czmq-ffi-gen 0.2.0 → 0.2.1

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

@@ -60,22 +60,27 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Create new patch
-      # @param path [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
       # @param file [Zfile, #__ptr]
       # @param op [Symbol]
-      # @param alias_ [String, #to_str, #to_s]
+      # @param alias_ [String, #to_s, nil]
       # @return [CZMQ::ZdirPatch]
       def self.new(path, file, op, alias_)
-        path = String(path)
         file = file.__ptr if file
-        alias_ = String(alias_)
         ptr = ::CZMQ::FFI.zdir_patch_new(path, file, op, alias_)
         __new ptr
       end

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

@@ -60,23 +60,28 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # If file exists, populates properties. CZMQ supports portable symbolic
       # links, which are files with the extension ".ln". A symbolic link is a
       # text file containing one line, the filename of a target file. Reading
       # data from the symbolic link actually reads from the target file. Path
       # may be NULL, in which case it is not used.                           
-      # @param path [String, #to_str, #to_s]
-      # @param name [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
+      # @param name [String, #to_s, nil]
       # @return [CZMQ::Zfile]
       def self.new(path, name)
-        path = String(path)
-        name = String(name)
         ptr = ::CZMQ::FFI.zfile_new(path, name)
         __new ptr
       end
@@ -105,12 +110,11 @@ module CZMQ
 
       # Return file name, remove path if provided
       #
-      # @param path [String, #to_str, #to_s]
+      # @param path [String, #to_s, nil]
       # @return [String]
       def filename(path)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        path = String(path)
         result = ::CZMQ::FFI.zfile_filename(self_p, path)
         result
       end

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Create a new frame. If size is not null, allocates the frame data
       # to the specified size. If additionally, data is not null, copies 
@@ -86,10 +93,9 @@ module CZMQ
       end
 
       # Create a frame with a specified string content.
-      # @param string [String, #to_str, #to_s]
+      # @param string [String, #to_s, nil]
       # @return [CZMQ::Zframe]
       def self.from(string)
-        string = String(string)
         ptr = ::CZMQ::FFI.zframe_from(string)
         __new ptr
       end
@@ -186,12 +192,11 @@ module CZMQ
 
       # Return TRUE if frame body is equal to string, excluding terminator
       #
-      # @param string [String, #to_str, #to_s]
+      # @param string [String, #to_s, nil]
       # @return [Boolean]
       def streq(string)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        string = String(string)
         result = ::CZMQ::FFI.zframe_streq(self_p, string)
         result
       end
@@ -273,12 +278,11 @@ module CZMQ
       # Send message to zsys log sink (may be stdout, or system facility as       
       # configured by zsys_set_logstream). Prefix shows before frame, if not null.
       #
-      # @param prefix [String, #to_str, #to_s]
+      # @param prefix [String, #to_s, nil]
       # @return [void]
       def print(prefix)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        prefix = String(prefix)
         result = ::CZMQ::FFI.zframe_print(self_p, prefix)
         result
       end

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Create a new callback of the following type:
       # Callback function for zhash_freefn method
@@ -131,13 +138,12 @@ module CZMQ
       # If key is already present returns -1 and leaves existing item unchanged
       # Returns 0 on success.                                                  
       #
-      # @param key [String, #to_str, #to_s]
+      # @param key [String, #to_s, nil]
       # @param item [::FFI::Pointer, #to_ptr]
       # @return [Integer]
       def insert(key, item)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        key = String(key)
         result = ::CZMQ::FFI.zhash_insert(self_p, key, item)
         result
       end
@@ -146,13 +152,12 @@ module CZMQ
       # If key is already present, destroys old item and inserts new one.   
       # Use free_fn method to ensure deallocator is properly called on item.
       #
-      # @param key [String, #to_str, #to_s]
+      # @param key [String, #to_s, nil]
       # @param item [::FFI::Pointer, #to_ptr]
       # @return [void]
       def update(key, item)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        key = String(key)
         result = ::CZMQ::FFI.zhash_update(self_p, key, item)
         result
       end
@@ -160,24 +165,22 @@ module CZMQ
       # Remove an item specified by key from the hash table. If there was no such
       # item, this function does nothing.                                        
       #
-      # @param key [String, #to_str, #to_s]
+      # @param key [String, #to_s, nil]
       # @return [void]
       def delete(key)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        key = String(key)
         result = ::CZMQ::FFI.zhash_delete(self_p, key)
         result
       end
 
       # Return the item at the specified key, or null
       #
-      # @param key [String, #to_str, #to_s]
+      # @param key [String, #to_s, nil]
       # @return [::FFI::Pointer]
       def lookup(key)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        key = String(key)
         result = ::CZMQ::FFI.zhash_lookup(self_p, key)
         result
       end
@@ -185,14 +188,12 @@ module CZMQ
       # Reindexes an item from an old key to a new key. If there was no such
       # item, does nothing. Returns 0 if successful, else -1.               
       #
-      # @param old_key [String, #to_str, #to_s]
-      # @param new_key [String, #to_str, #to_s]
+      # @param old_key [String, #to_s, nil]
+      # @param new_key [String, #to_s, nil]
       # @return [Integer]
       def rename(old_key, new_key)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        old_key = String(old_key)
-        new_key = String(new_key)
         result = ::CZMQ::FFI.zhash_rename(self_p, old_key, new_key)
         result
       end
