ffi 0.6.4 → 1.0.0

data/spec/ffi/custom_param_type.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "functions with custom parameter types" do
+  before :each do
+
+    Custom_enum = Class.new do
+      extend FFI::DataConverter
+      ToNativeMap= { :a => 1, :b => 2 }
+      FromNativeMap = { 1 => :a, 2 => :b }
+
+      def self.native_type
+        @native_type_called = true
+        FFI::Type::INT32
+      end
+
+      def self.to_native(val, ctx)
+        @to_native_called = true
+        ToNativeMap[val]
+      end
+
+      def self.from_native(val, ctx)
+        @from_native_called = true
+        FromNativeMap[val]
+      end
+      def self.native_type_called?; @native_type_called; end
+      def self.from_native_called?; @from_native_called; end
+      def self.to_native_called?; @to_native_called; end
+    end
+
+  end
+end

data/spec/ffi/custom_type_spec.rb

@@ -0,0 +1,73 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "functions with custom types" do
+  before :each do
+    
+    Custom_enum = Class.new do
+      extend FFI::DataConverter
+      ToNativeMap= { :a => 1, :b => 2, :c => 3 }
+      FromNativeMap = { 1 => :a, 2 => :b, 3 => :c }
+
+      def self.native_type
+        @native_type_called = true
+        FFI::Type::INT32
+      end
+
+      def self.to_native(val, ctx)
+        @to_native_called = true
+        ToNativeMap[val]
+      end
+
+      def self.from_native(val, ctx)
+        @from_native_called = true
+        FromNativeMap[val]
+      end
+      def self.native_type_called?; @native_type_called; end
+      def self.from_native_called?; @from_native_called; end
+      def self.to_native_called?; @to_native_called; end
+    end
+
+  end
+
+  it "can attach with custom return type" do
+    lambda do
+      m = Module.new do
+        extend FFI::Library
+        ffi_lib TestLibrary::PATH
+        attach_function :ret_s32, [ :int ], Custom_enum
+      end
+    end.should_not raise_error
+  end
+
+  it "should return object of correct type" do
+
+    m = Module.new do
+
+      extend FFI::Library
+      ffi_lib TestLibrary::PATH
+      attach_function :ret_s32, [ :int ], Custom_enum
+    end
+
+    m.ret_s32(1).is_a?(Symbol).should be_true
+  end
+
+  it "from_native should be called for result" do
+    m = Module.new do
+      extend FFI::Library
+      ffi_lib TestLibrary::PATH
+      attach_function :ret_s32, [ :int ], Custom_enum
+    end
+    m.ret_s32(1)
+    Custom_enum.from_native_called?.should be_true
+  end
+
+  it "to_native should be called for parameter" do
+    m = Module.new do
+      extend FFI::Library
+      ffi_lib TestLibrary::PATH
+      attach_function :ret_s32, [ Custom_enum ], :int
+    end
+    m.ret_s32(:a)
+    Custom_enum.to_native_called?.should be_true
+  end
+end

data/spec/ffi/enum_spec.rb

@@ -89,6 +89,25 @@ describe "A tagged typedef enum" do
     TestEnum3.test_tagged_typedef_enum4(:c15).should == :c15
     TestEnum3.test_tagged_typedef_enum4(:c16).should == :c16
   end
+
+  it "integers can be used instead of constants" do
+    TestEnum3.test_tagged_typedef_enum1(0).should == :c1
+    TestEnum3.test_tagged_typedef_enum1(1).should == :c2
+    TestEnum3.test_tagged_typedef_enum1(2).should == :c3
+    TestEnum3.test_tagged_typedef_enum1(3).should == :c4
+    TestEnum3.test_tagged_typedef_enum2(42).should == :c5
+    TestEnum3.test_tagged_typedef_enum2(43).should == :c6
+    TestEnum3.test_tagged_typedef_enum2(44).should == :c7
+    TestEnum3.test_tagged_typedef_enum2(45).should == :c8
+    TestEnum3.test_tagged_typedef_enum3(42).should == :c9
+    TestEnum3.test_tagged_typedef_enum3(43).should == :c10
+    TestEnum3.test_tagged_typedef_enum3(4242).should == :c11
+    TestEnum3.test_tagged_typedef_enum3(4243).should == :c12
+    TestEnum3.test_tagged_typedef_enum4(42).should == :c13
+    TestEnum3.test_tagged_typedef_enum4(4242).should == :c14
+    TestEnum3.test_tagged_typedef_enum4(424242).should == :c15
+    TestEnum3.test_tagged_typedef_enum4(42424242).should == :c16
+  end
 end
 
 describe "All enums" do

