ffidb 0.12.0

data/etc/templates/lisp.erb

@@ -0,0 +1,49 @@
+<% if header? %>
+; <%= FFIDB.header %>
+
+<% end %>
+(asdf:load-system :cffi)
+<% for library in @libraries %>
+<% if library && @functions[library] %>
+
+(cffi:define-foreign-library <%= library&.name || :lib %>
+  (t (:default "<%= dlopen_paths_for(library).first %>")))
+
+(cffi:use-foreign-library <%= library&.name || :lib %>)
+<% end %>
+<% for enum in @enums[library] || [] %>
+
+<% if enum.comment %>
+;; <%= enum.comment %>
+<% end %>
+(cffi:defcenum <%= enum.name %>
+<% for name, value in enum.values || {} %>
+  (:<%= name %> <%= value %>)
+<% end %>
+)
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+<% if struct.comment %>
+;; <%= struct.comment %>
+<% end %>
+<% if struct.opaque? %>
+(cffi:defctype <%= struct.name %> :pointer)
+<% else %>
+(cffi:defcstruct <%= struct.name %>
+<% for name, type in struct.fields || {} %>
+  (<%= name %> <%= struct_type(type).map(&:inspect).join(' ') %>)
+<% end %>
+)
+<% end %>
+<% end %>
+<% for function in @functions[library] || [] %>
+
+<% if function.comment %>
+;; <%= function.comment %>
+<% end %>
+(cffi:defcfun "<%= function.name %>" <%= param_type(function.type).inspect %> <%=
+  function.parameters.each_value.map { |p| "(#{p.name} #{param_type(p.type).inspect})" }.join(' ')
+%>)
+<% end %>
+<% end %>

data/etc/templates/python.erb

@@ -0,0 +1,59 @@
+<% if header? %>
+# <%= FFIDB.header %>
+
+<% end %>
+import ctypes, ctypes.util
+<% for library in @libraries %>
+<% if library && @functions[library] %>
+
+<%= library&.name || :lib %> = ctypes.CDLL(
+<% self.dlopen_paths_for(library).each_with_index do |library_path, i| %>
+    <%= i.nonzero? ? 'or ' : '' %>ctypes.util.find_library("<%= library_path %>")
+<% end %>
+<% if !options[:library_path] && library&.dlopen %>
+    or "<%= library.dlopen.first %>"
+<% end %>
+)
+<% end %>
+<% for enum in @enums[library] || [] %>
+
+<% if enum.comment %>
+# <%= enum.comment %>
+<% end %>
+<%= enum.name %> = ctypes.c_int
+<% for name, value in enum.values || {} %>
+<%= name %> = <%= value %>
+<% end %>
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+<% if struct.comment %>
+# <%= struct.comment %>
+<% end %>
+<% if struct.opaque? %>
+<%= struct.name %> = ctypes.POINTER(ctypes.c_void)
+<% else %>
+class <%= struct.name %>(Structure):
+  <% if struct.fields.nil? || struct.fields.empty? %>
+    _fields_ = []
+  <% else %>
+    _fields_ = [
+    <% for name, type in struct.fields || {} %>
+        (<%= name.to_s.inspect %>, <%= struct_type(type) %>),  # <%= type %>
+    <% end %>
+    ]
+  <% end %>
+<% end %>
+<% end %>
+<% for function in @functions[library] || [] %>
+
+<% if function.comment %>
+# <%= function.comment %>
+<% end %>
+<%= function.name %> = <%= library&.name || :lib %>.<%= function.name %>
+<%= function.name %>.restype = <%= param_type(function.type) %>
+<%= function.name %>.argtypes = [<%=
+  function.parameters.each_value.map { |p| param_type(p.type) }.join(', ')
+%>]
+<% end %>
+<% end %>

data/etc/templates/ruby.erb

@@ -0,0 +1,48 @@
+<% if header? %>
+# <%= FFIDB.header %>
+
+<% end %>
+require 'ffi'
+<% for library in @libraries %>
+
+module <%= options[:module] || library&.name&.capitalize || :FFI %>
+<% if library && @functions[library] %>
+  extend FFI::Library
+  ffi_lib [<%= dlopen_paths_for(library).map(&:inspect).join(', ') %>]
+<% end %>
+<% for enum in @enums[library] || [] %>
+
+  <% if enum.comment %>
+  # <%= enum.comment %>
+  <% end %>
+  <%= enum.name %> = :int
+  <% for name, value in enum.values || {} %>
+  <%= name %> = <%= value %>
+  <% end %>
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+  <% if struct.comment %>
+  # <%= struct.comment %>
+  <% end %>
+  <% if struct.opaque? %>
+  <%= struct.name %> = FFI::Pointer
+  <% else %>
+  class <%= struct.name %> < FFI::Struct
+  <% for (name, type), i in (struct.fields || {}).each_with_index %>
+    <%= i.zero? ? 'layout' : ' '*6 %> :<%= name %>, <%= struct_type(type).inspect %><%= (i == (struct.fields || {}).size-1) ? '' : ',' %>  # <%= type %>
+  <% end %>
+  end
+  <% end %>
+<% end %>
+<% for function in @functions[library] || [] %>
+
+  <% if function.comment %>
+  # <%= function.comment %>
+  <% end %>
+  attach_function :<%= function.name %>, [<%=
+    function.parameters.each_value.map { |p| param_type(p.type).inspect }.join(', ')
+  %>], :<%= param_type(function.type) %>
+<% end %>
+end # <%= options[:module] || library&.name&.capitalize || :FFI %>
+<% end %>

