ffidb 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 832a289161ba25e274a8a6d3a20a1592ec40bff4e3774400e6d7f5b3286335c5
-  data.tar.gz: 6b27cb31d52109e2a44c5c8a72f830b772d306206acec33add96eb8faf23e464
+  metadata.gz: b3d376934e5941a0509caeef0ec2b8c0fd2726234b62b499098097b501889012
+  data.tar.gz: 311ba10e14c9c50818cf8a3ffa928c55a989f285c599cd08e56c70caeed73319
 SHA512:
-  metadata.gz: 3b6bc06df8f1d94ded39f0370874d6c02c2f6dc33321f8a7affc51a3f53e2db5300b9291447b5528758a9ba5b22e3402a45b01f5ee17cca5acb642db531298ea
-  data.tar.gz: 4fba31365dbb2b0567dd381075b8f36c3d3bcf07324c9edf143f19e7472e7eabe1c6a17a00fff7b945e55ca47db33b81d1c7eb034e28de32753bff0adb1da820
+  metadata.gz: abfe03bcad1996b4eca15e62e8eacb0486b5a826d75e34c05ec63d500efbe74087b12259dc82fab13d934d4b573add37bc122a63a091a4ee3a6735d9605434a1
+  data.tar.gz: 0aa715b38545c0e4d09558b251ba198efa24bcd1bc6cc3c0e162aa75b8baf85cfd5e9f85319a71502d7d6885d3688aeff071fd9ab13a9d6b3cef60534fdc5c08

data/README.md

@@ -18,6 +18,22 @@ After installation, download and initialize the FFI DB registry as follows:
 
 Your local FFI DB registry is located at the path `$HOME/.ffidb/`.
 
+Features
+--------
+
+### Code generation
+
+| ID      | Language    | typedefs | enums | structs | unions | functions |
+| :------ | :---------- | :------- | :---- | :------ | :----- | :-------- |
+| c       | C           |          | ✔     |  ✔      |        |  ✔        | 
+| c++     | C++         |          | ✔     |  ✔      |        |  ✔        | 
+| dart    | Dart        |          | ✔     |  ✔      |        |  ✔        | 
+| go      | Go          |          | ✔     |  ✔      |        |  ✔        | 
+| java    | Java        |          | ✔     |  ✔      |        |  ✔        | 
+| lisp    | Common Lisp |          | ✔     |  ✔      |        |  ✔        | 
+| python  | Python      |          | ✔     |  ✔      |        |  ✔        | 
+| ruby    | Ruby        |          | ✔     |  ✔      |        |  ✔        | 
+
 Examples (API)
 --------------
 

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.13.0

data/etc/templates/c.erb

@@ -15,7 +15,7 @@
 <% for enum in @enums[library] || [] %>
 
 <% if enum.comment %>