data/spec/ffi/ffi_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "FFI" do
+
+  describe ".map_library_name" do
+
+    let(:prefix) { FFI::Platform::LIBPREFIX }
+    let(:suffix) { FFI::Platform::LIBSUFFIX }
+    
+    it "should add platform library extension if not present" do
+      FFI.map_library_name("#{prefix}dummy").should == "#{prefix}dummy.#{suffix}"
+    end
+
+    it "should add platform library extension even if lib suffix is present in name" do
+      FFI.map_library_name("#{prefix}dummy_with_#{suffix}").should == "#{prefix}dummy_with_#{suffix}.#{suffix}"
+    end
+
+    it "should return Platform::LIBC when called with 'c'" do
+      FFI.map_library_name('c').should == FFI::Library::LIBC
+    end
+
+  end
+
+end

data/spec/ffi/pointer_spec.rb

@@ -177,7 +177,21 @@ describe "AutoPointer" do
     end
     AutoPointerTestHelper.gc_everything loop_count
   end
+
+  it "can be used as the return type of a function" do
+    lambda do
+      Module.new do
+        extend FFI::Library
+        ffi_lib TestLibrary::PATH
+        class CustomAutoPointer < FFI::AutoPointer
+          def self.release(ptr); end
+        end
+        attach_function :ptr_from_address, [ FFI::Platform::ADDRESS_SIZE == 32 ? :uint : :ulong_long ], CustomAutoPointer
+      end
+    end.should_not raise_error
+  end
 end
+
 describe "AutoPointer#new" do
   class AutoPointerSubclass < FFI::AutoPointer
     def self.release(ptr); end
@@ -193,3 +207,4 @@ describe "AutoPointer#new" do
   end
 
 end
+

data/spec/ffi/rbx/memory_pointer_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require "rubygems"
 require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
 
@@ -13,7 +14,12 @@ describe "MemoryPointer" do
     m = FFI::MemoryPointer.from_string("FFI is Awesome")
     m.type_size.should == 15
   end
-  
+
+  it "makes a pointer from a string with multibyte characters" do
+    m = FFI::MemoryPointer.from_string("ぱんだ")
+    m.type_size.should == 10
+  end
+
   it "reads back a string" do
     m = FFI::MemoryPointer.from_string("FFI is Awesome")
     m.read_string.should == "FFI is Awesome"

data/spec/ffi/strptr_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe "functions returning :strptr" do
+  it "can attach function with :strptr return type" do
+    lambda do
+      m = Module.new do
+        extend FFI::Library
+        ffi_lib FFI::Library::LIBC
+        attach_function :strdup, [ :string ], :strptr
+      end
+    end.should_not raise_error
+  end
+
+  module StrPtr
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+    attach_function :strdup, [ :string ], :strptr
+    attach_function :free, [ :pointer ], :void
+  end
+
+  it "should return [ String, Pointer ]" do
+    result = StrPtr.strdup("test")
+    result[0].is_a?(String).should be_true
+    result[1].is_a?(FFI::Pointer).should be_true
+  end
+
+  it "should return the correct value" do
+    result = StrPtr.strdup("test")
+    result[0].should == "test"
+  end
+
+  it "should return non-NULL pointer" do
+    result = StrPtr.strdup("test")
+    result[1].null?.should be_false
+  end
+end

data/spec/ffi/struct_packed_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+
+describe FFI::Struct do
+  it "packed :char followed by :int should have size of 5" do
+    Class.new(FFI::Struct) do
+      packed
+      layout :c, :char, :i, :int
+    end.size.should == 5
+  end
+
+  it "packed :char followed by :int should have alignment of 1" do
+    Class.new(FFI::Struct) do
+      packed
+      layout :c, :char, :i, :int
+    end.alignment.should == 1
+  end
+
+  it "packed(2) :char followed by :int should have size of 6" do
+    Class.new(FFI::Struct) do
+      packed 2
+      layout :c, :char, :i, :int
+    end.size.should == 6
+  end
+
+  it "packed(2)  :char followed by :int should have alignment of 2" do
+    Class.new(FFI::Struct) do
+      packed 2
+      layout :c, :char, :i, :int
+    end.alignment.should == 2
+  end
+
+  it "packed :short followed by int should have size of 6" do
+    Class.new(FFI::Struct) do
+      packed
+      layout :s, :short, :i, :int
+    end.size.should == 6
+  end
+
+  it "packed :short followed by int should have alignment of 1" do
+    Class.new(FFI::Struct) do
+      packed
+      layout :s, :short, :i, :int
+    end.alignment.should == 1
+  end
+
+end

