ffidb 0.12.0

data/etc/mappings/dart.yaml

@@ -0,0 +1,35 @@
+# See: https://api.dart.dev/dev/dart-ffi/dart-ffi-library.html
+---
+_Bool: Int8                  # TODO
+char *: Pointer<Int8>        # TODO: Utf8
+char: Int8
+const char *: Pointer<Int8>  # TODO: Utf8
+double: Double
+float: Float
+int16_t: Int16
+int32_t: Int32
+int64_t: Int64
+int8_t: Int8
+int: Int32                   # TODO: https://github.com/dart-lang/sdk/issues/36140
+intptr_t: IntPtr
+long double:                 # not supported
+long long: Int64
+long: Int64                  # TODO: https://github.com/dart-lang/sdk/issues/36140
+off_t: Uint64                # TODO: https://github.com/dart-lang/sdk/issues/36140
+short: Int16
+size_t: Uint64               # TODO: https://github.com/dart-lang/sdk/issues/36140
+ssize_t: Int64               # TODO: https://github.com/dart-lang/sdk/issues/36140
+uint16_t: Uint16
+uint32_t: Uint32
+uint64_t: Uint64
+uint8_t: Uint8
+uintptr_t: IntPtr
+unsigned char: Uint8
+unsigned int: Uint32         # TODO: https://github.com/dart-lang/sdk/issues/36140
+unsigned long long: Uint64
+unsigned long: Uint64        # TODO: https://github.com/dart-lang/sdk/issues/36140
+unsigned short: Uint16
+va_list: Pointer<Void>
+void *: Pointer<Void>
+void: Void
+wchar_t: Int32               # TODO: https://github.com/dart-lang/sdk/issues/36140

data/etc/mappings/java.yaml

@@ -0,0 +1,36 @@
+# See: https://github.com/java-native-access/jna/blob/master/www/Mappings.md
+# See: https://java-native-access.github.io/jna/5.5.0/javadoc/overview-summary.html#marshalling
+---
+_Bool: boolean
+char *: String
+char: byte
+const char *: String
+double: double
+float: float
+int16_t: short
+int32_t: int
+int64_t: long
+int8_t: byte
+int: int
+intptr_t: Pointer
+long double:              # https://github.com/java-native-access/jna/issues/860
+long long: long
+long: NativeLong
+off_t: size_t             # TODO
+short: short
+size_t: size_t            # https://github.com/java-native-access/jna/issues/1113
+ssize_t: ssize_t
+uint16_t: short
+uint32_t: int
+uint64_t: long
+uint8_t: byte
+uintptr_t: Pointer
+unsigned char: byte
+unsigned int: int
+unsigned long long: long
+unsigned long: NativeLong
+unsigned short: short
+va_list: Pointer
+void *: Pointer
+void: void
+wchar_t: char

data/etc/mappings/lisp.yaml

@@ -0,0 +1,35 @@
+# See: https://common-lisp.net/project/cffi/manual/html_node/Foreign-Types.html
+---
+_Bool: bool
+char *: string
+char: char
+const char *: string
+double: double
+float: float
+int16_t: int16
+int32_t: int32
+int64_t: int64
+int8_t: int8
+int: int
+intptr_t: pointer
+long double: long-double
+long long: llong
+long: long
+off_t: ulong  # TODO
+short: short
+size_t: size-t
+ssize_t: long  # TODO
+uint16_t: uint16
+uint32_t: uint32
+uint64_t: uint64
+uint8_t: uint8
+uintptr_t: pointer
+unsigned char: uchar
+unsigned int: uint
+unsigned long long: ullong
+unsigned long: ulong
+unsigned short: ushort
+va_list: pointer
+void *: pointer
+void: void
+wchar_t: int  # TODO: https://stackoverflow.com/a/13510080

data/etc/mappings/python.yaml

@@ -0,0 +1,35 @@
+# See: https://docs.python.org/3/library/ctypes.html
+---
+_Bool: c_bool
+char *: c_char_p
+char: c_char
+const char *: c_char_p
+double: c_double
+float: c_float
+int16_t: c_int16
+int32_t: c_int32
+int64_t: c_int64
+int8_t: c_int8
+int: c_int
+intptr_t: c_void_p
+long double: c_longdouble
+long long: c_longlong
+long: c_long
+off_t: c_size_t  # TODO: https://stackoverflow.com/q/43671524
+short: c_short
+size_t: c_size_t
+ssize_t: c_ssize_t
+uint16_t: c_uint16
+uint32_t: c_uint32
+uint64_t: c_uint64
+uint8_t: c_uint8
+uintptr_t: c_void_p
+unsigned char: c_ubyte
+unsigned int: c_uint
+unsigned long long: c_ulonglong
+unsigned long: c_ulong
+unsigned short: c_ushort
+va_list: c_void_p
+void *: c_void_p
+void: None
+wchar_t: c_wchar_t

