glib/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-2008 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 DEBUG to get debugging output on stdout. */
  49
  50 #if 0
  51 #define DEBUG
  52 #endif
  53
  54 /* Use a macro for debugging printing, 'cause that eliminates the use of #ifdef
  55 inline, and there are *still* stupid compilers about that don't like indented
  56 pre-processor statements, or at least there were when I first wrote this. After
  57 all, it had only been about 10 years then...
  58
  59 It turns out that the Mac Debugging.h header also defines the macro DPRINTF, so
  60 be absolutely sure we get our version. */
  61
  62 #undef DPRINTF
  63 #ifdef DEBUG
  64 #define DPRINTF(p) printf p
  65 #else
  66 #define DPRINTF(p) /* Nothing */
  67 #endif
  68
  69
  70 /* Standard C headers plus the external interface definition. The only time
  71 setjmp and stdarg are used is when NO_RECURSE is set. */
  72
  73 #include <ctype.h>
  74 #include <limits.h>
  75 #include <setjmp.h>
  76 #include <stdarg.h>
  77 #include <stddef.h>
  78 #include <stdio.h>
  79 #include <stdlib.h>
  80 #include <string.h>
  81
  82 /* When compiling a DLL for Windows, the exported symbols have to be declared
  83 using some MS magic. I found some useful information on this web page:
  84 http://msdn2.microsoft.com/en-us/library/y4h7bcy6(VS.80).aspx. According to the
  85 information there, using __declspec(dllexport) without "extern" we have a
  86 definition; with "extern" we have a declaration. The settings here override the
  87 setting in pcre.h (which is included below); it defines only PCRE_EXP_DECL,
  88 which is all that is needed for applications (they just import the symbols). We
  89 use:
  90
  91   PCRE_EXP_DECL       for declarations
  92   PCRE_EXP_DEFN       for definitions of exported functions
  93   PCRE_EXP_DATA_DEFN  for definitions of exported variables
  94
  95 The reason for the two DEFN macros is that in non-Windows environments, one
  96 does not want to have "extern" before variable definitions because it leads to
  97 compiler warnings. So we distinguish between functions and variables. In
  98 Windows, the two should always be the same.
  99
 100 The reason for wrapping this in #ifndef PCRE_EXP_DECL is so that pcretest,
 101 which is an application, but needs to import this file in order to "peek" at
 102 internals, can #include pcre.h first to get an application's-eye view.
 103
 104 In principle, people compiling for non-Windows, non-Unix-like (i.e. uncommon,
 105 special-purpose environments) might want to stick other stuff in front of
 106 exported symbols. That's why, in the non-Windows case, we set PCRE_EXP_DEFN and
 107 PCRE_EXP_DATA_DEFN only if they are not already set. */
 108
 109 #ifndef PCRE_EXP_DECL
 110 #  ifdef _WIN32
 111 #    ifndef PCRE_STATIC
 112 #      define PCRE_EXP_DECL       extern __declspec(dllexport)
 113 #      define PCRE_EXP_DEFN       __declspec(dllexport)
 114 #      define PCRE_EXP_DATA_DEFN  __declspec(dllexport)
 115 #    else
 116 #      define PCRE_EXP_DECL       extern
 117 #      define PCRE_EXP_DEFN
 118 #      define PCRE_EXP_DATA_DEFN
 119 #    endif
 120 #  else
 121 #    ifdef __cplusplus
 122 #      define PCRE_EXP_DECL       extern "C"
 123 #    else
 124 #      define PCRE_EXP_DECL       extern
 125 #    endif
 126 #    ifndef PCRE_EXP_DEFN
 127 #      define PCRE_EXP_DEFN       PCRE_EXP_DECL
 128 #    endif
 129 #    ifndef PCRE_EXP_DATA_DEFN
 130 #      define PCRE_EXP_DATA_DEFN
 131 #    endif
 132 #  endif
 133 #endif
 134
 135 /* When compiling with the MSVC compiler, it is sometimes necessary to include
 136 a "calling convention" before exported function names. (This is secondhand
 137 information; I know nothing about MSVC myself). For example, something like
 138
 139   void __cdecl function(....)
 140
 141 might be needed. In order so make this easy, all the exported functions have
 142 PCRE_CALL_CONVENTION just before their names. It is rarely needed; if not
 143 set, we ensure here that it has no effect. */
 144
 145 #ifndef PCRE_CALL_CONVENTION
 146 #define PCRE_CALL_CONVENTION
 147 #endif
 148
 149 /* We need to have types that specify unsigned 16-bit and 32-bit integers. We
 150 cannot determine these outside the compilation (e.g. by running a program as
 151 part of "configure") because PCRE is often cross-compiled for use on other
 152 systems. Instead we make use of the maximum sizes that are available at
 153 preprocessor time in standard C environments. */
 154
 155 #if USHRT_MAX == 65535
 156   typedef unsigned short pcre_uint16;
 157   typedef short pcre_int16;
 158 #elif UINT_MAX == 65535
 159   typedef unsigned int pcre_uint16;
 160   typedef int pcre_int16;
 161 #else
 162   #error Cannot determine a type for 16-bit unsigned integers
 163 #endif
 164
 165 #if UINT_MAX == 4294967295
 166   typedef unsigned int pcre_uint32;
 167   typedef int pcre_int32;
 168 #elif ULONG_MAX == 4294967295
 169   typedef unsigned long int pcre_uint32;
 170   typedef long int pcre_int32;
 171 #else
 172   #error Cannot determine a type for 32-bit unsigned integers
 173 #endif
 174
 175 /* All character handling must be done as unsigned characters. Otherwise there
 176 are problems with top-bit-set characters and functions such as isspace().
 177 However, we leave the interface to the outside world as char *, because that
 178 should make things easier for callers. We define a short type for unsigned char
 179 to save lots of typing. I tried "uchar", but it causes problems on Digital
 180 Unix, where it is defined in sys/types, so use "uschar" instead. */
 181
 182 typedef unsigned char uschar;
 183
 184 /* This is an unsigned int value that no character can ever have. UTF-8
 185 characters only go up to 0x7fffffff (though Unicode doesn't go beyond
 186 0x0010ffff). */
 187
 188 #define NOTACHAR 0xffffffff
 189
 190 /* PCRE is able to support several different kinds of newline (CR, LF, CRLF,
 191 "any" and "anycrlf" at present). The following macros are used to package up
 192 testing for newlines. NLBLOCK, PSSTART, and PSEND are defined in the various
 193 modules to indicate in which datablock the parameters exist, and what the
 194 start/end of string field names are. */
 195
 196 #define NLTYPE_FIXED    0     /* Newline is a fixed length string */
 197 #define NLTYPE_ANY      1     /* Newline is any Unicode line ending */
 198 #define NLTYPE_ANYCRLF  2     /* Newline is CR, LF, or CRLF */
 199
 200 /* This macro checks for a newline at the given position */
 201
 202 #define IS_NEWLINE(p) \
 203   ((NLBLOCK->nltype != NLTYPE_FIXED)? \
 204     ((p) < NLBLOCK->PSEND && \
 205      _pcre_is_newline((p), NLBLOCK->nltype, NLBLOCK->PSEND, &(NLBLOCK->nllen),\
 206        utf8)) \
 207     : \
 208     ((p) <= NLBLOCK->PSEND - NLBLOCK->nllen && \
 209      (p)[0] == NLBLOCK->nl[0] && \
 210      (NLBLOCK->nllen == 1 || (p)[1] == NLBLOCK->nl[1]) \
 211     ) \
 212   )
 213
 214 /* This macro checks for a newline immediately preceding the given position */
 215
 216 #define WAS_NEWLINE(p) \
 217   ((NLBLOCK->nltype != NLTYPE_FIXED)? \
 218     ((p) > NLBLOCK->PSSTART && \
 219      _pcre_was_newline((p), NLBLOCK->nltype, NLBLOCK->PSSTART, \
 220        &(NLBLOCK->nllen), utf8)) \
 221     : \
 222     ((p) >= NLBLOCK->PSSTART + NLBLOCK->nllen && \
 223      (p)[-NLBLOCK->nllen] == NLBLOCK->nl[0] && \
 224      (NLBLOCK->nllen == 1 || (p)[-NLBLOCK->nllen+1] == NLBLOCK->nl[1]) \
 225     ) \
 226   )
 227
 228 /* When PCRE is compiled as a C++ library, the subject pointer can be replaced
 229 with a custom type. This makes it possible, for example, to allow pcre_exec()
 230 to process subject strings that are discontinuous by using a smart pointer
 231 class. It must always be possible to inspect all of the subject string in
 232 pcre_exec() because of the way it backtracks. Two macros are required in the
 233 normal case, for sign-unspecified and unsigned char pointers. The former is
 234 used for the external interface and appears in pcre.h, which is why its name
 235 must begin with PCRE_. */
 236
 237 #ifdef CUSTOM_SUBJECT_PTR
 238 #define PCRE_SPTR CUSTOM_SUBJECT_PTR
 239 #define USPTR CUSTOM_SUBJECT_PTR
 240 #else
 241 #define PCRE_SPTR const char *
 242 #define USPTR const unsigned char *
 243 #endif
 244
 245
 246
 247 /* Include the public PCRE header and the definitions of UCP character property
 248 values. */
 249
 250 #include "pcre.h"
 251 #include "ucp.h"
 252
 253 /* When compiling for use with the Virtual Pascal compiler, these functions
 254 need to have their names changed. PCRE must be compiled with the -DVPCOMPAT
 255 option on the command line. */
 256
 257 #ifdef VPCOMPAT
 258 #define strlen(s)        _strlen(s)
 259 #define strncmp(s1,s2,m) _strncmp(s1,s2,m)
 260 #define memcmp(s,c,n)    _memcmp(s,c,n)
 261 #define memcpy(d,s,n)    _memcpy(d,s,n)
 262 #define memset(s,c,n)    _memset(s,c,n)
 263 #else  /* VPCOMPAT */
 264
 265 /* To cope with SunOS4 and other systems that lack memmove() but have bcopy(),
 266 define a macro for memmove() if HAVE_MEMMOVE is false, provided that HAVE_BCOPY
 267 is set. Otherwise, include an emulating function for those systems that have
 268 neither (there some non-Unix environments where this is the case). */
 269
 270 #ifndef HAVE_MEMMOVE
 271 #undef  memmove        /* some systems may have a macro */
 272 #ifdef HAVE_BCOPY
 273 #define memmove(a, b, c) bcopy(b, a, c)
 274 #else  /* HAVE_BCOPY */
 275 static void *
 276 pcre_memmove(void *d, const void *s, size_t n)
 277 {
 278 size_t i;
 279 unsigned char *dest = (unsigned char *)d;
 280 const unsigned char *src = (const unsigned char *)s;
 281 if (dest > src)
 282   {
 283   dest += n;
 284   src += n;
 285   for (i = 0; i < n; ++i) *(--dest) = *(--src);
 286   return (void *)dest;
 287   }
 288 else
 289   {
 290   for (i = 0; i < n; ++i) *dest++ = *src++;
 291   return (void *)(dest - n);
 292   }
 293 }
 294 #define memmove(a, b, c) pcre_memmove(a, b, c)
 295 #endif   /* not HAVE_BCOPY */
 296 #endif   /* not HAVE_MEMMOVE */
 297 #endif   /* not VPCOMPAT */
 298
 299
 300 /* PCRE keeps offsets in its compiled code as 2-byte quantities (always stored
 301 in big-endian order) by default. These are used, for example, to link from the
 302 start of a subpattern to its alternatives and its end. The use of 2 bytes per
 303 offset limits the size of the compiled regex to around 64K, which is big enough
 304 for almost everybody. However, I received a request for an even bigger limit.
 305 For this reason, and also to make the code easier to maintain, the storing and
 306 loading of offsets from the byte string is now handled by the macros that are
 307 defined here.
 308
 309 The macros are controlled by the value of LINK_SIZE. This defaults to 2 in
 310 the config.h file, but can be overridden by using -D on the command line. This
 311 is automated on Unix systems via the "configure" command. */
 312
 313 #if LINK_SIZE == 2
 314
 315 #define PUT(a,n,d)   \
 316   (a[n] = (d) >> 8), \
 317   (a[(n)+1] = (d) & 255)
 318
 319 #define GET(a,n) \
 320   (((a)[n] << 8) | (a)[(n)+1])
 321
 322 #define MAX_PATTERN_SIZE (1 << 16)
 323
 324
 325 #elif LINK_SIZE == 3
 326
 327 #define PUT(a,n,d)       \
 328   (a[n] = (d) >> 16),    \
 329   (a[(n)+1] = (d) >> 8), \
 330   (a[(n)+2] = (d) & 255)
 331
 332 #define GET(a,n) \
 333   (((a)[n] << 16) | ((a)[(n)+1] << 8) | (a)[(n)+2])
 334
 335 #define MAX_PATTERN_SIZE (1 << 24)
 336
 337
 338 #elif LINK_SIZE == 4
 339
 340 #define PUT(a,n,d)        \
 341   (a[n] = (d) >> 24),     \
 342   (a[(n)+1] = (d) >> 16), \
 343   (a[(n)+2] = (d) >> 8),  \
 344   (a[(n)+3] = (d) & 255)
 345
 346 #define GET(a,n) \
 347   (((a)[n] << 24) | ((a)[(n)+1] << 16) | ((a)[(n)+2] << 8) | (a)[(n)+3])
 348
 349 #define MAX_PATTERN_SIZE (1 << 30)   /* Keep it positive */
 350
 351
 352 #else
 353 #error LINK_SIZE must be either 2, 3, or 4
 354 #endif
 355
 356
 357 /* Convenience macro defined in terms of the others */
 358
 359 #define PUTINC(a,n,d)   PUT(a,n,d), a += LINK_SIZE
 360
 361
 362 /* PCRE uses some other 2-byte quantities that do not change when the size of
 363 offsets changes. There are used for repeat counts and for other things such as
 364 capturing parenthesis numbers in back references. */
 365
 366 #define PUT2(a,n,d)   \
 367   a[n] = (d) >> 8; \
 368   a[(n)+1] = (d) & 255
 369
 370 #define GET2(a,n) \
 371   (((a)[n] << 8) | (a)[(n)+1])
 372
 373 #define PUT2INC(a,n,d)  PUT2(a,n,d), a += 2
 374
 375
 376 /* When UTF-8 encoding is being used, a character is no longer just a single
 377 byte. The macros for character handling generate simple sequences when used in
 378 byte-mode, and more complicated ones for UTF-8 characters. BACKCHAR should
 379 never be called in byte mode. To make sure it can never even appear when UTF-8
 380 support is omitted, we don't even define it. */
 381
 382 #ifndef SUPPORT_UTF8
 383 #define GETCHAR(c, eptr) c = *eptr;
 384 #define GETCHARTEST(c, eptr) c = *eptr;
 385 #define GETCHARINC(c, eptr) c = *eptr++;
 386 #define GETCHARINCTEST(c, eptr) c = *eptr++;
 387 #define GETCHARLEN(c, eptr, len) c = *eptr;
 388 /* #define BACKCHAR(eptr) */
 389
 390 #else   /* SUPPORT_UTF8 */
 391
 392 /* Get the next UTF-8 character, not advancing the pointer. This is called when
 393 we know we are in UTF-8 mode. */
 394
 395 #define GETCHAR(c, eptr) \
 396   c = *eptr; \
 397   if (c >= 0xc0) \
 398     { \
 399     int gcii; \
 400     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
 401     int gcss = 6*gcaa; \
 402     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
 403     for (gcii = 1; gcii <= gcaa; gcii++) \
 404       { \
 405       gcss -= 6; \
 406       c |= (eptr[gcii] & 0x3f) << gcss; \
 407       } \
 408     }
 409
 410 /* Get the next UTF-8 character, testing for UTF-8 mode, and not advancing the
 411 pointer. */
 412
 413 #define GETCHARTEST(c, eptr) \
 414   c = *eptr; \
 415   if (utf8 && c >= 0xc0) \
 416     { \
 417     int gcii; \
 418     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
 419     int gcss = 6*gcaa; \
 420     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
 421     for (gcii = 1; gcii <= gcaa; gcii++) \
 422       { \
 423       gcss -= 6; \
 424       c |= (eptr[gcii] & 0x3f) << gcss; \
 425       } \
 426     }
 427
 428 /* Get the next UTF-8 character, advancing the pointer. This is called when we
 429 know we are in UTF-8 mode. */
 430
 431 #define GETCHARINC(c, eptr) \
 432   c = *eptr++; \
 433   if (c >= 0xc0) \
 434     { \
 435     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
 436     int gcss = 6*gcaa; \
 437     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
 438     while (gcaa-- > 0) \
 439       { \
 440       gcss -= 6; \
 441       c |= (*eptr++ & 0x3f) << gcss; \
 442       } \
 443     }
 444
 445 /* Get the next character, testing for UTF-8 mode, and advancing the pointer */
 446
 447 #define GETCHARINCTEST(c, eptr) \
 448   c = *eptr++; \
 449   if (utf8 && c >= 0xc0) \
 450     { \
 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     while (gcaa-- > 0) \
 455       { \
 456       gcss -= 6; \
 457       c |= (*eptr++ & 0x3f) << gcss; \
 458       } \
 459     }
 460
 461 /* Get the next UTF-8 character, not advancing the pointer, incrementing length
 462 if there are extra bytes. This is called when we know we are in UTF-8 mode. */
 463
 464 #define GETCHARLEN(c, eptr, len) \
 465   c = *eptr; \
 466   if (c >= 0xc0) \
 467     { \
 468     int gcii; \
 469     int gcaa = _pcre_utf8_table4[c & 0x3f];  /* Number of additional bytes */ \
 470     int gcss = 6*gcaa; \
 471     c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
 472     for (gcii = 1; gcii <= gcaa; gcii++) \
 473       { \
 474       gcss -= 6; \
 475       c |= (eptr[gcii] & 0x3f) << gcss; \
 476       } \
 477     len += gcaa; \
 478     }
 479
 480 /* If the pointer is not at the start of a character, move it back until
 481 it is. This is called only in UTF-8 mode - we don't put a test within the macro
 482 because almost all calls are already within a block of UTF-8 only code. */
 483
 484 #define BACKCHAR(eptr) while((*eptr & 0xc0) == 0x80) eptr--
 485
 486 #endif
 487
 488
 489 /* In case there is no definition of offsetof() provided - though any proper
 490 Standard C system should have one. */
 491
 492 #ifndef offsetof
 493 #define offsetof(p_type,field) ((size_t)&(((p_type *)0)->field))
 494 #endif
 495
 496
 497 /* These are the public options that can change during matching. */
 498
 499 #define PCRE_IMS (PCRE_CASELESS|PCRE_MULTILINE|PCRE_DOTALL)
 500
 501 /* Private flags containing information about the compiled regex. They used to
 502 live at the top end of the options word, but that got almost full, so now they
 503 are in a 16-bit flags word. */
 504
 505 #define PCRE_NOPARTIAL     0x0001  /* can't use partial with this regex */
 506 #define PCRE_FIRSTSET      0x0002  /* first_byte is set */
 507 #define PCRE_REQCHSET      0x0004  /* req_byte is set */
 508 #define PCRE_STARTLINE     0x0008  /* start after \n for multiline */
 509 #define PCRE_JCHANGED      0x0010  /* j option used in regex */
 510 #define PCRE_HASCRORLF     0x0020  /* explicit \r or \n in pattern */
 511
 512 /* Options for the "extra" block produced by pcre_study(). */
 513
 514 #define PCRE_STUDY_MAPPED   0x01     /* a map of starting chars exists */
 515
 516 /* Masks for identifying the public options that are permitted at compile
 517 time, run time, or study time, respectively. */
 518
 519 #define PCRE_NEWLINE_BITS (PCRE_NEWLINE_CR|PCRE_NEWLINE_LF|PCRE_NEWLINE_ANY| \
 520                            PCRE_NEWLINE_ANYCRLF)
 521
 522 #define PUBLIC_OPTIONS \
 523   (PCRE_CASELESS|PCRE_EXTENDED|PCRE_ANCHORED|PCRE_MULTILINE| \
 524    PCRE_DOTALL|PCRE_DOLLAR_ENDONLY|PCRE_EXTRA|PCRE_UNGREEDY|PCRE_UTF8| \
 525    PCRE_NO_AUTO_CAPTURE|PCRE_NO_UTF8_CHECK|PCRE_AUTO_CALLOUT|PCRE_FIRSTLINE| \
 526    PCRE_DUPNAMES|PCRE_NEWLINE_BITS|PCRE_BSR_ANYCRLF|PCRE_BSR_UNICODE| \
 527    PCRE_JAVASCRIPT_COMPAT)
 528
 529 #define PUBLIC_EXEC_OPTIONS \
 530   (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NO_UTF8_CHECK| \
 531    PCRE_PARTIAL|PCRE_NEWLINE_BITS|PCRE_BSR_ANYCRLF|PCRE_BSR_UNICODE)
 532
 533 #define PUBLIC_DFA_EXEC_OPTIONS \
 534   (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NO_UTF8_CHECK| \
 535    PCRE_PARTIAL|PCRE_DFA_SHORTEST|PCRE_DFA_RESTART|PCRE_NEWLINE_BITS| \
 536    PCRE_BSR_ANYCRLF|PCRE_BSR_UNICODE)
 537
 538 #define PUBLIC_STUDY_OPTIONS 0   /* None defined */
 539
 540 /* Magic number to provide a small check against being handed junk. Also used
 541 to detect whether a pattern was compiled on a host of different endianness. */
 542
 543 #define MAGIC_NUMBER  0x50435245UL   /* 'PCRE' */
 544
 545 /* Negative values for the firstchar and reqchar variables */
 546
 547 #define REQ_UNSET (-2)
 548 #define REQ_NONE  (-1)
 549
 550 /* The maximum remaining length of subject we are prepared to search for a
 551 req_byte match. */
 552
 553 #define REQ_BYTE_MAX 1000
 554
 555 /* Flags added to firstbyte or reqbyte; a "non-literal" item is either a
 556 variable-length repeat, or a anything other than literal characters. */
 557
 558 #define REQ_CASELESS 0x0100    /* indicates caselessness */
 559 #define REQ_VARY     0x0200    /* reqbyte followed non-literal item */
 560
 561 /* Miscellaneous definitions. The #ifndef is to pacify compiler warnings in
 562 environments where these macros are defined elsewhere. */
 563
 564 typedef gboolean BOOL;
 565
 566 /* Escape items that are just an encoding of a particular data value. */
 567
 568 #ifndef ESC_e
 569 #define ESC_e 27
 570 #endif
 571
 572 #ifndef ESC_f
 573 #define ESC_f '\f'
 574 #endif
 575
 576 #ifndef ESC_n
 577 #define ESC_n '\n'
 578 #endif
 579
 580 #ifndef ESC_r
 581 #define ESC_r '\r'
 582 #endif
 583
 584 /* We can't officially use ESC_t because it is a POSIX reserved identifier
 585 (presumably because of all the others like size_t). */
 586
 587 #ifndef ESC_tee
 588 #define ESC_tee '\t'
 589 #endif
 590
 591 /* Codes for different types of Unicode property */
 592
 593 #define PT_ANY        0    /* Any property - matches all chars */
 594 #define PT_LAMP       1    /* L& - the union of Lu, Ll, Lt */
 595 #define PT_GC         2    /* General characteristic (e.g. L) */
 596 #define PT_PC         3    /* Particular characteristic (e.g. Lu) */
 597 #define PT_SC         4    /* Script (e.g. Han) */
 598
 599 /* Flag bits and data types for the extended class (OP_XCLASS) for classes that
 600 contain UTF-8 characters with values greater than 255. */
 601
 602 #define XCL_NOT    0x01    /* Flag: this is a negative class */
 603 #define XCL_MAP    0x02    /* Flag: a 32-byte map is present */
 604
 605 #define XCL_END       0    /* Marks end of individual items */
 606 #define XCL_SINGLE    1    /* Single item (one multibyte char) follows */
 607 #define XCL_RANGE     2    /* A range (two multibyte chars) follows */
 608 #define XCL_PROP      3    /* Unicode property (2-byte property code follows) */
 609 #define XCL_NOTPROP   4    /* Unicode inverted property (ditto) */
 610
 611 /* These are escaped items that aren't just an encoding of a particular data
 612 value such as \n. They must have non-zero values, as check_escape() returns
 613 their negation. Also, they must appear in the same order as in the opcode
 614 definitions below, up to ESC_z. There's a dummy for OP_ANY because it
 615 corresponds to "." rather than an escape sequence, and another for OP_ALLANY
 616 (which is used for [^] in JavaScript compatibility mode).
 617
 618 The final escape must be ESC_REF as subsequent values are used for
 619 backreferences (\1, \2, \3, etc). There are two tests in the code for an escape
 620 greater than ESC_b and less than ESC_Z to detect the types that may be
 621 repeated. These are the types that consume characters. If any new escapes are
 622 put in between that don't consume a character, that code will have to change.
 623 */
 624
 625 enum { ESC_A = 1, ESC_G, ESC_K, ESC_B, ESC_b, ESC_D, ESC_d, ESC_S, ESC_s,
 626        ESC_W, ESC_w, ESC_dum1, ESC_dum2, ESC_C, ESC_P, ESC_p, ESC_R, ESC_H,
 627        ESC_h, ESC_V, ESC_v, ESC_X, ESC_Z, ESC_z, ESC_E, ESC_Q, ESC_g, ESC_k,
 628        ESC_REF };
 629
 630
 631 /* Opcode table: Starting from 1 (i.e. after OP_END), the values up to
 632 OP_EOD must correspond in order to the list of escapes immediately above.
 633
 634 *** NOTE NOTE NOTE *** Whenever this list is updated, the two macro definitions
 635 that follow must also be updated to match. There is also a table called
 636 "coptable" in pcre_dfa_exec.c that must be updated. */
 637
 638 enum {
 639   OP_END,            /* 0 End of pattern */
 640
 641   /* Values corresponding to backslashed metacharacters */
 642
 643   OP_SOD,            /* 1 Start of data: \A */
 644   OP_SOM,            /* 2 Start of match (subject + offset): \G */
 645   OP_SET_SOM,        /* 3 Set start of match (\K) */
 646   OP_NOT_WORD_BOUNDARY,  /*  4 \B */
 647   OP_WORD_BOUNDARY,      /*  5 \b */
 648   OP_NOT_DIGIT,          /*  6 \D */
 649   OP_DIGIT,              /*  7 \d */
 650   OP_NOT_WHITESPACE,     /*  8 \S */
 651   OP_WHITESPACE,         /*  9 \s */
 652   OP_NOT_WORDCHAR,       /* 10 \W */
 653   OP_WORDCHAR,           /* 11 \w */
 654   OP_ANY,            /* 12 Match any character (subject to DOTALL) */
 655   OP_ALLANY,         /* 13 Match any character (not subject to DOTALL) */
 656   OP_ANYBYTE,        /* 14 Match any byte (\C); different to OP_ANY for UTF-8 */
 657   OP_NOTPROP,        /* 15 \P (not Unicode property) */
 658   OP_PROP,           /* 16 \p (Unicode property) */
 659   OP_ANYNL,          /* 17 \R (any newline sequence) */
 660   OP_NOT_HSPACE,     /* 18 \H (not horizontal whitespace) */
 661   OP_HSPACE,         /* 19 \h (horizontal whitespace) */
 662   OP_NOT_VSPACE,     /* 20 \V (not vertical whitespace) */
 663   OP_VSPACE,         /* 21 \v (vertical whitespace) */
 664   OP_EXTUNI,         /* 22 \X (extended Unicode sequence */
 665   OP_EODN,           /* 23 End of data or \n at end of data: \Z. */
 666   OP_EOD,            /* 24 End of data: \z */
 667
 668   OP_OPT,            /* 25 Set runtime options */
 669   OP_CIRC,           /* 26 Start of line - varies with multiline switch */
 670   OP_DOLL,           /* 27 End of line - varies with multiline switch */
 671   OP_CHAR,           /* 28 Match one character, casefully */
 672   OP_CHARNC,         /* 29 Match one character, caselessly */
 673   OP_NOT,            /* 30 Match one character, not the following one */
 674
 675   OP_STAR,           /* 31 The maximizing and minimizing versions of */
 676   OP_MINSTAR,        /* 32 these six opcodes must come in pairs, with */
 677   OP_PLUS,           /* 33 the minimizing one second. */
 678   OP_MINPLUS,        /* 34 This first set applies to single characters.*/
 679   OP_QUERY,          /* 35 */
 680   OP_MINQUERY,       /* 36 */
 681
 682   OP_UPTO,           /* 37 From 0 to n matches */
 683   OP_MINUPTO,        /* 38 */
 684   OP_EXACT,          /* 39 Exactly n matches */
 685
 686   OP_POSSTAR,        /* 40 Possessified star */
 687   OP_POSPLUS,        /* 41 Possessified plus */
 688   OP_POSQUERY,       /* 42 Posesssified query */
 689   OP_POSUPTO,        /* 43 Possessified upto */
 690
 691   OP_NOTSTAR,        /* 44 The maximizing and minimizing versions of */
 692   OP_NOTMINSTAR,     /* 45 these six opcodes must come in pairs, with */
 693   OP_NOTPLUS,        /* 46 the minimizing one second. They must be in */
 694   OP_NOTMINPLUS,     /* 47 exactly the same order as those above. */
 695   OP_NOTQUERY,       /* 48 This set applies to "not" single characters. */
 696   OP_NOTMINQUERY,    /* 49 */
 697
 698   OP_NOTUPTO,        /* 50 From 0 to n matches */
 699   OP_NOTMINUPTO,     /* 51 */
 700   OP_NOTEXACT,       /* 52 Exactly n matches */
 701
 702   OP_NOTPOSSTAR,     /* 53 Possessified versions */
 703   OP_NOTPOSPLUS,     /* 54 */
 704   OP_NOTPOSQUERY,    /* 55 */
 705   OP_NOTPOSUPTO,     /* 56 */
 706
 707   OP_TYPESTAR,       /* 57 The maximizing and minimizing versions of */
 708   OP_TYPEMINSTAR,    /* 58 these six opcodes must come in pairs, with */
 709   OP_TYPEPLUS,       /* 59 the minimizing one second. These codes must */
 710   OP_TYPEMINPLUS,    /* 60 be in exactly the same order as those above. */
 711   OP_TYPEQUERY,      /* 61 This set applies to character types such as \d */
 712   OP_TYPEMINQUERY,   /* 62 */
 713
 714   OP_TYPEUPTO,       /* 63 From 0 to n matches */
 715   OP_TYPEMINUPTO,    /* 64 */
 716   OP_TYPEEXACT,      /* 65 Exactly n matches */
 717
 718   OP_TYPEPOSSTAR,    /* 66 Possessified versions */
 719   OP_TYPEPOSPLUS,    /* 67 */
 720   OP_TYPEPOSQUERY,   /* 68 */
 721   OP_TYPEPOSUPTO,    /* 69 */
 722
 723   OP_CRSTAR,         /* 70 The maximizing and minimizing versions of */
 724   OP_CRMINSTAR,      /* 71 all these opcodes must come in pairs, with */
 725   OP_CRPLUS,         /* 72 the minimizing one second. These codes must */
 726   OP_CRMINPLUS,      /* 73 be in exactly the same order as those above. */
 727   OP_CRQUERY,        /* 74 These are for character classes and back refs */
 728   OP_CRMINQUERY,     /* 75 */
 729   OP_CRRANGE,        /* 76 These are different to the three sets above. */
 730   OP_CRMINRANGE,     /* 77 */
 731
 732   OP_CLASS,          /* 78 Match a character class, chars < 256 only */
 733   OP_NCLASS,         /* 79 Same, but the bitmap was created from a negative
 734                            class - the difference is relevant only when a UTF-8
 735                            character > 255 is encountered. */
 736
 737   OP_XCLASS,         /* 80 Extended class for handling UTF-8 chars within the
 738                            class. This does both positive and negative. */
 739
 740   OP_REF,            /* 81 Match a back reference */
 741   OP_RECURSE,        /* 82 Match a numbered subpattern (possibly recursive) */
 742   OP_CALLOUT,        /* 83 Call out to external function if provided */
 743
 744   OP_ALT,            /* 84 Start of alternation */
 745   OP_KET,            /* 85 End of group that doesn't have an unbounded repeat */
 746   OP_KETRMAX,        /* 86 These two must remain together and in this */
 747   OP_KETRMIN,        /* 87 order. They are for groups the repeat for ever. */
 748
 749   /* The assertions must come before BRA, CBRA, ONCE, and COND.*/
 750
 751   OP_ASSERT,         /* 88 Positive lookahead */
 752   OP_ASSERT_NOT,     /* 89 Negative lookahead */
 753   OP_ASSERTBACK,     /* 90 Positive lookbehind */
 754   OP_ASSERTBACK_NOT, /* 91 Negative lookbehind */
 755   OP_REVERSE,        /* 92 Move pointer back - used in lookbehind assertions */
 756
 757   /* ONCE, BRA, CBRA, and COND must come after the assertions, with ONCE first,
 758   as there's a test for >= ONCE for a subpattern that isn't an assertion. */
 759
 760   OP_ONCE,           /* 93 Atomic group */
 761   OP_BRA,            /* 94 Start of non-capturing bracket */
 762   OP_CBRA,           /* 95 Start of capturing bracket */
 763   OP_COND,           /* 96 Conditional group */
 764
 765   /* These three must follow the previous three, in the same order. There's a
 766   check for >= SBRA to distinguish the two sets. */
 767
 768   OP_SBRA,           /* 97 Start of non-capturing bracket, check empty  */
 769   OP_SCBRA,          /* 98 Start of capturing bracket, check empty */
 770   OP_SCOND,          /* 99 Conditional group, check empty */
 771
 772   OP_CREF,           /* 100 Used to hold a capture number as condition */
 773   OP_RREF,           /* 101 Used to hold a recursion number as condition */
 774   OP_DEF,            /* 102 The DEFINE condition */
 775
 776   OP_BRAZERO,        /* 103 These two must remain together and in this */
 777   OP_BRAMINZERO,     /* 104 order. */
 778
 779   /* These are backtracking control verbs */
 780
 781   OP_PRUNE,          /* 105 */
 782   OP_SKIP,           /* 106 */
 783   OP_THEN,           /* 107 */
 784   OP_COMMIT,         /* 108 */
 785
 786   /* These are forced failure and success verbs */
 787
 788   OP_FAIL,           /* 109 */
 789   OP_ACCEPT,         /* 110 */
 790
 791   /* This is used to skip a subpattern with a {0} quantifier */
 792
 793   OP_SKIPZERO        /* 111 */
 794 };
 795
 796
 797 /* This macro defines textual names for all the opcodes. These are used only
 798 for debugging. The macro is referenced only in pcre_printint.c. */
 799
 800 #define OP_NAME_LIST \
 801   "End", "\\A", "\\G", "\\K", "\\B", "\\b", "\\D", "\\d",         \
 802   "\\S", "\\s", "\\W", "\\w", "Any", "AllAny", "Anybyte",         \
 803   "notprop", "prop", "\\R", "\\H", "\\h", "\\V", "\\v",           \
 804   "extuni",  "\\Z", "\\z",                                        \
 805   "Opt", "^", "$", "char", "charnc", "not",                       \
 806   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
 807   "*+","++", "?+", "{",                                           \
 808   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
 809   "*+","++", "?+", "{",                                           \
 810   "*", "*?", "+", "+?", "?", "??", "{", "{", "{",                 \
 811   "*+","++", "?+", "{",                                           \
 812   "*", "*?", "+", "+?", "?", "??", "{", "{",                      \
 813   "class", "nclass", "xclass", "Ref", "Recurse", "Callout",       \
 814   "Alt", "Ket", "KetRmax", "KetRmin", "Assert", "Assert not",     \
 815   "AssertB", "AssertB not", "Reverse",                            \
 816   "Once", "Bra", "CBra", "Cond", "SBra", "SCBra", "SCond",        \
 817   "Cond ref", "Cond rec", "Cond def", "Brazero", "Braminzero",    \
 818   "*PRUNE", "*SKIP", "*THEN", "*COMMIT", "*FAIL", "*ACCEPT",      \
 819   "Skip zero"
 820
 821
 822 /* This macro defines the length of fixed length operations in the compiled
 823 regex. The lengths are used when searching for specific things, and also in the
 824 debugging printing of a compiled regex. We use a macro so that it can be
 825 defined close to the definitions of the opcodes themselves.
 826
 827 As things have been extended, some of these are no longer fixed lenths, but are
 828 minima instead. For example, the length of a single-character repeat may vary
 829 in UTF-8 mode. The code that uses this table must know about such things. */
 830
 831 #define OP_LENGTHS \
 832   1,                             /* End                                    */ \
 833   1, 1, 1, 1, 1,                 /* \A, \G, \K, \B, \b                     */ \
 834   1, 1, 1, 1, 1, 1,              /* \D, \d, \S, \s, \W, \w                 */ \
 835   1, 1, 1,                       /* Any, AllAny, Anybyte                   */ \
 836   3, 3, 1,                       /* NOTPROP, PROP, EXTUNI                  */ \
 837   1, 1, 1, 1, 1,                 /* \R, \H, \h, \V, \v                     */ \
 838   1, 1, 2, 1, 1,                 /* \Z, \z, Opt, ^, $                      */ \
 839   2,                             /* Char  - the minimum length             */ \
 840   2,                             /* Charnc  - the minimum length           */ \
 841   2,                             /* not                                    */ \
 842   /* Positive single-char repeats                            ** These are  */ \
 843   2, 2, 2, 2, 2, 2,              /* *, *?, +, +?, ?, ??      ** minima in  */ \
 844   4, 4, 4,                       /* upto, minupto, exact     ** UTF-8 mode */ \
 845   2, 2, 2, 4,                    /* *+, ++, ?+, upto+                      */ \
 846   /* Negative single-char repeats - only for chars < 256                   */ \
 847   2, 2, 2, 2, 2, 2,              /* NOT *, *?, +, +?, ?, ??                */ \
 848   4, 4, 4,                       /* NOT upto, minupto, exact               */ \
 849   2, 2, 2, 4,                    /* Possessive *, +, ?, upto               */ \
 850   /* Positive type repeats                                                 */ \
 851   2, 2, 2, 2, 2, 2,              /* Type *, *?, +, +?, ?, ??               */ \
 852   4, 4, 4,                       /* Type upto, minupto, exact              */ \
 853   2, 2, 2, 4,                    /* Possessive *+, ++, ?+, upto+           */ \
 854   /* Character class & ref repeats                                         */ \
 855   1, 1, 1, 1, 1, 1,              /* *, *?, +, +?, ?, ??                    */ \
 856   5, 5,                          /* CRRANGE, CRMINRANGE                    */ \
 857  33,                             /* CLASS                                  */ \
 858  33,                             /* NCLASS                                 */ \
 859   0,                             /* XCLASS - variable length               */ \
 860   3,                             /* REF                                    */ \
 861   1+LINK_SIZE,                   /* RECURSE                                */ \
 862   2+2*LINK_SIZE,                 /* CALLOUT                                */ \
 863   1+LINK_SIZE,                   /* Alt                                    */ \
 864   1+LINK_SIZE,                   /* Ket                                    */ \
 865   1+LINK_SIZE,                   /* KetRmax                                */ \
 866   1+LINK_SIZE,                   /* KetRmin                                */ \
 867   1+LINK_SIZE,                   /* Assert                                 */ \
 868   1+LINK_SIZE,                   /* Assert not                             */ \
 869   1+LINK_SIZE,                   /* Assert behind                          */ \
 870   1+LINK_SIZE,                   /* Assert behind not                      */ \
 871   1+LINK_SIZE,                   /* Reverse                                */ \
 872   1+LINK_SIZE,                   /* ONCE                                   */ \
 873   1+LINK_SIZE,                   /* BRA                                    */ \
 874   3+LINK_SIZE,                   /* CBRA                                   */ \
 875   1+LINK_SIZE,                   /* COND                                   */ \
 876   1+LINK_SIZE,                   /* SBRA                                   */ \
 877   3+LINK_SIZE,                   /* SCBRA                                  */ \
 878   1+LINK_SIZE,                   /* SCOND                                  */ \
 879   3,                             /* CREF                                   */ \
 880   3,                             /* RREF                                   */ \
 881   1,                             /* DEF                                    */ \
 882   1, 1,                          /* BRAZERO, BRAMINZERO                    */ \
 883   1, 1, 1, 1,                    /* PRUNE, SKIP, THEN, COMMIT,             */ \
 884   1, 1, 1                        /* FAIL, ACCEPT, SKIPZERO                 */
 885
 886
 887 /* A magic value for OP_RREF to indicate the "any recursion" condition. */
 888
 889 #define RREF_ANY  0xffff
 890
 891 /* Error code numbers. They are given names so that they can more easily be
 892 tracked. */
 893
 894 enum { ERR0,  ERR1,  ERR2,  ERR3,  ERR4,  ERR5,  ERR6,  ERR7,  ERR8,  ERR9,
 895        ERR10, ERR11, ERR12, ERR13, ERR14, ERR15, ERR16, ERR17, ERR18, ERR19,
 896        ERR20, ERR21, ERR22, ERR23, ERR24, ERR25, ERR26, ERR27, ERR28, ERR29,
 897        ERR30, ERR31, ERR32, ERR33, ERR34, ERR35, ERR36, ERR37, ERR38, ERR39,
 898        ERR40, ERR41, ERR42, ERR43, ERR44, ERR45, ERR46, ERR47, ERR48, ERR49,
 899        ERR50, ERR51, ERR52, ERR53, ERR54, ERR55, ERR56, ERR57, ERR58, ERR59,
 900        ERR60, ERR61, ERR62, ERR63, ERR64 };
 901
 902 /* The real format of the start of the pcre block; the index of names and the
 903 code vector run on as long as necessary after the end. We store an explicit
 904 offset to the name table so that if a regex is compiled on one host, saved, and
 905 then run on another where the size of pointers is different, all might still
 906 be well. For the case of compiled-on-4 and run-on-8, we include an extra
 907 pointer that is always NULL. For future-proofing, a few dummy fields were
 908 originally included - even though you can never get this planning right - but
 909 there is only one left now.
 910
 911 NOTE NOTE NOTE:
 912 Because people can now save and re-use compiled patterns, any additions to this
 913 structure should be made at the end, and something earlier (e.g. a new
 914 flag in the options or one of the dummy fields) should indicate that the new
 915 fields are present. Currently PCRE always sets the dummy fields to zero.
 916 NOTE NOTE NOTE:
 917 */
 918
 919 typedef struct real_pcre {
 920   pcre_uint32 magic_number;
 921   pcre_uint32 size;               /* Total that was malloced */
 922   pcre_uint32 options;            /* Public options */
 923   pcre_uint16 flags;              /* Private flags */
 924   pcre_uint16 dummy1;             /* For future use */
 925   pcre_uint16 top_bracket;
 926   pcre_uint16 top_backref;
 927   pcre_uint16 first_byte;
 928   pcre_uint16 req_byte;
 929   pcre_uint16 name_table_offset;  /* Offset to name table that follows */
 930   pcre_uint16 name_entry_size;    /* Size of any name items */
 931   pcre_uint16 name_count;         /* Number of name items */
 932   pcre_uint16 ref_count;          /* Reference count */
 933
 934   const unsigned char *tables;    /* Pointer to tables or NULL for std */
 935   const unsigned char *nullpad;   /* NULL padding */
 936 } real_pcre;
 937
 938 /* The format of the block used to store data from pcre_study(). The same
 939 remark (see NOTE above) about extending this structure applies. */
 940
 941 typedef struct pcre_study_data {
 942   pcre_uint32 size;               /* Total that was malloced */
 943   pcre_uint32 options;
 944   uschar start_bits[32];
 945 } pcre_study_data;
 946
 947 /* Structure for passing "static" information around between the functions
 948 doing the compiling, so that they are thread-safe. */
 949
 950 typedef struct compile_data {
 951   const uschar *lcc;            /* Points to lower casing table */
 952   const uschar *fcc;            /* Points to case-flipping table */
 953   const uschar *cbits;          /* Points to character type table */
 954   const uschar *ctypes;         /* Points to table of type maps */
 955   const uschar *start_workspace;/* The start of working space */
 956   const uschar *start_code;     /* The start of the compiled code */
 957   const uschar *start_pattern;  /* The start of the pattern */
 958   const uschar *end_pattern;    /* The end of the pattern */
 959   uschar *hwm;                  /* High watermark of workspace */
 960   uschar *name_table;           /* The name/number table */
 961   int  names_found;             /* Number of entries so far */
 962   int  name_entry_size;         /* Size of each entry */
 963   int  bracount;                /* Count of capturing parens as we compile */
 964   int  final_bracount;          /* Saved value after first pass */
 965   int  top_backref;             /* Maximum back reference */
 966   unsigned int backref_map;     /* Bitmap of low back refs */
 967   int  external_options;        /* External (initial) options */
 968   int  external_flags;          /* External flag bits to be set */
 969   int  req_varyopt;             /* "After variable item" flag for reqbyte */
 970   BOOL had_accept;              /* (*ACCEPT) encountered */
 971   int  nltype;                  /* Newline type */
 972   int  nllen;                   /* Newline string length */
 973   uschar nl[4];                 /* Newline string when fixed length */
 974 } compile_data;
 975
 976 /* Structure for maintaining a chain of pointers to the currently incomplete
 977 branches, for testing for left recursion. */
 978
 979 typedef struct branch_chain {
 980   struct branch_chain *outer;
 981   uschar *current;
 982 } branch_chain;
 983
 984 /* Structure for items in a linked list that represents an explicit recursive
 985 call within the pattern. */
 986
 987 typedef struct recursion_info {
 988   struct recursion_info *prevrec; /* Previous recursion record (or NULL) */
 989   int group_num;                /* Number of group that was called */
 990   const uschar *after_call;     /* "Return value": points after the call in the expr */
 991   USPTR save_start;             /* Old value of mstart */
 992   int *offset_save;             /* Pointer to start of saved offsets */
 993   int saved_max;                /* Number of saved offsets */
 994 } recursion_info;
 995
 996 /* Structure for building a chain of data for holding the values of the subject
 997 pointer at the start of each subpattern, so as to detect when an empty string
 998 has been matched by a subpattern - to break infinite loops. */
 999
