5 * "One Ring to rule them all, One Ring to find them..."
8 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
9 * confused with the original package (see point 3 below). Thanks, Henry!
12 /* Additional note: this code is very heavily munged from Henry's version
13 * in places. In some spots I've traded clarity for efficiency, so don't
14 * blame Henry for some of the lack of readability.
17 /* The names of the functions have been changed from regcomp and
18 * regexec to pregcomp and pregexec in order to avoid conflicts
19 * with the POSIX routines of the same names.
24 * pregcomp and pregexec -- regsub and regerror are not used in perl
26 * Copyright (c) 1986 by University of Toronto.
27 * Written by Henry Spencer. Not derived from licensed software.
29 * Permission is granted to anyone to use this software for any
30 * purpose on any computer system, and to redistribute it freely,
31 * subject to the following restrictions:
33 * 1. The author is not responsible for the consequences of use of
34 * this software, no matter how awful, even if they arise
37 * 2. The origin of this software must not be misrepresented, either
38 * by explicit claim or by omission.
40 * 3. Altered versions must be plainly marked as such, and must not
41 * be misrepresented as being the original software.
43 **** Alterations to Henry's code are...
45 **** Copyright (c) 1991-1997, Larry Wall
47 **** You may distribute under the terms of either the GNU General Public
48 **** License or the Artistic License, as specified in the README file.
50 * Beware that some of this code is subtly aware of the way operator
51 * precedence is structured in regular expressions. Serious changes in
52 * regular-expression syntax might require a total rethink.
63 static I32 regnarrate = 0;
64 static char* regprogram = 0;
67 /* Current curly descriptor */
68 typedef struct curcur CURCUR;
70 int parenfloor; /* how far back to strip paren data */
71 int cur; /* how many instances of scan we've matched */
72 int min; /* the minimal number of scans to match */
73 int max; /* the maximal number of scans to match */
74 int minmod; /* whether to work our way up or down */
75 char * scan; /* the thing to match */
76 char * next; /* what has to match after it */
77 char * lastloc; /* where we started matching this scan */
78 CURCUR * oldcc; /* current curly before we started this one */
83 typedef I32 CHECKPOINT;
85 static CHECKPOINT regcppush _((I32 parenfloor));
86 static char * regcppop _((void));
92 int retval = savestack_ix;
93 int i = (regsize - parenfloor) * 3;
97 for (p = regsize; p > parenfloor; p--) {
98 SSPUSHPTR(regendp[p]);
99 SSPUSHPTR(regstartp[p]);
103 SSPUSHINT(*reglastparen);
106 SSPUSHINT(SAVEt_REGCONTEXT);
117 assert(i == SAVEt_REGCONTEXT);
119 input = (char *) SSPOPPTR;
120 *reglastparen = SSPOPINT;
122 for (i -= 3; i > 0; i -= 3) {
123 paren = (U32)SSPOPINT;
124 regstartp[paren] = (char *) SSPOPPTR;
125 tmps = (char*)SSPOPPTR;
126 if (paren <= *reglastparen)
127 regendp[paren] = tmps;
129 for (paren = *reglastparen + 1; paren <= regnpar; paren++) {
131 regstartp[paren] = Nullch;
132 regendp[paren] = Nullch;
137 #define regcpblow(cp) leave_scope(cp)
140 * pregexec and friends
147 static I32 regmatch _((char *prog));
148 static I32 regrepeat _((char *p, I32 max));
149 static I32 regtry _((regexp *prog, char *startpos));
150 static bool reginclass _((char *p, I32 c));
152 static bool regtainted; /* tainted information used? */
155 - pregexec - match a regexp against a string
158 pregexec(prog, stringarg, strend, strbeg, minend, screamer, safebase)
159 register regexp *prog;
161 register char *strend; /* pointer to null at end of string */
162 char *strbeg; /* real beginning of string */
163 I32 minend; /* end of match must be at least minend after stringarg */
165 I32 safebase; /* no need to remember string in subbase */
169 register char *startpos = stringarg;
171 I32 minlen = 0; /* must match at least this many chars */
172 I32 dontbother = 0; /* how many characters not to try at end */
180 regnarrate = debug & 512;
181 regprogram = prog->program;
185 if (prog == NULL || startpos == NULL) {
186 croak("NULL regexp parameter");
190 if (startpos == strbeg) /* is ^ valid at stringarg? */
193 regprev = stringarg[-1];
194 if (!multiline && regprev == '\n')
195 regprev = '\0'; /* force ^ to NOT match */
198 regprecomp = prog->precomp;
199 /* Check validity of program. */
200 if (UCHARAT(prog->program) != MAGIC) {
201 FAIL("corrupted regexp program");
204 regnpar = prog->nparens;
207 /* If there is a "must appear" string, look for it. */
209 if (prog->regmust != Nullsv &&
210 !(prog->reganch & ROPT_ANCH_GPOS) &&
211 (!(prog->reganch & ROPT_ANCH_BOL)
212 || (multiline && prog->regback >= 0)) )
214 if (stringarg == strbeg && screamer) {
215 if (screamfirst[BmRARE(prog->regmust)] >= 0)
216 s = screaminstr(screamer,prog->regmust);
221 s = fbm_instr((unsigned char*)s, (unsigned char*)strend,
224 ++BmUSEFUL(prog->regmust); /* hooray */
225 goto phooey; /* not present */
227 else if (prog->regback >= 0) {
231 minlen = prog->regback + SvCUR(prog->regmust);
233 else if (!prog->naughty && --BmUSEFUL(prog->regmust) < 0) { /* boo */
234 SvREFCNT_dec(prog->regmust);
235 prog->regmust = Nullsv; /* disable regmust */
240 minlen = SvCUR(prog->regmust);
244 /* Mark beginning of line for ^ . */
247 /* Mark end of line for $ (and such) */
250 /* see how far we have to get to not match where we matched before */
251 regtill = startpos+minend;
253 /* Simplest case: anchored match need be tried only once. */
254 /* [unless only anchor is BOL and multiline is set] */
255 if (prog->reganch & ROPT_ANCH) {
256 if (regtry(prog, startpos))
258 else if (!(prog->reganch & ROPT_ANCH_GPOS) &&
259 (multiline || (prog->reganch & ROPT_IMPLICIT)))
262 dontbother = minlen - 1;
263 strend -= dontbother;
264 /* for multiline we only have to try after newlines */
269 if (s < strend && regtry(prog, s))
277 /* Messy cases: unanchored match. */
278 if (prog->regstart) {
279 if (prog->reganch & ROPT_SKIP) { /* we have /x+whatever/ */
280 /* it must be a one character string */
281 char ch = SvPVX(prog->regstart)[0];
287 while (s < strend && *s == ch)
293 else if (SvTYPE(prog->regstart) == SVt_PVBM) {
294 /* We know what string it must start with. */
295 while ((s = fbm_instr((unsigned char*)s,
296 (unsigned char*)strend, prog->regstart)) != NULL)
303 else { /* Optimized fbm_instr: */
304 c = SvPVX(prog->regstart);
305 while ((s = ninstr(s, strend, c, c + SvCUR(prog->regstart))) != NULL)
315 if (c = prog->regstclass) {
316 I32 doevery = (prog->reganch & ROPT_SKIP) == 0;
319 dontbother = minlen - 1;
320 strend -= dontbother; /* don't bother with what can't match */
322 /* We know what class it must start with. */
327 if (reginclass(c, *s)) {
328 if (tmp && regtry(prog, s))
343 dontbother++,strend--;
344 tmp = (s != startpos) ? UCHARAT(s - 1) : regprev;
345 tmp = ((OP(c) == BOUND ? isALNUM(tmp) : isALNUM_LC(tmp)) != 0);
347 if (tmp == !(OP(c) == BOUND ? isALNUM(*s) : isALNUM_LC(*s))) {
354 if ((minlen || tmp) && regtry(prog,s))
362 dontbother++,strend--;
363 tmp = (s != startpos) ? UCHARAT(s - 1) : regprev;
364 tmp = ((OP(c) == NBOUND ? isALNUM(tmp) : isALNUM_LC(tmp)) != 0);
366 if (tmp == !(OP(c) == NBOUND ? isALNUM(*s) : isALNUM_LC(*s)))
368 else if (regtry(prog, s))
372 if ((minlen || !tmp) && regtry(prog,s))
378 if (tmp && regtry(prog, s))
391 if (isALNUM_LC(*s)) {
392 if (tmp && regtry(prog, s))
405 if (tmp && regtry(prog, s))
418 if (!isALNUM_LC(*s)) {
419 if (tmp && regtry(prog, s))
432 if (tmp && regtry(prog, s))
445 if (isSPACE_LC(*s)) {
446 if (tmp && regtry(prog, s))
459 if (tmp && regtry(prog, s))
472 if (!isSPACE_LC(*s)) {
473 if (tmp && regtry(prog, s))
486 if (tmp && regtry(prog, s))
499 if (tmp && regtry(prog, s))
513 dontbother = minlen - 1;
514 strend -= dontbother;
515 /* We don't know much -- general case. */
519 } while (s++ < strend);
526 strend += dontbother; /* uncheat */
527 prog->subbeg = strbeg;
528 prog->subend = strend;
529 prog->exec_tainted = regtainted;
531 /* make sure $`, $&, $', and $digit will work later */
532 if (strbeg != prog->subbase) {
535 Safefree(prog->subbase);
536 prog->subbase = Nullch;
540 I32 i = strend - startpos + (stringarg - strbeg);
541 s = savepvn(strbeg, i);
542 Safefree(prog->subbase);
544 prog->subbeg = prog->subbase;
545 prog->subend = prog->subbase + i;
546 s = prog->subbase + (stringarg - strbeg);
547 for (i = 0; i <= prog->nparens; i++) {
549 prog->startp[i] = s + (prog->startp[i] - startpos);
550 prog->endp[i] = s + (prog->endp[i] - startpos);
562 - regtry - try match at specific point
564 static I32 /* 0 failure, 1 success */
565 regtry(prog, startpos)
574 regstartp = prog->startp;
575 regendp = prog->endp;
576 reglastparen = &prog->lastparen;
583 for (i = prog->nparens; i >= 0; i--) {
588 if (regmatch(prog->program + 1) && reginput >= regtill) {
589 prog->startp[0] = startpos;
590 prog->endp[0] = reginput;
598 - regmatch - main matching routine
600 * Conceptually the strategy is simple: check to see whether the current
601 * node matches, call self recursively to see whether the rest matches,
602 * and then act accordingly. In practice we make some effort to avoid
603 * recursion, in particular by going through "ordinary" nodes (that don't
604 * need to know whether the rest of the match failed) by a loop instead of
607 /* [lwall] I've hoisted the register declarations to the outer block in order to
608 * maybe save a little bit of pushing and popping on the stack. It also takes
609 * advantage of machines that use a register save mask on subroutine entry.
611 static I32 /* 0 failure, 1 success */
615 register char *scan; /* Current node. */
616 char *next; /* Next node. */
617 register I32 nextchar;
618 register I32 n; /* no or next */
619 register I32 ln; /* len or last */
620 register char *s; /* operand or save */
621 register char *locinput = reginput;
622 register I32 c1, c2; /* case fold search */
625 static int regindent = 0;
629 nextchar = UCHARAT(locinput);
631 while (scan != NULL) {
633 #define sayYES goto yes
634 #define sayNO goto no
635 #define saySAME(x) if (x) goto yes; else goto no
637 SV *prop = sv_newmortal();
639 PerlIO_printf(Perl_debug_log, "%*s%2d%-8.8s\t<%.10s>\n",
640 regindent*2, "", scan - regprogram,
641 SvPVX(prop), locinput);
644 #define sayYES return 1
645 #define sayNO return 0
646 #define saySAME(x) return x
650 next = scan + NEXT(scan);
654 next = regnext(scan);
659 if (locinput == regbol
661 : ((nextchar || locinput < regeol) && locinput[-1] == '\n') )
663 /* regtill = regbol; */
668 if (locinput == regbol
670 : ((nextchar || locinput < regeol) && locinput[-1] == '\n') )
676 if (locinput == regbol && regprev == '\n')
680 if (locinput == regbol)
690 if ((nextchar || locinput < regeol) && nextchar != '\n')
695 if ((nextchar || locinput < regeol) && nextchar != '\n')
697 if (regeol - locinput > 1)
701 if (!nextchar && locinput >= regeol)
703 nextchar = UCHARAT(++locinput);
706 if (!nextchar && locinput >= regeol || nextchar == '\n')
708 nextchar = UCHARAT(++locinput);
713 /* Inline the first character, for speed. */
714 if (UCHARAT(s) != nextchar)
716 if (regeol - locinput < ln)
718 if (ln > 1 && memNE(s, locinput, ln))
721 nextchar = UCHARAT(locinput);
729 /* Inline the first character, for speed. */
730 if (UCHARAT(s) != nextchar &&
731 UCHARAT(s) != ((OP(scan) == EXACTF)
732 ? fold : fold_locale)[nextchar])
734 if (regeol - locinput < ln)
736 if (ln > 1 && (OP(scan) == EXACTF
737 ? ibcmp(s, locinput, ln)
738 : ibcmp_locale(s, locinput, ln)))
741 nextchar = UCHARAT(locinput);
746 nextchar = UCHARAT(locinput);
747 if (!reginclass(s, nextchar))
749 if (!nextchar && locinput >= regeol)
751 nextchar = UCHARAT(++locinput);
759 if (!(OP(scan) == ALNUM
760 ? isALNUM(nextchar) : isALNUM_LC(nextchar)))
762 nextchar = UCHARAT(++locinput);
768 if (!nextchar && locinput >= regeol)
770 if (OP(scan) == NALNUM
771 ? isALNUM(nextchar) : isALNUM_LC(nextchar))
773 nextchar = UCHARAT(++locinput);
781 /* was last char in word? */
782 ln = (locinput != regbol) ? UCHARAT(locinput - 1) : regprev;
783 if (OP(scan) == BOUND || OP(scan) == NBOUND) {
785 n = isALNUM(nextchar);
789 n = isALNUM_LC(nextchar);
791 if (((!ln) == (!n)) == (OP(scan) == BOUND || OP(scan) == BOUNDL))
798 if (!nextchar && locinput >= regeol)
800 if (!(OP(scan) == SPACE
801 ? isSPACE(nextchar) : isSPACE_LC(nextchar)))
803 nextchar = UCHARAT(++locinput);
811 if (OP(scan) == SPACE
812 ? isSPACE(nextchar) : isSPACE_LC(nextchar))
814 nextchar = UCHARAT(++locinput);
817 if (!isDIGIT(nextchar))
819 nextchar = UCHARAT(++locinput);
822 if (!nextchar && locinput >= regeol)
824 if (isDIGIT(nextchar))
826 nextchar = UCHARAT(++locinput);
833 n = ARG1(scan); /* which paren pair */
841 /* Inline the first character, for speed. */
842 if (UCHARAT(s) != nextchar &&
844 (UCHARAT(s) != ((OP(scan) == REFF
845 ? fold : fold_locale)[nextchar]))))
848 if (locinput + ln > regeol)
850 if (ln > 1 && (OP(scan) == REF
851 ? memNE(s, locinput, ln)
853 ? ibcmp(s, locinput, ln)
854 : ibcmp_locale(s, locinput, ln))))
857 nextchar = UCHARAT(locinput);
865 n = ARG1(scan); /* which paren pair */
866 regstartp[n] = locinput;
871 n = ARG1(scan); /* which paren pair */
872 regendp[n] = locinput;
873 if (n > *reglastparen)
878 CHECKPOINT cp = savestack_ix;
881 cc.parenfloor = *reglastparen;
885 cc.scan = NEXTOPER(scan) + 4;
890 n = regmatch(PREVOPER(next)); /* start on the WHILEM */
898 * This is really hard to understand, because after we match
899 * what we're trying to match, we must make sure the rest of
900 * the RE is going to match for sure, and to do that we have
901 * to go back UP the parse tree by recursing ever deeper. And
902 * if it fails, we have to reset our parent's current state
903 * that we can try again after backing off.
908 n = cc->cur + 1; /* how many we know we matched */
913 PerlIO_printf(Perl_debug_log, "%*s %ld %lx\n", regindent*2, "",
917 /* If degenerate scan matches "", assume scan done. */
919 if (locinput == cc->lastloc && n >= cc->min) {
922 if (regmatch(cc->next))
929 /* First just match a string of min scans. */
933 cc->lastloc = locinput;
934 if (regmatch(cc->scan))
940 /* Prefer next over scan for minimal matching. */
945 cp = regcppush(cc->parenfloor);
946 if (regmatch(cc->next)) {
948 sayYES; /* All done. */
954 if (n >= cc->max) /* Maximum greed exceeded? */
957 /* Try scanning more and see if it helps. */
960 cc->lastloc = locinput;
961 cp = regcppush(cc->parenfloor);
962 if (regmatch(cc->scan)) {
971 /* Prefer scan over next for maximal matching. */
973 if (n < cc->max) { /* More greed allowed? */
974 cp = regcppush(cc->parenfloor);
976 cc->lastloc = locinput;
977 if (regmatch(cc->scan)) {
981 regcppop(); /* Restore some previous $<digit>s? */
985 /* Failed deeper matches of scan, so see if this one works. */
988 if (regmatch(cc->next))
997 if (OP(next) != BRANCH) /* No choice. */
998 next = NEXTOPER(scan);/* Avoid recursion. */
1000 int lastparen = *reglastparen;
1002 reginput = locinput;
1003 if (regmatch(NEXTOPER(scan)))
1005 for (n = *reglastparen; n > lastparen; n--)
1016 scan = regnext(scan);
1018 } while (scan != NULL && OP(scan) == BRANCH);
1028 ln = ARG1(scan); /* min to match */
1029 n = ARG2(scan); /* max to match */
1030 scan = NEXTOPER(scan) + 4;
1035 scan = NEXTOPER(scan);
1039 * Lookahead to avoid useless match attempts
1040 * when we know what character comes next.
1044 scan = NEXTOPER(scan);
1046 if (regkind[(U8)OP(next)] == EXACT) {
1047 c1 = UCHARAT(OPERAND(next) + 1);
1048 if (OP(next) == EXACTF)
1050 else if (OP(next) == EXACTFL)
1051 c2 = fold_locale[c1];
1057 reginput = locinput;
1060 if (ln && regrepeat(scan, ln) < ln)
1062 while (n >= ln || (n == 32767 && ln > 0)) { /* ln overflow ? */
1063 /* If it could work, try it. */
1065 UCHARAT(reginput) == c1 ||
1066 UCHARAT(reginput) == c2)
1071 /* Couldn't or didn't -- back up. */
1072 reginput = locinput + ln;
1073 if (regrepeat(scan, 1)) {
1075 reginput = locinput + ln;
1082 n = regrepeat(scan, n);
1083 if (ln < n && regkind[(U8)OP(next)] == EOL &&
1084 (!multiline || OP(next) == SEOL))
1085 ln = n; /* why back off? */
1087 /* If it could work, try it. */
1089 UCHARAT(reginput) == c1 ||
1090 UCHARAT(reginput) == c2)
1095 /* Couldn't or didn't -- back up. */
1097 reginput = locinput + n;
1103 reginput = locinput; /* put where regtry can find it */
1104 sayYES; /* Success! */
1106 reginput = locinput;
1107 scan = NEXTOPER(scan);
1108 if (!regmatch(scan))
1112 reginput = locinput;
1113 scan = NEXTOPER(scan);
1118 PerlIO_printf(PerlIO_stderr(), "%lx %d\n",
1119 (unsigned long)scan, scan[1]);
1120 FAIL("regexp memory corruption");
1126 * We get here only if there's trouble -- normally "case END" is
1127 * the terminating point.
1129 FAIL("corrupted regexp pointers");
1147 - regrepeat - repeatedly match something simple, report how many
1150 * [This routine now assumes that it will only match on things of length 1.
1151 * That was true before, but now we assume scan - reginput is the count,
1152 * rather than incrementing count on every character.]
1159 register char *scan;
1160 register char *opnd;
1162 register char *loceol = regeol;
1165 if (max != 32767 && max < loceol - scan)
1166 loceol = scan + max;
1170 while (scan < loceol && *scan != '\n')
1176 case EXACT: /* length of string is 1 */
1177 c = UCHARAT(++opnd);
1178 while (scan < loceol && UCHARAT(scan) == c)
1181 case EXACTF: /* length of string is 1 */
1182 c = UCHARAT(++opnd);
1183 while (scan < loceol &&
1184 (UCHARAT(scan) == c || UCHARAT(scan) == fold[c]))
1187 case EXACTFL: /* length of string is 1 */
1189 c = UCHARAT(++opnd);
1190 while (scan < loceol &&
1191 (UCHARAT(scan) == c || UCHARAT(scan) == fold_locale[c]))
1195 while (scan < loceol && reginclass(opnd, *scan))
1199 while (scan < loceol && isALNUM(*scan))
1204 while (scan < loceol && isALNUM_LC(*scan))
1208 while (scan < loceol && !isALNUM(*scan))
1213 while (scan < loceol && !isALNUM_LC(*scan))
1217 while (scan < loceol && isSPACE(*scan))
1222 while (scan < loceol && isSPACE_LC(*scan))
1226 while (scan < loceol && !isSPACE(*scan))
1231 while (scan < loceol && !isSPACE_LC(*scan))
1235 while (scan < loceol && isDIGIT(*scan))
1239 while (scan < loceol && !isDIGIT(*scan))
1242 default: /* Called on something of 0 width. */
1243 break; /* So match right here or not at all. */
1246 c = scan - reginput;
1253 - regclass - determine if a character falls into a character class
1265 if (p[1 + (c >> 3)] & (1 << (c & 7)))
1267 else if (flags & ANYOF_FOLD) {
1269 if (flags & ANYOF_LOCALE) {
1271 cf = fold_locale[c];
1275 if (p[1 + (cf >> 3)] & (1 << (cf & 7)))
1279 if (!match && (flags & ANYOF_ISA)) {
1282 if (((flags & ANYOF_ALNUML) && isALNUM_LC(c)) ||
1283 ((flags & ANYOF_NALNUML) && !isALNUM_LC(c)) ||
1284 ((flags & ANYOF_SPACEL) && isSPACE_LC(c)) ||
1285 ((flags & ANYOF_NSPACEL) && !isSPACE_LC(c)))
1291 return match ^ ((flags & ANYOF_INVERT) != 0);
1295 - regnext - dig the "next" pointer out of a node
1297 * [Note, when REGALIGN is defined there are two places in regmatch()
1298 * that bypass this code for speed.]
1304 register I32 offset;