ffi 0.5.4 → 0.6.0

data/lib/ffi/memorypointer.rb

@@ -1,73 +1,39 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Evan Phoenix nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 require 'ffi/pointer'
 module FFI
   class MemoryPointer
-      # call-seq:
-      #   MemoryPointer.new(num) => MemoryPointer instance of <i>num</i> bytes
-      #   MemoryPointer.new(sym) => MemoryPointer instance with number
-      #                             of bytes need by FFI type <i>sym</i>
-      #   MemoryPointer.new(obj) => MemoryPointer instance with number
-      #                             of <i>obj.size</i> bytes
-      #   MemoryPointer.new(sym, count) => MemoryPointer instance with number
-      #                             of bytes need by length-<i>count</i> array
-      #                             of FFI type <i>sym</i>
-      #   MemoryPointer.new(obj, count) => MemoryPointer instance with number
-      #                             of bytes need by length-<i>count</i> array
-      #                             of <i>obj.size</i> bytes
-      #   MemoryPointer.new(arg) { |p| ... }
-      #
-      # Both forms create a MemoryPointer instance. The number of bytes to
-      # allocate is either specified directly or by passing an FFI type, which
-      # specifies the number of bytes needed for that type.
-      #
-      # The form without a block returns the MemoryPointer instance. The form
-      # with a block yields the MemoryPointer instance and frees the memory
-      # when the block returns. The value returned is the value of the block.
-
-#      def self.new(type, count=nil, clear=true)
-#        size = if type.kind_of? Fixnum
-#          type
-#        elsif type.kind_of? Symbol
-#          FFI.type_size(type)
-#        else
-#          type.size
-#        end
-#        ptr = self.__allocate(size, count, clear)
-#        ptr.type_size = size
-#        if block_given?
-#          begin
-#            value = yield ptr
-#          ensure
-#            ptr.free
-#          end
-#          value
-#        else
-#          ptr
-#        end
-#      end
+      
       def self.from_string(s)
         ptr = self.new(s.length + 1, 1, false)
         ptr.put_string(0, s)
         ptr
       end
-      # Indicates how many bytes the type that the pointer is cast as uses.
-      # attr_accessor :type_size
 
-      # Access the MemoryPointer like a C array, accessing the +which+ number
-      # element in memory. The position of the element is calculate from
-      # +@type_size+ and +which+. A new MemoryPointer object is returned, which
-      # points to the address of the element.
-      #
-      # Example:
-      #   ptr = MemoryPointer.new(:int, 20)
-      #   new_ptr = ptr[9]
-      #
-      # c-equiv:
-      #   int *ptr = (int*)malloc(sizeof(int) * 20);
-      #   int *new_ptr;
-      #   new_ptr = &ptr[9];
-      #
-#      def [](which)
-#        self + (which * type_size)
-#      end
   end
 end

data/lib/ffi/platform.rb

@@ -1,3 +1,30 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Evan Phoenix nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 require 'rbconfig'
 module FFI
   class PlatformError < FFI::NativeError; end

data/lib/ffi/pointer.rb

@@ -1,3 +1,31 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+# Copyright (c) 2007, 2008 Evan Phoenix
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Evan Phoenix nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 require 'ffi/platform'
 module FFI
   class Pointer

data/lib/ffi/struct.rb

@@ -1,3 +1,33 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+# Copyright (C) 2008, 2009 Andrea Fazzi
+# Copyright (C) 2008, 2009 Luc Heinrich
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Evan Phoenix nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 require 'ffi/platform'
 module FFI
 
@@ -10,6 +40,28 @@ module FFI
     def offset_of(field_name)
       self[field_name].offset
     end
+
+    class Enum < Field
+      
+      def get(ptr)
+        type.find(ptr.get_int(0))
+      end
+
+      def put(ptr, value)
+        ptr.put_int(0, type.find(value))
+      end
+
+    end
+
+    class InlineStruct < Field
+      def get(ptr)
+        type.struct_class.new(ptr.slice(self.offset, self.size))
+      end
+
+#      def put(ptr, value)
+#        raise TypeError, "wrong value type (expected #{type.struct_class}" unless value.is_a(type.struct_class)
+#      end
+    end
   end
 
   
@@ -131,7 +183,9 @@ module FFI
       end
 
       def find_type(type, mod = nil)
