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