Copy from go-gem-wrapper

Author: sue445

.rubocop.yml

@@ -0,0 +1,83 @@
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+  SuggestExtensions: false
+
+  Exclude:
+    - "_benchmark/**/*"
+    - "ruby/testdata/example/vendor/**/*"
+
+    # ref. https://github.com/rubocop/rubocop/blob/v1.66.1/config/default.yml
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+
+Gemspec/RequireMFA:
+  Exclude:
+    - ruby/testdata/example/example.gemspec
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/SpaceAroundOperators:
+  Exclude:
+    # Suppress line breaks in spec files (e.g `it { should xxxx }`, `its(:method) { should xxxx }` )
+    - "**/*_spec.rb"
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Exclude:
+    - "**/*_spec.rb" # for rspec-parameterized
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/BlockLength:
+  Exclude:
+    - "*.gemspec"
+    - "**/*_spec.rb"
+
+Metrics/ClassLength:
+  Exclude:
+    - "**/*_test.rb"
+
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+Metrics/MethodLength:
+  Max: 28
+
+Metrics/PerceivedComplexity:
+  Max: 11
+
+Style/Documentation:
+  Exclude:
+    - "**/*_test.rb"
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

lib/ruby_header_parser.rb

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 require_relative "ruby_header_parser/version"
 
+# Parser for ruby.h
 module RubyHeaderParser
   class Error < StandardError; end
-  # Your code goes here...
+
+  autoload :ArgumentDefinition, "ruby_header_parser/argument_definition"
+  autoload :Data,               "ruby_header_parser/data"
+  autoload :EnumDefinition,     "ruby_header_parser/enum_definition"
+  autoload :FunctionDefinition, "ruby_header_parser/function_definition"
+  autoload :Parser,             "ruby_header_parser/parser"
+  autoload :StructDefinition,   "ruby_header_parser/struct_definition"
+  autoload :TypeDefinition,     "ruby_header_parser/type_definition"
+  autoload :TyperefDefinition,  "ruby_header_parser/typeref_definition"
+  autoload :Util,               "ruby_header_parser/util"
 end

lib/ruby_header_parser/argument_definition.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RubyHeaderParser
+  # argument definition for {RubyHeaderParser::FunctionDefinition}
+  class ArgumentDefinition
+    # @!attribute type
+    #   @return [String]
+    attr_accessor :type
+
+    # @!attribute name
+    #   @return [String]
+    attr_accessor :name
+
+    # @!attribute pointer
+    #   @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, :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 &&
+        length == other.length
+    end
+
+    # @return [Boolean]
+    def pointer?
+      !!pointer
+    end
+  end
+end

lib/ruby_header_parser/data.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module RubyHeaderParser
+  # Manager for `data.yml`
+  class Data
+    # @!attribute [r] data
+    #   @return [Hash]
+    attr_reader :data
+
+    def initialize
+      yaml = File.read(File.join(__dir__, "data.yml"))
+      @data = YAML.safe_load(yaml, aliases: true, permitted_classes: [Regexp])
+    end
+
+    # @param function_name [String]
+    # @param pos [Integer] arg position (1 origin)
+    # @return [Symbol] :ref, :array, :ref_array, :function, :sref, :str_array, :in_ref
+    def function_arg_pointer_hint(function_name:, pos:)
+      pointer_hint = data["function"]["pointer_hint"].dig(function_name, pos)
+      return pointer_hint.to_sym if pointer_hint
+
+      :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
+    # @param function_name [String]
+    # @return [Boolean]
+    def should_generate_function?(function_name)
+      return false if data["function"]["exclude_name"].any? { |format| format === function_name }
+
+      data["function"]["include_name"].any? { |format| format === function_name }
+    end
+
+    # Whether generate C struct to go
+    # @param struct_name [String]
+    # @return [Boolean]
+    def should_generate_struct?(struct_name)
+      return false if data["struct"]["exclude_name"].any? { |format| format === struct_name }
+
+      data["struct"]["include_name"].any? { |format| format === struct_name }
+    end
+
+    # Whether generate C type to go
+    # @param type_name [String]
+    # @return [Boolean]
+    def should_generate_type?(type_name)
+      return false if data["type"]["exclude_name"].any? { |format| format === type_name }
+
+      data["type"]["include_name"].any? { |format| format === type_name }
+    end
+
+    # Whether generate C enum to go
+    # @param enum_name [String]
+    # @return [Boolean]
+    def should_generate_enum?(enum_name)
+      return false if data["enum"]["exclude_name"].any? { |format| format === enum_name }
+
+      data["enum"]["include_name"].any? { |format| format === enum_name }
+    end
+
+    # rubocop:enable Style/CaseEquality
+  end
+end

lib/ruby_header_parser/data.yml

