ffi 1.16.3 → 1.17.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5920bab18c2bfca946febdf9d31aae894569dd1a293d816631a077696f7db8fa
-  data.tar.gz: 7aa17dd90399d15bd149573ab4b9857907028beae4f84409f76f50e9508aaba2
+  metadata.gz: 5ea15fd47a8241bb9bab7086d46ac6bc6ac752c383dc748c616d298f742ed0d0
+  data.tar.gz: 5253f331c7fea5590f4499133cac83dbeba5d833825339f4fc45cb57f0c94bcd
 SHA512:
-  metadata.gz: dd42730736988cac47f45485f4a8b200c26759066fe156a89ef7736cd6ac80f404e8aaced28a8f10f9b22b43436ed3e248cb191f1c457ccabc19299b91b49174
-  data.tar.gz: '0252969e7a324d530c1d704e2d408f1bd7283f320de90b4c98f20bb49f9d32733ac45609d78a40f821cd5335e102e80576fd446cd5de863babea041d0eb3c780'
+  metadata.gz: e42a6fc177d1302b64a07b6b93a20bf9e0ad4e692a7ab2c16f1f5fbf65ce795fe044187befdcc5859ecb8f3870acac3ca3b687e5e96773f448d0b16e6a1d7710
+  data.tar.gz: 2efdb5b63defea13f90d5ec7a7f8c7fb85e3cab24fc84320c8e061017946687f0238a68a57375a4ce76aa67f041b6b65966170d4d98d5ed4cac4d1dbd3dc71df

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+1.17.0.rc1 / 2024-04-07
+-------------------
+
+Fixed:
+* Fix type definitions on `aarch64-linux`. #1067, #1066
+* Use RB_TEST for `Pointer.autorelease=` . #1065
+  So that `false` and `nil` are treated as falsey and anything else as truthy.
+* Replace Fixnum by Integer. #1064
+  Fixnum is no longer present in the ruby language.
+* Update `FFI::NativeType` doc. #1061
+* Store FFI::Type::Mapped of FFI::StrPtrConverter in global instead of custom type map
+* Various documentation fixes. #1042
+* Update `FFI::Pointer#==` to return `false` if a pointer is compared to a non-pointer object, which is the expected behavior. #1083
+* Avoid warning about undefined wariable `@ffi_functions` #1085
+* Fix a very unlikely GC bug when using a callback block. # 1089
+
+Added:
+* Provide binary gems for many platforms. #990
+* Add Windows fat binary gem for Ruby-3.3
+* Add RBS type definitions for many user facing parts of the FFI API. #1042
+* Improve fallback search path logic. #1088
+  Respect LD_LIBRARY_PATH and DYLD_LIBRARY_PATH on Macos.
+* Update libffi to current git master branch.
+
+Removed:
+* Remove `enum CHAR_ARRAY` which is no longer used. #1063
+
+
 1.16.3 / 2023-10-04
 -------------------
 

data/Gemfile

@@ -1,14 +1,21 @@
 source 'https://rubygems.org'
 
 group :development do
+  gem 'bigdecimal' unless RUBY_VERSION =~ /^2\.[4567]|^3\.[012]\./ # necessary on ruby-3.3+
+  gem 'bundler', '>= 1.16', '< 3'
   gem 'rake', '~> 13.0'
   gem 'rake-compiler', '~> 1.1'
-  gem 'rake-compiler-dock', '~> 1.0'
+  gem 'rake-compiler-dock', '~> 1.0.pre'
   gem 'rspec', '~> 3.0'
-  gem 'bundler', '>= 1.16', '< 3'
 end
 
 group :doc do
   gem 'kramdown'
   gem 'yard', '~> 0.9'
 end
+
+group :type_check do
+  if RUBY_VERSION >= "2.6" && %w[ ruby truffleruby ].include?(RUBY_ENGINE)
+    gem 'rbs', '~> 3.0'
+  end
+end

