tdparser 1.5.1 → 1.6.0

data/sig/tdparser.rbs

@@ -0,0 +1,334 @@
+module TDParser
+  ParserException: Class | singleton(RuntimeError)
+  VERSION: String
+  include BufferUtils
+
+  def rule: (untyped sym, *untyped opts) -> NonTerminalParser
+  def token: (untyped x, ?:=== eqsym) -> TerminalParser
+
+  def back_ref: (untyped x, ?:=== eqsym) -> BackrefParser
+  alias backref back_ref
+
+  def stack_ref: (untyped stack, ?:=== eqsym) -> StackrefParser
+  alias stackref stack_ref
+
+  def state: (untyped s) -> StateParser
+
+  def empty_rule: -> EmptyParser
+  alias empty empty_rule
+
+  def any_rule: -> AnyParser
+  alias any any_rule
+
+  def none_rule: -> NoneParser
+  alias none none_rule
+
+  def fail_rule: -> FailParser
+  alias fail fail_rule
+
+  def condition_rule: -> ConditionParser
+  alias condition condition_rule
+
+  def left_rec: (*untyped rules) -> FailParser
+  alias leftrec left_rec
+
+  def right_rec: (*untyped rules) -> FailParser
+  alias rightrec right_rec
+
+  def chain_left: (untyped base, *untyped infixes) -> untyped
+  alias chainl chain_left
+
+  def chain_right: (untyped base, *untyped infixes) -> untyped
+  alias chainr chain_right
+
+  def self.define: (*untyped _args) -> untyped
+
+  class Token
+    attr_accessor kind: untyped
+    attr_accessor value: String
+    def initialize: (untyped kind, String value) -> void
+    def ==: (untyped other) -> bool
+    def ===: (untyped other) -> true
+    def =~: (untyped other) -> untyped
+  end
+
+  class BasicStringTokenizer
+    @rule: untyped
+    @scan_pattern: Regexp
+    @ignore_pattern: Regexp?
+
+    def self.[]: (untyped rule, ?nil ignore) -> BasicStringTokenizer
+    def initialize: (untyped rule, ?Regexp? ignore) -> void
+    def generate: (untyped str) -> untyped
+  end
+
+  class StringTokenizer < BasicStringTokenizer
+    def initialize: (untyped rule, ?nil ignore) -> void
+  end
+
+  class WaitingTokenGenerator
+    @terminated: bool
+
+    def initialize: (*untyped args) -> void
+    def terminate: -> true
+    def shift: -> nil
+  end
+
+  module XMLParser
+    XMLTokenGenerator: singleton(XMLTokenGenerator) | singleton(XMLTokenGenerator)
+
+    def start_element: (?singleton(String) name) -> untyped
+    def end_element: (?singleton(String) name) -> untyped
+    def element: (?singleton(String) elem) -> untyped
+    def text: (?singleton(String) match) -> untyped
+    def pi: -> untyped
+    def cdata: (?singleton(String) match) -> untyped
+    def comment: (?singleton(String) match) -> untyped
+    def xmldecl: -> untyped
+    def start_doctype: (?singleton(String) name) -> untyped
+    def end_doctype: -> untyped
+    def doctype: (?singleton(String) name) -> untyped
+    def externalentity: (?singleton(String) entity) -> untyped
+    def elementdecl: (?singleton(String) elem) -> untyped
+    def entitydecl: (?singleton(String) _entity) -> untyped
+    def attlistdecl: (?singleton(String) _decl) -> untyped
+    def notationdecl: (?singleton(String) _decl) -> untyped
+    def any_node: -> untyped
+    def dom_constructor: -> untyped
+
+    class XArray < Array[untyped]
+      def ===: (untyped ary) -> bool
+    end
+
+    class XHash < Hash[untyped, untyped]
+      def ===: (untyped h) -> bool
+    end
+  end
+
+  class TokenGenerator
+    @enumerator: Enumerator[bot, bot]
+    @buffer: Array[untyped]
+
+    def initialize: (?nil args) -> void
+    def next: -> bot
+    def next?: -> false
+    def to_a: -> Array[untyped]
+    def shift: -> nil
+    def unshift: (*untyped token) -> Array[untyped]
+  end
+
+  class TokenBuffer
+    extend Forwardable
+    # include Enumerable # TODO: Somehow cause error.
+    @array: Array[untyped]
+
+    attr_accessor map: Hash[untyped, untyped]
+    attr_accessor state: untyped
+    def initialize: (*untyped args) -> void
+    def []: (untyped idx) -> nil
+    def []=: (untyped idx, untyped val) -> untyped
+    def clear: -> void
+    alias self.[] self.new
+  end
+
+  class Sequence < Array[untyped]
+    def +: (untyped other) -> Sequence
+  end
+
+  module BufferUtils
+    def prepare: (TokenBuffer? buff) -> TokenBuffer
+    def recover: (TokenBuffer? buff, untyped ts) -> TokenBuffer
+  end
+
+  class Parser
+    include TDParser
+    include BufferUtils
+    @tokens: nil
+
+    def to_proc: -> ^(*untyped) -> nil
+    def to_s: -> String
+    def call: (*TokenBuffer? args) -> nil
+    def optimize: (?false _default) -> Parser
+    def ==: ((ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser)? _other) -> false
+    def same?: ((ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser)? r) -> bool
+    def -: (ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser other) -> ConcatParser
+    def +: (ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser other) -> ParallelParser
+    def |: (untyped other) -> (ActionParser | ChoiceParser | ConcatParser | ParallelParser)
+    def *: (untyped other) -> IterationParser
+    def >>: (^(Array[untyped]) -> nil? other) -> ActionParser
+    def /: (untyped other) -> LabelParser
+    def %: (untyped other) -> StackParser
+    def >: (untyped other) -> Parser
+    def ~: -> NegativeParser
+    def parse: (?nil tokens, ?nil buff) -> nil
+    def peek: -> untyped
+    def do: -> ActionParser
+  end
+
+  class NonTerminalParser < Parser
+    attr_reader context: Grammar | TDParser
+    attr_reader symbol: untyped
+    attr_reader options: Array[untyped]
+    def initialize: (Grammar | TDParser context, untyped sym, *untyped options) -> void
+    def call: (untyped tokens, untyped buff) -> nil
+    def ==: (untyped other) -> bool
+    def to_s: -> untyped
+  end
+
+  class TerminalParser < Parser
+    attr_reader symbol: untyped
+    attr_reader equality: :===
+    def initialize: (untyped obj, :=== eqsym) -> void
+    def call: (untyped tokens, untyped buff) -> Array[untyped]?
+    def ==: (untyped other) -> bool
+    def to_s: -> untyped
+  end
+
+  class CompositeParser < Parser
+    attr_accessor parsers: Array[ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser]
+    def initialize: (*ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser parsers) -> void
+    def optimize: (?false default) -> (ActionParser | ChoiceParser | ConcatParser | ParallelParser)
+    def ==: ((ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser)? other) -> bool
+    def same?: ((ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser)? r) -> bool
+    def to_s: -> String
+  end
+
+  class ActionParser < CompositeParser
+    attr_reader action: ^(Array[untyped]) -> nil?
+    def initialize: (ConcatParser | Parser parser, ^(Array[untyped]) -> nil? act) -> void
+    def call: (untyped tokens, TokenBuffer? buff) -> Array[nil]?
+    def ==: ((ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser)? other) -> bool
+    def to_s: -> String
+  end
+
+  class LabelParser < CompositeParser
+    attr_reader label: untyped
+    def initialize: (Parser parser, untyped label) -> void
+    def call: (untyped tokens, untyped buff) -> Array[Array[nil]?]?
+    def ==: (untyped other) -> false
+    def to_s: -> String
+  end
+
+  class StackParser < CompositeParser
+    attr_reader stack: untyped
+    def initialize: (Parser parser, untyped stack) -> void
+    def call: (untyped tokens, untyped buff) -> Array[Array[nil]?]?
+    def ==: (untyped other) -> false
+    def same?: (untyped _r) -> false
+    def to_s: -> String
+  end
+
+  class ConcatParser < CompositeParser
+    def call: (untyped tokens, TokenBuffer? buff) -> Array[Array[nil]?]?
+    def -: (ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser other) -> ConcatParser
+    def to_s: -> String
+  end
+
+  class ChoiceParser < CompositeParser
+    def call: (untyped tokens, TokenBuffer? buff) -> Array[Array[nil]?]?
+    def to_s: -> String
+    def shared_sequence: (ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser r1, ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser r2) -> ([(ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser)?, ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser, ActionParser | ChoiceParser | ConcatParser | ParallelParser | Parser])
+    def optimize: (?bool default) -> (ActionParser | ChoiceParser | ConcatParser | ParallelParser)
+  end
+
+  class ParallelParser < CompositeParser
+    def call: (untyped tokens, TokenBuffer? buff) -> Array[Array[Array[untyped]?]]
+    def to_s: -> String
+  end
+
+  class IterationParser < CompositeParser
+    attr_reader min: untyped
+    attr_reader range: nil
+    def initialize: (Parser parser, untyped n, nil range) -> void
+    def call: (untyped ts, untyped buff) -> (Array[Array[(Array[untyped] | true)?]]?)
+    def to_s: -> String
+    def ==: (untyped other) -> bool
+  end
+
+  class NegativeParser < CompositeParser
+    def call: (untyped tokens, untyped buff) -> Array[Array[untyped]]?
+    def to_s: -> String
+  end
+
+  class FailParser < Parser
+    def call: (untyped _tokens, untyped _buff) -> nil
+    def to_s: -> String
+    def ==: -> bool
+  end
+
+  class EmptyParser < Parser
+    def call: (untyped _tokens, untyped _buff) -> Array[nil]
+    def to_s: -> String
+    def ==: (untyped _other) -> true
+  end
+
+  class AnyParser < Parser
+    def call: (untyped tokens, untyped _buff) -> Array[untyped]?
+    def to_s: -> String
+    def ==: (untyped _other) -> true
+  end
+
+  class NoneParser < Parser
+    def call: (untyped tokens, untyped _buff) -> Array[nil]?
+    def to_s: -> String
+    def ==: (untyped _other) -> true
+  end
+
+  class ReferenceParser < Parser
+    private
+
+    def back_ref: (untyped xs, :=== eqsym) -> untyped
+    alias __backref__ back_ref
+
+    def same?: (untyped _r) -> false
+  end
+
+  class BackrefParser < ReferenceParser
+    attr_reader label: untyped
+    attr_reader equality: :===
+    def initialize: (untyped label, :=== eqsym) -> void
+    def call: (untyped tokens, untyped buff) -> nil
+    def to_s: -> String
+    def ==: (untyped other) -> false
+  end
+
+  class StackrefParser < ReferenceParser
+    attr_reader stack: untyped
+    attr_reader equality: :===
+    def initialize: (untyped stack, :=== eqsym) -> void
+    def call: (untyped tokens, untyped buff) -> nil
+    def to_s: -> String
+    def ==: (untyped other) -> false
+  end
+
+  class ConditionParser < Parser
+    attr_reader condition: nil
+    def initialize: -> void
+    def call: (untyped _tokens, untyped buff) -> Array[untyped]?
+    def to_s: -> String
+    def ==: (untyped other) -> false
+    def same?: (untyped _r) -> false
+  end
+
+  class StateParser < Parser
+    attr_reader state: untyped
+    def initialize: (untyped s) -> void
+    def call: (untyped _tokens, untyped buff) -> Array[untyped]?
+    def to_s: -> String
+    def ==: (untyped other) -> false
+    def same?: (untyped _r) -> false
+  end
+
+  class Grammar
+    include TDParser
+
+    alias define instance_eval
+    def method_missing: (untyped sym, *untyped args) -> (NonTerminalParser | true)
+  end
+
+  class XMLTokenGenerator
+    @xparser: untyped
+
+    def initialize: (untyped src) -> void
+  end
+end

