1 /*************************************************
2 * Perl-Compatible Regular Expressions *
3 *************************************************/
5 /* PCRE is a library of functions to support regular expressions whose syntax
6 and semantics are as close as possible to those of the Perl 5 language.
8 Written by Philip Hazel
9 Copyright (c) 1997-2009 University of Cambridge
11 -----------------------------------------------------------------------------
12 Redistribution and use in source and binary forms, with or without
13 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright notice,
16 this list of conditions and the following disclaimer.
18 * Redistributions in binary form must reproduce the above copyright
19 notice, this list of conditions and the following disclaimer in the
20 documentation and/or other materials provided with the distribution.
22 * Neither the name of the University of Cambridge nor the names of its
23 contributors may be used to endorse or promote products derived from
24 this software without specific prior written permission.
26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
30 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 POSSIBILITY OF SUCH DAMAGE.
37 -----------------------------------------------------------------------------
41 /* This module is a wrapper that provides a POSIX API to the underlying PCRE
50 /* Ensure that the PCREPOSIX_EXP_xxx macros are set appropriately for
51 compiling these functions. This must come before including pcreposix.h, where
52 they are set for an application (using these functions) if they have not
53 previously been set. */
55 #if defined(_WIN32) && !defined(PCRE_STATIC)
56 # define PCREPOSIX_EXP_DECL extern __declspec(dllexport)
57 # define PCREPOSIX_EXP_DEFN __declspec(dllexport)
61 #include "pcre_internal.h"
62 #include "pcreposix.h"
65 /* Table to translate PCRE compile time error codes into POSIX error codes. */
67 static const int eint[] = {
69 REG_EESCAPE, /* \ at end of pattern */
70 REG_EESCAPE, /* \c at end of pattern */
71 REG_EESCAPE, /* unrecognized character follows \ */
72 REG_BADBR, /* numbers out of order in {} quantifier */
73 REG_BADBR, /* number too big in {} quantifier */
74 REG_EBRACK, /* missing terminating ] for character class */
75 REG_ECTYPE, /* invalid escape sequence in character class */
76 REG_ERANGE, /* range out of order in character class */
77 REG_BADRPT, /* nothing to repeat */
78 REG_BADRPT, /* operand of unlimited repeat could match the empty string */
79 REG_ASSERT, /* internal error: unexpected repeat */
80 REG_BADPAT, /* unrecognized character after (? */
81 REG_BADPAT, /* POSIX named classes are supported only within a class */
82 REG_EPAREN, /* missing ) */
83 REG_ESUBREG, /* reference to non-existent subpattern */
84 REG_INVARG, /* erroffset passed as NULL */
85 REG_INVARG, /* unknown option bit(s) set */
86 REG_EPAREN, /* missing ) after comment */
87 REG_ESIZE, /* parentheses nested too deeply */
88 REG_ESIZE, /* regular expression too large */
89 REG_ESPACE, /* failed to get memory */
90 REG_EPAREN, /* unmatched brackets */
91 REG_ASSERT, /* internal error: code overflow */
92 REG_BADPAT, /* unrecognized character after (?< */
93 REG_BADPAT, /* lookbehind assertion is not fixed length */
94 REG_BADPAT, /* malformed number or name after (?( */
95 REG_BADPAT, /* conditional group contains more than two branches */
96 REG_BADPAT, /* assertion expected after (?( */
97 REG_BADPAT, /* (?R or (?[+-]digits must be followed by ) */
98 REG_ECTYPE, /* unknown POSIX class name */
99 REG_BADPAT, /* POSIX collating elements are not supported */
100 REG_INVARG, /* this version of PCRE is not compiled with PCRE_UTF8 support */
101 REG_BADPAT, /* spare error */
102 REG_BADPAT, /* character value in \x{...} sequence is too large */
103 REG_BADPAT, /* invalid condition (?(0) */
104 REG_BADPAT, /* \C not allowed in lookbehind assertion */
105 REG_EESCAPE, /* PCRE does not support \L, \l, \N, \U, or \u */
106 REG_BADPAT, /* number after (?C is > 255 */
107 REG_BADPAT, /* closing ) for (?C expected */
108 REG_BADPAT, /* recursive call could loop indefinitely */
109 REG_BADPAT, /* unrecognized character after (?P */
110 REG_BADPAT, /* syntax error in subpattern name (missing terminator) */
111 REG_BADPAT, /* two named subpatterns have the same name */
112 REG_BADPAT, /* invalid UTF-8 string */
113 REG_BADPAT, /* support for \P, \p, and \X has not been compiled */
114 REG_BADPAT, /* malformed \P or \p sequence */
115 REG_BADPAT, /* unknown property name after \P or \p */
116 REG_BADPAT, /* subpattern name is too long (maximum 32 characters) */
117 REG_BADPAT, /* too many named subpatterns (maximum 10,000) */
118 REG_BADPAT, /* repeated subpattern is too long */
119 REG_BADPAT, /* octal value is greater than \377 (not in UTF-8 mode) */
120 REG_BADPAT, /* internal error: overran compiling workspace */
121 REG_BADPAT, /* internal error: previously-checked referenced subpattern not found */
122 REG_BADPAT, /* DEFINE group contains more than one branch */
123 REG_BADPAT, /* repeating a DEFINE group is not allowed */
124 REG_INVARG, /* inconsistent NEWLINE options */
125 REG_BADPAT, /* \g is not followed followed by an (optionally braced) non-zero number */
126 REG_BADPAT, /* (?+ or (?- must be followed by a non-zero number */
127 REG_BADPAT, /* number is too big */
128 REG_BADPAT, /* subpattern name expected */
129 REG_BADPAT, /* digit expected after (?+ */
130 REG_BADPAT /* ] is an invalid data character in JavaScript compatibility mode */
133 /* Table of texts corresponding to POSIX error codes */
135 static const char *const pstring[] = {
136 "", /* Dummy for value 0 */
137 "internal error", /* REG_ASSERT */
138 "invalid repeat counts in {}", /* BADBR */
139 "pattern error", /* BADPAT */
140 "? * + invalid", /* BADRPT */
141 "unbalanced {}", /* EBRACE */
142 "unbalanced []", /* EBRACK */
143 "collation error - not relevant", /* ECOLLATE */
144 "bad class", /* ECTYPE */
145 "bad escape sequence", /* EESCAPE */
146 "empty expression", /* EMPTY */
147 "unbalanced ()", /* EPAREN */
148 "bad range inside []", /* ERANGE */
149 "expression too big", /* ESIZE */
150 "failed to get memory", /* ESPACE */
151 "bad back reference", /* ESUBREG */
152 "bad argument", /* INVARG */
153 "match failed" /* NOMATCH */
159 /*************************************************
160 * Translate error code to string *
161 *************************************************/
163 PCREPOSIX_EXP_DEFN size_t PCRE_CALL_CONVENTION
164 regerror(int errcode, const regex_t *preg, char *errbuf, size_t errbuf_size)
166 const char *message, *addmessage;
167 size_t length, addlength;
169 message = (errcode >= (int)(sizeof(pstring)/sizeof(char *)))?
170 "unknown error code" : pstring[errcode];
171 length = strlen(message) + 1;
173 addmessage = " at offset ";
174 addlength = (preg != NULL && (int)preg->re_erroffset != -1)?
175 strlen(addmessage) + 6 : 0;
179 if (addlength > 0 && errbuf_size >= length + addlength)
180 sprintf(errbuf, "%s%s%-6d", message, addmessage, (int)preg->re_erroffset);
183 strncpy(errbuf, message, errbuf_size - 1);
184 errbuf[errbuf_size-1] = 0;
188 return length + addlength;
194 /*************************************************
195 * Free store held by a regex *
196 *************************************************/
198 PCREPOSIX_EXP_DEFN void PCRE_CALL_CONVENTION
199 regfree(regex_t *preg)
201 (pcre_free)(preg->re_pcre);
207 /*************************************************
208 * Compile a regular expression *
209 *************************************************/
213 preg points to a structure for recording the compiled expression
214 pattern the pattern to compile
215 cflags compilation flags
217 Returns: 0 on success
218 various non-zero codes on failure
221 PCREPOSIX_EXP_DEFN int PCRE_CALL_CONVENTION
222 regcomp(regex_t *preg, const char *pattern, int cflags)
224 const char *errorptr;
229 if ((cflags & REG_ICASE) != 0) options |= PCRE_CASELESS;
230 if ((cflags & REG_NEWLINE) != 0) options |= PCRE_MULTILINE;
231 if ((cflags & REG_DOTALL) != 0) options |= PCRE_DOTALL;
232 if ((cflags & REG_NOSUB) != 0) options |= PCRE_NO_AUTO_CAPTURE;
233 if ((cflags & REG_UTF8) != 0) options |= PCRE_UTF8;
235 preg->re_pcre = pcre_compile2(pattern, options, &errorcode, &errorptr,
237 preg->re_erroffset = erroffset;
239 if (preg->re_pcre == NULL) return eint[errorcode];
241 preg->re_nsub = pcre_info((const pcre *)preg->re_pcre, NULL, NULL);
248 /*************************************************
249 * Match a regular expression *
250 *************************************************/
252 /* Unfortunately, PCRE requires 3 ints of working space for each captured
253 substring, so we have to get and release working store instead of just using
254 the POSIX structures as was done in earlier releases when PCRE needed only 2
255 ints. However, if the number of possible capturing brackets is small, use a
256 block of store on the stack, to reduce the use of malloc/free. The threshold is
257 in a macro that can be changed at configure time.
259 If REG_NOSUB was specified at compile time, the PCRE_NO_AUTO_CAPTURE flag will
260 be set. When this is the case, the nmatch and pmatch arguments are ignored, and
261 the only result is yes/no/error. */
263 PCREPOSIX_EXP_DEFN int PCRE_CALL_CONVENTION
264 regexec(const regex_t *preg, const char *string, size_t nmatch,
265 regmatch_t pmatch[], int eflags)
270 int small_ovector[POSIX_MALLOC_THRESHOLD * 3];
271 BOOL allocated_ovector = FALSE;
273 (((const pcre *)preg->re_pcre)->options & PCRE_NO_AUTO_CAPTURE) != 0;
275 if ((eflags & REG_NOTBOL) != 0) options |= PCRE_NOTBOL;
276 if ((eflags & REG_NOTEOL) != 0) options |= PCRE_NOTEOL;
277 if ((eflags & REG_NOTEMPTY) != 0) options |= PCRE_NOTEMPTY;
279 ((regex_t *)preg)->re_erroffset = (size_t)(-1); /* Only has meaning after compile */
281 /* When no string data is being returned, ensure that nmatch is zero.
282 Otherwise, ensure the vector for holding the return data is large enough. */
284 if (nosub) nmatch = 0;
288 if (nmatch <= POSIX_MALLOC_THRESHOLD)
290 ovector = &(small_ovector[0]);
294 if (nmatch > INT_MAX/(sizeof(int) * 3)) return REG_ESPACE;
295 ovector = (int *)malloc(sizeof(int) * nmatch * 3);
296 if (ovector == NULL) return REG_ESPACE;
297 allocated_ovector = TRUE;
301 /* REG_STARTEND is a BSD extension, to allow for non-NUL-terminated strings.
302 The man page from OS X says "REG_STARTEND affects only the location of the
303 string, not how it is matched". That is why the "so" value is used to bump the
304 start location rather than being passed as a PCRE "starting offset". */
306 if ((eflags & REG_STARTEND) != 0)
308 so = pmatch[0].rm_so;
309 eo = pmatch[0].rm_eo;
317 rc = pcre_exec((const pcre *)preg->re_pcre, NULL, string + so, (eo - so),
318 0, options, ovector, nmatch * 3);
320 if (rc == 0) rc = nmatch; /* All captured slots were filled in */
327 for (i = 0; i < (size_t)rc; i++)
329 pmatch[i].rm_so = ovector[i*2];
330 pmatch[i].rm_eo = ovector[i*2+1];
332 if (allocated_ovector) free(ovector);
333 for (; i < nmatch; i++) pmatch[i].rm_so = pmatch[i].rm_eo = -1;
340 if (allocated_ovector) free(ovector);
343 case PCRE_ERROR_NOMATCH: return REG_NOMATCH;
344 case PCRE_ERROR_NULL: return REG_INVARG;
345 case PCRE_ERROR_BADOPTION: return REG_INVARG;
346 case PCRE_ERROR_BADMAGIC: return REG_INVARG;
347 case PCRE_ERROR_UNKNOWN_NODE: return REG_ASSERT;
348 case PCRE_ERROR_NOMEMORY: return REG_ESPACE;
349 case PCRE_ERROR_MATCHLIMIT: return REG_ESPACE;
350 case PCRE_ERROR_BADUTF8: return REG_INVARG;
351 case PCRE_ERROR_BADUTF8_OFFSET: return REG_INVARG;
352 default: return REG_ASSERT;
357 /* End of pcreposix.c */
