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