346 lines
13 KiB
C
346 lines
13 KiB
C
/*************************************************
|
|
* Perl-Compatible Regular Expressions *
|
|
*************************************************/
|
|
|
|
/* This is the public header file for the PCRE library, to be #included by
|
|
applications that call the PCRE functions.
|
|
|
|
Copyright (c) 1997-2008 University of Cambridge
|
|
|
|
-----------------------------------------------------------------------------
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
* Redistributions of source code must retain the above copyright notice,
|
|
this list of conditions and the following disclaimer.
|
|
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
|
|
* Neither the name of the University of Cambridge nor the names of its
|
|
contributors may be used to endorse or promote products derived from
|
|
this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
-----------------------------------------------------------------------------
|
|
*/
|
|
|
|
#ifndef _PCRE_H
|
|
#define _PCRE_H
|
|
|
|
/* The current PCRE version information. */
|
|
|
|
#define PCRE_MAJOR 7
|
|
#define PCRE_MINOR 8
|
|
#define PCRE_PRERELEASE
|
|
#define PCRE_DATE 2008 - 09 - 05
|
|
|
|
/* When an application links to a PCRE DLL in Windows, the symbols that are
|
|
imported have to be identified as such. When building PCRE, the appropriate
|
|
export setting is defined in pcre_internal.h, which includes this file. So we
|
|
don't change existing definitions of PCRE_EXP_DECL and PCRECPP_EXP_DECL. */
|
|
|
|
/**
|
|
* NI CHANGE
|
|
*
|
|
* We don't build the DLL version. We only build the static lib version.
|
|
* Since we don't want to have to #define PCRE_STATIC in every component that
|
|
* includes pcre.h, we're just going to go ahead and define it here.
|
|
*
|
|
* Adam Kemp, 12/15/2008
|
|
*/
|
|
#define PCRE_STATIC
|
|
|
|
#if defined(_WIN32) && !defined(PCRE_STATIC)
|
|
#ifndef PCRE_EXP_DECL
|
|
#define PCRE_EXP_DECL extern __declspec(dllimport)
|
|
#endif
|
|
#ifdef __cplusplus
|
|
#ifndef PCRECPP_EXP_DECL
|
|
#define PCRECPP_EXP_DECL extern __declspec(dllimport)
|
|
#endif
|
|
#ifndef PCRECPP_EXP_DEFN
|
|
#define PCRECPP_EXP_DEFN __declspec(dllimport)
|
|
#endif
|
|
#endif
|
|
#endif
|
|
|
|
/* By default, we use the standard "extern" declarations. */
|
|
|
|
#ifndef PCRE_EXP_DECL
|
|
#ifdef __cplusplus
|
|
#define PCRE_EXP_DECL extern "C"
|
|
#else
|
|
#define PCRE_EXP_DECL extern
|
|
#endif
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
#ifndef PCRECPP_EXP_DECL
|
|
#define PCRECPP_EXP_DECL extern
|
|
#endif
|
|
#ifndef PCRECPP_EXP_DEFN
|
|
#define PCRECPP_EXP_DEFN
|
|
#endif
|
|
#endif
|
|
|
|
/**
|
|
* NI CHANGE
|
|
*
|
|
* We use __cdecl on win32 and the default calling convention elsewhere.
|
|
*
|
|
* Originall this macro did not appear in this file, but it was used in
|
|
* internal headers. I consider it an oversight on the part of the pcre
|
|
* developers that * it was not used in this file. If these functions use
|
|
* specific calling conventions then their prototypes should include that
|
|
* calling convention in case some other project uses a different default.
|
|
*
|
|
* Adam Kemp 12/15/2008
|
|
*/
|
|
#ifndef PCRE_CALL_CONVENTION
|
|
#if defined(_WIN32) /* 32-bit and 64-bit */
|
|
#define PCRE_CALL_CONVENTION __cdecl
|
|
#else
|
|
#define PCRE_CALL_CONVENTION
|
|
#endif
|
|
#else
|
|
#define PCRE_CALL_CONVENTION
|
|
#endif
|
|
|
|
/* Have to include stdlib.h in order to ensure that size_t is defined;
|
|
it is needed here for malloc. */
|
|
|
|
#include <stdlib.h>
|
|
|
|
/* Allow for C++ users */
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Options */
|
|
|
|
#define PCRE_CASELESS 0x00000001
|
|
#define PCRE_MULTILINE 0x00000002
|
|
#define PCRE_DOTALL 0x00000004
|
|
#define PCRE_EXTENDED 0x00000008
|
|
#define PCRE_ANCHORED 0x00000010
|
|
#define PCRE_DOLLAR_ENDONLY 0x00000020
|
|
#define PCRE_EXTRA 0x00000040
|
|
#define PCRE_NOTBOL 0x00000080
|
|
#define PCRE_NOTEOL 0x00000100
|
|
#define PCRE_UNGREEDY 0x00000200
|
|
#define PCRE_NOTEMPTY 0x00000400
|
|
#define PCRE_UTF8 0x00000800
|
|
#define PCRE_NO_AUTO_CAPTURE 0x00001000
|
|
#define PCRE_NO_UTF8_CHECK 0x00002000
|
|
#define PCRE_AUTO_CALLOUT 0x00004000
|
|
#define PCRE_PARTIAL 0x00008000
|
|
#define PCRE_DFA_SHORTEST 0x00010000
|
|
#define PCRE_DFA_RESTART 0x00020000
|
|
#define PCRE_FIRSTLINE 0x00040000
|
|
#define PCRE_DUPNAMES 0x00080000
|
|
#define PCRE_NEWLINE_CR 0x00100000
|
|
#define PCRE_NEWLINE_LF 0x00200000
|
|
#define PCRE_NEWLINE_CRLF 0x00300000
|
|
#define PCRE_NEWLINE_ANY 0x00400000
|
|
#define PCRE_NEWLINE_ANYCRLF 0x00500000
|
|
#define PCRE_BSR_ANYCRLF 0x00800000
|
|
#define PCRE_BSR_UNICODE 0x01000000
|
|
#define PCRE_JAVASCRIPT_COMPAT 0x02000000
|
|
|
|
/* Exec-time and get/set-time error codes */
|
|
|
|
#define PCRE_ERROR_NOMATCH (-1)
|
|
#define PCRE_ERROR_NULL (-2)
|
|
#define PCRE_ERROR_BADOPTION (-3)
|
|
#define PCRE_ERROR_BADMAGIC (-4)
|
|
#define PCRE_ERROR_UNKNOWN_OPCODE (-5)
|
|
#define PCRE_ERROR_UNKNOWN_NODE (-5) /* For backward compatibility */
|
|
#define PCRE_ERROR_NOMEMORY (-6)
|
|
#define PCRE_ERROR_NOSUBSTRING (-7)
|
|
#define PCRE_ERROR_MATCHLIMIT (-8)
|
|
#define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */
|
|
#define PCRE_ERROR_BADUTF8 (-10)
|
|
#define PCRE_ERROR_BADUTF8_OFFSET (-11)
|
|
#define PCRE_ERROR_PARTIAL (-12)
|
|
#define PCRE_ERROR_BADPARTIAL (-13)
|
|
#define PCRE_ERROR_INTERNAL (-14)
|
|
#define PCRE_ERROR_BADCOUNT (-15)
|
|
#define PCRE_ERROR_DFA_UITEM (-16)
|
|
#define PCRE_ERROR_DFA_UCOND (-17)
|
|
#define PCRE_ERROR_DFA_UMLIMIT (-18)
|
|
#define PCRE_ERROR_DFA_WSSIZE (-19)
|
|
#define PCRE_ERROR_DFA_RECURSE (-20)
|
|
#define PCRE_ERROR_RECURSIONLIMIT (-21)
|
|
#define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */
|
|
#define PCRE_ERROR_BADNEWLINE (-23)
|
|
|
|
/* Request types for pcre_fullinfo() */
|
|
|
|
#define PCRE_INFO_OPTIONS 0
|
|
#define PCRE_INFO_SIZE 1
|
|
#define PCRE_INFO_CAPTURECOUNT 2
|
|
#define PCRE_INFO_BACKREFMAX 3
|
|
#define PCRE_INFO_FIRSTBYTE 4
|
|
#define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */
|
|
#define PCRE_INFO_FIRSTTABLE 5
|
|
#define PCRE_INFO_LASTLITERAL 6
|
|
#define PCRE_INFO_NAMEENTRYSIZE 7
|
|
#define PCRE_INFO_NAMECOUNT 8
|
|
#define PCRE_INFO_NAMETABLE 9
|
|
#define PCRE_INFO_STUDYSIZE 10
|
|
#define PCRE_INFO_DEFAULT_TABLES 11
|
|
#define PCRE_INFO_OKPARTIAL 12
|
|
#define PCRE_INFO_JCHANGED 13
|
|
#define PCRE_INFO_HASCRORLF 14
|
|
|
|
/* Request types for pcre_config(). Do not re-arrange, in order to remain
|
|
compatible. */
|
|
|
|
#define PCRE_CONFIG_UTF8 0
|
|
#define PCRE_CONFIG_NEWLINE 1
|
|
#define PCRE_CONFIG_LINK_SIZE 2
|
|
#define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3
|
|
#define PCRE_CONFIG_MATCH_LIMIT 4
|
|
#define PCRE_CONFIG_STACKRECURSE 5
|
|
#define PCRE_CONFIG_UNICODE_PROPERTIES 6
|
|
#define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7
|
|
#define PCRE_CONFIG_BSR 8
|
|
|
|
/* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
|
|
these bits, just add new ones on the end, in order to remain compatible. */
|
|
|
|
#define PCRE_EXTRA_STUDY_DATA 0x0001
|
|
#define PCRE_EXTRA_MATCH_LIMIT 0x0002
|
|
#define PCRE_EXTRA_CALLOUT_DATA 0x0004
|
|
#define PCRE_EXTRA_TABLES 0x0008
|
|
#define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010
|
|
|
|
/* Types */
|
|
|
|
struct real_pcre; /* declaration; the definition is private */
|
|
typedef struct real_pcre pcre;
|
|
|
|
/* When PCRE is compiled as a C++ library, the subject pointer type can be
|
|
replaced with a custom type. For conventional use, the public interface is a
|
|
const char *. */
|
|
|
|
#ifndef PCRE_SPTR
|
|
#define PCRE_SPTR const char *
|
|
#endif
|
|
|
|
/* The structure for passing additional data to pcre_exec(). This is defined in
|
|
such as way as to be extensible. Always add new fields at the end, in order to
|
|
remain compatible. */
|
|
|
|
typedef struct pcre_extra {
|
|
unsigned long int flags; /* Bits for which fields are set */
|
|
void *study_data; /* Opaque data from pcre_study() */
|
|
unsigned long int match_limit; /* Maximum number of calls to match() */
|
|
void *callout_data; /* Data passed back in callouts */
|
|
const unsigned char *tables; /* Pointer to character tables */
|
|
unsigned long int match_limit_recursion; /* Max recursive calls to match() */
|
|
} pcre_extra;
|
|
|
|
/* The structure for passing out data via the pcre_callout_function. We use a
|
|
structure so that new fields can be added on the end in future versions,
|
|
without changing the API of the function, thereby allowing old clients to work
|
|
without modification. */
|
|
|
|
typedef struct pcre_callout_block {
|
|
int version; /* Identifies version of block */
|
|
/* ------------------------ Version 0 ------------------------------- */
|
|
int callout_number; /* Number compiled into pattern */
|
|
int *offset_vector; /* The offset vector */
|
|
PCRE_SPTR subject; /* The subject being matched */
|
|
int subject_length; /* The length of the subject */
|
|
int start_match; /* Offset to start of this match attempt */
|
|
int current_position; /* Where we currently are in the subject */
|
|
int capture_top; /* Max current capture */
|
|
int capture_last; /* Most recently closed capture */
|
|
void *callout_data; /* Data passed in with the call */
|
|
/* ------------------- Added for Version 1 -------------------------- */
|
|
int pattern_position; /* Offset to next item in the pattern */
|
|
int next_item_length; /* Length of next item in the pattern */
|
|
/* ------------------------------------------------------------------ */
|
|
} pcre_callout_block;
|
|
|
|
/* Indirection for store get and free functions. These can be set to
|
|
alternative malloc/free functions if required. Special ones are used in the
|
|
non-recursive case for "frames". There is also an optional callout function
|
|
that is triggered by the (?) regex item. For Virtual Pascal, these definitions
|
|
have to take another form. */
|
|
|
|
#ifndef VPCOMPAT
|
|
PCRE_EXP_DECL void *(PCRE_CALL_CONVENTION *pcre_malloc)(size_t);
|
|
PCRE_EXP_DECL void(PCRE_CALL_CONVENTION *pcre_free)(void *);
|
|
PCRE_EXP_DECL void *(PCRE_CALL_CONVENTION *pcre_stack_malloc)(size_t);
|
|
PCRE_EXP_DECL void(PCRE_CALL_CONVENTION *pcre_stack_free)(void *);
|
|
PCRE_EXP_DECL int(PCRE_CALL_CONVENTION *pcre_callout)(pcre_callout_block *);
|
|
#else /* VPCOMPAT */
|
|
PCRE_EXP_DECL void *PCRE_CALL_CONVENTION pcre_malloc(size_t);
|
|
PCRE_EXP_DECL void PCRE_CALL_CONVENTION pcre_free(void *);
|
|
PCRE_EXP_DECL void *PCRE_CALL_CONVENTION pcre_stack_malloc(size_t);
|
|
PCRE_EXP_DECL void PCRE_CALL_CONVENTION pcre_stack_free(void *);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION pcre_callout(pcre_callout_block *);
|
|
#endif /* VPCOMPAT */
|
|
|
|
/* Exported PCRE functions */
|
|
|
|
PCRE_EXP_DECL pcre *PCRE_CALL_CONVENTION
|
|
pcre_compile(const char *, int, const char **, int *, const unsigned char *);
|
|
PCRE_EXP_DECL pcre *PCRE_CALL_CONVENTION pcre_compile2(const char *, int, int *,
|
|
const char **, int *,
|
|
const unsigned char *);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION pcre_config(int, void *);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_copy_named_substring(const pcre *, const char *, int *, int, const char *,
|
|
char *, int);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_copy_substring(const char *, int *, int, int, char *, int);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_dfa_exec(const pcre *, const pcre_extra *, const char *, int, int, int,
|
|
int *, int, int *, int);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION pcre_exec(const pcre *,
|
|
const pcre_extra *, PCRE_SPTR,
|
|
int, int, int, int *, int);
|
|
PCRE_EXP_DECL void PCRE_CALL_CONVENTION pcre_free_substring(const char *);
|
|
PCRE_EXP_DECL void PCRE_CALL_CONVENTION pcre_free_substring_list(const char **);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_fullinfo(const pcre *, const pcre_extra *, int, void *);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_get_named_substring(const pcre *, const char *, int *, int, const char *,
|
|
const char **);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_get_stringnumber(const pcre *, const char *);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_get_stringtable_entries(const pcre *, const char *, char **, char **);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_get_substring(const char *, int *, int, int, const char **);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION
|
|
pcre_get_substring_list(const char *, int *, int, const char ***);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION pcre_info(const pcre *, int *, int *);
|
|
PCRE_EXP_DECL const unsigned char *PCRE_CALL_CONVENTION pcre_maketables(void);
|
|
PCRE_EXP_DECL int PCRE_CALL_CONVENTION pcre_refcount(pcre *, int);
|
|
PCRE_EXP_DECL pcre_extra *PCRE_CALL_CONVENTION
|
|
pcre_study(const pcre *, int, const char **);
|
|
PCRE_EXP_DECL const char *PCRE_CALL_CONVENTION pcre_version(void);
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /* End of pcre.h */
|