ruby_grammar_builder 0.0.1

data/lib/textmate_grammar/pattern_extensions/maybe.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# An optional pattern
+# for some pattern `p` this is equivalent to (?:p?)
+class MaybePattern < RepeatablePattern
+    #
+    # Construct a new MaybePattern
+    #
+    # @param [any] args arguments to pass to {PatternBase#initialize}
+    # @api private
+    #
+    # @see maybe
+    # @see PatternBase#maybe
+    def initialize(*args)
+        # run the normal pattern
+        super(*args)
+        # add quantifying options
+        @at_least = 0
+        @at_most = 1
+    end
+
+    # (see Pattern#quantifying_allowed?)
+    # @return [false]
+    def quantifying_allowed?
+        false
+    end
+
+    # (see PatternBase#do_get_to_s_name)
+    def do_get_to_s_name(top_level)
+        top_level ? "maybe(" : ".maybe("
+    end
+end
+
+class PatternBase
+    #
+    # Optionally match pattern
+    #
+    # @param [PatternBase,Regexp,String,Hash] pattern a pattern to optionally match
+    #
+    # @return [PatternBase] a pattern to append to
+    #
+    def maybe(pattern)
+        insert(MaybePattern.new(pattern))
+    end
+end
+
+# (see PatternBase#maybe)
+def maybe(pattern)
+    MaybePattern.new(pattern)
+end

data/lib/textmate_grammar/pattern_extensions/one_of.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+# Provides alternation
+# when one of the passed in patterns is accepted, this pattern is accepted
+class OneOfPattern < PatternBase
+    # create a new OneOfPattern
+    # this is expects an array of patterns
+
+    #
+    # Create a new OneOfPattern
+    #
+    # @param [Array<PatternBase,Regexp,String>] patterns a list of patterns to match
+    #
+    def initialize(patterns, deep_clone = nil, original_arguments = nil)
+        if deep_clone == :deep_clone
+            super(patterns, deep_clone, original_arguments)
+            return
+        end
+        unless patterns.is_a? Array
+            raise <<-HEREDOC.remove_indent
+                oneOf() expects an array of patterns, the provided argument is not an array.
+                The arguments to oneOf is below
+                #{patterns}
+            HEREDOC
+        end
+        super(
+            match: "one of",
+            patterns: patterns.map do |pattern|
+                next pattern if pattern.is_a? PatternBase
+
+                PatternBase.new(pattern)
+            end
+        )
+    end
+
+    # (see PatternBase#do_evaluate_self)
+    def do_evaluate_self(groups)
+        patterns_strings = @arguments[:patterns].map do |pattern|
+            regex = pattern.evaluate(groups)
+            next regex if pattern.single_entity?
+
+            "(?:#{regex})"
+        end
+
+        return "(#{patterns_strings.join '|'})" if needs_to_capture?
+
+        "(?:#{patterns_strings.join '|'})"
+    end
+
+    # (see PatternBase#do_collect_self_groups)
+    def do_collect_self_groups(next_group)
+        groups = []
+        @arguments[:patterns].each do |pattern|
+            pat_groups = pattern.collect_group_attributes(next_group)
+            groups.concat(pat_groups)
+            next_group += pat_groups.length
+        end
+        groups
+    end
+
+    # (see PatternBase#single_entity?)
+    # @return [true]
+    def single_entity?
+        true
+    end
+
+    # (see PatternBase#map!)
+    def map!(map_includes = false, &block)
+        @arguments[:patterns].map! { |p| p.map!(map_includes, &block) }
+        @next_pattern.map!(map_includes, &block) if @next_pattern.is_a? PatternBase
+        map_includes!(&block) if map_includes
+        self
+    end
+
+    # (see PatternBase#to_s)
+    def to_s(depth = 0, top_level = true)
+        indent = "  " * depth
+        output = top_level ? "oneOf([" : ".oneOf(["
+        output += "\n#{indent}  "
+        output += (@arguments[:patterns].map do |pattern|
+            pattern.to_s(depth + 1, true).lstrip
+        end).join ",\n#{indent}  "
+        output += "\n#{indent}])"
+        output += @next_pattern.to_s(depth, false).lstrip if @next_pattern
+        output
+    end
+end
+
+class PatternBase
+    #
+    # Match one of the supplied patterns
+    #
+    # @param [Array<PatternBase,Regexp,String>] patterns a list of patterns to match
+    #
+    # @return [PatternBase] a pattern to append to
+    #
+    def oneOf(patterns)
+        insert(OneOfPattern.new(patterns))
+    end
+end
+
+#
+# (see PatternBase#oneOf)
+#
+def oneOf(patterns)
+    OneOfPattern.new(patterns)
+end

