1 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
2 * confused with the original package (see point 3 below). Thanks, Henry!
5 /* Additional note: this code is very heavily munged from Henry's version
6 * in places. In some spots I've traded clarity for efficiency, so don't
7 * blame Henry for some of the lack of readability.
10 /* $Header: regcomp.c,v 3.0.1.6 90/10/16 10:17:33 lwall Locked $
13 * Revision 3.0.1.6 90/10/16 10:17:33 lwall
14 * patch29: patterns with multiple short literal strings sometimes failed
16 * Revision 3.0.1.5 90/08/13 22:23:29 lwall
17 * patch28: /x{m}/ didn't work right
19 * Revision 3.0.1.4 90/08/09 05:05:33 lwall
20 * patch19: sped up /x+y/ patterns greatly by not retrying on every x
21 * patch19: inhibited backoff on patterns anchored to the end like /\s+$/
22 * patch19: sped up {m,n} on simple items
23 * patch19: optimized /.*whatever/ to /^.*whatever/
24 * patch19: fixed character classes to allow backslashing hyphen
26 * Revision 3.0.1.3 90/03/12 16:59:22 lwall
27 * patch13: pattern matches can now use \0 to mean \000
29 * Revision 3.0.1.2 90/02/28 18:08:35 lwall
30 * patch9: /[\200-\377]/ didn't work on machines with signed chars
32 * Revision 3.0.1.1 89/11/11 04:51:04 lwall
33 * patch2: /[\000]/ didn't work
35 * Revision 3.0 89/10/18 15:22:29 lwall
41 * regcomp and regexec -- regsub and regerror are not used in perl
43 * Copyright (c) 1986 by University of Toronto.
44 * Written by Henry Spencer. Not derived from licensed software.
46 * Permission is granted to anyone to use this software for any
47 * purpose on any computer system, and to redistribute it freely,
48 * subject to the following restrictions:
50 * 1. The author is not responsible for the consequences of use of
51 * this software, no matter how awful, even if they arise
54 * 2. The origin of this software must not be misrepresented, either
55 * by explicit claim or by omission.
57 * 3. Altered versions must be plainly marked as such, and must not
58 * be misrepresented as being the original software.
61 **** Alterations to Henry's code are...
63 **** Copyright (c) 1989, Larry Wall
65 **** You may distribute under the terms of the GNU General Public License
66 **** as specified in the README file that comes with the perl 3.0 kit.
68 * Beware that some of this code is subtly aware of the way operator
69 * precedence is structured in regular expressions. Serious changes in
70 * regular-expression syntax might require a total rethink.
81 #define ISMULT1(c) ((c) == '*' || (c) == '+' || (c) == '?')
82 #define ISMULT2(s) ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
83 ((*s) == '{' && regcurly(s)))
84 #define META "^$.[()|?+*\\"
87 * Flags to be passed up and down.
89 #define HASWIDTH 01 /* Known never to match null string. */
90 #define SIMPLE 02 /* Simple enough to be STAR/PLUS operand. */
91 #define SPSTART 04 /* Starts with * or +. */
92 #define WORST 0 /* Worst case. */
95 * Global work variables for regcomp().
97 static char *regprecomp; /* uncompiled string. */
98 static char *regparse; /* Input-scan pointer. */
99 static char *regxend; /* End of input for compile */
100 static int regnpar; /* () count. */
101 static char *regcode; /* Code-emit pointer; ®dummy = don't. */
102 static long regsize; /* Code size. */
104 static int regsawbracket; /* Did we do {d,d} trick? */
107 * Forward declarations for regcomp()'s friends.
109 STATIC int regcurly();
111 STATIC char *regbranch();
112 STATIC char *regpiece();
113 STATIC char *regatom();
114 STATIC char *regclass();
115 STATIC char *regnode();
117 STATIC void reginsert();
118 STATIC void regtail();
119 STATIC void regoptail();
122 - regcomp - compile a regular expression into internal code
124 * We can't allocate space until we know how big the compiled form will be,
125 * but we can't compile it (and thus know how big it is) until we've got a
126 * place to put the code. So we cheat: we compile it twice, once with code
127 * generation turned off and size counting turned on, and once "for real".
128 * This also means that we don't allocate space until we are sure that the
129 * thing really will compile successfully, and we never have to move the
130 * code and thus invalidate pointers into it. (Note that it has to be in
131 * one piece because free() must be able to free it all.) [NB: not true in perl]
133 * Beware that the optimization-preparation code in here knows about some
134 * of the structure of the compiled regexp. [I'll say.]
137 regcomp(exp,xend,fold)
144 register STR *longish;
147 register char *first;
151 extern char *safemalloc();
152 extern char *savestr();
156 fatal("NULL regexp argument");
158 /* First pass: determine size, legality. */
162 regprecomp = nsavestr(exp,xend-exp);
168 if (reg(0, &flags) == NULL) {
169 Safefree(regprecomp);
173 /* Small enough for pointer-storage convention? */
174 if (regsize >= 32767L) /* Probably could be 65535L. */
175 FAIL("regexp too big");
177 /* Allocate space. */
178 Newc(1001, r, sizeof(regexp) + (unsigned)regsize, char, regexp);
180 FAIL("regexp out of space");
182 /* Second pass: emit code. */
184 bcopy(regprecomp,exp,xend-exp);
185 r->precomp = regprecomp;
189 regcode = r->program;
191 if (reg(0, &flags) == NULL)
194 /* Dig out information for optimizations. */
195 r->regstart = Nullstr; /* Worst-case defaults. */
197 r->regmust = Nullstr;
199 r->regstclass = Nullch;
200 scan = r->program+1; /* First BRANCH. */
201 if (OP(regnext(scan)) == END) {/* Only one top-level choice. */
202 scan = NEXTOPER(scan);
205 while ((OP(first) > OPEN && OP(first) < CLOSE) ||
206 (OP(first) == BRANCH && OP(regnext(first)) != BRANCH) ||
207 (OP(first) == PLUS) ||
208 (OP(first) == CURLY && ARG1(first) > 0) ) {
209 if (OP(first) == CURLY)
211 else if (OP(first) == PLUS)
213 first = NEXTOPER(first);
216 /* Starting-point info. */
217 if (OP(first) == EXACTLY) {
219 str_make(OPERAND(first)+1,*OPERAND(first));
220 if (r->regstart->str_cur > !(sawstudy|fold))
221 fbmcompile(r->regstart,fold);
223 else if ((exp = index(simple,OP(first))) && exp > simple)
224 r->regstclass = first;
225 else if (OP(first) == BOUND || OP(first) == NBOUND)
226 r->regstclass = first;
227 else if (OP(first) == BOL ||
228 (OP(first) == STAR && OP(NEXTOPER(first)) == ANY) )
229 r->reganch = 1; /* kinda turn .* into ^.* */
230 r->reganch |= sawplus;
234 fprintf(stderr,"first %d next %d offset %d\n",
235 OP(first), OP(NEXTOPER(first)), first - scan);
238 * If there's something expensive in the r.e., find the
239 * longest literal string that must appear and make it the
240 * regmust. Resolve ties in favor of later strings, since
241 * the regstart check works with the beginning of the r.e.
242 * and avoiding duplication strengthens checking. Not a
243 * strong reason, but sufficient in the absence of others.
244 * [Now we resolve ties in favor of the earlier string if
245 * it happens that curback has been invalidated, since the
246 * earlier string may buy us something the later one won't.]
248 longish = str_make("",0);
249 longest = str_make("",0);
253 while (scan != NULL) {
254 if (OP(scan) == BRANCH) {
255 if (OP(regnext(scan)) == BRANCH) {
257 while (OP(scan) == BRANCH)
258 scan = regnext(scan);
260 else /* single branch is ok */
261 scan = NEXTOPER(scan);
263 if (OP(scan) == EXACTLY) {
265 while (OP(regnext(scan)) >= CLOSE)
266 scan = regnext(scan);
267 if (curback - back == len) {
268 str_ncat(longish, OPERAND(first)+1,
270 len += *OPERAND(first);
271 curback += *OPERAND(first);
272 first = regnext(scan);
274 else if (*OPERAND(first) >= len + (curback >= 0)) {
275 len = *OPERAND(first);
276 str_nset(longish, OPERAND(first)+1,len);
279 first = regnext(scan);
282 curback += *OPERAND(first);
284 else if (index(varies,OP(scan))) {
287 if (longish->str_cur > longest->str_cur)
288 str_sset(longest,longish);
289 str_nset(longish,"",0);
291 else if (index(simple,OP(scan)))
293 scan = regnext(scan);
295 if (longish->str_cur > longest->str_cur)
296 str_sset(longest,longish);
298 if (longest->str_cur) {
299 r->regmust = longest;
304 > !(sawstudy || fold || OP(first) == EOL) )
305 fbmcompile(r->regmust,fold);
306 r->regmust->str_u.str_useful = 100;
307 if (OP(first) == EOL) /* is match anchored to EOL? */
308 r->regmust->str_pok |= SP_TAIL;
314 r->do_folding = fold;
315 r->nparens = regnpar - 1;
324 - reg - regular expression, i.e. main body or parenthesized thing
326 * Caller must absorb opening parenthesis.
328 * Combining parenthesis handling with the base level of regular expression
329 * is a trifle forced, but the need to tie the tails of the branches to what
330 * follows makes it hard to avoid.
334 int paren; /* Parenthesized? */
339 register char *ender;
343 *flagp = HASWIDTH; /* Tentatively. */
345 /* Make an OPEN node, if parenthesized. */
347 if (regnpar >= NSUBEXP)
348 FAIL("too many () in regexp");
351 ret = regnode(OPEN+parno);
355 /* Pick up the branches, linking them together. */
356 br = regbranch(&flags);
360 regtail(ret, br); /* OPEN -> first. */
363 if (!(flags&HASWIDTH))
365 *flagp |= flags&SPSTART;
366 while (*regparse == '|') {
368 br = regbranch(&flags);
371 regtail(ret, br); /* BRANCH -> BRANCH. */
372 if (!(flags&HASWIDTH))
374 *flagp |= flags&SPSTART;
377 /* Make a closing node, and hook it on the end. */
378 ender = regnode((paren) ? CLOSE+parno : END);
381 /* Hook the tails of the branches to the closing node. */
382 for (br = ret; br != NULL; br = regnext(br))
383 regoptail(br, ender);
385 /* Check for proper termination. */
386 if (paren && *regparse++ != ')') {
387 FAIL("unmatched () in regexp");
388 } else if (!paren && regparse < regxend) {
389 if (*regparse == ')') {
390 FAIL("unmatched () in regexp");
392 FAIL("junk on end of regexp"); /* "Can't happen". */
400 - regbranch - one alternative of an | operator
402 * Implements the concatenation operator.
409 register char *chain;
410 register char *latest;
413 *flagp = WORST; /* Tentatively. */
415 ret = regnode(BRANCH);
417 while (regparse < regxend && *regparse != '|' && *regparse != ')') {
418 latest = regpiece(&flags);
421 *flagp |= flags&HASWIDTH;
422 if (chain == NULL) /* First piece. */
423 *flagp |= flags&SPSTART;
425 regtail(chain, latest);
428 if (chain == NULL) /* Loop ran zero times. */
429 (void) regnode(NOTHING);
435 - regpiece - something followed by possible [*+?]
437 * Note that the branching code sequences used for ? and the general cases
438 * of * and + are somewhat optimized: they use the same NOTHING node as
439 * both the endmarker for their branch list and the body of the last branch.
440 * It might seem that this node could be dispensed with entirely, but the
441 * endmarker role is not redundant.
451 char *origparse = regparse;
452 int orignpar = regnpar;
457 ret = regatom(&flags);
463 /* Here's a total kludge: if after the atom there's a {\d+,?\d*}
464 * then we decrement the first number by one and reset our
465 * parsing back to the beginning of the same atom. If the first number
466 * is down to 0, decrement the second number instead and fake up
467 * a ? after it. Given the way this compiler doesn't keep track
468 * of offsets on the first pass, this is the only way to replicate
469 * a piece of code. Sigh.
471 if (op == '{' && regcurly(regparse)) {
474 while (isdigit(*next) || *next == ',') {
483 if (*next == '}') { /* got one */
487 iter = atoi(regparse);
488 if (flags&SIMPLE) { /* we can do it right after all */
491 reginsert(CURLY, ret);
497 if (tmp && tmp < iter)
498 fatal("Can't do {n,m} with n > m");
499 if (regcode != ®dummy) {
501 *(unsigned short *)(ret+3) = iter;
502 *(unsigned short *)(ret+5) = tmp;
504 ret[3] = iter >> 8; ret[4] = iter & 0377;
505 ret[5] = tmp >> 8; ret[6] = tmp & 0377;
511 regsawbracket++; /* remember we clobbered exp */
514 sprintf(regparse,"%.*d", max-regparse, iter - 1);
516 if (*max == ',' && max[1] != '}') {
517 if (atoi(max+1) <= 0)
518 fatal("Can't do {n,m} with n > m");
520 sprintf(max+1,"%.*d", next-(max+1), atoi(max+1) - 1);
523 if (iter != 1 || *max == ',') {
524 regparse = origparse; /* back up input pointer */
525 regnpar = orignpar; /* don't make more parens */
537 if (max == next) { /* any number more? */
539 op = '*'; /* fake up one with a star */
542 op = '?'; /* fake up optional atom */
544 sprintf(max,"%.*d", next-max, iter - 1);
549 regparse = origparse - 1; /* offset ++ below */
554 fatal("Can't do {n,0}");
557 fatal("Can't do {0}");
566 if (!(flags&HASWIDTH) && op != '?')
567 FAIL("regexp *+ operand could be empty");
568 *flagp = (op != '+') ? (WORST|SPSTART) : (WORST|HASWIDTH);
570 if (op == '*' && (flags&SIMPLE))
571 reginsert(STAR, ret);
572 else if (op == '*') {
573 /* Emit x* as (x&|), where & means "self". */
574 reginsert(BRANCH, ret); /* Either x */
575 regoptail(ret, regnode(BACK)); /* and loop */
576 regoptail(ret, ret); /* back */
577 regtail(ret, regnode(BRANCH)); /* or */
578 regtail(ret, regnode(NOTHING)); /* null. */
579 } else if (op == '+' && (flags&SIMPLE))
580 reginsert(PLUS, ret);
581 else if (op == '+') {
582 /* Emit x+ as x(&|), where & means "self". */
583 next = regnode(BRANCH); /* Either */
585 regtail(regnode(BACK), ret); /* loop back */
586 regtail(next, regnode(BRANCH)); /* or */
587 regtail(ret, regnode(NOTHING)); /* null. */
588 } else if (op == '?') {
589 /* Emit x? as (x|) */
590 reginsert(BRANCH, ret); /* Either x */
591 regtail(ret, regnode(BRANCH)); /* or */
592 next = regnode(NOTHING); /* null. */
594 regoptail(ret, next);
598 if (ISMULT2(regparse))
599 FAIL("nested *?+ in regexp");
605 - regatom - the lowest level
607 * Optimization: gobbles an entire sequence of ordinary characters so that
608 * it can turn them into a single node, which is smaller to store and
609 * faster to run. Backslashed characters are exceptions, each becoming a
610 * separate node; the code is simpler that way and it's not worth fixing.
612 * [Yes, it is worth fixing, some scripts can run twice the speed.]
621 *flagp = WORST; /* Tentatively. */
623 switch (*regparse++) {
632 *flagp |= HASWIDTH|SIMPLE;
636 *flagp |= HASWIDTH|SIMPLE;
639 ret = reg(1, &flags);
642 *flagp |= flags&(HASWIDTH|SPSTART);
646 FAIL("internal urp in regexp"); /* Supposed to be caught earlier. */
651 FAIL("?+* follows nothing in regexp");
656 ret = regnode(ALNUM);
657 *flagp |= HASWIDTH|SIMPLE;
661 ret = regnode(NALNUM);
662 *flagp |= HASWIDTH|SIMPLE;
666 ret = regnode(BOUND);
671 ret = regnode(NBOUND);
676 ret = regnode(SPACE);
677 *flagp |= HASWIDTH|SIMPLE;
681 ret = regnode(NSPACE);
682 *flagp |= HASWIDTH|SIMPLE;
686 ret = regnode(DIGIT);
687 *flagp |= HASWIDTH|SIMPLE;
691 ret = regnode(NDIGIT);
692 *flagp |= HASWIDTH|SIMPLE;
700 case '0': case '1': case '2': case '3': case '4':
701 case '5': case '6': case '7': case '8': case '9':
702 if (isdigit(regparse[1]) || *regparse == '0')
705 ret = regnode(REF + *regparse++ - '0');
710 if (regparse >= regxend)
711 FAIL("trailing \\ in regexp");
725 ret = regnode(EXACTLY);
726 regc(0); /* save spot for len */
727 for (len=0, p=regparse-1;
728 len < 127 && p < regxend;
769 case '0': case '1': case '2': case '3':case '4':
770 case '5': case '6': case '7': case '8':case '9':
771 if (isdigit(p[1]) || *p == '0') {
774 foo = (foo<<3) + *++p - '0';
776 foo = (foo<<3) + *++p - '0';
787 FAIL("trailing \\ in regexp");
798 if (regfold && isupper(ender))
799 ender = tolower(ender);
800 if (ISMULT2(p)) { /* Back off on ?+*. */
814 FAIL("internal disaster in regexp");
818 if (regcode != ®dummy)
834 if (regcode == ®dummy)
838 bits[c >> 3] &= ~(1 << (c & 7));
840 bits[c >> 3] |= (1 << (c & 7));
848 register int lastclass;
849 register int range = 0;
853 ret = regnode(ANYOF);
854 if (*regparse == '^') { /* Complement of range. */
861 for (class = 0; class < 32; class++)
863 if (*regparse == ']' || *regparse == '-')
864 goto skipcond; /* allow 1st char to be ] or - */
865 while (regparse < regxend && *regparse != ']') {
867 class = UCHARAT(regparse++);
869 class = UCHARAT(regparse++);
872 for (class = 'a'; class <= 'z'; class++)
873 regset(bits,def,class);
874 for (class = 'A'; class <= 'Z'; class++)
875 regset(bits,def,class);
876 for (class = '0'; class <= '9'; class++)
877 regset(bits,def,class);
878 regset(bits,def,'_');
882 regset(bits,def,' ');
883 regset(bits,def,'\t');
884 regset(bits,def,'\r');
885 regset(bits,def,'\f');
886 regset(bits,def,'\n');
890 for (class = '0'; class <= '9'; class++)
891 regset(bits,def,class);
909 case '0': case '1': case '2': case '3': case '4':
910 case '5': case '6': case '7': case '8': case '9':
912 if (isdigit(*regparse)) {
914 class += *regparse++ - '0';
916 if (isdigit(*regparse)) {
918 class += *regparse++ - '0';
924 if (lastclass > class)
925 FAIL("invalid [] range in regexp");
930 if (*regparse == '-' && regparse+1 < regxend &&
931 regparse[1] != ']') {
934 continue; /* do it next time */
937 for ( ; lastclass <= class; lastclass++) {
938 regset(bits,def,lastclass);
939 if (regfold && isupper(lastclass))
940 regset(bits,def,tolower(lastclass));
944 if (*regparse != ']')
945 FAIL("unmatched [] in regexp");
951 - regnode - emit a node
953 static char * /* Location. */
961 if (ret == ®dummy) {
972 if (!((long)ret & 1))
978 *ptr++ = '\0'; /* Null "next" pointer. */
986 - regc - emit (if appropriate) a byte of code
992 if (regcode != ®dummy)
999 - reginsert - insert an operator in front of already-emitted operand
1001 * Means relocating the operand.
1010 register char *place;
1011 register offset = (op == CURLY ? 4 : 0);
1013 if (regcode == ®dummy) {
1015 regsize += 4 + offset;
1017 regsize += 3 + offset;
1024 regcode += 4 + offset;
1026 regcode += 3 + offset;
1032 place = opnd; /* Op node, where operand used to be. */
1036 while (offset-- > 0)
1041 - regtail - set the next-pointer at the end of a node chain
1048 register char *scan;
1049 register char *temp;
1050 register int offset;
1055 /* Find last node. */
1058 temp = regnext(scan);
1065 offset = val - scan;
1067 *(short*)(scan+1) = offset;
1072 if (OP(scan) == BACK)
1073 offset = scan - val;
1075 offset = val - scan;
1076 *(scan+1) = (offset>>8)&0377;
1077 *(scan+2) = offset&0377;
1082 - regoptail - regtail on operand of first argument; nop if operandless
1089 /* "Operandless" and "op != BRANCH" are synonymous in practice. */
1090 if (p == NULL || p == ®dummy || OP(p) != BRANCH)
1092 regtail(NEXTOPER(p), val);
1096 - regcurly - a little FSA that accepts {\d+,?\d*}
1120 - regdump - dump a regexp onto stderr in vaguely comprehensible form
1127 register char op = EXACTLY; /* Arbitrary non-END op. */
1128 register char *next;
1129 extern char *index();
1133 while (op != END) { /* While that wasn't END last time... */
1139 fprintf(stderr,"%2d%s", s-r->program, regprop(s)); /* Where, what. */
1143 if (next == NULL) /* Next ptr. */
1144 fprintf(stderr,"(0)");
1146 fprintf(stderr,"(%d)", (s-r->program)+(next-s));
1151 if (op == EXACTLY) {
1152 /* Literal string, where present. */
1154 while (*s != '\0') {
1160 (void)putchar('\n');
1163 /* Header fields of interest. */
1165 fprintf(stderr,"start `%s' ", r->regstart->str_ptr);
1167 fprintf(stderr,"stclass `%s' ", regprop(r->regstclass));
1169 fprintf(stderr,"anchored ");
1171 fprintf(stderr,"plus ");
1172 if (r->regmust != NULL)
1173 fprintf(stderr,"must have \"%s\" back %d ", r->regmust->str_ptr,
1175 fprintf(stderr,"\n");
1179 - regprop - printable representation of opcode
1187 (void) strcpy(buf, ":");
1242 (void)sprintf(buf+strlen(buf), "CURLY {%d,%d}",
1256 (void)sprintf(buf+strlen(buf), "REF%d", OP(op)-REF);
1268 (void)sprintf(buf+strlen(buf), "OPEN%d", OP(op)-OPEN);
1280 (void)sprintf(buf+strlen(buf), "CLOSE%d", OP(op)-CLOSE);
1290 FAIL("corrupted regexp opcode");
1293 (void) strcat(buf, p);
1296 #endif /* DEBUGGING */
1302 Safefree(r->precomp);
1304 Safefree(r->subbase);
1306 str_free(r->regmust);
1308 str_free(r->regstart);