Fix spelling errors.
[oweals/busybox.git] / regexp.c
1 /* vi: set sw=4 ts=4: */
2 /* regexp.c */
3
4 #include "internal.h"
5 #include "regexp.h"
6 #include <setjmp.h>
7 #include <stdio.h>
8 #include <ctype.h>
9
10
11 #if ( defined BB_GREP || defined BB_SED)
12
13 /* This also tries to find a needle in a haystack, but uses
14  * real regular expressions....  The fake regular expression
15  * version of find_match lives in utility.c.  Using this version
16  * will add 3.9k to busybox...
17  *  -Erik Andersen
18  */
19 extern int find_match(char *haystack, char *needle, int ignoreCase)
20 {
21         int status;
22         struct regexp *re;
23
24         re = regcomp(needle);
25         status = regexec(re, haystack, FALSE, ignoreCase);
26         free(re);
27         return (status);
28 }
29
30 #if defined BB_SED
31 /* This performs substitutions after a regexp match has been found.  
32  * The new string is returned.  It is malloc'ed, and do must be freed. */
33 extern int replace_match(char *haystack, char *needle, char *newNeedle,
34                                                  int ignoreCase)
35 {
36         int status;
37         struct regexp *re;
38         char *s, buf[BUF_SIZE], *d = buf;
39
40         re = regcomp(needle);
41         status = regexec(re, haystack, FALSE, ignoreCase);
42         if (status == TRUE) {
43                 s = haystack;
44
45                 do {
46                         /* copy stuff from before the match */
47                         while (s < re->startp[0])
48                                 *d++ = *s++;
49                         /* substitute for the matched part */
50                         regsub(re, newNeedle, d);
51                         s = re->endp[0];
52                         d += strlen(d);
53                 } while (regexec(re, s, FALSE, ignoreCase) == TRUE);
54                 /* copy stuff from after the match */
55                 while ((*d++ = *s++)) {
56                 }
57                 d[0] = '\0';
58                 strcpy(haystack, buf);
59         }
60         free(re);
61         return (status);
62 }
63 #endif
64
65
66 /* code swiped from elvis-tiny 1.4 (a clone of vi) and adjusted to 
67  * suit the needs of busybox by Erik Andersen.
68  *
69  * From the README:
70  * "Elvis is freely redistributable, in either source form or executable form.
71  * There are no restrictions on how you may use it".
72  * Elvis was written by Steve Kirkendall <kirkenda@cs.pdx.edu>
73  *
74  *
75  * This file contains the code that compiles regular expressions and executes
76  * them.  It supports the same syntax and features as vi's regular expression
77  * code.  Specifically, the meta characters are:
78  *      ^       matches the beginning of a line
79  *      $       matches the end of a line
80  *      \<      matches the beginning of a word
81  *      \>      matches the end of a word
82  *      .       matches any single character
83  *      []      matches any character in a character class
84  *      \(      delimits the start of a subexpression
85  *      \)      delimits the end of a subexpression
86  *      *       repeats the preceding 0 or more times
87  * NOTE: You cannot follow a \) with a *.
88  *
89  * The physical structure of a compiled RE is as follows:
90  *      - First, there is a one-byte value that says how many character classes
91  *        are used in this regular expression
92  *      - Next, each character class is stored as a bitmap that is 256 bits
93  *        (32 bytes) long.
94  *      - A mixture of literal characters and compiled meta characters follows.
95  *        This begins with M_BEGIN(0) and ends with M_END(0).  All meta chars
96  *        are stored as a \n followed by a one-byte code, so they take up two
97  *        bytes apiece.  Literal characters take up one byte apiece.  \n can't
98  *        be used as a literal character.
99  *
100  */
101
102
103
104 static char *previous;                  /* the previous regexp, used when null regexp is given */
105
106 #if defined BB_SED
107 static char *previous1;                 /* a copy of the text from the previous substitution for regsub() */
108 #endif
109
110
111 /* These are used to classify or recognize meta-characters */
112 #define META            '\0'
113 #define BASE_META(m)    ((m) - 256)
114 #define INT_META(c)     ((c) + 256)
115 #define IS_META(m)      ((m) >= 256)
116 #define IS_CLASS(m)     ((m) >= M_CLASS(0) && (m) <= M_CLASS(9))
117 #define IS_START(m)     ((m) >= M_START(0) && (m) <= M_START(9))
118 #define IS_END(m)       ((m) >= M_END(0) && (m) <= M_END(9))
119 #define IS_CLOSURE(m)   ((m) >= M_SPLAT && (m) <= M_QMARK)
120 #define ADD_META(s,m)   (*(s)++ = META, *(s)++ = BASE_META(m))
121 #define GET_META(s)     (*(s) == META ? INT_META(*++(s)) : *s)
122
123 /* These are the internal codes used for each type of meta-character */
124 #define M_BEGLINE       256                     /* internal code for ^ */
125 #define M_ENDLINE       257                     /* internal code for $ */
126 #define M_BEGWORD       258                     /* internal code for \< */
127 #define M_ENDWORD       259                     /* internal code for \> */
128 #define M_ANY           260                     /* internal code for . */
129 #define M_SPLAT         261                     /* internal code for * */
130 #define M_PLUS          262                     /* internal code for \+ */
131 #define M_QMARK         263                     /* internal code for \? */
132 #define M_CLASS(n)      (264+(n))       /* internal code for [] */
133 #define M_START(n)      (274+(n))       /* internal code for \( */
134 #define M_END(n)        (284+(n))       /* internal code for \) */
135
136 /* These are used during compilation */
137 static int class_cnt;                   /* used to assign class IDs */
138 static int start_cnt;                   /* used to assign start IDs */
139 static int end_stk[NSUBEXP];    /* used to assign end IDs */
140 static int end_sp;
141 static char *retext;                    /* points to the text being compiled */
142
143 /* error-handling stuff */
144 jmp_buf errorhandler;
145
146 #define FAIL(why)  do {fprintf(stderr, why); longjmp(errorhandler, 1);} while (0)
147
148
149
150
151 /* This function builds a bitmap for a particular class */
152 /* text -- start of the class */
153 /* bmap -- the bitmap */
154 static char *makeclass(char *text, char *bmap)
155 {
156         int i;
157         int complement = 0;
158
159
160         /* zero the bitmap */
161         for (i = 0; bmap && i < 32; i++) {
162                 bmap[i] = 0;
163         }
164
165         /* see if we're going to complement this class */
166         if (*text == '^') {
167                 text++;
168                 complement = 1;
169         }
170
171         /* add in the characters */
172         while (*text && *text != ']') {
173                 /* is this a span of characters? */
174                 if (text[1] == '-' && text[2]) {
175                         /* spans can't be backwards */
176                         if (text[0] > text[2]) {
177                                 FAIL("Backwards span in []");
178                         }
179
180                         /* add each character in the span to the bitmap */
181                         for (i = text[0]; bmap && i <= text[2]; i++) {
182                                 bmap[i >> 3] |= (1 << (i & 7));
183                         }
184
185                         /* move past this span */
186                         text += 3;
187                 } else {
188                         /* add this single character to the span */
189                         i = *text++;
190                         if (bmap) {
191                                 bmap[i >> 3] |= (1 << (i & 7));
192                         }
193                 }
194         }
195
196         /* make sure the closing ] is missing */
197         if (*text++ != ']') {
198                 FAIL("] missing");
199         }
200
201         /* if we're supposed to complement this class, then do so */
202         if (complement && bmap) {
203                 for (i = 0; i < 32; i++) {
204                         bmap[i] = ~bmap[i];
205                 }
206         }
207
208         return text;
209 }
210
211
212
213
214 /* This function gets the next character or meta character from a string.
215  * The pointer is incremented by 1, or by 2 for \-quoted characters.  For [],
216  * a bitmap is generated via makeclass() (if re is given), and the
217  * character-class text is skipped.
218  */
219 static int gettoken(sptr, re)
220 char **sptr;
221 regexp *re;
222 {
223         int c;
224
225         c = **sptr;
226         ++*sptr;
227         if (c == '\\') {
228                 c = **sptr;
229                 ++*sptr;
230                 switch (c) {
231                 case '<':
232                         return M_BEGWORD;
233
234                 case '>':
235                         return M_ENDWORD;
236
237                 case '(':
238                         if (start_cnt >= NSUBEXP) {
239                                 FAIL("Too many \\(s");
240                         }
241                         end_stk[end_sp++] = start_cnt;
242                         return M_START(start_cnt++);
243
244                 case ')':
245                         if (end_sp <= 0) {
246                                 FAIL("Mismatched \\)");
247                         }
248                         return M_END(end_stk[--end_sp]);
249
250                 case '*':
251                         return M_SPLAT;
252
253                 case '.':
254                         return M_ANY;
255
256                 case '+':
257                         return M_PLUS;
258
259                 case '?':
260                         return M_QMARK;
261
262                 default:
263                         return c;
264                 }
265         } else {
266                 switch (c) {
267                 case '^':
268                         if (*sptr == retext + 1) {
269                                 return M_BEGLINE;
270                         }
271                         return c;
272
273                 case '$':
274                         if (!**sptr) {
275                                 return M_ENDLINE;
276                         }
277                         return c;
278
279                 case '.':
280                         return M_ANY;
281
282                 case '*':
283                         return M_SPLAT;
284
285                 case '[':
286                         /* make sure we don't have too many classes */
287                         if (class_cnt >= 10) {
288                                 FAIL("Too many []s");
289                         }
290
291                         /* process the character list for this class */
292                         if (re) {
293                                 /* generate the bitmap for this class */
294                                 *sptr = makeclass(*sptr, re->program + 1 + 32 * class_cnt);
295                         } else {
296                                 /* skip to end of the class */
297                                 *sptr = makeclass(*sptr, (char *) 0);
298                         }
299                         return M_CLASS(class_cnt++);
300
301                 default:
302                         return c;
303                 }
304         }
305  /*NOTREACHED*/}
306
307
308
309
310 /* This function calculates the number of bytes that will be needed for a
311  * compiled RE.  Its argument is the uncompiled version.  It is not clever
312  * about catching syntax errors; that is done in a later pass.
313  */
314 static unsigned calcsize(text)
315 char *text;
316 {
317         unsigned size;
318         int token;
319
320         retext = text;
321         class_cnt = 0;
322         start_cnt = 1;
323         end_sp = 0;
324         size = 5;
325         while ((token = gettoken(&text, (regexp *) 0)) != 0) {
326                 if (IS_CLASS(token)) {
327                         size += 34;
328                 } else if (IS_META(token)) {
329                         size += 2;
330                 } else {
331                         size++;
332                 }
333         }
334
335         return size;
336 }
337
338
339
340 /*---------------------------------------------------------------------------*/
341
342
343 /* This function checks for a match between a character and a token which is
344  * known to represent a single character.  It returns 0 if they match, or
345  * 1 if they don't.
346  */
347 static int match1(regexp * re, char ch, int token, int ignoreCase)
348 {
349         if (!ch) {
350                 /* the end of a line can't match any RE of width 1 */
351                 return 1;
352         }
353         if (token == M_ANY) {
354                 return 0;
355         } else if (IS_CLASS(token)) {
356                 if (re->program[1 + 32 * (token - M_CLASS(0)) + (ch >> 3)] & (1 << (ch & 7)))
357                         return 0;
358         }
359 //fprintf(stderr, "match1: ch='%c' token='%c': ", ch, token);
360         if (ch == token || (ignoreCase == TRUE && tolower(ch) == tolower(token))) {
361 //fprintf(stderr, "match\n");
362                 return 0;
363         }
364 //fprintf(stderr, "no match\n");
365         return 1;
366 }
367
368
369
370 /* This function checks characters up to and including the next closure, at
371  * which point it does a recursive call to check the rest of it.  This function
372  * returns 0 if everything matches, or 1 if something doesn't match.
373  */
374 /* re   -- the regular expression */
375 /* str  -- the string */
376 /* prog -- a portion of re->program, an compiled RE */
377 /* here -- a portion of str, the string to compare it to */
378 static int match(regexp * re, char *str, char *prog, char *here,
379                                  int ignoreCase)
380 {
381         int token;
382         int nmatched;
383         int closure;
384
385         for (token = GET_META(prog); !IS_CLOSURE(token);
386                  prog++, token = GET_META(prog)) {
387                 switch (token) {
388                         /*case M_BEGLINE: can't happen; re->bol is used instead */
389                 case M_ENDLINE:
390                         if (*here)
391                                 return 1;
392                         break;
393
394                 case M_BEGWORD:
395                         if (here != str &&
396                                 (here[-1] == '_' ||
397                                  (isascii(here[-1]) && isalnum(here[-1])))) return 1;
398                         break;
399
400                 case M_ENDWORD:
401                         if ((here[0] == '_' || isascii(here[0])) && isalnum(here[0]))
402                                 return 1;
403                         break;
404
405                 case M_START(0):
406                 case M_START(1):
407                 case M_START(2):
408                 case M_START(3):
409                 case M_START(4):
410                 case M_START(5):
411                 case M_START(6):
412                 case M_START(7):
413                 case M_START(8):
414                 case M_START(9):
415                         re->startp[token - M_START(0)] = (char *) here;
416                         break;
417
418                 case M_END(0):
419                 case M_END(1):
420                 case M_END(2):
421                 case M_END(3):
422                 case M_END(4):
423                 case M_END(5):
424                 case M_END(6):
425                 case M_END(7):
426                 case M_END(8):
427                 case M_END(9):
428                         re->endp[token - M_END(0)] = (char *) here;
429                         if (token == M_END(0)) {
430                                 return 0;
431                         }
432                         break;
433
434                 default:                                /* literal, M_CLASS(n), or M_ANY */
435                         if (match1(re, *here, token, ignoreCase) != 0)
436                                 return 1;
437                         here++;
438                 }
439         }
440
441         /* C L O S U R E */
442
443         /* step 1: see what we have to match against, and move "prog" to point
444          * the the remainder of the compiled RE.
445          */
446         closure = token;
447         prog++, token = GET_META(prog);
448         prog++;
449
450         /* step 2: see how many times we can match that token against the string */
451         for (nmatched = 0;
452                  (closure != M_QMARK || nmatched < 1) && *here
453                  && match1(re, *here, token, ignoreCase) == 0; nmatched++, here++) {
454         }
455
456         /* step 3: try to match the remainder, and back off if it doesn't */
457         while (nmatched >= 0 && match(re, str, prog, here, ignoreCase) != 0) {
458                 nmatched--;
459                 here--;
460         }
461
462         /* so how did it work out? */
463         if (nmatched >= ((closure == M_PLUS) ? 1 : 0))
464                 return 0;
465         return 1;
466 }
467
468
469 /* This function compiles a regexp. */
470 extern regexp *regcomp(char *text)
471 {
472         int needfirst;
473         unsigned size;
474         int token;
475         int peek;
476         char *build;
477         regexp *re;
478
479
480         /* prepare for error handling */
481         re = (regexp *) 0;
482         if (setjmp(errorhandler)) {
483                 if (re) {
484                         free(re);
485                 }
486                 return (regexp *) 0;
487         }
488
489         /* if an empty regexp string was given, use the previous one */
490         if (*text == 0) {
491                 if (!previous) {
492                         FAIL("No previous RE");
493                 }
494                 text = previous;
495         } else {                                        /* non-empty regexp given, so remember it */
496
497                 if (previous)
498                         free(previous);
499                 previous = (char *) malloc((unsigned) (strlen(text) + 1));
500                 if (previous)
501                         strcpy(previous, text);
502         }
503
504         /* allocate memory */
505         class_cnt = 0;
506         start_cnt = 1;
507         end_sp = 0;
508         retext = text;
509         size = calcsize(text) + sizeof(regexp);
510         re = (regexp *) malloc((unsigned) size);
511
512         if (!re) {
513                 FAIL("Not enough memory for this RE");
514         }
515
516         /* compile it */
517         build = &re->program[1 + 32 * class_cnt];
518         re->program[0] = class_cnt;
519         for (token = 0; token < NSUBEXP; token++) {
520                 re->startp[token] = re->endp[token] = (char *) 0;
521         }
522         re->first = 0;
523         re->bol = 0;
524         re->minlen = 0;
525         needfirst = 1;
526         class_cnt = 0;
527         start_cnt = 1;
528         end_sp = 0;
529         retext = text;
530         for (token = M_START(0), peek = gettoken(&text, re);
531                  token; token = peek, peek = gettoken(&text, re)) {
532
533                 /* special processing for the closure operator */
534                 if (IS_CLOSURE(peek)) {
535
536                         /* detect misuse of closure operator */
537                         if (IS_START(token)) {
538                                 FAIL("* or \\+ or \\? follows nothing");
539                         } else if (IS_META(token) && token != M_ANY && !IS_CLASS(token)) {
540                                 FAIL("* or \\+ or \\? can only follow a normal character or . or []");
541                         }
542
543                         /* it is okay -- make it prefix instead of postfix */
544                         ADD_META(build, peek);
545
546                         /* take care of "needfirst" - is this the first char? */
547                         if (needfirst && peek == M_PLUS && !IS_META(token)) {
548                                 re->first = token;
549                         }
550                         needfirst = 0;
551
552                         /* we used "peek" -- need to refill it */
553                         peek = gettoken(&text, re);
554                         if (IS_CLOSURE(peek)) {
555                                 FAIL("* or \\+ or \\? doubled up");
556                         }
557                 } else if (!IS_META(token)) {
558                         /* normal char is NOT argument of closure */
559                         if (needfirst) {
560                                 re->first = token;
561                                 needfirst = 0;
562                         }
563                         re->minlen++;
564                 } else if (token == M_ANY || IS_CLASS(token)) {
565                         /* . or [] is NOT argument of closure */
566                         needfirst = 0;
567                         re->minlen++;
568                 }
569
570                 /* the "token" character is not closure -- process it normally */
571                 if (token == M_BEGLINE) {
572                         /* set the BOL flag instead of storing M_BEGLINE */
573                         re->bol = 1;
574                 } else if (IS_META(token)) {
575                         ADD_META(build, token);
576                 } else {
577                         *build++ = token;
578                 }
579         }
580
581         /* end it with a \) which MUST MATCH the opening \( */
582         ADD_META(build, M_END(0));
583         if (end_sp > 0) {
584                 FAIL("Not enough \\)s");
585         }
586
587         return re;
588 }
589
590
591
592
593 /* This function searches through a string for text that matches an RE. */
594 /* re  -- the compiled regexp to search for */
595 /* str -- the string to search through */
596 /* bol -- does str start at the beginning of a line? (boolean) */
597 /* ignoreCase -- ignoreCase or not */
598 extern int regexec(struct regexp *re, char *str, int bol, int ignoreCase)
599 {
600         char *prog;                                     /* the entry point of re->program */
601         int len;                                        /* length of the string */
602         char *here;
603
604         /* if must start at the beginning of a line, and this isn't, then fail */
605         if (re->bol && bol == TRUE) {
606                 return FALSE;
607         }
608
609         len = strlen(str);
610         prog = re->program + 1 + 32 * re->program[0];
611
612         /* search for the RE in the string */
613         if (re->bol) {
614                 /* must occur at BOL */
615                 if ((re->first && match1(re, *(char *) str, re->first, ignoreCase))     /* wrong first letter? */
616                         ||len < re->minlen      /* not long enough? */
617                         || match(re, (char *) str, prog, str, ignoreCase))      /* doesn't match? */
618                         return FALSE;           /* THEN FAIL! */
619         } else if (ignoreCase == FALSE) {
620                 /* can occur anywhere in the line, noignorecase */
621                 for (here = (char *) str; (re->first && re->first != *here)
622                          || match(re, (char *) str, prog, here, ignoreCase);
623                          here++, len--) {
624                         if (len < re->minlen)
625                                 return FALSE;
626                 }
627         } else {
628                 /* can occur anywhere in the line, ignorecase */
629                 for (here = (char *) str;
630                          (re->first && match1(re, *here, (int) re->first, ignoreCase))
631                          || match(re, (char *) str, prog, here, ignoreCase);
632                          here++, len--) {
633                         if (len < re->minlen)
634                                 return FALSE;
635                 }
636         }
637
638         /* if we didn't fail, then we must have succeeded */
639         return TRUE;
640 }
641
642
643
644
645 #if defined BB_SED
646 /* This performs substitutions after a regexp match has been found.  */
647 extern void regsub(regexp * re, char *src, char *dst)
648 {
649         char *cpy;
650         char *end;
651         char c;
652         char *start;
653         int mod;
654
655         mod = 0;
656
657         start = src;
658         while ((c = *src++) != '\0') {
659                 /* recognize any meta characters */
660                 if (c == '&') {
661                         cpy = re->startp[0];
662                         end = re->endp[0];
663                 } else if (c == '~') {
664                         cpy = previous1;
665                         if (cpy)
666                                 end = cpy + strlen(cpy);
667                 } else if (c == '\\') {
668                         c = *src++;
669                         switch (c) {
670                         case '0':
671                         case '1':
672                         case '2':
673                         case '3':
674                         case '4':
675                         case '5':
676                         case '6':
677                         case '7':
678                         case '8':
679                         case '9':
680                                 /* \0 thru \9 mean "copy subexpression" */
681                                 c -= '0';
682                                 cpy = re->startp[(int) c];
683                                 end = re->endp[(int) c];
684                                 break;
685                         case 'U':
686                         case 'u':
687                         case 'L':
688                         case 'l':
689                                 /* \U and \L mean "convert to upper/lowercase" */
690                                 mod = c;
691                                 continue;
692
693                         case 'E':
694                         case 'e':
695                                 /* \E ends the \U or \L */
696                                 mod = 0;
697                                 continue;
698                         case '&':
699                                 /* "\&" means "original text" */
700                                 *dst++ = c;
701                                 continue;
702
703                         case '~':
704                                 /* "\~" means "previous text, if any" */
705                                 *dst++ = c;
706                                 continue;
707                         default:
708                                 /* ordinary char preceded by backslash */
709                                 *dst++ = c;
710                                 continue;
711                         }
712                 } else {
713                         /* ordinary character, so just copy it */
714                         *dst++ = c;
715                         continue;
716                 }
717
718                 /* Note: to reach this point in the code, we must have evaded
719                  * all "continue" statements.  To do that, we must have hit
720                  * a metacharacter that involves copying.
721                  */
722
723                 /* if there is nothing to copy, loop */
724                 if (!cpy)
725                         continue;
726
727                 /* copy over a portion of the original */
728                 while (cpy < end) {
729                         switch (mod) {
730                         case 'U':
731                         case 'u':
732                                 /* convert to uppercase */
733                                 if (isascii(*cpy) && islower(*cpy)) {
734                                         *dst++ = toupper(*cpy);
735                                         cpy++;
736                                 } else {
737                                         *dst++ = *cpy++;
738                                 }
739                                 break;
740
741                         case 'L':
742                         case 'l':
743                                 /* convert to lowercase */
744                                 if (isascii(*cpy) && isupper(*cpy)) {
745                                         *dst++ = tolower(*cpy);
746                                         cpy++;
747                                 } else {
748                                         *dst++ = *cpy++;
749                                 }
750                                 break;
751
752                         default:
753                                 /* copy without any conversion */
754                                 *dst++ = *cpy++;
755                         }
756
757                         /* \u and \l end automatically after the first char */
758                         if (mod && (mod == 'u' || mod == 'l')) {
759                                 mod = 0;
760                         }
761                 }
762         }
763         *dst = '\0';
764
765         /* remember what text we inserted this time */
766         if (previous1)
767                 free(previous1);
768         previous1 = (char *) malloc((unsigned) (strlen(start) + 1));
769         if (previous1)
770                 strcpy(previous1, start);
771 }
772 #endif
773
774 #endif                                                  /* BB_REGEXP */