ruby_header_parser 0.1.0

data/sig/ruby_header_parser/argument_definition.rbs

@@ -0,0 +1,14 @@
+module RubyHeaderParser
+  class ArgumentDefinition
+    attr_accessor type: String
+    attr_accessor name: String
+    attr_accessor pointer: :ref | :array | nil
+    attr_accessor length: Integer
+
+    def initialize: (type: String, name: String, pointer: (:ref | :array | :ref_array | :function | :sref | :str_array | :in_ref)?, ?length: Integer) -> void
+
+    def ==: (untyped other) -> bool
+
+    def pointer?: () -> bool
+  end
+end

data/sig/ruby_header_parser/config.rbs

@@ -0,0 +1,19 @@
+module RubyHeaderParser
+  class Config
+    attr_reader data: Hash[untyped, untyped]
+
+    def initialize: (String config_file) -> void
+
+    def function_arg_pointer_hint: (function_name: String, pos: Integer) -> (:ref | :array | :ref_array | :function | :sref | :str_array | :in_ref)
+
+    def function_self_pointer_hint: (String function_name) -> (:ref | :raw)
+
+    def should_generate_function?: (String function_name) -> bool
+
+    def should_generate_struct?: (String struct_name) -> bool
+
+    def should_generate_type?: (String type_name) -> bool
+
+    def should_generate_enum?: (String enum_name) -> bool
+  end
+end

data/sig/ruby_header_parser/enum_definition.rbs

@@ -0,0 +1,10 @@
+module RubyHeaderParser
+  class EnumDefinition
+    attr_accessor name: String
+    attr_accessor values: Array[String]
+
+    def initialize: (name: String, ?values: Array[String]) -> void
+
+    def ==: (untyped other) -> bool
+  end
+end

data/sig/ruby_header_parser/function_definition.rbs

@@ -0,0 +1,12 @@
+module RubyHeaderParser
+  class FunctionDefinition
+    attr_accessor name: String
+    attr_accessor definition: String
+    attr_accessor typeref: TyperefDefinition
+    attr_accessor args: Array[ArgumentDefinition]
+
+    def initialize: (name: String, definition: String, typeref: TyperefDefinition, args: Array[ArgumentDefinition]) -> void
+
+    def ==: (untyped other) -> bool
+  end
+end

data/sig/ruby_header_parser/parser.rbs

@@ -0,0 +1,84 @@
+module RubyHeaderParser
+  class Parser
+    attr_reader header_file: String
+    attr_reader include_paths: Array[String]
+    attr_reader dist_preprocessed_header_file: String
+    attr_reader config: Config
+
+    DEFAULT_HEADER_FILE: String
+    DEFAULT_INCLUDE_PATHS: Array[String]
+
+    def initialize: (
+        ?dist_preprocessed_header_file: String?,
+        ?header_file: String,
+        ?include_paths: Array[String],
+        ?config_file: String?
+      ) -> void
+
+    def extract_function_definitions: () -> Array[FunctionDefinition]
+
+    def extract_static_inline_function_definitions: () -> Array[FunctionDefinition]
+
+    def extract_struct_definitions: () -> Array[StructDefinition]
+
+    def extract_type_definitions: () -> Array[TyperefDefinition]
+
+    def extract_enum_definitions: () -> Array[EnumDefinition]
+
+    private
+
+    def __extract_function_definitions: (c_kinds: String, kind: String, is_parse_multiline_definition: bool) -> Array[FunctionDefinition]
+
+    def generate_function_definition_from_line: (line: String, kind: String, is_parse_multiline_definition: bool) -> FunctionDefinition?
+
+    def execute_ctags: (?String args) -> String
+
+    def read_definition_from_header_file: (String file, Integer line_num) -> String
+
+    def parse_function_definition: (
+        filepath: String,
+        pattern: String,
+        line_num: Integer,
+        is_parse_multiline_definition: bool
+      ) -> String
+
+    def parse_definition_args: (String function_name, String? signature) -> Array[ArgumentDefinition]
+
+    def create_typeref: (
+        definition: String,
+        function_name: String,
+        typeref_field: String?,
+        filepath: String,
+        line_num: Integer
+      ) -> TyperefDefinition
+
+    def parse_typeref_type: (
+        definition: String,
+        function_name: String,
+        typeref_field: String?,
+        filepath: String,
+        line_num: Integer
+      ) -> String
+
+    def read_file_line: (filepath: String, line_num: Integer) -> String?
+
+    def generate_argument_definition: (
+        function_name: String,
+        arg: String,
+        arg_pos: Integer
+      ) -> ArgumentDefinition
+
+    def analyze_argument_type: (
+        function_name: String,
+        arg_pos: Integer,
+        parts: Array[String]
+      ) -> [String, (:ref | :array | :ref_array | :function | :sref | :str_array | :in_ref)?, Integer]
+
+    def prepare_argument_parts: (
+        parts: Array[String],
+        arg_pos: Integer
+      ) -> [(:array)?, Integer]
+
+    def pointer_length: (String) -> Integer
+  end
+end

