ffi 1.9.25 → 1.12.2

data/lib/ffi/platform/x86_64-windows/types.conf

@@ -1,120 +1,120 @@
-rbx.platform.typedef.__int8_t = char
-rbx.platform.typedef.__uint8_t = uchar
+rbx.platform.typedef.*addr_t = char
+rbx.platform.typedef.__ULong = ulong
+rbx.platform.typedef.__blkcnt32_t = long
+rbx.platform.typedef.__blkcnt64_t = long_long
+rbx.platform.typedef.__dev16_t = short
+rbx.platform.typedef.__dev32_t = ulong
+rbx.platform.typedef.__dev_t = short
+rbx.platform.typedef.__gid16_t = ushort
+rbx.platform.typedef.__gid32_t = ulong
+rbx.platform.typedef.__gid_t = ushort
+rbx.platform.typedef.__ino32_t = ulong
+rbx.platform.typedef.__ino64_t = ulong_long
 rbx.platform.typedef.__int16_t = short
-rbx.platform.typedef.__uint16_t = ushort
-rbx.platform.typedef.__int_least16_t = short
-rbx.platform.typedef.__uint_least16_t = ushort
 rbx.platform.typedef.__int32_t = int
-rbx.platform.typedef.__uint32_t = uint
-rbx.platform.typedef.__int_least32_t = int
-rbx.platform.typedef.__uint_least32_t = uint
 rbx.platform.typedef.__int64_t = long_long
-rbx.platform.typedef.__uint64_t = ulong_long
-rbx.platform.typedef._off_t = long
-rbx.platform.typedef.__dev_t = short
+rbx.platform.typedef.__int8_t = char
+rbx.platform.typedef.__int_least16_t = short
+rbx.platform.typedef.__int_least32_t = int
+rbx.platform.typedef.__loff_t = long_long
+rbx.platform.typedef.__off_t = long
+rbx.platform.typedef.__pid_t = int
+rbx.platform.typedef.__time32_t = long
+rbx.platform.typedef.__time64_t = long_long
+rbx.platform.typedef.__uid16_t = ushort
+rbx.platform.typedef.__uid32_t = ulong
 rbx.platform.typedef.__uid_t = ushort
-rbx.platform.typedef.__gid_t = ushort
-rbx.platform.typedef._off64_t = long_long
-rbx.platform.typedef.fpos_t = long_long
-rbx.platform.typedef._fpos_t = long_long
+rbx.platform.typedef.__uint16_t = ushort
+rbx.platform.typedef.__uint32_t = uint
+rbx.platform.typedef.__uint64_t = ulong_long
+rbx.platform.typedef.__uint8_t = uchar
+rbx.platform.typedef.__uint_least16_t = ushort
+rbx.platform.typedef.__uint_least32_t = uint
+rbx.platform.typedef._dev_t = uint
 rbx.platform.typedef._fpos64_t = long_long
+rbx.platform.typedef._fpos_t = long_long
+rbx.platform.typedef._ino_t = ushort
+rbx.platform.typedef._mode_t = ushort
+rbx.platform.typedef._off64_t = long_long
+rbx.platform.typedef._off_t = long
+rbx.platform.typedef._sigset_t = ulong_long
 rbx.platform.typedef._ssize_t = long_long
-rbx.platform.typedef.wchar_t = ushort
-rbx.platform.typedef.wint_t = uint
-rbx.platform.typedef.wctype_t = ushort
-rbx.platform.typedef.ptrdiff_t = long_long
-rbx.platform.typedef.size_t = ulong_long
-rbx.platform.typedef.__off_t = long
-rbx.platform.typedef.__pid_t = int
-rbx.platform.typedef.__loff_t = long_long
-rbx.platform.typedef.u_char = uchar
-rbx.platform.typedef.u_short = ushort
-rbx.platform.typedef.u_int = uint
-rbx.platform.typedef.u_long = ulong
-rbx.platform.typedef.ushort = ushort
-rbx.platform.typedef.uint = uint
-rbx.platform.typedef.ulong = ulong
+rbx.platform.typedef.blkcnt_t = long_long
+rbx.platform.typedef.blksize_t = long
+rbx.platform.typedef.caddr_t = string
 rbx.platform.typedef.clock_t = ulong
