usr/src/man/man3c/re_comp.3c

   1 '\" te
   2 .\"  Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved  Portions Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH RE_COMP 3C "Feb 26, 1997"
  11 .SH NAME
  12 re_comp, re_exec \- compile and execute regular expressions
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <re_comp.h>
  17
  18 \fBchar *\fR\fBre_comp\fR(\fBconst char *\fR\fIstring\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBre_exec\fR(\fBconst char *\fR\fIstring\fR);
  24 .fi
  25
  26 .SH DESCRIPTION
  27 .sp
  28 .LP
  29 The \fBre_comp()\fR function converts a regular expression string (RE) into an
  30 internal form suitable for pattern matching.  The \fBre_exec()\fR function
  31 compares the string pointed to by the \fIstring\fR argument with the last
  32 regular expression passed to \fBre_comp()\fR.
  33 .sp
  34 .LP
  35 If \fBre_comp()\fR is called with a null pointer argument, the current regular
  36 expression remains unchanged.
  37 .sp
  38 .LP
  39 Strings passed to both \fBre_comp()\fR and \fBre_exec()\fR must be terminated
  40 by a null byte, and may include \fBNEWLINE\fR characters.
  41 .sp
  42 .LP
  43 The \fBre_comp()\fR and \fBre_exec()\fR functions support \fIsimple regular
  44 expressions\fR, which are defined on the \fBregexp\fR(5) manual page. The
  45 regular expressions of the form \fB\e{\fRm\fB\e}\fR, \fB\e{\fRm,\fB\e}\fR, or
  46 \fB\e{\fRm,n\fB\e}\fR are not supported.
  47 .SH RETURN VALUES
  48 .sp
  49 .LP
  50 The \fBre_comp()\fR function returns a null pointer when the string pointed to
  51 by the \fIstring\fR argument is successfully converted.  Otherwise, a pointer
  52 to one of the following error message strings is returned:
  53 .sp
  54 .in +2
  55 .nf
  56 No previous regular expression
  57 Regular expression too long
  58 unmatched \e\|(
  59 missing ]
  60 too many \e\|(\|\e\|) pairs
  61 unmatched \e\|)
  62 .fi
  63 .in -2
  64
  65 .sp
  66 .LP
  67 Upon successful completion, \fBre_exec()\fR returns \fB1\fR if \fIstring\fR
  68 matches the last compiled regular expression.  Otherwise, \fBre_exec()\fR
  69 returns \fB0\fR if \fIstring\fR fails to match the last compiled regular
  70 expression, and \fB\(mi1\fR if the compiled regular expression is invalid
  71 (indicating an internal error).
  72 .SH ERRORS
  73 .sp
  74 .LP
  75 No errors are defined.
  76 .SH USAGE
  77 .sp
  78 .LP
  79 For portability to implementations conforming to X/Open standards prior to SUS,
  80 \fBregcomp\fR(3C) and \fBregexec\fR(3C) are preferred to these functions.  See
  81 \fBstandards\fR(5).
  82 .SH SEE ALSO
  83 .sp
  84 .LP
  85 \fBgrep\fR(1), \fBregcmp\fR(1), \fBregcmp\fR(3C), \fBregcomp\fR(3C),
  86 \fBregexec\fR(3C), \fBregexpr\fR(3GEN), \fBregexp\fR(5), \fBstandards\fR(5)