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

Contents of /code/trunk/pcre.h

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

Name Value
svn:eol-style native
svn:keywords "Author Date Id Revision Url"

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12