fiddle 1.0.0.beta1

data/lib/fiddle/closure.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: false
+module Fiddle
+  class Closure
+
+    # the C type of the return of the FFI closure
+    attr_reader :ctype
+
+    # arguments of the FFI closure
+    attr_reader :args
+
+    # Extends Fiddle::Closure to allow for building the closure in a block
+    class BlockCaller < Fiddle::Closure
+
+      # == Description
+      #
+      # Construct a new BlockCaller object.
+      #
+      # * +ctype+ is the C type to be returned
+      # * +args+ are passed the callback
+      # * +abi+ is the abi of the closure
+      #
+      # If there is an error in preparing the +ffi_cif+ or +ffi_prep_closure+,
+      # then a RuntimeError will be raised.
+      #
+      # == Example
+      #
+      #   include Fiddle
+      #
+      #   cb = Closure::BlockCaller.new(TYPE_INT, [TYPE_INT]) do |one|
+      #     one
+      #   end
+      #
+      #   func = Function.new(cb, [TYPE_INT], TYPE_INT)
+      #
+      def initialize ctype, args, abi = Fiddle::Function::DEFAULT, &block
+        super(ctype, args, abi)
+        @block = block
+      end
+
+      # Calls the constructed BlockCaller, with +args+
+      #
+      # For an example see Fiddle::Closure::BlockCaller.new
+      #
+      def call *args
+        @block.call(*args)
+      end
+    end
+  end
+end

