Tristan Matthews | 0461646 | 2013-11-14 16:09:34 -0500 | [diff] [blame] | 1 | /************************************************* |
| 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-2011 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 | #define PCRE_MAJOR 8 |
| 45 | #define PCRE_MINOR 21 |
| 46 | #define PCRE_PRERELEASE |
| 47 | #define PCRE_DATE 2011-12-12 |
| 48 | |
| 49 | /* When an application links to a PCRE DLL in Windows, the symbols that are |
| 50 | imported have to be identified as such. When building PCRE, the appropriate |
| 51 | export setting is defined in pcre_internal.h, which includes this file. So we |
| 52 | don't change existing definitions of PCRE_EXP_DECL and PCRECPP_EXP_DECL. */ |
| 53 | |
| 54 | #if defined(_WIN32) && !defined(PCRE_STATIC) |
| 55 | # ifndef PCRE_EXP_DECL |
| 56 | # define PCRE_EXP_DECL extern __declspec(dllimport) |
| 57 | # endif |
| 58 | # ifdef __cplusplus |
| 59 | # ifndef PCRECPP_EXP_DECL |
| 60 | # define PCRECPP_EXP_DECL extern __declspec(dllimport) |
| 61 | # endif |
| 62 | # ifndef PCRECPP_EXP_DEFN |
| 63 | # define PCRECPP_EXP_DEFN __declspec(dllimport) |
| 64 | # endif |
| 65 | # endif |
| 66 | #endif |
| 67 | |
| 68 | /* By default, we use the standard "extern" declarations. */ |
| 69 | |
| 70 | #ifndef PCRE_EXP_DECL |
| 71 | # ifdef __cplusplus |
| 72 | # define PCRE_EXP_DECL extern "C" |
| 73 | # else |
| 74 | # define PCRE_EXP_DECL extern |
| 75 | # endif |
| 76 | #endif |
| 77 | |
| 78 | #ifdef __cplusplus |
| 79 | # ifndef PCRECPP_EXP_DECL |
| 80 | # define PCRECPP_EXP_DECL extern |
| 81 | # endif |
| 82 | # ifndef PCRECPP_EXP_DEFN |
| 83 | # define PCRECPP_EXP_DEFN |
| 84 | # endif |
| 85 | #endif |
| 86 | |
| 87 | /* Have to include stdlib.h in order to ensure that size_t is defined; |
| 88 | it is needed here for malloc. */ |
| 89 | |
| 90 | #include <stdlib.h> |
| 91 | |
| 92 | /* Allow for C++ users */ |
| 93 | |
| 94 | #ifdef __cplusplus |
| 95 | extern "C" { |
| 96 | #endif |
| 97 | |
| 98 | /* Options. Some are compile-time only, some are run-time only, and some are |
| 99 | both, so we keep them all distinct. However, almost all the bits in the options |
| 100 | word are now used. In the long run, we may have to re-use some of the |
| 101 | compile-time only bits for runtime options, or vice versa. In the comments |
| 102 | below, "compile", "exec", and "DFA exec" mean that the option is permitted to |
| 103 | be set for those functions; "used in" means that an option may be set only for |
| 104 | compile, but is subsequently referenced in exec and/or DFA exec. Any of the |
| 105 | compile-time options may be inspected during studying (and therefore JIT |
| 106 | compiling). */ |
| 107 | |
| 108 | #define PCRE_CASELESS 0x00000001 /* Compile */ |
| 109 | #define PCRE_MULTILINE 0x00000002 /* Compile */ |
| 110 | #define PCRE_DOTALL 0x00000004 /* Compile */ |
| 111 | #define PCRE_EXTENDED 0x00000008 /* Compile */ |
| 112 | #define PCRE_ANCHORED 0x00000010 /* Compile, exec, DFA exec */ |
| 113 | #define PCRE_DOLLAR_ENDONLY 0x00000020 /* Compile, used in exec, DFA exec */ |
| 114 | #define PCRE_EXTRA 0x00000040 /* Compile */ |
| 115 | #define PCRE_NOTBOL 0x00000080 /* Exec, DFA exec */ |
| 116 | #define PCRE_NOTEOL 0x00000100 /* Exec, DFA exec */ |
| 117 | #define PCRE_UNGREEDY 0x00000200 /* Compile */ |
| 118 | #define PCRE_NOTEMPTY 0x00000400 /* Exec, DFA exec */ |
| 119 | #define PCRE_UTF8 0x00000800 /* Compile, used in exec, DFA exec */ |
| 120 | #define PCRE_NO_AUTO_CAPTURE 0x00001000 /* Compile */ |
| 121 | #define PCRE_NO_UTF8_CHECK 0x00002000 /* Compile, exec, DFA exec */ |
| 122 | #define PCRE_AUTO_CALLOUT 0x00004000 /* Compile */ |
| 123 | #define PCRE_PARTIAL_SOFT 0x00008000 /* Exec, DFA exec */ |
| 124 | #define PCRE_PARTIAL 0x00008000 /* Backwards compatible synonym */ |
| 125 | #define PCRE_DFA_SHORTEST 0x00010000 /* DFA exec */ |
| 126 | #define PCRE_DFA_RESTART 0x00020000 /* DFA exec */ |
| 127 | #define PCRE_FIRSTLINE 0x00040000 /* Compile, used in exec, DFA exec */ |
| 128 | #define PCRE_DUPNAMES 0x00080000 /* Compile */ |
| 129 | #define PCRE_NEWLINE_CR 0x00100000 /* Compile, exec, DFA exec */ |
| 130 | #define PCRE_NEWLINE_LF 0x00200000 /* Compile, exec, DFA exec */ |
| 131 | #define PCRE_NEWLINE_CRLF 0x00300000 /* Compile, exec, DFA exec */ |
| 132 | #define PCRE_NEWLINE_ANY 0x00400000 /* Compile, exec, DFA exec */ |
| 133 | #define PCRE_NEWLINE_ANYCRLF 0x00500000 /* Compile, exec, DFA exec */ |
| 134 | #define PCRE_BSR_ANYCRLF 0x00800000 /* Compile, exec, DFA exec */ |
| 135 | #define PCRE_BSR_UNICODE 0x01000000 /* Compile, exec, DFA exec */ |
| 136 | #define PCRE_JAVASCRIPT_COMPAT 0x02000000 /* Compile, used in exec */ |
| 137 | #define PCRE_NO_START_OPTIMIZE 0x04000000 /* Compile, exec, DFA exec */ |
| 138 | #define PCRE_NO_START_OPTIMISE 0x04000000 /* Synonym */ |
| 139 | #define PCRE_PARTIAL_HARD 0x08000000 /* Exec, DFA exec */ |
| 140 | #define PCRE_NOTEMPTY_ATSTART 0x10000000 /* Exec, DFA exec */ |
| 141 | #define PCRE_UCP 0x20000000 /* Compile, used in exec, DFA exec */ |
| 142 | |
| 143 | /* Exec-time and get/set-time error codes */ |
| 144 | |
| 145 | #define PCRE_ERROR_NOMATCH (-1) |
| 146 | #define PCRE_ERROR_NULL (-2) |
| 147 | #define PCRE_ERROR_BADOPTION (-3) |
| 148 | #define PCRE_ERROR_BADMAGIC (-4) |
| 149 | #define PCRE_ERROR_UNKNOWN_OPCODE (-5) |
| 150 | #define PCRE_ERROR_UNKNOWN_NODE (-5) /* For backward compatibility */ |
| 151 | #define PCRE_ERROR_NOMEMORY (-6) |
| 152 | #define PCRE_ERROR_NOSUBSTRING (-7) |
| 153 | #define PCRE_ERROR_MATCHLIMIT (-8) |
| 154 | #define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */ |
| 155 | #define PCRE_ERROR_BADUTF8 (-10) |
| 156 | #define PCRE_ERROR_BADUTF8_OFFSET (-11) |
| 157 | #define PCRE_ERROR_PARTIAL (-12) |
| 158 | #define PCRE_ERROR_BADPARTIAL (-13) |
| 159 | #define PCRE_ERROR_INTERNAL (-14) |
| 160 | #define PCRE_ERROR_BADCOUNT (-15) |
| 161 | #define PCRE_ERROR_DFA_UITEM (-16) |
| 162 | #define PCRE_ERROR_DFA_UCOND (-17) |
| 163 | #define PCRE_ERROR_DFA_UMLIMIT (-18) |
| 164 | #define PCRE_ERROR_DFA_WSSIZE (-19) |
| 165 | #define PCRE_ERROR_DFA_RECURSE (-20) |
| 166 | #define PCRE_ERROR_RECURSIONLIMIT (-21) |
| 167 | #define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */ |
| 168 | #define PCRE_ERROR_BADNEWLINE (-23) |
| 169 | #define PCRE_ERROR_BADOFFSET (-24) |
| 170 | #define PCRE_ERROR_SHORTUTF8 (-25) |
| 171 | #define PCRE_ERROR_RECURSELOOP (-26) |
| 172 | #define PCRE_ERROR_JIT_STACKLIMIT (-27) |
| 173 | |
| 174 | /* Specific error codes for UTF-8 validity checks */ |
| 175 | |
| 176 | #define PCRE_UTF8_ERR0 0 |
| 177 | #define PCRE_UTF8_ERR1 1 |
| 178 | #define PCRE_UTF8_ERR2 2 |
| 179 | #define PCRE_UTF8_ERR3 3 |
| 180 | #define PCRE_UTF8_ERR4 4 |
| 181 | #define PCRE_UTF8_ERR5 5 |
| 182 | #define PCRE_UTF8_ERR6 6 |
| 183 | #define PCRE_UTF8_ERR7 7 |
| 184 | #define PCRE_UTF8_ERR8 8 |
| 185 | #define PCRE_UTF8_ERR9 9 |
| 186 | #define PCRE_UTF8_ERR10 10 |
| 187 | #define PCRE_UTF8_ERR11 11 |
| 188 | #define PCRE_UTF8_ERR12 12 |
| 189 | #define PCRE_UTF8_ERR13 13 |
| 190 | #define PCRE_UTF8_ERR14 14 |
| 191 | #define PCRE_UTF8_ERR15 15 |
| 192 | #define PCRE_UTF8_ERR16 16 |
| 193 | #define PCRE_UTF8_ERR17 17 |
| 194 | #define PCRE_UTF8_ERR18 18 |
| 195 | #define PCRE_UTF8_ERR19 19 |
| 196 | #define PCRE_UTF8_ERR20 20 |
| 197 | #define PCRE_UTF8_ERR21 21 |
| 198 | |
| 199 | /* Request types for pcre_fullinfo() */ |
| 200 | |
| 201 | #define PCRE_INFO_OPTIONS 0 |
| 202 | #define PCRE_INFO_SIZE 1 |
| 203 | #define PCRE_INFO_CAPTURECOUNT 2 |
| 204 | #define PCRE_INFO_BACKREFMAX 3 |
| 205 | #define PCRE_INFO_FIRSTBYTE 4 |
| 206 | #define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */ |
| 207 | #define PCRE_INFO_FIRSTTABLE 5 |
| 208 | #define PCRE_INFO_LASTLITERAL 6 |
| 209 | #define PCRE_INFO_NAMEENTRYSIZE 7 |
| 210 | #define PCRE_INFO_NAMECOUNT 8 |
| 211 | #define PCRE_INFO_NAMETABLE 9 |
| 212 | #define PCRE_INFO_STUDYSIZE 10 |
| 213 | #define PCRE_INFO_DEFAULT_TABLES 11 |
| 214 | #define PCRE_INFO_OKPARTIAL 12 |
| 215 | #define PCRE_INFO_JCHANGED 13 |
| 216 | #define PCRE_INFO_HASCRORLF 14 |
| 217 | #define PCRE_INFO_MINLENGTH 15 |
| 218 | #define PCRE_INFO_JIT 16 |
| 219 | #define PCRE_INFO_JITSIZE 17 |
| 220 | |
| 221 | /* Request types for pcre_config(). Do not re-arrange, in order to remain |
| 222 | compatible. */ |
| 223 | |
| 224 | #define PCRE_CONFIG_UTF8 0 |
| 225 | #define PCRE_CONFIG_NEWLINE 1 |
| 226 | #define PCRE_CONFIG_LINK_SIZE 2 |
| 227 | #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3 |
| 228 | #define PCRE_CONFIG_MATCH_LIMIT 4 |
| 229 | #define PCRE_CONFIG_STACKRECURSE 5 |
| 230 | #define PCRE_CONFIG_UNICODE_PROPERTIES 6 |
| 231 | #define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7 |
| 232 | #define PCRE_CONFIG_BSR 8 |
| 233 | #define PCRE_CONFIG_JIT 9 |
| 234 | |
| 235 | /* Request types for pcre_study(). Do not re-arrange, in order to remain |
| 236 | compatible. */ |
| 237 | |
| 238 | #define PCRE_STUDY_JIT_COMPILE 0x0001 |
| 239 | |
| 240 | /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine |
| 241 | these bits, just add new ones on the end, in order to remain compatible. */ |
| 242 | |
| 243 | #define PCRE_EXTRA_STUDY_DATA 0x0001 |
| 244 | #define PCRE_EXTRA_MATCH_LIMIT 0x0002 |
| 245 | #define PCRE_EXTRA_CALLOUT_DATA 0x0004 |
| 246 | #define PCRE_EXTRA_TABLES 0x0008 |
| 247 | #define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010 |
| 248 | #define PCRE_EXTRA_MARK 0x0020 |
| 249 | #define PCRE_EXTRA_EXECUTABLE_JIT 0x0040 |
| 250 | |
| 251 | /* Types */ |
| 252 | |
| 253 | struct real_pcre; /* declaration; the definition is private */ |
| 254 | typedef struct real_pcre pcre; |
| 255 | |
| 256 | struct real_pcre_jit_stack; /* declaration; the definition is private */ |
| 257 | typedef struct real_pcre_jit_stack pcre_jit_stack; |
| 258 | |
| 259 | /* When PCRE is compiled as a C++ library, the subject pointer type can be |
| 260 | replaced with a custom type. For conventional use, the public interface is a |
| 261 | const char *. */ |
| 262 | |
| 263 | #ifndef PCRE_SPTR |
| 264 | #define PCRE_SPTR const char * |
| 265 | #endif |
| 266 | |
| 267 | /* The structure for passing additional data to pcre_exec(). This is defined in |
| 268 | such as way as to be extensible. Always add new fields at the end, in order to |
| 269 | remain compatible. */ |
| 270 | |
| 271 | typedef struct pcre_extra { |
| 272 | unsigned long int flags; /* Bits for which fields are set */ |
| 273 | void *study_data; /* Opaque data from pcre_study() */ |
| 274 | unsigned long int match_limit; /* Maximum number of calls to match() */ |
| 275 | void *callout_data; /* Data passed back in callouts */ |
| 276 | const unsigned char *tables; /* Pointer to character tables */ |
| 277 | unsigned long int match_limit_recursion; /* Max recursive calls to match() */ |
| 278 | unsigned char **mark; /* For passing back a mark pointer */ |
| 279 | void *executable_jit; /* Contains a pointer to a compiled jit code */ |
| 280 | } pcre_extra; |
| 281 | |
| 282 | /* The structure for passing out data via the pcre_callout_function. We use a |
| 283 | structure so that new fields can be added on the end in future versions, |
| 284 | without changing the API of the function, thereby allowing old clients to work |
| 285 | without modification. */ |
| 286 | |
| 287 | typedef struct pcre_callout_block { |
| 288 | int version; /* Identifies version of block */ |
| 289 | /* ------------------------ Version 0 ------------------------------- */ |
| 290 | int callout_number; /* Number compiled into pattern */ |
| 291 | int *offset_vector; /* The offset vector */ |
| 292 | PCRE_SPTR subject; /* The subject being matched */ |
| 293 | int subject_length; /* The length of the subject */ |
| 294 | int start_match; /* Offset to start of this match attempt */ |
| 295 | int current_position; /* Where we currently are in the subject */ |
| 296 | int capture_top; /* Max current capture */ |
| 297 | int capture_last; /* Most recently closed capture */ |
| 298 | void *callout_data; /* Data passed in with the call */ |
| 299 | /* ------------------- Added for Version 1 -------------------------- */ |
| 300 | int pattern_position; /* Offset to next item in the pattern */ |
| 301 | int next_item_length; /* Length of next item in the pattern */ |
| 302 | /* ------------------- Added for Version 2 -------------------------- */ |
| 303 | const unsigned char *mark; /* Pointer to current mark or NULL */ |
| 304 | /* ------------------------------------------------------------------ */ |
| 305 | } pcre_callout_block; |
| 306 | |
| 307 | /* Indirection for store get and free functions. These can be set to |
| 308 | alternative malloc/free functions if required. Special ones are used in the |
| 309 | non-recursive case for "frames". There is also an optional callout function |
| 310 | that is triggered by the (?) regex item. For Virtual Pascal, these definitions |
| 311 | have to take another form. */ |
| 312 | |
| 313 | #ifndef VPCOMPAT |
| 314 | PCRE_EXP_DECL void *(*pcre_malloc)(size_t); |
| 315 | PCRE_EXP_DECL void (*pcre_free)(void *); |
| 316 | PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t); |
| 317 | PCRE_EXP_DECL void (*pcre_stack_free)(void *); |
| 318 | PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *); |
| 319 | #else /* VPCOMPAT */ |
| 320 | PCRE_EXP_DECL void *pcre_malloc(size_t); |
| 321 | PCRE_EXP_DECL void pcre_free(void *); |
| 322 | PCRE_EXP_DECL void *pcre_stack_malloc(size_t); |
| 323 | PCRE_EXP_DECL void pcre_stack_free(void *); |
| 324 | PCRE_EXP_DECL int pcre_callout(pcre_callout_block *); |
| 325 | #endif /* VPCOMPAT */ |
| 326 | |
| 327 | /* User defined callback which provides a stack just before the match starts. */ |
| 328 | |
| 329 | typedef pcre_jit_stack *(*pcre_jit_callback)(void *); |
| 330 | |
| 331 | /* Exported PCRE functions */ |
| 332 | |
| 333 | PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *, |
| 334 | const unsigned char *); |
| 335 | PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **, |
| 336 | int *, const unsigned char *); |
| 337 | PCRE_EXP_DECL int pcre_config(int, void *); |
| 338 | PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *, |
| 339 | int *, int, const char *, char *, int); |
| 340 | PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int, char *, |
| 341 | int); |
| 342 | PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *, |
| 343 | const char *, int, int, int, int *, int , int *, int); |
| 344 | PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR, |
| 345 | int, int, int, int *, int); |
| 346 | PCRE_EXP_DECL void pcre_free_substring(const char *); |
| 347 | PCRE_EXP_DECL void pcre_free_substring_list(const char **); |
| 348 | PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int, |
| 349 | void *); |
| 350 | PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *, |
| 351 | int *, int, const char *, const char **); |
| 352 | PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *); |
| 353 | PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *, |
| 354 | char **, char **); |
| 355 | PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int, |
| 356 | const char **); |
| 357 | PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int, |
| 358 | const char ***); |
| 359 | PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *); |
| 360 | PCRE_EXP_DECL const unsigned char *pcre_maketables(void); |
| 361 | PCRE_EXP_DECL int pcre_refcount(pcre *, int); |
| 362 | PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **); |
| 363 | PCRE_EXP_DECL void pcre_free_study(pcre_extra *); |
| 364 | PCRE_EXP_DECL const char *pcre_version(void); |
| 365 | |
| 366 | /* JIT compiler related functions. */ |
| 367 | |
| 368 | PCRE_EXP_DECL pcre_jit_stack *pcre_jit_stack_alloc(int, int); |
| 369 | PCRE_EXP_DECL void pcre_jit_stack_free(pcre_jit_stack *); |
| 370 | PCRE_EXP_DECL void pcre_assign_jit_stack(pcre_extra *, pcre_jit_callback, void *); |
| 371 | |
| 372 | #ifdef __cplusplus |
| 373 | } /* extern "C" */ |
| 374 | #endif |
| 375 | |
| 376 | #endif /* End of pcre.h */ |