xref: /freebsd/contrib/nvi/regex/regex2.h (revision 7431dfd4580e850375fe5478d92ec770344db098)
1 /*	$NetBSD: regex2.h,v 1.5 2011/11/23 15:43:39 tnozaki Exp $ */
2 
3 /*-
4  * Copyright (c) 1992, 1993, 1994 Henry Spencer.
5  * Copyright (c) 1992, 1993, 1994
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Henry Spencer of the University of Toronto.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *	This product includes software developed by the University of
22  *	California, Berkeley and its contributors.
23  * 4. Neither the name of the University nor the names of its contributors
24  *    may be used to endorse or promote products derived from this software
25  *    without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37  * SUCH DAMAGE.
38  *
39  *	@(#)regex2.h	8.3 (Berkeley) 3/16/94
40  */
41 
42 /*
43  * First, the stuff that ends up in the outside-world include file
44  = typedef off_t regoff_t;
45  = typedef struct {
46  = 	int re_magic;
47  = 	size_t re_nsub;		// number of parenthesized subexpressions
48  = 	const char *re_endp;	// end pointer for REG_PEND
49  = 	struct re_guts *re_g;	// none of your business :-)
50  = } regex_t;
51  = typedef struct {
52  = 	regoff_t rm_so;		// start of match
53  = 	regoff_t rm_eo;		// end of match
54  = } regmatch_t;
55  */
56 /*
57  * internals of regex_t
58  */
59 #define	MAGIC1	((('r'^0200)<<8) | 'e')
60 
61 /*
62  * The internal representation is a *strip*, a sequence of
63  * operators ending with an endmarker.  (Some terminology etc. is a
64  * historical relic of earlier versions which used multiple strips.)
65  * Certain oddities in the representation are there to permit running
66  * the machinery backwards; in particular, any deviation from sequential
67  * flow must be marked at both its source and its destination.  Some
68  * fine points:
69  *
70  * - OPLUS_ and O_PLUS are *inside* the loop they create.
71  * - OQUEST_ and O_QUEST are *outside* the bypass they create.
72  * - OCH_ and O_CH are *outside* the multi-way branch they create, while
73  *   OOR1 and OOR2 are respectively the end and the beginning of one of
74  *   the branches.  Note that there is an implicit OOR2 following OCH_
75  *   and an implicit OOR1 preceding O_CH.
76  *
77  * In state representations, an operator's bit is on to signify a state
78  * immediately *preceding* "execution" of that operator.
79  */
80 typedef char sop;	/* strip operator */
81 typedef size_t sopno;
82 /* operators			   meaning	operand			*/
83 /*						(back, fwd are offsets)	*/
84 #define	OEND	(1)		/* endmarker	-			*/
85 #define	OCHAR	(2)		/* character	unsigned char		*/
86 #define	OBOL	(3)		/* left anchor	-			*/
87 #define	OEOL	(4)		/* right anchor	-			*/
88 #define	OANY	(5)		/* .		-			*/
89 #define	OANYOF	(6)		/* [...]	set number		*/
90 #define	OBACK_	(7)		/* begin \d	paren number		*/
91 #define	O_BACK	(8)		/* end \d	paren number		*/
92 #define	OPLUS_	(9)		/* + prefix	fwd to suffix		*/
93 #define	O_PLUS	(10)		/* + suffix	back to prefix		*/
94 #define	OQUEST_	(11)		/* ? prefix	fwd to suffix		*/
95 #define	O_QUEST	(12)		/* ? suffix	back to prefix		*/
96 #define	OLPAREN	(13)		/* (		fwd to )		*/
97 #define	ORPAREN	(14)		/* )		back to (		*/
98 #define	OCH_	(15)		/* begin choice	fwd to OOR2		*/
99 #define	OOR1	(16)		/* | pt. 1	back to OOR1 or OCH_	*/
100 #define	OOR2	(17)		/* | pt. 2	fwd to OOR2 or O_CH	*/
101 #define	O_CH	(18)		/* end choice	back to OOR1		*/
102 #define	OBOW	(19)		/* begin word	-			*/
103 #define	OEOW	(20)		/* end word	-			*/
104 
105 /*
106  * Structure for [] character-set representation.  Character sets are
107  * done as bit vectors, grouped 8 to a byte vector for compactness.
108  * The individual set therefore has both a pointer to the byte vector
109  * and a mask to pick out the relevant bit of each byte.  A hash code
110  * simplifies testing whether two sets could be identical.
111  *
112  * This will get trickier for multicharacter collating elements.  As
113  * preliminary hooks for dealing with such things, we also carry along
114  * a string of multi-character elements, and decide the size of the
115  * vectors at run time.
116  */
117 typedef struct {
118 	uch *ptr;		/* -> uch [csetsize] */
119 	uch mask;		/* bit within array */
120 	uch hash;		/* hash code */
121 	size_t smultis;
122 	char *multis;		/* -> char[smulti]  ab\0cd\0ef\0\0 */
123 } cset;
124 /* note that CHadd and CHsub are unsafe, and CHIN doesn't yield 0/1 */
125 #define	CHadd(cs, c)	((cs)->ptr[(uch)(c)] |= (cs)->mask, (cs)->hash += (c))
126 #define	CHsub(cs, c)	((cs)->ptr[(uch)(c)] &= ~(cs)->mask, (cs)->hash -= (c))
127 #define	CHIN(cs, c)	((cs)->ptr[(uch)(c)] & (cs)->mask)
128 #define	MCadd(p, cs, cp)	mcadd(p, cs, cp)	/* regcomp() internal fns */
129 #define	MCsub(p, cs, cp)	mcsub(p, cs, cp)
130 #define	MCin(p, cs, cp)	mcin(p, cs, cp)
131 
132 /* stuff for character categories */
133 typedef RCHAR_T cat_t;
134 
135 /*
136  * main compiled-expression structure
137  */
138 struct re_guts {
139 	int magic;
140 #		define	MAGIC2	((('R'^0200)<<8)|'E')
141 	sop *strip;		/* malloced area for strip */
142 	RCHAR_T *stripdata;	/* malloced area for stripdata */
143 	size_t csetsize;	/* number of bits in a cset vector */
144 	size_t ncsets;		/* number of csets in use */
145 	cset *sets;		/* -> cset [ncsets] */
146 	uch *setbits;		/* -> uch[csetsize][ncsets/CHAR_BIT] */
147 	int cflags;		/* copy of regcomp() cflags argument */
148 	sopno nstates;		/* = number of sops */
149 	sopno firststate;	/* the initial OEND (normally 0) */
150 	sopno laststate;	/* the final OEND */
151 	int iflags;		/* internal flags */
152 #		define	USEBOL	01	/* used ^ */
153 #		define	USEEOL	02	/* used $ */
154 #		define	BAD	04	/* something wrong */
155 	size_t nbol;		/* number of ^ used */
156 	size_t neol;		/* number of $ used */
157 #if 0
158 	size_t ncategories;	/* how many character categories */
159 	cat_t *categories;	/* ->catspace[-CHAR_MIN] */
160 #endif
161 	RCHAR_T *must;		/* match must contain this string */
162 	size_t mlen;		/* length of must */
163 	size_t nsub;		/* copy of re_nsub */
164 	int backrefs;		/* does it use back references? */
165 	sopno nplus;		/* how deep does it nest +s? */
166 	/* catspace must be last */
167 #if 0
168 	cat_t catspace[1];	/* actually [NC] */
169 #endif
170 };
171 
172 /* misc utilities */
173 #define OUT	REOF	/* a non-character value */
174 #define	ISWORD(c) ((c) == '_' || (ISGRAPH((UCHAR_T)c) && !ISPUNCT((UCHAR_T)c)))
175