Merge pull request #145 from sue445/rb_block_proc

[WIP] Fix rb_block_proc

Author: sue445

_tools/ruby_h_to_go/exe/ruby_h_to_go

@@ -8,27 +8,51 @@
 
 require "optparse"
 require "fileutils"
+require "tmpdir"
 
 require_relative "../lib/ruby_h_to_go"
 
-header_dir = nil
+header_file = nil
+include_paths = nil
 dist_dir = nil
+dist_preprocessed_header_file = nil
+
+DEFAULT_RUBY_HEADER_FILE = File.join(RbConfig::CONFIG["rubyhdrdir"], "ruby.h")
+
+DEFAULT_INCLUDE_PATHS = [
+  RbConfig::CONFIG["rubyarchhdrdir"],
+  RbConfig::CONFIG["rubyhdrdir"],
+].freeze
 
-DEFAULT_RUBY_HEADER_DIR = RbConfig::CONFIG["rubyhdrdir"]
 DEFAULT_DIST_DIR = File.expand_path("../dist", __dir__)
 
+DEFAULT_DIST_PREPROCESSED_HEADER_FILE = File.join(Dir.tmpdir, "ruby_preprocessed.h")
+
 opt = OptionParser.new
-opt.on("-H", "--header-dir HEADER_DIR", "ruby header dir (default: #{DEFAULT_RUBY_HEADER_DIR})") { |v| header_dir = v }
+opt.on("-H", "--header-file HEADER_FILE", "ruby header file (default: #{DEFAULT_RUBY_HEADER_FILE})") do |v|
+  header_file = v
+end
+
+opt.on("-I", "--include-path path1,path2", Array, "include paths (default: #{DEFAULT_INCLUDE_PATHS})") do |v|
+  include_paths = v
+end
 
 opt.on("-D", "--dist-dir DIST_DIR", "dist dir for auto-generated Go code (default: #{DEFAULT_DIST_DIR})") do |v|
   dist_dir = v
 end
 
+opt.on("-p", "--dist-dir DIST_DIR",
+       "dist preprocessed ruby header file (default: #{DEFAULT_DIST_PREPROCESSED_HEADER_FILE})") do |v|
+  dist_preprocessed_header_file = v
+end
+
 opt.parse!(ARGV)
 
 # Use default header file and include paths
-header_dir ||= DEFAULT_RUBY_HEADER_DIR
+header_file ||= DEFAULT_RUBY_HEADER_FILE
+include_paths ||= DEFAULT_INCLUDE_PATHS
 
 dist_dir ||= DEFAULT_DIST_DIR
+dist_preprocessed_header_file ||= DEFAULT_DIST_PREPROCESSED_HEADER_FILE
 
-RubyHToGo::Cli.new(header_dir:, dist_dir:).perform
+RubyHToGo::Cli.new(header_file:, include_paths:, dist_dir:, dist_preprocessed_header_file:).perform

_tools/ruby_h_to_go/lib/ruby_h_to_go/argument_definition.rb

@@ -3,10 +3,6 @@
 module RubyHToGo
   # Proxy class for generating argument in go function
   class ArgumentDefinition
-    # @!attribute [r] header_dir
-    #   @return [String]
-    attr_reader :header_dir
-
     extend Forwardable
 
     def_delegators :@definition, :==, :type, :type=, :name, :name=, :pointer, :pointer=, :pointer?, :length, :length=
@@ -15,9 +11,8 @@ class ArgumentDefinition
 
     # @param definition [RubyHeaderParser::ArgumentDefinition]
     # @param header_dir [String]
-    def initialize(definition:, header_dir:)
+    def initialize(definition:)
       @definition = definition
