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

Contents of /code/trunk/pcre.h.in

Parent Directory Parent Directory | Revision Log Revision Log


Revision 145 - (show annotations) (download)
Wed Apr 4 14:06:52 2007 UTC (7 years, 3 months ago) by ph10
File size: 11761 byte(s)
Reworked all the WIN32 __declspec stuff in the hope of getting it right.

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12