Back to index

php5  5.3.10
pcre.h
Go to the documentation of this file.
00001 /*************************************************
00002 *       Perl-Compatible Regular Expressions      *
00003 *************************************************/
00004 
00005 /* This is the public header file for the PCRE library, to be #included by
00006 applications that call the PCRE functions.
00007 
00008            Copyright (c) 1997-2010 University of Cambridge
00009 
00010 -----------------------------------------------------------------------------
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014     * Redistributions of source code must retain the above copyright notice,
00015       this list of conditions and the following disclaimer.
00016 
00017     * Redistributions in binary form must reproduce the above copyright
00018       notice, this list of conditions and the following disclaimer in the
00019       documentation and/or other materials provided with the distribution.
00020 
00021     * Neither the name of the University of Cambridge nor the names of its
00022       contributors may be used to endorse or promote products derived from
00023       this software without specific prior written permission.
00024 
00025 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00028 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00029 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00030 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00031 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00032 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00033 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00034 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00035 POSSIBILITY OF SUCH DAMAGE.
00036 -----------------------------------------------------------------------------
00037 */
00038 
00039 #ifndef _PCRE_H
00040 #define _PCRE_H
00041 
00042 /* The current PCRE version information. */
00043 
00044 #define PCRE_MAJOR          8
00045 #define PCRE_MINOR          12
00046 #define PCRE_PRERELEASE     
00047 #define PCRE_DATE           2011-01-15
00048 
00049 /* When an application links to a PCRE DLL in Windows, the symbols that are
00050 imported have to be identified as such. When building PCRE, the appropriate
00051 export setting is defined in pcre_internal.h, which includes this file. So we
00052 don't change existing definitions of PCRE_EXP_DECL and PCRECPP_EXP_DECL. */
00053 
00054 #if defined(_WIN32) && !defined(PCRE_STATIC)
00055 #  ifndef PCRE_EXP_DECL
00056 #    define PCRE_EXP_DECL  extern __declspec(dllimport)
00057 #  endif
00058 #  ifdef __cplusplus
00059 #    ifndef PCRECPP_EXP_DECL
00060 #      define PCRECPP_EXP_DECL  extern __declspec(dllimport)
00061 #    endif
00062 #    ifndef PCRECPP_EXP_DEFN
00063 #      define PCRECPP_EXP_DEFN  __declspec(dllimport)
00064 #    endif
00065 #  endif
00066 #endif
00067 
00068 /* By default, we use the standard "extern" declarations. */
00069 
00070 #ifndef PCRE_EXP_DECL
00071 #  ifdef __cplusplus
00072 #    define PCRE_EXP_DECL  extern "C"
00073 #  else
00074 #    define PCRE_EXP_DECL  extern
00075 #  endif
00076 #endif
00077 
00078 #ifdef __cplusplus
00079 #  ifndef PCRECPP_EXP_DECL
00080 #    define PCRECPP_EXP_DECL  extern
00081 #  endif
00082 #  ifndef PCRECPP_EXP_DEFN
00083 #    define PCRECPP_EXP_DEFN
00084 #  endif
00085 #endif
00086 
00087 /* Have to include stdlib.h in order to ensure that size_t is defined;
00088 it is needed here for malloc. */
00089 
00090 #include <stdlib.h>
00091 
00092 /* Allow for C++ users */
00093 
00094 #ifdef __cplusplus
00095 extern "C" {
00096 #endif
00097 
00098 /* Options. Some are compile-time only, some are run-time only, and some are
00099 both, so we keep them all distinct. However, almost all the bits in the options
00100 word are now used. In the long run, we may have to re-use some of the
00101 compile-time only bits for runtime options, or vice versa. */
00102 
00103 #define PCRE_CASELESS           0x00000001  /* Compile */
00104 #define PCRE_MULTILINE          0x00000002  /* Compile */
00105 #define PCRE_DOTALL             0x00000004  /* Compile */
00106 #define PCRE_EXTENDED           0x00000008  /* Compile */
00107 #define PCRE_ANCHORED           0x00000010  /* Compile, exec, DFA exec */
00108 #define PCRE_DOLLAR_ENDONLY     0x00000020  /* Compile */
00109 #define PCRE_EXTRA              0x00000040  /* Compile */
00110 #define PCRE_NOTBOL             0x00000080  /* Exec, DFA exec */
00111 #define PCRE_NOTEOL             0x00000100  /* Exec, DFA exec */
00112 #define PCRE_UNGREEDY           0x00000200  /* Compile */
00113 #define PCRE_NOTEMPTY           0x00000400  /* Exec, DFA exec */
00114 #define PCRE_UTF8               0x00000800  /* Compile */
00115 #define PCRE_NO_AUTO_CAPTURE    0x00001000  /* Compile */
00116 #define PCRE_NO_UTF8_CHECK      0x00002000  /* Compile, exec, DFA exec */
00117 #define PCRE_AUTO_CALLOUT       0x00004000  /* Compile */
00118 #define PCRE_PARTIAL_SOFT       0x00008000  /* Exec, DFA exec */
00119 #define PCRE_PARTIAL            0x00008000  /* Backwards compatible synonym */
00120 #define PCRE_DFA_SHORTEST       0x00010000  /* DFA exec */
00121 #define PCRE_DFA_RESTART        0x00020000  /* DFA exec */
00122 #define PCRE_FIRSTLINE          0x00040000  /* Compile */
00123 #define PCRE_DUPNAMES           0x00080000  /* Compile */
00124 #define PCRE_NEWLINE_CR         0x00100000  /* Compile, exec, DFA exec */
00125 #define PCRE_NEWLINE_LF         0x00200000  /* Compile, exec, DFA exec */
00126 #define PCRE_NEWLINE_CRLF       0x00300000  /* Compile, exec, DFA exec */
00127 #define PCRE_NEWLINE_ANY        0x00400000  /* Compile, exec, DFA exec */
00128 #define PCRE_NEWLINE_ANYCRLF    0x00500000  /* Compile, exec, DFA exec */
00129 #define PCRE_BSR_ANYCRLF        0x00800000  /* Compile, exec, DFA exec */
00130 #define PCRE_BSR_UNICODE        0x01000000  /* Compile, exec, DFA exec */
00131 #define PCRE_JAVASCRIPT_COMPAT  0x02000000  /* Compile */
00132 #define PCRE_NO_START_OPTIMIZE  0x04000000  /* Compile, exec, DFA exec */
00133 #define PCRE_NO_START_OPTIMISE  0x04000000  /* Synonym */
00134 #define PCRE_PARTIAL_HARD       0x08000000  /* Exec, DFA exec */
00135 #define PCRE_NOTEMPTY_ATSTART   0x10000000  /* Exec, DFA exec */
00136 #define PCRE_UCP                0x20000000  /* Compile */
00137 
00138 /* Exec-time and get/set-time error codes */
00139 
00140 #define PCRE_ERROR_NOMATCH         (-1)
00141 #define PCRE_ERROR_NULL            (-2)
00142 #define PCRE_ERROR_BADOPTION       (-3)
00143 #define PCRE_ERROR_BADMAGIC        (-4)
00144 #define PCRE_ERROR_UNKNOWN_OPCODE  (-5)
00145 #define PCRE_ERROR_UNKNOWN_NODE    (-5)  /* For backward compatibility */
00146 #define PCRE_ERROR_NOMEMORY        (-6)
00147 #define PCRE_ERROR_NOSUBSTRING     (-7)
00148 #define PCRE_ERROR_MATCHLIMIT      (-8)
00149 #define PCRE_ERROR_CALLOUT         (-9)  /* Never used by PCRE itself */
00150 #define PCRE_ERROR_BADUTF8        (-10)
00151 #define PCRE_ERROR_BADUTF8_OFFSET (-11)
00152 #define PCRE_ERROR_PARTIAL        (-12)
00153 #define PCRE_ERROR_BADPARTIAL     (-13)
00154 #define PCRE_ERROR_INTERNAL       (-14)
00155 #define PCRE_ERROR_BADCOUNT       (-15)
00156 #define PCRE_ERROR_DFA_UITEM      (-16)
00157 #define PCRE_ERROR_DFA_UCOND      (-17)
00158 #define PCRE_ERROR_DFA_UMLIMIT    (-18)
00159 #define PCRE_ERROR_DFA_WSSIZE     (-19)
00160 #define PCRE_ERROR_DFA_RECURSE    (-20)
00161 #define PCRE_ERROR_RECURSIONLIMIT (-21)
00162 #define PCRE_ERROR_NULLWSLIMIT    (-22)  /* No longer actually used */
00163 #define PCRE_ERROR_BADNEWLINE     (-23)
00164 #define PCRE_ERROR_BADOFFSET      (-24)
00165 #define PCRE_ERROR_SHORTUTF8      (-25)
00166 
00167 /* Request types for pcre_fullinfo() */
00168 
00169 #define PCRE_INFO_OPTIONS            0
00170 #define PCRE_INFO_SIZE               1
00171 #define PCRE_INFO_CAPTURECOUNT       2
00172 #define PCRE_INFO_BACKREFMAX         3
00173 #define PCRE_INFO_FIRSTBYTE          4
00174 #define PCRE_INFO_FIRSTCHAR          4  /* For backwards compatibility */
00175 #define PCRE_INFO_FIRSTTABLE         5
00176 #define PCRE_INFO_LASTLITERAL        6
00177 #define PCRE_INFO_NAMEENTRYSIZE      7
00178 #define PCRE_INFO_NAMECOUNT          8
00179 #define PCRE_INFO_NAMETABLE          9
00180 #define PCRE_INFO_STUDYSIZE         10
00181 #define PCRE_INFO_DEFAULT_TABLES    11
00182 #define PCRE_INFO_OKPARTIAL         12
00183 #define PCRE_INFO_JCHANGED          13
00184 #define PCRE_INFO_HASCRORLF         14
00185 #define PCRE_INFO_MINLENGTH         15
00186 
00187 /* Request types for pcre_config(). Do not re-arrange, in order to remain
00188 compatible. */
00189 
00190 #define PCRE_CONFIG_UTF8                    0
00191 #define PCRE_CONFIG_NEWLINE                 1
00192 #define PCRE_CONFIG_LINK_SIZE               2
00193 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD  3
00194 #define PCRE_CONFIG_MATCH_LIMIT             4
00195 #define PCRE_CONFIG_STACKRECURSE            5
00196 #define PCRE_CONFIG_UNICODE_PROPERTIES      6
00197 #define PCRE_CONFIG_MATCH_LIMIT_RECURSION   7
00198 #define PCRE_CONFIG_BSR                     8
00199 
00200 /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
00201 these bits, just add new ones on the end, in order to remain compatible. */
00202 
00203 #define PCRE_EXTRA_STUDY_DATA             0x0001
00204 #define PCRE_EXTRA_MATCH_LIMIT            0x0002
00205 #define PCRE_EXTRA_CALLOUT_DATA           0x0004
00206 #define PCRE_EXTRA_TABLES                 0x0008
00207 #define PCRE_EXTRA_MATCH_LIMIT_RECURSION  0x0010
00208 #define PCRE_EXTRA_MARK                   0x0020
00209 
00210 /* Types */
00211 
00212 struct real_pcre;                 /* declaration; the definition is private  */
00213 typedef struct real_pcre pcre;
00214 
00215 /* When PCRE is compiled as a C++ library, the subject pointer type can be
00216 replaced with a custom type. For conventional use, the public interface is a
00217 const char *. */
00218 
00219 #ifndef PCRE_SPTR
00220 #define PCRE_SPTR const char *
00221 #endif
00222 
00223 /* The structure for passing additional data to pcre_exec(). This is defined in
00224 such as way as to be extensible. Always add new fields at the end, in order to
00225 remain compatible. */
00226 
00227 typedef struct pcre_extra {
00228   unsigned long int flags;        /* Bits for which fields are set */
00229   void *study_data;               /* Opaque data from pcre_study() */
00230   unsigned long int match_limit;  /* Maximum number of calls to match() */
00231   void *callout_data;             /* Data passed back in callouts */
00232   const unsigned char *tables;    /* Pointer to character tables */
00233   unsigned long int match_limit_recursion; /* Max recursive calls to match() */
00234   unsigned char **mark;           /* For passing back a mark pointer */
00235 } pcre_extra;
00236 
00237 /* The structure for passing out data via the pcre_callout_function. We use a
00238 structure so that new fields can be added on the end in future versions,
00239 without changing the API of the function, thereby allowing old clients to work
00240 without modification. */
00241 
00242 typedef struct pcre_callout_block {
00243   int          version;           /* Identifies version of block */
00244   /* ------------------------ Version 0 ------------------------------- */
00245   int          callout_number;    /* Number compiled into pattern */
00246   int         *offset_vector;     /* The offset vector */
00247   PCRE_SPTR    subject;           /* The subject being matched */
00248   int          subject_length;    /* The length of the subject */
00249   int          start_match;       /* Offset to start of this match attempt */
00250   int          current_position;  /* Where we currently are in the subject */
00251   int          capture_top;       /* Max current capture */
00252   int          capture_last;      /* Most recently closed capture */
00253   void        *callout_data;      /* Data passed in with the call */
00254   /* ------------------- Added for Version 1 -------------------------- */
00255   int          pattern_position;  /* Offset to next item in the pattern */
00256   int          next_item_length;  /* Length of next item in the pattern */
00257   /* ------------------------------------------------------------------ */
00258 } pcre_callout_block;
00259 
00260 /* Indirection for store get and free functions. These can be set to
00261 alternative malloc/free functions if required. Special ones are used in the
00262 non-recursive case for "frames". There is also an optional callout function
00263 that is triggered by the (?) regex item. For Virtual Pascal, these definitions
00264 have to take another form. */
00265 
00266 #ifndef VPCOMPAT
00267 PCRE_EXP_DECL void *(*pcre_malloc)(size_t);
00268 PCRE_EXP_DECL void  (*pcre_free)(void *);
00269 PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t);
00270 PCRE_EXP_DECL void  (*pcre_stack_free)(void *);
00271 PCRE_EXP_DECL int   (*pcre_callout)(pcre_callout_block *);
00272 #else   /* VPCOMPAT */
00273 PCRE_EXP_DECL void *pcre_malloc(size_t);
00274 PCRE_EXP_DECL void  pcre_free(void *);
00275 PCRE_EXP_DECL void *pcre_stack_malloc(size_t);
00276 PCRE_EXP_DECL void  pcre_stack_free(void *);
00277 PCRE_EXP_DECL int   pcre_callout(pcre_callout_block *);
00278 #endif  /* VPCOMPAT */
00279 
00280 /* Exported PCRE functions */
00281 
00282 PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *,
00283                   const unsigned char *);
00284 PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **,
00285                   int *, const unsigned char *);
00286 PCRE_EXP_DECL int  pcre_config(int, void *);
00287 PCRE_EXP_DECL int  pcre_copy_named_substring(const pcre *, const char *,
00288                   int *, int, const char *, char *, int);
00289 PCRE_EXP_DECL int  pcre_copy_substring(const char *, int *, int, int, char *,
00290                   int);
00291 PCRE_EXP_DECL int  pcre_dfa_exec(const pcre *, const pcre_extra *,
00292                   const char *, int, int, int, int *, int , int *, int);
00293 PCRE_EXP_DECL int  pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
00294                    int, int, int, int *, int);
00295 PCRE_EXP_DECL void pcre_free_substring(const char *);
00296 PCRE_EXP_DECL void pcre_free_substring_list(const char **);
00297 PCRE_EXP_DECL int  pcre_fullinfo(const pcre *, const pcre_extra *, int,
00298                   void *);
00299 PCRE_EXP_DECL int  pcre_get_named_substring(const pcre *, const char *,
00300                   int *, int, const char *, const char **);
00301 PCRE_EXP_DECL int  pcre_get_stringnumber(const pcre *, const char *);
00302 PCRE_EXP_DECL int  pcre_get_stringtable_entries(const pcre *, const char *,
00303                   char **, char **);
00304 PCRE_EXP_DECL int  pcre_get_substring(const char *, int *, int, int,
00305                   const char **);
00306 PCRE_EXP_DECL int  pcre_get_substring_list(const char *, int *, int,
00307                   const char ***);
00308 PCRE_EXP_DECL int  pcre_info(const pcre *, int *, int *);
00309 PCRE_EXP_DECL const unsigned char *pcre_maketables(void);
00310 PCRE_EXP_DECL int  pcre_refcount(pcre *, int);
00311 PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **);
00312 PCRE_EXP_DECL const char *pcre_version(void);
00313 
00314 #ifdef __cplusplus
00315 }  /* extern "C" */
00316 #endif
00317 
00318 #endif /* End of pcre.h */