This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.sym: Add comments
[perl5.git] / regcomp.sym
index ab57929..c33b792 100644 (file)
@@ -4,7 +4,7 @@
 #
 # Empty rows after #-comment are removed from input are ignored
 #
-# First section is for regops, second sectionis for regmatch-states
+# First section is for regops, second section is for regmatch-states
 #
 # Note that the order in this file is important.
 #
 #
 #
 # run perl regen.pl after editing this file
+# Also update perlredebguts.pod
 
 
 
-#* Exit points (0,1)
+#* Exit points
 
 END         END,        no        ; End of program.
 SUCCEED     END,        no        ; Return from a subroutine, basically.
 
-#* Anchors: (2..13)
+#* Anchors:
 
 BOL         BOL,        no        ; Match "" at beginning of line.
 MBOL        BOL,        no        ; Same, assuming multiline.
@@ -30,33 +31,49 @@ EOS         EOL,        no        ; Match "" at end of string.
 EOL         EOL,        no        ; Match "" at end of line.
 MEOL        EOL,        no        ; Same, assuming multiline.
 SEOL        EOL,        no        ; Same, assuming singleline.
-BOUND       BOUND,      no        ; Match "" at any word boundary
-BOUNDL      BOUND,      no        ; Match "" at any word boundary
-NBOUND      NBOUND,     no        ; Match "" at any word non-boundary
-NBOUNDL     NBOUND,     no        ; Match "" at any word non-boundary
+BOUND       BOUND,      no        ; Match "" at any word boundary using native charset semantics for non-utf8
+BOUNDL      BOUND,      no        ; Match "" at any locale word boundary
+BOUNDU      BOUND,      no        ; Match "" at any word boundary using Unicode semantics
+BOUNDA      BOUND,      no         ; Match "" at any word boundary using ASCII semantics
+# All NBOUND nodes are required by a line regexec.c to be greater than all BOUND ones
+NBOUND      NBOUND,     no        ; Match "" at any word non-boundary using native charset semantics for non-utf8
+NBOUNDL     NBOUND,     no        ; Match "" at any locale word non-boundary
+NBOUNDU     NBOUND,     no        ; Match "" at any word non-boundary using Unicode semantics
+NBOUNDA     NBOUND,     no        ; Match "" at any word non-boundary using ASCII semantics
 GPOS        GPOS,       no        ; Matches where last m//g left off.
 
-#* [Special] alternatives: (14..30)
+#* [Special] alternatives:
 
 REG_ANY     REG_ANY,    no 0 S    ; Match any one character (except newline).
 SANY        REG_ANY,    no 0 S    ; Match any one character.
 CANY        REG_ANY,    no 0 S    ; Match any one byte.
-ANYOF       ANYOF,      sv 0 S    ; Match character in (or not in) this class, folding is native charset for non-utf8.
-ALNUM       ALNUM,      no 0 S    ; Match any alphanumeric character
+ANYOF       ANYOF,      sv 0 S    ; Match character in (or not in) this class, single char match only
+ANYOFV      ANYOF,      sv 0 V    ; Match character in (or not in) this class, can match-multiple chars
+ALNUM       ALNUM,      no 0 S    ; Match any alphanumeric character using native charset semantics for non-utf8
 ALNUML      ALNUM,      no 0 S    ; Match any alphanumeric char in locale
-NALNUM      NALNUM,     no 0 S    ; Match any non-alphanumeric character
+ALNUMU      ALNUM,      no 0 S    ; Match any alphanumeric char using Unicode semantics
+ALNUMA      ALNUM,      no 0 S    ; Match [A-Za-z_0-9]
+NALNUM      NALNUM,     no 0 S    ; Match any non-alphanumeric character using native charset semantics for non-utf8
 NALNUML     NALNUM,     no 0 S    ; Match any non-alphanumeric char in locale
-SPACE       SPACE,      no 0 S    ; Match any whitespace character
+NALNUMU     NALNUM,     no 0 S    ; Match any non-alphanumeric char using Unicode semantics
+NALNUMA     NALNUM,     no 0 S    ; Match [^A-Za-z_0-9]
+SPACE       SPACE,      no 0 S    ; Match any whitespace character using native charset semantics for non-utf8
 SPACEL      SPACE,      no 0 S    ; Match any whitespace char in locale
-NSPACE      NSPACE,     no 0 S    ; Match any non-whitespace character
+SPACEU      SPACE,      no 0 S    ; Match any whitespace char using Unicode semantics
+SPACEA      SPACE,      no 0 S    ; Match [ \t\n\f\r]
+NSPACE      NSPACE,     no 0 S    ; Match any non-whitespace character using native charset semantics for non-utf8
 NSPACEL     NSPACE,     no 0 S    ; Match any non-whitespace char in locale
