libarchive-ruby-swig 0.5.6 → 0.5.7

data/ext/libarchive-ruby-swig/entry.cpp

@@ -113,7 +113,7 @@ void Entry::set_devminor(unsigned int devminor)
 
 unsigned long Entry::atime()
 {
-    archive_entry_atime(_entry);
+    return archive_entry_atime(_entry);
 }
 
 void Entry::set_atime(unsigned long atime)
@@ -128,7 +128,7 @@ void Entry::clear()
 
 Entry *Entry::clone()
 {
-    new Entry(archive_entry_clone(_entry));
+    return new Entry(archive_entry_clone(_entry));
 }
 
 unsigned long Entry::dev()

data/ext/libarchive-ruby-swig/entry.h

@@ -23,78 +23,257 @@ class Entry
         Entry(struct archive_entry *entry);
         virtual ~Entry();
 
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a regular file") is_file;
+        #endif
         bool is_file();
+
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a directory") is_directory;
+        #endif
         bool is_directory();
+
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a symlink") is_symbolic_link;
+        #endif
         bool is_symbolic_link();
+
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a block device node") is_block_special;
+        #endif
         bool is_block_special();
+
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a character device node") is_character_special;
+        #endif
         bool is_character_special();
+
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a fifo") is_fifo;
+        #endif
         bool is_fifo();
+
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a UNIX domain socket") is_socket;
+        #endif
         bool is_socket();
+
+        #ifdef SWIG
+        %feature("autodoc", "Indicates if Entry is a hardlink") is_hardlink;
+        #endif
         bool is_hardlink();
 
+        #ifdef SWIG
+        %feature("autodoc", "Returns the filetype bits for Entry") filetype;
+        #endif
         unsigned int filetype();
+
+        #ifdef SWIG
+        %feature("autodoc", "Use one of the <code>Archive::ENTRY_*</code> to specify the filetype of the Entry.") set_filetype;
+        #endif
         void set_filetype(unsigned int filetype);
 
+        #ifdef SWIG
+        %feature("autodoc", "Device major number of device on which this Entry resided. "
+                            "This field will not be available in most cases and is, in "
+                            "any case, platform-specific") devmajor;
+        #endif
         unsigned int devmajor();
+
+        #ifdef SWIG
+        %feature("autodoc", " Sets the device major number of the device on which "
+                            "this Entry resides. This field will not be availabla "
+                            "in most cases and is, in any case, platform-specific") set_devmajor;
+        #endif
         void set_devmajor(unsigned int devmajor);
 
+        #ifdef SWIG
+        %feature("autodoc", "Device minor number of device on which this Entry resided. "
+                            "This field will not be available in most cases and is, in "
+                            "any case, platform-specific") devminor;
+        #endif
         unsigned int devminor();
+
+        #ifdef SWIG
+        %feature("autodoc", " Sets the device minor number of the device on which "
+                            "this Entry resides. This field will not be availabla "
+                            "in most cases and is, in any case, platform-specific") set_devminor;
+        #endif
         void set_devminor(unsigned int devminor);
 
+        #ifdef SWIG
+        %feature("autodoc", "Returns the atime of the saved Entry as a timestamp since epoch") atime;
+        #endif
         unsigned long atime();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the atime of Entry to the given timestamp since epoch") set_atime;
+        #endif
         void set_atime(unsigned long atime);
 
+        #ifdef SWIG
+        %feature("autodoc", "Resets the Entry") clear;
+        #endif
         void clear();
 
-#ifdef SWIG
-%newobject clone(Entry *entry);
-#endif
-
+        #ifdef SWIG
+        %feature("autodoc", "Returns an exact clone of Entry") clone;
+        #endif
         Entry *clone();
 
+        #ifdef SWIG
+        %feature("autodoc", "Device id of the device on which entry resided. "
+                            "This is usually unused and, in any case, platform-specific") dev;
+        #endif
         unsigned long dev();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the device id of the device on which "
+                            "entry resided. This is usually unused and, "
+                            "in any case, platform-specific") set_dev;
+        #endif
         void set_dev(unsigned long dev);
 
+        #ifdef SWIG
+        %feature("autodoc", "Group id of Entry") gid;
+        #endif
         unsigned long gid();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the group id of Entry") set_gid;
