-=head2 Types of nodes
-
-Here are the possible types, with short descriptions:
-
- # TYPE arg-description [num-args] [longjump-len] DESCRIPTION
-
- # Exit points
- END no End of program.
- SUCCEED no Return from a subroutine, basically.
-
- # Anchors:
- BOL no Match "" at beginning of line.
- MBOL no Same, assuming multiline.
- SBOL no Same, assuming singleline.
- EOS no Match "" at end of string.
- EOL no Match "" at end of line.
- MEOL no Same, assuming multiline.
- SEOL no Same, assuming singleline.
- BOUND no Match "" at any word boundary
- BOUNDL no Match "" at any word boundary
- NBOUND no Match "" at any word non-boundary
- NBOUNDL no Match "" at any word non-boundary
- GPOS no Matches where last m//g left off.
-
- # [Special] alternatives
- ANY no Match any one character (except newline).
- SANY no Match any one character.
- ANYOF sv Match character in (or not in) this class.
- ALNUM no Match any alphanumeric character
- ALNUML no Match any alphanumeric char in locale
- NALNUM no Match any non-alphanumeric character
- NALNUML no Match any non-alphanumeric char in locale
- SPACE no Match any whitespace character
- SPACEL no Match any whitespace char in locale
- NSPACE no Match any non-whitespace character
- NSPACEL no Match any non-whitespace char in locale
- DIGIT no Match any numeric character
- NDIGIT no Match any non-numeric character
-
- # BRANCH The set of branches constituting a single choice are hooked
- # together with their "next" pointers, since precedence prevents
- # anything being concatenated to any individual branch. The
- # "next" pointer of the last BRANCH in a choice points to the
- # thing following the whole choice. This is also where the
- # final "next" pointer of each individual branch points; each
- # branch starts with the operand node of a BRANCH node.
- #
- BRANCH node Match this alternative, or the next...
-
- # BACK Normal "next" pointers all implicitly point forward; BACK
- # exists to make loop structures possible.
- # not used
- BACK no Match "", "next" ptr points backward.
-
- # Literals
- EXACT sv Match this string (preceded by length).
- EXACTF sv Match this string, folded (prec. by length).
- EXACTFL sv Match this string, folded in locale (w/len).
-
- # Do nothing
- NOTHING no Match empty string.
- # A variant of above which delimits a group, thus stops optimizations
- TAIL no Match empty string. Can jump here from outside.
-
- # STAR,PLUS '?', and complex '*' and '+', are implemented as circular
- # BRANCH structures using BACK. Simple cases (one character
- # per match) are implemented with STAR and PLUS for speed
- # and to minimize recursive plunges.
- #
- STAR node Match this (simple) thing 0 or more times.
- PLUS node Match this (simple) thing 1 or more times.
-
- CURLY sv 2 Match this simple thing {n,m} times.
- CURLYN no 2 Match next-after-this simple thing
- # {n,m} times, set parens.
- CURLYM no 2 Match this medium-complex thing {n,m} times.
- CURLYX sv 2 Match this complex thing {n,m} times.
-
- # This terminator creates a loop structure for CURLYX
- WHILEM no Do curly processing and see if rest matches.
-
- # OPEN,CLOSE,GROUPP ...are numbered at compile time.
- OPEN num 1 Mark this point in input as start of #n.
- CLOSE num 1 Analogous to OPEN.
-
- REF num 1 Match some already matched string
- REFF num 1 Match already matched string, folded
- REFFL num 1 Match already matched string, folded in loc.
-
- # grouping assertions
- IFMATCH off 1 2 Succeeds if the following matches.
- UNLESSM off 1 2 Fails if the following matches.
- SUSPEND off 1 1 "Independent" sub-regex.
- IFTHEN off 1 1 Switch, should be preceded by switcher .
- GROUPP num 1 Whether the group matched.
-
- # Support for long regex
- LONGJMP off 1 1 Jump far away.
- BRANCHJ off 1 1 BRANCH with long offset.
-
- # The heavy worker
- EVAL evl 1 Execute some Perl code.
-
- # Modifiers
- MINMOD no Next operator is not greedy.
- LOGICAL no Next opcode should set the flag only.
-
- # This is not used yet
- RENUM off 1 1 Group with independently numbered parens.
-
- # This is not really a node, but an optimized away piece of a "long" node.
- # To simplify debugging output, we mark it as if it were a node
- OPTIMIZED off Placeholder for dump.
+=head2 Types of Nodes
+
+Here are the current possible types, with short descriptions:
+
+=for comment
+This table is generated by regen/regcomp.pl. Any changes made here
+will be lost.
+
+=for regcomp.pl begin
+
+ # TYPE arg-description [num-args] [longjump-len] DESCRIPTION
+
+ # Exit points
+
+ END no End of program.
+ SUCCEED no Return from a subroutine, basically.
+
+ # Line Start Anchors:
+ SBOL no Match "" at beginning of line: /^/, /\A/
+ MBOL no Same, assuming multiline: /^/m
+
+ # Line End Anchors:
+ SEOL no Match "" at end of line: /$/
+ MEOL no Same, assuming multiline: /$/m
+ EOS no Match "" at end of string: /\z/
+
+ # Match Start Anchors:
+ GPOS no Matches where last m//g left off.
+
+ # Word Boundary Opcodes:
+ BOUND no Like BOUNDA for non-utf8, otherwise match
+ "" between any Unicode \w\W or \W\w
+ BOUNDL no Like BOUND/BOUNDU, but \w and \W are
+ defined by current locale
+ BOUNDU no Match "" at any boundary of a given type
+ using Unicode rules
+ BOUNDA no Match "" at any boundary between \w\W or
+ \W\w, where \w is [_a-zA-Z0-9]
+ NBOUND no Like NBOUNDA for non-utf8, otherwise match
+ "" between any Unicode \w\w or \W\W
+ NBOUNDL no Like NBOUND/NBOUNDU, but \w and \W are
+ defined by current locale
+ NBOUNDU no Match "" at any non-boundary of a given
+ type using using Unicode rules
+ NBOUNDA no Match "" betweeen any \w\w or \W\W, where
+ \w is [_a-zA-Z0-9]
+
+ # [Special] alternatives:
+ REG_ANY no Match any one character (except newline).
+ SANY no Match any one character.
+ ANYOF sv Match character in (or not in) this class,
+ charclass single char match only
+ ANYOFD sv Like ANYOF, but /d is in effect
+ charclass
+ ANYOFL sv Like ANYOF, but /l is in effect
+ charclass
+ ANYOFPOSIXL sv Like ANYOFL, but matches [[:posix:]]
+ charclass_ classes
+ posixl
+ ANYOFH sv 1 Like ANYOF, but only has "High" matches,
+ none in the bitmap
+ ANYOFM byte 1 Like ANYOF, but matches an invariant byte
+ as determined by the mask and arg
+ NANYOFM byte 1 complement of ANYOFM
+
+ # POSIX Character Classes:
+ POSIXD none Some [[:class:]] under /d; the FLAGS field
+ gives which one
+ POSIXL none Some [[:class:]] under /l; the FLAGS field
+ gives which one
+ POSIXU none Some [[:class:]] under /u; the FLAGS field
+ gives which one
+ POSIXA none Some [[:class:]] under /a; the FLAGS field
+ gives which one
+ NPOSIXD none complement of POSIXD, [[:^class:]]
+ NPOSIXL none complement of POSIXL, [[:^class:]]
+ NPOSIXU none complement of POSIXU, [[:^class:]]
+ NPOSIXA none complement of POSIXA, [[:^class:]]
+
+ CLUMP no Match any extended grapheme cluster
+ sequence
+
+ # Alternation
+
+ # BRANCH The set of branches constituting a single choice are
+ # hooked together with their "next" pointers, since
+ # precedence prevents anything being concatenated to
+ # any individual branch. The "next" pointer of the last
+ # BRANCH in a choice points to the thing following the
+ # whole choice. This is also where the final "next"
+ # pointer of each individual branch points; each branch
+ # starts with the operand node of a BRANCH node.
+ #
+ BRANCH node Match this alternative, or the next...
+
+ # Literals
+
+ EXACT str Match this string (preceded by length).
+ EXACTL str Like EXACT, but /l is in effect (used so
+ locale-related warnings can be checked
+ for).
+ EXACTF str Match this string using /id rules (w/len);
+ (string not UTF-8, not guaranteed to be
+ folded).
+ EXACTFL str Match this string using /il rules (w/len);
+ (string not guaranteed to be folded).
+ EXACTFU str Match this string using /iu rules (w/len);
+ (string folded iff in UTF-8; non-UTF8
+ folded length <= unfolded).
+ EXACTFAA str Match this string using /iaa rules (w/len)
+ (string folded iff in UTF-8; non-UTF8
+ folded length <= unfolded).
+
+ EXACTFUP str Match this string using /iu rules (w/len);
+ (string not UTF-8, not guaranteed to be
+ folded; and its Problematic).
+
+ EXACTFLU8 str Like EXACTFU, but use /il, UTF-8, folded,
+ and everything in it is above 255.
+ EXACTFAA_NO_TRIE str Match this string using /iaa rules (w/len)
+ (string not UTF-8, not guaranteed to be
+ folded, not currently trie-able).
+
+ EXACT_ONLY8 str Like EXACT, but only UTF-8 encoded targets
+ can match
+ EXACTFU_ONLY8 str Like EXACTFU, but only UTF-8 encoded
+ targets can match
+
+ EXACTFU_S_EDGE str /di rules, but nothing in it precludes /ui,
+ except begins and/or ends with [Ss];
+ (string not UTF-8; compile-time only).
+
+ # Do nothing types
+
+ NOTHING no Match empty string.
+ # A variant of above which delimits a group, thus stops optimizations
+ TAIL no Match empty string. Can jump here from
+ outside.
+
+ # Loops
+
+ # STAR,PLUS '?', and complex '*' and '+', are implemented as
+ # circular BRANCH structures. Simple cases
+ # (one character per match) are implemented with STAR
+ # and PLUS for speed and to minimize recursive plunges.
+ #
+ STAR node Match this (simple) thing 0 or more times.
+ PLUS node Match this (simple) thing 1 or more times.
+
+ CURLY sv 2 Match this simple thing {n,m} times.
+ CURLYN no 2 Capture next-after-this simple thing
+ CURLYM no 2 Capture this medium-complex thing {n,m}
+ times.
+ CURLYX sv 2 Match this complex thing {n,m} times.
+
+ # This terminator creates a loop structure for CURLYX
+ WHILEM no Do curly processing and see if rest
+ matches.
+
+ # Buffer related
+
+ # OPEN,CLOSE,GROUPP ...are numbered at compile time.
+ OPEN num 1 Mark this point in input as start of #n.
+ CLOSE num 1 Close corresponding OPEN of #n.
+ SROPEN none Same as OPEN, but for script run
+ SRCLOSE none Close preceding SROPEN
+
+ REF num 1 Match some already matched string
+ REFF num 1 Match already matched string, folded using
+ native charset rules for non-utf8
+ REFFL num 1 Match already matched string, folded in
+ loc.
+ REFFU num 1 Match already matched string, folded using
+ unicode rules for non-utf8
+ REFFA num 1 Match already matched string, folded using
+ unicode rules for non-utf8, no mixing
+ ASCII, non-ASCII
+
+ # Named references. Code in regcomp.c assumes that these all are after
+ # the numbered references
+ NREF no-sv 1 Match some already matched string
+ NREFF no-sv 1 Match already matched string, folded using
+ native charset rules for non-utf8
+ NREFFL no-sv 1 Match already matched string, folded in
+ loc.
+ NREFFU num 1 Match already matched string, folded using
+ unicode rules for non-utf8
+ NREFFA num 1 Match already matched string, folded using
+ unicode rules for non-utf8, no mixing
+ ASCII, non-ASCII
+
+ # Support for long RE
+ LONGJMP off 1 1 Jump far away.
+ BRANCHJ off 1 1 BRANCH with long offset.
+
+ # Special Case Regops
+ IFMATCH off 1 1 Succeeds if the following matches; non-zero
+ flags "f" means lookbehind assertion
+ starting "f" characters before current
+ UNLESSM off 1 1 Fails if the following matches; non-zero
+ flags "f" means lookbehind assertion
+ starting "f" characters before current
+ SUSPEND off 1 1 "Independent" sub-RE.
+ IFTHEN off 1 1 Switch, should be preceded by switcher.
+ GROUPP num 1 Whether the group matched.
+
+ # The heavy worker
+
+ EVAL evl/flags Execute some Perl code.
+ 2L
+
+ # Modifiers
+
+ MINMOD no Next operator is not greedy.
+ LOGICAL no Next opcode should set the flag only.
+
+ # This is not used yet
+ RENUM off 1 1 Group with independently numbered parens.
+
+ # Trie Related
+
+ # Behave the same as A|LIST|OF|WORDS would. The '..C' variants
+ # have inline charclass data (ascii only), the 'C' store it in the
+ # structure.
+
+ TRIE trie 1 Match many EXACT(F[ALU]?)? at once.
+ flags==type
+ TRIEC trie Same as TRIE, but with embedded charclass
+ charclass data
+
+ AHOCORASICK trie 1 Aho Corasick stclass. flags==type
+ AHOCORASICKC trie Same as AHOCORASICK, but with embedded
+ charclass charclass data
+
+ # Regex Subroutines
+ GOSUB num/ofs 2L recurse to paren arg1 at (signed) ofs arg2
+
+ # Special conditionals
+ NGROUPP no-sv 1 Whether the group matched.
+ INSUBP num 1 Whether we are in a specific recurse.
+ DEFINEP none 1 Never execute directly.
+
+ # Backtracking Verbs
+ ENDLIKE none Used only for the type field of verbs
+ OPFAIL no-sv 1 Same as (?!), but with verb arg
+ ACCEPT no-sv/num Accepts the current matched string, with
+ 2L verbar
+
+ # Verbs With Arguments
+ VERB no-sv 1 Used only for the type field of verbs
+ PRUNE no-sv 1 Pattern fails at this startpoint if no-
+ backtracking through this
+ MARKPOINT no-sv 1 Push the current location for rollback by
+ cut.
+ SKIP no-sv 1 On failure skip forward (to the mark)
+ before retrying
+ COMMIT no-sv 1 Pattern fails outright if backtracking
+ through this
+ CUTGROUP no-sv 1 On failure go to the next alternation in
+ the group
+
+ # Control what to keep in $&.
+ KEEPS no $& begins here.
+
+ # New charclass like patterns
+ LNBREAK none generic newline pattern
+
+ # SPECIAL REGOPS
+
+ # This is not really a node, but an optimized away piece of a "long"
+ # node. To simplify debugging output, we mark it as if it were a node
+ OPTIMIZED off Placeholder for dump.
+
+ # Special opcode with the property that no opcode in a compiled program
+ # will ever be of this type. Thus it can be used as a flag value that
+ # no other opcode has been seen. END is used similarly, in that an END
+ # node cant be optimized. So END implies "unoptimizable" and PSEUDO
+ # mean "not seen anything to optimize yet".
+ PSEUDO off Pseudo opcode for internal use.
+
+=for regcomp.pl end