freebsd-skq/lib/libcompat/4.3/re_comp.3

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)re_comp.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd June 4, 1993
.Dt RE_COMP 3
.Os
.Sh NAME
.Nm re_comp ,
.Nm re_exec
.Nd regular expression handler
.Sh LIBRARY
.Lb libcompat
.Sh SYNOPSIS
.In unistd.h
.Ft char *
.Fn re_comp "const char *s"
.Ft int
.Fn re_exec "const char *s"
.Sh DESCRIPTION
.Bf -symbolic
This interface is made obsolete by
.Xr regex 3 .
.Ef
.Pp
The
.Fn re_comp
function
compiles a string into an internal form suitable for pattern matching.
The
.Fn re_exec
function
checks the argument string against the last string passed to
.Fn re_comp .
.Pp
The
.Fn re_comp
function
returns 0 if the string
.Fa s
was compiled successfully; otherwise a string containing an
error message is returned.
If
.Fn re_comp
is passed 0 or a null string, it returns without changing the currently
compiled regular expression.
.Pp
The
.Fn re_exec
function
returns 1 if the string
.Fa s
matches the last compiled regular expression, 0 if the string
.Fa s
failed to match the last compiled regular expression, and \-1 if the compiled
regular expression was invalid (indicating an internal error).
.Pp
The strings passed to both
.Fn re_comp
and
.Fn re_exec
may have trailing or embedded newline characters;
they are terminated by
.Dv NUL Ns s .
The regular expressions recognized are described in the manual entry for
.Xr ed 1 ,
given the above difference.
.Sh DIAGNOSTICS
The
.Fn re_exec
function
returns \-1 for an internal error.
.Pp
The
.Fn re_comp
function
returns
.Dq no previous regular expression
or one of the strings generated by
.Xr regerror 3 .
.Sh SEE ALSO
.Xr ed 1 ,
.Xr egrep 1 ,
.Xr ex 1 ,
.Xr fgrep 1 ,
.Xr grep 1 ,
.Xr regex 3
.Sh HISTORY
The
.Fn re_comp
and
.Fn re_exec
functions appeared in
.Bx 4.0 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1980, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96 2017-02-28 23:42:47 +00:00			`.\" 3. Neither the name of the University nor the names of its contributors`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)re_comp.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
			`.Dd June 4, 1993`
			`.Dt RE_COMP 3`
			`.Os`
			`.Sh NAME`
			`.Nm re_comp ,`
			`.Nm re_exec`
			`.Nd regular expression handler`
Remove text saying "this is available from the compatibility library, libcompat" in favour of a .Sh LIBRARY section using the .Lb macro. Also add .Bf -symbolic around the text saying "this is obsolete" in re_comp.3. PR: 22675 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: sheldonh 2000-11-21 12:03:30 +00:00			`.Sh LIBRARY`
			`.Lb libcompat`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In unistd.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft char *`
			`.Fn re_comp "const char *s"`
			`.Ft int`
			`.Fn re_exec "const char *s"`
			`.Sh DESCRIPTION`
Remove text saying "this is available from the compatibility library, libcompat" in favour of a .Sh LIBRARY section using the .Lb macro. Also add .Bf -symbolic around the text saying "this is obsolete" in re_comp.3. PR: 22675 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: sheldonh 2000-11-21 12:03:30 +00:00			`.Bf -symbolic`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`This interface is made obsolete by`
			`.Xr regex 3 .`
Remove text saying "this is available from the compatibility library, libcompat" in favour of a .Sh LIBRARY section using the .Lb macro. Also add .Bf -symbolic around the text saying "this is obsolete" in re_comp.3. PR: 22675 Submitted by: Mike Meyer <mwm@mired.org> Reviewed by: sheldonh 2000-11-21 12:03:30 +00:00			`.Ef`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Pp`
			`The`
			`.Fn re_comp`
			`function`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`compiles a string into an internal form suitable for pattern matching.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`The`
			`.Fn re_exec`
			`function`
			`checks the argument string against the last string passed to`
			`.Fn re_comp .`
			`.Pp`
			`The`
			`.Fn re_comp`
			`function`
			`returns 0 if the string`
			`.Fa s`
			`was compiled successfully; otherwise a string containing an`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-02 09:14:21 +00:00			`error message is returned.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`If`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fn re_comp`
			`is passed 0 or a null string, it returns without changing the currently`
			`compiled regular expression.`
			`.Pp`
			`The`
			`.Fn re_exec`
			`function`
			`returns 1 if the string`
			`.Fa s`
			`matches the last compiled regular expression, 0 if the string`
			`.Fa s`
			`failed to match the last compiled regular expression, and \-1 if the compiled`
			`regular expression was invalid (indicating an internal error).`
			`.Pp`
			`The strings passed to both`
			`.Fn re_comp`
			`and`
			`.Fn re_exec`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`may have trailing or embedded newline characters;`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`they are terminated by`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Dv NUL Ns s .`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`The regular expressions recognized are described in the manual entry for`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Xr ed 1 ,`
			`given the above difference.`
			`.Sh DIAGNOSTICS`
			`The`
			`.Fn re_exec`
			`function`
			`returns \-1 for an internal error.`
			`.Pp`
			`The`
			`.Fn re_comp`
			`function`
Trim down libcompat by removing <regexp.h>. Erwin ran an exp-run with libcompat and <regexp.h> removed. It turns out the regexp library is almost entirely unused. In fact, it looks like it is sometimes used by accident. Because these function names clash with libc's <regex.h>, some application use both <regex.h> and libcompat, which means they link against the wrong regex library. This commit removes the regexp library and reimplements re_comp() and re_exec() using <regex.h>. It seems the grammar of the regular expressions accepted by these functions is similar to POSIX EREs. After this commit, 1 low-profile port will be broken, but the maintainer already has a patch for it sitting in his mailbox. 2010-03-14 10:18:58 +00:00			`returns`
			`.Dq no previous regular expression`
			`or one of the strings generated by`
			`.Xr regerror 3 .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr ed 1 ,`
			`.Xr egrep 1 ,`
Sort cross references. 1997-01-20 23:23:22 +00:00			`.Xr ex 1 ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Xr fgrep 1 ,`
			`.Xr grep 1 ,`
			`.Xr regex 3`
			`.Sh HISTORY`
			`The`
			`.Fn re_comp`
			`and`
			`.Fn re_exec`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`functions appeared in`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Bx 4.0 .`