-      @header_dir = header_dir
     end
 
     C_NAME_TO_GO_NAME = {

_tools/ruby_h_to_go/lib/ruby_h_to_go/cli.rb

@@ -3,19 +3,31 @@
 module RubyHToGo
   # client for ruby_h_to_go
   class Cli
-    # @!attribute [r] header_dir
+    # @!attribute [r] header_file
     #   @return [String]
-    attr_reader :header_dir
+    attr_reader :header_file
+
+    # @!attribute [r] include_paths
+    #   @return [Array<String>]
+    attr_reader :include_paths
 
     # @!attribute [r] dist_dir
     #   @return [String]
     attr_reader :dist_dir
 
-    # @param header_dir [String]
+    # @!attribute [r] dist_preprocessed_header_file
+    #   @return [String]
+    attr_reader :dist_preprocessed_header_file
+
+    # @param header_file [String] path to ruby.h
+    # @param include_paths [Array<String>]
     # @param dist_dir [String]
-    def initialize(header_dir:, dist_dir:)
-      @header_dir = header_dir
+    # @param dist_preprocessed_header_file [String]
+    def initialize(header_file:, include_paths:, dist_dir:, dist_preprocessed_header_file:)
+      @header_file = header_file
+      @include_paths = include_paths
       @dist_dir = dist_dir
+      @dist_preprocessed_header_file = dist_preprocessed_header_file
     end
 
     def perform
@@ -26,48 +38,46 @@ def perform
       write_function_definitions_to_go_file
 
       copy_go_files
-      remove_unused_imports
-      go_fmt
+
+      # FIXME: Enable after
+      # remove_unused_imports
+      # go_fmt
     end
 
     private
 
     # @return [RubyHeaderParser::Parser]
     def parser
-      @parser ||= RubyHeaderParser::Parser.new(header_dir)
+      @parser ||= RubyHeaderParser::Parser.new(header_file:, include_paths:, dist_preprocessed_header_file:)
     end
 
     def write_type_definitions_to_go_file
       type_definitions = parser.extract_type_definitions.map do |definition|
-        RubyHToGo::TypeDefinition.new(definition:, header_dir:)
+        RubyHToGo::TypeDefinition.new(definition:)
       end
 
       type_definitions.each do |definition|
-        next unless target_header_file?(definition.filepath)
-
         definition.write_go_file(dist_dir)
       end
     end
 
     def write_struct_definitions_to_go_file
       struct_definitions = parser.extract_struct_definitions.map do |definition|
-        RubyHToGo::StructDefinition.new(definition:, header_dir:)
+        RubyHToGo::StructDefinition.new(definition:)
       end
 
       struct_definitions.each do |definition|
-        next unless target_header_file?(definition.filepath)
-
         definition.write_go_file(dist_dir)
       end
     end
 
     def write_function_definitions_to_go_file
       function_definitions = parser.extract_function_definitions.map do |definition|
-        RubyHToGo::FunctionDefinition.new(definition:, header_dir:)
+        RubyHToGo::FunctionDefinition.new(definition:)
       end
 
       static_inline_function_definitions = parser.extract_static_inline_function_definitions.map do |definition|
-        RubyHToGo::FunctionDefinition.new(definition:, header_dir:)
+        RubyHToGo::FunctionDefinition.new(definition:)
       end
 
       static_inline_function_definitions.each do |static_inline_function_definition|
@@ -77,8 +87,6 @@ def write_function_definitions_to_go_file
       end
 
       function_definitions.each do |definition|
-        next unless target_header_file?(definition.filepath)
-
         definition.write_go_file(dist_dir)
       end
     end
@@ -115,11 +123,5 @@ def go_fmt
         system("go fmt", exception: true)
       end
     end
-
-    # @param filename [String]
-    # @return [Boolean]
-    def target_header_file?(filename)
-      File.extname(filename) == ".h"
-    end
   end
 end

_tools/ruby_h_to_go/lib/ruby_h_to_go/function_definition.rb

@@ -3,36 +3,31 @@
 module RubyHToGo
   # Proxy class for generating go function
   class FunctionDefinition
-    # @!attribute [r] header_dir
-    #   @return [String]
-    attr_reader :header_dir
-
     extend Forwardable
 
-    def_delegators :@definition, :==, :name, :name=, :definition, :definition=, :filepath, :filepath=
+    def_delegators :@definition, :==, :name, :name=, :definition, :definition=
 
     include GeneratorHelper
 
     # @param definition [RubyHeaderParser::FunctionDefinition]
-    def initialize(definition:, header_dir:)
+    def initialize(definition:)
       @definition = definition
-      @header_dir = header_dir
     end
 
     # @return [RubyHToGo::TyperefDefinition]
     def typeref
-      @typeref ||= RubyHToGo::TyperefDefinition.new(definition: @definition.typeref, header_dir:)
+      @typeref ||= RubyHToGo::TyperefDefinition.new(definition: @definition.typeref)
     end
 
     # @return [Array<RubyHToGo::ArgumentDefinition>]
     def args
-      @args ||= @definition.args.map { |arg| RubyHToGo::ArgumentDefinition.new(definition: arg, header_dir:) }
+      @args ||= @definition.args.map { |arg| RubyHToGo::ArgumentDefinition.new(definition: arg) }
     end
 
     # Write definition as go file
     # @param [String] dist_dir
     def write_go_file(dist_dir)
-      go_file_path = File.join(dist_dir, generate_go_file_name(header_dir:, ruby_header_file: filepath))
+      go_file_path = File.join(dist_dir, "function_generated.go")
 
       generate_initial_go_file(go_file_path)
 
@@ -48,16 +43,12 @@ def generate_go_content
 
       go_function_typeref = typeref.go_function_typeref
 
-      github_url = generate_include_github_url(header_dir:, ruby_header_file: filepath)
-
       go_function_lines = [
         "// #{go_function_name} calls `#{name}` in C",
         "//",
         "// Original definition is following",
         "//",
         "//\t#{definition}",
-        "//",
-        "// ref. #{github_url}",
       ]
 
       go_function_lines << "func #{go_function_name}(#{go_function_args.join(", ")}) #{go_function_typeref} {"

_tools/ruby_h_to_go/lib/ruby_h_to_go/generator_helper.rb

@@ -3,23 +3,6 @@
 module RubyHToGo
   # helper methods for generating go code
   module GeneratorHelper
-    # @param header_dir [String]
-    # @param ruby_header_file [String]
-    # @return [String]
-    def generate_go_file_name(header_dir:, ruby_header_file:)
-      ruby_header_file.delete_prefix(header_dir + File::SEPARATOR).gsub(File::SEPARATOR, "_").
-        gsub(/\.h$/, "_generated.go")
-    end
-
-    # Generate GitHub url in https://github.com/ruby/ruby
-    # @param header_dir [String]
-    # @param ruby_header_file [String]
-    # @return [String]
-    def generate_include_github_url(header_dir:, ruby_header_file:)
-      file = ruby_header_file.delete_prefix(header_dir + File::SEPARATOR)
-      "https://github.com/ruby/ruby/blob/master/include/#{file}"
-    end
-
     # @param str [String]
     # @return [String]
     def snake_to_camel(str)

_tools/ruby_h_to_go/lib/ruby_h_to_go/struct_definition.rb

@@ -3,27 +3,21 @@
 module RubyHToGo
   # Proxy class for generating go type
   class StructDefinition
-    # @!attribute [r] header_dir
-    #   @return [String]
-    attr_reader :header_dir
-
     extend Forwardable
 
-    def_delegators :@definition, :==, :name, :name=, :filepath, :filepath=
+    def_delegators :@definition, :==, :name, :name=
 
     include GeneratorHelper
 
     # @param definition [RubyHeaderParser::StructDefinition]
-    # @param header_dir [String]
-    def initialize(definition:, header_dir:)
+    def initialize(definition:)
       @definition = definition
-      @header_dir = header_dir
     end
 
     # Write definition as go file
     # @param [String] dist_dir
     def write_go_file(dist_dir)
-      go_file_path = File.join(dist_dir, generate_go_file_name(header_dir:, ruby_header_file: filepath))
+      go_file_path = File.join(dist_dir, "struct_generated.go")
 
       generate_initial_go_file(go_file_path)
 
@@ -34,14 +28,10 @@ def write_go_file(dist_dir)
 
     # @return [String]
     def generate_go_content
-      github_url = generate_include_github_url(header_dir:, ruby_header_file: filepath)
-
       go_type_name = snake_to_camel(name)
 
       <<~GO
         // #{go_type_name} is a type for passing `C.#{name}` in and out of package
-        //
-        // ref. #{github_url}
         type #{go_type_name} C.#{name}
 
       GO

_tools/ruby_h_to_go/lib/ruby_h_to_go/type_definition.rb

@@ -3,26 +3,21 @@
 module RubyHToGo
   # Proxy class for generating go type
   class TypeDefinition
-    # @!attribute [r] header_dir
-    #   @return [String]
-    attr_reader :header_dir
-
     extend Forwardable
 
-    def_delegators :@definition, :==, :name, :name=, :filepath, :filepath=
+    def_delegators :@definition, :==, :name, :name=
 
     include GeneratorHelper
 
     # @param definition [RubyHeaderParser::TypeDefinition]
-    def initialize(definition:, header_dir:)
+    def initialize(definition:)
       @definition = definition
-      @header_dir = header_dir
     end
 
     # Write definition as go file
     # @param [String] dist_dir
     def write_go_file(dist_dir)
-      go_file_path = File.join(dist_dir, generate_go_file_name(header_dir:, ruby_header_file: filepath))
+      go_file_path = File.join(dist_dir, "type_generated.go")
 
       generate_initial_go_file(go_file_path)
 
@@ -33,14 +28,10 @@ def write_go_file(dist_dir)
 
     # @return [String]
     def generate_go_content
-      github_url = generate_include_github_url(header_dir:, ruby_header_file: filepath)
-
       go_type_name = snake_to_camel(name)
 
       <<~GO
         // #{go_type_name} is a type for passing `C.#{name}` in and out of package
-        //
-        // ref. #{github_url}
         type #{go_type_name} C.#{name}
 
       GO

_tools/ruby_h_to_go/lib/ruby_h_to_go/typeref_definition.rb

@@ -3,20 +3,15 @@
 module RubyHToGo
   # Proxy class for generating typeref in go function
   class TyperefDefinition
-    # @!attribute [r] header_dir
-    #   @return [String]
-    attr_reader :header_dir
-
     extend Forwardable
 
     def_delegators :@definition, :==, :type, :type=, :pointer, :pointer=, :pointer?
 
     include GeneratorHelper
 
     # @param definition [RubyHeaderParser::TyperefDefinition]
-    def initialize(definition:, header_dir:)
+    def initialize(definition:)
       @definition = definition
-      @header_dir = header_dir
     end
 
     # @return [String]