Merge pull request #131 from sue445/add_types

Add types

Author: sue445

.rubocop_todo.yml

@@ -1,38 +1,43 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-09-15 15:09:33 UTC using RuboCop version 1.66.1.
+# on 2024-09-17 16:12:35 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: 4
+# Offense count: 5
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 64
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 40
+  Max: 41
+
+# Offense count: 1
+# Configuration parameters: CountBlocks, CountModifierForms.
+Metrics/BlockNesting:
+  Max: 4
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 169
+  Max: 175
 
 # Offense count: 4
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 17
 
 # Offense count: 9
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 58
 
-# Offense count: 4
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 15

Gemfile

@@ -5,6 +5,7 @@ source "https://rubygems.org"
 gem "rake"
 gem "rspec"
 gem "rspec-its"
+gem "rspec-parameterized"
 gem "rubocop", require: false
 gem "rubocop_auto_corrector", require: false
 gem "serverspec"

Gemfile.lock

@@ -15,9 +15,12 @@ GEM
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
+    binding_of_caller (1.0.1)
+      debug_inspector (>= 1.2.0)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     csv (3.3.0)
+    debug_inspector (1.2.0)
     diff-lcs (1.5.1)
     drb (2.2.1)
     ffi (1.17.0)
@@ -42,6 +45,10 @@ GEM
       ast (~> 2.4.1)
       racc
     power_assert (2.0.3)
+    proc_to_ast (0.2.0)
+      parser
+      rouge
+      unparser
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.2.1)
@@ -53,6 +60,7 @@ GEM
     rbs (3.5.3)
       logger
     regexp_parser (2.9.2)
+    rouge (4.4.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -68,6 +76,17 @@ GEM
     rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
+    rspec-parameterized (1.0.2)
+      rspec-parameterized-core (< 2)
+      rspec-parameterized-table_syntax (< 2)
+    rspec-parameterized-core (1.0.1)
+      parser
+      proc_to_ast (>= 0.2.0)
+      rspec (>= 2.13, < 4)
+      unparser
+    rspec-parameterized-table_syntax (1.0.1)
+      binding_of_caller
+      rspec-parameterized-core (< 2)
     rspec-support (3.13.1)
     rubocop (1.66.1)
       json (~> 2.3)
@@ -120,6 +139,9 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.6.0)
+    unparser (0.6.15)
+      diff-lcs (~> 1.3)
+      parser (>= 3.3.0)
     yard (0.9.37)
 
 PLATFORMS
@@ -131,6 +153,7 @@ DEPENDENCIES
   rake-compiler
   rspec
   rspec-its
+  rspec-parameterized
   rubocop
   rubocop_auto_corrector
   serverspec

_tools/ruby_h_to_go/lib/ruby_h_to_go/argument_definition.rb

@@ -5,7 +5,7 @@ module RubyHToGo
   class ArgumentDefinition
     extend Forwardable
 
-    def_delegators :@definition, :==, :type, :type=, :name, :name=, :pointer, :pointer=, :pointer?
+    def_delegators :@definition, :==, :type, :type=, :name, :name=, :pointer, :pointer=, :pointer?, :length, :length=
 
     include Helper
 
@@ -33,5 +33,12 @@ def go_name
     def go_function_arg
       "#{go_name} #{ruby_c_type_to_go_type(type, pointer:, type: :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
+
+      "#{cast_to_cgo_type(type)}(#{go_name})"
+    end
   end
 end

_tools/ruby_h_to_go/lib/ruby_h_to_go/cli.rb

@@ -68,6 +68,7 @@ def copy_go_files
       #       with automatically generated files. (Currently output to `dist/` as it is incomplete)
       %w[
         c_types.go
+        types.go
         wrapper.go
       ].each do |file|
         FileUtils.cp(File.join(__dir__, "..", "..", "..", "..", "ruby", file), dist_dir)

_tools/ruby_h_to_go/lib/ruby_h_to_go/function_definition.rb

@@ -57,13 +57,13 @@ def generate_go_content
       call_c_method = "C.#{name}("
 
       casted_go_args = []
-      char_var_count = args.count { |c_arg| c_arg.type == "char" && c_arg.pointer }
+      char_var_count = args.count { |c_arg| c_arg.type == "char" && c_arg.pointer == :ref }
 
       before_call_function_lines = []
       after_call_function_lines = []
 
       args.each do |c_arg|
-        if c_arg.type == "char" && c_arg.pointer?
+        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}"
@@ -83,14 +83,14 @@ def generate_go_content
           else
             c_var_name = "c#{snake_to_camel(c_arg.go_name)}"
 
-            before_call_function_lines << "var #{c_var_name} C.#{c_arg.type}"
+            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})"
 
             casted_go_args << "&#{c_var_name}"
           end
         else
-          casted_go_args << "#{cast_to_cgo_type(c_arg.type)}(#{c_arg.go_name})"
+          casted_go_args << c_arg.cast_to_cgo
         end
       end
 

_tools/ruby_h_to_go/lib/ruby_h_to_go/helper.rb

@@ -49,11 +49,13 @@ def ruby_c_type_to_go_type(typename, type: nil, pointer: nil)
       if pointer
         case typename
         when "char", "const char"
-          case type
-          when :arg, :return
-            return "string"
-          else
-            return "char2String"
+          if pointer == :ref
+            case type
+            when :arg, :return
+              return "string"
+            else
+              return "char2String"
+            end
           end
         when "void"
           return "unsafe.Pointer"
