1/************************************************* 2* Perl-Compatible Regular Expressions * 3*************************************************/ 4 5/* This is the public header file for the PCRE library, to be #included by 6applications that call the PCRE functions. 7 8 Copyright (c) 1997-2010 University of Cambridge 9 10----------------------------------------------------------------------------- 11Redistribution and use in source and binary forms, with or without 12modification, 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 25THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 26AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 27IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 28ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 29LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35POSSIBILITY 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 @PCRE_MAJOR@ 45#define PCRE_MINOR @PCRE_MINOR@ 46#define PCRE_PRERELEASE @PCRE_PRERELEASE@ 47#define PCRE_DATE @PCRE_DATE@ 48 49/* When an application links to a PCRE DLL in Windows, the symbols that are 50imported have to be identified as such. When building PCRE, the appropriate 51export setting is defined in pcre_internal.h, which includes this file. So we 52don'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; 88it is needed here for malloc. */ 89 90#include <stdlib.h> 91 92/* Allow for C++ users */ 93 94#ifdef __cplusplus 95extern "C" { 96#endif 97 98/* Options. Some are compile-time only, some are run-time only, and some are 99both, so we keep them all distinct. However, almost all the bits in the options 100word are now used. In the long run, we may have to re-use some of the 101compile-time only bits for runtime options, or vice versa. */ 102 103#define PCRE_CASELESS 0x00000001 /* Compile */ 104#define PCRE_MULTILINE 0x00000002 /* Compile */ 105#define PCRE_DOTALL 0x00000004 /* Compile */ 106#define PCRE_EXTENDED 0x00000008 /* Compile */ 107#define PCRE_ANCHORED 0x00000010 /* Compile, exec, DFA exec */ 108#define PCRE_DOLLAR_ENDONLY 0x00000020 /* Compile */ 109#define PCRE_EXTRA 0x00000040 /* Compile */ 110#define PCRE_NOTBOL 0x00000080 /* Exec, DFA exec */ 111#define PCRE_NOTEOL 0x00000100 /* Exec, DFA exec */ 112#define PCRE_UNGREEDY 0x00000200 /* Compile */ 113#define PCRE_NOTEMPTY 0x00000400 /* Exec, DFA exec */ 114#define PCRE_UTF8 0x00000800 /* Compile */ 115#define PCRE_NO_AUTO_CAPTURE 0x00001000 /* Compile */ 116#define PCRE_NO_UTF8_CHECK 0x00002000 /* Compile, exec, DFA exec */ 117#define PCRE_AUTO_CALLOUT 0x00004000 /* Compile */ 118#define PCRE_PARTIAL_SOFT 0x00008000 /* Exec, DFA exec */ 119#define PCRE_PARTIAL 0x00008000 /* Backwards compatible synonym */ 120#define PCRE_DFA_SHORTEST 0x00010000 /* DFA exec */ 121#define PCRE_DFA_RESTART 0x00020000 /* DFA exec */ 122#define PCRE_FIRSTLINE 0x00040000 /* Compile */ 123#define PCRE_DUPNAMES 0x00080000 /* Compile */ 124#define PCRE_NEWLINE_CR 0x00100000 /* Compile, exec, DFA exec */ 125#define PCRE_NEWLINE_LF 0x00200000 /* Compile, exec, DFA exec */ 126#define PCRE_NEWLINE_CRLF 0x00300000 /* Compile, exec, DFA exec */ 127#define PCRE_NEWLINE_ANY 0x00400000 /* Compile, exec, DFA exec */ 128#define PCRE_NEWLINE_ANYCRLF 0x00500000 /* Compile, exec, DFA exec */ 129#define PCRE_BSR_ANYCRLF 0x00800000 /* Compile, exec, DFA exec */ 130#define PCRE_BSR_UNICODE 0x01000000 /* Compile, exec, DFA exec */ 131#define PCRE_JAVASCRIPT_COMPAT 0x02000000 /* Compile */ 132#define PCRE_NO_START_OPTIMIZE 0x04000000 /* Compile, exec, DFA exec */ 133#define PCRE_NO_START_OPTIMISE 0x04000000 /* Synonym */ 134#define PCRE_PARTIAL_HARD 0x08000000 /* Exec, DFA exec */ 135#define PCRE_NOTEMPTY_ATSTART 0x10000000 /* Exec, DFA exec */ 136#define PCRE_UCP 0x20000000 /* Compile */ 137 138/* Exec-time and get/set-time error codes */ 139 140#define PCRE_ERROR_NOMATCH (-1) 141#define PCRE_ERROR_NULL (-2) 142#define PCRE_ERROR_BADOPTION (-3) 143#define PCRE_ERROR_BADMAGIC (-4) 144#define PCRE_ERROR_UNKNOWN_OPCODE (-5) 145#define PCRE_ERROR_UNKNOWN_NODE (-5) /* For backward compatibility */ 146#define PCRE_ERROR_NOMEMORY (-6) 147#define PCRE_ERROR_NOSUBSTRING (-7) 148#define PCRE_ERROR_MATCHLIMIT (-8) 149#define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */ 150#define PCRE_ERROR_BADUTF8 (-10) 151#define PCRE_ERROR_BADUTF8_OFFSET (-11) 152#define PCRE_ERROR_PARTIAL (-12) 153#define PCRE_ERROR_BADPARTIAL (-13) 154#define PCRE_ERROR_INTERNAL (-14) 155#define PCRE_ERROR_BADCOUNT (-15) 156#define PCRE_ERROR_DFA_UITEM (-16) 157#define PCRE_ERROR_DFA_UCOND (-17) 158#define PCRE_ERROR_DFA_UMLIMIT (-18) 159#define PCRE_ERROR_DFA_WSSIZE (-19) 160#define PCRE_ERROR_DFA_RECURSE (-20) 161#define PCRE_ERROR_RECURSIONLIMIT (-21) 162#define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */ 163#define PCRE_ERROR_BADNEWLINE (-23) 164#define PCRE_ERROR_BADOFFSET (-24) 165#define PCRE_ERROR_SHORTUTF8 (-25) 166 167/* Request types for pcre_fullinfo() */ 168 169#define PCRE_INFO_OPTIONS 0 170#define PCRE_INFO_SIZE 1 171#define PCRE_INFO_CAPTURECOUNT 2 172#define PCRE_INFO_BACKREFMAX 3 173#define PCRE_INFO_FIRSTBYTE 4 174#define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */ 175#define PCRE_INFO_FIRSTTABLE 5 176#define PCRE_INFO_LASTLITERAL 6 177#define PCRE_INFO_NAMEENTRYSIZE 7 178#define PCRE_INFO_NAMECOUNT 8 179#define PCRE_INFO_NAMETABLE 9 180#define PCRE_INFO_STUDYSIZE 10 181#define PCRE_INFO_DEFAULT_TABLES 11 182#define PCRE_INFO_OKPARTIAL 12 183#define PCRE_INFO_JCHANGED 13 184#define PCRE_INFO_HASCRORLF 14 185#define PCRE_INFO_MINLENGTH 15 186 187/* Request types for pcre_config(). Do not re-arrange, in order to remain 188compatible. */ 189 190#define PCRE_CONFIG_UTF8 0 191#define PCRE_CONFIG_NEWLINE 1 192#define PCRE_CONFIG_LINK_SIZE 2 193#define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3 194#define PCRE_CONFIG_MATCH_LIMIT 4 195#define PCRE_CONFIG_STACKRECURSE 5 196#define PCRE_CONFIG_UNICODE_PROPERTIES 6 197#define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7 198#define PCRE_CONFIG_BSR 8 199 200/* Bit flags for the pcre_extra structure. Do not re-arrange or redefine 201these bits, just add new ones on the end, in order to remain compatible. */ 202 203#define PCRE_EXTRA_STUDY_DATA 0x0001 204#define PCRE_EXTRA_MATCH_LIMIT 0x0002 205#define PCRE_EXTRA_CALLOUT_DATA 0x0004 206#define PCRE_EXTRA_TABLES 0x0008 207#define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010 208#define PCRE_EXTRA_MARK 0x0020 209 210/* Types */ 211 212struct real_pcre; /* declaration; the definition is private */ 213typedef struct real_pcre pcre; 214 215/* When PCRE is compiled as a C++ library, the subject pointer type can be 216replaced with a custom type. For conventional use, the public interface is a 217const char *. */ 218 219#ifndef PCRE_SPTR 220#define PCRE_SPTR const char * 221#endif 222 223/* The structure for passing additional data to pcre_exec(). This is defined in 224such as way as to be extensible. Always add new fields at the end, in order to 225remain compatible. */ 226 227typedef struct pcre_extra { 228 unsigned long int flags; /* Bits for which fields are set */ 229 void *study_data; /* Opaque data from pcre_study() */ 230 unsigned long int match_limit; /* Maximum number of calls to match() */ 231 void *callout_data; /* Data passed back in callouts */ 232 const unsigned char *tables; /* Pointer to character tables */ 233 unsigned long int match_limit_recursion; /* Max recursive calls to match() */ 234 unsigned char **mark; /* For passing back a mark pointer */ 235} pcre_extra; 236 237/* The structure for passing out data via the pcre_callout_function. We use a 238structure so that new fields can be added on the end in future versions, 239without changing the API of the function, thereby allowing old clients to work 240without modification. */ 241 242typedef struct pcre_callout_block { 243 int version; /* Identifies version of block */ 244 /* ------------------------ Version 0 ------------------------------- */ 245 int callout_number; /* Number compiled into pattern */ 246 int *offset_vector; /* The offset vector */ 247 PCRE_SPTR subject; /* The subject being matched */ 248 int subject_length; /* The length of the subject */ 249 int start_match; /* Offset to start of this match attempt */ 250 int current_position; /* Where we currently are in the subject */ 251 int capture_top; /* Max current capture */ 252 int capture_last; /* Most recently closed capture */ 253 void *callout_data; /* Data passed in with the call */ 254 /* ------------------- Added for Version 1 -------------------------- */ 255 int pattern_position; /* Offset to next item in the pattern */ 256 int next_item_length; /* Length of next item in the pattern */ 257 /* ------------------------------------------------------------------ */ 258} pcre_callout_block; 259 260/* Indirection for store get and free functions. These can be set to 261alternative malloc/free functions if required. Special ones are used in the 262non-recursive case for "frames". There is also an optional callout function 263that is triggered by the (?) regex item. For Virtual Pascal, these definitions 264have to take another form. */ 265 266#ifndef VPCOMPAT 267PCRE_EXP_DECL void *(*pcre_malloc)(size_t); 268PCRE_EXP_DECL void (*pcre_free)(void *); 269PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t); 270PCRE_EXP_DECL void (*pcre_stack_free)(void *); 271PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *); 272#else /* VPCOMPAT */ 273PCRE_EXP_DECL void *pcre_malloc(size_t); 274PCRE_EXP_DECL void pcre_free(void *); 275PCRE_EXP_DECL void *pcre_stack_malloc(size_t); 276PCRE_EXP_DECL void pcre_stack_free(void *); 277PCRE_EXP_DECL int pcre_callout(pcre_callout_block *); 278#endif /* VPCOMPAT */ 279 280/* Exported PCRE functions */ 281 282PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *, 283 const unsigned char *); 284PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **, 285 int *, const unsigned char *); 286PCRE_EXP_DECL int pcre_config(int, void *); 287PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *, 288 int *, int, const char *, char *, int); 289PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int, char *, 290 int); 291PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *, 292 const char *, int, int, int, int *, int , int *, int); 293PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR, 294 int, int, int, int *, int); 295PCRE_EXP_DECL void pcre_free_substring(const char *); 296PCRE_EXP_DECL void pcre_free_substring_list(const char **); 297PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int, 298 void *); 299PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *, 300 int *, int, const char *, const char **); 301PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *); 302PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *, 303 char **, char **); 304PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int, 305 const char **); 306PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int, 307 const char ***); 308PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *); 309PCRE_EXP_DECL const unsigned char *pcre_maketables(void); 310PCRE_EXP_DECL int pcre_refcount(pcre *, int); 311PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **); 312PCRE_EXP_DECL const char *pcre_version(void); 313 314#ifdef __cplusplus 315} /* extern "C" */ 316#endif 317 318#endif /* End of pcre.h */ 319