ffi 1.11.1 → 1.15.5

data/lib/ffi/pointer.rb

@@ -31,21 +31,28 @@
 #
 
 require 'ffi/platform'
+
+# NOTE: all method definitions in this file are conditional on
+# whether they are not already defined. This is needed because
+# some Ruby implementations (e.g., TruffleRuby) might already
+# provide these methods due to using FFI internally, and we
+# should not override them to avoid warnings.
+
 module FFI
   class Pointer
 
     # Pointer size
-    SIZE = Platform::ADDRESS_SIZE / 8
+    SIZE = Platform::ADDRESS_SIZE / 8 unless const_defined?(:SIZE)
 
     # Return the size of a pointer on the current platform, in bytes
     # @return [Numeric]
     def self.size
       SIZE
-    end
+    end unless respond_to?(:size)
 
     # @param [nil,Numeric] len length of string to return
     # @return [String]
-    # Read pointer's contents as a string, or the first +len+ bytes of the 
+    # Read pointer's contents as a string, or the first +len+ bytes of the
     # equivalent string if +len+ is not +nil+.
     def read_string(len=nil)
       if len
@@ -54,7 +61,7 @@ module FFI
       else
         get_string(0)
       end
-    end
+    end unless method_defined?(:read_string)
 
     # @param [Numeric] len length of string to return
     # @return [String]
@@ -64,7 +71,7 @@ module FFI
     #  ptr.read_string(len)  # with len not nil
     def read_string_length(len)
       get_bytes(0, len)
-    end
+    end unless method_defined?(:read_string_length)
 
     # @return [String]
     # Read pointer's contents as a string.
@@ -73,7 +80,7 @@ module FFI
     #  ptr.read_string  # with no len
     def read_string_to_null
       get_string(0)
-    end
+    end unless method_defined?(:read_string_to_null)
 
     # @param [String] str string to write
     # @param [Numeric] len length of string to return
@@ -84,18 +91,18 @@ module FFI
     #  ptr.write_string(str, len)   # with len not nil
     def write_string_length(str, len)
       put_bytes(0, str, 0, len)
-    end
+    end unless method_defined?(:write_string_length)
 
     # @param [String] str string to write
     # @param [Numeric] len length of string to return
     # @return [self]
-    # Write +str+ in pointer's contents, or first +len+ bytes if 
+    # Write +str+ in pointer's contents, or first +len+ bytes if
     # +len+ is not +nil+.
     def write_string(str, len=nil)
       len = str.bytesize unless len
       # Write the string data without NUL termination
       put_bytes(0, str, 0, len)
-    end
+    end unless method_defined?(:write_string)
 
     # @param [Type] type type of data to read from pointer's contents
     # @param [Symbol] reader method to send to +self+ to read +type+
@@ -113,7 +120,7 @@ module FFI
         tmp += size unless j == length-1 # avoid OOB
       }
       ary
-    end
+    end unless method_defined?(:read_array_of_type)
 
     # @param [Type] type type of data to write to pointer's contents
     # @param [Symbol] writer method to send to +self+ to write +type+
@@ -129,12 +136,12 @@ module FFI
         self.send(writer, i * size, val)
       }
       self
-    end
+    end unless method_defined?(:write_array_of_type)
 
     # @return [self]
     def to_ptr
       self
-    end
+    end unless method_defined?(:to_ptr)
 
     # @param [Symbol,Type] type of data to read
     # @return [Object]
@@ -144,7 +151,7 @@ module FFI
     #  ptr.get(type, 0)
     def read(type)
       get(type, 0)
-    end
+    end unless method_defined?(:read)
 
     # @param [Symbol,Type] type of data to read
     # @param [Object] value to write
@@ -155,6 +162,6 @@ module FFI
     #  ptr.put(type, 0)
     def write(type, value)
       put(type, 0, value)
-    end
+    end unless method_defined?(:write)
   end
 end

data/lib/ffi/struct.rb

@@ -190,7 +190,7 @@ module FFI
       #             :field2, :pointer, 6,  # set offset to 6 for this field
       #             :field3, :string
       #    end