-rbx.platform.typedef.time_t = long_long
+rbx.platform.typedef.clockid_t = ulong
 rbx.platform.typedef.daddr_t = long
-rbx.platform.typedef.caddr_t = string
-rbx.platform.typedef.pid_t = int
-rbx.platform.typedef.ssize_t = int
-rbx.platform.typedef.nlink_t = ushort
+rbx.platform.typedef.dev_t = uint
+rbx.platform.typedef.errno_t = int
 rbx.platform.typedef.fd_mask = long
-rbx.platform.typedef.clockid_t = ulong
-rbx.platform.typedef.timer_t = ulong
-rbx.platform.typedef.useconds_t = ulong
-rbx.platform.typedef.suseconds_t = long
-rbx.platform.typedef.int8_t = char
+rbx.platform.typedef.fpos_t = long_long
+rbx.platform.typedef.fsblkcnt_t = ulong
+rbx.platform.typedef.fsfilcnt_t = ulong
+rbx.platform.typedef.gid_t = ulong
+rbx.platform.typedef.id_t = ulong
+rbx.platform.typedef.ino_t = ushort
 rbx.platform.typedef.int16_t = short
 rbx.platform.typedef.int32_t = int
 rbx.platform.typedef.int64_t = long_long
-rbx.platform.typedef.uint8_t = uchar
-rbx.platform.typedef.uint16_t = ushort
-rbx.platform.typedef.uint32_t = uint
-rbx.platform.typedef.uint64_t = ulong_long
-rbx.platform.typedef.int_least8_t = char
-rbx.platform.typedef.int_least16_t = short
-rbx.platform.typedef.int_least32_t = int
-rbx.platform.typedef.int_least64_t = long_long
-rbx.platform.typedef.uint_least8_t = uchar
-rbx.platform.typedef.uint_least16_t = ushort
-rbx.platform.typedef.uint_least32_t = uint
-rbx.platform.typedef.uint_least64_t = ulong_long
-rbx.platform.typedef.int_fast8_t = char
+rbx.platform.typedef.int8_t = char
 rbx.platform.typedef.int_fast16_t = int
 rbx.platform.typedef.int_fast32_t = int
 rbx.platform.typedef.int_fast64_t = long_long
-rbx.platform.typedef.uint_fast8_t = uchar
+rbx.platform.typedef.int_fast8_t = char
+rbx.platform.typedef.int_least16_t = short
+rbx.platform.typedef.int_least32_t = int
+rbx.platform.typedef.int_least64_t = long_long
+rbx.platform.typedef.int_least8_t = char
+rbx.platform.typedef.intmax_t = long_long
+rbx.platform.typedef.intptr_t = long_long
+rbx.platform.typedef.key_t = long_long
+rbx.platform.typedef.loff_t = long_long
+rbx.platform.typedef.mode_t = ushort
+rbx.platform.typedef.nlink_t = ushort
+rbx.platform.typedef.off_t = long_long
+rbx.platform.typedef.pid_t = int
+rbx.platform.typedef.ptrdiff_t = long_long
+rbx.platform.typedef.register_t = int
+rbx.platform.typedef.rlim_t = ulong
+rbx.platform.typedef.sa_family_t = ushort
+rbx.platform.typedef.sig_atomic_t = int
+rbx.platform.typedef.sigset_t = ulong
+rbx.platform.typedef.size_t = ulong_long
+rbx.platform.typedef.socklen_t = int
+rbx.platform.typedef.ssize_t = int
+rbx.platform.typedef.suseconds_t = long
+rbx.platform.typedef.time_t = long_long
+rbx.platform.typedef.timer_t = ulong
+rbx.platform.typedef.u_char = uchar
+rbx.platform.typedef.u_int = uint
+rbx.platform.typedef.u_int16_t = ushort
+rbx.platform.typedef.u_int32_t = uint
+rbx.platform.typedef.u_int64_t = ulong_long
+rbx.platform.typedef.u_int8_t = uchar
+rbx.platform.typedef.u_long = ulong
+rbx.platform.typedef.u_short = ushort
+rbx.platform.typedef.uid_t = ulong
+rbx.platform.typedef.uint = uint
+rbx.platform.typedef.uint16_t = ushort
+rbx.platform.typedef.uint32_t = uint
+rbx.platform.typedef.uint64_t = ulong_long
+rbx.platform.typedef.uint8_t = uchar
 rbx.platform.typedef.uint_fast16_t = uint
 rbx.platform.typedef.uint_fast32_t = uint
 rbx.platform.typedef.uint_fast64_t = ulong_long
