xref: /freebsd/lib/libcompat/4.3/re_comp.3 (revision 4cf49a43559ed9fdad601bdcccd2c55963008675)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)re_comp.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd June 4, 1993
36.Dt RE_COMP 3
37.Os
38.Sh NAME
39.Nm re_comp ,
40.Nm re_exec
41.Nd regular expression handler
42.Sh SYNOPSIS
43.Fd #include <unistd.h>
44.Ft char *
45.Fn re_comp "const char *s"
46.Ft int
47.Fn re_exec "const char *s"
48.Sh DESCRIPTION
49This interface is made obsolete by
50.Xr regex 3 .
51It is available from the compatibility library, libcompat.
52.Pp
53The
54.Fn re_comp
55function
56compiles a string into an internal form suitable for pattern matching.
57The
58.Fn re_exec
59function
60checks the argument string against the last string passed to
61.Fn re_comp .
62.Pp
63The
64.Fn re_comp
65function
66returns 0 if the string
67.Fa s
68was compiled successfully; otherwise a string containing an
69error message is returned. If
70.Fn re_comp
71is passed 0 or a null string, it returns without changing the currently
72compiled regular expression.
73.Pp
74The
75.Fn re_exec
76function
77returns 1 if the string
78.Fa s
79matches the last compiled regular expression, 0 if the string
80.Fa s
81failed to match the last compiled regular expression, and \-1 if the compiled
82regular expression was invalid (indicating an internal error).
83.Pp
84The strings passed to both
85.Fn re_comp
86and
87.Fn re_exec
88may have trailing or embedded newline characters;
89they are terminated by
90.Dv NUL Ns s.
91The regular expressions recognized are described in the manual entry for
92.Xr ed 1 ,
93given the above difference.
94.Sh DIAGNOSTICS
95The
96.Fn re_exec
97function
98returns \-1 for an internal error.
99.Pp
100The
101.Fn re_comp
102function
103returns one of the following strings if an error occurs:
104.Bd -unfilled -offset indent
105No previous regular expression,
106Regular expression too long,
107unmatched \e(,
108missing ],
109too many \e(\e) pairs,
110unmatched \e).
111.Ed
112.Sh SEE ALSO
113.Xr ed 1 ,
114.Xr egrep 1 ,
115.Xr ex 1 ,
116.Xr fgrep 1 ,
117.Xr grep 1 ,
118.Xr regex 3
119.Sh HISTORY
120The
121.Fn re_comp
122and
123.Fn re_exec
124functions appeared in
125.Bx 4.0 .
126