-      #  @example Creating a layout from a hash +spec+ (Ruby 1.9 only)
+      #  @example Creating a layout from a hash +spec+
       #    class MyStructFromHash < Struct
       #      layout :field1 => :int,
       #             :field2 => :pointer,
@@ -202,9 +202,8 @@ module FFI
       #             :function2, callback([:pointer], :void),
       #             :field3, :string
       #    end
-      #  @note Creating a layout from a hash +spec+ is supported only for Ruby 1.9.
       def layout(*spec)
-        #raise RuntimeError, "struct layout already defined for #{self.inspect}" if defined?(@layout)
+        warn "[DEPRECATION] Struct layout is already defined for class #{self.inspect}. Redefinition as in #{caller[0]} will be disallowed in ffi-2.0." if defined?(@layout)
         return @layout if spec.size == 0
 
         builder = StructLayoutBuilder.new
@@ -229,7 +228,11 @@ module FFI
 
       def callback(params, ret)
         mod = enclosing_module
-        FFI::CallbackInfo.new(find_type(ret, mod), params.map { |e| find_type(e, mod) })
+        ret_type = find_type(ret, mod)
+        if ret_type == Type::STRING
+          raise TypeError, ":string is not allowed as return type of callbacks"
+        end
+        FFI::CallbackInfo.new(ret_type, params.map { |e| find_type(e, mod) })
       end
 
       def packed(packed = 1)
@@ -245,7 +248,9 @@ module FFI
       def enclosing_module
         begin
           mod = self.name.split("::")[0..-2].inject(Object) { |obj, c| obj.const_get(c) }
-          (mod < FFI::Library || mod < FFI::Struct || mod.respond_to?(:find_type)) ? mod : nil
+          if mod.respond_to?(:find_type) && (mod.is_a?(FFI::Library) || mod < FFI::Struct)
+            mod
+          end
         rescue Exception
           nil
         end

data/lib/ffi/tools/const_generator.rb

@@ -105,9 +105,10 @@ module FFI
     # @return [nil]
     # @raise if a constant is missing and +:required+ was set to +true+ (see {#initialize})
     def calculate(options = {})
-      binary = File.join Dir.tmpdir, "rb_const_gen_bin_#{Process.pid}"
+      binary_path = nil
 
       Tempfile.open("#{@prefix}.const_generator") do |f|
+        binary_path = f.path + ".bin"
         @includes.each do |inc|
           f.puts "#include <#{inc}>"
         end
@@ -124,7 +125,8 @@ module FFI
         f.puts "\n\treturn 0;\n}"
         f.flush
 
-        output = `gcc #{options[:cppflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary} 2>&1`
+        cc = ENV['CC'] || 'gcc'
+        output = `#{cc} #{options[:cppflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary_path} 2>&1`
 
         unless $?.success? then
           output = output.split("\n").map { |l| "\t#{l}" }.join "\n"
@@ -132,8 +134,8 @@ module FFI
         end
       end
 
-      output = `#{binary}`
-      File.unlink(binary + (FFI::Platform.windows? ? ".exe" : ""))
+      output = `#{binary_path}`
+      File.unlink(binary_path + (FFI::Platform.windows? ? ".exe" : ""))
       output.each_line do |line|
         line =~ /^(\S+)\s(.*)$/
         const = @constants[$1]

data/lib/ffi/tools/struct_generator.rb

@@ -82,7 +82,8 @@ module FFI
         f.puts "\n  return 0;\n}"
         f.flush
 
-        output = `gcc #{options[:cppflags]} #{options[:cflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary} 2>&1`
+        cc = ENV['CC'] || 'gcc'
+        output = `#{cc} #{options[:cppflags]} #{options[:cflags]} -D_DARWIN_USE_64_BIT_INODE -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64 -x c -Wall -Werror #{f.path} -o #{binary} 2>&1`
 
         unless $?.success? then
           @found = false

data/lib/ffi/tools/types_generator.rb

