1 /*************************************************
2 * Perl-Compatible Regular Expressions *
3 *************************************************/
5 /* This is the public header file for the PCRE library, to be #included by
6 applications that call the PCRE functions.
8 Copyright (c) 1997-2009 University of Cambridge
10 -----------------------------------------------------------------------------
11 Redistribution and use in source and binary forms, with or without
12 modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
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.
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.
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 -----------------------------------------------------------------------------
42 /* The current PCRE version information. */
44 #define PCRE_MAJOR @PCRE_MAJOR@
45 #define PCRE_MINOR @PCRE_MINOR@
46 #define PCRE_PRERELEASE @PCRE_PRERELEASE@
47 #define PCRE_DATE @PCRE_DATE@
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. */
54 #if defined(_WIN32) && !defined(PCRE_STATIC)
55 # ifndef PCRE_EXP_DECL
56 # define PCRE_EXP_DECL extern __declspec(dllimport)
59 # ifndef PCRECPP_EXP_DECL
60 # define PCRECPP_EXP_DECL extern __declspec(dllimport)
62 # ifndef PCRECPP_EXP_DEFN
63 # define PCRECPP_EXP_DEFN __declspec(dllimport)
68 /* By default, we use the standard "extern" declarations. */
72 # define PCRE_EXP_DECL extern "C"
74 # define PCRE_EXP_DECL extern
79 # ifndef PCRECPP_EXP_DECL
80 # define PCRECPP_EXP_DECL extern
82 # ifndef PCRECPP_EXP_DEFN
83 # define PCRECPP_EXP_DEFN
87 /* Have to include stdlib.h in order to ensure that size_t is defined;
88 it is needed here for malloc. */
92 /* Allow for C++ users */
98 /* Options. Some are compile-time only, some are run-time only, and some are
99 both, so we keep them all distinct. */
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 0x00008000
117 #define PCRE_DFA_SHORTEST 0x00010000
118 #define PCRE_DFA_RESTART 0x00020000
119 #define PCRE_FIRSTLINE 0x00040000
120 #define PCRE_DUPNAMES 0x00080000
121 #define PCRE_NEWLINE_CR 0x00100000
122 #define PCRE_NEWLINE_LF 0x00200000
123 #define PCRE_NEWLINE_CRLF 0x00300000
124 #define PCRE_NEWLINE_ANY 0x00400000
125 #define PCRE_NEWLINE_ANYCRLF 0x00500000
126 #define PCRE_BSR_ANYCRLF 0x00800000
127 #define PCRE_BSR_UNICODE 0x01000000
128 #define PCRE_JAVASCRIPT_COMPAT 0x02000000
129 #define PCRE_NO_START_OPTIMIZE 0x04000000
130 #define PCRE_NO_START_OPTIMISE 0x04000000
132 /* Exec-time and get/set-time error codes */
134 #define PCRE_ERROR_NOMATCH (-1)
135 #define PCRE_ERROR_NULL (-2)
136 #define PCRE_ERROR_BADOPTION (-3)
137 #define PCRE_ERROR_BADMAGIC (-4)
138 #define PCRE_ERROR_UNKNOWN_OPCODE (-5)
139 #define PCRE_ERROR_UNKNOWN_NODE (-5) /* For backward compatibility */
140 #define PCRE_ERROR_NOMEMORY (-6)
141 #define PCRE_ERROR_NOSUBSTRING (-7)
142 #define PCRE_ERROR_MATCHLIMIT (-8)
143 #define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */
144 #define PCRE_ERROR_BADUTF8 (-10)
145 #define PCRE_ERROR_BADUTF8_OFFSET (-11)
146 #define PCRE_ERROR_PARTIAL (-12)
147 #define PCRE_ERROR_BADPARTIAL (-13)
148 #define PCRE_ERROR_INTERNAL (-14)
149 #define PCRE_ERROR_BADCOUNT (-15)
150 #define PCRE_ERROR_DFA_UITEM (-16)
151 #define PCRE_ERROR_DFA_UCOND (-17)
152 #define PCRE_ERROR_DFA_UMLIMIT (-18)
153 #define PCRE_ERROR_DFA_WSSIZE (-19)
154 #define PCRE_ERROR_DFA_RECURSE (-20)
155 #define PCRE_ERROR_RECURSIONLIMIT (-21)
156 #define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */
157 #define PCRE_ERROR_BADNEWLINE (-23)
159 /* Request types for pcre_fullinfo() */
161 #define PCRE_INFO_OPTIONS 0
162 #define PCRE_INFO_SIZE 1
163 #define PCRE_INFO_CAPTURECOUNT 2
164 #define PCRE_INFO_BACKREFMAX 3
165 #define PCRE_INFO_FIRSTBYTE 4
166 #define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */
167 #define PCRE_INFO_FIRSTTABLE 5
168 #define PCRE_INFO_LASTLITERAL 6
169 #define PCRE_INFO_NAMEENTRYSIZE 7
170 #define PCRE_INFO_NAMECOUNT 8
171 #define PCRE_INFO_NAMETABLE 9
172 #define PCRE_INFO_STUDYSIZE 10
173 #define PCRE_INFO_DEFAULT_TABLES 11
174 #define PCRE_INFO_OKPARTIAL 12
175 #define PCRE_INFO_JCHANGED 13
176 #define PCRE_INFO_HASCRORLF 14
178 /* Request types for pcre_config(). Do not re-arrange, in order to remain
181 #define PCRE_CONFIG_UTF8 0
182 #define PCRE_CONFIG_NEWLINE 1
183 #define PCRE_CONFIG_LINK_SIZE 2
184 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3
185 #define PCRE_CONFIG_MATCH_LIMIT 4
186 #define PCRE_CONFIG_STACKRECURSE 5
187 #define PCRE_CONFIG_UNICODE_PROPERTIES 6
188 #define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7
189 #define PCRE_CONFIG_BSR 8
191 /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
192 these bits, just add new ones on the end, in order to remain compatible. */
194 #define PCRE_EXTRA_STUDY_DATA 0x0001
195 #define PCRE_EXTRA_MATCH_LIMIT 0x0002
196 #define PCRE_EXTRA_CALLOUT_DATA 0x0004
197 #define PCRE_EXTRA_TABLES 0x0008
198 #define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010
202 struct real_pcre; /* declaration; the definition is private */
203 typedef struct real_pcre pcre;
205 /* When PCRE is compiled as a C++ library, the subject pointer type can be
206 replaced with a custom type. For conventional use, the public interface is a
210 #define PCRE_SPTR const char *
213 /* The structure for passing additional data to pcre_exec(). This is defined in
214 such as way as to be extensible. Always add new fields at the end, in order to
215 remain compatible. */
217 typedef struct pcre_extra {
218 unsigned long int flags; /* Bits for which fields are set */
219 void *study_data; /* Opaque data from pcre_study() */
220 unsigned long int match_limit; /* Maximum number of calls to match() */
221 void *callout_data; /* Data passed back in callouts */
222 const unsigned char *tables; /* Pointer to character tables */
223 unsigned long int match_limit_recursion; /* Max recursive calls to match() */
226 /* The structure for passing out data via the pcre_callout_function. We use a
227 structure so that new fields can be added on the end in future versions,
228 without changing the API of the function, thereby allowing old clients to work
229 without modification. */
231 typedef struct pcre_callout_block {
232 int version; /* Identifies version of block */
233 /* ------------------------ Version 0 ------------------------------- */
234 int callout_number; /* Number compiled into pattern */
235 int *offset_vector; /* The offset vector */
236 PCRE_SPTR subject; /* The subject being matched */
237 int subject_length; /* The length of the subject */
238 int start_match; /* Offset to start of this match attempt */
239 int current_position; /* Where we currently are in the subject */
240 int capture_top; /* Max current capture */
241 int capture_last; /* Most recently closed capture */
242 void *callout_data; /* Data passed in with the call */
243 /* ------------------- Added for Version 1 -------------------------- */
244 int pattern_position; /* Offset to next item in the pattern */
245 int next_item_length; /* Length of next item in the pattern */
246 /* ------------------------------------------------------------------ */
247 } pcre_callout_block;
249 /* Indirection for store get and free functions. These can be set to
250 alternative malloc/free functions if required. Special ones are used in the
251 non-recursive case for "frames". There is also an optional callout function
252 that is triggered by the (?) regex item. For Virtual Pascal, these definitions
253 have to take another form. */
256 PCRE_EXP_DECL void *(*pcre_malloc)(size_t);
257 PCRE_EXP_DECL void (*pcre_free)(void *);
258 PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t);
259 PCRE_EXP_DECL void (*pcre_stack_free)(void *);
260 PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *);
262 PCRE_EXP_DECL void *pcre_malloc(size_t);
263 PCRE_EXP_DECL void pcre_free(void *);
264 PCRE_EXP_DECL void *pcre_stack_malloc(size_t);
265 PCRE_EXP_DECL void pcre_stack_free(void *);
266 PCRE_EXP_DECL int pcre_callout(pcre_callout_block *);
267 #endif /* VPCOMPAT */
269 /* Exported PCRE functions */
271 PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *,
272 const unsigned char *);
273 PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **,
274 int *, const unsigned char *);
275 PCRE_EXP_DECL int pcre_config(int, void *);
276 PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *,
277 int *, int, const char *, char *, int);
278 PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int, char *,
280 PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *,
281 const char *, int, int, int, int *, int , int *, int);
282 PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
283 int, int, int, int *, int);
284 PCRE_EXP_DECL void pcre_free_substring(const char *);
285 PCRE_EXP_DECL void pcre_free_substring_list(const char **);
286 PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int,
288 PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *,
289 int *, int, const char *, const char **);
290 PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *);
291 PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *,
293 PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int,
295 PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int,
297 PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *);
298 PCRE_EXP_DECL const unsigned char *pcre_maketables(void);
299 PCRE_EXP_DECL int pcre_refcount(pcre *, int);
300 PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **);
301 PCRE_EXP_DECL const char *pcre_version(void);
307 #endif /* End of pcre.h */
