Merge pull request #135 from sue445/fix_generated_code

Fix ruby_h_to_go

Author: sue445

.rubocop.yml

@@ -18,6 +18,9 @@ AllCops:
 Gemspec/RequireMFA:
   Enabled: false
 
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
 Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table

_tools/ruby_h_to_go/lib/ruby_h_to_go.rb

@@ -4,7 +4,7 @@
 
 require_relative "ruby_header_parser"
 
-require_relative "ruby_h_to_go/helper"
+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/function_definition"

_tools/ruby_h_to_go/lib/ruby_h_to_go/argument_definition.rb

@@ -7,19 +7,22 @@ class ArgumentDefinition
 
     def_delegators :@definition, :==, :type, :type=, :name, :name=, :pointer, :pointer=, :pointer?, :length, :length=
 
-    include Helper
+    include GeneratorHelper
 
     # @param definition [RubyHeaderParser::ArgumentDefinition]
     def initialize(definition)
       @definition = definition
     end
 
-    # These are reserved in Go
     C_NAME_TO_GO_NAME = {
+      # These are reserved in Go
       "var"   => "v",
       "func"  => "fun",
       "range" => "r",
       "type"  => "r",
+
+      # Can't use "_" as a value
+      "_"     => "arg",
     }.freeze
 
     # @return [String] Variable name available in Go

_tools/ruby_h_to_go/lib/ruby_h_to_go/function_definition.rb

@@ -7,7 +7,7 @@ class FunctionDefinition
 
     def_delegators :@definition, :==, :name, :name=, :definition, :definition=, :filepath, :filepath=
 
-    include Helper
+    include GeneratorHelper
 
     # @param definition [RubyHeaderParser::FunctionDefinition]
     def initialize(definition)

_tools/ruby_h_to_go/lib/ruby_h_to_go/helper.rb renamed to _tools/ruby_h_to_go/lib/ruby_h_to_go/generator_helper.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 module RubyHToGo
-  # helper methods for generating go coce
-  module Helper
+  # helper methods for generating go code
+  module GeneratorHelper
     # @param header_dir [String]
     # @param ruby_header_file [String]
     # @return [String]
     def go_file_name(header_dir:, ruby_header_file:)
-      ruby_header_file.delete_prefix(header_dir + File::SEPARATOR).gsub(File::SEPARATOR, "-").gsub(/\.h$/, ".go")
+      ruby_header_file.delete_prefix(header_dir + File::SEPARATOR).gsub(File::SEPARATOR, "_").
+        gsub(/\.h$/, "_generated.go")
     end
 
     # @param str [String]
@@ -24,6 +25,11 @@ def generate_initial_go_file(go_file_path)
       return if File.exist?(go_file_path)
 
       File.binwrite(go_file_path, <<~GO)