data/etc/mappings/ruby.yaml

@@ -0,0 +1,35 @@
+# See: https://github.com/ffi/ffi/wiki/Types
+---
+_Bool: bool
+char *: string
+char: char
+const char *: string
+double: double
+float: float
+int16_t: int16
+int32_t: int32
+int64_t: int64
+int8_t: int8
+int: int
+intptr_t: pointer
+long double: long_double
+long long: long_long
+long: long
+off_t: off_t
+short: short
+size_t: size_t
+ssize_t: ssize_t
+uint16_t: uint16
+uint32_t: uint32
+uint64_t: uint64
+uint8_t: uint8
+uintptr_t: pointer
+unsigned char: uchar
+unsigned int: uint
+unsigned long long: ulong_long
+unsigned long: ulong
+unsigned short: ushort
+va_list: pointer
+void *: pointer
+void: void
+wchar_t: wchar_t

data/etc/templates/c.erb

@@ -0,0 +1,46 @@
+<% if header? %>
+// <%= FFIDB.header %>
+
+<% end %>
+#include <stdarg.h>    // for va_list
+#include <stdbool.h>   // for _Bool
+#include <stddef.h>    // for size_t, wchar_t
+#include <stdint.h>    // for {,u}int*_t
+#include <sys/types.h> // for off_t, ssize_t
+<% for library in @libraries %>
+<% if library %>
+
+// <%= library.name %> API
+<% end %>
+<% for enum in @enums[library] || [] %>
+
+<% if enum.comment %>
+// <%= enum.comment %>
+<% end %>
+enum <%= enum.name %> {
+<% for name, value in enum.values || {} %>
+  <%= name %> = <%= value %>,
+<% end %>
+};
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+<% if struct.comment %>
+// <%= struct.comment %>
+<% end %>
+struct <%= struct.name %> {
+<% for name, type in struct.fields || {} %>
+  <%= type %> <%= name %>;
+<% end %>
+};
+<% end %>
+<% for function in @functions[library] || [] %>
+
+<% if function.comment %>
+// <%= function.comment %>
+<% end %>
+extern <%= function.type %> <%= function.name %>(<%=
+  function.parameters.each_value.map { |p| "#{p.type} #{p.name}" }.join(', ')
+%>);
+<% end %>
+<% end %>

data/etc/templates/cpp.erb

@@ -0,0 +1,45 @@
+<% if header? %>
+// <%= FFIDB.header %>
+
+<% end %>
+#include <cstdarg>     // for va_list
+#include <cstdbool>    // for bool
+#include <cstddef>     // for size_t
+#include <cstdint>     // for {,u}int*_t
+#include <sys/types.h> // for off_t, ssize_t
+<% for library in @libraries %>
+
+namespace <%= self.options[:module] || library&.name || :lib %> {
+<% for enum in @enums[library] || [] %>
+
+  <% if enum.comment %>
+  // <%= enum.comment %>
+  <% end %>
+  enum <%= enum.name %> {
+  <% for name, value in enum.values || {} %>
+    <%= name %> = <%= value %>,
+  <% end %>
+  };
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+  <% if struct.comment %>
+  // <%= struct.comment %>
+  <% end %>
+  struct <%= struct.name %> {
+  <% for name, type in struct.fields || {} %>
+    <%= type %> <%= name %>;
+  <% end %>
+  };
+<% end %>
+<% for function in @functions[library] || [] %>
+
+  <% if function.comment %>
+  // <%= function.comment %>
+  <% end %>
+  extern "C" <%= function.type %> <%= function.name %>(<%=
+    function.parameters.each_value.map { |p| "#{p.type} #{p.name}" }.join(', ')
+  %>);
+<% end %>
+} // <%= self.options[:module] || library&.name || :lib %>
+<% end %>

data/etc/templates/dart.erb

