New version from FSF.
[gnulib.git] / lib / regex.c
1 /* Extended regular expression matching and search library,
2    version 0.12.
3    (Implements POSIX draft P10003.2/D11.2, except for
4    internationalization features.)
5
6    Copyright (C) 1993, 1994 Free Software Foundation, Inc.
7
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2, or (at your option)
11    any later version.
12
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
21
22 /* AIX requires this to be the first thing in the file. */
23 #if defined (_AIX) && !defined (REGEX_MALLOC)
24   #pragma alloca
25 #endif
26
27 #define _GNU_SOURCE
28
29 #ifdef HAVE_CONFIG_H
30 #include <config.h>
31 #endif
32
33 /* We need this for `regex.h', and perhaps for the Emacs include files.  */
34 #include <sys/types.h>
35
36 /* This is for other GNU distributions with internationalized messages.
37    The GNU C Library itself does not yet support such messages.  */
38 #if HAVE_LIBINTL_H
39 # include <libintl.h>
40 #else
41 # define gettext(msgid) (msgid)
42 #endif
43
44 /* The `emacs' switch turns on certain matching commands
45    that make sense only in Emacs. */
46 #ifdef emacs
47
48 #include "lisp.h"
49 #include "buffer.h"
50 #include "syntax.h"
51
52 #else  /* not emacs */
53
54 #ifdef STDC_HEADERS
55 #include <stdlib.h>
56 #else
57 char *malloc ();
58 char *realloc ();
59 #endif
60
61
62 /* We used to test for `BSTRING' here, but only GCC and Emacs define
63    `BSTRING', as far as I know, and neither of them use this code.  */
64 #ifndef INHIBIT_STRING_HEADER
65 #if HAVE_STRING_H || STDC_HEADERS
66 #include <string.h>
67 #ifndef bcmp
68 #define bcmp(s1, s2, n) memcmp ((s1), (s2), (n))
69 #endif
70 #ifndef bcopy
71 #define bcopy(s, d, n)  memcpy ((d), (s), (n))
72 #endif
73 #ifndef bzero
74 #define bzero(s, n)     memset ((s), 0, (n))
75 #endif
76 #else
77 #include <strings.h>
78 #endif
79 #endif
80
81 /* Define the syntax stuff for \<, \>, etc.  */
82
83 /* This must be nonzero for the wordchar and notwordchar pattern
84    commands in re_match_2.  */
85 #ifndef Sword 
86 #define Sword 1
87 #endif
88
89 #ifdef SWITCH_ENUM_BUG
90 #define SWITCH_ENUM_CAST(x) ((int)(x))
91 #else
92 #define SWITCH_ENUM_CAST(x) (x)
93 #endif
94
95 #ifdef SYNTAX_TABLE
96
97 extern char *re_syntax_table;
98
99 #else /* not SYNTAX_TABLE */
100
101 /* How many characters in the character set.  */
102 #define CHAR_SET_SIZE 256
103
104 static char re_syntax_table[CHAR_SET_SIZE];
105
106 static void
107 init_syntax_once ()
108 {
109    register int c;
110    static int done = 0;
111
112    if (done)
113      return;
114
115    bzero (re_syntax_table, sizeof re_syntax_table);
116
117    for (c = 'a'; c <= 'z'; c++)
118      re_syntax_table[c] = Sword;
119
120    for (c = 'A'; c <= 'Z'; c++)
121      re_syntax_table[c] = Sword;
122
123    for (c = '0'; c <= '9'; c++)
124      re_syntax_table[c] = Sword;
125
126    re_syntax_table['_'] = Sword;
127
128    done = 1;
129 }
130
131 #endif /* not SYNTAX_TABLE */
132
133 #define SYNTAX(c) re_syntax_table[c]
134
135 #endif /* not emacs */
136 \f
137 /* Get the interface, including the syntax bits.  */
138 #include "regex.h"
139
140 /* isalpha etc. are used for the character classes.  */
141 #include <ctype.h>
142
143 /* Jim Meyering writes:
144
145    "... Some ctype macros are valid only for character codes that
146    isascii says are ASCII (SGI's IRIX-4.0.5 is one such system --when
147    using /bin/cc or gcc but without giving an ansi option).  So, all
148    ctype uses should be through macros like ISPRINT...  If
149    STDC_HEADERS is defined, then autoconf has verified that the ctype
150    macros don't need to be guarded with references to isascii. ...
151    Defining isascii to 1 should let any compiler worth its salt
152    eliminate the && through constant folding."  */
153
154 #if defined (STDC_HEADERS) || (!defined (isascii) && !defined (HAVE_ISASCII))
155 #define ISASCII(c) 1
156 #else
157 #define ISASCII(c) isascii(c)
158 #endif
159
160 #ifdef isblank
161 #define ISBLANK(c) (ISASCII (c) && isblank (c))
162 #else
163 #define ISBLANK(c) ((c) == ' ' || (c) == '\t')
164 #endif
165 #ifdef isgraph
166 #define ISGRAPH(c) (ISASCII (c) && isgraph (c))
167 #else
168 #define ISGRAPH(c) (ISASCII (c) && isprint (c) && !isspace (c))
169 #endif
170
171 #define ISPRINT(c) (ISASCII (c) && isprint (c))
172 #define ISDIGIT(c) (ISASCII (c) && isdigit (c))
173 #define ISALNUM(c) (ISASCII (c) && isalnum (c))
174 #define ISALPHA(c) (ISASCII (c) && isalpha (c))
175 #define ISCNTRL(c) (ISASCII (c) && iscntrl (c))
176 #define ISLOWER(c) (ISASCII (c) && islower (c))
177 #define ISPUNCT(c) (ISASCII (c) && ispunct (c))
178 #define ISSPACE(c) (ISASCII (c) && isspace (c))
179 #define ISUPPER(c) (ISASCII (c) && isupper (c))
180 #define ISXDIGIT(c) (ISASCII (c) && isxdigit (c))
181
182 #ifndef NULL
183 #define NULL 0
184 #endif
185
186 /* We remove any previous definition of `SIGN_EXTEND_CHAR',
187    since ours (we hope) works properly with all combinations of
188    machines, compilers, `char' and `unsigned char' argument types.
189    (Per Bothner suggested the basic approach.)  */
190 #undef SIGN_EXTEND_CHAR
191 #if __STDC__
192 #define SIGN_EXTEND_CHAR(c) ((signed char) (c))
193 #else  /* not __STDC__ */
194 /* As in Harbison and Steele.  */
195 #define SIGN_EXTEND_CHAR(c) ((((unsigned char) (c)) ^ 128) - 128)
196 #endif
197 \f
198 /* Should we use malloc or alloca?  If REGEX_MALLOC is not defined, we
199    use `alloca' instead of `malloc'.  This is because using malloc in
200    re_search* or re_match* could cause memory leaks when C-g is used in
201    Emacs; also, malloc is slower and causes storage fragmentation.  On
202    the other hand, malloc is more portable, and easier to debug.  
203    
204    Because we sometimes use alloca, some routines have to be macros,
205    not functions -- `alloca'-allocated space disappears at the end of the
206    function it is called in.  */
207
208 #ifdef REGEX_MALLOC
209
210 #define REGEX_ALLOCATE malloc
211 #define REGEX_REALLOCATE(source, osize, nsize) realloc (source, nsize)
212 #define REGEX_FREE free
213
214 #else /* not REGEX_MALLOC  */
215
216 /* Emacs already defines alloca, sometimes.  */
217 #ifndef alloca
218
219 /* Make alloca work the best possible way.  */
220 #ifdef __GNUC__
221 #define alloca __builtin_alloca
222 #else /* not __GNUC__ */
223 #if HAVE_ALLOCA_H
224 #include <alloca.h>
225 #else /* not __GNUC__ or HAVE_ALLOCA_H */
226 #ifndef _AIX /* Already did AIX, up at the top.  */
227 char *alloca ();
228 #endif /* not _AIX */
229 #endif /* not HAVE_ALLOCA_H */ 
230 #endif /* not __GNUC__ */
231
232 #endif /* not alloca */
233
234 #define REGEX_ALLOCATE alloca
235
236 /* Assumes a `char *destination' variable.  */
237 #define REGEX_REALLOCATE(source, osize, nsize)                          \
238   (destination = (char *) alloca (nsize),                               \
239    bcopy (source, destination, osize),                                  \
240    destination)
241
242 /* No need to do anything to free, after alloca.  */
243 #define REGEX_FREE(arg)
244
245 #endif /* not REGEX_MALLOC */
246
247 /* Define how to allocate the failure stack.  */
248
249 #ifdef REL_ALLOC
250 #define REGEX_ALLOCATE_STACK(size)                              \
251   r_alloc (&failure_stack_ptr, (size))
252 #define REGEX_REALLOCATE_STACK(source, osize, nsize)            \
253   r_re_alloc (&failure_stack_ptr, (nsize))
254 #define REGEX_FREE_STACK(ptr)                                   \
255   r_alloc_free (&failure_stack_ptr)
256
257 #else /* not REL_ALLOC */
258
259 #ifdef REGEX_MALLOC
260
261 #define REGEX_ALLOCATE_STACK malloc
262 #define REGEX_REALLOCATE_STACK(source, osize, nsize) realloc (source, nsize)
263 #define REGEX_FREE_STACK free
264
265 #else /* not REGEX_MALLOC */
266
267 #define REGEX_ALLOCATE_STACK alloca
268
269 #define REGEX_REALLOCATE_STACK(source, osize, nsize)                    \
270    REGEX_REALLOCATE (source, osize, nsize)
271 /* No need to explicitly free anything.  */
272 #define REGEX_FREE_STACK(arg)
273
274 #endif /* not REGEX_MALLOC */
275 #endif /* not REL_ALLOC */
276
277
278 /* True if `size1' is non-NULL and PTR is pointing anywhere inside
279    `string1' or just past its end.  This works if PTR is NULL, which is
280    a good thing.  */
281 #define FIRST_STRING_P(ptr)                                     \
282   (size1 && string1 <= (ptr) && (ptr) <= string1 + size1)
283
284 /* (Re)Allocate N items of type T using malloc, or fail.  */
285 #define TALLOC(n, t) ((t *) malloc ((n) * sizeof (t)))
286 #define RETALLOC(addr, n, t) ((addr) = (t *) realloc (addr, (n) * sizeof (t)))
287 #define RETALLOC_IF(addr, n, t) \
288   if (addr) RETALLOC((addr), (n), t); else (addr) = TALLOC ((n), t)
289 #define REGEX_TALLOC(n, t) ((t *) REGEX_ALLOCATE ((n) * sizeof (t)))
290
291 #define BYTEWIDTH 8 /* In bits.  */
292
293 #define STREQ(s1, s2) ((strcmp (s1, s2) == 0))
294
295 #undef MAX
296 #undef MIN
297 #define MAX(a, b) ((a) > (b) ? (a) : (b))
298 #define MIN(a, b) ((a) < (b) ? (a) : (b))
299
300 typedef char boolean;
301 #define false 0
302 #define true 1
303
304 static int re_match_2_internal ();
305 \f
306 /* These are the command codes that appear in compiled regular
307    expressions.  Some opcodes are followed by argument bytes.  A
308    command code can specify any interpretation whatsoever for its
309    arguments.  Zero bytes may appear in the compiled regular expression.  */
310
311 typedef enum
312 {
313   no_op = 0,
314
315   /* Succeed right away--no more backtracking.  */
316   succeed,
317
318         /* Followed by one byte giving n, then by n literal bytes.  */
319   exactn,
320
321         /* Matches any (more or less) character.  */
322   anychar,
323
324         /* Matches any one char belonging to specified set.  First
325            following byte is number of bitmap bytes.  Then come bytes
326            for a bitmap saying which chars are in.  Bits in each byte
327            are ordered low-bit-first.  A character is in the set if its
328            bit is 1.  A character too large to have a bit in the map is
329            automatically not in the set.  */
330   charset,
331
332         /* Same parameters as charset, but match any character that is
333            not one of those specified.  */
334   charset_not,
335
336         /* Start remembering the text that is matched, for storing in a
337            register.  Followed by one byte with the register number, in
338            the range 0 to one less than the pattern buffer's re_nsub
339            field.  Then followed by one byte with the number of groups
340            inner to this one.  (This last has to be part of the
341            start_memory only because we need it in the on_failure_jump
342            of re_match_2.)  */
343   start_memory,
344
345         /* Stop remembering the text that is matched and store it in a
346            memory register.  Followed by one byte with the register
347            number, in the range 0 to one less than `re_nsub' in the
348            pattern buffer, and one byte with the number of inner groups,
349            just like `start_memory'.  (We need the number of inner
350            groups here because we don't have any easy way of finding the
351            corresponding start_memory when we're at a stop_memory.)  */
352   stop_memory,
353
354         /* Match a duplicate of something remembered. Followed by one
355            byte containing the register number.  */
356   duplicate,
357
358         /* Fail unless at beginning of line.  */
359   begline,
360
361         /* Fail unless at end of line.  */
362   endline,
363
364         /* Succeeds if at beginning of buffer (if emacs) or at beginning
365            of string to be matched (if not).  */
366   begbuf,
367
368         /* Analogously, for end of buffer/string.  */
369   endbuf,
370  
371         /* Followed by two byte relative address to which to jump.  */
372   jump, 
373
374         /* Same as jump, but marks the end of an alternative.  */
375   jump_past_alt,
376
377         /* Followed by two-byte relative address of place to resume at
378            in case of failure.  */
379   on_failure_jump,
380         
381         /* Like on_failure_jump, but pushes a placeholder instead of the
382            current string position when executed.  */
383   on_failure_keep_string_jump,
384   
385         /* Throw away latest failure point and then jump to following
386            two-byte relative address.  */
387   pop_failure_jump,
388
389         /* Change to pop_failure_jump if know won't have to backtrack to
390            match; otherwise change to jump.  This is used to jump
391            back to the beginning of a repeat.  If what follows this jump
392            clearly won't match what the repeat does, such that we can be
393            sure that there is no use backtracking out of repetitions
394            already matched, then we change it to a pop_failure_jump.
395            Followed by two-byte address.  */
396   maybe_pop_jump,
397
398         /* Jump to following two-byte address, and push a dummy failure
399            point. This failure point will be thrown away if an attempt
400            is made to use it for a failure.  A `+' construct makes this
401            before the first repeat.  Also used as an intermediary kind
402            of jump when compiling an alternative.  */
403   dummy_failure_jump,
404
405         /* Push a dummy failure point and continue.  Used at the end of
406            alternatives.  */
407   push_dummy_failure,
408
409         /* Followed by two-byte relative address and two-byte number n.
410            After matching N times, jump to the address upon failure.  */
411   succeed_n,
412
413         /* Followed by two-byte relative address, and two-byte number n.
414            Jump to the address N times, then fail.  */
415   jump_n,
416
417         /* Set the following two-byte relative address to the
418            subsequent two-byte number.  The address *includes* the two
419            bytes of number.  */
420   set_number_at,
421
422   wordchar,     /* Matches any word-constituent character.  */
423   notwordchar,  /* Matches any char that is not a word-constituent.  */
424
425   wordbeg,      /* Succeeds if at word beginning.  */
426   wordend,      /* Succeeds if at word end.  */
427
428   wordbound,    /* Succeeds if at a word boundary.  */
429   notwordbound  /* Succeeds if not at a word boundary.  */
430
431 #ifdef emacs
432   ,before_dot,  /* Succeeds if before point.  */
433   at_dot,       /* Succeeds if at point.  */
434   after_dot,    /* Succeeds if after point.  */
435
436         /* Matches any character whose syntax is specified.  Followed by
437            a byte which contains a syntax code, e.g., Sword.  */
438   syntaxspec,
439
440         /* Matches any character whose syntax is not that specified.  */
441   notsyntaxspec
442 #endif /* emacs */
443 } re_opcode_t;
444 \f
445 /* Common operations on the compiled pattern.  */
446
447 /* Store NUMBER in two contiguous bytes starting at DESTINATION.  */
448
449 #define STORE_NUMBER(destination, number)                               \
450   do {                                                                  \
451     (destination)[0] = (number) & 0377;                                 \
452     (destination)[1] = (number) >> 8;                                   \
453   } while (0)
454
455 /* Same as STORE_NUMBER, except increment DESTINATION to
456    the byte after where the number is stored.  Therefore, DESTINATION
457    must be an lvalue.  */
458
459 #define STORE_NUMBER_AND_INCR(destination, number)                      \
460   do {                                                                  \
461     STORE_NUMBER (destination, number);                                 \
462     (destination) += 2;                                                 \
463   } while (0)
464
465 /* Put into DESTINATION a number stored in two contiguous bytes starting
466    at SOURCE.  */
467
468 #define EXTRACT_NUMBER(destination, source)                             \
469   do {                                                                  \
470     (destination) = *(source) & 0377;                                   \
471     (destination) += SIGN_EXTEND_CHAR (*((source) + 1)) << 8;           \
472   } while (0)
473
474 #ifdef DEBUG
475 static void
476 extract_number (dest, source)
477     int *dest;
478     unsigned char *source;
479 {
480   int temp = SIGN_EXTEND_CHAR (*(source + 1)); 
481   *dest = *source & 0377;
482   *dest += temp << 8;
483 }
484
485 #ifndef EXTRACT_MACROS /* To debug the macros.  */
486 #undef EXTRACT_NUMBER
487 #define EXTRACT_NUMBER(dest, src) extract_number (&dest, src)
488 #endif /* not EXTRACT_MACROS */
489
490 #endif /* DEBUG */
491
492 /* Same as EXTRACT_NUMBER, except increment SOURCE to after the number.
493    SOURCE must be an lvalue.  */
494
495 #define EXTRACT_NUMBER_AND_INCR(destination, source)                    \
496   do {                                                                  \
497     EXTRACT_NUMBER (destination, source);                               \
498     (source) += 2;                                                      \
499   } while (0)
500
501 #ifdef DEBUG
502 static void
503 extract_number_and_incr (destination, source)
504     int *destination;
505     unsigned char **source;
506
507   extract_number (destination, *source);
508   *source += 2;
509 }
510
511 #ifndef EXTRACT_MACROS
512 #undef EXTRACT_NUMBER_AND_INCR
513 #define EXTRACT_NUMBER_AND_INCR(dest, src) \
514   extract_number_and_incr (&dest, &src)
515 #endif /* not EXTRACT_MACROS */
516
517 #endif /* DEBUG */
518 \f
519 /* If DEBUG is defined, Regex prints many voluminous messages about what
520    it is doing (if the variable `debug' is nonzero).  If linked with the
521    main program in `iregex.c', you can enter patterns and strings
522    interactively.  And if linked with the main program in `main.c' and
523    the other test files, you can run the already-written tests.  */
524
525 #ifdef DEBUG
526
527 /* We use standard I/O for debugging.  */
528 #include <stdio.h>
529
530 /* It is useful to test things that ``must'' be true when debugging.  */
531 #include <assert.h>
532
533 static int debug = 0;
534
535 #define DEBUG_STATEMENT(e) e
536 #define DEBUG_PRINT1(x) if (debug) printf (x)
537 #define DEBUG_PRINT2(x1, x2) if (debug) printf (x1, x2)
538 #define DEBUG_PRINT3(x1, x2, x3) if (debug) printf (x1, x2, x3)
539 #define DEBUG_PRINT4(x1, x2, x3, x4) if (debug) printf (x1, x2, x3, x4)
540 #define DEBUG_PRINT_COMPILED_PATTERN(p, s, e)                           \
541   if (debug) print_partial_compiled_pattern (s, e)
542 #define DEBUG_PRINT_DOUBLE_STRING(w, s1, sz1, s2, sz2)                  \
543   if (debug) print_double_string (w, s1, sz1, s2, sz2)
544
545
546 /* Print the fastmap in human-readable form.  */
547
548 void
549 print_fastmap (fastmap)
550     char *fastmap;
551 {
552   unsigned was_a_range = 0;
553   unsigned i = 0;  
554   
555   while (i < (1 << BYTEWIDTH))
556     {
557       if (fastmap[i++])
558         {
559           was_a_range = 0;
560           putchar (i - 1);
561           while (i < (1 << BYTEWIDTH)  &&  fastmap[i])
562             {
563               was_a_range = 1;
564               i++;
565             }
566           if (was_a_range)
567             {
568               printf ("-");
569               putchar (i - 1);
570             }
571         }
572     }
573   putchar ('\n'); 
574 }
575
576
577 /* Print a compiled pattern string in human-readable form, starting at
578    the START pointer into it and ending just before the pointer END.  */
579
580 void
581 print_partial_compiled_pattern (start, end)
582     unsigned char *start;
583     unsigned char *end;
584 {
585   int mcnt, mcnt2;
586   unsigned char *p = start;
587   unsigned char *pend = end;
588
589   if (start == NULL)
590     {
591       printf ("(null)\n");
592       return;
593     }
594     
595   /* Loop over pattern commands.  */
596   while (p < pend)
597     {
598       printf ("%d:\t", p - start);
599
600       switch ((re_opcode_t) *p++)
601         {
602         case no_op:
603           printf ("/no_op");
604           break;
605
606         case exactn:
607           mcnt = *p++;
608           printf ("/exactn/%d", mcnt);
609           do
610             {
611               putchar ('/');
612               putchar (*p++);
613             }
614           while (--mcnt);
615           break;
616
617         case start_memory:
618           mcnt = *p++;
619           printf ("/start_memory/%d/%d", mcnt, *p++);
620           break;
621
622         case stop_memory:
623           mcnt = *p++;
624           printf ("/stop_memory/%d/%d", mcnt, *p++);
625           break;
626
627         case duplicate:
628           printf ("/duplicate/%d", *p++);
629           break;
630
631         case anychar:
632           printf ("/anychar");
633           break;
634
635         case charset:
636         case charset_not:
637           {
638             register int c, last = -100;
639             register int in_range = 0;
640
641             printf ("/charset [%s",
642                     (re_opcode_t) *(p - 1) == charset_not ? "^" : "");
643             
644             assert (p + *p < pend);
645
646             for (c = 0; c < 256; c++)
647               if (c / 8 < *p
648                   && (p[1 + (c/8)] & (1 << (c % 8))))
649                 {
650                   /* Are we starting a range?  */
651                   if (last + 1 == c && ! in_range)
652                     {
653                       putchar ('-');
654                       in_range = 1;
655                     }
656                   /* Have we broken a range?  */
657                   else if (last + 1 != c && in_range)
658               {
659                       putchar (last);
660                       in_range = 0;
661                     }
662                 
663                   if (! in_range)
664                     putchar (c);
665
666                   last = c;
667               }
668
669             if (in_range)
670               putchar (last);
671
672             putchar (']');
673
674             p += 1 + *p;
675           }
676           break;
677
678         case begline:
679           printf ("/begline");
680           break;
681
682         case endline:
683           printf ("/endline");
684           break;
685
686         case on_failure_jump:
687           extract_number_and_incr (&mcnt, &p);
688           printf ("/on_failure_jump to %d", p + mcnt - start);
689           break;
690
691         case on_failure_keep_string_jump:
692           extract_number_and_incr (&mcnt, &p);
693           printf ("/on_failure_keep_string_jump to %d", p + mcnt - start);
694           break;
695
696         case dummy_failure_jump:
697           extract_number_and_incr (&mcnt, &p);
698           printf ("/dummy_failure_jump to %d", p + mcnt - start);
699           break;
700
701         case push_dummy_failure:
702           printf ("/push_dummy_failure");
703           break;
704           
705         case maybe_pop_jump:
706           extract_number_and_incr (&mcnt, &p);
707           printf ("/maybe_pop_jump to %d", p + mcnt - start);
708           break;
709
710         case pop_failure_jump:
711           extract_number_and_incr (&mcnt, &p);
712           printf ("/pop_failure_jump to %d", p + mcnt - start);
713           break;          
714           
715         case jump_past_alt:
716           extract_number_and_incr (&mcnt, &p);
717           printf ("/jump_past_alt to %d", p + mcnt - start);
718           break;          
719           
720         case jump:
721           extract_number_and_incr (&mcnt, &p);
722           printf ("/jump to %d", p + mcnt - start);
723           break;
724
725         case succeed_n: 
726           extract_number_and_incr (&mcnt, &p);
727           extract_number_and_incr (&mcnt2, &p);
728           printf ("/succeed_n to %d, %d times", p + mcnt - start, mcnt2);
729           break;
730         
731         case jump_n: 
732           extract_number_and_incr (&mcnt, &p);
733           extract_number_and_incr (&mcnt2, &p);
734           printf ("/jump_n to %d, %d times", p + mcnt - start, mcnt2);
735           break;
736         
737         case set_number_at: 
738           extract_number_and_incr (&mcnt, &p);
739           extract_number_and_incr (&mcnt2, &p);
740           printf ("/set_number_at location %d to %d", p + mcnt - start, mcnt2);
741           break;
742         
743         case wordbound:
744           printf ("/wordbound");
745           break;
746
747         case notwordbound:
748           printf ("/notwordbound");
749           break;
750
751         case wordbeg:
752           printf ("/wordbeg");
753           break;
754           
755         case wordend:
756           printf ("/wordend");
757           
758 #ifdef emacs
759         case before_dot:
760           printf ("/before_dot");
761           break;
762
763         case at_dot:
764           printf ("/at_dot");
765           break;
766
767         case after_dot:
768           printf ("/after_dot");
769           break;
770
771         case syntaxspec:
772           printf ("/syntaxspec");
773           mcnt = *p++;
774           printf ("/%d", mcnt);
775           break;
776           
777         case notsyntaxspec:
778           printf ("/notsyntaxspec");
779           mcnt = *p++;
780           printf ("/%d", mcnt);
781           break;
782 #endif /* emacs */
783
784         case wordchar:
785           printf ("/wordchar");
786           break;
787           
788         case notwordchar:
789           printf ("/notwordchar");
790           break;
791
792         case begbuf:
793           printf ("/begbuf");
794           break;
795
796         case endbuf:
797           printf ("/endbuf");
798           break;
799
800         default:
801           printf ("?%d", *(p-1));
802         }
803
804       putchar ('\n');
805     }
806
807   printf ("%d:\tend of pattern.\n", p - start);
808 }
809
810
811 void
812 print_compiled_pattern (bufp)
813     struct re_pattern_buffer *bufp;
814 {
815   unsigned char *buffer = bufp->buffer;
816
817   print_partial_compiled_pattern (buffer, buffer + bufp->used);
818   printf ("%d bytes used/%d bytes allocated.\n", bufp->used, bufp->allocated);
819
820   if (bufp->fastmap_accurate && bufp->fastmap)
821     {
822       printf ("fastmap: ");
823       print_fastmap (bufp->fastmap);
824     }
825
826   printf ("re_nsub: %d\t", bufp->re_nsub);
827   printf ("regs_alloc: %d\t", bufp->regs_allocated);
828   printf ("can_be_null: %d\t", bufp->can_be_null);
829   printf ("newline_anchor: %d\n", bufp->newline_anchor);
830   printf ("no_sub: %d\t", bufp->no_sub);
831   printf ("not_bol: %d\t", bufp->not_bol);
832   printf ("not_eol: %d\t", bufp->not_eol);
833   printf ("syntax: %d\n", bufp->syntax);
834   /* Perhaps we should print the translate table?  */
835 }
836
837
838 void
839 print_double_string (where, string1, size1, string2, size2)
840     const char *where;
841     const char *string1;
842     const char *string2;
843     int size1;
844     int size2;
845 {
846   unsigned this_char;
847   
848   if (where == NULL)
849     printf ("(null)");
850   else
851     {
852       if (FIRST_STRING_P (where))
853         {
854           for (this_char = where - string1; this_char < size1; this_char++)
855             putchar (string1[this_char]);
856
857           where = string2;    
858         }
859
860       for (this_char = where - string2; this_char < size2; this_char++)
861         putchar (string2[this_char]);
862     }
863 }
864
865 #else /* not DEBUG */
866
867 #undef assert
868 #define assert(e)
869
870 #define DEBUG_STATEMENT(e)
871 #define DEBUG_PRINT1(x)
872 #define DEBUG_PRINT2(x1, x2)
873 #define DEBUG_PRINT3(x1, x2, x3)
874 #define DEBUG_PRINT4(x1, x2, x3, x4)
875 #define DEBUG_PRINT_COMPILED_PATTERN(p, s, e)
876 #define DEBUG_PRINT_DOUBLE_STRING(w, s1, sz1, s2, sz2)
877
878 #endif /* not DEBUG */
879 \f
880 /* Set by `re_set_syntax' to the current regexp syntax to recognize.  Can
881    also be assigned to arbitrarily: each pattern buffer stores its own
882    syntax, so it can be changed between regex compilations.  */
883 /* This has no initializer because initialized variables in Emacs
884    become read-only after dumping.  */
885 reg_syntax_t re_syntax_options;
886
887
888 /* Specify the precise syntax of regexps for compilation.  This provides
889    for compatibility for various utilities which historically have
890    different, incompatible syntaxes.
891
892    The argument SYNTAX is a bit mask comprised of the various bits
893    defined in regex.h.  We return the old syntax.  */
894
895 reg_syntax_t
896 re_set_syntax (syntax)
897     reg_syntax_t syntax;
898 {
899   reg_syntax_t ret = re_syntax_options;
900   
901   re_syntax_options = syntax;
902   return ret;
903 }
904 \f
905 /* This table gives an error message for each of the error codes listed
906    in regex.h.  Obviously the order here has to be same as there.
907    POSIX doesn't require that we do anything for REG_NOERROR,
908    but why not be nice?  */
909
910 static const char *re_error_msgid[] =
911   { "Success",                                  /* REG_NOERROR */
912     "No match",                                 /* REG_NOMATCH */
913     "Invalid regular expression",               /* REG_BADPAT */
914     "Invalid collation character",              /* REG_ECOLLATE */
915     "Invalid character class name",             /* REG_ECTYPE */
916     "Trailing backslash",                       /* REG_EESCAPE */
917     "Invalid back reference",                   /* REG_ESUBREG */
918     "Unmatched [ or [^",                        /* REG_EBRACK */
919     "Unmatched ( or \\(",                       /* REG_EPAREN */
920     "Unmatched \\{",                            /* REG_EBRACE */
921     "Invalid content of \\{\\}",                /* REG_BADBR */
922     "Invalid range end",                        /* REG_ERANGE */
923     "Memory exhausted",                         /* REG_ESPACE */
924     "Invalid preceding regular expression",     /* REG_BADRPT */
925     "Premature end of regular expression",      /* REG_EEND */
926     "Regular expression too big",               /* REG_ESIZE */
927     "Unmatched ) or \\)",                       /* REG_ERPAREN */
928   };
929 \f
930 /* Avoiding alloca during matching, to placate r_alloc.  */
931
932 /* Define MATCH_MAY_ALLOCATE unless we need to make sure that the
933    searching and matching functions should not call alloca.  On some
934    systems, alloca is implemented in terms of malloc, and if we're
935    using the relocating allocator routines, then malloc could cause a
936    relocation, which might (if the strings being searched are in the
937    ralloc heap) shift the data out from underneath the regexp
938    routines.
939
940    Here's another reason to avoid allocation: Emacs 
941    processes input from X in a signal handler; processing X input may
942    call malloc; if input arrives while a matching routine is calling
943    malloc, then we're scrod.  But Emacs can't just block input while
944    calling matching routines; then we don't notice interrupts when
945    they come in.  So, Emacs blocks input around all regexp calls
946    except the matching calls, which it leaves unprotected, in the
947    faith that they will not malloc.  */
948
949 /* Normally, this is fine.  */
950 #define MATCH_MAY_ALLOCATE
951
952 /* When using GNU C, we are not REALLY using the C alloca, no matter
953    what config.h may say.  So don't take precautions for it.  */
954 #ifdef __GNUC__
955 #undef C_ALLOCA
956 #endif
957
958 /* The match routines may not allocate if (1) they would do it with malloc
959    and (2) it's not safe for them to use malloc.  */
960 #if (defined (C_ALLOCA) || defined (REGEX_MALLOC)) && (defined (emacs) || defined (REL_ALLOC))
961 #undef MATCH_MAY_ALLOCATE
962 #endif
963
964 \f
965 /* Failure stack declarations and macros; both re_compile_fastmap and
966    re_match_2 use a failure stack.  These have to be macros because of
967    REGEX_ALLOCATE_STACK.  */
968    
969
970 /* Number of failure points for which to initially allocate space
971    when matching.  If this number is exceeded, we allocate more
972    space, so it is not a hard limit.  */
973 #ifndef INIT_FAILURE_ALLOC
974 #define INIT_FAILURE_ALLOC 5
975 #endif
976
977 /* Roughly the maximum number of failure points on the stack.  Would be
978    exactly that if always used MAX_FAILURE_SPACE each time we failed.
979    This is a variable only so users of regex can assign to it; we never
980    change it ourselves.  */
981 #ifdef REL_ALLOC
982 int re_max_failures = 20000000;
983 #else
984 int re_max_failures = 2000;
985 #endif
986
987 typedef unsigned char *fail_stack_elt_t;
988
989 typedef struct
990 {
991   fail_stack_elt_t *stack;
992   unsigned size;
993   unsigned avail;                       /* Offset of next open position.  */
994 } fail_stack_type;
995
996 #define FAIL_STACK_EMPTY()     (fail_stack.avail == 0)
997 #define FAIL_STACK_PTR_EMPTY() (fail_stack_ptr->avail == 0)
998 #define FAIL_STACK_FULL()      (fail_stack.avail == fail_stack.size)
999 #define FAIL_STACK_TOP()       (fail_stack.stack[fail_stack.avail])
1000
1001
1002 /* Initialize `fail_stack'.  Do `return -2' if the alloc fails.  */
1003
1004 #ifdef MATCH_MAY_ALLOCATE
1005 #define INIT_FAIL_STACK()                                               \
1006   do {                                                                  \
1007     fail_stack.stack = (fail_stack_elt_t *)                             \
1008       REGEX_ALLOCATE_STACK (INIT_FAILURE_ALLOC * sizeof (fail_stack_elt_t));    \
1009                                                                         \
1010     if (fail_stack.stack == NULL)                                       \
1011       return -2;                                                        \
1012                                                                         \
1013     fail_stack.size = INIT_FAILURE_ALLOC;                               \
1014     fail_stack.avail = 0;                                               \
1015   } while (0)
1016 #else
1017 #define INIT_FAIL_STACK()                                               \
1018   do {                                                                  \
1019     fail_stack.avail = 0;                                               \
1020   } while (0)
1021 #endif
1022
1023
1024 /* Double the size of FAIL_STACK, up to approximately `re_max_failures' items.
1025
1026    Return 1 if succeeds, and 0 if either ran out of memory
1027    allocating space for it or it was already too large.  
1028    
1029    REGEX_REALLOCATE_STACK requires `destination' be declared.   */
1030
1031 #define DOUBLE_FAIL_STACK(fail_stack)                                   \
1032   ((fail_stack).size > re_max_failures * MAX_FAILURE_ITEMS              \
1033    ? 0                                                                  \
1034    : ((fail_stack).stack = (fail_stack_elt_t *)                         \
1035         REGEX_REALLOCATE_STACK ((fail_stack).stack,                     \
1036           (fail_stack).size * sizeof (fail_stack_elt_t),                \
1037           ((fail_stack).size << 1) * sizeof (fail_stack_elt_t)),        \
1038                                                                         \
1039       (fail_stack).stack == NULL                                        \
1040       ? 0                                                               \
1041       : ((fail_stack).size <<= 1,                                       \
1042          1)))
1043
1044
1045 /* Push PATTERN_OP on FAIL_STACK. 
1046
1047    Return 1 if was able to do so and 0 if ran out of memory allocating
1048    space to do so.  */
1049 #define PUSH_PATTERN_OP(pattern_op, fail_stack)                         \
1050   ((FAIL_STACK_FULL ()                                                  \
1051     && !DOUBLE_FAIL_STACK (fail_stack))                                 \
1052    ? 0                                                                  \
1053    : ((fail_stack).stack[(fail_stack).avail++] = pattern_op,            \
1054       1))
1055
1056 /* Push a pointer value onto the failure stack.
1057    Assumes the variable `fail_stack'.  Probably should only
1058    be called from within `PUSH_FAILURE_POINT'.  */
1059 #define PUSH_FAILURE_POINTER(item)                                      \
1060   fail_stack.stack[fail_stack.avail++] = (fail_stack_elt_t) (item)
1061
1062 /* This pushes an integer-valued item onto the failure stack.
1063    Assumes the variable `fail_stack'.  Probably should only
1064    be called from within `PUSH_FAILURE_POINT'.  */
1065 #define PUSH_FAILURE_INT(item)                                  \
1066   fail_stack.stack[fail_stack.avail++] = (fail_stack_elt_t) (EMACS_INT) (item)
1067
1068 /* The complement operation.  Assumes `fail_stack' is nonempty.  */
1069 #define POP_FAILURE_POINTER() fail_stack.stack[--fail_stack.avail]
1070
1071 /* The complement operation.  Assumes `fail_stack' is nonempty.  */
1072 #define POP_FAILURE_INT() (EMACS_INT) fail_stack.stack[--fail_stack.avail]
1073
1074 /* Used to omit pushing failure point id's when we're not debugging.  */
1075 #ifdef DEBUG
1076 #define DEBUG_PUSH PUSH_FAILURE_INT
1077 #define DEBUG_POP(item_addr) *(item_addr) = POP_FAILURE_INT ()
1078 #else
1079 #define DEBUG_PUSH(item)
1080 #define DEBUG_POP(item_addr)
1081 #endif
1082
1083
1084 /* Push the information about the state we will need
1085    if we ever fail back to it.  
1086    
1087    Requires variables fail_stack, regstart, regend, reg_info, and
1088    num_regs be declared.  DOUBLE_FAIL_STACK requires `destination' be
1089    declared.
1090    
1091    Does `return FAILURE_CODE' if runs out of memory.  */
1092
1093 #define PUSH_FAILURE_POINT(pattern_place, string_place, failure_code)   \
1094   do {                                                                  \
1095     char *destination;                                                  \
1096     /* Must be int, so when we don't save any registers, the arithmetic \
1097        of 0 + -1 isn't done as unsigned.  */                            \
1098     int this_reg;                                                       \
1099                                                                         \
1100     DEBUG_STATEMENT (failure_id++);                                     \
1101     DEBUG_STATEMENT (nfailure_points_pushed++);                         \
1102     DEBUG_PRINT2 ("\nPUSH_FAILURE_POINT #%u:\n", failure_id);           \
1103     DEBUG_PRINT2 ("  Before push, next avail: %d\n", (fail_stack).avail);\
1104     DEBUG_PRINT2 ("                     size: %d\n", (fail_stack).size);\
1105                                                                         \
1106     DEBUG_PRINT2 ("  slots needed: %d\n", NUM_FAILURE_ITEMS);           \
1107     DEBUG_PRINT2 ("     available: %d\n", REMAINING_AVAIL_SLOTS);       \
1108                                                                         \
1109     /* Ensure we have enough space allocated for what we will push.  */ \
1110     while (REMAINING_AVAIL_SLOTS < NUM_FAILURE_ITEMS)                   \
1111       {                                                                 \
1112         if (!DOUBLE_FAIL_STACK (fail_stack))                            \
1113           return failure_code;                                          \
1114                                                                         \
1115         DEBUG_PRINT2 ("\n  Doubled stack; size now: %d\n",              \
1116                        (fail_stack).size);                              \
1117         DEBUG_PRINT2 ("  slots available: %d\n", REMAINING_AVAIL_SLOTS);\
1118       }                                                                 \
1119                                                                         \
1120     /* Push the info, starting with the registers.  */                  \
1121     DEBUG_PRINT1 ("\n");                                                \
1122                                                                         \
1123     for (this_reg = lowest_active_reg; this_reg <= highest_active_reg;  \
1124          this_reg++)                                                    \
1125       {                                                                 \
1126         DEBUG_PRINT2 ("  Pushing reg: %d\n", this_reg);                 \
1127         DEBUG_STATEMENT (num_regs_pushed++);                            \
1128                                                                         \
1129         DEBUG_PRINT2 ("    start: 0x%x\n", regstart[this_reg]);         \
1130         PUSH_FAILURE_POINTER (regstart[this_reg]);                      \
1131                                                                         \
1132         DEBUG_PRINT2 ("    end: 0x%x\n", regend[this_reg]);             \
1133         PUSH_FAILURE_POINTER (regend[this_reg]);                        \
1134                                                                         \
1135         DEBUG_PRINT2 ("    info: 0x%x\n      ", reg_info[this_reg]);    \
1136         DEBUG_PRINT2 (" match_null=%d",                                 \
1137                       REG_MATCH_NULL_STRING_P (reg_info[this_reg]));    \
1138         DEBUG_PRINT2 (" active=%d", IS_ACTIVE (reg_info[this_reg]));    \
1139         DEBUG_PRINT2 (" matched_something=%d",                          \
1140                       MATCHED_SOMETHING (reg_info[this_reg]));          \
1141         DEBUG_PRINT2 (" ever_matched=%d",                               \
1142                       EVER_MATCHED_SOMETHING (reg_info[this_reg]));     \
1143         DEBUG_PRINT1 ("\n");                                            \
1144         PUSH_FAILURE_POINTER (reg_info[this_reg].word);                 \
1145       }                                                                 \
1146                                                                         \
1147     DEBUG_PRINT2 ("  Pushing  low active reg: %d\n", lowest_active_reg);\
1148     PUSH_FAILURE_INT (lowest_active_reg);                               \
1149                                                                         \
1150     DEBUG_PRINT2 ("  Pushing high active reg: %d\n", highest_active_reg);\
1151     PUSH_FAILURE_INT (highest_active_reg);                              \
1152                                                                         \
1153     DEBUG_PRINT2 ("  Pushing pattern 0x%x: ", pattern_place);           \
1154     DEBUG_PRINT_COMPILED_PATTERN (bufp, pattern_place, pend);           \
1155     PUSH_FAILURE_POINTER (pattern_place);                               \
1156                                                                         \
1157     DEBUG_PRINT2 ("  Pushing string 0x%x: `", string_place);            \
1158     DEBUG_PRINT_DOUBLE_STRING (string_place, string1, size1, string2,   \
1159                                  size2);                                \
1160     DEBUG_PRINT1 ("'\n");                                               \
1161     PUSH_FAILURE_POINTER (string_place);                                \
1162                                                                         \
1163     DEBUG_PRINT2 ("  Pushing failure id: %u\n", failure_id);            \
1164     DEBUG_PUSH (failure_id);                                            \
1165   } while (0)
1166
1167 /* This is the number of items that are pushed and popped on the stack
1168    for each register.  */
1169 #define NUM_REG_ITEMS  3
1170
1171 /* Individual items aside from the registers.  */
1172 #ifdef DEBUG
1173 #define NUM_NONREG_ITEMS 5 /* Includes failure point id.  */
1174 #else
1175 #define NUM_NONREG_ITEMS 4
1176 #endif
1177
1178 /* We push at most this many items on the stack.  */
1179 #define MAX_FAILURE_ITEMS ((num_regs - 1) * NUM_REG_ITEMS + NUM_NONREG_ITEMS)
1180
1181 /* We actually push this many items.  */
1182 #define NUM_FAILURE_ITEMS                                               \
1183   ((highest_active_reg - lowest_active_reg + 1) * NUM_REG_ITEMS         \
1184     + NUM_NONREG_ITEMS)
1185
1186 /* How many items can still be added to the stack without overflowing it.  */
1187 #define REMAINING_AVAIL_SLOTS ((fail_stack).size - (fail_stack).avail)
1188
1189
1190 /* Pops what PUSH_FAIL_STACK pushes.
1191
1192    We restore into the parameters, all of which should be lvalues:
1193      STR -- the saved data position.
1194      PAT -- the saved pattern position.
1195      LOW_REG, HIGH_REG -- the highest and lowest active registers.
1196      REGSTART, REGEND -- arrays of string positions.
1197      REG_INFO -- array of information about each subexpression.
1198    
1199    Also assumes the variables `fail_stack' and (if debugging), `bufp',
1200    `pend', `string1', `size1', `string2', and `size2'.  */
1201
1202 #define POP_FAILURE_POINT(str, pat, low_reg, high_reg, regstart, regend, reg_info)\
1203 {                                                                       \
1204   DEBUG_STATEMENT (fail_stack_elt_t failure_id;)                        \
1205   int this_reg;                                                         \
1206   const unsigned char *string_temp;                                     \
1207                                                                         \
1208   assert (!FAIL_STACK_EMPTY ());                                        \
1209                                                                         \
1210   /* Remove failure points and point to how many regs pushed.  */       \
1211   DEBUG_PRINT1 ("POP_FAILURE_POINT:\n");                                \
1212   DEBUG_PRINT2 ("  Before pop, next avail: %d\n", fail_stack.avail);    \
1213   DEBUG_PRINT2 ("                    size: %d\n", fail_stack.size);     \
1214                                                                         \
1215   assert (fail_stack.avail >= NUM_NONREG_ITEMS);                        \
1216                                                                         \
1217   DEBUG_POP (&failure_id);                                              \
1218   DEBUG_PRINT2 ("  Popping failure id: %u\n", failure_id);              \
1219                                                                         \
1220   /* If the saved string location is NULL, it came from an              \
1221      on_failure_keep_string_jump opcode, and we want to throw away the  \
1222      saved NULL, thus retaining our current position in the string.  */ \
1223   string_temp = POP_FAILURE_POINTER ();                                 \
1224   if (string_temp != NULL)                                              \
1225     str = (const char *) string_temp;                                   \
1226                                                                         \
1227   DEBUG_PRINT2 ("  Popping string 0x%x: `", str);                       \
1228   DEBUG_PRINT_DOUBLE_STRING (str, string1, size1, string2, size2);      \
1229   DEBUG_PRINT1 ("'\n");                                                 \
1230                                                                         \
1231   pat = (unsigned char *) POP_FAILURE_POINTER ();                       \
1232   DEBUG_PRINT2 ("  Popping pattern 0x%x: ", pat);                       \
1233   DEBUG_PRINT_COMPILED_PATTERN (bufp, pat, pend);                       \
1234                                                                         \
1235   /* Restore register info.  */                                         \
1236   high_reg = (unsigned) POP_FAILURE_INT ();                             \
1237   DEBUG_PRINT2 ("  Popping high active reg: %d\n", high_reg);           \
1238                                                                         \
1239   low_reg = (unsigned) POP_FAILURE_INT ();                              \
1240   DEBUG_PRINT2 ("  Popping  low active reg: %d\n", low_reg);            \
1241                                                                         \
1242   for (this_reg = high_reg; this_reg >= low_reg; this_reg--)            \
1243     {                                                                   \
1244       DEBUG_PRINT2 ("    Popping reg: %d\n", this_reg);                 \
1245                                                                         \
1246       reg_info[this_reg].word = POP_FAILURE_POINTER ();                 \
1247       DEBUG_PRINT2 ("      info: 0x%x\n", reg_info[this_reg]);          \
1248                                                                         \
1249       regend[this_reg] = (const char *) POP_FAILURE_POINTER ();         \
1250       DEBUG_PRINT2 ("      end: 0x%x\n", regend[this_reg]);             \
1251                                                                         \
1252       regstart[this_reg] = (const char *) POP_FAILURE_POINTER ();       \
1253       DEBUG_PRINT2 ("      start: 0x%x\n", regstart[this_reg]);         \
1254     }                                                                   \
1255                                                                         \
1256   set_regs_matched_done = 0;                                            \
1257   DEBUG_STATEMENT (nfailure_points_popped++);                           \
1258 } /* POP_FAILURE_POINT */
1259
1260
1261 \f
1262 /* Structure for per-register (a.k.a. per-group) information.
1263    This must not be longer than one word, because we push this value
1264    onto the failure stack.  Other register information, such as the
1265    starting and ending positions (which are addresses), and the list of
1266    inner groups (which is a bits list) are maintained in separate
1267    variables.  
1268    
1269    We are making a (strictly speaking) nonportable assumption here: that
1270    the compiler will pack our bit fields into something that fits into
1271    the type of `word', i.e., is something that fits into one item on the
1272    failure stack.  */
1273 typedef union
1274 {
1275   fail_stack_elt_t word;
1276   struct
1277   {
1278       /* This field is one if this group can match the empty string,
1279          zero if not.  If not yet determined,  `MATCH_NULL_UNSET_VALUE'.  */
1280 #define MATCH_NULL_UNSET_VALUE 3
1281     unsigned match_null_string_p : 2;
1282     unsigned is_active : 1;
1283     unsigned matched_something : 1;
1284     unsigned ever_matched_something : 1;
1285   } bits;
1286 } register_info_type;
1287
1288 #define REG_MATCH_NULL_STRING_P(R)  ((R).bits.match_null_string_p)
1289 #define IS_ACTIVE(R)  ((R).bits.is_active)
1290 #define MATCHED_SOMETHING(R)  ((R).bits.matched_something)
1291 #define EVER_MATCHED_SOMETHING(R)  ((R).bits.ever_matched_something)
1292
1293
1294 /* Call this when have matched a real character; it sets `matched' flags
1295    for the subexpressions which we are currently inside.  Also records
1296    that those subexprs have matched.  */
1297 #define SET_REGS_MATCHED()                                              \
1298   do                                                                    \
1299     {                                                                   \
1300       if (!set_regs_matched_done)                                       \
1301         {                                                               \
1302           unsigned r;                                                   \
1303           set_regs_matched_done = 1;                                    \
1304           for (r = lowest_active_reg; r <= highest_active_reg; r++)     \
1305             {                                                           \
1306               MATCHED_SOMETHING (reg_info[r])                           \
1307                 = EVER_MATCHED_SOMETHING (reg_info[r])                  \
1308                 = 1;                                                    \
1309             }                                                           \
1310         }                                                               \
1311     }                                                                   \
1312   while (0)
1313
1314 /* Registers are set to a sentinel when they haven't yet matched.  */
1315 static char reg_unset_dummy;
1316 #define REG_UNSET_VALUE (&reg_unset_dummy)
1317 #define REG_UNSET(e) ((e) == REG_UNSET_VALUE)
1318 \f
1319 /* Subroutine declarations and macros for regex_compile.  */
1320
1321 static void store_op1 (), store_op2 ();
1322 static void insert_op1 (), insert_op2 ();
1323 static boolean at_begline_loc_p (), at_endline_loc_p ();
1324 static boolean group_in_compile_stack ();
1325 static reg_errcode_t compile_range ();
1326
1327 /* Fetch the next character in the uncompiled pattern---translating it 
1328    if necessary.  Also cast from a signed character in the constant
1329    string passed to us by the user to an unsigned char that we can use
1330    as an array index (in, e.g., `translate').  */
1331 #define PATFETCH(c)                                                     \
1332   do {if (p == pend) return REG_EEND;                                   \
1333     c = (unsigned char) *p++;                                           \
1334     if (translate) c = translate[c];                                    \
1335   } while (0)
1336
1337 /* Fetch the next character in the uncompiled pattern, with no
1338    translation.  */
1339 #define PATFETCH_RAW(c)                                                 \
1340   do {if (p == pend) return REG_EEND;                                   \
1341     c = (unsigned char) *p++;                                           \
1342   } while (0)
1343
1344 /* Go backwards one character in the pattern.  */
1345 #define PATUNFETCH p--
1346
1347
1348 /* If `translate' is non-null, return translate[D], else just D.  We
1349    cast the subscript to translate because some data is declared as
1350    `char *', to avoid warnings when a string constant is passed.  But
1351    when we use a character as a subscript we must make it unsigned.  */
1352 #define TRANSLATE(d) (translate ? translate[(unsigned char) (d)] : (d))
1353
1354
1355 /* Macros for outputting the compiled pattern into `buffer'.  */
1356
1357 /* If the buffer isn't allocated when it comes in, use this.  */
1358 #define INIT_BUF_SIZE  32
1359
1360 /* Make sure we have at least N more bytes of space in buffer.  */
1361 #define GET_BUFFER_SPACE(n)                                             \
1362     while (b - bufp->buffer + (n) > bufp->allocated)                    \
1363       EXTEND_BUFFER ()
1364
1365 /* Make sure we have one more byte of buffer space and then add C to it.  */
1366 #define BUF_PUSH(c)                                                     \
1367   do {                                                                  \
1368     GET_BUFFER_SPACE (1);                                               \
1369     *b++ = (unsigned char) (c);                                         \
1370   } while (0)
1371
1372
1373 /* Ensure we have two more bytes of buffer space and then append C1 and C2.  */
1374 #define BUF_PUSH_2(c1, c2)                                              \
1375   do {                                                                  \
1376     GET_BUFFER_SPACE (2);                                               \
1377     *b++ = (unsigned char) (c1);                                        \
1378     *b++ = (unsigned char) (c2);                                        \
1379   } while (0)
1380
1381
1382 /* As with BUF_PUSH_2, except for three bytes.  */
1383 #define BUF_PUSH_3(c1, c2, c3)                                          \
1384   do {                                                                  \
1385     GET_BUFFER_SPACE (3);                                               \
1386     *b++ = (unsigned char) (c1);                                        \
1387     *b++ = (unsigned char) (c2);                                        \
1388     *b++ = (unsigned char) (c3);                                        \
1389   } while (0)
1390
1391
1392 /* Store a jump with opcode OP at LOC to location TO.  We store a
1393    relative address offset by the three bytes the jump itself occupies.  */
1394 #define STORE_JUMP(op, loc, to) \
1395   store_op1 (op, loc, (to) - (loc) - 3)
1396
1397 /* Likewise, for a two-argument jump.  */
1398 #define STORE_JUMP2(op, loc, to, arg) \
1399   store_op2 (op, loc, (to) - (loc) - 3, arg)
1400
1401 /* Like `STORE_JUMP', but for inserting.  Assume `b' is the buffer end.  */
1402 #define INSERT_JUMP(op, loc, to) \
1403   insert_op1 (op, loc, (to) - (loc) - 3, b)
1404
1405 /* Like `STORE_JUMP2', but for inserting.  Assume `b' is the buffer end.  */
1406 #define INSERT_JUMP2(op, loc, to, arg) \
1407   insert_op2 (op, loc, (to) - (loc) - 3, arg, b)
1408
1409
1410 /* This is not an arbitrary limit: the arguments which represent offsets
1411    into the pattern are two bytes long.  So if 2^16 bytes turns out to
1412    be too small, many things would have to change.  */
1413 #define MAX_BUF_SIZE (1L << 16)
1414
1415
1416 /* Extend the buffer by twice its current size via realloc and
1417    reset the pointers that pointed into the old block to point to the
1418    correct places in the new one.  If extending the buffer results in it
1419    being larger than MAX_BUF_SIZE, then flag memory exhausted.  */
1420 #define EXTEND_BUFFER()                                                 \
1421   do {                                                                  \
1422     unsigned char *old_buffer = bufp->buffer;                           \
1423     if (bufp->allocated == MAX_BUF_SIZE)                                \
1424       return REG_ESIZE;                                                 \
1425     bufp->allocated <<= 1;                                              \
1426     if (bufp->allocated > MAX_BUF_SIZE)                                 \
1427       bufp->allocated = MAX_BUF_SIZE;                                   \
1428     bufp->buffer = (unsigned char *) realloc (bufp->buffer, bufp->allocated);\
1429     if (bufp->buffer == NULL)                                           \
1430       return REG_ESPACE;                                                \
1431     /* If the buffer moved, move all the pointers into it.  */          \
1432     if (old_buffer != bufp->buffer)                                     \
1433       {                                                                 \
1434         b = (b - old_buffer) + bufp->buffer;                            \
1435         begalt = (begalt - old_buffer) + bufp->buffer;                  \
1436         if (fixup_alt_jump)                                             \
1437           fixup_alt_jump = (fixup_alt_jump - old_buffer) + bufp->buffer;\
1438         if (laststart)                                                  \
1439           laststart = (laststart - old_buffer) + bufp->buffer;          \
1440         if (pending_exact)                                              \
1441           pending_exact = (pending_exact - old_buffer) + bufp->buffer;  \
1442       }                                                                 \
1443   } while (0)
1444
1445
1446 /* Since we have one byte reserved for the register number argument to
1447    {start,stop}_memory, the maximum number of groups we can report
1448    things about is what fits in that byte.  */
1449 #define MAX_REGNUM 255
1450
1451 /* But patterns can have more than `MAX_REGNUM' registers.  We just
1452    ignore the excess.  */
1453 typedef unsigned regnum_t;
1454
1455
1456 /* Macros for the compile stack.  */
1457
1458 /* Since offsets can go either forwards or backwards, this type needs to
1459    be able to hold values from -(MAX_BUF_SIZE - 1) to MAX_BUF_SIZE - 1.  */
1460 typedef int pattern_offset_t;
1461
1462 typedef struct
1463 {
1464   pattern_offset_t begalt_offset;
1465   pattern_offset_t fixup_alt_jump;
1466   pattern_offset_t inner_group_offset;
1467   pattern_offset_t laststart_offset;  
1468   regnum_t regnum;
1469 } compile_stack_elt_t;
1470
1471
1472 typedef struct
1473 {
1474   compile_stack_elt_t *stack;
1475   unsigned size;
1476   unsigned avail;                       /* Offset of next open position.  */
1477 } compile_stack_type;
1478
1479
1480 #define INIT_COMPILE_STACK_SIZE 32
1481
1482 #define COMPILE_STACK_EMPTY  (compile_stack.avail == 0)
1483 #define COMPILE_STACK_FULL  (compile_stack.avail == compile_stack.size)
1484
1485 /* The next available element.  */
1486 #define COMPILE_STACK_TOP (compile_stack.stack[compile_stack.avail])
1487
1488
1489 /* Set the bit for character C in a list.  */
1490 #define SET_LIST_BIT(c)                               \
1491   (b[((unsigned char) (c)) / BYTEWIDTH]               \
1492    |= 1 << (((unsigned char) c) % BYTEWIDTH))
1493
1494
1495 /* Get the next unsigned number in the uncompiled pattern.  */
1496 #define GET_UNSIGNED_NUMBER(num)                                        \
1497   { if (p != pend)                                                      \
1498      {                                                                  \
1499        PATFETCH (c);                                                    \
1500        while (ISDIGIT (c))                                              \
1501          {                                                              \
1502            if (num < 0)                                                 \
1503               num = 0;                                                  \
1504            num = num * 10 + c - '0';                                    \
1505            if (p == pend)                                               \
1506               break;                                                    \
1507            PATFETCH (c);                                                \
1508          }                                                              \
1509        }                                                                \
1510     }           
1511
1512 #define CHAR_CLASS_MAX_LENGTH  6 /* Namely, `xdigit'.  */
1513
1514 #define IS_CHAR_CLASS(string)                                           \
1515    (STREQ (string, "alpha") || STREQ (string, "upper")                  \
1516     || STREQ (string, "lower") || STREQ (string, "digit")               \
1517     || STREQ (string, "alnum") || STREQ (string, "xdigit")              \
1518     || STREQ (string, "space") || STREQ (string, "print")               \
1519     || STREQ (string, "punct") || STREQ (string, "graph")               \
1520     || STREQ (string, "cntrl") || STREQ (string, "blank"))
1521 \f
1522 #ifndef MATCH_MAY_ALLOCATE
1523
1524 /* If we cannot allocate large objects within re_match_2_internal,
1525    we make the fail stack and register vectors global.
1526    The fail stack, we grow to the maximum size when a regexp
1527    is compiled.
1528    The register vectors, we adjust in size each time we
1529    compile a regexp, according to the number of registers it needs.  */
1530
1531 static fail_stack_type fail_stack;
1532
1533 /* Size with which the following vectors are currently allocated.
1534    That is so we can make them bigger as needed,
1535    but never make them smaller.  */
1536 static int regs_allocated_size;
1537
1538 static const char **     regstart, **     regend;
1539 static const char ** old_regstart, ** old_regend;
1540 static const char **best_regstart, **best_regend;
1541 static register_info_type *reg_info; 
1542 static const char **reg_dummy;
1543 static register_info_type *reg_info_dummy;
1544
1545 /* Make the register vectors big enough for NUM_REGS registers,
1546    but don't make them smaller.  */
1547
1548 static
1549 regex_grow_registers (num_regs)
1550      int num_regs;
1551 {
1552   if (num_regs > regs_allocated_size)
1553     {
1554       RETALLOC_IF (regstart,     num_regs, const char *);
1555       RETALLOC_IF (regend,       num_regs, const char *);
1556       RETALLOC_IF (old_regstart, num_regs, const char *);
1557       RETALLOC_IF (old_regend,   num_regs, const char *);
1558       RETALLOC_IF (best_regstart, num_regs, const char *);
1559       RETALLOC_IF (best_regend,  num_regs, const char *);
1560       RETALLOC_IF (reg_info,     num_regs, register_info_type);
1561       RETALLOC_IF (reg_dummy,    num_regs, const char *);
1562       RETALLOC_IF (reg_info_dummy, num_regs, register_info_type);
1563
1564       regs_allocated_size = num_regs;
1565     }
1566 }
1567
1568 #endif /* not MATCH_MAY_ALLOCATE */
1569 \f
1570 /* `regex_compile' compiles PATTERN (of length SIZE) according to SYNTAX.
1571    Returns one of error codes defined in `regex.h', or zero for success.
1572
1573    Assumes the `allocated' (and perhaps `buffer') and `translate'
1574    fields are set in BUFP on entry.
1575
1576    If it succeeds, results are put in BUFP (if it returns an error, the
1577    contents of BUFP are undefined):
1578      `buffer' is the compiled pattern;
1579      `syntax' is set to SYNTAX;
1580      `used' is set to the length of the compiled pattern;
1581      `fastmap_accurate' is zero;
1582      `re_nsub' is the number of subexpressions in PATTERN;
1583      `not_bol' and `not_eol' are zero;
1584    
1585    The `fastmap' and `newline_anchor' fields are neither
1586    examined nor set.  */
1587
1588 /* Return, freeing storage we allocated.  */
1589 #define FREE_STACK_RETURN(value)                \
1590   return (free (compile_stack.stack), value)
1591
1592 static reg_errcode_t
1593 regex_compile (pattern, size, syntax, bufp)
1594      const char *pattern;
1595      int size;
1596      reg_syntax_t syntax;
1597      struct re_pattern_buffer *bufp;
1598 {
1599   /* We fetch characters from PATTERN here.  Even though PATTERN is
1600      `char *' (i.e., signed), we declare these variables as unsigned, so
1601      they can be reliably used as array indices.  */
1602   register unsigned char c, c1;
1603   
1604   /* A random temporary spot in PATTERN.  */
1605   const char *p1;
1606
1607   /* Points to the end of the buffer, where we should append.  */
1608   register unsigned char *b;
1609   
1610   /* Keeps track of unclosed groups.  */
1611   compile_stack_type compile_stack;
1612
1613   /* Points to the current (ending) position in the pattern.  */
1614   const char *p = pattern;
1615   const char *pend = pattern + size;
1616   
1617   /* How to translate the characters in the pattern.  */
1618   char *translate = bufp->translate;
1619
1620   /* Address of the count-byte of the most recently inserted `exactn'
1621      command.  This makes it possible to tell if a new exact-match
1622      character can be added to that command or if the character requires
1623      a new `exactn' command.  */
1624   unsigned char *pending_exact = 0;
1625
1626   /* Address of start of the most recently finished expression.
1627      This tells, e.g., postfix * where to find the start of its
1628      operand.  Reset at the beginning of groups and alternatives.  */
1629   unsigned char *laststart = 0;
1630
1631   /* Address of beginning of regexp, or inside of last group.  */
1632   unsigned char *begalt;
1633
1634   /* Place in the uncompiled pattern (i.e., the {) to
1635      which to go back if the interval is invalid.  */
1636   const char *beg_interval;
1637                 
1638   /* Address of the place where a forward jump should go to the end of
1639      the containing expression.  Each alternative of an `or' -- except the
1640      last -- ends with a forward jump of this sort.  */
1641   unsigned char *fixup_alt_jump = 0;
1642
1643   /* Counts open-groups as they are encountered.  Remembered for the
1644      matching close-group on the compile stack, so the same register
1645      number is put in the stop_memory as the start_memory.  */
1646   regnum_t regnum = 0;
1647
1648 #ifdef DEBUG
1649   DEBUG_PRINT1 ("\nCompiling pattern: ");
1650   if (debug)
1651     {
1652       unsigned debug_count;
1653       
1654       for (debug_count = 0; debug_count < size; debug_count++)
1655         putchar (pattern[debug_count]);
1656       putchar ('\n');
1657     }
1658 #endif /* DEBUG */
1659
1660   /* Initialize the compile stack.  */
1661   compile_stack.stack = TALLOC (INIT_COMPILE_STACK_SIZE, compile_stack_elt_t);
1662   if (compile_stack.stack == NULL)
1663     return REG_ESPACE;
1664
1665   compile_stack.size = INIT_COMPILE_STACK_SIZE;
1666   compile_stack.avail = 0;
1667
1668   /* Initialize the pattern buffer.  */
1669   bufp->syntax = syntax;
1670   bufp->fastmap_accurate = 0;
1671   bufp->not_bol = bufp->not_eol = 0;
1672
1673   /* Set `used' to zero, so that if we return an error, the pattern
1674      printer (for debugging) will think there's no pattern.  We reset it
1675      at the end.  */
1676   bufp->used = 0;
1677   
1678   /* Always count groups, whether or not bufp->no_sub is set.  */
1679   bufp->re_nsub = 0;                            
1680
1681 #if !defined (emacs) && !defined (SYNTAX_TABLE)
1682   /* Initialize the syntax table.  */
1683    init_syntax_once ();
1684 #endif
1685
1686   if (bufp->allocated == 0)
1687     {
1688       if (bufp->buffer)
1689         { /* If zero allocated, but buffer is non-null, try to realloc
1690              enough space.  This loses if buffer's address is bogus, but
1691              that is the user's responsibility.  */
1692           RETALLOC (bufp->buffer, INIT_BUF_SIZE, unsigned char);
1693         }
1694       else
1695         { /* Caller did not allocate a buffer.  Do it for them.  */
1696           bufp->buffer = TALLOC (INIT_BUF_SIZE, unsigned char);
1697         }
1698       if (!bufp->buffer) FREE_STACK_RETURN (REG_ESPACE);
1699
1700       bufp->allocated = INIT_BUF_SIZE;
1701     }
1702
1703   begalt = b = bufp->buffer;
1704
1705   /* Loop through the uncompiled pattern until we're at the end.  */
1706   while (p != pend)
1707     {
1708       PATFETCH (c);
1709
1710       switch (c)
1711         {
1712         case '^':
1713           {
1714             if (   /* If at start of pattern, it's an operator.  */
1715                    p == pattern + 1
1716                    /* If context independent, it's an operator.  */
1717                 || syntax & RE_CONTEXT_INDEP_ANCHORS
1718                    /* Otherwise, depends on what's come before.  */
1719                 || at_begline_loc_p (pattern, p, syntax))
1720               BUF_PUSH (begline);
1721             else
1722               goto normal_char;
1723           }
1724           break;
1725
1726
1727         case '$':
1728           {
1729             if (   /* If at end of pattern, it's an operator.  */
1730                    p == pend 
1731                    /* If context independent, it's an operator.  */
1732                 || syntax & RE_CONTEXT_INDEP_ANCHORS
1733                    /* Otherwise, depends on what's next.  */
1734                 || at_endline_loc_p (p, pend, syntax))
1735                BUF_PUSH (endline);
1736              else
1737                goto normal_char;
1738            }
1739            break;
1740
1741
1742         case '+':
1743         case '?':
1744           if ((syntax & RE_BK_PLUS_QM)
1745               || (syntax & RE_LIMITED_OPS))
1746             goto normal_char;
1747         handle_plus:
1748         case '*':
1749           /* If there is no previous pattern... */
1750           if (!laststart)
1751             {
1752               if (syntax & RE_CONTEXT_INVALID_OPS)
1753                 FREE_STACK_RETURN (REG_BADRPT);
1754               else if (!(syntax & RE_CONTEXT_INDEP_OPS))
1755                 goto normal_char;
1756             }
1757
1758           {
1759             /* Are we optimizing this jump?  */
1760             boolean keep_string_p = false;
1761             
1762             /* 1 means zero (many) matches is allowed.  */
1763             char zero_times_ok = 0, many_times_ok = 0;
1764
1765             /* If there is a sequence of repetition chars, collapse it
1766                down to just one (the right one).  We can't combine
1767                interval operators with these because of, e.g., `a{2}*',
1768                which should only match an even number of `a's.  */
1769
1770             for (;;)
1771               {
1772                 zero_times_ok |= c != '+';
1773                 many_times_ok |= c != '?';
1774
1775                 if (p == pend)
1776                   break;
1777
1778                 PATFETCH (c);
1779
1780                 if (c == '*'
1781                     || (!(syntax & RE_BK_PLUS_QM) && (c == '+' || c == '?')))
1782                   ;
1783
1784                 else if (syntax & RE_BK_PLUS_QM  &&  c == '\\')
1785                   {
1786                     if (p == pend) FREE_STACK_RETURN (REG_EESCAPE);
1787
1788                     PATFETCH (c1);
1789                     if (!(c1 == '+' || c1 == '?'))
1790                       {
1791                         PATUNFETCH;
1792                         PATUNFETCH;
1793                         break;
1794                       }
1795
1796                     c = c1;
1797                   }
1798                 else
1799                   {
1800                     PATUNFETCH;
1801                     break;
1802                   }
1803
1804                 /* If we get here, we found another repeat character.  */
1805                }
1806
1807             /* Star, etc. applied to an empty pattern is equivalent
1808                to an empty pattern.  */
1809             if (!laststart)  
1810               break;
1811
1812             /* Now we know whether or not zero matches is allowed
1813                and also whether or not two or more matches is allowed.  */
1814             if (many_times_ok)
1815               { /* More than one repetition is allowed, so put in at the
1816                    end a backward relative jump from `b' to before the next
1817                    jump we're going to put in below (which jumps from
1818                    laststart to after this jump).  
1819
1820                    But if we are at the `*' in the exact sequence `.*\n',
1821                    insert an unconditional jump backwards to the .,
1822                    instead of the beginning of the loop.  This way we only
1823                    push a failure point once, instead of every time
1824                    through the loop.  */
1825                 assert (p - 1 > pattern);
1826
1827                 /* Allocate the space for the jump.  */
1828                 GET_BUFFER_SPACE (3);
1829
1830                 /* We know we are not at the first character of the pattern,
1831                    because laststart was nonzero.  And we've already
1832                    incremented `p', by the way, to be the character after
1833                    the `*'.  Do we have to do something analogous here
1834                    for null bytes, because of RE_DOT_NOT_NULL?  */
1835                 if (TRANSLATE (*(p - 2)) == TRANSLATE ('.')
1836                     && zero_times_ok
1837                     && p < pend && TRANSLATE (*p) == TRANSLATE ('\n')
1838                     && !(syntax & RE_DOT_NEWLINE))
1839                   { /* We have .*\n.  */
1840                     STORE_JUMP (jump, b, laststart);
1841                     keep_string_p = true;
1842                   }
1843                 else
1844                   /* Anything else.  */
1845                   STORE_JUMP (maybe_pop_jump, b, laststart - 3);
1846
1847                 /* We've added more stuff to the buffer.  */
1848                 b += 3;
1849               }
1850
1851             /* On failure, jump from laststart to b + 3, which will be the
1852                end of the buffer after this jump is inserted.  */
1853             GET_BUFFER_SPACE (3);
1854             INSERT_JUMP (keep_string_p ? on_failure_keep_string_jump
1855                                        : on_failure_jump,
1856                          laststart, b + 3);
1857             pending_exact = 0;
1858             b += 3;
1859
1860             if (!zero_times_ok)
1861               {
1862                 /* At least one repetition is required, so insert a
1863                    `dummy_failure_jump' before the initial
1864                    `on_failure_jump' instruction of the loop. This
1865                    effects a skip over that instruction the first time
1866                    we hit that loop.  */
1867                 GET_BUFFER_SPACE (3);
1868                 INSERT_JUMP (dummy_failure_jump, laststart, laststart + 6);
1869                 b += 3;
1870               }
1871             }
1872           break;
1873
1874
1875         case '.':
1876           laststart = b;
1877           BUF_PUSH (anychar);
1878           break;
1879
1880
1881         case '[':
1882           {
1883             boolean had_char_class = false;
1884
1885             if (p == pend) FREE_STACK_RETURN (REG_EBRACK);
1886
1887             /* Ensure that we have enough space to push a charset: the
1888                opcode, the length count, and the bitset; 34 bytes in all.  */
1889             GET_BUFFER_SPACE (34);
1890
1891             laststart = b;
1892
1893             /* We test `*p == '^' twice, instead of using an if
1894                statement, so we only need one BUF_PUSH.  */
1895             BUF_PUSH (*p == '^' ? charset_not : charset); 
1896             if (*p == '^')
1897               p++;
1898
1899             /* Remember the first position in the bracket expression.  */
1900             p1 = p;
1901
1902             /* Push the number of bytes in the bitmap.  */
1903             BUF_PUSH ((1 << BYTEWIDTH) / BYTEWIDTH);
1904
1905             /* Clear the whole map.  */
1906             bzero (b, (1 << BYTEWIDTH) / BYTEWIDTH);
1907
1908             /* charset_not matches newline according to a syntax bit.  */
1909             if ((re_opcode_t) b[-2] == charset_not
1910                 && (syntax & RE_HAT_LISTS_NOT_NEWLINE))
1911               SET_LIST_BIT ('\n');
1912
1913             /* Read in characters and ranges, setting map bits.  */
1914             for (;;)
1915               {
1916                 if (p == pend) FREE_STACK_RETURN (REG_EBRACK);
1917
1918                 PATFETCH (c);
1919
1920                 /* \ might escape characters inside [...] and [^...].  */
1921                 if ((syntax & RE_BACKSLASH_ESCAPE_IN_LISTS) && c == '\\')
1922                   {
1923                     if (p == pend) FREE_STACK_RETURN (REG_EESCAPE);
1924
1925                     PATFETCH (c1);
1926                     SET_LIST_BIT (c1);
1927                     continue;
1928                   }
1929
1930                 /* Could be the end of the bracket expression.  If it's
1931                    not (i.e., when the bracket expression is `[]' so
1932                    far), the ']' character bit gets set way below.  */
1933                 if (c == ']' && p != p1 + 1)
1934                   break;
1935
1936                 /* Look ahead to see if it's a range when the last thing
1937                    was a character class.  */
1938                 if (had_char_class && c == '-' && *p != ']')
1939                   FREE_STACK_RETURN (REG_ERANGE);
1940
1941                 /* Look ahead to see if it's a range when the last thing
1942                    was a character: if this is a hyphen not at the
1943                    beginning or the end of a list, then it's the range
1944                    operator.  */
1945                 if (c == '-' 
1946                     && !(p - 2 >= pattern && p[-2] == '[') 
1947                     && !(p - 3 >= pattern && p[-3] == '[' && p[-2] == '^')
1948                     && *p != ']')
1949                   {
1950                     reg_errcode_t ret
1951                       = compile_range (&p, pend, translate, syntax, b);
1952                     if (ret != REG_NOERROR) FREE_STACK_RETURN (ret);
1953                   }
1954
1955                 else if (p[0] == '-' && p[1] != ']')
1956                   { /* This handles ranges made up of characters only.  */
1957                     reg_errcode_t ret;
1958
1959                     /* Move past the `-'.  */
1960                     PATFETCH (c1);
1961                     
1962                     ret = compile_range (&p, pend, translate, syntax, b);
1963                     if (ret != REG_NOERROR) FREE_STACK_RETURN (ret);
1964                   }
1965
1966                 /* See if we're at the beginning of a possible character
1967                    class.  */
1968
1969                 else if (syntax & RE_CHAR_CLASSES && c == '[' && *p == ':')
1970                   { /* Leave room for the null.  */
1971                     char str[CHAR_CLASS_MAX_LENGTH + 1];
1972
1973                     PATFETCH (c);
1974                     c1 = 0;
1975
1976                     /* If pattern is `[[:'.  */
1977                     if (p == pend) FREE_STACK_RETURN (REG_EBRACK);
1978
1979                     for (;;)
1980                       {
1981                         PATFETCH (c);
1982                         if (c == ':' || c == ']' || p == pend
1983                             || c1 == CHAR_CLASS_MAX_LENGTH)
1984                           break;
1985                         str[c1++] = c;
1986                       }
1987                     str[c1] = '\0';
1988
1989                     /* If isn't a word bracketed by `[:' and:`]':
1990                        undo the ending character, the letters, and leave 
1991                        the leading `:' and `[' (but set bits for them).  */
1992                     if (c == ':' && *p == ']')
1993                       {
1994                         int ch;
1995                         boolean is_alnum = STREQ (str, "alnum");
1996                         boolean is_alpha = STREQ (str, "alpha");
1997                         boolean is_blank = STREQ (str, "blank");
1998                         boolean is_cntrl = STREQ (str, "cntrl");
1999                         boolean is_digit = STREQ (str, "digit");
2000                         boolean is_graph = STREQ (str, "graph");
2001                         boolean is_lower = STREQ (str, "lower");
2002                         boolean is_print = STREQ (str, "print");
2003                         boolean is_punct = STREQ (str, "punct");
2004                         boolean is_space = STREQ (str, "space");
2005                         boolean is_upper = STREQ (str, "upper");
2006                         boolean is_xdigit = STREQ (str, "xdigit");
2007                         
2008                         if (!IS_CHAR_CLASS (str))
2009                           FREE_STACK_RETURN (REG_ECTYPE);
2010
2011                         /* Throw away the ] at the end of the character
2012                            class.  */
2013                         PATFETCH (c);                                   
2014
2015                         if (p == pend) FREE_STACK_RETURN (REG_EBRACK);
2016
2017                         for (ch = 0; ch < 1 << BYTEWIDTH; ch++)
2018                           {
2019                             /* This was split into 3 if's to
2020                                avoid an arbitrary limit in some compiler.  */
2021                             if (   (is_alnum  && ISALNUM (ch))
2022                                 || (is_alpha  && ISALPHA (ch))
2023                                 || (is_blank  && ISBLANK (ch))
2024                                 || (is_cntrl  && ISCNTRL (ch)))
2025                               SET_LIST_BIT (ch);
2026                             if (   (is_digit  && ISDIGIT (ch))
2027                                 || (is_graph  && ISGRAPH (ch))
2028                                 || (is_lower  && ISLOWER (ch))
2029                                 || (is_print  && ISPRINT (ch)))
2030                               SET_LIST_BIT (ch);
2031                             if (   (is_punct  && ISPUNCT (ch))
2032                                 || (is_space  && ISSPACE (ch))
2033                                 || (is_upper  && ISUPPER (ch))
2034                                 || (is_xdigit && ISXDIGIT (ch)))
2035                               SET_LIST_BIT (ch);
2036                           }
2037                         had_char_class = true;
2038                       }
2039                     else
2040                       {
2041                         c1++;
2042                         while (c1--)    
2043                           PATUNFETCH;
2044                         SET_LIST_BIT ('[');
2045                         SET_LIST_BIT (':');
2046                         had_char_class = false;
2047                       }
2048                   }
2049                 else
2050                   {
2051                     had_char_class = false;
2052                     SET_LIST_BIT (c);
2053                   }
2054               }
2055
2056             /* Discard any (non)matching list bytes that are all 0 at the
2057                end of the map.  Decrease the map-length byte too.  */
2058             while ((int) b[-1] > 0 && b[b[-1] - 1] == 0) 
2059               b[-1]--; 
2060             b += b[-1];
2061           }
2062           break;
2063
2064
2065         case '(':
2066           if (syntax & RE_NO_BK_PARENS)
2067             goto handle_open;
2068           else
2069             goto normal_char;
2070
2071
2072         case ')':
2073           if (syntax & RE_NO_BK_PARENS)
2074             goto handle_close;
2075           else
2076             goto normal_char;
2077
2078
2079         case '\n':
2080           if (syntax & RE_NEWLINE_ALT)
2081             goto handle_alt;
2082           else
2083             goto normal_char;
2084
2085
2086         case '|':
2087           if (syntax & RE_NO_BK_VBAR)
2088             goto handle_alt;
2089           else
2090             goto normal_char;
2091
2092
2093         case '{':
2094            if (syntax & RE_INTERVALS && syntax & RE_NO_BK_BRACES)
2095              goto handle_interval;
2096            else
2097              goto normal_char;
2098
2099
2100         case '\\':
2101           if (p == pend) FREE_STACK_RETURN (REG_EESCAPE);
2102
2103           /* Do not translate the character after the \, so that we can
2104              distinguish, e.g., \B from \b, even if we normally would
2105              translate, e.g., B to b.  */
2106           PATFETCH_RAW (c);
2107
2108           switch (c)
2109             {
2110             case '(':
2111               if (syntax & RE_NO_BK_PARENS)
2112                 goto normal_backslash;
2113
2114             handle_open:
2115               bufp->re_nsub++;
2116               regnum++;
2117
2118               if (COMPILE_STACK_FULL)
2119                 { 
2120                   RETALLOC (compile_stack.stack, compile_stack.size << 1,
2121                             compile_stack_elt_t);
2122                   if (compile_stack.stack == NULL) return REG_ESPACE;
2123
2124                   compile_stack.size <<= 1;
2125                 }
2126
2127               /* These are the values to restore when we hit end of this
2128                  group.  They are all relative offsets, so that if the
2129                  whole pattern moves because of realloc, they will still
2130                  be valid.  */
2131               COMPILE_STACK_TOP.begalt_offset = begalt - bufp->buffer;
2132               COMPILE_STACK_TOP.fixup_alt_jump 
2133                 = fixup_alt_jump ? fixup_alt_jump - bufp->buffer + 1 : 0;
2134               COMPILE_STACK_TOP.laststart_offset = b - bufp->buffer;
2135               COMPILE_STACK_TOP.regnum = regnum;
2136
2137               /* We will eventually replace the 0 with the number of
2138                  groups inner to this one.  But do not push a
2139                  start_memory for groups beyond the last one we can
2140                  represent in the compiled pattern.  */
2141               if (regnum <= MAX_REGNUM)
2142                 {
2143                   COMPILE_STACK_TOP.inner_group_offset = b - bufp->buffer + 2;
2144                   BUF_PUSH_3 (start_memory, regnum, 0);
2145                 }
2146                 
2147               compile_stack.avail++;
2148
2149               fixup_alt_jump = 0;
2150               laststart = 0;
2151               begalt = b;
2152               /* If we've reached MAX_REGNUM groups, then this open
2153                  won't actually generate any code, so we'll have to
2154                  clear pending_exact explicitly.  */
2155               pending_exact = 0;
2156               break;
2157
2158
2159             case ')':
2160               if (syntax & RE_NO_BK_PARENS) goto normal_backslash;
2161
2162               if (COMPILE_STACK_EMPTY)
2163                 if (syntax & RE_UNMATCHED_RIGHT_PAREN_ORD)
2164                   goto normal_backslash;
2165                 else
2166                   FREE_STACK_RETURN (REG_ERPAREN);
2167
2168             handle_close:
2169               if (fixup_alt_jump)
2170                 { /* Push a dummy failure point at the end of the
2171                      alternative for a possible future
2172                      `pop_failure_jump' to pop.  See comments at
2173                      `push_dummy_failure' in `re_match_2'.  */
2174                   BUF_PUSH (push_dummy_failure);
2175                   
2176                   /* We allocated space for this jump when we assigned
2177                      to `fixup_alt_jump', in the `handle_alt' case below.  */
2178                   STORE_JUMP (jump_past_alt, fixup_alt_jump, b - 1);
2179                 }
2180
2181               /* See similar code for backslashed left paren above.  */
2182               if (COMPILE_STACK_EMPTY)
2183                 if (syntax & RE_UNMATCHED_RIGHT_PAREN_ORD)
2184                   goto normal_char;
2185                 else
2186                   FREE_STACK_RETURN (REG_ERPAREN);
2187
2188               /* Since we just checked for an empty stack above, this
2189                  ``can't happen''.  */
2190               assert (compile_stack.avail != 0);
2191               {
2192                 /* We don't just want to restore into `regnum', because
2193                    later groups should continue to be numbered higher,
2194                    as in `(ab)c(de)' -- the second group is #2.  */
2195                 regnum_t this_group_regnum;
2196
2197                 compile_stack.avail--;          
2198                 begalt = bufp->buffer + COMPILE_STACK_TOP.begalt_offset;
2199                 fixup_alt_jump
2200                   = COMPILE_STACK_TOP.fixup_alt_jump
2201                     ? bufp->buffer + COMPILE_STACK_TOP.fixup_alt_jump - 1 
2202                     : 0;
2203                 laststart = bufp->buffer + COMPILE_STACK_TOP.laststart_offset;
2204                 this_group_regnum = COMPILE_STACK_TOP.regnum;
2205                 /* If we've reached MAX_REGNUM groups, then this open
2206                    won't actually generate any code, so we'll have to
2207                    clear pending_exact explicitly.  */
2208                 pending_exact = 0;
2209
2210                 /* We're at the end of the group, so now we know how many
2211                    groups were inside this one.  */
2212                 if (this_group_regnum <= MAX_REGNUM)
2213                   {
2214                     unsigned char *inner_group_loc
2215                       = bufp->buffer + COMPILE_STACK_TOP.inner_group_offset;
2216                     
2217                     *inner_group_loc = regnum - this_group_regnum;
2218                     BUF_PUSH_3 (stop_memory, this_group_regnum,
2219                                 regnum - this_group_regnum);
2220                   }
2221               }
2222               break;
2223
2224
2225             case '|':                                   /* `\|'.  */
2226               if (syntax & RE_LIMITED_OPS || syntax & RE_NO_BK_VBAR)
2227                 goto normal_backslash;
2228             handle_alt:
2229               if (syntax & RE_LIMITED_OPS)
2230                 goto normal_char;
2231
2232               /* Insert before the previous alternative a jump which
2233                  jumps to this alternative if the former fails.  */
2234               GET_BUFFER_SPACE (3);
2235               INSERT_JUMP (on_failure_jump, begalt, b + 6);
2236               pending_exact = 0;
2237               b += 3;
2238
2239               /* The alternative before this one has a jump after it
2240                  which gets executed if it gets matched.  Adjust that
2241                  jump so it will jump to this alternative's analogous
2242                  jump (put in below, which in turn will jump to the next
2243                  (if any) alternative's such jump, etc.).  The last such
2244                  jump jumps to the correct final destination.  A picture:
2245                           _____ _____ 
2246                           |   | |   |   
2247                           |   v |   v 
2248                          a | b   | c   
2249
2250                  If we are at `b', then fixup_alt_jump right now points to a
2251                  three-byte space after `a'.  We'll put in the jump, set
2252                  fixup_alt_jump to right after `b', and leave behind three
2253                  bytes which we'll fill in when we get to after `c'.  */
2254
2255               if (fixup_alt_jump)
2256                 STORE_JUMP (jump_past_alt, fixup_alt_jump, b);
2257
2258               /* Mark and leave space for a jump after this alternative,
2259                  to be filled in later either by next alternative or
2260                  when know we're at the end of a series of alternatives.  */
2261               fixup_alt_jump = b;
2262               GET_BUFFER_SPACE (3);
2263               b += 3;
2264
2265               laststart = 0;
2266               begalt = b;
2267               break;
2268
2269
2270             case '{': 
2271               /* If \{ is a literal.  */
2272               if (!(syntax & RE_INTERVALS)
2273                      /* If we're at `\{' and it's not the open-interval 
2274                         operator.  */
2275                   || ((syntax & RE_INTERVALS) && (syntax & RE_NO_BK_BRACES))
2276                   || (p - 2 == pattern  &&  p == pend))
2277                 goto normal_backslash;
2278
2279             handle_interval:
2280               {
2281                 /* If got here, then the syntax allows intervals.  */
2282
2283                 /* At least (most) this many matches must be made.  */
2284                 int lower_bound = -1, upper_bound = -1;
2285
2286                 beg_interval = p - 1;
2287
2288                 if (p == pend)
2289                   {
2290                     if (syntax & RE_NO_BK_BRACES)
2291                       goto unfetch_interval;
2292                     else
2293                       FREE_STACK_RETURN (REG_EBRACE);
2294                   }
2295
2296                 GET_UNSIGNED_NUMBER (lower_bound);
2297
2298                 if (c == ',')
2299                   {
2300                     GET_UNSIGNED_NUMBER (upper_bound);
2301                     if (upper_bound < 0) upper_bound = RE_DUP_MAX;
2302                   }
2303                 else
2304                   /* Interval such as `{1}' => match exactly once. */
2305                   upper_bound = lower_bound;
2306
2307                 if (lower_bound < 0 || upper_bound > RE_DUP_MAX
2308                     || lower_bound > upper_bound)
2309                   {
2310                     if (syntax & RE_NO_BK_BRACES)
2311                       goto unfetch_interval;
2312                     else 
2313                       FREE_STACK_RETURN (REG_BADBR);
2314                   }
2315
2316                 if (!(syntax & RE_NO_BK_BRACES)) 
2317                   {
2318                     if (c != '\\') FREE_STACK_RETURN (REG_EBRACE);
2319
2320                     PATFETCH (c);
2321                   }
2322
2323                 if (c != '}')
2324                   {
2325                     if (syntax & RE_NO_BK_BRACES)
2326                       goto unfetch_interval;
2327                     else 
2328                       FREE_STACK_RETURN (REG_BADBR);
2329                   }
2330
2331                 /* We just parsed a valid interval.  */
2332
2333                 /* If it's invalid to have no preceding re.  */
2334                 if (!laststart)
2335                   {
2336                     if (syntax & RE_CONTEXT_INVALID_OPS)
2337                       FREE_STACK_RETURN (REG_BADRPT);
2338                     else if (syntax & RE_CONTEXT_INDEP_OPS)
2339                       laststart = b;
2340                     else
2341                       goto unfetch_interval;
2342                   }
2343
2344                 /* If the upper bound is zero, don't want to succeed at
2345                    all; jump from `laststart' to `b + 3', which will be
2346                    the end of the buffer after we insert the jump.  */
2347                  if (upper_bound == 0)
2348                    {
2349                      GET_BUFFER_SPACE (3);
2350                      INSERT_JUMP (jump, laststart, b + 3);
2351                      b += 3;
2352                    }
2353
2354                  /* Otherwise, we have a nontrivial interval.  When
2355                     we're all done, the pattern will look like:
2356                       set_number_at <jump count> <upper bound>
2357                       set_number_at <succeed_n count> <lower bound>
2358                       succeed_n <after jump addr> <succeed_n count>
2359                       <body of loop>
2360                       jump_n <succeed_n addr> <jump count>
2361                     (The upper bound and `jump_n' are omitted if
2362                     `upper_bound' is 1, though.)  */
2363                  else 
2364                    { /* If the upper bound is > 1, we need to insert
2365                         more at the end of the loop.  */
2366                      unsigned nbytes = 10 + (upper_bound > 1) * 10;
2367
2368                      GET_BUFFER_SPACE (nbytes);
2369
2370                      /* Initialize lower bound of the `succeed_n', even
2371                         though it will be set during matching by its
2372                         attendant `set_number_at' (inserted next),
2373                         because `re_compile_fastmap' needs to know.
2374                         Jump to the `jump_n' we might insert below.  */
2375                      INSERT_JUMP2 (succeed_n, laststart,
2376                                    b + 5 + (upper_bound > 1) * 5,
2377                                    lower_bound);
2378                      b += 5;
2379
2380                      /* Code to initialize the lower bound.  Insert 
2381                         before the `succeed_n'.  The `5' is the last two
2382                         bytes of this `set_number_at', plus 3 bytes of
2383                         the following `succeed_n'.  */
2384                      insert_op2 (set_number_at, laststart, 5, lower_bound, b);
2385                      b += 5;
2386
2387                      if (upper_bound > 1)
2388                        { /* More than one repetition is allowed, so
2389                             append a backward jump to the `succeed_n'
2390                             that starts this interval.
2391                             
2392                             When we've reached this during matching,
2393                             we'll have matched the interval once, so
2394                             jump back only `upper_bound - 1' times.  */
2395                          STORE_JUMP2 (jump_n, b, laststart + 5,
2396                                       upper_bound - 1);
2397                          b += 5;
2398
2399                          /* The location we want to set is the second
2400                             parameter of the `jump_n'; that is `b-2' as
2401                             an absolute address.  `laststart' will be
2402                             the `set_number_at' we're about to insert;
2403                             `laststart+3' the number to set, the source
2404                             for the relative address.  But we are
2405                             inserting into the middle of the pattern --
2406                             so everything is getting moved up by 5.
2407                             Conclusion: (b - 2) - (laststart + 3) + 5,
2408                             i.e., b - laststart.
2409                             
2410                             We insert this at the beginning of the loop
2411                             so that if we fail during matching, we'll
2412                             reinitialize the bounds.  */
2413                          insert_op2 (set_number_at, laststart, b - laststart,
2414                                      upper_bound - 1, b);
2415                          b += 5;
2416                        }
2417                    }
2418                 pending_exact = 0;
2419                 beg_interval = NULL;
2420               }
2421               break;
2422
2423             unfetch_interval:
2424               /* If an invalid interval, match the characters as literals.  */
2425                assert (beg_interval);
2426                p = beg_interval;
2427                beg_interval = NULL;
2428
2429                /* normal_char and normal_backslash need `c'.  */
2430                PATFETCH (c);    
2431
2432                if (!(syntax & RE_NO_BK_BRACES))
2433                  {
2434                    if (p > pattern  &&  p[-1] == '\\')
2435                      goto normal_backslash;
2436                  }
2437                goto normal_char;
2438
2439 #ifdef emacs
2440             /* There is no way to specify the before_dot and after_dot
2441                operators.  rms says this is ok.  --karl  */
2442             case '=':
2443               BUF_PUSH (at_dot);
2444               break;
2445
2446             case 's':   
2447               laststart = b;
2448               PATFETCH (c);
2449               BUF_PUSH_2 (syntaxspec, syntax_spec_code[c]);
2450               break;
2451
2452             case 'S':
2453               laststart = b;
2454               PATFETCH (c);
2455               BUF_PUSH_2 (notsyntaxspec, syntax_spec_code[c]);
2456               break;
2457 #endif /* emacs */
2458
2459
2460             case 'w':
2461               laststart = b;
2462               BUF_PUSH (wordchar);
2463               break;
2464
2465
2466             case 'W':
2467               laststart = b;
2468               BUF_PUSH (notwordchar);
2469               break;
2470
2471
2472             case '<':
2473               BUF_PUSH (wordbeg);
2474               break;
2475
2476             case '>':
2477               BUF_PUSH (wordend);
2478               break;
2479
2480             case 'b':
2481               BUF_PUSH (wordbound);
2482               break;
2483
2484             case 'B':
2485               BUF_PUSH (notwordbound);
2486               break;
2487
2488             case '`':
2489               BUF_PUSH (begbuf);
2490               break;
2491
2492             case '\'':
2493               BUF_PUSH (endbuf);
2494               break;
2495
2496             case '1': case '2': case '3': case '4': case '5':
2497             case '6': case '7': case '8': case '9':
2498               if (syntax & RE_NO_BK_REFS)
2499                 goto normal_char;
2500
2501               c1 = c - '0';
2502
2503               if (c1 > regnum)
2504                 FREE_STACK_RETURN (REG_ESUBREG);
2505
2506               /* Can't back reference to a subexpression if inside of it.  */
2507               if (group_in_compile_stack (compile_stack, c1))
2508                 goto normal_char;
2509
2510               laststart = b;
2511               BUF_PUSH_2 (duplicate, c1);
2512               break;
2513
2514
2515             case '+':
2516             case '?':
2517               if (syntax & RE_BK_PLUS_QM)
2518                 goto handle_plus;
2519               else
2520                 goto normal_backslash;
2521
2522             default:
2523             normal_backslash:
2524               /* You might think it would be useful for \ to mean
2525                  not to translate; but if we don't translate it
2526                  it will never match anything.  */
2527               c = TRANSLATE (c);
2528               goto normal_char;
2529             }
2530           break;
2531
2532
2533         default:
2534         /* Expects the character in `c'.  */
2535         normal_char:
2536               /* If no exactn currently being built.  */
2537           if (!pending_exact 
2538
2539               /* If last exactn not at current position.  */
2540               || pending_exact + *pending_exact + 1 != b
2541               
2542               /* We have only one byte following the exactn for the count.  */
2543               || *pending_exact == (1 << BYTEWIDTH) - 1
2544
2545               /* If followed by a repetition operator.  */
2546               || *p == '*' || *p == '^'
2547               || ((syntax & RE_BK_PLUS_QM)
2548                   ? *p == '\\' && (p[1] == '+' || p[1] == '?')
2549                   : (*p == '+' || *p == '?'))
2550               || ((syntax & RE_INTERVALS)
2551                   && ((syntax & RE_NO_BK_BRACES)
2552                       ? *p == '{'
2553                       : (p[0] == '\\' && p[1] == '{'))))
2554             {
2555               /* Start building a new exactn.  */
2556               
2557               laststart = b;
2558
2559               BUF_PUSH_2 (exactn, 0);
2560               pending_exact = b - 1;
2561             }
2562             
2563           BUF_PUSH (c);
2564           (*pending_exact)++;
2565           break;
2566         } /* switch (c) */
2567     } /* while p != pend */
2568
2569   
2570   /* Through the pattern now.  */
2571   
2572   if (fixup_alt_jump)
2573     STORE_JUMP (jump_past_alt, fixup_alt_jump, b);
2574
2575   if (!COMPILE_STACK_EMPTY) 
2576     FREE_STACK_RETURN (REG_EPAREN);
2577
2578   /* If we don't want backtracking, force success
2579      the first time we reach the end of the compiled pattern.  */
2580   if (syntax & RE_NO_POSIX_BACKTRACKING)
2581     BUF_PUSH (succeed);
2582
2583   free (compile_stack.stack);
2584
2585   /* We have succeeded; set the length of the buffer.  */
2586   bufp->used = b - bufp->buffer;
2587
2588 #ifdef DEBUG
2589   if (debug)
2590     {
2591       DEBUG_PRINT1 ("\nCompiled pattern: \n");
2592       print_compiled_pattern (bufp);
2593     }
2594 #endif /* DEBUG */
2595
2596 #ifndef MATCH_MAY_ALLOCATE
2597   /* Initialize the failure stack to the largest possible stack.  This
2598      isn't necessary unless we're trying to avoid calling alloca in
2599      the search and match routines.  */
2600   {
2601     int num_regs = bufp->re_nsub + 1;
2602
2603     /* Since DOUBLE_FAIL_STACK refuses to double only if the current size
2604        is strictly greater than re_max_failures, the largest possible stack
2605        is 2 * re_max_failures failure points.  */
2606     if (fail_stack.size < (2 * re_max_failures * MAX_FAILURE_ITEMS))
2607       {
2608         fail_stack.size = (2 * re_max_failures * MAX_FAILURE_ITEMS);
2609
2610 #ifdef emacs
2611         if (! fail_stack.stack)
2612           fail_stack.stack
2613             = (fail_stack_elt_t *) xmalloc (fail_stack.size 
2614                                             * sizeof (fail_stack_elt_t));
2615         else
2616           fail_stack.stack
2617             = (fail_stack_elt_t *) xrealloc (fail_stack.stack,
2618                                              (fail_stack.size
2619                                               * sizeof (fail_stack_elt_t)));
2620 #else /* not emacs */
2621         if (! fail_stack.stack)
2622           fail_stack.stack
2623             = (fail_stack_elt_t *) malloc (fail_stack.size 
2624                                            * sizeof (fail_stack_elt_t));
2625         else
2626           fail_stack.stack
2627             = (fail_stack_elt_t *) realloc (fail_stack.stack,
2628                                             (fail_stack.size
2629                                              * sizeof (fail_stack_elt_t)));
2630 #endif /* not emacs */
2631       }
2632
2633     regex_grow_registers (num_regs);
2634   }
2635 #endif /* not MATCH_MAY_ALLOCATE */
2636
2637   return REG_NOERROR;
2638 } /* regex_compile */
2639 \f
2640 /* Subroutines for `regex_compile'.  */
2641
2642 /* Store OP at LOC followed by two-byte integer parameter ARG.  */
2643
2644 static void
2645 store_op1 (op, loc, arg)
2646     re_opcode_t op;
2647     unsigned char *loc;
2648     int arg;
2649 {
2650   *loc = (unsigned char) op;
2651   STORE_NUMBER (loc + 1, arg);
2652 }
2653
2654
2655 /* Like `store_op1', but for two two-byte parameters ARG1 and ARG2.  */
2656
2657 static void
2658 store_op2 (op, loc, arg1, arg2)
2659     re_opcode_t op;
2660     unsigned char *loc;
2661     int arg1, arg2;
2662 {
2663   *loc = (unsigned char) op;
2664   STORE_NUMBER (loc + 1, arg1);
2665   STORE_NUMBER (loc + 3, arg2);
2666 }
2667
2668
2669 /* Copy the bytes from LOC to END to open up three bytes of space at LOC
2670    for OP followed by two-byte integer parameter ARG.  */
2671
2672 static void
2673 insert_op1 (op, loc, arg, end)
2674     re_opcode_t op;
2675     unsigned char *loc;
2676     int arg;
2677     unsigned char *end;    
2678 {
2679   register unsigned char *pfrom = end;
2680   register unsigned char *pto = end + 3;
2681
2682   while (pfrom != loc)
2683     *--pto = *--pfrom;
2684     
2685   store_op1 (op, loc, arg);
2686 }
2687
2688
2689 /* Like `insert_op1', but for two two-byte parameters ARG1 and ARG2.  */
2690
2691 static void
2692 insert_op2 (op, loc, arg1, arg2, end)
2693     re_opcode_t op;
2694     unsigned char *loc;
2695     int arg1, arg2;
2696     unsigned char *end;    
2697 {
2698   register unsigned char *pfrom = end;
2699   register unsigned char *pto = end + 5;
2700
2701   while (pfrom != loc)
2702     *--pto = *--pfrom;
2703     
2704   store_op2 (op, loc, arg1, arg2);
2705 }
2706
2707
2708 /* P points to just after a ^ in PATTERN.  Return true if that ^ comes
2709    after an alternative or a begin-subexpression.  We assume there is at
2710    least one character before the ^.  */
2711
2712 static boolean
2713 at_begline_loc_p (pattern, p, syntax)
2714     const char *pattern, *p;
2715     reg_syntax_t syntax;
2716 {
2717   const char *prev = p - 2;
2718   boolean prev_prev_backslash = prev > pattern && prev[-1] == '\\';
2719   
2720   return
2721        /* After a subexpression?  */
2722        (*prev == '(' && (syntax & RE_NO_BK_PARENS || prev_prev_backslash))
2723        /* After an alternative?  */
2724     || (*prev == '|' && (syntax & RE_NO_BK_VBAR || prev_prev_backslash));
2725 }
2726
2727
2728 /* The dual of at_begline_loc_p.  This one is for $.  We assume there is
2729    at least one character after the $, i.e., `P < PEND'.  */
2730
2731 static boolean
2732 at_endline_loc_p (p, pend, syntax)
2733     const char *p, *pend;
2734     int syntax;
2735 {
2736   const char *next = p;
2737   boolean next_backslash = *next == '\\';
2738   const char *next_next = p + 1 < pend ? p + 1 : NULL;
2739   
2740   return
2741        /* Before a subexpression?  */
2742        (syntax & RE_NO_BK_PARENS ? *next == ')'
2743         : next_backslash && next_next && *next_next == ')')
2744        /* Before an alternative?  */
2745     || (syntax & RE_NO_BK_VBAR ? *next == '|'
2746         : next_backslash && next_next && *next_next == '|');
2747 }
2748
2749
2750 /* Returns true if REGNUM is in one of COMPILE_STACK's elements and 
2751    false if it's not.  */
2752
2753 static boolean
2754 group_in_compile_stack (compile_stack, regnum)
2755     compile_stack_type compile_stack;
2756     regnum_t regnum;
2757 {
2758   int this_element;
2759
2760   for (this_element = compile_stack.avail - 1;  
2761        this_element >= 0; 
2762        this_element--)
2763     if (compile_stack.stack[this_element].regnum == regnum)
2764       return true;
2765
2766   return false;
2767 }
2768
2769
2770 /* Read the ending character of a range (in a bracket expression) from the
2771    uncompiled pattern *P_PTR (which ends at PEND).  We assume the
2772    starting character is in `P[-2]'.  (`P[-1]' is the character `-'.)
2773    Then we set the translation of all bits between the starting and
2774    ending characters (inclusive) in the compiled pattern B.
2775    
2776    Return an error code.
2777    
2778    We use these short variable names so we can use the same macros as
2779    `regex_compile' itself.  */
2780
2781 static reg_errcode_t
2782 compile_range (p_ptr, pend, translate, syntax, b)
2783     const char **p_ptr, *pend;
2784     char *translate;
2785     reg_syntax_t syntax;
2786     unsigned char *b;
2787 {
2788   unsigned this_char;
2789
2790   const char *p = *p_ptr;
2791   int range_start, range_end;
2792   
2793   if (p == pend)
2794     return REG_ERANGE;
2795
2796   /* Even though the pattern is a signed `char *', we need to fetch
2797      with unsigned char *'s; if the high bit of the pattern character
2798      is set, the range endpoints will be negative if we fetch using a
2799      signed char *.
2800
2801      We also want to fetch the endpoints without translating them; the 
2802      appropriate translation is done in the bit-setting loop below.  */
2803   /* The SVR4 compiler on the 3B2 had trouble with unsigned const char *.  */
2804   range_start = ((const unsigned char *) p)[-2];
2805   range_end   = ((const unsigned char *) p)[0];
2806
2807   /* Have to increment the pointer into the pattern string, so the
2808      caller isn't still at the ending character.  */
2809   (*p_ptr)++;
2810
2811   /* If the start is after the end, the range is empty.  */
2812   if (range_start > range_end)
2813     return syntax & RE_NO_EMPTY_RANGES ? REG_ERANGE : REG_NOERROR;
2814
2815   /* Here we see why `this_char' has to be larger than an `unsigned
2816      char' -- the range is inclusive, so if `range_end' == 0xff
2817      (assuming 8-bit characters), we would otherwise go into an infinite
2818      loop, since all characters <= 0xff.  */
2819   for (this_char = range_start; this_char <= range_end; this_char++)
2820     {
2821       SET_LIST_BIT (TRANSLATE (this_char));
2822     }
2823   
2824   return REG_NOERROR;
2825 }
2826 \f
2827 /* re_compile_fastmap computes a ``fastmap'' for the compiled pattern in
2828    BUFP.  A fastmap records which of the (1 << BYTEWIDTH) possible
2829    characters can start a string that matches the pattern.  This fastmap
2830    is used by re_search to skip quickly over impossible starting points.
2831
2832    The caller must supply the address of a (1 << BYTEWIDTH)-byte data
2833    area as BUFP->fastmap.
2834    
2835    We set the `fastmap', `fastmap_accurate', and `can_be_null' fields in
2836    the pattern buffer.
2837
2838    Returns 0 if we succeed, -2 if an internal error.   */
2839
2840 int
2841 re_compile_fastmap (bufp)
2842      struct re_pattern_buffer *bufp;
2843 {
2844   int j, k;
2845 #ifdef MATCH_MAY_ALLOCATE
2846   fail_stack_type fail_stack;
2847 #endif
2848 #ifndef REGEX_MALLOC
2849   char *destination;
2850 #endif
2851   /* We don't push any register information onto the failure stack.  */
2852   unsigned num_regs = 0;
2853   
2854   register char *fastmap = bufp->fastmap;
2855   unsigned char *pattern = bufp->buffer;
2856   unsigned long size = bufp->used;
2857   unsigned char *p = pattern;
2858   register unsigned char *pend = pattern + size;
2859
2860   /* This holds the pointer to the failure stack, when
2861      it is allocated relocatably.  */
2862   fail_stack_elt_t *failure_stack_ptr;
2863
2864   /* Assume that each path through the pattern can be null until
2865      proven otherwise.  We set this false at the bottom of switch
2866      statement, to which we get only if a particular path doesn't
2867      match the empty string.  */
2868   boolean path_can_be_null = true;
2869
2870   /* We aren't doing a `succeed_n' to begin with.  */
2871   boolean succeed_n_p = false;
2872
2873   assert (fastmap != NULL && p != NULL);
2874   
2875   INIT_FAIL_STACK ();
2876   bzero (fastmap, 1 << BYTEWIDTH);  /* Assume nothing's valid.  */
2877   bufp->fastmap_accurate = 1;       /* It will be when we're done.  */
2878   bufp->can_be_null = 0;
2879       
2880   while (1)
2881     {
2882       if (p == pend || *p == succeed)
2883         {
2884           /* We have reached the (effective) end of pattern.  */
2885           if (!FAIL_STACK_EMPTY ())
2886             {
2887               bufp->can_be_null |= path_can_be_null;
2888
2889               /* Reset for next path.  */
2890               path_can_be_null = true;
2891
2892               p = fail_stack.stack[--fail_stack.avail];
2893
2894               continue;
2895             }
2896           else
2897             break;
2898         }
2899
2900       /* We should never be about to go beyond the end of the pattern.  */
2901       assert (p < pend);
2902       
2903       switch (SWITCH_ENUM_CAST ((re_opcode_t) *p++))
2904         {
2905
2906         /* I guess the idea here is to simply not bother with a fastmap
2907            if a backreference is used, since it's too hard to figure out
2908            the fastmap for the corresponding group.  Setting
2909            `can_be_null' stops `re_search_2' from using the fastmap, so
2910            that is all we do.  */
2911         case duplicate:
2912           bufp->can_be_null = 1;
2913           goto done;
2914
2915
2916       /* Following are the cases which match a character.  These end
2917          with `break'.  */
2918
2919         case exactn:
2920           fastmap[p[1]] = 1;
2921           break;
2922
2923
2924         case charset:
2925           for (j = *p++ * BYTEWIDTH - 1; j >= 0; j--)
2926             if (p[j / BYTEWIDTH] & (1 << (j % BYTEWIDTH)))
2927               fastmap[j] = 1;
2928           break;
2929
2930
2931         case charset_not:
2932           /* Chars beyond end of map must be allowed.  */
2933           for (j = *p * BYTEWIDTH; j < (1 << BYTEWIDTH); j++)
2934             fastmap[j] = 1;
2935
2936           for (j = *p++ * BYTEWIDTH - 1; j >= 0; j--)
2937             if (!(p[j / BYTEWIDTH] & (1 << (j % BYTEWIDTH))))
2938               fastmap[j] = 1;
2939           break;
2940
2941
2942         case wordchar:
2943           for (j = 0; j < (1 << BYTEWIDTH); j++)
2944             if (SYNTAX (j) == Sword)
2945               fastmap[j] = 1;
2946           break;
2947
2948
2949         case notwordchar:
2950           for (j = 0; j < (1 << BYTEWIDTH); j++)
2951             if (SYNTAX (j) != Sword)
2952               fastmap[j] = 1;
2953           break;
2954
2955
2956         case anychar:
2957           {
2958             int fastmap_newline = fastmap['\n'];
2959
2960             /* `.' matches anything ...  */
2961             for (j = 0; j < (1 << BYTEWIDTH); j++)
2962               fastmap[j] = 1;
2963
2964             /* ... except perhaps newline.  */
2965             if (!(bufp->syntax & RE_DOT_NEWLINE))
2966               fastmap['\n'] = fastmap_newline;
2967
2968             /* Return if we have already set `can_be_null'; if we have,
2969                then the fastmap is irrelevant.  Something's wrong here.  */
2970             else if (bufp->can_be_null)
2971               goto done;
2972
2973             /* Otherwise, have to check alternative paths.  */
2974             break;
2975           }
2976
2977 #ifdef emacs
2978         case syntaxspec:
2979           k = *p++;
2980           for (j = 0; j < (1 << BYTEWIDTH); j++)
2981             if (SYNTAX (j) == (enum syntaxcode) k)
2982               fastmap[j] = 1;
2983           break;
2984
2985
2986         case notsyntaxspec:
2987           k = *p++;
2988           for (j = 0; j < (1 << BYTEWIDTH); j++)
2989             if (SYNTAX (j) != (enum syntaxcode) k)
2990               fastmap[j] = 1;
2991           break;
2992
2993
2994       /* All cases after this match the empty string.  These end with
2995          `continue'.  */
2996
2997
2998         case before_dot:
2999         case at_dot:
3000         case after_dot:
3001           continue;
3002 #endif /* not emacs */
3003
3004
3005         case no_op:
3006         case begline:
3007         case endline:
3008         case begbuf:
3009         case endbuf:
3010         case wordbound:
3011         case notwordbound:
3012         case wordbeg:
3013         case wordend:
3014         case push_dummy_failure:
3015           continue;
3016
3017
3018         case jump_n:
3019         case pop_failure_jump:
3020         case maybe_pop_jump:
3021         case jump:
3022         case jump_past_alt:
3023         case dummy_failure_jump:
3024           EXTRACT_NUMBER_AND_INCR (j, p);
3025           p += j;       
3026           if (j > 0)
3027             continue;
3028             
3029           /* Jump backward implies we just went through the body of a
3030              loop and matched nothing.  Opcode jumped to should be
3031              `on_failure_jump' or `succeed_n'.  Just treat it like an
3032              ordinary jump.  For a * loop, it has pushed its failure
3033              point already; if so, discard that as redundant.  */
3034           if ((re_opcode_t) *p != on_failure_jump
3035               && (re_opcode_t) *p != succeed_n)
3036             continue;
3037
3038           p++;
3039           EXTRACT_NUMBER_AND_INCR (j, p);
3040           p += j;               
3041           
3042           /* If what's on the stack is where we are now, pop it.  */
3043           if (!FAIL_STACK_EMPTY () 
3044               && fail_stack.stack[fail_stack.avail - 1] == p)
3045             fail_stack.avail--;
3046
3047           continue;
3048
3049
3050         case on_failure_jump:
3051         case on_failure_keep_string_jump:
3052         handle_on_failure_jump:
3053           EXTRACT_NUMBER_AND_INCR (j, p);
3054
3055           /* For some patterns, e.g., `(a?)?', `p+j' here points to the
3056              end of the pattern.  We don't want to push such a point,
3057              since when we restore it above, entering the switch will
3058              increment `p' past the end of the pattern.  We don't need
3059              to push such a point since we obviously won't find any more
3060              fastmap entries beyond `pend'.  Such a pattern can match
3061              the null string, though.  */
3062           if (p + j < pend)
3063             {
3064               if (!PUSH_PATTERN_OP (p + j, fail_stack))
3065                 {
3066                   REGEX_FREE_STACK (fail_stack.stack);
3067                   return -2;
3068                 }
3069             }
3070           else
3071             bufp->can_be_null = 1;
3072
3073           if (succeed_n_p)
3074             {
3075               EXTRACT_NUMBER_AND_INCR (k, p);   /* Skip the n.  */
3076               succeed_n_p = false;
3077             }
3078
3079           continue;
3080
3081
3082         case succeed_n:
3083           /* Get to the number of times to succeed.  */
3084           p += 2;               
3085
3086           /* Increment p past the n for when k != 0.  */
3087           EXTRACT_NUMBER_AND_INCR (k, p);
3088           if (k == 0)
3089             {
3090               p -= 4;
3091               succeed_n_p = true;  /* Spaghetti code alert.  */
3092               goto handle_on_failure_jump;
3093             }
3094           continue;
3095
3096
3097         case set_number_at:
3098           p += 4;
3099           continue;
3100
3101
3102         case start_memory:
3103         case stop_memory:
3104           p += 2;
3105           continue;
3106
3107
3108         default:
3109           abort (); /* We have listed all the cases.  */
3110         } /* switch *p++ */
3111
3112       /* Getting here means we have found the possible starting
3113          characters for one path of the pattern -- and that the empty
3114          string does not match.  We need not follow this path further.
3115          Instead, look at the next alternative (remembered on the
3116          stack), or quit if no more.  The test at the top of the loop
3117          does these things.  */
3118       path_can_be_null = false;
3119       p = pend;
3120     } /* while p */
3121
3122   /* Set `can_be_null' for the last path (also the first path, if the
3123      pattern is empty).  */
3124   bufp->can_be_null |= path_can_be_null;
3125
3126  done:
3127   REGEX_FREE_STACK (fail_stack.stack);
3128   return 0;
3129 } /* re_compile_fastmap */
3130 \f
3131 /* Set REGS to hold NUM_REGS registers, storing them in STARTS and
3132    ENDS.  Subsequent matches using PATTERN_BUFFER and REGS will use
3133    this memory for recording register information.  STARTS and ENDS
3134    must be allocated using the malloc library routine, and must each
3135    be at least NUM_REGS * sizeof (regoff_t) bytes long.
3136
3137    If NUM_REGS == 0, then subsequent matches should allocate their own
3138    register data.
3139
3140    Unless this function is called, the first search or match using
3141    PATTERN_BUFFER will allocate its own register data, without
3142    freeing the old data.  */
3143
3144 void
3145 re_set_registers (bufp, regs, num_regs, starts, ends)
3146     struct re_pattern_buffer *bufp;
3147     struct re_registers *regs;
3148     unsigned num_regs;
3149     regoff_t *starts, *ends;
3150 {
3151   if (num_regs)
3152     {
3153       bufp->regs_allocated = REGS_REALLOCATE;
3154       regs->num_regs = num_regs;
3155       regs->start = starts;
3156       regs->end = ends;
3157     }
3158   else
3159     {
3160       bufp->regs_allocated = REGS_UNALLOCATED;
3161       regs->num_regs = 0;
3162       regs->start = regs->end = (regoff_t *) 0;
3163     }
3164 }
3165 \f
3166 /* Searching routines.  */
3167
3168 /* Like re_search_2, below, but only one string is specified, and
3169    doesn't let you say where to stop matching. */
3170
3171 int
3172 re_search (bufp, string, size, startpos, range, regs)
3173      struct re_pattern_buffer *bufp;
3174      const char *string;
3175      int size, startpos, range;
3176      struct re_registers *regs;
3177 {
3178   return re_search_2 (bufp, NULL, 0, string, size, startpos, range, 
3179                       regs, size);
3180 }
3181
3182
3183 /* Using the compiled pattern in BUFP->buffer, first tries to match the
3184    virtual concatenation of STRING1 and STRING2, starting first at index
3185    STARTPOS, then at STARTPOS + 1, and so on.
3186    
3187    STRING1 and STRING2 have length SIZE1 and SIZE2, respectively.
3188    
3189    RANGE is how far to scan while trying to match.  RANGE = 0 means try
3190    only at STARTPOS; in general, the last start tried is STARTPOS +
3191    RANGE.
3192    
3193    In REGS, return the indices of the virtual concatenation of STRING1
3194    and STRING2 that matched the entire BUFP->buffer and its contained
3195    subexpressions.
3196    
3197    Do not consider matching one past the index STOP in the virtual
3198    concatenation of STRING1 and STRING2.
3199
3200    We return either the position in the strings at which the match was
3201    found, -1 if no match, or -2 if error (such as failure
3202    stack overflow).  */
3203
3204 int
3205 re_search_2 (bufp, string1, size1, string2, size2, startpos, range, regs, stop)
3206      struct re_pattern_buffer *bufp;
3207      const char *string1, *string2;
3208      int size1, size2;
3209      int startpos;
3210      int range;
3211      struct re_registers *regs;
3212      int stop;
3213 {
3214   int val;
3215   register char *fastmap = bufp->fastmap;
3216   register char *translate = bufp->translate;
3217   int total_size = size1 + size2;
3218   int endpos = startpos + range;
3219
3220   /* Check for out-of-range STARTPOS.  */
3221   if (startpos < 0 || startpos > total_size)
3222     return -1;
3223     
3224   /* Fix up RANGE if it might eventually take us outside
3225      the virtual concatenation of STRING1 and STRING2.  */
3226   if (endpos < -1)
3227     range = -1 - startpos;
3228   else if (endpos > total_size)
3229     range = total_size - startpos;
3230
3231   /* If the search isn't to be a backwards one, don't waste time in a
3232      search for a pattern that must be anchored.  */
3233   if (bufp->used > 0 && (re_opcode_t) bufp->buffer[0] == begbuf && range > 0)
3234     {
3235       if (startpos > 0)
3236         return -1;
3237       else
3238         range = 1;
3239     }
3240
3241   /* Update the fastmap now if not correct already.  */
3242   if (fastmap && !bufp->fastmap_accurate)
3243     if (re_compile_fastmap (bufp) == -2)
3244       return -2;
3245   
3246   /* Loop through the string, looking for a place to start matching.  */
3247   for (;;)
3248     { 
3249       /* If a fastmap is supplied, skip quickly over characters that
3250          cannot be the start of a match.  If the pattern can match the
3251          null string, however, we don't need to skip characters; we want
3252          the first null string.  */
3253       if (fastmap && startpos < total_size && !bufp->can_be_null)
3254         {
3255           if (range > 0)        /* Searching forwards.  */
3256             {
3257               register const char *d;
3258               register int lim = 0;
3259               int irange = range;
3260
3261               if (startpos < size1 && startpos + range >= size1)
3262                 lim = range - (size1 - startpos);
3263
3264               d = (startpos >= size1 ? string2 - size1 : string1) + startpos;
3265    
3266               /* Written out as an if-else to avoid testing `translate'
3267                  inside the loop.  */
3268               if (translate)
3269                 while (range > lim
3270                        && !fastmap[(unsigned char)
3271                                    translate[(unsigned char) *d++]])
3272                   range--;
3273               else
3274                 while (range > lim && !fastmap[(unsigned char) *d++])
3275                   range--;
3276
3277               startpos += irange - range;
3278             }
3279           else                          /* Searching backwards.  */
3280             {
3281               register char c = (size1 == 0 || startpos >= size1
3282                                  ? string2[startpos - size1] 
3283                                  : string1[startpos]);
3284
3285               if (!fastmap[(unsigned char) TRANSLATE (c)])
3286                 goto advance;
3287             }
3288         }
3289
3290       /* If can't match the null string, and that's all we have left, fail.  */
3291       if (range >= 0 && startpos == total_size && fastmap
3292           && !bufp->can_be_null)
3293         return -1;
3294
3295       val = re_match_2_internal (bufp, string1, size1, string2, size2,
3296                                  startpos, regs, stop);
3297 #ifndef REGEX_MALLOC
3298 #ifdef C_ALLOCA
3299       alloca (0);
3300 #endif
3301 #endif
3302
3303       if (val >= 0)
3304         return startpos;
3305         
3306       if (val == -2)
3307         return -2;
3308
3309     advance:
3310       if (!range) 
3311         break;
3312       else if (range > 0) 
3313         {
3314           range--; 
3315           startpos++;
3316         }
3317       else
3318         {
3319           range++; 
3320           startpos--;
3321         }
3322     }
3323   return -1;
3324 } /* re_search_2 */
3325 \f
3326 /* Declarations and macros for re_match_2.  */
3327
3328 static int bcmp_translate ();
3329 static boolean alt_match_null_string_p (),
3330                common_op_match_null_string_p (),
3331                group_match_null_string_p ();
3332
3333 /* This converts PTR, a pointer into one of the search strings `string1'
3334    and `string2' into an offset from the beginning of that string.  */
3335 #define POINTER_TO_OFFSET(ptr)                  \
3336   (FIRST_STRING_P (ptr)                         \
3337    ? ((regoff_t) ((ptr) - string1))             \
3338    : ((regoff_t) ((ptr) - string2 + size1)))
3339
3340 /* Macros for dealing with the split strings in re_match_2.  */
3341
3342 #define MATCHING_IN_FIRST_STRING  (dend == end_match_1)
3343
3344 /* Call before fetching a character with *d.  This switches over to
3345    string2 if necessary.  */
3346 #define PREFETCH()                                                      \
3347   while (d == dend)                                                     \
3348     {                                                                   \
3349       /* End of string2 => fail.  */                                    \
3350       if (dend == end_match_2)                                          \
3351         goto fail;                                                      \
3352       /* End of string1 => advance to string2.  */                      \
3353       d = string2;                                                      \
3354       dend = end_match_2;                                               \
3355     }
3356
3357
3358 /* Test if at very beginning or at very end of the virtual concatenation
3359    of `string1' and `string2'.  If only one string, it's `string2'.  */
3360 #define AT_STRINGS_BEG(d) ((d) == (size1 ? string1 : string2) || !size2)
3361 #define AT_STRINGS_END(d) ((d) == end2) 
3362
3363
3364 /* Test if D points to a character which is word-constituent.  We have
3365    two special cases to check for: if past the end of string1, look at
3366    the first character in string2; and if before the beginning of
3367    string2, look at the last character in string1.  */
3368 #define WORDCHAR_P(d)                                                   \
3369   (SYNTAX ((d) == end1 ? *string2                                       \
3370            : (d) == string2 - 1 ? *(end1 - 1) : *(d))                   \
3371    == Sword)
3372
3373 /* Test if the character before D and the one at D differ with respect
3374    to being word-constituent.  */
3375 #define AT_WORD_BOUNDARY(d)                                             \
3376   (AT_STRINGS_BEG (d) || AT_STRINGS_END (d)                             \
3377    || WORDCHAR_P (d - 1) != WORDCHAR_P (d))
3378
3379
3380 /* Free everything we malloc.  */
3381 #ifdef MATCH_MAY_ALLOCATE
3382 #define FREE_VAR(var) if (var) REGEX_FREE (var); var = NULL
3383 #define FREE_VARIABLES()                                                \
3384   do {                                                                  \
3385     REGEX_FREE_STACK (fail_stack.stack);                                \
3386     FREE_VAR (regstart);                                                \
3387     FREE_VAR (regend);                                                  \
3388     FREE_VAR (old_regstart);                                            \
3389     FREE_VAR (old_regend);                                              \
3390     FREE_VAR (best_regstart);                                           \
3391     FREE_VAR (best_regend);                                             \
3392     FREE_VAR (reg_info);                                                \
3393     FREE_VAR (reg_dummy);                                               \
3394     FREE_VAR (reg_info_dummy);                                          \
3395   } while (0)
3396 #else
3397 #define FREE_VARIABLES() /* Do nothing!  */
3398 #endif /* not MATCH_MAY_ALLOCATE */
3399
3400 /* These values must meet several constraints.  They must not be valid
3401    register values; since we have a limit of 255 registers (because
3402    we use only one byte in the pattern for the register number), we can
3403    use numbers larger than 255.  They must differ by 1, because of
3404    NUM_FAILURE_ITEMS above.  And the value for the lowest register must
3405    be larger than the value for the highest register, so we do not try
3406    to actually save any registers when none are active.  */
3407 #define NO_HIGHEST_ACTIVE_REG (1 << BYTEWIDTH)
3408 #define NO_LOWEST_ACTIVE_REG (NO_HIGHEST_ACTIVE_REG + 1)
3409 \f
3410 /* Matching routines.  */
3411
3412 #ifndef emacs   /* Emacs never uses this.  */
3413 /* re_match is like re_match_2 except it takes only a single string.  */
3414
3415 int
3416 re_match (bufp, string, size, pos, regs)
3417      struct re_pattern_buffer *bufp;
3418      const char *string;
3419      int size, pos;
3420      struct re_registers *regs;
3421 {
3422   int result = re_match_2_internal (bufp, NULL, 0, string, size,
3423                                     pos, regs, size);
3424   alloca (0);
3425   return result;
3426 }
3427 #endif /* not emacs */
3428
3429
3430 /* re_match_2 matches the compiled pattern in BUFP against the
3431    the (virtual) concatenation of STRING1 and STRING2 (of length SIZE1
3432    and SIZE2, respectively).  We start matching at POS, and stop
3433    matching at STOP.
3434    
3435    If REGS is non-null and the `no_sub' field of BUFP is nonzero, we
3436    store offsets for the substring each group matched in REGS.  See the
3437    documentation for exactly how many groups we fill.
3438
3439    We return -1 if no match, -2 if an internal error (such as the
3440    failure stack overflowing).  Otherwise, we return the length of the
3441    matched substring.  */
3442
3443 int
3444 re_match_2 (bufp, string1, size1, string2, size2, pos, regs, stop)
3445      struct re_pattern_buffer *bufp;
3446      const char *string1, *string2;
3447      int size1, size2;
3448      int pos;
3449      struct re_registers *regs;
3450      int stop;
3451 {
3452   int result = re_match_2_internal (bufp, string1, size1, string2, size2,
3453                                     pos, regs, stop);
3454   alloca (0);
3455   return result;
3456 }
3457
3458 /* This is a separate function so that we can force an alloca cleanup
3459    afterwards.  */
3460 static int
3461 re_match_2_internal (bufp, string1, size1, string2, size2, pos, regs, stop)
3462      struct re_pattern_buffer *bufp;
3463      const char *string1, *string2;
3464      int size1, size2;
3465      int pos;
3466      struct re_registers *regs;
3467      int stop;
3468 {
3469   /* General temporaries.  */
3470   int mcnt;
3471   unsigned char *p1;
3472
3473   /* Just past the end of the corresponding string.  */
3474   const char *end1, *end2;
3475
3476   /* Pointers into string1 and string2, just past the last characters in
3477      each to consider matching.  */
3478   const char *end_match_1, *end_match_2;
3479
3480   /* Where we are in the data, and the end of the current string.  */
3481   const char *d, *dend;
3482   
3483   /* Where we are in the pattern, and the end of the pattern.  */
3484   unsigned char *p = bufp->buffer;
3485   register unsigned char *pend = p + bufp->used;
3486
3487   /* Mark the opcode just after a start_memory, so we can test for an
3488      empty subpattern when we get to the stop_memory.  */
3489   unsigned char *just_past_start_mem = 0;
3490
3491   /* We use this to map every character in the string.  */
3492   char *translate = bufp->translate;
3493
3494   /* Failure point stack.  Each place that can handle a failure further
3495      down the line pushes a failure point on this stack.  It consists of
3496      restart, regend, and reg_info for all registers corresponding to
3497      the subexpressions we're currently inside, plus the number of such
3498      registers, and, finally, two char *'s.  The first char * is where
3499      to resume scanning the pattern; the second one is where to resume
3500      scanning the strings.  If the latter is zero, the failure point is
3501      a ``dummy''; if a failure happens and the failure point is a dummy,
3502      it gets discarded and the next next one is tried.  */
3503 #ifdef MATCH_MAY_ALLOCATE /* otherwise, this is global.  */
3504   fail_stack_type fail_stack;
3505 #endif
3506 #ifdef DEBUG
3507   static unsigned failure_id = 0;
3508   unsigned nfailure_points_pushed = 0, nfailure_points_popped = 0;
3509 #endif
3510
3511   /* This holds the pointer to the failure stack, when
3512      it is allocated relocatably.  */
3513   fail_stack_elt_t *failure_stack_ptr;
3514
3515   /* We fill all the registers internally, independent of what we
3516      return, for use in backreferences.  The number here includes
3517      an element for register zero.  */
3518   unsigned num_regs = bufp->re_nsub + 1;
3519   
3520   /* The currently active registers.  */
3521   unsigned lowest_active_reg = NO_LOWEST_ACTIVE_REG;
3522   unsigned highest_active_reg = NO_HIGHEST_ACTIVE_REG;
3523
3524   /* Information on the contents of registers. These are pointers into
3525      the input strings; they record just what was matched (on this
3526      attempt) by a subexpression part of the pattern, that is, the
3527      regnum-th regstart pointer points to where in the pattern we began
3528      matching and the regnum-th regend points to right after where we
3529      stopped matching the regnum-th subexpression.  (The zeroth register
3530      keeps track of what the whole pattern matches.)  */
3531 #ifdef MATCH_MAY_ALLOCATE /* otherwise, these are global.  */
3532   const char **regstart, **regend;
3533 #endif
3534
3535   /* If a group that's operated upon by a repetition operator fails to
3536      match anything, then the register for its start will need to be
3537      restored because it will have been set to wherever in the string we
3538      are when we last see its open-group operator.  Similarly for a
3539      register's end.  */
3540 #ifdef MATCH_MAY_ALLOCATE /* otherwise, these are global.  */
3541   const char **old_regstart, **old_regend;
3542 #endif
3543
3544   /* The is_active field of reg_info helps us keep track of which (possibly
3545      nested) subexpressions we are currently in. The matched_something
3546      field of reg_info[reg_num] helps us tell whether or not we have
3547      matched any of the pattern so far this time through the reg_num-th
3548      subexpression.  These two fields get reset each time through any
3549      loop their register is in.  */
3550 #ifdef MATCH_MAY_ALLOCATE /* otherwise, this is global.  */
3551   register_info_type *reg_info; 
3552 #endif
3553
3554   /* The following record the register info as found in the above
3555      variables when we find a match better than any we've seen before. 
3556      This happens as we backtrack through the failure points, which in
3557      turn happens only if we have not yet matched the entire string. */
3558   unsigned best_regs_set = false;
3559 #ifdef MATCH_MAY_ALLOCATE /* otherwise, these are global.  */
3560   const char **best_regstart, **best_regend;
3561 #endif
3562   
3563   /* Logically, this is `best_regend[0]'.  But we don't want to have to
3564      allocate space for that if we're not allocating space for anything
3565      else (see below).  Also, we never need info about register 0 for
3566      any of the other register vectors, and it seems rather a kludge to
3567      treat `best_regend' differently than the rest.  So we keep track of
3568      the end of the best match so far in a separate variable.  We
3569      initialize this to NULL so that when we backtrack the first time
3570      and need to test it, it's not garbage.  */
3571   const char *match_end = NULL;
3572
3573   /* This helps SET_REGS_MATCHED avoid doing redundant work.  */
3574   int set_regs_matched_done = 0;
3575
3576   /* Used when we pop values we don't care about.  */
3577 #ifdef MATCH_MAY_ALLOCATE /* otherwise, these are global.  */
3578   const char **reg_dummy;
3579   register_info_type *reg_info_dummy;
3580 #endif
3581
3582 #ifdef DEBUG
3583   /* Counts the total number of registers pushed.  */
3584   unsigned num_regs_pushed = 0;         
3585 #endif
3586
3587   DEBUG_PRINT1 ("\n\nEntering re_match_2.\n");
3588   
3589   INIT_FAIL_STACK ();
3590   
3591 #ifdef MATCH_MAY_ALLOCATE
3592   /* Do not bother to initialize all the register variables if there are
3593      no groups in the pattern, as it takes a fair amount of time.  If
3594      there are groups, we include space for register 0 (the whole
3595      pattern), even though we never use it, since it simplifies the
3596      array indexing.  We should fix this.  */
3597   if (bufp->re_nsub)
3598     {
3599       regstart = REGEX_TALLOC (num_regs, const char *);
3600       regend = REGEX_TALLOC (num_regs, const char *);
3601       old_regstart = REGEX_TALLOC (num_regs, const char *);
3602       old_regend = REGEX_TALLOC (num_regs, const char *);
3603       best_regstart = REGEX_TALLOC (num_regs, const char *);
3604       best_regend = REGEX_TALLOC (num_regs, const char *);
3605       reg_info = REGEX_TALLOC (num_regs, register_info_type);
3606       reg_dummy = REGEX_TALLOC (num_regs, const char *);
3607       reg_info_dummy = REGEX_TALLOC (num_regs, register_info_type);
3608
3609       if (!(regstart && regend && old_regstart && old_regend && reg_info 
3610             && best_regstart && best_regend && reg_dummy && reg_info_dummy)) 
3611         {
3612           FREE_VARIABLES ();
3613           return -2;
3614         }
3615     }
3616   else
3617     {
3618       /* We must initialize all our variables to NULL, so that
3619          `FREE_VARIABLES' doesn't try to free them.  */
3620       regstart = regend = old_regstart = old_regend = best_regstart
3621         = best_regend = reg_dummy = NULL;
3622       reg_info = reg_info_dummy = (register_info_type *) NULL;
3623     }
3624 #endif /* MATCH_MAY_ALLOCATE */
3625
3626   /* The starting position is bogus.  */
3627   if (pos < 0 || pos > size1 + size2)
3628     {
3629       FREE_VARIABLES ();
3630       return -1;
3631     }
3632     
3633   /* Initialize subexpression text positions to -1 to mark ones that no
3634      start_memory/stop_memory has been seen for. Also initialize the
3635      register information struct.  */
3636   for (mcnt = 1; mcnt < num_regs; mcnt++)
3637     {
3638       regstart[mcnt] = regend[mcnt] 
3639         = old_regstart[mcnt] = old_regend[mcnt] = REG_UNSET_VALUE;
3640         
3641       REG_MATCH_NULL_STRING_P (reg_info[mcnt]) = MATCH_NULL_UNSET_VALUE;
3642       IS_ACTIVE (reg_info[mcnt]) = 0;
3643       MATCHED_SOMETHING (reg_info[mcnt]) = 0;
3644       EVER_MATCHED_SOMETHING (reg_info[mcnt]) = 0;
3645     }
3646   
3647   /* We move `string1' into `string2' if the latter's empty -- but not if
3648      `string1' is null.  */
3649   if (size2 == 0 && string1 != NULL)
3650     {
3651       string2 = string1;
3652       size2 = size1;
3653       string1 = 0;
3654       size1 = 0;
3655     }
3656   end1 = string1 + size1;
3657   end2 = string2 + size2;
3658
3659   /* Compute where to stop matching, within the two strings.  */
3660   if (stop <= size1)
3661     {
3662       end_match_1 = string1 + stop;
3663       end_match_2 = string2;
3664     }
3665   else
3666     {
3667       end_match_1 = end1;
3668       end_match_2 = string2 + stop - size1;
3669     }
3670
3671   /* `p' scans through the pattern as `d' scans through the data. 
3672      `dend' is the end of the input string that `d' points within.  `d'
3673      is advanced into the following input string whenever necessary, but
3674      this happens before fetching; therefore, at the beginning of the
3675      loop, `d' can be pointing at the end of a string, but it cannot
3676      equal `string2'.  */
3677   if (size1 > 0 && pos <= size1)
3678     {
3679       d = string1 + pos;
3680       dend = end_match_1;
3681     }
3682   else
3683     {
3684       d = string2 + pos - size1;
3685       dend = end_match_2;
3686     }
3687
3688   DEBUG_PRINT1 ("The compiled pattern is: ");
3689   DEBUG_PRINT_COMPILED_PATTERN (bufp, p, pend);
3690   DEBUG_PRINT1 ("The string to match is: `");
3691   DEBUG_PRINT_DOUBLE_STRING (d, string1, size1, string2, size2);
3692   DEBUG_PRINT1 ("'\n");
3693   
3694   /* This loops over pattern commands.  It exits by returning from the
3695      function if the match is complete, or it drops through if the match
3696      fails at this starting point in the input data.  */
3697   for (;;)
3698     {
3699       DEBUG_PRINT2 ("\n0x%x: ", p);
3700
3701       if (p == pend)
3702         { /* End of pattern means we might have succeeded.  */
3703           DEBUG_PRINT1 ("end of pattern ... ");
3704           
3705           /* If we haven't matched the entire string, and we want the
3706              longest match, try backtracking.  */
3707           if (d != end_match_2)
3708             {
3709               /* 1 if this match ends in the same string (string1 or string2)
3710                  as the best previous match.  */
3711               boolean same_str_p = (FIRST_STRING_P (match_end) 
3712                                     == MATCHING_IN_FIRST_STRING);
3713               /* 1 if this match is the best seen so far.  */
3714               boolean best_match_p;
3715
3716               /* AIX compiler got confused when this was combined
3717                  with the previous declaration.  */
3718               if (same_str_p)
3719                 best_match_p = d > match_end;
3720               else
3721                 best_match_p = !MATCHING_IN_FIRST_STRING;
3722
3723               DEBUG_PRINT1 ("backtracking.\n");
3724               
3725               if (!FAIL_STACK_EMPTY ())
3726                 { /* More failure points to try.  */
3727
3728                   /* If exceeds best match so far, save it.  */
3729                   if (!best_regs_set || best_match_p)
3730                     {
3731                       best_regs_set = true;
3732                       match_end = d;
3733                       
3734                       DEBUG_PRINT1 ("\nSAVING match as best so far.\n");
3735                       
3736                       for (mcnt = 1; mcnt < num_regs; mcnt++)
3737                         {
3738                           best_regstart[mcnt] = regstart[mcnt];
3739                           best_regend[mcnt] = regend[mcnt];
3740                         }
3741                     }
3742                   goto fail;           
3743                 }
3744
3745               /* If no failure points, don't restore garbage.  And if
3746                  last match is real best match, don't restore second
3747                  best one. */
3748               else if (best_regs_set && !best_match_p)
3749                 {
3750                 restore_best_regs:
3751                   /* Restore best match.  It may happen that `dend ==
3752                      end_match_1' while the restored d is in string2.
3753                      For example, the pattern `x.*y.*z' against the
3754                      strings `x-' and `y-z-', if the two strings are
3755                      not consecutive in memory.  */
3756                   DEBUG_PRINT1 ("Restoring best registers.\n");
3757                   
3758                   d = match_end;
3759                   dend = ((d >= string1 && d <= end1)
3760                            ? end_match_1 : end_match_2);
3761
3762                   for (mcnt = 1; mcnt < num_regs; mcnt++)
3763                     {
3764                       regstart[mcnt] = best_regstart[mcnt];
3765                       regend[mcnt] = best_regend[mcnt];
3766                     }
3767                 }
3768             } /* d != end_match_2 */
3769
3770         succeed_label:
3771           DEBUG_PRINT1 ("Accepting match.\n");
3772
3773           /* If caller wants register contents data back, do it.  */
3774           if (regs && !bufp->no_sub)
3775             {
3776               /* Have the register data arrays been allocated?  */
3777               if (bufp->regs_allocated == REGS_UNALLOCATED)
3778                 { /* No.  So allocate them with malloc.  We need one
3779                      extra element beyond `num_regs' for the `-1' marker
3780                      GNU code uses.  */
3781                   regs->num_regs = MAX (RE_NREGS, num_regs + 1);
3782                   regs->start = TALLOC (regs->num_regs, regoff_t);
3783                   regs->end = TALLOC (regs->num_regs, regoff_t);
3784                   if (regs->start == NULL || regs->end == NULL)
3785                     {
3786                       FREE_VARIABLES ();
3787                       return -2;
3788                     }
3789                   bufp->regs_allocated = REGS_REALLOCATE;
3790                 }
3791               else if (bufp->regs_allocated == REGS_REALLOCATE)
3792                 { /* Yes.  If we need more elements than were already
3793                      allocated, reallocate them.  If we need fewer, just
3794                      leave it alone.  */
3795                   if (regs->num_regs < num_regs + 1)
3796                     {
3797                       regs->num_regs = num_regs + 1;
3798                       RETALLOC (regs->start, regs->num_regs, regoff_t);
3799                       RETALLOC (regs->end, regs->num_regs, regoff_t);
3800                       if (regs->start == NULL || regs->end == NULL)
3801                         {
3802                           FREE_VARIABLES ();
3803                           return -2;
3804                         }
3805                     }
3806                 }
3807               else
3808                 {
3809                   /* These braces fend off a "empty body in an else-statement"
3810                      warning under GCC when assert expands to nothing.  */
3811                   assert (bufp->regs_allocated == REGS_FIXED);
3812                 }
3813
3814               /* Convert the pointer data in `regstart' and `regend' to
3815                  indices.  Register zero has to be set differently,
3816                  since we haven't kept track of any info for it.  */
3817               if (regs->num_regs > 0)
3818                 {
3819                   regs->start[0] = pos;
3820                   regs->end[0] = (MATCHING_IN_FIRST_STRING
3821                                   ? ((regoff_t) (d - string1))
3822                                   : ((regoff_t) (d - string2 + size1)));
3823                 }
3824               
3825               /* Go through the first `min (num_regs, regs->num_regs)'
3826                  registers, since that is all we initialized.  */
3827               for (mcnt = 1; mcnt < MIN (num_regs, regs->num_regs); mcnt++)
3828                 {
3829                   if (REG_UNSET (regstart[mcnt]) || REG_UNSET (regend[mcnt]))
3830                     regs->start[mcnt] = regs->end[mcnt] = -1;
3831                   else
3832                     {
3833                       regs->start[mcnt]
3834                         = (regoff_t) POINTER_TO_OFFSET (regstart[mcnt]);
3835                       regs->end[mcnt]
3836                         = (regoff_t) POINTER_TO_OFFSET (regend[mcnt]);
3837                     }
3838                 }
3839               
3840               /* If the regs structure we return has more elements than
3841                  were in the pattern, set the extra elements to -1.  If
3842                  we (re)allocated the registers, this is the case,
3843                  because we always allocate enough to have at least one
3844                  -1 at the end.  */
3845               for (mcnt = num_regs; mcnt < regs->num_regs; mcnt++)
3846                 regs->start[mcnt] = regs->end[mcnt] = -1;
3847             } /* regs && !bufp->no_sub */
3848
3849           DEBUG_PRINT4 ("%u failure points pushed, %u popped (%u remain).\n",
3850                         nfailure_points_pushed, nfailure_points_popped,
3851                         nfailure_points_pushed - nfailure_points_popped);
3852           DEBUG_PRINT2 ("%u registers pushed.\n", num_regs_pushed);
3853
3854           mcnt = d - pos - (MATCHING_IN_FIRST_STRING 
3855                             ? string1 
3856                             : string2 - size1);
3857
3858           DEBUG_PRINT2 ("Returning %d from re_match_2.\n", mcnt);
3859
3860           FREE_VARIABLES ();
3861           return mcnt;
3862         }
3863
3864       /* Otherwise match next pattern command.  */
3865       switch (SWITCH_ENUM_CAST ((re_opcode_t) *p++))
3866         {
3867         /* Ignore these.  Used to ignore the n of succeed_n's which
3868            currently have n == 0.  */
3869         case no_op:
3870           DEBUG_PRINT1 ("EXECUTING no_op.\n");
3871           break;
3872
3873         case succeed:
3874           DEBUG_PRINT1 ("EXECUTING succeed.\n");
3875           goto succeed_label;
3876
3877         /* Match the next n pattern characters exactly.  The following
3878            byte in the pattern defines n, and the n bytes after that
3879            are the characters to match.  */
3880         case exactn:
3881           mcnt = *p++;
3882           DEBUG_PRINT2 ("EXECUTING exactn %d.\n", mcnt);
3883
3884           /* This is written out as an if-else so we don't waste time
3885              testing `translate' inside the loop.  */
3886           if (translate)
3887             {
3888               do
3889                 {
3890                   PREFETCH ();
3891                   if (translate[(unsigned char) *d++] != (char) *p++)
3892                     goto fail;
3893                 }
3894               while (--mcnt);
3895             }
3896           else
3897             {
3898               do
3899                 {
3900                   PREFETCH ();
3901                   if (*d++ != (char) *p++) goto fail;
3902                 }
3903               while (--mcnt);
3904             }
3905           SET_REGS_MATCHED ();
3906           break;
3907
3908
3909         /* Match any character except possibly a newline or a null.  */
3910         case anychar:
3911           DEBUG_PRINT1 ("EXECUTING anychar.\n");
3912
3913           PREFETCH ();
3914
3915           if ((!(bufp->syntax & RE_DOT_NEWLINE) && TRANSLATE (*d) == '\n')
3916               || (bufp->syntax & RE_DOT_NOT_NULL && TRANSLATE (*d) == '\000'))
3917             goto fail;
3918
3919           SET_REGS_MATCHED ();
3920           DEBUG_PRINT2 ("  Matched `%d'.\n", *d);
3921           d++;
3922           break;
3923
3924
3925         case charset:
3926         case charset_not:
3927           {
3928             register unsigned char c;
3929             boolean not = (re_opcode_t) *(p - 1) == charset_not;
3930
3931             DEBUG_PRINT2 ("EXECUTING charset%s.\n", not ? "_not" : "");
3932
3933             PREFETCH ();
3934             c = TRANSLATE (*d); /* The character to match.  */
3935
3936             /* Cast to `unsigned' instead of `unsigned char' in case the
3937                bit list is a full 32 bytes long.  */
3938             if (c < (unsigned) (*p * BYTEWIDTH)
3939                 && p[1 + c / BYTEWIDTH] & (1 << (c % BYTEWIDTH)))
3940               not = !not;
3941
3942             p += 1 + *p;
3943
3944             if (!not) goto fail;
3945             
3946             SET_REGS_MATCHED ();
3947             d++;
3948             break;
3949           }
3950
3951
3952         /* The beginning of a group is represented by start_memory.
3953            The arguments are the register number in the next byte, and the
3954            number of groups inner to this one in the next.  The text
3955            matched within the group is recorded (in the internal
3956            registers data structure) under the register number.  */
3957         case start_memory:
3958           DEBUG_PRINT3 ("EXECUTING start_memory %d (%d):\n", *p, p[1]);
3959
3960           /* Find out if this group can match the empty string.  */
3961           p1 = p;               /* To send to group_match_null_string_p.  */
3962           
3963           if (REG_MATCH_NULL_STRING_P (reg_info[*p]) == MATCH_NULL_UNSET_VALUE)
3964             REG_MATCH_NULL_STRING_P (reg_info[*p]) 
3965               = group_match_null_string_p (&p1, pend, reg_info);
3966
3967           /* Save the position in the string where we were the last time
3968              we were at this open-group operator in case the group is
3969              operated upon by a repetition operator, e.g., with `(a*)*b'
3970              against `ab'; then we want to ignore where we are now in
3971              the string in case this attempt to match fails.  */
3972           old_regstart[*p] = REG_MATCH_NULL_STRING_P (reg_info[*p])
3973                              ? REG_UNSET (regstart[*p]) ? d : regstart[*p]
3974                              : regstart[*p];
3975           DEBUG_PRINT2 ("  old_regstart: %d\n", 
3976                          POINTER_TO_OFFSET (old_regstart[*p]));
3977
3978           regstart[*p] = d;
3979           DEBUG_PRINT2 ("  regstart: %d\n", POINTER_TO_OFFSET (regstart[*p]));
3980
3981           IS_ACTIVE (reg_info[*p]) = 1;
3982           MATCHED_SOMETHING (reg_info[*p]) = 0;
3983
3984           /* Clear this whenever we change the register activity status.  */
3985           set_regs_matched_done = 0;
3986           
3987           /* This is the new highest active register.  */
3988           highest_active_reg = *p;
3989           
3990           /* If nothing was active before, this is the new lowest active
3991              register.  */
3992           if (lowest_active_reg == NO_LOWEST_ACTIVE_REG)
3993             lowest_active_reg = *p;
3994
3995           /* Move past the register number and inner group count.  */
3996           p += 2;
3997           just_past_start_mem = p;
3998
3999           break;
4000
4001
4002         /* The stop_memory opcode represents the end of a group.  Its
4003            arguments are the same as start_memory's: the register
4004            number, and the number of inner groups.  */
4005         case stop_memory:
4006           DEBUG_PRINT3 ("EXECUTING stop_memory %d (%d):\n", *p, p[1]);
4007              
4008           /* We need to save the string position the last time we were at
4009              this close-group operator in case the group is operated
4010              upon by a repetition operator, e.g., with `((a*)*(b*)*)*'
4011              against `aba'; then we want to ignore where we are now in
4012              the string in case this attempt to match fails.  */
4013           old_regend[*p] = REG_MATCH_NULL_STRING_P (reg_info[*p])
4014                            ? REG_UNSET (regend[*p]) ? d : regend[*p]
4015                            : regend[*p];
4016           DEBUG_PRINT2 ("      old_regend: %d\n", 
4017                          POINTER_TO_OFFSET (old_regend[*p]));
4018
4019           regend[*p] = d;
4020           DEBUG_PRINT2 ("      regend: %d\n", POINTER_TO_OFFSET (regend[*p]));
4021
4022           /* This register isn't active anymore.  */
4023           IS_ACTIVE (reg_info[*p]) = 0;
4024
4025           /* Clear this whenever we change the register activity status.  */
4026           set_regs_matched_done = 0;
4027
4028           /* If this was the only register active, nothing is active
4029              anymore.  */
4030           if (lowest_active_reg == highest_active_reg)
4031             {
4032               lowest_active_reg = NO_LOWEST_ACTIVE_REG;
4033               highest_active_reg = NO_HIGHEST_ACTIVE_REG;
4034             }
4035           else
4036             { /* We must scan for the new highest active register, since
4037                  it isn't necessarily one less than now: consider
4038                  (a(b)c(d(e)f)g).  When group 3 ends, after the f), the
4039                  new highest active register is 1.  */
4040               unsigned char r = *p - 1;
4041               while (r > 0 && !IS_ACTIVE (reg_info[r]))
4042                 r--;
4043               
4044               /* If we end up at register zero, that means that we saved
4045                  the registers as the result of an `on_failure_jump', not
4046                  a `start_memory', and we jumped to past the innermost
4047                  `stop_memory'.  For example, in ((.)*) we save
4048                  registers 1 and 2 as a result of the *, but when we pop
4049                  back to the second ), we are at the stop_memory 1.
4050                  Thus, nothing is active.  */
4051               if (r == 0)
4052                 {
4053                   lowest_active_reg = NO_LOWEST_ACTIVE_REG;
4054                   highest_active_reg = NO_HIGHEST_ACTIVE_REG;
4055                 }
4056               else
4057                 highest_active_reg = r;
4058             }
4059           
4060           /* If just failed to match something this time around with a
4061              group that's operated on by a repetition operator, try to
4062              force exit from the ``loop'', and restore the register
4063              information for this group that we had before trying this
4064              last match.  */
4065           if ((!MATCHED_SOMETHING (reg_info[*p])
4066                || just_past_start_mem == p - 1)
4067               && (p + 2) < pend)              
4068             {
4069               boolean is_a_jump_n = false;
4070               
4071               p1 = p + 2;
4072               mcnt = 0;
4073               switch ((re_opcode_t) *p1++)
4074                 {
4075                   case jump_n:
4076                     is_a_jump_n = true;
4077                   case pop_failure_jump:
4078                   case maybe_pop_jump:
4079                   case jump:
4080                   case dummy_failure_jump:
4081                     EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4082                     if (is_a_jump_n)
4083                       p1 += 2;
4084                     break;
4085                   
4086                   default:
4087                     /* do nothing */ ;
4088                 }
4089               p1 += mcnt;
4090         
4091               /* If the next operation is a jump backwards in the pattern
4092                  to an on_failure_jump right before the start_memory
4093                  corresponding to this stop_memory, exit from the loop
4094                  by forcing a failure after pushing on the stack the
4095                  on_failure_jump's jump in the pattern, and d.  */
4096               if (mcnt < 0 && (re_opcode_t) *p1 == on_failure_jump
4097                   && (re_opcode_t) p1[3] == start_memory && p1[4] == *p)
4098                 {
4099                   /* If this group ever matched anything, then restore
4100                      what its registers were before trying this last
4101                      failed match, e.g., with `(a*)*b' against `ab' for
4102                      regstart[1], and, e.g., with `((a*)*(b*)*)*'
4103                      against `aba' for regend[3].
4104                      
4105                      Also restore the registers for inner groups for,
4106                      e.g., `((a*)(b*))*' against `aba' (register 3 would
4107                      otherwise get trashed).  */
4108                      
4109                   if (EVER_MATCHED_SOMETHING (reg_info[*p]))
4110                     {
4111                       unsigned r; 
4112         
4113                       EVER_MATCHED_SOMETHING (reg_info[*p]) = 0;
4114                       
4115                       /* Restore this and inner groups' (if any) registers.  */
4116                       for (r = *p; r < *p + *(p + 1); r++)
4117                         {
4118                           regstart[r] = old_regstart[r];
4119
4120                           /* xx why this test?  */
4121                           if (old_regend[r] >= regstart[r])
4122                             regend[r] = old_regend[r];
4123                         }     
4124                     }
4125                   p1++;
4126                   EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4127                   PUSH_FAILURE_POINT (p1 + mcnt, d, -2);
4128
4129                   goto fail;
4130                 }
4131             }
4132           
4133           /* Move past the register number and the inner group count.  */
4134           p += 2;
4135           break;
4136
4137
4138         /* \<digit> has been turned into a `duplicate' command which is
4139            followed by the numeric value of <digit> as the register number.  */
4140         case duplicate:
4141           {
4142             register const char *d2, *dend2;
4143             int regno = *p++;   /* Get which register to match against.  */
4144             DEBUG_PRINT2 ("EXECUTING duplicate %d.\n", regno);
4145
4146             /* Can't back reference a group which we've never matched.  */
4147             if (REG_UNSET (regstart[regno]) || REG_UNSET (regend[regno]))
4148               goto fail;
4149               
4150             /* Where in input to try to start matching.  */
4151             d2 = regstart[regno];
4152             
4153             /* Where to stop matching; if both the place to start and
4154                the place to stop matching are in the same string, then
4155                set to the place to stop, otherwise, for now have to use
4156                the end of the first string.  */
4157
4158             dend2 = ((FIRST_STRING_P (regstart[regno]) 
4159                       == FIRST_STRING_P (regend[regno]))
4160                      ? regend[regno] : end_match_1);
4161             for (;;)
4162               {
4163                 /* If necessary, advance to next segment in register
4164                    contents.  */
4165                 while (d2 == dend2)
4166                   {
4167                     if (dend2 == end_match_2) break;
4168                     if (dend2 == regend[regno]) break;
4169
4170                     /* End of string1 => advance to string2. */
4171                     d2 = string2;
4172                     dend2 = regend[regno];
4173                   }
4174                 /* At end of register contents => success */
4175                 if (d2 == dend2) break;
4176
4177                 /* If necessary, advance to next segment in data.  */
4178                 PREFETCH ();
4179
4180                 /* How many characters left in this segment to match.  */
4181                 mcnt = dend - d;
4182                 
4183                 /* Want how many consecutive characters we can match in
4184                    one shot, so, if necessary, adjust the count.  */
4185                 if (mcnt > dend2 - d2)
4186                   mcnt = dend2 - d2;
4187                   
4188                 /* Compare that many; failure if mismatch, else move
4189                    past them.  */
4190                 if (translate 
4191                     ? bcmp_translate (d, d2, mcnt, translate) 
4192                     : bcmp (d, d2, mcnt))
4193                   goto fail;
4194                 d += mcnt, d2 += mcnt;
4195
4196                 /* Do this because we've match some characters.  */
4197                 SET_REGS_MATCHED ();
4198               }
4199           }
4200           break;
4201
4202
4203         /* begline matches the empty string at the beginning of the string
4204            (unless `not_bol' is set in `bufp'), and, if
4205            `newline_anchor' is set, after newlines.  */
4206         case begline:
4207           DEBUG_PRINT1 ("EXECUTING begline.\n");
4208           
4209           if (AT_STRINGS_BEG (d))
4210             {
4211               if (!bufp->not_bol) break;
4212             }
4213           else if (d[-1] == '\n' && bufp->newline_anchor)
4214             {
4215               break;
4216             }
4217           /* In all other cases, we fail.  */
4218           goto fail;
4219
4220
4221         /* endline is the dual of begline.  */
4222         case endline:
4223           DEBUG_PRINT1 ("EXECUTING endline.\n");
4224
4225           if (AT_STRINGS_END (d))
4226             {
4227               if (!bufp->not_eol) break;
4228             }
4229           
4230           /* We have to ``prefetch'' the next character.  */
4231           else if ((d == end1 ? *string2 : *d) == '\n'
4232                    && bufp->newline_anchor)
4233             {
4234               break;
4235             }
4236           goto fail;
4237
4238
4239         /* Match at the very beginning of the data.  */
4240         case begbuf:
4241           DEBUG_PRINT1 ("EXECUTING begbuf.\n");
4242           if (AT_STRINGS_BEG (d))
4243             break;
4244           goto fail;
4245
4246
4247         /* Match at the very end of the data.  */
4248         case endbuf:
4249           DEBUG_PRINT1 ("EXECUTING endbuf.\n");
4250           if (AT_STRINGS_END (d))
4251             break;
4252           goto fail;
4253
4254
4255         /* on_failure_keep_string_jump is used to optimize `.*\n'.  It
4256            pushes NULL as the value for the string on the stack.  Then
4257            `pop_failure_point' will keep the current value for the
4258            string, instead of restoring it.  To see why, consider
4259            matching `foo\nbar' against `.*\n'.  The .* matches the foo;
4260            then the . fails against the \n.  But the next thing we want
4261            to do is match the \n against the \n; if we restored the
4262            string value, we would be back at the foo.
4263            
4264            Because this is used only in specific cases, we don't need to
4265            check all the things that `on_failure_jump' does, to make
4266            sure the right things get saved on the stack.  Hence we don't
4267            share its code.  The only reason to push anything on the
4268            stack at all is that otherwise we would have to change
4269            `anychar's code to do something besides goto fail in this
4270            case; that seems worse than this.  */
4271         case on_failure_keep_string_jump:
4272           DEBUG_PRINT1 ("EXECUTING on_failure_keep_string_jump");
4273           
4274           EXTRACT_NUMBER_AND_INCR (mcnt, p);
4275           DEBUG_PRINT3 (" %d (to 0x%x):\n", mcnt, p + mcnt);
4276
4277           PUSH_FAILURE_POINT (p + mcnt, NULL, -2);
4278           break;
4279
4280
4281         /* Uses of on_failure_jump:
4282         
4283            Each alternative starts with an on_failure_jump that points
4284            to the beginning of the next alternative.  Each alternative
4285            except the last ends with a jump that in effect jumps past
4286            the rest of the alternatives.  (They really jump to the
4287            ending jump of the following alternative, because tensioning
4288            these jumps is a hassle.)
4289
4290            Repeats start with an on_failure_jump that points past both
4291            the repetition text and either the following jump or
4292            pop_failure_jump back to this on_failure_jump.  */
4293         case on_failure_jump:
4294         on_failure:
4295           DEBUG_PRINT1 ("EXECUTING on_failure_jump");
4296
4297           EXTRACT_NUMBER_AND_INCR (mcnt, p);
4298           DEBUG_PRINT3 (" %d (to 0x%x)", mcnt, p + mcnt);
4299
4300           /* If this on_failure_jump comes right before a group (i.e.,
4301              the original * applied to a group), save the information
4302              for that group and all inner ones, so that if we fail back
4303              to this point, the group's information will be correct.
4304              For example, in \(a*\)*\1, we need the preceding group,
4305              and in \(\(a*\)b*\)\2, we need the inner group.  */
4306
4307           /* We can't use `p' to check ahead because we push
4308              a failure point to `p + mcnt' after we do this.  */
4309           p1 = p;
4310
4311           /* We need to skip no_op's before we look for the
4312              start_memory in case this on_failure_jump is happening as
4313              the result of a completed succeed_n, as in \(a\)\{1,3\}b\1
4314              against aba.  */
4315           while (p1 < pend && (re_opcode_t) *p1 == no_op)
4316             p1++;
4317
4318           if (p1 < pend && (re_opcode_t) *p1 == start_memory)
4319             {
4320               /* We have a new highest active register now.  This will
4321                  get reset at the start_memory we are about to get to,
4322                  but we will have saved all the registers relevant to
4323                  this repetition op, as described above.  */
4324               highest_active_reg = *(p1 + 1) + *(p1 + 2);
4325               if (lowest_active_reg == NO_LOWEST_ACTIVE_REG)
4326                 lowest_active_reg = *(p1 + 1);
4327             }
4328
4329           DEBUG_PRINT1 (":\n");
4330           PUSH_FAILURE_POINT (p + mcnt, d, -2);
4331           break;
4332
4333
4334         /* A smart repeat ends with `maybe_pop_jump'.
4335            We change it to either `pop_failure_jump' or `jump'.  */
4336         case maybe_pop_jump:
4337           EXTRACT_NUMBER_AND_INCR (mcnt, p);
4338           DEBUG_PRINT2 ("EXECUTING maybe_pop_jump %d.\n", mcnt);
4339           {
4340             register unsigned char *p2 = p;
4341
4342             /* Compare the beginning of the repeat with what in the
4343                pattern follows its end. If we can establish that there
4344                is nothing that they would both match, i.e., that we
4345                would have to backtrack because of (as in, e.g., `a*a')
4346                then we can change to pop_failure_jump, because we'll
4347                never have to backtrack.
4348                
4349                This is not true in the case of alternatives: in
4350                `(a|ab)*' we do need to backtrack to the `ab' alternative
4351                (e.g., if the string was `ab').  But instead of trying to
4352                detect that here, the alternative has put on a dummy
4353                failure point which is what we will end up popping.  */
4354
4355             /* Skip over open/close-group commands.
4356                If what follows this loop is a ...+ construct,
4357                look at what begins its body, since we will have to
4358                match at least one of that.  */
4359             while (1)
4360               {
4361                 if (p2 + 2 < pend
4362                     && ((re_opcode_t) *p2 == stop_memory
4363                         || (re_opcode_t) *p2 == start_memory))
4364                   p2 += 3;
4365                 else if (p2 + 6 < pend
4366                          && (re_opcode_t) *p2 == dummy_failure_jump)
4367                   p2 += 6;
4368                 else
4369                   break;
4370               }
4371
4372             p1 = p + mcnt;
4373             /* p1[0] ... p1[2] are the `on_failure_jump' corresponding
4374                to the `maybe_finalize_jump' of this case.  Examine what 
4375                follows.  */
4376
4377             /* If we're at the end of the pattern, we can change.  */
4378             if (p2 == pend)
4379               {
4380                 /* Consider what happens when matching ":\(.*\)"
4381                    against ":/".  I don't really understand this code
4382                    yet.  */
4383                 p[-3] = (unsigned char) pop_failure_jump;
4384                 DEBUG_PRINT1
4385                   ("  End of pattern: change to `pop_failure_jump'.\n");
4386               }
4387
4388             else if ((re_opcode_t) *p2 == exactn
4389                      || (bufp->newline_anchor && (re_opcode_t) *p2 == endline))
4390               {
4391                 register unsigned char c
4392                   = *p2 == (unsigned char) endline ? '\n' : p2[2];
4393
4394                 if ((re_opcode_t) p1[3] == exactn && p1[5] != c)
4395                   {
4396                     p[-3] = (unsigned char) pop_failure_jump;
4397                     DEBUG_PRINT3 ("  %c != %c => pop_failure_jump.\n",
4398                                   c, p1[5]);
4399                   }
4400                   
4401                 else if ((re_opcode_t) p1[3] == charset
4402                          || (re_opcode_t) p1[3] == charset_not)
4403                   {
4404                     int not = (re_opcode_t) p1[3] == charset_not;
4405                     
4406                     if (c < (unsigned char) (p1[4] * BYTEWIDTH)
4407                         && p1[5 + c / BYTEWIDTH] & (1 << (c % BYTEWIDTH)))
4408                       not = !not;
4409
4410                     /* `not' is equal to 1 if c would match, which means
4411                         that we can't change to pop_failure_jump.  */
4412                     if (!not)
4413                       {
4414                         p[-3] = (unsigned char) pop_failure_jump;
4415                         DEBUG_PRINT1 ("  No match => pop_failure_jump.\n");
4416                       }
4417                   }
4418               }
4419             else if ((re_opcode_t) *p2 == charset)
4420               {
4421 #ifdef DEBUG
4422                 register unsigned char c
4423                   = *p2 == (unsigned char) endline ? '\n' : p2[2];
4424 #endif
4425
4426                 if ((re_opcode_t) p1[3] == exactn
4427                     && ! ((int) p2[1] * BYTEWIDTH > (int) p1[4]
4428                           && (p2[1 + p1[4] / BYTEWIDTH]
4429                               & (1 << (p1[4] % BYTEWIDTH)))))
4430                   {
4431                     p[-3] = (unsigned char) pop_failure_jump;
4432                     DEBUG_PRINT3 ("  %c != %c => pop_failure_jump.\n",
4433                                   c, p1[5]);
4434                   }
4435                   
4436                 else if ((re_opcode_t) p1[3] == charset_not)
4437                   {
4438                     int idx;
4439                     /* We win if the charset_not inside the loop
4440                        lists every character listed in the charset after.  */
4441                     for (idx = 0; idx < (int) p2[1]; idx++)
4442                       if (! (p2[2 + idx] == 0
4443                              || (idx < (int) p1[4]
4444                                  && ((p2[2 + idx] & ~ p1[5 + idx]) == 0))))
4445                         break;
4446
4447                     if (idx == p2[1])
4448                       {
4449                         p[-3] = (unsigned char) pop_failure_jump;
4450                         DEBUG_PRINT1 ("  No match => pop_failure_jump.\n");
4451                       }
4452                   }
4453                 else if ((re_opcode_t) p1[3] == charset)
4454                   {
4455                     int idx;
4456                     /* We win if the charset inside the loop
4457                        has no overlap with the one after the loop.  */
4458                     for (idx = 0;
4459                          idx < (int) p2[1] && idx < (int) p1[4];
4460                          idx++)
4461                       if ((p2[2 + idx] & p1[5 + idx]) != 0)
4462                         break;
4463
4464                     if (idx == p2[1] || idx == p1[4])
4465                       {
4466                         p[-3] = (unsigned char) pop_failure_jump;
4467                         DEBUG_PRINT1 ("  No match => pop_failure_jump.\n");
4468                       }
4469                   }
4470               }
4471           }
4472           p -= 2;               /* Point at relative address again.  */
4473           if ((re_opcode_t) p[-1] != pop_failure_jump)
4474             {
4475               p[-1] = (unsigned char) jump;
4476               DEBUG_PRINT1 ("  Match => jump.\n");
4477               goto unconditional_jump;
4478             }
4479         /* Note fall through.  */
4480
4481
4482         /* The end of a simple repeat has a pop_failure_jump back to
4483            its matching on_failure_jump, where the latter will push a
4484            failure point.  The pop_failure_jump takes off failure
4485            points put on by this pop_failure_jump's matching
4486            on_failure_jump; we got through the pattern to here from the
4487            matching on_failure_jump, so didn't fail.  */
4488         case pop_failure_jump:
4489           {
4490             /* We need to pass separate storage for the lowest and
4491                highest registers, even though we don't care about the
4492                actual values.  Otherwise, we will restore only one
4493                register from the stack, since lowest will == highest in
4494                `pop_failure_point'.  */
4495             unsigned dummy_low_reg, dummy_high_reg;
4496             unsigned char *pdummy;
4497             const char *sdummy;
4498
4499             DEBUG_PRINT1 ("EXECUTING pop_failure_jump.\n");
4500             POP_FAILURE_POINT (sdummy, pdummy,
4501                                dummy_low_reg, dummy_high_reg,
4502                                reg_dummy, reg_dummy, reg_info_dummy);
4503           }
4504           /* Note fall through.  */
4505
4506           
4507         /* Unconditionally jump (without popping any failure points).  */
4508         case jump:
4509         unconditional_jump:
4510           EXTRACT_NUMBER_AND_INCR (mcnt, p);    /* Get the amount to jump.  */
4511           DEBUG_PRINT2 ("EXECUTING jump %d ", mcnt);
4512           p += mcnt;                            /* Do the jump.  */
4513           DEBUG_PRINT2 ("(to 0x%x).\n", p);
4514           break;
4515
4516         
4517         /* We need this opcode so we can detect where alternatives end
4518            in `group_match_null_string_p' et al.  */
4519         case jump_past_alt:
4520           DEBUG_PRINT1 ("EXECUTING jump_past_alt.\n");
4521           goto unconditional_jump;
4522
4523
4524         /* Normally, the on_failure_jump pushes a failure point, which
4525            then gets popped at pop_failure_jump.  We will end up at
4526            pop_failure_jump, also, and with a pattern of, say, `a+', we
4527            are skipping over the on_failure_jump, so we have to push
4528            something meaningless for pop_failure_jump to pop.  */
4529         case dummy_failure_jump:
4530           DEBUG_PRINT1 ("EXECUTING dummy_failure_jump.\n");
4531           /* It doesn't matter what we push for the string here.  What
4532              the code at `fail' tests is the value for the pattern.  */
4533           PUSH_FAILURE_POINT (0, 0, -2);
4534           goto unconditional_jump;
4535
4536
4537         /* At the end of an alternative, we need to push a dummy failure
4538            point in case we are followed by a `pop_failure_jump', because
4539            we don't want the failure point for the alternative to be
4540            popped.  For example, matching `(a|ab)*' against `aab'
4541            requires that we match the `ab' alternative.  */
4542         case push_dummy_failure:
4543           DEBUG_PRINT1 ("EXECUTING push_dummy_failure.\n");
4544           /* See comments just above at `dummy_failure_jump' about the
4545              two zeroes.  */
4546           PUSH_FAILURE_POINT (0, 0, -2);
4547           break;
4548
4549         /* Have to succeed matching what follows at least n times.
4550            After that, handle like `on_failure_jump'.  */
4551         case succeed_n: 
4552           EXTRACT_NUMBER (mcnt, p + 2);
4553           DEBUG_PRINT2 ("EXECUTING succeed_n %d.\n", mcnt);
4554
4555           assert (mcnt >= 0);
4556           /* Originally, this is how many times we HAVE to succeed.  */
4557           if (mcnt > 0)
4558             {
4559                mcnt--;
4560                p += 2;
4561                STORE_NUMBER_AND_INCR (p, mcnt);
4562                DEBUG_PRINT3 ("  Setting 0x%x to %d.\n", p, mcnt);
4563             }
4564           else if (mcnt == 0)
4565             {
4566               DEBUG_PRINT2 ("  Setting two bytes from 0x%x to no_op.\n", p+2);
4567               p[2] = (unsigned char) no_op;
4568               p[3] = (unsigned char) no_op;
4569               goto on_failure;
4570             }
4571           break;
4572         
4573         case jump_n: 
4574           EXTRACT_NUMBER (mcnt, p + 2);
4575           DEBUG_PRINT2 ("EXECUTING jump_n %d.\n", mcnt);
4576
4577           /* Originally, this is how many times we CAN jump.  */
4578           if (mcnt)
4579             {
4580                mcnt--;
4581                STORE_NUMBER (p + 2, mcnt);
4582                goto unconditional_jump;      
4583             }
4584           /* If don't have to jump any more, skip over the rest of command.  */
4585           else      
4586             p += 4;                  
4587           break;
4588         
4589         case set_number_at:
4590           {
4591             DEBUG_PRINT1 ("EXECUTING set_number_at.\n");
4592
4593             EXTRACT_NUMBER_AND_INCR (mcnt, p);
4594             p1 = p + mcnt;
4595             EXTRACT_NUMBER_AND_INCR (mcnt, p);
4596             DEBUG_PRINT3 ("  Setting 0x%x to %d.\n", p1, mcnt);
4597             STORE_NUMBER (p1, mcnt);
4598             break;
4599           }
4600
4601         case wordbound:
4602           DEBUG_PRINT1 ("EXECUTING wordbound.\n");
4603           if (AT_WORD_BOUNDARY (d))
4604             break;
4605           goto fail;
4606
4607         case notwordbound:
4608           DEBUG_PRINT1 ("EXECUTING notwordbound.\n");
4609           if (AT_WORD_BOUNDARY (d))
4610             goto fail;
4611           break;
4612
4613         case wordbeg:
4614           DEBUG_PRINT1 ("EXECUTING wordbeg.\n");
4615           if (WORDCHAR_P (d) && (AT_STRINGS_BEG (d) || !WORDCHAR_P (d - 1)))
4616             break;
4617           goto fail;
4618
4619         case wordend:
4620           DEBUG_PRINT1 ("EXECUTING wordend.\n");
4621           if (!AT_STRINGS_BEG (d) && WORDCHAR_P (d - 1)
4622               && (!WORDCHAR_P (d) || AT_STRINGS_END (d)))
4623             break;
4624           goto fail;
4625
4626 #ifdef emacs
4627         case before_dot:
4628           DEBUG_PRINT1 ("EXECUTING before_dot.\n");
4629           if (PTR_CHAR_POS ((unsigned char *) d) >= point)
4630             goto fail;
4631           break;
4632   
4633         case at_dot:
4634           DEBUG_PRINT1 ("EXECUTING at_dot.\n");
4635           if (PTR_CHAR_POS ((unsigned char *) d) != point)
4636             goto fail;
4637           break;
4638   
4639         case after_dot:
4640           DEBUG_PRINT1 ("EXECUTING after_dot.\n");
4641           if (PTR_CHAR_POS ((unsigned char *) d) <= point)
4642             goto fail;
4643           break;
4644 #if 0 /* not emacs19 */
4645         case at_dot:
4646           DEBUG_PRINT1 ("EXECUTING at_dot.\n");
4647           if (PTR_CHAR_POS ((unsigned char *) d) + 1 != point)
4648             goto fail;
4649           break;
4650 #endif /* not emacs19 */
4651
4652         case syntaxspec:
4653           DEBUG_PRINT2 ("EXECUTING syntaxspec %d.\n", mcnt);
4654           mcnt = *p++;
4655           goto matchsyntax;
4656
4657         case wordchar:
4658           DEBUG_PRINT1 ("EXECUTING Emacs wordchar.\n");
4659           mcnt = (int) Sword;
4660         matchsyntax:
4661           PREFETCH ();
4662           /* Can't use *d++ here; SYNTAX may be an unsafe macro.  */
4663           d++;
4664           if (SYNTAX (d[-1]) != (enum syntaxcode) mcnt)
4665             goto fail;
4666           SET_REGS_MATCHED ();
4667           break;
4668
4669         case notsyntaxspec:
4670           DEBUG_PRINT2 ("EXECUTING notsyntaxspec %d.\n", mcnt);
4671           mcnt = *p++;
4672           goto matchnotsyntax;
4673
4674         case notwordchar:
4675           DEBUG_PRINT1 ("EXECUTING Emacs notwordchar.\n");
4676           mcnt = (int) Sword;
4677         matchnotsyntax:
4678           PREFETCH ();
4679           /* Can't use *d++ here; SYNTAX may be an unsafe macro.  */
4680           d++;
4681           if (SYNTAX (d[-1]) == (enum syntaxcode) mcnt)
4682             goto fail;
4683           SET_REGS_MATCHED ();
4684           break;
4685
4686 #else /* not emacs */
4687         case wordchar:
4688           DEBUG_PRINT1 ("EXECUTING non-Emacs wordchar.\n");
4689           PREFETCH ();
4690           if (!WORDCHAR_P (d))
4691             goto fail;
4692           SET_REGS_MATCHED ();
4693           d++;
4694           break;
4695           
4696         case notwordchar:
4697           DEBUG_PRINT1 ("EXECUTING non-Emacs notwordchar.\n");
4698           PREFETCH ();
4699           if (WORDCHAR_P (d))
4700             goto fail;
4701           SET_REGS_MATCHED ();
4702           d++;
4703           break;
4704 #endif /* not emacs */
4705           
4706         default:
4707           abort ();
4708         }
4709       continue;  /* Successfully executed one pattern command; keep going.  */
4710
4711
4712     /* We goto here if a matching operation fails. */
4713     fail:
4714       if (!FAIL_STACK_EMPTY ())
4715         { /* A restart point is known.  Restore to that state.  */
4716           DEBUG_PRINT1 ("\nFAIL:\n");
4717           POP_FAILURE_POINT (d, p,
4718                              lowest_active_reg, highest_active_reg,
4719                              regstart, regend, reg_info);
4720
4721           /* If this failure point is a dummy, try the next one.  */
4722           if (!p)
4723             goto fail;
4724
4725           /* If we failed to the end of the pattern, don't examine *p.  */
4726           assert (p <= pend);
4727           if (p < pend)
4728             {
4729               boolean is_a_jump_n = false;
4730               
4731               /* If failed to a backwards jump that's part of a repetition
4732                  loop, need to pop this failure point and use the next one.  */
4733               switch ((re_opcode_t) *p)
4734                 {
4735                 case jump_n:
4736                   is_a_jump_n = true;
4737                 case maybe_pop_jump:
4738                 case pop_failure_jump:
4739                 case jump:
4740                   p1 = p + 1;
4741                   EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4742                   p1 += mcnt;   
4743
4744                   if ((is_a_jump_n && (re_opcode_t) *p1 == succeed_n)
4745                       || (!is_a_jump_n
4746                           && (re_opcode_t) *p1 == on_failure_jump))
4747                     goto fail;
4748                   break;
4749                 default:
4750                   /* do nothing */ ;
4751                 }
4752             }
4753
4754           if (d >= string1 && d <= end1)
4755             dend = end_match_1;
4756         }
4757       else
4758         break;   /* Matching at this starting point really fails.  */
4759     } /* for (;;) */
4760
4761   if (best_regs_set)
4762     goto restore_best_regs;
4763
4764   FREE_VARIABLES ();
4765
4766   return -1;                            /* Failure to match.  */
4767 } /* re_match_2 */
4768 \f
4769 /* Subroutine definitions for re_match_2.  */
4770
4771
4772 /* We are passed P pointing to a register number after a start_memory.
4773    
4774    Return true if the pattern up to the corresponding stop_memory can
4775    match the empty string, and false otherwise.
4776    
4777    If we find the matching stop_memory, sets P to point to one past its number.
4778    Otherwise, sets P to an undefined byte less than or equal to END.
4779
4780    We don't handle duplicates properly (yet).  */
4781
4782 static boolean
4783 group_match_null_string_p (p, end, reg_info)
4784     unsigned char **p, *end;
4785     register_info_type *reg_info;
4786 {
4787   int mcnt;
4788   /* Point to after the args to the start_memory.  */
4789   unsigned char *p1 = *p + 2;
4790   
4791   while (p1 < end)
4792     {
4793       /* Skip over opcodes that can match nothing, and return true or
4794          false, as appropriate, when we get to one that can't, or to the
4795          matching stop_memory.  */
4796       
4797       switch ((re_opcode_t) *p1)
4798         {
4799         /* Could be either a loop or a series of alternatives.  */
4800         case on_failure_jump:
4801           p1++;
4802           EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4803           
4804           /* If the next operation is not a jump backwards in the
4805              pattern.  */
4806
4807           if (mcnt >= 0)
4808             {
4809               /* Go through the on_failure_jumps of the alternatives,
4810                  seeing if any of the alternatives cannot match nothing.
4811                  The last alternative starts with only a jump,
4812                  whereas the rest start with on_failure_jump and end
4813                  with a jump, e.g., here is the pattern for `a|b|c':
4814
4815                  /on_failure_jump/0/6/exactn/1/a/jump_past_alt/0/6
4816                  /on_failure_jump/0/6/exactn/1/b/jump_past_alt/0/3
4817                  /exactn/1/c                                            
4818
4819                  So, we have to first go through the first (n-1)
4820                  alternatives and then deal with the last one separately.  */
4821
4822
4823               /* Deal with the first (n-1) alternatives, which start
4824                  with an on_failure_jump (see above) that jumps to right
4825                  past a jump_past_alt.  */
4826
4827               while ((re_opcode_t) p1[mcnt-3] == jump_past_alt)
4828                 {
4829                   /* `mcnt' holds how many bytes long the alternative
4830                      is, including the ending `jump_past_alt' and
4831                      its number.  */
4832
4833                   if (!alt_match_null_string_p (p1, p1 + mcnt - 3, 
4834                                                       reg_info))
4835                     return false;
4836
4837                   /* Move to right after this alternative, including the
4838                      jump_past_alt.  */
4839                   p1 += mcnt;   
4840
4841                   /* Break if it's the beginning of an n-th alternative
4842                      that doesn't begin with an on_failure_jump.  */
4843                   if ((re_opcode_t) *p1 != on_failure_jump)
4844                     break;
4845                 
4846                   /* Still have to check that it's not an n-th
4847                      alternative that starts with an on_failure_jump.  */
4848                   p1++;
4849                   EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4850                   if ((re_opcode_t) p1[mcnt-3] != jump_past_alt)
4851                     {
4852                       /* Get to the beginning of the n-th alternative.  */
4853                       p1 -= 3;
4854                       break;
4855                     }
4856                 }
4857
4858               /* Deal with the last alternative: go back and get number
4859                  of the `jump_past_alt' just before it.  `mcnt' contains
4860                  the length of the alternative.  */
4861               EXTRACT_NUMBER (mcnt, p1 - 2);
4862
4863               if (!alt_match_null_string_p (p1, p1 + mcnt, reg_info))
4864                 return false;
4865
4866               p1 += mcnt;       /* Get past the n-th alternative.  */
4867             } /* if mcnt > 0 */
4868           break;
4869
4870           
4871         case stop_memory:
4872           assert (p1[1] == **p);
4873           *p = p1 + 2;
4874           return true;
4875
4876         
4877         default: 
4878           if (!common_op_match_null_string_p (&p1, end, reg_info))
4879             return false;
4880         }
4881     } /* while p1 < end */
4882
4883   return false;
4884 } /* group_match_null_string_p */
4885
4886
4887 /* Similar to group_match_null_string_p, but doesn't deal with alternatives:
4888    It expects P to be the first byte of a single alternative and END one
4889    byte past the last. The alternative can contain groups.  */
4890    
4891 static boolean
4892 alt_match_null_string_p (p, end, reg_info)
4893     unsigned char *p, *end;
4894     register_info_type *reg_info;
4895 {
4896   int mcnt;
4897   unsigned char *p1 = p;
4898   
4899   while (p1 < end)
4900     {
4901       /* Skip over opcodes that can match nothing, and break when we get 
4902          to one that can't.  */
4903       
4904       switch ((re_opcode_t) *p1)
4905         {
4906         /* It's a loop.  */
4907         case on_failure_jump:
4908           p1++;
4909           EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4910           p1 += mcnt;
4911           break;
4912           
4913         default: 
4914           if (!common_op_match_null_string_p (&p1, end, reg_info))
4915             return false;
4916         }
4917     }  /* while p1 < end */
4918
4919   return true;
4920 } /* alt_match_null_string_p */
4921
4922
4923 /* Deals with the ops common to group_match_null_string_p and
4924    alt_match_null_string_p.  
4925    
4926    Sets P to one after the op and its arguments, if any.  */
4927
4928 static boolean
4929 common_op_match_null_string_p (p, end, reg_info)
4930     unsigned char **p, *end;
4931     register_info_type *reg_info;
4932 {
4933   int mcnt;
4934   boolean ret;
4935   int reg_no;
4936   unsigned char *p1 = *p;
4937
4938   switch ((re_opcode_t) *p1++)
4939     {
4940     case no_op:
4941     case begline:
4942     case endline:
4943     case begbuf:
4944     case endbuf:
4945     case wordbeg:
4946     case wordend:
4947     case wordbound:
4948     case notwordbound:
4949 #ifdef emacs
4950     case before_dot:
4951     case at_dot:
4952     case after_dot:
4953 #endif
4954       break;
4955
4956     case start_memory:
4957       reg_no = *p1;
4958       assert (reg_no > 0 && reg_no <= MAX_REGNUM);
4959       ret = group_match_null_string_p (&p1, end, reg_info);
4960       
4961       /* Have to set this here in case we're checking a group which
4962          contains a group and a back reference to it.  */
4963
4964       if (REG_MATCH_NULL_STRING_P (reg_info[reg_no]) == MATCH_NULL_UNSET_VALUE)
4965         REG_MATCH_NULL_STRING_P (reg_info[reg_no]) = ret;
4966
4967       if (!ret)
4968         return false;
4969       break;
4970           
4971     /* If this is an optimized succeed_n for zero times, make the jump.  */
4972     case jump:
4973       EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4974       if (mcnt >= 0)
4975         p1 += mcnt;
4976       else
4977         return false;
4978       break;
4979
4980     case succeed_n:
4981       /* Get to the number of times to succeed.  */
4982       p1 += 2;          
4983       EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4984
4985       if (mcnt == 0)
4986         {
4987           p1 -= 4;
4988           EXTRACT_NUMBER_AND_INCR (mcnt, p1);
4989           p1 += mcnt;
4990         }
4991       else
4992         return false;
4993       break;
4994
4995     case duplicate: 
4996       if (!REG_MATCH_NULL_STRING_P (reg_info[*p1]))
4997         return false;
4998       break;
4999
5000     case set_number_at:
5001       p1 += 4;
5002
5003     default:
5004       /* All other opcodes mean we cannot match the empty string.  */
5005       return false;
5006   }
5007
5008   *p = p1;
5009   return true;
5010 } /* common_op_match_null_string_p */
5011
5012
5013 /* Return zero if TRANSLATE[S1] and TRANSLATE[S2] are identical for LEN
5014    bytes; nonzero otherwise.  */
5015    
5016 static int
5017 bcmp_translate (s1, s2, len, translate)
5018      unsigned char *s1, *s2;
5019      register int len;
5020      char *translate;
5021 {
5022   register unsigned char *p1 = s1, *p2 = s2;
5023   while (len)
5024     {
5025       if (translate[*p1++] != translate[*p2++]) return 1;
5026       len--;
5027     }
5028   return 0;
5029 }
5030 \f
5031 /* Entry points for GNU code.  */
5032
5033 /* re_compile_pattern is the GNU regular expression compiler: it
5034    compiles PATTERN (of length SIZE) and puts the result in BUFP.
5035    Returns 0 if the pattern was valid, otherwise an error string.
5036    
5037    Assumes the `allocated' (and perhaps `buffer') and `translate' fields
5038    are set in BUFP on entry.
5039    
5040    We call regex_compile to do the actual compilation.  */
5041
5042 const char *
5043 re_compile_pattern (pattern, length, bufp)
5044      const char *pattern;
5045      int length;
5046      struct re_pattern_buffer *bufp;
5047 {
5048   reg_errcode_t ret;
5049   
5050   /* GNU code is written to assume at least RE_NREGS registers will be set
5051      (and at least one extra will be -1).  */
5052   bufp->regs_allocated = REGS_UNALLOCATED;
5053   
5054   /* And GNU code determines whether or not to get register information
5055      by passing null for the REGS argument to re_match, etc., not by
5056      setting no_sub.  */
5057   bufp->no_sub = 0;
5058   
5059   /* Match anchors at newline.  */
5060   bufp->newline_anchor = 1;
5061   
5062   ret = regex_compile (pattern, length, re_syntax_options, bufp);
5063
5064   if (!ret)
5065     return NULL;
5066   return gettext (re_error_msgid[(int) ret]);
5067 }     
5068 \f
5069 /* Entry points compatible with 4.2 BSD regex library.  We don't define
5070    them unless specifically requested.  */
5071
5072 #ifdef _REGEX_RE_COMP
5073
5074 /* BSD has one and only one pattern buffer.  */
5075 static struct re_pattern_buffer re_comp_buf;
5076
5077 char *
5078 re_comp (s)
5079     const char *s;
5080 {
5081   reg_errcode_t ret;
5082   
5083   if (!s)
5084     {
5085       if (!re_comp_buf.buffer)
5086         return gettext ("No previous regular expression");
5087       return 0;
5088     }
5089
5090   if (!re_comp_buf.buffer)
5091     {
5092       re_comp_buf.buffer = (unsigned char *) malloc (200);
5093       if (re_comp_buf.buffer == NULL)
5094         return gettext (re_error_msgid[(int) REG_ESPACE]);
5095       re_comp_buf.allocated = 200;
5096
5097       re_comp_buf.fastmap = (char *) malloc (1 << BYTEWIDTH);
5098       if (re_comp_buf.fastmap == NULL)
5099         return gettext (re_error_msgid[(int) REG_ESPACE]);
5100     }
5101
5102   /* Since `re_exec' always passes NULL for the `regs' argument, we
5103      don't need to initialize the pattern buffer fields which affect it.  */
5104
5105   /* Match anchors at newlines.  */
5106   re_comp_buf.newline_anchor = 1;
5107
5108   ret = regex_compile (s, strlen (s), re_syntax_options, &re_comp_buf);
5109   
5110   if (!ret)
5111     return NULL;
5112
5113   /* Yes, we're discarding `const' here if !HAVE_LIBINTL.  */
5114   return (char *) gettext (re_error_msgid[(int) ret]);
5115 }
5116
5117
5118 int
5119 re_exec (s)
5120     const char *s;
5121 {
5122   const int len = strlen (s);
5123   return
5124     0 <= re_search (&re_comp_buf, s, len, 0, len, (struct re_registers *) 0);
5125 }
5126 #endif /* _REGEX_RE_COMP */
5127 \f
5128 /* POSIX.2 functions.  Don't define these for Emacs.  */
5129
5130 #ifndef emacs
5131
5132 /* regcomp takes a regular expression as a string and compiles it.
5133
5134    PREG is a regex_t *.  We do not expect any fields to be initialized,
5135    since POSIX says we shouldn't.  Thus, we set
5136
5137      `buffer' to the compiled pattern;
5138      `used' to the length of the compiled pattern;
5139      `syntax' to RE_SYNTAX_POSIX_EXTENDED if the
5140        REG_EXTENDED bit in CFLAGS is set; otherwise, to
5141        RE_SYNTAX_POSIX_BASIC;
5142      `newline_anchor' to REG_NEWLINE being set in CFLAGS;
5143      `fastmap' and `fastmap_accurate' to zero;
5144      `re_nsub' to the number of subexpressions in PATTERN.
5145
5146    PATTERN is the address of the pattern string.
5147
5148    CFLAGS is a series of bits which affect compilation.
5149
5150      If REG_EXTENDED is set, we use POSIX extended syntax; otherwise, we
5151      use POSIX basic syntax.
5152
5153      If REG_NEWLINE is set, then . and [^...] don't match newline.
5154      Also, regexec will try a match beginning after every newline.
5155
5156      If REG_ICASE is set, then we considers upper- and lowercase
5157      versions of letters to be equivalent when matching.
5158
5159      If REG_NOSUB is set, then when PREG is passed to regexec, that
5160      routine will report only success or failure, and nothing about the
5161      registers.
5162
5163    It returns 0 if it succeeds, nonzero if it doesn't.  (See regex.h for
5164    the return codes and their meanings.)  */
5165
5166 int
5167 regcomp (preg, pattern, cflags)
5168     regex_t *preg;
5169     const char *pattern; 
5170     int cflags;
5171 {
5172   reg_errcode_t ret;
5173   unsigned syntax
5174     = (cflags & REG_EXTENDED) ?
5175       RE_SYNTAX_POSIX_EXTENDED : RE_SYNTAX_POSIX_BASIC;
5176
5177   /* regex_compile will allocate the space for the compiled pattern.  */
5178   preg->buffer = 0;
5179   preg->allocated = 0;
5180   preg->used = 0;
5181   
5182   /* Don't bother to use a fastmap when searching.  This simplifies the
5183      REG_NEWLINE case: if we used a fastmap, we'd have to put all the
5184      characters after newlines into the fastmap.  This way, we just try
5185      every character.  */
5186   preg->fastmap = 0;
5187   
5188   if (cflags & REG_ICASE)
5189     {
5190       unsigned i;
5191       
5192       preg->translate = (char *) malloc (CHAR_SET_SIZE);
5193       if (preg->translate == NULL)
5194         return (int) REG_ESPACE;
5195
5196       /* Map uppercase characters to corresponding lowercase ones.  */
5197       for (i = 0; i < CHAR_SET_SIZE; i++)
5198         preg->translate[i] = ISUPPER (i) ? tolower (i) : i;
5199     }
5200   else
5201     preg->translate = NULL;
5202
5203   /* If REG_NEWLINE is set, newlines are treated differently.  */
5204   if (cflags & REG_NEWLINE)
5205     { /* REG_NEWLINE implies neither . nor [^...] match newline.  */
5206       syntax &= ~RE_DOT_NEWLINE;
5207       syntax |= RE_HAT_LISTS_NOT_NEWLINE;
5208       /* It also changes the matching behavior.  */
5209       preg->newline_anchor = 1;
5210     }
5211   else
5212     preg->newline_anchor = 0;
5213
5214   preg->no_sub = !!(cflags & REG_NOSUB);
5215
5216   /* POSIX says a null character in the pattern terminates it, so we 
5217      can use strlen here in compiling the pattern.  */
5218   ret = regex_compile (pattern, strlen (pattern), syntax, preg);
5219   
5220   /* POSIX doesn't distinguish between an unmatched open-group and an
5221      unmatched close-group: both are REG_EPAREN.  */
5222   if (ret == REG_ERPAREN) ret = REG_EPAREN;
5223   
5224   return (int) ret;
5225 }
5226
5227
5228 /* regexec searches for a given pattern, specified by PREG, in the
5229    string STRING.
5230    
5231    If NMATCH is zero or REG_NOSUB was set in the cflags argument to
5232    `regcomp', we ignore PMATCH.  Otherwise, we assume PMATCH has at
5233    least NMATCH elements, and we set them to the offsets of the
5234    corresponding matched substrings.
5235    
5236    EFLAGS specifies `execution flags' which affect matching: if
5237    REG_NOTBOL is set, then ^ does not match at the beginning of the
5238    string; if REG_NOTEOL is set, then $ does not match at the end.
5239    
5240    We return 0 if we find a match and REG_NOMATCH if not.  */
5241
5242 int
5243 regexec (preg, string, nmatch, pmatch, eflags)
5244     const regex_t *preg;
5245     const char *string; 
5246     size_t nmatch; 
5247     regmatch_t pmatch[]; 
5248     int eflags;
5249 {
5250   int ret;
5251   struct re_registers regs;
5252   regex_t private_preg;
5253   int len = strlen (string);
5254   boolean want_reg_info = !preg->no_sub && nmatch > 0;
5255
5256   private_preg = *preg;
5257   
5258   private_preg.not_bol = !!(eflags & REG_NOTBOL);
5259   private_preg.not_eol = !!(eflags & REG_NOTEOL);
5260   
5261   /* The user has told us exactly how many registers to return
5262      information about, via `nmatch'.  We have to pass that on to the
5263      matching routines.  */
5264   private_preg.regs_allocated = REGS_FIXED;
5265   
5266   if (want_reg_info)
5267     {
5268       regs.num_regs = nmatch;
5269       regs.start = TALLOC (nmatch, regoff_t);
5270       regs.end = TALLOC (nmatch, regoff_t);
5271       if (regs.start == NULL || regs.end == NULL)
5272         return (int) REG_NOMATCH;
5273     }
5274
5275   /* Perform the searching operation.  */
5276   ret = re_search (&private_preg, string, len,
5277                    /* start: */ 0, /* range: */ len,
5278                    want_reg_info ? &regs : (struct re_registers *) 0);
5279   
5280   /* Copy the register information to the POSIX structure.  */
5281   if (want_reg_info)
5282     {
5283       if (ret >= 0)
5284         {
5285           unsigned r;
5286
5287           for (r = 0; r < nmatch; r++)
5288             {
5289               pmatch[r].rm_so = regs.start[r];
5290               pmatch[r].rm_eo = regs.end[r];
5291             }
5292         }
5293
5294       /* If we needed the temporary register info, free the space now.  */
5295       free (regs.start);
5296       free (regs.end);
5297     }
5298
5299   /* We want zero return to mean success, unlike `re_search'.  */
5300   return ret >= 0 ? (int) REG_NOERROR : (int) REG_NOMATCH;
5301 }
5302
5303
5304 /* Returns a message corresponding to an error code, ERRCODE, returned
5305    from either regcomp or regexec.   We don't use PREG here.  */
5306
5307 size_t
5308 regerror (errcode, preg, errbuf, errbuf_size)
5309     int errcode;
5310     const regex_t *preg;
5311     char *errbuf;
5312     size_t errbuf_size;
5313 {
5314   const char *msg;
5315   size_t msg_size;
5316
5317   if (errcode < 0
5318       || errcode >= (sizeof (re_error_msgid) / sizeof (re_error_msgid[0])))
5319     /* Only error codes returned by the rest of the code should be passed 
5320        to this routine.  If we are given anything else, or if other regex
5321        code generates an invalid error code, then the program has a bug.
5322        Dump core so we can fix it.  */
5323     abort ();
5324
5325   msg = gettext (re_error_msgid[errcode]);
5326
5327   msg_size = strlen (msg) + 1; /* Includes the null.  */
5328   
5329   if (errbuf_size != 0)
5330     {
5331       if (msg_size > errbuf_size)
5332         {
5333           strncpy (errbuf, msg, errbuf_size - 1);
5334           errbuf[errbuf_size - 1] = 0;
5335         }
5336       else
5337         strcpy (errbuf, msg);
5338     }
5339
5340   return msg_size;
5341 }
5342
5343
5344 /* Free dynamically allocated space used by PREG.  */
5345
5346 void
5347 regfree (preg)
5348     regex_t *preg;
5349 {
5350   if (preg->buffer != NULL)
5351     free (preg->buffer);
5352   preg->buffer = NULL;
5353   
5354   preg->allocated = 0;
5355   preg->used = 0;
5356
5357   if (preg->fastmap != NULL)
5358     free (preg->fastmap);
5359   preg->fastmap = NULL;
5360   preg->fastmap_accurate = 0;
5361
5362   if (preg->translate != NULL)
5363     free (preg->translate);
5364   preg->translate = NULL;
5365 }
5366
5367 #endif /* not emacs  */
5368 \f
5369 /*
5370 Local variables:
5371 make-backup-files: t
5372 version-control: t
5373 trim-versions-without-asking: nil
5374 End:
5375 */