xref: /freebsd/include/regex.h (revision 6fd05b64b5b65dd4ba9b86482a0634a5f0b96c29)
1 /*-
2  * Copyright (c) 1992 Henry Spencer.
3  * Copyright (c) 1992, 1993
4  *	The Regents of the University of California.  All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * Henry Spencer of the University of Toronto.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by the University of
20  *	California, Berkeley and its contributors.
21  * 4. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * 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 REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)regex.h	8.2 (Berkeley) 1/3/94
38  * $FreeBSD$
39  */
40 
41 #ifndef _REGEX_H_
42 #define	_REGEX_H_
43 
44 #include <sys/cdefs.h>
45 #include <sys/_types.h>
46 
47 /* types */
48 typedef	__off_t		regoff_t;
49 
50 #ifndef _SIZE_T_DECLARED
51 typedef	__size_t	size_t;
52 #define	_SIZE_T_DECLARED
53 #endif
54 
55 typedef struct {
56 	int re_magic;
57 	size_t re_nsub;		/* number of parenthesized subexpressions */
58 	__const char *re_endp;	/* end pointer for REG_PEND */
59 	struct re_guts *re_g;	/* none of your business :-) */
60 } regex_t;
61 
62 typedef struct {
63 	regoff_t rm_so;		/* start of match */
64 	regoff_t rm_eo;		/* end of match */
65 } regmatch_t;
66 
67 /* regcomp() flags */
68 #define	REG_BASIC	0000
69 #define	REG_EXTENDED	0001
70 #define	REG_ICASE	0002
71 #define	REG_NOSUB	0004
72 #define	REG_NEWLINE	0010
73 #define	REG_NOSPEC	0020
74 #define	REG_PEND	0040
75 #define	REG_DUMP	0200
76 
77 /* regerror() flags */
78 #define	REG_ENOSYS	(-1)
79 #define	REG_NOMATCH	 1
80 #define	REG_BADPAT	 2
81 #define	REG_ECOLLATE	 3
82 #define	REG_ECTYPE	 4
83 #define	REG_EESCAPE	 5
84 #define	REG_ESUBREG	 6
85 #define	REG_EBRACK	 7
86 #define	REG_EPAREN	 8
87 #define	REG_EBRACE	 9
88 #define	REG_BADBR	10
89 #define	REG_ERANGE	11
90 #define	REG_ESPACE	12
91 #define	REG_BADRPT	13
92 #define	REG_EMPTY	14
93 #define	REG_ASSERT	15
94 #define	REG_INVARG	16
95 #define	REG_ILLSEQ	17
96 #define	REG_ATOI	255	/* convert name to number (!) */
97 #define	REG_ITOA	0400	/* convert number to name (!) */
98 
99 /* regexec() flags */
100 #define	REG_NOTBOL	00001
101 #define	REG_NOTEOL	00002
102 #define	REG_STARTEND	00004
103 #define	REG_TRACE	00400	/* tracing of execution */
104 #define	REG_LARGE	01000	/* force large representation */
105 #define	REG_BACKR	02000	/* force use of backref code */
106 
107 __BEGIN_DECLS
108 int	regcomp(regex_t * __restrict, const char * __restrict, int);
109 size_t	regerror(int, const regex_t * __restrict, char * __restrict, size_t);
110 /*
111  * XXX forth parameter should be `regmatch_t [__restrict]', but isn't because
112  * of a bug in GCC 3.2 (when -std=c99 is specified) which perceives this as a
113  * syntax error.
114  */
115 int	regexec(const regex_t * __restrict, const char * __restrict, size_t,
116 	    regmatch_t * __restrict, int);
117 void	regfree(regex_t *);
118 __END_DECLS
119 
120 #endif /* !_REGEX_H_ */
121