@@ -0,0 +1,64 @@
+<% if header? %>
+// <%= FFIDB.header %>
+
+<% end %>
+<% if options[:module] %>
+library <%= options[:module] %>;
+
+<% end %>
+import 'dart:ffi';
+import 'dart:io' as io;
+<% for library in @libraries %>
+<% if library && @functions[library] %>
+
+final <%= library&.name || :lib %> = DynamicLibrary.open('<%= dlopen_paths_for(library).first %>');
+<% end %>
+<% for enum in @enums[library] || [] %>
+
+<% if enum.comment %>
+/// <%= enum.comment %>
+<% end %>
+abstract class <%= enum.name %> {
+  <%= enum.name %>._();
+
+  <% for name, value in enum.values || {} %>
+  static const <%= name %> = <%= value %>;
+  <% end %>
+}
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+<% if struct.comment %>
+/// <%= struct.comment %>
+<% end %>
+<% if struct.opaque? %>
+class <%= struct.name %> extends Struct {
+    Int8 _opaque;
+<% else %>
+class <%= struct.name %> extends Struct {
+  <% for (name, type), i in (struct.fields || {}).each_with_index %>
+<%= i.zero? ? '' : "\n" -%>
+    <% unless type.pointer? %>
+    @<%= ffi_struct_type(type) %>() // <%= type %>
+    <% else %>
+    // <%= type %>
+    <% end %>
+    <%= dart_struct_type(type) %> <%= name %>;
+  <% end %>
+<% end %>
+}
+<% end %>
+<% for function in @functions[library] || [] %>
+
+<% if function.comment %>
+/// <%= function.comment %>
+<% end %>
+final <%= dart_param_type(function.type) %> Function(<%=
+      function.parameters.each_value.map { |p| dart_param_type(p.type) }.join(', ')
+    %>) <%= function.name %> = <%= library&.name || :lib %>
+    .lookup<NativeFunction<<%= ffi_param_type(function.type) %> Function(<%=
+      function.parameters.each_value.map { |p| ffi_param_type(p.type) }.join(', ')
+    %>)>>('<%= function.name %>')
+    .asFunction();
+<% end %>
+<% end %>

data/etc/templates/go.erb

@@ -0,0 +1,50 @@
+<% if header? %>
+// <%= FFIDB.header %>
+
+<% end %>
+/*
+#include <stdarg.h>    // for va_list
+#include <stdbool.h>   // for _Bool
+#include <stddef.h>    // for size_t, wchar_t
+#include <stdint.h>    // for {,u}int*_t
+#include <sys/types.h> // for off_t, ssize_t
+<% for library in @libraries %>
+<% if library %>
+
+// <%= library.name %> API
+#cgo LDFLAGS: -l<%= library.dlopen.first %>
+<% end %>
+<% for enum in @enums[library] || [] %>
+
+<% if enum.comment %>
+// <%= enum.comment %>
+<% end %>
+enum <%= enum.name %> {
+<% for name, value in enum.values || {} %>
+  <%= name %> = <%= value %>,
+<% end %>
+};
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+<% if struct.comment %>
+// <%= struct.comment %>
+<% end %>
+struct <%= struct.name %> {
+<% for name, type in struct.fields || {} %>
+  <%= type %> <%= name %>;
+<% end %>
+};
+<% end %>
+<% for function in @functions[library] || [] %>
+
+<% if function.comment %>
+// <%= function.comment %>
+<% end %>
+extern <%= function.type %> <%= function.name %>(<%=
+  function.parameters.each_value.map { |p| "#{p.type} #{p.name}" }.join(', ')
+%>);
+<% end %>
+<% end %>
+*/
+import "C"

data/etc/templates/java.erb

@@ -0,0 +1,56 @@
+<% if header? %>
+// <%= FFIDB.header %>
+
+<% end %>
+import com.sun.jna.Library;
+import com.sun.jna.Native;
+import com.sun.jna.NativeLong;
+import com.sun.jna.Pointer;
+import com.sun.jna.Structure.FFIType.size_t;
+import com.sun.jna.platform.linux.XAttr.ssize_t;
+<% for library in @libraries %>
+
+public interface <%= library&.interface_name || :FFI %> extends Library {
+<% if library && @functions[library] %>
+  <%= library&.interface_name || :FFI %> INSTANCE = (<%= library&.interface_name || :FFI %>)Native.load("<%= dlopen_paths_for(library).first %>", <%= library&.interface_name || :FFI %>.class);
+<% end %>
+<% for enum in @enums[library] || [] %>
+
+<% if enum.comment %>
+  // <%= enum.comment %>
+<% end %>
+  public static class <%= enum.name %> {
+  <% for name, value in enum.values || {} %>
+    public static final int <%= name %> = <%= value %>;
+  <% end %>
+  }
+<% end %>
+<% for struct in @structs[library] || [] %>
+
+  <% if struct.comment %>
+  // <%= struct.comment %>
+  <% end %>
+  <% if struct.opaque? %>
+  @FieldOrder({ "_opaque" })
+  public static class <%= struct.name %> extends Structure {
+    public byte _opaque;
+  <% else %>
+  @FieldOrder({ <%= (struct.fields || {}).keys.map(&:to_s).map(&:inspect).join(', ') %> })
+  public static class <%= struct.name %> extends Structure {
+  <% for name, type in struct.fields || {} %>
+    public <%= struct_type(type) %> <%= name %>; // <%= type %>
+  <% end %>
+  <% end %>
+  }
+<% end %>
+<% for function in @functions[library] || [] %>
+
+  <% if function.comment %>
+  // <%= function.comment %>
+  <% end %>
+  <%= param_type(function.type) %> <%= function.name %>(<%=
+  function.parameters.each_value.map { |p| [param_type(p.type), p.name].join(' ') }.join(', ')
+%>);
+<% end %>
+} // <%= library&.interface_name || :FFI %>
+<% end %>