boostorg/regex
1
0
Fork 1
mirror of https://github.com/boostorg/regex.git synced 2025-07-16 05:42:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Tweeked regex version number to reference <boost/version.hpp>

Browse Source 
[SVN r11309]
This commit is contained in:
John Maddock
2001-09-30 10:30:14 +00:00
parent 4dd87c299f
commit fe45d5bf4a
63 changed files with 1619 additions and 1388 deletions
Download Patch File Download Diff File Expand all files Collapse all files

439
format_string.htm
View File

@ -1,202 +1,245 @@
<!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++, Format String Reference</TITLE>
</HEAD>
<html>
<BODY BGCOLOR="#FFFFFF" LINK="#0000FF" VLINK="#800080">
&nbsp; <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++, Format String 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++, Format String 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.&nbsp; Dr John Maddock makes no representations
about the suitability of this software for any purpose.&nbsp;&nbsp;
It is provided &quot;as is&quot; without express or implied warranty.</I></PRE>
<body bgcolor="#FFFFFF" link="#0000FF" vlink="#800080">
</TD>
</TR>
</TABLE>
<HR>
<H3> <A NAME="format_string"></A>Format String Syntax</H3>
Format strings are used by the algorithms
<A HREF="template_class_ref.htm#reg_format">regex_format</A> and
<A HREF="template_class_ref.htm#reg_merge">regex_merge</A>, and are used to
transform one string into another. <P>There are three kind of format string:
sed, perl and extended, the extended syntax is the default so this is covered
first. </P>
<P><B><I>Extended format syntax</I></B> </P>
<P>In format strings, all characters are treated as literals except: ()$\?:
</P>
<P>To use any of these as literals you must prefix them with the escape
character \ </P>
<P>The following special sequences are recognized: <BR>
&nbsp; <BR>
&nbsp; </P>
<P><I>Grouping:</I> </P>
<P>Use the parenthesis characters ( and ) to group sub-expressions within the
format string, use \( and \) to represent literal '(' and ')'. <BR>
&nbsp; <BR>
&nbsp; </P>
<P><I>Sub-expression expansions:</I> </P>
<P>The following perl like expressions expand to a particular matched
sub-expression: <BR>
&nbsp; </P>
<TABLE BORDER="0" CELLSPACING="0" CELLPADDING="7" WIDTH="100%">
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">$`</TD>
<TD VALIGN="TOP" WIDTH="43%">Expands to all the text from the end of the
previous match to the start of the current match, if there was no previous
match in the current operation, then everything from the start of the input
string to the start of the match.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">$'</TD>
<TD VALIGN="TOP" WIDTH="43%">Expands to all the text from the end of the match
to the end of the input string.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">$&amp;</TD>
<TD VALIGN="TOP" WIDTH="43%">Expands to all of the current match.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">$0</TD>
<TD VALIGN="TOP" WIDTH="43%">Expands to all of the current match.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">$N</TD>
<TD VALIGN="TOP" WIDTH="43%">Expands to the text that matched sub-expression
<I>N</I>.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
</TABLE>
<BR>
&nbsp; <P><I>Conditional expressions:</I> </P>
<P>Conditional expressions allow two different format strings to be selected
dependent upon whether a sub-expression participated in the match or not: </P>
<P>?Ntrue_expression:false_expression </P>
<P>Executes true_expression if sub-expression <I>N</I> participated in the
match, otherwise executes false_expression. </P>
<P>Example: suppose we search for &quot;(while)|(for)&quot; then the format
string &quot;?1WHILE:FOR&quot; would output what matched, but in upper case.
<BR>
&nbsp; <BR>
&nbsp; </P>
<P><I>Escape sequences:</I> </P>
<P>The following escape sequences are also allowed: <BR>
&nbsp; </P>
<TABLE BORDER="0" CELLSPACING="0" CELLPADDING="7" WIDTH="100%">
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\a</TD>
<TD VALIGN="TOP" WIDTH="43%">The bell character.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\f</TD>
<TD VALIGN="TOP" WIDTH="43%">The form feed character.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\n</TD>
<TD VALIGN="TOP" WIDTH="43%">The newline character.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\r</TD>
<TD VALIGN="TOP" WIDTH="43%">The carriage return character.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\t</TD>
<TD VALIGN="TOP" WIDTH="43%">The tab character.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\v</TD>
<TD VALIGN="TOP" WIDTH="43%">A vertical tab character.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\x</TD>
<TD VALIGN="TOP" WIDTH="43%">A hexadecimal character - for example \x0D.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\x{}</TD>
<TD VALIGN="TOP" WIDTH="43%">A possible unicode hexadecimal character - for
example \x{1A0}</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\cx</TD>
<TD VALIGN="TOP" WIDTH="43%">The ASCII escape character x, for example \c@ is
equivalent to escape-@.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\e</TD>
<TD VALIGN="TOP" WIDTH="43%">The ASCII escape character.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
<TR>
<TD VALIGN="TOP" WIDTH="8%">&nbsp;</TD>
<TD VALIGN="TOP" WIDTH="40%">\dd</TD>
<TD VALIGN="TOP" WIDTH="43%">An octal character constant, for example \10.</TD>
<TD VALIGN="TOP" WIDTH="9%">&nbsp;</TD>
</TR>
</TABLE>
<BR>
&nbsp; <P><B><I>Perl format strings</I></B> </P>
<P>Perl format strings are the same as the default syntax except that the
characters ()?: have no special meaning. </P>
<P><B><I>Sed format strings</I></B> </P>
<P>Sed format strings use only the characters \ and &amp; as special
characters. </P>
<P>\n where n is a digit, is expanded to the nth sub-expression. </P>
<P>&amp; is expanded to the whole of the match (equivalent to \0). </P>
<P>Other escape sequences are expanded as per the default syntax. <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>
<p>&nbsp; </p>
<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++, Format
String Reference.</h3>
<p align="left"><i>(Version 3.20, 29th Sept 2001)</i>&nbsp;
</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 &quot;as is&quot;
without express or implied warranty.</i></p>
</td>
</tr>
</table>
<hr>
<h3><a name="format_string"></a>Format String Syntax</h3>
<p>Format strings are used by the algorithms <a
href="template_class_ref.htm#reg_format">regex_format</a> and <a
href="template_class_ref.htm#reg_merge">regex_merge</a>, and are
used to transform one string into another. </p>
<p>There are three kind of format string: sed, perl and extended,
the extended syntax is the default so this is covered first. </p>
<p><b><i>Extended format syntax</i></b> </p>
<p>In format strings, all characters are treated as literals
except: ()$\?: </p>
<p>To use any of these as literals you must prefix them with the
escape character \ </p>
<p>The following special sequences are recognized: <br>
&nbsp; <br>
&nbsp; </p>
<p><i>Grouping:</i> </p>
<p>Use the parenthesis characters ( and ) to group sub-expressions
within the format string, use \( and \) to represent literal '('
and ')'. <br>
&nbsp; <br>
&nbsp; </p>
<p><i>Sub-expression expansions:</i> </p>
<p>The following perl like expressions expand to a particular
matched sub-expression: <br>
&nbsp; </p>
<table border="0" cellpadding="7" cellspacing="0" width="100%">
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">$`</td>
<td valign="top" width="43%">Expands to all the text from
the end of the previous match to the start of the current
match, if there was no previous match in the current
operation, then everything from the start of the input
string to the start of the match.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">$'</td>
<td valign="top" width="43%">Expands to all the text from
the end of the match to the end of the input string.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">$&amp;</td>
<td valign="top" width="43%">Expands to all of the
current match.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">$0</td>
<td valign="top" width="43%">Expands to all of the
current match.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">$N</td>
<td valign="top" width="43%">Expands to the text that
matched sub-expression <i>N</i>.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
</table>
<p><br>
&nbsp; </p>
<p><i>Conditional expressions:</i> </p>
<p>Conditional expressions allow two different format strings to
be selected dependent upon whether a sub-expression participated
in the match or not: </p>
<p>?Ntrue_expression:false_expression </p>
<p>Executes true_expression if sub-expression <i>N</i>
participated in the match, otherwise executes false_expression. </p>
<p>Example: suppose we search for &quot;(while)|(for)&quot; then
the format string &quot;?1WHILE:FOR&quot; would output what
matched, but in upper case. <br>
&nbsp; <br>
&nbsp; </p>
<p><i>Escape sequences:</i> </p>
<p>The following escape sequences are also allowed: <br>
&nbsp; </p>
<table border="0" cellpadding="7" cellspacing="0" width="100%">
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\a</td>
<td valign="top" width="43%">The bell character.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\f</td>
<td valign="top" width="43%">The form feed character.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\n</td>
<td valign="top" width="43%">The newline character.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\r</td>
<td valign="top" width="43%">The carriage return
character.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\t</td>
<td valign="top" width="43%">The tab character.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\v</td>
<td valign="top" width="43%">A vertical tab character.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\x</td>
<td valign="top" width="43%">A hexadecimal character -
for example \x0D.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\x{}</td>
<td valign="top" width="43%">A possible unicode
hexadecimal character - for example \x{1A0}</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\cx</td>
<td valign="top" width="43%">The ASCII escape character
x, for example \c@ is equivalent to escape-@.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\e</td>
<td valign="top" width="43%">The ASCII escape character.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
<tr>
<td valign="top" width="8%">&nbsp;</td>
<td valign="top" width="40%">\dd</td>
<td valign="top" width="43%">An octal character constant,
for example \10.</td>
<td valign="top" width="9%">&nbsp;</td>
</tr>
</table>
<p><br>
&nbsp; </p>
<p><b><i>Perl format strings</i></b> </p>
<p>Perl format strings are the same as the default syntax except
that the characters ()?: have no special meaning. </p>
<p><b><i>Sed format strings</i></b> </p>
<p>Sed format strings use only the characters \ and &amp; as
special characters. </p>
<p>\n where n is a digit, is expanded to the nth sub-expression. </p>
<p>&amp; is expanded to the whole of the match (equivalent to \0).
</p>
<p>Other escape sequences are expanded as per the default syntax.
<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>