data/sig/ruby_header_parser/struct_definition.rbs

@@ -0,0 +1,9 @@
+module RubyHeaderParser
+  class StructDefinition
+    attr_accessor name: String
+
+    def initialize: (name: String) -> void
+
+    def ==: (untyped other) -> bool
+  end
+end

data/sig/ruby_header_parser/type_definition.rbs

@@ -0,0 +1,9 @@
+module RubyHeaderParser
+  class TypeDefinition
+    attr_accessor name: String
+
+    def initialize: (name: String) -> void
+
+    def ==: (untyped other) -> bool
+  end
+end

data/sig/ruby_header_parser/typeref_definition.rbs

@@ -0,0 +1,12 @@
+module RubyHeaderParser
+  class TyperefDefinition
+    attr_accessor type: String
+    attr_accessor pointer: :ref | :raw | nil
+
+    def initialize: (type: String, pointer: (:ref | :raw)?) -> void
+
+    def ==: (untyped other) -> bool
+
+    def pointer?: () -> bool
+  end
+end

data/sig/ruby_header_parser/util.rbs

@@ -0,0 +1,9 @@
+module RubyHeaderParser
+  module Util
+    def self.find_field: (Array[String] array, String field_name) -> String?
+
+    def self.split_signature: (String signature) -> Array[String]
+
+    def self.sanitize_type: (String type) -> String
+  end
+end

data/sig/ruby_header_parser.rbs

@@ -0,0 +1,7 @@
+module RubyHeaderParser
+  class Error < StandardError
+  end
+
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: ruby_header_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sue445
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-parameterized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-temp_dir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop_auto_corrector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Parser for ruby.h
+email:
+- sue445@sue445.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CONFIG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- config/default.yml
+- lib/ruby_header_parser.rb
+- lib/ruby_header_parser/argument_definition.rb
+- lib/ruby_header_parser/config.rb
+- lib/ruby_header_parser/enum_definition.rb
+- lib/ruby_header_parser/function_definition.rb
+- lib/ruby_header_parser/parser.rb
+- lib/ruby_header_parser/struct_definition.rb
+- lib/ruby_header_parser/type_definition.rb
+- lib/ruby_header_parser/typeref_definition.rb
+- lib/ruby_header_parser/util.rb
+- lib/ruby_header_parser/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig/ruby_header_parser.rbs
+- sig/ruby_header_parser/argument_definition.rbs
+- sig/ruby_header_parser/config.rbs
+- sig/ruby_header_parser/enum_definition.rbs
+- sig/ruby_header_parser/function_definition.rbs
+- sig/ruby_header_parser/parser.rbs
+- sig/ruby_header_parser/struct_definition.rbs
+- sig/ruby_header_parser/type_definition.rbs
+- sig/ruby_header_parser/typeref_definition.rbs
+- sig/ruby_header_parser/util.rbs
+homepage: https://github.com/sue445/ruby_header_parser
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sue445/ruby_header_parser
+  source_code_uri: https://github.com/sue445/ruby_header_parser
+  changelog_uri: https://github.com/sue445/ruby_header_parser/blob/main/CHANGELOG.md
+  documentation_uri: https://sue445.github.io/ruby_header_parser/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Parser for ruby.h
+test_files: []