ffi 0.3.1 → 0.4.0

data/lib/ffi/struct.rb

@@ -1,5 +1,6 @@
 require 'ffi/platform'
 module FFI
+
   class StructLayout
     attr_reader :size, :align
 
@@ -13,6 +14,7 @@ module FFI
       @fields[field_name].offset
     end
   end
+
   class StructLayoutBuilder
     class Field
       def size
@@ -31,6 +33,7 @@ module FFI
         const_get(:ALIGN)
       end
     end
+
     def self.struct_field_class_from(type)
       klass_name = type.name.split('::').last
       code = <<-code
@@ -39,7 +42,7 @@ module FFI
           class << self
             attr_reader :info
             def size
-              #{type.size} * 8
+              #{type.size}
             end
             def align
               #{type.align}
@@ -53,6 +56,7 @@ module FFI
       code
       self.module_eval(code)
     end
+
     def self.array_field_class_from(type, num)
       klass_name = type.name.split('::').last
       code = <<-code
@@ -80,22 +84,32 @@ module FFI
       code
       self.module_eval(code)
     end
+
     class CallbackField < Field
-      def self.size; Platform::ADDRESS_SIZE; end
-      def self.align; Platform::ADDRESS_ALIGN; end
+      def self.size
+        FFI::Type::POINTER.size
+      end
+
+      def self.align
+        FFI::Type::POINTER.alignment
+      end
+
       def put(ptr, proc)
         ptr.put_callback(@off, proc, @info)
       end
+
       def get(ptr)
         raise ArgumentError, "Cannot get callback fields"
       end
     end
+
     def initialize
       @field_names = []
       @fields = {}
       @size = 0
       @min_align = 1
     end
+
     def native_field_class_from(type)
       case type
       when :char, NativeType::INT8
@@ -128,15 +142,19 @@ module FFI
         StringField
       end
     end
+
     def callback_field_class_from(type)
       return CallbackField, type if type.is_a?(FFI::CallbackInfo)
     end
+
     def struct_field_class_from(type)
       self.class.struct_field_class_from(type) if type.is_a?(Class) and type < FFI::Struct
     end
+
     def array_field_class_from(type)
       self.class.array_field_class_from(field_class_from(type[0]), type[1]) if type.is_a?(Array)
     end
+
     def field_class_from(type)
       field_class = native_field_class_from(type) ||
         callback_field_class_from(type) ||
@@ -144,24 +162,24 @@ module FFI
         struct_field_class_from(type)
       field_class or raise ArgumentError, "Unknown type: #{type}"
     end
+
     def add_field(name, type, offset = nil)
       field_class, info = field_class_from(type)
       off = calc_alignment_of(field_class, offset)
-      calc_current_size(off, field_class.size / 8)
+      calc_current_size(off, field_class.size)
       @field_names << name
       @fields[name] = field_class.new(off, info)
       @min_align = field_class.align if field_class.align > @min_align
     end
+
     def build
-      align = @min_align / 8
-      StructLayout.new @field_names, @fields, align + ((@size - 1) & ~(align - 1)), @min_align
+      StructLayout.new(@field_names, @fields, align(@size, @min_align), @min_align)
     end
-    def align(offset, bits)
-      bytes = bits / 8
-      mask = bytes - 1;
-      off = offset;
-      ((off & mask) != 0) ? (off & ~mask) + bytes : off
+
+    def align(offset, align)
+      align + ((offset - 1) & ~(align - 1))
     end
+
     private
     def calc_alignment_of(field_class, offset)
       offset ? offset.to_i : align(@size, field_class.align)
@@ -170,81 +188,112 @@ module FFI
       @size = offset + size
     end
   end
+
   class Struct
     class Array
       include Enumerable
+
       def initialize(ptr, type, num)
         @pointer, @type, @num = ptr, type, num
       end
-      def to_ptr 
+
+      def to_ptr
         @pointer 
       end
+
       def to_a
         get_array_data(@pointer)
       end
+
       def size
-        @num * @type.size / 8
+        @num * @type.size
       end
+
       def each(&blk)
         to_a.each(&blk)
       end
