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 period_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.period_parser_hpp" title="Header <boost/date_time/period_parser.hpp>"> 10<link rel="prev" href="period_formatter.html" title="Class template period_formatter"> 11<link rel="next" href="special_values_formatter.html" title="Class template special_values_formatter"> 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="period_formatter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.period_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="special_values_formatter.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.date_time.period_parser"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template period_parser</span></h2> 30<p>boost::date_time::period_parser — Not a facet, but a class used to specify and control period 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.period_parser_hpp" title="Header <boost/date_time/period_parser.hpp>">boost/date_time/period_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="period_parser.html" title="Class template period_parser">period_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.period_parser.string_type"></a><span class="identifier">string_type</span><span class="special">;</span> 40 <span class="keyword">typedef</span> <span class="identifier">CharT</span> <a name="boost.date_time.period_parser.char_type"></a><span class="identifier">char_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.period_parser.stream_itr_type"></a><span class="identifier">stream_itr_type</span><span class="special">;</span> 42 <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.period_parser.parse_tree_type"></a><span class="identifier">parse_tree_type</span><span class="special">;</span> 43 <span class="keyword">typedef</span> parse_tree_type::parse_match_result_type <a name="boost.date_time.period_parser.match_results"></a><span class="identifier">match_results</span><span class="special">;</span> 44 <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.period_parser.collection_type"></a><span class="identifier">collection_type</span><span class="special">;</span> 45 46 <span class="keyword">enum</span> <a name="boost.date_time.period_parser.period_range_option"></a>period_range_option <span class="special">{</span> AS_OPEN_RANGE, AS_CLOSED_RANGE <span class="special">}</span><span class="special">;</span> 47 48 <span class="comment">// <a class="link" href="period_parser.html#boost.date_time.period_parserconstruct-copy-destruct">construct/copy/destruct</a></span> 49 <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_16-bb"><span class="identifier">period_parser</span></a><span class="special">(</span><span class="identifier">period_range_option</span> <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> 50 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_separator</span><span class="special">,</span> 51 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_start_delimeter</span><span class="special">,</span> 52 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_open_range_end_delimeter</span><span class="special">,</span> 53 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> <span class="special">=</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">)</span><span class="special">;</span> 54 55 <span class="comment">// <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_15-bb">public member functions</a></span> 56 <span class="identifier">period_range_option</span> <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_15_1-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 57 <span class="keyword">void</span> <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_15_2-bb"><span class="identifier">range_option</span></a><span class="special">(</span><span class="identifier">period_range_option</span><span class="special">)</span><span class="special">;</span> 58 <span class="identifier">collection_type</span> <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_15_3-bb"><span class="identifier">delimiter_strings</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 59 <span class="keyword">void</span> <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_15_4-bb"><span class="identifier">delimiter_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> 60 <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><span class="special">;</span> 61 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> duration_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">></span> 62 <span class="identifier">period_type</span> <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_15_5-bb"><span class="identifier">get_period</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> 63 <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&</span><span class="special">,</span> 64 <span class="keyword">const</span> <span class="identifier">duration_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 65 66 <span class="comment">// <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_17-bb">private member functions</a></span> 67 <span class="keyword">void</span> <a class="link" href="period_parser.html#id-1_3_14_15_3_38_1_1_1_17_1-bb"><span class="identifier">consume_delim</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> 68 <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="special">;</span> 69 70 <span class="comment">// public data members</span> 71 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_separator</span><span class="special">;</span> 72 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_start_delimeter</span><span class="special">;</span> 73 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_open_range_end_delimeter</span><span class="special">;</span> 74 <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">;</span> 75<span class="special">}</span><span class="special">;</span></pre></div> 76<div class="refsect1"> 77<a name="id-1.3.14.15.3.37.3.4"></a><h2>Description</h2> 78<p>Provides settings for the following:</p> 79<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 80<li class="listitem"><p>period_separator – default '/'</p></li> 81<li class="listitem"><p>period_open_start_delimeter – default '['</p></li> 82<li class="listitem"><p>period_open_range_end_delimeter – default ')'</p></li> 83<li class="listitem"><p>period_closed_range_end_delimeter – default ']'</p></li> 84<li class="listitem"><p>display_as_open_range, display_as_closed_range – default closed_range</p></li> 85</ul></div> 86<p> 87</p> 88<p>For a typical date_period, the contents of the input stream would be </p> 89<pre class="programlisting"><span class="special">[</span><span class="number">2004</span><span class="special">-</span><span class="identifier">Jan</span><span class="special">-</span><span class="number">04</span><span class="special">/</span><span class="number">2004</span><span class="special">-</span><span class="identifier">Feb</span><span class="special">-</span><span class="number">01</span><span class="special">]</span> 90</pre> 91<p> where the date format is controlled by the date facet </p> 92<div class="refsect2"> 93<a name="id-1.3.14.15.3.37.3.4.4"></a><h3> 94<a name="boost.date_time.period_parserconstruct-copy-destruct"></a><code class="computeroutput">period_parser</code> 95 public 96 construct/copy/destruct</h3> 97<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 98<pre class="literallayout"><a name="id-1_3_14_15_3_38_1_1_1_16-bb"></a><span class="identifier">period_parser</span><span class="special">(</span><span class="identifier">period_range_option</span> range_opt <span class="special">=</span> <span class="identifier">AS_CLOSED_RANGE</span><span class="special">,</span> 99 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_separator <span class="special">=</span> <span class="identifier">default_period_separator</span><span class="special">,</span> 100 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_start_delimeter <span class="special">=</span> <span class="identifier">default_period_start_delimeter</span><span class="special">,</span> 101 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_open_range_end_delimeter <span class="special">=</span> <span class="identifier">default_period_open_range_end_delimeter</span><span class="special">,</span> 102 <span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="keyword">const</span> period_closed_range_end_delimeter <span class="special">=</span> <span class="identifier">default_period_closed_range_end_delimeter</span><span class="special">)</span><span class="special">;</span></pre>Constructor that sets up period parser options. </li></ol></div> 103</div> 104<div class="refsect2"> 105<a name="id-1.3.14.15.3.37.3.4.5"></a><h3> 106<a name="id-1_3_14_15_3_38_1_1_1_15-bb"></a><code class="computeroutput">period_parser</code> public member functions</h3> 107<div class="orderedlist"><ol class="orderedlist" type="1"> 108<li class="listitem"><pre class="literallayout"><span class="identifier">period_range_option</span> <a name="id-1_3_14_15_3_38_1_1_1_15_1-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 109<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_14_15_3_38_1_1_1_15_2-bb"></a><span class="identifier">range_option</span><span class="special">(</span><span class="identifier">period_range_option</span> option<span class="special">)</span><span class="special">;</span></pre></li> 110<li class="listitem"><pre class="literallayout"><span class="identifier">collection_type</span> <a name="id-1_3_14_15_3_38_1_1_1_15_3-bb"></a><span class="identifier">delimiter_strings</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> 111<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_14_15_3_38_1_1_1_15_4-bb"></a><span class="identifier">delimiter_strings</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> separator<span class="special">,</span> 112 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> start_delim<span class="special">,</span> 113 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> open_end_delim<span class="special">,</span> 114 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> closed_end_delim<span class="special">)</span><span class="special">;</span></pre></li> 115<li class="listitem"> 116<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> period_type<span class="special">,</span> <span class="keyword">typename</span> duration_type<span class="special">,</span> <span class="keyword">typename</span> facet_type<span class="special">></span> 117 <span class="identifier">period_type</span> <a name="id-1_3_14_15_3_38_1_1_1_15_5-bb"></a><span class="identifier">get_period</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> stream_end<span class="special">,</span> 118 <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span> <span class="special">&</span> a_ios<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">period_type</span> <span class="special">&</span><span class="special">,</span> 119 <span class="keyword">const</span> <span class="identifier">duration_type</span> <span class="special">&</span> dur_unit<span class="special">,</span> 120 <span class="keyword">const</span> <span class="identifier">facet_type</span> <span class="special">&</span> facet<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Generic code to parse a period – no matter the period type. <p>This generic code will parse any period using a facet to to get the 'elements'. For example, in the case of a date_period the elements will be instances of a date which will be parsed according the to setup in the passed facet parameter.</p> 121<p>The steps for parsing a period are always the same:</p> 122<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 123<li class="listitem"><p>consume the start delimiter</p></li> 124<li class="listitem"><p>get start element</p></li> 125<li class="listitem"><p>consume the separator</p></li> 126<li class="listitem"><p>get either last or end element depending on range settings</p></li> 127<li class="listitem"><p>consume the end delimeter depending on range settings</p></li> 128</ul></div> 129<p> 130</p> 131<p>Thus for a typical date period the contents of the input stream might look like this: </p> 132<pre class="programlisting"><span class="special">[</span><span class="identifier">March</span> <span class="number">01</span><span class="special">,</span> <span class="number">2004</span><span class="special">/</span><span class="identifier">June</span> <span class="number">07</span><span class="special">,</span> <span class="number">2004</span><span class="special">]</span> <span class="special"><</span><span class="special">--</span> <span class="identifier">closed</span> <span class="identifier">range</span> 133<span class="special">[</span><span class="identifier">March</span> <span class="number">01</span><span class="special">,</span> <span class="number">2004</span><span class="special">/</span><span class="identifier">June</span> <span class="number">08</span><span class="special">,</span> <span class="number">2004</span><span class="special">)</span> <span class="special"><</span><span class="special">--</span> <span class="identifier">open</span> <span class="identifier">range</span> 134</pre> 135<p> </p> 136</li> 137</ol></div> 138</div> 139<div class="refsect2"> 140<a name="id-1.3.14.15.3.37.3.4.6"></a><h3> 141<a name="id-1_3_14_15_3_38_1_1_1_17-bb"></a><code class="computeroutput">period_parser</code> private member functions</h3> 142<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 143<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_14_15_3_38_1_1_1_17_1-bb"></a><span class="identifier">consume_delim</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> stream_end<span class="special">,</span> 144 <span class="keyword">const</span> <span class="identifier">string_type</span> <span class="special">&</span> delim<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>throws ios_base::failure if delimiter and parsed data do not match </li></ol></div> 145</div> 146</div> 147</div> 148<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 149<td align="left"></td> 150<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 151 <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> 152</div></td> 153</tr></table> 154<hr> 155<div class="spirit-nav"> 156<a accesskey="p" href="period_formatter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../date_time/doxy.html#header.boost.date_time.period_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="special_values_formatter.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 157</div> 158</body> 159</html> 160