+        #endif
         void set_gid(unsigned long gid);
 
+        #ifdef SWIG
+        %feature("autodoc", "Group name of Entry") gname;
+        #endif
         const char *gname();
+
+        #ifdef SWIG
+        %feature("autodoc", "Set group name of Entry") set_gname;
+        #endif
         void set_gname(const char *gname);
 
+        #ifdef SWIG
+        %feature("autodoc", "Path of file this entry was hardlinked to") hardlink;
+        #endif
         const char *hardlink();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the path to the file this entry is hard-linked to") set_hardlink;
+        #endif
         void set_hardlink(const char *hardlink);
 
+        #ifdef SWIG
+        %feature("autodoc", "Inode of Entry") ino;
+        #endif
         unsigned long ino();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the inode of Entry") set_ino;
+        #endif
         void set_ino(unsigned long ino);
 
+        #ifdef SWIG
+        %feature("autodoc", "Permission bits and filetype of entry") mode;
+        #endif
         int mode();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets filetype and permission bits of Entry") set_mode;
+        #endif
         void set_mode(int mode);
 
+        #ifdef SWIG
+        %feature("autodoc", "Returns the mtime of Entry as a timestamp since epoch") mtime;
+        #endif
         unsigned long mtime();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the mtime of Entry to given timestamp since epoch") set_mtime;
+        #endif
         void set_mtime(unsigned long mtime);
 
+        #ifdef SWIG
+        %feature("autodoc", "Number of hard links to Entry") nlink;
+        #endif
         unsigned int nlink();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the number of hardlinks to Entry") set_nlink;
+        #endif
         void set_nlink(unsigned int nlink);
 
+        #ifdef SWIG
+        %feature("autodoc", "Returns the pathname of Entry") pathname;
+        #endif
         const char *pathname();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the pathname of Entry") set_pathname;
+        #endif
         void set_pathname(const char *pathname);
 
+        #ifdef SWIG
+        %feature("autodoc", "The dev major number of the device represented by Entry") rdevmajor;
+        #endif
         unsigned int rdevmajor();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the dev major number of the device represented by Entry") set_rdevmajor;
+        #endif
         void set_rdevmajor(unsigned int rdevmajor);
 
+        #ifdef SWIG
+        %feature("autodoc", "The dev minor number of the device represented by Entry") rdevminor;
+        #endif
         unsigned int rdevminor();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the dev minor number of the device represented by Entry") set_rdevminor;
+        #endif
         void set_rdevminor(unsigned int rdevminor);
 
+        #ifdef SWIG
+        %feature("autodoc", "Size of the Entry. In case Entry is a symlink, "
+                            "returns the size of the symlink's target name") size;
+        #endif
         unsigned long size();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the size of the Entry. In case Entry is "
+                            "a symlink, this should be the length of the string set with <code>symlink=</code>") set_size;
+        #endif
         void set_size(unsigned long size);
 
+        #ifdef SWIG
+        %feature("autodoc", "Returns the target of a symlink Entry") symlink;
+        #endif
         const char *symlink();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the target of a symlink Entry") set_symlink;
+        #endif
         void set_symlink(const char *symlink);
 
+        #ifdef SWIG
+        %feature("autodoc", "Returns the numeric user id of Entry") uid;
+        #endif
         unsigned long uid();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the numeric user id of Entry") set_uid;
+        #endif
         void set_uid(unsigned long uid);
 
+        #ifdef SWIG
+        %feature("autodoc", "Returns the Entry owner's username") uname;
+        #endif
         const char *uname();
+
+        #ifdef SWIG
+        %feature("autodoc", "Sets the Entry owner's username") set_uname;
+        #endif
         void set_uname(const char *uname);
 
 #ifdef SWIG

data/ext/libarchive-ruby-swig/extconf.rb

@@ -22,7 +22,7 @@ end
 
 if swig = find_executable('swig')
   `#{swig} -c++ -ruby -features autodoc=0 libarchive.i`
-  $distcleanfiles << 'libarchive_wrap.cxx'
+  $distcleanfiles += [ 'libarchive_wrap.cxx', 'libarchive_wrap_doc.cxx' ]
 else
   $stderr.write "You need SWIG to compile this extension.\n"
   exit 1

