src/src/pcre/pcre.h

   1 /* $Cambridge: exim/src/src/pcre/pcre.h,v 1.6 2007/06/26 11:16:54 ph10 Exp $ */
   2
   3 /*************************************************
   4 *       Perl-Compatible Regular Expressions      *
   5 *************************************************/
   6
   7 /* This is the public header file for the PCRE library, to be #included by
   8 applications that call the PCRE functions.
   9
  10            Copyright (c) 1997-2007 University of Cambridge
  11
  12 -----------------------------------------------------------------------------
  13 Redistribution and use in source and binary forms, with or without
  14 modification, are permitted provided that the following conditions are met:
  15
  16     * Redistributions of source code must retain the above copyright notice,
  17       this list of conditions and the following disclaimer.
  18
  19     * Redistributions in binary form must reproduce the above copyright
  20       notice, this list of conditions and the following disclaimer in the
  21       documentation and/or other materials provided with the distribution.
  22
  23     * Neither the name of the University of Cambridge nor the names of its
  24       contributors may be used to endorse or promote products derived from
  25       this software without specific prior written permission.
  26
  27 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  28 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  31 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  32 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  33 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  34 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  35 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37 POSSIBILITY OF SUCH DAMAGE.
  38 -----------------------------------------------------------------------------
  39 */
  40
  41 #ifndef _PCRE_H
  42 #define _PCRE_H
  43
  44 /* The current PCRE version information. */
  45
  46 #define PCRE_MAJOR          7
  47 #define PCRE_MINOR          2
  48 #define PCRE_PRERELEASE
  49 #define PCRE_DATE           2007-06-19
  50
  51 /* When an application links to a PCRE DLL in Windows, the symbols that are
  52 imported have to be identified as such. When building PCRE, the appropriate
  53 export setting is defined in pcre_internal.h, which includes this file. So we
  54 don't change an existing definition of PCRE_EXP_DECL. */
  55
  56 #ifndef PCRE_EXP_DECL
  57 #  ifdef _WIN32
  58 #    ifndef PCRE_STATIC
  59 #      define PCRE_EXP_DECL extern __declspec(dllimport)
  60 #    endif
  61 #  endif
  62 #endif
  63
  64 /* By default, we use the standard "extern" declarations. */
  65
  66 #ifndef PCRE_EXP_DECL
  67 #  ifdef __cplusplus
  68 #    define PCRE_EXP_DECL       extern "C"
  69 #  else
  70 #    define PCRE_EXP_DECL       extern
  71 #  endif
  72 #endif
  73
  74 /* Have to include stdlib.h in order to ensure that size_t is defined;
  75 it is needed here for malloc. */
  76
  77 #include <stdlib.h>
  78
  79 /* Allow for C++ users */
  80
  81 #ifdef __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 /* Options */
  86
  87 #define PCRE_CASELESS           0x00000001
  88 #define PCRE_MULTILINE          0x00000002
  89 #define PCRE_DOTALL             0x00000004
  90 #define PCRE_EXTENDED           0x00000008
  91 #define PCRE_ANCHORED           0x00000010
  92 #define PCRE_DOLLAR_ENDONLY     0x00000020
  93 #define PCRE_EXTRA              0x00000040
  94 #define PCRE_NOTBOL             0x00000080
  95 #define PCRE_NOTEOL             0x00000100
  96 #define PCRE_UNGREEDY           0x00000200
  97 #define PCRE_NOTEMPTY           0x00000400
  98 #define PCRE_UTF8               0x00000800
  99 #define PCRE_NO_AUTO_CAPTURE    0x00001000
 100 #define PCRE_NO_UTF8_CHECK      0x00002000
 101 #define PCRE_AUTO_CALLOUT       0x00004000
 102 #define PCRE_PARTIAL            0x00008000
 103 #define PCRE_DFA_SHORTEST       0x00010000
 104 #define PCRE_DFA_RESTART        0x00020000
 105 #define PCRE_FIRSTLINE          0x00040000
 106 #define PCRE_DUPNAMES           0x00080000
 107 #define PCRE_NEWLINE_CR         0x00100000
 108 #define PCRE_NEWLINE_LF         0x00200000
 109 #define PCRE_NEWLINE_CRLF       0x00300000
 110 #define PCRE_NEWLINE_ANY        0x00400000
 111 #define PCRE_NEWLINE_ANYCRLF    0x00500000
 112
 113 /* Exec-time and get/set-time error codes */
 114
 115 #define PCRE_ERROR_NOMATCH         (-1)
 116 #define PCRE_ERROR_NULL            (-2)
 117 #define PCRE_ERROR_BADOPTION       (-3)
 118 #define PCRE_ERROR_BADMAGIC        (-4)
 119 #define PCRE_ERROR_UNKNOWN_OPCODE  (-5)
 120 #define PCRE_ERROR_UNKNOWN_NODE    (-5)  /* For backward compatibility */
 121 #define PCRE_ERROR_NOMEMORY        (-6)
 122 #define PCRE_ERROR_NOSUBSTRING     (-7)
 123 #define PCRE_ERROR_MATCHLIMIT      (-8)
 124 #define PCRE_ERROR_CALLOUT         (-9)  /* Never used by PCRE itself */
 125 #define PCRE_ERROR_BADUTF8        (-10)
 126 #define PCRE_ERROR_BADUTF8_OFFSET (-11)
 127 #define PCRE_ERROR_PARTIAL        (-12)
 128 #define PCRE_ERROR_BADPARTIAL     (-13)
 129 #define PCRE_ERROR_INTERNAL       (-14)
 130 #define PCRE_ERROR_BADCOUNT       (-15)
 131 #define PCRE_ERROR_DFA_UITEM      (-16)
 132 #define PCRE_ERROR_DFA_UCOND      (-17)
 133 #define PCRE_ERROR_DFA_UMLIMIT    (-18)
 134 #define PCRE_ERROR_DFA_WSSIZE     (-19)
 135 #define PCRE_ERROR_DFA_RECURSE    (-20)
 136 #define PCRE_ERROR_RECURSIONLIMIT (-21)
 137 #define PCRE_ERROR_NULLWSLIMIT    (-22)
 138 #define PCRE_ERROR_BADNEWLINE     (-23)
 139
 140 /* Request types for pcre_fullinfo() */
 141
 142 #define PCRE_INFO_OPTIONS            0
 143 #define PCRE_INFO_SIZE               1
 144 #define PCRE_INFO_CAPTURECOUNT       2
 145 #define PCRE_INFO_BACKREFMAX         3
 146 #define PCRE_INFO_FIRSTBYTE          4
 147 #define PCRE_INFO_FIRSTCHAR          4  /* For backwards compatibility */
 148 #define PCRE_INFO_FIRSTTABLE         5
 149 #define PCRE_INFO_LASTLITERAL        6
 150 #define PCRE_INFO_NAMEENTRYSIZE      7
 151 #define PCRE_INFO_NAMECOUNT          8
 152 #define PCRE_INFO_NAMETABLE          9
 153 #define PCRE_INFO_STUDYSIZE         10
 154 #define PCRE_INFO_DEFAULT_TABLES    11
 155 #define PCRE_INFO_OKPARTIAL         12
 156 #define PCRE_INFO_JCHANGED          13
 157
 158 /* Request types for pcre_config(). Do not re-arrange, in order to remain
 159 compatible. */
 160
 161 #define PCRE_CONFIG_UTF8                    0
 162 #define PCRE_CONFIG_NEWLINE                 1
 163 #define PCRE_CONFIG_LINK_SIZE               2
 164 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD  3
 165 #define PCRE_CONFIG_MATCH_LIMIT             4
 166 #define PCRE_CONFIG_STACKRECURSE            5
 167 #define PCRE_CONFIG_UNICODE_PROPERTIES      6
 168 #define PCRE_CONFIG_MATCH_LIMIT_RECURSION   7
 169
 170 /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
 171 these bits, just add new ones on the end, in order to remain compatible. */
 172
 173 #define PCRE_EXTRA_STUDY_DATA             0x0001
 174 #define PCRE_EXTRA_MATCH_LIMIT            0x0002
 175 #define PCRE_EXTRA_CALLOUT_DATA           0x0004
 176 #define PCRE_EXTRA_TABLES                 0x0008
 177 #define PCRE_EXTRA_MATCH_LIMIT_RECURSION  0x0010
 178
 179 /* Types */
 180
 181 struct real_pcre;                 /* declaration; the definition is private  */
 182 typedef struct real_pcre pcre;
 183
 184 /* When PCRE is compiled as a C++ library, the subject pointer type can be
 185 replaced with a custom type. For conventional use, the public interface is a
 186 const char *. */
 187
 188 #ifndef PCRE_SPTR
 189 #define PCRE_SPTR const char *
 190 #endif
 191
 192 /* The structure for passing additional data to pcre_exec(). This is defined in
 193 such as way as to be extensible. Always add new fields at the end, in order to
 194 remain compatible. */
 195
 196 typedef struct pcre_extra {
 197   unsigned long int flags;        /* Bits for which fields are set */
 198   void *study_data;               /* Opaque data from pcre_study() */
 199   unsigned long int match_limit;  /* Maximum number of calls to match() */
 200   void *callout_data;             /* Data passed back in callouts */
 201   const unsigned char *tables;    /* Pointer to character tables */
 202   unsigned long int match_limit_recursion; /* Max recursive calls to match() */
 203 } pcre_extra;
 204
 205 /* The structure for passing out data via the pcre_callout_function. We use a
 206 structure so that new fields can be added on the end in future versions,
 207 without changing the API of the function, thereby allowing old clients to work
 208 without modification. */
 209
 210 typedef struct pcre_callout_block {
 211   int          version;           /* Identifies version of block */
 212   /* ------------------------ Version 0 ------------------------------- */
 213   int          callout_number;    /* Number compiled into pattern */
 214   int         *offset_vector;     /* The offset vector */
 215   PCRE_SPTR    subject;           /* The subject being matched */
 216   int          subject_length;    /* The length of the subject */
 217   int          start_match;       /* Offset to start of this match attempt */
 218   int          current_position;  /* Where we currently are in the subject */
 219   int          capture_top;       /* Max current capture */
 220   int          capture_last;      /* Most recently closed capture */
 221   void        *callout_data;      /* Data passed in with the call */
 222   /* ------------------- Added for Version 1 -------------------------- */
 223   int          pattern_position;  /* Offset to next item in the pattern */
 224   int          next_item_length;  /* Length of next item in the pattern */
 225   /* ------------------------------------------------------------------ */
 226 } pcre_callout_block;
 227
 228 /* Indirection for store get and free functions. These can be set to
 229 alternative malloc/free functions if required. Special ones are used in the
 230 non-recursive case for "frames". There is also an optional callout function
 231 that is triggered by the (?) regex item. For Virtual Pascal, these definitions
 232 have to take another form. */
 233
 234 #ifndef VPCOMPAT
 235 PCRE_EXP_DECL void *(*pcre_malloc)(size_t);
 236 PCRE_EXP_DECL void  (*pcre_free)(void *);
 237 PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t);
 238 PCRE_EXP_DECL void  (*pcre_stack_free)(void *);
 239 PCRE_EXP_DECL int   (*pcre_callout)(pcre_callout_block *);
 240 #else   /* VPCOMPAT */
 241 PCRE_EXP_DECL void *pcre_malloc(size_t);
 242 PCRE_EXP_DECL void  pcre_free(void *);
 243 PCRE_EXP_DECL void *pcre_stack_malloc(size_t);
 244 PCRE_EXP_DECL void  pcre_stack_free(void *);
 245 PCRE_EXP_DECL int   pcre_callout(pcre_callout_block *);
 246 #endif  /* VPCOMPAT */
 247
 248 /* Exported PCRE functions */
 249
 250 PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *,
 251                   const unsigned char *);
 252 PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **,
 253                   int *, const unsigned char *);
 254 PCRE_EXP_DECL int  pcre_config(int, void *);
 255 PCRE_EXP_DECL int  pcre_copy_named_substring(const pcre *, const char *,
 256                   int *, int, const char *, char *, int);
 257 PCRE_EXP_DECL int  pcre_copy_substring(const char *, int *, int, int, char *,
 258                   int);
 259 PCRE_EXP_DECL int  pcre_dfa_exec(const pcre *, const pcre_extra *,
 260                   const char *, int, int, int, int *, int , int *, int);
 261 PCRE_EXP_DECL int  pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
 262                    int, int, int, int *, int);
 263 PCRE_EXP_DECL void pcre_free_substring(const char *);
 264 PCRE_EXP_DECL void pcre_free_substring_list(const char **);
 265 PCRE_EXP_DECL int  pcre_fullinfo(const pcre *, const pcre_extra *, int,
 266                   void *);
 267 PCRE_EXP_DECL int  pcre_get_named_substring(const pcre *, const char *,
 268                   int *, int, const char *, const char **);
 269 PCRE_EXP_DECL int  pcre_get_stringnumber(const pcre *, const char *);
 270 PCRE_EXP_DECL int  pcre_get_stringtable_entries(const pcre *, const char *,
 271                   char **, char **);
 272 PCRE_EXP_DECL int  pcre_get_substring(const char *, int *, int, int,
 273                   const char **);
 274 PCRE_EXP_DECL int  pcre_get_substring_list(const char *, int *, int,
 275                   const char ***);
 276 PCRE_EXP_DECL int  pcre_info(const pcre *, int *, int *);
 277 PCRE_EXP_DECL const unsigned char *pcre_maketables(void);
 278 PCRE_EXP_DECL int  pcre_refcount(pcre *, int);
 279 PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **);
 280 PCRE_EXP_DECL const char *pcre_version(void);
 281
 282 #ifdef __cplusplus
 283 }  /* extern "C" */
 284 #endif
 285
 286 #endif /* End of pcre.h */