-// <%= enum.comment %>
+<%= format_comment(enum.comment, '//') %>
 <% end %>
 enum <%= enum.name %> {
 <% for name, value in enum.values || {} %>
@@ -26,7 +26,7 @@ enum <%= enum.name %> {
 <% for struct in @structs[library] || [] %>
 
 <% if struct.comment %>
-// <%= struct.comment %>
+<%= format_comment(struct.comment, '//') %>
 <% end %>
 struct <%= struct.name %> {
 <% for name, type in struct.fields || {} %>
@@ -37,7 +37,7 @@ struct <%= struct.name %> {
 <% for function in @functions[library] || [] %>
 
 <% if function.comment %>
-// <%= function.comment %>
+<%= format_comment(function.comment, '//') %>
 <% end %>
 extern <%= function.type %> <%= function.name %>(<%=
   function.parameters.each_value.map { |p| "#{p.type} #{p.name}" }.join(', ')

data/etc/templates/cpp.erb

@@ -13,7 +13,7 @@ namespace <%= self.options[:module] || library&.name || :lib %> {
 <% for enum in @enums[library] || [] %>
 
   <% if enum.comment %>
-  // <%= enum.comment %>
+<%= format_comment(enum.comment, '  //') %>
   <% end %>
   enum <%= enum.name %> {
   <% for name, value in enum.values || {} %>
@@ -24,7 +24,7 @@ namespace <%= self.options[:module] || library&.name || :lib %> {
 <% for struct in @structs[library] || [] %>
 
   <% if struct.comment %>
-  // <%= struct.comment %>
+<%= format_comment(struct.comment, '  //') %>
   <% end %>
   struct <%= struct.name %> {
   <% for name, type in struct.fields || {} %>
@@ -35,7 +35,7 @@ namespace <%= self.options[:module] || library&.name || :lib %> {
 <% for function in @functions[library] || [] %>
 
   <% if function.comment %>
-  // <%= function.comment %>
+<%= format_comment(function.comment, '  //') %>
   <% end %>
   extern "C" <%= function.type %> <%= function.name %>(<%=
     function.parameters.each_value.map { |p| "#{p.type} #{p.name}" }.join(', ')

data/etc/templates/dart.erb

@@ -16,7 +16,7 @@ final <%= library&.name || :lib %> = DynamicLibrary.open('<%= dlopen_paths_for(l
 <% for enum in @enums[library] || [] %>
 
 <% if enum.comment %>
-/// <%= enum.comment %>
+<%= format_comment(enum.comment, '///') %>
 <% end %>
 abstract class <%= enum.name %> {
   <%= enum.name %>._();
@@ -29,11 +29,12 @@ abstract class <%= enum.name %> {
 <% for struct in @structs[library] || [] %>
 
 <% if struct.comment %>
-/// <%= struct.comment %>
+<%= format_comment(struct.comment, '///') %>
 <% end %>
 <% if struct.opaque? %>
 class <%= struct.name %> extends Struct {
-    Int8 _opaque;
+    @Uint8()
+    int _opaque;
 <% else %>
 class <%= struct.name %> extends Struct {
   <% for (name, type), i in (struct.fields || {}).each_with_index %>
@@ -51,7 +52,7 @@ class <%= struct.name %> extends Struct {
 <% for function in @functions[library] || [] %>
 
 <% if function.comment %>
-/// <%= function.comment %>
+<%= format_comment(function.comment, '///') %>
 <% end %>
 final <%= dart_param_type(function.type) %> Function(<%=
       function.parameters.each_value.map { |p| dart_param_type(p.type) }.join(', ')

data/etc/templates/go.erb

@@ -17,7 +17,7 @@
 <% for enum in @enums[library] || [] %>
 
 <% if enum.comment %>
-// <%= enum.comment %>
+<%= format_comment(enum.comment, '//') %>
 <% end %>
 enum <%= enum.name %> {
 <% for name, value in enum.values || {} %>
@@ -28,7 +28,7 @@ enum <%= enum.name %> {
 <% for struct in @structs[library] || [] %>
 
 <% if struct.comment %>
-// <%= struct.comment %>
+<%= format_comment(struct.comment, '//') %>
 <% end %>
 struct <%= struct.name %> {
 <% for name, type in struct.fields || {} %>
@@ -39,7 +39,7 @@ struct <%= struct.name %> {
 <% for function in @functions[library] || [] %>
 
 <% if function.comment %>
-// <%= function.comment %>
+<%= format_comment(function.comment, '//') %>
 <% end %>
 extern <%= function.type %> <%= function.name %>(<%=
   function.parameters.each_value.map { |p| "#{p.type} #{p.name}" }.join(', ')

data/etc/templates/java.erb

@@ -16,9 +16,9 @@ public interface <%= library&.interface_name || :FFI %> extends Library {
 <% end %>
 <% for enum in @enums[library] || [] %>
 
-<% if enum.comment %>
-  // <%= enum.comment %>
-<% end %>
+  <% if enum.comment %>
+<%= format_comment(enum.comment, '  //') %>
+  <% end %>
   public static class <%= enum.name %> {
   <% for name, value in enum.values || {} %>
     public static final int <%= name %> = <%= value %>;
@@ -28,7 +28,7 @@ public interface <%= library&.interface_name || :FFI %> extends Library {
 <% for struct in @structs[library] || [] %>
 
   <% if struct.comment %>
-  // <%= struct.comment %>
+<%= format_comment(struct.comment, '  //') %>
   <% end %>
   <% if struct.opaque? %>
   @FieldOrder({ "_opaque" })
@@ -46,7 +46,7 @@ public interface <%= library&.interface_name || :FFI %> extends Library {
 <% for function in @functions[library] || [] %>
 
   <% if function.comment %>
-  // <%= function.comment %>
+<%= format_comment(function.comment, '  //') %>
   <% end %>
   <%= param_type(function.type) %> <%= function.name %>(<%=
   function.parameters.each_value.map { |p| [param_type(p.type), p.name].join(' ') }.join(', ')

data/etc/templates/lisp.erb

@@ -14,7 +14,7 @@
 <% for enum in @enums[library] || [] %>
 
 <% if enum.comment %>
-;; <%= enum.comment %>
+<%= format_comment(enum.comment, ';;') %>
 <% end %>
 (cffi:defcenum <%= enum.name %>
 <% for name, value in enum.values || {} %>
@@ -25,14 +25,14 @@
 <% for struct in @structs[library] || [] %>
 
 <% if struct.comment %>
-;; <%= struct.comment %>
+<%= format_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(' ') %>)
+  (<%= name %> <%= struct_type(type) %>)
 <% end %>
 )
 <% end %>
@@ -40,10 +40,10 @@
 <% for function in @functions[library] || [] %>
 
 <% if function.comment %>
-;; <%= function.comment %>
+<%= format_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(' ')
+(cffi:defcfun "<%= function.name %>" <%= param_type(function.type) %><%=
+  function.parameters.each_value.map { |p| " (#{p.name} #{param_type(p.type)})" }.join
 %>)
 <% end %>
 <% end %>

data/etc/templates/python.erb

@@ -18,7 +18,7 @@ import ctypes, ctypes.util
 <% for enum in @enums[library] || [] %>
 
 <% if enum.comment %>
-# <%= enum.comment %>
+<%= format_comment(enum.comment, '#') %>
 <% end %>
 <%= enum.name %> = ctypes.c_int
 <% for name, value in enum.values || {} %>
@@ -28,12 +28,12 @@ import ctypes, ctypes.util
 <% for struct in @structs[library] || [] %>
 
 <% if struct.comment %>
-# <%= struct.comment %>
+<%= format_comment(struct.comment, '#') %>
 <% end %>
 <% if struct.opaque? %>
-<%= struct.name %> = ctypes.POINTER(ctypes.c_void)
+<%= struct.name %> = ctypes.POINTER(ctypes.c_void_p)
 <% else %>
-class <%= struct.name %>(Structure):
+class <%= struct.name %>(ctypes.Structure):
   <% if struct.fields.nil? || struct.fields.empty? %>
     _fields_ = []
   <% else %>
@@ -48,7 +48,7 @@ class <%= struct.name %>(Structure):
 <% for function in @functions[library] || [] %>
 
 <% if function.comment %>
-# <%= function.comment %>
+<%= format_comment(function.comment, '#') %>
 <% end %>
 <%= function.name %> = <%= library&.name || :lib %>.<%= function.name %>
 <%= function.name %>.restype = <%= param_type(function.type) %>

data/etc/templates/ruby.erb

@@ -13,7 +13,7 @@ module <%= options[:module] || library&.name&.capitalize || :FFI %>
 <% for enum in @enums[library] || [] %>
 
   <% if enum.comment %>
-  # <%= enum.comment %>
+<%= format_comment(enum.comment, '  #') %>
   <% end %>
   <%= enum.name %> = :int
   <% for name, value in enum.values || {} %>
@@ -23,14 +23,14 @@ module <%= options[:module] || library&.name&.capitalize || :FFI %>
 <% for struct in @structs[library] || [] %>
 
   <% if struct.comment %>
-  # <%= struct.comment %>
+<%= format_comment(struct.comment, '  #') %>
   <% end %>
   <% if struct.opaque? %>
-  <%= struct.name %> = FFI::Pointer
+  <%= struct.name %> = :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 %>
+    <%= i.zero? ? 'layout' : ' '*6 %> :<%= name %>, <%= struct_type(type) %><%= (i == (struct.fields || {}).size-1) ? '' : ',' %>  # <%= type %>
   <% end %>
   end
   <% end %>
@@ -38,11 +38,11 @@ module <%= options[:module] || library&.name&.capitalize || :FFI %>
 <% for function in @functions[library] || [] %>
 
   <% if function.comment %>
-  # <%= function.comment %>
+<%= format_comment(function.comment, '  #') %>
   <% end %>
   attach_function :<%= function.name %>, [<%=
-    function.parameters.each_value.map { |p| param_type(p.type).inspect }.join(', ')
-  %>], :<%= param_type(function.type) %>
+    function.parameters.each_value.map { |param| param_type(param.type) }.join(', ')
+  %>], <%= param_type(function.type) %>
 <% end %>
 end # <%= options[:module] || library&.name&.capitalize || :FFI %>
 <% end %>

data/lib/ffidb/exporter.rb

@@ -88,7 +88,8 @@ module FFIDB
     end
 
     def export_typedef(typedef, disabled: nil)
-      (@typedefs[@library] ||= []) << typedef
+      @typedefs[@library] ||= {}
+      @typedefs[@library][typedef.name] = typedef
     end
 
     def export_enum(enum, disabled: nil)
@@ -96,15 +97,15 @@ module FFIDB
     end
 
     def export_struct(struct, disabled: nil)
-      (@structs[@library] ||= []) << struct
+      (@structs[@library] ||= []) << self.resolve_struct(struct)
     end
 
     def export_union(union, disabled: nil)
-      (@unions[@library] ||= []) << union
+      (@unions[@library] ||= []) << self.resolve_union(union)
     end
 
     def export_function(function, disabled: nil)
-      (@functions[@library] ||= []) << function
+      (@functions[@library] ||= []) << self.resolve_function(function)
     end
 
     def finish_library
@@ -125,13 +126,121 @@ module FFIDB
       @stream.print *args
     end
 
+    ##
+    # @param  [String] comment
+    # @param  [String] prefix
+    # @return [String]
+    def format_comment(comment, prefix)
+      prefix = prefix + ' '
+      comment.each_line.map(&:strip).map { |s| s.prepend(prefix) }.join("\n")
+    end
+
+    ##
+    # @param  [Function] function
+    # @feturn [Function]
+    def resolve_function(function)
+      function.type = self.resolve_type(function.type)
+      function.parameters.transform_values! do |param|
+        param.type = self.resolve_type(param.type)
+        param
+      end
+      function
+    end
+
+    ##
+    # @param  [Struct] struct
+    # @feturn [Struct]
+    def resolve_struct(struct)
+      struct.fields.each do |field_name, field_type|
+        struct.fields[field_name] = self.resolve_type(field_type)
+      end
+      struct
+    end
+
+    ##
+    # @param  [Union] union
+    # @feturn [Union]
+    def resolve_union(union)
+      self.resolve_struct(union)
+    end
+
+    ##
+    # @param  [Type] type
+    # @return [Type, Symbol]
+    def resolve_type(type)
+      case
+        when type.struct_pointer?
+          name = type.spec.gsub(/^const /, '').gsub(/^struct /, '').gsub(/\s*\*+$/, '')
+          name.to_sym
+        when type.struct? || type.union?
+          type
+        when typedef = lookup_typedef(type.name)
+          case typedef.type.tag
+            when :enum then type.name.to_sym
+            when :struct then (type.pointer? ? type.name : "#{type.name}.by_value").to_sym # FIXME
+            else typedef.type
+          end
+        else type
+      end
+    end
+
+    ##
+    # @param  [Type] type
+    # @return [Symbolic]
+    def lookup_symbol(type)
+      self.lookup_typedef(type.name)
+    end
+
+    ##
+    # @param  [Symbol] type_name
+    # @return [Typedef]
+    def lookup_typedef(type_name)
+      @typedefs && @typedefs[@library] && @typedefs[@library][type_name]
+    end
+
+    ##
+    # @param  [Symbol, Type] c_type
+    # @return [#to_s]
+    def struct_type(c_type)
+      return c_type if c_type.is_a?(Symbol) # a resolved typedef
+      self.param_type(c_type)
+    end
+
+    ##
+    # @param  [Symbol, Type] c_type
+    # @return [#to_s]
+    def param_type(c_type)
+      return c_type if c_type.is_a?(Symbol) # a resolved typedef
+      case
+        when type = typemap[c_type.to_s] then type
+        when c_type.enum? then typemap['int']
+        when c_type.pointer? then typemap['void *']
+        when c_type.array? then typemap['void *']
+        else
+          warn "#{$0}: unknown C type #{c_type}, mapping to enum (int)" if debug?
+          typemap['int'] # TODO: typedef or enum
+      end
+    end
+
+    def typemap
+      @typemap ||= self.load_typemap(self.class.const_get(:TYPE_MAP))
+    end
+
+    def load_typemap(typemap_name)
+      ::YAML.load(File.read(self.path_to_typemap(typemap_name))).freeze
+    end
+
+    def path_to_typemap(typemap_name)
+      File.expand_path("../../etc/mappings/#{typemap_name}", __dir__)
+    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))
+      File.read(self.path_to_template(template_name)).freeze
     end
 
     def path_to_template(template_name)

data/lib/ffidb/exporters/dart.rb

@@ -10,25 +10,24 @@ module FFIDB::Exporters
   # @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
+    TYPE_MAP = 'dart.yaml'
 
     # @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>',
+      '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>',
+      'Pointer<Void>' => 'Pointer<Void>',
     }
 
     def finish
@@ -39,22 +38,45 @@ module FFIDB::Exporters
 
     ##
     # @param  [FFIDB::Type] c_type
-    # @return [#to_s]
+    # @return [String]
+    def dart_struct_type(c_type)
+      case
+        when c_type.array? then self.dart_param_type(c_type) # TODO: https://github.com/dart-lang/sdk/issues/35763
+        else self.dart_param_type(c_type)
+      end
+    end
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [String]
+    def ffi_struct_type(c_type)
+      case
+        when c_type.array? then self.ffi_param_type(c_type) # TODO: https://github.com/dart-lang/sdk/issues/35763
+        else self.ffi_param_type(c_type)
+      end
+    end
+
+    ##
+    # @param  [FFIDB::Type] c_type
+    # @return [String]
     def dart_param_type(c_type)
-      TYPE_MAP_DART[self.ffi_param_type(c_type)] || TYPE_MAP_DART[nil]
+      case
+        when c_type.array?
+          "Pointer<#{self.dart_param_type(c_type.array_type)}>"
+        when type = TYPE_MAP_DART[self.ffi_param_type(c_type)] then type
+        else TYPE_MAP_DART[self.typemap['int']].to_s
+      end
     end
-    alias_method :dart_struct_type, :dart_param_type
 
     ##
     # @param  [FFIDB::Type] c_type
-    # @return [#to_s]
+    # @return [String]
     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 *']
+        when c_type.array?
+          "Pointer<#{self.ffi_param_type(c_type.array_type)}>"
+        else self.param_type(c_type)
       end
     end
-    alias_method :ffi_struct_type, :ffi_param_type
   end # Dart
 end # FFIDB::Exporters

data/lib/ffidb/exporters/java.rb

@@ -8,8 +8,7 @@ module FFIDB::Exporters
   #
   # @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
+    TYPE_MAP = 'java.yaml'
 
     def begin_library(library)
       if library
@@ -22,18 +21,5 @@ module FFIDB::Exporters
     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/lisp.rb

@@ -8,9 +8,7 @@ module FFIDB::Exporters
   #
   # @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
+    TYPE_MAP = 'lisp.yaml'
 
     def finish
       puts self.render_template('lisp.erb')
@@ -20,22 +18,19 @@ module FFIDB::Exporters
 
     ##
     # @param  [FFIDB::Type] c_type
-    # @return [#inspect]
+    # @return [String]
     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)]
+        when c_type.array? then [c_type.array_type.to_s.to_sym, :count, c_type.array_size].map(&:inspect).join(' ')
+        else self.param_type(c_type)
       end
     end
 
     ##
     # @param  [FFIDB::Type] c_type
-    # @return [#inspect]
+    # @return [String]
     def param_type(c_type)
-      case
-        when c_type.enum? then :int
-        else TYPE_MAP[c_type.to_s] || TYPE_MAP['void *']
-      end
+      ':' << super(c_type)
     end
   end # Lisp
 end # FFIDB::Exporters

data/lib/ffidb/exporters/python.rb

@@ -8,8 +8,7 @@ module FFIDB::Exporters
   #
   # @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
+    TYPE_MAP = 'python.yaml'
 
     def finish
       puts self.render_template('python.erb')
@@ -18,18 +17,27 @@ module FFIDB::Exporters
     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}"
+    # @param  [Symbol, FFIDB::Type] c_type
+    # @return [String]
+    def struct_type(c_type)
+      case c_type
+        when Symbol then c_type.to_s  # a typedef
+        else case
+          when c_type.array? then [self.param_type(c_type.array_type), '*', c_type.array_size].join(' ')
+          else self.param_type(c_type)
         end
       end
     end
-    alias_method :struct_type, :param_type
+
+    ##
+    # @param  [Symbol, FFIDB::Type] c_type
+    # @return [String]
+    def param_type(c_type)
+      case type = super(c_type)
+        when Symbol then type.to_s  # a typedef
+        when 'None' then type
+        else "ctypes.#{type}"
+      end
+    end
   end # Python
 end # FFIDB::Exporters

data/lib/ffidb/exporters/ruby.rb

@@ -8,9 +8,7 @@ module FFIDB::Exporters
   #
   # @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
+    TYPE_MAP = 'ruby.yaml'
 
     def finish
       puts self.render_template('ruby.erb')
@@ -19,15 +17,26 @@ module FFIDB::Exporters
     protected
 
     ##
-    # @param  [FFIDB::Type] c_type
-    # @return [#inspect]
+    # @param  [Symbol, FFIDB::Type] c_type
+    # @return [String]
+    def struct_type(c_type)
+      case c_type
+        when Symbol then c_type.to_s  # a typedef
+        else case
+          when c_type.array? then [self.param_type(c_type.array_type), c_type.array_size].inspect
+          else self.param_type(c_type)
+        end
+      end
+    end
+
+    ##
+    # @param  [Symbol, FFIDB::Type] c_type
+    # @return [String]
     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 *']
+      case type = super(c_type)
+        when Symbol then type.to_s  # a typedef
+        else ':' << type.to_s
       end
     end
-    alias_method :struct_type, :param_type
   end # Ruby
 end # FFIDB::Exporters

data/lib/ffidb/type.rb

@@ -23,6 +23,23 @@ module FFIDB
     # @return [Integer]
     def <=>(other) self.spec <=> other.spec end
 
+    ##
+    # @return [Symbol]
+    def tag
+      case self.spec.gsub(/^const /, '')
+        when 'enum', /^enum\s+/ then :enum
+        when 'struct', /^struct\s+/ then :struct
+        when 'union', /^union\s+/ then :union
+        else nil
+      end
+    end
+
+    ##
+    # @return [Symbol]
+    def name
+      self.spec.gsub(/\s*\*+$/, '').to_sym # TODO
+    end
+
     ##
     # @return [Boolean]
     def const_qualified?
@@ -50,13 +67,13 @@ module FFIDB
     ##
     # @return [Boolean]
     def enum?
-      !(self.pointer?) && self.spec.start_with?('enum ')
+      !(self.pointer?) && (self.spec == 'enum' || self.spec.start_with?('enum '))
     end
 
     ##
     # @return [Boolean]
     def struct?
-      !(self.pointer?) && (self.spec.start_with?('struct ') || self.spec.start_with?('const struct '))
+      !(self.pointer?) && (self.spec == 'struct' || self.spec.start_with?('struct ') || self.spec.start_with?('const struct '))
     end
 
     ##
@@ -180,19 +197,6 @@ module FFIDB
       self.spec.include?('(*)')
     end
 
-    ##
-    # @return [Integer, Range, nil]
-    def sizeof
-      nil # TODO
-    end
-    alias_method :size, :sizeof
-
-    ##
-    # @return [Integer, Range, nil]
-    def alignof
-      nil # TODO
-    end
-
     ##
     # @return [String]
     def to_s
@@ -210,5 +214,20 @@ module FFIDB
     def inspect
       "#{self.class}(#{self.spec.inspect})"
     end
+
+    protected
+
+    ##
+    # @return [Integer, Range, nil]
+    def sizeof
+      nil # TODO
+    end
+    alias_method :size, :sizeof
+
+    ##
+    # @return [Integer, Range, nil]
+    def alignof
+      nil # TODO
+    end
   end # Type
 end # FFIDB

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffidb
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Arto Bendiken
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: dogma.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -175,7 +189,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/github/ffidb/ffidb.rb/master
   homepage_uri: https://github.com/ffidb
   source_code_uri: https://github.com/ffidb/ffidb.rb
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 3.1.2
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Command-line interface (CLI) for the FFI DB registry.
 test_files: []