• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 template split_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="find_all_regex.html" title="Function template find_all_regex">
11<link rel="next" href="join_if_1_3_3_9_16_2_1_12.html" title="Function template join_if">
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="find_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="join_if_1_3_3_9_16_2_1_12.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25</div>
26<div class="refentry">
27<a name="boost.algorithm.split_regex"></a><div class="titlepage"></div>
28<div class="refnamediv">
29<h2><span class="refentrytitle">Function template split_regex</span></h2>
30<p>boost::algorithm::split_regex — Split 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">split_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="id-1.3.3.9.17.14.4"></a><h2>Description</h2>
44<p>Tokenize expression. This function is equivalent to C strtok. Input sequence is split into tokens, separated by separators. Separator is an every match of the given regex. 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>
45<p>
46
47</p>
48<div class="note"><table border="0" summary="Note">
49<tr>
50<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
51<th align="left">Note</th>
52</tr>
53<tr><td align="left" valign="top"><p>Prior content of the result will be overwritten.</p></td></tr>
54</table></div>
55<p>
56</p>
57<div class="note"><table border="0" summary="Note">
58<tr>
59<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td>
60<th align="left">Note</th>
61</tr>
62<tr><td align="left" valign="top"><p>This function provides the strong exception-safety guarantee </p></td></tr>
63</table></div>
64<p>
65</p>
66<div class="variablelist"><table border="0" class="variablelist compact">
67<colgroup>
68<col align="left" valign="top">
69<col>
70</colgroup>
71<tbody>
72<tr>
73<td><p><span class="term">Parameters:</span></p></td>
74<td><div class="variablelist"><table border="0" class="variablelist compact">
75<colgroup>
76<col align="left" valign="top">
77<col>
78</colgroup>
79<tbody>
80<tr>
81<td><p><span class="term"><code class="computeroutput">Flags</code></span></p></td>
82<td><p>Regex options </p></td>
83</tr>
84<tr>
85<td><p><span class="term"><code class="computeroutput">Input</code></span></p></td>
86<td><p>A container which will be searched. </p></td>
87</tr>
88<tr>
89<td><p><span class="term"><code class="computeroutput">Result</code></span></p></td>
90<td><p>A container that can hold copies of references to the substrings.</p></td>
91</tr>
92<tr>
93<td><p><span class="term"><code class="computeroutput">Rx</code></span></p></td>
94<td><p>A regular expression </p></td>
95</tr>
96</tbody>
97</table></div></td>
98</tr>
99<tr>
100<td><p><span class="term">Returns:</span></p></td>
101<td><p>A reference to the result</p></td>
102</tr>
103</tbody>
104</table></div>
105</div>
106</div>
107<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
108<td align="left"></td>
109<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Pavol Droba<p>Use, modification and distribution is subject to the Boost
110                Software License, Version 1.0. (See accompanying file
111                <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>)
112            </p>
113</div></td>
114</tr></table>
115<hr>
116<div class="spirit-nav">
117<a accesskey="p" href="find_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="join_if_1_3_3_9_16_2_1_12.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
118</div>
119</body>
120</html>
121