data/ext/libarchive-ruby-swig/reader.h

@@ -23,6 +23,10 @@ class Reader
     public:
         Reader(struct archive *ar);
         virtual ~Reader();
+
+        #ifdef SWIG
+        %feature("autodoc", "Releases all resources associated with the Reader object") close;
+        #endif
         void close();
 
 #ifdef SWIG
@@ -39,8 +43,11 @@ class Reader
 #endif
 
 #ifdef SWIG
+%feature("autodoc", "Use <code>Archive::read_open_filename</code> instead") read_open_filename;
 %newobject read_open_filename(const char *filename, const char *cmd);
+%feature("autodoc", "Use <code>Archive::read_open_memory</code> instead") read_open_memory;
 %newobject read_open_memory(const char *string, int length, const char *cmd);
+%feature("autodoc", "Returns the next Entry meta data object in the Archive") next_header;
 %newobject next_header();
 #endif
 
@@ -59,8 +66,8 @@ class Reader
     private:
         struct archive *_ar;
         char *_buf;
-        char *_archive_content;
         int _buf_size;
+        char *_archive_content;
 };
 
 #endif

data/ext/libarchive-ruby-swig/writer.h

@@ -54,6 +54,10 @@ class Writer
     public:
         Writer(struct archive *ar);
         virtual ~Writer();
+
+        #ifdef SWIG
+        %feature("autodoc", "Releases all resources associated with the Writer object") close;
+        #endif
         void close();
 
 #ifdef SWIG
@@ -70,6 +74,7 @@ class Writer
 #endif
 
 #ifdef SWIG
