Fix memory bug (could segfault) for $reply_address when Reply-to: is
[exim.git] / src / src / pcre / pcre.h
CommitLineData
8ac170f3
PH
1/* $Cambridge: exim/src/src/pcre/pcre.h,v 1.2 2005/06/15 08:57:10 ph10 Exp $ */
2
c86f6258
PH
3/*************************************************
4* Perl-Compatible Regular Expressions *
5*************************************************/
6
7/* In its original form, this is the .in file that is transformed by
8"configure" into pcre.h.
9
8ac170f3 10 Copyright (c) 1997-2005 University of Cambridge
c86f6258
PH
11
12-----------------------------------------------------------------------------
13Redistribution and use in source and binary forms, with or without
14modification, are permitted provided that the following conditions are met:
15
16 * Redistributions of source code must retain the above copyright notice,
17 this list of conditions and the following disclaimer.
18
19 * Redistributions in binary form must reproduce the above copyright
20 notice, this list of conditions and the following disclaimer in the
21 documentation and/or other materials provided with the distribution.
22
23 * Neither the name of the University of Cambridge nor the names of its
24 contributors may be used to endorse or promote products derived from
25 this software without specific prior written permission.
26
27THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
31LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37POSSIBILITY OF SUCH DAMAGE.
38-----------------------------------------------------------------------------
39*/
40
41#ifndef _PCRE_H
42#define _PCRE_H
43
44/* The file pcre.h is build by "configure". Do not edit it; instead
45make changes to pcre.in. */
46
8ac170f3 47#define PCRE_MAJOR 6
c86f6258 48#define PCRE_MINOR 0
8ac170f3 49#define PCRE_DATE 07-Jun-2005
c86f6258 50
8ac170f3 51/* Win32 uses DLL by default; it needs special stuff for exported functions. */
c86f6258
PH
52
53#ifdef _WIN32
54# ifdef PCRE_DEFINITION
55# ifdef DLL_EXPORT
56# define PCRE_DATA_SCOPE __declspec(dllexport)
57# endif
58# else
59# ifndef PCRE_STATIC
60# define PCRE_DATA_SCOPE extern __declspec(dllimport)
61# endif
62# endif
63#endif
8ac170f3
PH
64
65/* For other operating systems, we use the standard "extern". */
66
c86f6258 67#ifndef PCRE_DATA_SCOPE
8ac170f3
PH
68# ifdef __cplusplus
69# define PCRE_DATA_SCOPE extern "C"
70# else
71# define PCRE_DATA_SCOPE extern
72# endif
c86f6258
PH
73#endif
74
75/* Have to include stdlib.h in order to ensure that size_t is defined;
76it is needed here for malloc. */
77
78#include <stdlib.h>
79
80/* Allow for C++ users */
81
82#ifdef __cplusplus
83extern "C" {
84#endif
85
86/* Options */
87
8ac170f3
PH
88#define PCRE_CASELESS 0x00000001
89#define PCRE_MULTILINE 0x00000002
90#define PCRE_DOTALL 0x00000004
91#define PCRE_EXTENDED 0x00000008
92#define PCRE_ANCHORED 0x00000010
93#define PCRE_DOLLAR_ENDONLY 0x00000020
94#define PCRE_EXTRA 0x00000040
95#define PCRE_NOTBOL 0x00000080
96#define PCRE_NOTEOL 0x00000100
97#define PCRE_UNGREEDY 0x00000200
98#define PCRE_NOTEMPTY 0x00000400
99#define PCRE_UTF8 0x00000800
100#define PCRE_NO_AUTO_CAPTURE 0x00001000
101#define PCRE_NO_UTF8_CHECK 0x00002000
102#define PCRE_AUTO_CALLOUT 0x00004000
103#define PCRE_PARTIAL 0x00008000
104#define PCRE_DFA_SHORTEST 0x00010000
105#define PCRE_DFA_RESTART 0x00020000
106#define PCRE_FIRSTLINE 0x00040000
c86f6258
PH
107
108/* Exec-time and get/set-time error codes */
109
110#define PCRE_ERROR_NOMATCH (-1)
111#define PCRE_ERROR_NULL (-2)
112#define PCRE_ERROR_BADOPTION (-3)
113#define PCRE_ERROR_BADMAGIC (-4)
114#define PCRE_ERROR_UNKNOWN_NODE (-5)
115#define PCRE_ERROR_NOMEMORY (-6)
116#define PCRE_ERROR_NOSUBSTRING (-7)
117#define PCRE_ERROR_MATCHLIMIT (-8)
118#define PCRE_ERROR_CALLOUT (-9) /* Never used by PCRE itself */
119#define PCRE_ERROR_BADUTF8 (-10)
120#define PCRE_ERROR_BADUTF8_OFFSET (-11)
121#define PCRE_ERROR_PARTIAL (-12)
122#define PCRE_ERROR_BADPARTIAL (-13)
123#define PCRE_ERROR_INTERNAL (-14)
124#define PCRE_ERROR_BADCOUNT (-15)
8ac170f3
PH
125#define PCRE_ERROR_DFA_UITEM (-16)
126#define PCRE_ERROR_DFA_UCOND (-17)
127#define PCRE_ERROR_DFA_UMLIMIT (-18)
128#define PCRE_ERROR_DFA_WSSIZE (-19)
129#define PCRE_ERROR_DFA_RECURSE (-20)
c86f6258
PH
130
131/* Request types for pcre_fullinfo() */
132
133#define PCRE_INFO_OPTIONS 0
134#define PCRE_INFO_SIZE 1
135#define PCRE_INFO_CAPTURECOUNT 2
136#define PCRE_INFO_BACKREFMAX 3
137#define PCRE_INFO_FIRSTBYTE 4
138#define PCRE_INFO_FIRSTCHAR 4 /* For backwards compatibility */
139#define PCRE_INFO_FIRSTTABLE 5
140#define PCRE_INFO_LASTLITERAL 6
141#define PCRE_INFO_NAMEENTRYSIZE 7
142#define PCRE_INFO_NAMECOUNT 8
143#define PCRE_INFO_NAMETABLE 9
144#define PCRE_INFO_STUDYSIZE 10
145#define PCRE_INFO_DEFAULT_TABLES 11
146
147/* Request types for pcre_config() */
148
149#define PCRE_CONFIG_UTF8 0
150#define PCRE_CONFIG_NEWLINE 1
151#define PCRE_CONFIG_LINK_SIZE 2
152#define PCRE_CONFIG_POSIX_MALLOC_THRESHOLD 3
153#define PCRE_CONFIG_MATCH_LIMIT 4
154#define PCRE_CONFIG_STACKRECURSE 5
155#define PCRE_CONFIG_UNICODE_PROPERTIES 6
156
157/* Bit flags for the pcre_extra structure */
158
159#define PCRE_EXTRA_STUDY_DATA 0x0001
160#define PCRE_EXTRA_MATCH_LIMIT 0x0002
161#define PCRE_EXTRA_CALLOUT_DATA 0x0004
162#define PCRE_EXTRA_TABLES 0x0008
163
164/* Types */
165
166struct real_pcre; /* declaration; the definition is private */
167typedef struct real_pcre pcre;
168
169/* The structure for passing additional data to pcre_exec(). This is defined in
170such as way as to be extensible. Always add new fields at the end, in order to
171remain compatible. */
172
173typedef struct pcre_extra {
174 unsigned long int flags; /* Bits for which fields are set */
175 void *study_data; /* Opaque data from pcre_study() */
176 unsigned long int match_limit; /* Maximum number of calls to match() */
177 void *callout_data; /* Data passed back in callouts */
178 const unsigned char *tables; /* Pointer to character tables */
179} pcre_extra;
180
181/* The structure for passing out data via the pcre_callout_function. We use a
182structure so that new fields can be added on the end in future versions,
183without changing the API of the function, thereby allowing old clients to work
184without modification. */
185
186typedef struct pcre_callout_block {
187 int version; /* Identifies version of block */
188 /* ------------------------ Version 0 ------------------------------- */
189 int callout_number; /* Number compiled into pattern */
190 int *offset_vector; /* The offset vector */
191 const char *subject; /* The subject being matched */
192 int subject_length; /* The length of the subject */
193 int start_match; /* Offset to start of this match attempt */
194 int current_position; /* Where we currently are in the subject */
195 int capture_top; /* Max current capture */
196 int capture_last; /* Most recently closed capture */
197 void *callout_data; /* Data passed in with the call */
198 /* ------------------- Added for Version 1 -------------------------- */
199 int pattern_position; /* Offset to next item in the pattern */
200 int next_item_length; /* Length of next item in the pattern */
201 /* ------------------------------------------------------------------ */
202} pcre_callout_block;
203
204/* Indirection for store get and free functions. These can be set to
205alternative malloc/free functions if required. Special ones are used in the
206non-recursive case for "frames". There is also an optional callout function
8ac170f3
PH
207that is triggered by the (?) regex item. For Virtual Pascal, these definitions
208have to take another form. */
c86f6258
PH
209
210#ifndef VPCOMPAT
211PCRE_DATA_SCOPE void *(*pcre_malloc)(size_t);
212PCRE_DATA_SCOPE void (*pcre_free)(void *);
213PCRE_DATA_SCOPE void *(*pcre_stack_malloc)(size_t);
214PCRE_DATA_SCOPE void (*pcre_stack_free)(void *);
215PCRE_DATA_SCOPE int (*pcre_callout)(pcre_callout_block *);
216#else /* VPCOMPAT */
8ac170f3
PH
217PCRE_DATA_SCOPE void *pcre_malloc(size_t);
218PCRE_DATA_SCOPE void pcre_free(void *);
219PCRE_DATA_SCOPE void *pcre_stack_malloc(size_t);
220PCRE_DATA_SCOPE void pcre_stack_free(void *);
221PCRE_DATA_SCOPE int pcre_callout(pcre_callout_block *);
c86f6258
PH
222#endif /* VPCOMPAT */
223
224/* Exported PCRE functions */
225
8ac170f3
PH
226PCRE_DATA_SCOPE pcre *pcre_compile(const char *, int, const char **, int *,
227 const unsigned char *);
228PCRE_DATA_SCOPE pcre *pcre_compile2(const char *, int, int *, const char **,
229 int *, const unsigned char *);
230PCRE_DATA_SCOPE int pcre_config(int, void *);
231PCRE_DATA_SCOPE int pcre_copy_named_substring(const pcre *, const char *,
232 int *, int, const char *, char *, int);
233PCRE_DATA_SCOPE int pcre_copy_substring(const char *, int *, int, int, char *,
234 int);
235PCRE_DATA_SCOPE int pcre_dfa_exec(const pcre *, const pcre_extra *,
236 const char *, int, int, int, int *, int , int *, int);
237PCRE_DATA_SCOPE int pcre_exec(const pcre *, const pcre_extra *, const char *,
238 int, int, int, int *, int);
239PCRE_DATA_SCOPE void pcre_free_substring(const char *);
240PCRE_DATA_SCOPE void pcre_free_substring_list(const char **);
241PCRE_DATA_SCOPE int pcre_fullinfo(const pcre *, const pcre_extra *, int,
242 void *);
243PCRE_DATA_SCOPE int pcre_get_named_substring(const pcre *, const char *,
244 int *, int, const char *, const char **);
245PCRE_DATA_SCOPE int pcre_get_stringnumber(const pcre *, const char *);
246PCRE_DATA_SCOPE int pcre_get_substring(const char *, int *, int, int,
247 const char **);
248PCRE_DATA_SCOPE int pcre_get_substring_list(const char *, int *, int,
249 const char ***);
250PCRE_DATA_SCOPE int pcre_info(const pcre *, int *, int *);
251PCRE_DATA_SCOPE const unsigned char *pcre_maketables(void);
252PCRE_DATA_SCOPE int pcre_refcount(pcre *, int);
253PCRE_DATA_SCOPE pcre_extra *pcre_study(const pcre *, int, const char **);
254PCRE_DATA_SCOPE const char *pcre_version(void);
c86f6258
PH
255
256#ifdef __cplusplus
257} /* extern "C" */
258#endif
259
260#endif /* End of pcre.h */