@@ -47,9 +47,12 @@ module FFI
       typedefs = nil
       Tempfile.open 'ffi_types_generator' do |io|
         io.puts <<-C
+#include <stdint.h>
+#include <stddef.h>
 #include <sys/types.h>
 #if !(defined(WIN32))
 #include <sys/socket.h>
+#include <netinet/in.h>
 #include <sys/resource.h>
 #endif
         C
@@ -66,7 +69,7 @@ module FFI
         end
       end
 
-      code = ""
+      code = []
 
       typedefs.each_line do |type|
         # We only care about single line typedef
@@ -116,18 +119,18 @@ module FFI
         end
 
         if type = TYPE_MAP[def_type]
-          code << "rbx.platform.typedef.#{final_type} = #{type}\n"
+          code << "rbx.platform.typedef.#{final_type} = #{type}"
           TYPE_MAP[final_type] = TYPE_MAP[def_type]
         else
           # Fallback to an ordinary pointer if we don't know the type
           if def_type =~ /\*/
-            code << "rbx.platform.typedef.#{final_type} = pointer\n"
+            code << "rbx.platform.typedef.#{final_type} = pointer"
             TYPE_MAP[final_type] = :pointer
           end
         end
       end
 
-      code
+      code.sort.join("\n")
     end
   end
 end

data/lib/ffi/variadic.rb

@@ -31,16 +31,7 @@
 #
 
 module FFI
-  class VariadicInvoker    
-    def init(arg_types, type_map)
-      @fixed = Array.new
-      @type_map = type_map
-      arg_types.each_with_index do |type, i|
-        @fixed << type unless type == Type::VARARGS
-      end
-    end
-
-
+  class VariadicInvoker
     def call(*args, &block)
       param_types = Array.new(@fixed)
       param_values = Array.new

data/lib/ffi/version.rb

@@ -1,3 +1,3 @@
 module FFI
-  VERSION = '1.11.1'
+  VERSION = '1.15.5'
 end

data/lib/ffi.rb

@@ -1,5 +1,4 @@
-if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
-  Object.send(:remove_const, :FFI) if defined?(::FFI)
+if RUBY_ENGINE == 'ruby'
   begin
     require RUBY_VERSION.split('.')[0, 2].join('.') + '/ffi_c'
   rescue Exception
@@ -8,7 +7,15 @@ if !defined?(RUBY_ENGINE) || RUBY_ENGINE == 'ruby' || RUBY_ENGINE == 'rbx'
 
   require 'ffi/ffi'
 
-elsif defined?(RUBY_ENGINE)
+elsif RUBY_ENGINE == 'jruby' && (RUBY_ENGINE_VERSION.split('.').map(&:to_i) <=> [9, 2, 20]) >= 0
+  JRuby::Util.load_ext("org.jruby.ext.ffi.FFIService")
+  require 'ffi/ffi'
+
+elsif RUBY_ENGINE == 'truffleruby' && (RUBY_ENGINE_VERSION.split('.').map(&:to_i) <=> [20, 1, 0]) >= 0
+  require 'truffleruby/ffi_backend'
+  require 'ffi/ffi'
+
+else
   # Remove the ffi gem dir from the load path, then reload the internal ffi implementation
   $LOAD_PATH.delete(File.dirname(__FILE__))
   $LOAD_PATH.delete(File.join(File.dirname(__FILE__), 'ffi'))

data/rakelib/ffi_gem_helper.rb

