fiddle 1.0.0 → 1.0.1

data/ext/fiddle/win32/libffi-config.rb

@@ -32,7 +32,7 @@ IO.foreach("#{srcdir}/configure.ac") do |line|
   end
 end
 
-builddir = srcdir == "." ? enable['builddir'] : "."
+builddir = srcdir == "." ? (enable['builddir'] || ".") : "."
 conf['TARGET'] = /^x64/ =~ host ? "X86_WIN64" : "X86_WIN32"
 
 FileUtils.mkdir_p([builddir, "#{builddir}/include", "#{builddir}/src/x86"])

data/fiddle.gemspec

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
+
+version_module = Module.new do
+  version_rb = File.join(__dir__, "lib/fiddle/version.rb")
+  module_eval(File.read(version_rb), version_rb, __LINE__)
+end
+
 Gem::Specification.new do |spec|
   spec.name          = "fiddle"
-  spec.version       = '1.0.0'
+  spec.version       = version_module::Fiddle::VERSION
   spec.authors       = ["Aaron Patterson", "SHIBATA Hiroshi"]
   spec.email         = ["aaron@tenderlovemaking.com", "hsbt@ruby-lang.org"]
 
@@ -10,14 +16,50 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ruby/fiddle"
   spec.license       = "BSD-2-Clause"
 
-  spec.files         = [".gitignore", ".travis.yml", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "ext/fiddle/closure.c", "ext/fiddle/closure.h", "ext/fiddle/conversions.c", "ext/fiddle/conversions.h", "ext/fiddle/extconf.rb", "ext/fiddle/extlibs", "ext/fiddle/fiddle.c", "ext/fiddle/fiddle.h", "ext/fiddle/function.c", "ext/fiddle/function.h", "ext/fiddle/handle.c", "ext/fiddle/pointer.c", "ext/fiddle/win32/fficonfig.h", "ext/fiddle/win32/libffi-3.2.1-mswin.patch", "ext/fiddle/win32/libffi-config.rb", "ext/fiddle/win32/libffi.mk.tmpl", "fiddle.gemspec", "lib/fiddle.rb", "lib/fiddle/closure.rb", "lib/fiddle/cparser.rb", "lib/fiddle/function.rb", "lib/fiddle/import.rb", "lib/fiddle/pack.rb", "lib/fiddle/struct.rb", "lib/fiddle/types.rb", "lib/fiddle/value.rb"]
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = [
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bin/downloader.rb",
+    "bin/extlibs.rb",
+    "ext/fiddle/closure.c",
+    "ext/fiddle/closure.h",
+    "ext/fiddle/conversions.c",
+    "ext/fiddle/conversions.h",
+    "ext/fiddle/depend",
+    "ext/fiddle/extconf.rb",
+    "ext/fiddle/extlibs",
+    "ext/fiddle/fiddle.c",
+    "ext/fiddle/fiddle.h",
+    "ext/fiddle/function.c",
+    "ext/fiddle/function.h",
+    "ext/fiddle/handle.c",
+    "ext/fiddle/pinned.c",
+    "ext/fiddle/pointer.c",
+    "ext/fiddle/win32/fficonfig.h",
+    "ext/fiddle/win32/libffi-3.2.1-mswin.patch",
+    "ext/fiddle/win32/libffi-config.rb",
+    "ext/fiddle/win32/libffi.mk.tmpl",
+    "fiddle.gemspec",
+    "lib/fiddle.rb",
+    "lib/fiddle/closure.rb",
+    "lib/fiddle/cparser.rb",
+    "lib/fiddle/function.rb",
+    "lib/fiddle/import.rb",
+    "lib/fiddle/pack.rb",
+    "lib/fiddle/struct.rb",
+    "lib/fiddle/types.rb",
+    "lib/fiddle/value.rb",
+    "lib/fiddle/version.rb",
+  ]
   spec.require_paths = ["lib"]
+  spec.extensions = ["ext/fiddle/extconf.rb"]
 
   spec.required_ruby_version = ">= 2.3.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rake-compiler"