+
       private
       def get_array_data(ptr)
         (0..@num - 1).inject([]) do |array, index| 
-          array << @type.new(0).get(ptr + index * @type.size / 8)
+          array << @type.new(0).get(ptr + index * @type.size)
         end
       end
     end
+
     def self.size
       @size
     end
+
     def self.members
       @layout.members
     end
+
     def self.align
       @layout.align
     end
+
     def self.offsets
       @layout.offsets
     end
+
     def self.offset_of(field_name)
       @layout.offset_of(field_name)
     end
+
     def size
       self.class.size
     end
+
     def align
       self.class.align
     end
+
     def members
       layout.members
     end
+
     def values
       layout.members.map { |m| self[m] }
     end
     def offsets
       self.class.offsets
     end
+
     def offset_of(field_name)
       self.class.offset_of(field_name)
     end
+
     def clear
       pointer.clear
       self
     end
+
     def to_ptr
       pointer
     end
+
     def self.in
       :buffer_in
     end
+
     def self.out
       :buffer_out
     end
+
+    protected
+
+    def self.callback(params, ret)
+      mod = enclosing_module
+      FFI::CallbackInfo.new(find_type(ret, mod), params.map { |e| find_type(e, mod) })
+    end
+
     private
+
     def self.builder
       StructLayoutBuilder.new
     end
+
     def self.enclosing_module
       begin
         mod = self.name.split("::")[0..-2].inject(Object) { |obj, c| obj.const_get(c) }
@@ -253,13 +302,16 @@ module FFI
         nil
       end
     end
+
     def self.is_a_struct?(type)
       type.is_a?(Class) and type < Struct
     end
+
     def self.find_type(type, mod = nil)
       return type if is_a_struct?(type) or type.is_a?(::Array)
       mod ? mod.find_type(type) : FFI.find_type(type)
     end
+
     def self.hash_layout(spec)
       raise "Ruby version not supported" if RUBY_VERSION =~ /1.8.*/
       builder = self.builder
@@ -269,6 +321,7 @@ module FFI
       end
       builder.build
     end
+
     def self.array_layout(spec)
       builder = self.builder
       mod = enclosing_module
@@ -288,6 +341,7 @@ module FFI
       end
       builder.build
     end
+
     public
     def self.layout(*spec)
       return @layout if spec.size == 0

data/lib/ffi/types.rb

@@ -1,7 +1,7 @@
 module FFI
 #  TypeDefs = Hash.new
   def self.add_typedef(current, add)
-    if current.kind_of? Integer
+    if current.kind_of?(FFI::Type)
       code = current
     else
       code = TypeDefs[current]
@@ -13,8 +13,7 @@ module FFI
   def self.find_type(name, type_map = nil)
     type_map = TypeDefs if type_map.nil?
     code = type_map[name]
-    code = name if !code && name.kind_of?(Integer)
-    code = name if !code && name.kind_of?(FFI::CallbackInfo)
+    code = name if !code && name.kind_of?(FFI::Type)
     raise TypeError, "Unable to resolve type '#{name}'" unless code
     return code
   end
@@ -92,7 +91,11 @@ module FFI
   add_typedef(NativeType::BUFFER_IN, :buffer_in)
   add_typedef(NativeType::BUFFER_OUT, :buffer_out)
   add_typedef(NativeType::BUFFER_INOUT, :buffer_inout)
+
   add_typedef(NativeType::VARARGS, :varargs)
+  
+  add_typedef(NativeType::ENUM, :enum)
+  add_typedef(NativeType::BOOL, :bool)
 
   # Use for a C struct with a char [] embedded inside.
   add_typedef(NativeType::CHAR_ARRAY, :char_array)

data/lib/ffi/variadic.rb

@@ -1,7 +1,7 @@
 module FFI
   class VariadicInvoker
-    def VariadicInvoker.new(library, function, arg_types, ret_type, options)
-      invoker = self.__new(library, function, ret_type, options[:convention].to_s)
+    def VariadicInvoker.new(function, arg_types, rb_ret_type, ret_type, options)
+      invoker = self.__new(function, rb_ret_type, ret_type, options[:convention].to_s, options[:enums])
       invoker.init(arg_types, options[:type_map])
       invoker
     end

