ffi 0.1.0

data/nbproject/configurations.xml

@@ -0,0 +1,169 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configurationDescriptor version="47">
+  <logicalFolder name="root" displayName="root" projectFiles="true">
+    <logicalFolder name="ruby-ffi" displayName="ruby-ffi" projectFiles="true">
+      <logicalFolder name="ext" displayName="ext" projectFiles="true">
+        <itemPath>ext/AbstractMemory.c</itemPath>
+        <itemPath>ext/AbstractMemory.h</itemPath>
+        <itemPath>/Users/wayne/src/ruby-ffi/ext/Buffer.c</itemPath>
+        <itemPath>ext/Callback.c</itemPath>
+        <itemPath>/Users/wayne/src/ruby-ffi/ext/Callback.h</itemPath>
+        <itemPath>ext/ffi.c</itemPath>
+        <itemPath>/Users/wayne/src/ruby-ffi/ext/Invoker.c</itemPath>
+        <itemPath>ext/MemoryPointer.c</itemPath>
+        <itemPath>ext/MemoryPointer.h</itemPath>
+        <itemPath>ext/Platform.c</itemPath>
+        <itemPath>ext/Platform.h</itemPath>
+        <itemPath>ext/rbffi.h</itemPath>
+        <itemPath>/Users/wayne/src/ruby-ffi/ext/Types.c</itemPath>
+        <itemPath>/Users/wayne/src/ruby-ffi/ext/Types.h</itemPath>
+      </logicalFolder>
+      <logicalFolder name="f1" displayName="lib" projectFiles="true">
+        <logicalFolder name="ffi" displayName="ffi" projectFiles="true">
+          <itemPath>/Users/wayne/src/ruby-ffi/lib/ffi/callback.rb</itemPath>
+          <itemPath>lib/ffi/ffi.rb</itemPath>
+          <itemPath>lib/ffi/memorypointer.rb</itemPath>
+          <itemPath>lib/ffi/platform.rb</itemPath>
+          <itemPath>lib/ffi/struct.rb</itemPath>
+        </logicalFolder>
+        <itemPath>lib/ffi.rb</itemPath>
+      </logicalFolder>
+      <logicalFolder name="specs" displayName="specs" projectFiles="true">
+        <logicalFolder name="rbx" displayName="rbx" projectFiles="true">
+          <itemPath>specs/rbx/attach_function_spec.rb</itemPath>
+          <itemPath>specs/rbx/memory_pointer_spec.rb</itemPath>
+          <itemPath>specs/rbx/spec_helper.rb</itemPath>
+          <itemPath>specs/rbx/struct_spec.rb</itemPath>
+        </logicalFolder>
+        <itemPath>specs/buffer_spec.rb</itemPath>
+        <itemPath>specs/callback_spec.rb</itemPath>
+        <itemPath>specs/spec_helper.rb</itemPath>
+      </logicalFolder>
+    </logicalFolder>
+    <logicalFolder name="ExternalFiles"
+                   displayName="Important Files"
+                   projectFiles="false">
+      <itemPath>libffi.mk</itemPath>
+      <itemPath>Makefile</itemPath>
+      <itemPath>ruby-ffi-Makefile.mk</itemPath>
+    </logicalFolder>
+  </logicalFolder>
+  <sourceEncoding>UTF-8</sourceEncoding>
+  <projectmakefile>ruby-ffi-Makefile.mk</projectmakefile>
+  <confs>
+    <conf name="Default" type="0">
+      <toolsSet>
+        <developmentServer>localhost</developmentServer>
+        <compilerSet>GNU|GNU</compilerSet>
+        <platform>4</platform>
+      </toolsSet>
+      <makefileType>
+        <makeTool>
+          <buildCommandWorkingDir>.</buildCommandWorkingDir>
+          <buildCommand>make -f Makefile</buildCommand>
+          <cleanCommand>make -f Makefile clean</cleanCommand>
+          <executablePath></executablePath>
+          <cCompilerTool>
+            <includeDirectories>
+              <directoryPath>/opt/local/include</directoryPath>
+            </includeDirectories>
+          </cCompilerTool>
+        </makeTool>
+        <requiredProjects>
+        </requiredProjects>
+      </makefileType>
+      <item path="/Users/wayne/src/ruby-ffi/ext/Buffer.c">
+        <itemTool>0</itemTool>
+      </item>
+      <item path="/Users/wayne/src/ruby-ffi/ext/Callback.h">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>3</itemTool>
+      </item>
+      <item path="/Users/wayne/src/ruby-ffi/ext/Invoker.c">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>0</itemTool>
+      </item>
+      <item path="/Users/wayne/src/ruby-ffi/ext/Types.c">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>0</itemTool>
+      </item>
+      <item path="/Users/wayne/src/ruby-ffi/ext/Types.h">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>3</itemTool>
+      </item>
+      <item path="/Users/wayne/src/ruby-ffi/lib/ffi/callback.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="ext/AbstractMemory.c">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>0</itemTool>
+      </item>
+      <item path="ext/AbstractMemory.h">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>3</itemTool>
+      </item>
+      <item path="ext/Callback.c">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>0</itemTool>
+      </item>
+      <item path="ext/MemoryPointer.c">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>3</itemTool>
+      </item>
+      <item path="ext/MemoryPointer.h">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="ext/Platform.c">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>0</itemTool>
+      </item>
+      <item path="ext/Platform.h">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="ext/ffi.c">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>0</itemTool>
+      </item>
+      <item path="ext/rbffi.h">
+        <itemExcluded>true</itemExcluded>
+        <itemTool>3</itemTool>
+      </item>
+      <item path="lib/ffi.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="lib/ffi/ffi.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="lib/ffi/memorypointer.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="lib/ffi/platform.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="lib/ffi/struct.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="specs/buffer_spec.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="specs/callback_spec.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="specs/rbx/attach_function_spec.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="specs/rbx/memory_pointer_spec.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="specs/rbx/spec_helper.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="specs/rbx/struct_spec.rb">
+        <itemTool>3</itemTool>
+      </item>
+      <item path="specs/spec_helper.rb">
+        <itemTool>3</itemTool>
+      </item>
+    </conf>
+  </confs>
+</configurationDescriptor>

