mirror of
https://github.com/boostorg/regex.git
synced 2025-07-16 05:42:15 +02:00
Tweeked regex version number to reference <boost/version.hpp>
[SVN r11309]
This commit is contained in:
John Maddock
553
posix_ref.htm
553
posix_ref.htm
@ -1,66 +1,74 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//w3c//dtd html 4.0 transitional//en">
|
||||
|
||||
<HTML>
|
||||
|
||||
<HEAD>
|
||||
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
|
||||
<META NAME="Template"
|
||||
CONTENT="C:\PROGRAM FILES\MICROSOFT OFFICE\OFFICE\html.dot">
|
||||
<META NAME="GENERATOR" CONTENT="Mozilla/4.5 [en] (Win98; I) [Netscape]">
|
||||
<TITLE>Regex++, POSIX API Reference</TITLE>
|
||||
</HEAD>
|
||||
<html>
|
||||
|
||||
<BODY BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#800080">
|
||||
<TABLE BORDER="0" CELLSPACING="0" CELLPADDING="7" WIDTH="100%">
|
||||
<TR>
|
||||
<TD VALIGN="TOP" WIDTH="50%"> <H3>
|
||||
<IMG SRC="../../c++boost.gif" HEIGHT="86" WIDTH="276" ALT="C++ Boost"></H3>
|
||||
</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%"> <CENTER>
|
||||
<H3> Regex++, POSIX API Reference.</H3>
|
||||
</CENTER>
|
||||
<CENTER>
|
||||
<I>(version 3.12, 18 April 2000)</I>
|
||||
</CENTER>
|
||||
<PRE><I>Copyright (c) 1998-2000
|
||||
Dr John Maddock
|
||||
<head>
|
||||
<meta http-equiv="Content-Type"
|
||||
content="text/html; charset=iso-8859-1">
|
||||
<meta name="Template"
|
||||
content="C:\PROGRAM FILES\MICROSOFT OFFICE\OFFICE\html.dot">
|
||||
<meta name="GENERATOR" content="Microsoft FrontPage Express 2.0">
|
||||
<title>Regex++, POSIX API Reference</title>
|
||||
</head>
|
||||
|
||||
Permission to use, copy, modify, distribute and sell this software
|
||||
and its documentation for any purpose is hereby granted without fee,
|
||||
provided that the above copyright notice appear in all copies and
|
||||
that both that copyright notice and this permission notice appear
|
||||
in supporting documentation. Dr John Maddock makes no representations
|
||||
about the suitability of this software for any purpose.
|
||||
It is provided "as is" without express or implied warranty.</I></PRE>
|
||||
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
|
||||
|
||||
</TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<HR>
|
||||
<H3> <A NAME="posix"></A><I>POSIX compatibility library</I></H3>
|
||||
<PRE>#include <boost/cregex.hpp>
|
||||
<I>or</I>:
|
||||
#include <boost/regex.h></PRE>
|
||||
<p> </p>
|
||||
|
||||
<P>The following functions are available for users who need a POSIX compatible
|
||||
C library, they are available in both Unicode and narrow character versions,
|
||||
the standard POSIX API names are macros that expand to one version or the other
|
||||
depending upon whether UNICODE is defined or not. </P>
|
||||
<P><B>Important</B>: Note that all the symbols defined here are enclosed inside
|
||||
namespace <I>boost</I> when used in C++ programs, unless you use #include
|
||||
<boost/regex.h> instead - in which case the symbols are still defined in
|
||||
namespace boost, but are made available in the global namespace as well.</P>
|
||||
<P>The functions are defined as: </P>
|
||||
<PRE>extern "C" {
|
||||
<B>int</B> regcompA(regex_tA*, <B>const</B> <B>char</B>*, <B>int</B>);
|
||||
<B>unsigned</B> <B>int</B> regerrorA(<B>int</B>, <B>const</B> regex_tA*, <B>char</B>*, <B>unsigned</B> <B>int</B>);
|
||||
<B>int</B> regexecA(<B>const</B> regex_tA*, <B>const</B> <B>char</B>*, <B>unsigned</B> <B>int</B>, regmatch_t*, <B>int</B>);
|
||||
<B>void</B> regfreeA(regex_tA*);
|
||||
<table border="0" cellpadding="7" cellspacing="0" width="100%">
|
||||
<tr>
|
||||
<td valign="top"><h3><img src="../../c++boost.gif"
|
||||
alt="C++ Boost" width="276" height="86"></h3>
|
||||
</td>
|
||||
<td valign="top"><h3 align="center">Regex++, POSIX API
|
||||
Reference.</h3>
|
||||
<p align="left"><i>(Version 3.20, 29th Sept 2001)</i>
|
||||
</p>
|
||||
<p align="left"><i>Copyright (c) 1998-2001 </i></p>
|
||||
<p align="left"><i>Dr John Maddock</i></p>
|
||||
<p align="left"><i>Permission to use, copy, modify,
|
||||
distribute and sell this software and its documentation
|
||||
for any purpose is hereby granted without fee, provided
|
||||
that the above copyright notice appear in all copies and
|
||||
that both that copyright notice and this permission
|
||||
notice appear in supporting documentation. Dr John
|
||||
Maddock makes no representations about the suitability of
|
||||
this software for any purpose. It is provided "as is"
|
||||
without express or implied warranty.</i></p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<B>int</B> regcompW(regex_tW*, <B>const</B> <B>wchar_t</B>*, <B>int</B>);
|
||||
<B>unsigned</B> <B>int</B> regerrorW(<B>int</B>, <B>const</B> regex_tW*, <B>wchar_t</B>*, <B>unsigned</B> <B>int</B>);
|
||||
<B>int</B> regexecW(<B>const</B> regex_tW*, <B>const</B> <B>wchar_t</B>*, <B>unsigned</B> <B>int</B>, regmatch_t*, <B>int</B>);
|
||||
<B>void</B> regfreeW(regex_tW*);
|
||||
<hr>
|
||||
|
||||
<h3><a name="posix"></a><i>POSIX compatibility library</i></h3>
|
||||
|
||||
<pre>#include <boost/cregex.hpp>
|
||||
<i>or</i>:
|
||||
#include <boost/regex.h></pre>
|
||||
|
||||
<p>The following functions are available for users who need a
|
||||
POSIX compatible C library, they are available in both Unicode
|
||||
and narrow character versions, the standard POSIX API names are
|
||||
macros that expand to one version or the other depending upon
|
||||
whether UNICODE is defined or not. </p>
|
||||
|
||||
<p><b>Important</b>: Note that all the symbols defined here are
|
||||
enclosed inside namespace <i>boost</i> when used in C++ programs,
|
||||
unless you use #include <boost/regex.h> instead - in which
|
||||
case the symbols are still defined in namespace boost, but are
|
||||
made available in the global namespace as well.</p>
|
||||
|
||||
<p>The functions are defined as: </p>
|
||||
|
||||
<pre>extern "C" {
|
||||
<b>int</b> regcompA(regex_tA*, <b>const</b> <b>char</b>*, <b>int</b>);
|
||||
<b>unsigned</b> <b>int</b> regerrorA(<b>int</b>, <b>const</b> regex_tA*, <b>char</b>*, <b>unsigned</b> <b>int</b>);
|
||||
<b>int</b> regexecA(<b>const</b> regex_tA*, <b>const</b> <b>char</b>*, <b>unsigned</b> <b>int</b>, regmatch_t*, <b>int</b>);
|
||||
<b>void</b> regfreeA(regex_tA*);
|
||||
|
||||
<b>int</b> regcompW(regex_tW*, <b>const</b> <b>wchar_t</b>*, <b>int</b>);
|
||||
<b>unsigned</b> <b>int</b> regerrorW(<b>int</b>, <b>const</b> regex_tW*, <b>wchar_t</b>*, <b>unsigned</b> <b>int</b>);
|
||||
<b>int</b> regexecW(<b>const</b> regex_tW*, <b>const</b> <b>wchar_t</b>*, <b>unsigned</b> <b>int</b>, regmatch_t*, <b>int</b>);
|
||||
<b>void</b> regfreeW(regex_tW*);
|
||||
|
||||
#ifdef UNICODE
|
||||
#define regcomp regcompW
|
||||
@ -75,203 +83,234 @@ namespace boost, but are made available in the global namespace as well.</P>
|
||||
#define regfree regfreeA
|
||||
#define regex_t regex_tA
|
||||
#endif
|
||||
}</PRE>
|
||||
All the functions operate on structure <B>regex_t</B>, which exposes two public
|
||||
members:
|
||||
<P><B>unsigned int re_nsub</B> this is filled in by <B>regcomp</B> and
|
||||
indicates the number of sub-expressions contained in the regular expression.
|
||||
</P>
|
||||
<P><B>const TCHAR* re_endp</B> points to the end of the expression to compile
|
||||
when the flag REG_PEND is set. </P>
|
||||
<P><I>Footnote: regex_t is actually a #define - it is either regex_tA or
|
||||
regex_tW depending upon whether UNICODE is defined or not, TCHAR is either char
|
||||
or wchar_t again depending upon the macro UNICODE.</I> </P>
|
||||
<P><B>regcomp</B> takes a pointer to a <B>regex_t</B>, a pointer to the
|
||||
expression to compile and a flags parameter which can be a combination of: <BR>
|
||||
</P>
|
||||
<TABLE BORDER="0" CELLSPACING="0" CELLPADDING="7" WIDTH="100%">
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_EXTENDED</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">Compiles modern regular expressions. Equivalent to
|
||||
regbase::char_classes | regbase::intervals | regbase::bk_refs.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_BASIC</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">Compiles basic (obsolete) regular expression
|
||||
syntax. Equivalent to regbase::char_classes | regbase::intervals |
|
||||
regbase::limited_ops | regbase::bk_braces | regbase::bk_parens |
|
||||
regbase::bk_refs.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_NOSPEC</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">All characters are ordinary, the expression is a
|
||||
literal string.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_ICASE</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">Compiles for matching that ignores character
|
||||
case.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_NOSUB</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">Has no effect in this library.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_NEWLINE</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">When this flag is set a dot does not match the
|
||||
newline character.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_PEND</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">When this flag is set the re_endp parameter of the
|
||||
regex_t structure must point to the end of the regular expression to
|
||||
compile.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_NOCOLLATE</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">When this flag is set then locale dependent
|
||||
collation for character ranges is turned off.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_ESCAPE_IN_LISTS<BR>
|
||||
, , , </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">When this flag is set, then escape sequences are
|
||||
permitted in bracket expressions (character sets).</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_NEWLINE_ALT </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">When this flag is set then the newline character
|
||||
is equivalent to the alternation operator |.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_PERL </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%"> A shortcut for perl-like behavior:
|
||||
REG_EXTENDED | REG_NOCOLLATE | REG_ESCAPE_IN_LISTS</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_AWK</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">A shortcut for awk-like behavior: REG_EXTENDED |
|
||||
REG_ESCAPE_IN_LISTS</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_GREP</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">A shortcut for grep like behavior: REG_BASIC |
|
||||
REG_NEWLINE_ALT</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%">REG_EGREP</TD>
|
||||
<TD VALIGN="TOP" WIDTH="45%"> A shortcut for egrep like behavior:
|
||||
REG_EXTENDED | REG_NEWLINE_ALT</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<BR>
|
||||
<P><B>regerror</B> takes the following parameters, it maps an error code
|
||||
to a human readable string: <BR>
|
||||
</P>
|
||||
<TABLE BORDER="0" CELLSPACING="0" CELLPADDING="7" WIDTH="100%">
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">int code</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">The error code.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">const regex_t* e</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">The regular expression (can be null).</TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">char* buf</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">The buffer to fill in with the error message.</TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">unsigned int buf_size</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">The length of buf.</TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<P>If the error code is OR'ed with REG_ITOA then the message that results is
|
||||
the printable name of the code rather than a message, for example
|
||||
"REG_BADPAT". If the code is REG_ATIO then <B>e</B> must not be null
|
||||
and <B>e->re_pend</B> must point to the printable name of an error code, the
|
||||
return value is then the value of the error code. For any other value of
|
||||
<B>code</B>, the return value is the number of characters in the error message,
|
||||
if the return value is greater than or equal to <B>buf_size</B> then
|
||||
<B>regerror</B> will have to be called again with a larger buffer.</P>
|
||||
<P><B>regexec</B> finds the first occurrence of expression <B>e</B> within
|
||||
string <B>buf</B>. If <B>len</B> is non-zero then *<B>m</B> is filled in with
|
||||
what matched the regular expression, <B>m[0]</B> contains what matched the
|
||||
whole string, <B>m[1] </B>the first sub-expression etc, see <B>regmatch_t</B>
|
||||
in the header file declaration for more details. The <B>eflags</B> parameter
|
||||
can be a combination of: <BR>
|
||||
</P>
|
||||
<TABLE BORDER="0" CELLSPACING="0" CELLPADDING="7" WIDTH="100%">
|
||||
<TR>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">REG_NOTBOL</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">Parameter <B>buf </B>does not represent the start
|
||||
of a line.</TD>
|
||||
<TD WIDTH="5%"> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">REG_NOTEOL</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">Parameter <B>buf</B> does not terminate at the end
|
||||
of a line.</TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
<TR>
|
||||
<TD> </TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">REG_STARTEND</TD>
|
||||
<TD VALIGN="TOP" WIDTH="50%">The string searched starts at buf +
|
||||
pmatch[0].rm_so and ends at buf + pmatch[0].rm_eo.</TD>
|
||||
<TD> </TD>
|
||||
</TR>
|
||||
</TABLE>
|
||||
<BR>
|
||||
<P>Finally <B>regfree</B> frees all the memory that was allocated by
|
||||
regcomp. </P>
|
||||
<P><I>Footnote: this is an abridged reference to the POSIX API functions, it is
|
||||
provided for compatibility with other libraries, rather than an API to be used
|
||||
in new code (unless you need access from a language other than C++). This
|
||||
version of these functions should also happily coexist with other versions, as
|
||||
the names used are macros that expand to the actual function names.</I> <BR>
|
||||
</P>
|
||||
<HR>
|
||||
<P><I>Copyright <A HREF="mailto:John_Maddock@compuserve.com">Dr John
|
||||
Maddock</A> 1998-2000 all rights reserved.</I> </P>
|
||||
</BODY>
|
||||
</HTML>
|
||||
}</pre>
|
||||
|
||||
<p>All the functions operate on structure <b>regex_t</b>, which
|
||||
exposes two public members: </p>
|
||||
|
||||
<p><b>unsigned int re_nsub</b> this is filled in by <b>regcomp</b>
|
||||
and indicates the number of sub-expressions contained in the
|
||||
regular expression. </p>
|
||||
|
||||
<p><b>const TCHAR* re_endp</b> points to the end of the
|
||||
expression to compile when the flag REG_PEND is set. </p>
|
||||
|
||||
<p><i>Footnote: regex_t is actually a #define - it is either
|
||||
regex_tA or regex_tW depending upon whether UNICODE is defined or
|
||||
not, TCHAR is either char or wchar_t again depending upon the
|
||||
macro UNICODE.</i> </p>
|
||||
|
||||
<p><b>regcomp</b> takes a pointer to a <b>regex_t</b>, a pointer
|
||||
to the expression to compile and a flags parameter which can be a
|
||||
combination of: <br>
|
||||
</p>
|
||||
|
||||
<table border="0" cellpadding="7" cellspacing="0" width="100%">
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_EXTENDED</td>
|
||||
<td valign="top" width="45%">Compiles modern regular
|
||||
expressions. Equivalent to regbase::char_classes |
|
||||
regbase::intervals | regbase::bk_refs.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_BASIC</td>
|
||||
<td valign="top" width="45%">Compiles basic (obsolete)
|
||||
regular expression syntax. Equivalent to regbase::char_classes
|
||||
| regbase::intervals | regbase::limited_ops | regbase::bk_braces
|
||||
| regbase::bk_parens | regbase::bk_refs.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_NOSPEC</td>
|
||||
<td valign="top" width="45%">All characters are ordinary,
|
||||
the expression is a literal string.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_ICASE</td>
|
||||
<td valign="top" width="45%">Compiles for matching that
|
||||
ignores character case.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_NOSUB</td>
|
||||
<td valign="top" width="45%">Has no effect in this
|
||||
library.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_NEWLINE</td>
|
||||
<td valign="top" width="45%">When this flag is set a dot
|
||||
does not match the newline character.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_PEND</td>
|
||||
<td valign="top" width="45%">When this flag is set the
|
||||
re_endp parameter of the regex_t structure must point to
|
||||
the end of the regular expression to compile.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_NOCOLLATE</td>
|
||||
<td valign="top" width="45%">When this flag is set then
|
||||
locale dependent collation for character ranges is turned
|
||||
off.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_ESCAPE_IN_LISTS<br>
|
||||
, , , </td>
|
||||
<td valign="top" width="45%">When this flag is set, then
|
||||
escape sequences are permitted in bracket expressions (character
|
||||
sets).</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_NEWLINE_ALT </td>
|
||||
<td valign="top" width="45%">When this flag is set then
|
||||
the newline character is equivalent to the alternation
|
||||
operator |.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_PERL </td>
|
||||
<td valign="top" width="45%"> A shortcut for perl-like
|
||||
behavior: REG_EXTENDED | REG_NOCOLLATE |
|
||||
REG_ESCAPE_IN_LISTS</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_AWK</td>
|
||||
<td valign="top" width="45%">A shortcut for awk-like
|
||||
behavior: REG_EXTENDED | REG_ESCAPE_IN_LISTS</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_GREP</td>
|
||||
<td valign="top" width="45%">A shortcut for grep like
|
||||
behavior: REG_BASIC | REG_NEWLINE_ALT</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="45%">REG_EGREP</td>
|
||||
<td valign="top" width="45%"> A shortcut for egrep
|
||||
like behavior: REG_EXTENDED | REG_NEWLINE_ALT</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p><br>
|
||||
</p>
|
||||
|
||||
<p><b>regerror</b> takes the following parameters, it maps an
|
||||
error code to a human readable string: <br>
|
||||
</p>
|
||||
|
||||
<table border="0" cellpadding="7" cellspacing="0" width="100%">
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="50%">int code</td>
|
||||
<td valign="top" width="50%">The error code.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td valign="top" width="50%">const regex_t* e</td>
|
||||
<td valign="top" width="50%">The regular expression (can
|
||||
be null).</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td valign="top" width="50%">char* buf</td>
|
||||
<td valign="top" width="50%">The buffer to fill in with
|
||||
the error message.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td valign="top" width="50%">unsigned int buf_size</td>
|
||||
<td valign="top" width="50%">The length of buf.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p>If the error code is OR'ed with REG_ITOA then the message that
|
||||
results is the printable name of the code rather than a message,
|
||||
for example "REG_BADPAT". If the code is REG_ATIO then <b>e</b>
|
||||
must not be null and <b>e->re_pend</b> must point to the
|
||||
printable name of an error code, the return value is then the
|
||||
value of the error code. For any other value of <b>code</b>, the
|
||||
return value is the number of characters in the error message, if
|
||||
the return value is greater than or equal to <b>buf_size</b> then
|
||||
<b>regerror</b> will have to be called again with a larger buffer.</p>
|
||||
|
||||
<p><b>regexec</b> finds the first occurrence of expression <b>e</b>
|
||||
within string <b>buf</b>. If <b>len</b> is non-zero then *<b>m</b>
|
||||
is filled in with what matched the regular expression, <b>m[0]</b>
|
||||
contains what matched the whole string, <b>m[1] </b>the first sub-expression
|
||||
etc, see <b>regmatch_t</b> in the header file declaration for
|
||||
more details. The <b>eflags</b> parameter can be a combination of:
|
||||
<br>
|
||||
</p>
|
||||
|
||||
<table border="0" cellpadding="7" cellspacing="0" width="100%">
|
||||
<tr>
|
||||
<td width="5%"> </td>
|
||||
<td valign="top" width="50%">REG_NOTBOL</td>
|
||||
<td valign="top" width="50%">Parameter <b>buf </b>does
|
||||
not represent the start of a line.</td>
|
||||
<td width="5%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td valign="top" width="50%">REG_NOTEOL</td>
|
||||
<td valign="top" width="50%">Parameter <b>buf</b> does
|
||||
not terminate at the end of a line.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td> </td>
|
||||
<td valign="top" width="50%">REG_STARTEND</td>
|
||||
<td valign="top" width="50%">The string searched starts
|
||||
at buf + pmatch[0].rm_so and ends at buf + pmatch[0].rm_eo.</td>
|
||||
<td> </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<p><br>
|
||||
</p>
|
||||
|
||||
<p>Finally <b>regfree</b> frees all the memory that was allocated
|
||||
by regcomp. </p>
|
||||
|
||||
<p><i>Footnote: this is an abridged reference to the POSIX API
|
||||
functions, it is provided for compatibility with other libraries,
|
||||
rather than an API to be used in new code (unless you need access
|
||||
from a language other than C++). This version of these functions
|
||||
should also happily coexist with other versions, as the names
|
||||
used are macros that expand to the actual function names.</i> <br>
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
|
||||
<p><i>Copyright </i><a href="mailto:John_Maddock@compuserve.com"><i>Dr
|
||||
John Maddock</i></a><i> 1998-2000 all rights reserved.</i> </p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user