@@ -69,8 +71,14 @@ def ruby_c_type_to_go_type(typename, type: nil, pointer: nil)
       case typename
       when "unsigned int", "unsigned long"
         return "uint"
+      when "unsigned short"
+        return "Ushort"
       when "unsigned char"
         return "Uchar"
+      when "LONG_LONG"
+        return "Longlong"
+      when "unsigned LONG_LONG"
+        return "Ulonglong"
       when /^VALUE\s*\(\*func\)\s*\(ANYARGS\)$/
         return "unsafe.Pointer"
       when /^[A-Z]+$/, "int"
@@ -94,8 +102,12 @@ def cast_to_cgo_type(typename)
         return "C.uint"
       when "unsigned char"
         return "C.uchar"
-      when "VALUE*"
-        return "toCValueArray"
+      when "unsigned short"
+        return "C.ushort"
+      when "LONG_LONG"
+        return "C.Longlong"
+      when "unsigned LONG_LONG"
+        return "C.Ulonglong"
       when /^VALUE\s*\(\*func\)\s*\(ANYARGS\)$/
         return "toCPointer"
       end

_tools/ruby_h_to_go/lib/ruby_header_parser/argument_definition.rb

@@ -12,22 +12,29 @@ class ArgumentDefinition
     attr_accessor :name
 
     # @!attribute pointer
-    #   @return [Symbol,nil]
+    #   @return [Symbol,nil] :ref, :array
     attr_accessor :pointer
 
+    # @!attribute length
+    #   @return [Integer]
+    attr_accessor :length
+
     # @param type [String]
     # @param name [String]
-    # @param pointer [Symbol,nil] :ref
-    def initialize(type:, name:, pointer: nil)
+    # @param pointer [Symbol,nil] :ref, :array
+    # @param length [String]
+    def initialize(type:, name:, pointer: nil, length: 0)
       @type = type
       @name = name
       @pointer = pointer
+      @length = length
     end
 
     # @param other [ArgumentDefinition]
     # @return [Boolean]
     def ==(other)
-      other.is_a?(ArgumentDefinition) && type == other.type && name == other.name && pointer == other.pointer
+      other.is_a?(ArgumentDefinition) && type == other.type && name == other.name && pointer == other.pointer &&
+        length == other.length
     end
 
     # @return [Boolean]

_tools/ruby_h_to_go/lib/ruby_header_parser/parser.rb

@@ -159,7 +159,7 @@ def should_generate_struct?(struct_name)
     end
 
     ALLOW_TYPE_NAME_PREFIXES = %w[rb_ st_].freeze
-    ALLOW_TYPE_NAMES = %w[id value long_long].freeze
+    ALLOW_TYPE_NAMES = %w[id value].freeze
 
     # Whether generate C type to go
     # @param type_name [String]
@@ -196,25 +196,33 @@ def parse_definition_args(function_name, signature)
           )
         else
           loop do
-            break unless parts[-1].start_with?("*")
+            pointer_index = parts.index("*")
+            break unless pointer_index
 
-            parts[-1].delete_prefix!("*")
-            parts[-2] << "*"
+            parts[pointer_index - 1] << "*"
+            parts.delete_at(pointer_index)
+          end
+
+          pointer = nil
+          length = 0
+
+          if parts[-1] =~ /\[([0-9]+)\]$/
+            parts[-1].gsub!(/\[([0-9]+)\]$/, "")
+            length = ::Regexp.last_match(1).to_i
+            pointer = :array
           end
 
           unless parts[-1] =~ /^[0-9a-zA-Z_]+$/
             # last elements isn't dummy argument
             parts << "arg#{arg_pos}"
           end
 
-          type = parts[0...-1].join(" ")
-          type = type.delete_prefix("const ").delete_prefix("volatile ").delete_prefix("struct ").strip
+          type = Util.sanitize_type(parts[0...-1].join(" "))
           name = parts[-1]
 
-          pointer = nil
           if type.match?(/\*+$/)
             type = type.gsub(/\*+$/, "").strip
-            pointer = function_arg_pointer_hint(function_name, arg_pos - 1)
+            pointer ||= function_arg_pointer_hint(function_name, arg_pos - 1)
           elsif /^void\s*\s/.match?(type) || /\(.*\)/.match?(type)
             # function pointer (e.g. void *(*func)(void *)) is treated as `void*`
             type = "void"
@@ -225,6 +233,7 @@ def parse_definition_args(function_name, signature)
             type:,
             name:,
             pointer:,
+            length:,
           )
         end
       end.compact
@@ -245,6 +254,8 @@ def function_arg_pointer_hint(function_name, index)
     # @return [RubyHeaderParser::TyperefDefinition]
     def create_typeref(definition, function_name)
       typeref_type = definition[0...definition.index(function_name)].gsub("char *", "char*").strip
+      typeref_type = Util.sanitize_type(typeref_type)
+
       typeref_pointer = nil
       if typeref_type.match?(/\*+$/)
         typeref_type = typeref_type.gsub(/\*+$/, "").strip

_tools/ruby_h_to_go/lib/ruby_header_parser/util.rb

@@ -19,5 +19,11 @@ def self.find_field(array, field_name)
     def self.split_signature(signature)
       signature.scan(/[^,]+\([^()]*\)|[^,]+/).map(&:strip)
     end
+
+    # @param type [String]
+    # @return [String]
+    def self.sanitize_type(type)
+      type.gsub(/(RUBY_EXTERN|enum|volatile|const|struct)\s+/i, "").gsub("const*", "").strip
+    end
   end
 end