@@ -0,0 +1,65 @@
+require 'bundler'
+require 'bundler/gem_helper'
+
+class FfiGemHelper < Bundler::GemHelper
+  attr_accessor :cross_platforms
+
+  def install
+    super
+
+    task "release:guard_clean" => ["release:update_history"]
+
+    task "release:update_history" do
+      update_history
+    end
+
+    task "release:rubygem_push" => ["gem:native", "gem:java"]
+  end
+
+  def hfile
+    "CHANGELOG.md"
+  end
+
+  def headline
+    '([^\w]*)(\d+\.\d+\.\d+(?:\.\w+)?)([^\w]+)([2Y][0Y][0-9Y][0-9Y]-[0-1M][0-9M]-[0-3D][0-9D])([^\w]*|$)'
+  end
+
+  def reldate
+    Time.now.strftime("%Y-%m-%d")
+  end
+
+  def update_history
+    hin = File.read(hfile)
+    hout = hin.sub(/#{headline}/) do
+      raise "#{hfile} isn't up-to-date for version #{version}" unless $2==version.to_s
+      $1 + $2 + $3 + reldate + $5
+    end
+    if hout != hin
+      Bundler.ui.confirm "Updating #{hfile} for release."
+      File.write(hfile, hout)
+      Rake::FileUtilsExt.sh "git", "commit", hfile, "-m", "Update release date in #{hfile}"
+    end
+  end
+
+  def tag_version
+    Bundler.ui.confirm "Tag release with annotation:"
+    m = File.read(hfile).match(/(?<annotation>#{headline}.*?)#{headline}/m) || raise("Unable to find release notes in #{hfile}")
+    Bundler.ui.info(m[:annotation].gsub(/^/, "    "))
+    IO.popen(["git", "tag", "--file=-", version_tag], "w") do |fd|
+      fd.write m[:annotation]
+    end
+    yield if block_given?
+  rescue
+    Bundler.ui.error "Untagging #{version_tag} due to error."
+    sh_with_code "git tag -d #{version_tag}"
+    raise
+  end
+
+  def rubygem_push(path)
+    cross_platforms.each do |ruby_platform|
+      super(path.gsub(/\.gem\z/, "-#{ruby_platform}.gem"))
+    end
+    super(path.gsub(/\.gem\z/, "-java.gem"))
+    super(path)
+  end
+end

data/samples/getlogin.rb

@@ -1,5 +1,5 @@
-require 'rubygems'
 require 'ffi'
+
 module Foo
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/samples/getpid.rb

@@ -1,5 +1,5 @@
-require 'rubygems'
 require 'ffi'
+
 module Foo
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/samples/gettimeofday.rb

@@ -1,16 +1,16 @@
-require 'rubygems'
 require 'ffi'
+require 'rbconfig'
+
 class Timeval < FFI::Struct
-  rb_maj, rb_min, rb_micro = RUBY_VERSION.split('.')
-  if rb_maj.to_i >= 1 && rb_min.to_i >= 9 || RUBY_PLATFORM =~ /java/
-    layout :tv_sec => :ulong, :tv_usec => :ulong
-  else
-    layout :tv_sec, :ulong, 0, :tv_usec, :ulong, 4
-  end
+  layout tv_sec: :ulong, tv_usec: :ulong
 end
 module LibC
   extend FFI::Library
-  ffi_lib FFI::Library::LIBC
+  if FFI::Platform.windows?
+    ffi_lib RbConfig::CONFIG["LIBRUBY_SO"]
+  else
+    ffi_lib FFI::Library::LIBC
+  end
   attach_function :gettimeofday, [ :pointer, :pointer ], :int
 end
 t = Timeval.new

data/samples/hello.rb

@@ -1,4 +1,5 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "sample_helper"))
+require 'ffi'
+
 module Foo
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/samples/inotify.rb

@@ -1,5 +1,5 @@
-require 'rubygems'
 require 'ffi'
+
 module Inotify
   extend FFI::Library
   ffi_lib FFI::Library::LIBC

data/samples/pty.rb

@@ -1,6 +1,5 @@
 require 'ffi'
 
-
 module PTY
   private
   module LibC
@@ -41,7 +40,7 @@ module PTY
     #
     exec_cmd, exec_args = build_args(args)
     pid = LibC.forkpty(mfdp, name, nil, nil)
-    raise "forkpty failed: #{LibC.strerror(FFI.errno)}" if pid < 0    
+    raise "forkpty failed: #{LibC.strerror(FFI.errno)}" if pid < 0
     if pid == 0
       LibC.execvp(exec_cmd, exec_args)
       exit 1

data/samples/qsort.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'ffi'
 
 module LibC