1000 typedef struct eptrblock {
1001   struct eptrblock *epb_prev;
1002   USPTR epb_saved_eptr;
1003 } eptrblock;
1004
1005
1006 /* Structure for passing "static" information around between the functions
1007 doing traditional NFA matching, so that they are thread-safe. */
1008
1009 typedef struct match_data {
1010   unsigned long int match_call_count;      /* As it says */
1011   unsigned long int match_limit;           /* As it says */
1012   unsigned long int match_limit_recursion; /* As it says */
1013   int   *offset_vector;         /* Offset vector */
1014   int    offset_end;            /* One past the end */
1015   int    offset_max;            /* The maximum usable for return data */
1016   int    nltype;                /* Newline type */
1017   int    nllen;                 /* Newline string length */
1018   uschar nl[4];                 /* Newline string when fixed */
1019   const uschar *lcc;            /* Points to lower casing table */
1020   const uschar *ctypes;         /* Points to table of type maps */
1021   BOOL   offset_overflow;       /* Set if too many extractions */
1022   BOOL   notbol;                /* NOTBOL flag */
1023   BOOL   noteol;                /* NOTEOL flag */
1024   BOOL   utf8;                  /* UTF8 flag */
1025   BOOL   jscript_compat;        /* JAVASCRIPT_COMPAT flag */
1026   BOOL   endonly;               /* Dollar not before final \n */
1027   BOOL   notempty;              /* Empty string match not wanted */
1028   BOOL   partial;               /* PARTIAL flag */
1029   BOOL   hitend;                /* Hit the end of the subject at some point */
1030   BOOL   bsr_anycrlf;           /* \R is just any CRLF, not full Unicode */
1031   const uschar *start_code;     /* For use when recursing */
1032   USPTR  start_subject;         /* Start of the subject string */
1033   USPTR  end_subject;           /* End of the subject string */
1034   USPTR  start_match_ptr;       /* Start of matched string */
1035   USPTR  end_match_ptr;         /* Subject position at end match */
1036   int    end_offset_top;        /* Highwater mark at end of match */
1037   int    capture_last;          /* Most recent capture number */
1038   int    start_offset;          /* The start offset value */
1039   eptrblock *eptrchain;         /* Chain of eptrblocks for tail recursions */
1040   int    eptrn;                 /* Next free eptrblock */
1041   recursion_info *recursive;    /* Linked list of recursion data */
1042   void  *callout_data;          /* To pass back to callouts */
1043 } match_data;
1044
1045 /* A similar structure is used for the same purpose by the DFA matching
1046 functions. */
1047
1048 typedef struct dfa_match_data {
1049   const uschar *start_code;     /* Start of the compiled pattern */
1050   const uschar *start_subject;  /* Start of the subject string */
1051   const uschar *end_subject;    /* End of subject string */
1052   const uschar *tables;         /* Character tables */
1053   int   moptions;               /* Match options */
1054   int   poptions;               /* Pattern options */
1055   int    nltype;                /* Newline type */
1056   int    nllen;                 /* Newline string length */
1057   uschar nl[4];                 /* Newline string when fixed */
1058   void  *callout_data;          /* To pass back to callouts */
1059 } dfa_match_data;
1060
1061 /* Bit definitions for entries in the pcre_ctypes table. */
1062
1063 #define ctype_space   0x01
1064 #define ctype_letter  0x02
1065 #define ctype_digit   0x04
1066 #define ctype_xdigit  0x08
1067 #define ctype_word    0x10   /* alphanumeric or '_' */
1068 #define ctype_meta    0x80   /* regexp meta char or zero (end pattern) */
1069
1070 /* Offsets for the bitmap tables in pcre_cbits. Each table contains a set
1071 of bits for a class map. Some classes are built by combining these tables. */
1072
1073 #define cbit_space     0      /* [:space:] or \s */
1074 #define cbit_xdigit   32      /* [:xdigit:] */
1075 #define cbit_digit    64      /* [:digit:] or \d */
1076 #define cbit_upper    96      /* [:upper:] */
1077 #define cbit_lower   128      /* [:lower:] */
1078 #define cbit_word    160      /* [:word:] or \w */
1079 #define cbit_graph   192      /* [:graph:] */
1080 #define cbit_print   224      /* [:print:] */
1081 #define cbit_punct   256      /* [:punct:] */
1082 #define cbit_cntrl   288      /* [:cntrl:] */
1083 #define cbit_length  320      /* Length of the cbits table */
1084
1085 /* Offsets of the various tables from the base tables pointer, and
1086 total length. */
1087
1088 #define lcc_offset      0
1089 #define fcc_offset    256
1090 #define cbits_offset  512
1091 #define ctypes_offset (cbits_offset + cbit_length)
1092 #define tables_length (ctypes_offset + 256)
1093
1094 /* Layout of the UCP type table that translates property names into types and
1095 codes. Each entry used to point directly to a name, but to reduce the number of
1096 relocations in shared libraries, it now has an offset into a single string
1097 instead. */
1098
1099 typedef struct {
1100   pcre_uint16 name_offset;
1101   pcre_uint16 type;
1102   pcre_uint16 value;
1103 } ucp_type_table;
1104
1105
1106 /* Internal shared data tables. These are tables that are used by more than one
1107 of the exported public functions. They have to be "external" in the C sense,
1108 but are not part of the PCRE public API. The data for these tables is in the
1109 pcre_tables.c module. */
1110
1111 extern const int    _pcre_utf8_table1[];
1112 extern const int    _pcre_utf8_table2[];
1113 extern const int    _pcre_utf8_table3[];
1114 extern const uschar _pcre_utf8_table4[];
1115
1116 extern const int    _pcre_utf8_table1_size;
1117
1118 extern const char   _pcre_utt_names[];
1119 extern const ucp_type_table _pcre_utt[];
1120 extern const int _pcre_utt_size;
1121
1122 extern const uschar _pcre_default_tables[];
1123
1124 extern const uschar _pcre_OP_lengths[];
1125
1126
1127 /* Internal shared functions. These are functions that are used by more than
1128 one of the exported public functions. They have to be "external" in the C
1129 sense, but are not part of the PCRE public API. */
1130
1131 extern BOOL         _pcre_is_newline(const uschar *, int, const uschar *,
1132                       int *, BOOL);
1133 extern int          _pcre_ord2utf8(int, uschar *);
1134 extern real_pcre   *_pcre_try_flipped(const real_pcre *, real_pcre *,
1135                       const pcre_study_data *, pcre_study_data *);
1136 extern int          _pcre_valid_utf8(const uschar *, int);
1137 extern BOOL         _pcre_was_newline(const uschar *, int, const uschar *,
1138                       int *, BOOL);
1139 extern BOOL         _pcre_xclass(int, const uschar *);
1140 extern unsigned int _pcre_ucp_othercase(unsigned int);
1141
1142
1143 extern const int         _pcre_ucp_gentype[];
1144
1145
1146 /* UCD access macros */
1147
1148 #include "../glib.h"
1149
1150 #define UCD_CHARTYPE(ch)  g_unichar_type(ch)
1151 #define UCD_SCRIPT(ch)    g_unichar_get_script(ch)
1152 #define UCD_CATEGORY(ch)  _pcre_ucp_gentype[UCD_CHARTYPE(ch)]
1153 #define UCD_OTHERCASE(ch) _pcre_ucp_othercase(ch)
1154
1155 #endif
1156
1157 /* End of pcre_internal.h */