-rbx.platform.typedef.intptr_t = long_long
-rbx.platform.typedef.uintptr_t = ulong_long
-rbx.platform.typedef.intmax_t = long_long
+rbx.platform.typedef.uint_fast8_t = uchar
+rbx.platform.typedef.uint_least16_t = ushort
+rbx.platform.typedef.uint_least32_t = uint
+rbx.platform.typedef.uint_least64_t = ulong_long
+rbx.platform.typedef.uint_least8_t = uchar
 rbx.platform.typedef.uintmax_t = ulong_long
-rbx.platform.typedef.off_t = long_long
-rbx.platform.typedef.loff_t = long_long
-rbx.platform.typedef.__dev16_t = short
-rbx.platform.typedef.__dev32_t = ulong
-rbx.platform.typedef._dev_t = uint
-rbx.platform.typedef.dev_t = uint
-rbx.platform.typedef.blksize_t = long
-rbx.platform.typedef.__blkcnt32_t = long
-rbx.platform.typedef.__blkcnt64_t = long_long
-rbx.platform.typedef.blkcnt_t = long_long
-rbx.platform.typedef.fsblkcnt_t = ulong
-rbx.platform.typedef.fsfilcnt_t = ulong
-rbx.platform.typedef.__uid16_t = ushort
-rbx.platform.typedef.__uid32_t = ulong
-rbx.platform.typedef.uid_t = ulong
-rbx.platform.typedef.__gid16_t = ushort
-rbx.platform.typedef.__gid32_t = ulong
-rbx.platform.typedef.gid_t = ulong
-rbx.platform.typedef.__ino32_t = ulong
-rbx.platform.typedef.__ino64_t = ulong_long
-rbx.platform.typedef.ino_t = ushort
-rbx.platform.typedef._ino_t = ushort
-rbx.platform.typedef.id_t = ulong
-rbx.platform.typedef.key_t = long_long
+rbx.platform.typedef.uintptr_t = ulong_long
+rbx.platform.typedef.ulong = ulong
+rbx.platform.typedef.useconds_t = ulong
+rbx.platform.typedef.ushort = ushort
 rbx.platform.typedef.vm_offset_t = ulong
 rbx.platform.typedef.vm_size_t = ulong
-rbx.platform.typedef.u_int8_t = uchar
-rbx.platform.typedef.u_int16_t = ushort
-rbx.platform.typedef.u_int32_t = uint
-rbx.platform.typedef.u_int64_t = ulong_long
-rbx.platform.typedef.register_t = int
-rbx.platform.typedef.*addr_t = char
-rbx.platform.typedef.socklen_t = int
-rbx.platform.typedef.sa_family_t = ushort
-rbx.platform.typedef.__ULong = ulong
-rbx.platform.typedef.sigset_t = ulong
-rbx.platform.typedef.sig_atomic_t = int
-rbx.platform.typedef.rlim_t = ulong
-rbx.platform.typedef._sigset_t = ulong_long
-rbx.platform.typedef.__time32_t = long
-rbx.platform.typedef.__time64_t = long_long
-rbx.platform.typedef.errno_t = int
-rbx.platform.typedef._mode_t = ushort
-rbx.platform.typedef.mode_t = ushort
+rbx.platform.typedef.wchar_t = ushort
+rbx.platform.typedef.wctype_t = ushort
+rbx.platform.typedef.wint_t = uint

data/lib/ffi/platform.rb

@@ -46,6 +46,8 @@ module FFI
       "netbsd"
     when /openbsd/
       "openbsd"
+    when /dragonfly/
+      "dragonflybsd"
     when /sunos|solaris/
       "solaris"
     when /mingw|mswin/
@@ -54,6 +56,10 @@ module FFI
       RbConfig::CONFIG['host_os'].downcase
     end
 
