1/*************************************************
2*       Perl-Compatible Regular Expressions      *
3*************************************************/
4
5#ifndef _PCREPOSIX_H
6#define _PCREPOSIX_H
7
8/* This is the header for the POSIX wrapper interface to the PCRE Perl-
9Compatible Regular Expression library. It defines the things POSIX says should
10be there. I hope.
11
12            Copyright (c) 1997-2009 University of Cambridge
13
14-----------------------------------------------------------------------------
15Redistribution and use in source and binary forms, with or without
16modification, are permitted provided that the following conditions are met:
17
18    * Redistributions of source code must retain the above copyright notice,
19      this list of conditions and the following disclaimer.
20
21    * Redistributions in binary form must reproduce the above copyright
22      notice, this list of conditions and the following disclaimer in the
23      documentation and/or other materials provided with the distribution.
24
25    * Neither the name of the University of Cambridge nor the names of its
26      contributors may be used to endorse or promote products derived from
27      this software without specific prior written permission.
28
29THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
30AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
31IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
32ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
33LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39POSSIBILITY OF SUCH DAMAGE.
40-----------------------------------------------------------------------------
41*/
42
43/* Have to include stdlib.h in order to ensure that size_t is defined. */
44
45#include <stdlib.h>
46
47/* Allow for C++ users */
48
49#ifdef __cplusplus
50extern "C" {
51#endif
52
53/* Options, mostly defined by POSIX, but with some extras. */
54
55#define REG_ICASE     0x0001   /* Maps to PCRE_CASELESS */
56#define REG_NEWLINE   0x0002   /* Maps to PCRE_MULTILINE */
57#define REG_NOTBOL    0x0004   /* Maps to PCRE_NOTBOL */
58#define REG_NOTEOL    0x0008   /* Maps to PCRE_NOTEOL */
59#define REG_DOTALL    0x0010   /* NOT defined by POSIX; maps to PCRE_DOTALL */
60#define REG_NOSUB     0x0020   /* Maps to PCRE_NO_AUTO_CAPTURE */
61#define REG_UTF8      0x0040   /* NOT defined by POSIX; maps to PCRE_UTF8 */
62#define REG_STARTEND  0x0080   /* BSD feature: pass subject string by so,eo */
63#define REG_NOTEMPTY  0x0100   /* NOT defined by POSIX; maps to PCRE_NOTEMPTY */
64#define REG_UNGREEDY  0x0200   /* NOT defined by POSIX; maps to PCRE_UNGREEDY */
65
66/* This is not used by PCRE, but by defining it we make it easier
67to slot PCRE into existing programs that make POSIX calls. */
68
69#define REG_EXTENDED  0
70
71/* Error values. Not all these are relevant or used by the wrapper. */
72
73enum {
74  REG_ASSERT = 1,  /* internal error ? */
75  REG_BADBR,       /* invalid repeat counts in {} */
76  REG_BADPAT,      /* pattern error */
77  REG_BADRPT,      /* ? * + invalid */
78  REG_EBRACE,      /* unbalanced {} */
79  REG_EBRACK,      /* unbalanced [] */
80  REG_ECOLLATE,    /* collation error - not relevant */
81  REG_ECTYPE,      /* bad class */
82  REG_EESCAPE,     /* bad escape sequence */
83  REG_EMPTY,       /* empty expression */
84  REG_EPAREN,      /* unbalanced () */
85  REG_ERANGE,      /* bad range inside [] */
86  REG_ESIZE,       /* expression too big */
87  REG_ESPACE,      /* failed to get memory */
88  REG_ESUBREG,     /* bad back reference */
89  REG_INVARG,      /* bad argument */
90  REG_NOMATCH      /* match failed */
91};
92
93
94/* The structure representing a compiled regular expression. */
95
96typedef struct {
97  void *re_pcre;
98  size_t re_nsub;
99  size_t re_erroffset;
100} regex_t;
101
102/* The structure in which a captured offset is returned. */
103
104typedef int regoff_t;
105
106typedef struct {
107  regoff_t rm_so;
108  regoff_t rm_eo;
109} regmatch_t;
110
111/* When an application links to a PCRE DLL in Windows, the symbols that are
112imported have to be identified as such. When building PCRE, the appropriate
113export settings are needed, and are set in pcreposix.c before including this
114file. */
115
116#if defined(_WIN32) && !defined(PCRE_STATIC) && !defined(PCREPOSIX_EXP_DECL)
117#  define PCREPOSIX_EXP_DECL  extern __declspec(dllimport)
118#  define PCREPOSIX_EXP_DEFN  __declspec(dllimport)
119#endif
120
121/* By default, we use the standard "extern" declarations. */
122
123#ifndef PCREPOSIX_EXP_DECL
124#  ifdef __cplusplus
125#    define PCREPOSIX_EXP_DECL  extern "C"
126#    define PCREPOSIX_EXP_DEFN  extern "C"
127#  else
128#    define PCREPOSIX_EXP_DECL  extern
129#    define PCREPOSIX_EXP_DEFN  extern
130#  endif
131#endif
132
133/* The functions */
134
135PCREPOSIX_EXP_DECL int regcomp(regex_t *, const char *, int);
136PCREPOSIX_EXP_DECL int regexec(const regex_t *, const char *, size_t,
137                     regmatch_t *, int);
138PCREPOSIX_EXP_DECL size_t regerror(int, const regex_t *, char *, size_t);
139PCREPOSIX_EXP_DECL void regfree(regex_t *);
140
141#ifdef __cplusplus
142}   /* extern "C" */
143#endif
144
145#endif /* End of pcreposix.h */
146