# Note that the order in this file is important.
#
# Format for first section:
-# NAME \s+ TYPE, arg-description [num-args] [flags] [longjump] ; DESCRIPTION
+# NAME \s+ TYPE, arg-description [struct regnode suffix] [flags] [longjump] ; DESCRIPTION
+# arg-description is currently unused
+# suffix is appended to 'struct_regnode_' giving which one to use. If empty,
+# it means plain 'struct regnode'. If the regnode is a string one, this
+# should instead refer to the base regnode, without the char[1] element
+# of the structure
# flag <S> means is REGNODE_SIMPLE; flag <V> means is REGNODE_VARIES; <.> is
-# a placeholder
-# longjump is 1 if the (first) argument holds the next offset.
-#
+# a placeholder
+# longjump is 1 if the (first) argument holds the next offset (instead of the
+# usual 'next_offset' field
#
# run perl regen.pl after editing this file
+# +- suffix of which struct regnode to use e.g.,
+# | +- flags (S or V) struct regnode_1
+# un- | | +- longjmp (0, blank, or 1) blank means 0
+# Name Type used | | | ; comment
+# --------------------------------------------------------------------------
+# IFMATCH BRANCHJ, off 1 . 1 ; Succeeds if the following matches.
+# UNLESSM BRANCHJ, off 1 . 1 ; Fails if the following matches.
+# SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
+# IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
+# GROUPP GROUPP, num 1 ; Whether the group matched.
#* Exit points
ANYOFD ANYOF, sv charclass S ; Like ANYOF, but /d is in effect
ANYOFL ANYOF, sv charclass S ; Like ANYOF, but /l is in effect
ANYOFPOSIXL ANYOF, sv charclass_posixl S ; Like ANYOFL, but matches [[:posix:]] classes
-ANYOFH ANYOF, sv 1 S ; Like ANYOF, but only has "High" matches, none in the bitmap; non-zero flags "f" means "f" is the first UTF-8 byte shared in common by all code points matched
+
+# Must be sequential
+ANYOFH ANYOF, sv 1 S ; Like ANYOF, but only has "High" matches, none in the bitmap; the flags field contains the lowest matchable UTF-8 start byte
+ANYOFHb ANYOF, sv 1 S ; Like ANYOFH, but all matches share the same UTF-8 start byte, given in the flags field
+ANYOFHr ANYOF, sv 1 S ; Like ANYOFH, but the flags field contains packed bounds for all matchable UTF-8 start bytes.
+
ANYOFM ANYOFM byte 1 S ; Like ANYOF, but matches an invariant byte as determined by the mask and arg
NANYOFM ANYOFM byte 1 S ; complement of ANYOFM
#*Literals
# NOTE: the relative ordering of these types is important do not change it
-EXACT EXACT, str ; Match this string (preceded by length).
+EXACT EXACT, str ; Match this string (flags field is the length).
EXACTL EXACT, str ; Like EXACT, but /l is in effect (used so locale-related warnings can be checked for).
-EXACTF EXACT, str ; Match this string using /id rules (w/len); (string not UTF-8, not guaranteed to be folded).
-EXACTFL EXACT, str ; Match this string using /il rules (w/len); (string not guaranteed to be folded).
-EXACTFU EXACT, str ; Match this string using /iu rules (w/len); (string folded iff in UTF-8; non-UTF8 folded length <= unfolded).
-EXACTFAA EXACT, str ; Match this string using /iaa rules (w/len) (string folded iff in UTF-8; non-UTF8 folded length <= unfolded).
+EXACTF EXACT, str ; Like EXACT, but match using /id rules; (string not UTF-8, not guaranteed to be folded).
+EXACTFL EXACT, str ; Like EXACT, but match using /il rules; (string not likely to be folded).
+EXACTFU EXACT, str ; Like EXACT, but match using /iu rules; (string folded).
+EXACTFAA EXACT, str ; Like EXACT, but match using /iaa rules; (string folded iff pattern is UTF8; folded length <= unfolded).
# End of important relative ordering.
-EXACTFUP EXACT, str ; Match this string using /iu rules (w/len); (string not UTF-8, not guaranteed to be folded; and its Problematic).
+EXACTFUP EXACT, str ; Like EXACT, but match using /iu rules; (string not UTF-8, not guaranteed to be folded; and it is Problematic).
# In order for a non-UTF-8 EXACTFAA to think the pattern is pre-folded when
# matching a UTF-8 target string, there would have to be something like an
# EXACTFAA_MICRO which would not be considered pre-folded for UTF-8 targets,
# since the fold of the MICRO SIGN would not be done, and would be
# representable in the UTF-8 target string.
-EXACTFLU8 EXACT, str ; Like EXACTFU, but use /il, UTF-8, folded, and everything in it is above 255.
-EXACTFAA_NO_TRIE EXACT, str ; Match this string using /iaa rules (w/len) (string not UTF-8, not guaranteed to be folded, not currently trie-able).
+EXACTFLU8 EXACT, str ; Like EXACTFU, but use /il, UTF-8, (string is folded, and everything in it is above 255.
+EXACTFAA_NO_TRIE EXACT, str ; Like EXACT, but match using /iaa rules (string not UTF-8, not guaranteed to be folded, not currently trie-able).
EXACT_ONLY8 EXACT, str ; Like EXACT, but only UTF-8 encoded targets can match
EXACTFU_ONLY8 EXACT, str ; Like EXACTFU, but only UTF-8 encoded targets can match
-# One could add EXACTFAA8 and and something that has the same effect for /l,
+# One could add EXACTFAA8 and something that has the same effect for /l,
# but these would be extremely uncommon
EXACTFU_S_EDGE EXACT, str ; /di rules, but nothing in it precludes /ui, except begins and/or ends with [Ss]; (string not UTF-8; compile-time only).
https://perl5.git.perl.org / perl5.git / blobdiff