pcre.h.in

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