1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Function regex_replace</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../xpressive/reference.html#header.boost.xpressive.regex_algorithms_hpp" title="Header <boost/xpressive/regex_algorithms.hpp>"> 10<link rel="prev" href="regex_search.html" title="Function regex_search"> 11<link rel="next" href="regex_constants/syntax_option_type.html" title="Type syntax_option_type"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="regex_search.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.regex_algorithms_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="regex_constants/syntax_option_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.xpressive.regex_replace"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Function regex_replace</span></h2> 30<p>boost::xpressive::regex_replace — Build an output sequence given an input sequence, a regex, and a format string or a formatter object, function, or expression. </p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../xpressive/reference.html#header.boost.xpressive.regex_algorithms_hpp" title="Header <boost/xpressive/regex_algorithms.hpp>">boost/xpressive/regex_algorithms.hpp</a>> 34 35</span> 36<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OutIter<span class="special">,</span> <span class="keyword">typename</span> BidiIter<span class="special">,</span> <span class="keyword">typename</span> Formatter<span class="special">></span> 37 <span class="identifier">OutIter</span> <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">OutIter</span> out<span class="special">,</span> <span class="identifier">BidiIter</span> begin<span class="special">,</span> <span class="identifier">BidiIter</span> end<span class="special">,</span> 38 <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 39 <span class="identifier">Formatter</span> <span class="keyword">const</span> <span class="special">&</span> format<span class="special">,</span> 40 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">,</span> 41 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 42<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> OutIter<span class="special">,</span> <span class="keyword">typename</span> BidiIter<span class="special">></span> 43 <span class="identifier">OutIter</span> <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">OutIter</span> out<span class="special">,</span> <span class="identifier">BidiIter</span> begin<span class="special">,</span> <span class="identifier">BidiIter</span> end<span class="special">,</span> 44 <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 45 <span class="keyword">typename</span> <span class="identifier">iterator_value</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="keyword">const</span> <span class="special">*</span> format<span class="special">,</span> 46 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">)</span><span class="special">;</span> 47<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiContainer<span class="special">,</span> <span class="keyword">typename</span> BidiIter<span class="special">,</span> <span class="keyword">typename</span> Formatter<span class="special">></span> 48 <span class="identifier">BidiContainer</span> 49 <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">BidiContainer</span> <span class="special">&</span> str<span class="special">,</span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 50 <span class="identifier">Formatter</span> <span class="keyword">const</span> <span class="special">&</span> format<span class="special">,</span> 51 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">,</span> 52 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 53<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiContainer<span class="special">,</span> <span class="keyword">typename</span> BidiIter<span class="special">,</span> <span class="keyword">typename</span> Formatter<span class="special">></span> 54 <span class="identifier">BidiContainer</span> 55 <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">BidiContainer</span> <span class="keyword">const</span> <span class="special">&</span> str<span class="special">,</span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 56 <span class="identifier">Formatter</span> <span class="keyword">const</span> <span class="special">&</span> format<span class="special">,</span> 57 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">,</span> 58 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 59<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">,</span> <span class="keyword">typename</span> Formatter<span class="special">></span> 60 <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">remove_const</span><span class="special"><</span> <span class="identifier">Char</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">></span> 61 <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">Char</span> <span class="special">*</span> str<span class="special">,</span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 62 <span class="identifier">Formatter</span> <span class="keyword">const</span> <span class="special">&</span> format<span class="special">,</span> 63 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">,</span> 64 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 65<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiContainer<span class="special">,</span> <span class="keyword">typename</span> BidiIter<span class="special">></span> 66 <span class="identifier">BidiContainer</span> 67 <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">BidiContainer</span> <span class="special">&</span> str<span class="special">,</span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 68 <span class="keyword">typename</span> <span class="identifier">iterator_value</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="keyword">const</span> <span class="special">*</span> format<span class="special">,</span> 69 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">,</span> 70 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 71<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> BidiContainer<span class="special">,</span> <span class="keyword">typename</span> BidiIter<span class="special">></span> 72 <span class="identifier">BidiContainer</span> 73 <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">BidiContainer</span> <span class="keyword">const</span> <span class="special">&</span> str<span class="special">,</span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 74 <span class="keyword">typename</span> <span class="identifier">iterator_value</span><span class="special"><</span> <span class="identifier">BidiIter</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="keyword">const</span> <span class="special">*</span> format<span class="special">,</span> 75 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">,</span> 76 <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> 77<span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Char<span class="special">></span> 78 <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">remove_const</span><span class="special"><</span> <span class="identifier">Char</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">></span> 79 <span class="identifier">regex_replace</span><span class="special">(</span><span class="identifier">Char</span> <span class="special">*</span> str<span class="special">,</span> <a class="link" href="basic_regex.html" title="Struct template basic_regex">basic_regex</a><span class="special"><</span> <span class="identifier">Char</span> <span class="special">*</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> re<span class="special">,</span> 80 <span class="keyword">typename</span> <span class="identifier">add_const</span><span class="special"><</span> <span class="identifier">Char</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">*</span> format<span class="special">,</span> 81 <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_flag_type</span> flags <span class="special">=</span> <span class="identifier">regex_constants</span><span class="special">::</span><span class="identifier">match_default</span><span class="special">)</span><span class="special">;</span></pre></div> 82<div class="refsect1"> 83<a name="id-1.3.47.5.5.6.4"></a><h2>Description</h2> 84<p>Constructs a <code class="computeroutput"><code class="computeroutput"><a class="link" href="regex_iterator.html" title="Struct template regex_iterator">regex_iterator</a></code></code> object: <code class="computeroutput"><code class="computeroutput"><a class="link" href="regex_iterator.html" title="Struct template regex_iterator">regex_iterator</a></code>< BidiIter > i(begin, end, re, flags)</code>, and uses <code class="computeroutput">i</code> to enumerate through all of the matches m of type <code class="computeroutput"><code class="computeroutput"><a class="link" href="match_results.html" title="Struct template match_results">match_results</a></code>< BidiIter ></code> that occur within the sequence <code class="computeroutput">[begin, end)</code>. If no such matches are found and <code class="computeroutput">!(flags & format_no_copy)</code> then calls <code class="computeroutput">std::copy(begin, end, out)</code>. Otherwise, for each match found, if <code class="computeroutput">!(flags & format_no_copy)</code> calls <code class="computeroutput">std::copy(m.prefix().first, m.prefix().second, out)</code>, and then calls <code class="computeroutput">m.format(out, format, flags)</code>. Finally if <code class="computeroutput">!(flags & format_no_copy)</code> calls <code class="computeroutput">std::copy(last_m.suffix().first, last_m.suffix().second, out)</code> where <code class="computeroutput">last_m</code> is a copy of the last match found.</p> 85<p>If <code class="computeroutput">flags & format_first_only</code> is non-zero then only the first match found is replaced.</p> 86<p> 87 88 89 90 91 92 93</p> 94<div class="variablelist"><table border="0" class="variablelist compact"> 95<colgroup> 96<col align="left" valign="top"> 97<col> 98</colgroup> 99<tbody> 100<tr> 101<td><p><span class="term">Parameters:</span></p></td> 102<td><div class="variablelist"><table border="0" class="variablelist compact"> 103<colgroup> 104<col align="left" valign="top"> 105<col> 106</colgroup> 107<tbody> 108<tr> 109<td><p><span class="term"><code class="computeroutput">begin</code></span></p></td> 110<td><p>The beginning of the input sequence. </p></td> 111</tr> 112<tr> 113<td><p><span class="term"><code class="computeroutput">end</code></span></p></td> 114<td><p>The end of the input sequence. </p></td> 115</tr> 116<tr> 117<td><p><span class="term"><code class="computeroutput">flags</code></span></p></td> 118<td><p>Optional match flags, used to control how the expression is matched against the sequence. (See <code class="computeroutput">match_flag_type</code>.) </p></td> 119</tr> 120<tr> 121<td><p><span class="term"><code class="computeroutput">format</code></span></p></td> 122<td><p>The format string used to format the replacement sequence, or a formatter function, function object, or expression. </p></td> 123</tr> 124<tr> 125<td><p><span class="term"><code class="computeroutput">out</code></span></p></td> 126<td><p>An output iterator into which the output sequence is written. </p></td> 127</tr> 128<tr> 129<td><p><span class="term"><code class="computeroutput">re</code></span></p></td> 130<td><p>The regular expression object to use. </p></td> 131</tr> 132</tbody> 133</table></div></td> 134</tr> 135<tr> 136<td><p><span class="term">Requires:</span></p></td> 137<td><p>Type <code class="computeroutput">BidiIter</code> meets the requirements of a Bidirectional Iterator (24.1.4). </p></td> 138</tr> 139<tr> 140<td><p><span class="term">Requires:</span></p></td> 141<td><p>Type <code class="computeroutput">OutIter</code> meets the requirements of an Output Iterator (24.1.2). </p></td> 142</tr> 143<tr> 144<td><p><span class="term">Requires:</span></p></td> 145<td><p>Type <code class="computeroutput">Formatter</code> models <code class="computeroutput">ForwardRange</code>, <code class="computeroutput">Callable<<a class="link" href="match_results.html" title="Struct template match_results">match_results</a><BidiIter> ></code>, <code class="computeroutput">Callable<<a class="link" href="match_results.html" title="Struct template match_results">match_results</a><BidiIter>, OutIter></code>, or <code class="computeroutput">Callable<<a class="link" href="match_results.html" title="Struct template match_results">match_results</a><BidiIter>, OutIter, regex_constants::match_flag_type></code>; or else it is a null-terminated format string, or an expression template representing a formatter lambda expression. </p></td> 146</tr> 147<tr> 148<td><p><span class="term">Requires:</span></p></td> 149<td><p><code class="computeroutput">[begin,end)</code> denotes a valid iterator range. </p></td> 150</tr> 151<tr> 152<td><p><span class="term">Returns:</span></p></td> 153<td><p>The value of the output iterator after the output sequence has been written to it. </p></td> 154</tr> 155<tr> 156<td><p><span class="term">Throws:</span></p></td> 157<td> 158<a class="link" href="regex_error.html" title="Struct regex_error">regex_error</a> on stack exhaustion or invalid format string. </td> 159</tr> 160</tbody> 161</table></div> 162</div> 163</div> 164<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 165<td align="left"></td> 166<td align="right"><div class="copyright-footer">Copyright © 2007 Eric Niebler<p> 167 Distributed under the Boost Software License, Version 1.0. (See accompanying 168 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 169 </p> 170</div></td> 171</tr></table> 172<hr> 173<div class="spirit-nav"> 174<a accesskey="p" href="regex_search.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../xpressive/reference.html#header.boost.xpressive.regex_algorithms_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="regex_constants/syntax_option_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 175</div> 176</body> 177</html> 178