+
+  spec.metadata["msys2_mingw_dependencies"] = "libffi"
 end

data/lib/fiddle.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+
 require 'fiddle.so'
-require 'fiddle/function'
 require 'fiddle/closure'
+require 'fiddle/function'
+require 'fiddle/version'
 
 module Fiddle
   if WINDOWS

data/lib/fiddle/cparser.rb

@@ -35,12 +35,37 @@ module Fiddle
     def parse_struct_signature(signature, tymap=nil)
       if signature.is_a?(String)
         signature = split_arguments(signature, /[,;]/)
+      elsif signature.is_a?(Hash)
+        signature = [signature]
       end
       mems = []
       tys  = []
       signature.each{|msig|
-        msig = compact(msig)
+        msig = compact(msig) if msig.is_a?(String)
         case msig
+        when Hash
+          msig.each do |struct_name, struct_signature|
+            struct_name = struct_name.to_s if struct_name.is_a?(Symbol)
+            struct_name = compact(struct_name)
+            struct_count = nil
+            if struct_name =~ /^([\w\*\s]+)\[(\d+)\]$/
+              struct_count = $2.to_i
+              struct_name = $1
+            end
+            if struct_signature.respond_to?(:entity_class)
+              struct_type = struct_signature
+            else
+              parsed_struct = parse_struct_signature(struct_signature, tymap)
+              struct_type = CStructBuilder.create(CStruct, *parsed_struct)
+            end
+            if struct_count
+              ty = [struct_type, struct_count]
+            else
+              ty = struct_type
+            end
+            mems.push([struct_name, struct_type.members])
+            tys.push(ty)
+          end
         when /^[\w\*\s]+[\*\s](\w+)$/
           mems.push($1)
           tys.push(parse_ctype(msig, tymap))
@@ -172,6 +197,8 @@ module Fiddle
         return TYPE_UINTPTR_T
       when /\*/, /\[[\s\d]*\]/
         return TYPE_VOIDP
+      when "..."
+        return TYPE_VARIADIC
       else
         ty = ty.split(' ', 2)[0]
         if( tymap[ty] )
@@ -186,7 +213,7 @@ module Fiddle
 
     def split_arguments(arguments, sep=',')
       return [] if arguments.strip == 'void'
-      arguments.scan(/([\w\*\s]+\(\*\w*\)\(.*?\)|[\w\*\s\[\]]+)(?:#{sep}\s*|$)/).collect {|m| m[0]}
+      arguments.scan(/([\w\*\s]+\(\*\w*\)\(.*?\)|[\w\*\s\[\]]+|\.\.\.)(?:#{sep}\s*|$)/).collect {|m| m[0]}
     end
 
     def compact(signature)

data/lib/fiddle/import.rb

@@ -83,11 +83,7 @@ module Fiddle
         when Importer
           lib.handlers
         else
-          begin
-            Fiddle.dlopen(lib)
-          rescue DLError
-            raise(DLError, "can't load #{lib}")
-          end
+          Fiddle.dlopen(lib)
         end
       }.flatten()
       @handler = CompositeHandler.new(handles)
@@ -115,16 +111,21 @@ module Fiddle
           return SIZEOF_INT
         when TYPE_LONG
           return SIZEOF_LONG
-        when TYPE_LONG_LONG
-          return SIZEOF_LONG_LONG
         when TYPE_FLOAT
           return SIZEOF_FLOAT
         when TYPE_DOUBLE
           return SIZEOF_DOUBLE
         when TYPE_VOIDP
           return SIZEOF_VOIDP
+        when TYPE_CONST_STRING
+          return SIZEOF_CONST_STRING
         else
-          raise(DLError, "unknown type: #{ty}")
+          if defined?(TYPE_LONG_LONG) and
+            ty == TYPE_LONG_LONG
+            return SIZEOF_LONG_LONG
+          else
+            raise(DLError, "unknown type: #{ty}")
+          end
         end
       when Class
         if( ty.instance_methods().include?(:to_ptr) )
@@ -154,7 +155,8 @@ module Fiddle
     # :stopdoc:
     CALL_TYPE_TO_ABI = Hash.new { |h, k|
       raise RuntimeError, "unsupported call type: #{k}"
-    }.merge({ :stdcall => (Function::STDCALL rescue Function::DEFAULT),
+    }.merge({ :stdcall => Function.const_defined?(:STDCALL) ? Function::STDCALL :
+                          Function::DEFAULT,
               :cdecl   => Function::DEFAULT,
               nil      => Function::DEFAULT
             }).freeze

data/lib/fiddle/pack.rb

@@ -18,7 +18,7 @@ module Fiddle
     }
 
     PACK_MAP = {
-      TYPE_VOIDP => ((SIZEOF_VOIDP == SIZEOF_LONG_LONG) ? "q" : "l!"),
+      TYPE_VOIDP => "l!",
       TYPE_CHAR  => "c",
       TYPE_SHORT => "s!",
       TYPE_INT   => "i!",
@@ -48,6 +48,7 @@ module Fiddle
       ALIGN_MAP[TYPE_LONG_LONG] = ALIGN_MAP[-TYPE_LONG_LONG] = ALIGN_LONG_LONG
       PACK_MAP[TYPE_LONG_LONG] = PACK_MAP[-TYPE_LONG_LONG] = "q"
       SIZE_MAP[TYPE_LONG_LONG] = SIZE_MAP[-TYPE_LONG_LONG] = SIZEOF_LONG_LONG
+      PACK_MAP[TYPE_VOIDP] = "q" if SIZEOF_LONG_LONG == SIZEOF_VOIDP
     end
 
     def align(addr, align)
@@ -80,10 +81,13 @@ module Fiddle
       case SIZEOF_VOIDP
       when SIZEOF_LONG
         ary.pack(@template)
-      when SIZEOF_LONG_LONG
-        ary.pack(@template)
       else
-        raise(RuntimeError, "sizeof(void*)?")
+        if defined?(TYPE_LONG_LONG) and
+          SIZEOF_VOIDP == SIZEOF_LONG_LONG
+          ary.pack(@template)
+        else
+          raise(RuntimeError, "sizeof(void*)?")
+        end
       end
     end
 
@@ -91,10 +95,13 @@ module Fiddle
       case SIZEOF_VOIDP
       when SIZEOF_LONG
         ary.join().unpack(@template)
-      when SIZEOF_LONG_LONG
-        ary.join().unpack(@template)
       else
-        raise(RuntimeError, "sizeof(void*)?")
+        if defined?(TYPE_LONG_LONG) and
+          SIZEOF_VOIDP == SIZEOF_LONG_LONG
+          ary.join().unpack(@template)
+        else
+          raise(RuntimeError, "sizeof(void*)?")
+        end
       end
     end
 

data/lib/fiddle/struct.rb

@@ -4,15 +4,72 @@ require 'fiddle/value'
 require 'fiddle/pack'
 
 module Fiddle
-  # C struct shell
+  # A base class for objects representing a C structure
   class CStruct
+    include Enumerable
+
     # accessor to Fiddle::CStructEntity
     def CStruct.entity_class
       CStructEntity
     end
+
+    def each
+      return enum_for(__function__) unless block_given?
+
+      self.class.members.each do |name,|
+        yield(self[name])
+      end
+    end
+
+    def each_pair
+      return enum_for(__function__) unless block_given?
+
+      self.class.members.each do |name,|
+        yield(name, self[name])
+      end
+    end
+
+    def to_h
+      hash = {}
+      each_pair do |name, value|
+        hash[name] = unstruct(value)
+      end
+      hash
+    end
+
+    def replace(another)
+      if another.nil?
+        self.class.members.each do |name,|
+          self[name] = nil
+        end
+      elsif another.respond_to?(:each_pair)
+        another.each_pair do |name, value|
+          self[name] = value
+        end
+      else
+        another.each do |name, value|
+          self[name] = value
+        end
+      end
+      self
+    end
+
+    private
+    def unstruct(value)
+      case value
+      when CStruct
+        value.to_h
+      when Array
+        value.collect do |v|
+          unstruct(v)
+        end
+      else
+        value
+      end
+    end
   end
 
-  # C union shell
+  # A base class for objects representing a C union
   class CUnion
     # accessor to Fiddle::CUnionEntity
     def CUnion.entity_class
@@ -20,6 +77,41 @@ module Fiddle
     end
   end
 
+  # Wrapper for arrays within a struct
+  class StructArray < Array
+    include ValueUtil
+
+    def initialize(ptr, type, initial_values)
+      @ptr = ptr
+      @type = type
+      @is_struct = @type.respond_to?(:entity_class)
+      if @is_struct
+        super(initial_values)
+      else
+        @size = Fiddle::PackInfo::SIZE_MAP[type]
+        @pack_format = Fiddle::PackInfo::PACK_MAP[type]
+        super(initial_values.collect { |v| unsigned_value(v, type) })
+      end
+    end
+
+    def to_ptr
+      @ptr
+    end
+
+    def []=(index, value)
+      if index < 0 || index >= size
+        raise IndexError, 'index %d outside of array bounds 0...%d' % [index, size]
+      end
+
+      if @is_struct
+        self[index].replace(value)
+      else
+        to_ptr[index * @size, @size] = [value].pack(@pack_format)
+        super(index, value)
+      end
+    end
+  end
+
   # Used to construct C classes (CUnion, CStruct, etc)
   #
   # Fiddle::Importer#struct and Fiddle::Importer#union wrap this functionality in an
@@ -35,7 +127,7 @@ module Fiddle
     # Fiddle::Importer#struct and Fiddle::Importer#union wrap this functionality in an
     # easy-to-use manner.
     #
-    # Example:
+    # Examples:
     #
     #   require 'fiddle/struct'
     #   require 'fiddle/cparser'
@@ -46,47 +138,98 @@ module Fiddle
     #
     #   MyStruct = Fiddle::CStructBuilder.create(Fiddle::CUnion, types, members)
     #
-    #   obj = MyStruct.allocate
+    #   MyStruct.malloc(Fiddle::RUBY_FREE) do |obj|
+    #     ...
+    #   end
+    #
+    #   obj = MyStruct.malloc(Fiddle::RUBY_FREE)
+    #   begin
+    #     ...
+    #   ensure
+    #     obj.call_free
+    #   end
+    #
+    #   obj = MyStruct.malloc
+    #   begin
+    #     ...
+    #   ensure
+    #     Fiddle.free obj.to_ptr
+    #   end
     #
     def create(klass, types, members)
       new_class = Class.new(klass){
-        define_method(:initialize){|addr|
-          @entity = klass.entity_class.new(addr, types)
+        define_method(:initialize){|addr, func = nil|
+          if addr.is_a?(self.class.entity_class)
+            @entity = addr
+          else
+            @entity = self.class.entity_class.new(addr, types, func)
+          end
           @entity.assign_names(members)
         }
+        define_method(:[]) { |*args| @entity.send(:[], *args) }
+        define_method(:[]=) { |*args| @entity.send(:[]=, *args) }
         define_method(:to_ptr){ @entity }
         define_method(:to_i){ @entity.to_i }
+        define_singleton_method(:types) { types }
+        define_singleton_method(:members) { members }
         members.each{|name|
+          name = name[0] if name.is_a?(Array) # name is a nested struct
+          next if method_defined?(name)
           define_method(name){ @entity[name] }
           define_method(name + "="){|val| @entity[name] = val }
         }
-      }
-      size = klass.entity_class.size(types)
-      new_class.module_eval(<<-EOS, __FILE__, __LINE__+1)
-        def new_class.size()
-          #{size}
+        entity_class = klass.entity_class
+        alignment = entity_class.alignment(types)
+        size = entity_class.size(types)
+        define_singleton_method(:alignment) { alignment }
+        define_singleton_method(:size) { size }
+        define_singleton_method(:malloc) do |func=nil, &block|
+          if block
+            entity_class.malloc(types, func, size) do |entity|
+              block.call(new(entity))
+            end
+          else
+            new(entity_class.malloc(types, func, size))
+          end
         end
-        def new_class.malloc()
-          addr = Fiddle.malloc(#{size})
-          new(addr)
-        end
-      EOS
+      }
       return new_class
     end
     module_function :create
   end
 
-  # A C struct wrapper
+  # A pointer to a C structure
   class CStructEntity < Fiddle::Pointer
     include PackInfo
     include ValueUtil
 
+    def CStructEntity.alignment(types)
+      max = 1
+      types.each do |type, count = 1|
+        if type.respond_to?(:entity_class)
+          n = type.alignment
+        else
+          n = ALIGN_MAP[type]
+        end
+        max = n if n > max
+      end
+      max
+    end
+
     # Allocates a C struct with the +types+ provided.
     #
-    # When the instance is garbage collected, the C function +func+ is called.
-    def CStructEntity.malloc(types, func = nil)
-      addr = Fiddle.malloc(CStructEntity.size(types))
-      CStructEntity.new(addr, types, func)
+    # See Fiddle::Pointer.malloc for memory management issues.
+    def CStructEntity.malloc(types, func = nil, size = size(types), &block)
+      if block_given?
+        super(size, func) do |struct|
+          struct.set_ctypes types
+          yield struct
+        end
+      else
+        struct = super(size, func)
+        struct.set_ctypes types
+        struct
+      end
     end
 
     # Returns the offset for the packed sizes for the given +types+.
@@ -102,9 +245,15 @@ module Fiddle
       max_align = types.map { |type, count = 1|
         last_offset = offset
 
-        align = PackInfo::ALIGN_MAP[type]
+        if type.respond_to?(:entity_class)
+          align = type.alignment
+          type_size = type.size
+        else
+          align = PackInfo::ALIGN_MAP[type]
+          type_size = PackInfo::SIZE_MAP[type]
+        end
         offset = PackInfo.align(last_offset, align) +
-                 (PackInfo::SIZE_MAP[type] * count)
+                 (type_size * count)
 
         align
       }.max
@@ -118,13 +267,37 @@ module Fiddle
     #
     # See also Fiddle::Pointer.new
     def initialize(addr, types, func = nil)
+      if func && addr.is_a?(Pointer) && addr.free
+        raise ArgumentError, 'free function specified on both underlying struct Pointer and when creating a CStructEntity - who do you want to free this?'
+      end
       set_ctypes(types)
       super(addr, @size, func)
     end
 
     # Set the names of the +members+ in this C struct
     def assign_names(members)
-      @members = members
+      @members = []
+      @nested_structs = {}
+      members.each_with_index do |member, index|
+        if member.is_a?(Array) # nested struct
+          member_name = member[0]
+          struct_type, struct_count = @ctypes[index]
+          if struct_count.nil?
+            struct = struct_type.new(to_i + @offset[index])
+          else
+            structs = struct_count.times.map do |i|
+              struct_type.new(to_i + @offset[index] + i * struct_type.size)
+            end
+            struct = StructArray.new(to_i + @offset[index],
+                                     struct_type,
+                                     structs)
+          end
+          @nested_structs[member_name] = struct
+        else
+          member_name = member
+        end
+        @members << member_name
+      end
     end
 
     # Calculates the offsets and sizes for the given +types+ in the struct.
@@ -135,12 +308,18 @@ module Fiddle
 
       max_align = types.map { |type, count = 1|
         orig_offset = offset
-        align = ALIGN_MAP[type]
+        if type.respond_to?(:entity_class)
+          align = type.alignment
+          type_size = type.size
+        else
+          align = ALIGN_MAP[type]
+          type_size = SIZE_MAP[type]
+        end
         offset = PackInfo.align(orig_offset, align)
 
         @offset << offset
 
-        offset += (SIZE_MAP[type] * count)
+        offset += (type_size * count)
 
         align
       }.max
@@ -148,15 +327,34 @@ module Fiddle
       @size = PackInfo.align(offset, max_align)
     end
 
-    # Fetch struct member +name+
-    def [](name)
+    # Fetch struct member +name+ if only one argument is specified. If two
+    # arguments are specified, the first is an offset and the second is a
+    # length and this method returns the string of +length+ bytes beginning at
+    # +offset+.
+    #
+    # Examples:
+    #
+    #     my_struct = struct(['int id']).malloc
+    #     my_struct.id = 1
+    #     my_struct['id'] # => 1
+    #     my_struct[0, 4] # => "\x01\x00\x00\x00".b
+    #
+    def [](*args)
+      return super(*args) if args.size > 1
+      name = args[0]
       idx = @members.index(name)
       if( idx.nil? )
         raise(ArgumentError, "no such member: #{name}")
       end
       ty = @ctypes[idx]
       if( ty.is_a?(Array) )
-        r = super(@offset[idx], SIZE_MAP[ty[0]] * ty[1])
+        if ty.first.respond_to?(:entity_class)
+          return @nested_structs[name]
+        else
+          r = super(@offset[idx], SIZE_MAP[ty[0]] * ty[1])
+        end
+      elsif ty.respond_to?(:entity_class)
+        return @nested_structs[name]
       else
         r = super(@offset[idx], SIZE_MAP[ty.abs])
       end
@@ -176,14 +374,44 @@ module Fiddle
       if( ty.is_a?(Integer) && (ty < 0) )
         return unsigned_value(val, ty)
       elsif( ty.is_a?(Array) && (ty[0] < 0) )
-        return val.collect{|v| unsigned_value(v,ty[0])}
+        return StructArray.new(self + @offset[idx], ty[0], val)
       else
         return val
       end
     end
 
-    # Set struct member +name+, to value +val+
-    def []=(name, val)
+    # Set struct member +name+, to value +val+. If more arguments are
+    # specified, writes the string of bytes to the memory at the given
+    # +offset+ and +length+.
+    #
+    # Examples:
+    #
+    #     my_struct = struct(['int id']).malloc
+    #     my_struct['id'] = 1
+    #     my_struct[0, 4] = "\x01\x00\x00\x00".b
+    #     my_struct.id # => 1
+    #
+    def []=(*args)
+      return super(*args) if args.size > 2
+      name, val = *args
+      name = name.to_s if name.is_a?(Symbol)
+      nested_struct = @nested_structs[name]
+      if nested_struct
+        if nested_struct.is_a?(StructArray)
+          if val.nil?
+            nested_struct.each do |s|
+              s.replace(nil)
+            end
+          else
+            val.each_with_index do |v, i|
+              nested_struct[i] = v
+            end
+          end
+        else
+          nested_struct.replace(val)
+        end
+        return val
+      end
       idx = @members.index(name)
       if( idx.nil? )
         raise(ArgumentError, "no such member: #{name}")
@@ -202,23 +430,16 @@ module Fiddle
       end
     end
 
+    undef_method :size=
     def to_s() # :nodoc:
       super(@size)
     end
   end
 
-  # A C union wrapper
+  # A pointer to a C union
   class CUnionEntity < CStructEntity
     include PackInfo
 
-    # Allocates a C union the +types+ provided.
-    #
-    # When the instance is garbage collected, the C function +func+ is called.
-    def CUnionEntity.malloc(types, func=nil)
-      addr = Fiddle.malloc(CUnionEntity.size(types))
-      CUnionEntity.new(addr, types, func)
-    end
-
     # Returns the size needed for the union with the given +types+.
     #
     #   Fiddle::CUnionEntity.size(
@@ -228,7 +449,11 @@ module Fiddle
     #       Fiddle::TYPE_VOIDP ]) #=> 8
     def CUnionEntity.size(types)
       types.map { |type, count = 1|
-        PackInfo::SIZE_MAP[type] * count
+        if type.respond_to?(:entity_class)
+          type.size * count
+        else
+          PackInfo::SIZE_MAP[type] * count
+        end
       }.max
     end
 
@@ -241,4 +466,3 @@ module Fiddle
     end
   end
 end
-