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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 305 - (hide annotations) (download)
Sun Jan 20 20:07:32 2008 UTC (6 years, 7 months ago) by ph10
File size: 12478 byte(s)
Update copyright year to 2008.

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

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12