doc/html/boost/algorithm/find_all_regex.html

   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=US-ASCII">
   5 <title>Function template find_all_regex</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="../../string_algo/reference.html#header.boost.algorithm.string.regex_hpp" title="Header &lt;boost/algorithm/string/regex.hpp&gt;">
  10 <link rel="prev" href="erase_all_regex.html" title="Function template erase_all_regex">
  11 <link rel="next" href="split_regex.html" title="Function template split_regex">
  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="erase_all_regex.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.regex_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="split_regex.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.algorithm.find_all_regex"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template find_all_regex</span></h2>
  30 <p>boost::algorithm::find_all_regex &#8212; Find all regex algorithm. </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: &lt;<a class="link" href="../../string_algo/reference.html#header.boost.algorithm.string.regex_hpp" title="Header &lt;boost/algorithm/string/regex.hpp&gt;">boost/algorithm/string/regex.hpp</a>&gt;
  34
  35 </span>
  36 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> SequenceSequenceT<span class="special">,</span> <span class="keyword">typename</span> RangeT<span class="special">,</span> <span class="keyword">typename</span> CharT<span class="special">,</span>
  37          <span class="keyword">typename</span> RegexTraitsT<span class="special">&gt;</span>
  38   <span class="identifier">SequenceSequenceT</span> <span class="special">&amp;</span>
  39   <span class="identifier">find_all_regex</span><span class="special">(</span><span class="identifier">SequenceSequenceT</span> <span class="special">&amp;</span> Result<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">RangeT</span> <span class="special">&amp;</span> Input<span class="special">,</span>
  40                  <span class="keyword">const</span> <span class="identifier">basic_regex</span><span class="special">&lt;</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">RegexTraitsT</span> <span class="special">&gt;</span> <span class="special">&amp;</span> Rx<span class="special">,</span>
  41                  <span class="identifier">match_flag_type</span> Flags <span class="special">=</span> <span class="identifier">match_default</span><span class="special">)</span><span class="special">;</span></pre></div>
  42 <div class="refsect1">
  43 <a name="idp130808640"></a><h2>Description</h2>
  44 <p>This algorithm finds all substrings matching the give regex in the input.</p>
  45 <p>Each part is copied and added as a new element to the output container. Thus the result container must be able to hold copies of the matches (in a compatible structure like std::string) or a reference to it (e.g. using the iterator range class). Examples of such a container are <code class="computeroutput">std::vector&lt;std::string&gt;</code> or <code class="computeroutput">std::list&lt;boost::iterator_range&lt;std::string::iterator&gt;&gt;</code> </p>
  46 <p>
  47
  48 </p>
  49 <div class="note"><table border="0" summary="Note">
  50 <tr>
  51 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
  52 <th align="left">Note</th>
  53 </tr>
  54 <tr><td align="left" valign="top">
  55 <p>Prior content of the result will be overwritten.</p>
  56 <p>This function provides the strong exception-safety guarantee </p>
  57 </td></tr>
  58 </table></div>
  59 <p>
  60 </p>
  61 <div class="variablelist"><table border="0" class="variablelist compact">
  62 <colgroup>
  63 <col align="left" valign="top">
  64 <col>
  65 </colgroup>
  66 <tbody>
  67 <tr>
  68 <td><p><span class="term">Parameters:</span></p></td>
  69 <td><div class="variablelist"><table border="0" class="variablelist compact">
  70 <colgroup>
  71 <col align="left" valign="top">
  72 <col>
  73 </colgroup>
  74 <tbody>
  75 <tr>
  76 <td><p><span class="term"><code class="computeroutput">Flags</code></span></p></td>
  77 <td><p>Regex options </p></td>
  78 </tr>
  79 <tr>
  80 <td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
  81 <td><p>A container which will be searched. </p></td>
  82 </tr>
  83 <tr>
  84 <td><p><span class="term"><code class="computeroutput">Result</code></span></p></td>
  85 <td><p>A container that can hold copies of references to the substrings. </p></td>
  86 </tr>
  87 <tr>
  88 <td><p><span class="term"><code class="computeroutput">Rx</code></span></p></td>
  89 <td><p>A regular expression </p></td>
  90 </tr>
  91 </tbody>
  92 </table></div></td>
  93 </tr>
  94 <tr>
  95 <td><p><span class="term">Returns:</span></p></td>
  96 <td><p>A reference to the result</p></td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 </div>
 101 </div>
 102 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 103 <td align="left"></td>
 104 <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
 105                 Software License, Version 1.0. (See accompanying file
 106                 <code class="filename">LICENSE_1_0.txt</code> or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
 107             </p>
 108 </div></td>
 109 </tr></table>
 110 <hr>
 111 <div class="spirit-nav">
 112 <a accesskey="p" href="erase_all_regex.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../string_algo/reference.html#header.boost.algorithm.string.regex_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="split_regex.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 113 </div>
 114 </body>
 115 </html>