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