fiddley 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5efaacddbd8392ed670102f7b62b32fe2a6024c
+  data.tar.gz: 20a196def56f4a803388c342ad513832fd7632ff
+SHA512:
+  metadata.gz: 231465cbe7a2a2a87ca7dc43b0186d8f0df8d044b9ae0ab0ea0ea76c11d99ac9a622444739501bd7536233a6eb77c20be99c51f9e406dd9f61440f812dfbf083
+  data.tar.gz: 924b4785615ba80370947d36fa9c7263e38cd763fd63c2198cf23a56a9a6847fb4770f9ba60130a397592a6484e4ae358d8b2f847d61ac6bd791285822e4b9e8

data/README.md

@@ -0,0 +1,38 @@
+Fiddley
+=======
+
+Ruby-FFI compatible API layer for Fiddle.
+
+
+Status
+------
+
+Under development.
+
+
+
+License
+-------
+
+Copyright (c) 2017 NAKAMURA Usaku usa@garbagecollect.jp
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+2. 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.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
+

data/Rakefile

@@ -0,0 +1,10 @@
+# -*- Ruby -*-
+require "bundler/gem_tasks"
+require "rake/testtask.rb"
+
+task :default => :test
+
+desc "Run all tests"
+task :test do
+  ruby "-Ilib test/sample.rb"
+end

data/fiddley.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fiddley"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fiddley"
+  spec.version       = Fiddley::VERSION
+  spec.authors       = ["U.Nakamura"]
+  spec.email         = ["usa@garbagecollect.jp"]
+
+  spec.summary       = "FFI compatible interface for Fiddle"
+  spec.description   = "Use Fiddle instead of Ruby-FFI !!!"
+  spec.homepage      = "https://github.com/unak/fiddley"
+  spec.license       = "BSD-2-Clause"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^tmp/|^tools/|^examples/|^\.}) }
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+end

data/lib/ffi.rb

@@ -0,0 +1 @@
+require "fiddley"

data/lib/fiddley.rb

@@ -0,0 +1,11 @@
+module Fiddley
+  VERSION = "0.0.1"
+end
+
+FFI = Fiddley
+
+require "fiddley/function"
+require "fiddley/memory_pointer"
+require "fiddley/library"
+require "fiddley/struct"
+require "fiddley/utils"

data/lib/fiddley/function.rb

@@ -0,0 +1,13 @@
+require "fiddle/import"
+
+module Fiddley
+  class Function
+    def initialize(ret, params, blk)
+      Module.new do
+        extend Fiddle::Importer
+        dlload Fiddley::Library::LIBC
+        @@func = bind("#{Fiddley.type2str(ret)} callback(#{params.map{|e|Fiddley.type2str(e)}.join(', ')})", &blk)
+      end
+    end
+  end
+end

data/lib/fiddley/library.rb

