Merge pull request #139 from sue445/feature/replace_all_bindings

Replace all bindings with auto-generated code

Author: sue445

.rubocop_todo.yml

@@ -1,43 +1,57 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-09-25 08:16:07 UTC using RuboCop version 1.66.1.
+# on 2024-09-30 08:46:06 UTC using RuboCop version 1.66.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 6
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - '_tools/ruby_h_to_go/spec/ruby_h_to_go/function_definition_spec.rb'
+    - '_tools/ruby_h_to_go/spec/ruby_header_parser/util_spec.rb'
+
+# Offense count: 8
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 68
+  Max: 79
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 41
-
-# Offense count: 1
-# Configuration parameters: CountBlocks, CountModifierForms.
-Metrics/BlockNesting:
-  Max: 4
+  Max: 48
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 131
 
-# Offense count: 5
+# Offense count: 7
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 17
+  Max: 15
 
-# Offense count: 12
+# Offense count: 15
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 67
+  Max: 75
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ModuleLength:
+  Max: 108
 
 # Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 17
+  Max: 16
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 132

_tools/ruby_h_to_go/exe/ruby_h_to_go

@@ -24,8 +24,7 @@ DEFAULT_INCLUDE_PATHS = [
   RbConfig::CONFIG["rubyhdrdir"],
 ].freeze
 
-DEFAULT_DIST_DIR = File.expand_path("../dist", __dir__)
-
+DEFAULT_DIST_DIR = File.expand_path("../../../ruby", __dir__)
 DEFAULT_DIST_PREPROCESSED_HEADER_FILE = File.join(Dir.tmpdir, "ruby_preprocessed.h")
 
 opt = OptionParser.new

_tools/ruby_h_to_go/lib/ruby_h_to_go.rb

@@ -7,6 +7,7 @@
 require_relative "ruby_h_to_go/generator_helper"
 require_relative "ruby_h_to_go/argument_definition"
 require_relative "ruby_h_to_go/cli"
+require_relative "ruby_h_to_go/enum_definition"
 require_relative "ruby_h_to_go/function_definition"
 require_relative "ruby_h_to_go/struct_definition"
 require_relative "ruby_h_to_go/type_definition"

_tools/ruby_h_to_go/lib/ruby_h_to_go/argument_definition.rb

@@ -35,12 +35,23 @@ def go_name
 
     # @return [String]
     def go_function_arg
-      "#{go_name} #{ruby_c_type_to_go_type(type, pointer:, type: :arg)}"
+      "#{go_name} #{ruby_c_type_to_go_type(type, pointer:, pointer_length: length, pos: :arg)}"
     end
 
     # @return [String]
     def cast_to_cgo
-      return "toCArray[#{ruby_c_type_to_go_type(type)}, #{cast_to_cgo_type(type)}](#{go_name})" if pointer == :array
+      case pointer
+      when :array
+        return "toCArray[#{ruby_c_type_to_go_type(type)}, #{cast_to_cgo_type(type)}](#{go_name})"
+      when :ref_array
+        return "toCArray[*#{ruby_c_type_to_go_type(type)}, *#{cast_to_cgo_type(type)}](#{go_name})"
+      when :sref
+        return go_name if type == "void" && length == 2
+
+        return "(#{"*" * length}#{cast_to_cgo_type(type)})(unsafe.Pointer(#{go_name}))"
+      when :in_ref
+        return "(*#{cast_to_cgo_type(type)})(#{go_name})"
+      end
 
       "#{cast_to_cgo_type(type)}(#{go_name})"
     end

_tools/ruby_h_to_go/lib/ruby_h_to_go/cli.rb

@@ -36,12 +36,11 @@ def perform
       write_type_definitions_to_go_file
       write_struct_definitions_to_go_file
       write_function_definitions_to_go_file
+      write_enum_definitions_to_go_file
 
       copy_go_files
-
-      # FIXME: Enable after
-      # remove_unused_imports
-      # go_fmt
+      remove_unused_imports
+      go_fmt
     end
 
     private
@@ -56,7 +55,7 @@ def write_type_definitions_to_go_file
         RubyHToGo::TypeDefinition.new(definition:)
       end
 
-      type_definitions.each do |definition|
+      type_definitions.sort_by(&:name).each do |definition|
         definition.write_go_file(dist_dir)
       end
     end
@@ -66,7 +65,7 @@ def write_struct_definitions_to_go_file
         RubyHToGo::StructDefinition.new(definition:)
       end
 
-      struct_definitions.each do |definition|
+      struct_definitions.sort_by(&:name).each do |definition|
         definition.write_go_file(dist_dir)
       end
     end
@@ -86,23 +85,33 @@ def write_function_definitions_to_go_file
         end
       end
 
-      function_definitions.each do |definition|
+      function_definitions.sort_by(&:name).each do |definition|
+        definition.write_go_file(dist_dir)
+      end
+    end
+
+    def write_enum_definitions_to_go_file
+      enum_definitions = parser.extract_enum_definitions.map do |definition|
+        RubyHToGo::EnumDefinition.new(definition:)
+      end
+
+      enum_definitions.sort_by(&:name).each do |definition|
         definition.write_go_file(dist_dir)
       end
     end
 
     # Clean all generated files in dist/
     def clean_generated_files
-      FileUtils.rm_f(Dir.glob(File.join(dist_dir, "*.go")))
+      FileUtils.rm_f(Dir.glob(File.join(dist_dir, "*_generated.go")))
     end
 
     def copy_go_files
       src_dir = File.expand_path("../../../../ruby", __dir__)
       return if src_dir == dist_dir
 
       %w[
+        c_struct.go
         c_types.go
-        types.go
         wrapper.go
       ].each do |file|
         FileUtils.cp(File.join(src_dir, file), dist_dir)