data/updoc

@@ -0,0 +1,11 @@
+#!/bin/sh
+set -eu
+tmp=$(mktemp -d)
+cp -r html/* "$tmp"
+pages=pages
+source=main
+git checkout $pages
+cp -r "$tmp"/* .
+git add .
+git commit -m "Update documentation."
+git checkout $source

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tdparser
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Takaaki Tateishi
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-10 00:00:00.000000000 Z
+date: 2024-11-17 00:00:00.000000000 Z
 dependencies: []
 description: TDParser (formerly TDP4R) is a top-down parser library that consists
   of parser combinators and utility functions.
@@ -30,6 +30,32 @@ files:
 - doc/faq.rdoc
 - doc/guide.rdoc
 - lib/tdparser.rb
+- lib/tdparser/action_parser.rb
+- lib/tdparser/any_parser.rb
+- lib/tdparser/backref_parser.rb
+- lib/tdparser/buffer_utils.rb
+- lib/tdparser/choice_parser.rb
+- lib/tdparser/composite_parser.rb
+- lib/tdparser/concat_parser.rb
+- lib/tdparser/condition_parser.rb
+- lib/tdparser/empty_parser.rb
+- lib/tdparser/fail_parser.rb
+- lib/tdparser/grammar.rb
+- lib/tdparser/iteration_parser.rb
+- lib/tdparser/label_parser.rb
+- lib/tdparser/negative_parser.rb
+- lib/tdparser/non_terminal_parser.rb
+- lib/tdparser/none_parser.rb
+- lib/tdparser/parallel_parser.rb
+- lib/tdparser/parser.rb
+- lib/tdparser/reference_parser.rb
+- lib/tdparser/sequence.rb
+- lib/tdparser/stack_parser.rb
+- lib/tdparser/stackref_parser.rb
+- lib/tdparser/state_parser.rb
+- lib/tdparser/terminal_parser.rb
+- lib/tdparser/token_buffer.rb
+- lib/tdparser/token_generator.rb
 - lib/tdparser/utils.rb
 - lib/tdparser/version.rb
 - lib/tdparser/xml.rb
@@ -43,6 +69,8 @@ files:
 - samples/sample_list.rb
 - samples/sample_optimize.rb
 - samples/sample_xml.rb
+- sig/tdparser.rbs
+- updoc
 homepage: https://git.disroot.org/gemmaro/tdparser
 licenses:
 - BSD-3-Clause
@@ -50,10 +78,10 @@ metadata:
   rubygems_mfa_required: 'true'
   bug_tracker_uri: https://git.disroot.org/gemmaro/tdparser/issues
   changelog_uri: https://git.disroot.org/gemmaro/tdparser/src/branch/main/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/tcepsni
+  documentation_uri: https://gemmaro.github.io/tdparser
   homepage_uri: https://git.disroot.org/gemmaro/tdparser
   source_code_uri: https://git.disroot.org/gemmaro/tdparser
-  wiki_uri: https://git.disroot.org/gemmaro/tdparser//wiki
+  wiki_uri: https://git.disroot.org/gemmaro/tdparser/wiki
 post_install_message:
 rdoc_options: []
 require_paths: