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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 835 - (hide annotations) (download)
Wed Dec 28 16:10:09 2011 UTC (2 years, 7 months ago) by ph10
File size: 16089 byte(s)
Rolled back trunk to r755 to prepare for merging the 16-bit branch.

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 ph10 835 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 ph10 835 #define PCRE_DOLLAR_ENDONLY 0x00000020 /* Compile */
109 ph10 553 #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 ph10 835 #define PCRE_UTF8 0x00000800 /* Compile */
115 ph10 553 #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 ph10 835 #define PCRE_FIRSTLINE 0x00040000 /* Compile */
123 ph10 553 #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 ph10 835 #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 ph10 835 #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 676 #define PCRE_ERROR_JIT_STACKLIMIT (-27)
168 ph10 97
169 ph10 598 /* Specific error codes for UTF-8 validity checks */
170    
171     #define PCRE_UTF8_ERR0 0
172     #define PCRE_UTF8_ERR1 1
173     #define PCRE_UTF8_ERR2 2
174     #define PCRE_UTF8_ERR3 3
175     #define PCRE_UTF8_ERR4 4
176     #define PCRE_UTF8_ERR5 5
177     #define PCRE_UTF8_ERR6 6
178     #define PCRE_UTF8_ERR7 7
179     #define PCRE_UTF8_ERR8 8
180     #define PCRE_UTF8_ERR9 9
181     #define PCRE_UTF8_ERR10 10
182     #define PCRE_UTF8_ERR11 11
183     #define PCRE_UTF8_ERR12 12
184     #define PCRE_UTF8_ERR13 13
185     #define PCRE_UTF8_ERR14 14
186     #define PCRE_UTF8_ERR15 15
187     #define PCRE_UTF8_ERR16 16
188     #define PCRE_UTF8_ERR17 17
189     #define PCRE_UTF8_ERR18 18
190     #define PCRE_UTF8_ERR19 19
191     #define PCRE_UTF8_ERR20 20
192     #define PCRE_UTF8_ERR21 21
193    
194 ph10 97 /* Request types for pcre_fullinfo() */
195    
196     #define PCRE_INFO_OPTIONS 0
197     #define PCRE_INFO_SIZE 1
198     #define PCRE_INFO_CAPTURECOUNT 2
199     #define PCRE_INFO_BACKREFMAX 3
200     #define PCRE_INFO_FIRSTBYTE 4
201     #define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */
202     #define PCRE_INFO_FIRSTTABLE 5
203     #define PCRE_INFO_LASTLITERAL 6
204     #define PCRE_INFO_NAMEENTRYSIZE 7
205     #define PCRE_INFO_NAMECOUNT 8
206     #define PCRE_INFO_NAMETABLE 9
207     #define PCRE_INFO_STUDYSIZE 10
208     #define PCRE_INFO_DEFAULT_TABLES 11
209 ph10 169 #define PCRE_INFO_OKPARTIAL 12
210     #define PCRE_INFO_JCHANGED 13
211 ph10 226 #define PCRE_INFO_HASCRORLF 14
212 ph10 455 #define PCRE_INFO_MINLENGTH 15
213 ph10 666 #define PCRE_INFO_JIT 16
214 ph10 97
215     /* Request types for pcre_config(). Do not re-arrange, in order to remain
216     compatible. */
217    
218     #define PCRE_CONFIG_UTF8 0
219     #define PCRE_CONFIG_NEWLINE 1
220     #define PCRE_CONFIG_LINK_SIZE 2
221     #define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3
222     #define PCRE_CONFIG_MATCH_LIMIT 4
223     #define PCRE_CONFIG_STACKRECURSE 5
224     #define PCRE_CONFIG_UNICODE_PROPERTIES 6
225     #define PCRE_CONFIG_MATCH_LIMIT_RECURSION 7
226 ph10 231 #define PCRE_CONFIG_BSR 8
227 ph10 666 #define PCRE_CONFIG_JIT 9
228 ph10 97
229 ph10 666 /* Request types for pcre_study(). Do not re-arrange, in order to remain
230     compatible. */
231    
232     #define PCRE_STUDY_JIT_COMPILE 0x0001
233    
234 ph10 97 /* Bit flags for the pcre_extra structure. Do not re-arrange or redefine
235     these bits, just add new ones on the end, in order to remain compatible. */
236    
237     #define PCRE_EXTRA_STUDY_DATA 0x0001
238     #define PCRE_EXTRA_MATCH_LIMIT 0x0002
239     #define PCRE_EXTRA_CALLOUT_DATA 0x0004
240     #define PCRE_EXTRA_TABLES 0x0008
241     #define PCRE_EXTRA_MATCH_LIMIT_RECURSION 0x0010
242 ph10 510 #define PCRE_EXTRA_MARK 0x0020
243 ph10 666 #define PCRE_EXTRA_EXECUTABLE_JIT 0x0040
244 ph10 97
245     /* Types */
246    
247     struct real_pcre; /* declaration; the definition is private */
248     typedef struct real_pcre pcre;
249    
250 ph10 666 struct real_pcre_jit_stack; /* declaration; the definition is private */
251     typedef struct real_pcre_jit_stack pcre_jit_stack;
252    
253 ph10 97 /* When PCRE is compiled as a C++ library, the subject pointer type can be
254     replaced with a custom type. For conventional use, the public interface is a
255     const char *. */
256    
257     #ifndef PCRE_SPTR
258     #define PCRE_SPTR const char *
259     #endif
260    
261     /* The structure for passing additional data to pcre_exec(). This is defined in
262     such as way as to be extensible. Always add new fields at the end, in order to
263     remain compatible. */
264    
265     typedef struct pcre_extra {
266     unsigned long int flags; /* Bits for which fields are set */
267     void *study_data; /* Opaque data from pcre_study() */
268     unsigned long int match_limit; /* Maximum number of calls to match() */
269     void *callout_data; /* Data passed back in callouts */
270     const unsigned char *tables; /* Pointer to character tables */
271     unsigned long int match_limit_recursion; /* Max recursive calls to match() */
272 ph10 510 unsigned char **mark; /* For passing back a mark pointer */
273 ph10 666 void *executable_jit; /* Contains a pointer to a compiled jit code */
274 ph10 97 } pcre_extra;
275    
276     /* The structure for passing out data via the pcre_callout_function. We use a
277     structure so that new fields can be added on the end in future versions,
278     without changing the API of the function, thereby allowing old clients to work
279     without modification. */
280    
281     typedef struct pcre_callout_block {
282     int version; /* Identifies version of block */
283     /* ------------------------ Version 0 ------------------------------- */
284     int callout_number; /* Number compiled into pattern */
285     int *offset_vector; /* The offset vector */
286     PCRE_SPTR subject; /* The subject being matched */
287     int subject_length; /* The length of the subject */
288     int start_match; /* Offset to start of this match attempt */
289     int current_position; /* Where we currently are in the subject */
290     int capture_top; /* Max current capture */
291     int capture_last; /* Most recently closed capture */
292     void *callout_data; /* Data passed in with the call */
293     /* ------------------- Added for Version 1 -------------------------- */
294     int pattern_position; /* Offset to next item in the pattern */
295     int next_item_length; /* Length of next item in the pattern */
296 ph10 645 /* ------------------- Added for Version 2 -------------------------- */
297 ph10 654 const unsigned char *mark; /* Pointer to current mark or NULL */
298 ph10 97 /* ------------------------------------------------------------------ */
299     } pcre_callout_block;
300    
301     /* Indirection for store get and free functions. These can be set to
302     alternative malloc/free functions if required. Special ones are used in the
303     non-recursive case for "frames". There is also an optional callout function
304     that is triggered by the (?) regex item. For Virtual Pascal, these definitions
305     have to take another form. */
306    
307     #ifndef VPCOMPAT
308 ph10 145 PCRE_EXP_DECL void *(*pcre_malloc)(size_t);
309     PCRE_EXP_DECL void (*pcre_free)(void *);
310     PCRE_EXP_DECL void *(*pcre_stack_malloc)(size_t);
311     PCRE_EXP_DECL void (*pcre_stack_free)(void *);
312     PCRE_EXP_DECL int (*pcre_callout)(pcre_callout_block *);
313 ph10 97 #else /* VPCOMPAT */
314 ph10 145 PCRE_EXP_DECL void *pcre_malloc(size_t);
315     PCRE_EXP_DECL void pcre_free(void *);
316     PCRE_EXP_DECL void *pcre_stack_malloc(size_t);
317     PCRE_EXP_DECL void pcre_stack_free(void *);
318     PCRE_EXP_DECL int pcre_callout(pcre_callout_block *);
319 ph10 97 #endif /* VPCOMPAT */
320    
321 ph10 666 /* User defined callback which provides a stack just before the match starts. */
322    
323     typedef pcre_jit_stack *(*pcre_jit_callback)(void *);
324    
325 ph10 97 /* Exported PCRE functions */
326    
327 ph10 145 PCRE_EXP_DECL pcre *pcre_compile(const char *, int, const char **, int *,
328 ph10 97 const unsigned char *);
329 ph10 145 PCRE_EXP_DECL pcre *pcre_compile2(const char *, int, int *, const char **,
330 ph10 97 int *, const unsigned char *);
331 ph10 145 PCRE_EXP_DECL int pcre_config(int, void *);
332     PCRE_EXP_DECL int pcre_copy_named_substring(const pcre *, const char *,
333 ph10 97 int *, int, const char *, char *, int);
334 ph10 145 PCRE_EXP_DECL int pcre_copy_substring(const char *, int *, int, int, char *,
335 ph10 97 int);
336 ph10 145 PCRE_EXP_DECL int pcre_dfa_exec(const pcre *, const pcre_extra *,
337 ph10 97 const char *, int, int, int, int *, int , int *, int);
338 ph10 145 PCRE_EXP_DECL int pcre_exec(const pcre *, const pcre_extra *, PCRE_SPTR,
339 ph10 97 int, int, int, int *, int);
340 ph10 145 PCRE_EXP_DECL void pcre_free_substring(const char *);
341     PCRE_EXP_DECL void pcre_free_substring_list(const char **);
342     PCRE_EXP_DECL int pcre_fullinfo(const pcre *, const pcre_extra *, int,
343 ph10 97 void *);
344 ph10 145 PCRE_EXP_DECL int pcre_get_named_substring(const pcre *, const char *,
345 ph10 97 int *, int, const char *, const char **);
346 ph10 145 PCRE_EXP_DECL int pcre_get_stringnumber(const pcre *, const char *);
347     PCRE_EXP_DECL int pcre_get_stringtable_entries(const pcre *, const char *,
348 ph10 97 char **, char **);
349 ph10 145 PCRE_EXP_DECL int pcre_get_substring(const char *, int *, int, int,
350 ph10 97 const char **);
351 ph10 145 PCRE_EXP_DECL int pcre_get_substring_list(const char *, int *, int,
352 ph10 97 const char ***);
353 ph10 145 PCRE_EXP_DECL int pcre_info(const pcre *, int *, int *);
354     PCRE_EXP_DECL const unsigned char *pcre_maketables(void);
355     PCRE_EXP_DECL int pcre_refcount(pcre *, int);
356     PCRE_EXP_DECL pcre_extra *pcre_study(const pcre *, int, const char **);
357 ph10 666 PCRE_EXP_DECL void pcre_free_study(pcre_extra *);
358 ph10 145 PCRE_EXP_DECL const char *pcre_version(void);
359 ph10 97
360 ph10 666 /* JIT compiler related functions. */
361    
362     PCRE_EXP_DECL pcre_jit_stack *pcre_jit_stack_alloc(int, int);
363     PCRE_EXP_DECL void pcre_jit_stack_free(pcre_jit_stack *);
364 ph10 675 PCRE_EXP_DECL void pcre_assign_jit_stack(pcre_extra *, pcre_jit_callback, void *);
365 ph10 666
366 ph10 97 #ifdef __cplusplus
367     } /* extern "C" */
368     #endif
369    
370     #endif /* End of pcre.h */

webmaster@exim.org
ViewVC Help
Powered by ViewVC 1.1.12