-DIGIT       DIGIT,      no 0 S    ; Match any numeric character
-DIGITL      DIGIT,      no        ; Match any numeric character in locale
-NDIGIT      NDIGIT,     no 0 S    ; Match any non-numeric character
-NDIGITL     NDIGIT,     no        ; Match any non-numeric character in locale
+NSPACEU     NSPACE,     no 0 S    ; Match any non-whitespace char using Unicode semantics
+NSPACEA     NSPACE,     no 0 S    ; Match [^ \t\n\f\r]
+DIGIT       DIGIT,      no 0 S    ; Match any numeric character using native charset semantics for non-utf8
+DIGITL      DIGIT,      no 0 S    ; Match any numeric character in locale
+DIGITA      DIGIT,      no 0 S    ; Match [0-9]
+NDIGIT      NDIGIT,     no 0 S    ; Match any non-numeric character using native charset semantics for non-utf8
+NDIGITL     NDIGIT,     no 0 S    ; Match any non-numeric character in locale
+NDIGITA     NDIGIT,     no 0 S    ; Match [^0-9]
 CLUMP       CLUMP,      no 0 V    ; Match any extended grapheme cluster sequence
 
-#* Alternation (31)
+#* Alternation
 
 # BRANCH        The set of branches constituting a single choice are hooked
 #               together with their "next" pointers, since precedence prevents
@@ -68,26 +85,28 @@ CLUMP       CLUMP,      no 0 V    ; Match any extended grapheme cluster sequence
 #
 BRANCH      BRANCH,     node 0 V  ; Match this alternative, or the next...
 
-#*Back pointer (32)
+#*Back pointer
 
 # BACK          Normal "next" pointers all implicitly point forward; BACK
 #               exists to make loop structures possible.
 # not used
 BACK        BACK,       no 0 V    ; Match "", "next" ptr points backward.
 
-#*Literals (33..35)
+#*Literals
 
 EXACT       EXACT,      str       ; Match this string (preceded by length).
-EXACTF      EXACT,      str       ; Match this string, folded, native charset semantics for non-utf8 (prec. by length).
-EXACTFL     EXACT,      str       ; Match this string, folded in locale (w/len).
+EXACTF      EXACT,      str       ; Match this (folded if in UTF-8) string, folded, native charset semantics for non-utf8 (prec. by length).
+EXACTFL     EXACT,      str       ; Match this (not guaranteed to be folded) string, folded in locale (w/len).
+EXACTFU     EXACT,      str      ; Match this (folded if in UTF-8) string, folded, Unicode semantics for non-utf8 (prec. by length).
+EXACTFA     EXACT,      str      ; Match this (not guaranteed to be folded) string, folded, Unicode semantics for non-utf8, but no ASCII-range character matches outside ASCII (prec. by length),.
 
-#*Do nothing types (36..37)
+#*Do nothing types
 
 NOTHING     NOTHING,    no        ; Match empty string.
 # A variant of above which delimits a group, thus stops optimizations
 TAIL        NOTHING,    no        ; Match empty string. Can jump here from outside.
 
-#*Loops (38..44)
+#*Loops
 
 # STAR,PLUS    '?', and complex '*' and '+', are implemented as circular
 #               BRANCH structures using BACK.  Simple cases (one character
@@ -105,7 +124,7 @@ CURLYX      CURLY,      sv 2 V    ; Match this complex thing {n,m} times.
 # This terminator creates a loop structure for CURLYX
 WHILEM      WHILEM,     no 0 V    ; Do curly processing and see if rest matches.
 
-#*Buffer related (45..49)
+#*Buffer related
 
 # OPEN,CLOSE,GROUPP     ...are numbered at compile time.
 OPEN        OPEN,       num 1     ; Mark this point in input as start of #n.
@@ -114,60 +133,65 @@ CLOSE       CLOSE,      num 1     ; Analogous to OPEN.
 REF         REF,        num 1 V   ; Match some already matched string
 REFF        REF,        num 1 V   ; Match already matched string, folded using native charset semantics for non-utf8
 REFFL       REF,        num 1 V   ; Match already matched string, folded in loc.
+# N?REFF[AU] could have been implemented using the FLAGS field of the
+# regnode, but by having a separate node type, we can use the existing switch
+# statement to avoid some tests
+REFFU       REF,        num 1 V   ; Match already matched string, folded using unicode semantics for non-utf8
+REFFA       REF,        num 1 V   ; Match already matched string, folded using unicode semantics for non-utf8, no mixing ASCII, non-ASCII
 
