| 5 |
/* This is the public header file for the PCRE library, to be #included by |
/* This is the public header file for the PCRE library, to be #included by |
| 6 |
applications that call the PCRE functions. |
applications that call the PCRE functions. |
| 7 |
|
|
| 8 |
Copyright (c) 1997-2007 University of Cambridge |
Copyright (c) 1997-2010 University of Cambridge |
| 9 |
|
|
| 10 |
----------------------------------------------------------------------------- |
----------------------------------------------------------------------------- |
| 11 |
Redistribution and use in source and binary forms, with or without |
Redistribution and use in source and binary forms, with or without |
| 46 |
#define PCRE_PRERELEASE @PCRE_PRERELEASE@ |
#define PCRE_PRERELEASE @PCRE_PRERELEASE@ |
| 47 |
#define PCRE_DATE @PCRE_DATE@ |
#define PCRE_DATE @PCRE_DATE@ |
| 48 |
|
|
| 49 |
/* Win32 uses DLL by default; it needs special stuff for exported functions |
/* When an application links to a PCRE DLL in Windows, the symbols that are |
| 50 |
when building PCRE. */ |
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 |
#ifdef _WIN32 |
don't change existing definitions of PCRE_EXP_DECL and PCRECPP_EXP_DECL. */ |
| 53 |
# ifdef PCRE_DEFINITION |
|
| 54 |
# ifdef DLL_EXPORT |
#if defined(_WIN32) && !defined(PCRE_STATIC) |
| 55 |
# define PCRE_DATA_SCOPE __declspec(dllexport) |
# 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 |
# endif |
| 62 |
# else |
# ifndef PCRECPP_EXP_DEFN |
| 63 |
# ifndef PCRE_STATIC |
# define PCRECPP_EXP_DEFN __declspec(dllimport) |
|
# define PCRE_DATA_SCOPE extern __declspec(dllimport) |
|
| 64 |
# endif |
# endif |
| 65 |
# endif |
# endif |
| 66 |
#endif |
#endif |
| 67 |
|
|
| 68 |
/* Otherwise, we use the standard "extern". */ |
/* By default, we use the standard "extern" declarations. */ |
| 69 |
|
|
| 70 |
#ifndef PCRE_DATA_SCOPE |
#ifndef PCRE_EXP_DECL |
| 71 |
# ifdef __cplusplus |
# ifdef __cplusplus |
| 72 |
# define PCRE_DATA_SCOPE extern "C" |
# define PCRE_EXP_DECL extern "C" |
| 73 |
# else |
# else |
| 74 |
# define PCRE_DATA_SCOPE extern |
# 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 |
# endif |
| 85 |
#endif |
#endif |
| 86 |
|
|
| 95 |
extern "C" { |
extern "C" { |
| 96 |
#endif |
#endif |
| 97 |
|
|
| 98 |
/* Options */ |
/* 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 |
#define PCRE_CASELESS 0x00000001 |
word are now used. In the long run, we may have to re-use some of the |
| 101 |
#define PCRE_MULTILINE 0x00000002 |
compile-time only bits for runtime options, or vice versa. */ |
| 102 |
#define PCRE_DOTALL 0x00000004 |
|
| 103 |
#define PCRE_EXTENDED 0x00000008 |
#define PCRE_CASELESS 0x00000001 /* Compile */ |
| 104 |
#define PCRE_ANCHORED 0x00000010 |
#define PCRE_MULTILINE 0x00000002 /* Compile */ |
| 105 |
#define PCRE_DOLLAR_ENDONLY 0x00000020 |
#define PCRE_DOTALL 0x00000004 /* Compile */ |
| 106 |
#define PCRE_EXTRA 0x00000040 |
#define PCRE_EXTENDED 0x00000008 /* Compile */ |
| 107 |
#define PCRE_NOTBOL 0x00000080 |
#define PCRE_ANCHORED 0x00000010 /* Compile, exec, DFA exec */ |
| 108 |
#define PCRE_NOTEOL 0x00000100 |
#define PCRE_DOLLAR_ENDONLY 0x00000020 /* Compile */ |
| 109 |
#define PCRE_UNGREEDY 0x00000200 |
#define PCRE_EXTRA 0x00000040 /* Compile */ |
| 110 |
#define PCRE_NOTEMPTY 0x00000400 |
#define PCRE_NOTBOL 0x00000080 /* Exec, DFA exec */ |
| 111 |
#define PCRE_UTF8 0x00000800 |
#define PCRE_NOTEOL 0x00000100 /* Exec, DFA exec */ |
| 112 |
#define PCRE_NO_AUTO_CAPTURE 0x00001000 |
#define PCRE_UNGREEDY 0x00000200 /* Compile */ |
| 113 |
#define PCRE_NO_UTF8_CHECK 0x00002000 |
#define PCRE_NOTEMPTY 0x00000400 /* Exec, DFA exec */ |
| 114 |
#define PCRE_AUTO_CALLOUT 0x00004000 |
#define PCRE_UTF8 0x00000800 /* Compile */ |
| 115 |
#define PCRE_PARTIAL 0x00008000 |
#define PCRE_NO_AUTO_CAPTURE 0x00001000 /* Compile */ |
| 116 |
#define PCRE_DFA_SHORTEST 0x00010000 |
#define PCRE_NO_UTF8_CHECK 0x00002000 /* Compile, exec, DFA exec */ |
| 117 |
#define PCRE_DFA_RESTART 0x00020000 |
#define PCRE_AUTO_CALLOUT 0x00004000 /* Compile */ |
| 118 |
#define PCRE_FIRSTLINE 0x00040000 |
#define PCRE_PARTIAL_SOFT 0x00008000 /* Exec, DFA exec */ |
| 119 |
#define PCRE_DUPNAMES 0x00080000 |
#define PCRE_PARTIAL 0x00008000 /* Backwards compatible synonym */ |
| 120 |
#define PCRE_NEWLINE_CR 0x00100000 |
#define PCRE_DFA_SHORTEST 0x00010000 /* DFA exec */ |
| 121 |
#define PCRE_NEWLINE_LF 0x00200000 |
#define PCRE_DFA_RESTART 0x00020000 /* DFA exec */ |
| 122 |
#define PCRE_NEWLINE_CRLF 0x00300000 |
#define PCRE_FIRSTLINE 0x00040000 /* Compile */ |
| 123 |
#define PCRE_NEWLINE_ANY 0x00400000 |
#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 */ |
/* Exec-time and get/set-time error codes */ |
| 139 |
|
|
| 159 |
#define PCRE_ERROR_DFA_WSSIZE (-19) |
#define PCRE_ERROR_DFA_WSSIZE (-19) |
| 160 |
#define PCRE_ERROR_DFA_RECURSE (-20) |
#define PCRE_ERROR_DFA_RECURSE (-20) |
| 161 |
#define PCRE_ERROR_RECURSIONLIMIT (-21) |
#define PCRE_ERROR_RECURSIONLIMIT (-21) |
| 162 |
#define PCRE_ERROR_NULLWSLIMIT (-22) |
#define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */ |
| 163 |
#define PCRE_ERROR_BADNEWLINE (-23) |
#define PCRE_ERROR_BADNEWLINE (-23) |
| 164 |
|
#define PCRE_ERROR_BADOFFSET (-24) |
| 165 |
|
#define PCRE_ERROR_SHORTUTF8 (-25) |
| 166 |
|
|
| 167 |
/* Request types for pcre_fullinfo() */ |
/* Request types for pcre_fullinfo() */ |
| 168 |
|
|
| 179 |
#define PCRE_INFO_NAMETABLE 9 |
#define PCRE_INFO_NAMETABLE 9 |
| 180 |
#define PCRE_INFO_STUDYSIZE 10 |
#define PCRE_INFO_STUDYSIZE 10 |
| 181 |
#define PCRE_INFO_DEFAULT_TABLES 11 |
#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 |
/* Request types for pcre_config(). Do not re-arrange, in order to remain |
| 188 |
compatible. */ |
compatible. */ |
| 195 |
#define PCRE_CONFIG_STACKRECURSE 5 |
#define PCRE_CONFIG_STACKRECURSE 5 |
| 196 |
#define PCRE_CONFIG_UNICODE_PROPERTIES 6 |
#define PCRE_CONFIG_UNICODE_PROPERTIES 6 |
| 197 |
#define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7 |
#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 |
/* Bit flags for the pcre_extra structure. Do not re-arrange or redefine |
| 201 |
these bits, just add new ones on the end, in order to remain compatible. */ |
these bits, just add new ones on the end, in order to remain compatible. */ |
| 205 |
#define PCRE_EXTRA_CALLOUT_DATA 0x0004 |
#define PCRE_EXTRA_CALLOUT_DATA 0x0004 |
| 206 |
#define PCRE_EXTRA_TABLES 0x0008 |
#define PCRE_EXTRA_TABLES 0x0008 |
| 207 |
#define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010 |
#define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010 |
| 208 |
|
#define PCRE_EXTRA_MARK 0x0020 |
| 209 |
|
|
| 210 |
/* Types */ |
/* Types */ |
| 211 |
|
|
| 231 |
void *callout_data; /* Data passed back in callouts */ |
void *callout_data; /* Data passed back in callouts */ |
| 232 |
const unsigned char *tables; /* Pointer to character tables */ |
const unsigned char *tables; /* Pointer to character tables */ |
| 233 |
unsigned long int match_limit_recursion; /* Max recursive calls to match() */ |
unsigned long int match_limit_recursion; /* Max recursive calls to match() */ |
| 234 |
|
unsigned char **mark; /* For passing back a mark pointer */ |
| 235 |
} pcre_extra; |
} pcre_extra; |
| 236 |
|
|
| 237 |
/* The structure for passing out data via the pcre_callout_function. We use a |
/* The structure for passing out data via the pcre_callout_function. We use a |
| 264 |
have to take another form. */ |
have to take another form. */ |
| 265 |
|
|
| 266 |
#ifndef VPCOMPAT |
#ifndef VPCOMPAT |
| 267 |
PCRE_DATA_SCOPE void *(*pcre_malloc)(size_t); |
PCRE_EXP_DECL void *(*pcre_malloc)(size_t); |
| 268 |
PCRE_DATA_SCOPE void (*pcre_free)(void *); |
PCRE_EXP_DECL void (*pcre_free)(void *); |
| 269 |
PCRE_DATA_SCOPE void *(*pcre_stack_malloc)(size_t); |
PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t); |
| 270 |
PCRE_DATA_SCOPE void (*pcre_stack_free)(void *); |
PCRE_EXP_DECL void (*pcre_stack_free)(void *); |
| 271 |
PCRE_DATA_SCOPE int (*pcre_callout)(pcre_callout_block *); |
PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *); |
| 272 |
#else /* VPCOMPAT */ |
#else /* VPCOMPAT */ |
| 273 |
PCRE_DATA_SCOPE void *pcre_malloc(size_t); |
PCRE_EXP_DECL void *pcre_malloc(size_t); |
| 274 |
PCRE_DATA_SCOPE void pcre_free(void *); |
PCRE_EXP_DECL void pcre_free(void *); |
| 275 |
PCRE_DATA_SCOPE void *pcre_stack_malloc(size_t); |
PCRE_EXP_DECL void *pcre_stack_malloc(size_t); |
| 276 |
PCRE_DATA_SCOPE void pcre_stack_free(void *); |
PCRE_EXP_DECL void pcre_stack_free(void *); |
| 277 |
PCRE_DATA_SCOPE int pcre_callout(pcre_callout_block *); |
PCRE_EXP_DECL int pcre_callout(pcre_callout_block *); |
| 278 |
#endif /* VPCOMPAT */ |
#endif /* VPCOMPAT */ |
| 279 |
|
|
| 280 |
/* Exported PCRE functions */ |
/* Exported PCRE functions */ |
| 281 |
|
|
| 282 |
PCRE_DATA_SCOPE pcre *pcre_compile(const char *, int, const char **, int *, |
PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *, |
| 283 |
const unsigned char *); |
const unsigned char *); |
| 284 |
PCRE_DATA_SCOPE pcre *pcre_compile2(const char *, int, int *, const char **, |
PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **, |
| 285 |
int *, const unsigned char *); |
int *, const unsigned char *); |
| 286 |
PCRE_DATA_SCOPE int pcre_config(int, void *); |
PCRE_EXP_DECL int pcre_config(int, void *); |
| 287 |
PCRE_DATA_SCOPE int pcre_copy_named_substring(const pcre *, const char *, |
PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *, |
| 288 |
int *, int, const char *, char *, int); |
int *, int, const char *, char *, int); |
| 289 |
PCRE_DATA_SCOPE int pcre_copy_substring(const char *, int *, int, int, char *, |
PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int, char *, |
| 290 |
int); |
int); |
| 291 |
PCRE_DATA_SCOPE int pcre_dfa_exec(const pcre *, const pcre_extra *, |
PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *, |
| 292 |
const char *, int, int, int, int *, int , int *, int); |
const char *, int, int, int, int *, int , int *, int); |
| 293 |
PCRE_DATA_SCOPE int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR, |
PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR, |
| 294 |
int, int, int, int *, int); |
int, int, int, int *, int); |
| 295 |
PCRE_DATA_SCOPE void pcre_free_substring(const char *); |
PCRE_EXP_DECL void pcre_free_substring(const char *); |
| 296 |
PCRE_DATA_SCOPE void pcre_free_substring_list(const char **); |
PCRE_EXP_DECL void pcre_free_substring_list(const char **); |
| 297 |
PCRE_DATA_SCOPE int pcre_fullinfo(const pcre *, const pcre_extra *, int, |
PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int, |
| 298 |
void *); |
void *); |
| 299 |
PCRE_DATA_SCOPE int pcre_get_named_substring(const pcre *, const char *, |
PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *, |
| 300 |
int *, int, const char *, const char **); |
int *, int, const char *, const char **); |
| 301 |
PCRE_DATA_SCOPE int pcre_get_stringnumber(const pcre *, const char *); |
PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *); |
| 302 |
PCRE_DATA_SCOPE int pcre_get_stringtable_entries(const pcre *, const char *, |
PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *, |
| 303 |
char **, char **); |
char **, char **); |
| 304 |
PCRE_DATA_SCOPE int pcre_get_substring(const char *, int *, int, int, |
PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int, |
| 305 |
const char **); |
const char **); |
| 306 |
PCRE_DATA_SCOPE int pcre_get_substring_list(const char *, int *, int, |
PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int, |
| 307 |
const char ***); |
const char ***); |
| 308 |
PCRE_DATA_SCOPE int pcre_info(const pcre *, int *, int *); |
PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *); |
| 309 |
PCRE_DATA_SCOPE const unsigned char *pcre_maketables(void); |
PCRE_EXP_DECL const unsigned char *pcre_maketables(void); |
| 310 |
PCRE_DATA_SCOPE int pcre_refcount(pcre *, int); |
PCRE_EXP_DECL int pcre_refcount(pcre *, int); |
| 311 |
PCRE_DATA_SCOPE pcre_extra *pcre_study(const pcre *, int, const char **); |
PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **); |
| 312 |
PCRE_DATA_SCOPE const char *pcre_version(void); |
PCRE_EXP_DECL const char *pcre_version(void); |
| 313 |
|
|
| 314 |
#ifdef __cplusplus |
#ifdef __cplusplus |
| 315 |
} /* extern "C" */ |
} /* extern "C" */ |