data/lib/textmate_grammar/pattern_extensions/one_or_more_of.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# An optional repeated pattern
+# for some pattern `p` this is equivalent to (?:p+)
+class OneOrMoreOfPattern < RepeatablePattern
+    def initialize(*args)
+        # run the normal pattern
+        super(*args)
+        # add quantifying options
+        @at_least = 1
+        @at_most = nil
+    end
+
+    # (see Pattern#quantifying_allowed?)
+    # @return [false]
+    def quantifying_allowed?
+        false
+    end
+
+    # (see PatternBase#do_get_to_s_name)
+    def do_get_to_s_name(top_level)
+        top_level ? "oneOrMoreOf(" : ".oneOrMoreOf("
+    end
+end
+
+class PatternBase
+    #
+    # Match pattern one or more times
+    #
+    # @param [PatternBase,Regexp,String,Hash] pattern a pattern to match
+    #
+    # @return [PatternBase] a pattern to append to
+    #
+    def oneOrMoreOf(pattern)
+        insert(OneOrMoreOfPattern.new(pattern))
+    end
+end
+
+# (see PatternBase#oneOrMoreOf)
+def oneOrMoreOf(pattern)
+    OneOrMoreOfPattern.new(pattern)
+end

data/lib/textmate_grammar/pattern_extensions/or_pattern.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative '../regex_operators/alternation'
+
+# Provides alternation
+# Either the previous pattern or provided pattern is accepted
+# @note OneOfPattern is likely just as powerful and less confusing
+class OrPattern < PatternBase
+    #
+    # (see PatternBase#evaluate_operator)
+    #
+    # @return [AlternationOperator] the alternation operator
+    #
+    def evaluate_operator
+        AlternationOperator.new
+    end
+
+    #
+    # Raises an error to prevent use as initial type
+    #
+    # @param _ignored ignored
+    #
+    # @return [void]
+    #
+    def evaluate(*_ignored)
+        raise "evaluate is not implemented for OrPattern"
+    end
+
+    # (see PatternBase#do_get_to_s_name)
+    def do_get_to_s_name(top_level)
+        top_level ? "or(" : ".or("
+    end
+
+    # (see PatternBase#single_entity?)
+    # @return [true]
+    def single_entity?
+        true
+    end
+end
+
+class PatternBase
+    #
+    # Match either the preceding pattern chain or pattern
+    #
+    # @param [PatternBase,Regexp,String,Hash] pattern a pattern to match
+    #   instead of the previous chain
+    #
+    # @return [PatternBase] a pattern to append to
+    #
+    def or(pattern)
+        insert(OrPattern.new(pattern))
+    end
+end
+
+# or does not have a top level option

data/lib/textmate_grammar/pattern_extensions/placeholder.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+#
+# Implements using a pattern that has not been defined
+#
+class PlaceholderPattern < PatternBase
+    #
+    # Constructs a new placeholder pattern
+    # @overload initialize(placeholder)
+    #   @param [Symbol] placeholder the name to replace with
+    #
+    # @overload initialize(opts, deep_clone, original)
+    #   @param (see PatternBase#initialize)
+    #
+    def initialize(placeholder, deep_clone = nil, original_arguments = nil)
+        if deep_clone == :deep_clone
+            super(placeholder, deep_clone, original_arguments)
+        else
+            super(
+                match: Regexp.new("placeholder(?##{placeholder})"),
+                placeholder: placeholder
+            )
+        end
+    end
+
+    # (see PatternBase#to_s)
+    def to_s(depth = 0, top_level = true)
+        return super unless @match == "placeholder"
+
+        output = top_level ? "placeholder(" : ".placeholder("
+        output += ":#{@arguments[:placeholder]})"
+        output += @next_pattern.to_s(depth, false).lstrip if @next_pattern
+        output
+    end
+
+    # (see PatternBase#to_tag)
+    # @note this raises a runtime error if the pattern has not been resolved
+    def to_tag
+        if @match.is_a?(String) && @match.start_with?("placeholder")
+            placeholder = @arguments[:placeholder]
+            raise "Attempting to create a tag from an unresolved placeholder `:#{placeholder}'"
+        end
+
+        super()
+    end
+
+    # (see PatternBase#evaluate)
+    # @note this raises a runtime error if the pattern has not been resolved
+    def evaluate(groups = nil)
+        if @match.is_a?(String) && @match.start_with?("placeholder")
+            raise "Attempting to evaluate an unresolved placeholder `:#{@arguments[:placeholder]}'"
+        end
+
+        super(groups)
+    end
+
+    #
+    # Resolves the placeholder
+    #
+    # @param [Hash] repository the repository to use to resolve the placeholder
+    #
+    # @return [self]
+    #
+    def resolve!(repository)
+        unless repository[@arguments[:placeholder]].is_a? PatternBase
+            raise ":#{@arguments[:placeholder]} is not a pattern and cannot be substituted"
+        end
+
+        @match = repository[@arguments[:placeholder]].__deep_clone__
+        self
+        # repository[@arguments[:placeholder]].resolve(repository)
+    end
+end
+
+class PatternBase
+    #
+    # Match a pattern that does not exist yet
+    #
+    # @param [Symbol] placeholder the name of the pattern to match
+    #
+    # @return [PatternBase] a pattern to append to
+    #
+    def placeholder(placeholder)
+        insert(PlaceholderPattern.new(placeholder))
+    end
+
+    #
+    # Resolves any placeholder patterns
+    #
+    # @param [Hash] repository the repository to resolve patterns with
+    #
+    # @return [PatternBase] a copy of self with placeholders resolved
+    #
+    def resolve(repository)
+        __deep_clone__.map!(true) { |s| s.resolve!(repository) if s.respond_to? :resolve! }.freeze
+    end
+end
+
+# (see PatternBase#placeholder)
+def placeholder(placeholder)
+    PlaceholderPattern.new(placeholder)
+end

