c2ffi4rb 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86a593339fb44c53b753ecbae5120b0d3cd67363f8899b8122fa100f800d1fcc
+  data.tar.gz: c2a2c0ab90ce7e1307d706b268778267237691a56ce71491bfe2503b27b3f8c8
+SHA512:
+  metadata.gz: 42260432b9a7267183c23e4ab79303257e25445c5ea5be46bcf61d7d27b43e8283144741bcf6eb95a9fd66ac7e3094067e68165648fa6fe13594459b588670f4
+  data.tar.gz: '08281db0ccbaedba8fb39908f343c69dbe348da5e8e49071ded01c382468962b84b308b59c6a57c707586a94dba6b5fb86937d48e0c3a1f37486ae1b52b29bdd'

data/README.md

@@ -0,0 +1,31 @@
+# c2ffi4rb
+
+[c2ffi](https://github.com/rpav/c2ffi) - FFI binding generator - for Ruby
+
+# installation
+
+```sh
+gem install c2ffi4rb
+```
+
+## Usage
+
+First, produce a `spec` file using `c2ffi`:
+
+```sh
+c2ffi -M macros.h -o example.json example.h
+c2ffi -o macros.json macros.h
+```
+
+Now you can generate a file manually with the included tool,
+`c2ffi-ruby`, as follows:
+
+```sh
+c2ffi4rb example.json macro.json > simple.rb
+```
+
+This produces the `simple.rb` file, as included.
+
+## Licence
+
+- [LGPL-2](https://github.com/rpav/c2ffi-ruby/blob/master/c2ffi-ruby.gemspec)

data/exe/c2ffi4rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+## This is meant to be more of an unsophisticated demo than a
+## production tool.  Generating spec and ruby files should be part of
+## your build system.  But this is how you can use it.
+
+require 'optparse'
+require 'json'
+require 'c2ffi4rb'
+
+options = {}
+
+Version = C2FFI4RB::VERSION # Fixme
+
+opts = OptionParser.new
+opts.banner = 'Usage: c2ffi4rb [options] [file1, file2, ...]'
+opts.on('-h', '--help', 'Show this message') do
+  puts opts
+  exit
+end
+opts.parse!
+
+if ARGV.empty?
+  warn opts
+  exit 1
+end
+
+spec = []
+ARGV.each do |file|
+  File.open(file) do |io|
+    spec += JSON.parse(io.read, Hash[:symbolize_names, true])
+  end
+end
+
+C2FFI4RB::Parser.parse(spec)

data/lib/c2ffi4rb/parser.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module C2FFI4RB
+  class Parser
+    TYPE_TABLE = {
+      "unsigned-int": :uint,
+      "unsigned-char": :uchar,
+      "unsigned-long": :ulong,
+      "function-pointer": :pointer
+    }.freeze
+
+    def self.parse(arr)
+      Parser.new.parse(arr)
+    end
+
+    def initialize
+      @struct_type = {}
+      @toplevels = []
+      @anon_counter = 0
+    end
+
+    def parse(arr)
+      arr.each do |form|
+        s = parse_toplevel(form)
+        @toplevels << s if s
+      end
+
+      @toplevels.each do |t|
+        puts
+        case t
+        when String
+          puts "#{t}"
+        when Array
+          t.each do |l|
+            puts "#{l}"
+          end
+        end
+      end
+    end
+
+    private
+
+    def parse_toplevel(form)
+      case form[:tag]
+      when 'typedef'
+        type = parse_type(form[:type])
+
+        # I don't think typedef works right with structs, so assign
+        if @struct_type[type]
+          name = add_struct(form[:name])
+          "#{name} = #{type}"
+        else
+          "typedef #{type}, :#{form[:name]}"
+        end
+
+      when 'const'
+        type = parse_type(form[:type])
+        if type == ':string'
+          "#{form[:name].upcase} = \"#{form[:value]}\""
+        else
+          "#{form[:name].upcase} = #{form[:value]}"
+        end
+
+      when 'extern'
+        'attach_variable ' \
+            ":#{form[:name]}, :#{form[:name]}, #{parse_type(form[:type])}"
+
+      when 'function'
+        s = []
+        s << "attach_function '#{form[:name]}', ["
+        form[:parameters].each do |f|
+          s << "  #{parse_type(f[:type])},"
+        end
+        s << "], #{parse_type(form['return-type'.intern])}"
+      # emacs doesn't like :"foo" ---^
+
+      when 'struct', 'union'
+        name = add_struct(form[:name])
+        make_struct(form)
+
+      when 'enum'
+        name = add_enum(form[:name])
+        s = []
+        s << "enum #{name}, ["
+        form[:fields].each do |f|
+          s << "  :#{f[:name]}, #{f[:value]},"
+        end
+        s << ']'
+      end
+    end
+
+    def add_struct(name)
+      if name == ''
+        @anon_counter += 1
+        name = 'Anon_Type_' + @anon_counter.to_s
+        return name
+      end
+
+      name = 'C' + name if name.start_with? '_'
+
+      name = name.capitalize.gsub!(/_([a-z])/) { |m| "_#{m[1].upcase}" }
+      @struct_type[name] = true
+      name
+    end
+
+    def add_enum(name)
+      if name == ''
+        @anon_counter += 1
+        name = ':anon_type_' + @anon_counter.to_s
+        return name
+      end
+
+      if name[0] != ':'
+        ":#{name}"
+      else
+        name
+      end
+    end
+
+    def make_struct(form)
+      name = add_struct(form[:name])
+
+      type = if form[:tag] == ':struct'
+               'FFI::Struct'
+             else
+               'FFI::Union'
+             end
+
+      s = []
+      s << "class #{name} < #{type}"
+
+      if form[:fields].length.positive?
+        s << '  layout \\'
+        size = form[:fields].length
+        sep = ','
+        form[:fields].each_with_index do |f, i|
+          sep = '' if i >= (size - 1)
+          s << "    :#{f[:name]}, #{parse_type(f[:type])}#{sep}"
+        end
+      end
+      s << 'end'
+    end
+
+    def parse_type(form)
+      tt = TYPE_TABLE[form[:tag]]
+      return tt if tt
+
+      case form[:tag]
+      when ':pointer'
+        pointee = parse_type(form[:type])
+        if [':char', ':uchar'].include?(pointee)
+          ':string'
+        elsif @struct_type[pointee]
+          "#{@struct_type[pointee]}.ptr"
+        else
+          ':pointer'
+        end
+
+      when ':array'
+        "[#{parse_type(form[:type])}, #{form[:size]}]"
+
+      when ':struct', ':union'
+        add_struct(form[:name])
+
+      when ':enum'
+        add_enum(form[:name])
+
+      when 'enum'
+        form[:name] = add_enum(form[:name])
+        parse_toplevel(form)
+        form[:name]
+
+      when 'struct', 'union'
+        form[:name] = add_struct(form[:name])
+        parse_toplevel(form)
+        form[:name]
+
+      else
+        # All non-Classy types are :-prefixed?
+        if form[:tag][0] != ':'
+          ":#{form[:tag]}"
+        else
+          form[:tag]
+        end
+      end
+    end
+  end
+end

data/lib/c2ffi4rb/version.rb

@@ -0,0 +1,3 @@
+module C2FFI4RB
+  VERSION = '0.0.0'
+end

data/lib/c2ffi4rb.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'c2ffi4rb/version'
+require_relative 'c2ffi4rb/parser'
+
+module C2FFI4RB
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: c2ffi4rb
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- kojix2
+- Ryan Pavlik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Import C2FFI JSON to ruby/ffi
+email:
+- 2xijok@gmail.com
+- rpavlik@gmail.com
+executables:
+- c2ffi4rb
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/c2ffi4rb
+- lib/c2ffi4rb.rb
+- lib/c2ffi4rb/parser.rb
+- lib/c2ffi4rb/version.rb
+homepage: https://github.com/kojix2/c2ffi4rb
+licenses:
+- LGPL-2
+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: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: C2FFI for Ruby-FFI
+test_files: []