@@ -0,0 +1,97 @@
+require "fiddle/import"
+
+module Fiddley
+  module Library
+    include Fiddle::Importer
+    alias ffi_lib dlload
+
+    def extended(mod)
+      @convention = nil
+    end
+
+    def attach_function(rname, cname, params, ret = nil, blocking: false)
+      if ret.nil?
+        ret = params
+        params = cname
+        cname = rname
+      end
+      extern "#{Fiddley.type2str(ret)} #{cname}(#{params.map{|e| Fiddley.type2str(e)}.join(', ')})", @convention
+      if cname != rname
+        instance_eval <<-end
+          alias #{rname.inspect} #{cname.inspect}
+        end
+      end
+    end
+
+    def ffi_convention(conv)
+      @convention = conv
+    end
+
+    case RUBY_PLATFORM
+    when /cygwin/
+      libc_so = "cygwin1.dll"
+      libm_so = "cygwin1.dll"
+    when /linux/
+      libdir = '/lib'
+      case [0].pack('L!').size
+      when 4
+        # 32-bit ruby
+        libdir = '/lib32' if File.directory? '/lib32'
+      when 8
+        # 64-bit ruby
+        libdir = '/lib64' if File.directory? '/lib64'
+      end
+      libc_so = File.join(libdir, "libc.so.6")
+      libm_so = File.join(libdir, "libm.so.6")
+    when /mingw/, /mswin/
+      require "rbconfig"
+      crtname = RbConfig::CONFIG["RUBY_SO_NAME"][/msvc\w+/] || 'ucrtbase'
+      libc_so = libm_so = "#{crtname}.dll"
+    when /darwin/
+      libc_so = "/usr/lib/libc.dylib"
+      libm_so = "/usr/lib/libm.dylib"
+    when /kfreebsd/
+      libc_so = "/lib/libc.so.0.1"
+      libm_so = "/lib/libm.so.1"
+    when /gnu/	#GNU/Hurd
+      libc_so = "/lib/libc.so.0.3"
+      libm_so = "/lib/libm.so.6"
+    when /mirbsd/
+      libc_so = "/usr/lib/libc.so.41.10"
+      libm_so = "/usr/lib/libm.so.7.0"
+    when /freebsd/
+      libc_so = "/lib/libc.so.7"
+      libm_so = "/lib/libm.so.5"
+    when /bsd|dragonfly/
+      libc_so = "/usr/lib/libc.so"
+      libm_so = "/usr/lib/libm.so"
+    when /solaris/
+      libdir = '/lib'
+      case [0].pack('L!').size
+      when 4
+        # 32-bit ruby
+        libdir = '/lib' if File.directory? '/lib'
+      when 8
+        # 64-bit ruby
+        libdir = '/lib/64' if File.directory? '/lib/64'
+      end
+      libc_so = File.join(libdir, "libc.so")
+      libm_so = File.join(libdir, "libm.so")
+    end
+
+    libc_so = nil if !libc_so || (libc_so[0] == ?/ && !File.file?(libc_so))
+    libm_so = nil if !libm_so || (libm_so[0] == ?/ && !File.file?(libm_so))
+
+    if !libc_so || !libm_so
+      ruby = EnvUtil.rubybin
+      ldd = `ldd #{ruby}`
+      #puts ldd
+      libc_so = $& if !libc_so && %r{/\S*/libc\.so\S*} =~ ldd
+      libm_so = $& if !libm_so && %r{/\S*/libm\.so\S*} =~ ldd
+      #p [libc_so, libm_so]
+    end
+
+    LIBC = libc_so
+    LIBM = libm_so
+  end
+end

data/lib/fiddley/memory_pointer.rb

@@ -0,0 +1,85 @@
+require "fiddle/import"
+
+module Fiddley
+  class MemoryPointer
+    def initialize(type, num = 1)
+      size = Fiddley.type2size(type) * num
+      @ptr = Fiddle::Pointer.malloc(size)
+    end
+
+    def write_int16(val)
+      @ptr[0, 2] = [val].pack('s')
+    end
+
+    def write_int32(val)
+      @ptr[0, 4] = [val].pack('l')
+    end
+
+    def write_array_of_uint32(ary)
+      write_string(ary.pack('L*'))
+    end
+
+    def write_string(str)
+      @ptr[0, str.bytesize] = str
+    end
+
+    def read_bytes(size)
+      @ptr[0, size]
+    end
+
+    def read_int8
+      get_int8(0)
+    end
+
+    def read_uint8
+      get_uint8(0)
+    end
+
+    def read_int16
+      get_int16(0)
+    end
+
+    def read_uint16
+      get_uint16(0)
+    end
+
+    def read_int32
+      get_int32(0)
+    end
+
+    def read_uint32
+      get_uint32(0)
+    end
+
+    def get_int8(offset)
+      @ptr[offset, 1].unpack1('c')
+    end
+
+    def get_uint8(offset)
+      @ptr[offset, 1].unpack1('C')
+    end
+
+    def get_int16(offset)
+      @ptr[offset, 2].unpack1('s')
+    end
+
+    def get_uint16(offset)
+      @ptr[offset, 2].unpack1('S')
+    end
+
+    def get_int32(offset)
+      @ptr[offset, 4].unpack1('l')
+    end
+
+    def get_uint32(offset)
+      @ptr[offset, 4].unpack1('L')
+    end
+
+    alias read_int read_int32
+    alias get_int get_int32
+
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/fiddley/struct.rb