+%feature("autodoc", "Use Archive::write_open_filename instead") write_open_filename;
 %newobject write_open_filename(const char *filename,
     const char *cmd, int format);
 %newobject write_open_filename(const char *filename,
@@ -82,6 +87,9 @@ class Writer
         static Writer *write_open_filename(const char *filename,
             int compression, int format);
 
+        #ifdef SWIG
+        %feature("autodoc", "Write Entry meta data to Archive") write_header;
+        #endif
         void write_header(Entry *entry);
 
         void write_data_helper(const char *string, int length);

data/lib/libarchive_rs.rb

@@ -12,6 +12,23 @@ require 'archive'
 
 module Archive
 
+  ##
+  #
+  # Thrown on problems with opening or processing an archive.
+  #
+  class Error < StandardError
+  end
+
+  ##
+  #
+  # This class is not meant to be used directly. It exists for the sole purpose
+  # of initializing the <code>Archive::ENTRY_*</code> constants in a
+  # platform-independent way.
+  #
+  class Stat
+    private_class_method :new
+  end  
+
   ENTRY_FILE = Stat.type_file
   ENTRY_DIRECTORY = Stat.type_directory
   ENTRY_SYMBOLIC_LINK = Stat.type_symbolic_link
@@ -105,9 +122,9 @@ module Archive
 
     ##
     #
-    # Returns a new Entry instance. An Entry holds the meta data for an item
-    # stored in an Archive, such as filetype, mode, owner, etc. It is written
-    # before the actual data.
+    # Creates a new Entry. An Entry holds the meta data for an item stored in
+    # an Archive, such as filetype, mode, owner, etc. It is typically populated
+    # by a call to <code>copy_stat</code>. It is written before the actual data.
     #
     def new_entry()
       entry = self.new_entry_helper

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: libarchive-ruby-swig
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 5
-  - 6
-  version: 0.5.6
+  - 7
+  version: 0.5.7
 platform: ruby
 authors: 
 - Tobias Koch
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-16 00:00:00 +03:00
+date: 2011-11-07 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -29,7 +29,6 @@ extra_rdoc_files: []
 
 files: 
 - lib/libarchive_rs.rb
-- lib/libarchive_doc.rb
 - ext/libarchive-ruby-swig/stat.cpp
 - ext/libarchive-ruby-swig/stat.h
 - ext/libarchive-ruby-swig/entry.cpp

data/lib/libarchive_doc.rb

@@ -1,478 +0,0 @@
-#
-# This file is part of "libarchive-ruby-swig", a simple SWIG wrapper around
-# libarchive.
-#
-# Copyright 2011, Tobias Koch <tobias.koch@gmail.com>
-# 
-# libarchive-ruby-swig is licensed under a simplified BSD License. A copy of the
-# license text can be found in the file LICENSE.txt distributed with the source.
-#
-
-#
-module Archive
-
-  ##
-  #
-  # Thrown on problems with opening or processing an archive.
-  #
-  class Error < StandardError
-  end
-
-  ##
-  #
-  # This class is not meant to be used directly. It exists for the sole purpose
-  # of initializing the <code>Archive::ENTRY_*</code> constants in a
-  # platform-independent way.
-  #
-  class Stat
-
-    private
-
-    def self.new()
-    end
-  end
-
-  class Entry
-
-    ##
-    #
-    # Is Entry a regular file?
-    #
-    def is_file
-    end
-
-    ##
-    #
-    # Is Entry a directory?
-    #
-    def is_directory
-    end
-
-    ##
-    #
-    # Is Entry a symbolic link?
-    #
-    def is_symbolic_link
-    end
-
-    ##
-    #
-    # Is Entry a block device?
-    #
-    def is_block_special
-    end
-
-    ##
-    #
-    # Is Entry a char device?
-    #
-    def is_character_special
-    end
-
-    ##
-    #
-    # Is Entry a fifo?
-    #
-    def is_fifo
-    end
-
-    ##
-    #
-    # Is Entry a socket?
-    #
-    def is_socket
-    end
-
-    ##
-    #
-    # Is Entry a hardlink?
-    #
-    def is_hardlink
-    end
-
-    ##
-    #
-    # Returns the filetype bits for entry.
-    #
-    def filetype
-    end
-
-    ##
-    #
-    # Use one of the <code>Archive::ENTRY_*</code> to specify the filetype of
-    # the Entry.
-    #
-    def set_filetype(filetype)
-    end
-
-    ##
-    #
-    # Device major number of device on which this Entry resided. This field
-    # will not be available in most cases and is, in any case,
-    # platform-specific.
-    #
-    def devmajor
-    end
-
-    ##
-    #
-    # Sets the device major number of the device on which this Entry resides. This
-    # field will not be availabla in most cases and is, in any case,
-    # platform-specific.
-    #
-    def set_devmajor(devmajor)
-    end
-
-    ##
-    #
-    # Device minor number of device on which this Entry resided. This field
-    # will not be available in most cases and is, in any case,
-    # platform-specific.
-    #
-    def devminor
-      return numeric_result
-    end
-
-    ##
-    #
-    # Sets the device minor number of the device on which this Entry resides. This
-    # field will not be availabla in most cases and is, in any case,
-    # platform-specific.
-    #
-    def set_devminor(devminor)
-    end
-
-    ##
-    #
-    # Returns the atime of the saved Entry as a timestamp since epoch.
-    #
-    def atime
-    end
-
-    ##
-    #
-    # Sets the atime of the saved Entry from a timestamp.
-    #
-    def atime(atime)
-    end
-
-    ##
-    #
-    # Resets the Entry.
-    #
-    def clear
-    end
-
-    ##
-    #
-    # Returns an exact clone of Entry.
-    #
-    Entry *clone();
-
-    ##
-    #
-    # Device id of the device on which entry resided. This is usually unused
-    # and, in any case, platform-specific.
-    #
-    def dev
-    end
-
-    ##
-    #
-    # Sets the device id of the device on which entry resided. This is usually
-    # unused and, in any case, platform-specific.
-    #
-    def set_dev(dev)
-    end
-
-    ##
-    #
-    # Group id of the Entry.
-    #
-    def gid
-    end
-
-    ##
-    #
-    # Sets the group id of the Entry.
-    #
-    def set_gid(gid)
-    end
-
-    ##
-    #
-    # Group name of the Entry.
-    #
-    def gname
-    end
-
-    ##
-    #
-    # Sets the group name of the Entry.
-    #
-    def set_gname(gname)
-    end
-
-    ##
-    #
-    # Path of file this entry was hardlinked to.
-    #
-    def hardlink
-    end
-
-    ##
-    #
-    # Sets the path to the file this entry is hard-linked to.
-    #
-    def set_hardlink(path)
-    end
-
-    ##
-    #
-    # Inode of Entry.
-    #
-    def ino
-    end
-
-    ##
-    #
-    # Sets the inode of Entry.
-    #
-    def set_ino(ino)
-    end
-
-    ##
-    #
-    # Permission bits and filetype of entry
-    #
-    def mode
-    end
-
-    ##
-    #
-    # Sets the permission bits (and/or filetype) of Entry.
-    #
-    def set_mode(mode)
-    end
-
-    ##
-    #
-    # Returns the mtime of the saved Entry as a timestamp since epoch.
-    #
-    def mtime
-    end
-
-    ##
-    #
-    # Sets the mtime of the saved Entry from a timestamp.
-    #
-    def set_mtime(mtime)
-    end
-
-    ##
-    #
-    # Number of hard links to this Entry.
-    #
-    def nlink
-    end
-
-    ##
-    #
-    # Sets the number of hard links to this Entry.
-    #
-    def set_nlink(num_links)
-    end
-
-    ##
-    #
-    # Returns the pathname of this Entry.
-    #
-    def pathname
-    end
-
-    ##
-    #
-    # Sets the pathname of this Entry.
-    #
-    def set_pathname(pathname)
-    end
-
-    ##
-    #
-    # The dev major number of the device this Entry represents.
-    #
-    def rdevmajor
-    end
-
-    ##
-    #
-    # Sets the dev major number of the device this Entry represents.
-    #
-    def set_rdevmajor(devmajor)
-    end
-
-    ##
-    #
-    # The dev minor number of the device this Entry represents.
-    #
-    def rdevminor
-    end
-
-    ##
-    #
-    # Sets the dev minor number of the device this Entry represents.
-    #
-    def set_rdevminor(devminor)
-    end
-
-    ##
-    #
-    # Size of the Entry. In case Entry is a symlink, returns the size of
-    # symlink's target name.
-    #
-    def size
-    end
-
-    ##
-    #
-    # Sets the size of the Entry. In case Entry is a symlink, this should
-    # be the length of the string set with <code>symlink=</code>.
-    #
-    def set_size()
-    end
-
-    ##
-    #
-    # Returns the rarget of a symlink Entry.
-    #
-    def symlink
-    end
-
-    ##
-    #
-    # Sets the target of a symlink Entry.
-    #
-    def set_symlink(path)
-    end
-
-    ##
-    #
-    # The user id of this Entry.
-    #
-    def uid
-    end
-
-    ##
-    #
-    # Sets the user id of this Entry.
-    #
-    def set_uid(uid)
-    end
-
-    ##
-    #
-    # The owner name of this entry.
-    #
-    def uname
-    end
-
-    ##
-    #
-    # Sets the owner name of this Entry.
-    #
-    def set_uname(uname)
-    end
-
-    private
-
-    def self.new()
-    end
-  end
-
-  class Reader
-
-    ##
-    #
-    # Use <code>Archive::read_open_filename</code> instead.
-    #
-    def self.read_open_filename(filename, cmd = nil)
-    end
-
-    ##
-    #
-    # Use <code>Archive::read_open_memory</code> instead.
-    #
-    def self.read_open_memory(string, cmd = nil)
-    end
-
-    ##
-    #
-    # Releases all resources associated with the Reader object.
-    #
-    def close()
-    end
-
-    ##
-    #
-    # Returns the next Entry meta data object in the Archive.
-    #
-    def next_header()
-    end
-
-    private
-
-    def read_data_helper(len)
-    end
-
-    def self.new()
-    end
-
-  end
-
-  class Writer
-
-    ##
-    #
-    # Use Archive::write_open_filename instead.
-    #
-    #
-    def self.write_open_filename(filename, compression, format)
-    end
-
-    ##
-    #
-    # Releases all resources associated with the Writer object.
-    #
-    def close()
-    end
-
-    ##
-    #
-    # Creates a new Entry. An Entry holds the meta data for an item stored in
-    # an Archive, such as filetype, mode, owner, etc. It is typically populated
-    # by a call to <code>copy_stat</code>. It is written before the actual data.
-    #
-    def new_entry()
-    end
-
-    ##
-    #
-    # Write Entry meta data to Archive.
-    #
-    def write_header(entry)
-    end
-
-    private
-
-    def self.new()
-    end
-
-    def new_entry_helper()
-    end
-
-    def write_data_helper()
-    end
-
-  end
-
-end