data/nbproject/private/configurations.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configurationDescriptor version="47">
+  <projectmakefile>ruby-ffi-Makefile.mk</projectmakefile>
+  <defaultConf>0</defaultConf>
+  <confs>
+    <conf name="Default" type="0">
+      <gdbdebugger version="2">
+        <gdb_command>gdb</gdb_command>
+        <array_repeat_threshold>10</array_repeat_threshold>
+      </gdbdebugger>
+      <runprofile version="5">
+        <args></args>
+        <rundir></rundir>
+        <buildfirst>true</buildfirst>
+        <console-type>0</console-type>
+        <terminal-type>0</terminal-type>
+        <environment>
+        </environment>
+      </runprofile>
+    </conf>
+  </confs>
+</configurationDescriptor>

data/nbproject/private/private.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project-private xmlns="http://www.netbeans.org/ns/project-private/1">
+    <code-assistance-data xmlns="http://www.netbeans.org/ns/make-project-private/1">
+        <code-model-enabled>false</code-model-enabled>
+    </code-assistance-data>
+    <editor-bookmarks xmlns="http://www.netbeans.org/ns/editor-bookmarks/1"/>
+</project-private>

data/nbproject/project.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://www.netbeans.org/ns/project/1">
+    <type>org.netbeans.modules.cnd.makeproject</type>
+    <configuration>
+        <data xmlns="http://www.netbeans.org/ns/make-project/1">
+            <name>ruby-ffi</name>
+            <make-project-type>0</make-project-type>
+            <make-dep-projects/>
+        </data>
+    </configuration>
+</project>

data/samples/getlogin.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'ffi'
+module Foo
+  extend FFI::Library
+  attach_function :getlogin, [ ], :string
+end
+puts "getlogin=#{Foo.getlogin}"

