ghazel-ffi_gen 1.3.0

data/lib/ffi_gen/java_enum.java

@@ -0,0 +1,3 @@
+interface NativeEnum {
+    public int toNativeInt();
+}

data/lib/ffi_gen/java_output.rb

@@ -0,0 +1,324 @@
+class FFIGen
+  def generate_java
+    writer = Writer.new "    ", " * ", "/**", " */"
+    writer.puts "// Generated by ffi_gen. Please do not change this file by hand.", "import java.util.*;", "import com.sun.jna.*;", "import java.lang.annotation.*;", "import java.lang.reflect.Method;", "", "public class #{@module_name} {"
+    writer.indent do
+      writer.puts "private static #{@module_name}Interface INSTANCE = #{@module_name}Interface.JnaInstanceCreator.createInstance();"
+      writer.puts "", *IO.readlines(File.join(File.dirname(__FILE__), "java_enum.java")).map(&:rstrip), ""
+
+      declarations.each do |declaration|
+        if declaration.respond_to? :write_static_java
+          declaration.write_static_java writer
+        else
+          declaration.write_java writer
+        end
+      end
+      writer.puts ""
+
+      writer.puts "private interface #{@module_name}Interface extends Library {"
+      writer.indent do
+        writer.puts "", *IO.readlines(File.join(File.dirname(__FILE__), "java_pre.java")).map(&:rstrip), ""
+        writer.puts "static class JnaInstanceCreator {"
+        writer.indent do
+          writer.puts "private static #{@module_name}Interface createInstance() {"
+          writer.indent do
+            writer.puts "DefaultTypeMapper typeMapper = new DefaultTypeMapper();", "typeMapper.addFromNativeConverter(NativeEnum.class, new EnumConverter());", "typeMapper.addToNativeConverter(NativeEnum.class, new EnumConverter());", ""
+            writer.puts "Map<String, Object> options = new HashMap<String, Object>();", "options.put(Library.OPTION_FUNCTION_MAPPER, new NativeNameAnnotationFunctionMapper());", "options.put(Library.OPTION_TYPE_MAPPER, typeMapper);", ""
+            writer.puts "return (#{@module_name}Interface) Native.loadLibrary(\"#{@ffi_lib}\", #{@module_name}Interface.class, options);"
+          end
+          writer.puts "}"
+        end
+        writer.puts "}", ""
+        declarations.each do |declaration|
+          if declaration.is_a? FunctionOrCallback
+            declaration.write_java writer
+          end
+        end
+      end
+      writer.puts "}"
+    end
+    writer.puts "}"
+    writer.output
+  end
+  
+  class Name
+    JAVA_KEYWORDS = %w{abstract assert boolean break byte case catch char class const continue default do double else enum extends final finally float for goto if implements import instanceof int interface long native new package private protected public return short static strictfp super switch synchronized this throw throws transient try void volatile while}
+    
+    def to_java_downcase
+      format :camelcase, :initial_downcase, JAVA_KEYWORDS
+    end
+    
+    def to_java_classname
+      format :camelcase, JAVA_KEYWORDS
+    end
+    
+    def to_java_constant
+      format :upcase, :underscores, JAVA_KEYWORDS
+    end
+  end
+  
+  class Type
+    def java_description
+      java_name
+    end
+  end
+  
+  class Enum
+    def write_java(writer)
+      return if @name.nil?
+      shorten_names
+      
+      writer.comment do
+        writer.write_description @description
+        writer.puts "", "<em>This entry is only for documentation and no real method. The FFI::Enum can be accessed via #enum_type(:#{java_name}).</em>"
+        writer.puts "", "=== Options:"
+        @constants.each do |constant|
+          writer.puts "#{constant[:name].to_java_constant} ::"
+          writer.write_description constant[:comment], false, "  ", "  "
+        end
+        writer.puts "", "@method _enum_#{java_name}_", "@return [Symbol]", "@scope class"
+      end
+      
+      writer.puts "public enum #{java_name} implements NativeEnum {"
+      writer.indent do
+        writer.write_array @constants, "," do |constant|
+          "#{constant[:name].to_java_constant}(#{constant[:value]})"
+        end
+        writer.puts ";"
+        
+        writer.puts "", "private int nativeInt;", "", "private #{java_name}(int nativeInt) {", "    this.nativeInt = nativeInt;", "}", "", "@Override", "public int toNativeInt() {", "    return nativeInt;", "}"
+      end
+      writer.puts "}", ""
+    end
+    
+    def java_name
+      @java_name ||= @name.to_java_classname
+    end
+    
+    def java_jna_type
+      java_name
+    end
+    
+    def java_description
+      "Symbol from _enum_#{java_name}_"
+    end
+  end
+  
+  class StructOrUnion
+    def write_java(writer)
+      writer.comment do
+        writer.write_description @description
+        unless @fields.empty?
+          writer.puts "", "= Fields:"
+          @fields.each do |field|
+            writer.puts ":#{field[:name].to_java_downcase} ::"
+            writer.write_description field[:comment], false, "  (#{field[:type].java_description}) ", "  "
+          end
+        end
+      end
+      
+      writer.puts "public static class #{java_name} extends #{@is_union ? 'Union' : (@fields.empty? ? 'PointerType' : 'Structure')} {"
+      writer.indent do
+        @fields.each do |field|
+          writer.puts "public #{field[:type].java_jna_type} #{field[:name].raw};"
+        end
+        writer.puts "// hidden structure" if @fields.empty?
+      end
+      writer.indent do
+        writer.puts "protected List<String> getFieldOrder() {"
+        writer.indent do
+          fs = @fields.map{|f| '"' + f[:name].raw + '"'}.join(", ")
+          writer.puts "return Arrays.asList(new String[] { #{fs} } );"
+        end
+        writer.puts "}"
+      end
+      writer.puts "}", ""
+      
+      @written = true
+    end
+    
+    def java_name
+      @java_name ||= @name.to_java_classname
+    end
+    
+    def java_jna_type
+      @written ? java_name : "Pointer"
+    end
+    
+    def java_description
+      @written ? java_name : "FFI::Pointer(*#{java_name})"
+    end
+  end
+  
+  class FunctionOrCallback
+    def write_java(writer)
+      return if @is_callback # not yet supported
+      
+      jna_signature = "#{@parameters.map{ |parameter| "#{parameter[:type].java_jna_type} #{parameter[:name].to_java_downcase}" }.join(', ')}"
+      if @is_callback
+        writer.puts "callback :#{java_name}, #{jna_signature}", ""
+      else
+        writer.puts "@NativeName(\"#{@name.raw}\")", "#{@return_type.java_jna_type} #{java_name}(#{jna_signature});", ""
+      end
+    end
+    
+    def write_static_java(writer)
+      return if @is_callback # not yet supported
+      
+      writer.comment do
+        writer.write_description @function_description
+        writer.puts "", "<em>This entry is only for documentation and no real method.</em>" if @is_callback
+        writer.puts "", "@method #{@is_callback ? "_callback_#{java_name}_" : java_name}(#{@parameters.map{ |parameter| parameter[:name].to_java_downcase }.join(', ')})"
+        @parameters.each do |parameter|
+          writer.write_description parameter[:description], false, "@param [#{parameter[:type].java_description}] #{parameter[:name].to_java_downcase} ", "  "
+        end
+        writer.write_description @return_value_description, false, "@return [#{@return_type.java_description}] ", "  "
+        writer.puts "@scope class"
+      end
+      
+      args = @parameters.map{ |parameter| parameter[:name].to_java_downcase }.join(', ')
+      jna_signature = "#{@parameters.map{ |parameter| "#{parameter[:type].java_jna_type} #{parameter[:name].to_java_downcase}" }.join(', ')}"
+      writer.puts "static #{@return_type.java_jna_type} #{java_name}(#{jna_signature}) {"
+      writer.indent do
+        call = "INSTANCE.#{java_name}(#{args});"
+        if @return_type.respond_to? :no_return and @return_type.no_return
+          writer.puts call
+        elsif @return_type.is_a? StructOrUnion
+          writer.puts "return (#{@return_type.java_jna_type})#{call}"
+        else
+          writer.puts "return #{call}"
+        end
+      end
+      writer.puts "}", ""
+    end
+    
+    def java_name
+      @java_name ||= @name.to_java_downcase
+    end
+    
+    def java_jna_type
+      java_name
+    end
+    
+    def java_description
+      "Proc(_callback_#{java_name}_)"
+    end
+  end
+  
+  class Define
+    def write_java(writer)
+      parts = @value.map { |v|
+        if v.is_a? Array
+          case v[0]
+          when :method then v[1].to_java_downcase
+          when :constant then v[1].to_java_constant
+          else raise ArgumentError
+          end
+        else
+          v
+        end
+      }
+      if @parameters
+        # not implemented
+      else
+        writer.puts "public static int #{@name.to_java_constant} = #{parts.join};", ""
+      end
+    end
+  end
+  
+  class PrimitiveType
+    def java_name
+      case @clang_type
+      when :void
+        "nil"
+      when :bool
+        "Boolean"
+      when :u_char, :u_short, :u_int, :u_long, :u_long_long, :char_s, :s_char, :short, :int, :long, :long_long
+        "Integer"
+      when :float, :double
+        "Float"
+      end
+    end
+    
+    def java_jna_type
+      case @clang_type
+      when :void            then "void"
+      when :bool            then "boolean"
+      when :u_char          then "byte"
+      when :u_short         then "short"
+      when :u_int           then "int"
+      when :u_long          then "NativeLong"
+      when :u_long_long     then "long"
+      when :char_s, :s_char then "byte"
+      when :short           then "short"
+      when :int             then "int"
+      when :long            then "NativeLong"
+      when :long_long       then "long"
+      when :float           then "float"
+      when :double          then "double"
+      end
+    end
+  end
+  
+  class StringType
+    def java_name
+      "String"
+    end
+    
+    def java_jna_type
+      "String"
+    end
+  end
+  
+  class ByValueType
+    def java_name
+      @inner_type.java_name
+    end
+    
+    def java_jna_type
+      @inner_type.java_jna_type
+    end
+  end
+  
+  class PointerType
+    def java_name
+      @pointee_name.to_java_downcase
+    end
+    
+    def java_jna_type
+      "Pointer"
+    end
+    
+    def java_description
+      "FFI::Pointer(#{'*' * @depth}#{@pointee_name ? @pointee_name.to_java_classname : ''})"
+    end
+  end
+  
+  class ArrayType
+    def java_name
+      "array"
+    end
+    
+    def java_jna_type
+      if @constant_size
+        raise
+      else
+        "#{@element_type.java_jna_type}[]"
+      end
+    end
+    
+    def java_description
+      "Array of #{@element_type.java_description}"
+    end
+  end
+    
+  class UnknownType
+    def java_name
+      "unknown"
+    end
+
+    def java_jna_type
+      "byte"
+    end
+  end
+end

