Breccia.parser/PatternMatcher.java at reluk.ca · Michael-Allan/Breccia.parser · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
package Breccia.parser;


       @TagName("PatternMatcher") @DataReflector
public interface PatternMatcher extends Granum {


    /** The series of match modifiers, or null if none is present.
      */
    public @TagName("MatchModifiers") Granum matchModifiers();


    /** Among the potential components of the pattern are the following.<ul>
      *
      *     <li>`{@linkplain AnchoredPrefix      AnchoredPrefix}`</li>
      *     <li>`{@linkplain BackslashedSpecial  BackslashedSpecial}`</li>
      *     <li>`{@linkplain GroupDelimiter      GroupDelimiter}`</li>
      *     <li>`{@linkplain Literalizer         Literalizer}`</li>
      *     <li>`{@linkplain Metacharacter       Metacharacter}`</li></ul>
      */
    public @TagName("Pattern") Granum pattern();


   // ━━━  G r a n u m  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


    /** The default implementation returns ‘PatternMatcher’.
      */
    public default @Override String tagName() { return "PatternMatcher"; }


   // ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀


    /** An achored prefix within a regular-expression pattern, one of ‘^*’,  ‘^+’ or  ‘^^’.
      *
      */          @TagName("AnchoredPrefix") @DataReflector
    public static interface AnchoredPrefix extends Granum {


       // ━━━  G r a n u m  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


        /** The default implementation returns ‘AnchoredPrefix’.
          */
        public default @Override String tagName() { return "AnchoredPrefix"; }}


   // ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀


    /** A ‘backslash sequence’, a sequence commencing with a backslash that has special meaning
      * in a regular-expression pattern.
      *
      *     @see <a href='https://perldoc.perl.org/perlrebackslash#The-backslash'>The backslash</a>
      *     @see Literalizer
      *
      */          @TagName("BackslashedSpecial") @DataReflector
    public static interface BackslashedSpecial extends Granum {


       // ━━━  G r a n u m  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


        /** The default implementation returns ‘BackslashedSpecial’.
          */
        public default @Override String tagName() { return "BackslashedSpecial"; }}


   // ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀


    /** A group delimiter within a regular-expression pattern, one of ‘(’, ‘(?:’ or ‘)’.
      *
      */          @TagName("GroupDelimiter") @DataReflector
    public static interface GroupDelimiter extends Granum {


       // ━━━  G r a n u m  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


        /** The default implementation returns ‘GroupDelimiter’.
          */
        public default @Override String tagName() { return "GroupDelimiter"; }}


   // ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀


    /** A literalizing backslash within a regular-expression pattern, one that
      * ‘takes away [any] special meaning of the character following it’.
      *
      *     @see <a href='https://perldoc.perl.org/perlrebackslash#The-backslash'>The backslash</a>
      *     @see BackslashedSpecial
      *
      */          @TagName("Literalizer") @DataReflector
    public static interface Literalizer extends Granum {


       // ━━━  G r a n u m  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


        /** The default implementation returns ‘Literalizer’.
          */
        public default @Override String tagName() { return "Literalizer"; }}


   // ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀


    /** A metacharacter within a regular-expression pattern.
      *
      *     @see <a href='https://perldoc.perl.org/perlre#Metacharacters'>Metacharacters</a>
      *
      */          @TagName("Metacharacter") @DataReflector
    public static interface Metacharacter extends Granum {


       // ━━━  G r a n u m  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


        /** The default implementation returns ‘Metacharacter’.
          */
        public default @Override String tagName() { return "Metacharacter"; }}


   // ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀


    /** A variable interpolator `${⋯}` within a regular-expression pattern.
      *
      */          @TagName("Variable") @DataReflector
    public static interface Variable extends Granum {


       // ━━━  G r a n u m  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━


        /** The default implementation returns ‘Variable’.
          */
        public default @Override String tagName() { return "Variable"; }}}


                                                        // Copyright © 2022  Michael Allan.  Licence MIT.