ffi 1.9.24 → 1.16.3

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

@@ -1,120 +1,52 @@
-rbx.platform.typedef.__int8_t = char
-rbx.platform.typedef.__uint8_t = uchar
-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.__uid_t = ushort
-rbx.platform.typedef.__gid_t = ushort
+rbx.platform.typedef.__time32_t = long
+rbx.platform.typedef.__time64_t = long_long
+rbx.platform.typedef._dev_t = uint
+rbx.platform.typedef._ino_t = ushort
+rbx.platform.typedef._mode_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._fpos64_t = long_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.clock_t = ulong
-rbx.platform.typedef.time_t = long_long
-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.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._off_t = long
+rbx.platform.typedef._pid_t = long_long
+rbx.platform.typedef._sigset_t = ulong_long
+rbx.platform.typedef.dev_t = uint
+rbx.platform.typedef.errno_t = int
+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.int8_t = char
+rbx.platform.typedef.int_fast16_t = short
+rbx.platform.typedef.int_fast32_t = int
+rbx.platform.typedef.int_fast64_t = long_long
+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.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.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.uint_fast16_t = uint
+rbx.platform.typedef.int_least8_t = char
+rbx.platform.typedef.intmax_t = long_long
+rbx.platform.typedef.intptr_t = long_long
+rbx.platform.typedef.mode_t = ushort
+rbx.platform.typedef.off32_t = long
+rbx.platform.typedef.off64_t = long_long
+rbx.platform.typedef.off_t = long_long
+rbx.platform.typedef.pid_t = long_long
+rbx.platform.typedef.ptrdiff_t = long_long
+rbx.platform.typedef.rsize_t = ulong_long
+rbx.platform.typedef.size_t = ulong_long
+rbx.platform.typedef.ssize_t = long_long
+rbx.platform.typedef.time_t = long_long
+rbx.platform.typedef.uint16_t = ushort
+rbx.platform.typedef.uint64_t = ulong_long
+rbx.platform.typedef.uint8_t = uchar
+rbx.platform.typedef.uint_fast16_t = ushort
 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_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.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.uintptr_t = ulong_long
+rbx.platform.typedef.useconds_t = uint
+rbx.platform.typedef.wchar_t = ushort
+rbx.platform.typedef.wctype_t = ushort
+rbx.platform.typedef.wint_t = ushort

data/lib/ffi/platform.rb

@@ -29,13 +29,15 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.#
 
 require 'rbconfig'
+require_relative 'compat'
+
 module FFI
   class PlatformError < LoadError; end
 
   # This module defines different constants and class methods to play with
   # various platforms.
   module Platform
-    OS = case RbConfig::CONFIG['host_os'].downcase
+    OS = FFI.make_shareable(case RbConfig::CONFIG['host_os'].downcase
     when /linux/
       "linux"
     when /darwin/
@@ -46,18 +48,24 @@ module FFI
       "netbsd"
     when /openbsd/
       "openbsd"
+    when /dragonfly/
+      "dragonflybsd"
     when /sunos|solaris/
       "solaris"
     when /mingw|mswin/
       "windows"
     else
       RbConfig::CONFIG['host_os'].downcase
-    end
+    end)
+
+    OSVERSION = RbConfig::CONFIG['host_os'].gsub(/[^\d]/, '').to_i
+
+    CPU = FFI.make_shareable(RbConfig::CONFIG['host_cpu'])
 
-    ARCH = case CPU.downcase
-    when /amd64|x86_64/
+    ARCH = FFI.make_shareable(case CPU.downcase
+    when /amd64|x86_64|x64/
       "x86_64"
-    when /i?86|x86|i86pc/
+    when /i\d86|x86|i86pc/
       "i386"
     when /ppc64|powerpc64/
       "powerpc64"
@@ -65,14 +73,17 @@ module FFI
       "powerpc"
     when /sparcv9|sparc64/
       "sparcv9"
-    else
-      case RbConfig::CONFIG['host_cpu']
-      when /^arm/
-        "arm"
+    when /arm64|aarch64/  # MacOS calls it "arm64", other operating systems "aarch64"
+      "aarch64"
+    when /^arm/
+      if OS == "darwin"   # Ruby before 3.0 reports "arm" instead of "arm64" as host_cpu on darwin
+        "aarch64"
       else
-        RbConfig::CONFIG['host_cpu']
+        "arm"
       end
-    end
+    else
+      RbConfig::CONFIG['host_cpu']
+    end)
 
     private
     # @param [String) os
@@ -82,30 +93,35 @@ 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
-    CONF_DIR = File.join(File.dirname(__FILE__), 'platform', NAME)
+    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 = FFI.make_shareable("#{ARCH}-#{OS}#{name_version}")
+    CONF_DIR = FFI.make_shareable(File.join(File.dirname(__FILE__), 'platform', NAME))
 
     public
 
-    LIBPREFIX = case OS
+    LIBPREFIX = FFI.make_shareable(case OS
     when /windows|msys/
       ''
     when /cygwin/
       'cyg'
     else
       'lib'
-    end
+    end)
 
-    LIBSUFFIX = case OS
+    LIBSUFFIX = FFI.make_shareable(case OS
     when /darwin/
       'dylib'
     when /linux|bsd|solaris/
@@ -115,10 +131,11 @@ module FFI
     else
       # Punt and just assume a sane unix (i.e. anything but AIX)
       'so'
-    end
+    end)
 
