| 1 |
nigel |
87 |
/************************************************* |
| 2 |
|
|
* Perl-Compatible Regular Expressions * |
| 3 |
|
|
*************************************************/ |
| 4 |
|
|
|
| 5 |
|
|
/* This is the public header file for the PCRE library, to be #included by |
| 6 |
|
|
applications that call the PCRE functions. |
| 7 |
|
|
|
| 8 |
|
|
Copyright (c) 1997-2005 University of Cambridge |
| 9 |
|
|
|
| 10 |
|
|
----------------------------------------------------------------------------- |
| 11 |
|
|
Redistribution and use in source and binary forms, with or without |
| 12 |
|
|
modification, are permitted provided that the following conditions are met: |
| 13 |
|
|
|
| 14 |
|
|
* Redistributions of source code must retain the above copyright notice, |
| 15 |
|
|
this list of conditions and the following disclaimer. |
| 16 |
|
|
|
| 17 |
|
|
* Redistributions in binary form must reproduce the above copyright |
| 18 |
|
|
notice, this list of conditions and the following disclaimer in the |
| 19 |
|
|
documentation and/or other materials provided with the distribution. |
| 20 |
|
|
|
| 21 |
|
|
* Neither the name of the University of Cambridge nor the names of its |
| 22 |
|
|
contributors may be used to endorse or promote products derived from |
| 23 |
|
|
this software without specific prior written permission. |
| 24 |
|
|
|
| 25 |
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 26 |
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 27 |
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 28 |
|
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| 29 |
|
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 30 |
|
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 31 |
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 32 |
|
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 33 |
|
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 34 |
|
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 35 |
|
|
POSSIBILITY OF SUCH DAMAGE. |
| 36 |
|
|
----------------------------------------------------------------------------- |
| 37 |
|
|
*/ |
| 38 |
|
|
|
| 39 |
|
|
#ifndef _PCRE_H |
| 40 |
|
|
#define _PCRE_H |
| 41 |
|
|
|
| 42 |
|
|
/* The current PCRE version information. */ |
| 43 |
|
|
|
| 44 |
|
|
/* NOTES FOR FUTURE MAINTAINERS: Do not use numbers with leading zeros, because |
| 45 |
|
|
they may be treated as octal constants. The PCRE_PRERELEASE feature is for |
| 46 |
|
|
identifying release candidates. It might be defined as -RC2, for example. In |
| 47 |
|
|
real releases, it should be defined empty. Do not change the alignment of these |
| 48 |
|
|
statments. The code in ./configure greps out the version numbers by using "cut" |
| 49 |
|
|
to get values from column 29 onwards. These are substituted into pcre-config |
| 50 |
|
|
and libpcre.pc. The values are not put into configure.ac and substituted here |
| 51 |
|
|
(which would simplify this issue) because that makes life harder for those who |
| 52 |
|
|
cannot run ./configure. As it now stands, this file need not be edited in that |
| 53 |
|
|
circumstance. */ |
| 54 |
|
|
|
| 55 |
|
|
#define PCRE_MAJOR 6 |
| 56 |
|
|
#define PCRE_MINOR 5 |
| 57 |
|
|
#define PCRE_PRERELEASE |
| 58 |
|
|
#define PCRE_DATE 01-Feb-2006 |
| 59 |
|
|
|
| 60 |
|
|
/* Win32 uses DLL by default; it needs special stuff for exported functions. */ |
| 61 |
|
|
|
| 62 |
|
|
#ifdef _WIN32 |
| 63 |
|
|
# ifdef PCRE_DEFINITION |
| 64 |
|
|
# ifdef DLL_EXPORT |
| 65 |
|
|
# define PCRE_DATA_SCOPE __declspec(dllexport) |
| 66 |
|
|
# endif |
| 67 |
|
|
# else |
| 68 |
|
|
# ifndef PCRE_STATIC |
| 69 |
|
|
# define PCRE_DATA_SCOPE extern __declspec(dllimport) |
| 70 |
|
|
# endif |
| 71 |
|
|
# endif |
| 72 |
|
|
#endif |
| 73 |
|
|
|
| 74 |
|
|
/* For other operating systems, we use the standard "extern". */ |
| 75 |
|
|
|
| 76 |
|
|
#ifndef PCRE_DATA_SCOPE |
| 77 |
|
|
# ifdef __cplusplus |
| 78 |
|
|
# define PCRE_DATA_SCOPE extern "C" |
| 79 |
|
|
# else |
| 80 |
|
|
# define PCRE_DATA_SCOPE extern |
| 81 |
|
|
# endif |
| 82 |
|
|
#endif |
| 83 |
|
|
|
| 84 |
|
|
/* Have to include stdlib.h in order to ensure that size_t is defined; |
| 85 |
|
|
it is needed here for malloc. */ |
| 86 |
|
|
|
| 87 |
|
|
#include <stdlib.h> |
| 88 |
|
|
|
| 89 |
|
|
/* Allow for C++ users */ |
| 90 |
|
|
|
| 91 |
|
|
#ifdef __cplusplus |
| 92 |
|
|
extern "C" { |
| 93 |
|
|
#endif |
| 94 |
|
|
|
| 95 |
|
|
/* Options */ |
| 96 |
|
|
|
| 97 |
|
|
#define PCRE_CASELESS 0x00000001 |
| 98 |
|
|
#define PCRE_MULTILINE 0x00000002 |
| 99 |
|
|
#define PCRE_DOTALL 0x00000004 |
| 100 |
|
|
#define PCRE_EXTENDED 0x00000008 |
| 101 |
|
|
#define PCRE_ANCHORED 0x00000010 |
| 102 |
|
|
#define PCRE_DOLLAR_ENDONLY 0x00000020 |
| 103 |
|
|
#define PCRE_EXTRA 0x00000040 |
| 104 |
|
|
#define PCRE_NOTBOL 0x00000080 |
| 105 |
|
|
#define PCRE_NOTEOL 0x00000100 |
| 106 |
|
|
#define PCRE_UNGREEDY 0x00000200 |
| 107 |
|
|
#define PCRE_NOTEMPTY 0x00000400 |
| 108 |
|
|
#define PCRE_UTF8 0x00000800 |
| 109 |
|
|
#define PCRE_NO_AUTO_CAPTURE 0x00001000 |
| 110 |
|
|
#define PCRE_NO_UTF8_CHECK 0x00002000 |
| 111 |
|
|
#define PCRE_AUTO_CALLOUT 0x00004000 |
| 112 |
|
|
#define PCRE_PARTIAL 0x00008000 |
| 113 |
|
|
#define PCRE_DFA_SHORTEST 0x00010000 |
| 114 |
|
|
#define PCRE_DFA_RESTART 0x00020000 |
| 115 |
|
|
#define PCRE_FIRSTLINE 0x00040000 |
| 116 |
|
|
|
| 117 |
|
|
/* Exec-time and get/set-time error codes */ |
| 118 |
|
|
|
| 119 |
|
|
#define PCRE_ERROR_NOMATCH (-1) |
| 120 |
|
|
#define PCRE_ERROR_NULL (-2) |
| 121 |
|
|
#define PCRE_ERROR_BADOPTION (-3) |
| 122 |
|
|
#define PCRE_ERROR_BADMAGIC (-4) |
| 123 |
|
|
#define PCRE_ERROR_UNKNOWN_NODE (-5) |
| 124 |
|
|
#define PCRE_ERROR_NOMEMORY (-6) |
| 125 |
|
|
#define PCRE_ERROR_NOSUBSTRING (-7) |
| 126 |
|
|
#define PCRE_ERROR_MATCHLIMIT (-8) |
| 127 |
|
|
#define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */ |
| 128 |
|
|
#define PCRE_ERROR_BADUTF8 (-10) |
| 129 |
|
|
#define PCRE_ERROR_BADUTF8_OFFSET (-11) |
| 130 |
|
|
#define PCRE_ERROR_PARTIAL (-12) |
| 131 |
|
|
#define PCRE_ERROR_BADPARTIAL (-13) |
| 132 |
|
|
#define PCRE_ERROR_INTERNAL (-14) |
| 133 |
|
|
#define PCRE_ERROR_BADCOUNT (-15) |
| 134 |
|
|
#define PCRE_ERROR_DFA_UITEM (-16) |
| 135 |
|
|
#define PCRE_ERROR_DFA_UCOND (-17) |
| 136 |
|
|
#define PCRE_ERROR_DFA_UMLIMIT (-18) |
| 137 |
|
|
#define PCRE_ERROR_DFA_WSSIZE (-19) |
| 138 |
|
|
#define PCRE_ERROR_DFA_RECURSE (-20) |
| 139 |
|
|
#define PCRE_ERROR_RECURSIONLIMIT (-21) |
| 140 |
|
|
|
| 141 |
|
|
/* Request types for pcre_fullinfo() */ |
| 142 |
|
|
|
| 143 |
|
|
#define PCRE_INFO_OPTIONS 0 |
| 144 |
|
|
#define PCRE_INFO_SIZE 1 |
| 145 |
|
|
#define PCRE_INFO_CAPTURECOUNT 2 |
| 146 |
|
|
#define PCRE_INFO_BACKREFMAX 3 |
| 147 |
|
|
#define PCRE_INFO_FIRSTBYTE 4 |
| 148 |
|
|
#define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */ |
| 149 |
|
|
#define PCRE_INFO_FIRSTTABLE 5 |
| 150 |
|
|
#define PCRE_INFO_LASTLITERAL 6 |
| 151 |
|
|
#define PCRE_INFO_NAMEENTRYSIZE 7 |
| 152 |
|
|
#define PCRE_INFO_NAMECOUNT 8 |
| 153 |
|
|
#define PCRE_INFO_NAMETABLE 9 |
| 154 |
|
|
#define PCRE_INFO_STUDYSIZE 10 |
| 155 |
|
|
#define PCRE_INFO_DEFAULT_TABLES 11 |
| 156 |
|
|
|
| 157 |
|
|
/* Request types for pcre_config(). Do not re-arrange, in order to remain |
| 158 |
|
|
compatible. */ |
| 159 |
|
|
|
| 160 |
|
|
#define PCRE_CONFIG_UTF8 0 |
| 161 |
|
|
#define PCRE_CONFIG_NEWLINE 1 |
| 162 |
|
|
#define PCRE_CONFIG_LINK_SIZE 2 |
| 163 |
|
|
#define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3 |
| 164 |
|
|
#define PCRE_CONFIG_MATCH_LIMIT 4 |
| 165 |
|
|
#define PCRE_CONFIG_STACKRECURSE 5 |
| 166 |
|
|
#define PCRE_CONFIG_UNICODE_PROPERTIES 6 |
| 167 |
|
|
#define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7 |
| 168 |
|
|
|
| 169 |
|
|
/* Bit flags for the pcre_extra structure. Do not re-arrange or redefine |
| 170 |
|
|
these bits, just add new ones on the end, in order to remain compatible. */ |
| 171 |
|
|
|
| 172 |
|
|
#define PCRE_EXTRA_STUDY_DATA 0x0001 |
| 173 |
|
|
#define PCRE_EXTRA_MATCH_LIMIT 0x0002 |
| 174 |
|
|
#define PCRE_EXTRA_CALLOUT_DATA 0x0004 |
| 175 |
|
|
#define PCRE_EXTRA_TABLES 0x0008 |
| 176 |
|
|
#define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010 |
| 177 |
|
|
|
| 178 |
|
|
/* Types */ |
| 179 |
|
|
|
| 180 |
|
|
struct real_pcre; /* declaration; the definition is private */ |
| 181 |
|
|
typedef struct real_pcre pcre; |
| 182 |
|
|
|
| 183 |
|
|
/* When PCRE is compiled as a C++ library, the subject pointer type can be |
| 184 |
|
|
replaced with a custom type. For conventional use, the public interface is a |
| 185 |
|
|
const char *. */ |
| 186 |
|
|
|
| 187 |
|
|
#ifndef PCRE_SPTR |
| 188 |
|
|
#define PCRE_SPTR const char * |
| 189 |
|
|
#endif |
| 190 |
|
|
|
| 191 |
|
|
/* The structure for passing additional data to pcre_exec(). This is defined in |
| 192 |
|
|
such as way as to be extensible. Always add new fields at the end, in order to |
| 193 |
|
|
remain compatible. */ |
| 194 |
|
|
|
| 195 |
|
|
typedef struct pcre_extra { |
| 196 |
|
|
unsigned long int flags; /* Bits for which fields are set */ |
| 197 |
|
|
void *study_data; /* Opaque data from pcre_study() */ |
| 198 |
|
|
unsigned long int match_limit; /* Maximum number of calls to match() */ |
| 199 |
|
|
void *callout_data; /* Data passed back in callouts */ |
| 200 |
|
|
const unsigned char *tables; /* Pointer to character tables */ |
| 201 |
|
|
unsigned long int match_limit_recursion; /* Max recursive calls to match() */ |
| 202 |
|
|
} pcre_extra; |
| 203 |
|
|
|
| 204 |
|
|
/* The structure for passing out data via the pcre_callout_function. We use a |
| 205 |
|
|
structure so that new fields can be added on the end in future versions, |
| 206 |
|
|
without changing the API of the function, thereby allowing old clients to work |
| 207 |
|
|
without modification. */ |
| 208 |
|
|
|
| 209 |
|
|
typedef struct pcre_callout_block { |
| 210 |
|
|
int version; /* Identifies version of block */ |
| 211 |
|
|
/* ------------------------ Version 0 ------------------------------- */ |
| 212 |
|
|
int callout_number; /* Number compiled into pattern */ |
| 213 |
|
|
int *offset_vector; /* The offset vector */ |
| 214 |
|
|
PCRE_SPTR subject; /* The subject being matched */ |
| 215 |
|
|
int subject_length; /* The length of the subject */ |
| 216 |
|
|
int start_match; /* Offset to start of this match attempt */ |
| 217 |
|
|
int current_position; /* Where we currently are in the subject */ |
| 218 |
|
|
int capture_top; /* Max current capture */ |
| 219 |
|
|
int capture_last; /* Most recently closed capture */ |
| 220 |
|
|
void *callout_data; /* Data passed in with the call */ |
| 221 |
|
|
/* ------------------- Added for Version 1 -------------------------- */ |
| 222 |
|
|
int pattern_position; /* Offset to next item in the pattern */ |
| 223 |
|
|
int next_item_length; /* Length of next item in the pattern */ |
| 224 |
|
|
/* ------------------------------------------------------------------ */ |
| 225 |
|
|
} pcre_callout_block; |
| 226 |
|
|
|
| 227 |
|
|
/* Indirection for store get and free functions. These can be set to |
| 228 |
|
|
alternative malloc/free functions if required. Special ones are used in the |
| 229 |
|
|
non-recursive case for "frames". There is also an optional callout function |
| 230 |
|
|
that is triggered by the (?) regex item. For Virtual Pascal, these definitions |
| 231 |
|
|
have to take another form. */ |
| 232 |
|
|
|
| 233 |
|
|
#ifndef VPCOMPAT |
| 234 |
|
|
PCRE_DATA_SCOPE void *(*pcre_malloc)(size_t); |
| 235 |
|
|
PCRE_DATA_SCOPE void (*pcre_free)(void *); |
| 236 |
|
|
PCRE_DATA_SCOPE void *(*pcre_stack_malloc)(size_t); |
| 237 |
|
|
PCRE_DATA_SCOPE void (*pcre_stack_free)(void *); |
| 238 |
|
|
PCRE_DATA_SCOPE int (*pcre_callout)(pcre_callout_block *); |
| 239 |
|
|
#else /* VPCOMPAT */ |
| 240 |
|
|
PCRE_DATA_SCOPE void *pcre_malloc(size_t); |
| 241 |
|
|
PCRE_DATA_SCOPE void pcre_free(void *); |
| 242 |
|
|
PCRE_DATA_SCOPE void *pcre_stack_malloc(size_t); |
| 243 |
|
|
PCRE_DATA_SCOPE void pcre_stack_free(void *); |
| 244 |
|
|
PCRE_DATA_SCOPE int pcre_callout(pcre_callout_block *); |
| 245 |
|
|
#endif /* VPCOMPAT */ |
| 246 |
|
|
|
| 247 |
|
|
/* Exported PCRE functions */ |
| 248 |
|
|
|
| 249 |
|
|
PCRE_DATA_SCOPE pcre *pcre_compile(const char *, int, const char **, int *, |
| 250 |
|
|
const unsigned char *); |
| 251 |
|
|
PCRE_DATA_SCOPE pcre *pcre_compile2(const char *, int, int *, const char **, |
| 252 |
|
|
int *, const unsigned char *); |
| 253 |
|
|
PCRE_DATA_SCOPE int pcre_config(int, void *); |
| 254 |
|
|
PCRE_DATA_SCOPE int pcre_copy_named_substring(const pcre *, const char *, |
| 255 |
|
|
int *, int, const char *, char *, int); |
| 256 |
|
|
PCRE_DATA_SCOPE int pcre_copy_substring(const char *, int *, int, int, char *, |
| 257 |
|
|
int); |
| 258 |
|
|
PCRE_DATA_SCOPE int pcre_dfa_exec(const pcre *, const pcre_extra *, |
| 259 |
|
|
const char *, int, int, int, int *, int , int *, int); |
| 260 |
|
|
PCRE_DATA_SCOPE int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR, |
| 261 |
|
|
int, int, int, int *, int); |
| 262 |
|
|
PCRE_DATA_SCOPE void pcre_free_substring(const char *); |
| 263 |
|
|
PCRE_DATA_SCOPE void pcre_free_substring_list(const char **); |
| 264 |
|
|
PCRE_DATA_SCOPE int pcre_fullinfo(const pcre *, const pcre_extra *, int, |
| 265 |
|
|
void *); |
| 266 |
|
|
PCRE_DATA_SCOPE int pcre_get_named_substring(const pcre *, const char *, |
| 267 |
|
|
int *, int, const char *, const char **); |
| 268 |
|
|
PCRE_DATA_SCOPE int pcre_get_stringnumber(const pcre *, const char *); |
| 269 |
|
|
PCRE_DATA_SCOPE int pcre_get_substring(const char *, int *, int, int, |
| 270 |
|
|
const char **); |
| 271 |
|
|
PCRE_DATA_SCOPE int pcre_get_substring_list(const char *, int *, int, |
| 272 |
|
|
const char ***); |
| 273 |
|
|
PCRE_DATA_SCOPE int pcre_info(const pcre *, int *, int *); |
| 274 |
|
|
PCRE_DATA_SCOPE const unsigned char *pcre_maketables(void); |
| 275 |
|
|
PCRE_DATA_SCOPE int pcre_refcount(pcre *, int); |
| 276 |
|
|
PCRE_DATA_SCOPE pcre_extra *pcre_study(const pcre *, int, const char **); |
| 277 |
|
|
PCRE_DATA_SCOPE const char *pcre_version(void); |
| 278 |
|
|
|
| 279 |
|
|
#ifdef __cplusplus |
| 280 |
|
|
} /* extern "C" */ |
| 281 |
|
|
#endif |
| 282 |
|
|
|
| 283 |
|
|
#endif /* End of pcre.h */ |
Parent Directory
| 
Revision Log