-        if (type.kind_of?(Class) && type < FFI::Struct) || type.is_a?(::Array)
+        if type.kind_of?(Class) && type < FFI::Struct
+          FFI::Type::Struct.new(type)
+        elsif type.is_a?(::Array)
           type
         elsif mod
           mod.find_type(type)

data/lib/ffi/types.rb

@@ -1,3 +1,32 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+# Copyright (C) 2009 Luc Heinrich
+# Copyright (c) 2007, 2008 Evan Phoenix
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Evan Phoenix nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 module FFI
 #  TypeDefs = Hash.new
   def self.add_typedef(current, add)

data/lib/ffi/variadic.rb

@@ -1,3 +1,32 @@
+#
+# Copyright (C) 2008, 2009 Wayne Meissner
+# Copyright (C) 2009 Luc Heinrich
+# 
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# * Redistributions of source code must retain the above copyright notice, this
+#   list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright notice
+#   this list of conditions and the following disclaimer in the documentation
+#   and/or other materials provided with the distribution.
+# * Neither the name of the Evan Phoenix nor the names of its contributors
+#   may be used to endorse or promote products derived from this software
+#   without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 module FFI
   class VariadicInvoker    
     def init(arg_types, type_map)

data/spec/ffi/library_spec.rb

@@ -1,19 +1,20 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
 describe "Library" do
 
-  unless Config::CONFIG['target_os'] =~ /mingw/ || Config::CONFIG['target_os'] =~ /win/
+  unless Config::CONFIG['target_os'] =~ /mswin|mingw/
     it "attach_function with no library specified" do
       lambda {
         Module.new do |m|
           m.extend FFI::Library
           attach_function :getpid, [ ], :uint
         end
-      }.should_not raise_error
+      }.should raise_error
     end
     it "attach_function :getpid from this process" do
       lambda {
         Module.new do |m|
           m.extend FFI::Library
+          ffi_lib FFI::Library::CURRENT_PROCESS
           attach_function :getpid, [ ], :uint
         end.getpid.should == Process.pid
       }.should_not raise_error
@@ -22,7 +23,7 @@ describe "Library" do
       lambda {
         Module.new do |m|
           m.extend FFI::Library
-          ffi_lib 'c', 'libc.so.6'
+          ffi_lib [ 'c', 'libc.so.6' ]
           attach_function :getpid, [ ], :uint
         end.getpid.should == Process.pid
       }.should_not raise_error
@@ -31,7 +32,7 @@ describe "Library" do
       lambda {
         Module.new do |m|
           m.extend FFI::Library
-          ffi_lib 'libc.so.6', 'c'
+          ffi_lib [ 'libc.so.6', 'c' ]
           attach_function :getpid, [ ], :uint
         end.getpid.should == Process.pid
       }.should_not raise_error
@@ -40,7 +41,7 @@ describe "Library" do
       lambda {
         Module.new do |m|
           m.extend FFI::Library
-          ffi_lib 'libfubar.so.0xdeadbeef', nil, 'c'
+          ffi_lib [ 'libfubar.so.0xdeadbeef', nil, 'c' ]
           attach_function :getpid, [ ], :uint
         end.getpid.should == Process.pid
       }.should_not raise_error
@@ -145,4 +146,29 @@ describe "Library" do
     lib.gvar = val
     lib.get.should == val
   end
+
+  [ 0, 0x7fffffff, -0x80000000, -1 ].each do |i|
+    it "structure" do
+      class GlobalStruct < FFI::Struct
+        layout :data, :long
+      end
+
+      lib = Module.new do |m|
+        m.extend FFI::Library
+        ffi_lib TestLibrary::PATH
+        attach_variable :gvar, "gvar_gstruct", GlobalStruct
+        attach_function :get, "gvar_gstruct_get", [], GlobalStruct
+        attach_function :set, "gvar_gstruct_set", [ GlobalStruct ], :void
+      end
+
+      val = GlobalStruct.new
+      val[:data] = i
+      lib.set(val)
+      lib.gvar[:data].should == i
+      val[:data] = 0
+      lib.gvar[:data] = i
+      val = GlobalStruct.new(lib.get)
+      val[:data].should == i
+    end
+  end
 end

