czmq-ffi-gen 0.1.0

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

@@ -0,0 +1,201 @@
+################################################################################
+#  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
+
+    # sending and receiving strings
+    # @note This class is 100% generated using zproject.
+    class Zstr
+      # Raised when one tries to use an instance of {Zstr} 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
+      # @return [Proc]
+      def self.create_finalizer_for(ptr)
+        Proc.new do
+          "WARNING: "\
+          "Objects of type #{self} cannot be destroyed implicitly. "\
+          "Please call the correct destroy method with the relevant arguments."
+        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
+
+      # Receive C string from socket. Caller must free returned string using
+      # zstr_free(). Returns NULL if the context is being terminated or the 
+      # process was interrupted.                                            
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::AutoPointer]
+      def self.recv(source)
+        result = ::CZMQ::FFI.zstr_recv(source)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Receive a series of strings (until NULL) from multipart data.    
+      # Each string is allocated and filled with string data; if there   
+      # are not enough frames, unallocated strings are set to NULL.      
+      # Returns -1 if the message could not be read, else returns the    
+      # number of strings filled, zero or more. Free each returned string
+      # using zstr_free(). If not enough strings are provided, remaining 
+      # multipart frames in the message are dropped.                     
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @param string_p [::FFI::Pointer, #to_ptr]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.recvx(source, string_p, *args)
+        result = ::CZMQ::FFI.zstr_recvx(source, string_p, *args)
+        result
+      end
+
+      # Send a C string to a socket, as a frame. The string is sent without 
+      # trailing null byte; to read this you can use zstr_recv, or a similar
+      # method that adds a null terminator on the received string. String   
+      # may be NULL, which is sent as "".                                   
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param string [String, #to_str, #to_s]
+      # @return [Integer]
+      def self.send(dest, string)
+        string = String(string)
+        result = ::CZMQ::FFI.zstr_send(dest, string)
+        result
+      end
+
+      # Send a C string to a socket, as zstr_send(), with a MORE flag, so that
+      # you can send further strings in the same multi-part message.          
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param string [String, #to_str, #to_s]
+      # @return [Integer]
+      def self.sendm(dest, string)
+        string = String(string)
+        result = ::CZMQ::FFI.zstr_sendm(dest, string)
+        result
+      end
+
+      # Send a formatted string to a socket. Note that you should NOT use
+      # user-supplied strings in the format (they may contain '%' which  
+      # will create security holes).                                     
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.sendf(dest, format, *args)
+        format = String(format)
+        result = ::CZMQ::FFI.zstr_sendf(dest, format, *args)
+        result
+      end
+
+      # Send a formatted string to a socket, as for zstr_sendf(), with a      
+      # MORE flag, so that you can send further strings in the same multi-part
+      # message.                                                              
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param format [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.sendfm(dest, format, *args)
+        format = String(format)
+        result = ::CZMQ::FFI.zstr_sendfm(dest, format, *args)
+        result
+      end
+
+      # Send a series of strings (until NULL) as multipart data   
+      # Returns 0 if the strings could be sent OK, or -1 on error.
+      #
+      # @param dest [::FFI::Pointer, #to_ptr]
+      # @param string [String, #to_str, #to_s]
+      # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
+      # @return [Integer]
+      def self.sendx(dest, string, *args)
+        string = String(string)
+        result = ::CZMQ::FFI.zstr_sendx(dest, string, *args)
+        result
+      end
+
+      # Accepts a void pointer and returns a fresh character string. If source
+      # is null, returns an empty string.                                     
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [::FFI::AutoPointer]
+      def self.str(source)
+        result = ::CZMQ::FFI.zstr_str(source)
+        result = ::FFI::AutoPointer.new(result, LibC.method(:free))
+        result
+      end
+
+      # Free a provided string, and nullify the parent pointer. Safe to call on
+      # a null pointer.                                                        
+      #
+      # @param string_p [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def self.free(string_p)
+        result = ::CZMQ::FFI.zstr_free(string_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.zstr_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/ztrie.rb

@@ -0,0 +1,217 @@
+################################################################################
+#  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
+
+    # simple trie for tokenizable strings
+    # @note This class is 100% generated using zproject.
+    class Ztrie
+      # Raised when one tries to use an instance of {Ztrie} 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.ztrie_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:
+      # Callback function for ztrie_node to destroy node data.
+      #     typedef void (ztrie_destroy_data_fn) (
+      #         void **data);                     
+      #
+      # @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.destroy_data_fn
+        ::FFI::Function.new :void, [:pointer], blocking: true do |data|
+          result = yield data
+          result
+        end
+      end
+
+      # Creates a new ztrie.
+      # @param delimiter [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Ztrie]
+      def self.new(delimiter)
+        ptr = ::CZMQ::FFI.ztrie_new(delimiter)
+        __new ptr
+      end
+
+      # Destroy the ztrie.
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.ztrie_destroy(self_p)
+        result
+      end
+
+      # Inserts a new route into the tree and attaches the data. Returns -1     
+      # if the route already exists, otherwise 0. This method takes ownership of
+      # the provided data if a destroy_data_fn is provided.                     
+      #
+      # @param path [String, #to_str, #to_s]
+      # @param data [::FFI::Pointer, #to_ptr]
+      # @param destroy_data_fn [::FFI::Pointer, #to_ptr]
+      # @return [Integer]
+      def insert_route(path, data, destroy_data_fn)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        path = String(path)
+        result = ::CZMQ::FFI.ztrie_insert_route(self_p, path, data, destroy_data_fn)
+        result
+      end
+
+      # Removes a route from the trie and destroys its data. Returns -1 if the
+      # route does not exists, otherwise 0.                                   
+      # the start of the list call zlist_first (). Advances the cursor.       
+      #
+      # @param path [String, #to_str, #to_s]
+      # @return [Integer]
+      def remove_route(path)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        path = String(path)
+        result = ::CZMQ::FFI.ztrie_remove_route(self_p, path)
+        result
+      end
+
+      # Returns true if the path matches a route in the tree, otherwise false.
+      #
+      # @param path [String, #to_str, #to_s]
+      # @return [Boolean]
+      def matches(path)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        path = String(path)
+        result = ::CZMQ::FFI.ztrie_matches(self_p, path)
+        result
+      end
+
+      # Returns the data of a matched route from last ztrie_matches. If the path
+      # did not match, returns NULL. Do not delete the data as it's owned by    
+      # ztrie.                                                                  
+      #
+      # @return [::FFI::Pointer]
+      def hit_data()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_data(self_p)
+        result
+      end
+
+      # Returns the count of parameters that a matched route has.
+      #
+      # @return [Integer]
+      def hit_parameter_count()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_parameter_count(self_p)
+        result
+      end
+
+      # Returns the parameters of a matched route with named regexes from last   
+      # ztrie_matches. If the path did not match or the route did not contain any
+      # named regexes, returns NULL.                                             
+      #
+      # @return [Zhashx]
+      def hit_parameters()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_parameters(self_p)
+        result = Zhashx.__new result, false
+        result
+      end
+
+      # Returns the asterisk matched part of a route, if there has been no match
+      # or no asterisk match, returns NULL.                                     
+      #
+      # @return [String]
+      def hit_asterisk_match()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_hit_asterisk_match(self_p)
+        result
+      end
+
+      # Print the trie
+      #
+      # @return [void]
+      def print()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.ztrie_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.ztrie_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/zuuid.rb

@@ -0,0 +1,221 @@
+################################################################################
+#  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
+
+    # UUID support class
+    # @note This class is 100% generated using zproject.
+    class Zuuid
+      # Raised when one tries to use an instance of {Zuuid} 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.zuuid_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 UUID object.
+      # @return [CZMQ::Zuuid]
+      def self.new()
+        ptr = ::CZMQ::FFI.zuuid_new()
+        __new ptr
+      end
+
+      # Create UUID object from supplied ZUUID_LEN-octet value.
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [CZMQ::Zuuid]
+      def self.new_from(source)
+        ptr = ::CZMQ::FFI.zuuid_new_from(source)
+        __new ptr
+      end
+
+      # Destroy a specified UUID object.
+      #
+      # @return [void]
+      def destroy()
+        return unless @ptr
+        self_p = __ptr_give_ref
+        result = ::CZMQ::FFI.zuuid_destroy(self_p)
+        result
+      end
+
+      # Set UUID to new supplied ZUUID_LEN-octet value.
+      #
+      # @param source [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def set(source)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_set(self_p, source)
+        result
+      end
+
+      # Set UUID to new supplied string value skipping '-' and '{' '}'
+      # optional delimiters. Return 0 if OK, else returns -1.         
+      #
+      # @param source [String, #to_str, #to_s]
+      # @return [Integer]
+      def set_str(source)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        source = String(source)
+        result = ::CZMQ::FFI.zuuid_set_str(self_p, source)
+        result
+      end
+
+      # Return UUID binary data.
+      #
+      # @return [::FFI::Pointer]
+      def data()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_data(self_p)
+        result
+      end
+
+      # Return UUID binary size
+      #
+      # @return [Integer]
+      def size()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_size(self_p)
+        result
+      end
+
+      # Returns UUID as string
+      #
+      # @return [String]
+      def str()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_str(self_p)
+        result
+      end
+
+      # Return UUID in the canonical string format: 8-4-4-4-12, in lower
+      # case. Caller does not modify or free returned value. See        
+      # http://en.wikipedia.org/wiki/Universally_unique_identifier      
+      #
+      # @return [String]
+      def str_canonical()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_str_canonical(self_p)
+        result
+      end
+
+      # Store UUID blob in target array
+      #
+      # @param target [::FFI::Pointer, #to_ptr]
+      # @return [void]
+      def export(target)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_export(self_p, target)
+        result
+      end
+
+      # Check if UUID is same as supplied value
+      #
+      # @param compare [::FFI::Pointer, #to_ptr]
+      # @return [Boolean]
+      def eq(compare)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_eq(self_p, compare)
+        result
+      end
+
+      # Check if UUID is different from supplied value
+      #
+      # @param compare [::FFI::Pointer, #to_ptr]
+      # @return [Boolean]
+      def neq(compare)
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_neq(self_p, compare)
+        result
+      end
+
+      # Make copy of UUID object; if uuid is null, or memory was exhausted,
+      # returns null.                                                      
+      #
+      # @return [Zuuid]
+      def dup()
+        raise DestroyedError unless @ptr
+        self_p = @ptr
+        result = ::CZMQ::FFI.zuuid_dup(self_p)
+        result = Zuuid.__new result, false
+        result
+      end
+
+      # Self test of this class.
+      #
+      # @param verbose [Boolean]
+      # @return [void]
+      def self.test(verbose)
+        verbose = !(0==verbose||!verbose) # boolean
+        result = ::CZMQ::FFI.zuuid_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.  #
+################################################################################