data/lib/ffi.rb

@@ -1,2 +1,11 @@
-require 'ffi_c'
+begin
+  if RUBY_VERSION =~ /1.8/
+    require '1.8/ffi_c'
+  elsif RUBY_VERSION =~ /1.9/
+    require '1.9/ffi_c'
+  end
+rescue Exception
+  require 'ffi_c'
+end
+
 require 'ffi/ffi'

data/spec/ffi/bool_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+describe "Function with primitive boolean arguments and return values" do
+  module LibTest
+    extend FFI::Library
+    ffi_lib TestLibrary::PATH
+    attach_function :bool_return_true, [ ], :bool
+    attach_function :bool_return_false, [ ], :bool
+    attach_function :bool_return_val, [ :bool ], :bool
+    attach_function :bool_reverse_val, [ :bool ], :bool
+  end
+  it "bools" do
+    LibTest.bool_return_true.should == true
+    LibTest.bool_return_false.should == false
+
+    LibTest.bool_return_val(true).should == true
+    LibTest.bool_return_val(false).should == false
+
+    LibTest.bool_reverse_val(true).should == false
+    LibTest.bool_reverse_val(false).should == true
+  end
+  it "raise error on invalid types" do
+    lambda { LibTest.bool_return_val(nil) }.should raise_error(::TypeError)
+  end
+end

data/spec/ffi/callback_spec.rb

@@ -37,21 +37,30 @@ describe "Callback" do
     callback :cbVrU16, [ ], :ushort
     callback :cbVrS32, [ ], :int
     callback :cbVrU32, [ ], :uint
+    callback :cbVrL, [ ], :long
+    callback :cbVrUL, [ ], :ulong
     callback :cbVrS64, [ ], :long_long
     callback :cbVrU64, [ ], :ulong_long
     callback :cbVrP, [], :pointer
+    callback :cbVrZ, [], :bool
     callback :cbCrV, [ :char ], :void
     callback :cbSrV, [ :short ], :void
     callback :cbIrV, [ :int ], :void
+    callback :cbLrV, [ :long ], :void
+    callback :cbULrV, [ :ulong ], :void
     callback :cbLrV, [ :long_long ], :void
+
     attach_function :testCallbackVrS8, :testClosureVrB, [ :cbVrS8 ], :char
     attach_function :testCallbackVrU8, :testClosureVrB, [ :cbVrU8 ], :uchar
     attach_function :testCallbackVrS16, :testClosureVrS, [ :cbVrS16 ], :short
     attach_function :testCallbackVrU16, :testClosureVrS, [ :cbVrU16 ], :ushort
     attach_function :testCallbackVrS32, :testClosureVrI, [ :cbVrS32 ], :int
     attach_function :testCallbackVrU32, :testClosureVrI, [ :cbVrU32 ], :uint
-    attach_function :testCallbackVrS64, :testClosureVrL, [ :cbVrS64 ], :long_long
-    attach_function :testCallbackVrU64, :testClosureVrL, [ :cbVrU64 ], :ulong_long
+    attach_function :testCallbackVrL, :testClosureVrL, [ :cbVrL ], :long
+    attach_function :testCallbackVrZ, :testClosureVrZ, [ :cbVrZ ], :bool
+    attach_function :testCallbackVrUL, :testClosureVrL, [ :cbVrUL ], :ulong
+    attach_function :testCallbackVrS64, :testClosureVrLL, [ :cbVrS64 ], :long_long
+    attach_function :testCallbackVrU64, :testClosureVrLL, [ :cbVrU64 ], :ulong_long
     attach_function :testCallbackVrP, :testClosureVrP, [ :cbVrP ], :pointer
     attach_function :testCallbackCrV, :testClosureBrV, [ :cbCrV, :char ], :void
     attach_variable :cbVrS8, :gvar_pointer, :cbVrS8
@@ -122,7 +131,6 @@ describe "Callback" do
   it "returning :ushort (-1)" do
     LibTest.testCallbackVrU16 { -1 }.should == 0xffff
   end