+    OSVERSION = RbConfig::CONFIG['host_os'].gsub(/[^\d]/, '').to_i
+
+    CPU = RbConfig::CONFIG['host_cpu']
+
     ARCH = case CPU.downcase
     when /amd64|x86_64/
       "x86_64"
@@ -82,16 +88,21 @@ module FFI
       OS == os
     end
 
-    NAME = "#{ARCH}-#{OS}"
     IS_GNU = defined?(GNU_LIBC)
     IS_LINUX = is_os("linux")
     IS_MAC = is_os("darwin")
     IS_FREEBSD = is_os("freebsd")
     IS_NETBSD = is_os("netbsd")
     IS_OPENBSD = is_os("openbsd")
+    IS_DRAGONFLYBSD = is_os("dragonfly")
     IS_SOLARIS = is_os("solaris")
     IS_WINDOWS = is_os("windows")
-    IS_BSD = IS_MAC || IS_FREEBSD || IS_NETBSD || IS_OPENBSD
+    IS_BSD = IS_MAC || IS_FREEBSD || IS_NETBSD || IS_OPENBSD || IS_DRAGONFLYBSD
+
+    # Add the version for known ABI breaks
+    name_version = "12" if IS_FREEBSD && OSVERSION >= 12 # 64-bit inodes
+
+    NAME = "#{ARCH}-#{OS}#{name_version}"
     CONF_DIR = File.join(File.dirname(__FILE__), 'platform', NAME)
 
     public

data/lib/ffi/pointer.rb

@@ -49,7 +49,7 @@ module FFI
     # equivalent string if +len+ is not +nil+.
     def read_string(len=nil)
       if len
-        return '' if len == 0
+        return ''.b if len == 0
         get_bytes(0, len)
       else
         get_string(0)
@@ -103,7 +103,7 @@ module FFI
     # @return [Array]
     # Read an array of +type+ of length +length+.
     # @example
-    #  ptr.read_array_of_type(TYPE_UINT8, :get_uint8, 4) # -> [1, 2, 3, 4]
+    #  ptr.read_array_of_type(TYPE_UINT8, :read_uint8, 4) # -> [1, 2, 3, 4]
     def read_array_of_type(type, reader, length)
       ary = []
       size = FFI.type_size(type)
@@ -124,10 +124,9 @@ module FFI
     #  ptr.write_array_of_type(TYPE_UINT8, :put_uint8, [1, 2, 3 ,4])
     def write_array_of_type(type, writer, ary)
       size = FFI.type_size(type)
-      tmp = self
-      ary.each_with_index {|i, j|
-        tmp.send(writer, i)
-        tmp += size unless j == ary.length-1 # avoid OOB
+      ary.each_with_index { |val, i|
+        break unless i < self.size
+        self.send(writer, i * size, val)
       }
       self
     end

data/lib/ffi/struct.rb

@@ -32,72 +32,12 @@
 #
 
 require 'ffi/platform'
+require 'ffi/struct_layout'
 require 'ffi/struct_layout_builder'
+require 'ffi/struct_by_reference'
 
 module FFI
 
-  class StructLayout
-
-    # @return [Array<Array(Symbol, Numeric)>
-    # Get an array of tuples (field name, offset of the field).
-    def offsets
-      members.map { |m| [ m, self[m].offset ] }
-    end
-
-    # @return [Numeric]
-    # Get the offset of a field.
-    def offset_of(field_name)
-      self[field_name].offset
-    end
-
-    # An enum {Field} in a {StructLayout}.
-    class Enum < Field
-
-      # @param [AbstractMemory] ptr pointer on a {Struct}
-      # @return [Object]
-      # Get an object of type {#type} from memory pointed by +ptr+.
-      def get(ptr)
-        type.find(ptr.get_int(offset))
-      end
-
-      # @param [AbstractMemory] ptr pointer on a {Struct}
-      # @param  value
-      # @return [nil]
-      # Set +value+ into memory pointed by +ptr+.
-      def put(ptr, value)
-        ptr.put_int(offset, type.find(value))
-      end
-
-    end
-
-    class InnerStruct < 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)
-       ptr.slice(self.offset, self.size).__copy_from__(value.pointer, self.size)
-     end
-    end
-
-    class Mapped < Field
-      def initialize(name, offset, type, orig_field)
-        super(name, offset, type)
-        @orig_field = orig_field
-      end
-
-      def get(ptr)
-        type.from_native(@orig_field.get(ptr), nil)
-      end
-
-      def put(ptr, value)
-        @orig_field.put(ptr, type.to_native(value, nil))
-      end
-    end
-  end
-
-  
   class Struct
 
     # Get struct size