data/lib/textmate_grammar/pattern_extensions/recursively_match.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+#
+# Implements subexp calls
+# for some group N whose reference is "foo"
+# recursivelyMatch("foo") results in the pattern /\gN/
+#
+class RecursivelyMatchPattern < PatternBase
+    def initialize(reference, deep_clone = nil, original_arguments = nil)
+        if reference.is_a? String
+            super(
+                match: Regexp.new("(?#[:subroutine:#{reference}:])"),
+                subroutine_key: reference
+            )
+        else
+            # most likely __deep_clone__ was called, just call the super initializer
+            super(reference, deep_clone, original_arguments)
+        end
+    end
+
+    # (see PatternBase#to_s)
+    def to_s(depth = 0, top_level = true)
+        output = top_level ? "recursivelyMatch(" : ".recursivelyMatch("
+        output += "\"#{@arguments[:subroutine_key]}\")"
+        output += @next_pattern.to_s(depth, false).lstrip if @next_pattern
+        output
+    end
+
+    # (see PatternBase#single_entity?)
+    # @return [true]
+    def single_entity?
+        true
+    end
+
+    # (see PatternBase#self_scramble_references)
+    def self_scramble_references
+        scramble = lambda do |name|
+            return name if name.start_with?("__scrambled__")
+
+            "__scrambled__" + name
+        end
+
+        key = @arguments[:subroutine_key]
+        scrambled = scramble.call(key)
+
+        @match = @match.sub(key, scrambled)
+        @arguments[:subroutine_key] = scrambled
+    end
+
+    #
+    # RecursivelyMatchPattern can cause its capture groups to be rematched
+    #
+    # @return [true] rematching is possible
+    #
+    def self_capture_group_rematch
+        true
+    end
+end
+
+class PatternBase
+    #
+    # Recursively match some outer pattern
+    #
+    # @param [String] reference a reference to an outer pattern
+    #
+    # @return [PatternBase] a PatternBase to append to
+    #
+    def recursivelyMatch(reference)
+        insert(RecursivelyMatchPattern.new(reference))
+    end
+end
+
+# (see PatternBase#recursivelyMatch)
+def recursivelyMatch(reference)
+    RecursivelyMatchPattern.new(reference)
+end

data/lib/textmate_grammar/pattern_extensions/zero_or_more_of.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# An repeated pattern
+# for some pattern `p` this is equivalent to (?:p*)
+class ZeroOrMoreOfPattern < RepeatablePattern
+    #
+    # Construct a new ZeroOrMoreOfPattern
+    #
+    # @param [any] args arguments to pass to {PatternBase#initialize}
+    # @api private
+    #
+    # @see zeroOrMoreOf
+    # @see PatternBase#zeroOrMoreOf
+    def initialize(*args)
+        # run the normal pattern
+        super(*args)
+        # add quantifying options
+        @at_least = 0
+        @at_most = nil
+    end
+
+    # (see Pattern#quantifying_allowed?)
+    # @return [false]
+    def quantifying_allowed?
+        false
+    end
+
+    # (see PatternBase#do_get_to_s_name)
+    def do_get_to_s_name(top_level)
+        top_level ? "zeroOrMoreOf(" : ".zeroOrMoreOf("
+    end
+end
+
+class PatternBase
+    #
+    # Match pattern zero or more times
+    #
+    # @param [PatternBase,Regexp,String,Hash] pattern a pattern to match
+    #
+    # @return [PatternBase] a pattern to append to
+    #
+    def zeroOrMoreOf(pattern)
+        insert(ZeroOrMoreOfPattern.new(pattern))
+    end
+end
+
+# (see PatternBase#zeroOrMoreOf)
+def zeroOrMoreOf(pattern)
+    ZeroOrMoreOfPattern.new(pattern)
+end