-
   it "returning :int (0)" do
     LibTest.testCallbackVrS32 { 0 }.should == 0
   end
@@ -136,7 +144,6 @@ describe "Callback" do
   it "returning :int (-1)" do
     LibTest.testCallbackVrS32 { -1 }.should == -1
   end
-
   it "returning :uint (0)" do
     LibTest.testCallbackVrU32 { 0 }.should == 0
   end
@@ -153,7 +160,39 @@ describe "Callback" do
   it "Callback returning :uint (-1)" do
     LibTest.testCallbackVrU32 { -1 }.should == 0xffffffff
   end
-
+  it "returning :long (0)" do
+    LibTest.testCallbackVrL { 0 }.should == 0
+  end
+  it "returning :long (0x7fffffff)" do
+    LibTest.testCallbackVrL { 0x7fffffff }.should == 0x7fffffff
+  end
+  # test wrap around
+  it "returning :long (-0x80000000)" do
+    LibTest.testCallbackVrL { -0x80000000 }.should == -0x80000000
+  end
+  it "returning :long (-1)" do
+    LibTest.testCallbackVrL { -1 }.should == -1
+  end
+  it "returning :ulong (0)" do
+    LibTest.testCallbackVrUL { 0 }.should == 0
+  end
+  it "returning :ulong (0x7fffffff)" do
+    LibTest.testCallbackVrUL { 0x7fffffff }.should == 0x7fffffff
+  end
+  # test wrap around
+  it "returning :ulong (0x80000000)" do
+    LibTest.testCallbackVrUL { 0x80000000 }.should == 0x80000000
+  end
+  it "returning :ulong (0xffffffff)" do
+    LibTest.testCallbackVrUL { 0xffffffff }.should == 0xffffffff
+  end
+  it "Callback returning :ulong (-1)" do
+    if FFI::Platform::LONG_SIZE == 32
+      LibTest.testCallbackVrUL { -1 }.should == 0xffffffff
+    else
+      LibTest.testCallbackVrUL { -1 }.should == 0xffffffffffffffff
+    end
+  end
   it "returning :long_long (0)" do
     LibTest.testCallbackVrS64 { 0 }.should == 0
   end
@@ -167,11 +206,14 @@ describe "Callback" do
   it "returning :long_long (-1)" do
     LibTest.testCallbackVrS64 { -1 }.should == -1
   end
+  it "returning bool" do
+    LibTest.testCallbackVrZ { true }.should be_true
+  end
   it "returning :pointer (nil)" do
     LibTest.testCallbackVrP { nil }.null?.should be_true
   end
   it "returning :pointer (MemoryPointer)" do
-    p = MemoryPointer.new :long
+    p = FFI::MemoryPointer.new :long
     LibTest.testCallbackVrP { p }.should == p
   end
 
@@ -187,6 +229,113 @@ describe "Callback" do
     end
   end
 