@@ -203,13 +204,12 @@ module CZMQ
       # you don't have memory leaks. You can pass 'free' or NULL as a free_fn. 
       # Returns the item, or NULL if there is no such item.                    
       #
-      # @param key [String, #to_str, #to_s]
+      # @param key [String, #to_s, nil]
       # @param free_fn [::FFI::Pointer, #to_ptr]
       # @return [::FFI::Pointer]
       def freefn(key, free_fn)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        key = String(key)
         result = ::CZMQ::FFI.zhash_freefn(self_p, key, free_fn)
         result
       end
@@ -294,13 +294,12 @@ module CZMQ
       # comment lines as you like. These comment lines are discarded when loading
       # the file. If you use a null format, all comments are deleted.            
       #
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [void]
       def comment(format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        format = String(format)
         result = ::CZMQ::FFI.zhash_comment(self_p, format, *args)
         result
       end
@@ -339,12 +338,11 @@ module CZMQ
       # printable strings; keys may not contain '=' character. Returns 0 if OK, 
       # else -1 if a file error occurred.                                       
       #
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def save(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zhash_save(self_p, filename)
         result
       end
@@ -353,12 +351,11 @@ module CZMQ
       # already exist. Hash values must printable strings; keys may not contain
       # '=' character. Returns 0 if OK, else -1 if a file was not readable.    
       #
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def load(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zhash_load(self_p, filename)
         result
       end

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Create a new callback of the following type:
       # Destroy an item
@@ -366,13 +373,12 @@ module CZMQ
       # comment lines as you like. These comment lines are discarded when loading
       # the file. If you use a null format, all comments are deleted.            
       #
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [void]
       def comment(format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        format = String(format)
         result = ::CZMQ::FFI.zhashx_comment(self_p, format, *args)
         result
       end
@@ -381,12 +387,11 @@ module CZMQ
       # printable strings; keys may not contain '=' character. Returns 0 if OK, 
       # else -1 if a file error occurred.                                       
       #
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def save(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zhashx_save(self_p, filename)
         result
       end
@@ -395,12 +400,11 @@ module CZMQ
       # already exist. Hash values must printable strings; keys may not contain
       # '=' character. Returns 0 if OK, else -1 if a file was not readable.    
       #
-      # @param filename [String, #to_str, #to_s]
+      # @param filename [String, #to_s, nil]
       # @return [Integer]
       def load(filename)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        filename = String(filename)
         result = ::CZMQ::FFI.zhashx_load(self_p, filename)
         result
       end

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Get a list of network interfaces currently defined on the system
       # @return [CZMQ::Ziflist]

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Create a new callback of the following type:
       # Comparison function e.g. for sorting and removing.

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Create a new callback of the following type:
       # Callback function for reactor socket activity

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

@@ -60,11 +60,18 @@ module CZMQ
         raise DestroyedError unless @ptr
         ptr_ptr = ::FFI::MemoryPointer.new :pointer
         ptr_ptr.write_pointer @ptr
-        ObjectSpace.undefine_finalizer self if @finalizer
-        @finalizer = nil
+        __undef_finalizer if @finalizer
         @ptr = nil
         ptr_ptr
       end
+      # Undefines the finalizer for this object.
+      # @note Only use this if you need to and can guarantee that the native
+      #   object will be freed by other means.
+      # @return [void]
+      def __undef_finalizer
+        ObjectSpace.undefine_finalizer self
+        @finalizer = nil
+      end
 
       # Create a new empty message object
       # @return [CZMQ::Zmsg]
@@ -272,12 +279,11 @@ module CZMQ
       # Push string as new frame to front of message.
       # Returns 0 on success, -1 on error.           
       #
-      # @param string [String, #to_str, #to_s]
+      # @param string [String, #to_s, nil]
       # @return [Integer]
       def pushstr(string)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        string = String(string)
         result = ::CZMQ::FFI.zmsg_pushstr(self_p, string)
         result
       end
@@ -285,12 +291,11 @@ module CZMQ
       # Push string as new frame to end of message.
       # Returns 0 on success, -1 on error.         
       #
-      # @param string [String, #to_str, #to_s]
+      # @param string [String, #to_s, nil]
       # @return [Integer]
       def addstr(string)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        string = String(string)
         result = ::CZMQ::FFI.zmsg_addstr(self_p, string)
         result
       end
@@ -298,13 +303,12 @@ module CZMQ
       # Push formatted string as new frame to front of message.
       # Returns 0 on success, -1 on error.                     
       #
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [Integer]
       def pushstrf(format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        format = String(format)
         result = ::CZMQ::FFI.zmsg_pushstrf(self_p, format, *args)
         result
       end
@@ -312,13 +316,12 @@ module CZMQ
       # Push formatted string as new frame to end of message.
       # Returns 0 on success, -1 on error.                   
       #
-      # @param format [String, #to_str, #to_s]
+      # @param format [String, #to_s, nil]
       # @param args [Array<Object>] see https://github.com/ffi/ffi/wiki/examples#using-varargs
       # @return [Integer]
       def addstrf(format, *args)
         raise DestroyedError unless @ptr
         self_p = @ptr
-        format = String(format)
         result = ::CZMQ::FFI.zmsg_addstrf(self_p, format, *args)
         result
       end