data/lib/ffidb.rb

@@ -0,0 +1,34 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'ffidb/enum'
+require_relative 'ffidb/errors'
+require_relative 'ffidb/exporter'
+require_relative 'ffidb/exporters'
+require_relative 'ffidb/function'
+require_relative 'ffidb/glob'
+require_relative 'ffidb/header'
+require_relative 'ffidb/header_parser'
+require_relative 'ffidb/library'
+require_relative 'ffidb/library_parser'
+require_relative 'ffidb/location'
+require_relative 'ffidb/parameter'
+require_relative 'ffidb/registry'
+require_relative 'ffidb/release'
+require_relative 'ffidb/struct'
+require_relative 'ffidb/symbolic'
+require_relative 'ffidb/symbol_table'
+require_relative 'ffidb/sysexits'
+require_relative 'ffidb/type'
+require_relative 'ffidb/typedef'
+require_relative 'ffidb/union'
+require_relative 'ffidb/version'
+
+module FFIDB
+  HEADER = "This is free and unencumbered software released into the public domain.".freeze
+
+  ##
+  # @return [String]
+  def self.header
+    HEADER
+  end
+end # FFIDB

data/lib/ffidb/enum.rb

@@ -0,0 +1,37 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'symbolic'
+
+module FFIDB
+  class Enum < ::Struct.new(:name, :values, :comment)
+    include Symbolic
+
+    ##
+    # @param  [Symbol, #to_sym] name
+    # @param  [Map<String, Integer>] values
+    # @param  [String, #to_s] comment
+    def initialize(name, values = {}, comment = nil)
+      super(name.to_sym, values || {}, comment&.to_s)
+    end
+
+    ##
+    # @return [Boolean]
+    def enum?() return true end
+
+    ##
+    # @return [String]
+    def to_s
+      "enum #{self.name}"
+    end
+
+    ##
+    # @return [Hash<Symbol, Type>]
+    def to_h
+      {
+        name: self.name.to_s,
+        comment: self.comment,
+        values: self.values,
+      }.delete_if { |k, v| v.nil? }
+    end
+  end # Enum
+end # FFIDB

data/lib/ffidb/errors.rb

@@ -0,0 +1,64 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'sysexits'
+
+module FFIDB
+  ##
+  # Base class for FFIDB errors.
+  class Error < StandardError
+    EXIT_CODE = Sysexits::EX_SOFTWARE
+
+    ##
+    # @return [Integer]
+    def exit_code
+      self.class.const_get(:EXIT_CODE)
+    end
+  end
+
+  ##
+  # An error indicating that a problem with the registry.
+  class RegistryError < Error
+    EXIT_CODE = Sysexits::EX_CONFIG
+  end
+
+  ##
+  # An error indicating that opening a registry directory requires a newer
+  # version of FFIDB.rb than the current one.
+  class RegistryVersionMismatch < RegistryError; end
+
+  ##
+  # An error indicating that an FFI symbol was not found.
+  class SymbolNotFound < Error
+    EXIT_CODE = Sysexits::EX_NOINPUT
+
+    def initialize(symbol_kind, symbol_name)
+      super("#{symbol_kind.to_s.capitalize} not found: #{symbol_name}")
+    end
+  end
+
+  ##
+  # An error indicating that an FFI function was not found.
+  class FunctionNotFound < SymbolNotFound
+    def initialize(function_name)
+      super(:function, function_name)
+    end
+  end
+
+  ##
+  # A warning raised during header file parsing.
+  class ParseWarning < Error
+    EXIT_CODE = Sysexits::EX_DATAERR
+  end
+
+  ##
+  # An error raised during header file parsing.
+  class ParseError < Error
+    EXIT_CODE = Sysexits::EX_DATAERR
+  end
+
+  ##
+  # A fatal error raised during header file parsing.
+  class ParsePanic < Error
+    EXIT_CODE = Sysexits::EX_DATAERR
+  end
+end # FFIDB

data/lib/ffidb/exporter.rb

