ffidb 0.12.0

data/lib/ffidb/exporters/c.rb

@@ -0,0 +1,52 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the C programming language.
+  class C < FFIDB::Exporter
+    SYMBOL_INDENT    = 0
+    EXTERN_QUALIFIER = 'extern'
+
+    def finish
+      puts self.render_template('c.erb')
+    end
+
+    def _export_function(function, **kwargs)
+      parameters = function.parameters.each_value.map do |p|
+        p_type = case
+          when p.type.function_pointer?
+            p.type.to_s.sub('(*)', "(*#{p.name})")
+          when self.options[:parameter_names] == false
+            p.type.to_s.gsub(' *', '*')
+          else "#{p.type.to_s.gsub(' *', '*')} #{p.name}"
+        end
+        p_type.gsub('const char *const[]', 'const char* const*') # FIXME
+      end
+      print ' '*self.symbol_indent if self.symbol_indent.nonzero?
+      print self.extern_qualifier, ' ' if self.extern_qualifier
+      if function.type.function_pointer?
+        print function.type.to_s.sub('(*)', "(*#{function.name}(#{parameters.join(', ')}))")
+      else
+        print function.type, ' ', function.name, '('
+        parameters.each_with_index do |p, i|
+          print ', ' if i.nonzero?
+          print p
+        end
+        print ')'
+      end
+      puts (self.options[:semicolon] == false ? '' : ';')
+    end
+
+    protected
+
+    def symbol_indent
+      self.class.const_get(:SYMBOL_INDENT)
+    end
+
+    def extern_qualifier
+      self.class.const_get(:EXTERN_QUALIFIER)
+    end
+  end # C
+end # FFIDB::Exporters

data/lib/ffidb/exporters/cpp.rb

@@ -0,0 +1,13 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'c'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the C++ programming language.
+  class Cpp < C
+    def finish
+      puts self.render_template('cpp.erb')
+    end
+  end # Cpp
+end # FFIDB::Exporters

data/lib/ffidb/exporters/csharp.rb

@@ -0,0 +1,6 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://docs.microsoft.com/en-us/dotnet/framework/interop/platform-invoke-examples
+# TODO: https://docs.microsoft.com/en-us/dotnet/framework/interop/
+# TODO: https://docs.microsoft.com/en-us/dotnet/framework/interop/consuming-unmanaged-dll-functions
+# TODO: https://docs.microsoft.com/en-us/dotnet/api/system.runtime.interopservices.dllimportattribute

data/lib/ffidb/exporters/csv.rb

@@ -0,0 +1,24 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the CSV file format.
+  class CSV < FFIDB::Exporter
+    DELIMITER = ','
+
+    def begin
+      puts [:library, :kind, :name].join(DELIMITER) # TODO: definition
+    end
+
+    def export_symbol(symbol, **kwargs)
+      puts [@library&.name, symbol.kind, symbol.name].join(DELIMITER)
+    end
+    alias_method :export_typedef, :export_symbol
+    alias_method :export_enum, :export_symbol
+    alias_method :export_struct, :export_symbol
+    alias_method :export_union, :export_symbol
+    alias_method :export_function, :export_symbol
+  end # CSV
+end # FFIDB::Exporters

data/lib/ffidb/exporters/dart.rb

