xref: /PHP-8.0/ext/pcre/pcre2lib/pcre2.h (revision 9f2d0395)
1 /*************************************************
2 *       Perl-Compatible Regular Expressions      *
3 *************************************************/
4 
5 /* This is the public header file for the PCRE library, second API, to be
6 #included by applications that call PCRE2 functions.
7 
8            Copyright (c) 2016-2020 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 PCRE2_H_IDEMPOTENT_GUARD
40 #define PCRE2_H_IDEMPOTENT_GUARD
41 
42 /* The current PCRE version information. */
43 
44 #define PCRE2_MAJOR           10
45 #define PCRE2_MINOR           35
46 #define PCRE2_PRERELEASE
47 #define PCRE2_DATE            2020-05-09
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 PCRE2, the appropriate
51 export setting is defined in pcre2_internal.h, which includes this file. So we
52 don't change existing definitions of PCRE2_EXP_DECL. */
53 
54 #if defined(_WIN32) && !defined(PCRE2_STATIC)
55 #  ifndef PCRE2_EXP_DECL
56 #    define PCRE2_EXP_DECL  extern __declspec(dllimport)
57 #  endif
58 #endif
59 
60 /* By default, we use the standard "extern" declarations. */
61 
62 #ifndef PCRE2_EXP_DECL
63 #  ifdef __cplusplus
64 #    define PCRE2_EXP_DECL  extern "C"
65 #  else
66 #    define PCRE2_EXP_DECL  extern
67 #  endif
68 #endif
69 
70 /* When compiling with the MSVC compiler, it is sometimes necessary to include
71 a "calling convention" before exported function names. (This is secondhand
72 information; I know nothing about MSVC myself). For example, something like
73 
74   void __cdecl function(....)
75 
76 might be needed. In order so make this easy, all the exported functions have
77 PCRE2_CALL_CONVENTION just before their names. It is rarely needed; if not
78 set, we ensure here that it has no effect. */
79 
80 #ifndef PCRE2_CALL_CONVENTION
81 #define PCRE2_CALL_CONVENTION
82 #endif
83 
84 /* Have to include limits.h, stdlib.h, and inttypes.h to ensure that size_t and
85 uint8_t, UCHAR_MAX, etc are defined. Some systems that do have inttypes.h do
86 not have stdint.h, which is why we use inttypes.h, which according to the C
87 standard is a superset of stdint.h. If none of these headers are available,
88 the relevant values must be provided by some other means. */
89 
90 #include <limits.h>
91 #include <stdlib.h>
92 #include <inttypes.h>
93 
94 /* Allow for C++ users compiling this directly. */
95 
96 #ifdef __cplusplus
97 extern "C" {
98 #endif
99 
100 /* The following option bits can be passed to pcre2_compile(), pcre2_match(),
101 or pcre2_dfa_match(). PCRE2_NO_UTF_CHECK affects only the function to which it
102 is passed. Put these bits at the most significant end of the options word so
103 others can be added next to them */
104 
105 #define PCRE2_ANCHORED            0x80000000u
106 #define PCRE2_NO_UTF_CHECK        0x40000000u
107 #define PCRE2_ENDANCHORED         0x20000000u
108 
109 /* The following option bits can be passed only to pcre2_compile(). However,
110 they may affect compilation, JIT compilation, and/or interpretive execution.
111 The following tags indicate which:
112 
113 C   alters what is compiled by pcre2_compile()
114 J   alters what is compiled by pcre2_jit_compile()
115 M   is inspected during pcre2_match() execution
116 D   is inspected during pcre2_dfa_match() execution
117 */
118 
119 #define PCRE2_ALLOW_EMPTY_CLASS   0x00000001u  /* C       */
120 #define PCRE2_ALT_BSUX            0x00000002u  /* C       */
121 #define PCRE2_AUTO_CALLOUT        0x00000004u  /* C       */
122 #define PCRE2_CASELESS            0x00000008u  /* C       */
123 #define PCRE2_DOLLAR_ENDONLY      0x00000010u  /*   J M D */
124 #define PCRE2_DOTALL              0x00000020u  /* C       */
125 #define PCRE2_DUPNAMES            0x00000040u  /* C       */
126 #define PCRE2_EXTENDED            0x00000080u  /* C       */
127 #define PCRE2_FIRSTLINE           0x00000100u  /*   J M D */
128 #define PCRE2_MATCH_UNSET_BACKREF 0x00000200u  /* C J M   */
129 #define PCRE2_MULTILINE           0x00000400u  /* C       */
130 #define PCRE2_NEVER_UCP           0x00000800u  /* C       */
131 #define PCRE2_NEVER_UTF           0x00001000u  /* C       */
132 #define PCRE2_NO_AUTO_CAPTURE     0x00002000u  /* C       */
133 #define PCRE2_NO_AUTO_POSSESS     0x00004000u  /* C       */
134 #define PCRE2_NO_DOTSTAR_ANCHOR   0x00008000u  /* C       */
135 #define PCRE2_NO_START_OPTIMIZE   0x00010000u  /*   J M D */
136 #define PCRE2_UCP                 0x00020000u  /* C J M D */
137 #define PCRE2_UNGREEDY            0x00040000u  /* C       */
138 #define PCRE2_UTF                 0x00080000u  /* C J M D */
139 #define PCRE2_NEVER_BACKSLASH_C   0x00100000u  /* C       */
140 #define PCRE2_ALT_CIRCUMFLEX      0x00200000u  /*   J M D */
141 #define PCRE2_ALT_VERBNAMES       0x00400000u  /* C       */
142 #define PCRE2_USE_OFFSET_LIMIT    0x00800000u  /*   J M D */
143 #define PCRE2_EXTENDED_MORE       0x01000000u  /* C       */
144 #define PCRE2_LITERAL             0x02000000u  /* C       */
145 #define PCRE2_MATCH_INVALID_UTF   0x04000000u  /*   J M D */
146 
147 /* An additional compile options word is available in the compile context. */
148 
149 #define PCRE2_EXTRA_ALLOW_SURROGATE_ESCAPES  0x00000001u  /* C */
150 #define PCRE2_EXTRA_BAD_ESCAPE_IS_LITERAL    0x00000002u  /* C */
151 #define PCRE2_EXTRA_MATCH_WORD               0x00000004u  /* C */
152 #define PCRE2_EXTRA_MATCH_LINE               0x00000008u  /* C */
153 #define PCRE2_EXTRA_ESCAPED_CR_IS_LF         0x00000010u  /* C */
154 #define PCRE2_EXTRA_ALT_BSUX                 0x00000020u  /* C */
155 
156 /* These are for pcre2_jit_compile(). */
157 
158 #define PCRE2_JIT_COMPLETE        0x00000001u  /* For full matching */
159 #define PCRE2_JIT_PARTIAL_SOFT    0x00000002u
160 #define PCRE2_JIT_PARTIAL_HARD    0x00000004u
161 #define PCRE2_JIT_INVALID_UTF     0x00000100u
162 
163 /* These are for pcre2_match(), pcre2_dfa_match(), pcre2_jit_match(), and
164 pcre2_substitute(). Some are allowed only for one of the functions, and in
165 these cases it is noted below. Note that PCRE2_ANCHORED, PCRE2_ENDANCHORED and
166 PCRE2_NO_UTF_CHECK can also be passed to these functions (though
167 pcre2_jit_match() ignores the latter since it bypasses all sanity checks). */
168 
169 #define PCRE2_NOTBOL                      0x00000001u
170 #define PCRE2_NOTEOL                      0x00000002u
171 #define PCRE2_NOTEMPTY                    0x00000004u  /* ) These two must be kept */
172 #define PCRE2_NOTEMPTY_ATSTART            0x00000008u  /* ) adjacent to each other. */
173 #define PCRE2_PARTIAL_SOFT                0x00000010u
174 #define PCRE2_PARTIAL_HARD                0x00000020u
175 #define PCRE2_DFA_RESTART                 0x00000040u  /* pcre2_dfa_match() only */
176 #define PCRE2_DFA_SHORTEST                0x00000080u  /* pcre2_dfa_match() only */
177 #define PCRE2_SUBSTITUTE_GLOBAL           0x00000100u  /* pcre2_substitute() only */
178 #define PCRE2_SUBSTITUTE_EXTENDED         0x00000200u  /* pcre2_substitute() only */
179 #define PCRE2_SUBSTITUTE_UNSET_EMPTY      0x00000400u  /* pcre2_substitute() only */
180 #define PCRE2_SUBSTITUTE_UNKNOWN_UNSET    0x00000800u  /* pcre2_substitute() only */
181 #define PCRE2_SUBSTITUTE_OVERFLOW_LENGTH  0x00001000u  /* pcre2_substitute() only */
182 #define PCRE2_NO_JIT                      0x00002000u  /* Not for pcre2_dfa_match() */
183 #define PCRE2_COPY_MATCHED_SUBJECT        0x00004000u
184 #define PCRE2_SUBSTITUTE_LITERAL          0x00008000u  /* pcre2_substitute() only */
185 #define PCRE2_SUBSTITUTE_MATCHED          0x00010000u  /* pcre2_substitute() only */
186 #define PCRE2_SUBSTITUTE_REPLACEMENT_ONLY 0x00020000u  /* pcre2_substitute() only */
187 
188 /* Options for pcre2_pattern_convert(). */
189 
190 #define PCRE2_CONVERT_UTF                    0x00000001u
191 #define PCRE2_CONVERT_NO_UTF_CHECK           0x00000002u
192 #define PCRE2_CONVERT_POSIX_BASIC            0x00000004u
193 #define PCRE2_CONVERT_POSIX_EXTENDED         0x00000008u
194 #define PCRE2_CONVERT_GLOB                   0x00000010u
195 #define PCRE2_CONVERT_GLOB_NO_WILD_SEPARATOR 0x00000030u
196 #define PCRE2_CONVERT_GLOB_NO_STARSTAR       0x00000050u
197 
198 /* Newline and \R settings, for use in compile contexts. The newline values
199 must be kept in step with values set in config.h and both sets must all be
200 greater than zero. */
201 
202 #define PCRE2_NEWLINE_CR          1
203 #define PCRE2_NEWLINE_LF          2
204 #define PCRE2_NEWLINE_CRLF        3
205 #define PCRE2_NEWLINE_ANY         4
206 #define PCRE2_NEWLINE_ANYCRLF     5
207 #define PCRE2_NEWLINE_NUL         6
208 
209 #define PCRE2_BSR_UNICODE         1
210 #define PCRE2_BSR_ANYCRLF         2
211 
212 /* Error codes for pcre2_compile(). Some of these are also used by
213 pcre2_pattern_convert(). */
214 
215 #define PCRE2_ERROR_END_BACKSLASH                  101
216 #define PCRE2_ERROR_END_BACKSLASH_C                102
217 #define PCRE2_ERROR_UNKNOWN_ESCAPE                 103
218 #define PCRE2_ERROR_QUANTIFIER_OUT_OF_ORDER        104
219 #define PCRE2_ERROR_QUANTIFIER_TOO_BIG             105
220 #define PCRE2_ERROR_MISSING_SQUARE_BRACKET         106
221 #define PCRE2_ERROR_ESCAPE_INVALID_IN_CLASS        107
222 #define PCRE2_ERROR_CLASS_RANGE_ORDER              108
223 #define PCRE2_ERROR_QUANTIFIER_INVALID             109
224 #define PCRE2_ERROR_INTERNAL_UNEXPECTED_REPEAT     110
225 #define PCRE2_ERROR_INVALID_AFTER_PARENS_QUERY     111
226 #define PCRE2_ERROR_POSIX_CLASS_NOT_IN_CLASS       112
227 #define PCRE2_ERROR_POSIX_NO_SUPPORT_COLLATING     113
228 #define PCRE2_ERROR_MISSING_CLOSING_PARENTHESIS    114
229 #define PCRE2_ERROR_BAD_SUBPATTERN_REFERENCE       115
230 #define PCRE2_ERROR_NULL_PATTERN                   116
231 #define PCRE2_ERROR_BAD_OPTIONS                    117
232 #define PCRE2_ERROR_MISSING_COMMENT_CLOSING        118
233 #define PCRE2_ERROR_PARENTHESES_NEST_TOO_DEEP      119
234 #define PCRE2_ERROR_PATTERN_TOO_LARGE              120
235 #define PCRE2_ERROR_HEAP_FAILED                    121
236 #define PCRE2_ERROR_UNMATCHED_CLOSING_PARENTHESIS  122
237 #define PCRE2_ERROR_INTERNAL_CODE_OVERFLOW         123
238 #define PCRE2_ERROR_MISSING_CONDITION_CLOSING      124
239 #define PCRE2_ERROR_LOOKBEHIND_NOT_FIXED_LENGTH    125
240 #define PCRE2_ERROR_ZERO_RELATIVE_REFERENCE        126
241 #define PCRE2_ERROR_TOO_MANY_CONDITION_BRANCHES    127
242 #define PCRE2_ERROR_CONDITION_ASSERTION_EXPECTED   128
243 #define PCRE2_ERROR_BAD_RELATIVE_REFERENCE         129
244 #define PCRE2_ERROR_UNKNOWN_POSIX_CLASS            130
245 #define PCRE2_ERROR_INTERNAL_STUDY_ERROR           131
246 #define PCRE2_ERROR_UNICODE_NOT_SUPPORTED          132
247 #define PCRE2_ERROR_PARENTHESES_STACK_CHECK        133
248 #define PCRE2_ERROR_CODE_POINT_TOO_BIG             134
249 #define PCRE2_ERROR_LOOKBEHIND_TOO_COMPLICATED     135
250 #define PCRE2_ERROR_LOOKBEHIND_INVALID_BACKSLASH_C 136
251 #define PCRE2_ERROR_UNSUPPORTED_ESCAPE_SEQUENCE    137
252 #define PCRE2_ERROR_CALLOUT_NUMBER_TOO_BIG         138
253 #define PCRE2_ERROR_MISSING_CALLOUT_CLOSING        139
254 #define PCRE2_ERROR_ESCAPE_INVALID_IN_VERB         140
255 #define PCRE2_ERROR_UNRECOGNIZED_AFTER_QUERY_P     141
256 #define PCRE2_ERROR_MISSING_NAME_TERMINATOR        142
257 #define PCRE2_ERROR_DUPLICATE_SUBPATTERN_NAME      143
258 #define PCRE2_ERROR_INVALID_SUBPATTERN_NAME        144
259 #define PCRE2_ERROR_UNICODE_PROPERTIES_UNAVAILABLE 145
260 #define PCRE2_ERROR_MALFORMED_UNICODE_PROPERTY     146
261 #define PCRE2_ERROR_UNKNOWN_UNICODE_PROPERTY       147
262 #define PCRE2_ERROR_SUBPATTERN_NAME_TOO_LONG       148
263 #define PCRE2_ERROR_TOO_MANY_NAMED_SUBPATTERNS     149
264 #define PCRE2_ERROR_CLASS_INVALID_RANGE            150
265 #define PCRE2_ERROR_OCTAL_BYTE_TOO_BIG             151
266 #define PCRE2_ERROR_INTERNAL_OVERRAN_WORKSPACE     152
267 #define PCRE2_ERROR_INTERNAL_MISSING_SUBPATTERN    153
268 #define PCRE2_ERROR_DEFINE_TOO_MANY_BRANCHES       154
269 #define PCRE2_ERROR_BACKSLASH_O_MISSING_BRACE      155
270 #define PCRE2_ERROR_INTERNAL_UNKNOWN_NEWLINE       156
271 #define PCRE2_ERROR_BACKSLASH_G_SYNTAX             157
272 #define PCRE2_ERROR_PARENS_QUERY_R_MISSING_CLOSING 158
273 /* Error 159 is obsolete and should now never occur */
274 #define PCRE2_ERROR_VERB_ARGUMENT_NOT_ALLOWED      159
275 #define PCRE2_ERROR_VERB_UNKNOWN                   160
276 #define PCRE2_ERROR_SUBPATTERN_NUMBER_TOO_BIG      161
277 #define PCRE2_ERROR_SUBPATTERN_NAME_EXPECTED       162
278 #define PCRE2_ERROR_INTERNAL_PARSED_OVERFLOW       163
279 #define PCRE2_ERROR_INVALID_OCTAL                  164
280 #define PCRE2_ERROR_SUBPATTERN_NAMES_MISMATCH      165
281 #define PCRE2_ERROR_MARK_MISSING_ARGUMENT          166
282 #define PCRE2_ERROR_INVALID_HEXADECIMAL            167
283 #define PCRE2_ERROR_BACKSLASH_C_SYNTAX             168
284 #define PCRE2_ERROR_BACKSLASH_K_SYNTAX             169
285 #define PCRE2_ERROR_INTERNAL_BAD_CODE_LOOKBEHINDS  170
286 #define PCRE2_ERROR_BACKSLASH_N_IN_CLASS           171
287 #define PCRE2_ERROR_CALLOUT_STRING_TOO_LONG        172
288 #define PCRE2_ERROR_UNICODE_DISALLOWED_CODE_POINT  173
289 #define PCRE2_ERROR_UTF_IS_DISABLED                174
290 #define PCRE2_ERROR_UCP_IS_DISABLED                175
291 #define PCRE2_ERROR_VERB_NAME_TOO_LONG             176
292 #define PCRE2_ERROR_BACKSLASH_U_CODE_POINT_TOO_BIG 177
293 #define PCRE2_ERROR_MISSING_OCTAL_OR_HEX_DIGITS    178
294 #define PCRE2_ERROR_VERSION_CONDITION_SYNTAX       179
295 #define PCRE2_ERROR_INTERNAL_BAD_CODE_AUTO_POSSESS 180
296 #define PCRE2_ERROR_CALLOUT_NO_STRING_DELIMITER    181
297 #define PCRE2_ERROR_CALLOUT_BAD_STRING_DELIMITER   182
298 #define PCRE2_ERROR_BACKSLASH_C_CALLER_DISABLED    183
299 #define PCRE2_ERROR_QUERY_BARJX_NEST_TOO_DEEP      184
300 #define PCRE2_ERROR_BACKSLASH_C_LIBRARY_DISABLED   185
301 #define PCRE2_ERROR_PATTERN_TOO_COMPLICATED        186
302 #define PCRE2_ERROR_LOOKBEHIND_TOO_LONG            187
303 #define PCRE2_ERROR_PATTERN_STRING_TOO_LONG        188
304 #define PCRE2_ERROR_INTERNAL_BAD_CODE              189
305 #define PCRE2_ERROR_INTERNAL_BAD_CODE_IN_SKIP      190
306 #define PCRE2_ERROR_NO_SURROGATES_IN_UTF16         191
307 #define PCRE2_ERROR_BAD_LITERAL_OPTIONS            192
308 #define PCRE2_ERROR_SUPPORTED_ONLY_IN_UNICODE      193
309 #define PCRE2_ERROR_INVALID_HYPHEN_IN_OPTIONS      194
310 #define PCRE2_ERROR_ALPHA_ASSERTION_UNKNOWN        195
311 #define PCRE2_ERROR_SCRIPT_RUN_NOT_AVAILABLE       196
312 #define PCRE2_ERROR_TOO_MANY_CAPTURES              197
313 #define PCRE2_ERROR_CONDITION_ATOMIC_ASSERTION_EXPECTED  198
314 
315 
316 /* "Expected" matching error codes: no match and partial match. */
317 
318 #define PCRE2_ERROR_NOMATCH          (-1)
319 #define PCRE2_ERROR_PARTIAL          (-2)
320 
321 /* Error codes for UTF-8 validity checks */
322 
323 #define PCRE2_ERROR_UTF8_ERR1        (-3)
324 #define PCRE2_ERROR_UTF8_ERR2        (-4)
325 #define PCRE2_ERROR_UTF8_ERR3        (-5)
326 #define PCRE2_ERROR_UTF8_ERR4        (-6)
327 #define PCRE2_ERROR_UTF8_ERR5        (-7)
328 #define PCRE2_ERROR_UTF8_ERR6        (-8)
329 #define PCRE2_ERROR_UTF8_ERR7        (-9)
330 #define PCRE2_ERROR_UTF8_ERR8       (-10)
331 #define PCRE2_ERROR_UTF8_ERR9       (-11)
332 #define PCRE2_ERROR_UTF8_ERR10      (-12)
333 #define PCRE2_ERROR_UTF8_ERR11      (-13)
334 #define PCRE2_ERROR_UTF8_ERR12      (-14)
335 #define PCRE2_ERROR_UTF8_ERR13      (-15)
336 #define PCRE2_ERROR_UTF8_ERR14      (-16)
337 #define PCRE2_ERROR_UTF8_ERR15      (-17)
338 #define PCRE2_ERROR_UTF8_ERR16      (-18)
339 #define PCRE2_ERROR_UTF8_ERR17      (-19)
340 #define PCRE2_ERROR_UTF8_ERR18      (-20)
341 #define PCRE2_ERROR_UTF8_ERR19      (-21)
342 #define PCRE2_ERROR_UTF8_ERR20      (-22)
343 #define PCRE2_ERROR_UTF8_ERR21      (-23)
344 
345 /* Error codes for UTF-16 validity checks */
346 
347 #define PCRE2_ERROR_UTF16_ERR1      (-24)
348 #define PCRE2_ERROR_UTF16_ERR2      (-25)
349 #define PCRE2_ERROR_UTF16_ERR3      (-26)
350 
351 /* Error codes for UTF-32 validity checks */
352 
353 #define PCRE2_ERROR_UTF32_ERR1      (-27)
354 #define PCRE2_ERROR_UTF32_ERR2      (-28)
355 
356 /* Miscellaneous error codes for pcre2[_dfa]_match(), substring extraction
357 functions, context functions, and serializing functions. They are in numerical
358 order. Originally they were in alphabetical order too, but now that PCRE2 is
359 released, the numbers must not be changed. */
360 
361 #define PCRE2_ERROR_BADDATA           (-29)
362 #define PCRE2_ERROR_MIXEDTABLES       (-30)  /* Name was changed */
363 #define PCRE2_ERROR_BADMAGIC          (-31)
364 #define PCRE2_ERROR_BADMODE           (-32)
365 #define PCRE2_ERROR_BADOFFSET         (-33)
366 #define PCRE2_ERROR_BADOPTION         (-34)
367 #define PCRE2_ERROR_BADREPLACEMENT    (-35)
368 #define PCRE2_ERROR_BADUTFOFFSET      (-36)
369 #define PCRE2_ERROR_CALLOUT           (-37)  /* Never used by PCRE2 itself */
370 #define PCRE2_ERROR_DFA_BADRESTART    (-38)
371 #define PCRE2_ERROR_DFA_RECURSE       (-39)
372 #define PCRE2_ERROR_DFA_UCOND         (-40)
373 #define PCRE2_ERROR_DFA_UFUNC         (-41)
374 #define PCRE2_ERROR_DFA_UITEM         (-42)
375 #define PCRE2_ERROR_DFA_WSSIZE        (-43)
376 #define PCRE2_ERROR_INTERNAL          (-44)
377 #define PCRE2_ERROR_JIT_BADOPTION     (-45)
378 #define PCRE2_ERROR_JIT_STACKLIMIT    (-46)
379 #define PCRE2_ERROR_MATCHLIMIT        (-47)
380 #define PCRE2_ERROR_NOMEMORY          (-48)
381 #define PCRE2_ERROR_NOSUBSTRING       (-49)
382 #define PCRE2_ERROR_NOUNIQUESUBSTRING (-50)
383 #define PCRE2_ERROR_NULL              (-51)
384 #define PCRE2_ERROR_RECURSELOOP       (-52)
385 #define PCRE2_ERROR_DEPTHLIMIT        (-53)
386 #define PCRE2_ERROR_RECURSIONLIMIT    (-53)  /* Obsolete synonym */
387 #define PCRE2_ERROR_UNAVAILABLE       (-54)
388 #define PCRE2_ERROR_UNSET             (-55)
389 #define PCRE2_ERROR_BADOFFSETLIMIT    (-56)
390 #define PCRE2_ERROR_BADREPESCAPE      (-57)
391 #define PCRE2_ERROR_REPMISSINGBRACE   (-58)
392 #define PCRE2_ERROR_BADSUBSTITUTION   (-59)
393 #define PCRE2_ERROR_BADSUBSPATTERN    (-60)
394 #define PCRE2_ERROR_TOOMANYREPLACE    (-61)
395 #define PCRE2_ERROR_BADSERIALIZEDDATA (-62)
396 #define PCRE2_ERROR_HEAPLIMIT         (-63)
397 #define PCRE2_ERROR_CONVERT_SYNTAX    (-64)
398 #define PCRE2_ERROR_INTERNAL_DUPMATCH (-65)
399 #define PCRE2_ERROR_DFA_UINVALID_UTF  (-66)
400 
401 
402 /* Request types for pcre2_pattern_info() */
403 
404 #define PCRE2_INFO_ALLOPTIONS            0
405 #define PCRE2_INFO_ARGOPTIONS            1
406 #define PCRE2_INFO_BACKREFMAX            2
407 #define PCRE2_INFO_BSR                   3
408 #define PCRE2_INFO_CAPTURECOUNT          4
409 #define PCRE2_INFO_FIRSTCODEUNIT         5
410 #define PCRE2_INFO_FIRSTCODETYPE         6
411 #define PCRE2_INFO_FIRSTBITMAP           7
412 #define PCRE2_INFO_HASCRORLF             8
413 #define PCRE2_INFO_JCHANGED              9
414 #define PCRE2_INFO_JITSIZE              10
415 #define PCRE2_INFO_LASTCODEUNIT         11
416 #define PCRE2_INFO_LASTCODETYPE         12
417 #define PCRE2_INFO_MATCHEMPTY           13
418 #define PCRE2_INFO_MATCHLIMIT           14
419 #define PCRE2_INFO_MAXLOOKBEHIND        15
420 #define PCRE2_INFO_MINLENGTH            16
421 #define PCRE2_INFO_NAMECOUNT            17
422 #define PCRE2_INFO_NAMEENTRYSIZE        18
423 #define PCRE2_INFO_NAMETABLE            19
424 #define PCRE2_INFO_NEWLINE              20
425 #define PCRE2_INFO_DEPTHLIMIT           21
426 #define PCRE2_INFO_RECURSIONLIMIT       21  /* Obsolete synonym */
427 #define PCRE2_INFO_SIZE                 22
428 #define PCRE2_INFO_HASBACKSLASHC        23
429 #define PCRE2_INFO_FRAMESIZE            24
430 #define PCRE2_INFO_HEAPLIMIT            25
431 #define PCRE2_INFO_EXTRAOPTIONS         26
432 
433 /* Request types for pcre2_config(). */
434 
435 #define PCRE2_CONFIG_BSR                     0
436 #define PCRE2_CONFIG_JIT                     1
437 #define PCRE2_CONFIG_JITTARGET               2
438 #define PCRE2_CONFIG_LINKSIZE                3
439 #define PCRE2_CONFIG_MATCHLIMIT              4
440 #define PCRE2_CONFIG_NEWLINE                 5
441 #define PCRE2_CONFIG_PARENSLIMIT             6
442 #define PCRE2_CONFIG_DEPTHLIMIT              7
443 #define PCRE2_CONFIG_RECURSIONLIMIT          7  /* Obsolete synonym */
444 #define PCRE2_CONFIG_STACKRECURSE            8  /* Obsolete */
445 #define PCRE2_CONFIG_UNICODE                 9
446 #define PCRE2_CONFIG_UNICODE_VERSION        10
447 #define PCRE2_CONFIG_VERSION                11
448 #define PCRE2_CONFIG_HEAPLIMIT              12
449 #define PCRE2_CONFIG_NEVER_BACKSLASH_C      13
450 #define PCRE2_CONFIG_COMPILED_WIDTHS        14
451 #define PCRE2_CONFIG_TABLES_LENGTH          15
452 
453 
454 /* Types for code units in patterns and subject strings. */
455 
456 typedef uint8_t  PCRE2_UCHAR8;
457 typedef uint16_t PCRE2_UCHAR16;
458 typedef uint32_t PCRE2_UCHAR32;
459 
460 typedef const PCRE2_UCHAR8  *PCRE2_SPTR8;
461 typedef const PCRE2_UCHAR16 *PCRE2_SPTR16;
462 typedef const PCRE2_UCHAR32 *PCRE2_SPTR32;
463 
464 /* The PCRE2_SIZE type is used for all string lengths and offsets in PCRE2,
465 including pattern offsets for errors and subject offsets after a match. We
466 define special values to indicate zero-terminated strings and unset offsets in
467 the offset vector (ovector). */
468 
469 #define PCRE2_SIZE            size_t
470 #define PCRE2_SIZE_MAX        SIZE_MAX
471 #define PCRE2_ZERO_TERMINATED (~(PCRE2_SIZE)0)
472 #define PCRE2_UNSET           (~(PCRE2_SIZE)0)
473 
474 /* Generic types for opaque structures and JIT callback functions. These
475 declarations are defined in a macro that is expanded for each width later. */
476 
477 #define PCRE2_TYPES_LIST \
478 struct pcre2_real_general_context; \
479 typedef struct pcre2_real_general_context pcre2_general_context; \
480 \
481 struct pcre2_real_compile_context; \
482 typedef struct pcre2_real_compile_context pcre2_compile_context; \
483 \
484 struct pcre2_real_match_context; \
485 typedef struct pcre2_real_match_context pcre2_match_context; \
486 \
487 struct pcre2_real_convert_context; \
488 typedef struct pcre2_real_convert_context pcre2_convert_context; \
489 \
490 struct pcre2_real_code; \
491 typedef struct pcre2_real_code pcre2_code; \
492 \
493 struct pcre2_real_match_data; \
494 typedef struct pcre2_real_match_data pcre2_match_data; \
495 \
496 struct pcre2_real_jit_stack; \
497 typedef struct pcre2_real_jit_stack pcre2_jit_stack; \
498 \
499 typedef pcre2_jit_stack *(*pcre2_jit_callback)(void *);
500 
501 
502 /* The structures for passing out data via callout functions. We use structures
503 so that new fields can be added on the end in future versions, without changing
504 the API of the function, thereby allowing old clients to work without
505 modification. Define the generic versions in a macro; the width-specific
506 versions are generated from this macro below. */
507 
508 /* Flags for the callout_flags field. These are cleared after a callout. */
509 
510 #define PCRE2_CALLOUT_STARTMATCH    0x00000001u  /* Set for each bumpalong */
511 #define PCRE2_CALLOUT_BACKTRACK     0x00000002u  /* Set after a backtrack */
512 
513 #define PCRE2_STRUCTURE_LIST \
514 typedef struct pcre2_callout_block { \
515   uint32_t      version;           /* Identifies version of block */ \
516   /* ------------------------ Version 0 ------------------------------- */ \
517   uint32_t      callout_number;    /* Number compiled into pattern */ \
518   uint32_t      capture_top;       /* Max current capture */ \
519   uint32_t      capture_last;      /* Most recently closed capture */ \
520   PCRE2_SIZE   *offset_vector;     /* The offset vector */ \
521   PCRE2_SPTR    mark;              /* Pointer to current mark or NULL */ \
522   PCRE2_SPTR    subject;           /* The subject being matched */ \
523   PCRE2_SIZE    subject_length;    /* The length of the subject */ \
524   PCRE2_SIZE    start_match;       /* Offset to start of this match attempt */ \
525   PCRE2_SIZE    current_position;  /* Where we currently are in the subject */ \
526   PCRE2_SIZE    pattern_position;  /* Offset to next item in the pattern */ \
527   PCRE2_SIZE    next_item_length;  /* Length of next item in the pattern */ \
528   /* ------------------- Added for Version 1 -------------------------- */ \
529   PCRE2_SIZE    callout_string_offset; /* Offset to string within pattern */ \
530   PCRE2_SIZE    callout_string_length; /* Length of string compiled into pattern */ \
531   PCRE2_SPTR    callout_string;    /* String compiled into pattern */ \
532   /* ------------------- Added for Version 2 -------------------------- */ \
533   uint32_t      callout_flags;     /* See above for list */ \
534   /* ------------------------------------------------------------------ */ \
535 } pcre2_callout_block; \
536 \
537 typedef struct pcre2_callout_enumerate_block { \
538   uint32_t      version;           /* Identifies version of block */ \
539   /* ------------------------ Version 0 ------------------------------- */ \
540   PCRE2_SIZE    pattern_position;  /* Offset to next item in the pattern */ \
541   PCRE2_SIZE    next_item_length;  /* Length of next item in the pattern */ \
542   uint32_t      callout_number;    /* Number compiled into pattern */ \
543   PCRE2_SIZE    callout_string_offset; /* Offset to string within pattern */ \
544   PCRE2_SIZE    callout_string_length; /* Length of string compiled into pattern */ \
545   PCRE2_SPTR    callout_string;    /* String compiled into pattern */ \
546   /* ------------------------------------------------------------------ */ \
547 } pcre2_callout_enumerate_block; \
548 \
549 typedef struct pcre2_substitute_callout_block { \
550   uint32_t      version;           /* Identifies version of block */ \
551   /* ------------------------ Version 0 ------------------------------- */ \
552   PCRE2_SPTR    input;             /* Pointer to input subject string */ \
553   PCRE2_SPTR    output;            /* Pointer to output buffer */ \
554   PCRE2_SIZE    output_offsets[2]; /* Changed portion of the output */ \
555   PCRE2_SIZE   *ovector;           /* Pointer to current ovector */ \
556   uint32_t      oveccount;         /* Count of pairs set in ovector */ \
557   uint32_t      subscount;         /* Substitution number */ \
558   /* ------------------------------------------------------------------ */ \
559 } pcre2_substitute_callout_block;
560 
561 
562 /* List the generic forms of all other functions in macros, which will be
563 expanded for each width below. Start with functions that give general
564 information. */
565 
566 #define PCRE2_GENERAL_INFO_FUNCTIONS \
567 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION pcre2_config(uint32_t, void *);
568 
569 
570 /* Functions for manipulating contexts. */
571 
572 #define PCRE2_GENERAL_CONTEXT_FUNCTIONS \
573 PCRE2_EXP_DECL pcre2_general_context PCRE2_CALL_CONVENTION \
574   *pcre2_general_context_copy(pcre2_general_context *); \
575 PCRE2_EXP_DECL pcre2_general_context PCRE2_CALL_CONVENTION \
576   *pcre2_general_context_create(void *(*)(PCRE2_SIZE, void *), \
577     void (*)(void *, void *), void *); \
578 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
579   pcre2_general_context_free(pcre2_general_context *);
580 
581 #define PCRE2_COMPILE_CONTEXT_FUNCTIONS \
582 PCRE2_EXP_DECL pcre2_compile_context PCRE2_CALL_CONVENTION \
583   *pcre2_compile_context_copy(pcre2_compile_context *); \
584 PCRE2_EXP_DECL pcre2_compile_context PCRE2_CALL_CONVENTION \
585   *pcre2_compile_context_create(pcre2_general_context *);\
586 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
587   pcre2_compile_context_free(pcre2_compile_context *); \
588 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
589   pcre2_set_bsr(pcre2_compile_context *, uint32_t); \
590 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
591   pcre2_set_character_tables(pcre2_compile_context *, const uint8_t *); \
592 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
593   pcre2_set_compile_extra_options(pcre2_compile_context *, uint32_t); \
594 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
595   pcre2_set_max_pattern_length(pcre2_compile_context *, PCRE2_SIZE); \
596 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
597   pcre2_set_newline(pcre2_compile_context *, uint32_t); \
598 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
599   pcre2_set_parens_nest_limit(pcre2_compile_context *, uint32_t); \
600 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
601   pcre2_set_compile_recursion_guard(pcre2_compile_context *, \
602     int (*)(uint32_t, void *), void *);
603 
604 #define PCRE2_MATCH_CONTEXT_FUNCTIONS \
605 PCRE2_EXP_DECL pcre2_match_context PCRE2_CALL_CONVENTION \
606   *pcre2_match_context_copy(pcre2_match_context *); \
607 PCRE2_EXP_DECL pcre2_match_context PCRE2_CALL_CONVENTION \
608   *pcre2_match_context_create(pcre2_general_context *); \
609 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
610   pcre2_match_context_free(pcre2_match_context *); \
611 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
612   pcre2_set_callout(pcre2_match_context *, \
613     int (*)(pcre2_callout_block *, void *), void *); \
614 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
615   pcre2_set_substitute_callout(pcre2_match_context *, \
616     int (*)(pcre2_substitute_callout_block *, void *), void *); \
617 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
618   pcre2_set_depth_limit(pcre2_match_context *, uint32_t); \
619 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
620   pcre2_set_heap_limit(pcre2_match_context *, uint32_t); \
621 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
622   pcre2_set_match_limit(pcre2_match_context *, uint32_t); \
623 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
624   pcre2_set_offset_limit(pcre2_match_context *, PCRE2_SIZE); \
625 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
626   pcre2_set_recursion_limit(pcre2_match_context *, uint32_t); \
627 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
628   pcre2_set_recursion_memory_management(pcre2_match_context *, \
629     void *(*)(PCRE2_SIZE, void *), void (*)(void *, void *), void *);
630 
631 #define PCRE2_CONVERT_CONTEXT_FUNCTIONS \
632 PCRE2_EXP_DECL pcre2_convert_context PCRE2_CALL_CONVENTION \
633   *pcre2_convert_context_copy(pcre2_convert_context *); \
634 PCRE2_EXP_DECL pcre2_convert_context PCRE2_CALL_CONVENTION \
635   *pcre2_convert_context_create(pcre2_general_context *); \
636 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
637   pcre2_convert_context_free(pcre2_convert_context *); \
638 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
639   pcre2_set_glob_escape(pcre2_convert_context *, uint32_t); \
640 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
641   pcre2_set_glob_separator(pcre2_convert_context *, uint32_t);
642 
643 
644 /* Functions concerned with compiling a pattern to PCRE internal code. */
645 
646 #define PCRE2_COMPILE_FUNCTIONS \
647 PCRE2_EXP_DECL pcre2_code PCRE2_CALL_CONVENTION \
648   *pcre2_compile(PCRE2_SPTR, PCRE2_SIZE, uint32_t, int *, PCRE2_SIZE *, \
649     pcre2_compile_context *); \
650 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
651   pcre2_code_free(pcre2_code *); \
652 PCRE2_EXP_DECL pcre2_code PCRE2_CALL_CONVENTION \
653   *pcre2_code_copy(const pcre2_code *); \
654 PCRE2_EXP_DECL pcre2_code PCRE2_CALL_CONVENTION \
655   *pcre2_code_copy_with_tables(const pcre2_code *);
656 
657 
658 /* Functions that give information about a compiled pattern. */
659 
660 #define PCRE2_PATTERN_INFO_FUNCTIONS \
661 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
662   pcre2_pattern_info(const pcre2_code *, uint32_t, void *); \
663 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
664   pcre2_callout_enumerate(const pcre2_code *, \
665     int (*)(pcre2_callout_enumerate_block *, void *), void *);
666 
667 
668 /* Functions for running a match and inspecting the result. */
669 
670 #define PCRE2_MATCH_FUNCTIONS \
671 PCRE2_EXP_DECL pcre2_match_data PCRE2_CALL_CONVENTION \
672   *pcre2_match_data_create(uint32_t, pcre2_general_context *); \
673 PCRE2_EXP_DECL pcre2_match_data PCRE2_CALL_CONVENTION \
674   *pcre2_match_data_create_from_pattern(const pcre2_code *, \
675     pcre2_general_context *); \
676 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
677   pcre2_dfa_match(const pcre2_code *, PCRE2_SPTR, PCRE2_SIZE, PCRE2_SIZE, \
678     uint32_t, pcre2_match_data *, pcre2_match_context *, int *, PCRE2_SIZE); \
679 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
680   pcre2_match(const pcre2_code *, PCRE2_SPTR, PCRE2_SIZE, PCRE2_SIZE, \
681     uint32_t, pcre2_match_data *, pcre2_match_context *); \
682 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
683   pcre2_match_data_free(pcre2_match_data *); \
684 PCRE2_EXP_DECL PCRE2_SPTR PCRE2_CALL_CONVENTION \
685   pcre2_get_mark(pcre2_match_data *); \
686 PCRE2_EXP_DECL PCRE2_SIZE PCRE2_CALL_CONVENTION \
687   pcre2_get_match_data_size(pcre2_match_data *); \
688 PCRE2_EXP_DECL uint32_t PCRE2_CALL_CONVENTION \
689   pcre2_get_ovector_count(pcre2_match_data *); \
690 PCRE2_EXP_DECL PCRE2_SIZE PCRE2_CALL_CONVENTION \
691   *pcre2_get_ovector_pointer(pcre2_match_data *); \
692 PCRE2_EXP_DECL PCRE2_SIZE PCRE2_CALL_CONVENTION \
693   pcre2_get_startchar(pcre2_match_data *);
694 
695 
696 /* Convenience functions for handling matched substrings. */
697 
698 #define PCRE2_SUBSTRING_FUNCTIONS \
699 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
700   pcre2_substring_copy_byname(pcre2_match_data *, PCRE2_SPTR, PCRE2_UCHAR *, \
701     PCRE2_SIZE *); \
702 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
703   pcre2_substring_copy_bynumber(pcre2_match_data *, uint32_t, PCRE2_UCHAR *, \
704     PCRE2_SIZE *); \
705 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
706   pcre2_substring_free(PCRE2_UCHAR *); \
707 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
708   pcre2_substring_get_byname(pcre2_match_data *, PCRE2_SPTR, PCRE2_UCHAR **, \
709     PCRE2_SIZE *); \
710 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
711   pcre2_substring_get_bynumber(pcre2_match_data *, uint32_t, PCRE2_UCHAR **, \
712     PCRE2_SIZE *); \
713 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
714   pcre2_substring_length_byname(pcre2_match_data *, PCRE2_SPTR, PCRE2_SIZE *); \
715 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
716   pcre2_substring_length_bynumber(pcre2_match_data *, uint32_t, PCRE2_SIZE *); \
717 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
718   pcre2_substring_nametable_scan(const pcre2_code *, PCRE2_SPTR, PCRE2_SPTR *, \
719     PCRE2_SPTR *); \
720 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
721   pcre2_substring_number_from_name(const pcre2_code *, PCRE2_SPTR); \
722 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
723   pcre2_substring_list_free(PCRE2_SPTR *); \
724 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
725   pcre2_substring_list_get(pcre2_match_data *, PCRE2_UCHAR ***, PCRE2_SIZE **);
726 
727 /* Functions for serializing / deserializing compiled patterns. */
728 
729 #define PCRE2_SERIALIZE_FUNCTIONS \
730 PCRE2_EXP_DECL int32_t PCRE2_CALL_CONVENTION \
731   pcre2_serialize_encode(const pcre2_code **, int32_t, uint8_t **, \
732     PCRE2_SIZE *, pcre2_general_context *); \
733 PCRE2_EXP_DECL int32_t PCRE2_CALL_CONVENTION \
734   pcre2_serialize_decode(pcre2_code **, int32_t, const uint8_t *, \
735     pcre2_general_context *); \
736 PCRE2_EXP_DECL int32_t PCRE2_CALL_CONVENTION \
737   pcre2_serialize_get_number_of_codes(const uint8_t *); \
738 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
739   pcre2_serialize_free(uint8_t *);
740 
741 
742 /* Convenience function for match + substitute. */
743 
744 #define PCRE2_SUBSTITUTE_FUNCTION \
745 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
746   pcre2_substitute(const pcre2_code *, PCRE2_SPTR, PCRE2_SIZE, PCRE2_SIZE, \
747     uint32_t, pcre2_match_data *, pcre2_match_context *, PCRE2_SPTR, \
748     PCRE2_SIZE, PCRE2_UCHAR *, PCRE2_SIZE *);
749 
750 
751 /* Functions for converting pattern source strings. */
752 
753 #define PCRE2_CONVERT_FUNCTIONS \
754 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
755   pcre2_pattern_convert(PCRE2_SPTR, PCRE2_SIZE, uint32_t, PCRE2_UCHAR **, \
756     PCRE2_SIZE *, pcre2_convert_context *); \
757 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
758   pcre2_converted_pattern_free(PCRE2_UCHAR *);
759 
760 
761 /* Functions for JIT processing */
762 
763 #define PCRE2_JIT_FUNCTIONS \
764 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
765   pcre2_jit_compile(pcre2_code *, uint32_t); \
766 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
767   pcre2_jit_match(const pcre2_code *, PCRE2_SPTR, PCRE2_SIZE, PCRE2_SIZE, \
768     uint32_t, pcre2_match_data *, pcre2_match_context *); \
769 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
770   pcre2_jit_free_unused_memory(pcre2_general_context *); \
771 PCRE2_EXP_DECL pcre2_jit_stack PCRE2_CALL_CONVENTION \
772   *pcre2_jit_stack_create(PCRE2_SIZE, PCRE2_SIZE, pcre2_general_context *); \
773 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
774   pcre2_jit_stack_assign(pcre2_match_context *, pcre2_jit_callback, void *); \
775 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
776   pcre2_jit_stack_free(pcre2_jit_stack *);
777 
778 
779 /* Other miscellaneous functions. */
780 
781 #define PCRE2_OTHER_FUNCTIONS \
782 PCRE2_EXP_DECL int PCRE2_CALL_CONVENTION \
783   pcre2_get_error_message(int, PCRE2_UCHAR *, PCRE2_SIZE); \
784 PCRE2_EXP_DECL const uint8_t PCRE2_CALL_CONVENTION \
785   *pcre2_maketables(pcre2_general_context *); \
786 PCRE2_EXP_DECL void PCRE2_CALL_CONVENTION \
787   pcre2_maketables_free(pcre2_general_context *, const uint8_t *);
788 
789 /* Define macros that generate width-specific names from generic versions. The
790 three-level macro scheme is necessary to get the macros expanded when we want
791 them to be. First we get the width from PCRE2_LOCAL_WIDTH, which is used for
792 generating three versions of everything below. After that, PCRE2_SUFFIX will be
793 re-defined to use PCRE2_CODE_UNIT_WIDTH, for use when macros such as
794 pcre2_compile are called by application code. */
795 
796 #define PCRE2_JOIN(a,b) a ## b
797 #define PCRE2_GLUE(a,b) PCRE2_JOIN(a,b)
798 #define PCRE2_SUFFIX(a) PCRE2_GLUE(a,PCRE2_LOCAL_WIDTH)
799 
800 
801 /* Data types */
802 
803 #define PCRE2_UCHAR                 PCRE2_SUFFIX(PCRE2_UCHAR)
804 #define PCRE2_SPTR                  PCRE2_SUFFIX(PCRE2_SPTR)
805 
806 #define pcre2_code                  PCRE2_SUFFIX(pcre2_code_)
807 #define pcre2_jit_callback          PCRE2_SUFFIX(pcre2_jit_callback_)
808 #define pcre2_jit_stack             PCRE2_SUFFIX(pcre2_jit_stack_)
809 
810 #define pcre2_real_code             PCRE2_SUFFIX(pcre2_real_code_)
811 #define pcre2_real_general_context  PCRE2_SUFFIX(pcre2_real_general_context_)
812 #define pcre2_real_compile_context  PCRE2_SUFFIX(pcre2_real_compile_context_)
813 #define pcre2_real_convert_context  PCRE2_SUFFIX(pcre2_real_convert_context_)
814 #define pcre2_real_match_context    PCRE2_SUFFIX(pcre2_real_match_context_)
815 #define pcre2_real_jit_stack        PCRE2_SUFFIX(pcre2_real_jit_stack_)
816 #define pcre2_real_match_data       PCRE2_SUFFIX(pcre2_real_match_data_)
817 
818 
819 /* Data blocks */
820 
821 #define pcre2_callout_block            PCRE2_SUFFIX(pcre2_callout_block_)
822 #define pcre2_callout_enumerate_block  PCRE2_SUFFIX(pcre2_callout_enumerate_block_)
823 #define pcre2_substitute_callout_block PCRE2_SUFFIX(pcre2_substitute_callout_block_)
824 #define pcre2_general_context          PCRE2_SUFFIX(pcre2_general_context_)
825 #define pcre2_compile_context          PCRE2_SUFFIX(pcre2_compile_context_)
826 #define pcre2_convert_context          PCRE2_SUFFIX(pcre2_convert_context_)
827 #define pcre2_match_context            PCRE2_SUFFIX(pcre2_match_context_)
828 #define pcre2_match_data               PCRE2_SUFFIX(pcre2_match_data_)
829 
830 
831 /* Functions: the complete list in alphabetical order */
832 
833 #define pcre2_callout_enumerate               PCRE2_SUFFIX(pcre2_callout_enumerate_)
834 #define pcre2_code_copy                       PCRE2_SUFFIX(pcre2_code_copy_)
835 #define pcre2_code_copy_with_tables           PCRE2_SUFFIX(pcre2_code_copy_with_tables_)
836 #define pcre2_code_free                       PCRE2_SUFFIX(pcre2_code_free_)
837 #define pcre2_compile                         PCRE2_SUFFIX(pcre2_compile_)
838 #define pcre2_compile_context_copy            PCRE2_SUFFIX(pcre2_compile_context_copy_)
839 #define pcre2_compile_context_create          PCRE2_SUFFIX(pcre2_compile_context_create_)
840 #define pcre2_compile_context_free            PCRE2_SUFFIX(pcre2_compile_context_free_)
841 #define pcre2_config                          PCRE2_SUFFIX(pcre2_config_)
842 #define pcre2_convert_context_copy            PCRE2_SUFFIX(pcre2_convert_context_copy_)
843 #define pcre2_convert_context_create          PCRE2_SUFFIX(pcre2_convert_context_create_)
844 #define pcre2_convert_context_free            PCRE2_SUFFIX(pcre2_convert_context_free_)
845 #define pcre2_converted_pattern_free          PCRE2_SUFFIX(pcre2_converted_pattern_free_)
846 #define pcre2_dfa_match                       PCRE2_SUFFIX(pcre2_dfa_match_)
847 #define pcre2_general_context_copy            PCRE2_SUFFIX(pcre2_general_context_copy_)
848 #define pcre2_general_context_create          PCRE2_SUFFIX(pcre2_general_context_create_)
849 #define pcre2_general_context_free            PCRE2_SUFFIX(pcre2_general_context_free_)
850 #define pcre2_get_error_message               PCRE2_SUFFIX(pcre2_get_error_message_)
851 #define pcre2_get_mark                        PCRE2_SUFFIX(pcre2_get_mark_)
852 #define pcre2_get_match_data_size             PCRE2_SUFFIX(pcre2_get_match_data_size_)
853 #define pcre2_get_ovector_pointer             PCRE2_SUFFIX(pcre2_get_ovector_pointer_)
854 #define pcre2_get_ovector_count               PCRE2_SUFFIX(pcre2_get_ovector_count_)
855 #define pcre2_get_startchar                   PCRE2_SUFFIX(pcre2_get_startchar_)
856 #define pcre2_jit_compile                     PCRE2_SUFFIX(pcre2_jit_compile_)
857 #define pcre2_jit_match                       PCRE2_SUFFIX(pcre2_jit_match_)
858 #define pcre2_jit_free_unused_memory          PCRE2_SUFFIX(pcre2_jit_free_unused_memory_)
859 #define pcre2_jit_stack_assign                PCRE2_SUFFIX(pcre2_jit_stack_assign_)
860 #define pcre2_jit_stack_create                PCRE2_SUFFIX(pcre2_jit_stack_create_)
861 #define pcre2_jit_stack_free                  PCRE2_SUFFIX(pcre2_jit_stack_free_)
862 #define pcre2_maketables                      PCRE2_SUFFIX(pcre2_maketables_)
863 #define pcre2_maketables_free                 PCRE2_SUFFIX(pcre2_maketables_free_)
864 #define pcre2_match                           PCRE2_SUFFIX(pcre2_match_)
865 #define pcre2_match_context_copy              PCRE2_SUFFIX(pcre2_match_context_copy_)
866 #define pcre2_match_context_create            PCRE2_SUFFIX(pcre2_match_context_create_)
867 #define pcre2_match_context_free              PCRE2_SUFFIX(pcre2_match_context_free_)
868 #define pcre2_match_data_create               PCRE2_SUFFIX(pcre2_match_data_create_)
869 #define pcre2_match_data_create_from_pattern  PCRE2_SUFFIX(pcre2_match_data_create_from_pattern_)
870 #define pcre2_match_data_free                 PCRE2_SUFFIX(pcre2_match_data_free_)
871 #define pcre2_pattern_convert                 PCRE2_SUFFIX(pcre2_pattern_convert_)
872 #define pcre2_pattern_info                    PCRE2_SUFFIX(pcre2_pattern_info_)
873 #define pcre2_serialize_decode                PCRE2_SUFFIX(pcre2_serialize_decode_)
874 #define pcre2_serialize_encode                PCRE2_SUFFIX(pcre2_serialize_encode_)
875 #define pcre2_serialize_free                  PCRE2_SUFFIX(pcre2_serialize_free_)
876 #define pcre2_serialize_get_number_of_codes   PCRE2_SUFFIX(pcre2_serialize_get_number_of_codes_)
877 #define pcre2_set_bsr                         PCRE2_SUFFIX(pcre2_set_bsr_)
878 #define pcre2_set_callout                     PCRE2_SUFFIX(pcre2_set_callout_)
879 #define pcre2_set_character_tables            PCRE2_SUFFIX(pcre2_set_character_tables_)
880 #define pcre2_set_compile_extra_options       PCRE2_SUFFIX(pcre2_set_compile_extra_options_)
881 #define pcre2_set_compile_recursion_guard     PCRE2_SUFFIX(pcre2_set_compile_recursion_guard_)
882 #define pcre2_set_depth_limit                 PCRE2_SUFFIX(pcre2_set_depth_limit_)
883 #define pcre2_set_glob_escape                 PCRE2_SUFFIX(pcre2_set_glob_escape_)
884 #define pcre2_set_glob_separator              PCRE2_SUFFIX(pcre2_set_glob_separator_)
885 #define pcre2_set_heap_limit                  PCRE2_SUFFIX(pcre2_set_heap_limit_)
886 #define pcre2_set_match_limit                 PCRE2_SUFFIX(pcre2_set_match_limit_)
887 #define pcre2_set_max_pattern_length          PCRE2_SUFFIX(pcre2_set_max_pattern_length_)
888 #define pcre2_set_newline                     PCRE2_SUFFIX(pcre2_set_newline_)
889 #define pcre2_set_parens_nest_limit           PCRE2_SUFFIX(pcre2_set_parens_nest_limit_)
890 #define pcre2_set_offset_limit                PCRE2_SUFFIX(pcre2_set_offset_limit_)
891 #define pcre2_set_substitute_callout          PCRE2_SUFFIX(pcre2_set_substitute_callout_)
892 #define pcre2_substitute                      PCRE2_SUFFIX(pcre2_substitute_)
893 #define pcre2_substring_copy_byname           PCRE2_SUFFIX(pcre2_substring_copy_byname_)
894 #define pcre2_substring_copy_bynumber         PCRE2_SUFFIX(pcre2_substring_copy_bynumber_)
895 #define pcre2_substring_free                  PCRE2_SUFFIX(pcre2_substring_free_)
896 #define pcre2_substring_get_byname            PCRE2_SUFFIX(pcre2_substring_get_byname_)
897 #define pcre2_substring_get_bynumber          PCRE2_SUFFIX(pcre2_substring_get_bynumber_)
898 #define pcre2_substring_length_byname         PCRE2_SUFFIX(pcre2_substring_length_byname_)
899 #define pcre2_substring_length_bynumber       PCRE2_SUFFIX(pcre2_substring_length_bynumber_)
900 #define pcre2_substring_list_get              PCRE2_SUFFIX(pcre2_substring_list_get_)
901 #define pcre2_substring_list_free             PCRE2_SUFFIX(pcre2_substring_list_free_)
902 #define pcre2_substring_nametable_scan        PCRE2_SUFFIX(pcre2_substring_nametable_scan_)
903 #define pcre2_substring_number_from_name      PCRE2_SUFFIX(pcre2_substring_number_from_name_)
904 
905 /* Keep this old function name for backwards compatibility */
906 #define pcre2_set_recursion_limit PCRE2_SUFFIX(pcre2_set_recursion_limit_)
907 
908 /* Keep this obsolete function for backwards compatibility: it is now a noop. */
909 #define pcre2_set_recursion_memory_management PCRE2_SUFFIX(pcre2_set_recursion_memory_management_)
910 
911 /* Now generate all three sets of width-specific structures and function
912 prototypes. */
913 
914 #define PCRE2_TYPES_STRUCTURES_AND_FUNCTIONS \
915 PCRE2_TYPES_LIST \
916 PCRE2_STRUCTURE_LIST \
917 PCRE2_GENERAL_INFO_FUNCTIONS \
918 PCRE2_GENERAL_CONTEXT_FUNCTIONS \
919 PCRE2_COMPILE_CONTEXT_FUNCTIONS \
920 PCRE2_CONVERT_CONTEXT_FUNCTIONS \
921 PCRE2_CONVERT_FUNCTIONS \
922 PCRE2_MATCH_CONTEXT_FUNCTIONS \
923 PCRE2_COMPILE_FUNCTIONS \
924 PCRE2_PATTERN_INFO_FUNCTIONS \
925 PCRE2_MATCH_FUNCTIONS \
926 PCRE2_SUBSTRING_FUNCTIONS \
927 PCRE2_SERIALIZE_FUNCTIONS \
928 PCRE2_SUBSTITUTE_FUNCTION \
929 PCRE2_JIT_FUNCTIONS \
930 PCRE2_OTHER_FUNCTIONS
931 
932 #define PCRE2_LOCAL_WIDTH 8
933 PCRE2_TYPES_STRUCTURES_AND_FUNCTIONS
934 #undef PCRE2_LOCAL_WIDTH
935 
936 #define PCRE2_LOCAL_WIDTH 16
937 PCRE2_TYPES_STRUCTURES_AND_FUNCTIONS
938 #undef PCRE2_LOCAL_WIDTH
939 
940 #define PCRE2_LOCAL_WIDTH 32
941 PCRE2_TYPES_STRUCTURES_AND_FUNCTIONS
942 #undef PCRE2_LOCAL_WIDTH
943 
944 /* Undefine the list macros; they are no longer needed. */
945 
946 #undef PCRE2_TYPES_LIST
947 #undef PCRE2_STRUCTURE_LIST
948 #undef PCRE2_GENERAL_INFO_FUNCTIONS
949 #undef PCRE2_GENERAL_CONTEXT_FUNCTIONS
950 #undef PCRE2_COMPILE_CONTEXT_FUNCTIONS
951 #undef PCRE2_CONVERT_CONTEXT_FUNCTIONS
952 #undef PCRE2_MATCH_CONTEXT_FUNCTIONS
953 #undef PCRE2_COMPILE_FUNCTIONS
954 #undef PCRE2_PATTERN_INFO_FUNCTIONS
955 #undef PCRE2_MATCH_FUNCTIONS
956 #undef PCRE2_SUBSTRING_FUNCTIONS
957 #undef PCRE2_SERIALIZE_FUNCTIONS
958 #undef PCRE2_SUBSTITUTE_FUNCTION
959 #undef PCRE2_JIT_FUNCTIONS
960 #undef PCRE2_OTHER_FUNCTIONS
961 #undef PCRE2_TYPES_STRUCTURES_AND_FUNCTIONS
962 
963 /* PCRE2_CODE_UNIT_WIDTH must be defined. If it is 8, 16, or 32, redefine
964 PCRE2_SUFFIX to use it. If it is 0, undefine the other macros and make
965 PCRE2_SUFFIX a no-op. Otherwise, generate an error. */
966 
967 #undef PCRE2_SUFFIX
968 #ifndef PCRE2_CODE_UNIT_WIDTH
969 #error PCRE2_CODE_UNIT_WIDTH must be defined before including pcre2.h.
970 #error Use 8, 16, or 32; or 0 for a multi-width application.
971 #else  /* PCRE2_CODE_UNIT_WIDTH is defined */
972 #if PCRE2_CODE_UNIT_WIDTH == 8 || \
973     PCRE2_CODE_UNIT_WIDTH == 16 || \
974     PCRE2_CODE_UNIT_WIDTH == 32
975 #define PCRE2_SUFFIX(a) PCRE2_GLUE(a, PCRE2_CODE_UNIT_WIDTH)
976 #elif PCRE2_CODE_UNIT_WIDTH == 0
977 #undef PCRE2_JOIN
978 #undef PCRE2_GLUE
979 #define PCRE2_SUFFIX(a) a
980 #else
981 #error PCRE2_CODE_UNIT_WIDTH must be 0, 8, 16, or 32.
982 #endif
983 #endif  /* PCRE2_CODE_UNIT_WIDTH is defined */
984 
985 #ifdef __cplusplus
986 }  /* extern "C" */
987 #endif
988 
989 #endif  /* PCRE2_H_IDEMPOTENT_GUARD */
990 
991 /* End of pcre2.h */
992