/[pcre]/code/branches/pcre16/pcre.h.in
ViewVC logotype

Contents of /code/branches/pcre16/pcre.h.in

Parent Directory Parent Directory | Revision Log Revision Log


Revision 795 - (show annotations)
Sat Dec 10 02:20:06 2011 UTC (7 years, 8 months ago) by zherczeg
File size: 19072 byte(s)
extending the 16 bit API, mode check, and fixes
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 @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
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. */
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 (Same as PCRE_UTF16) */
115 #define PCRE_UTF16 0x00000800 /* Compile (Same as PCRE_UTF8) */
116 #define PCRE_NO_AUTO_CAPTURE 0x00001000 /* Compile */
117 #define PCRE_NO_UTF8_CHECK 0x00002000 /* Compile, exec, DFA exec */
118 #define PCRE_AUTO_CALLOUT 0x00004000 /* Compile */
119 #define PCRE_PARTIAL_SOFT 0x00008000 /* Exec, DFA exec */
120 #define PCRE_PARTIAL 0x00008000 /* Backwards compatible synonym */
121 #define PCRE_DFA_SHORTEST 0x00010000 /* DFA exec */
122 #define PCRE_DFA_RESTART 0x00020000 /* DFA exec */
123 #define PCRE_FIRSTLINE 0x00040000 /* Compile */
124 #define PCRE_DUPNAMES 0x00080000 /* Compile */
125 #define PCRE_NEWLINE_CR 0x00100000 /* Compile, exec, DFA exec */
126 #define PCRE_NEWLINE_LF 0x00200000 /* Compile, exec, DFA exec */
127 #define PCRE_NEWLINE_CRLF 0x00300000 /* Compile, exec, DFA exec */
128 #define PCRE_NEWLINE_ANY 0x00400000 /* Compile, exec, DFA exec */
129 #define PCRE_NEWLINE_ANYCRLF 0x00500000 /* Compile, exec, DFA exec */
130 #define PCRE_BSR_ANYCRLF 0x00800000 /* Compile, exec, DFA exec */
131 #define PCRE_BSR_UNICODE 0x01000000 /* Compile, exec, DFA exec */
132 #define PCRE_JAVASCRIPT_COMPAT 0x02000000 /* Compile */
133 #define PCRE_NO_START_OPTIMIZE 0x04000000 /* Compile, exec, DFA exec */
134 #define PCRE_NO_START_OPTIMISE 0x04000000 /* Synonym */
135 #define PCRE_PARTIAL_HARD 0x08000000 /* Exec, DFA exec */
136 #define PCRE_NOTEMPTY_ATSTART 0x10000000 /* Exec, DFA exec */
137 #define PCRE_UCP 0x20000000 /* Compile */
138
139 /* Exec-time and get/set-time error codes */
140
141 #define PCRE_ERROR_NOMATCH (-1)
142 #define PCRE_ERROR_NULL (-2)
143 #define PCRE_ERROR_BADOPTION (-3)
144 #define PCRE_ERROR_BADMAGIC (-4)
145 #define PCRE_ERROR_UNKNOWN_OPCODE (-5)
146 #define PCRE_ERROR_UNKNOWN_NODE (-5) /* For backward compatibility */
147 #define PCRE_ERROR_NOMEMORY (-6)
148 #define PCRE_ERROR_NOSUBSTRING (-7)
149 #define PCRE_ERROR_MATCHLIMIT (-8)
150 #define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */
151 #define PCRE_ERROR_BADUTF8 (-10)
152 #define PCRE_ERROR_BADUTF8_OFFSET (-11)
153 #define PCRE_ERROR_PARTIAL (-12)
154 #define PCRE_ERROR_BADPARTIAL (-13)
155 #define PCRE_ERROR_INTERNAL (-14)
156 #define PCRE_ERROR_BADCOUNT (-15)
157 #define PCRE_ERROR_DFA_UITEM (-16)
158 #define PCRE_ERROR_DFA_UCOND (-17)
159 #define PCRE_ERROR_DFA_UMLIMIT (-18)
160 #define PCRE_ERROR_DFA_WSSIZE (-19)
161 #define PCRE_ERROR_DFA_RECURSE (-20)
162 #define PCRE_ERROR_RECURSIONLIMIT (-21)
163 #define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */
164 #define PCRE_ERROR_BADNEWLINE (-23)
165 #define PCRE_ERROR_BADOFFSET (-24)
166 #define PCRE_ERROR_SHORTUTF8 (-25)
167 #define PCRE_ERROR_RECURSELOOP (-26)
168 #define PCRE_ERROR_JIT_STACKLIMIT (-27)
169 #define PCRE_ERROR_BADMODE (-28)
170
171 /* Specific error codes for UTF-8 validity checks */
172
173 #define PCRE_UTF8_ERR0 0
174 #define PCRE_UTF8_ERR1 1
175 #define PCRE_UTF8_ERR2 2
176 #define PCRE_UTF8_ERR3 3
177 #define PCRE_UTF8_ERR4 4
178 #define PCRE_UTF8_ERR5 5
179 #define PCRE_UTF8_ERR6 6
180 #define PCRE_UTF8_ERR7 7
181 #define PCRE_UTF8_ERR8 8
182 #define PCRE_UTF8_ERR9 9
183 #define PCRE_UTF8_ERR10 10
184 #define PCRE_UTF8_ERR11 11
185 #define PCRE_UTF8_ERR12 12
186 #define PCRE_UTF8_ERR13 13
187 #define PCRE_UTF8_ERR14 14
188 #define PCRE_UTF8_ERR15 15
189 #define PCRE_UTF8_ERR16 16
190 #define PCRE_UTF8_ERR17 17
191 #define PCRE_UTF8_ERR18 18
192 #define PCRE_UTF8_ERR19 19
193 #define PCRE_UTF8_ERR20 20
194 #define PCRE_UTF8_ERR21 21
195
196 /* Specific error codes for UTF-16 validity checks */
197
198 #define PCRE_UTF16_ERR0 0
199 #define PCRE_UTF16_ERR1 1
200 #define PCRE_UTF16_ERR2 2
201 #define PCRE_UTF16_ERR3 3
202 #define PCRE_UTF16_ERR4 4
203
204 /* Request types for pcre_fullinfo() */
205
206 #define PCRE_INFO_OPTIONS 0
207 #define PCRE_INFO_SIZE 1
208 #define PCRE_INFO_CAPTURECOUNT 2
209 #define PCRE_INFO_BACKREFMAX 3
210 #define PCRE_INFO_FIRSTBYTE 4
211 #define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */
212 #define PCRE_INFO_FIRSTTABLE 5
213 #define PCRE_INFO_LASTLITERAL 6
214 #define PCRE_INFO_NAMEENTRYSIZE 7
215 #define PCRE_INFO_NAMECOUNT 8
216 #define PCRE_INFO_NAMETABLE 9
217 #define PCRE_INFO_STUDYSIZE 10
218 #define PCRE_INFO_DEFAULT_TABLES 11
219 #define PCRE_INFO_OKPARTIAL 12
220 #define PCRE_INFO_JCHANGED 13
221 #define PCRE_INFO_HASCRORLF 14
222 #define PCRE_INFO_MINLENGTH 15
223 #define PCRE_INFO_JIT 16
224
225 /* Request types for pcre_config(). Do not re-arrange, in order to remain
226 compatible. */
227
228 #define PCRE_CONFIG_UTF8 0
229 #define PCRE_CONFIG_NEWLINE 1
230 #define PCRE_CONFIG_LINK_SIZE 2
231 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3
232 #define PCRE_CONFIG_MATCH_LIMIT 4
233 #define PCRE_CONFIG_STACKRECURSE 5
234 #define PCRE_CONFIG_UNICODE_PROPERTIES 6
235 #define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7
236 #define PCRE_CONFIG_BSR 8
237 #define PCRE_CONFIG_JIT 9
238 #define PCRE_CONFIG_UTF16 10
239
240 /* Request types for pcre_study(). Do not re-arrange, in order to remain
241 compatible. */
242
243 #define PCRE_STUDY_JIT_COMPILE 0x0001
244
245 /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
246 these bits, just add new ones on the end, in order to remain compatible. */
247
248 #define PCRE_EXTRA_STUDY_DATA 0x0001
249 #define PCRE_EXTRA_MATCH_LIMIT 0x0002
250 #define PCRE_EXTRA_CALLOUT_DATA 0x0004
251 #define PCRE_EXTRA_TABLES 0x0008
252 #define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010
253 #define PCRE_EXTRA_MARK 0x0020
254 #define PCRE_EXTRA_EXECUTABLE_JIT 0x0040
255
256 /* Types */
257
258 struct real_pcre; /* declaration; the definition is private */
259 typedef struct real_pcre pcre;
260
261 struct real_pcre_jit_stack; /* declaration; the definition is private */
262 typedef struct real_pcre_jit_stack pcre_jit_stack;
263
264 /* If PCRE is compiled with 16 bit character support, PCRE_SCHAR16 must contain
265 a 16 bit wide signed data type. Otherwise it can be a dummy data type since
266 pcre16 functions are not implemented. There is a check for this in pcre_internal.h. */
267 #ifndef PCRE_SCHAR16
268 #define PCRE_SCHAR16 short
269 #endif
270
271 #ifndef PCRE_SPTR16
272 #define PCRE_SPTR16 const PCRE_SCHAR16 *
273 #endif
274
275 /* When PCRE is compiled as a C++ library, the subject pointer type can be
276 replaced with a custom type. For conventional use, the public interface is a
277 const char *. */
278
279 #ifndef PCRE_SPTR
280 #define PCRE_SPTR const char *
281 #endif
282
283 /* The structure for passing additional data to pcre_exec(). This is defined in
284 such as way as to be extensible. Always add new fields at the end, in order to
285 remain compatible. */
286
287 typedef struct pcre_extra {
288 unsigned long int flags; /* Bits for which fields are set */
289 void *study_data; /* Opaque data from pcre_study() */
290 unsigned long int match_limit; /* Maximum number of calls to match() */
291 void *callout_data; /* Data passed back in callouts */
292 const unsigned char *tables; /* Pointer to character tables */
293 unsigned long int match_limit_recursion; /* Max recursive calls to match() */
294 unsigned char **mark; /* For passing back a mark pointer */
295 void *executable_jit; /* Contains a pointer to a compiled jit code */
296 } pcre_extra;
297
298 /* The structure for passing out data via the pcre_callout_function. We use a
299 structure so that new fields can be added on the end in future versions,
300 without changing the API of the function, thereby allowing old clients to work
301 without modification. */
302
303 typedef struct pcre_callout_block {
304 int version; /* Identifies version of block */
305 /* ------------------------ Version 0 ------------------------------- */
306 int callout_number; /* Number compiled into pattern */
307 int *offset_vector; /* The offset vector */
308 PCRE_SPTR subject; /* The subject being matched */
309 int subject_length; /* The length of the subject */
310 int start_match; /* Offset to start of this match attempt */
311 int current_position; /* Where we currently are in the subject */
312 int capture_top; /* Max current capture */
313 int capture_last; /* Most recently closed capture */
314 void *callout_data; /* Data passed in with the call */
315 /* ------------------- Added for Version 1 -------------------------- */
316 int pattern_position; /* Offset to next item in the pattern */
317 int next_item_length; /* Length of next item in the pattern */
318 /* ------------------- Added for Version 2 -------------------------- */
319 const unsigned char *mark; /* Pointer to current mark or NULL */
320 /* ------------------------------------------------------------------ */
321 } pcre_callout_block;
322
323 /* Indirection for store get and free functions. These can be set to
324 alternative malloc/free functions if required. Special ones are used in the
325 non-recursive case for "frames". There is also an optional callout function
326 that is triggered by the (?) regex item. For Virtual Pascal, these definitions
327 have to take another form. */
328
329 #ifndef VPCOMPAT
330 PCRE_EXP_DECL void *(*pcre_malloc)(size_t);
331 PCRE_EXP_DECL void (*pcre_free)(void *);
332 PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t);
333 PCRE_EXP_DECL void (*pcre_stack_free)(void *);
334 PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *);
335 #else /* VPCOMPAT */
336 PCRE_EXP_DECL void *pcre_malloc(size_t);
337 PCRE_EXP_DECL void pcre_free(void *);
338 PCRE_EXP_DECL void *pcre_stack_malloc(size_t);
339 PCRE_EXP_DECL void pcre_stack_free(void *);
340 PCRE_EXP_DECL int pcre_callout(pcre_callout_block *);
341 #endif /* VPCOMPAT */
342
343 /* User defined callback which provides a stack just before the match starts. */
344
345 typedef pcre_jit_stack *(*pcre_jit_callback)(void *);
346
347 /* Exported PCRE functions */
348
349 PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *,
350 const unsigned char *);
351 PCRE_EXP_DECL pcre *pcre16_compile(PCRE_SPTR16, int, const char **, int *,
352 const unsigned char *);
353 PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **,
354 int *, const unsigned char *);
355 PCRE_EXP_DECL pcre *pcre16_compile2(PCRE_SPTR16, int, int *, const char **,
356 int *, const unsigned char *);
357 PCRE_EXP_DECL int pcre_config(int, void *);
358 PCRE_EXP_DECL int pcre16_config(int, void *);
359 PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *,
360 int *, int, const char *, char *, int);
361 PCRE_EXP_DECL int pcre16_copy_named_substring(const pcre *, PCRE_SPTR16,
362 int *, int, PCRE_SPTR16, PCRE_SCHAR16 *, int);
363 PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int,
364 char *, int);
365 PCRE_EXP_DECL int pcre16_copy_substring(PCRE_SPTR16, int *, int, int,
366 PCRE_SCHAR16 *, int);
367 PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *,
368 const char *, int, int, int, int *, int , int *, int);
369 PCRE_EXP_DECL int pcre16_dfa_exec(const pcre *, const pcre_extra *,
370 PCRE_SPTR16, int, int, int, int *, int , int *, int);
371 PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
372 int, int, int, int *, int);
373 PCRE_EXP_DECL int pcre16_exec(const pcre *, const pcre_extra *, PCRE_SPTR16,
374 int, int, int, int *, int);
375 PCRE_EXP_DECL void pcre_free_substring(const char *);
376 PCRE_EXP_DECL void pcre16_free_substring(PCRE_SPTR16);
377 PCRE_EXP_DECL void pcre_free_substring_list(const char **);
378 PCRE_EXP_DECL void pcre16_free_substring_list(PCRE_SPTR16 *);
379 PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int,
380 void *);
381 PCRE_EXP_DECL int pcre16_fullinfo(const pcre *, const pcre_extra *, int,
382 void *);
383 PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *,
384 int *, int, const char *, const char **);
385 PCRE_EXP_DECL int pcre16_get_named_substring(const pcre *, PCRE_SPTR16,
386 int *, int, PCRE_SPTR16, PCRE_SPTR16 *);
387 PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *);
388 PCRE_EXP_DECL int pcre16_get_stringnumber(const pcre *, PCRE_SPTR16);
389 PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *,
390 char **, char **);
391 PCRE_EXP_DECL int pcre16_get_stringtable_entries(const pcre *, PCRE_SPTR16,
392 PCRE_SCHAR16 **, PCRE_SCHAR16 **);
393 PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int,
394 const char **);
395 PCRE_EXP_DECL int pcre16_get_substring(PCRE_SPTR16, int *, int, int,
396 PCRE_SPTR16 *);
397 PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int,
398 const char ***);
399 PCRE_EXP_DECL int pcre16_get_substring_list(PCRE_SPTR16, int *, int,
400 PCRE_SPTR16 **);
401 PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *);
402 PCRE_EXP_DECL int pcre16_info(const pcre *, int *, int *);
403 PCRE_EXP_DECL const unsigned char *pcre_maketables(void);
404 PCRE_EXP_DECL int pcre_refcount(pcre *, int);
405 PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **);
406 PCRE_EXP_DECL pcre_extra *pcre16_study(const pcre *, int, const char **);
407 PCRE_EXP_DECL void pcre_free_study(pcre_extra *);
408 PCRE_EXP_DECL void pcre16_free_study(pcre_extra *);
409 PCRE_EXP_DECL const char *pcre_version(void);
410 PCRE_EXP_DECL const char *pcre16_version(void);
411
412 /* Utility functions. */
413 PCRE_EXP_DECL int pcre16_utf16_to_host_byte_order(PCRE_SCHAR16 *,
414 PCRE_SPTR16, int, int);
415
416 /* JIT compiler related functions. */
417
418 PCRE_EXP_DECL pcre_jit_stack *pcre_jit_stack_alloc(int, int);
419 PCRE_EXP_DECL pcre_jit_stack *pcre16_jit_stack_alloc(int, int);
420 PCRE_EXP_DECL void pcre_jit_stack_free(pcre_jit_stack *);
421 PCRE_EXP_DECL void pcre16_jit_stack_free(pcre_jit_stack *);
422 PCRE_EXP_DECL void pcre_assign_jit_stack(pcre_extra *,
423 pcre_jit_callback, void *);
424 PCRE_EXP_DECL void pcre16_assign_jit_stack(pcre_extra *,
425 pcre_jit_callback, void *);
426
427 #ifdef __cplusplus
428 } /* extern "C" */
429 #endif
430
431 #endif /* End of pcre.h */

  ViewVC Help
Powered by ViewVC 1.1.5