OSDN Git Service

First version
[st-ro/stro.git] / 3rdparty / pcre / include / pcre.h
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-2013 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          8
45 #define PCRE_MINOR          33
46 #define PCRE_PRERELEASE     
47 #define PCRE_DATE           2013-05-28
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 /* Public options. Some are compile-time only, some are run-time only, and some
99 are both. Most of the compile-time options are saved with the compiled regex so
100 that they can be inspected during studying (and therefore JIT compiling). Note
101 that pcre_study() has its own set of options. Originally, all the options
102 defined here used distinct bits. However, almost all the bits in a 32-bit word
103 are now used, so in order to conserve them, option bits that were previously
104 only recognized at matching time (i.e. by pcre_exec() or pcre_dfa_exec()) may
105 also be used for compile-time options that affect only compiling and are not
106 relevant for studying or JIT compiling.
107
108 Some options for pcre_compile() change its behaviour but do not affect the
109 behaviour of the execution functions. Other options are passed through to the
110 execution functions and affect their behaviour, with or without affecting the
111 behaviour of pcre_compile().
112
113 Options that can be passed to pcre_compile() are tagged Cx below, with these
114 variants:
115
116 C1   Affects compile only
117 C2   Does not affect compile; affects exec, dfa_exec
118 C3   Affects compile, exec, dfa_exec
119 C4   Affects compile, exec, dfa_exec, study
120 C5   Affects compile, exec, study
121
122 Options that can be set for pcre_exec() and/or pcre_dfa_exec() are flagged with
123 E and D, respectively. They take precedence over C3, C4, and C5 settings passed
124 from pcre_compile(). Those that are compatible with JIT execution are flagged
125 with J. */
126
127 #define PCRE_CASELESS           0x00000001  /* C1       */
128 #define PCRE_MULTILINE          0x00000002  /* C1       */
129 #define PCRE_DOTALL             0x00000004  /* C1       */
130 #define PCRE_EXTENDED           0x00000008  /* C1       */
131 #define PCRE_ANCHORED           0x00000010  /* C4 E D   */
132 #define PCRE_DOLLAR_ENDONLY     0x00000020  /* C2       */
133 #define PCRE_EXTRA              0x00000040  /* C1       */
134 #define PCRE_NOTBOL             0x00000080  /*    E D J */
135 #define PCRE_NOTEOL             0x00000100  /*    E D J */
136 #define PCRE_UNGREEDY           0x00000200  /* C1       */
137 #define PCRE_NOTEMPTY           0x00000400  /*    E D J */
138 #define PCRE_UTF8               0x00000800  /* C4        )          */
139 #define PCRE_UTF16              0x00000800  /* C4        ) Synonyms */
140 #define PCRE_UTF32              0x00000800  /* C4        )          */
141 #define PCRE_NO_AUTO_CAPTURE    0x00001000  /* C1       */
142 #define PCRE_NO_UTF8_CHECK      0x00002000  /* C1 E D J  )          */
143 #define PCRE_NO_UTF16_CHECK     0x00002000  /* C1 E D J  ) Synonyms */
144 #define PCRE_NO_UTF32_CHECK     0x00002000  /* C1 E D J  )          */
145 #define PCRE_AUTO_CALLOUT       0x00004000  /* C1       */
146 #define PCRE_PARTIAL_SOFT       0x00008000  /*    E D J  ) Synonyms */
147 #define PCRE_PARTIAL            0x00008000  /*    E D J  )          */
148
149 /* This pair use the same bit. */
150 #define PCRE_NEVER_UTF          0x00010000  /* C1        ) Overlaid */
151 #define PCRE_DFA_SHORTEST       0x00010000  /*      D    ) Overlaid */
152
153 #define PCRE_DFA_RESTART        0x00020000  /*      D   */
154 #define PCRE_FIRSTLINE          0x00040000  /* C3       */
155 #define PCRE_DUPNAMES           0x00080000  /* C1       */
156 #define PCRE_NEWLINE_CR         0x00100000  /* C3 E D   */
157 #define PCRE_NEWLINE_LF         0x00200000  /* C3 E D   */
158 #define PCRE_NEWLINE_CRLF       0x00300000  /* C3 E D   */
159 #define PCRE_NEWLINE_ANY        0x00400000  /* C3 E D   */
160 #define PCRE_NEWLINE_ANYCRLF    0x00500000  /* C3 E D   */
161 #define PCRE_BSR_ANYCRLF        0x00800000  /* C3 E D   */
162 #define PCRE_BSR_UNICODE        0x01000000  /* C3 E D   */
163 #define PCRE_JAVASCRIPT_COMPAT  0x02000000  /* C5       */
164 #define PCRE_NO_START_OPTIMIZE  0x04000000  /* C2 E D    ) Synonyms */
165 #define PCRE_NO_START_OPTIMISE  0x04000000  /* C2 E D    )          */
166 #define PCRE_PARTIAL_HARD       0x08000000  /*    E D J */
167 #define PCRE_NOTEMPTY_ATSTART   0x10000000  /*    E D J */
168 #define PCRE_UCP                0x20000000  /* C3       */
169
170 /* Exec-time and get/set-time error codes */
171
172 #define PCRE_ERROR_NOMATCH          (-1)
173 #define PCRE_ERROR_NULL             (-2)
174 #define PCRE_ERROR_BADOPTION        (-3)
175 #define PCRE_ERROR_BADMAGIC         (-4)
176 #define PCRE_ERROR_UNKNOWN_OPCODE   (-5)
177 #define PCRE_ERROR_UNKNOWN_NODE     (-5)  /* For backward compatibility */
178 #define PCRE_ERROR_NOMEMORY         (-6)
179 #define PCRE_ERROR_NOSUBSTRING      (-7)
180 #define PCRE_ERROR_MATCHLIMIT       (-8)
181 #define PCRE_ERROR_CALLOUT          (-9)  /* Never used by PCRE itself */
182 #define PCRE_ERROR_BADUTF8         (-10)  /* Same for 8/16/32 */
183 #define PCRE_ERROR_BADUTF16        (-10)  /* Same for 8/16/32 */
184 #define PCRE_ERROR_BADUTF32        (-10)  /* Same for 8/16/32 */
185 #define PCRE_ERROR_BADUTF8_OFFSET  (-11)  /* Same for 8/16 */
186 #define PCRE_ERROR_BADUTF16_OFFSET (-11)  /* Same for 8/16 */
187 #define PCRE_ERROR_PARTIAL         (-12)
188 #define PCRE_ERROR_BADPARTIAL      (-13)
189 #define PCRE_ERROR_INTERNAL        (-14)
190 #define PCRE_ERROR_BADCOUNT        (-15)
191 #define PCRE_ERROR_DFA_UITEM       (-16)
192 #define PCRE_ERROR_DFA_UCOND       (-17)
193 #define PCRE_ERROR_DFA_UMLIMIT     (-18)
194 #define PCRE_ERROR_DFA_WSSIZE      (-19)
195 #define PCRE_ERROR_DFA_RECURSE     (-20)
196 #define PCRE_ERROR_RECURSIONLIMIT  (-21)
197 #define PCRE_ERROR_NULLWSLIMIT     (-22)  /* No longer actually used */
198 #define PCRE_ERROR_BADNEWLINE      (-23)
199 #define PCRE_ERROR_BADOFFSET       (-24)
200 #define PCRE_ERROR_SHORTUTF8       (-25)
201 #define PCRE_ERROR_SHORTUTF16      (-25)  /* Same for 8/16 */
202 #define PCRE_ERROR_RECURSELOOP     (-26)
203 #define PCRE_ERROR_JIT_STACKLIMIT  (-27)
204 #define PCRE_ERROR_BADMODE         (-28)
205 #define PCRE_ERROR_BADENDIANNESS   (-29)
206 #define PCRE_ERROR_DFA_BADRESTART  (-30)
207 #define PCRE_ERROR_JIT_BADOPTION   (-31)
208 #define PCRE_ERROR_BADLENGTH       (-32)
209 #define PCRE_ERROR_UNSET           (-33)
210
211 /* Specific error codes for UTF-8 validity checks */
212
213 #define PCRE_UTF8_ERR0               0
214 #define PCRE_UTF8_ERR1               1
215 #define PCRE_UTF8_ERR2               2
216 #define PCRE_UTF8_ERR3               3
217 #define PCRE_UTF8_ERR4               4
218 #define PCRE_UTF8_ERR5               5
219 #define PCRE_UTF8_ERR6               6
220 #define PCRE_UTF8_ERR7               7
221 #define PCRE_UTF8_ERR8               8
222 #define PCRE_UTF8_ERR9               9
223 #define PCRE_UTF8_ERR10             10
224 #define PCRE_UTF8_ERR11             11
225 #define PCRE_UTF8_ERR12             12
226 #define PCRE_UTF8_ERR13             13
227 #define PCRE_UTF8_ERR14             14
228 #define PCRE_UTF8_ERR15             15
229 #define PCRE_UTF8_ERR16             16
230 #define PCRE_UTF8_ERR17             17
231 #define PCRE_UTF8_ERR18             18
232 #define PCRE_UTF8_ERR19             19
233 #define PCRE_UTF8_ERR20             20
234 #define PCRE_UTF8_ERR21             21
235 #define PCRE_UTF8_ERR22             22  /* Unused (was non-character) */
236
237 /* Specific error codes for UTF-16 validity checks */
238
239 #define PCRE_UTF16_ERR0              0
240 #define PCRE_UTF16_ERR1              1
241 #define PCRE_UTF16_ERR2              2
242 #define PCRE_UTF16_ERR3              3
243 #define PCRE_UTF16_ERR4              4  /* Unused (was non-character) */
244
245 /* Specific error codes for UTF-32 validity checks */
246
247 #define PCRE_UTF32_ERR0              0
248 #define PCRE_UTF32_ERR1              1
249 #define PCRE_UTF32_ERR2              2  /* Unused (was non-character) */
250 #define PCRE_UTF32_ERR3              3
251
252 /* Request types for pcre_fullinfo() */
253
254 #define PCRE_INFO_OPTIONS            0
255 #define PCRE_INFO_SIZE               1
256 #define PCRE_INFO_CAPTURECOUNT       2
257 #define PCRE_INFO_BACKREFMAX         3
258 #define PCRE_INFO_FIRSTBYTE          4
259 #define PCRE_INFO_FIRSTCHAR          4  /* For backwards compatibility */
260 #define PCRE_INFO_FIRSTTABLE         5
261 #define PCRE_INFO_LASTLITERAL        6
262 #define PCRE_INFO_NAMEENTRYSIZE      7
263 #define PCRE_INFO_NAMECOUNT          8
264 #define PCRE_INFO_NAMETABLE          9
265 #define PCRE_INFO_STUDYSIZE         10
266 #define PCRE_INFO_DEFAULT_TABLES    11
267 #define PCRE_INFO_OKPARTIAL         12
268 #define PCRE_INFO_JCHANGED          13
269 #define PCRE_INFO_HASCRORLF         14
270 #define PCRE_INFO_MINLENGTH         15
271 #define PCRE_INFO_JIT               16
272 #define PCRE_INFO_JITSIZE           17
273 #define PCRE_INFO_MAXLOOKBEHIND     18
274 #define PCRE_INFO_FIRSTCHARACTER    19
275 #define PCRE_INFO_FIRSTCHARACTERFLAGS 20
276 #define PCRE_INFO_REQUIREDCHAR      21
277 #define PCRE_INFO_REQUIREDCHARFLAGS 22
278 #define PCRE_INFO_MATCHLIMIT        23
279 #define PCRE_INFO_RECURSIONLIMIT    24
280
281 /* Request types for pcre_config(). Do not re-arrange, in order to remain
282 compatible. */
283
284 #define PCRE_CONFIG_UTF8                    0
285 #define PCRE_CONFIG_NEWLINE                 1
286 #define PCRE_CONFIG_LINK_SIZE               2
287 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD  3
288 #define PCRE_CONFIG_MATCH_LIMIT             4
289 #define PCRE_CONFIG_STACKRECURSE            5
290 #define PCRE_CONFIG_UNICODE_PROPERTIES      6
291 #define PCRE_CONFIG_MATCH_LIMIT_RECURSION   7
292 #define PCRE_CONFIG_BSR                     8
293 #define PCRE_CONFIG_JIT                     9
294 #define PCRE_CONFIG_UTF16                  10
295 #define PCRE_CONFIG_JITTARGET              11
296 #define PCRE_CONFIG_UTF32                  12
297
298 /* Request types for pcre_study(). Do not re-arrange, in order to remain
299 compatible. */
300
301 #define PCRE_STUDY_JIT_COMPILE                0x0001
302 #define PCRE_STUDY_JIT_PARTIAL_SOFT_COMPILE   0x0002
303 #define PCRE_STUDY_JIT_PARTIAL_HARD_COMPILE   0x0004
304 #define PCRE_STUDY_EXTRA_NEEDED               0x0008
305
306 /* Bit flags for the pcre[16|32]_extra structure. Do not re-arrange or redefine
307 these bits, just add new ones on the end, in order to remain compatible. */
308
309 #define PCRE_EXTRA_STUDY_DATA             0x0001
310 #define PCRE_EXTRA_MATCH_LIMIT            0x0002
311 #define PCRE_EXTRA_CALLOUT_DATA           0x0004
312 #define PCRE_EXTRA_TABLES                 0x0008
313 #define PCRE_EXTRA_MATCH_LIMIT_RECURSION  0x0010
314 #define PCRE_EXTRA_MARK                   0x0020
315 #define PCRE_EXTRA_EXECUTABLE_JIT         0x0040
316
317 /* Types */
318
319 struct real_pcre;                 /* declaration; the definition is private  */
320 typedef struct real_pcre pcre;
321
322 struct real_pcre16;               /* declaration; the definition is private  */
323 typedef struct real_pcre16 pcre16;
324
325 struct real_pcre32;               /* declaration; the definition is private  */
326 typedef struct real_pcre32 pcre32;
327
328 struct real_pcre_jit_stack;       /* declaration; the definition is private  */
329 typedef struct real_pcre_jit_stack pcre_jit_stack;
330
331 struct real_pcre16_jit_stack;     /* declaration; the definition is private  */
332 typedef struct real_pcre16_jit_stack pcre16_jit_stack;
333
334 struct real_pcre32_jit_stack;     /* declaration; the definition is private  */
335 typedef struct real_pcre32_jit_stack pcre32_jit_stack;
336
337 /* If PCRE is compiled with 16 bit character support, PCRE_UCHAR16 must contain
338 a 16 bit wide signed data type. Otherwise it can be a dummy data type since
339 pcre16 functions are not implemented. There is a check for this in pcre_internal.h. */
340 #ifndef PCRE_UCHAR16
341 #define PCRE_UCHAR16 unsigned short
342 #endif
343
344 #ifndef PCRE_SPTR16
345 #define PCRE_SPTR16 const PCRE_UCHAR16 *
346 #endif
347
348 /* If PCRE is compiled with 32 bit character support, PCRE_UCHAR32 must contain
349 a 32 bit wide signed data type. Otherwise it can be a dummy data type since
350 pcre32 functions are not implemented. There is a check for this in pcre_internal.h. */
351 #ifndef PCRE_UCHAR32
352 #define PCRE_UCHAR32 unsigned int
353 #endif
354
355 #ifndef PCRE_SPTR32
356 #define PCRE_SPTR32 const PCRE_UCHAR32 *
357 #endif
358
359 /* When PCRE is compiled as a C++ library, the subject pointer type can be
360 replaced with a custom type. For conventional use, the public interface is a
361 const char *. */
362
363 #ifndef PCRE_SPTR
364 #define PCRE_SPTR const char *
365 #endif
366
367 /* The structure for passing additional data to pcre_exec(). This is defined in
368 such as way as to be extensible. Always add new fields at the end, in order to
369 remain compatible. */
370
371 typedef struct pcre_extra {
372   unsigned long int flags;        /* Bits for which fields are set */
373   void *study_data;               /* Opaque data from pcre_study() */
374   unsigned long int match_limit;  /* Maximum number of calls to match() */
375   void *callout_data;             /* Data passed back in callouts */
376   const unsigned char *tables;    /* Pointer to character tables */
377   unsigned long int match_limit_recursion; /* Max recursive calls to match() */
378   unsigned char **mark;           /* For passing back a mark pointer */
379   void *executable_jit;           /* Contains a pointer to a compiled jit code */
380 } pcre_extra;
381
382 /* Same structure as above, but with 16 bit char pointers. */
383
384 typedef struct pcre16_extra {
385   unsigned long int flags;        /* Bits for which fields are set */
386   void *study_data;               /* Opaque data from pcre_study() */
387   unsigned long int match_limit;  /* Maximum number of calls to match() */
388   void *callout_data;             /* Data passed back in callouts */
389   const unsigned char *tables;    /* Pointer to character tables */
390   unsigned long int match_limit_recursion; /* Max recursive calls to match() */
391   PCRE_UCHAR16 **mark;            /* For passing back a mark pointer */
392   void *executable_jit;           /* Contains a pointer to a compiled jit code */
393 } pcre16_extra;
394
395 /* Same structure as above, but with 32 bit char pointers. */
396
397 typedef struct pcre32_extra {
398   unsigned long int flags;        /* Bits for which fields are set */
399   void *study_data;               /* Opaque data from pcre_study() */
400   unsigned long int match_limit;  /* Maximum number of calls to match() */
401   void *callout_data;             /* Data passed back in callouts */
402   const unsigned char *tables;    /* Pointer to character tables */
403   unsigned long int match_limit_recursion; /* Max recursive calls to match() */
404   PCRE_UCHAR32 **mark;            /* For passing back a mark pointer */
405   void *executable_jit;           /* Contains a pointer to a compiled jit code */
406 } pcre32_extra;
407
408 /* The structure for passing out data via the pcre_callout_function. We use a
409 structure so that new fields can be added on the end in future versions,
410 without changing the API of the function, thereby allowing old clients to work
411 without modification. */
412
413 typedef struct pcre_callout_block {
414   int          version;           /* Identifies version of block */
415   /* ------------------------ Version 0 ------------------------------- */
416   int          callout_number;    /* Number compiled into pattern */
417   int         *offset_vector;     /* The offset vector */
418   PCRE_SPTR    subject;           /* The subject being matched */
419   int          subject_length;    /* The length of the subject */
420   int          start_match;       /* Offset to start of this match attempt */
421   int          current_position;  /* Where we currently are in the subject */
422   int          capture_top;       /* Max current capture */
423   int          capture_last;      /* Most recently closed capture */
424   void        *callout_data;      /* Data passed in with the call */
425   /* ------------------- Added for Version 1 -------------------------- */
426   int          pattern_position;  /* Offset to next item in the pattern */
427   int          next_item_length;  /* Length of next item in the pattern */
428   /* ------------------- Added for Version 2 -------------------------- */
429   const unsigned char *mark;      /* Pointer to current mark or NULL    */
430   /* ------------------------------------------------------------------ */
431 } pcre_callout_block;
432
433 /* Same structure as above, but with 16 bit char pointers. */
434
435 typedef struct pcre16_callout_block {
436   int          version;           /* Identifies version of block */
437   /* ------------------------ Version 0 ------------------------------- */
438   int          callout_number;    /* Number compiled into pattern */
439   int         *offset_vector;     /* The offset vector */
440   PCRE_SPTR16  subject;           /* The subject being matched */
441   int          subject_length;    /* The length of the subject */
442   int          start_match;       /* Offset to start of this match attempt */
443   int          current_position;  /* Where we currently are in the subject */
444   int          capture_top;       /* Max current capture */
445   int          capture_last;      /* Most recently closed capture */
446   void        *callout_data;      /* Data passed in with the call */
447   /* ------------------- Added for Version 1 -------------------------- */
448   int          pattern_position;  /* Offset to next item in the pattern */
449   int          next_item_length;  /* Length of next item in the pattern */
450   /* ------------------- Added for Version 2 -------------------------- */
451   const PCRE_UCHAR16 *mark;       /* Pointer to current mark or NULL    */
452   /* ------------------------------------------------------------------ */
453 } pcre16_callout_block;
454
455 /* Same structure as above, but with 32 bit char pointers. */
456
457 typedef struct pcre32_callout_block {
458   int          version;           /* Identifies version of block */
459   /* ------------------------ Version 0 ------------------------------- */
460   int          callout_number;    /* Number compiled into pattern */
461   int         *offset_vector;     /* The offset vector */
462   PCRE_SPTR32  subject;           /* The subject being matched */
463   int          subject_length;    /* The length of the subject */
464   int          start_match;       /* Offset to start of this match attempt */
465   int          current_position;  /* Where we currently are in the subject */
466   int          capture_top;       /* Max current capture */
467   int          capture_last;      /* Most recently closed capture */
468   void        *callout_data;      /* Data passed in with the call */
469   /* ------------------- Added for Version 1 -------------------------- */
470   int          pattern_position;  /* Offset to next item in the pattern */
471   int          next_item_length;  /* Length of next item in the pattern */
472   /* ------------------- Added for Version 2 -------------------------- */
473   const PCRE_UCHAR32 *mark;       /* Pointer to current mark or NULL    */
474   /* ------------------------------------------------------------------ */
475 } pcre32_callout_block;
476
477 /* Indirection for store get and free functions. These can be set to
478 alternative malloc/free functions if required. Special ones are used in the
479 non-recursive case for "frames". There is also an optional callout function
480 that is triggered by the (?) regex item. For Virtual Pascal, these definitions
481 have to take another form. */
482
483 #ifndef VPCOMPAT
484 PCRE_EXP_DECL void *(*pcre_malloc)(size_t);
485 PCRE_EXP_DECL void  (*pcre_free)(void *);
486 PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t);
487 PCRE_EXP_DECL void  (*pcre_stack_free)(void *);
488 PCRE_EXP_DECL int   (*pcre_callout)(pcre_callout_block *);
489
490 PCRE_EXP_DECL void *(*pcre16_malloc)(size_t);
491 PCRE_EXP_DECL void  (*pcre16_free)(void *);
492 PCRE_EXP_DECL void *(*pcre16_stack_malloc)(size_t);
493 PCRE_EXP_DECL void  (*pcre16_stack_free)(void *);
494 PCRE_EXP_DECL int   (*pcre16_callout)(pcre16_callout_block *);
495
496 PCRE_EXP_DECL void *(*pcre32_malloc)(size_t);
497 PCRE_EXP_DECL void  (*pcre32_free)(void *);
498 PCRE_EXP_DECL void *(*pcre32_stack_malloc)(size_t);
499 PCRE_EXP_DECL void  (*pcre32_stack_free)(void *);
500 PCRE_EXP_DECL int   (*pcre32_callout)(pcre32_callout_block *);
501 #else   /* VPCOMPAT */
502 PCRE_EXP_DECL void *pcre_malloc(size_t);
503 PCRE_EXP_DECL void  pcre_free(void *);
504 PCRE_EXP_DECL void *pcre_stack_malloc(size_t);
505 PCRE_EXP_DECL void  pcre_stack_free(void *);
506 PCRE_EXP_DECL int   pcre_callout(pcre_callout_block *);
507
508 PCRE_EXP_DECL void *pcre16_malloc(size_t);
509 PCRE_EXP_DECL void  pcre16_free(void *);
510 PCRE_EXP_DECL void *pcre16_stack_malloc(size_t);
511 PCRE_EXP_DECL void  pcre16_stack_free(void *);
512 PCRE_EXP_DECL int   pcre16_callout(pcre16_callout_block *);
513
514 PCRE_EXP_DECL void *pcre32_malloc(size_t);
515 PCRE_EXP_DECL void  pcre32_free(void *);
516 PCRE_EXP_DECL void *pcre32_stack_malloc(size_t);
517 PCRE_EXP_DECL void  pcre32_stack_free(void *);
518 PCRE_EXP_DECL int   pcre32_callout(pcre32_callout_block *);
519 #endif  /* VPCOMPAT */
520
521 /* User defined callback which provides a stack just before the match starts. */
522
523 typedef pcre_jit_stack *(*pcre_jit_callback)(void *);
524 typedef pcre16_jit_stack *(*pcre16_jit_callback)(void *);
525 typedef pcre32_jit_stack *(*pcre32_jit_callback)(void *);
526
527 /* Exported PCRE functions */
528
529 PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *,
530                   const unsigned char *);
531 PCRE_EXP_DECL pcre16 *pcre16_compile(PCRE_SPTR16, int, const char **, int *,
532                   const unsigned char *);
533 PCRE_EXP_DECL pcre32 *pcre32_compile(PCRE_SPTR32, int, const char **, int *,
534                   const unsigned char *);
535 PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **,
536                   int *, const unsigned char *);
537 PCRE_EXP_DECL pcre16 *pcre16_compile2(PCRE_SPTR16, int, int *, const char **,
538                   int *, const unsigned char *);
539 PCRE_EXP_DECL pcre32 *pcre32_compile2(PCRE_SPTR32, int, int *, const char **,
540                   int *, const unsigned char *);
541 PCRE_EXP_DECL int  pcre_config(int, void *);
542 PCRE_EXP_DECL int  pcre16_config(int, void *);
543 PCRE_EXP_DECL int  pcre32_config(int, void *);
544 PCRE_EXP_DECL int  pcre_copy_named_substring(const pcre *, const char *,
545                   int *, int, const char *, char *, int);
546 PCRE_EXP_DECL int  pcre16_copy_named_substring(const pcre16 *, PCRE_SPTR16,
547                   int *, int, PCRE_SPTR16, PCRE_UCHAR16 *, int);
548 PCRE_EXP_DECL int  pcre32_copy_named_substring(const pcre32 *, PCRE_SPTR32,
549                   int *, int, PCRE_SPTR32, PCRE_UCHAR32 *, int);
550 PCRE_EXP_DECL int  pcre_copy_substring(const char *, int *, int, int,
551                   char *, int);
552 PCRE_EXP_DECL int  pcre16_copy_substring(PCRE_SPTR16, int *, int, int,
553                   PCRE_UCHAR16 *, int);
554 PCRE_EXP_DECL int  pcre32_copy_substring(PCRE_SPTR32, int *, int, int,
555                   PCRE_UCHAR32 *, int);
556 PCRE_EXP_DECL int  pcre_dfa_exec(const pcre *, const pcre_extra *,
557                   const char *, int, int, int, int *, int , int *, int);
558 PCRE_EXP_DECL int  pcre16_dfa_exec(const pcre16 *, const pcre16_extra *,
559                   PCRE_SPTR16, int, int, int, int *, int , int *, int);
560 PCRE_EXP_DECL int  pcre32_dfa_exec(const pcre32 *, const pcre32_extra *,
561                   PCRE_SPTR32, int, int, int, int *, int , int *, int);
562 PCRE_EXP_DECL int  pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
563                    int, int, int, int *, int);
564 PCRE_EXP_DECL int  pcre16_exec(const pcre16 *, const pcre16_extra *,
565                    PCRE_SPTR16, int, int, int, int *, int);
566 PCRE_EXP_DECL int  pcre32_exec(const pcre32 *, const pcre32_extra *,
567                    PCRE_SPTR32, int, int, int, int *, int);
568 PCRE_EXP_DECL int  pcre_jit_exec(const pcre *, const pcre_extra *,
569                    PCRE_SPTR, int, int, int, int *, int,
570                    pcre_jit_stack *);
571 PCRE_EXP_DECL int  pcre16_jit_exec(const pcre16 *, const pcre16_extra *,
572                    PCRE_SPTR16, int, int, int, int *, int,
573                    pcre16_jit_stack *);
574 PCRE_EXP_DECL int  pcre32_jit_exec(const pcre32 *, const pcre32_extra *,
575                    PCRE_SPTR32, int, int, int, int *, int,
576                    pcre32_jit_stack *);
577 PCRE_EXP_DECL void pcre_free_substring(const char *);
578 PCRE_EXP_DECL void pcre16_free_substring(PCRE_SPTR16);
579 PCRE_EXP_DECL void pcre32_free_substring(PCRE_SPTR32);
580 PCRE_EXP_DECL void pcre_free_substring_list(const char **);
581 PCRE_EXP_DECL void pcre16_free_substring_list(PCRE_SPTR16 *);
582 PCRE_EXP_DECL void pcre32_free_substring_list(PCRE_SPTR32 *);
583 PCRE_EXP_DECL int  pcre_fullinfo(const pcre *, const pcre_extra *, int,
584                   void *);
585 PCRE_EXP_DECL int  pcre16_fullinfo(const pcre16 *, const pcre16_extra *, int,
586                   void *);
587 PCRE_EXP_DECL int  pcre32_fullinfo(const pcre32 *, const pcre32_extra *, int,
588                   void *);
589 PCRE_EXP_DECL int  pcre_get_named_substring(const pcre *, const char *,
590                   int *, int, const char *, const char **);
591 PCRE_EXP_DECL int  pcre16_get_named_substring(const pcre16 *, PCRE_SPTR16,
592                   int *, int, PCRE_SPTR16, PCRE_SPTR16 *);
593 PCRE_EXP_DECL int  pcre32_get_named_substring(const pcre32 *, PCRE_SPTR32,
594                   int *, int, PCRE_SPTR32, PCRE_SPTR32 *);
595 PCRE_EXP_DECL int  pcre_get_stringnumber(const pcre *, const char *);
596 PCRE_EXP_DECL int  pcre16_get_stringnumber(const pcre16 *, PCRE_SPTR16);
597 PCRE_EXP_DECL int  pcre32_get_stringnumber(const pcre32 *, PCRE_SPTR32);
598 PCRE_EXP_DECL int  pcre_get_stringtable_entries(const pcre *, const char *,
599                   char **, char **);
600 PCRE_EXP_DECL int  pcre16_get_stringtable_entries(const pcre16 *, PCRE_SPTR16,
601                   PCRE_UCHAR16 **, PCRE_UCHAR16 **);
602 PCRE_EXP_DECL int  pcre32_get_stringtable_entries(const pcre32 *, PCRE_SPTR32,
603                   PCRE_UCHAR32 **, PCRE_UCHAR32 **);
604 PCRE_EXP_DECL int  pcre_get_substring(const char *, int *, int, int,
605                   const char **);
606 PCRE_EXP_DECL int  pcre16_get_substring(PCRE_SPTR16, int *, int, int,
607                   PCRE_SPTR16 *);
608 PCRE_EXP_DECL int  pcre32_get_substring(PCRE_SPTR32, int *, int, int,
609                   PCRE_SPTR32 *);
610 PCRE_EXP_DECL int  pcre_get_substring_list(const char *, int *, int,
611                   const char ***);
612 PCRE_EXP_DECL int  pcre16_get_substring_list(PCRE_SPTR16, int *, int,
613                   PCRE_SPTR16 **);
614 PCRE_EXP_DECL int  pcre32_get_substring_list(PCRE_SPTR32, int *, int,
615                   PCRE_SPTR32 **);
616 PCRE_EXP_DECL const unsigned char *pcre_maketables(void);
617 PCRE_EXP_DECL const unsigned char *pcre16_maketables(void);
618 PCRE_EXP_DECL const unsigned char *pcre32_maketables(void);
619 PCRE_EXP_DECL int  pcre_refcount(pcre *, int);
620 PCRE_EXP_DECL int  pcre16_refcount(pcre16 *, int);
621 PCRE_EXP_DECL int  pcre32_refcount(pcre32 *, int);
622 PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **);
623 PCRE_EXP_DECL pcre16_extra *pcre16_study(const pcre16 *, int, const char **);
624 PCRE_EXP_DECL pcre32_extra *pcre32_study(const pcre32 *, int, const char **);
625 PCRE_EXP_DECL void pcre_free_study(pcre_extra *);
626 PCRE_EXP_DECL void pcre16_free_study(pcre16_extra *);
627 PCRE_EXP_DECL void pcre32_free_study(pcre32_extra *);
628 PCRE_EXP_DECL const char *pcre_version(void);
629 PCRE_EXP_DECL const char *pcre16_version(void);
630 PCRE_EXP_DECL const char *pcre32_version(void);
631
632 /* Utility functions for byte order swaps. */
633 PCRE_EXP_DECL int  pcre_pattern_to_host_byte_order(pcre *, pcre_extra *,
634                   const unsigned char *);
635 PCRE_EXP_DECL int  pcre16_pattern_to_host_byte_order(pcre16 *, pcre16_extra *,
636                   const unsigned char *);
637 PCRE_EXP_DECL int  pcre32_pattern_to_host_byte_order(pcre32 *, pcre32_extra *,
638                   const unsigned char *);
639 PCRE_EXP_DECL int  pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *,
640                   PCRE_SPTR16, int, int *, int);
641 PCRE_EXP_DECL int  pcre32_utf32_to_host_byte_order(PCRE_UCHAR32 *,
642                   PCRE_SPTR32, int, int *, int);
643
644 /* JIT compiler related functions. */
645
646 PCRE_EXP_DECL pcre_jit_stack *pcre_jit_stack_alloc(int, int);
647 PCRE_EXP_DECL pcre16_jit_stack *pcre16_jit_stack_alloc(int, int);
648 PCRE_EXP_DECL pcre32_jit_stack *pcre32_jit_stack_alloc(int, int);
649 PCRE_EXP_DECL void pcre_jit_stack_free(pcre_jit_stack *);
650 PCRE_EXP_DECL void pcre16_jit_stack_free(pcre16_jit_stack *);
651 PCRE_EXP_DECL void pcre32_jit_stack_free(pcre32_jit_stack *);
652 PCRE_EXP_DECL void pcre_assign_jit_stack(pcre_extra *,
653                   pcre_jit_callback, void *);
654 PCRE_EXP_DECL void pcre16_assign_jit_stack(pcre16_extra *,
655                   pcre16_jit_callback, void *);
656 PCRE_EXP_DECL void pcre32_assign_jit_stack(pcre32_extra *,
657                   pcre32_jit_callback, void *);
658
659 #ifdef __cplusplus
660 }  /* extern "C" */
661 #endif
662
663 #endif /* End of pcre.h */