1/*************************************************
2*      Perl-Compatible Regular Expressions       *
3*************************************************/
4
5/* PCRE is a library of functions to support regular expressions whose syntax
6and semantics are as close as possible to those of the Perl 5 language.
7
8                       Written by Philip Hazel
9           Copyright (c) 1997-2010 University of Cambridge
10
11-----------------------------------------------------------------------------
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14
15    * Redistributions of source code must retain the above copyright notice,
16      this list of conditions and the following disclaimer.
17
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.
21
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.
25
26THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
27AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
30LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36POSSIBILITY OF SUCH DAMAGE.
37-----------------------------------------------------------------------------
38*/
39
40
41/* This module is a wrapper that provides a POSIX API to the underlying PCRE
42functions. */
43
44
45#ifdef HAVE_CONFIG_H
46#include "config.h"
47#endif
48
49
50/* Ensure that the PCREPOSIX_EXP_xxx macros are set appropriately for
51compiling these functions. This must come before including pcreposix.h, where
52they are set for an application (using these functions) if they have not
53previously been set. */
54
55#if defined(_WIN32) && !defined(PCRE_STATIC)
56#  define PCREPOSIX_EXP_DECL extern __declspec(dllexport)
57#  define PCREPOSIX_EXP_DEFN __declspec(dllexport)
58#endif
59
60/* We include pcre.h before pcre_internal.h so that the PCRE library functions
61are declared as "import" for Windows by defining PCRE_EXP_DECL as "import".
62This is needed even though pcre_internal.h itself includes pcre.h, because it
63does so after it has set PCRE_EXP_DECL to "export" if it is not already set. */
64
65#include "pcre.h"
66#include "pcre_internal.h"
67#include "pcreposix.h"
68
69
70/* Table to translate PCRE compile time error codes into POSIX error codes. */
71
72static const int eint[] = {
73  0,           /* no error */
74  REG_EESCAPE, /* \ at end of pattern */
75  REG_EESCAPE, /* \c at end of pattern */
76  REG_EESCAPE, /* unrecognized character follows \ */
77  REG_BADBR,   /* numbers out of order in {} quantifier */
78  /* 5 */
79  REG_BADBR,   /* number too big in {} quantifier */
80  REG_EBRACK,  /* missing terminating ] for character class */
81  REG_ECTYPE,  /* invalid escape sequence in character class */
82  REG_ERANGE,  /* range out of order in character class */
83  REG_BADRPT,  /* nothing to repeat */
84  /* 10 */
85  REG_BADRPT,  /* operand of unlimited repeat could match the empty string */
86  REG_ASSERT,  /* internal error: unexpected repeat */
87  REG_BADPAT,  /* unrecognized character after (? */
88  REG_BADPAT,  /* POSIX named classes are supported only within a class */
89  REG_EPAREN,  /* missing ) */
90  /* 15 */
91  REG_ESUBREG, /* reference to non-existent subpattern */
92  REG_INVARG,  /* erroffset passed as NULL */
93  REG_INVARG,  /* unknown option bit(s) set */
94  REG_EPAREN,  /* missing ) after comment */
95  REG_ESIZE,   /* parentheses nested too deeply */
96  /* 20 */
97  REG_ESIZE,   /* regular expression too large */
98  REG_ESPACE,  /* failed to get memory */
99  REG_EPAREN,  /* unmatched parentheses */
100  REG_ASSERT,  /* internal error: code overflow */
101  REG_BADPAT,  /* unrecognized character after (?< */
102  /* 25 */
103  REG_BADPAT,  /* lookbehind assertion is not fixed length */
104  REG_BADPAT,  /* malformed number or name after (?( */
105  REG_BADPAT,  /* conditional group contains more than two branches */
106  REG_BADPAT,  /* assertion expected after (?( */
107  REG_BADPAT,  /* (?R or (?[+-]digits must be followed by ) */
108  /* 30 */
109  REG_ECTYPE,  /* unknown POSIX class name */
110  REG_BADPAT,  /* POSIX collating elements are not supported */
111  REG_INVARG,  /* this version of PCRE is not compiled with PCRE_UTF8 support */
112  REG_BADPAT,  /* spare error */
113  REG_BADPAT,  /* character value in \x{...} sequence is too large */
114  /* 35 */
115  REG_BADPAT,  /* invalid condition (?(0) */
116  REG_BADPAT,  /* \C not allowed in lookbehind assertion */
117  REG_EESCAPE, /* PCRE does not support \L, \l, \N, \U, or \u */
118  REG_BADPAT,  /* number after (?C is > 255 */
119  REG_BADPAT,  /* closing ) for (?C expected */
120  /* 40 */
121  REG_BADPAT,  /* recursive call could loop indefinitely */
122  REG_BADPAT,  /* unrecognized character after (?P */
123  REG_BADPAT,  /* syntax error in subpattern name (missing terminator) */
124  REG_BADPAT,  /* two named subpatterns have the same name */
125  REG_BADPAT,  /* invalid UTF-8 string */
126  /* 45 */
127  REG_BADPAT,  /* support for \P, \p, and \X has not been compiled */
128  REG_BADPAT,  /* malformed \P or \p sequence */
129  REG_BADPAT,  /* unknown property name after \P or \p */
130  REG_BADPAT,  /* subpattern name is too long (maximum 32 characters) */
131  REG_BADPAT,  /* too many named subpatterns (maximum 10,000) */
132  /* 50 */
133  REG_BADPAT,  /* repeated subpattern is too long */
134  REG_BADPAT,  /* octal value is greater than \377 (not in UTF-8 mode) */
135  REG_BADPAT,  /* internal error: overran compiling workspace */
136  REG_BADPAT,  /* internal error: previously-checked referenced subpattern not found */
137  REG_BADPAT,  /* DEFINE group contains more than one branch */
138  /* 55 */
139  REG_BADPAT,  /* repeating a DEFINE group is not allowed */
140  REG_INVARG,  /* inconsistent NEWLINE options */
141  REG_BADPAT,  /* \g is not followed followed by an (optionally braced) non-zero number */
142  REG_BADPAT,  /* a numbered reference must not be zero */
143  REG_BADPAT,  /* an argument is not allowed for (*ACCEPT), (*FAIL), or (*COMMIT) */
144  /* 60 */
145  REG_BADPAT,  /* (*VERB) not recognized */
146  REG_BADPAT,  /* number is too big */
147  REG_BADPAT,  /* subpattern name expected */
148  REG_BADPAT,  /* digit expected after (?+ */
149  REG_BADPAT,  /* ] is an invalid data character in JavaScript compatibility mode */
150  /* 65 */
151  REG_BADPAT,  /* different names for subpatterns of the same number are not allowed */
152  REG_BADPAT,  /* (*MARK) must have an argument */
153  REG_INVARG,  /* this version of PCRE is not compiled with PCRE_UCP support */
154  REG_BADPAT,  /* \c must be followed by an ASCII character */
155};
156
157/* Table of texts corresponding to POSIX error codes */
158
159static const char *const pstring[] = {
160  "",                                /* Dummy for value 0 */
161  "internal error",                  /* REG_ASSERT */
162  "invalid repeat counts in {}",     /* BADBR      */
163  "pattern error",                   /* BADPAT     */
164  "? * + invalid",                   /* BADRPT     */
165  "unbalanced {}",                   /* EBRACE     */
166  "unbalanced []",                   /* EBRACK     */
167  "collation error - not relevant",  /* ECOLLATE   */
168  "bad class",                       /* ECTYPE     */
169  "bad escape sequence",             /* EESCAPE    */
170  "empty expression",                /* EMPTY      */
171  "unbalanced ()",                   /* EPAREN     */
172  "bad range inside []",             /* ERANGE     */
173  "expression too big",              /* ESIZE      */
174  "failed to get memory",            /* ESPACE     */
175  "bad back reference",              /* ESUBREG    */
176  "bad argument",                    /* INVARG     */
177  "match failed"                     /* NOMATCH    */
178};
179
180
181
182
183/*************************************************
184*          Translate error code to string        *
185*************************************************/
186
187PCREPOSIX_EXP_DEFN size_t PCRE_CALL_CONVENTION
188regerror(int errcode, const regex_t *preg, char *errbuf, size_t errbuf_size)
189{
190const char *message, *addmessage;
191size_t length, addlength;
192
193message = (errcode >= (int)(sizeof(pstring)/sizeof(char *)))?
194  "unknown error code" : pstring[errcode];
195length = strlen(message) + 1;
196
197addmessage = " at offset ";
198addlength = (preg != NULL && (int)preg->re_erroffset != -1)?
199  strlen(addmessage) + 6 : 0;
200
201if (errbuf_size > 0)
202  {
203  if (addlength > 0 && errbuf_size >= length + addlength)
204    sprintf(errbuf, "%s%s%-6d", message, addmessage, (int)preg->re_erroffset);
205  else
206    {
207    strncpy(errbuf, message, errbuf_size - 1);
208    errbuf[errbuf_size-1] = 0;
209    }
210  }
211
212return length + addlength;
213}
214
215
216
217
218/*************************************************
219*           Free store held by a regex           *
220*************************************************/
221
222PCREPOSIX_EXP_DEFN void PCRE_CALL_CONVENTION
223regfree(regex_t *preg)
224{
225(pcre_free)(preg->re_pcre);
226}
227
228
229
230
231/*************************************************
232*            Compile a regular expression        *
233*************************************************/
234
235/*
236Arguments:
237  preg        points to a structure for recording the compiled expression
238  pattern     the pattern to compile
239  cflags      compilation flags
240
241Returns:      0 on success
242              various non-zero codes on failure
243*/
244
245PCREPOSIX_EXP_DEFN int PCRE_CALL_CONVENTION
246regcomp(regex_t *preg, const char *pattern, int cflags)
247{
248const char *errorptr;
249int erroffset;
250int errorcode;
251int options = 0;
252
253if ((cflags & REG_ICASE) != 0)    options |= PCRE_CASELESS;
254if ((cflags & REG_NEWLINE) != 0)  options |= PCRE_MULTILINE;
255if ((cflags & REG_DOTALL) != 0)   options |= PCRE_DOTALL;
256if ((cflags & REG_NOSUB) != 0)    options |= PCRE_NO_AUTO_CAPTURE;
257if ((cflags & REG_UTF8) != 0)     options |= PCRE_UTF8;
258if ((cflags & REG_UCP) != 0)      options |= PCRE_UCP;
259if ((cflags & REG_UNGREEDY) != 0) options |= PCRE_UNGREEDY;
260
261preg->re_pcre = pcre_compile2(pattern, options, &errorcode, &errorptr,
262  &erroffset, NULL);
263preg->re_erroffset = erroffset;
264
265/* Safety: if the error code is too big for the translation vector (which
266should not happen, but we all make mistakes), return REG_BADPAT. */
267
268if (preg->re_pcre == NULL)
269  {
270  return (errorcode < sizeof(eint)/sizeof(const int))?
271    eint[errorcode] : REG_BADPAT;
272  }
273
274preg->re_nsub = pcre_info((const pcre *)preg->re_pcre, NULL, NULL);
275return 0;
276}
277
278
279
280
281/*************************************************
282*              Match a regular expression        *
283*************************************************/
284
285/* Unfortunately, PCRE requires 3 ints of working space for each captured
286substring, so we have to get and release working store instead of just using
287the POSIX structures as was done in earlier releases when PCRE needed only 2
288ints. However, if the number of possible capturing brackets is small, use a
289block of store on the stack, to reduce the use of malloc/free. The threshold is
290in a macro that can be changed at configure time.
291
292If REG_NOSUB was specified at compile time, the PCRE_NO_AUTO_CAPTURE flag will
293be set. When this is the case, the nmatch and pmatch arguments are ignored, and
294the only result is yes/no/error. */
295
296PCREPOSIX_EXP_DEFN int PCRE_CALL_CONVENTION
297regexec(const regex_t *preg, const char *string, size_t nmatch,
298  regmatch_t pmatch[], int eflags)
299{
300int rc, so, eo;
301int options = 0;
302int *ovector = NULL;
303int small_ovector[POSIX_MALLOC_THRESHOLD * 3];
304BOOL allocated_ovector = FALSE;
305BOOL nosub =
306  (((const pcre *)preg->re_pcre)->options & PCRE_NO_AUTO_CAPTURE) != 0;
307
308if ((eflags & REG_NOTBOL) != 0) options |= PCRE_NOTBOL;
309if ((eflags & REG_NOTEOL) != 0) options |= PCRE_NOTEOL;
310if ((eflags & REG_NOTEMPTY) != 0) options |= PCRE_NOTEMPTY;
311
312((regex_t *)preg)->re_erroffset = (size_t)(-1);  /* Only has meaning after compile */
313
314/* When no string data is being returned, or no vector has been passed in which
315to put it, ensure that nmatch is zero. Otherwise, ensure the vector for holding
316the return data is large enough. */
317
318if (nosub || pmatch == NULL) nmatch = 0;
319
320else if (nmatch > 0)
321  {
322  if (nmatch <= POSIX_MALLOC_THRESHOLD)
323    {
324    ovector = &(small_ovector[0]);
325    }
326  else
327    {
328    if (nmatch > INT_MAX/(sizeof(int) * 3)) return REG_ESPACE;
329    ovector = (int *)malloc(sizeof(int) * nmatch * 3);
330    if (ovector == NULL) return REG_ESPACE;
331    allocated_ovector = TRUE;
332    }
333  }
334
335/* REG_STARTEND is a BSD extension, to allow for non-NUL-terminated strings.
336The man page from OS X says "REG_STARTEND affects only the location of the
337string, not how it is matched". That is why the "so" value is used to bump the
338start location rather than being passed as a PCRE "starting offset". */
339
340if ((eflags & REG_STARTEND) != 0)
341  {
342  so = pmatch[0].rm_so;
343  eo = pmatch[0].rm_eo;
344  }
345else
346  {
347  so = 0;
348  eo = (int)strlen(string);
349  }
350
351rc = pcre_exec((const pcre *)preg->re_pcre, NULL, string + so, (eo - so),
352  0, options, ovector, (int)(nmatch * 3));
353
354if (rc == 0) rc = (int)nmatch;    /* All captured slots were filled in */
355
356/* Successful match */
357
358if (rc >= 0)
359  {
360  size_t i;
361  if (!nosub)
362    {
363    for (i = 0; i < (size_t)rc; i++)
364      {
365      pmatch[i].rm_so = ovector[i*2];
366      pmatch[i].rm_eo = ovector[i*2+1];
367      }
368    if (allocated_ovector) free(ovector);
369    for (; i < nmatch; i++) pmatch[i].rm_so = pmatch[i].rm_eo = -1;
370    }
371  return 0;
372  }
373
374/* Unsuccessful match */
375
376if (allocated_ovector) free(ovector);
377switch(rc)
378  {
379/* ========================================================================== */
380  /* These cases are never obeyed. This is a fudge that causes a compile-time
381  error if the vector eint, which is indexed by compile-time error number, is
382  not the correct length. It seems to be the only way to do such a check at
383  compile time, as the sizeof() operator does not work in the C preprocessor.
384  As all the PCRE_ERROR_xxx values are negative, we can use 0 and 1. */
385
386  case 0:
387  case (sizeof(eint)/sizeof(int) == ERRCOUNT):
388  return REG_ASSERT;
389/* ========================================================================== */
390
391  case PCRE_ERROR_NOMATCH: return REG_NOMATCH;
392  case PCRE_ERROR_NULL: return REG_INVARG;
393  case PCRE_ERROR_BADOPTION: return REG_INVARG;
394  case PCRE_ERROR_BADMAGIC: return REG_INVARG;
395  case PCRE_ERROR_UNKNOWN_NODE: return REG_ASSERT;
396  case PCRE_ERROR_NOMEMORY: return REG_ESPACE;
397  case PCRE_ERROR_MATCHLIMIT: return REG_ESPACE;
398  case PCRE_ERROR_BADUTF8: return REG_INVARG;
399  case PCRE_ERROR_BADUTF8_OFFSET: return REG_INVARG;
400  default: return REG_ASSERT;
401  }
402}
403
404/* End of pcreposix.c */
405