+        // THE AUTOGENERATED LICENSE. ALL THE RIGHTS ARE RESERVED BY ROBOTS.
+
+        // WARNING: This file has automatically been generated
+        // Code generated by ruby_h_to_go. DO NOT EDIT.
+
         package ruby
 
         /*
@@ -44,8 +50,6 @@ def generate_initial_go_file(go_file_path)
     # @param pointer [Symbol,nil] Whether pointer hint
     # @return [String]
     def ruby_c_type_to_go_type(typename, type: nil, pointer: nil)
-      typename = typename.delete_prefix("struct ").delete_prefix("volatile ")
-
       if pointer
         case typename
         when "char", "const char"
@@ -79,7 +83,7 @@ def ruby_c_type_to_go_type(typename, type: nil, pointer: nil)
         return "Longlong"
       when "unsigned LONG_LONG"
         return "Ulonglong"
-      when /^VALUE\s*\(\*func\)\s*\(ANYARGS\)$/
+      when /^VALUE\s*\(\*func\)\s*\(ANYARGS\)$/, "RUBY_DATA_FUNC"
         return "unsafe.Pointer"
       when /^[A-Z]+$/, "int"
         # e.g. VALUE
@@ -108,7 +112,7 @@ def cast_to_cgo_type(typename)
         return "C.Longlong"
       when "unsigned LONG_LONG"
         return "C.Ulonglong"
-      when /^VALUE\s*\(\*func\)\s*\(ANYARGS\)$/
+      when /^VALUE\s*\(\*func\)\s*\(ANYARGS\)$/, "RUBY_DATA_FUNC"
         return "toCPointer"
       end
 

_tools/ruby_h_to_go/lib/ruby_h_to_go/struct_definition.rb

@@ -7,7 +7,7 @@ class StructDefinition
 
     def_delegators :@definition, :==, :name, :name=, :filepath, :filepath=
 
-    include Helper
+    include GeneratorHelper
 
     # @param definition [RubyHeaderParser::StructDefinition]
     def initialize(definition)

_tools/ruby_h_to_go/lib/ruby_h_to_go/type_definition.rb

@@ -7,7 +7,7 @@ class TypeDefinition
 
     def_delegators :@definition, :==, :name, :name=, :filepath, :filepath=
 
-    include Helper
+    include GeneratorHelper
 
     # @param definition [RubyHeaderParser::TypeDefinition]
     def initialize(definition)

_tools/ruby_h_to_go/lib/ruby_h_to_go/typeref_definition.rb

@@ -7,7 +7,7 @@ class TyperefDefinition
 
     def_delegators :@definition, :==, :type, :type=, :pointer, :pointer=, :pointer?
 
-    include Helper
+    include GeneratorHelper
 
     # @param definition [RubyHeaderParser::TyperefDefinition]
     def initialize(definition)

_tools/ruby_h_to_go/lib/ruby_header_parser/data.rb

@@ -26,8 +26,6 @@ def function_arg_pointer_hint(function_name:, index:)
     # @param function_name [String]
     # @return [Boolean]
     def should_generate_function?(function_name)
-      function_name = function_name.downcase
-
       return false if data["function"]["deny_name"].any? { |format| format === function_name } # rubocop:disable Style/CaseEquality
 
       data["function"]["allow_name"].any? { |format| format === function_name } # rubocop:disable Style/CaseEquality
@@ -37,17 +35,13 @@ def should_generate_function?(function_name)
     # @param struct_name [String]
     # @return [Boolean]
     def should_generate_struct?(struct_name)
-      struct_name = struct_name.downcase
-
       data["struct"]["allow_name"].any? { |format| format === struct_name } # rubocop:disable Style/CaseEquality
     end
 
     # Whether generate C type to go
     # @param type_name [String]
     # @return [Boolean]
     def should_generate_type?(type_name)
-      type_name = type_name.downcase
-
       data["type"]["allow_name"].any? { |format| format === type_name } # rubocop:disable Style/CaseEquality
     end
   end

_tools/ruby_h_to_go/lib/ruby_header_parser/data.yml

@@ -1,7 +1,7 @@
 function:
   allow_name:
-    - !ruby/regexp /^rb_/
-    - !ruby/regexp /^rstring_/
+    - !ruby/regexp /^rb_/i
+    - !ruby/regexp /^rstring_/i
 
   deny_name:
     # deprecated functions
@@ -29,6 +29,11 @@ function:
     # internal functions in ruby.h
     - rb_scan_args_bad_format
 
+    # FIXME: Both `rb_hash` and `rb_Hash` are defined in ruby.h
+    #        Converting to Go function names would result in both being `RbHash`
+    #        Exclude one of the function names because duplicate function names will result in an error.
+    - rb_Hash
+
   pointer_hint:
     rb_funcallv:
       3: array
@@ -37,11 +42,14 @@ function:
 
 struct:
   allow_name:
-    - !ruby/regexp /^rb_/
+    - !ruby/regexp /^rb_/i
+    - re_registers
 
 type:
   allow_name:
-    - !ruby/regexp /^rb_/
-    - !ruby/regexp /^st_/
-    - id
-    - value
+    - !ruby/regexp /^rb_/i
+    - !ruby/regexp /^st_/i
+    - ID
+    - VALUE
+    - regex_t
+    - OnigPosition