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>Class template special_values_parser</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="../../date_time/doxy.html#header.boost.date_time.special_values_parser_hpp" title="Header <boost/date_time/special_values_parser.hpp>"> 10<link rel="prev" href="special_values_formatter.html" title="Class template special_values_formatter"> 11<link rel="next" href="convert_string_type.html" title="Function template convert_string_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="special_values_formatter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.special_values_parser_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="convert_string_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.special_values_parser"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template special_values_parser</span></h2> 30<p>boost::date_time::special_values_parser — Class for special_value parsing. </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="../../date_time/doxy.html#header.boost.date_time.special_values_parser_hpp" title="Header <boost/date_time/special_values_parser.hpp>">boost/date_time/special_values_parser.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> date_type<span class="special">,</span> <span class="keyword">typename</span> charT<span class="special">></span> 36<span class="keyword">class</span> <a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</a> <span class="special">{</span> 37<span class="keyword">public</span><span class="special">:</span> 38 <span class="comment">// types</span> 39 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="boost.date_time.special_values_parser.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_stringstream</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="boost.date_time.special_values_parser.stringstream_type"></a><span class="identifier">stringstream_type</span><span class="special">;</span> 41 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">istreambuf_iterator</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="boost.date_time.special_values_parser.stream_itr_type"></a><span class="identifier">stream_itr_type</span><span class="special">;</span> 42 <span class="keyword">typedef</span> <span class="identifier">date_type</span><span class="special">::</span><span class="identifier">duration_type</span> <a name="boost.date_time.special_values_parser.duration_type"></a><span class="identifier">duration_type</span><span class="special">;</span> 43 <span class="keyword">typedef</span> <a class="link" href="string_parse_tree.html" title="Struct template string_parse_tree">string_parse_tree</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="boost.date_time.special_values_parser.parse_tree_type"></a><span class="identifier">parse_tree_type</span><span class="special">;</span> 44 <span class="keyword">typedef</span> parse_tree_type::parse_match_result_type <a name="boost.date_time.special_values_parser.match_results"></a><span class="identifier">match_results</span><span class="special">;</span> 45 <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <a name="boost.date_time.special_values_parser.collection_type"></a><span class="identifier">collection_type</span><span class="special">;</span> 46 <span class="keyword">typedef</span> <span class="identifier">charT</span> <a name="boost.date_time.special_values_parser.char_type"></a><span class="identifier">char_type</span><span class="special">;</span> 47 48 <span class="comment">// <a class="link" href="special_values_parser.html#boost.date_time.special_values_parserconstruct-copy-destruct">construct/copy/destruct</a></span> 49 <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_18-bb"><span class="identifier">special_values_parser</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 50 <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_19-bb"><span class="identifier">special_values_parser</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> 51 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> 52 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 53 <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_20-bb"><span class="identifier">special_values_parser</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">,</span> 54 <span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span><span class="special">)</span><span class="special">;</span> 55 56 <span class="comment">// <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_17-bb">public member functions</a></span> 57 <span class="keyword">void</span> <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_17_1-bb"><span class="identifier">sv_strings</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> 58 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">,</span> 59 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 60 <span class="keyword">bool</span> <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_17_2-bb"><span class="identifier">match</span></a><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="special_values_parser.html#boost.date_time.special_values_parser.match_results">match_results</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 61 62 <span class="comment">// <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_21-bb">public static functions</a></span> 63 <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="special_values_parser.html#id-1_3_14_15_3_41_1_1_1_21_1-bb"><span class="identifier">likely</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 64 65 <span class="comment">// public data members</span> 66 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">nadt_string</span><span class="special">;</span> 67 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">neg_inf_string</span><span class="special">;</span> 68 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">pos_inf_string</span><span class="special">;</span> 69 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">min_date_time_string</span><span class="special">;</span> 70 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">max_date_time_string</span><span class="special">;</span> 71<span class="special">}</span><span class="special">;</span></pre></div> 72<div class="refsect1"> 73<a name="id-1.3.14.15.3.40.3.4"></a><h2>Description</h2> 74<p>TODO: add doc-comments for which elements can be changed Parses input stream for strings representing special_values. Special values parsed are:</p> 75<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 76<li class="listitem"><p>not_a_date_time</p></li> 77<li class="listitem"><p>neg_infin</p></li> 78<li class="listitem"><p>pod_infin</p></li> 79<li class="listitem"><p>min_date_time</p></li> 80<li class="listitem"><p>max_date_time </p></li> 81</ul></div> 82<p> 83</p> 84<div class="refsect2"> 85<a name="id-1.3.14.15.3.40.3.4.3"></a><h3> 86<a name="boost.date_time.special_values_parserconstruct-copy-destruct"></a><code class="computeroutput">special_values_parser</code> 87 public 88 construct/copy/destruct</h3> 89<div class="orderedlist"><ol class="orderedlist" type="1"> 90<li class="listitem"> 91<pre class="literallayout"><a name="id-1_3_14_15_3_41_1_1_1_18-bb"></a><span class="identifier">special_values_parser</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Creates a <code class="computeroutput"><a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</a></code> with the default set of "sv_strings". </li> 92<li class="listitem"> 93<pre class="literallayout"><a name="id-1_3_14_15_3_41_1_1_1_19-bb"></a><span class="identifier">special_values_parser</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> nadt_str<span class="special">,</span> 94 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> neg_inf_str<span class="special">,</span> 95 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> pos_inf_str<span class="special">,</span> 96 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> min_dt_str<span class="special">,</span> 97 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> max_dt_str<span class="special">)</span><span class="special">;</span></pre>Creates a <code class="computeroutput"><a class="link" href="special_values_parser.html" title="Class template special_values_parser">special_values_parser</a></code> using a user defined set of element strings. </li> 98<li class="listitem"><pre class="literallayout"><a name="id-1_3_14_15_3_41_1_1_1_20-bb"></a><span class="identifier">special_values_parser</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span> beg<span class="special">,</span> 99 <span class="keyword">typename</span> <span class="identifier">collection_type</span><span class="special">::</span><span class="identifier">iterator</span> end<span class="special">)</span><span class="special">;</span></pre></li> 100</ol></div> 101</div> 102<div class="refsect2"> 103<a name="id-1.3.14.15.3.40.3.4.4"></a><h3> 104<a name="id-1_3_14_15_3_41_1_1_1_17-bb"></a><code class="computeroutput">special_values_parser</code> public member functions</h3> 105<div class="orderedlist"><ol class="orderedlist" type="1"> 106<li class="listitem"> 107<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_14_15_3_41_1_1_1_17_1-bb"></a><span class="identifier">sv_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> nadt_str<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> neg_inf_str<span class="special">,</span> 108 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> pos_inf_str<span class="special">,</span> 109 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> min_dt_str<span class="special">,</span> 110 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> max_dt_str<span class="special">)</span><span class="special">;</span></pre>Replace special value strings. </li> 111<li class="listitem"> 112<pre class="literallayout"><span class="keyword">bool</span> <a name="id-1_3_14_15_3_41_1_1_1_17_2-bb"></a><span class="identifier">match</span><span class="special">(</span><span class="identifier">stream_itr_type</span> <span class="special">&</span> sitr<span class="special">,</span> <span class="identifier">stream_itr_type</span> <span class="special">&</span> str_end<span class="special">,</span> 113 <a class="link" href="special_values_parser.html#boost.date_time.special_values_parser.match_results">match_results</a> <span class="special">&</span> mr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 114<p>Given an input iterator, attempt to match it to a known special value 115 116</p> 117<div class="variablelist"><table border="0" class="variablelist compact"> 118<colgroup> 119<col align="left" valign="top"> 120<col> 121</colgroup> 122<tbody> 123<tr> 124<td><p><span class="term">Parameters:</span></p></td> 125<td><div class="variablelist"><table border="0" class="variablelist compact"> 126<colgroup> 127<col align="left" valign="top"> 128<col> 129</colgroup> 130<tbody> 131<tr> 132<td><p><span class="term"><code class="computeroutput">mr</code></span></p></td> 133<td><p>the match result: mr.current_match is set to the corresponding special_value or -1 </p></td> 134</tr> 135<tr> 136<td><p><span class="term"><code class="computeroutput">sitr</code></span></p></td> 137<td><p>the start iterator </p></td> 138</tr> 139<tr> 140<td><p><span class="term"><code class="computeroutput">str_end</code></span></p></td> 141<td><p>the end iterator </p></td> 142</tr> 143</tbody> 144</table></div></td> 145</tr> 146<tr> 147<td><p><span class="term">Returns:</span></p></td> 148<td><p>whether something matched </p></td> 149</tr> 150</tbody> 151</table></div> 152</li> 153</ol></div> 154</div> 155<div class="refsect2"> 156<a name="id-1.3.14.15.3.40.3.4.5"></a><h3> 157<a name="id-1_3_14_15_3_41_1_1_1_21-bb"></a><code class="computeroutput">special_values_parser</code> public static functions</h3> 158<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 159<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="id-1_3_14_15_3_41_1_1_1_21_1-bb"></a><span class="identifier">likely</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> str<span class="special">)</span><span class="special">;</span></pre> 160<p>The parser is expensive to create, and not thread-safe so it cannot be static therefore given a string, determine if it is likely to be a special value. A negative response is a definite no, whereas a positive is only likely and match() should be called and return value checked. 161 162</p> 163<div class="variablelist"><table border="0" class="variablelist compact"> 164<colgroup> 165<col align="left" valign="top"> 166<col> 167</colgroup> 168<tbody> 169<tr> 170<td><p><span class="term">Parameters:</span></p></td> 171<td><div class="variablelist"><table border="0" class="variablelist compact"> 172<colgroup> 173<col align="left" valign="top"> 174<col> 175</colgroup> 176<tbody><tr> 177<td><p><span class="term"><code class="computeroutput">str</code></span></p></td> 178<td><p>the string to check </p></td> 179</tr></tbody> 180</table></div></td> 181</tr> 182<tr> 183<td><p><span class="term">Returns:</span></p></td> 184<td><p>false if it is definitely not a special value </p></td> 185</tr> 186</tbody> 187</table></div> 188</li></ol></div> 189</div> 190</div> 191</div> 192<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 193<td align="left"></td> 194<td align="right"><div class="copyright-footer">Copyright © 2001-2005 CrystalClear Software, Inc<p>Subject to the Boost Software License, Version 1.0. (See accompanying file 195 <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>)</p> 196</div></td> 197</tr></table> 198<hr> 199<div class="spirit-nav"> 200<a accesskey="p" href="special_values_formatter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.special_values_parser_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="convert_string_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 201</div> 202</body> 203</html> 204