data/spec/ffi/struct_spec.rb

@@ -158,7 +158,7 @@ describe "Struct tests" do
       class TestStruct < FFI::Struct
         layout :c, :char
       end
-      attach_function :struct_field_s8, [ TestStruct ], :char
+      attach_function :struct_field_s8, [ TestStruct.in ], :char
     end
   end
   it "Can use Struct subclass as IN parameter type" do
@@ -327,8 +327,8 @@ describe "Struct tests" do
       layout :add, :add,
         :sub, :sub
     end
-    attach_function :struct_call_add_cb, [TestStruct, :int, :int], :int
-    attach_function :struct_call_sub_cb, [TestStruct, :int, :int], :int
+    attach_function :struct_call_add_cb, [TestStruct.in, :int, :int], :int
+    attach_function :struct_call_sub_cb, [TestStruct.in, :int, :int], :int
   end
   it "Can have CallbackInfo struct field" do
       s = CallbackMember::TestStruct.new
@@ -336,8 +336,8 @@ describe "Struct tests" do
       sub_proc = lambda { |a, b| a-b }
       s[:add] = add_proc
       s[:sub] = sub_proc
-      CallbackMember.struct_call_add_cb(s.pointer, 40, 2).should == 42
-      CallbackMember.struct_call_sub_cb(s.pointer, 44, 2).should == 42
+      CallbackMember.struct_call_add_cb(s, 40, 2).should == 42
+      CallbackMember.struct_call_sub_cb(s, 44, 2).should == 42
   end
   it "Can return its members as a list" do
     class TestStruct < FFI::Struct
@@ -621,4 +621,18 @@ describe "Struct allocation" do
     p.put_uint(4, 0xdeadbeef)
     S.new(p[1])[:i].should == 0xdeadbeef
   end
+
+  it "null? should be true when initialized with NULL pointer" do
+    class S < FFI::Struct
+      layout :i, :uint
+    end
+    S.new(Pointer::NULL).null?.should be_true
+  end
+
+  it "null? should be false when initialized with non-NULL pointer" do
+    class S < FFI::Struct
+      layout :i, :uint
+    end
+    S.new(MemoryPointer.new(S)).null?.should be_false
+  end
 end

data/spec/ffi/typedef_spec.rb

@@ -45,4 +45,18 @@ describe "Custom type definitions" do
     s[:a] = 0x12345678
     s.pointer.get_uint(0).should == 0x12345678
   end
+
+  it "attach_function after a typedef should not reject normal types" do
+    lambda do
+      Module.new do
+        extend FFI::Library
+        # enum() will insert a custom typedef called :foo for the enum
+        enum :foo, [ :a, :b ]
+        typedef :int, :bar
+        
+        ffi_lib TestLibrary::PATH
+        attach_function :ptr_ret_int32_t, [ :string, :foo ], :bar
+      end
+    end.should_not raise_error
+  end
 end

data/tasks/ann.rake

@@ -0,0 +1,80 @@
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = (PROJ.ann.email[:from] || PROJ.email) if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/extension.rake

@@ -0,0 +1,25 @@
+spec = Gem::Specification.new do |s|
+  s.name = PROJ.name
+  s.version = PROJ.version
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
+  s.summary = PROJ.summary
+  s.description = PROJ.description
+  s.authors = Array(PROJ.authors)
+  s.email = PROJ.email
+  s.homepage = Array(PROJ.url).first
+  s.rubyforge_project = PROJ.rubyforge.name
+  s.extensions = %w(ext/ffi_c/extconf.rb gen/Rakefile)
+  s.require_path = 'lib'
+  s.files = PROJ.gem.files
+  s.add_dependency *PROJ.gem.dependencies.flatten
+end
+
+Rake::ExtensionTask.new('ffi_c', spec) do |ext|
+  ext.name = 'ffi_c'                                        # indicate the name of the extension.
+  # ext.lib_dir = BUILD_DIR                                 # put binaries into this folder.
+  ext.tmp_dir = BUILD_DIR                                   # temporary folder used during compilation.
+  ext.cross_compile = true                                  # enable cross compilation (requires cross compile toolchain)
+  ext.cross_platform = ['i386-mingw32', 'i386-mswin32']     # forces the Windows platform instead of the default one
+end if USE_RAKE_COMPILER