lib/libcompat/4.3/re_comp.3

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