data/lib/fiddle/cparser.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: false
+module Fiddle
+  # A mixin that provides methods for parsing C struct and prototype signatures.
+  #
+  # == Example
+  #   require 'fiddle/import'
+  #
+  #   include Fiddle::CParser
+  #     #=> Object
+  #
+  #   parse_ctype('int')
+  #     #=> Fiddle::TYPE_INT
+  #
+  #   parse_struct_signature(['int i', 'char c'])
+  #     #=> [[Fiddle::TYPE_INT, Fiddle::TYPE_CHAR], ["i", "c"]]
+  #
+  #   parse_signature('double sum(double, double)')
+  #     #=> ["sum", Fiddle::TYPE_DOUBLE, [Fiddle::TYPE_DOUBLE, Fiddle::TYPE_DOUBLE]]
+  #
+  module CParser
+    # Parses a C struct's members
+    #
+    # Example:
+    #
+    #   include Fiddle::CParser
+    #     #=> Object
+    #
+    #   parse_struct_signature(['int i', 'char c'])
+    #     #=> [[Fiddle::TYPE_INT, Fiddle::TYPE_CHAR], ["i", "c"]]
+    #
+    #   parse_struct_signature(['char buffer[80]'])
+    #     #=> [[[Fiddle::TYPE_CHAR, 80]], ["buffer"]]
+    #
+    def parse_struct_signature(signature, tymap=nil)
+      if signature.is_a?(String)
+        signature = split_arguments(signature, /[,;]/)
+      end
+      mems = []
+      tys  = []
+      signature.each{|msig|
+        msig = compact(msig)
+        case msig
+        when /^[\w\*\s]+[\*\s](\w+)$/
+          mems.push($1)
+          tys.push(parse_ctype(msig, tymap))
+        when /^[\w\*\s]+\(\*(\w+)\)\(.*?\)$/
+          mems.push($1)
+          tys.push(parse_ctype(msig, tymap))
+        when /^([\w\*\s]+[\*\s])(\w+)\[(\d+)\]$/
+          mems.push($2)
+          tys.push([parse_ctype($1.strip, tymap), $3.to_i])
+        when /^([\w\*\s]+)\[(\d+)\](\w+)$/
+          mems.push($3)
+          tys.push([parse_ctype($1.strip, tymap), $2.to_i])
+        else
+          raise(RuntimeError,"can't parse the struct member: #{msig}")
+        end
+      }
+      return tys, mems
+    end
+
+    # Parses a C prototype signature
+    #
+    # If Hash +tymap+ is provided, the return value and the arguments from the
+    # +signature+ are expected to be keys, and the value will be the C type to
+    # be looked up.
+    #
+    # Example:
+    #
+    #   include Fiddle::CParser
+    #     #=> Object
+    #
+    #   parse_signature('double sum(double, double)')
+    #     #=> ["sum", Fiddle::TYPE_DOUBLE, [Fiddle::TYPE_DOUBLE, Fiddle::TYPE_DOUBLE]]
+    #
+    #   parse_signature('void update(void (*cb)(int code))')
+    #     #=> ["update", Fiddle::TYPE_VOID, [Fiddle::TYPE_VOIDP]]
+    #
+    #   parse_signature('char (*getbuffer(void))[80]')
+    #     #=> ["getbuffer", Fiddle::TYPE_VOIDP, []]
+    #
+    def parse_signature(signature, tymap=nil)
+      tymap ||= {}
+      case compact(signature)
+      when /^(?:[\w\*\s]+)\(\*(\w+)\((.*?)\)\)(?:\[\w*\]|\(.*?\));?$/
+        func, args = $1, $2
+        return [func, TYPE_VOIDP, split_arguments(args).collect {|arg| parse_ctype(arg, tymap)}]
+      when /^([\w\*\s]+[\*\s])(\w+)\((.*?)\);?$/
+        ret, func, args = $1.strip, $2, $3
+        return [func, parse_ctype(ret, tymap), split_arguments(args).collect {|arg| parse_ctype(arg, tymap)}]
+      else
+        raise(RuntimeError,"can't parse the function prototype: #{signature}")
+      end
+    end
+
+    # Given a String of C type +ty+, returns the corresponding Fiddle constant.
+    #
+    # +ty+ can also accept an Array of C type Strings, and will be returned in
+    # a corresponding Array.
+    #
+    # If Hash +tymap+ is provided, +ty+ is expected to be the key, and the
+    # value will be the C type to be looked up.
+    #
+    # Example:
+    #
+    #   include Fiddle::CParser
+    #     #=> Object
+    #
+    #   parse_ctype('int')
+    #     #=> Fiddle::TYPE_INT
+    #
+    #   parse_ctype('double diff')
+    #     #=> Fiddle::TYPE_DOUBLE
+    #
+    #   parse_ctype('unsigned char byte')
+    #     #=> -Fiddle::TYPE_CHAR
+    #
+    #   parse_ctype('const char* const argv[]')
+    #     #=> -Fiddle::TYPE_VOIDP
+    #
+    def parse_ctype(ty, tymap=nil)
+      tymap ||= {}
+      case ty
+      when Array
+        return [parse_ctype(ty[0], tymap), ty[1]]
+      when 'void'
+        return TYPE_VOID
+      when /^(?:(?:signed\s+)?long\s+long(?:\s+int\s+)?|int64_t)(?:\s+\w+)?$/
+        if( defined?(TYPE_LONG_LONG) )
+          return TYPE_LONG_LONG
+        else
+          raise(RuntimeError, "unsupported type: #{ty}")
+        end
+      when /^(?:unsigned\s+long\s+long(?:\s+int\s+)?|uint64_t)(?:\s+\w+)?$/
+        if( defined?(TYPE_LONG_LONG) )
+          return -TYPE_LONG_LONG
+        else
+          raise(RuntimeError, "unsupported type: #{ty}")
+        end
+      when /^(?:signed\s+)?long(?:\s+int\s+)?(?:\s+\w+)?$/
+        return TYPE_LONG
+      when /^unsigned\s+long(?:\s+int\s+)?(?:\s+\w+)?$/
+        return -TYPE_LONG
+      when /^(?:signed\s+)?int(?:\s+\w+)?$/
+        return TYPE_INT
+      when /^(?:unsigned\s+int|uint)(?:\s+\w+)?$/
+        return -TYPE_INT
+      when /^(?:signed\s+)?short(?:\s+int\s+)?(?:\s+\w+)?$/
+        return TYPE_SHORT
+      when /^unsigned\s+short(?:\s+int\s+)?(?:\s+\w+)?$/
+        return -TYPE_SHORT
+      when /^(?:signed\s+)?char(?:\s+\w+)?$/
+        return TYPE_CHAR
+      when /^unsigned\s+char(?:\s+\w+)?$/
+        return  -TYPE_CHAR
+      when /^float(?:\s+\w+)?$/
+        return TYPE_FLOAT
+      when /^double(?:\s+\w+)?$/
+        return TYPE_DOUBLE
+      when /^size_t(?:\s+\w+)?$/
+        return TYPE_SIZE_T
+      when /^ssize_t(?:\s+\w+)?$/
+        return TYPE_SSIZE_T
+      when /^ptrdiff_t(?:\s+\w+)?$/
+        return TYPE_PTRDIFF_T
+      when /^intptr_t(?:\s+\w+)?$/
+        return TYPE_INTPTR_T
+      when /^uintptr_t(?:\s+\w+)?$/
+        return TYPE_UINTPTR_T
+      when /\*/, /\[[\s\d]*\]/
+        return TYPE_VOIDP
+      else
+        ty = ty.split(' ', 2)[0]
+        if( tymap[ty] )
+          return parse_ctype(tymap[ty], tymap)
+        else
+          raise(DLError, "unknown type: #{ty}")
+        end
+      end
+    end
+
+    private
+
+    def split_arguments(arguments, sep=',')
+      return [] if arguments.strip == 'void'
+      arguments.scan(/([\w\*\s]+\(\*\w*\)\(.*?\)|[\w\*\s\[\]]+)(?:#{sep}\s*|$)/).collect {|m| m[0]}
+    end
+
+    def compact(signature)
+      signature.gsub(/\s+/, ' ').gsub(/\s*([\(\)\[\]\*,;])\s*/, '\1').strip
+    end
+
+  end
+end

data/lib/fiddle/function.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: false
+module Fiddle
+  class Function
+    # The ABI of the Function.
+    attr_reader :abi
+
+    # The address of this function
+    attr_reader :ptr
+
+    # The name of this function
+    attr_reader :name
+
+    # The integer memory location of this function
+    def to_i
+      ptr.to_i
+    end
+  end
+end

data/lib/fiddle/import.rb

@@ -0,0 +1,318 @@
+# frozen_string_literal: false
+require 'fiddle'
+require 'fiddle/struct'
+require 'fiddle/cparser'
+
+module Fiddle
+
+  # Used internally by Fiddle::Importer
+  class CompositeHandler
+    # Create a new handler with the open +handlers+
+    #
+    # Used internally by Fiddle::Importer.dlload
+    def initialize(handlers)
+      @handlers = handlers
+    end
+
+    # Array of the currently loaded libraries.
+    def handlers()
+      @handlers
+    end
+
+    # Returns the address as an Integer from any handlers with the function
+    # named +symbol+.
+    #
+    # Raises a DLError if the handle is closed.
+    def sym(symbol)
+      @handlers.each{|handle|
+        if( handle )
+          begin
+            addr = handle.sym(symbol)
+            return addr
+          rescue DLError
+          end
+        end
+      }
+      return nil
+    end
+
+    # See Fiddle::CompositeHandler.sym
+    def [](symbol)
+      sym(symbol)
+    end
+  end
+
+  # A DSL that provides the means to dynamically load libraries and build
+  # modules around them including calling extern functions within the C
+  # library that has been loaded.
+  #
+  # == Example
+  #
+  #   require 'fiddle'
+  #   require 'fiddle/import'
+  #
+  #   module LibSum
+  #   	extend Fiddle::Importer
+  #   	dlload './libsum.so'
+  #   	extern 'double sum(double*, int)'
+  #   	extern 'double split(double)'
+  #   end
+  #
+  module Importer
+    include Fiddle
+    include CParser
+    extend Importer
+
+    attr_reader :type_alias
+    private :type_alias
+
+    # Creates an array of handlers for the given +libs+, can be an instance of
+    # Fiddle::Handle, Fiddle::Importer, or will create a new instance of
+    # Fiddle::Handle using Fiddle.dlopen
+    #
+    # Raises a DLError if the library cannot be loaded.
+    #
+    # See Fiddle.dlopen
+    def dlload(*libs)
+      handles = libs.collect{|lib|
+        case lib
+        when nil
+          nil
+        when Handle
+          lib
+        when Importer
+          lib.handlers
+        else
+          begin
+            Fiddle.dlopen(lib)
+          rescue DLError
+            raise(DLError, "can't load #{lib}")
+          end
+        end
+      }.flatten()
+      @handler = CompositeHandler.new(handles)
+      @func_map = {}
+      @type_alias = {}
+    end
+
+    # Sets the type alias for +alias_type+ as +orig_type+
+    def typealias(alias_type, orig_type)
+      @type_alias[alias_type] = orig_type
+    end
+
+    # Returns the sizeof +ty+, using Fiddle::Importer.parse_ctype to determine
+    # the C type and the appropriate Fiddle constant.
+    def sizeof(ty)
+      case ty
+      when String
+        ty = parse_ctype(ty, type_alias).abs()
+        case ty
+        when TYPE_CHAR
+          return SIZEOF_CHAR
+        when TYPE_SHORT
+          return SIZEOF_SHORT
+        when TYPE_INT
+          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
+        else
+          raise(DLError, "unknown type: #{ty}")
+        end
+      when Class
+        if( ty.instance_methods().include?(:to_ptr) )
+          return ty.size()
+        end
+      end
+      return Pointer[ty].size()
+    end
+
+    def parse_bind_options(opts)
+      h = {}
+      while( opt = opts.shift() )
+        case opt
+        when :stdcall, :cdecl
+          h[:call_type] = opt
+        when :carried, :temp, :temporal, :bind
+          h[:callback_type] = opt
+          h[:carrier] = opts.shift()
+        else
+          h[opt] = true
+        end
+      end
+      h
+    end
+    private :parse_bind_options
+
+    # :stopdoc:
+    CALL_TYPE_TO_ABI = Hash.new { |h, k|
+      raise RuntimeError, "unsupported call type: #{k}"
+    }.merge({ :stdcall => (Function::STDCALL rescue Function::DEFAULT),
+              :cdecl   => Function::DEFAULT,
+              nil      => Function::DEFAULT
+            }).freeze
+    private_constant :CALL_TYPE_TO_ABI
+    # :startdoc:
+
+    # Creates a global method from the given C +signature+.
+    def extern(signature, *opts)
+      symname, ctype, argtype = parse_signature(signature, type_alias)
+      opt = parse_bind_options(opts)
+      f = import_function(symname, ctype, argtype, opt[:call_type])
+      name = symname.gsub(/@.+/,'')
+      @func_map[name] = f
+      # define_method(name){|*args,&block| f.call(*args,&block)}
+      begin
+        /^(.+?):(\d+)/ =~ caller.first
+        file, line = $1, $2.to_i
+      rescue
+        file, line = __FILE__, __LINE__+3
+      end
+      module_eval(<<-EOS, file, line)
+        def #{name}(*args, &block)
+          @func_map['#{name}'].call(*args,&block)
+        end
+      EOS
+      module_function(name)
+      f
+    end
+
+    # Creates a global method from the given C +signature+ using the given
+    # +opts+ as bind parameters with the given block.
+    def bind(signature, *opts, &blk)
+      name, ctype, argtype = parse_signature(signature, type_alias)
+      h = parse_bind_options(opts)
+      case h[:callback_type]
+      when :bind, nil
+        f = bind_function(name, ctype, argtype, h[:call_type], &blk)
+      else
+        raise(RuntimeError, "unknown callback type: #{h[:callback_type]}")
+      end
+      @func_map[name] = f
+      #define_method(name){|*args,&block| f.call(*args,&block)}
+      begin
+        /^(.+?):(\d+)/ =~ caller.first
+        file, line = $1, $2.to_i
+      rescue
+        file, line = __FILE__, __LINE__+3
+      end
+      module_eval(<<-EOS, file, line)
+        def #{name}(*args,&block)
+          @func_map['#{name}'].call(*args,&block)
+        end
+      EOS
+      module_function(name)
+      f
+    end
+
+    # Creates a class to wrap the C struct described by +signature+.
+    #
+    #   MyStruct = struct ['int i', 'char c']
+    def struct(signature)
+      tys, mems = parse_struct_signature(signature, type_alias)
+      Fiddle::CStructBuilder.create(CStruct, tys, mems)
+    end
+
+    # Creates a class to wrap the C union described by +signature+.
+    #
+    #   MyUnion = union ['int i', 'char c']
+    def union(signature)
+      tys, mems = parse_struct_signature(signature, type_alias)
+      Fiddle::CStructBuilder.create(CUnion, tys, mems)
+    end
+
+    # Returns the function mapped to +name+, that was created by either
+    # Fiddle::Importer.extern or Fiddle::Importer.bind
+    def [](name)
+      @func_map[name]
+    end
+
+    # Creates a class to wrap the C struct with the value +ty+
+    #
+    # See also Fiddle::Importer.struct
+    def create_value(ty, val=nil)
+      s = struct([ty + " value"])
+      ptr = s.malloc()
+      if( val )
+        ptr.value = val
+      end
+      return ptr
+    end
+    alias value create_value
+
+    # Returns a new instance of the C struct with the value +ty+ at the +addr+
+    # address.
+    def import_value(ty, addr)
+      s = struct([ty + " value"])
+      ptr = s.new(addr)
+      return ptr
+    end
+
+
+    # The Fiddle::CompositeHandler instance
+    #
+    # Will raise an error if no handlers are open.
+    def handler
+      (@handler ||= nil) or raise "call dlload before importing symbols and functions"
+    end
+
+    # Returns a new Fiddle::Pointer instance at the memory address of the given
+    # +name+ symbol.
+    #
+    # Raises a DLError if the +name+ doesn't exist.
+    #
+    # See Fiddle::CompositeHandler.sym and Fiddle::Handle.sym
+    def import_symbol(name)
+      addr = handler.sym(name)
+      if( !addr )
+        raise(DLError, "cannot find the symbol: #{name}")
+      end
+      Pointer.new(addr)
+    end
+
+    # Returns a new Fiddle::Function instance at the memory address of the given
+    # +name+ function.
+    #
+    # Raises a DLError if the +name+ doesn't exist.
+    #
+    # * +argtype+ is an Array of arguments, passed to the +name+ function.
+    # * +ctype+ is the return type of the function
+    # * +call_type+ is the ABI of the function
+    #
+    # See also Fiddle:Function.new
+    #
+    # See Fiddle::CompositeHandler.sym and Fiddle::Handler.sym
+    def import_function(name, ctype, argtype, call_type = nil)
+      addr = handler.sym(name)
+      if( !addr )
+        raise(DLError, "cannot find the function: #{name}()")
+      end
+      Function.new(addr, argtype, ctype, CALL_TYPE_TO_ABI[call_type],
+                   name: name)
+    end
+
+    # Returns a new closure wrapper for the +name+ function.
+    #
+    # * +ctype+ is the return type of the function
+    # * +argtype+ is an Array of arguments, passed to the callback function
+    # * +call_type+ is the abi of the closure
+    # * +block+ is passed to the callback
+    #
+    # See Fiddle::Closure
+    def bind_function(name, ctype, argtype, call_type = nil, &block)
+      abi = CALL_TYPE_TO_ABI[call_type]
+      closure = Class.new(Fiddle::Closure) {
+        define_method(:call, block)
+      }.new(ctype, argtype, abi)
+
+      Function.new(closure, argtype, ctype, abi, name: name)
+    end
+  end
+end