@@ -0,0 +1,60 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the Dart programming language.
+  #
+  # @see https://dart.dev/guides/libraries/c-interop
+  # @see https://flutter.dev/docs/development/platform-integration/c-interop
+  # @see https://api.dart.dev/dev/dart-ffi/dart-ffi-library.html
+  class Dart < FFIDB::Exporter
+    TYPE_MAP_FFI = ::YAML.load(File.read(File.expand_path("../../../etc/mappings/dart.yaml", __dir__)))
+      .freeze
+
+    # @see https://dart.dev/guides/language/language-tour
+    TYPE_MAP_DART = {
+      :Void                => :void,
+      :Int8                => :int,
+      :Int16               => :int,
+      :Int32               => :int,
+      :Int64               => :int,
+      :Uint8               => :int,
+      :Uint16              => :int,
+      :Uint32              => :int,
+      :Uint64              => :int,
+      :Float               => :double,
+      :Double              => :double,
+      :IntPtr              => :int,
+      'Pointer<Int8>'      => 'Pointer<Int8>',
+      nil                  => 'Pointer<Void>',
+    }
+
+    def finish
+      puts self.render_template('dart.erb')
+    end
+
+    protected
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [#to_s]
+    def dart_param_type(c_type)
+      TYPE_MAP_DART[self.ffi_param_type(c_type)] || TYPE_MAP_DART[nil]
+    end
+    alias_method :dart_struct_type, :dart_param_type
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [#to_s]
+    def ffi_param_type(c_type)
+      case
+        #when c_type.array? then # TODO: https://github.com/dart-lang/sdk/issues/35763
+        when c_type.enum? then :Int32
+        else TYPE_MAP_FFI[c_type.to_s] || TYPE_MAP_FFI['void *']
+      end
+    end
+    alias_method :ffi_struct_type, :ffi_param_type
+  end # Dart
+end # FFIDB::Exporters

data/lib/ffidb/exporters/go.rb

@@ -0,0 +1,16 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'c'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the Go programming language (using Cgo).
+  #
+  # @see https://golang.org/cmd/cgo/
+  # @see https://github.com/golang/go/wiki/cgo
+  class Go < C
+    def finish
+      puts self.render_template('go.erb')
+    end
+  end # Go
+end # FFIDB::Exporters

data/lib/ffidb/exporters/haskell.rb

@@ -0,0 +1,3 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://wiki.haskell.org/Foreign_Function_Interface

data/lib/ffidb/exporters/java.rb

@@ -0,0 +1,39 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the Java programming language (using JNA).
+  #
+  # @see https://github.com/java-native-access/jna/blob/master/www/GettingStarted.md
+  class Java < FFIDB::Exporter
+    TYPE_MAP = ::YAML.load(File.read(File.expand_path("../../../etc/mappings/java.yaml", __dir__)))
+      .freeze
+
+    def begin_library(library)
+      if library
+        interface_name = self.options[:module] || library.name.capitalize
+        library.define_singleton_method(:interface_name) { interface_name }
+      end
+      super(library)
+    end
+
+    def finish
+      puts self.render_template('java.erb')
+    end
+
+    protected
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [#to_s]
+    def param_type(c_type)
+      case
+        when c_type.enum? then :int
+        else TYPE_MAP[c_type.to_s] || TYPE_MAP['void *']
+      end
+    end
+    alias_method :struct_type, :param_type
+  end # Java
+end # FFIDB::Exporters

data/lib/ffidb/exporters/json.rb

@@ -0,0 +1,38 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+require 'json'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the JSON data interchange language.
+  class JSON < FFIDB::Exporter
+    def begin
+      # No header, because JSON doesn't support comments
+      @json = {}
+    end
+
+    def begin_library(library)
+      @library = library
+      @json[@library&.name] ||= {}
+    end
+
+    def export_symbol(symbol, **kwargs)
+      @json[@library&.name][symbol.name] = {kind: symbol.kind.to_s}.merge!(symbol.to_h)
+    end
+    alias_method :export_typedef, :export_symbol
+    alias_method :export_enum, :export_symbol
+    alias_method :export_struct, :export_symbol
+    alias_method :export_union, :export_symbol
+    alias_method :export_function, :export_symbol
+
+    def finish_library
+      @library = nil
+    end
+
+    def finish
+      puts ::JSON.pretty_generate(@json)
+    end
+  end # JSON
+end # FFIDB::Exporters

data/lib/ffidb/exporters/julia.rb

@@ -0,0 +1,3 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://docs.julialang.org/en/v1/manual/calling-c-and-fortran-code/

data/lib/ffidb/exporters/lisp.rb

@@ -0,0 +1,41 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the Common Lisp programming language (using CFFI).
+  #
+  # @see https://common-lisp.net/project/cffi/
+  class Lisp < FFIDB::Exporter
+    TYPE_MAP = ::YAML.load(File.read(File.expand_path("../../../etc/mappings/lisp.yaml", __dir__)))
+      .transform_values(&:to_sym)
+      .freeze
+
+    def finish
+      puts self.render_template('lisp.erb')
+    end
+
+    protected
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [#inspect]
+    def struct_type(c_type)
+      case
+        when c_type.array? then [c_type.array_type.to_s.to_sym, :count, c_type.array_size]
+        else [self.param_type(c_type)]
+      end
+    end
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [#inspect]
+    def param_type(c_type)
+      case
+        when c_type.enum? then :int
+        else TYPE_MAP[c_type.to_s] || TYPE_MAP['void *']
+      end
+    end
+  end # Lisp
+end # FFIDB::Exporters

data/lib/ffidb/exporters/luajit.rb

@@ -0,0 +1,3 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://luajit.org/ext_ffi.html

data/lib/ffidb/exporters/nim.rb

@@ -0,0 +1,4 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://nim-lang.org/docs/manual.html#foreign-function-interface
+# TODO: https://livebook.manning.com/book/nim-in-action/chapter-8/

data/lib/ffidb/exporters/nodejs.rb

@@ -0,0 +1,4 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://github.com/node-ffi/node-ffi
+# TODO: https://github.com/node-ffi/node-ffi/wiki/Node-FFI-Tutorial

data/lib/ffidb/exporters/ocaml.rb

@@ -0,0 +1,4 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://ocamlverse.github.io/content/ffi.html
+# TODO: http://ocamllabs.io/ocaml-ctypes/PosixTypes.html

data/lib/ffidb/exporters/php.rb

@@ -0,0 +1,4 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://wiki.php.net/rfc/ffi
+# TODO: https://www.php.net/manual/en/book.ffi.php

data/lib/ffidb/exporters/python.rb

@@ -0,0 +1,35 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the Python programming language (using ctypes).
+  #
+  # @see https://docs.python.org/3/library/ctypes.html
+  class Python < FFIDB::Exporter
+    TYPE_MAP = ::YAML.load(File.read(File.expand_path("../../../etc/mappings/python.yaml", __dir__)))
+      .freeze
+
+    def finish
+      puts self.render_template('python.erb')
+    end
+
+    protected
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [#to_s]
+    def param_type(c_type)
+      case
+        when c_type.enum? then 'ctypes.c_int'
+        when c_type.array? then [self.param_type(c_type.array_type), '*', c_type.array_size].join(' ')
+        else case py_type = TYPE_MAP[c_type.to_s] || TYPE_MAP['void *']
+          when 'None' then py_type
+          else "ctypes.#{py_type}"
+        end
+      end
+    end
+    alias_method :struct_type, :param_type
+  end # Python
+end # FFIDB::Exporters

data/lib/ffidb/exporters/racket.rb

@@ -0,0 +1,3 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://docs.racket-lang.org/foreign/intro.html

data/lib/ffidb/exporters/ruby.rb

@@ -0,0 +1,33 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the Ruby programming language (using FFI).
+  #
+  # @see https://github.com/ffi/ffi/wiki
+  class Ruby < FFIDB::Exporter
+    TYPE_MAP = ::YAML.load(File.read(File.expand_path("../../../etc/mappings/ruby.yaml", __dir__)))
+      .transform_values(&:to_sym)
+      .freeze
+
+    def finish
+      puts self.render_template('ruby.erb')
+    end
+
+    protected
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [#inspect]
+    def param_type(c_type)
+      case
+        when c_type.enum? then :int
+        when c_type.array? then [self.param_type(c_type.array_type), c_type.array_size]
+        else TYPE_MAP[c_type.to_s] || TYPE_MAP['void *']
+      end
+    end
+    alias_method :struct_type, :param_type
+  end # Ruby
+end # FFIDB::Exporters

data/lib/ffidb/exporters/rust.rb

@@ -0,0 +1,5 @@
+# This is free and unencumbered software released into the public domain.
+
+# TODO: https://doc.rust-lang.org/nomicon/ffi.html
+# TODO: https://doc.rust-lang.org/1.0.0/book/ffi.html
+# TODO: https://rust-embedded.github.io/book/interoperability/c-with-rust.html

data/lib/ffidb/exporters/yaml.rb

@@ -0,0 +1,31 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative '../exporter'
+
+module FFIDB::Exporters
+  ##
+  # Code generator for the YAML markup language.
+  class YAML < FFIDB::Exporter
+    def begin
+      puts "# #{FFIDB.header}" if self.header?
+      puts if self.header?
+    end
+
+    def begin_library(library) end
+
+    def export_symbol(symbol, **kwargs)
+      @counter ||= 0
+      puts unless @counter.zero?
+      puts "# #{symbol.instance_variable_get(:@debug)}" if self.debug? && symbol.instance_variable_get(:@debug)
+      puts symbol.to_yaml
+      @counter += 1
+    end
+    alias_method :export_typedef, :export_symbol
+    alias_method :export_enum, :export_symbol
+    alias_method :export_struct, :export_symbol
+    alias_method :export_union, :export_symbol
+    alias_method :export_function, :export_symbol
+
+    def finish_library() end
+  end # YAML
+end # FFIDB::Exporters