data/README.md

@@ -114,7 +114,7 @@ The following people have submitted code, bug reports, or otherwise contributed
 * Jurij Smakov <jurij@wooyd.org>
 * KISHIMOTO, Makoto <ksmakoto@dd.iij4u.or.jp>
 * Kim Burgestrand <kim@burgestrand.se>
-* Lars Kanis <kanis@comcard.de>
+* Lars Kanis <lars@greiz-reinsdorf.de>
 * Luc Heinrich <luc@honk-honk.com>
 * Luis Lavena <luislavena@gmail.com>
 * Matijs van Zuijlen <matijs@matijs.net>

data/Rakefile

@@ -13,7 +13,7 @@ BUILD_EXT_DIR = File.join(BUILD_DIR, "#{RbConfig::CONFIG['arch']}", 'ffi_c', RUB
 
 gem_spec = Bundler.load_gemspec('ffi.gemspec')
 
-RSpec::Core::RakeTask.new(:spec => :compile) do |config|
+RSpec::Core::RakeTask.new(:spec) do |config|
   config.rspec_opts = YAML.load_file 'spec/spec.opts'
 end
 
@@ -84,10 +84,22 @@ end
 task 'gem:java' => 'java:gem'
 
 FfiGemHelper.install_tasks
-# Register windows gems to be pushed to rubygems.org
-Bundler::GemHelper.instance.cross_platforms = %w[x86-mingw32 x64-mingw-ucrt x64-mingw32]
-# These platforms are not yet enabled, since there are issues on musl-based distors (alpine-linux):
-# + %w[x86-linux x86_64-linux arm-linux aarch64-linux x86_64-darwin arm64-darwin]
+# Register binary gems to be pushed to rubygems.org
+Bundler::GemHelper.instance.cross_platforms = %w[
+  x86-mingw32
+  x64-mingw-ucrt
+  x64-mingw32
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-linux-gnu
+  x86_64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  x86_64-darwin
+  arm64-darwin
+]
 
 if RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
   require 'rake/extensiontask'

data/ext/ffi_c/AbstractMemory.c

@@ -324,7 +324,7 @@ memory_clear(VALUE self)
 /*
  * call-seq: memory.size
  * Return memory size in bytes (alias: #total)
- * @return [Numeric]
+ * @return [Integer]
  */
 static VALUE
 memory_size(VALUE self)
@@ -340,7 +340,7 @@ memory_size(VALUE self)
  * call-seq: memory.get(type, offset)
  * Return data of given type contained in memory.
  * @param [Symbol, Type] type_name type of data to get
- * @param [Numeric] offset point in buffer to start from
+ * @param [Integer] offset point in buffer to start from
  * @return [Object]
  * @raise {ArgumentError} if type is not supported
  */
@@ -373,7 +373,7 @@ undefined_type: {
 /*
  * call-seq: memory.put(type, offset, value)
  * @param [Symbol, Type] type_name type of data to put
- * @param [Numeric] offset point in buffer to start from
+ * @param [Integer] offset point in buffer to start from
  * @return [nil]
  * @raise {ArgumentError} if type is not supported
  */
@@ -407,8 +407,8 @@ undefined_type: {
 /*
  * call-seq: memory.get_string(offset, length=nil)
  * Return string contained in memory.
- * @param [Numeric] offset point in buffer to start from
- * @param [Numeric] length string's length in bytes. If nil, a (memory size - offset) length string is returned).
+ * @param [Integer] offset point in buffer to start from
+ * @param [Integer] length string's length in bytes. If nil, a (memory size - offset) length string is returned).
  * @return [String]
  * @raise {IndexError} if +length+ is too great
  * @raise {NullPointerError} if memory not initialized
@@ -435,8 +435,8 @@ memory_get_string(int argc, VALUE* argv, VALUE self)
 /*
  * call-seq: memory.get_array_of_string(offset, count=nil)
  * Return an array of strings contained in memory.
- * @param [Numeric] offset point in memory to start from
- * @param [Numeric] count number of strings to get. If nil, return all strings
+ * @param [Integer] offset point in memory to start from
+ * @param [Integer] count number of strings to get. If nil, return all strings
  * @return [Array<String>]
  * @raise {IndexError} if +offset+ is too great
  * @raise {NullPointerError} if memory not initialized
@@ -485,7 +485,7 @@ memory_get_array_of_string(int argc, VALUE* argv, VALUE self)
  * call-seq: memory.read_array_of_string(count=nil)
  * Return an array of strings contained in memory. Same as:
  *  memory.get_array_of_string(0, count)
- * @param [Numeric] count number of strings to get. If nil, return all strings
+ * @param [Integer] count number of strings to get. If nil, return all strings
  * @return [Array<String>]
  */
 static VALUE
@@ -505,7 +505,7 @@ memory_read_array_of_string(int argc, VALUE* argv, VALUE self)
 
 /*
  * call-seq: memory.put_string(offset, str)
- * @param [Numeric] offset
+ * @param [Integer] offset
  * @param [String] str
  * @return [self]
  * @raise {SecurityError} when writing unsafe string to memory
@@ -535,8 +535,8 @@ memory_put_string(VALUE self, VALUE offset, VALUE str)
 /*
  * call-seq: memory.get_bytes(offset, length)
  * Return string contained in memory.
- * @param [Numeric] offset point in buffer to start from
- * @param [Numeric] length string's length in bytes.
+ * @param [Integer] offset point in buffer to start from
+ * @param [Integer] length string's length in bytes.
  * @return [String]
  * @raise {IndexError} if +length+ is too great
  * @raise {NullPointerError} if memory not initialized
@@ -559,10 +559,10 @@ memory_get_bytes(VALUE self, VALUE offset, VALUE length)
 /*
  * call-seq: memory.put_bytes(offset, str, index=0, length=nil)
  * Put a string in memory.
- * @param [Numeric] offset point in buffer to start from
+ * @param [Integer] offset point in buffer to start from
  * @param [String] str string to put to memory
- * @param [Numeric] index
- * @param [Numeric] length string's length in bytes. If nil, a (memory size - offset) length string is returned).
+ * @param [Integer] index
+ * @param [Integer] length string's length in bytes. If nil, a (memory size - offset) length string is returned).
  * @return [self]
  * @raise {IndexError} if +length+ is too great
  * @raise {NullPointerError} if memory not initialized
@@ -601,7 +601,7 @@ memory_put_bytes(int argc, VALUE* argv, VALUE self)
 
 /*
  * call-seq: memory.read_bytes(length)
- * @param [Numeric] length of string to return
+ * @param [Integer] length of string to return
  * @return [String]
  * equivalent to :
  *  memory.get_bytes(0, length)
@@ -615,8 +615,8 @@ memory_read_bytes(VALUE self, VALUE length)
 /*
  * call-seq: memory.write_bytes(str, index=0, length=nil)
  * @param [String] str string to put to memory
- * @param [Numeric] index
- * @param [Numeric] length string's length in bytes. If nil, a (memory size - offset) length string is returned).
+ * @param [Integer] index
+ * @param [Integer] length string's length in bytes. If nil, a (memory size - offset) length string is returned).
  * @return [self]
  * equivalent to :
  *  memory.put_bytes(0, str, index, length)
@@ -637,7 +637,7 @@ memory_write_bytes(int argc, VALUE* argv, VALUE self)
 
 /*
  * call-seq: memory.type_size
- * @return [Numeric] type size in bytes
+ * @return [Integer] type size in bytes
  * Get the memory's type size.
  */
 static VALUE
@@ -653,7 +653,7 @@ memory_type_size(VALUE self)
 /*
  * Document-method: []
  * call-seq: memory[idx]
- * @param [Numeric] idx index to access in memory
+ * @param [Integer] idx index to access in memory
  * @return
  * Memory read accessor.
  */
@@ -861,8 +861,8 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
 
     /*
      * Document-method: put_float32
-     * call-seq: memory.put_float32offset, value)
-     * @param [Numeric] offset
+     * call-seq: memory.put_float32(offset, value)
+     * @param [Integer] offset
      * @param [Numeric] value
      * @return [self]
      * Put +value+ as a 32-bit float in memory at offset +offset+ (alias: #put_float).
@@ -871,7 +871,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: get_float32
      * call-seq: memory.get_float32(offset)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @return [Float]
      * Get a 32-bit float from memory at offset +offset+ (alias: #get_float).
      */
@@ -902,7 +902,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: put_array_of_float32
      * call-seq: memory.put_array_of_float32(offset, ary)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @param [Array<Numeric>] ary
      * @return [self]
      * Put values from +ary+ as 32-bit floats in memory from offset +offset+ (alias: #put_array_of_float).
@@ -911,8 +911,8 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: get_array_of_float32
      * call-seq: memory.get_array_of_float32(offset, length)
-     * @param [Numeric] offset
-     * @param [Numeric] length number of Float to get
+     * @param [Integer] offset
+     * @param [Integer] length number of Float to get
      * @return [Array<Float>]
      * Get 32-bit floats in memory from offset +offset+ (alias: #get_array_of_float).
      */
@@ -931,7 +931,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: read_array_of_float
      * call-seq: memory.read_array_of_float(length)
-     * @param [Numeric] length number of Float to read
+     * @param [Integer] length number of Float to read
      * @return [Array<Float>]
      * Read 32-bit floats from memory.
      *
@@ -944,7 +944,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: put_float64
      * call-seq: memory.put_float64(offset, value)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @param [Numeric] value
      * @return [self]
      * Put +value+ as a 64-bit float (double) in memory at offset +offset+ (alias: #put_double).
@@ -953,7 +953,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: get_float64
      * call-seq: memory.get_float64(offset)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @return [Float]
      * Get a 64-bit float (double) from memory at offset +offset+ (alias: #get_double).
      */
@@ -984,7 +984,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: put_array_of_float64
      * call-seq: memory.put_array_of_float64(offset, ary)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @param [Array<Numeric>] ary
      * @return [self]
      * Put values from +ary+ as 64-bit floats (doubles) in memory from offset +offset+ (alias: #put_array_of_double).
@@ -993,8 +993,8 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: get_array_of_float64
      * call-seq: memory.get_array_of_float64(offset, length)
-     * @param [Numeric] offset
-     * @param [Numeric] length number of Float to get
+     * @param [Integer] offset
+     * @param [Integer] length number of Float to get
      * @return [Array<Float>]
      * Get 64-bit floats (doubles) in memory from offset +offset+ (alias: #get_array_of_double).
      */
@@ -1013,7 +1013,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: read_array_of_double
      * call-seq: memory.read_array_of_double(length)
-     * @param [Numeric] length number of Float to read
+     * @param [Integer] length number of Float to read
      * @return [Array<Float>]
      * Read 64-bit floats (doubles) from memory.
      *
@@ -1026,7 +1026,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: put_pointer
      * call-seq: memory.put_pointer(offset, value)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @param [nil,Pointer, Integer, #to_ptr] value
      * @return [self]
      * Put +value+ in memory from +offset+..
@@ -1035,7 +1035,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: get_pointer
      * call-seq: memory.get_pointer(offset)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @return [Pointer]
      * Get a {Pointer} to the memory from +offset+.
      */
@@ -1064,7 +1064,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: put_array_of_pointer
      * call-seq: memory.put_array_of_pointer(offset, ary)
-     * @param [Numeric] offset
+     * @param [Integer] offset
      * @param [Array<#to_ptr>] ary
      * @return [self]
      * Put an array of {Pointer} into memory from +offset+.
@@ -1073,8 +1073,8 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: get_array_of_pointer
      * call-seq: memory.get_array_of_pointer(offset, length)
-     * @param [Numeric] offset
-     * @param [Numeric] length
+     * @param [Integer] offset
+     * @param [Integer] length
      * @return [Array<Pointer>]
      * Get an array of {Pointer} of length +length+ from +offset+.
      */
@@ -1093,7 +1093,7 @@ rbffi_AbstractMemory_Init(VALUE moduleFFI)
     /*
      * Document-method: read_array_of_pointer
      * call-seq: memory.read_array_of_pointer(length)
-     * @param [Numeric] length
+     * @param [Integer] length
      * @return [Array<Pointer>]
      * Read an array of {Pointer} of length +length+.
      *

data/ext/ffi_c/ArrayType.c

@@ -110,7 +110,7 @@ array_type_memsize(const void *data)
 /*
  * call-seq: initialize(component_type, length)
  * @param [Type] component_type
- * @param [Numeric] length
+ * @param [Integer] length
  * @return [self]
  * A new instance of ArrayType.
  */
@@ -140,7 +140,7 @@ array_type_initialize(VALUE self, VALUE rbComponentType, VALUE rbLength)
 
 /*
  * call-seq: length
- * @return [Numeric]
+ * @return [Integer]
  * Get array's length
  */
 static VALUE

data/ext/ffi_c/Buffer.c

@@ -114,7 +114,7 @@ buffer_release(void *data)
 /*
  * call-seq: initialize(size, count=1, clear=false)
  * @param [Integer, Symbol, #size] Type or size in bytes of a buffer cell
- * @param [Fixnum] count number of cell in the Buffer
+ * @param [Integer] count number of cell in the Buffer
  * @param [Boolean] clear if true, set the buffer to all-zero
  * @return [self]
  * @raise {NoMemoryError} if failed to allocate memory for Buffer
@@ -219,7 +219,7 @@ slice(VALUE self, long offset, long len)
 
 /*
  * call-seq: + offset
- * @param [Numeric] offset
+ * @param [Integer] offset
  * @return [Buffer] a new instance of Buffer pointing from offset until end of previous buffer.
  * Add a Buffer with an offset
  */
@@ -236,8 +236,8 @@ buffer_plus(VALUE self, VALUE rbOffset)
 
 /*
  * call-seq: slice(offset, length)
- * @param [Numeric] offset
- * @param [Numeric] length
+ * @param [Integer] offset
+ * @param [Integer] length
  * @return [Buffer] a new instance of Buffer
  * Slice an existing Buffer.
  */

data/ext/ffi_c/Call.c

@@ -86,10 +86,11 @@ static inline void* getPointer(VALUE value, int type);
 
 static ID id_to_ptr, id_map_symbol, id_to_native;
 
-void
+VALUE
 rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, Type** paramTypes,
         FFIStorage* paramStorage, void** ffiValues,
-        VALUE* callbackParameters, int callbackCount, VALUE enums)
+        VALUE* callbackParameters, int callbackCount,
+        VALUE enums)
 {
     VALUE callbackProc = Qnil;
     FFIStorage* param = &paramStorage[0];
@@ -327,6 +328,7 @@ rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, Type** paramTypes,
                 rb_raise(rb_eArgError, "Invalid parameter type: %d", paramType->nativeType);
         }
     }
+    return callbackProc;
 }
 
 static void *
@@ -362,6 +364,7 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
     FFIStorage* params;
     VALUE rbReturnValue;
     rbffi_frame_t frame = { 0 };
+    VALUE callbackProc;
 
     retval = alloca(MAX(fnInfo->ffi_cif.rtype->size, FFI_SIZEOF_ARG));
 
@@ -379,9 +382,10 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
         bc->params = params;
         bc->frame = &frame;
 
-        rbffi_SetupCallParams(argc, argv,
+        callbackProc = rbffi_SetupCallParams(argc, argv,
             fnInfo->parameterCount, fnInfo->parameterTypes, params, ffiValues,
-            fnInfo->callbackParameters, fnInfo->callbackCount, fnInfo->rbEnums);
+            fnInfo->callbackParameters, fnInfo->callbackCount,
+            fnInfo->rbEnums);
 
         rbffi_frame_push(&frame);
         rb_rescue2(rbffi_do_blocking_call, (VALUE) bc, rbffi_save_frame_exception, (VALUE) &frame, rb_eException, (VALUE) 0);
@@ -392,14 +396,16 @@ rbffi_CallFunction(int argc, VALUE* argv, void* function, FunctionType* fnInfo)
         ffiValues = ALLOCA_N(void *, fnInfo->parameterCount);
         params = ALLOCA_N(FFIStorage, fnInfo->parameterCount);
 
-        rbffi_SetupCallParams(argc, argv,
+        callbackProc = rbffi_SetupCallParams(argc, argv,
             fnInfo->parameterCount, fnInfo->parameterTypes, params, ffiValues,
-            fnInfo->callbackParameters, fnInfo->callbackCount, fnInfo->rbEnums);
+            fnInfo->callbackParameters, fnInfo->callbackCount,
+            fnInfo->rbEnums);
 
         rbffi_frame_push(&frame);
         ffi_call(&fnInfo->ffi_cif, FFI_FN(function), retval, ffiValues);
         rbffi_frame_pop(&frame);
     }
+    RB_GC_GUARD(callbackProc);
 
     if (unlikely(!fnInfo->ignoreErrno)) {
         rbffi_save_errno();

data/ext/ffi_c/Call.h

@@ -73,9 +73,10 @@ typedef union {
 
 extern void rbffi_Call_Init(VALUE moduleFFI);
 
-extern void rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, Type** paramTypes,
+extern VALUE rbffi_SetupCallParams(int argc, VALUE* argv, int paramCount, Type** paramTypes,
         FFIStorage* paramStorage, void** ffiValues,
-        VALUE* callbackParameters, int callbackCount, VALUE enums);
+        VALUE* callbackParameters, int callbackCount,
+        VALUE enums);
 
 struct FunctionType_;
 extern VALUE rbffi_CallFunction(int argc, VALUE* argv, void* function, struct FunctionType_* fnInfo);

data/ext/ffi_c/DynamicLibrary.c

@@ -128,7 +128,7 @@ library_open(VALUE klass, VALUE libname, VALUE libflags)
 /*
  * call-seq: initialize(libname, libflags)
  * @param [String] libname name of library to open
- * @param [Fixnum] libflags flags for library to open
+ * @param [Integer] libflags flags for library to open
  * @return [FFI::DynamicLibrary]
  * @raise {LoadError} if +libname+ cannot be opened
  * A new DynamicLibrary instance.
@@ -232,7 +232,7 @@ dl_error(char* buf, int size)
 
     // Get the associated message
     LPSTR message = NULL;
-    FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER, 
+    FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_ALLOCATE_BUFFER,
                    NULL, error, 0, (LPSTR)&message, 0, NULL);
 
     // Update the passed in buffer

data/ext/ffi_c/LastError.c

@@ -141,7 +141,7 @@ thread_data_get(void)
 
 /*
  * call-seq: error
- * @return [Numeric]
+ * @return [Integer]
  * Get +errno+ value.
  */
 static VALUE
@@ -153,7 +153,7 @@ get_last_error(VALUE self)
 #if defined(_WIN32) || defined(__CYGWIN__)
 /*
  * call-seq: winapi_error
- * @return [Numeric]
+ * @return [Integer]
  * Get +GetLastError()+ value. Only Windows or Cygwin.
  */
 static VALUE
@@ -166,7 +166,7 @@ get_last_winapi_error(VALUE self)
 
 /*
  * call-seq: error(error)
- * @param [Numeric] error
+ * @param [Integer] error
  * @return [nil]
  * Set +errno+ value.
  */
@@ -185,7 +185,7 @@ set_last_error(VALUE self, VALUE error)
 #if defined(_WIN32) || defined(__CYGWIN__)
 /*
  * call-seq: error(error)
- * @param [Numeric] error
+ * @param [Integer] error
  * @return [nil]
  * Set +GetLastError()+ value. Only on Windows and Cygwin.
  */

data/ext/ffi_c/MemoryPointer.c

@@ -80,8 +80,8 @@ memptr_allocate(VALUE klass)
 
 /*
  * call-seq: initialize(size, count=1, clear=true)
- * @param [Fixnum, Bignum, Symbol, FFI::Type] size size of a memory cell (in bytes, or type whom size will be used)
- * @param [Numeric] count number of cells in memory
+ * @param [Integer, Symbol, FFI::Type] size size of a memory cell (in bytes, or type whom size will be used)
+ * @param [Integer] count number of cells in memory
  * @param [Boolean] clear set memory to all-zero if +true+
  * @return [self]
  * A new instance of FFI::MemoryPointer.

data/ext/ffi_c/Pointer.c

@@ -95,12 +95,10 @@ ptr_allocate(VALUE klass)
 }
 
 /*
- * @overload initialize(pointer)
- *  @param [Pointer] pointer another pointer to initialize from
- *  Create a new pointer from another {Pointer}.
+ * @overload initialize(address)
  * @overload initialize(type, address)
- *  @param [Type] type type for pointer
- *  @param [Integer] address base address for pointer
+ *  @param [Type] type Optional type for pointer (defaults to byte)
+ *  @param [Pointer, Integer] address base address for pointer
  *  Create a new pointer from a {Type} and a base address
  * @return [self]
  * A new instance of Pointer.
@@ -229,7 +227,7 @@ slice(VALUE self, long offset, long size)
 /*
  * Document-method: +
  * call-seq: ptr + offset
- * @param [Numeric] offset
+ * @param [Integer] offset
  * @return [Pointer]
  * Return a new {Pointer} from an existing pointer and an +offset+.
  */
@@ -246,8 +244,8 @@ ptr_plus(VALUE self, VALUE offset)
 
 /*
  * call-seq: ptr.slice(offset, length)
- * @param [Numeric] offset
- * @param [Numeric] length
+ * @param [Integer] offset
+ * @param [Integer] length
  * @return [Pointer]
  * Return a new {Pointer} from an existing one. This pointer points on same contents
  * from +offset+ for a length +length+.
@@ -314,12 +312,17 @@ ptr_equals(VALUE self, VALUE other)
         return ptr->memory.address == NULL ? Qtrue : Qfalse;
     }
 
-    return ptr->memory.address == POINTER(other)->address ? Qtrue : Qfalse;
+    if (!rb_obj_is_kind_of(other, rbffi_PointerClass)) {
+        return Qfalse;
+    }
+    else {
+        return ptr->memory.address == POINTER(other)->address ? Qtrue : Qfalse;
+    }
 }
 
 /*
  * call-seq: ptr.address
- * @return [Numeric] pointer's base address
+ * @return [Integer] pointer's base address
  * Return +self+'s base address (alias: #to_i).
  */
 static VALUE
@@ -440,7 +443,7 @@ ptr_autorelease(VALUE self, VALUE autorelease)
 
     rb_check_frozen(self);
     TypedData_Get_Struct(self, Pointer, &rbffi_pointer_data_type, ptr);
-    ptr->autorelease = autorelease == Qtrue;
+    ptr->autorelease = RB_TEST(autorelease);
 
     return autorelease;
 }