Sync usage with man page.
[netbsd-mini2440.git] / dist / nvi / regex / regex.h
blobb48fe5220b6f1ca53a2ded910246dfbba29c0479
1 /* $NetBSD$ */
3 /*-
4 * Copyright (c) 1992 Henry Spencer.
5 * Copyright (c) 1992, 1993
6 * The Regents of the University of California. All rights reserved.
8 * This code is derived from software contributed to Berkeley by
9 * Henry Spencer of the University of Toronto.
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.
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.
39 * @(#)regex.h 8.1 (Berkeley) 6/2/93
42 #ifndef _REGEX_H_
43 #define _REGEX_H_
45 #ifdef __REGEX_PRIVATE
46 #include "config.h"
47 #include "port.h"
48 #include "../common/multibyte.h"
49 #endif
51 /* types */
52 typedef off_t regoff_t;
54 typedef struct {
55 int re_magic;
56 size_t re_nsub; /* number of parenthesized subexpressions */
57 const RCHAR_T *re_endp; /* end pointer for REG_PEND */
58 struct re_guts *re_g; /* none of your business :-) */
59 } regex_t;
61 typedef struct {
62 regoff_t rm_so; /* start of match */
63 regoff_t rm_eo; /* end of match */
64 } regmatch_t;
66 /* regcomp() flags */
67 #define REG_BASIC 0000
68 #define REG_EXTENDED 0001
69 #define REG_ICASE 0002
70 #define REG_NOSUB 0004
71 #define REG_NEWLINE 0010
72 #define REG_NOSPEC 0020
73 #define REG_PEND 0040
74 #define REG_DUMP 0200
76 /* regerror() flags */
77 #define REG_NOMATCH 1
78 #define REG_BADPAT 2
79 #define REG_ECOLLATE 3
80 #define REG_ECTYPE 4
81 #define REG_EESCAPE 5
82 #define REG_ESUBREG 6
83 #define REG_EBRACK 7
84 #define REG_EPAREN 8
85 #define REG_EBRACE 9
86 #define REG_BADBR 10
87 #define REG_ERANGE 11
88 #define REG_ESPACE 12
89 #define REG_BADRPT 13
90 #define REG_EMPTY 14
91 #define REG_ASSERT 15
92 #define REG_INVARG 16
93 #define REG_ATOI 255 /* convert name to number (!) */
94 #define REG_ITOA 0400 /* convert number to name (!) */
96 /* regexec() flags */
97 #define REG_NOTBOL 00001
98 #define REG_NOTEOL 00002
99 #define REG_STARTEND 00004
100 #define REG_TRACE 00400 /* tracing of execution */
101 #define REG_LARGE 01000 /* force large representation */
102 #define REG_BACKR 02000 /* force use of backref code */
104 int regcomp __P((regex_t *, const RCHAR_T *, int));
105 size_t regerror __P((int, const regex_t *, char *, size_t));
106 int regexec __P((const regex_t *,
107 const RCHAR_T *, size_t, regmatch_t [], int));
108 void regfree __P((regex_t *));
110 #endif /* !_REGEX_H_ */