@@ -0,0 +1,141 @@
+# This is free and unencumbered software released into the public domain.
+
+#require 'erb'
+require 'tilt' # https://rubygems.org/gems/tilt
+require 'yaml'
+
+module FFIDB
+  class Exporter
+    def self.for(format) # TODO
+      require_relative 'exporters'
+      case format&.to_sym
+        when :c, :c99, :c11, :c18 then Exporters::C
+        when :'c++', :'c++11', :'c++14', :'c++17', :'c++20', :cpp, :cxx then Exporters::Cpp
+        when :csv then Exporters::CSV
+        when :dart, :flutter then Exporters::Dart
+        when :go, :cgo then Exporters::Go
+        when :java, :jna then Exporters::Java
+        when :json then Exporters::JSON
+        when :lisp, :'common-lisp' then Exporters::Lisp
+        when :python, :py then Exporters::Python
+        when :ruby, :rb then Exporters::Ruby
+        # TODO: csharp, haskell, julia, luajit, nim, nodejs, ocaml, php, racket, rust, zig
+        when :yaml then Exporters::YAML
+        else raise "unknown output format: #{format}"
+      end
+    end
+
+    attr_reader :options
+
+    def initialize(stream = $stdout, **kwargs)
+      @stream = stream
+      @options = kwargs.transform_keys(&:to_sym).freeze
+    end
+
+    def debug?
+      self.options[:debug]
+    end
+
+    def verbose?
+      self.options[:verbose] || self.debug?
+    end
+
+    def header?
+      self.options[:header]
+    end
+
+    def emit(&block)
+      begin
+        self.begin
+        yield self
+        self.finish
+      ensure
+        self.close
+      end
+    end
+
+    def dlopen_paths_for(library)
+      if library_path = self.options[:library_path]
+        library.objects.map { |lib| library_path.delete_suffix('/') << "/" << lib }
+      else
+        library.objects + library.dlopen
+      end
+    end
+
+    def begin() end
+
+    def begin_library(library)
+      @library = library
+      @libraries ||= []
+      @libraries << library
+      @typedefs ||= {}
+      @enums ||= {}
+      @structs ||= {}
+      @unions ||= {}
+      @functions ||= {}
+    end
+
+    def export_header(header)
+      header.typedefs.sort.each { |typedef| self.export_typedef(typedef) }
+      header.enums.sort.each { |enum| self.export_enum(enum) }
+      header.structs.sort.each { |struct| self.export_struct(struct) }
+      header.unions.sort.each { |union| self.export_union(union) }
+      header.functions.sort.each { |function| self.export_function(function) }
+    end
+
+    def export_symbol(symbol, disabled: nil)
+      self.__send__("export_#{symbol.kind}", symbol, disabled: disabled)
+    end
+
+    def export_typedef(typedef, disabled: nil)
+      (@typedefs[@library] ||= []) << typedef
+    end
+
+    def export_enum(enum, disabled: nil)
+      (@enums[@library] ||= []) << enum
+    end
+
+    def export_struct(struct, disabled: nil)
+      (@structs[@library] ||= []) << struct
+    end
+
+    def export_union(union, disabled: nil)
+      (@unions[@library] ||= []) << union
+    end
+
+    def export_function(function, disabled: nil)
+      (@functions[@library] ||= []) << function
+    end
+
+    def finish_library
+      @library = nil
+    end
+
+    def finish() end
+
+    def close() end
+
+    protected
+
+    def puts(*args)
+      @stream.puts *args
+    end
+
+    def print(*args)
+      @stream.print *args
+    end
+
+    def render_template(template_name)
+      #ERB.new(self.load_template(template_name)).result(binding)
+      Tilt.new(self.path_to_template(template_name)).render(self)
+    end
+
+    def load_template(template_name)
+      File.read(self.path_to_template(template_name))
+    end
+
+    def path_to_template(template_name)
+      File.expand_path("../../etc/templates/#{template_name}", __dir__)
+    end
+  end # Exporter
+end # FFIDB

data/lib/ffidb/exporters.rb

@@ -0,0 +1,28 @@
+# This is free and unencumbered software released into the public domain.
+
+module FFIDB
+  module Exporters; end
+end
+
+require_relative 'exporters/c'
+require_relative 'exporters/cpp'
+require_relative 'exporters/csharp'
+require_relative 'exporters/csv'
+require_relative 'exporters/dart'
+require_relative 'exporters/go'
+require_relative 'exporters/haskell'
+require_relative 'exporters/java'
+require_relative 'exporters/julia'
+require_relative 'exporters/json'
+require_relative 'exporters/lisp'
+require_relative 'exporters/luajit'
+require_relative 'exporters/nim'
+require_relative 'exporters/nodejs'
+require_relative 'exporters/ocaml'
+require_relative 'exporters/php'
+require_relative 'exporters/python'
+require_relative 'exporters/racket'
+require_relative 'exporters/ruby'
+require_relative 'exporters/rust'
+require_relative 'exporters/yaml'
+require_relative 'exporters/zig'