glib/pcre/pcre.h

   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-2006 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 /* NOTES FOR FUTURE MAINTAINERS: Do not use numbers with leading zeros, because
  45 they may be treated as octal constants. The PCRE_PRERELEASE feature is for
  46 identifying release candidates. It might be defined as -RC2, for example. In
  47 real releases, it should be defined empty. Do not change the alignment of these
  48 statments. The code in ./configure greps out the version numbers by using "cut"
  49 to get values from column 29 onwards. These are substituted into pcre-config
  50 and libpcre.pc. The values are not put into configure.ac and substituted here
  51 (which would simplify this issue) because that makes life harder for those who
  52 cannot run ./configure. As it now stands, this file need not be edited in that
  53 circumstance. */
  54
  55 #define PCRE_MAJOR          7
  56 #define PCRE_MINOR          0
  57 #define PCRE_PRERELEASE
  58 #define PCRE_DATE           18-Dec-2006
  59
  60 /* Win32 uses DLL by default; it needs special stuff for exported functions
  61 when building PCRE. */
  62
  63 #ifdef _WIN32
  64 #  ifdef PCRE_DEFINITION
  65 #    ifdef DLL_EXPORT
  66 #      define PCRE_DATA_SCOPE __declspec(dllexport)
  67 #    endif
  68 #  else
  69 #    ifndef PCRE_STATIC
  70 #      define PCRE_DATA_SCOPE extern __declspec(dllimport)
  71 #    endif
  72 #  endif
  73 #endif
  74
  75 /* Otherwise, we use the standard "extern". */
  76
  77 #ifndef PCRE_DATA_SCOPE
  78 #  ifdef __cplusplus
  79 #    define PCRE_DATA_SCOPE     extern "C"
  80 #  else
  81 #    define PCRE_DATA_SCOPE     extern
  82 #  endif
  83 #endif
  84
  85 /* Have to include stdlib.h in order to ensure that size_t is defined;
  86 it is needed here for malloc. */
  87
  88 #include <stdlib.h>
  89
  90 /* Allow for C++ users */
  91
  92 #ifdef __cplusplus
  93 extern "C" {
  94 #endif
  95
  96 /* Options */
  97
  98 #define PCRE_CASELESS           0x00000001
  99 #define PCRE_MULTILINE          0x00000002
 100 #define PCRE_DOTALL             0x00000004
 101 #define PCRE_EXTENDED           0x00000008
 102 #define PCRE_ANCHORED           0x00000010
 103 #define PCRE_DOLLAR_ENDONLY     0x00000020
 104 #define PCRE_EXTRA              0x00000040
 105 #define PCRE_NOTBOL             0x00000080
 106 #define PCRE_NOTEOL             0x00000100
 107 #define PCRE_UNGREEDY           0x00000200
 108 #define PCRE_NOTEMPTY           0x00000400
 109 #define PCRE_UTF8               0x00000800
 110 #define PCRE_NO_AUTO_CAPTURE    0x00001000
 111 #define PCRE_NO_UTF8_CHECK      0x00002000
 112 #define PCRE_AUTO_CALLOUT       0x00004000
 113 #define PCRE_PARTIAL            0x00008000
 114 #define PCRE_DFA_SHORTEST       0x00010000
 115 #define PCRE_DFA_RESTART        0x00020000
 116 #define PCRE_FIRSTLINE          0x00040000
 117 #define PCRE_DUPNAMES           0x00080000
 118 #define PCRE_NEWLINE_CR         0x00100000
 119 #define PCRE_NEWLINE_LF         0x00200000
 120 #define PCRE_NEWLINE_CRLF       0x00300000
 121 #define PCRE_NEWLINE_ANY        0x00400000
 122
 123 /* Exec-time and get/set-time error codes */
 124
 125 #define PCRE_ERROR_NOMATCH         (-1)
 126 #define PCRE_ERROR_NULL            (-2)
 127 #define PCRE_ERROR_BADOPTION       (-3)
 128 #define PCRE_ERROR_BADMAGIC        (-4)
 129 #define PCRE_ERROR_UNKNOWN_OPCODE  (-5)
 130 #define PCRE_ERROR_UNKNOWN_NODE    (-5)  /* For backward compatibility */
 131 #define PCRE_ERROR_NOMEMORY        (-6)
 132 #define PCRE_ERROR_NOSUBSTRING     (-7)
 133 #define PCRE_ERROR_MATCHLIMIT      (-8)
 134 #define PCRE_ERROR_CALLOUT         (-9)  /* Never used by PCRE itself */
 135 #define PCRE_ERROR_BADUTF8        (-10)
 136 #define PCRE_ERROR_BADUTF8_OFFSET (-11)
 137 #define PCRE_ERROR_PARTIAL        (-12)
 138 #define PCRE_ERROR_BADPARTIAL     (-13)
 139 #define PCRE_ERROR_INTERNAL       (-14)
 140 #define PCRE_ERROR_BADCOUNT       (-15)
 141 #define PCRE_ERROR_DFA_UITEM      (-16)
 142 #define PCRE_ERROR_DFA_UCOND      (-17)
 143 #define PCRE_ERROR_DFA_UMLIMIT    (-18)
 144 #define PCRE_ERROR_DFA_WSSIZE     (-19)
 145 #define PCRE_ERROR_DFA_RECURSE    (-20)
 146 #define PCRE_ERROR_RECURSIONLIMIT (-21)
 147 #define PCRE_ERROR_NULLWSLIMIT    (-22)
 148 #define PCRE_ERROR_BADNEWLINE     (-23)
 149
 150 /* Request types for pcre_fullinfo() */
 151
 152 #define PCRE_INFO_OPTIONS            0
 153 #define PCRE_INFO_SIZE               1
 154 #define PCRE_INFO_CAPTURECOUNT       2
 155 #define PCRE_INFO_BACKREFMAX         3
 156 #define PCRE_INFO_FIRSTBYTE          4
 157 #define PCRE_INFO_FIRSTCHAR          4  /* For backwards compatibility */
 158 #define PCRE_INFO_FIRSTTABLE         5
 159 #define PCRE_INFO_LASTLITERAL        6
 160 #define PCRE_INFO_NAMEENTRYSIZE      7
 161 #define PCRE_INFO_NAMECOUNT          8
 162 #define PCRE_INFO_NAMETABLE          9
 163 #define PCRE_INFO_STUDYSIZE         10
 164 #define PCRE_INFO_DEFAULT_TABLES    11
 165
 166 /* Request types for pcre_config(). Do not re-arrange, in order to remain
 167 compatible. */
 168
 169 #define PCRE_CONFIG_UTF8                    0
 170 #define PCRE_CONFIG_NEWLINE                 1
 171 #define PCRE_CONFIG_LINK_SIZE               2
 172 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD  3
 173 #define PCRE_CONFIG_MATCH_LIMIT             4
 174 #define PCRE_CONFIG_STACKRECURSE            5
 175 #define PCRE_CONFIG_UNICODE_PROPERTIES      6
 176 #define PCRE_CONFIG_MATCH_LIMIT_RECURSION   7
 177
 178 /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
 179 these bits, just add new ones on the end, in order to remain compatible. */
 180
 181 #define PCRE_EXTRA_STUDY_DATA             0x0001
 182 #define PCRE_EXTRA_MATCH_LIMIT            0x0002
 183 #define PCRE_EXTRA_CALLOUT_DATA           0x0004
 184 #define PCRE_EXTRA_TABLES                 0x0008
 185 #define PCRE_EXTRA_MATCH_LIMIT_RECURSION  0x0010
 186
 187 /* Types */
 188
 189 struct real_pcre;                 /* declaration; the definition is private  */
 190 typedef struct real_pcre pcre;
 191
 192 /* When PCRE is compiled as a C++ library, the subject pointer type can be
 193 replaced with a custom type. For conventional use, the public interface is a
 194 const char *. */
 195
 196 #ifndef PCRE_SPTR
 197 #define PCRE_SPTR const char *
 198 #endif
 199
 200 /* The structure for passing additional data to pcre_exec(). This is defined in
 201 such as way as to be extensible. Always add new fields at the end, in order to
 202 remain compatible. */
 203
 204 typedef struct pcre_extra {
 205   unsigned long int flags;        /* Bits for which fields are set */
 206   void *study_data;               /* Opaque data from pcre_study() */
 207   unsigned long int match_limit;  /* Maximum number of calls to match() */
 208   void *callout_data;             /* Data passed back in callouts */
 209   const unsigned char *tables;    /* Pointer to character tables */
 210   unsigned long int match_limit_recursion; /* Max recursive calls to match() */
 211 } pcre_extra;
 212
 213 /* The structure for passing out data via the pcre_callout_function. We use a
 214 structure so that new fields can be added on the end in future versions,
 215 without changing the API of the function, thereby allowing old clients to work
 216 without modification. */
 217
 218 typedef struct pcre_callout_block {
 219   int          version;           /* Identifies version of block */
 220   /* ------------------------ Version 0 ------------------------------- */
 221   int          callout_number;    /* Number compiled into pattern */
 222   int         *offset_vector;     /* The offset vector */
 223   PCRE_SPTR    subject;           /* The subject being matched */
 224   int          subject_length;    /* The length of the subject */
 225   int          start_match;       /* Offset to start of this match attempt */
 226   int          current_position;  /* Where we currently are in the subject */
 227   int          capture_top;       /* Max current capture */
 228   int          capture_last;      /* Most recently closed capture */
 229   void        *callout_data;      /* Data passed in with the call */
 230   /* ------------------- Added for Version 1 -------------------------- */
 231   int          pattern_position;  /* Offset to next item in the pattern */
 232   int          next_item_length;  /* Length of next item in the pattern */
 233   /* ------------------------------------------------------------------ */
 234 } pcre_callout_block;
 235
 236 #include "glib.h"
 237 #include "galias.h"
 238
 239 #define pcre_malloc g_try_malloc
 240 #define pcre_free g_free
 241 #define pcre_stack_malloc g_try_malloc
 242
 243 PCRE_DATA_SCOPE int   (*pcre_callout)(pcre_callout_block *);
 244
 245 /* Exported PCRE functions */
 246
 247 PCRE_DATA_SCOPE pcre *pcre_compile(const char *, int, const char **, int *,
 248                   const unsigned char *);
 249 PCRE_DATA_SCOPE pcre *pcre_compile2(const char *, int, int *, const char **,
 250                   int *, const unsigned char *);
 251 PCRE_DATA_SCOPE int  pcre_config(int, void *);
 252 PCRE_DATA_SCOPE int  pcre_copy_named_substring(const pcre *, const char *,
 253                   int *, int, const char *, char *, int);
 254 PCRE_DATA_SCOPE int  pcre_copy_substring(const char *, int *, int, int, char *,
 255                   int);
 256 PCRE_DATA_SCOPE int  pcre_dfa_exec(const pcre *, const pcre_extra *,
 257                   const char *, int, int, int, int *, int , int *, int);
 258 PCRE_DATA_SCOPE int  pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
 259                    int, int, int, int *, int);
 260 PCRE_DATA_SCOPE void pcre_free_substring(const char *);
 261 PCRE_DATA_SCOPE void pcre_free_substring_list(const char **);
 262 PCRE_DATA_SCOPE int  pcre_fullinfo(const pcre *, const pcre_extra *, int,
 263                   void *);
 264 PCRE_DATA_SCOPE int  pcre_get_named_substring(const pcre *, const char *,
 265                   int *, int, const char *, const char **);
 266 PCRE_DATA_SCOPE int  pcre_get_stringnumber(const pcre *, const char *);
 267 PCRE_DATA_SCOPE int  pcre_get_stringtable_entries(const pcre *, const char *,
 268                   char **, char **);
 269 PCRE_DATA_SCOPE int  pcre_get_substring(const char *, int *, int, int,
 270                   const char **);
 271 PCRE_DATA_SCOPE int  pcre_get_substring_list(const char *, int *, int,
 272                   const char ***);
 273 PCRE_DATA_SCOPE int  pcre_info(const pcre *, int *, int *);
 274 PCRE_DATA_SCOPE const unsigned char *pcre_maketables(void);
 275 PCRE_DATA_SCOPE int  pcre_refcount(pcre *, int);
 276 PCRE_DATA_SCOPE pcre_extra *pcre_study(const pcre *, int, const char **);
 277 PCRE_DATA_SCOPE const char *pcre_version(void);
 278
 279 #ifdef __cplusplus
 280 }  /* extern "C" */
 281 #endif
 282
 283 #endif /* End of pcre.h */