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. 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 .\"
  34 .Dd June 4, 1993
  35 .Dt RE_COMP 3
  36 .Os
  37 .Sh NAME
  38 .Nm re_comp ,
  39 .Nm re_exec
  40 .Nd regular expression handler
  41 .Sh SYNOPSIS
  42 .Fd #include <unistd.h>
  43 .Ft char *
  44 .Fn re_comp "const char *s"
  45 .Ft int
  46 .Fn re_exec "const char *s"
  47 .Sh DESCRIPTION
  48 This interface is made obsolete by
  49 .Xr regex 3 .
  50 It is available from the compatibility library, libcompat.
  51 .Pp
  52 The
  53 .Fn re_comp
  54 function
  55 compiles a string into an internal form suitable for pattern matching.
  56 The
  57 .Fn re_exec
  58 function
  59 checks the argument string against the last string passed to
  60 .Fn re_comp .
  61 .Pp
  62 The
  63 .Fn re_comp
  64 function
  65 returns 0 if the string
  66 .Fa s
  67 was compiled successfully; otherwise a string containing an
  68 error message is returned. If
  69 .Fn re_comp
  70 is passed 0 or a null string, it returns without changing the currently
  71 compiled regular expression.
  72 .Pp
  73 The
  74 .Fn re_exec
  75 function
  76 returns 1 if the string
  77 .Fa s
  78 matches the last compiled regular expression, 0 if the string
  79 .Fa s
  80 failed to match the last compiled regular expression, and \-1 if the compiled
  81 regular expression was invalid (indicating an internal error).
  82 .Pp
  83 The strings passed to both
  84 .Fn re_comp
  85 and
  86 .Fn re_exec
  87 may have trailing or embedded newline characters;
  88 they are terminated by
  89 .Dv NUL Ns s.
  90 The regular expressions recognized are described in the manual entry for
  91 .Xr ed 1 ,
  92 given the above difference.
  93 .Sh DIAGNOSTICS
  94 The
  95 .Fn re_exec
  96 function
  97 returns \-1 for an internal error.
  98 .Pp
  99 The
 100 .Fn re_comp
 101 function
 102 returns one of the following strings if an error occurs:
 103 .Bd -unfilled -offset indent
 104 No previous regular expression,
 105 Regular expression too long,
 106 unmatched \e(,
 107 missing ],
 108 too many \e(\e) pairs,
 109 unmatched \e).
 110 .Ed
 111 .Sh SEE ALSO
 112 .Xr ed 1 ,
 113 .Xr egrep 1 ,
 114 .Xr ex 1 ,
 115 .Xr fgrep 1 ,
 116 .Xr grep 1 ,
 117 .Xr regex 3
 118 .Sh HISTORY
 119 The
 120 .Fn re_comp
 121 and
 122 .Fn re_exec
 123 functions appeared in
 124 .Bx 4.0 .