data/samples/getpid.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'ffi'
+module Foo
+  extend FFI::Library
+  attach_function :getpid, [ ], :int
+end
+puts "My pid=#{Foo.getpid}"

data/samples/gettimeofday.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'ffi'
+class Timeval < FFI::Struct
+#  layout :tv_sec => :ulong, :tv_usec => :ulong
+  layout :tv_sec, :ulong, 0, :tv_usec, :ulong, 4
+end
+module LibC
+  extend FFI::Library
+  attach_function :gettimeofday, [ :pointer, :pointer ], :int
+end
+t = Timeval.new
+LibC.gettimeofday(t.pointer, nil)
+puts "t.tv_sec=#{t[:tv_sec]} t.tv_usec=#{t[:tv_usec]}"

data/samples/hello.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'ffi'
+module Foo
+  extend FFI::Library
+  attach_function("cputs", "puts", [ :string ], :int)
+end
+Foo.cputs("Hello, World via libc puts using FFI on MRI ruby")

data/samples/qsort.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'ffi'
+
+module LibC
+  extend FFI::Library
+  callback :qsort_cmp, [ :pointer, :pointer ], :int
+  attach_function :qsort, [ :pointer, :int, :int, :qsort_cmp ], :int
+end
+
+p = MemoryPointer.new(:int, 2)
+p.put_array_of_int32(0, [ 2, 1 ])
+puts "ptr=#{p.inspect}"
+puts "Before qsort #{p.get_array_of_int32(0, 2).join(', ')}"
+LibC.qsort(p, 2, 4) do |p1, p2|
+  i1 = p1.get_int32(0)
+  i2 = p2.get_int32(0)
+  puts "In block: comparing #{i1} and #{i2}"
+  i1 < i2 ? -1 : i1 > i2 ? 1 : 0
+end
+puts "After qsort #{p.get_array_of_int32(0, 2).join(', ')}"

data/specs/buffer_spec.rb

