/tags/beta3/harbour/source/hbpcre/pcreinal.h
C Header | 912 lines | 502 code | 181 blank | 229 comment | 28 complexity | 3ab546ee02d1aa260ac31b808aa9ab45 MD5 | raw file
Possible License(s): AGPL-1.0, BSD-3-Clause, CC-BY-SA-3.0, LGPL-3.0, GPL-2.0, LGPL-2.0, LGPL-2.1
- /*************************************************
- * Perl-Compatible Regular Expressions *
- *************************************************/
- /* PCRE is a library of functions to support regular expressions whose syntax
- and semantics are as close as possible to those of the Perl 5 language.
- Written by Philip Hazel
- Copyright (c) 1997-2005 University of Cambridge
- -----------------------------------------------------------------------------
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions are met:
- * Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in the
- documentation and/or other materials provided with the distribution.
- * Neither the name of the University of Cambridge nor the names of its
- contributors may be used to endorse or promote products derived from
- this software without specific prior written permission.
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
- SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
- INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
- CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- POSSIBILITY OF SUCH DAMAGE.
- -----------------------------------------------------------------------------
- */
- /* This header contains definitions that are shared between the different
- modules, but which are not relevant to the exported API. This includes some
- functions whose names all begin with "_pcre_". */
- /* Define DEBUG to get debugging output on stdout. */
- /****
- #define DEBUG
- ****/
- /* Use a macro for debugging printing, 'cause that eliminates the use of #ifdef
- inline, and there are *still* stupid compilers about that don't like indented
- pre-processor statements, or at least there were when I first wrote this. After
- all, it had only been about 10 years then... */
- #ifdef DEBUG
- #define DPRINTF(p) printf p
- #else
- #define DPRINTF(p) /*nothing*/
- #endif
- /* Get the definitions provided by running "configure" */
- #include "config.h"
- /* Standard C headers plus the external interface definition. The only time
- setjmp and stdarg are used is when NO_RECURSE is set. */
- #include <ctype.h>
- #include <limits.h>
- #include <setjmp.h>
- #include <stdarg.h>
- #include <stddef.h>
- #include <stdio.h>
- #include <stdlib.h>
- #include <string.h>
- #ifndef PCRE_SPY
- #define PCRE_DEFINITION /* Win32 __declspec(export) trigger for .dll */
- #endif
- /* We need to have types that specify unsigned 16-bit and 32-bit integers. We
- cannot determine these outside the compilation (e.g. by running a program as
- part of "configure") because PCRE is often cross-compiled for use on other
- systems. Instead we make use of the maximum sizes that are available at
- preprocessor time in standard C environments. */
- #if USHRT_MAX == 65535
- typedef unsigned short pcre_uint16;
- #elif UINT_MAX == 65535
- typedef unsigned int pcre_uint16;
- #else
- #error Cannot determine a type for 16-bit unsigned integers
- #endif
- #if UINT_MAX == 4294967295
- typedef unsigned int pcre_uint32;
- #elif ULONG_MAX == 4294967295
- typedef unsigned long int pcre_uint32;
- #else
- #error Cannot determine a type for 32-bit unsigned integers
- #endif
- /* All character handling must be done as unsigned characters. Otherwise there
- are problems with top-bit-set characters and functions such as isspace().
- However, we leave the interface to the outside world as char *, because that
- should make things easier for callers. We define a short type for unsigned char
- to save lots of typing. I tried "uchar", but it causes problems on Digital
- Unix, where it is defined in sys/types, so use "uschar" instead. */
- typedef unsigned char uschar;
- /* Include the public PCRE header */
- #include "pcre.h"
- /* Include the (copy of) the public ucp header, changing the external name into
- a private one. This does no harm, even if we aren't compiling UCP support. */
- #define ucp_findchar _pcre_ucp_findchar
- #include "ucp.h"
- /* When compiling for use with the Virtual Pascal compiler, these functions
- need to have their names changed. PCRE must be compiled with the -DVPCOMPAT
- option on the command line. */
- #ifdef VPCOMPAT
- #define strncmp(s1,s2,m) _strncmp(s1,s2,m)
- #define memcpy(d,s,n) _memcpy(d,s,n)
- #define memmove(d,s,n) _memmove(d,s,n)
- #define memset(s,c,n) _memset(s,c,n)
- #else /* VPCOMPAT */
- /* To cope with SunOS4 and other systems that lack memmove() but have bcopy(),
- define a macro for memmove() if HAVE_MEMMOVE is false, provided that HAVE_BCOPY
- is set. Otherwise, include an emulating function for those systems that have
- neither (there some non-Unix environments where this is the case). This assumes
- that all calls to memmove are moving strings upwards in store, which is the
- case in PCRE. */
- #if ! HAVE_MEMMOVE
- #undef memmove /* some systems may have a macro */
- #if HAVE_BCOPY
- #define memmove(a, b, c) bcopy(b, a, c)
- #else /* HAVE_BCOPY */
- void *
- pcre_memmove(unsigned char *dest, const unsigned char *src, size_t n)
- {
- int i;
- dest += n;
- src += n;
- for (i = 0; i < n; ++i) *(--dest) = *(--src);
- }
- #define memmove(a, b, c) pcre_memmove(a, b, c)
- #endif /* not HAVE_BCOPY */
- #endif /* not HAVE_MEMMOVE */
- #endif /* not VPCOMPAT */
- /* PCRE keeps offsets in its compiled code as 2-byte quantities (always stored
- in big-endian order) by default. These are used, for example, to link from the
- start of a subpattern to its alternatives and its end. The use of 2 bytes per
- offset limits the size of the compiled regex to around 64K, which is big enough
- for almost everybody. However, I received a request for an even bigger limit.
- For this reason, and also to make the code easier to maintain, the storing and
- loading of offsets from the byte string is now handled by the macros that are
- defined here.
- The macros are controlled by the value of LINK_SIZE. This defaults to 2 in
- the config.h file, but can be overridden by using -D on the command line. This
- is automated on Unix systems via the "configure" command. */
- #if LINK_SIZE == 2
- #define PUT(a,n,d) \
- (a[n] = (d) >> 8), \
- (a[(n)+1] = (d) & 255)
- #define GET(a,n) \
- (((a)[n] << 8) | (a)[(n)+1])
- #define MAX_PATTERN_SIZE (1 << 16)
- #elif LINK_SIZE == 3
- #define PUT(a,n,d) \
- (a[n] = (d) >> 16), \
- (a[(n)+1] = (d) >> 8), \
- (a[(n)+2] = (d) & 255)
- #define GET(a,n) \
- (((a)[n] << 16) | ((a)[(n)+1] << 8) | (a)[(n)+2])
- #define MAX_PATTERN_SIZE (1 << 24)
- #elif LINK_SIZE == 4
- #define PUT(a,n,d) \
- (a[n] = (d) >> 24), \
- (a[(n)+1] = (d) >> 16), \
- (a[(n)+2] = (d) >> 8), \
- (a[(n)+3] = (d) & 255)
- #define GET(a,n) \
- (((a)[n] << 24) | ((a)[(n)+1] << 16) | ((a)[(n)+2] << 8) | (a)[(n)+3])
- #define MAX_PATTERN_SIZE (1 << 30) /* Keep it positive */
- #else
- #error LINK_SIZE must be either 2, 3, or 4
- #endif
- /* Convenience macro defined in terms of the others */
- #define PUTINC(a,n,d) PUT(a,n,d), a += LINK_SIZE
- /* PCRE uses some other 2-byte quantities that do not change when the size of
- offsets changes. There are used for repeat counts and for other things such as
- capturing parenthesis numbers in back references. */
- #define PUT2(a,n,d) \
- a[n] = (d) >> 8; \
- a[(n)+1] = (d) & 255
- #define GET2(a,n) \
- (((a)[n] << 8) | (a)[(n)+1])
- #define PUT2INC(a,n,d) PUT2(a,n,d), a += 2
- /* When UTF-8 encoding is being used, a character is no longer just a single
- byte. The macros for character handling generate simple sequences when used in
- byte-mode, and more complicated ones for UTF-8 characters. */
- #ifndef SUPPORT_UTF8
- #define GETCHAR(c, eptr) c = *eptr;
- #define GETCHARTEST(c, eptr) c = *eptr;
- #define GETCHARINC(c, eptr) c = *eptr++;
- #define GETCHARINCTEST(c, eptr) c = *eptr++;
- #define GETCHARLEN(c, eptr, len) c = *eptr;
- #define BACKCHAR(eptr)
- #else /* SUPPORT_UTF8 */
- /* Get the next UTF-8 character, not advancing the pointer. This is called when
- we know we are in UTF-8 mode. */
- #define GETCHAR(c, eptr) \
- c = *eptr; \
- if ((c & 0xc0) == 0xc0) \
- { \
- int gcii; \
- int gcaa = _pcre_utf8_table4[c & 0x3f]; /* Number of additional bytes */ \
- int gcss = 6*gcaa; \
- c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
- for (gcii = 1; gcii <= gcaa; gcii++) \
- { \
- gcss -= 6; \
- c |= (eptr[gcii] & 0x3f) << gcss; \
- } \
- }
- /* Get the next UTF-8 character, testing for UTF-8 mode, and not advancing the
- pointer. */
- #define GETCHARTEST(c, eptr) \
- c = *eptr; \
- if (utf8 && (c & 0xc0) == 0xc0) \
- { \
- int gcii; \
- int gcaa = _pcre_utf8_table4[c & 0x3f]; /* Number of additional bytes */ \
- int gcss = 6*gcaa; \
- c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
- for (gcii = 1; gcii <= gcaa; gcii++) \
- { \
- gcss -= 6; \
- c |= (eptr[gcii] & 0x3f) << gcss; \
- } \
- }
- /* Get the next UTF-8 character, advancing the pointer. This is called when we
- know we are in UTF-8 mode. */
- #define GETCHARINC(c, eptr) \
- c = *eptr++; \
- if ((c & 0xc0) == 0xc0) \
- { \
- int gcaa = _pcre_utf8_table4[c & 0x3f]; /* Number of additional bytes */ \
- int gcss = 6*gcaa; \
- c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
- while (gcaa-- > 0) \
- { \
- gcss -= 6; \
- c |= (*eptr++ & 0x3f) << gcss; \
- } \
- }
- /* Get the next character, testing for UTF-8 mode, and advancing the pointer */
- #define GETCHARINCTEST(c, eptr) \
- c = *eptr++; \
- if (utf8 && (c & 0xc0) == 0xc0) \
- { \
- int gcaa = _pcre_utf8_table4[c & 0x3f]; /* Number of additional bytes */ \
- int gcss = 6*gcaa; \
- c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
- while (gcaa-- > 0) \
- { \
- gcss -= 6; \
- c |= (*eptr++ & 0x3f) << gcss; \
- } \
- }
- /* Get the next UTF-8 character, not advancing the pointer, incrementing length
- if there are extra bytes. This is called when we know we are in UTF-8 mode. */
- #define GETCHARLEN(c, eptr, len) \
- c = *eptr; \
- if ((c & 0xc0) == 0xc0) \
- { \
- int gcii; \
- int gcaa = _pcre_utf8_table4[c & 0x3f]; /* Number of additional bytes */ \
- int gcss = 6*gcaa; \
- c = (c & _pcre_utf8_table3[gcaa]) << gcss; \
- for (gcii = 1; gcii <= gcaa; gcii++) \
- { \
- gcss -= 6; \
- c |= (eptr[gcii] & 0x3f) << gcss; \
- } \
- len += gcaa; \
- }
- /* If the pointer is not at the start of a character, move it back until
- it is. Called only in UTF-8 mode. */
- #define BACKCHAR(eptr) while((*eptr & 0xc0) == 0x80) eptr--;
- #endif
- /* In case there is no definition of offsetof() provided - though any proper
- Standard C system should have one. */
- #ifndef offsetof
- #define offsetof(p_type,field) ((size_t)&(((p_type *)0)->field))
- #endif
- /* These are the public options that can change during matching. */
- #define PCRE_IMS (PCRE_CASELESS|PCRE_MULTILINE|PCRE_DOTALL)
- /* Private options flags start at the most significant end of the four bytes,
- but skip the top bit so we can use ints for convenience without getting tangled
- with negative values. The public options defined in pcre.h start at the least
- significant end. Make sure they don't overlap! */
- #define PCRE_FIRSTSET 0x40000000 /* first_byte is set */
- #define PCRE_REQCHSET 0x20000000 /* req_byte is set */
- #define PCRE_STARTLINE 0x10000000 /* start after \n for multiline */
- #define PCRE_ICHANGED 0x08000000 /* i option changes within regex */
- #define PCRE_NOPARTIAL 0x04000000 /* can't use partial with this regex */
- /* Options for the "extra" block produced by pcre_study(). */
- #define PCRE_STUDY_MAPPED 0x01 /* a map of starting chars exists */
- /* Masks for identifying the public options that are permitted at compile
- time, run time, or study time, respectively. */
- #define PUBLIC_OPTIONS \
- (PCRE_CASELESS|PCRE_EXTENDED|PCRE_ANCHORED|PCRE_MULTILINE| \
- PCRE_DOTALL|PCRE_DOLLAR_ENDONLY|PCRE_EXTRA|PCRE_UNGREEDY|PCRE_UTF8| \
- PCRE_NO_AUTO_CAPTURE|PCRE_NO_UTF8_CHECK|PCRE_AUTO_CALLOUT|PCRE_FIRSTLINE)
- #define PUBLIC_EXEC_OPTIONS \
- (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NO_UTF8_CHECK| \
- PCRE_PARTIAL)
- #define PUBLIC_DFA_EXEC_OPTIONS \
- (PCRE_ANCHORED|PCRE_NOTBOL|PCRE_NOTEOL|PCRE_NOTEMPTY|PCRE_NO_UTF8_CHECK| \
- PCRE_PARTIAL|PCRE_DFA_SHORTEST|PCRE_DFA_RESTART)
- #define PUBLIC_STUDY_OPTIONS 0 /* None defined */
- /* Magic number to provide a small check against being handed junk. Also used
- to detect whether a pattern was compiled on a host of different endianness. */
- #define MAGIC_NUMBER 0x50435245UL /* 'PCRE' */
- /* Negative values for the firstchar and reqchar variables */
- #define REQ_UNSET (-2)
- #define REQ_NONE (-1)
- /* The maximum remaining length of subject we are prepared to search for a
- req_byte match. */
- #define REQ_BYTE_MAX 1000
- /* Flags added to firstbyte or reqbyte; a "non-literal" item is either a
- variable-length repeat, or a anything other than literal characters. */
- #define REQ_CASELESS 0x0100 /* indicates caselessness */
- #define REQ_VARY 0x0200 /* reqbyte followed non-literal item */
- /* Miscellaneous definitions */
- /* 30/08/2005 - <maurilio.longo@libero.it>
- Use xharbour typedefs if they exist, ie, this file
- has been included after xharbour ones
- */
- #ifndef FALSE
- typedef int BOOL;
- #define FALSE 0
- #define TRUE 1
- #endif
- /* Escape items that are just an encoding of a particular data value. Note that
- ESC_n is defined as yet another macro, which is set in config.h to either \n
- (the default) or \r (which some people want). */
- #ifndef ESC_e
- #define ESC_e 27
- #endif
- #ifndef ESC_f
- #define ESC_f '\f'
- #endif
- #ifndef ESC_n
- #define ESC_n NEWLINE
- #endif
- #ifndef ESC_r
- #define ESC_r '\r'
- #endif
- /* We can't officially use ESC_t because it is a POSIX reserved identifier
- (presumably because of all the others like size_t). */
- #ifndef ESC_tee
- #define ESC_tee '\t'
- #endif
- /* These are escaped items that aren't just an encoding of a particular data
- value such as \n. They must have non-zero values, as check_escape() returns
- their negation. Also, they must appear in the same order as in the opcode
- definitions below, up to ESC_z. There's a dummy for OP_ANY because it
- corresponds to "." rather than an escape sequence. The final one must be
- ESC_REF as subsequent values are used for \1, \2, \3, etc. There is are two
- tests in the code for an escape greater than ESC_b and less than ESC_Z to
- detect the types that may be repeated. These are the types that consume
- characters. If any new escapes are put in between that don't consume a
- character, that code will have to change. */
- enum { ESC_A = 1, ESC_G, ESC_B, ESC_b, ESC_D, ESC_d, ESC_S, ESC_s, ESC_W,
- ESC_w, ESC_dum1, ESC_C, ESC_P, ESC_p, ESC_X, ESC_Z, ESC_z, ESC_E,
- ESC_Q, ESC_REF };
- /* Flag bits and data types for the extended class (OP_XCLASS) for classes that
- contain UTF-8 characters with values greater than 255. */
- #define XCL_NOT 0x01 /* Flag: this is a negative class */
- #define XCL_MAP 0x02 /* Flag: a 32-byte map is present */
- #define XCL_END 0 /* Marks end of individual items */
- #define XCL_SINGLE 1 /* Single item (one multibyte char) follows */
- #define XCL_RANGE 2 /* A range (two multibyte chars) follows */
- #define XCL_PROP 3 /* Unicode property (one property code) follows */
- #define XCL_NOTPROP 4 /* Unicode inverted property (ditto) */
- /* Opcode table: OP_BRA must be last, as all values >= it are used for brackets
- that extract substrings. Starting from 1 (i.e. after OP_END), the values up to
- OP_EOD must correspond in order to the list of escapes immediately above.
- Note that whenever this list is updated, the two macro definitions that follow
- must also be updated to match. */
- enum {
- OP_END, /* 0 End of pattern */
- /* Values corresponding to backslashed metacharacters */
- OP_SOD, /* 1 Start of data: \A */
- OP_SOM, /* 2 Start of match (subject + offset): \G */
- OP_NOT_WORD_BOUNDARY, /* 3 \B */
- OP_WORD_BOUNDARY, /* 4 \b */
- OP_NOT_DIGIT, /* 5 \D */
- OP_DIGIT, /* 6 \d */
- OP_NOT_WHITESPACE, /* 7 \S */
- OP_WHITESPACE, /* 8 \s */
- OP_NOT_WORDCHAR, /* 9 \W */
- OP_WORDCHAR, /* 10 \w */
- OP_ANY, /* 11 Match any character */
- OP_ANYBYTE, /* 12 Match any byte (\C); different to OP_ANY for UTF-8 */
- OP_NOTPROP, /* 13 \P (not Unicode property) */
- OP_PROP, /* 14 \p (Unicode property) */
- OP_EXTUNI, /* 15 \X (extended Unicode sequence */
- OP_EODN, /* 16 End of data or \n at end of data: \Z. */
- OP_EOD, /* 17 End of data: \z */
- OP_OPT, /* 18 Set runtime options */
- OP_CIRC, /* 19 Start of line - varies with multiline switch */
- OP_DOLL, /* 20 End of line - varies with multiline switch */
- OP_CHAR, /* 21 Match one character, casefully */
- OP_CHARNC, /* 22 Match one character, caselessly */
- OP_NOT, /* 23 Match anything but the following char */
- OP_STAR, /* 24 The maximizing and minimizing versions of */
- OP_MINSTAR, /* 25 all these opcodes must come in pairs, with */
- OP_PLUS, /* 26 the minimizing one second. */
- OP_MINPLUS, /* 27 This first set applies to single characters */
- OP_QUERY, /* 28 */
- OP_MINQUERY, /* 29 */
- OP_UPTO, /* 30 From 0 to n matches */
- OP_MINUPTO, /* 31 */
- OP_EXACT, /* 32 Exactly n matches */
- OP_NOTSTAR, /* 33 The maximizing and minimizing versions of */
- OP_NOTMINSTAR, /* 34 all these opcodes must come in pairs, with */
- OP_NOTPLUS, /* 35 the minimizing one second. */
- OP_NOTMINPLUS, /* 36 This set applies to "not" single characters */
- OP_NOTQUERY, /* 37 */
- OP_NOTMINQUERY, /* 38 */
- OP_NOTUPTO, /* 39 From 0 to n matches */
- OP_NOTMINUPTO, /* 40 */
- OP_NOTEXACT, /* 41 Exactly n matches */
- OP_TYPESTAR, /* 42 The maximizing and minimizing versions of */
- OP_TYPEMINSTAR, /* 43 all these opcodes must come in pairs, with */
- OP_TYPEPLUS, /* 44 the minimizing one second. These codes must */
- OP_TYPEMINPLUS, /* 45 be in exactly the same order as those above. */
- OP_TYPEQUERY, /* 46 This set applies to character types such as \d */
- OP_TYPEMINQUERY, /* 47 */
- OP_TYPEUPTO, /* 48 From 0 to n matches */
- OP_TYPEMINUPTO, /* 49 */
- OP_TYPEEXACT, /* 50 Exactly n matches */
- OP_CRSTAR, /* 51 The maximizing and minimizing versions of */
- OP_CRMINSTAR, /* 52 all these opcodes must come in pairs, with */
- OP_CRPLUS, /* 53 the minimizing one second. These codes must */
- OP_CRMINPLUS, /* 54 be in exactly the same order as those above. */
- OP_CRQUERY, /* 55 These are for character classes and back refs */
- OP_CRMINQUERY, /* 56 */
- OP_CRRANGE, /* 57 These are different to the three sets above. */
- OP_CRMINRANGE, /* 58 */
- OP_CLASS, /* 59 Match a character class, chars < 256 only */
- OP_NCLASS, /* 60 Same, but the bitmap was created from a negative
- class - the difference is relevant only when a UTF-8
- character > 255 is encountered. */
- OP_XCLASS, /* 61 Extended class for handling UTF-8 chars within the
- class. This does both positive and negative. */
- OP_REF, /* 62 Match a back reference */
- OP_RECURSE, /* 63 Match a numbered subpattern (possibly recursive) */
- OP_CALLOUT, /* 64 Call out to external function if provided */
- OP_ALT, /* 65 Start of alternation */
- OP_KET, /* 66 End of group that doesn't have an unbounded repeat */
- OP_KETRMAX, /* 67 These two must remain together and in this */
- OP_KETRMIN, /* 68 order. They are for groups the repeat for ever. */
- /* The assertions must come before ONCE and COND */
- OP_ASSERT, /* 69 Positive lookahead */
- OP_ASSERT_NOT, /* 70 Negative lookahead */
- OP_ASSERTBACK, /* 71 Positive lookbehind */
- OP_ASSERTBACK_NOT, /* 72 Negative lookbehind */
- OP_REVERSE, /* 73 Move pointer back - used in lookbehind assertions */
- /* ONCE and COND must come after the assertions, with ONCE first, as there's
- a test for >= ONCE for a subpattern that isn't an assertion. */
- OP_ONCE, /* 74 Once matched, don't back up into the subpattern */
- OP_COND, /* 75 Conditional group */
- OP_CREF, /* 76 Used to hold an extraction string number (cond ref) */
- OP_BRAZERO, /* 77 These two must remain together and in this */
- OP_BRAMINZERO, /* 78 order. */
- OP_BRANUMBER, /* 79 Used for extracting brackets whose number is greater
- than can fit into an opcode. */
- OP_BRA /* 80 This and greater values are used for brackets that
- extract substrings up to EXTRACT_BASIC_MAX. After
- that, use is made of OP_BRANUMBER. */
- };
- /* WARNING WARNING WARNING: There is an implicit assumption in pcre.c and
- study.c that all opcodes are less than 128 in value. This makes handling UTF-8
- character sequences easier. */
- /* The highest extraction number before we have to start using additional
- bytes. (Originally PCRE didn't have support for extraction counts highter than
- this number.) The value is limited by the number of opcodes left after OP_BRA,
- i.e. 255 - OP_BRA. We actually set it a bit lower to leave room for additional
- opcodes. */
- #define EXTRACT_BASIC_MAX 100
- /* This macro defines textual names for all the opcodes. These are used only
- for debugging. The macro is referenced only in pcreprni.c. */
- #define OP_NAME_LIST \
- "End", "\\A", "\\G", "\\B", "\\b", "\\D", "\\d", \
- "\\S", "\\s", "\\W", "\\w", "Any", "Anybyte", \
- "notprop", "prop", "extuni", \
- "\\Z", "\\z", \
- "Opt", "^", "$", "char", "charnc", "not", \
- "*", "*?", "+", "+?", "?", "??", "{", "{", "{", \
- "*", "*?", "+", "+?", "?", "??", "{", "{", "{", \
- "*", "*?", "+", "+?", "?", "??", "{", "{", "{", \
- "*", "*?", "+", "+?", "?", "??", "{", "{", \
- "class", "nclass", "xclass", "Ref", "Recurse", "Callout", \
- "Alt", "Ket", "KetRmax", "KetRmin", "Assert", "Assert not", \
- "AssertB", "AssertB not", "Reverse", "Once", "Cond", "Cond ref",\
- "Brazero", "Braminzero", "Branumber", "Bra"
- /* This macro defines the length of fixed length operations in the compiled
- regex. The lengths are used when searching for specific things, and also in the
- debugging printing of a compiled regex. We use a macro so that it can be
- defined close to the definitions of the opcodes themselves.
- As things have been extended, some of these are no longer fixed lenths, but are
- minima instead. For example, the length of a single-character repeat may vary
- in UTF-8 mode. The code that uses this table must know about such things. */
- #define OP_LENGTHS \
- 1, /* End */ \
- 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* \A, \G, \B, \B, \D, \d, \S, \s, \W, \w */ \
- 1, 1, /* Any, Anybyte */ \
- 2, 2, 1, /* NOTPROP, PROP, EXTUNI */ \
- 1, 1, 2, 1, 1, /* \Z, \z, Opt, ^, $ */ \
- 2, /* Char - the minimum length */ \
- 2, /* Charnc - the minimum length */ \
- 2, /* not */ \
- /* Positive single-char repeats ** These are */ \
- 2, 2, 2, 2, 2, 2, /* *, *?, +, +?, ?, ?? ** minima in */ \
- 4, 4, 4, /* upto, minupto, exact ** UTF-8 mode */ \
- /* Negative single-char repeats - only for chars < 256 */ \
- 2, 2, 2, 2, 2, 2, /* NOT *, *?, +, +?, ?, ?? */ \
- 4, 4, 4, /* NOT upto, minupto, exact */ \
- /* Positive type repeats */ \
- 2, 2, 2, 2, 2, 2, /* Type *, *?, +, +?, ?, ?? */ \
- 4, 4, 4, /* Type upto, minupto, exact */ \
- /* Character class & ref repeats */ \
- 1, 1, 1, 1, 1, 1, /* *, *?, +, +?, ?, ?? */ \
- 5, 5, /* CRRANGE, CRMINRANGE */ \
- 33, /* CLASS */ \
- 33, /* NCLASS */ \
- 0, /* XCLASS - variable length */ \
- 3, /* REF */ \
- 1+LINK_SIZE, /* RECURSE */ \
- 2+2*LINK_SIZE, /* CALLOUT */ \
- 1+LINK_SIZE, /* Alt */ \
- 1+LINK_SIZE, /* Ket */ \
- 1+LINK_SIZE, /* KetRmax */ \
- 1+LINK_SIZE, /* KetRmin */ \
- 1+LINK_SIZE, /* Assert */ \
- 1+LINK_SIZE, /* Assert not */ \
- 1+LINK_SIZE, /* Assert behind */ \
- 1+LINK_SIZE, /* Assert behind not */ \
- 1+LINK_SIZE, /* Reverse */ \
- 1+LINK_SIZE, /* Once */ \
- 1+LINK_SIZE, /* COND */ \
- 3, /* CREF */ \
- 1, 1, /* BRAZERO, BRAMINZERO */ \
- 3, /* BRANUMBER */ \
- 1+LINK_SIZE /* BRA */ \
- /* A magic value for OP_CREF to indicate the "in recursion" condition. */
- #define CREF_RECURSE 0xffff
- /* Error code numbers. They are given names so that they can more easily be
- tracked. */
- enum { ERR0, ERR1, ERR2, ERR3, ERR4, ERR5, ERR6, ERR7, ERR8, ERR9,
- ERR10, ERR11, ERR12, ERR13, ERR14, ERR15, ERR16, ERR17, ERR18, ERR19,
- ERR20, ERR21, ERR22, ERR23, ERR24, ERR25, ERR26, ERR27, ERR28, ERR29,
- ERR30, ERR31, ERR32, ERR33, ERR34, ERR35, ERR36, ERR37, ERR38, ERR39,
- ERR40, ERR41, ERR42, ERR43, ERR44, ERR45, ERR46, ERR47 };
- /* The real format of the start of the pcre block; the index of names and the
- code vector run on as long as necessary after the end. We store an explicit
- offset to the name table so that if a regex is compiled on one host, saved, and
- then run on another where the size of pointers is different, all might still
- be well. For the case of compiled-on-4 and run-on-8, we include an extra
- pointer that is always NULL. For future-proofing, a few dummy fields were
- originally included - even though you can never get this planning right - but
- there is only one left now.
- NOTE NOTE NOTE:
- Because people can now save and re-use compiled patterns, any additions to this
- structure should be made at the end, and something earlier (e.g. a new
- flag in the options or one of the dummy fields) should indicate that the new
- fields are present. Currently PCRE always sets the dummy fields to zero.
- NOTE NOTE NOTE:
- */
- typedef struct real_pcre {
- pcre_uint32 magic_number;
- pcre_uint32 size; /* Total that was malloced */
- pcre_uint32 options;
- pcre_uint32 dummy1; /* For future use, maybe */
- pcre_uint16 top_bracket;
- pcre_uint16 top_backref;
- pcre_uint16 first_byte;
- pcre_uint16 req_byte;
- pcre_uint16 name_table_offset; /* Offset to name table that follows */
- pcre_uint16 name_entry_size; /* Size of any name items */
- pcre_uint16 name_count; /* Number of name items */
- pcre_uint16 ref_count; /* Reference count */
- const unsigned char *tables; /* Pointer to tables or NULL for std */
- const unsigned char *nullpad; /* NULL padding */
- } real_pcre;
- /* The format of the block used to store data from pcre_study(). The same
- remark (see NOTE above) about extending this structure applies. */
- typedef struct pcre_study_data {
- pcre_uint32 size; /* Total that was malloced */
- pcre_uint32 options;
- uschar start_bits[32];
- } pcre_study_data;
- /* Structure for passing "static" information around between the functions
- doing the compiling, so that they are thread-safe. */
- typedef struct compile_data {
- const uschar *lcc; /* Points to lower casing table */
- const uschar *fcc; /* Points to case-flipping table */
- const uschar *cbits; /* Points to character type table */
- const uschar *ctypes; /* Points to table of type maps */
- const uschar *start_code; /* The start of the compiled code */
- const uschar *start_pattern; /* The start of the pattern */
- uschar *name_table; /* The name/number table */
- int names_found; /* Number of entries so far */
- int name_entry_size; /* Size of each entry */
- int top_backref; /* Maximum back reference */
- unsigned int backref_map; /* Bitmap of low back refs */
- int req_varyopt; /* "After variable item" flag for reqbyte */
- BOOL nopartial; /* Set TRUE if partial won't work */
- } compile_data;
- /* Structure for maintaining a chain of pointers to the currently incomplete
- branches, for testing for left recursion. */
- typedef struct branch_chain {
- struct branch_chain *outer;
- uschar *current;
- } branch_chain;
- /* Structure for items in a linked list that represents an explicit recursive
- call within the pattern. */
- typedef struct recursion_info {
- struct recursion_info *prevrec; /* Previous recursion record (or NULL) */
- int group_num; /* Number of group that was called */
- const uschar *after_call; /* "Return value": points after the call in the expr */
- const uschar *save_start; /* Old value of md->start_match */
- int *offset_save; /* Pointer to start of saved offsets */
- int saved_max; /* Number of saved offsets */
- } recursion_info;
- /* When compiling in a mode that doesn't use recursive calls to match(),
- a structure is used to remember local variables on the heap. It is defined in
- pcre.c, close to the match() function, so that it is easy to keep it in step
- with any changes of local variable. However, the pointer to the current frame
- must be saved in some "static" place over a longjmp(). We declare the
- structure here so that we can put a pointer in the match_data structure.
- NOTE: This isn't used for a "normal" compilation of pcre. */
- struct heapframe;
- /* Structure for passing "static" information around between the functions
- doing traditional NFA matching, so that they are thread-safe. */
- typedef struct match_data {
- unsigned long int match_call_count; /* As it says */
- unsigned long int match_limit;/* As it says */
- int *offset_vector; /* Offset vector */
- int offset_end; /* One past the end */
- int offset_max; /* The maximum usable for return data */
- const uschar *lcc; /* Points to lower casing table */
- const uschar *ctypes; /* Points to table of type maps */
- BOOL offset_overflow; /* Set if too many extractions */
- BOOL notbol; /* NOTBOL flag */
- BOOL noteol; /* NOTEOL flag */
- BOOL utf8; /* UTF8 flag */
- BOOL endonly; /* Dollar not before final \n */
- BOOL notempty; /* Empty string match not wanted */
- BOOL partial; /* PARTIAL flag */
- BOOL hitend; /* Hit the end of the subject at some point */
- const uschar *start_code; /* For use when recursing */
- const uschar *start_subject; /* Start of the subject string */
- const uschar *end_subject; /* End of the subject string */
- const uschar *start_match; /* Start of this match attempt */
- const uschar *end_match_ptr; /* Subject position at end match */
- int end_offset_top; /* Highwater mark at end of match */
- int capture_last; /* Most recent capture number */
- int start_offset; /* The start offset value */
- recursion_info *recursive; /* Linked list of recursion data */
- void *callout_data; /* To pass back to callouts */
- struct heapframe *thisframe; /* Used only when compiling for no recursion */
- } match_data;
- /* A similar structure is used for the same purpose by the DFA matching
- functions. */
- typedef struct dfa_match_data {
- const uschar *start_code; /* Start of the compiled pattern */
- const uschar *start_subject; /* Start of the subject string */
- const uschar *end_subject; /* End of subject string */
- const uschar *tables; /* Character tables */
- int moptions; /* Match options */
- int poptions; /* Pattern options */
- void *callout_data; /* To pass back to callouts */
- } dfa_match_data;
- /* Bit definitions for entries in the pcre_ctypes table. */
- #define ctype_space 0x01
- #define ctype_letter 0x02
- #define ctype_digit 0x04
- #define ctype_xdigit 0x08
- #define ctype_word 0x10 /* alphameric or '_' */
- #define ctype_meta 0x80 /* regexp meta char or zero (end pattern) */
- /* Offsets for the bitmap tables in pcre_cbits. Each table contains a set
- of bits for a class map. Some classes are built by combining these tables. */
- #define cbit_space 0 /* [:space:] or \s */
- #define cbit_xdigit 32 /* [:xdigit:] */
- #define cbit_digit 64 /* [:digit:] or \d */
- #define cbit_upper 96 /* [:upper:] */
- #define cbit_lower 128 /* [:lower:] */
- #define cbit_word 160 /* [:word:] or \w */
- #define cbit_graph 192 /* [:graph:] */
- #define cbit_print 224 /* [:print:] */
- #define cbit_punct 256 /* [:punct:] */
- #define cbit_cntrl 288 /* [:cntrl:] */
- #define cbit_length 320 /* Length of the cbits table */
- /* Offsets of the various tables from the base tables pointer, and
- total length. */
- #define lcc_offset 0
- #define fcc_offset 256
- #define cbits_offset 512
- #define ctypes_offset (cbits_offset + cbit_length)
- #define tables_length (ctypes_offset + 256)
- /* Layout of the UCP type table that translates property names into codes for
- ucp_findchar(). */
- typedef struct {
- const char *name;
- int value;
- } ucp_type_table;
- /* Internal shared data tables. These are tables that are used by more than one
- of the exported public functions. They have to be "external" in the C sense,
- but are not part of the PCRE public API. The data for these tables is in the
- pcretabs.c module. */
- extern const int _pcre_utf8_table1[];
- extern const int _pcre_utf8_table2[];
- extern const int _pcre_utf8_table3[];
- extern const uschar _pcre_utf8_table4[];
- extern const int _pcre_utf8_table1_size;
- extern const ucp_type_table _pcre_utt[];
- extern const int _pcre_utt_size;
- extern const uschar _pcre_default_tables[];
- extern const uschar _pcre_OP_lengths[];
- /* Internal shared functions. These are functions that are used by more than
- one of the exported public functions. They have to be "external" in the C
- sense, but are not part of the PCRE public API. */
- extern int _pcre_ord2utf8(int, uschar *);
- extern void _pcre_printint(pcre *, FILE *);
- extern real_pcre * _pcre_try_flipped(const real_pcre *, real_pcre *,
- const pcre_study_data *, pcre_study_data *);
- extern int _pcre_ucp_findchar(const int, int *, int *);
- extern int _pcre_valid_utf8(const uschar *, int);
- extern BOOL _pcre_xclass(int, const uschar *);
- /* End of pcreinal.h */