Merge pull request #152 from sue445/feature/fix_rstring_char

Fix RSTRING_PTR

Author: sue445

_tools/ruby_h_to_go/lib/ruby_h_to_go/generator_helper.rb

@@ -39,7 +39,7 @@ def generate_initial_go_file(go_file_path)
     # Convert C type to Go type. (used in wrapper function args and return type etc)
     # @param typename [String]
     # @param pos [Symbol,nil] :arg, :typeref, :return
-    # @param pointer [Symbol,nil] Whether pointer hint
+    # @param pointer [Symbol,nil] pointer hint (:ref, :array, :ref_array, :function, :sref, :str_array, :in_ref, :raw)
     # @param pointer_length [Integer]
     # @return [String]
     def ruby_c_type_to_go_type(typename, pos: nil, pointer: nil, pointer_length: 0)
@@ -107,7 +107,7 @@ def cast_to_cgo_type(typename)
     # Convert pointer C type to Go type. (used in wrapper function args and return type etc)
     # @param typename [String]
     # @param pos [Symbol,nil] :arg, :typeref, :return
-    # @param pointer [Symbol,nil] Whether pointer hint
+    # @param pointer [Symbol,nil] pointer hint (:ref, :array, :ref_array, :function, :sref, :str_array, :in_ref, :raw)
     # @param pointer_length [Integer]
     # @return [String]
     def ruby_pointer_c_type_to_go_type(typename, pos:, pointer:, pointer_length:)

_tools/ruby_h_to_go/lib/ruby_header_parser/data.rb

@@ -22,6 +22,15 @@ def function_arg_pointer_hint(function_name:, pos:)
       :ref
     end
 
+    # @param function_name [String]
+    # @return [Symbol] :ref, :raw
+    def function_self_pointer_hint(function_name)
+      pointer_hint = data["function"]["pointer_hint"].dig(function_name, "self")
+      return pointer_hint.to_sym if pointer_hint
+
+      :ref
+    end
+
     # rubocop:disable Style/CaseEquality
 
     # Whether generate C function to go

_tools/ruby_h_to_go/lib/ruby_header_parser/data.yml

@@ -68,6 +68,8 @@ function:
     - rb_class_descendants
 
   pointer_hint:
+    RSTRING_PTR:
+      self: raw
     rb_data_object_make:
       4: sref
     rb_data_typed_object_make:

_tools/ruby_h_to_go/lib/ruby_header_parser/parser.rb

@@ -265,7 +265,7 @@ def create_typeref(definition:, function_name:, typeref_field:, filepath:, line_
       typeref_pointer = nil
       if typeref_type.match?(/\*+$/)
         typeref_type = typeref_type.gsub(/\*+$/, "").strip
-        typeref_pointer = :ref
+        typeref_pointer = data.function_self_pointer_hint(function_name)
       end
 
       TyperefDefinition.new(type: typeref_type, pointer: typeref_pointer)

_tools/ruby_h_to_go/spec/ruby_h_to_go/function_definition_spec.rb

@@ -502,6 +502,36 @@
 
       it { should eq go_content }
     end
+
+    context "RSTRING_PTR" do
+      let(:definition) do
+        RubyHeaderParser::FunctionDefinition.new(
+          name:       "RSTRING_PTR",
+          definition: "RSTRING_PTR(VALUE str)",
+          typeref:    typeref(type: "char", pointer: :raw),
+          args:       [
+            argument(type: "VALUE", name: "str"),
+          ],
+        )
+      end
+
+      let(:go_content) do
+        <<~GO
+          // RSTRING_PTR calls `RSTRING_PTR` in C
+          //
+          // Original definition is following
+          //
+          //	RSTRING_PTR(VALUE str)
+          func RSTRING_PTR(str VALUE) *Char {
+          ret := (*Char)(C.RSTRING_PTR(C.VALUE(str)))
+          return ret
+          }
+
+        GO
+      end
+
+      it { should eq go_content }
+    end
   end
 
   describe "#go_function_name" do

_tools/ruby_h_to_go/spec/ruby_header_parser/data_spec.rb

@@ -21,6 +21,22 @@
     end
   end
 
+  describe "#function_self_pointer_hint" do
+    subject { data.function_self_pointer_hint(function_name) }
+
+    context "found in data.yml" do
+      let(:function_name) { "RSTRING_PTR" }
+
+      it { should eq :raw }
+    end
+
+    context "not found in data.yml" do
+      let(:function_name) { "rb_class2name" }
+
+      it { should eq :ref }
+    end
+  end
+
   describe "#should_generate_function?" do
     subject { data.should_generate_function?(function_name) }
 

_tools/ruby_h_to_go/spec/ruby_header_parser/parser_spec.rb

@@ -301,6 +301,21 @@
       its(:typeref)    { should eq typeref(type: "VALUE") }
       its(:args)       { should eq args }
     end
+
+    context "RSTRING_PTR" do
+      subject { definitions.find { |d| d.name == "RSTRING_PTR" } }
+
+      let(:args) do
+        [
+          argument(type: "VALUE", name: "str"),
+        ]
+      end
+
+      its(:name)       { should eq "RSTRING_PTR" }
+      its(:definition) { should eq "RSTRING_PTR(VALUE str)" }
+      its(:typeref)    { should eq typeref(type: "char", pointer: :raw) }
+      its(:args)       { should eq args }
+    end
   end
 
   describe "#extract_struct_definitions" do