@@ -0,0 +1,170 @@
+function:
+  include_name:
+    - !ruby/regexp /^rb_/i
+    - !ruby/regexp /^rstring_/i
+
+  exclude_name:
+    # deprecated functions
+    - !ruby/regexp /^rb_check_safe_str$/i
+    - !ruby/regexp /^rb_clear_constant_cache$/i
+    - !ruby/regexp /^rb_clone_setup$/i
+    - !ruby/regexp /^rb_complex_polar$/i
+    - !ruby/regexp /^rb_data_object_alloc$/i
+    - !ruby/regexp /^rb_data_object_get_warning$/i
+    - !ruby/regexp /^rb_data_object_wrap_warning$/i
+    - !ruby/regexp /^rb_data_typed_object_alloc$/i
+    - !ruby/regexp /^rb_dup_setup$/i
+    - !ruby/regexp /^rb_gc_force_recycle$/i
+    - !ruby/regexp /^rb_iterate$/i
+    - !ruby/regexp /^rb_obj_infect$/i
+    - !ruby/regexp /^rb_obj_infect_raw$/i
+    - !ruby/regexp /^rb_obj_taint$/i
+    - !ruby/regexp /^rb_obj_taint_raw$/i
+    - !ruby/regexp /^rb_obj_taintable$/i
+    - !ruby/regexp /^rb_obj_tainted$/i
+    - !ruby/regexp /^rb_obj_tainted_raw$/i
+    - !ruby/regexp /^rb_scan_args_length_mismatch$/i
+    - !ruby/regexp /^rb_varargs_bad_length$/i
+
+    # internal functions in ruby.h
+    - rb_scan_args_bad_format
+
+    # internal macros
+    - !ruby/regexp /^rb_define_global_function_(m?[0-9]+|notimpl)$/i
+    - !ruby/regexp /^rb_define_method_(m?[0-9]+|notimpl)$/i
+    - !ruby/regexp /^rb_define_method_id_(m?[0-9]+|notimpl)$/i
+    - !ruby/regexp /^rb_define_module_function_(m?[0-9]+|notimpl)$/i
+    - !ruby/regexp /^rb_define_private_method_(m?[0-9]+|notimpl)$/i
+    - !ruby/regexp /^rb_define_protected_method_(m?[0-9]+|notimpl)$/i
+    - !ruby/regexp /^rb_define_singleton_method_(m?[0-9]+|notimpl)$/i
+
+    # 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
+
+    # Available only in certain platform
+    - !ruby/regexp /^rb_w32_/i
+
+    # FIXME: Workaround for "could not determine kind of name for C.rb_gc_unprotect_logging"
+    - rb_gc_unprotect_logging
+
+    # FIXME: Workaround for "could not determine kind of name for C.rb_iterate_deprecated"
+    - rb_iterate_deprecated
+
+    # FIXME: Workaround for "could not determine kind of name for C.rb_gc_guarded_ptr_val"
+    - rb_gc_guarded_ptr_val
+
+    # FIXME: Workaround for "cannot use _cgo2 (variable of type _Ctype_va_list) as *_Ctype_struct___va_list_tag value in argument to _Cfunc_rb_str_vcatf" on GitHub Actions (Ubuntu 22.04)
+    - rb_str_vcatf
+
+    # FIXME: Workaround for "cannot use _cgo4 (variable of type _Ctype_va_list) as *_Ctype_struct___va_list_tag value in argument to _Cfunc_rb_vrescue2" on GitHub Actions (Ubuntu 22.04)
+    - rb_vrescue2
+
+    # FIXME: Workaround for "cannot use _cgo1 (variable of type _Ctype_va_list) as *_Ctype_struct___va_list_tag value in argument to _Cfunc_rb_vsprintf" on GitHub Actions (Ubuntu 22.04)
+    - rb_vsprintf
+
+    # FIXME: Workaround for "undefined reference to `rb_class_descendants'" on GitHub Actions (Ubuntu 22.04)
+    - rb_class_descendants
+
+  pointer_hint:
+    RSTRING_PTR:
+      self: raw
+    rb_data_object_make:
+      4: sref
+    rb_data_typed_object_make:
+      3: sref
+    rb_define_global_function:
+      2: function
+    rb_define_method:
+      3: function
+    rb_define_method_id:
+      3: function
+    rb_define_module_function:
+      3: function
+    rb_define_private_method:
+      3: function
+    rb_define_protected_method:
+      3: function
+    rb_define_singleton_method:
+      3: function
+    rb_define_variable:
+      2: in_ref
+    rb_ensure:
+      1: function
+      3: function
+    rb_exec_recursive:
+      1: function
+    rb_exec_recursive_outer:
+      1: function
+    rb_exec_recursive_paired:
+      1: function
+    rb_exec_recursive_paired_outer:
+      1: function
+    rb_feature_provided:
+      2: sref
+    rb_find_file_ext:
+      2: str_array
+    rb_funcallv:
+      4: array
+    rb_funcallv_public:
+      4: array
+    rb_get_values_at:
+      5: function
+    rb_glob:
+      2: function
+    rb_hash_foreach:
+      2: function
+    rb_ivar_foreach:
+      2: function
+    rb_marshal_define_compat:
+      3: function
+      4: function
+    rb_mutex_synchronize:
+      2: function
+    rb_protect:
+      1: function
+    rb_rescue:
+      1: function
+      3: function
+    rb_scan_args_set:
+      10: ref_array
+    rb_set_end_proc:
+      1: function
+    rb_st_insert2:
+      4: function
+    rb_thread_call_with_gvl:
+      1: function
+    rb_thread_create:
+      1: function
+    rb_vrescue2:
+      1: function
+      3: function
+
+struct:
+  include_name:
+    - !ruby/regexp /^rb_/i
+    - re_registers
+
+  exclude_name:
+    - rb_data_type_struct
+
+type:
+  include_name:
+    - !ruby/regexp /^rb_/i
+    - !ruby/regexp /^st_/i
+    - ID
+    - VALUE
+    - regex_t
+    - OnigPosition
+    - pid_t
+    - off_t
+
+  exclude_name: []
+
+enum:
+  include_name:
+    - ruby_value_type
+    - rb_io_wait_readwrite
+
+  exclude_name: []