@@ -250,7 +190,7 @@ module FFI
       #             :field2, :pointer, 6,  # set offset to 6 for this field
       #             :field3, :string
       #    end
-      #  @example Creating a layout from a hash +spec+ (Ruby 1.9 only)
+      #  @example Creating a layout from a hash +spec+
       #    class MyStructFromHash < Struct
       #      layout :field1 => :int,
       #             :field2 => :pointer,
@@ -262,9 +202,8 @@ module FFI
       #             :function2, callback([:pointer], :void),
       #             :field3, :string
       #    end
-      #  @note Creating a layout from a hash +spec+ is supported only for Ruby 1.9.
       def layout(*spec)
-        #raise RuntimeError, "struct layout already defined for #{self.inspect}" if defined?(@layout)
+        warn "[DEPRECATION] Struct layout is already defined for class #{self.inspect}. Redefinition as in #{caller[0]} will be disallowed in ffi-2.0." if defined?(@layout)
         return @layout if spec.size == 0
 
         builder = StructLayoutBuilder.new
@@ -296,7 +235,7 @@ module FFI
         @packed = packed
       end
       alias :pack :packed
-      
+
       def aligned(alignment = 1)
         @min_alignment = alignment
       end

data/lib/ffi/struct_by_reference.rb

@@ -0,0 +1,72 @@
+#
+# Copyright (C) 2010 Wayne Meissner
+#
+# This file is part of ruby-ffi.
+#
+# 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 Ruby FFI project 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
+  # This class includes the {FFI::DataConverter} module.
+  class StructByReference
+    include DataConverter
+
+    attr_reader :struct_class
+
+    # @param [Struct] struct_class
+    def initialize(struct_class)
+      unless Class === struct_class and struct_class < FFI::Struct
+        raise TypeError, 'wrong type (expected subclass of FFI::Struct)'
+      end
+      @struct_class = struct_class
+    end
+
+    # Always get {FFI::Type}::POINTER.
+    def native_type
+      FFI::Type::POINTER
+    end
+
+    # @param [nil, Struct] value
+    # @param [nil] ctx
+    # @return [AbstractMemory] Pointer on +value+.
+    def to_native(value, ctx)
+      return Pointer::NULL if value.nil?
+
+      unless @struct_class === value
+        raise TypeError, "wrong argument type #{value.class} (expected #{@struct_class})"
+      end
+
+      value.pointer
+    end
+
+    # @param [AbstractMemory] value
+    # @param [nil] ctx
+    # @return [Struct]
+    # Create a struct from content of memory +value+.
+    def from_native(value, ctx)
+      @struct_class.new(value)
+    end
+  end
+end

data/lib/ffi/struct_layout.rb

@@ -0,0 +1,96 @@
+#
+# Copyright (C) 2008-2010 Wayne Meissner
+# Copyright (C) 2008, 2009 Andrea Fazzi
+# Copyright (C) 2008, 2009 Luc Heinrich
+#
+# This file is part of ruby-ffi.
+#
+# 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 Ruby FFI project 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 StructLayout
+
+    # @return [Array<Array(Symbol, Numeric)>
+    # Get an array of tuples (field name, offset of the field).
+    def offsets
+      members.map { |m| [ m, self[m].offset ] }
+    end
+
+    # @return [Numeric]
+    # Get the offset of a field.
+    def offset_of(field_name)
+      self[field_name].offset
+    end
+
+    # An enum {Field} in a {StructLayout}.
+    class Enum < Field
+
+      # @param [AbstractMemory] ptr pointer on a {Struct}
+      # @return [Object]
+      # Get an object of type {#type} from memory pointed by +ptr+.
+      def get(ptr)
+        type.find(ptr.get_int(offset))
+      end
+
+      # @param [AbstractMemory] ptr pointer on a {Struct}
+      # @param  value
+      # @return [nil]
+      # Set +value+ into memory pointed by +ptr+.
+      def put(ptr, value)
+        ptr.put_int(offset, type.find(value))
+      end
+
+    end
+
+    class InnerStruct < 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)
+       ptr.slice(self.offset, self.size).__copy_from__(value.pointer, self.size)
+     end
+    end
+
+    class Mapped < Field
+      def initialize(name, offset, type, orig_field)
+        super(name, offset, type)
+        @orig_field = orig_field
+      end
+
+      def get(ptr)
+        type.from_native(@orig_field.get(ptr), nil)
+      end
+
+      def put(ptr, value)
+        @orig_field.put(ptr, type.to_native(value, nil))
+      end
+    end
+  end
+end