_tools/ruby_h_to_go/lib/ruby_h_to_go/enum_definition.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RubyHToGo
+  # Proxy class for generating go enum
+  class EnumDefinition
+    extend Forwardable
+
+    def_delegators :@definition, :==, :name, :name=, :values, :values=
+
+    include GeneratorHelper
+
+    # @param definition [RubyHeaderParser::EnumDefinition]
+    def initialize(definition:)
+      @definition = definition
+    end
+
+    # Write definition as go file
+    # @param [String] dist_dir
+    def write_go_file(dist_dir)
+      go_file_path = File.join(dist_dir, "enum_generated.go")
+
+      generate_initial_go_file(go_file_path)
+
+      File.open(go_file_path, "a") do |f|
+        f.write(generate_go_content)
+      end
+    end
+
+    # @return [String]
+    def generate_go_content
+      go_type_name = snake_to_camel(name)
+
+      go_enum_lines = [
+        "// #{go_type_name} is a type for passing `C.#{name}` in and out of package",
+        "type #{go_type_name} int",
+        "",
+        "// #{go_type_name} enumeration",
+        "const (",
+      ]
+
+      values.each do |value|
+        go_enum_lines << "#{value} #{go_type_name} = C.#{value}"
+      end
+
+      go_enum_lines << ")"
+      go_enum_lines << ""
+      go_enum_lines << ""
+
+      go_enum_lines.join("\n")
+    end
+  end
+end

_tools/ruby_h_to_go/lib/ruby_h_to_go/function_definition.rb

@@ -56,37 +56,58 @@ def generate_go_content
 
       casted_go_args = []
       char_var_count = args.count { |c_arg| c_arg.type == "char" && c_arg.pointer == :ref }
+      chars_var_count = args.count { |c_arg| c_arg.type == "char" && c_arg.pointer == :str_array }
 
       before_call_function_lines = []
       after_call_function_lines = []
 
       args.each do |c_arg|
-        if c_arg.type == "char" && c_arg.pointer == :ref
-          if char_var_count >= 2
-            char_var_name = "char#{snake_to_camel(c_arg.go_name)}"
-            clean_var_name = "cleanChar#{c_arg.go_name}"
-          else
-            char_var_name = "char"
-            clean_var_name = "clean"
-          end
-
-          go_function_lines << "#{char_var_name}, #{clean_var_name} := string2Char(#{c_arg.go_name})"
-          go_function_lines << "defer #{clean_var_name}()"
-          go_function_lines << ""
-
-          casted_go_args << char_var_name.to_s
-        elsif c_arg.pointer == :ref
-          if c_arg.type == "void"
-            casted_go_args << "toCPointer(#{c_arg.go_name})"
+        case c_arg.pointer
+        when :ref
+          case c_arg.type
+          when "char"
+            # c_arg is string
+            if char_var_count >= 2
+              chars_var_name = "char#{snake_to_camel(c_arg.go_name)}"
+              clean_var_name = "cleanChar#{c_arg.go_name}"
+            else
+              chars_var_name = "char"
+              clean_var_name = "clean"
+            end
+
+            go_function_lines << "#{chars_var_name}, #{clean_var_name} := string2Char(#{c_arg.go_name})"
+            go_function_lines << "defer #{clean_var_name}()"
+            go_function_lines << ""
+
+            casted_go_args << chars_var_name.to_s
+          when "void"
+            # c_arg is pointer
+            casted_go_args << c_arg.go_name
           else
             c_var_name = "c#{snake_to_camel(c_arg.go_name)}"
 
             before_call_function_lines << "var #{c_var_name} #{cast_to_cgo_type(c_arg.type)}"
             after_call_function_lines <<
-              "*#{c_arg.go_name} = #{ruby_c_type_to_go_type(c_arg.type, type: :arg)}(#{c_var_name})"
+              "*#{c_arg.go_name} = #{ruby_c_type_to_go_type(c_arg.type, pos: :arg)}(#{c_var_name})"
 
             casted_go_args << "&#{c_var_name}"
           end
+        when :function
+          casted_go_args << "toCFunctionPointer(#{c_arg.go_name})"
+        when :str_array
+          if chars_var_count >= 2
+            chars_var_name = "chars#{snake_to_camel(c_arg.go_name)}"
+            clean_var_name = "cleanChars#{c_arg.go_name}"
+          else
+            chars_var_name = "chars"
+            clean_var_name = "cleanChars"
+          end
+
+          go_function_lines << "#{chars_var_name}, #{clean_var_name} := strings2Chars(#{c_arg.go_name})"
+          go_function_lines << "defer #{clean_var_name}()"
+          go_function_lines << ""
+
+          casted_go_args << chars_var_name
         else
           casted_go_args << c_arg.cast_to_cgo
         end
@@ -96,17 +117,11 @@ def generate_go_content
       call_c_method << ")"
 
       go_function_lines.push(*before_call_function_lines)
-      if go_function_typeref == ""
+      cast_func = typeref.cast_func_for_function_return
+      if cast_func == ""
         go_function_lines << call_c_method
         go_function_lines.push(*after_call_function_lines)
       else
-        cast_func =
-          if go_function_typeref.start_with?("*")
-            "(#{go_function_typeref})"
-          else
-            go_function_typeref
-          end
-
         go_function_lines << "ret := #{cast_func}(#{call_c_method})"
         go_function_lines.push(*after_call_function_lines)
         go_function_lines << "return ret"