OSDN Git Service

Separate vc71 Build* folders from vc100 (expat)
[winmerge-jp/winmerge-jp.git] / Externals / 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-2010 University of Cambridge
11
12 -----------------------------------------------------------------------------
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15
16     * Redistributions of source code must retain the above copyright notice,
17       this list of conditions and the following disclaimer.
18
19     * Redistributions in binary form must reproduce the above copyright
20       notice, this list of conditions and the following disclaimer in the
21       documentation and/or other materials provided with the distribution.
22
23     * Neither the name of the University of Cambridge nor the names of its
24       contributors may be used to endorse or promote products derived from
25       this software without specific prior written permission.
26
27 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 POSSIBILITY OF SUCH DAMAGE.
38 -----------------------------------------------------------------------------
39 */
40
41 /* This header contains definitions that are shared between the different
42 modules, but which are not relevant to the exported API. This includes some
43 functions whose names all begin with "_pcre_". */
44
45 #ifndef PCRE_INTERNAL_H
46 #define PCRE_INTERNAL_H
47
48 /* Define PCRE_DEBUG to get debugging output on stdout. */
49
50 #if 0
51 #define PCRE_DEBUG
52 #endif
53
54 /* We do not support both EBCDIC and UTF-8 at the same time. The "configure"
55 script prevents both being selected, but not everybody uses "configure". */
56
57 #if defined EBCDIC && defined SUPPORT_UTF8
58 #error The use of both EBCDIC and SUPPORT_UTF8 is not supported.
59 #endif
60
61 /* If SUPPORT_UCP is defined, SUPPORT_UTF8 must also be defined. The
62 "configure" script ensures this, but not everybody uses "configure". */
63
64 #if defined SUPPORT_UCP && !defined SUPPORT_UTF8
65 #define SUPPORT_UTF8 1
66 #endif
67
68 /* Use a macro for debugging printing, 'cause that eliminates the use of #ifdef
69 inline, and there are *still* stupid compilers about that don't like indented
70 pre-processor statements, or at least there were when I first wrote this. After
71 all, it had only been about 10 years then...
72
73 It turns out that the Mac Debugging.h header also defines the macro DPRINTF, so
74 be absolutely sure we get our version. */
75
76 #undef DPRINTF
77 #ifdef PCRE_DEBUG
78 #define DPRINTF(p) printf p
79 #else
80 #define DPRINTF(p) /* Nothing */
81 #endif
82
83
84 /* Standard C headers plus the external interface definition. The only time
85 setjmp and stdarg are used is when NO_RECURSE is set. */
86
87 #include <ctype.h>
88 #include <limits.h>
89 #include <stddef.h>
90 #include <stdio.h>
91 #include <stdlib.h>
92 #include <string.h>
93
94 /* When compiling a DLL for Windows, the exported symbols have to be declared
95 using some MS magic. I found some useful information on this web page:
96 http://msdn2.microsoft.com/en-us/library/y4h7bcy6(VS.80).aspx. According to the
97 information there, using __declspec(dllexport) without "extern" we have a
98 definition; with "extern" we have a declaration. The settings here override the
99 setting in pcre.h (which is included below); it defines only PCRE_EXP_DECL,
100 which is all that is needed for applications (they just import the symbols). We
101 use:
102
103   PCRE_EXP_DECL       for declarations
104   PCRE_EXP_DEFN       for definitions of exported functions
105   PCRE_EXP_DATA_DEFN  for definitions of exported variables
106
107 The reason for the two DEFN macros is that in non-Windows environments, one
108 does not want to have "extern" before variable definitions because it leads to
109 compiler warnings. So we distinguish between functions and variables. In
110 Windows, the two should always be the same.
111
112 The reason for wrapping this in #ifndef PCRE_EXP_DECL is so that pcretest,
113 which is an application, but needs to import this file in order to "peek" at
114 internals, can #include pcre.h first to get an application's-eye view.
115
116 In principle, people compiling for non-Windows, non-Unix-like (i.e. uncommon,
117 special-purpose environments) might want to stick other stuff in front of
118 exported symbols. That's why, in the non-Windows case, we set PCRE_EXP_DEFN and
119 PCRE_EXP_DATA_DEFN only if they are not already set. */
120
121 #ifndef PCRE_EXP_DECL
122 #  ifdef _WIN32
123 #    ifndef PCRE_STATIC
124 #      define PCRE_EXP_DECL       extern __declspec(dllexport)
125 #      define PCRE_EXP_DEFN       __declspec(dllexport)
126 #      define PCRE_EXP_DATA_DEFN  __declspec(dllexport)
127 #    else
128 #      define PCRE_EXP_DECL       extern
129 #      define PCRE_EXP_DEFN
130 #      define PCRE_EXP_DATA_DEFN
131 #    endif
132 #  else
133 #    ifdef __cplusplus
134 #      define PCRE_EXP_DECL       extern "C"
135 #    else
136 #      define PCRE_EXP_DECL       extern
137 #    endif
138 #    ifndef PCRE_EXP_DEFN
139 #      define PCRE_EXP_DEFN       PCRE_EXP_DECL
140 #    endif
141 #    ifndef PCRE_EXP_DATA_DEFN
142 #      define PCRE_EXP_DATA_DEFN
143 #    endif
144 #  endif
145 #endif
146
147 /* When compiling with the MSVC compiler, it is sometimes necessary to include
148 a "calling convention" before exported function names. (This is secondhand
149 information; I know nothing about MSVC myself). For example, something like
150
151   void __cdecl function(....)
152
153 might be needed. In order so make this easy, all the exported functions have
154 PCRE_CALL_CONVENTION just before their names. It is rarely needed; if not
155 set, we ensure here that it has no effect. */
156
157 #ifndef PCRE_CALL_CONVENTION
158 #define PCRE_CALL_CONVENTION
159 #endif
160
161 /* We need to have types that specify unsigned 16-bit and 32-bit integers. We
162 cannot determine these outside the compilation (e.g. by running a program as
163 part of "configure") because PCRE is often cross-compiled for use on other
164 systems. Instead we make use of the maximum sizes that are available at
165 preprocessor time in standard C environments. */
166
167 #if USHRT_MAX == 65535
168   typedef unsigned short pcre_uint16;
169   typedef short pcre_int16;
170 #elif UINT_MAX == 65535
171   typedef unsigned int pcre_uint16;
172   typedef int pcre_int16;
173 #else
174   #error Cannot determine a type for 16-bit unsigned integers
175 #endif
176
177 #if UINT_MAX == 4294967295
178   typedef unsigned int pcre_uint32;
179   typedef int pcre_int32;
180 #elif ULONG_MAX == 4294967295
181   typedef unsigned long int pcre_uint32;
182   typedef long int pcre_int32;
183 #else
184   #error Cannot determine a type for 32-bit unsigned integers
185 #endif
186
187 /* When checking for integer overflow in pcre_compile(), we need to handle
188 large integers. If a 64-bit integer type is available, we can use that.
189 Otherwise we have to cast to double, which of course requires floating point
190 arithmetic. Handle this by defining a macro for the appropriate type. If
191 stdint.h is available, include it; it may define INT64_MAX. Systems that do not
192 have stdint.h (e.g. Solaris) may have inttypes.h. The macro int64_t may be set
193 by "configure". */
194
195 #if HAVE_STDINT_H
196 #include <stdint.h>
197 #elif HAVE_INTTYPES_H
198 #include <inttypes.h>
199 #endif
200
201 #if defined INT64_MAX || defined int64_t
202 #define INT64_OR_DOUBLE int64_t
203 #else
204 #define INT64_OR_DOUBLE double
205 #endif
206
207 /* All character handling must be done as unsigned characters. Otherwise there
208 are problems with top-bit-set characters and functions such as isspace().
209 However, we leave the interface to the outside world as char *, because that
210 should make things easier for callers. We define a short type for unsigned char
211 to save lots of typing. I tried "uchar", but it causes problems on Digital
212 Unix, where it is defined in sys/types, so use "uschar" instead. */
213
214 typedef unsigned char uschar;
215
216 /* This is an unsigned int value that no character can ever have. UTF-8
217 characters only go up to 0x7fffffff (though Unicode doesn't go beyond
218 0x0010ffff). */
219
220 #define NOTACHAR 0xffffffff
221
222 /* PCRE is able to support several different kinds of newline (CR, LF, CRLF,
223 "any" and "anycrlf" at present). The following macros are used to package up
224 testing for newlines. NLBLOCK, PSSTART, and PSEND are defined in the various
225 modules to indicate in which datablock the parameters exist, and what the
226 start/end of string field names are. */
227
228 #define NLTYPE_FIXED    0     /* Newline is a fixed length string */
229 #define NLTYPE_ANY      1     /* Newline is any Unicode line ending */
230 #define NLTYPE_ANYCRLF  2     /* Newline is CR, LF, or CRLF */
231
232 /* This macro checks for a newline at the given position */
233
234 #define IS_NEWLINE(p) \
235   ((NLBLOCK->nltype != NLTYPE_FIXED)? \
236     ((p) < NLBLOCK->PSEND && \
237      _pcre_is_newline((p), NLBLOCK->nltype, NLBLOCK->PSEND, &(NLBLOCK->nllen),\
238        utf8)) \
239     : \
240     ((p) <= NLBLOCK->PSEND - NLBLOCK->nllen && \
241      (p)[0] == NLBLOCK->nl[0] && \
242      (NLBLOCK->nllen == 1 || (p)[1] == NLBLOCK->nl[1]) \
243     ) \
244   )
245
246 /* This macro checks for a newline immediately preceding the given position */
247
248 #define WAS_NEWLINE(p) \
249   ((NLBLOCK->nltype != NLTYPE_FIXED)? \
250     ((p) > NLBLOCK->PSSTART && \
251      _pcre_was_newline((p), NLBLOCK->nltype, NLBLOCK->PSSTART, \
252        &(NLBLOCK->nllen), utf8)) \
253     : \
254     ((p) >= NLBLOCK->PSSTART + NLBLOCK->nllen && \
255      (p)[-NLBLOCK->nllen] == NLBLOCK->nl[0] && \
256      (NLBLOCK->nllen == 1 || (p)[-NLBLOCK->nllen+1] == NLBLOCK->nl[1]) \
257     ) \
258   )
259
260 /* When PCRE is compiled as a C++ library, the subject pointer can be replaced
261 with a custom type. This makes it possible, for example, to allow pcre_exec()
262 to process subject strings that are discontinuous by using a smart pointer
263 class. It must always be possible to inspect all of the subject string in
264 pcre_exec() because of the way it backtracks. Two macros are required in the
265 normal case, for sign-unspecified and unsigned char pointers. The former is
266 used for the external interface and appears in pcre.h, which is why its name
267 must begin with PCRE_. */
268
269 #ifdef CUSTOM_SUBJECT_PTR
270 #define PCRE_SPTR CUSTOM_SUBJECT_PTR
271 #define USPTR CUSTOM_SUBJECT_PTR
272 #else
273 #define PCRE_SPTR const char *
274 #define USPTR const unsigned char *
275 #endif
276
277
278
279 /* Include the public PCRE header and the definitions of UCP character property
280 values. */
281
282 #include "pcre.h"
283 #include "ucp.h"
284
285 /* When compiling for use with the Virtual Pascal compiler, these functions
286 need to have their names changed. PCRE must be compiled with the -DVPCOMPAT
287 option on the command line. */
288
289 #ifdef VPCOMPAT
290 #define strlen(s)        _strlen(s)
291 #define strncmp(s1,s2,m) _strncmp(s1,s2,m)
292 #define memcmp(s,c,n)    _memcmp(s,c,n)
293 #define memcpy(d,s,n)    _memcpy(d,s,n)
294 #define memmove(d,s,n)   _memmove(d,s,n)
295 #define memset(s,c,n)    _memset(s,c,n)
296 #else  /* VPCOMPAT */
297
298 /* To cope with SunOS4 and other systems that lack memmove() but have bcopy(),
299 define a macro for memmove() if HAVE_MEMMOVE is false, provided that HAVE_BCOPY
300 is set. Otherwise, include an emulating function for those systems that have
301 neither (there some non-Unix environments where this is the case). */
302
303 #ifndef HAVE_MEMMOVE
304 #undef  memmove        /* some systems may have a macro */
305 #ifdef HAVE_BCOPY
306 #define memmove(a, b, c) bcopy(b, a, c)
307 #else  /* HAVE_BCOPY */
308 static void *
309 pcre_memmove(void *d, const void *s, size_t n)
310 {
311 size_t i;
312 unsigned char *dest = (unsigned char *)d;
313 const unsigned char *src = (const unsigned char *)s;
314 if (dest > src)
315   {
316   dest += n;
317   src += n;
318   for (i = 0; i < n; ++i) *(--dest) = *(--src);
319   return (void *)dest;
320   }
321 else
322   {
323   for (i = 0; i < n; ++i) *dest++ = *src++;
324   return (void *)(dest - n);
325   }
326 }
327 #define memmove(a, b, c) pcre_memmove(a, b, c)
328 #endif   /* not HAVE_BCOPY */
329 #endif   /* not HAVE_MEMMOVE */
330 #endif   /* not VPCOMPAT */
331
332
333 /* PCRE keeps offsets in its compiled code as 2-byte quantities (always stored
334 in big-endian order) by default. These are used, for example, to link from the
335 start of a subpattern to its alternatives and its end. The use of 2 bytes per
336 offset limits the size of the compiled regex to around 64K, which is big enough
337 for almost everybody. However, I received a request for an even bigger limit.
338 For this reason, and also to make the code easier to maintain, the storing and
339 loading of offsets from the byte string is now handled by the macros that are
340 defined here.
341
342 The macros are controlled by the value of LINK_SIZE. This defaults to 2 in
343 the config.h file, but can be overridden by using -D on the command line. This
344 is automated on Unix systems via the "configure" command. */
345
346 #if LINK_SIZE == 2
347
348 #define PUT(a,n,d)   \
349   (a[n] = (d) >> 8), \
350   (a[(n)+1] = (d) & 255)
351
352 #define GET(a,n) \
353   (((a)[n] << 8) | (a)[(n)+1])
354
355 #define MAX_PATTERN_SIZE (1 << 16)
356
357
358 #elif LINK_SIZE == 3
359
360 #define PUT(a,n,d)       \
361   (a[n] = (d) >> 16),    \
362   (a[(n)+1] = (d) >> 8), \
363   (a[(n)+2] = (d) & 255)
364
365 #define GET(a,n) \
366   (((a)[n] << 16) | ((a)[(n)+1] << 8) | (a)[(n)+2])
367
368 #define MAX_PATTERN_SIZE (1 << 24)
369
370
371 #elif LINK_SIZE == 4
372
373 #define PUT(a,n,d)        \
374   (a[n] = (d) >> 24),     \
375   (a[(n)+1] = (d) >> 16), \
376   (a[(n)+2] = (d) >> 8),  \
377   (a[(n)+3] = (d) & 255)
378
379 #define GET(a,n) \
380   (((a)[n] << 24) | ((a)[(n)+1] << 16) | ((a)[(n)+2] << 8) | (a)[(n)+3])
381
382 #define MAX_PATTERN_SIZE (1 << 30)   /* Keep it positive */
383
384
385 #else
386 #error LINK_SIZE must be either 2, 3, or 4
387 #endif
388
389
390 /* Convenience macro defined in terms of the others */
391
392 #define PUTINC(a,n,d)   PUT(a,n,d), a += LINK_SIZE
393
394
395 /* PCRE uses some other 2-byte quantities that do not change when the size of
396 offsets changes. There are used for repeat counts and for other things such as
397 capturing parenthesis numbers in back references. */
398
399 #define PUT2(a,n,d)   \
400   a[n] = (d) >> 8; \
401   a[(n)+1] = (d) & 255
402
403 #define GET2(a,n) \
404   (((a)[n] << 8) | (a)[(n)+1])
405
406 #define PUT2INC(a,n,d)  PUT2(a,n,d), a += 2
407
408
409 /* When UTF-8 encoding is being used, a character is no longer just a single
410 byte. The macros for character handling generate simple sequences when used in
411 byte-mode, and more complicated ones for UTF-8 characters. BACKCHAR should
412 never be called in byte mode. To make sure it can never even appear when UTF-8
413 support is omitted, we don't even define it. */
414
415 #ifndef SUPPORT_UTF8
416 #define GETCHAR(c, eptr) c = *eptr;
417 #define GETCHARTEST(c, eptr) c = *eptr;
418 #define GETCHARINC(c, eptr) c = *eptr++;
419 #define GETCHARINCTEST(c, eptr) c = *eptr++;
420 #define GETCHARLEN(c, eptr, len) c = *eptr;
421 /* #define BACKCHAR(eptr) */
422
423 #else   /* SUPPORT_UTF8 */
424
425 /* Get the next UTF-8 character, not advancing the pointer. This is called when
426 we know we are in UTF-8 mode. */
427
428 #define GETCHAR(c, eptr) \
429   c = *eptr; \
430   if (c >= 0xc0) \
431     { \
432     int gcii; \
433     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
434     int gcss = 6*gcaa; \
435     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
436     for (gcii = 1; gcii <= gcaa; gcii++) \
437       { \
438       gcss -= 6; \
439       c |= (eptr[gcii] & 0x3f) << gcss; \
440       } \
441     }
442
443 /* Get the next UTF-8 character, testing for UTF-8 mode, and not advancing the
444 pointer. */
445
446 #define GETCHARTEST(c, eptr) \
447   c = *eptr; \
448   if (utf8 && c >= 0xc0) \
449     { \
450     int gcii; \
451     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
452     int gcss = 6*gcaa; \
453     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
454     for (gcii = 1; gcii <= gcaa; gcii++) \
455       { \
456       gcss -= 6; \
457       c |= (eptr[gcii] & 0x3f) << gcss; \
458       } \
459     }
460
461 /* Get the next UTF-8 character, advancing the pointer. This is called when we
462 know we are in UTF-8 mode. */
463
464 #define GETCHARINC(c, eptr) \
465   c = *eptr++; \
466   if (c >= 0xc0) \
467     { \
468     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
469     int gcss = 6*gcaa; \
470     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
471     while (gcaa-- > 0) \
472       { \
473       gcss -= 6; \
474       c |= (*eptr++ & 0x3f) << gcss; \
475       } \
476     }
477
478 /* Get the next character, testing for UTF-8 mode, and advancing the pointer.
479 This is called when we don't know if we are in UTF-8 mode. */
480
481 #define GETCHARINCTEST(c, eptr) \
482   c = *eptr++; \
483   if (utf8 && c >= 0xc0) \
484     { \
485     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
486     int gcss = 6*gcaa; \
487     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
488     while (gcaa-- > 0) \
489       { \
490       gcss -= 6; \
491       c |= (*eptr++ & 0x3f) << gcss; \
492       } \
493     }
494
495 /* Get the next UTF-8 character, not advancing the pointer, incrementing length
496 if there are extra bytes. This is called when we know we are in UTF-8 mode. */
497
498 #define GETCHARLEN(c, eptr, len) \
499   c = *eptr; \
500   if (c >= 0xc0) \
501     { \
502     int gcii; \
503     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
504     int gcss = 6*gcaa; \
505     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
506     for (gcii = 1; gcii <= gcaa; gcii++) \
507       { \
508       gcss -= 6; \
509       c |= (eptr[gcii] & 0x3f) << gcss; \
510       } \
511     len += gcaa; \
512     }
513
514 /* Get the next UTF-8 character, testing for UTF-8 mode, not advancing the
515 pointer, incrementing length if there are extra bytes. This is called when we
516 do not know if we are in UTF-8 mode. */
517
518 #define GETCHARLENTEST(c, eptr, len) \
519   c = *eptr; \
520   if (utf8 && c >= 0xc0) \
521     { \
522     int gcii; \
523     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
524     int gcss = 6*gcaa; \
525     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
526     for (gcii = 1; gcii <= gcaa; gcii++) \
527       { \
528       gcss -= 6; \
529       c |= (eptr[gcii] & 0x3f) << gcss; \
530       } \
531     len += gcaa; \
532     }
533
534 /* If the pointer is not at the start of a character, move it back until
535 it is. This is called only in UTF-8 mode - we don't put a test within the macro
536 because almost all calls are already within a block of UTF-8 only code. */
537
538 #define BACKCHAR(eptr) while((*eptr & 0xc0) == 0x80) eptr--
539
540 #endif
541
542
543 /* In case there is no definition of offsetof() provided - though any proper
544 Standard C system should have one. */
545
546 #ifndef offsetof
547 #define offsetof(p_type,field) ((size_t)&(((p_type *)0)->field))
548 #endif
549
550
551 /* These are the public options that can change during matching. */
552
553 #define PCRE_IMS (PCRE_CASELESS|PCRE_MULTILINE|PCRE_DOTALL)
554
555 /* Private flags containing information about the compiled regex. They used to
556 live at the top end of the options word, but that got almost full, so now they
557 are in a 16-bit flags word. From release 8.00, PCRE_NOPARTIAL is unused, as
558 the restrictions on partial matching have been lifted. It remains for backwards
559 compatibility. */
560
561 #define PCRE_NOPARTIAL     0x0001  /* can't use partial with this regex */
562 #define PCRE_FIRSTSET      0x0002  /* first_byte is set */
563 #define PCRE_REQCHSET      0x0004  /* req_byte is set */
564 #define PCRE_STARTLINE     0x0008  /* start after \n for multiline */
565 #define PCRE_JCHANGED      0x0010  /* j option used in regex */
566 #define PCRE_HASCRORLF     0x0020  /* explicit \r or \n in pattern */
567
568 /* Options for the "extra" block produced by pcre_study(). */
569
570 #define PCRE_STUDY_MAPPED   0x01     /* a map of starting chars exists */
571 #define PCRE_STUDY_MINLEN   0x02     /* a minimum length field exists */
572
573 /* Masks for identifying the public options that are permitted at compile
574 time, run time, or study time, respectively. */
575
576 #define PCRE_NEWLINE_BITS (PCRE_NEWLINE_CR|PCRE_NEWLINE_LF|PCRE_NEWLINE_ANY| \
577                            PCRE_NEWLINE_ANYCRLF)
578
579 #define PUBLIC_COMPILE_OPTIONS \
580   (PCRE_CASELESS|PCRE_EXTENDED|PCRE_ANCHORED|PCRE_MULTILINE| \
581    PCRE_DOTALL|PCRE_DOLLAR_ENDONLY|PCRE_EXTRA|PCRE_UNGREEDY|PCRE_UTF8| \
582    PCRE_NO_AUTO_CAPTURE|PCRE_NO_UTF8_CHECK|PCRE_AUTO_CALLOUT|PCRE_FIRSTLINE| \
583    PCRE_DUPNAMES|PCRE_NEWLINE_BITS|PCRE_BSR_ANYCRLF|PCRE_BSR_UNICODE| \
584    PCRE_JAVASCRIPT_COMPAT|PCRE_UCP)
585
586 #define PUBLIC_EXEC_OPTIONS \
587   (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NOTEMPTY_ATSTART| \
588    PCRE_NO_UTF8_CHECK|PCRE_PARTIAL_HARD|PCRE_PARTIAL_SOFT|PCRE_NEWLINE_BITS| \
589    PCRE_BSR_ANYCRLF|PCRE_BSR_UNICODE|PCRE_NO_START_OPTIMIZE)
590
591 #define PUBLIC_DFA_EXEC_OPTIONS \
592   (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NOTEMPTY_ATSTART| \
593    PCRE_NO_UTF8_CHECK|PCRE_PARTIAL_HARD|PCRE_PARTIAL_SOFT|PCRE_DFA_SHORTEST| \
594    PCRE_DFA_RESTART|PCRE_NEWLINE_BITS|PCRE_BSR_ANYCRLF|PCRE_BSR_UNICODE| \
595    PCRE_NO_START_OPTIMIZE)
596
597 #define PUBLIC_STUDY_OPTIONS 0   /* None defined */
598
599 /* Magic number to provide a small check against being handed junk. Also used
600 to detect whether a pattern was compiled on a host of different endianness. */
601
602 #define MAGIC_NUMBER  0x50435245UL   /* 'PCRE' */
603
604 /* Negative values for the firstchar and reqchar variables */
605
606 #define REQ_UNSET (-2)
607 #define REQ_NONE  (-1)
608
609 /* The maximum remaining length of subject we are prepared to search for a
610 req_byte match. */
611
612 #define REQ_BYTE_MAX 1000
613
614 /* Flags added to firstbyte or reqbyte; a "non-literal" item is either a
615 variable-length repeat, or a anything other than literal characters. */
616
617 #define REQ_CASELESS 0x0100    /* indicates caselessness */
618 #define REQ_VARY     0x0200    /* reqbyte followed non-literal item */
619
620 /* Miscellaneous definitions. The #ifndef is to pacify compiler warnings in
621 environments where these macros are defined elsewhere. Unfortunately, there
622 is no way to do the same for the typedef. */
623
624 typedef int BOOL;
625
626 #ifndef FALSE
627 #define FALSE   0
628 #define TRUE    1
629 #endif
630
631 /* If PCRE is to support UTF-8 on EBCDIC platforms, we cannot use normal
632 character constants like '*' because the compiler would emit their EBCDIC code,
633 which is different from their ASCII/UTF-8 code. Instead we define macros for
634 the characters so that they always use the ASCII/UTF-8 code when UTF-8 support
635 is enabled. When UTF-8 support is not enabled, the definitions use character
636 literals. Both character and string versions of each character are needed, and
637 there are some longer strings as well.
638
639 This means that, on EBCDIC platforms, the PCRE library can handle either
640 EBCDIC, or UTF-8, but not both. To support both in the same compiled library
641 would need different lookups depending on whether PCRE_UTF8 was set or not.
642 This would make it impossible to use characters in switch/case statements,
643 which would reduce performance. For a theoretical use (which nobody has asked
644 for) in a minority area (EBCDIC platforms), this is not sensible. Any
645 application that did need both could compile two versions of the library, using
646 macros to give the functions distinct names. */
647
648 #ifndef SUPPORT_UTF8
649
650 /* UTF-8 support is not enabled; use the platform-dependent character literals
651 so that PCRE works on both ASCII and EBCDIC platforms, in non-UTF-mode only. */
652
653 #define CHAR_HT                     '\t'
654 #define CHAR_VT                     '\v'
655 #define CHAR_FF                     '\f'
656 #define CHAR_CR                     '\r'
657 #define CHAR_NL                     '\n'
658 #define CHAR_BS                     '\b'
659 #define CHAR_BEL                    '\a'
660 #ifdef EBCDIC
661 #define CHAR_ESC                    '\047'
662 #define CHAR_DEL                    '\007'
663 #else
664 #define CHAR_ESC                    '\033'
665 #define CHAR_DEL                    '\177'
666 #endif
667
668 #define CHAR_SPACE                  ' '
669 #define CHAR_EXCLAMATION_MARK       '!'
670 #define CHAR_QUOTATION_MARK         '"'
671 #define CHAR_NUMBER_SIGN            '#'
672 #define CHAR_DOLLAR_SIGN            '$'
673 #define CHAR_PERCENT_SIGN           '%'
674 #define CHAR_AMPERSAND              '&'
675 #define CHAR_APOSTROPHE             '\''
676 #define CHAR_LEFT_PARENTHESIS       '('
677 #define CHAR_RIGHT_PARENTHESIS      ')'
678 #define CHAR_ASTERISK               '*'
679 #define CHAR_PLUS                   '+'
680 #define CHAR_COMMA                  ','
681 #define CHAR_MINUS                  '-'
682 #define CHAR_DOT                    '.'
683 #define CHAR_SLASH                  '/'
684 #define CHAR_0                      '0'
685 #define CHAR_1                      '1'
686 #define CHAR_2                      '2'
687 #define CHAR_3                      '3'
688 #define CHAR_4                      '4'
689 #define CHAR_5                      '5'
690 #define CHAR_6                      '6'
691 #define CHAR_7                      '7'
692 #define CHAR_8                      '8'
693 #define CHAR_9                      '9'
694 #define CHAR_COLON                  ':'
695 #define CHAR_SEMICOLON              ';'
696 #define CHAR_LESS_THAN_SIGN         '<'
697 #define CHAR_EQUALS_SIGN            '='
698 #define CHAR_GREATER_THAN_SIGN      '>'
699 #define CHAR_QUESTION_MARK          '?'
700 #define CHAR_COMMERCIAL_AT          '@'
701 #define CHAR_A                      'A'
702 #define CHAR_B                      'B'
703 #define CHAR_C                      'C'
704 #define CHAR_D                      'D'
705 #define CHAR_E                      'E'
706 #define CHAR_F                      'F'
707 #define CHAR_G                      'G'
708 #define CHAR_H                      'H'
709 #define CHAR_I                      'I'
710 #define CHAR_J                      'J'
711 #define CHAR_K                      'K'
712 #define CHAR_L                      'L'
713 #define CHAR_M                      'M'
714 #define CHAR_N                      'N'
715 #define CHAR_O                      'O'
716 #define CHAR_P                      'P'
717 #define CHAR_Q                      'Q'
718 #define CHAR_R                      'R'
719 #define CHAR_S                      'S'
720 #define CHAR_T                      'T'
721 #define CHAR_U                      'U'
722 #define CHAR_V                      'V'
723 #define CHAR_W                      'W'
724 #define CHAR_X                      'X'
725 #define CHAR_Y                      'Y'
726 #define CHAR_Z                      'Z'
727 #define CHAR_LEFT_SQUARE_BRACKET    '['
728 #define CHAR_BACKSLASH              '\\'
729 #define CHAR_RIGHT_SQUARE_BRACKET   ']'
730 #define CHAR_CIRCUMFLEX_ACCENT      '^'
731 #define CHAR_UNDERSCORE             '_'
732 #define CHAR_GRAVE_ACCENT           '`'
733 #define CHAR_a                      'a'
734 #define CHAR_b                      'b'
735 #define CHAR_c                      'c'
736 #define CHAR_d                      'd'
737 #define CHAR_e                      'e'
738 #define CHAR_f                      'f'
739 #define CHAR_g                      'g'
740 #define CHAR_h                      'h'
741 #define CHAR_i                      'i'
742 #define CHAR_j                      'j'
743 #define CHAR_k                      'k'
744 #define CHAR_l                      'l'
745 #define CHAR_m                      'm'
746 #define CHAR_n                      'n'
747 #define CHAR_o                      'o'
748 #define CHAR_p                      'p'
749 #define CHAR_q                      'q'
750 #define CHAR_r                      'r'
751 #define CHAR_s                      's'
752 #define CHAR_t                      't'
753 #define CHAR_u                      'u'
754 #define CHAR_v                      'v'
755 #define CHAR_w                      'w'
756 #define CHAR_x                      'x'
757 #define CHAR_y                      'y'
758 #define CHAR_z                      'z'
759 #define CHAR_LEFT_CURLY_BRACKET     '{'
760 #define CHAR_VERTICAL_LINE          '|'
761 #define CHAR_RIGHT_CURLY_BRACKET    '}'
762 #define CHAR_TILDE                  '~'
763
764 #define STR_HT                      "\t"
765 #define STR_VT                      "\v"
766 #define STR_FF                      "\f"
767 #define STR_CR                      "\r"
768 #define STR_NL                      "\n"
769 #define STR_BS                      "\b"
770 #define STR_BEL                     "\a"
771 #ifdef EBCDIC
772 #define STR_ESC                     "\047"
773 #define STR_DEL                     "\007"
774 #else
775 #define STR_ESC                     "\033"
776 #define STR_DEL                     "\177"
777 #endif
778
779 #define STR_SPACE                   " "
780 #define STR_EXCLAMATION_MARK        "!"
781 #define STR_QUOTATION_MARK          "\""
782 #define STR_NUMBER_SIGN             "#"
783 #define STR_DOLLAR_SIGN             "$"
784 #define STR_PERCENT_SIGN            "%"
785 #define STR_AMPERSAND               "&"
786 #define STR_APOSTROPHE              "'"
787 #define STR_LEFT_PARENTHESIS        "("
788 #define STR_RIGHT_PARENTHESIS       ")"
789 #define STR_ASTERISK                "*"
790 #define STR_PLUS                    "+"
791 #define STR_COMMA                   ","
792 #define STR_MINUS                   "-"
793 #define STR_DOT                     "."
794 #define STR_SLASH                   "/"
795 #define STR_0                       "0"
796 #define STR_1                       "1"
797 #define STR_2                       "2"
798 #define STR_3                       "3"
799 #define STR_4                       "4"
800 #define STR_5                       "5"
801 #define STR_6                       "6"
802 #define STR_7                       "7"
803 #define STR_8                       "8"
804 #define STR_9                       "9"
805 #define STR_COLON                   ":"
806 #define STR_SEMICOLON               ";"
807 #define STR_LESS_THAN_SIGN          "<"
808 #define STR_EQUALS_SIGN             "="
809 #define STR_GREATER_THAN_SIGN       ">"
810 #define STR_QUESTION_MARK           "?"
811 #define STR_COMMERCIAL_AT           "@"
812 #define STR_A                       "A"
813 #define STR_B                       "B"
814 #define STR_C                       "C"
815 #define STR_D                       "D"
816 #define STR_E                       "E"
817 #define STR_F                       "F"
818 #define STR_G                       "G"
819 #define STR_H                       "H"
820 #define STR_I                       "I"
821 #define STR_J                       "J"
822 #define STR_K                       "K"
823 #define STR_L                       "L"
824 #define STR_M                       "M"
825 #define STR_N                       "N"
826 #define STR_O                       "O"
827 #define STR_P                       "P"
828 #define STR_Q                       "Q"
829 #define STR_R                       "R"
830 #define STR_S                       "S"
831 #define STR_T                       "T"
832 #define STR_U                       "U"
833 #define STR_V                       "V"
834 #define STR_W                       "W"
835 #define STR_X                       "X"
836 #define STR_Y                       "Y"
837 #define STR_Z                       "Z"
838 #define STR_LEFT_SQUARE_BRACKET     "["
839 #define STR_BACKSLASH               "\\"
840 #define STR_RIGHT_SQUARE_BRACKET    "]"
841 #define STR_CIRCUMFLEX_ACCENT       "^"
842 #define STR_UNDERSCORE              "_"
843 #define STR_GRAVE_ACCENT            "`"
844 #define STR_a                       "a"
845 #define STR_b                       "b"
846 #define STR_c                       "c"
847 #define STR_d                       "d"
848 #define STR_e                       "e"
849 #define STR_f                       "f"
850 #define STR_g                       "g"
851 #define STR_h                       "h"
852 #define STR_i                       "i"
853 #define STR_j                       "j"
854 #define STR_k                       "k"
855 #define STR_l                       "l"
856 #define STR_m                       "m"
857 #define STR_n                       "n"
858 #define STR_o                       "o"
859 #define STR_p                       "p"
860 #define STR_q                       "q"
861 #define STR_r                       "r"
862 #define STR_s                       "s"
863 #define STR_t                       "t"
864 #define STR_u                       "u"
865 #define STR_v                       "v"
866 #define STR_w                       "w"
867 #define STR_x                       "x"
868 #define STR_y                       "y"
869 #define STR_z                       "z"
870 #define STR_LEFT_CURLY_BRACKET      "{"
871 #define STR_VERTICAL_LINE           "|"
872 #define STR_RIGHT_CURLY_BRACKET     "}"
873 #define STR_TILDE                   "~"
874
875 #define STRING_ACCEPT0              "ACCEPT\0"
876 #define STRING_COMMIT0              "COMMIT\0"
877 #define STRING_F0                   "F\0"
878 #define STRING_FAIL0                "FAIL\0"
879 #define STRING_MARK0                "MARK\0"
880 #define STRING_PRUNE0               "PRUNE\0"
881 #define STRING_SKIP0                "SKIP\0"
882 #define STRING_THEN                 "THEN"
883
884 #define STRING_alpha0               "alpha\0"
885 #define STRING_lower0               "lower\0"
886 #define STRING_upper0               "upper\0"
887 #define STRING_alnum0               "alnum\0"
888 #define STRING_ascii0               "ascii\0"
889 #define STRING_blank0               "blank\0"
890 #define STRING_cntrl0               "cntrl\0"
891 #define STRING_digit0               "digit\0"
892 #define STRING_graph0               "graph\0"
893 #define STRING_print0               "print\0"
894 #define STRING_punct0               "punct\0"
895 #define STRING_space0               "space\0"
896 #define STRING_word0                "word\0"
897 #define STRING_xdigit               "xdigit"
898
899 #define STRING_DEFINE               "DEFINE"
900
901 #define STRING_CR_RIGHTPAR          "CR)"
902 #define STRING_LF_RIGHTPAR          "LF)"
903 #define STRING_CRLF_RIGHTPAR        "CRLF)"
904 #define STRING_ANY_RIGHTPAR         "ANY)"
905 #define STRING_ANYCRLF_RIGHTPAR     "ANYCRLF)"
906 #define STRING_BSR_ANYCRLF_RIGHTPAR "BSR_ANYCRLF)"
907 #define STRING_BSR_UNICODE_RIGHTPAR "BSR_UNICODE)"
908 #define STRING_UTF8_RIGHTPAR        "UTF8)"
909 #define STRING_UCP_RIGHTPAR         "UCP)"
910
911 #else  /* SUPPORT_UTF8 */
912
913 /* UTF-8 support is enabled; always use UTF-8 (=ASCII) character codes. This
914 works in both modes non-EBCDIC platforms, and on EBCDIC platforms in UTF-8 mode
915 only. */
916
917 #define CHAR_HT                     '\011'
918 #define CHAR_VT                     '\013'
919 #define CHAR_FF                     '\014'
920 #define CHAR_CR                     '\015'
921 #define CHAR_NL                     '\012'
922 #define CHAR_BS                     '\010'
923 #define CHAR_BEL                    '\007'
924 #define CHAR_ESC                    '\033'
925 #define CHAR_DEL                    '\177'
926
927 #define CHAR_SPACE                  '\040'
928 #define CHAR_EXCLAMATION_MARK       '\041'
929 #define CHAR_QUOTATION_MARK         '\042'
930 #define CHAR_NUMBER_SIGN            '\043'
931 #define CHAR_DOLLAR_SIGN            '\044'
932 #define CHAR_PERCENT_SIGN           '\045'
933 #define CHAR_AMPERSAND              '\046'
934 #define CHAR_APOSTROPHE             '\047'
935 #define CHAR_LEFT_PARENTHESIS       '\050'
936 #define CHAR_RIGHT_PARENTHESIS      '\051'
937 #define CHAR_ASTERISK               '\052'
938 #define CHAR_PLUS                   '\053'
939 #define CHAR_COMMA                  '\054'
940 #define CHAR_MINUS                  '\055'
941 #define CHAR_DOT                    '\056'
942 #define CHAR_SLASH                  '\057'
943 #define CHAR_0                      '\060'
944 #define CHAR_1                      '\061'
945 #define CHAR_2                      '\062'
946 #define CHAR_3                      '\063'
947 #define CHAR_4                      '\064'
948 #define CHAR_5                      '\065'
949 #define CHAR_6                      '\066'
950 #define CHAR_7                      '\067'
951 #define CHAR_8                      '\070'
952 #define CHAR_9                      '\071'
953 #define CHAR_COLON                  '\072'
954 #define CHAR_SEMICOLON              '\073'
955 #define CHAR_LESS_THAN_SIGN         '\074'
956 #define CHAR_EQUALS_SIGN            '\075'
957 #define CHAR_GREATER_THAN_SIGN      '\076'
958 #define CHAR_QUESTION_MARK          '\077'
959 #define CHAR_COMMERCIAL_AT          '\100'
960 #define CHAR_A                      '\101'
961 #define CHAR_B                      '\102'
962 #define CHAR_C                      '\103'
963 #define CHAR_D                      '\104'
964 #define CHAR_E                      '\105'
965 #define CHAR_F                      '\106'
966 #define CHAR_G                      '\107'
967 #define CHAR_H                      '\110'
968 #define CHAR_I                      '\111'
969 #define CHAR_J                      '\112'
970 #define CHAR_K                      '\113'
971 #define CHAR_L                      '\114'
972 #define CHAR_M                      '\115'
973 #define CHAR_N                      '\116'
974 #define CHAR_O                      '\117'
975 #define CHAR_P                      '\120'
976 #define CHAR_Q                      '\121'
977 #define CHAR_R                      '\122'
978 #define CHAR_S                      '\123'
979 #define CHAR_T                      '\124'
980 #define CHAR_U                      '\125'
981 #define CHAR_V                      '\126'
982 #define CHAR_W                      '\127'
983 #define CHAR_X                      '\130'
984 #define CHAR_Y                      '\131'
985 #define CHAR_Z                      '\132'
986 #define CHAR_LEFT_SQUARE_BRACKET    '\133'
987 #define CHAR_BACKSLASH              '\134'
988 #define CHAR_RIGHT_SQUARE_BRACKET   '\135'
989 #define CHAR_CIRCUMFLEX_ACCENT      '\136'
990 #define CHAR_UNDERSCORE             '\137'
991 #define CHAR_GRAVE_ACCENT           '\140'
992 #define CHAR_a                      '\141'
993 #define CHAR_b                      '\142'
994 #define CHAR_c                      '\143'
995 #define CHAR_d                      '\144'
996 #define CHAR_e                      '\145'
997 #define CHAR_f                      '\146'
998 #define CHAR_g                      '\147'
999 #define CHAR_h                      '\150'
1000 #define CHAR_i                      '\151'
1001 #define CHAR_j                      '\152'
1002 #define CHAR_k                      '\153'
1003 #define CHAR_l                      '\154'
1004 #define CHAR_m                      '\155'
1005 #define CHAR_n                      '\156'
1006 #define CHAR_o                      '\157'
1007 #define CHAR_p                      '\160'
1008 #define CHAR_q                      '\161'
1009 #define CHAR_r                      '\162'
1010 #define CHAR_s                      '\163'
1011 #define CHAR_t                      '\164'
1012 #define CHAR_u                      '\165'
1013 #define CHAR_v                      '\166'
1014 #define CHAR_w                      '\167'
1015 #define CHAR_x                      '\170'
1016 #define CHAR_y                      '\171'
1017 #define CHAR_z                      '\172'
1018 #define CHAR_LEFT_CURLY_BRACKET     '\173'
1019 #define CHAR_VERTICAL_LINE          '\174'
1020 #define CHAR_RIGHT_CURLY_BRACKET    '\175'
1021 #define CHAR_TILDE                  '\176'
1022
1023 #define STR_HT                      "\011"
1024 #define STR_VT                      "\013"
1025 #define STR_FF                      "\014"
1026 #define STR_CR                      "\015"
1027 #define STR_NL                      "\012"
1028 #define STR_BS                      "\010"
1029 #define STR_BEL                     "\007"
1030 #define STR_ESC                     "\033"
1031 #define STR_DEL                     "\177"
1032
1033 #define STR_SPACE                   "\040"
1034 #define STR_EXCLAMATION_MARK        "\041"
1035 #define STR_QUOTATION_MARK          "\042"
1036 #define STR_NUMBER_SIGN             "\043"
1037 #define STR_DOLLAR_SIGN             "\044"
1038 #define STR_PERCENT_SIGN            "\045"
1039 #define STR_AMPERSAND               "\046"
1040 #define STR_APOSTROPHE              "\047"
1041 #define STR_LEFT_PARENTHESIS        "\050"
1042 #define STR_RIGHT_PARENTHESIS       "\051"
1043 #define STR_ASTERISK                "\052"
1044 #define STR_PLUS                    "\053"
1045 #define STR_COMMA                   "\054"
1046 #define STR_MINUS                   "\055"
1047 #define STR_DOT                     "\056"
1048 #define STR_SLASH                   "\057"
1049 #define STR_0                       "\060"
1050 #define STR_1                       "\061"
1051 #define STR_2                       "\062"
1052 #define STR_3                       "\063"
1053 #define STR_4                       "\064"
1054 #define STR_5                       "\065"
1055 #define STR_6                       "\066"
1056 #define STR_7                       "\067"
1057 #define STR_8                       "\070"
1058 #define STR_9                       "\071"
1059 #define STR_COLON                   "\072"
1060 #define STR_SEMICOLON               "\073"
1061 #define STR_LESS_THAN_SIGN          "\074"
1062 #define STR_EQUALS_SIGN             "\075"
1063 #define STR_GREATER_THAN_SIGN       "\076"
1064 #define STR_QUESTION_MARK           "\077"
1065 #define STR_COMMERCIAL_AT           "\100"
1066 #define STR_A                       "\101"
1067 #define STR_B                       "\102"
1068 #define STR_C                       "\103"
1069 #define STR_D                       "\104"
1070 #define STR_E                       "\105"
1071 #define STR_F                       "\106"
1072 #define STR_G                       "\107"
1073 #define STR_H                       "\110"
1074 #define STR_I                       "\111"
1075 #define STR_J                       "\112"
1076 #define STR_K                       "\113"
1077 #define STR_L                       "\114"
1078 #define STR_M                       "\115"
1079 #define STR_N                       "\116"
1080 #define STR_O                       "\117"
1081 #define STR_P                       "\120"
1082 #define STR_Q                       "\121"
1083 #define STR_R                       "\122"
1084 #define STR_S                       "\123"
1085 #define STR_T                       "\124"
1086 #define STR_U                       "\125"
1087 #define STR_V                       "\126"
1088 #define STR_W                       "\127"
1089 #define STR_X                       "\130"
1090 #define STR_Y                       "\131"
1091 #define STR_Z                       "\132"
1092 #define STR_LEFT_SQUARE_BRACKET     "\133"
1093 #define STR_BACKSLASH               "\134"
1094 #define STR_RIGHT_SQUARE_BRACKET    "\135"
1095 #define STR_CIRCUMFLEX_ACCENT       "\136"
1096 #define STR_UNDERSCORE              "\137"
1097 #define STR_GRAVE_ACCENT            "\140"
1098 #define STR_a                       "\141"
1099 #define STR_b                       "\142"
1100 #define STR_c                       "\143"
1101 #define STR_d                       "\144"
1102 #define STR_e                       "\145"
1103 #define STR_f                       "\146"
1104 #define STR_g                       "\147"
1105 #define STR_h                       "\150"
1106 #define STR_i                       "\151"
1107 #define STR_j                       "\152"
1108 #define STR_k                       "\153"
1109 #define STR_l                       "\154"
1110 #define STR_m                       "\155"
1111 #define STR_n                       "\156"
1112 #define STR_o                       "\157"
1113 #define STR_p                       "\160"
1114 #define STR_q                       "\161"
1115 #define STR_r                       "\162"
1116 #define STR_s                       "\163"
1117 #define STR_t                       "\164"
1118 #define STR_u                       "\165"
1119 #define STR_v                       "\166"
1120 #define STR_w                       "\167"
1121 #define STR_x                       "\170"
1122 #define STR_y                       "\171"
1123 #define STR_z                       "\172"
1124 #define STR_LEFT_CURLY_BRACKET      "\173"
1125 #define STR_VERTICAL_LINE           "\174"
1126 #define STR_RIGHT_CURLY_BRACKET     "\175"
1127 #define STR_TILDE                   "\176"
1128
1129 #define STRING_ACCEPT0              STR_A STR_C STR_C STR_E STR_P STR_T "\0"
1130 #define STRING_COMMIT0              STR_C STR_O STR_M STR_M STR_I STR_T "\0"
1131 #define STRING_F0                   STR_F "\0"
1132 #define STRING_FAIL0                STR_F STR_A STR_I STR_L "\0"
1133 #define STRING_MARK0                STR_M STR_A STR_R STR_K "\0"
1134 #define STRING_PRUNE0               STR_P STR_R STR_U STR_N STR_E "\0"
1135 #define STRING_SKIP0                STR_S STR_K STR_I STR_P "\0"
1136 #define STRING_THEN                 STR_T STR_H STR_E STR_N
1137
1138 #define STRING_alpha0               STR_a STR_l STR_p STR_h STR_a "\0"
1139 #define STRING_lower0               STR_l STR_o STR_w STR_e STR_r "\0"
1140 #define STRING_upper0               STR_u STR_p STR_p STR_e STR_r "\0"
1141 #define STRING_alnum0               STR_a STR_l STR_n STR_u STR_m "\0"
1142 #define STRING_ascii0               STR_a STR_s STR_c STR_i STR_i "\0"
1143 #define STRING_blank0               STR_b STR_l STR_a STR_n STR_k "\0"
1144 #define STRING_cntrl0               STR_c STR_n STR_t STR_r STR_l "\0"
1145 #define STRING_digit0               STR_d STR_i STR_g STR_i STR_t "\0"
1146 #define STRING_graph0               STR_g STR_r STR_a STR_p STR_h "\0"
1147 #define STRING_print0               STR_p STR_r STR_i STR_n STR_t "\0"
1148 #define STRING_punct0               STR_p STR_u STR_n STR_c STR_t "\0"
1149 #define STRING_space0               STR_s STR_p STR_a STR_c STR_e "\0"
1150 #define STRING_word0                STR_w STR_o STR_r STR_d       "\0"
1151 #define STRING_xdigit               STR_x STR_d STR_i STR_g STR_i STR_t
1152
1153 #define STRING_DEFINE               STR_D STR_E STR_F STR_I STR_N STR_E
1154
1155 #define STRING_CR_RIGHTPAR          STR_C STR_R STR_RIGHT_PARENTHESIS
1156 #define STRING_LF_RIGHTPAR          STR_L STR_F STR_RIGHT_PARENTHESIS
1157 #define STRING_CRLF_RIGHTPAR        STR_C STR_R STR_L STR_F STR_RIGHT_PARENTHESIS
1158 #define STRING_ANY_RIGHTPAR         STR_A STR_N STR_Y STR_RIGHT_PARENTHESIS
1159 #define STRING_ANYCRLF_RIGHTPAR     STR_A STR_N STR_Y STR_C STR_R STR_L STR_F STR_RIGHT_PARENTHESIS
1160 #define STRING_BSR_ANYCRLF_RIGHTPAR STR_B STR_S STR_R STR_UNDERSCORE STR_A STR_N STR_Y STR_C STR_R STR_L STR_F STR_RIGHT_PARENTHESIS
1161 #define STRING_BSR_UNICODE_RIGHTPAR STR_B STR_S STR_R STR_UNDERSCORE STR_U STR_N STR_I STR_C STR_O STR_D STR_E STR_RIGHT_PARENTHESIS
1162 #define STRING_UTF8_RIGHTPAR        STR_U STR_T STR_F STR_8 STR_RIGHT_PARENTHESIS
1163 #define STRING_UCP_RIGHTPAR         STR_U STR_C STR_P STR_RIGHT_PARENTHESIS
1164
1165 #endif  /* SUPPORT_UTF8 */
1166
1167 /* Escape items that are just an encoding of a particular data value. */
1168
1169 #ifndef ESC_e
1170 #define ESC_e CHAR_ESC
1171 #endif
1172
1173 #ifndef ESC_f
1174 #define ESC_f CHAR_FF
1175 #endif
1176
1177 #ifndef ESC_n
1178 #define ESC_n CHAR_NL
1179 #endif
1180
1181 #ifndef ESC_r
1182 #define ESC_r CHAR_CR
1183 #endif
1184
1185 /* We can't officially use ESC_t because it is a POSIX reserved identifier
1186 (presumably because of all the others like size_t). */
1187
1188 #ifndef ESC_tee
1189 #define ESC_tee CHAR_HT
1190 #endif
1191
1192 /* Codes for different types of Unicode property */
1193
1194 #define PT_ANY        0    /* Any property - matches all chars */
1195 #define PT_LAMP       1    /* L& - the union of Lu, Ll, Lt */
1196 #define PT_GC         2    /* Specified general characteristic (e.g. L) */
1197 #define PT_PC         3    /* Specified particular characteristic (e.g. Lu) */
1198 #define PT_SC         4    /* Script (e.g. Han) */
1199 #define PT_ALNUM      5    /* Alphanumeric - the union of L and N */
1200 #define PT_SPACE      6    /* Perl space - Z plus 9,10,12,13 */
1201 #define PT_PXSPACE    7    /* POSIX space - Z plus 9,10,11,12,13 */
1202 #define PT_WORD       8    /* Word - L plus N plus underscore */
1203
1204 /* Flag bits and data types for the extended class (OP_XCLASS) for classes that
1205 contain UTF-8 characters with values greater than 255. */
1206
1207 #define XCL_NOT    0x01    /* Flag: this is a negative class */
1208 #define XCL_MAP    0x02    /* Flag: a 32-byte map is present */
1209
1210 #define XCL_END       0    /* Marks end of individual items */
1211 #define XCL_SINGLE    1    /* Single item (one multibyte char) follows */
1212 #define XCL_RANGE     2    /* A range (two multibyte chars) follows */
1213 #define XCL_PROP      3    /* Unicode property (2-byte property code follows) */
1214 #define XCL_NOTPROP   4    /* Unicode inverted property (ditto) */
1215
1216 /* These are escaped items that aren't just an encoding of a particular data
1217 value such as \n. They must have non-zero values, as check_escape() returns
1218 their negation. Also, they must appear in the same order as in the opcode
1219 definitions below, up to ESC_z. There's a dummy for OP_ALLANY because it
1220 corresponds to "." in DOTALL mode rather than an escape sequence. It is also
1221 used for [^] in JavaScript compatibility mode. In non-DOTALL mode, "." behaves
1222 like \N.
1223
1224 The special values ESC_DU, ESC_du, etc. are used instead of ESC_D, ESC_d, etc.
1225 when PCRE_UCP is set, when replacement of \d etc by \p sequences is required.
1226 They must be contiguous, and remain in order so that the replacements can be
1227 looked up from a table.
1228
1229 The final escape must be ESC_REF as subsequent values are used for
1230 backreferences (\1, \2, \3, etc). There are two tests in the code for an escape
1231 greater than ESC_b and less than ESC_Z to detect the types that may be
1232 repeated. These are the types that consume characters. If any new escapes are
1233 put in between that don't consume a character, that code will have to change.
1234 */
1235
1236 enum { ESC_A = 1, ESC_G, ESC_K, ESC_B, ESC_b, ESC_D, ESC_d, ESC_S, ESC_s,
1237        ESC_W, ESC_w, ESC_N, ESC_dum, ESC_C, ESC_P, ESC_p, ESC_R, ESC_H,
1238        ESC_h, ESC_V, ESC_v, ESC_X, ESC_Z, ESC_z,
1239        ESC_E, ESC_Q, ESC_g, ESC_k,
1240        ESC_DU, ESC_du, ESC_SU, ESC_su, ESC_WU, ESC_wu,
1241        ESC_REF };
1242
1243 /* Opcode table: Starting from 1 (i.e. after OP_END), the values up to
1244 OP_EOD must correspond in order to the list of escapes immediately above.
1245
1246 *** NOTE NOTE NOTE *** Whenever this list is updated, the two macro definitions
1247 that follow must also be updated to match. There are also tables called
1248 "coptable" and "poptable" in pcre_dfa_exec.c that must be updated. */
1249
1250 enum {
1251   OP_END,            /* 0 End of pattern */
1252
1253   /* Values corresponding to backslashed metacharacters */
1254
1255   OP_SOD,            /* 1 Start of data: \A */
1256   OP_SOM,            /* 2 Start of match (subject + offset): \G */
1257   OP_SET_SOM,        /* 3 Set start of match (\K) */
1258   OP_NOT_WORD_BOUNDARY,  /*  4 \B */
1259   OP_WORD_BOUNDARY,      /*  5 \b */
1260   OP_NOT_DIGIT,          /*  6 \D */
1261   OP_DIGIT,              /*  7 \d */
1262   OP_NOT_WHITESPACE,     /*  8 \S */
1263   OP_WHITESPACE,         /*  9 \s */
1264   OP_NOT_WORDCHAR,       /* 10 \W */
1265   OP_WORDCHAR,           /* 11 \w */
1266   OP_ANY,            /* 12 Match any character except newline */
1267   OP_ALLANY,         /* 13 Match any character */
1268   OP_ANYBYTE,        /* 14 Match any byte (\C); different to OP_ANY for UTF-8 */
1269   OP_NOTPROP,        /* 15 \P (not Unicode property) */
1270   OP_PROP,           /* 16 \p (Unicode property) */
1271   OP_ANYNL,          /* 17 \R (any newline sequence) */
1272   OP_NOT_HSPACE,     /* 18 \H (not horizontal whitespace) */
1273   OP_HSPACE,         /* 19 \h (horizontal whitespace) */
1274   OP_NOT_VSPACE,     /* 20 \V (not vertical whitespace) */
1275   OP_VSPACE,         /* 21 \v (vertical whitespace) */
1276   OP_EXTUNI,         /* 22 \X (extended Unicode sequence */
1277   OP_EODN,           /* 23 End of data or \n at end of data: \Z. */
1278   OP_EOD,            /* 24 End of data: \z */
1279
1280   OP_OPT,            /* 25 Set runtime options */
1281   OP_CIRC,           /* 26 Start of line - varies with multiline switch */
1282   OP_DOLL,           /* 27 End of line - varies with multiline switch */
1283   OP_CHAR,           /* 28 Match one character, casefully */
1284   OP_CHARNC,         /* 29 Match one character, caselessly */
1285   OP_NOT,            /* 30 Match one character, not the following one */
1286
1287   OP_STAR,           /* 31 The maximizing and minimizing versions of */
1288   OP_MINSTAR,        /* 32 these six opcodes must come in pairs, with */
1289   OP_PLUS,           /* 33 the minimizing one second. */
1290   OP_MINPLUS,        /* 34 This first set applies to single characters.*/
1291   OP_QUERY,          /* 35 */
1292   OP_MINQUERY,       /* 36 */
1293
1294   OP_UPTO,           /* 37 From 0 to n matches */
1295   OP_MINUPTO,        /* 38 */
1296   OP_EXACT,          /* 39 Exactly n matches */
1297
1298   OP_POSSTAR,        /* 40 Possessified star */
1299   OP_POSPLUS,        /* 41 Possessified plus */
1300   OP_POSQUERY,       /* 42 Posesssified query */
1301   OP_POSUPTO,        /* 43 Possessified upto */
1302
1303   OP_NOTSTAR,        /* 44 The maximizing and minimizing versions of */
1304   OP_NOTMINSTAR,     /* 45 these six opcodes must come in pairs, with */
1305   OP_NOTPLUS,        /* 46 the minimizing one second. They must be in */
1306   OP_NOTMINPLUS,     /* 47 exactly the same order as those above. */
1307   OP_NOTQUERY,       /* 48 This set applies to "not" single characters. */
1308   OP_NOTMINQUERY,    /* 49 */
1309
1310   OP_NOTUPTO,        /* 50 From 0 to n matches */
1311   OP_NOTMINUPTO,     /* 51 */
1312   OP_NOTEXACT,       /* 52 Exactly n matches */
1313
1314   OP_NOTPOSSTAR,     /* 53 Possessified versions */
1315   OP_NOTPOSPLUS,     /* 54 */
1316   OP_NOTPOSQUERY,    /* 55 */
1317   OP_NOTPOSUPTO,     /* 56 */
1318
1319   OP_TYPESTAR,       /* 57 The maximizing and minimizing versions of */
1320   OP_TYPEMINSTAR,    /* 58 these six opcodes must come in pairs, with */
1321   OP_TYPEPLUS,       /* 59 the minimizing one second. These codes must */
1322   OP_TYPEMINPLUS,    /* 60 be in exactly the same order as those above. */
1323   OP_TYPEQUERY,      /* 61 This set applies to character types such as \d */
1324   OP_TYPEMINQUERY,   /* 62 */
1325
1326   OP_TYPEUPTO,       /* 63 From 0 to n matches */
1327   OP_TYPEMINUPTO,    /* 64 */
1328   OP_TYPEEXACT,      /* 65 Exactly n matches */
1329
1330   OP_TYPEPOSSTAR,    /* 66 Possessified versions */
1331   OP_TYPEPOSPLUS,    /* 67 */
1332   OP_TYPEPOSQUERY,   /* 68 */
1333   OP_TYPEPOSUPTO,    /* 69 */
1334
1335   OP_CRSTAR,         /* 70 The maximizing and minimizing versions of */
1336   OP_CRMINSTAR,      /* 71 all these opcodes must come in pairs, with */
1337   OP_CRPLUS,         /* 72 the minimizing one second. These codes must */
1338   OP_CRMINPLUS,      /* 73 be in exactly the same order as those above. */
1339   OP_CRQUERY,        /* 74 These are for character classes and back refs */
1340   OP_CRMINQUERY,     /* 75 */
1341   OP_CRRANGE,        /* 76 These are different to the three sets above. */
1342   OP_CRMINRANGE,     /* 77 */
1343
1344   OP_CLASS,          /* 78 Match a character class, chars < 256 only */
1345   OP_NCLASS,         /* 79 Same, but the bitmap was created from a negative
1346                            class - the difference is relevant only when a UTF-8
1347                            character > 255 is encountered. */
1348
1349   OP_XCLASS,         /* 80 Extended class for handling UTF-8 chars within the
1350                            class. This does both positive and negative. */
1351
1352   OP_REF,            /* 81 Match a back reference */
1353   OP_RECURSE,        /* 82 Match a numbered subpattern (possibly recursive) */
1354   OP_CALLOUT,        /* 83 Call out to external function if provided */
1355
1356   OP_ALT,            /* 84 Start of alternation */
1357   OP_KET,            /* 85 End of group that doesn't have an unbounded repeat */
1358   OP_KETRMAX,        /* 86 These two must remain together and in this */
1359   OP_KETRMIN,        /* 87 order. They are for groups the repeat for ever. */
1360
1361   /* The assertions must come before BRA, CBRA, ONCE, and COND.*/
1362
1363   OP_ASSERT,         /* 88 Positive lookahead */
1364   OP_ASSERT_NOT,     /* 89 Negative lookahead */
1365   OP_ASSERTBACK,     /* 90 Positive lookbehind */
1366   OP_ASSERTBACK_NOT, /* 91 Negative lookbehind */
1367   OP_REVERSE,        /* 92 Move pointer back - used in lookbehind assertions */
1368
1369   /* ONCE, BRA, CBRA, and COND must come after the assertions, with ONCE first,
1370   as there's a test for >= ONCE for a subpattern that isn't an assertion. */
1371
1372   OP_ONCE,           /* 93 Atomic group */
1373   OP_BRA,            /* 94 Start of non-capturing bracket */
1374   OP_CBRA,           /* 95 Start of capturing bracket */
1375   OP_COND,           /* 96 Conditional group */
1376
1377   /* These three must follow the previous three, in the same order. There's a
1378   check for >= SBRA to distinguish the two sets. */
1379
1380   OP_SBRA,           /* 97 Start of non-capturing bracket, check empty  */
1381   OP_SCBRA,          /* 98 Start of capturing bracket, check empty */
1382   OP_SCOND,          /* 99 Conditional group, check empty */
1383
1384   /* The next two pairs must (respectively) be kept together. */
1385
1386   OP_CREF,           /* 100 Used to hold a capture number as condition */
1387   OP_NCREF,          /* 101 Same, but generaged by a name reference*/
1388   OP_RREF,           /* 102 Used to hold a recursion number as condition */
1389   OP_NRREF,          /* 103 Same, but generaged by a name reference*/
1390   OP_DEF,            /* 104 The DEFINE condition */
1391
1392   OP_BRAZERO,        /* 105 These two must remain together and in this */
1393   OP_BRAMINZERO,     /* 106 order. */
1394
1395   /* These are backtracking control verbs */
1396
1397   OP_MARK,           /* 107 always has an argument */
1398   OP_PRUNE,          /* 108 */
1399   OP_PRUNE_ARG,      /* 109 same, but with argument */
1400   OP_SKIP,           /* 110 */
1401   OP_SKIP_ARG,       /* 111 same, but with argument */
1402   OP_THEN,           /* 112 */
1403   OP_THEN_ARG,       /* 113 same, but with argument */
1404   OP_COMMIT,         /* 114 */
1405
1406   /* These are forced failure and success verbs */
1407
1408   OP_FAIL,           /* 115 */
1409   OP_ACCEPT,         /* 116 */
1410   OP_CLOSE,          /* 117 Used before OP_ACCEPT to close open captures */
1411
1412   /* This is used to skip a subpattern with a {0} quantifier */
1413
1414   OP_SKIPZERO,       /* 118 */
1415
1416   /* This is not an opcode, but is used to check that tables indexed by opcode
1417   are the correct length, in order to catch updating errors - there have been
1418   some in the past. */
1419
1420   OP_TABLE_LENGTH
1421 };
1422
1423 /* *** NOTE NOTE NOTE *** Whenever the list above is updated, the two macro
1424 definitions that follow must also be updated to match. There are also tables
1425 called "coptable" and "poptable" in pcre_dfa_exec.c that must be updated. */
1426
1427
1428 /* This macro defines textual names for all the opcodes. These are used only
1429 for debugging. The macro is referenced only in pcre_printint.c. */
1430
1431 #define OP_NAME_LIST \
1432   "End", "\\A", "\\G", "\\K", "\\B", "\\b", "\\D", "\\d",         \
1433   "\\S", "\\s", "\\W", "\\w", "Any", "AllAny", "Anybyte",         \
1434   "notprop", "prop", "\\R", "\\H", "\\h", "\\V", "\\v",           \
1435   "extuni",  "\\Z", "\\z",                                        \
1436   "Opt", "^", "$", "char", "charnc", "not",                       \
1437   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
1438   "*+","++", "?+", "{",                                           \
1439   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
1440   "*+","++", "?+", "{",                                           \
1441   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
1442   "*+","++", "?+", "{",                                           \
1443   "*", "*?", "+", "+?", "?", "??", "{", "{",                      \
1444   "class", "nclass", "xclass", "Ref", "Recurse", "Callout",       \
1445   "Alt", "Ket", "KetRmax", "KetRmin", "Assert", "Assert not",     \
1446   "AssertB", "AssertB not", "Reverse",                            \
1447   "Once", "Bra", "CBra", "Cond", "SBra", "SCBra", "SCond",        \
1448   "Cond ref", "Cond nref", "Cond rec", "Cond nrec", "Cond def",   \
1449   "Brazero", "Braminzero",                                        \
1450   "*MARK", "*PRUNE", "*PRUNE", "*SKIP", "*SKIP",                  \
1451   "*THEN", "*THEN", "*COMMIT", "*FAIL", "*ACCEPT",                \
1452   "Close", "Skip zero"
1453
1454
1455 /* This macro defines the length of fixed length operations in the compiled
1456 regex. The lengths are used when searching for specific things, and also in the
1457 debugging printing of a compiled regex. We use a macro so that it can be
1458 defined close to the definitions of the opcodes themselves.
1459
1460 As things have been extended, some of these are no longer fixed lenths, but are
1461 minima instead. For example, the length of a single-character repeat may vary
1462 in UTF-8 mode. The code that uses this table must know about such things. */
1463
1464 #define OP_LENGTHS \
1465   1,                             /* End                                    */ \
1466   1, 1, 1, 1, 1,                 /* \A, \G, \K, \B, \b                     */ \
1467   1, 1, 1, 1, 1, 1,              /* \D, \d, \S, \s, \W, \w                 */ \
1468   1, 1, 1,                       /* Any, AllAny, Anybyte                   */ \
1469   3, 3,                          /* \P, \p                                 */ \
1470   1, 1, 1, 1, 1,                 /* \R, \H, \h, \V, \v                     */ \
1471   1,                             /* \X                                     */ \
1472   1, 1, 2, 1, 1,                 /* \Z, \z, Opt, ^, $                      */ \
1473   2,                             /* Char  - the minimum length             */ \
1474   2,                             /* Charnc  - the minimum length           */ \
1475   2,                             /* not                                    */ \
1476   /* Positive single-char repeats                            ** These are  */ \
1477   2, 2, 2, 2, 2, 2,              /* *, *?, +, +?, ?, ??      ** minima in  */ \
1478   4, 4, 4,                       /* upto, minupto, exact     ** UTF-8 mode */ \
1479   2, 2, 2, 4,                    /* *+, ++, ?+, upto+                      */ \
1480   /* Negative single-char repeats - only for chars < 256                   */ \
1481   2, 2, 2, 2, 2, 2,              /* NOT *, *?, +, +?, ?, ??                */ \
1482   4, 4, 4,                       /* NOT upto, minupto, exact               */ \
1483   2, 2, 2, 4,                    /* Possessive *, +, ?, upto               */ \
1484   /* Positive type repeats                                                 */ \
1485   2, 2, 2, 2, 2, 2,              /* Type *, *?, +, +?, ?, ??               */ \
1486   4, 4, 4,                       /* Type upto, minupto, exact              */ \
1487   2, 2, 2, 4,                    /* Possessive *+, ++, ?+, upto+           */ \
1488   /* Character class & ref repeats                                         */ \
1489   1, 1, 1, 1, 1, 1,              /* *, *?, +, +?, ?, ??                    */ \
1490   5, 5,                          /* CRRANGE, CRMINRANGE                    */ \
1491  33,                             /* CLASS                                  */ \
1492  33,                             /* NCLASS                                 */ \
1493   0,                             /* XCLASS - variable length               */ \
1494   3,                             /* REF                                    */ \
1495   1+LINK_SIZE,                   /* RECURSE                                */ \
1496   2+2*LINK_SIZE,                 /* CALLOUT                                */ \
1497   1+LINK_SIZE,                   /* Alt                                    */ \
1498   1+LINK_SIZE,                   /* Ket                                    */ \
1499   1+LINK_SIZE,                   /* KetRmax                                */ \
1500   1+LINK_SIZE,                   /* KetRmin                                */ \
1501   1+LINK_SIZE,                   /* Assert                                 */ \
1502   1+LINK_SIZE,                   /* Assert not                             */ \
1503   1+LINK_SIZE,                   /* Assert behind                          */ \
1504   1+LINK_SIZE,                   /* Assert behind not                      */ \
1505   1+LINK_SIZE,                   /* Reverse                                */ \
1506   1+LINK_SIZE,                   /* ONCE                                   */ \
1507   1+LINK_SIZE,                   /* BRA                                    */ \
1508   3+LINK_SIZE,                   /* CBRA                                   */ \
1509   1+LINK_SIZE,                   /* COND                                   */ \
1510   1+LINK_SIZE,                   /* SBRA                                   */ \
1511   3+LINK_SIZE,                   /* SCBRA                                  */ \
1512   1+LINK_SIZE,                   /* SCOND                                  */ \
1513   3, 3,                          /* CREF, NCREF                            */ \
1514   3, 3,                          /* RREF, NRREF                            */ \
1515   1,                             /* DEF                                    */ \
1516   1, 1,                          /* BRAZERO, BRAMINZERO                    */ \
1517   3, 1, 3,                       /* MARK, PRUNE, PRUNE_ARG,                */ \
1518   1, 3, 1, 3,                    /* SKIP, SKIP_ARG, THEN, THEN_ARG,        */ \
1519   1, 1, 1, 3, 1                  /* COMMIT, FAIL, ACCEPT, CLOSE, SKIPZERO  */
1520
1521
1522 /* A magic value for OP_RREF and OP_NRREF to indicate the "any recursion"
1523 condition. */
1524
1525 #define RREF_ANY  0xffff
1526
1527 /* Compile time error code numbers. They are given names so that they can more
1528 easily be tracked. When a new number is added, the table called eint in
1529 pcreposix.c must be updated. */
1530
1531 enum { ERR0,  ERR1,  ERR2,  ERR3,  ERR4,  ERR5,  ERR6,  ERR7,  ERR8,  ERR9,
1532        ERR10, ERR11, ERR12, ERR13, ERR14, ERR15, ERR16, ERR17, ERR18, ERR19,
1533        ERR20, ERR21, ERR22, ERR23, ERR24, ERR25, ERR26, ERR27, ERR28, ERR29,
1534        ERR30, ERR31, ERR32, ERR33, ERR34, ERR35, ERR36, ERR37, ERR38, ERR39,
1535        ERR40, ERR41, ERR42, ERR43, ERR44, ERR45, ERR46, ERR47, ERR48, ERR49,
1536        ERR50, ERR51, ERR52, ERR53, ERR54, ERR55, ERR56, ERR57, ERR58, ERR59,
1537        ERR60, ERR61, ERR62, ERR63, ERR64, ERR65, ERR66, ERR67, ERRCOUNT };
1538
1539 /* The real format of the start of the pcre block; the index of names and the
1540 code vector run on as long as necessary after the end. We store an explicit
1541 offset to the name table so that if a regex is compiled on one host, saved, and
1542 then run on another where the size of pointers is different, all might still
1543 be well. For the case of compiled-on-4 and run-on-8, we include an extra
1544 pointer that is always NULL. For future-proofing, a few dummy fields were
1545 originally included - even though you can never get this planning right - but
1546 there is only one left now.
1547
1548 NOTE NOTE NOTE:
1549 Because people can now save and re-use compiled patterns, any additions to this
1550 structure should be made at the end, and something earlier (e.g. a new
1551 flag in the options or one of the dummy fields) should indicate that the new
1552 fields are present. Currently PCRE always sets the dummy fields to zero.
1553 NOTE NOTE NOTE
1554 */
1555
1556 typedef struct real_pcre {
1557   pcre_uint32 magic_number;
1558   pcre_uint32 size;               /* Total that was malloced */
1559   pcre_uint32 options;            /* Public options */
1560   pcre_uint16 flags;              /* Private flags */
1561   pcre_uint16 dummy1;             /* For future use */
1562   pcre_uint16 top_bracket;
1563   pcre_uint16 top_backref;
1564   pcre_uint16 first_byte;
1565   pcre_uint16 req_byte;
1566   pcre_uint16 name_table_offset;  /* Offset to name table that follows */
1567   pcre_uint16 name_entry_size;    /* Size of any name items */
1568   pcre_uint16 name_count;         /* Number of name items */
1569   pcre_uint16 ref_count;          /* Reference count */
1570
1571   const unsigned char *tables;    /* Pointer to tables or NULL for std */
1572   const unsigned char *nullpad;   /* NULL padding */
1573 } real_pcre;
1574
1575 /* The format of the block used to store data from pcre_study(). The same
1576 remark (see NOTE above) about extending this structure applies. */
1577
1578 typedef struct pcre_study_data {
1579   pcre_uint32 size;               /* Total that was malloced */
1580   pcre_uint32 flags;              /* Private flags */
1581   uschar start_bits[32];          /* Starting char bits */
1582   pcre_uint32 minlength;          /* Minimum subject length */
1583 } pcre_study_data;
1584
1585 /* Structure for building a chain of open capturing subpatterns during
1586 compiling, so that instructions to close them can be compiled when (*ACCEPT) is
1587 encountered. This is also used to identify subpatterns that contain recursive
1588 back references to themselves, so that they can be made atomic. */
1589
1590 typedef struct open_capitem {
1591   struct open_capitem *next;    /* Chain link */
1592   pcre_uint16 number;           /* Capture number */
1593   pcre_uint16 flag;             /* Set TRUE if recursive back ref */
1594 } open_capitem;
1595
1596 /* Structure for passing "static" information around between the functions
1597 doing the compiling, so that they are thread-safe. */
1598
1599 typedef struct compile_data {
1600   const uschar *lcc;            /* Points to lower casing table */
1601   const uschar *fcc;            /* Points to case-flipping table */
1602   const uschar *cbits;          /* Points to character type table */
1603   const uschar *ctypes;         /* Points to table of type maps */
1604   const uschar *start_workspace;/* The start of working space */
1605   const uschar *start_code;     /* The start of the compiled code */
1606   const uschar *start_pattern;  /* The start of the pattern */
1607   const uschar *end_pattern;    /* The end of the pattern */
1608   open_capitem *open_caps;      /* Chain of open capture items */
1609   uschar *hwm;                  /* High watermark of workspace */
1610   uschar *name_table;           /* The name/number table */
1611   int  names_found;             /* Number of entries so far */
1612   int  name_entry_size;         /* Size of each entry */
1613   int  bracount;                /* Count of capturing parens as we compile */
1614   int  final_bracount;          /* Saved value after first pass */
1615   int  top_backref;             /* Maximum back reference */
1616   unsigned int backref_map;     /* Bitmap of low back refs */
1617   int  external_options;        /* External (initial) options */
1618   int  external_flags;          /* External flag bits to be set */
1619   int  req_varyopt;             /* "After variable item" flag for reqbyte */
1620   BOOL had_accept;              /* (*ACCEPT) encountered */
1621   BOOL check_lookbehind;        /* Lookbehinds need later checking */
1622   int  nltype;                  /* Newline type */
1623   int  nllen;                   /* Newline string length */
1624   uschar nl[4];                 /* Newline string when fixed length */
1625 } compile_data;
1626
1627 /* Structure for maintaining a chain of pointers to the currently incomplete
1628 branches, for testing for left recursion. */
1629
1630 typedef struct branch_chain {
1631   struct branch_chain *outer;
1632   uschar *current_branch;
1633 } branch_chain;
1634
1635 /* Structure for items in a linked list that represents an explicit recursive
1636 call within the pattern. */
1637
1638 typedef struct recursion_info {
1639   struct recursion_info *prevrec; /* Previous recursion record (or NULL) */
1640   int group_num;                /* Number of group that was called */
1641   const uschar *after_call;     /* "Return value": points after the call in the expr */
1642   int *offset_save;             /* Pointer to start of saved offsets */
1643   int saved_max;                /* Number of saved offsets */
1644   int save_offset_top;          /* Current value of offset_top */
1645 } recursion_info;
1646
1647 /* Structure for building a chain of data for holding the values of the subject
1648 pointer at the start of each subpattern, so as to detect when an empty string
1649 has been matched by a subpattern - to break infinite loops. */
1650
1651 typedef struct eptrblock {
1652   struct eptrblock *epb_prev;
1653   USPTR epb_saved_eptr;
1654 } eptrblock;
1655
1656
1657 /* Structure for passing "static" information around between the functions
1658 doing traditional NFA matching, so that they are thread-safe. */
1659
1660 typedef struct match_data {
1661   unsigned long int match_call_count;      /* As it says */
1662   unsigned long int match_limit;           /* As it says */
1663   unsigned long int match_limit_recursion; /* As it says */
1664   int   *offset_vector;         /* Offset vector */
1665   int    offset_end;            /* One past the end */
1666   int    offset_max;            /* The maximum usable for return data */
1667   int    nltype;                /* Newline type */
1668   int    nllen;                 /* Newline string length */
1669   int    name_count;            /* Number of names in name table */
1670   int    name_entry_size;       /* Size of entry in names table */
1671   uschar *name_table;           /* Table of names */
1672   uschar nl[4];                 /* Newline string when fixed */
1673   const uschar *lcc;            /* Points to lower casing table */
1674   const uschar *ctypes;         /* Points to table of type maps */
1675   BOOL   offset_overflow;       /* Set if too many extractions */
1676   BOOL   notbol;                /* NOTBOL flag */
1677   BOOL   noteol;                /* NOTEOL flag */
1678   BOOL   utf8;                  /* UTF8 flag */
1679   BOOL   jscript_compat;        /* JAVASCRIPT_COMPAT flag */
1680   BOOL   use_ucp;               /* PCRE_UCP flag */
1681   BOOL   endonly;               /* Dollar not before final \n */
1682   BOOL   notempty;              /* Empty string match not wanted */
1683   BOOL   notempty_atstart;      /* Empty string match at start not wanted */
1684   BOOL   hitend;                /* Hit the end of the subject at some point */
1685   BOOL   bsr_anycrlf;           /* \R is just any CRLF, not full Unicode */
1686   const uschar *start_code;     /* For use when recursing */
1687   USPTR  start_subject;         /* Start of the subject string */
1688   USPTR  end_subject;           /* End of the subject string */
1689   USPTR  start_match_ptr;       /* Start of matched string */
1690   USPTR  end_match_ptr;         /* Subject position at end match */
1691   USPTR  start_used_ptr;        /* Earliest consulted character */
1692   int    partial;               /* PARTIAL options */
1693   int    end_offset_top;        /* Highwater mark at end of match */
1694   int    capture_last;          /* Most recent capture number */
1695   int    start_offset;          /* The start offset value */
1696   eptrblock *eptrchain;         /* Chain of eptrblocks for tail recursions */
1697   int    eptrn;                 /* Next free eptrblock */
1698   recursion_info *recursive;    /* Linked list of recursion data */
1699   void  *callout_data;          /* To pass back to callouts */
1700   const uschar *mark;           /* Mark pointer to pass back */
1701 } match_data;
1702
1703 /* A similar structure is used for the same purpose by the DFA matching
1704 functions. */
1705
1706 typedef struct dfa_match_data {
1707   const uschar *start_code;     /* Start of the compiled pattern */
1708   const uschar *start_subject;  /* Start of the subject string */
1709   const uschar *end_subject;    /* End of subject string */
1710   const uschar *start_used_ptr; /* Earliest consulted character */
1711   const uschar *tables;         /* Character tables */
1712   int   start_offset;           /* The start offset value */
1713   int   moptions;               /* Match options */
1714   int   poptions;               /* Pattern options */
1715   int    nltype;                /* Newline type */
1716   int    nllen;                 /* Newline string length */
1717   uschar nl[4];                 /* Newline string when fixed */
1718   void  *callout_data;          /* To pass back to callouts */
1719 } dfa_match_data;
1720
1721 /* Bit definitions for entries in the pcre_ctypes table. */
1722
1723 #define ctype_space   0x01
1724 #define ctype_letter  0x02
1725 #define ctype_digit   0x04
1726 #define ctype_xdigit  0x08
1727 #define ctype_word    0x10   /* alphanumeric or '_' */
1728 #define ctype_meta    0x80   /* regexp meta char or zero (end pattern) */
1729
1730 /* Offsets for the bitmap tables in pcre_cbits. Each table contains a set
1731 of bits for a class map. Some classes are built by combining these tables. */
1732
1733 #define cbit_space     0      /* [:space:] or \s */
1734 #define cbit_xdigit   32      /* [:xdigit:] */
1735 #define cbit_digit    64      /* [:digit:] or \d */
1736 #define cbit_upper    96      /* [:upper:] */
1737 #define cbit_lower   128      /* [:lower:] */
1738 #define cbit_word    160      /* [:word:] or \w */
1739 #define cbit_graph   192      /* [:graph:] */
1740 #define cbit_print   224      /* [:print:] */
1741 #define cbit_punct   256      /* [:punct:] */
1742 #define cbit_cntrl   288      /* [:cntrl:] */
1743 #define cbit_length  320      /* Length of the cbits table */
1744
1745 /* Offsets of the various tables from the base tables pointer, and
1746 total length. */
1747
1748 #define lcc_offset      0
1749 #define fcc_offset    256
1750 #define cbits_offset  512
1751 #define ctypes_offset (cbits_offset + cbit_length)
1752 #define tables_length (ctypes_offset + 256)
1753
1754 /* Layout of the UCP type table that translates property names into types and
1755 codes. Each entry used to point directly to a name, but to reduce the number of
1756 relocations in shared libraries, it now has an offset into a single string
1757 instead. */
1758
1759 typedef struct {
1760   pcre_uint16 name_offset;
1761   pcre_uint16 type;
1762   pcre_uint16 value;
1763 } ucp_type_table;
1764
1765
1766 /* Internal shared data tables. These are tables that are used by more than one
1767 of the exported public functions. They have to be "external" in the C sense,
1768 but are not part of the PCRE public API. The data for these tables is in the
1769 pcre_tables.c module. */
1770
1771 extern const int    _pcre_utf8_table1[];
1772 extern const int    _pcre_utf8_table2[];
1773 extern const int    _pcre_utf8_table3[];
1774 extern const uschar _pcre_utf8_table4[];
1775
1776 extern const int    _pcre_utf8_table1_size;
1777
1778 extern const char   _pcre_utt_names[];
1779 extern const ucp_type_table _pcre_utt[];
1780 extern const int _pcre_utt_size;
1781
1782 extern const uschar _pcre_default_tables[];
1783
1784 extern const uschar _pcre_OP_lengths[];
1785
1786
1787 /* Internal shared functions. These are functions that are used by more than
1788 one of the exported public functions. They have to be "external" in the C
1789 sense, but are not part of the PCRE public API. */
1790
1791 extern const uschar *_pcre_find_bracket(const uschar *, BOOL, int);
1792 extern BOOL          _pcre_is_newline(USPTR, int, USPTR, int *, BOOL);
1793 extern int           _pcre_ord2utf8(int, uschar *);
1794 extern real_pcre    *_pcre_try_flipped(const real_pcre *, real_pcre *,
1795                        const pcre_study_data *, pcre_study_data *);
1796 extern int           _pcre_valid_utf8(USPTR, int);
1797 extern BOOL          _pcre_was_newline(USPTR, int, USPTR, int *, BOOL);
1798 extern BOOL          _pcre_xclass(int, const uschar *);
1799
1800
1801 /* Unicode character database (UCD) */
1802
1803 typedef struct {
1804   uschar script;
1805   uschar chartype;
1806   pcre_int32 other_case;
1807 } ucd_record;
1808
1809 extern const ucd_record  _pcre_ucd_records[];
1810 extern const uschar      _pcre_ucd_stage1[];
1811 extern const pcre_uint16 _pcre_ucd_stage2[];
1812 extern const int         _pcre_ucp_gentype[];
1813
1814
1815 /* UCD access macros */
1816
1817 #define UCD_BLOCK_SIZE 128
1818 #define GET_UCD(ch) (_pcre_ucd_records + \
1819         _pcre_ucd_stage2[_pcre_ucd_stage1[(ch) / UCD_BLOCK_SIZE] * \
1820         UCD_BLOCK_SIZE + ch % UCD_BLOCK_SIZE])
1821
1822 #define UCD_CHARTYPE(ch)  GET_UCD(ch)->chartype
1823 #define UCD_SCRIPT(ch)    GET_UCD(ch)->script
1824 #define UCD_CATEGORY(ch)  _pcre_ucp_gentype[UCD_CHARTYPE(ch)]
1825 #define UCD_OTHERCASE(ch) (ch + GET_UCD(ch)->other_case)
1826
1827 #endif
1828
1829 /* End of pcre_internal.h */