xref: /titanic_44/usr/src/man/man3head/regex.h.3head (revision 63ff6dceb8bca4c7bef31895a1286319033330d0)
te
Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
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
http://www.opengroup.org/bookstore/.
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.
This notice shall appear on any product containing this material.
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.
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.
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]
regex.h 3HEAD "9 Sep 2004" "SunOS 5.11" "Headers"
NAME
regex.h, regex - regular expression matching types
SYNOPSIS

#include <regex.h>
DESCRIPTION

The <regex.h> header defines the structures and symbolic constants used by the regcomp(), regexec(), regerror(), and regfree() functions. See regcomp(3C).

The structure type regex_t contains the following member:

size_t re_nsub number of parenthesized subexpressions

The type size_t is defined as described in <sys/types.h>. See types.h(3HEAD).

The type regoff_t is defined as a signed integer type that can hold the largest value that can be stored in either a type off_t or type ssize_t. The structure type regmatch_t contains the following members:

regoff_t rm_so byte offset from start of string to start 
 of substring
regoff_t rm_eo byte offset from start of string of the 
 first character after the end of substring

Values for the cflags parameter to the regcomp function are as follows:

REG_EXTENDED

use extended regular expressions

REG_ICASE

ignore case in match

REG_NOSUB

report only success or fail in regexec()

REG_NEWLINE

change the handling of NEWLINE character

Values for the eflags parameter to the regexec() function are as follows:

REG_NOTBOL

The circumflex character (^), when taken as a special character, does not match the beginning of string.

REG_NOTEOL

The dollar sign ($), when taken as a special character, does not match the end of string.

The following constants are defined as error return values:

REG_NOMATCH

regexec() failed to match.

REG_BADPAT

Invalid regular expression.

REG_ECOLLATE

Invalid collating element referenced.

REG_ECTYPE

Invalid character class type referenced.

REG_EESCAPE

Trailing '\e' in pattern.

REG_ESUBREG

Number in \digit invalid or in error.

REG_EBRACK

"[]" imbalance.

REG_EPAREN

"\e(\e)" or "()" imbalance.

REG_EBRACE

"\{\}" imbalance.

REG_BADBR

Content of "\{\}" invalid: not a number, number too large, more than two numbers, first larger than second.

REG_ERANGE

Invalid endpoint in range expression.

REG_ESPACE

Out of memory.

REG_BADRPT

'?', '*', or '+' not preceded by valid regular expression.

REG_ENOSYS

Reserved.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStandard
SEE ALSO

regcomp(3C), types.h(3HEAD), attributes(5), standards(5)