ffi 0.6.0 → 1.0.0

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

@@ -133,6 +133,24 @@ describe "Struct tests" do
       mp.get_int64(ll_off).should == 0xfee1deadbeef
       end
   end
+
+  it "subclass overrides initialize without calling super" do
+    class InitializeWithoutSuper < FFI::Struct
+      layout :a, :int, :b, :long_long, :d, [:double, 2]
+
+      def initialize(a, b)
+        self[:a] = a
+        self[:b] = b
+        self[:d][0] = 1.2
+        self[:d][1] = 3.4
+      end
+
+    end
+    s = InitializeWithoutSuper.new(0x1eefbeef, 0xdeadcafebabe)
+    s[:a].should == 0x1eefbeef
+    s[:b].should == 0xdeadcafebabe
+  end
+
   it "Can use Struct subclass as parameter type" do
     module StructParam
       extend FFI::Library
@@ -140,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
@@ -290,14 +308,14 @@ describe "Struct tests" do
     extend FFI::Library
     enum :test_enum, [:c1, 10, :c2, 20, :c3, 30, :c4, 40]
     class TestStruct < FFI::Struct
-      layout :c, :test_enum
+      layout :a, :int, :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.pointer.get_uint(FFI::Type::INT32.size).should == 30
     s[:c].should == :c3
   end
   module CallbackMember
@@ -309,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
@@ -318,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
@@ -603,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

data/tasks/gem.rake

@@ -0,0 +1,200 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+end  # namespace :gem
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+remove_desc_for_task 'gem:clobber_package'
+
+# EOF

data/tasks/git.rake

@@ -0,0 +1,41 @@
+
+if HAVE_GIT
+
+namespace :git do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show tags from the Git repository'
+  task :show_tags => 'git:prereqs' do |t|
+    puts %x/git tag/
+  end
+
+  desc 'Create a new tag in the Git repository'
+  task :create_tag => 'git:prereqs' do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+#    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = "%s" % [ PROJ.version ]
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating Git tag '#{tag}'"
+    unless system "git tag -a -m '#{msg}' #{tag}"
+      abort "Tag creation failed"
+    end
+
+#    if %x/git remote/ =~ %r/^origin\s*$/
+#      unless system "git push origin #{tag}"
+#        abort "Could not push tag to remote Git repository"
+#      end
+#    end
+  end
+
+end  # namespace :git
+
+#task 'gem:release' => 'git:create_tag'
+
+end  # if HAVE_GIT
+
+# EOF

data/tasks/notes.rake

@@ -0,0 +1,27 @@
+
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do |t|
+  id = if t.application.top_level_tasks.length > 1
+    t.application.top_level_tasks.slice!(1..-1).join(' ')
+  end
+  Bones::AnnotationExtractor.enumerate(
+      PROJ, PROJ.notes.tags.join('|'), id, :tag => true)
+end
+
+namespace :notes do
+  PROJ.notes.tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do |t|
+      id = if t.application.top_level_tasks.length > 1
+        t.application.top_level_tasks.slice!(1..-1).join(' ')
+      end
+      Bones::AnnotationExtractor.enumerate(PROJ, tag, id)
+    end
+  end
+end
+
+end  # if HAVE_BONES
+
+# EOF

data/tasks/post_load.rake

@@ -0,0 +1,34 @@
+
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.ignore_file)}$",
+                 "^#{Regexp.escape(PROJ.rdoc.dir)}/",
+                 "^#{Regexp.escape(PROJ.rcov.dir)}/"]
+
+flatten_arrays = lambda do |this,os|
+    os.instance_variable_get(:@table).each do |key,val|
+      next if key == :dependencies \
+           or key == :development_dependencies
+      case val
+      when Array; val.flatten!
+      when OpenStruct; this.call(this,val)
+      end
+    end
+  end
+flatten_arrays.call(flatten_arrays,PROJ)
+
+PROJ.changes ||= paragraphs_of(PROJ.history_file, 0..1).join("\n\n")
+
+PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
+
+PROJ.summary ||= PROJ.description.split('.').first
+
+PROJ.gem.files ||= manifest
+
+PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
+
+PROJ.rdoc.main ||= PROJ.readme_file
+
+# EOF