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-2009 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 8 45#define PCRE_MINOR 02 46#define PCRE_PRERELEASE 47#define PCRE_DATE 2010-03-19 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. */ 100 101#define PCRE_CASELESS 0x00000001 102#define PCRE_MULTILINE 0x00000002 103#define PCRE_DOTALL 0x00000004 104#define PCRE_EXTENDED 0x00000008 105#define PCRE_ANCHORED 0x00000010 106#define PCRE_DOLLAR_ENDONLY 0x00000020 107#define PCRE_EXTRA 0x00000040 108#define PCRE_NOTBOL 0x00000080 109#define PCRE_NOTEOL 0x00000100 110#define PCRE_UNGREEDY 0x00000200 111#define PCRE_NOTEMPTY 0x00000400 112#define PCRE_UTF8 0x00000800 113#define PCRE_NO_AUTO_CAPTURE 0x00001000 114#define PCRE_NO_UTF8_CHECK 0x00002000 115#define PCRE_AUTO_CALLOUT 0x00004000 116#define PCRE_PARTIAL_SOFT 0x00008000 117#define PCRE_PARTIAL 0x00008000 /* Backwards compatible synonym */ 118#define PCRE_DFA_SHORTEST 0x00010000 119#define PCRE_DFA_RESTART 0x00020000 120#define PCRE_FIRSTLINE 0x00040000 121#define PCRE_DUPNAMES 0x00080000 122#define PCRE_NEWLINE_CR 0x00100000 123#define PCRE_NEWLINE_LF 0x00200000 124#define PCRE_NEWLINE_CRLF 0x00300000 125#define PCRE_NEWLINE_ANY 0x00400000 126#define PCRE_NEWLINE_ANYCRLF 0x00500000 127#define PCRE_BSR_ANYCRLF 0x00800000 128#define PCRE_BSR_UNICODE 0x01000000 129#define PCRE_JAVASCRIPT_COMPAT 0x02000000 130#define PCRE_NO_START_OPTIMIZE 0x04000000 131#define PCRE_NO_START_OPTIMISE 0x04000000 132#define PCRE_PARTIAL_HARD 0x08000000 133#define PCRE_NOTEMPTY_ATSTART 0x10000000 134 135/* Exec-time and get/set-time error codes */ 136 137#define PCRE_ERROR_NOMATCH (-1) 138#define PCRE_ERROR_NULL (-2) 139#define PCRE_ERROR_BADOPTION (-3) 140#define PCRE_ERROR_BADMAGIC (-4) 141#define PCRE_ERROR_UNKNOWN_OPCODE (-5) 142#define PCRE_ERROR_UNKNOWN_NODE (-5) /* For backward compatibility */ 143#define PCRE_ERROR_NOMEMORY (-6) 144#define PCRE_ERROR_NOSUBSTRING (-7) 145#define PCRE_ERROR_MATCHLIMIT (-8) 146#define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */ 147#define PCRE_ERROR_BADUTF8 (-10) 148#define PCRE_ERROR_BADUTF8_OFFSET (-11) 149#define PCRE_ERROR_PARTIAL (-12) 150#define PCRE_ERROR_BADPARTIAL (-13) 151#define PCRE_ERROR_INTERNAL (-14) 152#define PCRE_ERROR_BADCOUNT (-15) 153#define PCRE_ERROR_DFA_UITEM (-16) 154#define PCRE_ERROR_DFA_UCOND (-17) 155#define PCRE_ERROR_DFA_UMLIMIT (-18) 156#define PCRE_ERROR_DFA_WSSIZE (-19) 157#define PCRE_ERROR_DFA_RECURSE (-20) 158#define PCRE_ERROR_RECURSIONLIMIT (-21) 159#define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */ 160#define PCRE_ERROR_BADNEWLINE (-23) 161 162/* Request types for pcre_fullinfo() */ 163 164#define PCRE_INFO_OPTIONS 0 165#define PCRE_INFO_SIZE 1 166#define PCRE_INFO_CAPTURECOUNT 2 167#define PCRE_INFO_BACKREFMAX 3 168#define PCRE_INFO_FIRSTBYTE 4 169#define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */ 170#define PCRE_INFO_FIRSTTABLE 5 171#define PCRE_INFO_LASTLITERAL 6 172#define PCRE_INFO_NAMEENTRYSIZE 7 173#define PCRE_INFO_NAMECOUNT 8 174#define PCRE_INFO_NAMETABLE 9 175#define PCRE_INFO_STUDYSIZE 10 176#define PCRE_INFO_DEFAULT_TABLES 11 177#define PCRE_INFO_OKPARTIAL 12 178#define PCRE_INFO_JCHANGED 13 179#define PCRE_INFO_HASCRORLF 14 180#define PCRE_INFO_MINLENGTH 15 181 182/* Request types for pcre_config(). Do not re-arrange, in order to remain 183compatible. */ 184 185#define PCRE_CONFIG_UTF8 0 186#define PCRE_CONFIG_NEWLINE 1 187#define PCRE_CONFIG_LINK_SIZE 2 188#define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3 189#define PCRE_CONFIG_MATCH_LIMIT 4 190#define PCRE_CONFIG_STACKRECURSE 5 191#define PCRE_CONFIG_UNICODE_PROPERTIES 6 192#define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7 193#define PCRE_CONFIG_BSR 8 194 195/* Bit flags for the pcre_extra structure. Do not re-arrange or redefine 196these bits, just add new ones on the end, in order to remain compatible. */ 197 198#define PCRE_EXTRA_STUDY_DATA 0x0001 199#define PCRE_EXTRA_MATCH_LIMIT 0x0002 200#define PCRE_EXTRA_CALLOUT_DATA 0x0004 201#define PCRE_EXTRA_TABLES 0x0008 202#define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010 203 204/* Types */ 205 206struct real_pcre; /* declaration; the definition is private */ 207typedef struct real_pcre pcre; 208 209/* When PCRE is compiled as a C++ library, the subject pointer type can be 210replaced with a custom type. For conventional use, the public interface is a 211const char *. */ 212 213#ifndef PCRE_SPTR 214#define PCRE_SPTR const char * 215#endif 216 217/* The structure for passing additional data to pcre_exec(). This is defined in 218such as way as to be extensible. Always add new fields at the end, in order to 219remain compatible. */ 220 221typedef struct pcre_extra { 222 unsigned long int flags; /* Bits for which fields are set */ 223 void *study_data; /* Opaque data from pcre_study() */ 224 unsigned long int match_limit; /* Maximum number of calls to match() */ 225 void *callout_data; /* Data passed back in callouts */ 226 const unsigned char *tables; /* Pointer to character tables */ 227 unsigned long int match_limit_recursion; /* Max recursive calls to match() */ 228} pcre_extra; 229 230/* The structure for passing out data via the pcre_callout_function. We use a 231structure so that new fields can be added on the end in future versions, 232without changing the API of the function, thereby allowing old clients to work 233without modification. */ 234 235typedef struct pcre_callout_block { 236 int version; /* Identifies version of block */ 237 /* ------------------------ Version 0 ------------------------------- */ 238 int callout_number; /* Number compiled into pattern */ 239 int *offset_vector; /* The offset vector */ 240 PCRE_SPTR subject; /* The subject being matched */ 241 int subject_length; /* The length of the subject */ 242 int start_match; /* Offset to start of this match attempt */ 243 int current_position; /* Where we currently are in the subject */ 244 int capture_top; /* Max current capture */ 245 int capture_last; /* Most recently closed capture */ 246 void *callout_data; /* Data passed in with the call */ 247 /* ------------------- Added for Version 1 -------------------------- */ 248 int pattern_position; /* Offset to next item in the pattern */ 249 int next_item_length; /* Length of next item in the pattern */ 250 /* ------------------------------------------------------------------ */ 251} pcre_callout_block; 252 253/* Indirection for store get and free functions. These can be set to 254alternative malloc/free functions if required. Special ones are used in the 255non-recursive case for "frames". There is also an optional callout function 256that is triggered by the (?) regex item. For Virtual Pascal, these definitions 257have to take another form. */ 258 259#ifndef VPCOMPAT 260PCRE_EXP_DECL void *(*pcre_malloc)(size_t); 261PCRE_EXP_DECL void (*pcre_free)(void *); 262PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t); 263PCRE_EXP_DECL void (*pcre_stack_free)(void *); 264PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *); 265#else /* VPCOMPAT */ 266PCRE_EXP_DECL void *pcre_malloc(size_t); 267PCRE_EXP_DECL void pcre_free(void *); 268PCRE_EXP_DECL void *pcre_stack_malloc(size_t); 269PCRE_EXP_DECL void pcre_stack_free(void *); 270PCRE_EXP_DECL int pcre_callout(pcre_callout_block *); 271#endif /* VPCOMPAT */ 272 273/* Exported PCRE functions */ 274 275PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *, 276 const unsigned char *); 277PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **, 278 int *, const unsigned char *); 279PCRE_EXP_DECL int pcre_config(int, void *); 280PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *, 281 int *, int, const char *, char *, int); 282PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int, char *, 283 int); 284PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *, 285 const char *, int, int, int, int *, int , int *, int); 286PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR, 287 int, int, int, int *, int); 288PCRE_EXP_DECL void pcre_free_substring(const char *); 289PCRE_EXP_DECL void pcre_free_substring_list(const char **); 290PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int, 291 void *); 292PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *, 293 int *, int, const char *, const char **); 294PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *); 295PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *, 296 char **, char **); 297PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int, 298 const char **); 299PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int, 300 const char ***); 301PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *); 302PCRE_EXP_DECL const unsigned char *pcre_maketables(void); 303PCRE_EXP_DECL int pcre_refcount(pcre *, int); 304PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **); 305PCRE_EXP_DECL const char *pcre_version(void); 306 307#ifdef __cplusplus 308} /* extern "C" */ 309#endif 310 311#endif /* End of pcre.h */ 312