+  describe 'when inlined' do
+    it 'could be anonymous' do
+      module LibTest
+        extend FFI::Library
+        attach_function :testCallbackVrS8, :testClosureVrB, [ callback([ ], :char) ], :char
+      end
+      LibTest.testCallbackVrS8 { 0 }.should == 0
+    end
+  end
+
+  describe "as return value" do
+
+    it "should not blow up when a callback is defined that returns a callback" do
+      module LibTest
+        extend FFI::Library
+        callback :cb_return_type_1, [ :short ], :short
+        callback :cb_lookup_1, [ :short ], :cb_return_type_1
+        attach_function :testReturnsCallback_1, :testReturnsClosure, [ :cb_lookup_1, :short ], :cb_return_type_1
+      end      
+    end
+
+    it "should return a callback" do
+      module LibTest
+        extend FFI::Library
+        callback :cb_return_type, [ :int ], :int
+        callback :cb_lookup, [ ], :cb_return_type
+        attach_function :testReturnsCallback, :testReturnsClosure, [ :cb_lookup, :int ], :int
+      end      
+
+      lookup_proc_called = false
+      return_proc_called = false
+
+      return_proc = Proc.new do |a|
+        return_proc_called = true
+        a * 2
+      end
+      lookup_proc = Proc.new do
+        lookup_proc_called = true
+        return_proc
+      end
+
+      val = LibTest.testReturnsCallback(lookup_proc, 0x1234)
+      val.should == 0x1234 * 2
+      lookup_proc_called.should be_true
+      return_proc_called.should be_true
+    end
+
+    it "should return a method callback" do
+      module LibTest
+        extend FFI::Library
+        callback :cb_return_type, [ :int ], :int
+        callback :cb_lookup, [ ], :cb_return_type
+        attach_function :testReturnsCallback, :testReturnsClosure, [ :cb_lookup, :int ], :int
+      end
+      module MethodCallback
+        def self.lookup
+          method(:perform)
+        end
+        def self.perform num
+          num * 2
+        end
+      end
+
+      LibTest.testReturnsCallback(MethodCallback.method(:lookup), 0x1234).should == 0x2468
+    end
+
+    it 'should not blow up when a callback takes a callback as argument' do
+      module LibTest
+        extend FFI::Library
+        callback :cb_argument, [ :int ], :int
+        callback :cb_with_cb_argument, [ :cb_argument, :int ], :int
+        attach_function :testCallbackAsArgument, :testArgumentClosure, [ :cb_with_cb_argument, :int ], :int
+      end   
+    end
+    it 'should be able to use the callback argument' do
+      module LibTest
+        extend FFI::Library
+        callback :cb_argument, [ :int ], :int
+        callback :cb_with_cb_argument, [ :cb_argument, :int ], :int
+        attach_function :testCallbackAsArgument, :testArgumentClosure, [ :cb_with_cb_argument, :cb_argument, :int ], :int
+      end   
+      callback_arg_called = false
+      callback_with_callback_arg_called = false         
+      callback_arg = Proc.new do |val|
+        callback_arg_called = true
+        val * 2
+      end
+      callback_with_callback_arg = Proc.new do |cb, val|
+        callback_with_callback_arg_called = true
+        cb.call(val)
+      end
+      val = LibTest.testCallbackAsArgument(callback_with_callback_arg, callback_arg, 0xff1)
+      val.should == 0xff1 * 2
+      callback_arg_called.should be_true
+      callback_with_callback_arg_called.should be_true         
+    end
+    it 'function returns callable object' do
+      module LibTest
+        extend FFI::Library
+        callback :funcptr, [ :int ], :int
+        attach_function :testReturnsFunctionPointer, [  ], :funcptr
+      end
+      f = LibTest.testReturnsFunctionPointer
+      f.call(3).should == 6
+    end
+  end
+
 end
 describe "primitive argument" do
   #
@@ -199,16 +348,27 @@ describe "primitive argument" do
     callback :cbU8rV, [ :uchar ], :void
     callback :cbS16rV, [ :short ], :void
     callback :cbU16rV, [ :ushort ], :void
+
+    callback :cbZrV, [ :bool ], :void
     callback :cbS32rV, [ :int ], :void
     callback :cbU32rV, [ :uint ], :void
+
+    callback :cbLrV, [ :long ], :void
+    callback :cbULrV, [ :ulong ], :void
+
     callback :cbS64rV, [ :long_long ], :void
     attach_function :testCallbackCrV, :testClosureBrV, [ :cbS8rV, :char ], :void
     attach_function :testCallbackU8rV, :testClosureBrV, [ :cbU8rV, :uchar ], :void
     attach_function :testCallbackSrV, :testClosureSrV, [ :cbS16rV, :short ], :void
     attach_function :testCallbackU16rV, :testClosureSrV, [ :cbU16rV, :ushort ], :void
+    attach_function :testCallbackZrV, :testClosureZrV, [ :cbZrV, :bool ], :void
     attach_function :testCallbackIrV, :testClosureIrV, [ :cbS32rV, :int ], :void
     attach_function :testCallbackU32rV, :testClosureIrV, [ :cbU32rV, :uint ], :void