@@ -0,0 +1,52 @@
+require "fiddle/import"
+
+module Fiddley
+  class Struct
+    def self.layout(*args)
+      @members = {}
+      @size = 0
+      args.each_slice(2) do |name, type|
+        @members[name] = [type, @size]
+        @size += Fiddley.type2size(type)
+      end
+    end
+
+    def self.ptr
+      :pointer
+    end
+
+    def self.members
+      @members
+    end
+
+    def self.size
+      @size
+    end
+
+    def self.offset_of(key)
+      raise IndexError, "#{key} is not defined" unless members.has_key?(key)
+      type, offset = members[key]
+      offset
+    end
+
+    def initialize
+      @ptr = Fiddle::Pointer.malloc(self.class.size)
+    end
+
+    def [](key)
+      raise IndexError, "#{key} is not defined" unless self.class.members.has_key?(key)
+      type, offset = self.class.members[key]
+      Fiddley.str2value(type, @ptr[offset, Fiddley.type2size(type)])
+    end
+
+    def []=(key, value)
+      raise IndexError, "#{key} is not defined" unless self.class.members.has_key?(key)
+      type, offset = self.class.members[key]
+      @ptr[offset, Fiddley.type2size(type)] = Fiddley.value2str(type, value)
+    end
+
+    def to_ptr
+      @ptr
+    end
+  end
+end

data/lib/fiddley/utils.rb

@@ -0,0 +1,81 @@
+module Fiddley
+  def self.type2size(type)
+    case type
+    when :char, :uchar, :int8, :uint8
+      1
+    when :short, :ushort, :int16, :uint16
+      2
+    when :int, :uint, :int32, :uint32
+      4
+    when :long, :ulong, :int64, :uint64
+      8
+    when :string, :pointer
+      8
+    else
+      raise TypeError, "unknown type #{type}"
+    end
+  end
+
+  def self.str2value(type, str)
+    case type
+    when :char, :uchar, :int8, :uint8
+      str.unpack1('c')
+    when :short, :ushort, :int16, :uint16
+      str.unpack1('s')
+    when :int, :uint, :int32, :uint32
+      str.unpack1('l')
+    when :long, :ulong, :int64, :uint64
+      str.unpack1('Q')
+    when :string, :pointer
+      str.unpack1('p')
+    else
+      raise TypeError, "unknown type #{type}"
+    end
+  end
+
+  def self.value2str(type, value)
+    case type
+    when :char, :uchar, :int8, :uint8
+      [value].pack('c')
+    when :short, :ushort, :int16, :uint16
+      [value].pack('s')
+    when :int, :uint, :int32, :uint32
+      [value].pack('l')
+    when :long, :ulong, :int64, :uint64
+      [value].pack('Q')
+    when :string, :pointer
+      [value].pack('p')
+    else
+      raise TypeError, "unknown type #{type}"
+    end
+  end
+
+  def self.type2str(type)
+    case type
+    when :char, :int8
+      "char"
+    when :uchar, :uint8
+      "unsigned char"
+    when :short, :int16
+      "short"
+    when :ushort, :uint16
+      "unsigned short"
+    when :int, :int32
+      "int"
+    when :uint, :uint32
+      "unsigned int"
+    when :long, :int64
+      "long"
+    when :ulong, :uint64
+      "unsigned long"
+    when :long_long
+      "long long"
+    when :ulong_long
+      "unsigned long long"
+    when :string, :pointer
+      "void *"
+    else
+      type.to_s
+    end
+  end
+end

data/test/sample.rb

@@ -0,0 +1,9 @@
+require "ffi"
+
+module Hello
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+  attach_function :puts, [:string], :int
+end
+
+Hello.puts("Hello, world")

data/test/sample2.rb

@@ -0,0 +1,13 @@
+require 'ffi'
+
+module HelloWin
+  extend FFI::Library
+
+  ffi_lib 'user32'
+  ffi_convention :stdcall
+
+  attach_function :message_box, :MessageBoxA,[ :pointer, :string, :string, :uint ], :int
+end
+
+rc = HelloWin.message_box nil, 'Hello Windows!', 'FFI on Windows', 1
+puts "Return code: #{rc}"

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: fiddley
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- U.Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-30 00:00:00.000000000 Z
+dependencies: []
+description: Use Fiddle instead of Ruby-FFI !!!
+email:
+- usa@garbagecollect.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- fiddley.gemspec
+- lib/ffi.rb
+- lib/fiddley.rb
+- lib/fiddley/function.rb
+- lib/fiddley/library.rb
+- lib/fiddley/memory_pointer.rb
+- lib/fiddley/struct.rb
+- lib/fiddley/utils.rb
+- test/sample.rb
+- test/sample2.rb
+homepage: https://github.com/unak/fiddley
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: FFI compatible interface for Fiddle
+test_files: []