czmq-ffi-gen 0.1.0

data/lib/czmq-ffi-gen/czmq/ffi/zconfig.rb

@@ -0,0 +1,449 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # zconfig - work with config files written in rfc.zeromq.org/spec:4/ZPL.
+    # @note This class is 100% generated using zproject.
+    class Zconfig
+      # Raised when one tries to use an instance of {Zconfig} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zconfig_destroy ptr_ptr
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        ObjectSpace.undefine_finalizer self if @finalizer
+        @finalizer = nil
+        @ptr = nil
+        ptr_ptr
+      end
+
+      # Create a new callback of the following type:
+      # 
+      #     typedef int (zconfig_fct) (                
+      #         zconfig_t *self, void *arg, int level);
+      #
+      # @note WARNING: If your Ruby code doesn't retain a reference to the
+      #   FFI::Function object after passing it to a C function call,
+      #   it may be garbage collected while C still holds the pointer,
+      #   potentially resulting in a segmentation fault.
+      def self.fct
+        ::FFI::Function.new :int, [:pointer, :pointer, :int], blocking: true do |self_, arg, level|
+          self_ = Zconfig.__new self_, false
+          result = yield self_, arg, level
+          result = Integer(result)
+          result
+        end
+      end
+
+      # Create new config item
+      # @param name [String, #to_str, #to_s]
+      # @param parent [Zconfig, #__ptr]
+      # @return [CZMQ::Zconfig]
+      def self.new(name, parent)
+        name = String(name)
+        parent = parent.__ptr if parent
+        ptr = ::CZMQ::FFI.zconfig_new(name, parent)
+        __new ptr
+      end
+
+      # Load a config tree from a specified ZPL text file; returns a zconfig_t  
+      # reference for the root, if the file exists and is readable. Returns NULL
+      # if the file does not exist.                                             
+      # @param filename [String, #to_str, #to_s]
+      # @return [CZMQ::Zconfig]
+      def self.load(filename)
+        filename = String(filename)
+        ptr = ::CZMQ::FFI.zconfig_load(filename)
+        __new ptr
+      end
+
+      # Equivalent to zconfig_load, taking a format string instead of a fixed
+      # filename.                                                            
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>]
+      # @return [CZMQ::Zconfig]
+      def self.loadf(format, *args)
+        format = String(format)
+        ptr = ::CZMQ::FFI.zconfig_loadf(format, *args)
+        __new ptr
+      end
+
+      # Destroy a config item and all its children
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zconfig_destroy(self_p)
+        result
+      end
+
+      # Return name of config item
+      #
+      # @return [::FFI::Pointer]
+      def name()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_name(self_p)
+        result
+      end
+
+      # Return value of config item
+      #
+      # @return [::FFI::Pointer]
+      def value()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_value(self_p)
+        result
+      end
+
+      # Insert or update configuration key with value
+      #
+      # @param path [String, #to_str, #to_s]
+      # @param value [String, #to_str, #to_s]
+      # @return [void]
+      def put(path, value)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        path = String(path)
+        value = String(value)
+        result = ::CZMQ::FFI.zconfig_put(self_p, path, value)
+        result
+      end
+
+      # Equivalent to zconfig_put, accepting a format specifier and variable
+      # argument list, instead of a single string value.                    
+      #
+      # @param path [String, #to_str, #to_s]
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def putf(path, format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        path = String(path)
+        format = String(format)
+        result = ::CZMQ::FFI.zconfig_putf(self_p, path, format, *args)
+        result
+      end
+
+      # Get value for config item into a string value; leading slash is optional
+      # and ignored.                                                            
+      #
+      # @param path [String, #to_str, #to_s]
+      # @param default_value [String, #to_str, #to_s]
+      # @return [::FFI::Pointer]
+      def get(path, default_value)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        path = String(path)
+        default_value = String(default_value)
+        result = ::CZMQ::FFI.zconfig_get(self_p, path, default_value)
+        result
+      end
+
+      # Set config item name, name may be NULL
+      #
+      # @param name [String, #to_str, #to_s]
+      # @return [void]
+      def set_name(name)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        name = String(name)
+        result = ::CZMQ::FFI.zconfig_set_name(self_p, name)
+        result
+      end
+
+      # Set new value for config item. The new value may be a string, a printf  
+      # format, or NULL. Note that if string may possibly contain '%', or if it 
+      # comes from an insecure source, you must use '%s' as the format, followed
+      # by the string.                                                          
+      #
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def set_value(format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        format = String(format)
+        result = ::CZMQ::FFI.zconfig_set_value(self_p, format, *args)
+        result
+      end
+
+      # Find our first child, if any
+      #
+      # @return [Zconfig]
+      def child()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_child(self_p)
+        result = Zconfig.__new result, false
+        result
+      end
+
+      # Find our first sibling, if any
+      #
+      # @return [Zconfig]
+      def next()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_next(self_p)
+        result = Zconfig.__new result, false
+        result
+      end
+
+      # Find a config item along a path; leading slash is optional and ignored.
+      #
+      # @param path [String, #to_str, #to_s]
+      # @return [Zconfig]
+      def locate(path)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        path = String(path)
+        result = ::CZMQ::FFI.zconfig_locate(self_p, path)
+        result = Zconfig.__new result, false
+        result
+      end
+
+      # Locate the last config item at a specified depth
+      #
+      # @param level [Integer, #to_int, #to_i]
+      # @return [Zconfig]
+      def at_depth(level)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        level = Integer(level)
+        result = ::CZMQ::FFI.zconfig_at_depth(self_p, level)
+        result = Zconfig.__new result, false
+        result
+      end
+
+      # Execute a callback for each config item in the tree; returns zero if
+      # successful, else -1.                                                
+      #
+      # @param handler [::FFI::Pointer, #to_ptr]
+      # @param arg [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def execute(handler, arg)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_execute(self_p, handler, arg)
+        result
+      end
+
+      # Add comment to config item before saving to disk. You can add as many
+      # comment lines as you like. If you use a null format, all comments are
+      # deleted.                                                             
+      #
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [void]
+      def set_comment(format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        format = String(format)
+        result = ::CZMQ::FFI.zconfig_set_comment(self_p, format, *args)
+        result
+      end
+
+      # Return comments of config item, as zlist.
+      #
+      # @return [Zlist]
+      def comments()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_comments(self_p)
+        result = Zlist.__new result, false
+        result
+      end
+
+      # Save a config tree to a specified ZPL text file, where a filename
+      # "-" means dump to standard output.                               
+      #
+      # @param filename [String, #to_str, #to_s]
+      # @return [Integer]
+      def save(filename)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        filename = String(filename)
+        result = ::CZMQ::FFI.zconfig_save(self_p, filename)
+        result
+      end
+
+      # Equivalent to zconfig_save, taking a format string instead of a fixed
+      # filename.                                                            
+      #
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def savef(format, *args)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        format = String(format)
+        result = ::CZMQ::FFI.zconfig_savef(self_p, format, *args)
+        result
+      end
+
+      # Report filename used during zconfig_load, or NULL if none
+      #
+      # @return [String]
+      def filename()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_filename(self_p)
+        result
+      end
+
+      # Reload config tree from same file that it was previously loaded from.
+      # Returns 0 if OK, -1 if there was an error (and then does not change  
+      # existing data).                                                      
+      #
+      # @param self_p [#__ptr_give_ref]
+      # @return [Integer]
+      def self.reload(self_p)
+        self_p = self_p.__ptr_give_ref
+        result = ::CZMQ::FFI.zconfig_reload(self_p)
+        result
+      end
+
+      # Load a config tree from a memory chunk
+      #
+      # @param chunk [::FFI::Pointer, #to_ptr]
+      # @return [Zconfig]
+      def self.chunk_load(chunk)
+        result = ::CZMQ::FFI.zconfig_chunk_load(chunk)
+        result = Zconfig.__new result, false
+        result
+      end
+
+      # Save a config tree to a new memory chunk
+      #
+      # @return [::FFI::Pointer]
+      def chunk_save()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_chunk_save(self_p)
+        result
+      end
+
+      # Load a config tree from a null-terminated string
+      #
+      # @param string [String, #to_str, #to_s]
+      # @return [Zconfig]
+      def self.str_load(string)
+        string = String(string)
+        result = ::CZMQ::FFI.zconfig_str_load(string)
+        result = Zconfig.__new result, true
+        result
+      end
+
+      # Save a config tree to a new null terminated string
+      #
+      # @return [::FFI::AutoPointer]
+      def str_save()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_str_save(self_p)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Return true if a configuration tree was loaded from a file and that
+      # file has changed in since the tree was loaded.                     
+      #
+      # @return [Boolean]
+      def has_changed()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_has_changed(self_p)
+        result
+      end
+
+      # Print the config file to open stream
+      #
+      # @param file [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def fprint(file)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_fprint(self_p, file)
+        result
+      end
+
+      # Print properties of object
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zconfig_print(self_p)
+        result
+      end
+
+      # Self test of this class
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zconfig_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################

data/lib/czmq-ffi-gen/czmq/ffi/zdir.rb

@@ -0,0 +1,280 @@
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################
+
+module CZMQ
+  module FFI
+
+    # work with file-system directories
+    # @note This class is 100% generated using zproject.
+    class Zdir
+      # Raised when one tries to use an instance of {Zdir} after
+      # the internal pointer to the native object has been nullified.
+      class DestroyedError < RuntimeError; end
+
+      # Boilerplate for self pointer, initializer, and finalizer
+      class << self
+        alias :__new :new
+      end
+      # Attaches the pointer _ptr_ to this instance and defines a finalizer for
+      # it if necessary.
+      # @param ptr [::FFI::Pointer]
+      # @param finalize [Boolean]
+      def initialize(ptr, finalize = true)
+        @ptr = ptr
+        if @ptr.null?
+          @ptr = nil # Remove null pointers so we don't have to test for them.
+        elsif finalize
+          @finalizer = self.class.create_finalizer_for @ptr
+          ObjectSpace.define_finalizer self, @finalizer
+        end
+      end
+      # @param ptr [::FFI::Pointer]
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          ptr_ptr = ::FFI::MemoryPointer.new :pointer
+          ptr_ptr.write_pointer ptr
+          ::CZMQ::FFI.zdir_destroy ptr_ptr
+        end
+      end
+      # @return [Boolean]
+      def null?
+        !@ptr or @ptr.null?
+      end
+      # Return internal pointer
+      # @return [::FFI::Pointer]
+      def __ptr
+        raise DestroyedError unless @ptr
+        @ptr
+      end
+      # So external Libraries can just pass the Object to a FFI function which expects a :pointer
+      alias_method :to_ptr, :__ptr
+      # Nullify internal pointer and return pointer pointer.
+      # @note This detaches the current instance from the native object
+      #   and thus makes it unusable.
+      # @return [::FFI::MemoryPointer] the pointer pointing to a pointer
+      #   pointing to the native object
+      def __ptr_give_ref
+        raise DestroyedError unless @ptr
+        ptr_ptr = ::FFI::MemoryPointer.new :pointer
+        ptr_ptr.write_pointer @ptr
+        ObjectSpace.undefine_finalizer self if @finalizer
+        @finalizer = nil
+        @ptr = nil
+        ptr_ptr
+      end
+
+      # Create a new directory item that loads in the full tree of the specified
+      # path, optionally located under some parent path. If parent is "-", then 
+      # loads only the top-level directory, and does not use parent as a path.  
+      # @param path [String, #to_str, #to_s]
+      # @param parent [String, #to_str, #to_s]
+      # @return [CZMQ::Zdir]
+      def self.new(path, parent)
+        path = String(path)
+        parent = String(parent)
+        ptr = ::CZMQ::FFI.zdir_new(path, parent)
+        __new ptr
+      end
+
+      # Destroy a directory tree and all children it contains.
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zdir_destroy(self_p)
+        result
+      end
+
+      # Return directory path
+      #
+      # @return [String]
+      def path()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdir_path(self_p)
+        result
+      end
+
+      # Return last modification time for directory.
+      #
+      # @return [::FFI::Pointer]
+      def modified()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdir_modified(self_p)
+        result
+      end
+
+      # Return total hierarchy size, in bytes of data contained in all files
+      # in the directory tree.                                              
+      #
+      # @return [::FFI::Pointer]
+      def cursize()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdir_cursize(self_p)
+        result
+      end
+
+      # Return directory count
+      #
+      # @return [Integer]
+      def count()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdir_count(self_p)
+        result
+      end
+
+      # Returns a sorted list of zfile objects; Each entry in the list is a pointer
+      # to a zfile_t item already allocated in the zdir tree. Do not destroy the   
+      # original zdir tree until you are done with this list.                      
+      #
+      # @return [Zlist]
+      def list()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdir_list(self_p)
+        result = Zlist.__new result, true
+        result
+      end
+
+      # Remove directory, optionally including all files that it contains, at  
+      # all levels. If force is false, will only remove the directory if empty.
+      # If force is true, will remove all files and all subdirectories.        
+      #
+      # @param force [Boolean]
+      # @return [void]
+      def remove(force)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        force = !(0==force||!force) # boolean
+        result = ::CZMQ::FFI.zdir_remove(self_p, force)
+        result
+      end
+
+      # Calculate differences between two versions of a directory tree.    
+      # Returns a list of zdir_patch_t patches. Either older or newer may  
+      # be null, indicating the directory is empty/absent. If alias is set,
+      # generates virtual filename (minus path, plus alias).               
+      #
+      # @param older [Zdir, #__ptr]
+      # @param newer [Zdir, #__ptr]
+      # @param alias_ [String, #to_str, #to_s]
+      # @return [Zlist]
+      def self.diff(older, newer, alias_)
+        older = older.__ptr if older
+        newer = newer.__ptr if newer
+        alias_ = String(alias_)
+        result = ::CZMQ::FFI.zdir_diff(older, newer, alias_)
+        result = Zlist.__new result, true
+        result
+      end
+
+      # Return full contents of directory as a zdir_patch list.
+      #
+      # @param alias_ [String, #to_str, #to_s]
+      # @return [Zlist]
+      def resync(alias_)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        alias_ = String(alias_)
+        result = ::CZMQ::FFI.zdir_resync(self_p, alias_)
+        result = Zlist.__new result, true
+        result
+      end
+
+      # Load directory cache; returns a hash table containing the SHA-1 digests
+      # of every file in the tree. The cache is saved between runs in .cache.  
+      #
+      # @return [Zhash]
+      def cache()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zdir_cache(self_p)
+        result = Zhash.__new result, true
+        result
+      end
+
+      # Print contents of directory to open stream
+      #
+      # @param file [::FFI::Pointer, #to_ptr]
+      # @param indent [Integer, #to_int, #to_i]
+      # @return [void]
+      def fprint(file, indent)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        indent = Integer(indent)
+        result = ::CZMQ::FFI.zdir_fprint(self_p, file, indent)
+        result
+      end
+
+      # Print contents of directory to stdout
+      #
+      # @param indent [Integer, #to_int, #to_i]
+      # @return [void]
+      def print(indent)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        indent = Integer(indent)
+        result = ::CZMQ::FFI.zdir_print(self_p, indent)
+        result
+      end
+
+      # Create a new zdir_watch actor instance:                       
+      #                                                               
+      #     zactor_t *watch = zactor_new (zdir_watch, NULL);          
+      #                                                               
+      # Destroy zdir_watch instance:                                  
+      #                                                               
+      #     zactor_destroy (&watch);                                  
+      #                                                               
+      # Enable verbose logging of commands and activity:              
+      #                                                               
+      #     zstr_send (watch, "VERBOSE");                             
+      #                                                               
+      # Subscribe to changes to a directory path:                     
+      #                                                               
+      #     zsock_send (watch, "ss", "SUBSCRIBE", "directory_path");  
+      #                                                               
+      # Unsubscribe from changes to a directory path:                 
+      #                                                               
+      #     zsock_send (watch, "ss", "UNSUBSCRIBE", "directory_path");
+      #                                                               
+      # Receive directory changes:                                    
+      #     zsock_recv (watch, "sp", &path, &patches);                
+      #                                                               
+      #     // Delete the received data.                              
+      #     free (path);                                              
+      #     zlist_destroy (&patches);                                 
+      #
+      # @param pipe [Zsock, #__ptr]
+      # @param unused [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def self.watch(pipe, unused)
+        pipe = pipe.__ptr if pipe
+        result = ::CZMQ::FFI.zdir_watch(pipe, unused)
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zdir_test(verbose)
+        result
+      end
+    end
+  end
+end
+
+################################################################################
+#  THIS FILE IS 100% GENERATED BY ZPROJECT; DO NOT EDIT EXCEPT EXPERIMENTALLY  #
+#  Please refer to the README for information about making permanent changes.  #
+################################################################################