-    attach_function :testCallbackLrV, :testClosureLrV, [ :cbS64rV, :long_long ], :void
+
+    attach_function :testCallbackLrV, :testClosureLrV, [ :cbLrV, :long ], :void
+    attach_function :testCallbackULrV, :testClosureULrV, [ :cbULrV, :ulong ], :void
+
+    attach_function :testCallbackLLrV, :testClosureLLrV, [ :cbS64rV, :long_long ], :void
   end
   it ":char (0) argument" do
     v = 0xdeadbeef
@@ -230,7 +390,6 @@ describe "primitive argument" do
     LibTest.testCallbackCrV(-1) { |i| v = i }
     v.should == -1
   end
-
   it ":uchar (0) argument" do
     v = 0xdeadbeef
     LibTest.testCallbackU8rV(0) { |i| v = i }
@@ -272,7 +431,6 @@ describe "primitive argument" do
     LibTest.testCallbackSrV(-1) { |i| v = i }
     v.should == -1
   end
-
   it ":ushort (0) argument" do
     v = 0xdeadbeef
     LibTest.testCallbackU16rV(0) { |i| v = i }
@@ -293,7 +451,11 @@ describe "primitive argument" do
     LibTest.testCallbackU16rV(0xffff) { |i| v = i }
     v.should == 0xffff
   end
-
+  it ":bool (true) argument" do
+    v = false
+    LibTest.testCallbackZrV(true) { |i| v = i }
+    v.should be_true
+  end
   it ":int (0) argument" do
     v = 0xdeadbeef
     LibTest.testCallbackIrV(0) { |i| v = i }
@@ -314,7 +476,6 @@ describe "primitive argument" do
     LibTest.testCallbackIrV(-1) { |i| v = i }
     v.should == -1
   end
-
   it ":uint (0) argument" do
     v = 0xdeadbeef
     LibTest.testCallbackU32rV(0) { |i| v = i }
@@ -335,26 +496,65 @@ describe "primitive argument" do
     LibTest.testCallbackU32rV(0xffffffff) { |i| v = i }
     v.should == 0xffffffff
   end
-
-  it ":long_long (0) argument" do
+  it ":long (0) argument" do
     v = 0xdeadbeef
     LibTest.testCallbackLrV(0) { |i| v = i }
     v.should == 0
   end
+  it ":long (0x7fffffff) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackLrV(0x7fffffff) { |i| v = i }
+    v.should == 0x7fffffff
+  end
+  it ":long (-0x80000000) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackLrV(-0x80000000) { |i| v = i }
+    v.should == -0x80000000
+  end
+  it ":long (-1) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackLrV(-1) { |i| v = i }
+    v.should == -1
+  end
+  it ":ulong (0) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackULrV(0) { |i| v = i }
+    v.should == 0
+  end
+  it ":ulong (0x7fffffff) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackULrV(0x7fffffff) { |i| v = i }
+    v.should == 0x7fffffff
+  end
+  it ":ulong (0x80000000) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackULrV(0x80000000) { |i| v = i }
+    v.should == 0x80000000
+  end
+  it ":ulong (0xffffffff) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackULrV(0xffffffff) { |i| v = i }
+    v.should == 0xffffffff
+  end
+  it ":long_long (0) argument" do
+    v = 0xdeadbeef
+    LibTest.testCallbackLLrV(0) { |i| v = i }
+    v.should == 0
+  end
   it ":long_long (0x7fffffffffffffff) argument" do
     v = 0xdeadbeef
-    LibTest.testCallbackLrV(0x7fffffffffffffff) { |i| v = i }
+    LibTest.testCallbackLLrV(0x7fffffffffffffff) { |i| v = i }
     v.should == 0x7fffffffffffffff
   end
   it ":long_long (-0x8000000000000000) argument" do
     v = 0xdeadbeef
-    LibTest.testCallbackLrV(-0x8000000000000000) { |i| v = i }
+    LibTest.testCallbackLLrV(-0x8000000000000000) { |i| v = i }
     v.should == -0x8000000000000000
   end
   it ":long_long (-1) argument" do
     v = 0xdeadbeef
-    LibTest.testCallbackLrV(-1) { |i| v = i }
+    LibTest.testCallbackLLrV(-1) { |i| v = i }
     v.should == -1
   end
   
-end unless true
+end # unless true