-    LIBC = if IS_WINDOWS
-      RbConfig::CONFIG['RUBY_SO_NAME'].split('-')[-2] + '.dll'
+    LIBC = FFI.make_shareable(if IS_WINDOWS
+      crtname = RbConfig::CONFIG["RUBY_SO_NAME"][/msvc\w+/] || 'ucrtbase'
+      "#{crtname}.dll"
     elsif IS_GNU
       GNU_LIBC
     elsif OS == 'cygwin'
@@ -128,6 +145,12 @@ module FFI
       "msys-2.0.dll"
     else
       "#{LIBPREFIX}c.#{LIBSUFFIX}"
+    end)
+
+    LITTLE_ENDIAN = 1234 unless defined?(LITTLE_ENDIAN)
+    BIG_ENDIAN = 4321 unless defined?(BIG_ENDIAN)
+    unless defined?(BYTE_ORDER)
+      BYTE_ORDER = [0x12345678].pack("I") == [0x12345678].pack("N") ? BIG_ENDIAN : LITTLE_ENDIAN
     end
 
     # Test if current OS is a *BSD (include MAC)

data/lib/ffi/pointer.rb

@@ -31,30 +31,37 @@
 #
 
 require 'ffi/platform'
+
+# NOTE: all method definitions in this file are conditional on
+# whether they are not already defined. This is needed because
+# some Ruby implementations (e.g., TruffleRuby) might already
+# provide these methods due to using FFI internally, and we
+# should not override them to avoid warnings.
+
 module FFI
   class Pointer
 
     # Pointer size
-    SIZE = Platform::ADDRESS_SIZE / 8
+    SIZE = Platform::ADDRESS_SIZE / 8 unless const_defined?(:SIZE)
 
     # Return the size of a pointer on the current platform, in bytes
     # @return [Numeric]
     def self.size
       SIZE
-    end
+    end unless respond_to?(:size)
 
     # @param [nil,Numeric] len length of string to return
     # @return [String]
-    # Read pointer's contents as a string, or the first +len+ bytes of the 
+    # Read pointer's contents as a string, or the first +len+ bytes of the
     # 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)
       end
-    end
+    end unless method_defined?(:read_string)
 
     # @param [Numeric] len length of string to return
     # @return [String]
@@ -64,7 +71,7 @@ module FFI
     #  ptr.read_string(len)  # with len not nil
     def read_string_length(len)
       get_bytes(0, len)
-    end
+    end unless method_defined?(:read_string_length)
 
     # @return [String]
     # Read pointer's contents as a string.
@@ -73,7 +80,7 @@ module FFI
     #  ptr.read_string  # with no len
     def read_string_to_null
       get_string(0)
-    end
+    end unless method_defined?(:read_string_to_null)
 
     # @param [String] str string to write
     # @param [Numeric] len length of string to return
@@ -84,18 +91,18 @@ module FFI
     #  ptr.write_string(str, len)   # with len not nil
     def write_string_length(str, len)
       put_bytes(0, str, 0, len)
-    end
+    end unless method_defined?(:write_string_length)
 
     # @param [String] str string to write
     # @param [Numeric] len length of string to return
     # @return [self]
-    # Write +str+ in pointer's contents, or first +len+ bytes if 
+    # Write +str+ in pointer's contents, or first +len+ bytes if
     # +len+ is not +nil+.
     def write_string(str, len=nil)
       len = str.bytesize unless len
       # Write the string data without NUL termination
       put_bytes(0, str, 0, len)
-    end
+    end unless method_defined?(:write_string)
 
     # @param [Type] type type of data to read from pointer's contents
     # @param [Symbol] reader method to send to +self+ to read +type+
@@ -103,7 +110,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)
@@ -113,7 +120,7 @@ module FFI
         tmp += size unless j == length-1 # avoid OOB
       }
       ary
-    end
+    end unless method_defined?(:read_array_of_type)
 
     # @param [Type] type type of data to write to pointer's contents
     # @param [Symbol] writer method to send to +self+ to write +type+
@@ -124,18 +131,17 @@ 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
+    end unless method_defined?(:write_array_of_type)
 
     # @return [self]
     def to_ptr
       self
-    end
+    end unless method_defined?(:to_ptr)
 
     # @param [Symbol,Type] type of data to read
     # @return [Object]
@@ -145,7 +151,7 @@ module FFI
     #  ptr.get(type, 0)
     def read(type)
       get(type, 0)
-    end
+    end unless method_defined?(:read)
 
     # @param [Symbol,Type] type of data to read
     # @param [Object] value to write
@@ -156,6 +162,6 @@ module FFI
     #  ptr.put(type, 0)
     def write(type, value)
       put(type, 0, value)
-    end
+    end unless method_defined?(:write)
   end
 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,11 +202,11 @@ 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)
         return @layout if spec.size == 0
 
+        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)
+
         builder = StructLayoutBuilder.new
         builder.union = self < Union
         builder.packed = @packed if defined?(@packed)
@@ -289,14 +229,18 @@ module FFI
 
       def callback(params, ret)
         mod = enclosing_module
-        FFI::CallbackInfo.new(find_type(ret, mod), params.map { |e| find_type(e, mod) })
+        ret_type = find_type(ret, mod)
+        if ret_type == Type::STRING
+          raise TypeError, ":string is not allowed as return type of callbacks"
+        end
+        FFI::CallbackInfo.new(ret_type, params.map { |e| find_type(e, mod) })
       end
 
       def packed(packed = 1)
         @packed = packed
       end
       alias :pack :packed
-      
+
       def aligned(alignment = 1)
         @min_alignment = alignment
       end
@@ -305,7 +249,9 @@ module FFI
       def enclosing_module
         begin
           mod = self.name.split("::")[0..-2].inject(Object) { |obj, c| obj.const_get(c) }
-          (mod < FFI::Library || mod < FFI::Struct || mod.respond_to?(:find_type)) ? mod : nil
+          if mod.respond_to?(:find_type) && (mod.is_a?(FFI::Library) || mod < FFI::Struct)
+            mod
+          end
         rescue Exception
           nil
         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