@@ -0,0 +1,141 @@
+require "rubygems"
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_helper"))
+if RUBY_PLATFORM == "java"
+  Buffer = JRuby::FFI::Buffer
+  Platform = JRuby::FFI::Platform
+  LongSize = JRuby::FFI::Platform::LONG_SIZE / 8
+else
+  Buffer = FFI::Buffer
+  Platform = FFI::Platform
+  LongSize = FFI::Platform::LONG_SIZE / 8
+end
+describe "Buffer#total" do
+  [1,2,3].each do |i|
+    { :char => 1, :uchar => 1, :short => 2, :ushort => 2, :int => 4, 
+      :uint => 4, :long => LongSize, :ulong => LongSize, 
+      :long_long => 8, :ulong_long => 8, :float => 4, :double => 8
+    }.each_pair do |t, s|
+      it "Buffer.alloc_in(#{t}, #{i}).total == #{i * s}" do
+        Buffer.alloc_in(t, i).total.should == i * s
+      end
+      it "Buffer.alloc_out(#{t}, #{i}).total == #{i * s}" do
+        Buffer.alloc_out(t, i).total.should == i * s
+      end
+      it "Buffer.alloc_inout(#{t}, #{i}).total == #{i * s}" do
+        Buffer.alloc_inout(t, i).total.should == i * s
+      end
+    end
+  end
+end
+
+describe "Buffer#put_char" do
+  bufsize = 4
+  (0..127).each do |i|
+    (0..bufsize-1).each do |offset|
+      it "put_char(#{offset}, #{i}).get_char(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_char(offset, i).get_char(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_uchar" do
+  bufsize = 4
+  (0..255).each do |i|
+    (0..bufsize-1).each do |offset|
+      it "Buffer.put_uchar(#{offset}, #{i}).get_uchar(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_uchar(offset, i).get_uchar(offset).should == i
+      end
+    end
+  end 
+end
+describe "Buffer#put_short" do
+  bufsize = 4
+  [0, 1, 128, 32767].each do |i|
+    (0..bufsize-2).each do |offset|
+      it "put_short(#{offset}, #{i}).get_short(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_short(offset, i).get_short(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_ushort" do
+  bufsize = 4
+  [ 0, 1, 128, 32767, 65535, 0xfee1, 0xdead, 0xbeef, 0xcafe ].each do |i|
+    (0..bufsize-2).each do |offset|
+      it "put_ushort(#{offset}, #{i}).get_ushort(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_ushort(offset, i).get_ushort(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_int" do
+  bufsize = 8
+  [0, 1, 128, 32767, 0x7ffffff ].each do |i|
+    (0..bufsize-4).each do |offset|
+      it "put_int(#{offset}, #{i}).get_int(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_int(offset, i).get_int(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_uint" do
+  bufsize = 8
+  [ 0, 1, 128, 32767, 65535, 0xfee1dead, 0xcafebabe, 0xffffffff ].each do |i|
+    (0..bufsize-4).each do |offset|
+      it "put_uint(#{offset}, #{i}).get_uint(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_uint(offset, i).get_uint(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_long" do
+  bufsize = 16
+  [0, 1, 128, 32767, 0x7ffffff ].each do |i|
+    (0..bufsize-LongSize).each do |offset|
+      it "put_long(#{offset}, #{i}).get_long(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_long(offset, i).get_long(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_ulong" do
+  bufsize = 16
+  [ 0, 1, 128, 32767, 65535, 0xfee1dead, 0xcafebabe, 0xffffffff ].each do |i|
+    (0..bufsize-LongSize).each do |offset|
+      it "put_ulong(#{offset}, #{i}).get_ulong(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_ulong(offset, i).get_ulong(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_long_long" do
+  bufsize = 16
+  [0, 1, 128, 32767, 0x7ffffffffffffff ].each do |i|
+    (0..bufsize-8).each do |offset|
+      it "put_long_long(#{offset}, #{i}).get_long_long(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_long_long(offset, i).get_long_long(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_ulong_long" do
+  bufsize = 16
+  [ 0, 1, 128, 32767, 65535, 0xdeadcafebabe, 0x7fffffffffffffff ].each do |i|
+    (0..bufsize-8).each do |offset|
+      it "put_ulong_long(#{offset}, #{i}).get_ulong_long(#{offset}) == #{i}" do
+        Buffer.alloc_in(bufsize).put_ulong_long(offset, i).get_ulong_long(offset).should == i
+      end
+    end
+  end
+end
+describe "Buffer#put_pointer" do
+  it "put_pointer(0, p).get_pointer(0) == p" do
+    p = MemoryPointer.new :ulong_long
+    p.put_uint(0, 0xdeadbeef)
+    buf = Buffer.alloc_inout 8
+    p2 = buf.put_pointer(0, p).get_pointer(0)
+    p2.should_not be_nil
+    p2.should == p
+    p2.get_uint(0).should == 0xdeadbeef
+  end
+end

data/specs/callback_spec.rb

@@ -0,0 +1,31 @@
+require 'ffi'
+
+describe "Callback" do
+  module LibC
+    extend FFI::Library
+    callback :qsort_cmp, [ :pointer, :pointer ], :int
+    attach_function :qsort, [ :pointer, :int, :int, :qsort_cmp ], :int
+  end
+  it "arguments get passed correctly" do
+    p = MemoryPointer.new(:int, 2)
+    p.put_array_of_int32(0, [ 1 , 2 ])
+    args = []
+    cmp = proc do |p1, p2| args.push(p1.get_int(0)); args.push(p2.get_int(0)); 0; end
+    # this is a bit dodgey, as it relies on qsort passing the args in order
+    LibC.qsort(p, 2, 4, cmp)
+    args.should == [ 1, 2 ]
+  end
+
+  it "Block can be substituted for Callback as last argument" do
+    p = MemoryPointer.new(:int, 2)
+    p.put_array_of_int32(0, [ 1 , 2 ])
+    args = []
+    # this is a bit dodgey, as it relies on qsort passing the args in order
+    LibC.qsort(p, 2, 4) do |p1, p2| 
+      args.push(p1.get_int(0))
+      args.push(p2.get_int(0))
+      0
+    end
+    args.should == [ 1, 2 ]
+  end  
+end