2006-09-01 Nikolas Zimmermann <zimmermann@kde.org>
[WebKit-https.git] / JavaScriptCore / pcre / pcre_internal.h
1 /*************************************************
2 *      Perl-Compatible Regular Expressions       *
3 *************************************************/
4
5
6 /* PCRE is a library of functions to support regular expressions whose syntax
7 and semantics are as close as possible to those of the Perl 5 language.
8
9                        Written by Philip Hazel
10            Copyright (c) 1997-2005 University of Cambridge
11            Copyright (c) 2004, 2005 Apple Computer, Inc.
12
13 -----------------------------------------------------------------------------
14 Redistribution and use in source and binary forms, with or without
15 modification, are permitted provided that the following conditions are met:
16
17     * Redistributions of source code must retain the above copyright notice,
18       this list of conditions and the following disclaimer.
19
20     * Redistributions in binary form must reproduce the above copyright
21       notice, this list of conditions and the following disclaimer in the
22       documentation and/or other materials provided with the distribution.
23
24     * Neither the name of the University of Cambridge nor the names of its
25       contributors may be used to endorse or promote products derived from
26       this software without specific prior written permission.
27
28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
31 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
32 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 POSSIBILITY OF SUCH DAMAGE.
39 -----------------------------------------------------------------------------
40 */
41
42 #include "Assertions.h"
43
44 /* Added to prevent 64-to-32 shortening warnings when compiling for 64-bit
45   <rdar://problem/4712064> PCRE generates many warnings with -Wshorten-64-to-32 */
46 #if defined(__GNUC__) && defined(__LP64__)
47 #define INT_CAST(i) (int)(i); ASSERT((i) <= INT_MAX)
48 #else
49 #define INT_CAST(i) (i)
50 #endif
51
52 /* This header contains definitions that are shared between the different
53 modules, but which are not relevant to the exported API. This includes some
54 functions whose names all begin with "_pcre_". */
55
56 #define _pcre_OP_lengths kjs_pcre_OP_lengths
57 #define _pcre_default_tables kjs_pcre_default_tables
58 #define _pcre_ord2utf8 kjs_pcre_ord2utf8
59 #define _pcre_printint kjs_pcre_printint
60 #define _pcre_try_flipped kjs_pcre_try_flipped
61 #define _pcre_ucp_findchar kjs_pcre_ucp_findchar
62 #define _pcre_utf8_table1 kjs_pcre_utf8_table1
63 #define _pcre_utf8_table1_size  kjs_pcre_utf8_table1_size
64 #define _pcre_utf8_table2 kjs_pcre_utf8_table2
65 #define _pcre_utf8_table3 kjs_pcre_utf8_table3
66 #define _pcre_utf8_table4 kjs_pcre_utf8_table4
67 #define _pcre_utt kjs_pcre_utt
68 #define _pcre_utt_size kjs_pcre_utt_size
69 #define _pcre_valid_utf8 kjs_pcre_valid_utf8
70 #define _pcre_xclass kjs_pcre_xclass
71
72 /* Define DEBUG to get debugging output on stdout. */
73
74 /****
75 #define DEBUG
76 ****/
77
78 /* Use a macro for debugging printing, 'cause that eliminates the use of #ifdef
79 inline, and there are *still* stupid compilers about that don't like indented
80 pre-processor statements, or at least there were when I first wrote this. After
81 all, it had only been about 10 years then... */
82
83 #ifdef DEBUG
84 #define DPRINTF(p) printf p
85 #else
86 #define DPRINTF(p) /*nothing*/
87 #endif
88
89
90 /* Get the definitions provided by running "configure" */
91
92 #include "pcre-config.h"
93
94 /* Standard C headers plus the external interface definition. The only time
95 setjmp and stdarg are used is when NO_RECURSE is set. */
96
97 #include <ctype.h>
98 #include <limits.h>
99 #include <setjmp.h>
100 #include <stdarg.h>
101 #include <stddef.h>
102 #include <stdio.h>
103 #include <stdlib.h>
104 #include <string.h>
105
106 #ifndef PCRE_SPY
107 #define PCRE_DEFINITION       /* Win32 __declspec(export) trigger for .dll */
108 #endif
109
110 /* We need to have types that specify unsigned 16-bit and 32-bit integers. We
111 cannot determine these outside the compilation (e.g. by running a program as
112 part of "configure") because PCRE is often cross-compiled for use on other
113 systems. Instead we make use of the maximum sizes that are available at
114 preprocessor time in standard C environments. */
115
116 #if USHRT_MAX == 65535
117   typedef unsigned short pcre_uint16;
118 #elif UINT_MAX == 65535
119   typedef unsigned int pcre_uint16;
120 #else
121   #error Cannot determine a type for 16-bit unsigned integers
122 #endif
123
124 #if UINT_MAX == 4294967295
125   typedef unsigned int pcre_uint32;
126 #elif ULONG_MAX == 4294967295
127   typedef unsigned long int pcre_uint32;
128 #else
129   #error Cannot determine a type for 32-bit unsigned integers
130 #endif
131
132 /* Include the public PCRE header */
133
134 #include "pcre.h"
135
136 /* All character handling must be done as unsigned characters. Otherwise there
137 are problems with top-bit-set characters and functions such as isspace().
138 However, we leave the interface to the outside world as char *, because that
139 should make things easier for callers. We define a short type for unsigned char
140 to save lots of typing. I tried "uchar", but it causes problems on Digital
141 Unix, where it is defined in sys/types, so use "uschar" instead. */
142
143 typedef unsigned char uschar;
144
145 /* Use pcre_uchar for always-unsigned version of pcre_char. */
146 #if PCRE_UTF16
147 typedef pcre_char pcre_uchar;
148 #else
149 typedef unsigned char pcre_uchar;
150 #endif
151
152 /* Include the (copy of) the public ucp header, changing the external name into
153 a private one. This does no harm, even if we aren't compiling UCP support. */
154
155 #define ucp_findchar _pcre_ucp_findchar
156 #include "ucp.h"
157
158 /* When compiling for use with the Virtual Pascal compiler, these functions
159 need to have their names changed. PCRE must be compiled with the -DVPCOMPAT
160 option on the command line. */
161
162 #ifdef VPCOMPAT
163 #define strncmp(s1,s2,m) _strncmp(s1,s2,m)
164 #define memcpy(d,s,n)    _memcpy(d,s,n)
165 #define memmove(d,s,n)   _memmove(d,s,n)
166 #define memset(s,c,n)    _memset(s,c,n)
167 #else  /* VPCOMPAT */
168
169 /* To cope with SunOS4 and other systems that lack memmove() but have bcopy(),
170 define a macro for memmove() if HAVE_MEMMOVE is false, provided that HAVE_BCOPY
171 is set. Otherwise, include an emulating function for those systems that have
172 neither (there some non-Unix environments where this is the case). This assumes
173 that all calls to memmove are moving strings upwards in store, which is the
174 case in PCRE. */
175
176 #if ! HAVE_MEMMOVE
177 #undef  memmove        /* some systems may have a macro */
178 #if HAVE_BCOPY
179 #define memmove(a, b, c) bcopy(b, a, c)
180 #else  /* HAVE_BCOPY */
181 void *
182 pcre_memmove(unsigned char *dest, const unsigned char *src, size_t n)
183 {
184 int i;
185 dest += n;
186 src += n;
187 for (i = 0; i < n; ++i) *(--dest) =  *(--src);
188 }
189 #define memmove(a, b, c) pcre_memmove(a, b, c)
190 #endif   /* not HAVE_BCOPY */
191 #endif   /* not HAVE_MEMMOVE */
192 #endif   /* not VPCOMPAT */
193
194
195 /* PCRE keeps offsets in its compiled code as 2-byte quantities (always stored
196 in big-endian order) by default. These are used, for example, to link from the
197 start of a subpattern to its alternatives and its end. The use of 2 bytes per
198 offset limits the size of the compiled regex to around 64K, which is big enough
199 for almost everybody. However, I received a request for an even bigger limit.
200 For this reason, and also to make the code easier to maintain, the storing and
201 loading of offsets from the byte string is now handled by the macros that are
202 defined here.
203
204 The macros are controlled by the value of LINK_SIZE. This defaults to 2 in
205 the config.h file, but can be overridden by using -D on the command line. This
206 is automated on Unix systems via the "configure" command. */
207
208 #if LINK_SIZE == 2
209
210 #define PUT(a,n,d)   \
211   (a[n] = (d) >> 8), \
212   (a[(n)+1] = (d) & 255)
213
214 #define GET(a,n) \
215   (((a)[n] << 8) | (a)[(n)+1])
216
217 #define MAX_PATTERN_SIZE (1 << 16)
218
219
220 #elif LINK_SIZE == 3
221
222 #define PUT(a,n,d)       \
223   (a[n] = (d) >> 16),    \
224   (a[(n)+1] = (d) >> 8), \
225   (a[(n)+2] = (d) & 255)
226
227 #define GET(a,n) \
228   (((a)[n] << 16) | ((a)[(n)+1] << 8) | (a)[(n)+2])
229
230 #define MAX_PATTERN_SIZE (1 << 24)
231
232
233 #elif LINK_SIZE == 4
234
235 #define PUT(a,n,d)        \
236   (a[n] = (d) >> 24),     \
237   (a[(n)+1] = (d) >> 16), \
238   (a[(n)+2] = (d) >> 8),  \
239   (a[(n)+3] = (d) & 255)
240
241 #define GET(a,n) \
242   (((a)[n] << 24) | ((a)[(n)+1] << 16) | ((a)[(n)+2] << 8) | (a)[(n)+3])
243
244 #define MAX_PATTERN_SIZE (1 << 30)   /* Keep it positive */
245
246
247 #else
248 #error LINK_SIZE must be either 2, 3, or 4
249 #endif
250
251
252 /* Convenience macro defined in terms of the others */
253
254 #define PUTINC(a,n,d)   PUT(a,n,d), a += LINK_SIZE
255
256
257 /* PCRE uses some other 2-byte quantities that do not change when the size of
258 offsets changes. There are used for repeat counts and for other things such as
259 capturing parenthesis numbers in back references. */
260
261 #define PUT2(a,n,d)   \
262   a[n] = (d) >> 8; \
263   a[(n)+1] = (d) & 255
264
265 #define GET2(a,n) \
266   (((a)[n] << 8) | (a)[(n)+1])
267
268 #define PUT2INC(a,n,d)  PUT2(a,n,d), a += 2
269
270
271 /* When UTF-8 encoding is being used, a character is no longer just a single
272 byte. The macros for character handling generate simple sequences when used in
273 byte-mode, and more complicated ones for UTF-8 characters. */
274
275 #ifndef SUPPORT_UTF8
276 #define GETCHAR(c, eptr) c = *eptr;
277 #define GETCHARTEST(c, eptr) c = *eptr;
278 #define GETCHARINC(c, eptr) c = *eptr++;
279 #define GETCHARINCTEST(c, eptr) c = *eptr++;
280 #define GETCHARLEN(c, eptr, len) c = *eptr;
281 #define BACKCHAR(eptr)
282
283 #else   /* SUPPORT_UTF8 */
284
285 /* Get the next UTF-8 character, not advancing the pointer, incrementing length
286 if there are extra bytes. This is called when we know we are in UTF-8 mode. */
287
288 #define GETUTF8CHARLEN(c, eptr, len) \
289   c = *eptr; \
290   if ((c & 0xc0) == 0xc0) \
291     { \
292     int gcii; \
293     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
294     int gcss = 6*gcaa; \
295     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
296     for (gcii = 1; gcii <= gcaa; gcii++) \
297       { \
298       gcss -= 6; \
299       c |= (eptr[gcii] & 0x3f) << gcss; \
300       } \
301     len += gcaa; \
302     }
303
304 /* Get the next UTF-8 character, advancing the pointer. This is called when we
305 know we are in UTF-8 mode. */
306
307 #define GETUTF8CHARINC(c, eptr) \
308 c = *eptr++; \
309 if ((c & 0xc0) == 0xc0) \
310 { \
311   int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
312     int gcss = 6*gcaa; \
313       c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
314         while (gcaa-- > 0) \
315         { \
316           gcss -= 6; \
317             c |= (*eptr++ & 0x3f) << gcss; \
318         } \
319 }
320
321 #if PCRE_UTF16
322
323 #define LEAD_OFFSET (0xd800 - (0x10000 >> 10))
324 #define SURROGATE_OFFSET (0x10000 - (0xd800 << 10) - 0xdc00)
325
326 #define IS_LEADING_SURROGATE(c) (((c) & ~0x3ff) == 0xd800)
327 #define IS_TRAILING_SURROGATE(c) (((c) & ~0x3ff) == 0xdc00)
328
329 #define DECODE_SURROGATE_PAIR(l, t) (((l) << 10) + (t) + SURROGATE_OFFSET)
330 #define LEADING_SURROGATE(c) (LEAD_OFFSET + ((c) >> 10))
331 #define TRAILING_SURROGATE(c) (0xdc00 + ((c) & 0x3FF))
332
333 #define GETCHAR(c, eptr) \
334   c = eptr[0]; \
335   if (IS_LEADING_SURROGATE(c)) \
336     c = DECODE_SURROGATE_PAIR(c, eptr[1])
337
338 #define GETCHARTEST(c, eptr) GETCHAR(c, eptr)
339
340 #define GETCHARINC(c, eptr) \
341   c = *eptr++; \
342   if (IS_LEADING_SURROGATE(c)) \
343     c = DECODE_SURROGATE_PAIR(c, *eptr++)
344
345 #define GETCHARINCTEST(c, eptr) GETCHARINC(c, eptr)
346
347 #define GETCHARLEN(c, eptr, len) \
348   c = eptr[0]; \
349   if (IS_LEADING_SURROGATE(c)) \
350     { \
351     c = DECODE_SURROGATE_PAIR(c, eptr[1]); \
352     ++len; \
353     }
354
355 #define ISMIDCHAR(c) IS_TRAILING_SURROGATE(c)
356
357 #else
358
359 /* Get the next UTF-8 character, not advancing the pointer. This is called when
360 we know we are in UTF-8 mode. */
361
362 #define GETCHAR(c, eptr) \
363   c = *eptr; \
364   if ((c & 0xc0) == 0xc0) \
365     { \
366     int gcii; \
367     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
368     int gcss = 6*gcaa; \
369     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
370     for (gcii = 1; gcii <= gcaa; gcii++) \
371       { \
372       gcss -= 6; \
373       c |= (eptr[gcii] & 0x3f) << gcss; \
374       } \
375     }
376
377 /* Get the next UTF-8 character, testing for UTF-8 mode, and not advancing the
378 pointer. */
379
380 #define GETCHARTEST(c, eptr) \
381   c = *eptr; \
382   if (utf8 && (c & 0xc0) == 0xc0) \
383     { \
384     int gcii; \
385     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
386     int gcss = 6*gcaa; \
387     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
388     for (gcii = 1; gcii <= gcaa; gcii++) \
389       { \
390       gcss -= 6; \
391       c |= (eptr[gcii] & 0x3f) << gcss; \
392       } \
393     }
394
395 /* Get the next UTF-8 character, advancing the pointer. This is called when we
396 know we are in UTF-8 mode. */
397
398 #define GETCHARINC GETUTF8CHARINC
399
400 /* Get the next character, testing for UTF-8 mode, and advancing the pointer */
401
402 #define GETCHARINCTEST(c, eptr) \
403   c = *eptr++; \
404   if (utf8 && (c & 0xc0) == 0xc0) \
405     { \
406     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
407     int gcss = 6*gcaa; \
408     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
409     while (gcaa-- > 0) \
410       { \
411       gcss -= 6; \
412       c |= (*eptr++ & 0x3f) << gcss; \
413       } \
414     }
415
416 #define GETCHARLEN(c, eptr) GETUTF8CHARLEN(c, eptr)
417
418 /* Return 1 if not the start of a character. */
419
420 #define ISMIDCHAR(c) (((c) & 0xc0) == 0x80)
421
422 #endif
423
424 /* If the pointer is not at the start of a character, move it back until
425 it is. Called only in UTF-8 mode. */
426
427 #define BACKCHAR(eptr) while(ISMIDCHAR(*eptr)) eptr--;
428
429 #endif
430
431
432 /* In case there is no definition of offsetof() provided - though any proper
433 Standard C system should have one. */
434
435 #ifndef offsetof
436 #define offsetof(p_type,field) ((size_t)&(((p_type *)0)->field))
437 #endif
438
439
440 /* These are the public options that can change during matching. */
441
442 #define PCRE_IMS (PCRE_CASELESS|PCRE_MULTILINE|PCRE_DOTALL)
443
444 /* Private options flags start at the most significant end of the four bytes,
445 but skip the top bit so we can use ints for convenience without getting tangled
446 with negative values. The public options defined in pcre.h start at the least
447 significant end. Make sure they don't overlap! */
448
449 #define PCRE_FIRSTSET      0x40000000  /* first_byte is set */
450 #define PCRE_REQCHSET      0x20000000  /* req_byte is set */
451 #define PCRE_STARTLINE     0x10000000  /* start after \n for multiline */
452 #define PCRE_ICHANGED      0x08000000  /* i option changes within regex */
453 #define PCRE_NOPARTIAL     0x04000000  /* can't use partial with this regex */
454
455 /* Options for the "extra" block produced by pcre_study(). */
456
457 #define PCRE_STUDY_MAPPED   0x01     /* a map of starting chars exists */
458
459 /* Masks for identifying the public options that are permitted at compile
460 time, run time, or study time, respectively. */
461
462 #define PUBLIC_OPTIONS \
463   (PCRE_CASELESS|PCRE_EXTENDED|PCRE_ANCHORED|PCRE_MULTILINE| \
464    PCRE_DOTALL|PCRE_DOLLAR_ENDONLY|PCRE_EXTRA|PCRE_UNGREEDY|PCRE_UTF8| \
465    PCRE_NO_AUTO_CAPTURE|PCRE_NO_UTF8_CHECK|PCRE_AUTO_CALLOUT|PCRE_FIRSTLINE)
466
467 #define PUBLIC_EXEC_OPTIONS \
468   (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NO_UTF8_CHECK| \
469    PCRE_PARTIAL)
470
471 #define PUBLIC_DFA_EXEC_OPTIONS \
472   (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NO_UTF8_CHECK| \
473    PCRE_PARTIAL|PCRE_DFA_SHORTEST|PCRE_DFA_RESTART)
474
475 #define PUBLIC_STUDY_OPTIONS 0   /* None defined */
476
477 /* Magic number to provide a small check against being handed junk. Also used
478 to detect whether a pattern was compiled on a host of different endianness. */
479
480 #define MAGIC_NUMBER  0x50435245UL   /* 'PCRE' */
481
482 /* Negative values for the firstchar and reqchar variables */
483
484 #define REQ_UNSET (-2)
485 #define REQ_NONE  (-1)
486
487 /* The maximum remaining length of subject we are prepared to search for a
488 req_byte match. */
489
490 #define REQ_BYTE_MAX 1000
491
492 /* Flags added to firstbyte or reqbyte; a "non-literal" item is either a
493 variable-length repeat, or a anything other than literal characters. */
494
495 #define REQ_CASELESS 0x0100    /* indicates caselessness */
496 #define REQ_VARY     0x0200    /* reqbyte followed non-literal item */
497
498 /* Miscellaneous definitions */
499
500 typedef int BOOL;
501
502 #define FALSE   0
503 #define TRUE    1
504
505 /* Escape items that are just an encoding of a particular data value. Note that
506 ESC_n is defined as yet another macro, which is set in config.h to either \n
507 (the default) or \r (which some people want). */
508
509 #ifndef ESC_e
510 #define ESC_e 27
511 #endif
512
513 #ifndef ESC_f
514 #define ESC_f '\f'
515 #endif
516
517 #ifndef ESC_n
518 #define ESC_n NEWLINE
519 #endif
520
521 #ifndef ESC_r
522 #define ESC_r '\r'
523 #endif
524
525 /* We can't officially use ESC_t because it is a POSIX reserved identifier
526 (presumably because of all the others like size_t). */
527
528 #ifndef ESC_tee
529 #define ESC_tee '\t'
530 #endif
531
532 /* These are escaped items that aren't just an encoding of a particular data
533 value such as \n. They must have non-zero values, as check_escape() returns
534 their negation. Also, they must appear in the same order as in the opcode
535 definitions below, up to ESC_z. There's a dummy for OP_ANY because it
536 corresponds to "." rather than an escape sequence. The final one must be
537 ESC_REF as subsequent values are used for \1, \2, \3, etc. There is are two
538 tests in the code for an escape greater than ESC_b and less than ESC_Z to
539 detect the types that may be repeated. These are the types that consume
540 characters. If any new escapes are put in between that don't consume a
541 character, that code will have to change. */
542
543 enum { ESC_A = 1, ESC_G, ESC_B, ESC_b, ESC_D, ESC_d, ESC_S, ESC_s, ESC_W,
544        ESC_w, ESC_dum1, ESC_C, ESC_P, ESC_p, ESC_X, ESC_Z, ESC_z, ESC_E,
545        ESC_Q, ESC_REF };
546
547 /* Flag bits and data types for the extended class (OP_XCLASS) for classes that
548 contain UTF-8 characters with values greater than 255. */
549
550 #define XCL_NOT    0x01    /* Flag: this is a negative class */
551 #define XCL_MAP    0x02    /* Flag: a 32-byte map is present */
552
553 #define XCL_END       0    /* Marks end of individual items */
554 #define XCL_SINGLE    1    /* Single item (one multibyte char) follows */
555 #define XCL_RANGE     2    /* A range (two multibyte chars) follows */
556 #define XCL_PROP      3    /* Unicode property (one property code) follows */
557 #define XCL_NOTPROP   4    /* Unicode inverted property (ditto) */
558
559
560 /* Opcode table: OP_BRA must be last, as all values >= it are used for brackets
561 that extract substrings. Starting from 1 (i.e. after OP_END), the values up to
562 OP_EOD must correspond in order to the list of escapes immediately above.
563 Note that whenever this list is updated, the two macro definitions that follow
564 must also be updated to match. */
565
566 enum {
567   OP_END,            /* 0 End of pattern */
568
569   /* Values corresponding to backslashed metacharacters */
570
571   OP_SOD,            /* 1 Start of data: \A */
572   OP_SOM,            /* 2 Start of match (subject + offset): \G */
573   OP_NOT_WORD_BOUNDARY,  /*  3 \B */
574   OP_WORD_BOUNDARY,      /*  4 \b */
575   OP_NOT_DIGIT,          /*  5 \D */
576   OP_DIGIT,              /*  6 \d */
577   OP_NOT_WHITESPACE,     /*  7 \S */
578   OP_WHITESPACE,         /*  8 \s */
579   OP_NOT_WORDCHAR,       /*  9 \W */
580   OP_WORDCHAR,           /* 10 \w */
581   OP_ANY,            /* 11 Match any character */
582   OP_ANYBYTE,        /* 12 Match any byte (\C); different to OP_ANY for UTF-8 */
583   OP_NOTPROP,        /* 13 \P (not Unicode property) */
584   OP_PROP,           /* 14 \p (Unicode property) */
585   OP_EXTUNI,         /* 15 \X (extended Unicode sequence */
586   OP_EODN,           /* 16 End of data or \n at end of data: \Z. */
587   OP_EOD,            /* 17 End of data: \z */
588
589   OP_OPT,            /* 18 Set runtime options */
590   OP_CIRC,           /* 19 Start of line - varies with multiline switch */
591   OP_DOLL,           /* 20 End of line - varies with multiline switch */
592   OP_CHAR,           /* 21 Match one character, casefully */
593   OP_CHARNC,         /* 22 Match one character, caselessly */
594   OP_NOT,            /* 23 Match anything but the following char */
595
596   OP_STAR,           /* 24 The maximizing and minimizing versions of */
597   OP_MINSTAR,        /* 25 all these opcodes must come in pairs, with */
598   OP_PLUS,           /* 26 the minimizing one second. */
599   OP_MINPLUS,        /* 27 This first set applies to single characters */
600   OP_QUERY,          /* 28 */
601   OP_MINQUERY,       /* 29 */
602   OP_UPTO,           /* 30 From 0 to n matches */
603   OP_MINUPTO,        /* 31 */
604   OP_EXACT,          /* 32 Exactly n matches */
605
606   OP_NOTSTAR,        /* 33 The maximizing and minimizing versions of */
607   OP_NOTMINSTAR,     /* 34 all these opcodes must come in pairs, with */
608   OP_NOTPLUS,        /* 35 the minimizing one second. */
609   OP_NOTMINPLUS,     /* 36 This set applies to "not" single characters */
610   OP_NOTQUERY,       /* 37 */
611   OP_NOTMINQUERY,    /* 38 */
612   OP_NOTUPTO,        /* 39 From 0 to n matches */
613   OP_NOTMINUPTO,     /* 40 */
614   OP_NOTEXACT,       /* 41 Exactly n matches */
615
616   OP_TYPESTAR,       /* 42 The maximizing and minimizing versions of */
617   OP_TYPEMINSTAR,    /* 43 all these opcodes must come in pairs, with */
618   OP_TYPEPLUS,       /* 44 the minimizing one second. These codes must */
619   OP_TYPEMINPLUS,    /* 45 be in exactly the same order as those above. */
620   OP_TYPEQUERY,      /* 46 This set applies to character types such as \d */
621   OP_TYPEMINQUERY,   /* 47 */
622   OP_TYPEUPTO,       /* 48 From 0 to n matches */
623   OP_TYPEMINUPTO,    /* 49 */
624   OP_TYPEEXACT,      /* 50 Exactly n matches */
625
626   OP_CRSTAR,         /* 51 The maximizing and minimizing versions of */
627   OP_CRMINSTAR,      /* 52 all these opcodes must come in pairs, with */
628   OP_CRPLUS,         /* 53 the minimizing one second. These codes must */
629   OP_CRMINPLUS,      /* 54 be in exactly the same order as those above. */
630   OP_CRQUERY,        /* 55 These are for character classes and back refs */
631   OP_CRMINQUERY,     /* 56 */
632   OP_CRRANGE,        /* 57 These are different to the three sets above. */
633   OP_CRMINRANGE,     /* 58 */
634
635   OP_CLASS,          /* 59 Match a character class, chars < 256 only */
636   OP_NCLASS,         /* 60 Same, but the bitmap was created from a negative
637                            class - the difference is relevant only when a UTF-8
638                            character > 255 is encountered. */
639
640   OP_XCLASS,         /* 61 Extended class for handling UTF-8 chars within the
641                            class. This does both positive and negative. */
642
643   OP_REF,            /* 62 Match a back reference */
644   OP_RECURSE,        /* 63 Match a numbered subpattern (possibly recursive) */
645   OP_CALLOUT,        /* 64 Call out to external function if provided */
646
647   OP_ALT,            /* 65 Start of alternation */
648   OP_KET,            /* 66 End of group that doesn't have an unbounded repeat */
649   OP_KETRMAX,        /* 67 These two must remain together and in this */
650   OP_KETRMIN,        /* 68 order. They are for groups the repeat for ever. */
651
652   /* The assertions must come before ONCE and COND */
653
654   OP_ASSERT,         /* 69 Positive lookahead */
655   OP_ASSERT_NOT,     /* 70 Negative lookahead */
656   OP_ASSERTBACK,     /* 71 Positive lookbehind */
657   OP_ASSERTBACK_NOT, /* 72 Negative lookbehind */
658   OP_REVERSE,        /* 73 Move pointer back - used in lookbehind assertions */
659
660   /* ONCE and COND must come after the assertions, with ONCE first, as there's
661   a test for >= ONCE for a subpattern that isn't an assertion. */
662
663   OP_ONCE,           /* 74 Once matched, don't back up into the subpattern */
664   OP_COND,           /* 75 Conditional group */
665   OP_CREF,           /* 76 Used to hold an extraction string number (cond ref) */
666
667   OP_BRAZERO,        /* 77 These two must remain together and in this */
668   OP_BRAMINZERO,     /* 78 order. */
669
670   OP_BRANUMBER,      /* 79 Used for extracting brackets whose number is greater
671                            than can fit into an opcode. */
672
673   OP_BRA             /* 80 This and greater values are used for brackets that
674                            extract substrings up to EXTRACT_BASIC_MAX. After
675                            that, use is made of OP_BRANUMBER. */
676 };
677
678 /* WARNING WARNING WARNING: There is an implicit assumption in pcre.c and
679 study.c that all opcodes are less than 128 in value. This makes handling UTF-8
680 character sequences easier. */
681
682 /* The highest extraction number before we have to start using additional
683 bytes. (Originally PCRE didn't have support for extraction counts highter than
684 this number.) The value is limited by the number of opcodes left after OP_BRA,
685 i.e. 255 - OP_BRA. We actually set it a bit lower to leave room for additional
686 opcodes. */
687
688 #define EXTRACT_BASIC_MAX  100
689
690
691 /* This macro defines textual names for all the opcodes. These are used only
692 for debugging. The macro is referenced only in pcre_printint.c. */
693
694 #define OP_NAME_LIST \
695   "End", "\\A", "\\G", "\\B", "\\b", "\\D", "\\d",                \
696   "\\S", "\\s", "\\W", "\\w", "Any", "Anybyte",                   \
697   "notprop", "prop", "extuni",                                    \
698   "\\Z", "\\z",                                                   \
699   "Opt", "^", "$", "char", "charnc", "not",                       \
700   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
701   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
702   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
703   "*", "*?", "+", "+?", "?", "??", "{", "{",                      \
704   "class", "nclass", "xclass", "Ref", "Recurse", "Callout",       \
705   "Alt", "Ket", "KetRmax", "KetRmin", "Assert", "Assert not",     \
706   "AssertB", "AssertB not", "Reverse", "Once", "Cond", "Cond ref",\
707   "Brazero", "Braminzero", "Branumber", "Bra"
708
709
710 /* This macro defines the length of fixed length operations in the compiled
711 regex. The lengths are used when searching for specific things, and also in the
712 debugging printing of a compiled regex. We use a macro so that it can be
713 defined close to the definitions of the opcodes themselves.
714
715 As things have been extended, some of these are no longer fixed lenths, but are
716 minima instead. For example, the length of a single-character repeat may vary
717 in UTF-8 mode. The code that uses this table must know about such things. */
718
719 #define OP_LENGTHS \
720   1,                             /* End                                    */ \
721   1, 1, 1, 1, 1, 1, 1, 1, 1, 1,  /* \A, \G, \B, \B, \D, \d, \S, \s, \W, \w */ \
722   1, 1,                          /* Any, Anybyte                           */ \
723   2, 2, 1,                       /* NOTPROP, PROP, EXTUNI                  */ \
724   1, 1, 2, 1, 1,                 /* \Z, \z, Opt, ^, $                      */ \
725   2,                             /* Char  - the minimum length             */ \
726   2,                             /* Charnc  - the minimum length           */ \
727   2,                             /* not                                    */ \
728   /* Positive single-char repeats                            ** These are  */ \
729   2, 2, 2, 2, 2, 2,              /* *, *?, +, +?, ?, ??      ** minima in  */ \
730   4, 4, 4,                       /* upto, minupto, exact     ** UTF-8 mode */ \
731   /* Negative single-char repeats - only for chars < 256                   */ \
732   2, 2, 2, 2, 2, 2,              /* NOT *, *?, +, +?, ?, ??                */ \
733   4, 4, 4,                       /* NOT upto, minupto, exact               */ \
734   /* Positive type repeats                                                 */ \
735   2, 2, 2, 2, 2, 2,              /* Type *, *?, +, +?, ?, ??               */ \
736   4, 4, 4,                       /* Type upto, minupto, exact              */ \
737   /* Character class & ref repeats                                         */ \
738   1, 1, 1, 1, 1, 1,              /* *, *?, +, +?, ?, ??                    */ \
739   5, 5,                          /* CRRANGE, CRMINRANGE                    */ \
740  33,                             /* CLASS                                  */ \
741  33,                             /* NCLASS                                 */ \
742   0,                             /* XCLASS - variable length               */ \
743   3,                             /* REF                                    */ \
744   1+LINK_SIZE,                   /* RECURSE                                */ \
745   2+2*LINK_SIZE,                 /* CALLOUT                                */ \
746   1+LINK_SIZE,                   /* Alt                                    */ \
747   1+LINK_SIZE,                   /* Ket                                    */ \
748   1+LINK_SIZE,                   /* KetRmax                                */ \
749   1+LINK_SIZE,                   /* KetRmin                                */ \
750   1+LINK_SIZE,                   /* Assert                                 */ \
751   1+LINK_SIZE,                   /* Assert not                             */ \
752   1+LINK_SIZE,                   /* Assert behind                          */ \
753   1+LINK_SIZE,                   /* Assert behind not                      */ \
754   1+LINK_SIZE,                   /* Reverse                                */ \
755   1+LINK_SIZE,                   /* Once                                   */ \
756   1+LINK_SIZE,                   /* COND                                   */ \
757   3,                             /* CREF                                   */ \
758   1, 1,                          /* BRAZERO, BRAMINZERO                    */ \
759   3,                             /* BRANUMBER                              */ \
760   1+LINK_SIZE                    /* BRA                                    */ \
761
762
763 /* A magic value for OP_CREF to indicate the "in recursion" condition. */
764
765 #define CREF_RECURSE  0xffff
766
767 /* Error code numbers. They are given names so that they can more easily be
768 tracked. */
769
770 enum { ERR0,  ERR1,  ERR2,  ERR3,  ERR4,  ERR5,  ERR6,  ERR7,  ERR8,  ERR9,
771        ERR10, ERR11, ERR12, ERR13, ERR14, ERR15, ERR16, ERR17, ERR18, ERR19,
772        ERR20, ERR21, ERR22, ERR23, ERR24, ERR25, ERR26, ERR27, ERR28, ERR29,
773        ERR30, ERR31, ERR32, ERR33, ERR34, ERR35, ERR36, ERR37, ERR38, ERR39,
774        ERR40, ERR41, ERR42, ERR43, ERR44, ERR45, ERR46, ERR47 };
775
776 /* The real format of the start of the pcre block; the index of names and the
777 code vector run on as long as necessary after the end. We store an explicit
778 offset to the name table so that if a regex is compiled on one host, saved, and
779 then run on another where the size of pointers is different, all might still
780 be well. For the case of compiled-on-4 and run-on-8, we include an extra
781 pointer that is always NULL. For future-proofing, a few dummy fields were
782 originally included - even though you can never get this planning right - but
783 there is only one left now.
784
785 NOTE NOTE NOTE:
786 Because people can now save and re-use compiled patterns, any additions to this
787 structure should be made at the end, and something earlier (e.g. a new
788 flag in the options or one of the dummy fields) should indicate that the new
789 fields are present. Currently PCRE always sets the dummy fields to zero.
790 NOTE NOTE NOTE:
791 */
792
793 typedef struct real_pcre {
794   pcre_uint32 magic_number;
795   pcre_uint32 size;               /* Total that was malloced */
796   pcre_uint32 options;
797   pcre_uint32 dummy1;             /* For future use, maybe */
798
799   pcre_uint16 top_bracket;
800   pcre_uint16 top_backref;
801   pcre_uint16 first_byte;
802   pcre_uint16 req_byte;
803   pcre_uint16 name_table_offset;  /* Offset to name table that follows */
804   pcre_uint16 name_entry_size;    /* Size of any name items */
805   pcre_uint16 name_count;         /* Number of name items */
806   pcre_uint16 ref_count;          /* Reference count */
807
808   const unsigned char *tables;    /* Pointer to tables or NULL for std */
809   const unsigned char *nullpad;   /* NULL padding */
810 } real_pcre;
811
812 /* The format of the block used to store data from pcre_study(). The same
813 remark (see NOTE above) about extending this structure applies. */
814
815 typedef struct pcre_study_data {
816   pcre_uint32 size;               /* Total that was malloced */
817   pcre_uint32 options;
818   uschar start_bits[32];
819 } pcre_study_data;
820
821 /* Structure for passing "static" information around between the functions
822 doing the compiling, so that they are thread-safe. */
823
824 typedef struct compile_data {
825   const uschar *lcc;            /* Points to lower casing table */
826   const uschar *fcc;            /* Points to case-flipping table */
827   const uschar *cbits;          /* Points to character type table */
828   const uschar *ctypes;         /* Points to table of type maps */
829   const uschar *start_code;     /* The start of the compiled code */
830   const pcre_uchar *start_pattern;   /* The start of the pattern */
831   uschar *name_table;           /* The name/number table */
832   int  names_found;             /* Number of entries so far */
833   int  name_entry_size;         /* Size of each entry */
834   int  top_backref;             /* Maximum back reference */
835   unsigned int backref_map;     /* Bitmap of low back refs */
836   int  req_varyopt;             /* "After variable item" flag for reqbyte */
837   BOOL nopartial;               /* Set TRUE if partial won't work */
838 } compile_data;
839
840 /* Structure for maintaining a chain of pointers to the currently incomplete
841 branches, for testing for left recursion. */
842
843 typedef struct branch_chain {
844   struct branch_chain *outer;
845   uschar *current;
846 } branch_chain;
847
848 /* Structure for items in a linked list that represents an explicit recursive
849 call within the pattern. */
850
851 typedef struct recursion_info {
852   struct recursion_info *prevrec; /* Previous recursion record (or NULL) */
853   int group_num;                /* Number of group that was called */
854   const uschar *after_call;     /* "Return value": points after the call in the expr */
855   const pcre_uchar *save_start;     /* Old value of md->start_match */
856   int *offset_save;             /* Pointer to start of saved offsets */
857   int saved_max;                /* Number of saved offsets */
858 } recursion_info;
859
860 /* When compiling in a mode that doesn't use recursive calls to match(),
861 a structure is used to remember local variables on the heap. It is defined in
862 pcre.c, close to the match() function, so that it is easy to keep it in step
863 with any changes of local variable. However, the pointer to the current frame
864 must be saved in some "static" place over a longjmp(). We declare the
865 structure here so that we can put a pointer in the match_data structure.
866 NOTE: This isn't used for a "normal" compilation of pcre. */
867
868 struct heapframe;
869
870 /* Structure for passing "static" information around between the functions
871 doing traditional NFA matching, so that they are thread-safe. */
872
873 typedef struct match_data {
874   unsigned long int match_call_count; /* As it says */
875   unsigned long int match_limit;/* As it says */
876   int   *offset_vector;         /* Offset vector */
877   int    offset_end;            /* One past the end */
878   int    offset_max;            /* The maximum usable for return data */
879   const uschar *lcc;            /* Points to lower casing table */
880   const uschar *ctypes;         /* Points to table of type maps */
881   BOOL   offset_overflow;       /* Set if too many extractions */
882   BOOL   notbol;                /* NOTBOL flag */
883   BOOL   noteol;                /* NOTEOL flag */
884   BOOL   utf8;                  /* UTF8 flag */
885   BOOL   endonly;               /* Dollar not before final \n */
886   BOOL   notempty;              /* Empty string match not wanted */
887   BOOL   partial;               /* PARTIAL flag */
888   BOOL   hitend;                /* Hit the end of the subject at some point */
889   const uschar *start_code;     /* For use when recursing */
890   const pcre_uchar *start_subject;   /* Start of the subject string */
891   const pcre_uchar *end_subject;     /* End of the subject string */
892   const pcre_uchar *start_match;     /* Start of this match attempt */
893   const pcre_uchar *end_match_ptr;   /* Subject position at end match */
894   int    end_offset_top;        /* Highwater mark at end of match */
895   int    capture_last;          /* Most recent capture number */
896   int    start_offset;          /* The start offset value */
897   recursion_info *recursive;    /* Linked list of recursion data */
898   void  *callout_data;          /* To pass back to callouts */
899   struct heapframe *thisframe;  /* Used only when compiling for no recursion */
900 } match_data;
901
902 /* A similar structure is used for the same purpose by the DFA matching
903 functions. */
904
905 typedef struct dfa_match_data {
906   const uschar *start_code;     /* Start of the compiled pattern */
907   const pcre_uchar *start_subject;   /* Start of the subject string */
908   const pcre_uchar *end_subject;     /* End of subject string */
909   const uschar *tables;         /* Character tables */
910   int   moptions;               /* Match options */
911   int   poptions;               /* Pattern options */
912   void  *callout_data;          /* To pass back to callouts */
913 } dfa_match_data;
914
915 /* Bit definitions for entries in the pcre_ctypes table. */
916
917 #define ctype_space   0x01
918 #define ctype_letter  0x02
919 #define ctype_digit   0x04
920 #define ctype_xdigit  0x08
921 #define ctype_word    0x10   /* alphameric or '_' */
922 #define ctype_meta    0x80   /* regexp meta char or zero (end pattern) */
923
924 /* Offsets for the bitmap tables in pcre_cbits. Each table contains a set
925 of bits for a class map. Some classes are built by combining these tables. */
926
927 #define cbit_space     0      /* [:space:] or \s */
928 #define cbit_xdigit   32      /* [:xdigit:] */
929 #define cbit_digit    64      /* [:digit:] or \d */
930 #define cbit_upper    96      /* [:upper:] */
931 #define cbit_lower   128      /* [:lower:] */
932 #define cbit_word    160      /* [:word:] or \w */
933 #define cbit_graph   192      /* [:graph:] */
934 #define cbit_print   224      /* [:print:] */
935 #define cbit_punct   256      /* [:punct:] */
936 #define cbit_cntrl   288      /* [:cntrl:] */
937 #define cbit_length  320      /* Length of the cbits table */
938
939 /* Offsets of the various tables from the base tables pointer, and
940 total length. */
941
942 #define lcc_offset      0
943 #define fcc_offset    256
944 #define cbits_offset  512
945 #define ctypes_offset (cbits_offset + cbit_length)
946 #define tables_length (ctypes_offset + 256)
947
948 /* Layout of the UCP type table that translates property names into codes for
949 ucp_findchar(). */
950
951 typedef struct {
952   const char *name;
953   int value;
954 } ucp_type_table;
955
956
957 /* Internal shared data tables. These are tables that are used by more than one
958 of the exported public functions. They have to be "external" in the C sense,
959 but are not part of the PCRE public API. The data for these tables is in the
960 pcre_tables.c module. */
961
962 extern const int    _pcre_utf8_table1[];
963 extern const int    _pcre_utf8_table2[];
964 extern const int    _pcre_utf8_table3[];
965 extern const uschar _pcre_utf8_table4[];
966
967 extern const int    _pcre_utf8_table1_size;
968
969 extern const ucp_type_table _pcre_utt[];
970 extern const int _pcre_utt_size;
971
972 extern const uschar _pcre_default_tables[];
973
974 extern const uschar _pcre_OP_lengths[];
975
976 /* Internal shared functions. These are functions that are used by more than
977 one of the exported public functions. They have to be "external" in the C
978 sense, but are not part of the PCRE public API. */
979
980 extern int         _pcre_ord2utf8(int, uschar *);
981 extern void        _pcre_printint(pcre *, FILE *);
982 extern real_pcre * _pcre_try_flipped(const real_pcre *, real_pcre *,
983                      const pcre_study_data *, pcre_study_data *);
984 extern int         _pcre_ucp_findchar(const int, int *, int *);
985 extern int         _pcre_valid_utf8(const uschar *, int);
986 extern BOOL        _pcre_xclass(int, const uschar *);
987
988 /* End of pcre_internal.h */