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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 654 - (hide annotations) (download)
Tue Aug 2 11:00:40 2011 UTC (2 years, 8 months ago) by ph10
File size: 15132 byte(s)
Documentation and general text tidies in preparation for test release.

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 598 Copyright (c) 1997-2011 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 ph10 392 /* Options. Some are compile-time only, some are run-time only, and some are
99 ph10 579 both, so we keep them all distinct. However, almost all the bits in the options
100 ph10 553 word are now used. In the long run, we may have to re-use some of the
101     compile-time only bits for runtime options, or vice versa. */
102 ph10 97
103 ph10 553 #define PCRE_CASELESS 0x00000001 /* Compile */
104     #define PCRE_MULTILINE 0x00000002 /* Compile */
105     #define PCRE_DOTALL 0x00000004 /* Compile */
106     #define PCRE_EXTENDED 0x00000008 /* Compile */
107     #define PCRE_ANCHORED 0x00000010 /* Compile, exec, DFA exec */
108     #define PCRE_DOLLAR_ENDONLY 0x00000020 /* Compile */
109     #define PCRE_EXTRA 0x00000040 /* Compile */
110     #define PCRE_NOTBOL 0x00000080 /* Exec, DFA exec */
111     #define PCRE_NOTEOL 0x00000100 /* Exec, DFA exec */
112     #define PCRE_UNGREEDY 0x00000200 /* Compile */
113     #define PCRE_NOTEMPTY 0x00000400 /* Exec, DFA exec */
114     #define PCRE_UTF8 0x00000800 /* Compile */
115     #define PCRE_NO_AUTO_CAPTURE 0x00001000 /* Compile */
116     #define PCRE_NO_UTF8_CHECK 0x00002000 /* Compile, exec, DFA exec */
117     #define PCRE_AUTO_CALLOUT 0x00004000 /* Compile */
118     #define PCRE_PARTIAL_SOFT 0x00008000 /* Exec, DFA exec */
119 ph10 427 #define PCRE_PARTIAL 0x00008000 /* Backwards compatible synonym */
120 ph10 553 #define PCRE_DFA_SHORTEST 0x00010000 /* DFA exec */
121     #define PCRE_DFA_RESTART 0x00020000 /* DFA exec */
122     #define PCRE_FIRSTLINE 0x00040000 /* Compile */
123     #define PCRE_DUPNAMES 0x00080000 /* Compile */
124     #define PCRE_NEWLINE_CR 0x00100000 /* Compile, exec, DFA exec */
125     #define PCRE_NEWLINE_LF 0x00200000 /* Compile, exec, DFA exec */
126     #define PCRE_NEWLINE_CRLF 0x00300000 /* Compile, exec, DFA exec */
127     #define PCRE_NEWLINE_ANY 0x00400000 /* Compile, exec, DFA exec */
128     #define PCRE_NEWLINE_ANYCRLF 0x00500000 /* Compile, exec, DFA exec */
129     #define PCRE_BSR_ANYCRLF 0x00800000 /* Compile, exec, DFA exec */
130     #define PCRE_BSR_UNICODE 0x01000000 /* Compile, exec, DFA exec */
131     #define PCRE_JAVASCRIPT_COMPAT 0x02000000 /* Compile */
132 ph10 576 #define PCRE_NO_START_OPTIMIZE 0x04000000 /* Compile, exec, DFA exec */
133 ph10 553 #define PCRE_NO_START_OPTIMISE 0x04000000 /* Synonym */
134     #define PCRE_PARTIAL_HARD 0x08000000 /* Exec, DFA exec */
135     #define PCRE_NOTEMPTY_ATSTART 0x10000000 /* Exec, DFA exec */
136     #define PCRE_UCP 0x20000000 /* Compile */
137 ph10 97
138     /* Exec-time and get/set-time error codes */
139    
140     #define PCRE_ERROR_NOMATCH (-1)
141     #define PCRE_ERROR_NULL (-2)
142     #define PCRE_ERROR_BADOPTION (-3)
143     #define PCRE_ERROR_BADMAGIC (-4)
144     #define PCRE_ERROR_UNKNOWN_OPCODE (-5)
145     #define PCRE_ERROR_UNKNOWN_NODE (-5) /* For backward compatibility */
146     #define PCRE_ERROR_NOMEMORY (-6)
147     #define PCRE_ERROR_NOSUBSTRING (-7)
148     #define PCRE_ERROR_MATCHLIMIT (-8)
149     #define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */
150     #define PCRE_ERROR_BADUTF8 (-10)
151     #define PCRE_ERROR_BADUTF8_OFFSET (-11)
152     #define PCRE_ERROR_PARTIAL (-12)
153     #define PCRE_ERROR_BADPARTIAL (-13)
154     #define PCRE_ERROR_INTERNAL (-14)
155     #define PCRE_ERROR_BADCOUNT (-15)
156     #define PCRE_ERROR_DFA_UITEM (-16)
157     #define PCRE_ERROR_DFA_UCOND (-17)
158     #define PCRE_ERROR_DFA_UMLIMIT (-18)
159     #define PCRE_ERROR_DFA_WSSIZE (-19)
160     #define PCRE_ERROR_DFA_RECURSE (-20)
161     #define PCRE_ERROR_RECURSIONLIMIT (-21)
162 ph10 233 #define PCRE_ERROR_NULLWSLIMIT (-22) /* No longer actually used */
163 ph10 97 #define PCRE_ERROR_BADNEWLINE (-23)
164 ph10 567 #define PCRE_ERROR_BADOFFSET (-24)
165 ph10 569 #define PCRE_ERROR_SHORTUTF8 (-25)
166 ph10 642 #define PCRE_ERROR_RECURSELOOP (-26)
167 ph10 97
168 ph10 598 /* Specific error codes for UTF-8 validity checks */
169    
170     #define PCRE_UTF8_ERR0 0
171     #define PCRE_UTF8_ERR1 1
172     #define PCRE_UTF8_ERR2 2
173     #define PCRE_UTF8_ERR3 3
174     #define PCRE_UTF8_ERR4 4
175     #define PCRE_UTF8_ERR5 5
176     #define PCRE_UTF8_ERR6 6
177     #define PCRE_UTF8_ERR7 7
178     #define PCRE_UTF8_ERR8 8
179     #define PCRE_UTF8_ERR9 9
180     #define PCRE_UTF8_ERR10 10
181     #define PCRE_UTF8_ERR11 11
182     #define PCRE_UTF8_ERR12 12
183     #define PCRE_UTF8_ERR13 13
184     #define PCRE_UTF8_ERR14 14
185     #define PCRE_UTF8_ERR15 15
186     #define PCRE_UTF8_ERR16 16
187     #define PCRE_UTF8_ERR17 17
188     #define PCRE_UTF8_ERR18 18
189     #define PCRE_UTF8_ERR19 19
190     #define PCRE_UTF8_ERR20 20
191     #define PCRE_UTF8_ERR21 21
192    
193 ph10 97 /* Request types for pcre_fullinfo() */
194    
195     #define PCRE_INFO_OPTIONS 0
196     #define PCRE_INFO_SIZE 1
197     #define PCRE_INFO_CAPTURECOUNT 2
198     #define PCRE_INFO_BACKREFMAX 3
199     #define PCRE_INFO_FIRSTBYTE 4
200     #define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */
201     #define PCRE_INFO_FIRSTTABLE 5
202     #define PCRE_INFO_LASTLITERAL 6
203     #define PCRE_INFO_NAMEENTRYSIZE 7
204     #define PCRE_INFO_NAMECOUNT 8
205     #define PCRE_INFO_NAMETABLE 9
206     #define PCRE_INFO_STUDYSIZE 10
207     #define PCRE_INFO_DEFAULT_TABLES 11
208 ph10 169 #define PCRE_INFO_OKPARTIAL 12
209     #define PCRE_INFO_JCHANGED 13
210 ph10 226 #define PCRE_INFO_HASCRORLF 14
211 ph10 455 #define PCRE_INFO_MINLENGTH 15
212 ph10 97
213     /* Request types for pcre_config(). Do not re-arrange, in order to remain
214     compatible. */
215    
216     #define PCRE_CONFIG_UTF8 0
217     #define PCRE_CONFIG_NEWLINE 1
218     #define PCRE_CONFIG_LINK_SIZE 2
219     #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3
220     #define PCRE_CONFIG_MATCH_LIMIT 4
221     #define PCRE_CONFIG_STACKRECURSE 5
222     #define PCRE_CONFIG_UNICODE_PROPERTIES 6
223     #define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7
224 ph10 231 #define PCRE_CONFIG_BSR 8
225 ph10 97
226     /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
227     these bits, just add new ones on the end, in order to remain compatible. */
228    
229     #define PCRE_EXTRA_STUDY_DATA 0x0001
230     #define PCRE_EXTRA_MATCH_LIMIT 0x0002
231     #define PCRE_EXTRA_CALLOUT_DATA 0x0004
232     #define PCRE_EXTRA_TABLES 0x0008
233     #define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010
234 ph10 510 #define PCRE_EXTRA_MARK 0x0020
235 ph10 97
236     /* Types */
237    
238     struct real_pcre; /* declaration; the definition is private */
239     typedef struct real_pcre pcre;
240    
241     /* When PCRE is compiled as a C++ library, the subject pointer type can be
242     replaced with a custom type. For conventional use, the public interface is a
243     const char *. */
244    
245     #ifndef PCRE_SPTR
246     #define PCRE_SPTR const char *
247     #endif
248    
249     /* The structure for passing additional data to pcre_exec(). This is defined in
250     such as way as to be extensible. Always add new fields at the end, in order to
251     remain compatible. */
252    
253     typedef struct pcre_extra {
254     unsigned long int flags; /* Bits for which fields are set */
255     void *study_data; /* Opaque data from pcre_study() */
256     unsigned long int match_limit; /* Maximum number of calls to match() */
257     void *callout_data; /* Data passed back in callouts */
258     const unsigned char *tables; /* Pointer to character tables */
259     unsigned long int match_limit_recursion; /* Max recursive calls to match() */
260 ph10 510 unsigned char **mark; /* For passing back a mark pointer */
261 ph10 97 } pcre_extra;
262    
263     /* The structure for passing out data via the pcre_callout_function. We use a
264     structure so that new fields can be added on the end in future versions,
265     without changing the API of the function, thereby allowing old clients to work
266     without modification. */
267    
268     typedef struct pcre_callout_block {
269     int version; /* Identifies version of block */
270     /* ------------------------ Version 0 ------------------------------- */
271     int callout_number; /* Number compiled into pattern */
272     int *offset_vector; /* The offset vector */
273     PCRE_SPTR subject; /* The subject being matched */
274     int subject_length; /* The length of the subject */
275     int start_match; /* Offset to start of this match attempt */
276     int current_position; /* Where we currently are in the subject */
277     int capture_top; /* Max current capture */
278     int capture_last; /* Most recently closed capture */
279     void *callout_data; /* Data passed in with the call */
280     /* ------------------- Added for Version 1 -------------------------- */
281     int pattern_position; /* Offset to next item in the pattern */
282     int next_item_length; /* Length of next item in the pattern */
283 ph10 645 /* ------------------- Added for Version 2 -------------------------- */
284 ph10 654 const unsigned char *mark; /* Pointer to current mark or NULL */
285 ph10 97 /* ------------------------------------------------------------------ */
286     } pcre_callout_block;
287    
288     /* Indirection for store get and free functions. These can be set to
289     alternative malloc/free functions if required. Special ones are used in the
290     non-recursive case for "frames". There is also an optional callout function
291     that is triggered by the (?) regex item. For Virtual Pascal, these definitions
292     have to take another form. */
293    
294     #ifndef VPCOMPAT
295 ph10 145 PCRE_EXP_DECL void *(*pcre_malloc)(size_t);
296     PCRE_EXP_DECL void (*pcre_free)(void *);
297     PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t);
298     PCRE_EXP_DECL void (*pcre_stack_free)(void *);
299     PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *);
300 ph10 97 #else /* VPCOMPAT */
301 ph10 145 PCRE_EXP_DECL void *pcre_malloc(size_t);
302     PCRE_EXP_DECL void pcre_free(void *);
303     PCRE_EXP_DECL void *pcre_stack_malloc(size_t);
304     PCRE_EXP_DECL void pcre_stack_free(void *);
305     PCRE_EXP_DECL int pcre_callout(pcre_callout_block *);
306 ph10 97 #endif /* VPCOMPAT */
307    
308     /* Exported PCRE functions */
309    
310 ph10 145 PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *,
311 ph10 97 const unsigned char *);
312 ph10 145 PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **,
313 ph10 97 int *, const unsigned char *);
314 ph10 145 PCRE_EXP_DECL int pcre_config(int, void *);
315     PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *,
316 ph10 97 int *, int, const char *, char *, int);
317 ph10 145 PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int, char *,
318 ph10 97 int);
319 ph10 145 PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *,
320 ph10 97 const char *, int, int, int, int *, int , int *, int);
321 ph10 145 PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
322 ph10 97 int, int, int, int *, int);
323 ph10 145 PCRE_EXP_DECL void pcre_free_substring(const char *);
324     PCRE_EXP_DECL void pcre_free_substring_list(const char **);
325     PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int,
326 ph10 97 void *);
327 ph10 145 PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *,
328 ph10 97 int *, int, const char *, const char **);
329 ph10 145 PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *);
330     PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *,
331 ph10 97 char **, char **);
332 ph10 145 PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int,
333 ph10 97 const char **);
334 ph10 145 PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int,
335 ph10 97 const char ***);
336 ph10 145 PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *);
337     PCRE_EXP_DECL const unsigned char *pcre_maketables(void);
338     PCRE_EXP_DECL int pcre_refcount(pcre *, int);
339     PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **);
340     PCRE_EXP_DECL const char *pcre_version(void);
341 ph10 97
342     #ifdef __cplusplus
343     } /* extern "C" */
344     #endif
345    
346     #endif /* End of pcre.h */

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12