sitar 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c92941d27abd491805383eec1ef8cdb6bb3c1365
+  data.tar.gz: 62d445d65ab7b13b775b058017e3a79444d17a99
+SHA512:
+  metadata.gz: c830628399e594f378ffaba57bca4aaf8b30cf3639441f38fa88027989eb0a8e4c130b63cb4bf3a4cc95f3d1ff4e6e27cf2759a218596c0f6390d369818d079f
+  data.tar.gz: d153bc4f14ceb763cab6da453ed8201cde48e095ef97955aaf4ac7a4759e653dcd90755010c3063c32b6c7848c37147e8f2de82865f4388032cc7ed37d32327a

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# Mac OS
+.DS_Store
+
+# Spec
+spec/lib/build/

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+
+before_script:
+  - cd spec/lib && ./build.sh
+
+rvm:
+  - "2.0.0"
+  - "2.1.0"
+  - "2.2.0"
+  - "2.3.0"

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at slowhand0309@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sitar.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Slowhand0309
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Sitar
+
+Sitar is easy to use the [fiddle](https://github.com/ruby/ruby/tree/trunk/ext/fiddle).
+
+[![Build Status](https://travis-ci.org/Slowhand0309/sitar.svg?branch=master)](https://travis-ci.org/Slowhand0309/sitar)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sitar'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sitar
+
+## Usage
+
+You can used C method only to extend sitar and load shared library like follow:
+
+C function in `libsample.so`
+
+```c
+int add(int a, int b) {
+  return a + b;
+}
+```
+
+Use in ruby.
+
+```ruby
+module M
+  extend Sitar
+
+  load 'libsample.so'
+end
+
+M.add(1, 2).ret_i # => 3
+```
+
+* List of function return type mthod like ret_XXX.
+
+|Method|Return Type in C|Return Type in Ruby|Description|
+|:-----|:------|:----------|:----------|
+|call|void|nil|Not returned value.|
+|ret_i|int|Integer|Returned int value.|
+|ret_s|char *|String|Return string pointer.|
+|ret_ws|wchar_t *|String|Return wide char string pointer.|
+|ret_f|float|Float|Return float value.|
+|ret_d|double|Float|Return double value.|
+
+## Struct
+
+You can easy to use struct by `Sitar::Types::StructFactory`.
+
+e.g.
+
+```ruby
+module M
+  extend Sitar
+  extend Sitar::Types::StructFactory
+
+  # struct Car {
+  #   int id;
+  #   char name[20];
+  # };
+  define 'Car', ["int id", "char name[20]"]
+
+  # struct Owner {
+  #   int seq;
+  #   struct Car cars[3];
+  # };
+  define 'Owner', ["int seq", "Car cars[3]"]
+
+  define_eval(self)
+end
+
+M::CAR.malloc
+
+owner = M::OWNER.malloc
+# Car cars[3] is expanded like follow:
+# struct Owner {
+#   int seq;
+#   int id_1;
+#   char name_1[20];
+#   int id_2;
+#   char name_2[20];
+#   int id_3;
+#   char name_3[20];
+# }
+owner.id_1
+owner.name_1
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Author
+
+[slowhand0309](https://github.com/Slowhand0309)

data/Rakefile

@@ -0,0 +1,7 @@
+# coding: utf-8
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sitar.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+require 'sitar/binder'
+
+module Sitar
+
+  # == Description
+  #
+  # Load shared librarys (.so, .dll).
+  # And extend typealias.
+  #
+  # * +library+ is the specfic library path's
+  #
+  # == Example
+  #
+  # module M
+  #  extend Sitar
+  #  load 'path/liba.so', 'path/libb.so'
+  # end
+  def load(*library)
+    Binder::dlload(*library)
+    Binder::typealias_ext
+  end
+
+  # Implemention method_missing.
+  #
+  def method_missing(name, *args)
+    e = Binder::at(name, *args)
+    unless e
+      super(name, *args) # No method error.
+    else
+      e
+    end
+  end
+
+  # Create C struct.
+  #
+  def struct(signature)
+    Binder::struct(signature)
+  end
+
+  # Create C union.
+  #
+  def union(signature)
+    Binder::union(signature)
+  end
+
+  # Declare typealias.
+  #
+  def typealias(alias_type, orig_type)
+    Binder::typealias(alias_type, orig_type)
+  end
+
+end

data/lib/sitar/binder.rb

@@ -0,0 +1,67 @@
+# coding: utf-8
+require 'fiddle'
+require 'fiddle/import'
+require 'sitar/executor'
+require 'sitar/types'
+
+module Sitar
+  module Binder
+    extend Fiddle::Importer
+
+    class << self
+
+      # Bind at function.
+      #
+      # * +name+ is the function name
+      # * +args+ is the function args
+      #
+      # Return the executor class instance.
+      def at(name, *args)
+        address = nil
+        argv = []
+        begin
+          address = handler.sym(name.to_s)
+          argv = parse_arguments(*args)
+        rescue Fiddle::DLError => e
+          $stderr.puts "Fiddle::DLError #{e}"
+        end
+        if address
+          Executor.new(address, argv, *args)
+        else
+          nil # If invalid symbol name, return nil.
+        end
+      end
+
+      def typealias_ext
+        include Types::Aliases
+      end
+
+      def parse_arguments(*args)
+        values = *args
+        # No have argument.
+        if values.length == 0
+          return []
+        end
+
+        argv = []
+        values.each do |arg|
+          # Decide arg type.
+          if arg.kind_of?(Integer)
+            argv << Fiddle::TYPE_INT
+          elsif arg.kind_of?(Float)
+            argv << Fiddle::TYPE_DOUBLE
+          elsif arg.kind_of?(String)
+            argv << Fiddle::TYPE_VOIDP
+          elsif arg.kind_of?(Fiddle::Pointer)
+            argv << Fiddle::TYPE_VOIDP
+          else
+            argv << Fiddle::TYPE_VOIDP
+          end
+        end
+        argv
+      end
+
+    end
+
+  end
+end

data/lib/sitar/executor.rb

@@ -0,0 +1,103 @@
+# coding: utf-8
+require 'fiddle/import'
+require 'sitar/types'
+
+module Sitar
+  class Executor
+
+    # === Description
+    #
+    # Construct new object.
+    #
+    # * +address+ is the shared library memory address.
+    def initialize(address, argv, *args)
+      @address = address
+      @argv = argv
+      @args = args
+    end
+
+    # === Description
+    #
+    # Call function with no returned value.
+    def call
+      func = get_func(Fiddle::TYPE_VOID)
+      if func
+        func.call(*@args)
+      end
+    end
+
+    # === Description
+    #
+    # Call function with integer returned value.
+    # If failed call, returned -1.
+    def ret_i
+      result = -1
+      func = get_func(Fiddle::TYPE_LONG)
+      if func
+        result = func.call(*@args).to_i
+      end
+      result
+    end
+
+    # === Description
+    #
+    # Call function with (char *) returned value.
+    # If failed call, returned ''.
+    def ret_s
+      result = ''
+      func = get_func(Fiddle::TYPE_LONG)
+      if func
+        result = Fiddle::Pointer.new(func.call(*@args)).to_s
+      end
+      result
+    end
+
+    # === Description
+    #
+    # Call function with (wchar_t *) returned value.
+    # If failed call, returned ''.
+    def ret_ws
+      result = ''
+      func = get_func(Fiddle::TYPE_LONG)
+      if func
+        result = Types::WideChar.from_ptr(func.call(*@args))
+      end
+      result
+    end
+
+    # === Description
+    #
+    # Call function with float returned value.
+    # If failed call, returned 0.0.
+    def ret_f
+      result = 0.0
+      func = get_func(Fiddle::TYPE_FLOAT)
+      if func
+        result = func.call(*@args).to_f
+      end
+      result
+    end
+
+    # === Description
+    #
+    # Call function with double returned value.
+    # If failed call, returned 0.0.
+    def ret_d
+      result = 0.0
+      func = get_func(Fiddle::TYPE_DOUBLE)
+      if func
+        result = func.call(*@args).to_f
+      end
+      result
+    end
+
+    private
+
+    def get_func(type)
+      unless @address
+        return nil
+      end
+      Fiddle::Function.new(@address, @argv, type)
+    end
+  end
+end

data/lib/sitar/helper.rb

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+module Sitar
+  class Helper
+
+    class << self
+
+      # Platform to check whether windows.
+      #
+      # === Return
+      # If return true, platform is windows.
+      def platform_windows?
+        RUBY_PLATFORM =~ /cygwin|mswin|mingw|bccwin|wince|emx/
+      end
+
+      # Platform to check whether mac os.
+      #
+      # === Return
+      # If return true, platform is mac os.
+      def platform_mac?
+        RUBY_PLATFORM =~ /darwin/
+      end
+
+      # Platform to check whether linux.
+      #
+      # === Return
+      # If return true, platform is linux.
+      def platform_linux?
+        RUBY_PLATFORM =~ /linux/
+      end
+    end
+
+  end
+end

data/lib/sitar/types.rb

@@ -0,0 +1,13 @@
+# coding: utf-8
+require 'active_support'
+
+module Sitar
+  module Types
+    extend ActiveSupport::Autoload
+
+    autoload :Aliases
+    autoload :Pointer
+    autoload :StructFactory
+    autoload :WideChar
+  end
+end

data/lib/sitar/types/aliases.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+require 'sitar/helper'
+
+module Sitar
+  module Types
+
+    module Aliases
+
+      def self.included(m)
+        m.module_eval{
+          if Helper.platform_windows?
+            # Windows UTF-16 2-byte wide chars.
+            typealias "wchar_t", "short"
+          else
+            # Linux and OS X is 4 bytes UTF-32.
+            typealias "wchar_t", "int"
+          end
+          typealias "bool", "unsigned char"
+        }
+      end
+
+    end
+
+  end
+end

data/lib/sitar/types/pointer.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+require 'fiddle'
+
+module Sitar
+  module Types
+
+    class Pointer
+
+      class << self
+
+        # Cretae double pointer value.
+        # e.g. void **double_ptr;
+        def pptr
+          Fiddle::Pointer.malloc(Fiddle::SIZEOF_VOIDP)
+        end
+
+      end
+    end
+
+  end
+end

data/lib/sitar/types/struct_factory.rb

@@ -0,0 +1,79 @@
+# coding: utf-8
+require 'fiddle/import'
+
+module Sitar
+  module Types
+
+    module StructFactory
+
+      # Define struct.
+      #
+      # == Example
+      #
+      # module M
+      #   extend Sitar::Types::StructFactory
+      #
+      #   define 'struct', ["int no", "char *name"]
+      # end
+      def define(struct_name, members)
+        @structs ||= {}
+        @structs[struct_name] = members
+      end
+
+      # Apply struct via define method.
+      def define_eval(m)
+        @structs.each do |k, v|
+          # Declare struct.
+          name = k.upcase
+          members = parse(k, v)
+          m.module_eval <<-EOF
+             #{name} = struct(#{members})
+          EOF
+        end
+      end
+
+      private
+
+      def parse(struct_name, members)
+        parse_inner_struct(1, struct_name, members)
+      end
+
+      def parse_inner_struct(count, struct_name, members)
+        inners = []
+        1.upto count do |idx|
+          members.each do |member|
+            # Parse inner struct.
+            type = member.split(' ')[0]
+            value = member.split(' ')[1]
+
+            inner_struct = @structs[type]
+            if type != struct_name && inner_struct
+              array_count = 1
+              if /\[(\d+)\]/ =~ value
+                array_count = $1.to_i
+              end
+              inners << parse_inner_struct(array_count, type, inner_struct)
+            else
+              if count > 1
+                # Add member prefix. XX_1, XX_2
+                if /([a-zA-Z]+)\[(\d+)\]/ =~ value
+                  # Replace XXX[20] -> XXX_1[20]
+                  value = "#{$1}_#{idx}[#{$2}]"
+                else
+                  value = "#{value}_#{idx}"
+                end
+
+                inners << "#{type} #{value}"
+              else
+                inners << member
+              end
+            end
+          end
+        end
+        inners.flatten
+      end
+
+    end
+
+  end
+end

data/lib/sitar/types/wide_char.rb

@@ -0,0 +1,60 @@
+# coding: utf-8
+require 'fiddle'
+require 'sitar/helper'
+
+module Sitar
+  module Types
+    class WideChar
+
+      NULL_STRING = "\u0000".freeze
+
+      class << self
+
+        # Check '\u0000' charactor.
+        #
+        # === Return
+        # If return true, value is '\u0000'.
+        def null?(value)
+          value == NULL_STRING
+        end
+
+        # Convert array to unicode string.
+        #
+        # === Example
+        #
+        #   from_array([119]) => 'w'
+        def from_array(array)
+          array.pack('U*')
+        end
+
+        # Convert pointer to unicode string.
+        def from_ptr(ptr)
+          pointer = Fiddle::Pointer.new(ptr)
+          size = 4 # Linux and OS X is 4 bytes UTF-32.
+          if Helper.platform_windows?
+            size = 2 # Windows UTF-16 2-byte wide chars.
+          end
+
+          index = 0
+          result = ''
+          loop do
+            val = []
+            size.times do |i|
+              n = pointer[index + i].to_i
+              val << n if n != 0
+            end
+            break if val.empty?
+
+            index = index + size
+
+            str = from_array(val)
+            result = result + str
+          end
+          result
+        end
+
+      end
+
+    end
+  end
+end

data/lib/sitar/version.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+module Sitar
+  VERSION = "0.0.1"
+end

data/sitar.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sitar"
+  spec.version       = Sitar::VERSION
+  spec.authors       = ["Slowhand0309"]
+  spec.email         = ["slowhand0309@gmail.com"]
+  
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.summary       = %q{Sitar is easy to use the fiddle}
+  spec.description   = %q{You can used C method only to extend module with Sitar and load shared library.}
+  spec.homepage      = "https://github.com/Slowhand0309/sitar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: sitar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Slowhand0309
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: You can used C method only to extend module with Sitar and load shared
+  library.
+email:
+- slowhand0309@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sitar.rb
+- lib/sitar/binder.rb
+- lib/sitar/executor.rb
+- lib/sitar/helper.rb
+- lib/sitar/types.rb
+- lib/sitar/types/aliases.rb
+- lib/sitar/types/pointer.rb
+- lib/sitar/types/struct_factory.rb
+- lib/sitar/types/wide_char.rb
+- lib/sitar/version.rb
+- sitar.gemspec
+homepage: https://github.com/Slowhand0309/sitar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Sitar is easy to use the fiddle
+test_files: []