data/spec/ffi/rbx/attach_function_spec.rb

@@ -6,7 +6,8 @@ end
 
 module LibC
   extend FFI::Library
-  
+  ffi_lib FFI::Library::LIBC
+
   attach_function :gettimeofday, [:pointer, :pointer], :int
 end
 

data/spec/ffi/rbx/memory_pointer_spec.rb

@@ -3,7 +3,8 @@ require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
 
 module CTest
   extend FFI::Library
-  
+  ffi_lib FFI::Library::LIBC
+
   attach_function :strcat, [:pointer, :pointer], :pointer
 end
 

data/spec/ffi/spec_helper.rb

@@ -2,10 +2,14 @@ require 'rubygems'
 require 'rbconfig'
 require 'spec'
 
-if ENV["MRI_FFI"]
+if RUBY_PLATFORM =~/java/
+  libdir = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib"))
+  $:.reject! { |p| p == libdir }
+else
   $:.unshift File.join(File.dirname(__FILE__), "..", "..", "lib"),
     File.join(File.dirname(__FILE__), "..", "..", "build", "#{Config::CONFIG['host_cpu''arch']}", "ffi_c", RUBY_VERSION)
 end
+puts "loadpath=#{$:.join(':')}"
 require "ffi"
 
 module TestLibrary

data/spec/ffi/struct_spec.rb

@@ -286,6 +286,20 @@ describe "Struct tests" do
     s[:v] = value
     (s.pointer.get_double(0) - value).abs.should < 0.0001
   end
+  module EnumFields
+    extend FFI::Library
+    enum :test_enum, [:c1, 10, :c2, 20, :c3, 30, :c4, 40]
+    class TestStruct < FFI::Struct
+      layout :c, :test_enum
+    end
+  end
+  it ":enum field r/w" do
+    s = EnumFields::TestStruct.new
+    s[:c] = :c3
+
+    s.pointer.get_uint(0).should == 30
+    s[:c].should == :c3
+  end
   module CallbackMember
     extend FFI::Library
     ffi_lib TestLibrary::PATH
@@ -379,6 +393,56 @@ describe FFI::Struct, ' with a nested struct field'  do
   end
 end
 
+describe FFI::Struct, ' with a nested array of structs'  do
+  module InlineArrayOfStructs
+    extend FFI::Library
+    ffi_lib TestLibrary::PATH
+    class NestedStruct < FFI::Struct
+      layout :i, :int
+    end
+    class ContainerStruct < FFI::Struct
+      layout :first, :char, :ns, [ NestedStruct, 1 ]
+    end
+    attach_function :struct_align_nested_struct, [ :pointer ], :int
+    attach_function :struct_make_container_struct, [ :int ], :pointer
+  end
+
+  before do
+    @cs = InlineArrayOfStructs::ContainerStruct.new
+  end
+
+  it 'should align correctly nested struct field' do
+    @cs[:ns][0][:i] = 123
+    InlineArrayOfStructs.struct_align_nested_struct(@cs.to_ptr).should == 123
+  end
+
+  it 'should correctly calculate Container size (in bytes)' do
+    InlineArrayOfStructs::ContainerStruct.size.should == 8
+  end
+
+  it 'should return a Struct object when the field is accessed' do
+    @cs[:ns][0].is_a?(FFI::Struct).should be_true
+  end
+
+  it 'should read a value from memory' do
+    @cs = InlineArrayOfStructs::ContainerStruct.new(InlineArrayOfStructs.struct_make_container_struct(123))
+    @cs[:ns][0][:i].should == 123
+  end
+
+  it 'should write a value to memory' do
+    @cs = InlineArrayOfStructs::ContainerStruct.new(InlineArrayOfStructs.struct_make_container_struct(123))
+    @cs[:ns][0][:i] = 456
+    InlineArrayOfStructs.struct_align_nested_struct(@cs.to_ptr).should == 456
+  end
+
+  it 'should support Enumerable#each' do
+    @cs = InlineArrayOfStructs::ContainerStruct.new(InlineArrayOfStructs.struct_make_container_struct(123))
+    ints = []
+    @cs[:ns].each { |s| ints << s[:i] }
+    ints[0].should == 123
+  end
+end
+
 describe FFI::Struct, ' by value'  do
   module LibTest
     extend FFI::Library