/[pcre]/code/trunk/pcre.h
ViewVC logotype

Contents of /code/trunk/pcre.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 91 - (show annotations) (download)
Sat Feb 24 21:41:34 2007 UTC (7 years, 8 months ago) by nigel
File MIME type: text/plain
File size: 12199 byte(s)
Load pcre-6.7 into code/trunk.

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-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 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 6
56 #define PCRE_MINOR 7
57 #define PCRE_PRERELEASE
58 #define PCRE_DATE 04-Jul-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
122 /* Exec-time and get/set-time error codes */
123
124 #define PCRE_ERROR_NOMATCH (-1)
125 #define PCRE_ERROR_NULL (-2)
126 #define PCRE_ERROR_BADOPTION (-3)
127 #define PCRE_ERROR_BADMAGIC (-4)
128 #define PCRE_ERROR_UNKNOWN_NODE (-5)
129 #define PCRE_ERROR_NOMEMORY (-6)
130 #define PCRE_ERROR_NOSUBSTRING (-7)
131 #define PCRE_ERROR_MATCHLIMIT (-8)
132 #define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */
133 #define PCRE_ERROR_BADUTF8 (-10)
134 #define PCRE_ERROR_BADUTF8_OFFSET (-11)
135 #define PCRE_ERROR_PARTIAL (-12)
136 #define PCRE_ERROR_BADPARTIAL (-13)
137 #define PCRE_ERROR_INTERNAL (-14)
138 #define PCRE_ERROR_BADCOUNT (-15)
139 #define PCRE_ERROR_DFA_UITEM (-16)
140 #define PCRE_ERROR_DFA_UCOND (-17)
141 #define PCRE_ERROR_DFA_UMLIMIT (-18)
142 #define PCRE_ERROR_DFA_WSSIZE (-19)
143 #define PCRE_ERROR_DFA_RECURSE (-20)
144 #define PCRE_ERROR_RECURSIONLIMIT (-21)
145
146 /* Request types for pcre_fullinfo() */
147
148 #define PCRE_INFO_OPTIONS 0
149 #define PCRE_INFO_SIZE 1
150 #define PCRE_INFO_CAPTURECOUNT 2
151 #define PCRE_INFO_BACKREFMAX 3
152 #define PCRE_INFO_FIRSTBYTE 4
153 #define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */
154 #define PCRE_INFO_FIRSTTABLE 5
155 #define PCRE_INFO_LASTLITERAL 6
156 #define PCRE_INFO_NAMEENTRYSIZE 7
157 #define PCRE_INFO_NAMECOUNT 8
158 #define PCRE_INFO_NAMETABLE 9
159 #define PCRE_INFO_STUDYSIZE 10
160 #define PCRE_INFO_DEFAULT_TABLES 11
161
162 /* Request types for pcre_config(). Do not re-arrange, in order to remain
163 compatible. */
164
165 #define PCRE_CONFIG_UTF8 0
166 #define PCRE_CONFIG_NEWLINE 1
167 #define PCRE_CONFIG_LINK_SIZE 2
168 #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3
169 #define PCRE_CONFIG_MATCH_LIMIT 4
170 #define PCRE_CONFIG_STACKRECURSE 5
171 #define PCRE_CONFIG_UNICODE_PROPERTIES 6
172 #define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7
173
174 /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
175 these bits, just add new ones on the end, in order to remain compatible. */
176
177 #define PCRE_EXTRA_STUDY_DATA 0x0001
178 #define PCRE_EXTRA_MATCH_LIMIT 0x0002
179 #define PCRE_EXTRA_CALLOUT_DATA 0x0004
180 #define PCRE_EXTRA_TABLES 0x0008
181 #define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010
182
183 /* Types */
184
185 struct real_pcre; /* declaration; the definition is private */
186 typedef struct real_pcre pcre;
187
188 /* When PCRE is compiled as a C++ library, the subject pointer type can be
189 replaced with a custom type. For conventional use, the public interface is a
190 const char *. */
191
192 #ifndef PCRE_SPTR
193 #define PCRE_SPTR const char *
194 #endif
195
196 /* The structure for passing additional data to pcre_exec(). This is defined in
197 such as way as to be extensible. Always add new fields at the end, in order to
198 remain compatible. */
199
200 typedef struct pcre_extra {
201 unsigned long int flags; /* Bits for which fields are set */
202 void *study_data; /* Opaque data from pcre_study() */
203 unsigned long int match_limit; /* Maximum number of calls to match() */
204 void *callout_data; /* Data passed back in callouts */
205 const unsigned char *tables; /* Pointer to character tables */
206 unsigned long int match_limit_recursion; /* Max recursive calls to match() */
207 } pcre_extra;
208
209 /* The structure for passing out data via the pcre_callout_function. We use a
210 structure so that new fields can be added on the end in future versions,
211 without changing the API of the function, thereby allowing old clients to work
212 without modification. */
213
214 typedef struct pcre_callout_block {
215 int version; /* Identifies version of block */
216 /* ------------------------ Version 0 ------------------------------- */
217 int callout_number; /* Number compiled into pattern */
218 int *offset_vector; /* The offset vector */
219 PCRE_SPTR subject; /* The subject being matched */
220 int subject_length; /* The length of the subject */
221 int start_match; /* Offset to start of this match attempt */
222 int current_position; /* Where we currently are in the subject */
223 int capture_top; /* Max current capture */
224 int capture_last; /* Most recently closed capture */
225 void *callout_data; /* Data passed in with the call */
226 /* ------------------- Added for Version 1 -------------------------- */
227 int pattern_position; /* Offset to next item in the pattern */
228 int next_item_length; /* Length of next item in the pattern */
229 /* ------------------------------------------------------------------ */
230 } pcre_callout_block;
231
232 /* Indirection for store get and free functions. These can be set to
233 alternative malloc/free functions if required. Special ones are used in the
234 non-recursive case for "frames". There is also an optional callout function
235 that is triggered by the (?) regex item. For Virtual Pascal, these definitions
236 have to take another form. */
237
238 #ifndef VPCOMPAT
239 PCRE_DATA_SCOPE void *(*pcre_malloc)(size_t);
240 PCRE_DATA_SCOPE void (*pcre_free)(void *);
241 PCRE_DATA_SCOPE void *(*pcre_stack_malloc)(size_t);
242 PCRE_DATA_SCOPE void (*pcre_stack_free)(void *);
243 PCRE_DATA_SCOPE int (*pcre_callout)(pcre_callout_block *);
244 #else /* VPCOMPAT */
245 PCRE_DATA_SCOPE void *pcre_malloc(size_t);
246 PCRE_DATA_SCOPE void pcre_free(void *);
247 PCRE_DATA_SCOPE void *pcre_stack_malloc(size_t);
248 PCRE_DATA_SCOPE void pcre_stack_free(void *);
249 PCRE_DATA_SCOPE int pcre_callout(pcre_callout_block *);
250 #endif /* VPCOMPAT */
251
252 /* Exported PCRE functions */
253
254 PCRE_DATA_SCOPE pcre *pcre_compile(const char *, int, const char **, int *,
255 const unsigned char *);
256 PCRE_DATA_SCOPE pcre *pcre_compile2(const char *, int, int *, const char **,
257 int *, const unsigned char *);
258 PCRE_DATA_SCOPE int pcre_config(int, void *);
259 PCRE_DATA_SCOPE int pcre_copy_named_substring(const pcre *, const char *,
260 int *, int, const char *, char *, int);
261 PCRE_DATA_SCOPE int pcre_copy_substring(const char *, int *, int, int, char *,
262 int);
263 PCRE_DATA_SCOPE int pcre_dfa_exec(const pcre *, const pcre_extra *,
264 const char *, int, int, int, int *, int , int *, int);
265 PCRE_DATA_SCOPE int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
266 int, int, int, int *, int);
267 PCRE_DATA_SCOPE void pcre_free_substring(const char *);
268 PCRE_DATA_SCOPE void pcre_free_substring_list(const char **);
269 PCRE_DATA_SCOPE int pcre_fullinfo(const pcre *, const pcre_extra *, int,
270 void *);
271 PCRE_DATA_SCOPE int pcre_get_named_substring(const pcre *, const char *,
272 int *, int, const char *, const char **);
273 PCRE_DATA_SCOPE int pcre_get_stringnumber(const pcre *, const char *);
274 PCRE_DATA_SCOPE int pcre_get_stringtable_entries(const pcre *, const char *,
275 char **, char **);
276 PCRE_DATA_SCOPE int pcre_get_substring(const char *, int *, int, int,
277 const char **);
278 PCRE_DATA_SCOPE int pcre_get_substring_list(const char *, int *, int,
279 const char ***);
280 PCRE_DATA_SCOPE int pcre_info(const pcre *, int *, int *);
281 PCRE_DATA_SCOPE const unsigned char *pcre_maketables(void);
282 PCRE_DATA_SCOPE int pcre_refcount(pcre *, int);
283 PCRE_DATA_SCOPE pcre_extra *pcre_study(const pcre *, int, const char **);
284 PCRE_DATA_SCOPE const char *pcre_version(void);
285
286 #ifdef __cplusplus
287 } /* extern "C" */
288 #endif
289
290 #endif /* End of pcre.h */

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12