data/lib/ffi_gen/java_pre.java

@@ -0,0 +1,35 @@
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.METHOD)
+@interface NativeName {
+    String value();
+}
+
+class NativeNameAnnotationFunctionMapper implements FunctionMapper {
+    @Override
+    public String getFunctionName(NativeLibrary library, Method method) {
+        return method.getAnnotation(NativeName.class).value();
+    }
+}
+
+class EnumConverter implements TypeConverter {
+    public Class<?> nativeType() {
+        return Integer.class;
+    }
+
+    public Object fromNative(Object input, FromNativeContext context) {
+        int intValue = (Integer) input;
+
+        Class<?> targetClass = context.getTargetType();
+        for (Object constant : targetClass.getEnumConstants()) {
+            if (((NativeEnum) constant).toNativeInt() == intValue) {
+                return constant;
+            }
+        }
+
+        throw new IllegalArgumentException("No constant with integer value " + intValue + " in enum " + targetClass.getName() + ".");
+    }
+
+    public Object toNative(Object input, ToNativeContext context) {
+        return ((NativeEnum) input).toNativeInt();
+    }
+}

data/lib/ffi_gen/ruby_output.rb

@@ -0,0 +1,302 @@
+class FFIGen
+  def generate_rb
+    writer = Writer.new "  ", "# "
+    writer.puts "# Generated by ffi_gen. Please do not change this file by hand.", "", "require 'ffi'", "", "module #{@module_name}"
+    writer.indent do
+      writer.puts "extend FFI::Library"
+      writer.puts "ffi_lib_flags #{@ffi_lib_flags.map(&:inspect).join(', ')}" if @ffi_lib_flags
+      writer.puts "ffi_lib #{@ffi_lib.inspect}", "" if @ffi_lib
+      writer.puts "def self.attach_function(name, *_)", "  begin; super; rescue FFI::NotFoundError => e", "    (class << self; self; end).class_eval { define_method(name) { |*_| raise e } }", "  end", "end", ""
+      declarations.each do |declaration|
+        declaration.write_ruby writer
+      end
+    end
+    writer.puts "end"
+    writer.output
+  end
+
+  class Name
+    RUBY_KEYWORDS = %w{alias and begin break case class def defined do else elsif end ensure false for if in module next nil not or redo rescue retry return self super then true undef unless until when while yield BEGIN END}
+
+    def to_ruby_downcase
+      format :downcase, :underscores, RUBY_KEYWORDS
+    end
+
+    def to_ruby_classname
+      format :camelcase, RUBY_KEYWORDS
+    end
+
+    def to_ruby_constant
+      format :upcase, :underscores, RUBY_KEYWORDS
+    end
+  end
+
+  class Type
+    def ruby_description
+      ruby_name
+    end
+  end
+
+  class Enum
+    def write_ruby(writer)
+      return if @name.nil?
+      shorten_names
+
+      @constants.each do |constant|
+        constant[:symbol] = ":#{constant[:name].to_ruby_downcase}"
+      end
+
+      writer.comment do
+        writer.write_description @description
+        writer.puts "", "<em>This entry is only for documentation and no real method. The FFI::Enum can be accessed via #enum_type(:#{ruby_name}).</em>"
+        writer.puts "", "=== Options:"
+        @constants.each do |constant|
+          writer.puts "#{constant[:symbol]} ::"
+          writer.write_description constant[:comment], false, "  ", "  "
+        end
+        writer.puts "", "@method _enum_#{ruby_name}_", "@return [Symbol]", "@scope class"
+      end
+
+      writer.puts "enum :#{ruby_name}, ["
+      writer.indent do
+        writer.write_array @constants, "," do |constant|
+          "#{constant[:symbol]}, #{constant[:value]}"
+        end
+      end
+      writer.puts "]", ""
+    end
+
+    def ruby_name
+      @ruby_name ||= @name.to_ruby_downcase
+    end
+
+    def ruby_ffi_type
+      ":#{ruby_name}"
+    end
+
+    def ruby_description
+      "Symbol from _enum_#{ruby_name}_"
+    end
+  end
+
+  class StructOrUnion
+    def write_ruby(writer)
+      writer.comment do
+        writer.write_description @description
+        unless @fields.empty?
+          writer.puts "", "= Fields:"
+          @fields.each do |field|
+            writer.puts ":#{field[:name].to_ruby_downcase} ::"
+            writer.write_description field[:comment], false, "  (#{field[:type].ruby_description}) ", "  "
+          end
+        end
+      end
+
+      @fields << { name: Name.new(["dummy"]), type: PrimitiveType.new(:char_s) } if @fields.empty?
+
+      unless @oo_functions.empty?
+        writer.puts "module #{ruby_name}Wrappers"
+        writer.indent do
+          @oo_functions.each_with_index do |(name, function), index|
+            parameter_names = function.parameters[1..-1].map { |parameter| parameter[:name].to_ruby_downcase }
+            writer.puts "" unless index == 0
+            writer.comment do
+              function.parameters[1..-1].each do |parameter|
+                writer.write_description parameter[:description], false, "@param [#{parameter[:type].ruby_description}] #{parameter[:name].to_ruby_downcase} ", "  "
+              end
+              return_type = function.return_type.is_a?(StructOrUnion) ? function.return_type.ruby_name : function.return_type.ruby_description
+              writer.write_description function.return_value_description, false, "@return [#{return_type}] ", "  "
+            end
+            writer.puts "def #{name.to_ruby_downcase}(#{parameter_names.join(', ')})"
+            writer.indent do
+              cast = function.return_type.is_a?(StructOrUnion) ? "#{function.return_type.ruby_name}.new " : ""
+              writer.puts "#{cast}#{@generator.module_name}.#{function.ruby_name}(#{(["self"] + parameter_names).join(', ')})"
+            end
+            writer.puts "end"
+          end
+        end
+        writer.puts "end", ""
+      end
+
+      writer.puts "class #{ruby_name} < #{@is_union ? 'FFI::Union' : 'FFI::Struct'}"
+      writer.indent do
+        writer.puts "include #{ruby_name}Wrappers" unless @oo_functions.empty?
+        writer.write_array @fields, ",", "layout ", "       " do |field|
+          ":#{field[:name].to_ruby_downcase}, #{field[:type].ruby_ffi_type}"
+        end
+      end
+      writer.puts "end", ""
+
+      @written = true
+    end
+
+    def ruby_name
+      @ruby_name ||= @name.to_ruby_classname
+    end
+
+    def ruby_ffi_type
+      @written ? ruby_name : ":pointer"
+    end
+
+    def ruby_description
+      @written ? ruby_name : "FFI::Pointer(*#{ruby_name})"
+    end
+  end
+
+  class FunctionOrCallback
+    def write_ruby(writer)
+      writer.puts "@blocking = true" if @blocking
+      writer.comment do
+        writer.write_description @function_description
+        writer.puts "", "<em>This entry is only for documentation and no real method.</em>" if @is_callback
+        writer.puts "", "@method #{@is_callback ? "_callback_#{ruby_name}_" : ruby_name}(#{@parameters.map{ |parameter| parameter[:name].to_ruby_downcase }.join(', ')})"
+        @parameters.each do |parameter|
+          writer.write_description parameter[:description], false, "@param [#{parameter[:type].ruby_description}] #{parameter[:name].to_ruby_downcase} ", "  "
+        end
+        writer.write_description @return_value_description, false, "@return [#{@return_type.ruby_description}] ", "  "
+        writer.puts "@scope class"
+      end
+
+      ffi_signature = "[#{@parameters.map{ |parameter| parameter[:type].ruby_ffi_type }.join(', ')}], #{@return_type.ruby_ffi_type}"
+      if @is_callback
+        writer.puts "callback :#{ruby_name}, #{ffi_signature}", ""
+      else
+        writer.puts "attach_function :#{ruby_name}, :#{@name.raw}, #{ffi_signature}", ""
+      end
+    end
+
+    def ruby_name
+      @ruby_name ||= @name.to_ruby_downcase
+    end
+
+    def ruby_ffi_type
+      ":#{ruby_name}"
+    end
+
+    def ruby_description
+      "Proc(_callback_#{ruby_name}_)"
+    end
+  end
+
+  class Define
+    def write_ruby(writer)
+      parts = @value.map { |v|
+        if v.is_a? Array
+          case v[0]
+          when :method then v[1].to_ruby_downcase
+          when :constant then v[1].to_ruby_constant
+          else raise ArgumentError
+          end
+        else
+          v
+        end
+      }
+      if @parameters
+        writer.puts "def #{@name.to_ruby_downcase}(#{@parameters.join(", ")})"
+        writer.indent do
+          writer.puts parts.join
+        end
+        writer.puts "end", ""
+      else
+        writer.puts "#{@name.to_ruby_constant} = #{parts.join}", ""
+      end
+    end
+  end
+
+  class PrimitiveType
+    def ruby_name
+      case @clang_type
+      when :void
+        "nil"
+      when :bool
+        "Boolean"
+      when :u_char, :u_short, :u_int, :u_long, :u_long_long, :char_s, :s_char, :short, :int, :long, :long_long
+        "Integer"
+      when :float, :double
+        "Float"
+      end
+    end
+
+    def ruby_ffi_type
+      case @clang_type
+      when :void            then ":void"
+      when :bool            then ":bool"
+      when :u_char          then ":uchar"
+      when :u_short         then ":ushort"
+      when :u_int           then ":uint"
+      when :u_long          then ":ulong"
+      when :u_long_long     then ":ulong_long"
+      when :char_s, :s_char then ":char"
+      when :short           then ":short"
+      when :int             then ":int"
+      when :long            then ":long"
+      when :long_long       then ":long_long"
+      when :float           then ":float"
+      when :double          then ":double"
+      end
+    end
+  end
+
+  class StringType
+    def ruby_name
+      "String"
+    end
+
+    def ruby_ffi_type
+      ":string"
+    end
+  end
+
+  class ByValueType
+    def ruby_name
+      @inner_type.ruby_name
+    end
+
+    def ruby_ffi_type
+      "#{@inner_type.ruby_ffi_type}.by_value"
+    end
+  end
+
+  class PointerType
+    def ruby_name
+      @pointee_name.to_ruby_downcase
+    end
+
+    def ruby_ffi_type
+      ":pointer"
+    end
+
+    def ruby_description
+      "FFI::Pointer(#{'*' * @depth}#{@pointee_name ? @pointee_name.to_ruby_classname : ''})"
+    end
+  end
+
+  class ArrayType
+    def ruby_name
+      "array"
+    end
+
+    def ruby_ffi_type
+      if @constant_size
+        "[#{@element_type.ruby_ffi_type}, #{@constant_size}]"
+      else
+        ":pointer"
+      end
+    end
+
+    def ruby_description
+      "Array<#{@element_type.ruby_description}>"
+    end
+  end
+
+  class UnknownType
+    def ruby_name
+      "unknown"
+    end
+
+    def ruby_ffi_type
+      ":char"
+    end
+  end
+
+end