src/src/pcre/pcre.h

   1 /*************************************************
   2 *       Perl-Compatible Regular Expressions      *
   3 *************************************************/
   4
   5 /* In its original form, this is the .in file that is transformed by
   6 "configure" into pcre.h.
   7
   8            Copyright (c) 1997-2005 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 file pcre.h is build by "configure". Do not edit it; instead
  43 make changes to pcre.in. */
  44
  45 #define PCRE_MAJOR          6
  46 #define PCRE_MINOR          2
  47 #define PCRE_DATE           01-Aug-2005
  48
  49 /* Win32 uses DLL by default; it needs special stuff for exported functions. */
  50
  51 #ifdef _WIN32
  52 #  ifdef PCRE_DEFINITION
  53 #    ifdef DLL_EXPORT
  54 #      define PCRE_DATA_SCOPE __declspec(dllexport)
  55 #    endif
  56 #  else
  57 #    ifndef PCRE_STATIC
  58 #      define PCRE_DATA_SCOPE extern __declspec(dllimport)
  59 #    endif
  60 #  endif
  61 #endif
  62
  63 /* For other operating systems, we use the standard "extern". */
  64
  65 #ifndef PCRE_DATA_SCOPE
  66 #  ifdef __cplusplus
  67 #    define PCRE_DATA_SCOPE     extern "C"
  68 #  else
  69 #    define PCRE_DATA_SCOPE     extern
  70 #  endif
  71 #endif
  72
  73 /* Have to include stdlib.h in order to ensure that size_t is defined;
  74 it is needed here for malloc. */
  75
  76 #include <stdlib.h>
  77
  78 /* Allow for C++ users */
  79
  80 #ifdef __cplusplus
  81 extern "C" {
  82 #endif
  83
  84 /* Options */
  85
  86 #define PCRE_CASELESS           0x00000001
  87 #define PCRE_MULTILINE          0x00000002
  88 #define PCRE_DOTALL             0x00000004
  89 #define PCRE_EXTENDED           0x00000008
  90 #define PCRE_ANCHORED           0x00000010
  91 #define PCRE_DOLLAR_ENDONLY     0x00000020
  92 #define PCRE_EXTRA              0x00000040
  93 #define PCRE_NOTBOL             0x00000080
  94 #define PCRE_NOTEOL             0x00000100
  95 #define PCRE_UNGREEDY           0x00000200
  96 #define PCRE_NOTEMPTY           0x00000400
  97 #define PCRE_UTF8               0x00000800
  98 #define PCRE_NO_AUTO_CAPTURE    0x00001000
  99 #define PCRE_NO_UTF8_CHECK      0x00002000
 100 #define PCRE_AUTO_CALLOUT       0x00004000
 101 #define PCRE_PARTIAL            0x00008000
 102 #define PCRE_DFA_SHORTEST       0x00010000
 103 #define PCRE_DFA_RESTART        0x00020000
 104 #define PCRE_FIRSTLINE          0x00040000
 105
 106 /* Exec-time and get/set-time error codes */
 107
 108 #define PCRE_ERROR_NOMATCH         (-1)
 109 #define PCRE_ERROR_NULL            (-2)
 110 #define PCRE_ERROR_BADOPTION       (-3)
 111 #define PCRE_ERROR_BADMAGIC        (-4)
 112 #define PCRE_ERROR_UNKNOWN_NODE    (-5)
 113 #define PCRE_ERROR_NOMEMORY        (-6)
 114 #define PCRE_ERROR_NOSUBSTRING     (-7)
 115 #define PCRE_ERROR_MATCHLIMIT      (-8)
 116 #define PCRE_ERROR_CALLOUT         (-9)  /* Never used by PCRE itself */
 117 #define PCRE_ERROR_BADUTF8        (-10)
 118 #define PCRE_ERROR_BADUTF8_OFFSET (-11)
 119 #define PCRE_ERROR_PARTIAL        (-12)
 120 #define PCRE_ERROR_BADPARTIAL     (-13)
 121 #define PCRE_ERROR_INTERNAL       (-14)
 122 #define PCRE_ERROR_BADCOUNT       (-15)
 123 #define PCRE_ERROR_DFA_UITEM      (-16)
 124 #define PCRE_ERROR_DFA_UCOND      (-17)
 125 #define PCRE_ERROR_DFA_UMLIMIT    (-18)
 126 #define PCRE_ERROR_DFA_WSSIZE     (-19)
 127 #define PCRE_ERROR_DFA_RECURSE    (-20)
 128
 129 /* Request types for pcre_fullinfo() */
 130
 131 #define PCRE_INFO_OPTIONS            0
 132 #define PCRE_INFO_SIZE               1
 133 #define PCRE_INFO_CAPTURECOUNT       2
 134 #define PCRE_INFO_BACKREFMAX         3
 135 #define PCRE_INFO_FIRSTBYTE          4
 136 #define PCRE_INFO_FIRSTCHAR          4  /* For backwards compatibility */
 137 #define PCRE_INFO_FIRSTTABLE         5
 138 #define PCRE_INFO_LASTLITERAL        6
 139 #define PCRE_INFO_NAMEENTRYSIZE      7
 140 #define PCRE_INFO_NAMECOUNT          8
 141 #define PCRE_INFO_NAMETABLE          9
 142 #define PCRE_INFO_STUDYSIZE         10
 143 #define PCRE_INFO_DEFAULT_TABLES    11
 144
 145 /* Request types for pcre_config() */
 146
 147 #define PCRE_CONFIG_UTF8                    0
 148 #define PCRE_CONFIG_NEWLINE                 1
 149 #define PCRE_CONFIG_LINK_SIZE               2
 150 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD  3
 151 #define PCRE_CONFIG_MATCH_LIMIT             4
 152 #define PCRE_CONFIG_STACKRECURSE            5
 153 #define PCRE_CONFIG_UNICODE_PROPERTIES      6
 154
 155 /* Bit flags for the pcre_extra structure */
 156
 157 #define PCRE_EXTRA_STUDY_DATA          0x0001
 158 #define PCRE_EXTRA_MATCH_LIMIT         0x0002
 159 #define PCRE_EXTRA_CALLOUT_DATA        0x0004
 160 #define PCRE_EXTRA_TABLES              0x0008
 161
 162 /* Types */
 163
 164 struct real_pcre;                 /* declaration; the definition is private  */
 165 typedef struct real_pcre pcre;
 166
 167 /* The structure for passing additional data to pcre_exec(). This is defined in
 168 such as way as to be extensible. Always add new fields at the end, in order to
 169 remain compatible. */
 170
 171 typedef struct pcre_extra {
 172   unsigned long int flags;        /* Bits for which fields are set */
 173   void *study_data;               /* Opaque data from pcre_study() */
 174   unsigned long int match_limit;  /* Maximum number of calls to match() */
 175   void *callout_data;             /* Data passed back in callouts */
 176   const unsigned char *tables;    /* Pointer to character tables */
 177 } pcre_extra;
 178
 179 /* The structure for passing out data via the pcre_callout_function. We use a
 180 structure so that new fields can be added on the end in future versions,
 181 without changing the API of the function, thereby allowing old clients to work
 182 without modification. */
 183
 184 typedef struct pcre_callout_block {
 185   int          version;           /* Identifies version of block */
 186   /* ------------------------ Version 0 ------------------------------- */
 187   int          callout_number;    /* Number compiled into pattern */
 188   int         *offset_vector;     /* The offset vector */
 189   const char  *subject;           /* The subject being matched */
 190   int          subject_length;    /* The length of the subject */
 191   int          start_match;       /* Offset to start of this match attempt */
 192   int          current_position;  /* Where we currently are in the subject */
 193   int          capture_top;       /* Max current capture */
 194   int          capture_last;      /* Most recently closed capture */
 195   void        *callout_data;      /* Data passed in with the call */
 196   /* ------------------- Added for Version 1 -------------------------- */
 197   int          pattern_position;  /* Offset to next item in the pattern */
 198   int          next_item_length;  /* Length of next item in the pattern */
 199   /* ------------------------------------------------------------------ */
 200 } pcre_callout_block;
 201
 202 /* Indirection for store get and free functions. These can be set to
 203 alternative malloc/free functions if required. Special ones are used in the
 204 non-recursive case for "frames". There is also an optional callout function
 205 that is triggered by the (?) regex item. For Virtual Pascal, these definitions
 206 have to take another form. */
 207
 208 #ifndef VPCOMPAT
 209 PCRE_DATA_SCOPE void *(*pcre_malloc)(size_t);
 210 PCRE_DATA_SCOPE void  (*pcre_free)(void *);
 211 PCRE_DATA_SCOPE void *(*pcre_stack_malloc)(size_t);
 212 PCRE_DATA_SCOPE void  (*pcre_stack_free)(void *);
 213 PCRE_DATA_SCOPE int   (*pcre_callout)(pcre_callout_block *);
 214 #else   /* VPCOMPAT */
 215 PCRE_DATA_SCOPE void *pcre_malloc(size_t);
 216 PCRE_DATA_SCOPE void  pcre_free(void *);
 217 PCRE_DATA_SCOPE void *pcre_stack_malloc(size_t);
 218 PCRE_DATA_SCOPE void  pcre_stack_free(void *);
 219 PCRE_DATA_SCOPE int   pcre_callout(pcre_callout_block *);
 220 #endif  /* VPCOMPAT */
 221
 222 /* Exported PCRE functions */
 223
 224 PCRE_DATA_SCOPE pcre *pcre_compile(const char *, int, const char **, int *,
 225                   const unsigned char *);
 226 PCRE_DATA_SCOPE pcre *pcre_compile2(const char *, int, int *, const char **,
 227                   int *, const unsigned char *);
 228 PCRE_DATA_SCOPE int  pcre_config(int, void *);
 229 PCRE_DATA_SCOPE int  pcre_copy_named_substring(const pcre *, const char *,
 230                   int *, int, const char *, char *, int);
 231 PCRE_DATA_SCOPE int  pcre_copy_substring(const char *, int *, int, int, char *,
 232                   int);
 233 PCRE_DATA_SCOPE int  pcre_dfa_exec(const pcre *, const pcre_extra *,
 234                   const char *, int, int, int, int *, int , int *, int);
 235 PCRE_DATA_SCOPE int  pcre_exec(const pcre *, const pcre_extra *, const char *,
 236                    int, int, int, int *, int);
 237 PCRE_DATA_SCOPE void pcre_free_substring(const char *);
 238 PCRE_DATA_SCOPE void pcre_free_substring_list(const char **);
 239 PCRE_DATA_SCOPE int  pcre_fullinfo(const pcre *, const pcre_extra *, int,
 240                   void *);
 241 PCRE_DATA_SCOPE int  pcre_get_named_substring(const pcre *, const char *,
 242                   int *, int, const char *, const char **);
 243 PCRE_DATA_SCOPE int  pcre_get_stringnumber(const pcre *, const char *);
 244 PCRE_DATA_SCOPE int  pcre_get_substring(const char *, int *, int, int,
 245                   const char **);
 246 PCRE_DATA_SCOPE int  pcre_get_substring_list(const char *, int *, int,
 247                   const char ***);
 248 PCRE_DATA_SCOPE int  pcre_info(const pcre *, int *, int *);
 249 PCRE_DATA_SCOPE const unsigned char *pcre_maketables(void);
 250 PCRE_DATA_SCOPE int  pcre_refcount(pcre *, int);
 251 PCRE_DATA_SCOPE pcre_extra *pcre_study(const pcre *, int, const char **);
 252 PCRE_DATA_SCOPE const char *pcre_version(void);
 253
 254 #ifdef __cplusplus
 255 }  /* extern "C" */
 256 #endif
 257
 258 #endif /* End of pcre.h */