+#*Named references.  Code in regcomp.c assumes that these all are after the numbered references
+NREF        REF,        no-sv 1 V ; Match some already matched string
+NREFF       REF,        no-sv 1 V ; Match already matched string, folded using native charset semantics for non-utf8
+NREFFL      REF,        no-sv 1 V ; Match already matched string, folded in loc.
+NREFFU      REF,        num   1 V ; Match already matched string, folded using unicode semantics for non-utf8
+NREFFA      REF,        num   1 V ; Match already matched string, folded using unicode semantics for non-utf8, no mixing ASCII, non-ASCII
 
 IFMATCH     BRANCHJ,    off 1 . 2 ; Succeeds if the following matches.
 UNLESSM     BRANCHJ,    off 1 . 2 ; Fails if the following matches.
 SUSPEND     BRANCHJ,    off 1 V 1 ; "Independent" sub-RE.
-IFTHEN      BRANCHJ,    off 1 V 1 ; Switch, should be preceeded by switcher .
+IFTHEN      BRANCHJ,    off 1 V 1 ; Switch, should be preceded by switcher .
 GROUPP      GROUPP,     num 1     ; Whether the group matched.
 
-#*Support for long RE (55..56)
+#*Support for long RE
 
 LONGJMP     LONGJMP,    off 1 . 1 ; Jump far away.
 BRANCHJ     BRANCHJ,    off 1 V 1 ; BRANCH with long offset.
 
-#*The heavy worker (57)
+#*The heavy worker
 
 EVAL        EVAL,       evl 1     ; Execute some Perl code.
 
-#*Modifiers (58..59)
+#*Modifiers
 
 MINMOD      MINMOD,     no        ; Next operator is not greedy.
 LOGICAL     LOGICAL,    no        ; Next opcode should set the flag only.
 
-# This is not used yet (60)
+# This is not used yet
 RENUM       BRANCHJ,    off 1 . 1 ; Group with independently numbered parens.
 
-#*Trie Related (61..62)
+#*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.
-# NOTE: the relative order of the TRIE-like regops  is signifigant
+# NOTE: the relative order of the TRIE-like regops  is significant
 
-TRIE        TRIE,       trie 1    ; Match many EXACT(F[LU]?)? at once. flags==type
+TRIE        TRIE,       trie 1    ; Match many EXACT(F[ALU]?)? at once. flags==type
 TRIEC       TRIE,trie charclass   ; Same as TRIE, but with embedded charclass data
 
 # For start classes, contains an added fail table.
 AHOCORASICK     TRIE,   trie 1    ; Aho Corasick stclass. flags==type
 AHOCORASICKC    TRIE,trie charclass   ; Same as AHOCORASICK, but with embedded charclass data
 
-#*Regex Subroutines (65..66) 
+#*Regex Subroutines
 GOSUB       GOSUB,      num/ofs 2L    ; recurse to paren arg1 at (signed) ofs arg2
 GOSTART     GOSTART,    no        ; recurse to start of pattern
 
-#*Named references (67..69)
-NREF        REF,        no-sv 1 V ; Match some already matched string
-NREFF       REF,        no-sv 1 V ; Match already matched string, folded using native charset semantics for non-utf8
-NREFFL      REF,        no-sv 1 V ; Match already matched string, folded in loc.
-
-
-#*Special conditionals  (70..72)
+#*Special conditionals
 NGROUPP     NGROUPP,    no-sv 1   ; Whether the group matched.            
 INSUBP      INSUBP,     num 1     ; Whether we are in a specific recurse.  
 DEFINEP     DEFINEP,    none 1    ; Never execute directly.               
 
-#*Bactracking Verbs
+#*Backtracking Verbs
 ENDLIKE     ENDLIKE,    none      ; Used only for the type field of verbs
 OPFAIL      ENDLIKE,    none      ; Same as (?!)
 ACCEPT      ENDLIKE,    parno 1   ; Accepts the current matched string.
@@ -192,9 +216,9 @@ HORIZWS     HORIZWS,    none 0 S  ; horizontal whitespace       (Perl 6)
 NHORIZWS    NHORIZWS,   none 0 S  ; not horizontal whitespace   (Perl 6)
 
 FOLDCHAR    FOLDCHAR,   codepoint 1 ; codepoint with tricky case folding properties.
-EXACTFU     EXACT,      str        ; Match this string, folded, Unicode semantics for non-utf8 (prec. by length).
 
-# NEW STUFF ABOVE THIS LINE  
+
+# NEW STUFF SOMEWHERE ABOVE THIS LINE
 
 ################################################################################