data/lib/ffi/tools/const_generator.rb

@@ -6,6 +6,7 @@ module FFI
   # ConstGenerator turns C constants into ruby values.
   #
   # @example a simple example for stdio
+  #  require 'ffi/tools/const_generator'
   #  cg = FFI::ConstGenerator.new('stdio') do |gen|
   #    gen.const(:SEEK_SET)
   #    gen.const('SEEK_CUR')
@@ -25,10 +26,10 @@ module FFI
     #
     # The only option is +:required+, which if set to +true+ raises an error if a
     # constant you have requested was not found.
-    # 
+    #
     # @param [#to_s] prefix
     # @param [Hash] options
-    # @return 
+    # @return
     # @option options [Boolean] :required
     # @overload initialize(prefix, options)
     # @overload initialize(prefix, options) { |gen| ... }
@@ -79,7 +80,7 @@ module FFI
     #  @param [#call] converter convert the value from a string to the appropriate
     #   type for {#to_ruby}.
     # @overload const(name, format=nil, cast='', ruby_name=nil) { |value| ... }
-    #  Use a converter block. This block convert the value from a string to the 
+    #  Use a converter block. This block convert the value from a string to the
     #  appropriate type for {#to_ruby}.
     #  @yieldparam value constant value
     def const(name, format = nil, cast = '', ruby_name = nil, converter = nil,
@@ -224,6 +225,6 @@ module FFI
       "#{ruby_name} = #{converted_value}"
     end
 
-  end  
+  end
 
 end

data/lib/ffi/tools/generator.rb

@@ -1,6 +1,51 @@
+require 'ffi/tools/struct_generator'
+require 'ffi/tools/const_generator'
+
 module FFI
 
-  # @private
+  ##
+  # Generate files with C structs for FFI::Struct and C constants.
+  #
+  # == A simple example
+  #
+  # In file +zlib.rb.ffi+:
+  #   module Zlib
+  #     @@@
+  #     constants do |c|
+  #       c.include "zlib.h"
+  #       c.const :ZLIB_VERNUM
+  #     end
+  #     @@@
+  #
+  #     class ZStream < FFI::Struct
+  #
+  #       struct do |s|
+  #         s.name "struct z_stream_s"
+  #         s.include "zlib.h"
+  #
+  #         s.field :next_in,   :pointer
+  #         s.field :avail_in,  :uint
+  #         s.field :total_in,  :ulong
+  #       end
+  #       @@@
+  #     end
+  #   end
+  #
+  # Translate the file:
+  #   require "ffi/tools/generator"
+  #   FFI::Generator.new "zlib.rb.ffi", "zlib.rb"
+  #
+  # Generates the file +zlib.rb+ with constant values and offsets:
+  #   module Zlib
+  #   ZLIB_VERNUM = 4784
+  #
+  #   class ZStream < FFI::Struct
+  #     layout :next_in, :pointer, 0,
+  #            :avail_in, :uint, 8,
+  #            :total_in, :ulong, 16
+  #   end
+  #
+  # @see FFI::Generator::Task for easy integration in a Rakefile
   class Generator
 
     def initialize(ffi_name, rb_name, options = {})
@@ -34,7 +79,7 @@ module FFI
       end
 
       open @rb_name, 'w' do |f|
-        f.puts "# This file is generated by rake. Do not edit."
+        f.puts "# This file is generated from `#{@ffi_name}'. Do not edit."
         f.puts
         f.puts new_file
       end