diff options
Diffstat (limited to 'doc/html/boost/program_options')
53 files changed, 654 insertions, 695 deletions
diff --git a/doc/html/boost/program_options/abstract_variables_map.html b/doc/html/boost/program_options/abstract_variables_map.html index 5cb6659920..846979aabb 100644 --- a/doc/html/boost/program_options/abstract_variables_map.html +++ b/doc/html/boost/program_options/abstract_variables_map.html @@ -36,37 +36,37 @@ <span class="keyword">class</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="abstract_variables_map.html#boost.program_options.abstract_variables_mapconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="abstract_variables_map.html#idp682591824-bb"><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="abstract_variables_map.html#idp682592112-bb"><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="abstract_variables_map.html#idp682593536-bb"><span class="special">~</span><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="abstract_variables_map.html#idp709292032-bb"><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="abstract_variables_map.html#idp709292320-bb"><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="abstract_variables_map.html#idp709293744-bb"><span class="special">~</span><span class="identifier">abstract_variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="abstract_variables_map.html#idp682581472-bb">public member functions</a></span> - <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="abstract_variables_map.html#idp682582032-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="abstract_variables_map.html#idp682589360-bb"><span class="identifier">next</span></a><span class="special">(</span><a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="abstract_variables_map.html#idp709281680-bb">public member functions</a></span> + <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="abstract_variables_map.html#idp709282240-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="abstract_variables_map.html#idp709289568-bb"><span class="identifier">next</span></a><span class="special">(</span><a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="abstract_variables_map.html#idp682593824-bb">private member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="abstract_variables_map.html#idp682594400-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="comment">// <a class="link" href="abstract_variables_map.html#idp709294032-bb">private member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="abstract_variables_map.html#idp709294608-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440333648"></a><h2>Description</h2> +<a name="idp424110800"></a><h2>Description</h2> <p>Implements string->string mapping with convenient value casting facilities. </p> <div class="refsect2"> -<a name="idp440334528"></a><h3> +<a name="idp424111680"></a><h3> <a name="boost.program_options.abstract_variables_mapconstruct-copy-destruct"></a><code class="computeroutput">abstract_variables_map</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682591824-bb"></a><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682592112-bb"></a><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682593536-bb"></a><span class="special">~</span><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp709292032-bb"></a><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp709292320-bb"></a><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp709293744-bb"></a><span class="special">~</span><span class="identifier">abstract_variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp440350544"></a><h3> -<a name="idp682581472-bb"></a><code class="computeroutput">abstract_variables_map</code> public member functions</h3> +<a name="idp424127568"></a><h3> +<a name="idp709281680-bb"></a><code class="computeroutput">abstract_variables_map</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp682582032-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp709282240-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Obtains the value of variable 'name', from *this and possibly from the chain of variable maps.</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"> @@ -93,16 +93,16 @@ </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682589360-bb"></a><span class="identifier">next</span><span class="special">(</span><a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp709289568-bb"></a><span class="identifier">next</span><span class="special">(</span><a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre> <p>Sets next variable map, which will be used to find variables not found in *this. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp440374480"></a><h3> -<a name="idp682593824-bb"></a><code class="computeroutput">abstract_variables_map</code> private member functions</h3> +<a name="idp424151504"></a><h3> +<a name="idp709294032-bb"></a><code class="computeroutput">abstract_variables_map</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp682594400-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp709294608-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>Returns value of variable 'name' stored in *this, or empty value otherwise. </p> </li></ol></div> </div> diff --git a/doc/html/boost/program_options/ambiguous_option.html b/doc/html/boost/program_options/ambiguous_option.html index 77c88ea357..0a40f832bc 100644 --- a/doc/html/boost/program_options/ambiguous_option.html +++ b/doc/html/boost/program_options/ambiguous_option.html @@ -38,38 +38,38 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="ambiguous_option.html#boost.program_options.ambiguous_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="ambiguous_option.html#idp682136944-bb"><span class="identifier">ambiguous_option</span></a><span class="special">(</span><span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="ambiguous_option.html#idp682137936-bb"><span class="special">~</span><span class="identifier">ambiguous_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="ambiguous_option.html#idp708848000-bb"><span class="identifier">ambiguous_option</span></a><span class="special">(</span><span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="ambiguous_option.html#idp708848992-bb"><span class="special">~</span><span class="identifier">ambiguous_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="ambiguous_option.html#idp682135088-bb">public member functions</a></span> - <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> <a class="link" href="ambiguous_option.html#idp682135648-bb"><span class="identifier">alternatives</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="ambiguous_option.html#idp708846144-bb">public member functions</a></span> + <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> <a class="link" href="ambiguous_option.html#idp708846704-bb"><span class="identifier">alternatives</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="ambiguous_option.html#idp682138224-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="ambiguous_option.html#idp682138800-bb"><span class="identifier">substitute_placeholders</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="ambiguous_option.html#idp708849280-bb">protected member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="ambiguous_option.html#idp708849856-bb"><span class="identifier">substitute_placeholders</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437025616"></a><h2>Description</h2> +<a name="idp420876592"></a><h2>Description</h2> <p>Class thrown when there's ambiguity amoung several possible options. </p> <div class="refsect2"> -<a name="idp437026288"></a><h3> +<a name="idp420877264"></a><h3> <a name="boost.program_options.ambiguous_optionconstruct-copy-destruct"></a><code class="computeroutput">ambiguous_option</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682136944-bb"></a><span class="identifier">ambiguous_option</span><span class="special">(</span><span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> xalternatives<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682137936-bb"></a><span class="special">~</span><span class="identifier">ambiguous_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708848000-bb"></a><span class="identifier">ambiguous_option</span><span class="special">(</span><span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> xalternatives<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708848992-bb"></a><span class="special">~</span><span class="identifier">ambiguous_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp437042576"></a><h3> -<a name="idp682135088-bb"></a><code class="computeroutput">ambiguous_option</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> <a name="idp682135648-bb"></a><span class="identifier">alternatives</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> +<a name="idp420893616"></a><h3> +<a name="idp708846144-bb"></a><code class="computeroutput">ambiguous_option</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> <a name="idp708846704-bb"></a><span class="identifier">alternatives</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp437055168"></a><h3> -<a name="idp682138224-bb"></a><code class="computeroutput">ambiguous_option</code> protected member functions</h3> +<a name="idp420906208"></a><h3> +<a name="idp708849280-bb"></a><code class="computeroutput">ambiguous_option</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp682138800-bb"></a><span class="identifier">substitute_placeholders</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> error_template<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp708849856-bb"></a><span class="identifier">substitute_placeholders</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> error_template<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Makes all substitutions using the template </p> </li></ol></div> </div> diff --git a/doc/html/boost/program_options/basic_command_line_parser.html b/doc/html/boost/program_options/basic_command_line_parser.html index 631622a0e5..f4f47f97a5 100644 --- a/doc/html/boost/program_options/basic_command_line_parser.html +++ b/doc/html/boost/program_options/basic_command_line_parser.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="basic_parsed__idp682320512.html" title="Class basic_parsed_options<wchar_t>"> +<link rel="prev" href="basic_parsed__idp709020576.html" title="Class basic_parsed_options<wchar_t>"> <link rel="next" href="collect_unrecognized_mode.html" title="Type collect_unrecognized_mode"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_parsed__idp682320512.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_parsed__idp709020576.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.basic_command_line_parser"></a><div class="titlepage"></div> @@ -36,71 +36,71 @@ <span class="keyword">class</span> <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">:</span> <span class="keyword">private</span> <span class="identifier">cmdline</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="basic_command_line_parser.html#boost.program_options.basic_command_line_parserconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_command_line_parser.html#idp682353072-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">const</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> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html#idp682354592-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html#idp709053136-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">const</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> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html#idp709054656-bb"><span class="identifier">basic_command_line_parser</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_command_line_parser.html#idp682336976-bb">public member functions</a></span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp682337536-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_command_line_parser.html#idp709037040-bb">public member functions</a></span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp709037600-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> - <a class="link" href="basic_command_line_parser.html#idp682340256-bb"><span class="identifier">positional</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_op_idp682411312.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp682343008-bb"><span class="identifier">style</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp682345280-bb"><span class="identifier">extra_parser</span></a><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a class="link" href="basic_command_line_parser.html#idp682347552-bb"><span class="identifier">run</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp682349152-bb"><span class="identifier">allow_unregistered</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp682351072-bb"><span class="identifier">extra_style_parser</span></a><span class="special">(</span><span class="identifier">style_parser</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html#idp709040320-bb"><span class="identifier">positional</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_op_idp709111376.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp709043072-bb"><span class="identifier">style</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp709045344-bb"><span class="identifier">extra_parser</span></a><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a class="link" href="basic_command_line_parser.html#idp709047616-bb"><span class="identifier">run</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp709049216-bb"><span class="identifier">allow_unregistered</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a class="link" href="basic_command_line_parser.html#idp709051136-bb"><span class="identifier">extra_style_parser</span></a><span class="special">(</span><span class="identifier">style_parser</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438646016"></a><h2>Description</h2> +<a name="idp422421552"></a><h2>Description</h2> <p>Command line parser.</p> <p>The class allows one to specify all the information needed for parsing and to parse the command line. It is primarily needed to emulate named function parameters -- a regular function with 5 parameters will be hard to use and creating overloads with a smaller number of parameters will be confusing.</p> <p>For the most common case, the function parse_command_line is a better alternative.</p> <p>There are two typedefs -- command_line_parser and wcommand_line_parser, for charT == char and charT == wchar_t cases. </p> <div class="refsect2"> -<a name="idp438648032"></a><h3> +<a name="idp422423568"></a><h3> <a name="boost.program_options.basic_command_line_parserconstruct-copy-destruct"></a><code class="computeroutput">basic_command_line_parser</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp682353072-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">const</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> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp709053136-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">const</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> <span class="special">&</span> args<span class="special">)</span><span class="special">;</span></pre> <p>Creates a command line parser for the specified arguments list. The 'args' parameter should not include program name. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp682354592-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">int</span> argc<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> argv<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp709054656-bb"></a><span class="identifier">basic_command_line_parser</span><span class="special">(</span><span class="keyword">int</span> argc<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">charT</span> <span class="special">*</span><span class="keyword">const</span> argv<span class="special">)</span><span class="special">;</span></pre> <p>Creates a command line parser for the specified arguments list. The parameters should be the same as passed to 'main'. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp438670432"></a><h3> -<a name="idp682336976-bb"></a><code class="computeroutput">basic_command_line_parser</code> public member functions</h3> +<a name="idp422445968"></a><h3> +<a name="idp709037040-bb"></a><code class="computeroutput">basic_command_line_parser</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp682337536-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp709037600-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Sets options descriptions to use. </p> </li> <li class="listitem"> <pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> -<a name="idp682340256-bb"></a><span class="identifier">positional</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_op_idp682411312.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> +<a name="idp709040320-bb"></a><span class="identifier">positional</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="positional_op_idp709111376.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Sets positional options description to use. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp682343008-bb"></a><span class="identifier">style</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp709043072-bb"></a><span class="identifier">style</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span></pre> <p>Sets the command line style. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp682345280-bb"></a><span class="identifier">extra_parser</span><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp709045344-bb"></a><span class="identifier">extra_parser</span><span class="special">(</span><span class="identifier">ext_parser</span><span class="special">)</span><span class="special">;</span></pre> <p>Sets the extra parsers. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="idp682347552-bb"></a><span class="identifier">run</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <a name="idp709047616-bb"></a><span class="identifier">run</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Parses the options and returns the result of parsing. Throws on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp682349152-bb"></a><span class="identifier">allow_unregistered</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp709049216-bb"></a><span class="identifier">allow_unregistered</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Specifies that unregistered options are allowed and should be passed though. For each command like token that looks like an option but does not contain a recognized name, an instance of basic_option<charT> will be added to result, with 'unrecognized' field set to 'true'. It's possible to collect all unrecognized options with the 'collect_unrecognized' funciton. </p> </li> -<li class="listitem"><pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp682351072-bb"></a><span class="identifier">extra_style_parser</span><span class="special">(</span><span class="identifier">style_parser</span> s<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> <span class="special">&</span> <a name="idp709051136-bb"></a><span class="identifier">extra_style_parser</span><span class="special">(</span><span class="identifier">style_parser</span> s<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> @@ -115,7 +115,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_parsed__idp682320512.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_parsed__idp709020576.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized_mode.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/basic_option.html b/doc/html/boost/program_options/basic_option.html index d8fca6e525..eacbefd3b4 100644 --- a/doc/html/boost/program_options/basic_option.html +++ b/doc/html/boost/program_options/basic_option.html @@ -36,8 +36,8 @@ <span class="keyword">class</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="basic_option.html#boost.program_options.basic_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_option.html#idp682202992-bb"><span class="identifier">basic_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_option.html#idp682203280-bb"><span class="identifier">basic_option</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_option.html#idp708914208-bb"><span class="identifier">basic_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_option.html#idp708914496-bb"><span class="identifier">basic_option</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_option.html#boost.program_options.basic_optionpublic-data-members">public data members</a></span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="basic_option.html#boost.program_options.basic_option.string_key"><span class="identifier">string_key</span></a><span class="special">;</span> @@ -48,21 +48,21 @@ <span class="keyword">bool</span> <a class="link" href="basic_option.html#boost.program_options.basic_option.case_insensitive"><span class="identifier">case_insensitive</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437513728"></a><h2>Description</h2> +<a name="idp421364736"></a><h2>Description</h2> <p>Option found in input source. Contains a key and a value. The key, in turn, can be a string (name of an option), or an integer (position in input source) -- in case no name is specified. The latter is only possible for command line. The template parameter specifies the type of char used for storing the option's value. </p> <div class="refsect2"> -<a name="idp437514736"></a><h3> +<a name="idp421365744"></a><h3> <a name="boost.program_options.basic_optionconstruct-copy-destruct"></a><code class="computeroutput">basic_option</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682202992-bb"></a><span class="identifier">basic_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682203280-bb"></a><span class="identifier">basic_option</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> xstring_key<span class="special">,</span> +<li class="listitem"><pre class="literallayout"><a name="idp708914208-bb"></a><span class="identifier">basic_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708914496-bb"></a><span class="identifier">basic_option</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> xstring_key<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> xvalue<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp437534304"></a><h3> +<a name="idp421385168"></a><h3> <a name="boost.program_options.basic_optionpublic-data-members"></a><code class="computeroutput">basic_option</code> public public data members</h3> diff --git a/doc/html/boost/program_options/basic_parsed__idp682320512.html b/doc/html/boost/program_options/basic_parsed__idp709020576.html index 7c58ee5379..5bf740a3d8 100644 --- a/doc/html/boost/program_options/basic_parsed__idp682320512.html +++ b/doc/html/boost/program_options/basic_parsed__idp709020576.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="basic_parsed_options.html" title="Class template basic_parsed_options"> +<link rel="prev" href="duplicate_option_error.html" title="Class duplicate_option_error"> <link rel="next" href="basic_command_line_parser.html" title="Class template basic_command_line_parser"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_options.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="basic_command_line_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="basic_command_line_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.basic_parsed__idp682320512"></a><div class="titlepage"></div> +<a name="boost.program_options.basic_parsed__idp709020576"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class basic_parsed_options<wchar_t></span></h2> <p>boost::program_options::basic_parsed_options<wchar_t></p> @@ -33,19 +33,19 @@ <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="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="basic_parsed__idp682320512.html" title="Class basic_parsed_options<wchar_t>">basic_parsed_options</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="basic_parsed__idp709020576.html" title="Class basic_parsed_options<wchar_t>">basic_parsed_options</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="basic_parsed__idp682320512.html#boost.program_options.basic_parsed__idp682320512construct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_parsed__idp682320512.html#idp682331264-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_parsed__idp709020576.html#boost.program_options.basic_parsed__idp709020576construct-copy-destruct">construct/copy/destruct</a></span> + <span class="keyword">explicit</span> <a class="link" href="basic_parsed__idp709020576.html#idp709031328-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_parsed__idp682320512.html#boost.program_options.basic_parsed__idp682320512public-data-members">public data members</a></span> + <span class="comment">// <a class="link" href="basic_parsed__idp709020576.html#boost.program_options.basic_parsed__idp709020576public-data-members">public data members</a></span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">></span> <span class="identifier">options</span><span class="special">;</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <span class="identifier">description</span><span class="special">;</span> - <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <a class="link" href="basic_parsed__idp682320512.html#boost.program_options.basic_parsed__idp682320512.utf8_encoded_options"><span class="identifier">utf8_encoded_options</span></a><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="basic_parsed__idp682320512.html#boost.program_options.basic_parsed__idp682320512.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span> + <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <a class="link" href="basic_parsed__idp709020576.html#boost.program_options.basic_parsed__idp709020576.utf8_encoded_options"><span class="identifier">utf8_encoded_options</span></a><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="basic_parsed__idp709020576.html#boost.program_options.basic_parsed__idp709020576.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438547200"></a><h2>Description</h2> +<a name="idp422322336"></a><h2>Description</h2> <p>Specialization of <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a> which:</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> <li class="listitem"><p>provides convenient conversion from <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options<char></a></p></li> @@ -54,27 +54,27 @@ <p> </p> <div class="refsect2"> -<a name="idp438550832"></a><h3> -<a name="boost.program_options.basic_parsed__idp682320512construct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> +<a name="idp422325968"></a><h3> +<a name="boost.program_options.basic_parsed__idp709020576construct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp682331264-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> po<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp709031328-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> po<span class="special">)</span><span class="special">;</span></pre> <p>Constructs wrapped options from options in UTF8 encoding. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp438562032"></a><h3> -<a name="boost.program_options.basic_parsed__idp682320512public-data-members"></a><code class="computeroutput">basic_parsed_options</code> +<a name="idp422337104"></a><h3> +<a name="boost.program_options.basic_parsed__idp709020576public-data-members"></a><code class="computeroutput">basic_parsed_options</code> public public data members</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <a name="boost.program_options.basic_parsed__idp682320512.utf8_encoded_options"></a><span class="identifier">utf8_encoded_options</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <a name="boost.program_options.basic_parsed__idp709020576.utf8_encoded_options"></a><span class="identifier">utf8_encoded_options</span><span class="special">;</span></pre> <p>Stores UTF8 encoded options that were passed to constructor, to avoid reverse conversion in some cases. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_parsed__idp682320512.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_parsed__idp709020576.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre> <p>Mainly used for the diagnostic messages in exceptions. The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short </p> </li> </ol></div> @@ -91,7 +91,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_parsed_options.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="basic_command_line_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="basic_command_line_parser.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/basic_parsed_options.html b/doc/html/boost/program_options/basic_parsed_options.html index 1004910cc1..8f67db98d4 100644 --- a/doc/html/boost/program_options/basic_parsed_options.html +++ b/doc/html/boost/program_options/basic_parsed_options.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="duplicate_option_error.html" title="Class duplicate_option_error"> -<link rel="next" href="basic_parsed__idp682320512.html" title="Class basic_parsed_options<wchar_t>"> +<link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> +<link rel="prev" href="bool_switch.html" title="Function bool_switch"> +<link rel="next" href="variable_value.html" title="Class variable_value"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="basic_parsed__idp682320512.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.basic_parsed_options"></a><div class="titlepage"></div> @@ -30,54 +30,25 @@ <p>boost::program_options::basic_parsed_options</p> </div> <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> -<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="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>">boost/program_options/parsers.hpp</a>> +<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="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>">boost/program_options/variables_map.hpp</a>> </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> <span class="keyword">class</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionsconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_parsed_options.html#idp682317840-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - - <span class="comment">// <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_optionspublic-data-members">public data members</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.options"><span class="identifier">options</span></a><span class="special">;</span> - <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.description"><span class="identifier">description</span></a><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="basic_parsed_options.html#boost.program_options.basic_parsed_options.m_options_prefix"><span class="identifier">m_options_prefix</span></a><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="basic_parsed_options.html#idp709259008-bb"><span class="identifier">basic_parsed_options</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438473552"></a><h2>Description</h2> +<a name="idp423902592"></a><h2>Description</h2> <p>Results of parsing an input source. The primary use of this class is passing information from parsers component to value storage component. This class does not makes much sense itself. </p> <div class="refsect2"> -<a name="idp438474432"></a><h3> +<a name="idp423903472"></a><h3> <a name="boost.program_options.basic_parsed_optionsconstruct-copy-destruct"></a><code class="computeroutput">basic_parsed_options</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp682317840-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> xdescription<span class="special">,</span> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp709259008-bb"></a><span class="identifier">basic_parsed_options</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> xdescription<span class="special">,</span> <span class="keyword">int</span> options_prefix <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> -<div class="refsect2"> -<a name="idp438485920"></a><h3> -<a name="boost.program_options.basic_parsed_optionspublic-data-members"></a><code class="computeroutput">basic_parsed_options</code> - public - public data members</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <a name="boost.program_options.basic_parsed_options.options"></a><span class="identifier">options</span><span class="special">;</span></pre> -<p>Options found in the source. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> <a name="boost.program_options.basic_parsed_options.description"></a><span class="identifier">description</span><span class="special">;</span></pre> -<p>Options description that was used for parsing. Parsers should return pointer to the instance of <a class="link" href="option_description.html" title="Class option_description">option_description</a> passed to them, and issues of lifetime are up to the caller. Can be NULL. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="boost.program_options.basic_parsed_options.m_options_prefix"></a><span class="identifier">m_options_prefix</span><span class="special">;</span></pre> -<p>Mainly used for the diagnostic messages in exceptions. The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short </p> -</li> -</ol></div> -</div> -<div class="refsect2"> -<a name="idp438506880"></a><h3>Specializations</h3> -<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a class="link" href="basic_parsed__idp682320512.html" title="Class basic_parsed_options<wchar_t>">Class basic_parsed_options<wchar_t></a></p></li></ul></div> -</div> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -90,7 +61,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="duplicate_option_error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="basic_parsed__idp682320512.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/bool_switch.html b/doc/html/boost/program_options/bool_switch.html index d6ac9f594c..4f5f1e892e 100644 --- a/doc/html/boost/program_options/bool_switch.html +++ b/doc/html/boost/program_options/bool_switch.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> <link rel="prev" href="wvalue.html" title="Function wvalue"> -<link rel="next" href="variable_value.html" title="Class variable_value"> +<link rel="next" href="basic_parsed_options.html" title="Class template basic_parsed_options"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="basic_parsed_options.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.bool_switch"></a><div class="titlepage"></div> @@ -36,7 +36,7 @@ <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="keyword">bool</span> <span class="special">></span> <span class="special">*</span> <span class="identifier">bool_switch</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="keyword">bool</span> <span class="special">></span> <span class="special">*</span> <span class="identifier">bool_switch</span><span class="special">(</span><span class="keyword">bool</span> <span class="special">*</span> v<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440092240"></a><h2>Description</h2> +<a name="idp423831504"></a><h2>Description</h2> <p>Works the same way as the 'value<bool>' function, but the created <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code> won't accept any explicit value. So, if the option is present on the command line, the value will be 'true'. </p> </div> </div> @@ -50,7 +50,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="variable_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="basic_parsed_options.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/collect_unrecognized.html b/doc/html/boost/program_options/collect_unrecognized.html index 71438414f3..80bfc8ac68 100644 --- a/doc/html/boost/program_options/collect_unrecognized.html +++ b/doc/html/boost/program_options/collect_unrecognized.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="parse_config__idp682378032.html" title="Function template parse_config_file"> -<link rel="next" href="parse_environ_idp682387952.html" title="Function parse_environment"> +<link rel="prev" href="parse_config__idp709078096.html" title="Function template parse_config_file"> +<link rel="next" href="parse_environ_idp709088016.html" title="Function parse_environment"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_config__idp682378032.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp682387952.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_config__idp709078096.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp709088016.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.collect_unrecognized"></a><div class="titlepage"></div> @@ -38,7 +38,7 @@ <span class="identifier">collect_unrecognized</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <a class="link" href="basic_option.html" title="Class template basic_option">basic_option</a><span class="special"><</span> <span class="identifier">charT</span> <span class="special">></span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <span class="keyword">enum</span> <span class="identifier">collect_unrecognized_mode</span> mode<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438851680"></a><h2>Description</h2> +<a name="idp422627104"></a><h2>Description</h2> <p>Collects the original tokens for all named options with 'unregistered' flag set. If 'mode' is 'include_positional' also collects all positional options. Returns the vector of origianl tokens for all collected options. </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_config__idp682378032.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp682387952.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_config__idp709078096.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp709088016.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/collect_unrecognized_mode.html b/doc/html/boost/program_options/collect_unrecognized_mode.html index d3bca72751..e71b0f9bba 100644 --- a/doc/html/boost/program_options/collect_unrecognized_mode.html +++ b/doc/html/boost/program_options/collect_unrecognized_mode.html @@ -36,7 +36,7 @@ <span class="keyword">enum</span> <span class="identifier">collect_unrecognized_mode</span> <span class="special">{</span> include_positional, exclude_positional <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438725776"></a><h2>Description</h2> +<a name="idp422501200"></a><h2>Description</h2> <p>Controls if the 'collect_unregistered' function should include positional options, or not. </p> </div> </div> diff --git a/doc/html/boost/program_options/command_line_style/style_t.html b/doc/html/boost/program_options/command_line_style/style_t.html index a271bc5039..abf688efbd 100644 --- a/doc/html/boost/program_options/command_line_style/style_t.html +++ b/doc/html/boost/program_options/command_line_style/style_t.html @@ -52,7 +52,7 @@ | allow_dash_for_short), <a class="link" href="style_t.html#boost.program_options.command_line_style.style_t.default_style">default_style</a> = = unix_style <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436117456"></a><h2>Description</h2> +<a name="idp419969904"></a><h2>Description</h2> <p>Various possible styles of options.</p> <p>There are "long" options, which start with "--" and "short", which start with either "-" or "/". Both kinds can be allowed or disallowed, see allow_long and allow_short. The allowed character for short options is also configurable.</p> <p>Option's value can be specified in the same token as name ("--foo=bar"), or in the next token.</p> diff --git a/doc/html/boost/program_options/duplicate_option_error.html b/doc/html/boost/program_options/duplicate_option_error.html index 7af79b80d8..15053c7a3f 100644 --- a/doc/html/boost/program_options/duplicate_option_error.html +++ b/doc/html/boost/program_options/duplicate_option_error.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> <link rel="prev" href="options_description.html" title="Class options_description"> -<link rel="next" href="basic_parsed_options.html" title="Class template basic_parsed_options"> +<link rel="next" href="basic_parsed__idp709020576.html" title="Class basic_parsed_options<wchar_t>"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="options_description.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="basic_parsed_options.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="options_description.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="basic_parsed__idp709020576.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.duplicate_option_error"></a><div class="titlepage"></div> @@ -36,17 +36,17 @@ <span class="keyword">class</span> <a class="link" href="duplicate_option_error.html" title="Class duplicate_option_error">duplicate_option_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="duplicate_option_error.html#boost.program_options.duplicate_option_errorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="duplicate_option_error.html#idp682306048-bb"><span class="identifier">duplicate_option_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="duplicate_option_error.html#idp709017264-bb"><span class="identifier">duplicate_option_error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438188832"></a><h2>Description</h2> +<a name="idp422040336"></a><h2>Description</h2> <p>Class thrown when duplicate option description is found. </p> <div class="refsect2"> -<a name="idp438189504"></a><h3> +<a name="idp422041008"></a><h3> <a name="boost.program_options.duplicate_option_errorconstruct-copy-destruct"></a><code class="computeroutput">duplicate_option_error</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682306048-bb"></a><span class="identifier">duplicate_option_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> xwhat<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp709017264-bb"></a><span class="identifier">duplicate_option_error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> xwhat<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> @@ -60,7 +60,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="options_description.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="basic_parsed_options.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="options_description.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="basic_parsed__idp709020576.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/error.html b/doc/html/boost/program_options/error.html index 01032bb394..1820e72100 100644 --- a/doc/html/boost/program_options/error.html +++ b/doc/html/boost/program_options/error.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> <link rel="prev" href="../eof_iterator.html" title="Class template eof_iterator"> -<link rel="next" href="too_many_posi_idp682066288.html" title="Class too_many_positional_options_error"> +<link rel="next" href="too_many_posi_idp708777344.html" title="Class too_many_positional_options_error"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../eof_iterator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="too_many_posi_idp682066288.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../eof_iterator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="too_many_posi_idp708777344.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.error"></a><div class="titlepage"></div> @@ -36,17 +36,17 @@ <span class="keyword">class</span> <a class="link" href="error.html" title="Class error">error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">logic_error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="error.html#boost.program_options.errorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="error.html#idp682065312-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="error.html#idp708776368-bb"><span class="identifier">error</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436387984"></a><h2>Description</h2> +<a name="idp420239888"></a><h2>Description</h2> <p>Base class for all errors in the library. </p> <div class="refsect2"> -<a name="idp436388656"></a><h3> +<a name="idp420240624"></a><h3> <a name="boost.program_options.errorconstruct-copy-destruct"></a><code class="computeroutput">error</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682065312-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> xwhat<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp708776368-bb"></a><span class="identifier">error</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> xwhat<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> @@ -60,7 +60,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../eof_iterator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="too_many_posi_idp682066288.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../eof_iterator.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="too_many_posi_idp708777344.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/error_with_no_option_name.html b/doc/html/boost/program_options/error_with_no_option_name.html index 0a6db57ee3..39f5396a24 100644 --- a/doc/html/boost/program_options/error_with_no_option_name.html +++ b/doc/html/boost/program_options/error_with_no_option_name.html @@ -38,33 +38,33 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="error_with_no_option_name.html#boost.program_options.error_with_no_option_nameconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="error_with_no_option_name.html#idp682127680-bb"><span class="identifier">error_with_no_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="error_with_no_option_name.html#idp682129632-bb"><span class="special">~</span><span class="identifier">error_with_no_option_name</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="error_with_no_option_name.html#idp708838736-bb"><span class="identifier">error_with_no_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="error_with_no_option_name.html#idp708840688-bb"><span class="special">~</span><span class="identifier">error_with_no_option_name</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="error_with_no_option_name.html#idp682124688-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_no_option_name.html#idp682125248-bb"><span class="identifier">set_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="error_with_no_option_name.html#idp708835744-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_no_option_name.html#idp708836304-bb"><span class="identifier">set_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436907184"></a><h2>Description</h2> +<a name="idp420758272"></a><h2>Description</h2> <p>Base class of unparsable options, when the desired option cannot be identified.</p> <p>It makes no sense to have an option name, when we can't match an option to the parameter</p> <p>Having this a part of the <a class="link" href="error_with_option_name.html" title="Class error_with_option_name">error_with_option_name</a> hierachy makes error handling a lot easier, even if the name indicates some sort of conceptual dissonance! </p> <div class="refsect2"> -<a name="idp436909680"></a><h3> +<a name="idp420760768"></a><h3> <a name="boost.program_options.error_with_no_option_nameconstruct-copy-destruct"></a><code class="computeroutput">error_with_no_option_name</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682127680-bb"></a><span class="identifier">error_with_no_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> template_<span class="special">,</span> +<li class="listitem"><pre class="literallayout"><a name="idp708838736-bb"></a><span class="identifier">error_with_no_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> template_<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682129632-bb"></a><span class="special">~</span><span class="identifier">error_with_no_option_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708840688-bb"></a><span class="special">~</span><span class="identifier">error_with_no_option_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp436927808"></a><h3> -<a name="idp682124688-bb"></a><code class="computeroutput">error_with_no_option_name</code> public member functions</h3> +<a name="idp420778960"></a><h3> +<a name="idp708835744-bb"></a><code class="computeroutput">error_with_no_option_name</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp682125248-bb"></a><span class="identifier">set_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp708836304-bb"></a><span class="identifier">set_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Does NOT set option name, because no option name makes sense </p> </li></ol></div> </div> diff --git a/doc/html/boost/program_options/error_with_option_name.html b/doc/html/boost/program_options/error_with_option_name.html index 820f912498..832d015d92 100644 --- a/doc/html/boost/program_options/error_with_option_name.html +++ b/doc/html/boost/program_options/error_with_option_name.html @@ -36,32 +36,32 @@ <span class="keyword">class</span> <a class="link" href="error_with_option_name.html" title="Class error_with_option_name">error_with_option_name</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="error_with_option_name.html#boost.program_options.error_with_option_nameconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="error_with_option_name.html#idp682099424-bb"><span class="identifier">error_with_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> + <a class="link" href="error_with_option_name.html#idp708810480-bb"><span class="identifier">error_with_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="error_with_option_name.html#idp682103328-bb"><span class="special">~</span><span class="identifier">error_with_option_name</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="error_with_option_name.html#idp708814384-bb"><span class="special">~</span><span class="identifier">error_with_option_name</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="error_with_option_name.html#idp682080192-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682080752-bb"><span class="identifier">set_substitute</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682083456-bb"><span class="identifier">set_substitute_default</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> + <span class="comment">// <a class="link" href="error_with_option_name.html#idp708791248-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708791808-bb"><span class="identifier">set_substitute</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708794512-bb"><span class="identifier">set_substitute_default</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682086848-bb"><span class="identifier">add_context</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682090192-bb"><span class="identifier">set_prefix</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682091728-bb"><span class="identifier">set_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp682094720-bb"><span class="identifier">get_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682095840-bb"><span class="identifier">set_original_token</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="error_with_option_name.html#idp682097376-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708797904-bb"><span class="identifier">add_context</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708801248-bb"><span class="identifier">set_prefix</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708802784-bb"><span class="identifier">set_option_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp708805776-bb"><span class="identifier">get_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708806896-bb"><span class="identifier">set_original_token</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="error_with_option_name.html#idp708808432-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="error_with_option_name.html#idp682104096-bb">protected member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682104672-bb"><span class="identifier">substitute_placeholders</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp682107200-bb"><span class="identifier">replace_token</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp682109696-bb"><span class="identifier">get_canonical_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp682111344-bb"><span class="identifier">get_canonical_option_prefix</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="error_with_option_name.html#idp708815152-bb">protected member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708815728-bb"><span class="identifier">substitute_placeholders</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#idp708818256-bb"><span class="identifier">replace_token</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp708820752-bb"><span class="identifier">get_canonical_option_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#idp708822400-bb"><span class="identifier">get_canonical_option_prefix</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="comment">// <a class="link" href="error_with_option_name.html#boost.program_options.error_with_option_namepublic-data-members">public data members</a></span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#boost.program_options.error_with_option_name.m_error_template"><span class="identifier">m_error_template</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436619376"></a><h2>Description</h2> +<a name="idp420470976"></a><h2>Description</h2> <p>Base class for most exceptions in the library.</p> <p>Substitutes the values for the parameter name placeholders in the template to create the human readable error message</p> <p>Placeholders are surrounded by % signs: example% Poor man's version of boost::format</p> @@ -69,71 +69,71 @@ <p>Options are displayed in "canonical" form This is the most unambiguous form of the <span class="emphasis"><em>parsed</em></span> option name and would correspond to option_description::format_name() i.e. what is shown by print_usage()</p> <p>The "canonical" form depends on whether the option is specified in short or long form, using dashes or slashes or without a prefix (from a configuration file) </p> <div class="refsect2"> -<a name="idp436622560"></a><h3> +<a name="idp420474160"></a><h3> <a name="boost.program_options.error_with_option_nameconstruct-copy-destruct"></a><code class="computeroutput">error_with_option_name</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682099424-bb"></a><span class="identifier">error_with_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> template_<span class="special">,</span> +<li class="listitem"><pre class="literallayout"><a name="idp708810480-bb"></a><span class="identifier">error_with_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> template_<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idp682103328-bb"></a><span class="special">~</span><span class="identifier">error_with_option_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp708814384-bb"></a><span class="special">~</span><span class="identifier">error_with_option_name</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>gcc says that throw specification on dtor is loosened without this line </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp436648576"></a><h3> -<a name="idp682080192-bb"></a><code class="computeroutput">error_with_option_name</code> public member functions</h3> +<a name="idp420500240"></a><h3> +<a name="idp708791248-bb"></a><code class="computeroutput">error_with_option_name</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682080752-bb"></a><span class="identifier">set_substitute</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> parameter_name<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp708791808-bb"></a><span class="identifier">set_substitute</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> parameter_name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre> <p>Substitute parameter_name->value to create the error message from the error template </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682083456-bb"></a><span class="identifier">set_substitute_default</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> parameter_name<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp708794512-bb"></a><span class="identifier">set_substitute_default</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> parameter_name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> from<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> to<span class="special">)</span><span class="special">;</span></pre> <p>If the parameter is missing, then make the from->to substitution instead </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682086848-bb"></a><span class="identifier">add_context</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp708797904-bb"></a><span class="identifier">add_context</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token<span class="special">,</span> <span class="keyword">int</span> option_style<span class="special">)</span><span class="special">;</span></pre> <p>Add context to an exception </p> </li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp682090192-bb"></a><span class="identifier">set_prefix</span><span class="special">(</span><span class="keyword">int</span> option_style<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp708801248-bb"></a><span class="identifier">set_prefix</span><span class="special">(</span><span class="keyword">int</span> option_style<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp682091728-bb"></a><span class="identifier">set_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp708802784-bb"></a><span class="identifier">set_option_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name<span class="special">)</span><span class="special">;</span></pre> <p>Overridden in <code class="computeroutput"><a class="link" href="error_with_no_option_name.html" title="Class error_with_no_option_name">error_with_no_option_name</a></code> </p> </li> -<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682094720-bb"></a><span class="identifier">get_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp682095840-bb"></a><span class="identifier">set_original_token</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708805776-bb"></a><span class="identifier">get_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp708806896-bb"></a><span class="identifier">set_original_token</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp682097376-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp708808432-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Creates the error_message on the fly Currently a thin wrapper for substitute_placeholders() </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp436726416"></a><h3> -<a name="idp682104096-bb"></a><code class="computeroutput">error_with_option_name</code> protected member functions</h3> +<a name="idp420577824"></a><h3> +<a name="idp708815152-bb"></a><code class="computeroutput">error_with_option_name</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp682104672-bb"></a><span class="identifier">substitute_placeholders</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> error_template<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp708815728-bb"></a><span class="identifier">substitute_placeholders</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> error_template<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Makes all substitutions using the template </p> </li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp682107200-bb"></a><span class="identifier">replace_token</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> from<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> to<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp708818256-bb"></a><span class="identifier">replace_token</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> from<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> to<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682109696-bb"></a><span class="identifier">get_canonical_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708820752-bb"></a><span class="identifier">get_canonical_option_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Construct option name in accordance with the appropriate prefix style: i.e. long dash or short slash etc </p> </li> -<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682111344-bb"></a><span class="identifier">get_canonical_option_prefix</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708822400-bb"></a><span class="identifier">get_canonical_option_prefix</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp436762224"></a><h3> +<a name="idp420613504"></a><h3> <a name="boost.program_options.error_with_option_namepublic-data-members"></a><code class="computeroutput">error_with_option_name</code> public public data members</h3> diff --git a/doc/html/boost/program_options/ext_parser.html b/doc/html/boost/program_options/ext_parser.html index 9bab472187..b091b5a0ad 100644 --- a/doc/html/boost/program_options/ext_parser.html +++ b/doc/html/boost/program_options/ext_parser.html @@ -35,7 +35,7 @@ </span> <span class="keyword">typedef</span> <span class="identifier">function1</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">></span> <span class="identifier">ext_parser</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438744896"></a><h2>Description</h2> +<a name="idp422520384"></a><h2>Description</h2> <p>Augments <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options<wchar_t></a> with conversion from 'parsed_options' </p> </div> </div> diff --git a/doc/html/boost/program_options/invalid_bool_value.html b/doc/html/boost/program_options/invalid_bool_value.html index 8622bfcf08..0954d12335 100644 --- a/doc/html/boost/program_options/invalid_bool_value.html +++ b/doc/html/boost/program_options/invalid_bool_value.html @@ -36,17 +36,17 @@ <span class="keyword">class</span> <a class="link" href="invalid_bool_value.html" title="Class invalid_bool_value">invalid_bool_value</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">validation_error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="invalid_bool_value.html#boost.program_options.invalid_bool_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_bool_value.html#idp682187392-bb"><span class="identifier">invalid_bool_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_bool_value.html#idp708898448-bb"><span class="identifier">invalid_bool_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437423008"></a><h2>Description</h2> +<a name="idp421273632"></a><h2>Description</h2> <p>Class thrown if there is an invalid bool value given </p> <div class="refsect2"> -<a name="idp437423744"></a><h3> +<a name="idp421274368"></a><h3> <a name="boost.program_options.invalid_bool_valueconstruct-copy-destruct"></a><code class="computeroutput">invalid_bool_value</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682187392-bb"></a><span class="identifier">invalid_bool_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp708898448-bb"></a><span class="identifier">invalid_bool_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/program_options/invalid_comma_idp682162800.html b/doc/html/boost/program_options/invalid_comma_idp708873856.html index e0b4f6463c..6c43a02907 100644 --- a/doc/html/boost/program_options/invalid_comma_idp682162800.html +++ b/doc/html/boost/program_options/invalid_comma_idp708873856.html @@ -24,7 +24,7 @@ <a accesskey="p" href="invalid_config_file_syntax.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="validation_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.invalid_comma_idp682162800"></a><div class="titlepage"></div> +<a name="boost.program_options.invalid_comma_idp708873856"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class invalid_command_line_syntax</span></h2> <p>boost::program_options::invalid_command_line_syntax</p> @@ -33,28 +33,28 @@ <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="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="invalid_comma_idp682162800.html" title="Class invalid_command_line_syntax">invalid_command_line_syntax</a> <span class="special">:</span> +<span class="keyword">class</span> <a class="link" href="invalid_comma_idp708873856.html" title="Class invalid_command_line_syntax">invalid_command_line_syntax</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">invalid_syntax</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="invalid_comma_idp682162800.html#boost.program_options.invalid_comma_idp682162800construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_comma_idp682162800.html#idp682164976-bb"><span class="identifier">invalid_command_line_syntax</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> + <span class="comment">// <a class="link" href="invalid_comma_idp708873856.html#boost.program_options.invalid_comma_idp708873856construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="invalid_comma_idp708873856.html#idp708876032-bb"><span class="identifier">invalid_command_line_syntax</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_comma_idp682162800.html#idp682168880-bb"><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_comma_idp708873856.html#idp708879936-bb"><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437259392"></a><h2>Description</h2> +<a name="idp421110320"></a><h2>Description</h2> <p>Class thrown when there are syntax errors in given command line </p> <div class="refsect2"> -<a name="idp437260064"></a><h3> -<a name="boost.program_options.invalid_comma_idp682162800construct-copy-destruct"></a><code class="computeroutput">invalid_command_line_syntax</code> +<a name="idp421111072"></a><h3> +<a name="boost.program_options.invalid_comma_idp708873856construct-copy-destruct"></a><code class="computeroutput">invalid_command_line_syntax</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682164976-bb"></a><span class="identifier">invalid_command_line_syntax</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span> +<li class="listitem"><pre class="literallayout"><a name="idp708876032-bb"></a><span class="identifier">invalid_command_line_syntax</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682168880-bb"></a><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708879936-bb"></a><span class="special">~</span><span class="identifier">invalid_command_line_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/program_options/invalid_command_line_style.html b/doc/html/boost/program_options/invalid_command_line_style.html index 1975e0eeb9..1628945054 100644 --- a/doc/html/boost/program_options/invalid_command_line_style.html +++ b/doc/html/boost/program_options/invalid_command_line_style.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="too_many_posi_idp682066288.html" title="Class too_many_positional_options_error"> +<link rel="prev" href="too_many_posi_idp708777344.html" title="Class too_many_positional_options_error"> <link rel="next" href="reading_file.html" title="Class reading_file"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="too_many_posi_idp682066288.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="reading_file.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="too_many_posi_idp708777344.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="reading_file.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.invalid_command_line_style"></a><div class="titlepage"></div> @@ -36,17 +36,17 @@ <span class="keyword">class</span> <a class="link" href="invalid_command_line_style.html" title="Class invalid_command_line_style">invalid_command_line_style</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="invalid_command_line_style.html#boost.program_options.invalid_command_line_styleconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_command_line_style.html#idp682070944-bb"><span class="identifier">invalid_command_line_style</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_command_line_style.html#idp708782000-bb"><span class="identifier">invalid_command_line_style</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436442096"></a><h2>Description</h2> +<a name="idp420293936"></a><h2>Description</h2> <p>Class thrown when there are programming error related to style </p> <div class="refsect2"> -<a name="idp436442768"></a><h3> +<a name="idp420294608"></a><h3> <a name="boost.program_options.invalid_command_line_styleconstruct-copy-destruct"></a><code class="computeroutput">invalid_command_line_style</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682070944-bb"></a><span class="identifier">invalid_command_line_style</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> msg<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp708782000-bb"></a><span class="identifier">invalid_command_line_style</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> msg<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> @@ -60,7 +60,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="too_many_posi_idp682066288.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="reading_file.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="too_many_posi_idp708777344.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="reading_file.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/invalid_config_file_syntax.html b/doc/html/boost/program_options/invalid_config_file_syntax.html index e1c86b3f0f..940842063c 100644 --- a/doc/html/boost/program_options/invalid_config_file_syntax.html +++ b/doc/html/boost/program_options/invalid_config_file_syntax.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> <link rel="prev" href="invalid_syntax.html" title="Class invalid_syntax"> -<link rel="next" href="invalid_comma_idp682162800.html" title="Class invalid_command_line_syntax"> +<link rel="next" href="invalid_comma_idp708873856.html" title="Class invalid_command_line_syntax"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="invalid_syntax.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_comma_idp682162800.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="invalid_syntax.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_comma_idp708873856.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.invalid_config_file_syntax"></a><div class="titlepage"></div> @@ -38,29 +38,29 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="invalid_config_file_syntax.html#boost.program_options.invalid_config_file_syntaxconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_config_file_syntax.html#idp682160848-bb"><span class="identifier">invalid_config_file_syntax</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_config_file_syntax.html#idp682162512-bb"><span class="special">~</span><span class="identifier">invalid_config_file_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_config_file_syntax.html#idp708871904-bb"><span class="identifier">invalid_config_file_syntax</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_config_file_syntax.html#idp708873568-bb"><span class="special">~</span><span class="identifier">invalid_config_file_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="invalid_config_file_syntax.html#idp682158288-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_config_file_syntax.html#idp682158848-bb"><span class="identifier">tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="invalid_config_file_syntax.html#idp708869344-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_config_file_syntax.html#idp708869904-bb"><span class="identifier">tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437201392"></a><h2>Description</h2> +<a name="idp421052496"></a><h2>Description</h2> <div class="refsect2"> -<a name="idp437201808"></a><h3> +<a name="idp421052912"></a><h3> <a name="boost.program_options.invalid_config_file_syntaxconstruct-copy-destruct"></a><code class="computeroutput">invalid_config_file_syntax</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682160848-bb"></a><span class="identifier">invalid_config_file_syntax</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> invalid_line<span class="special">,</span> <span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682162512-bb"></a><span class="special">~</span><span class="identifier">invalid_config_file_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708871904-bb"></a><span class="identifier">invalid_config_file_syntax</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> invalid_line<span class="special">,</span> <span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708873568-bb"></a><span class="special">~</span><span class="identifier">invalid_config_file_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp437216448"></a><h3> -<a name="idp682158288-bb"></a><code class="computeroutput">invalid_config_file_syntax</code> public member functions</h3> +<a name="idp421067552"></a><h3> +<a name="idp708869344-bb"></a><code class="computeroutput">invalid_config_file_syntax</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682158848-bb"></a><span class="identifier">tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708869904-bb"></a><span class="identifier">tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Convenience functions for backwards compatibility </p> </li></ol></div> </div> @@ -76,7 +76,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="invalid_syntax.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_comma_idp682162800.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="invalid_syntax.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_comma_idp708873856.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/invalid_option_value.html b/doc/html/boost/program_options/invalid_option_value.html index fddc6c4ff2..a2b104f200 100644 --- a/doc/html/boost/program_options/invalid_option_value.html +++ b/doc/html/boost/program_options/invalid_option_value.html @@ -36,20 +36,20 @@ <span class="keyword">class</span> <a class="link" href="invalid_option_value.html" title="Class invalid_option_value">invalid_option_value</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">validation_error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="invalid_option_value.html#boost.program_options.invalid_option_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_option_value.html#idp682183280-bb"><span class="identifier">invalid_option_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_option_value.html#idp682184256-bb"><span class="identifier">invalid_option_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_option_value.html#idp708894336-bb"><span class="identifier">invalid_option_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_option_value.html#idp708895312-bb"><span class="identifier">invalid_option_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437386320"></a><h2>Description</h2> +<a name="idp421236864"></a><h2>Description</h2> <p>Class thrown if there is an invalid option value given </p> <div class="refsect2"> -<a name="idp437387056"></a><h3> +<a name="idp421237600"></a><h3> <a name="boost.program_options.invalid_option_valueconstruct-copy-destruct"></a><code class="computeroutput">invalid_option_value</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682183280-bb"></a><span class="identifier">invalid_option_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682184256-bb"></a><span class="identifier">invalid_option_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708894336-bb"></a><span class="identifier">invalid_option_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708895312-bb"></a><span class="identifier">invalid_option_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/program_options/invalid_syntax.html b/doc/html/boost/program_options/invalid_syntax.html index 6d7e17c91b..6e716bf616 100644 --- a/doc/html/boost/program_options/invalid_syntax.html +++ b/doc/html/boost/program_options/invalid_syntax.html @@ -40,47 +40,47 @@ short_adjacent_not_allowed, empty_adjacent_parameter, missing_parameter, extra_parameter, unrecognized_line <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="invalid_syntax.html#boost.program_options.invalid_syntaxconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="invalid_syntax.html#idp682150384-bb"><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> + <a class="link" href="invalid_syntax.html#idp708861440-bb"><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="invalid_syntax.html#idp682154288-bb"><span class="special">~</span><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="invalid_syntax.html#idp708865344-bb"><span class="special">~</span><span class="identifier">invalid_syntax</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="invalid_syntax.html#idp682146704-bb">public member functions</a></span> - <span class="identifier">kind_t</span> <a class="link" href="invalid_syntax.html#idp682147264-bb"><span class="identifier">kind</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#idp682148384-bb"><span class="identifier">tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="invalid_syntax.html#idp708857760-bb">public member functions</a></span> + <span class="identifier">kind_t</span> <a class="link" href="invalid_syntax.html#idp708858320-bb"><span class="identifier">kind</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#idp708859440-bb"><span class="identifier">tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="invalid_syntax.html#idp682154576-bb">protected member functions</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#idp682155152-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="invalid_syntax.html#idp708865632-bb">protected member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="invalid_syntax.html#idp708866208-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437122256"></a><h2>Description</h2> +<a name="idp420973232"></a><h2>Description</h2> <p>Class thrown when there's syntax error either for command line or config file options. See derived children for concrete classes. </p> <div class="refsect2"> -<a name="idp437123072"></a><h3> +<a name="idp420974016"></a><h3> <a name="boost.program_options.invalid_syntaxconstruct-copy-destruct"></a><code class="computeroutput">invalid_syntax</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682150384-bb"></a><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span> +<li class="listitem"><pre class="literallayout"><a name="idp708861440-bb"></a><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682154288-bb"></a><span class="special">~</span><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708865344-bb"></a><span class="special">~</span><span class="identifier">invalid_syntax</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp437146384"></a><h3> -<a name="idp682146704-bb"></a><code class="computeroutput">invalid_syntax</code> public member functions</h3> +<a name="idp420997296"></a><h3> +<a name="idp708857760-bb"></a><code class="computeroutput">invalid_syntax</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="identifier">kind_t</span> <a name="idp682147264-bb"></a><span class="identifier">kind</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">kind_t</span> <a name="idp708858320-bb"></a><span class="identifier">kind</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682148384-bb"></a><span class="identifier">tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708859440-bb"></a><span class="identifier">tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Convenience functions for backwards compatibility </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp437160496"></a><h3> -<a name="idp682154576-bb"></a><code class="computeroutput">invalid_syntax</code> protected member functions</h3> +<a name="idp421011472"></a><h3> +<a name="idp708865632-bb"></a><code class="computeroutput">invalid_syntax</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682155152-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708866208-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> <p>Used to convert kind_t to a related error text </p> </li></ol></div> </div> diff --git a/doc/html/boost/program_options/multiple_occurrences.html b/doc/html/boost/program_options/multiple_occurrences.html index 7605eb9303..20d0062cfc 100644 --- a/doc/html/boost/program_options/multiple_occurrences.html +++ b/doc/html/boost/program_options/multiple_occurrences.html @@ -38,20 +38,20 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="multiple_occurrences.html#boost.program_options.multiple_occurrencesconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="multiple_occurrences.html#idp682117664-bb"><span class="identifier">multiple_occurrences</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="multiple_occurrences.html#idp682117952-bb"><span class="special">~</span><span class="identifier">multiple_occurrences</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="multiple_occurrences.html#idp708828720-bb"><span class="identifier">multiple_occurrences</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="multiple_occurrences.html#idp708829008-bb"><span class="special">~</span><span class="identifier">multiple_occurrences</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436821248"></a><h2>Description</h2> +<a name="idp420672688"></a><h2>Description</h2> <p>Class thrown when there are several occurrences of an option, but user called a method which cannot return them all. </p> <div class="refsect2"> -<a name="idp436822048"></a><h3> +<a name="idp420673488"></a><h3> <a name="boost.program_options.multiple_occurrencesconstruct-copy-destruct"></a><code class="computeroutput">multiple_occurrences</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682117664-bb"></a><span class="identifier">multiple_occurrences</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682117952-bb"></a><span class="special">~</span><span class="identifier">multiple_occurrences</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708828720-bb"></a><span class="identifier">multiple_occurrences</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708829008-bb"></a><span class="special">~</span><span class="identifier">multiple_occurrences</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/program_options/multiple_values.html b/doc/html/boost/program_options/multiple_values.html index 5adf139c4f..a22fb65048 100644 --- a/doc/html/boost/program_options/multiple_values.html +++ b/doc/html/boost/program_options/multiple_values.html @@ -36,20 +36,20 @@ <span class="keyword">class</span> <a class="link" href="multiple_values.html" title="Class multiple_values">multiple_values</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="multiple_values.html#boost.program_options.multiple_valuesconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="multiple_values.html#idp682114864-bb"><span class="identifier">multiple_values</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="multiple_values.html#idp682115152-bb"><span class="special">~</span><span class="identifier">multiple_values</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="multiple_values.html#idp708825920-bb"><span class="identifier">multiple_values</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="multiple_values.html#idp708826208-bb"><span class="special">~</span><span class="identifier">multiple_values</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436789808"></a><h2>Description</h2> +<a name="idp420641088"></a><h2>Description</h2> <p>Class thrown when there are several option values, but user called a method which cannot return them all. </p> <div class="refsect2"> -<a name="idp436790608"></a><h3> +<a name="idp420641888"></a><h3> <a name="boost.program_options.multiple_valuesconstruct-copy-destruct"></a><code class="computeroutput">multiple_values</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682114864-bb"></a><span class="identifier">multiple_values</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682115152-bb"></a><span class="special">~</span><span class="identifier">multiple_values</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708825920-bb"></a><span class="identifier">multiple_values</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708826208-bb"></a><span class="special">~</span><span class="identifier">multiple_values</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/program_options/notify.html b/doc/html/boost/program_options/notify.html index b5b12d337e..52cfe8eac1 100644 --- a/doc/html/boost/program_options/notify.html +++ b/doc/html/boost/program_options/notify.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="store_idp682619776.html" title="Function store"> +<link rel="prev" href="store_idp709319824.html" title="Function store"> <link rel="next" href="../../BOOST_PROGRAM_OPTIONS_VERSION.html" title="Macro BOOST_PROGRAM_OPTIONS_VERSION"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="store_idp682619776.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="../../BOOST_PROGRAM_OPTIONS_VERSION.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="store_idp709319824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="../../BOOST_PROGRAM_OPTIONS_VERSION.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.notify"></a><div class="titlepage"></div> @@ -35,7 +35,7 @@ </span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> <span class="identifier">notify</span><span class="special">(</span><a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440557168"></a><h2>Description</h2> +<a name="idp424334080"></a><h2>Description</h2> <p>Runs all 'notify' function for options in 'm'. </p> </div> </div> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="store_idp682619776.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="../../BOOST_PROGRAM_OPTIONS_VERSION.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="store_idp709319824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="../../BOOST_PROGRAM_OPTIONS_VERSION.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/option_description.html b/doc/html/boost/program_options/option_description.html index aad1afde08..b0b4645718 100644 --- a/doc/html/boost/program_options/option_description.html +++ b/doc/html/boost/program_options/option_description.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> <link rel="prev" href="basic_option.html" title="Class template basic_option"> -<link rel="next" href="options_descr_idp682248336.html" title="Class options_description_easy_init"> +<link rel="next" href="options_descr_idp708959552.html" title="Class options_description_easy_init"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_option.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_descr_idp682248336.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_option.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_descr_idp708959552.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.option_description"></a><div class="titlepage"></div> @@ -38,40 +38,40 @@ <span class="keyword">enum</span> <a name="boost.program_options.option_description.match_result"></a>match_result <span class="special">{</span> no_match, full_match, approximate_match <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="option_description.html#boost.program_options.option_descriptionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="option_description.html#idp682232720-bb"><span class="identifier">option_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="option_description.html#idp682233008-bb"><span class="identifier">option_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="option_description.html#idp682242240-bb"><span class="identifier">option_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="option_description.html#idp682245488-bb"><span class="special">~</span><span class="identifier">option_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="option_description.html#idp708943936-bb"><span class="identifier">option_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="option_description.html#idp708944224-bb"><span class="identifier">option_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="option_description.html#idp708953456-bb"><span class="identifier">option_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="option_description.html#idp708956704-bb"><span class="special">~</span><span class="identifier">option_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="option_description.html#idp682214128-bb">public member functions</a></span> - <span class="identifier">match_result</span> <a class="link" href="option_description.html#idp682214688-bb"><span class="identifier">match</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#idp682219056-bb"><span class="identifier">key</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp682222272-bb"><span class="identifier">canonical_display_name</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#idp682225088-bb"><span class="identifier">long_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#idp682226208-bb"><span class="identifier">description</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a class="link" href="option_description.html#idp682227632-bb"><span class="identifier">semantic</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp682229504-bb"><span class="identifier">format_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp682230960-bb"><span class="identifier">format_parameter</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="option_description.html#idp708925344-bb">public member functions</a></span> + <span class="identifier">match_result</span> <a class="link" href="option_description.html#idp708925904-bb"><span class="identifier">match</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#idp708930272-bb"><span class="identifier">key</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp708933488-bb"><span class="identifier">canonical_display_name</span></a><span class="special">(</span><span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#idp708936304-bb"><span class="identifier">long_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="option_description.html#idp708937424-bb"><span class="identifier">description</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a class="link" href="option_description.html#idp708938848-bb"><span class="identifier">semantic</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp708940720-bb"><span class="identifier">format_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="option_description.html#idp708942176-bb"><span class="identifier">format_parameter</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="option_description.html#idp682245776-bb">private member functions</a></span> - <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a class="link" href="option_description.html#idp682246352-bb"><span class="identifier">set_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="option_description.html#idp708956992-bb">private member functions</a></span> + <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a class="link" href="option_description.html#idp708957568-bb"><span class="identifier">set_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437694192"></a><h2>Description</h2> +<a name="idp421545136"></a><h2>Description</h2> <p>Describes one possible command line/config file option. There are two kinds of properties of an option. First describe it syntactically and are used only to validate input. Second affect interpretation of the option, for example default value for it or function that should be called when the value is finally known. Routines which perform parsing never use second kind of properties -- they are side effect free. </p> <p><span class="bold"><strong>See Also:</strong></span></p> <p><a class="link" href="options_description.html" title="Class options_description">options_description</a> </p> <p> </p> <div class="refsect2"> -<a name="idp437697104"></a><h3> +<a name="idp421548528"></a><h3> <a name="boost.program_options.option_descriptionconstruct-copy-destruct"></a><code class="computeroutput">option_description</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682232720-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708943936-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idp682233008-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp708944224-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">)</span><span class="special">;</span></pre> <p>Initializes the object with the passed data.</p> <p>Note: it would be nice to make the second parameter auto_ptr, to explicitly pass ownership. Unfortunately, it's often needed to create objects of types derived from '<code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code>': <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code> d; d.add_options()("a", parameter<int>("n")->default_value(1)); Here, the static type returned by 'parameter' should be derived from <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code>.</p> <p>Alas, derived->base conversion for auto_ptr does not really work, see <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf" target="_top">http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2000/n1232.pdf</a> <a href="http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84" target="_top">http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#84</a></p> @@ -85,48 +85,48 @@ </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp682242240-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">,</span> +<pre class="literallayout"><a name="idp708953456-bb"></a><span class="identifier">option_description</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> description<span class="special">)</span><span class="special">;</span></pre> <p>Initializes the class with the passed data. </p> </li> -<li class="listitem"><pre class="literallayout"><a name="idp682245488-bb"></a><span class="special">~</span><span class="identifier">option_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708956704-bb"></a><span class="special">~</span><span class="identifier">option_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp437735904"></a><h3> -<a name="idp682214128-bb"></a><code class="computeroutput">option_description</code> public member functions</h3> +<a name="idp421587328"></a><h3> +<a name="idp708925344-bb"></a><code class="computeroutput">option_description</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><span class="identifier">match_result</span> -<a name="idp682214688-bb"></a><span class="identifier">match</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case<span class="special">,</span> +<a name="idp708925904-bb"></a><span class="identifier">match</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case<span class="special">,</span> <span class="keyword">bool</span> short_ignore_case<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Given 'option', specified in the input source, returns 'true' if 'option' specifies *this. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp682219056-bb"></a><span class="identifier">key</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp708930272-bb"></a><span class="identifier">key</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the key that should identify the option, in particular in the <code class="computeroutput"><a class="link" href="variables_map.html" title="Class variables_map">variables_map</a></code> class. The 'option' parameter is the option spelling from the input source. If option name contains '*', returns 'option'. If long name was specified, it's the long name, otherwise it's a short name with prepended '-'. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682222272-bb"></a><span class="identifier">canonical_display_name</span><span class="special">(</span><span class="keyword">int</span> canonical_option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708933488-bb"></a><span class="identifier">canonical_display_name</span><span class="special">(</span><span class="keyword">int</span> canonical_option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the canonical name for the option description to enable the user to recognised a matching option. 1) For short options ('-', '/'), returns the short name prefixed. 2) For long options ('–' / '-') returns the long name prefixed 3) All other cases, returns the long name (if present) or the short name, unprefixed. </p> </li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp682225088-bb"></a><span class="identifier">long_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp708936304-bb"></a><span class="identifier">long_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp682226208-bb"></a><span class="identifier">description</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Explanation of this option. </li> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp708937424-bb"></a><span class="identifier">description</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Explanation of this option. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a name="idp682227632-bb"></a><span class="identifier">semantic</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Semantic of option's value. </li> +<pre class="literallayout"><span class="identifier">shared_ptr</span><span class="special"><</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">></span> <a name="idp708938848-bb"></a><span class="identifier">semantic</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Semantic of option's value. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682229504-bb"></a><span class="identifier">format_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the option name, formatted suitably for usage message. </li> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708940720-bb"></a><span class="identifier">format_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the option name, formatted suitably for usage message. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682230960-bb"></a><span class="identifier">format_parameter</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708942176-bb"></a><span class="identifier">format_parameter</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the parameter name and properties, formatted suitably for usage message. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp437807360"></a><h3> -<a name="idp682245776-bb"></a><code class="computeroutput">option_description</code> private member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a name="idp682246352-bb"></a><span class="identifier">set_name</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<a name="idp421658960"></a><h3> +<a name="idp708956992-bb"></a><code class="computeroutput">option_description</code> private member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> <a name="idp708957568-bb"></a><span class="identifier">set_name</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> @@ -140,7 +140,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_option.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_descr_idp682248336.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_option.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_descr_idp708959552.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/options_descr_idp682248336.html b/doc/html/boost/program_options/options_descr_idp708959552.html index 9780692219..2e9ebe3b6f 100644 --- a/doc/html/boost/program_options/options_descr_idp682248336.html +++ b/doc/html/boost/program_options/options_descr_idp708959552.html @@ -24,7 +24,7 @@ <a accesskey="p" href="option_description.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="options_description.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.options_descr_idp682248336"></a><div class="titlepage"></div> +<a name="boost.program_options.options_descr_idp708959552"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class options_description_easy_init</span></h2> <p>boost::program_options::options_description_easy_init</p> @@ -33,38 +33,38 @@ <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="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>">boost/program_options/options_description.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="options_descr_idp682248336.html#boost.program_options.options_descr_idp682248336construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="options_descr_idp682248336.html#idp682259840-bb"><span class="identifier">options_description_easy_init</span></a><span class="special">(</span><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="options_descr_idp708959552.html#boost.program_options.options_descr_idp708959552construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="options_descr_idp708959552.html#idp708971056-bb"><span class="identifier">options_description_easy_init</span></a><span class="special">(</span><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="options_descr_idp682248336.html#idp682249952-bb">public member functions</a></span> - <a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> <a class="link" href="options_descr_idp682248336.html#idp682250512-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> - <a class="link" href="options_descr_idp682248336.html#idp682253040-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> - <a class="link" href="options_descr_idp682248336.html#idp682256016-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="options_descr_idp708959552.html#idp708961168-bb">public member functions</a></span> + <a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> <a class="link" href="options_descr_idp708959552.html#idp708961728-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> + <a class="link" href="options_descr_idp708959552.html#idp708964256-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> + <a class="link" href="options_descr_idp708959552.html#idp708967232-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437865648"></a><h2>Description</h2> +<a name="idp421717440"></a><h2>Description</h2> <p>Class which provides convenient creation syntax to <a class="link" href="option_description.html" title="Class option_description">option_description</a>. </p> <div class="refsect2"> -<a name="idp437867264"></a><h3> -<a name="boost.program_options.options_descr_idp682248336construct-copy-destruct"></a><code class="computeroutput">options_description_easy_init</code> +<a name="idp421719056"></a><h3> +<a name="boost.program_options.options_descr_idp708959552construct-copy-destruct"></a><code class="computeroutput">options_description_easy_init</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682259840-bb"></a><span class="identifier">options_description_easy_init</span><span class="special">(</span><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> owner<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp708971056-bb"></a><span class="identifier">options_description_easy_init</span><span class="special">(</span><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">*</span> owner<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp437874816"></a><h3> -<a name="idp682249952-bb"></a><code class="computeroutput">options_description_easy_init</code> public member functions</h3> +<a name="idp421726608"></a><h3> +<a name="idp708961168-bb"></a><code class="computeroutput">options_description_easy_init</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> -<a name="idp682250512-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> description<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> -<a name="idp682253040-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> -<a name="idp682256016-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">,</span> +<li class="listitem"><pre class="literallayout"><a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> +<a name="idp708961728-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> description<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> +<a name="idp708964256-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <span class="special">&</span> +<a name="idp708967232-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">*</span> s<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> description<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> diff --git a/doc/html/boost/program_options/options_description.html b/doc/html/boost/program_options/options_description.html index 700a091352..fbba436dd4 100644 --- a/doc/html/boost/program_options/options_description.html +++ b/doc/html/boost/program_options/options_description.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.options_description_hpp" title="Header <boost/program_options/options_description.hpp>"> -<link rel="prev" href="options_descr_idp682248336.html" title="Class options_description_easy_init"> +<link rel="prev" href="options_descr_idp708959552.html" title="Class options_description_easy_init"> <link rel="next" href="duplicate_option_error.html" title="Class duplicate_option_error"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="options_descr_idp682248336.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="options_descr_idp708959552.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.options_description"></a><div class="titlepage"></div> @@ -36,32 +36,32 @@ <span class="keyword">class</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="options_description.html#boost.program_options.options_descriptionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="options_description.html#idp682292128-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> + <a class="link" href="options_description.html#idp709003344-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_description.html#idp682294784-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> + <a class="link" href="options_description.html#idp709006000-bb"><span class="identifier">options_description</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="options_description.html#idp682265232-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="options_description.html#idp682265792-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span><span class="special">)</span><span class="special">;</span> - <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a class="link" href="options_description.html#idp682268304-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="options_description.html#idp682271168-bb"><span class="identifier">get_option_column_width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <a class="link" href="options_description.html#idp682272768-bb"><span class="identifier">add_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="options_description.html#idp708976448-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="options_description.html#idp708977008-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span><span class="special">)</span><span class="special">;</span> + <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a class="link" href="options_description.html#idp708979520-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">unsigned</span> <a class="link" href="options_description.html#idp708982384-bb"><span class="identifier">get_option_column_width</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <a class="link" href="options_description.html#idp708983984-bb"><span class="identifier">add_options</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> - <a class="link" href="options_description.html#idp682276592-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="options_description.html#idp708987808-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span> - <a class="link" href="options_description.html#idp682281488-bb"><span class="identifier">find_nothrow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a class="link" href="options_description.html#idp682286384-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="options_description.html#idp682287968-bb"><span class="identifier">print</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="options_description.html#idp708992704-bb"><span class="identifier">find_nothrow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a class="link" href="options_description.html#idp708997600-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="options_description.html#idp708999184-bb"><span class="identifier">print</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="options_description.html#idp682299152-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="options_description.html#idp709010368-bb">friend functions</a></span> <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> - <a class="link" href="options_description.html#idp682299712-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="options_description.html#idp709010928-bb"><span class="keyword">operator</span><span class="special"><<</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="comment">// public data members</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="identifier">m_default_line_length</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438034304"></a><h2>Description</h2> +<a name="idp421885968"></a><h2>Description</h2> <p>A set of option descriptions. This provides convenient interface for adding new option (the add_options) method, and facilities to search for options by name.</p> <p>See here for option adding interface discussion. </p> <p><span class="bold"><strong>See Also:</strong></span></p> @@ -69,18 +69,18 @@ <p> </p> <div class="refsect2"> -<a name="idp438037312"></a><h3> +<a name="idp421888944"></a><h3> <a name="boost.program_options.options_descriptionconstruct-copy-destruct"></a><code class="computeroutput">options_description</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp682292128-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> +<pre class="literallayout"><a name="idp709003344-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates the instance. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp682294784-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> caption<span class="special">,</span> +<pre class="literallayout"><a name="idp709006000-bb"></a><span class="identifier">options_description</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> caption<span class="special">,</span> <span class="keyword">unsigned</span> line_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">,</span> <span class="keyword">unsigned</span> min_description_length <span class="special">=</span> <span class="identifier">m_default_line_length</span><span class="special">/</span><span class="number">2</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates the instance. The 'caption' parameter gives the name of this '<code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>' instance. Primarily useful for output. The 'description_length' specifies the number of columns that should be reserved for the description text; if the option text encroaches into this, then the description will start on the next line. </p> @@ -88,44 +88,44 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp438064000"></a><h3> -<a name="idp682265232-bb"></a><code class="computeroutput">options_description</code> public member functions</h3> +<a name="idp421915568"></a><h3> +<a name="idp708976448-bb"></a><code class="computeroutput">options_description</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682265792-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> desc<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp708977008-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Adds new variable description. Throws duplicate_variable_error if either short or long name matches that of already present one. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a name="idp682268304-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> <a name="idp708979520-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Adds a group of option description. This has the same effect as adding all option_descriptions in 'desc' individually, except that output operator will show a separate group. Returns *this. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp682271168-bb"></a><span class="identifier">get_option_column_width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp708982384-bb"></a><span class="identifier">get_option_column_width</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Find the maximum width of the option column, including options in groups. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="options_descr_idp682248336.html" title="Class options_description_easy_init">options_description_easy_init</a> <a name="idp682272768-bb"></a><span class="identifier">add_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="options_descr_idp708959552.html" title="Class options_description_easy_init">options_description_easy_init</a> <a name="idp708983984-bb"></a><span class="identifier">add_options</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns an object of implementation-defined type suitable for adding options to <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code>. The returned object will have overloaded operator() with parameter type matching '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructors. Calling the operator will create new <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> instance and add it. </p> </li> <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">&</span> -<a name="idp682276592-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> +<a name="idp708987808-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">*</span> -<a name="idp682281488-bb"></a><span class="identifier">find_nothrow</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> +<a name="idp708992704-bb"></a><span class="identifier">find_nothrow</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">,</span> <span class="keyword">bool</span> approx<span class="special">,</span> <span class="keyword">bool</span> long_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">,</span> <span class="keyword">bool</span> short_ignore_case <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a name="idp682286384-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span> <span class="identifier">shared_ptr</span><span class="special"><</span> <a class="link" href="option_description.html" title="Class option_description">option_description</a> <span class="special">></span> <span class="special">></span> <span class="special">&</span> <a name="idp708997600-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682287968-bb"></a><span class="identifier">print</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">unsigned</span> width <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp708999184-bb"></a><span class="identifier">print</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">unsigned</span> width <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Outputs 'desc' to the specified stream, calling 'f' to output each <code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code> element. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp438151280"></a><h3> -<a name="idp682299152-bb"></a><code class="computeroutput">options_description</code> friend functions</h3> +<a name="idp422002912"></a><h3> +<a name="idp709010368-bb"></a><code class="computeroutput">options_description</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> -<a name="idp682299712-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> +<a name="idp709010928-bb"></a><span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ostream</span> <span class="special">&</span> os<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span> desc<span class="special">)</span><span class="special">;</span></pre> <p>Produces a human readable output of 'desc', listing options, their descriptions and allowed parameters. Other <code class="computeroutput"><a class="link" href="options_description.html" title="Class options_description">options_description</a></code> instances previously passed to add will be output separately. </p> </li></ol></div> </div> @@ -141,7 +141,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="options_descr_idp682248336.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="options_descr_idp708959552.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.options_description_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="duplicate_option_error.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/parse_command_line.html b/doc/html/boost/program_options/parse_command_line.html index 2e176701e7..a8a9d276d7 100644 --- a/doc/html/boost/program_options/parse_command_line.html +++ b/doc/html/boost/program_options/parse_command_line.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> <link rel="prev" href="ext_parser.html" title="Type definition ext_parser"> -<link rel="next" href="parse_config__idp682372336.html" title="Function template parse_config_file"> +<link rel="next" href="parse_config__idp709072400.html" title="Function template parse_config_file"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="ext_parser.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp682372336.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="ext_parser.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp709072400.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.parse_command_line"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">int</span> style <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">function1</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">></span> ext <span class="special">=</span> <span class="identifier">ext_parser</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438782864"></a><h2>Description</h2> +<a name="idp422558352"></a><h2>Description</h2> <p>Creates instance of 'command_line_parser', passes parameters to it, and returns the result of calling the 'run' method. </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="ext_parser.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp682372336.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="ext_parser.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp709072400.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/parse_config__idp682372336.html b/doc/html/boost/program_options/parse_config__idp709072400.html index 93d958b0d4..b43ae3558e 100644 --- a/doc/html/boost/program_options/parse_config__idp682372336.html +++ b/doc/html/boost/program_options/parse_config__idp709072400.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> <link rel="prev" href="parse_command_line.html" title="Function template parse_command_line"> -<link rel="next" href="parse_config__idp682378032.html" title="Function template parse_config_file"> +<link rel="next" href="parse_config__idp709078096.html" title="Function template parse_config_file"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_command_line.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp682378032.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_command_line.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp709078096.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.parse_config__idp682372336"></a><div class="titlepage"></div> +<a name="boost.program_options.parse_config__idp709072400"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template parse_config_file</span></h2> <p>boost::program_options::parse_config_file</p> @@ -39,7 +39,7 @@ <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span> allow_unregistered <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438805488"></a><h2>Description</h2> +<a name="idp422580912"></a><h2>Description</h2> <p>Parse a config file.</p> <p>Read from given stream. </p> </div> @@ -54,7 +54,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_command_line.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp682378032.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_command_line.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_config__idp709078096.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/parse_config__idp682378032.html b/doc/html/boost/program_options/parse_config__idp709078096.html index 7e6e8e8517..941266a866 100644 --- a/doc/html/boost/program_options/parse_config__idp682378032.html +++ b/doc/html/boost/program_options/parse_config__idp709078096.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="parse_config__idp682372336.html" title="Function template parse_config_file"> +<link rel="prev" href="parse_config__idp709072400.html" title="Function template parse_config_file"> <link rel="next" href="collect_unrecognized.html" title="Function template collect_unrecognized"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_config__idp682372336.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_config__idp709072400.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.parse_config__idp682378032"></a><div class="titlepage"></div> +<a name="boost.program_options.parse_config__idp709078096"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template parse_config_file</span></h2> <p>boost::program_options::parse_config_file</p> @@ -38,7 +38,7 @@ <span class="identifier">parse_config_file</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span> allow_unregistered <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438826128"></a><h2>Description</h2> +<a name="idp422601488"></a><h2>Description</h2> <p>Parse a config file.</p> <p>Read from file with the given name. The character type is passed to the file stream. </p> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_config__idp682372336.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_config__idp709072400.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="collect_unrecognized.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/parse_environ_idp682387952.html b/doc/html/boost/program_options/parse_environ_idp709088016.html index 2d592a6fff..0515998bf4 100644 --- a/doc/html/boost/program_options/parse_environ_idp682387952.html +++ b/doc/html/boost/program_options/parse_environ_idp709088016.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> <link rel="prev" href="collect_unrecognized.html" title="Function template collect_unrecognized"> -<link rel="next" href="parse_environ_idp682392176.html" title="Function parse_environment"> +<link rel="next" href="parse_environ_idp709092240.html" title="Function parse_environment"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="collect_unrecognized.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp682392176.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="collect_unrecognized.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp709092240.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.parse_environ_idp682387952"></a><div class="titlepage"></div> +<a name="boost.program_options.parse_environ_idp709088016"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function parse_environment</span></h2> <p>boost::program_options::parse_environment</p> @@ -37,7 +37,7 @@ <span class="identifier">parse_environment</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">function1</span><span class="special"><</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">></span> <span class="special">&</span> name_mapper<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438870432"></a><h2>Description</h2> +<a name="idp422645856"></a><h2>Description</h2> <p>Parse environment.</p> <p>For each environment variable, the 'name_mapper' function is called to obtain the option name. If it returns empty string, the variable is ignored.</p> <p>This is done since naming of environment variables is typically different from the naming of command line options. </p> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="collect_unrecognized.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp682392176.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="collect_unrecognized.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp709092240.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/parse_environ_idp682392176.html b/doc/html/boost/program_options/parse_environ_idp709092240.html index 84939a3eff..c163199c08 100644 --- a/doc/html/boost/program_options/parse_environ_idp682392176.html +++ b/doc/html/boost/program_options/parse_environ_idp709092240.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="parse_environ_idp682387952.html" title="Function parse_environment"> -<link rel="next" href="parse_environ_idp682396016.html" title="Function parse_environment"> +<link rel="prev" href="parse_environ_idp709088016.html" title="Function parse_environment"> +<link rel="next" href="parse_environ_idp709096080.html" title="Function parse_environment"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_environ_idp682387952.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp682396016.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_environ_idp709088016.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp709096080.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.parse_environ_idp682392176"></a><div class="titlepage"></div> +<a name="boost.program_options.parse_environ_idp709092240"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function parse_environment</span></h2> <p>boost::program_options::parse_environment</p> @@ -36,7 +36,7 @@ <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="../../program_options/reference.html#boost.program_options.parsed_options">parsed_options</a> <span class="identifier">parse_environment</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> prefix<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438885504"></a><h2>Description</h2> +<a name="idp422660992"></a><h2>Description</h2> <p>Parse environment.</p> <p>Takes all environment variables which start with 'prefix'. The option name is obtained from variable name by removing the prefix and converting the remaining string into lower case. </p> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_environ_idp682387952.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp682396016.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_environ_idp709088016.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="parse_environ_idp709096080.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/parse_environ_idp682396016.html b/doc/html/boost/program_options/parse_environ_idp709096080.html index 4051b2eb19..ddaba1ab49 100644 --- a/doc/html/boost/program_options/parse_environ_idp682396016.html +++ b/doc/html/boost/program_options/parse_environ_idp709096080.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="parse_environ_idp682392176.html" title="Function parse_environment"> +<link rel="prev" href="parse_environ_idp709092240.html" title="Function parse_environment"> <link rel="next" href="split_unix.html" title="Function split_unix"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_environ_idp682392176.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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_unix.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_environ_idp709092240.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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_unix.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.parse_environ_idp682396016"></a><div class="titlepage"></div> +<a name="boost.program_options.parse_environ_idp709096080"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function parse_environment</span></h2> <p>boost::program_options::parse_environment</p> @@ -36,7 +36,7 @@ <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <a class="link" href="../../program_options/reference.html#boost.program_options.parsed_options">parsed_options</a> <span class="identifier">parse_environment</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> prefix<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438899200"></a><h2>Description</h2> +<a name="idp422674688"></a><h2>Description</h2> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This function exists to resolve ambiguity between the two above functions when second argument is of 'char*' type. There's implicit conversion to both function1 and string. </p> </div> </div> @@ -50,7 +50,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_environ_idp682392176.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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_unix.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_environ_idp709092240.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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_unix.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/positional_op_idp682411312.html b/doc/html/boost/program_options/positional_op_idp709111376.html index 30f14bff68..ac9c6ca9e3 100644 --- a/doc/html/boost/program_options/positional_op_idp682411312.html +++ b/doc/html/boost/program_options/positional_op_idp709111376.html @@ -24,7 +24,7 @@ <a accesskey="p" href="split_unix.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.positional_options_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="value_semantic.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.positional_op_idp682411312"></a><div class="titlepage"></div> +<a name="boost.program_options.positional_op_idp709111376"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class positional_options_description</span></h2> <p>boost::program_options::positional_options_description</p> @@ -33,43 +33,43 @@ <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="../../program_options/reference.html#header.boost.program_options.positional_options_hpp" title="Header <boost/program_options/positional_options.hpp>">boost/program_options/positional_options.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="positional_op_idp682411312.html" title="Class positional_options_description">positional_options_description</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="positional_op_idp709111376.html" title="Class positional_options_description">positional_options_description</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="positional_op_idp682411312.html#boost.program_options.positional_op_idp682411312construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="positional_op_idp682411312.html#idp682421440-bb"><span class="identifier">positional_options_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="positional_op_idp709111376.html#boost.program_options.positional_op_idp709111376construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="positional_op_idp709111376.html#idp709121504-bb"><span class="identifier">positional_options_description</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="positional_op_idp682411312.html#idp682413600-bb">public member functions</a></span> - <a class="link" href="positional_op_idp682411312.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> <a class="link" href="positional_op_idp682411312.html#idp682414160-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="positional_op_idp682411312.html#idp682417280-bb"><span class="identifier">max_total_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="positional_op_idp682411312.html#idp682418944-bb"><span class="identifier">name_for_position</span></a><span class="special">(</span><span class="keyword">unsigned</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="positional_op_idp709111376.html#idp709113664-bb">public member functions</a></span> + <a class="link" href="positional_op_idp709111376.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> <a class="link" href="positional_op_idp709111376.html#idp709114224-bb"><span class="identifier">add</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">unsigned</span> <a class="link" href="positional_op_idp709111376.html#idp709117344-bb"><span class="identifier">max_total_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a class="link" href="positional_op_idp709111376.html#idp709119008-bb"><span class="identifier">name_for_position</span></a><span class="special">(</span><span class="keyword">unsigned</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439002144"></a><h2>Description</h2> +<a name="idp422777632"></a><h2>Description</h2> <p>Describes positional options.</p> <p>The class allows to guess option names for positional options, which are specified on the command line and are identified by the position. The class uses the information provided by the user to associate a name with every positional option, or tell that no name is known.</p> <p>The primary assumption is that only the relative order of the positional options themselves matters, and that any interleaving ordinary options don't affect interpretation of positional options.</p> <p>The user initializes the class by specifying that first N positional options should be given the name X1, following M options should be given the name X2 and so on. </p> <div class="refsect2"> -<a name="idp439004304"></a><h3> -<a name="boost.program_options.positional_op_idp682411312construct-copy-destruct"></a><code class="computeroutput">positional_options_description</code> +<a name="idp422779792"></a><h3> +<a name="boost.program_options.positional_op_idp709111376construct-copy-destruct"></a><code class="computeroutput">positional_options_description</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682421440-bb"></a><span class="identifier">positional_options_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp709121504-bb"></a><span class="identifier">positional_options_description</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp439010320"></a><h3> -<a name="idp682413600-bb"></a><code class="computeroutput">positional_options_description</code> public member functions</h3> +<a name="idp422785728"></a><h3> +<a name="idp709113664-bb"></a><code class="computeroutput">positional_options_description</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="positional_op_idp682411312.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> <a name="idp682414160-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">int</span> max_count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="positional_op_idp709111376.html" title="Class positional_options_description">positional_options_description</a> <span class="special">&</span> <a name="idp709114224-bb"></a><span class="identifier">add</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">int</span> max_count<span class="special">)</span><span class="special">;</span></pre> <p>Species that up to 'max_count' next positional options should be given the 'name'. The value of '-1' means 'unlimited'. No calls to 'add' can be made after call with 'max_value' equal to '-1'. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp682417280-bb"></a><span class="identifier">max_total_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp709117344-bb"></a><span class="identifier">max_total_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the maximum number of positional options that can be present. Can return (numeric_limits<unsigned>::max)() to indicate unlimited number. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp682418944-bb"></a><span class="identifier">name_for_position</span><span class="special">(</span><span class="keyword">unsigned</span> position<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <a name="idp709119008-bb"></a><span class="identifier">name_for_position</span><span class="special">(</span><span class="keyword">unsigned</span> position<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the name that should be associated with positional options at 'position'. Precondition: position < max_total_count() </p> </li> </ol></div> diff --git a/doc/html/boost/program_options/reading_file.html b/doc/html/boost/program_options/reading_file.html index 3d9027d7c9..358669aa66 100644 --- a/doc/html/boost/program_options/reading_file.html +++ b/doc/html/boost/program_options/reading_file.html @@ -36,17 +36,17 @@ <span class="keyword">class</span> <a class="link" href="reading_file.html" title="Class reading_file">reading_file</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="reading_file.html#boost.program_options.reading_fileconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="reading_file.html#idp682074064-bb"><span class="identifier">reading_file</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="reading_file.html#idp708785120-bb"><span class="identifier">reading_file</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436470992"></a><h2>Description</h2> +<a name="idp420322720"></a><h2>Description</h2> <p>Class thrown if config file can not be read </p> <div class="refsect2"> -<a name="idp436471728"></a><h3> +<a name="idp420323456"></a><h3> <a name="boost.program_options.reading_fileconstruct-copy-destruct"></a><code class="computeroutput">reading_file</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682074064-bb"></a><span class="identifier">reading_file</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp708785120-bb"></a><span class="identifier">reading_file</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/program_options/required_option.html b/doc/html/boost/program_options/required_option.html index aab307e7db..7df9b0fdcd 100644 --- a/doc/html/boost/program_options/required_option.html +++ b/doc/html/boost/program_options/required_option.html @@ -36,20 +36,20 @@ <span class="keyword">class</span> <a class="link" href="required_option.html" title="Class required_option">required_option</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error_with_option_name</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="required_option.html#boost.program_options.required_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="required_option.html#idp682120416-bb"><span class="identifier">required_option</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="required_option.html#idp682121392-bb"><span class="special">~</span><span class="identifier">required_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="required_option.html#idp708831472-bb"><span class="identifier">required_option</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="required_option.html#idp708832448-bb"><span class="special">~</span><span class="identifier">required_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436855712"></a><h2>Description</h2> +<a name="idp420706960"></a><h2>Description</h2> <p>Class thrown when a required/mandatory option is missing </p> <div class="refsect2"> -<a name="idp436856384"></a><h3> +<a name="idp420707712"></a><h3> <a name="boost.program_options.required_optionconstruct-copy-destruct"></a><code class="computeroutput">required_option</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682120416-bb"></a><span class="identifier">required_option</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682121392-bb"></a><span class="special">~</span><span class="identifier">required_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708831472-bb"></a><span class="identifier">required_option</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708832448-bb"></a><span class="special">~</span><span class="identifier">required_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/program_options/split_unix.html b/doc/html/boost/program_options/split_unix.html index 83fc09ef1f..794d627d12 100644 --- a/doc/html/boost/program_options/split_unix.html +++ b/doc/html/boost/program_options/split_unix.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp" title="Header <boost/program_options/parsers.hpp>"> -<link rel="prev" href="parse_environ_idp682396016.html" title="Function parse_environment"> -<link rel="next" href="positional_op_idp682411312.html" title="Class positional_options_description"> +<link rel="prev" href="parse_environ_idp709096080.html" title="Function parse_environment"> +<link rel="next" href="positional_op_idp709111376.html" title="Class positional_options_description"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_environ_idp682396016.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="positional_op_idp682411312.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_environ_idp709096080.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="positional_op_idp709111376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.split_unix"></a><div class="titlepage"></div> @@ -43,7 +43,7 @@ <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span> quote <span class="special">=</span> <span class="identifier">L</span><span class="string">"'\""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">wstring</span> <span class="special">&</span> escape <span class="special">=</span> <span class="identifier">L</span><span class="string">"\\"</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp438957488"></a><h2>Description</h2> +<a name="idp422732848"></a><h2>Description</h2> <p>Splits a given string to a collection of single strings which can be passed to command_line_parser. The second parameter is used to specify a collection of possible seperator chars used for splitting. The seperator is defaulted to space " ". Splitting is done in a unix style way, with respect to quotes '"' and escape characters '\' </p> </div> </div> @@ -57,7 +57,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="parse_environ_idp682396016.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="positional_op_idp682411312.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="parse_environ_idp709096080.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_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="positional_op_idp709111376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/store_idp682615248.html b/doc/html/boost/program_options/store_idp709315296.html index df995327c0..f9a135b7fd 100644 --- a/doc/html/boost/program_options/store_idp682615248.html +++ b/doc/html/boost/program_options/store_idp709315296.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> <link rel="prev" href="variables_map.html" title="Class variables_map"> -<link rel="next" href="store_idp682619776.html" title="Function store"> +<link rel="next" href="store_idp709319824.html" title="Function store"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp682619776.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp709319824.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.store_idp682615248"></a><div class="titlepage"></div> +<a name="boost.program_options.store_idp709315296"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function store</span></h2> <p>boost::program_options::store</p> @@ -37,7 +37,7 @@ <span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">bool</span> utf8 <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440532528"></a><h2>Description</h2> +<a name="idp424309376"></a><h2>Description</h2> <p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp682619776.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp709319824.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/store_idp682619776.html b/doc/html/boost/program_options/store_idp709319824.html index 7b488591af..c5db646b0b 100644 --- a/doc/html/boost/program_options/store_idp682619776.html +++ b/doc/html/boost/program_options/store_idp709319824.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="store_idp682615248.html" title="Function store"> +<link rel="prev" href="store_idp709315296.html" title="Function store"> <link rel="next" href="notify.html" title="Function notify"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="store_idp682615248.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="notify.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="store_idp709315296.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="notify.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.store_idp682619776"></a><div class="titlepage"></div> +<a name="boost.program_options.store_idp709319824"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function store</span></h2> <p>boost::program_options::store</p> @@ -36,7 +36,7 @@ <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> <span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440547248"></a><h2>Description</h2> +<a name="idp424324160"></a><h2>Description</h2> <p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. This is wide character variant. </p> </div> </div> @@ -50,7 +50,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="store_idp682615248.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="notify.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="store_idp709315296.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="notify.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/too_many_posi_idp682066288.html b/doc/html/boost/program_options/too_many_posi_idp708777344.html index 0ec10f8f0e..52e70cf24b 100644 --- a/doc/html/boost/program_options/too_many_posi_idp682066288.html +++ b/doc/html/boost/program_options/too_many_posi_idp708777344.html @@ -24,7 +24,7 @@ <a accesskey="p" href="error.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_command_line_style.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.too_many_posi_idp682066288"></a><div class="titlepage"></div> +<a name="boost.program_options.too_many_posi_idp708777344"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class too_many_positional_options_error</span></h2> <p>boost::program_options::too_many_positional_options_error</p> @@ -33,22 +33,22 @@ <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="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="too_many_posi_idp682066288.html" title="Class too_many_positional_options_error">too_many_positional_options_error</a> <span class="special">:</span> +<span class="keyword">class</span> <a class="link" href="too_many_posi_idp708777344.html" title="Class too_many_positional_options_error">too_many_positional_options_error</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">error</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="too_many_posi_idp682066288.html#boost.program_options.too_many_posi_idp682066288construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="too_many_posi_idp682066288.html#idp682068480-bb"><span class="identifier">too_many_positional_options_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="too_many_posi_idp708777344.html#boost.program_options.too_many_posi_idp708777344construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="too_many_posi_idp708777344.html#idp708779536-bb"><span class="identifier">too_many_positional_options_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436415040"></a><h2>Description</h2> +<a name="idp420266896"></a><h2>Description</h2> <p>Class thrown when there are too many positional options. This is a programming error. </p> <div class="refsect2"> -<a name="idp436415808"></a><h3> -<a name="boost.program_options.too_many_posi_idp682066288construct-copy-destruct"></a><code class="computeroutput">too_many_positional_options_error</code> +<a name="idp420267664"></a><h3> +<a name="boost.program_options.too_many_posi_idp708777344construct-copy-destruct"></a><code class="computeroutput">too_many_positional_options_error</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682068480-bb"></a><span class="identifier">too_many_positional_options_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp708779536-bb"></a><span class="identifier">too_many_positional_options_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/program_options/typed_value.html b/doc/html/boost/program_options/typed_value.html index 6729190ed1..fa82f25a55 100644 --- a/doc/html/boost/program_options/typed_value.html +++ b/doc/html/boost/program_options/typed_value.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> <link rel="prev" href="typed_value_base.html" title="Class typed_value_base"> -<link rel="next" href="value_idp682542144.html" title="Function value"> +<link rel="next" href="value_idp709237120.html" title="Function value"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="typed_value_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_idp682542144.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="typed_value_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_idp709237120.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.typed_value"></a><div class="titlepage"></div> @@ -38,107 +38,105 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="typed_value.html#boost.program_options.typed_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="typed_value.html#idp682540496-bb"><span class="identifier">typed_value</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html#idp709235472-bb"><span class="identifier">typed_value</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="typed_value.html#idp682500976-bb">public member functions</a></span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682501536-bb"><span class="identifier">default_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682503888-bb"><span class="identifier">default_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682507040-bb"><span class="identifier">implicit_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682509584-bb"><span class="identifier">value_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682511872-bb"><span class="identifier">implicit_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682515264-bb"><span class="identifier">notifier</span></a><span class="special">(</span><span class="identifier">function1</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <span class="special">></span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682517568-bb"><span class="identifier">composing</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682519184-bb"><span class="identifier">multitoken</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682520768-bb"><span class="identifier">zero_tokens</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp682522656-bb"><span class="identifier">required</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="typed_value.html#idp682524224-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp682525344-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="typed_value.html#idp682526464-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">unsigned</span> <a class="link" href="typed_value.html#idp682527584-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp682528704-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp682529824-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="typed_value.html#idp682530944-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp682533984-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="typed_value.html#idp682536608-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a class="link" href="typed_value.html#idp682538944-bb"><span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="typed_value.html#idp709197232-bb">public member functions</a></span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709197792-bb"><span class="identifier">default_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709200144-bb"><span class="identifier">default_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709203296-bb"><span class="identifier">implicit_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709205680-bb"><span class="identifier">value_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709207968-bb"><span class="identifier">implicit_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709211360-bb"><span class="identifier">notifier</span></a><span class="special">(</span><span class="identifier">function1</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <span class="special">></span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709213664-bb"><span class="identifier">composing</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709215280-bb"><span class="identifier">multitoken</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709216864-bb"><span class="identifier">zero_tokens</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a class="link" href="typed_value.html#idp709218752-bb"><span class="identifier">required</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="typed_value.html#idp709220320-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp709221440-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">unsigned</span> <a class="link" href="typed_value.html#idp709222560-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">unsigned</span> <a class="link" href="typed_value.html#idp709223680-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp709224800-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="typed_value.html#idp709225920-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="typed_value.html#idp709228960-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="typed_value.html#idp709231584-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a class="link" href="typed_value.html#idp709233920-bb"><span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439857504"></a><h2>Description</h2> +<a name="idp423602944"></a><h2>Description</h2> <p>Class which handles value of a specific type. </p> <div class="refsect2"> -<a name="idp439858240"></a><h3> +<a name="idp423603680"></a><h3> <a name="boost.program_options.typed_valueconstruct-copy-destruct"></a><code class="computeroutput">typed_value</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp682540496-bb"></a><span class="identifier">typed_value</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> store_to<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp709235472-bb"></a><span class="identifier">typed_value</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> store_to<span class="special">)</span><span class="special">;</span></pre> <p>Ctor. The 'store_to' parameter tells where to store the value when it's known. The parameter can be NULL. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp439866016"></a><h3> -<a name="idp682500976-bb"></a><code class="computeroutput">typed_value</code> public member functions</h3> +<a name="idp423611392"></a><h3> +<a name="idp709197232-bb"></a><code class="computeroutput">typed_value</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682501536-bb"></a><span class="identifier">default_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709197792-bb"></a><span class="identifier">default_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre> <p>Specifies default value, which will be used if none is explicitly specified. The type 'T' should provide operator<< for ostream. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682503888-bb"></a><span class="identifier">default_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> textual<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709200144-bb"></a><span class="identifier">default_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> textual<span class="special">)</span><span class="special">;</span></pre> <p>Specifies default value, which will be used if none is explicitly specified. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682507040-bb"></a><span class="identifier">implicit_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre> -<p>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '–option=value'. Giving '-o' or '–option' will cause the implicit value to be applied. </p> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709203296-bb"></a><span class="identifier">implicit_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">)</span><span class="special">;</span></pre> +<p>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682509584-bb"></a><span class="identifier">value_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709205680-bb"></a><span class="identifier">value_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Specifies the name used to to the value in help message. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682511872-bb"></a><span class="identifier">implicit_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> textual<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709207968-bb"></a><span class="identifier">implicit_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> v<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> textual<span class="special">)</span><span class="special">;</span></pre> <p>Specifies an implicit value, which will be used if the option is given, but without an adjacent value. Using this implies that an explicit value is optional, but if given, must be strictly adjacent to the option, i.e.: '-ovalue' or '–option=value'. Giving '-o' or '–option' will cause the implicit value to be applied. Unlike the above overload, the type 'T' need not provide operator<< for ostream, but textual representation of default value must be provided by the user. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682515264-bb"></a><span class="identifier">notifier</span><span class="special">(</span><span class="identifier">function1</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <span class="special">></span> f<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709211360-bb"></a><span class="identifier">notifier</span><span class="special">(</span><span class="identifier">function1</span><span class="special"><</span> <span class="keyword">void</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <span class="special">></span> f<span class="special">)</span><span class="special">;</span></pre> <p>Specifies a function to be called when the final value is determined. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682517568-bb"></a><span class="identifier">composing</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709213664-bb"></a><span class="identifier">composing</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Specifies that the value is composing. See the 'is_composing' method for explanation. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682519184-bb"></a><span class="identifier">multitoken</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709215280-bb"></a><span class="identifier">multitoken</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Specifies that the value can span multiple tokens. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682520768-bb"></a><span class="identifier">zero_tokens</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709216864-bb"></a><span class="identifier">zero_tokens</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Specifies that no tokens may be provided as the value of this option, which means that only presense of the option is significant. For such option to be useful, either the 'validate' function should be specialized, or the 'implicit_value' method should be also used. In most cases, you can use the 'bool_switch' function instead of using this method. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp682522656-bb"></a><span class="identifier">required</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a> <span class="special">*</span> <a name="idp709218752-bb"></a><span class="identifier">required</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Specifies that the value must occur. </p> </li> -<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682524224-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp682525344-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp682526464-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp682527584-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp682528704-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp682529824-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp709220320-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp709221440-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp709222560-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">unsigned</span> <a name="idp709223680-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">bool</span> <a name="idp709224800-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682530944-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp709225920-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Creates an instance of the 'validator' class and calls its operator() to perform the actual conversion. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682533984-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp709228960-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>If default value was specified via previous call to 'default_value', stores that value into 'value_store'. Returns true if default value was stored. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp682536608-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp709231584-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>If an address of variable to store value was specified when creating *this, stores the value there. Otherwise, does nothing. </p> </li> -<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a name="idp682538944-bb"></a><span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a name="idp709233920-bb"></a><span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> </ol></div> </div> </div> @@ -153,7 +151,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="typed_value_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_idp682542144.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="typed_value_base.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_idp709237120.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/typed_value_base.html b/doc/html/boost/program_options/typed_value_base.html index 982fac0cf5..99ff00903a 100644 --- a/doc/html/boost/program_options/typed_value_base.html +++ b/doc/html/boost/program_options/typed_value_base.html @@ -36,25 +36,25 @@ <span class="keyword">class</span> <a class="link" href="typed_value_base.html" title="Class typed_value_base">typed_value_base</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="typed_value_base.html#boost.program_options.typed_value_baseconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="typed_value_base.html#idp682496944-bb"><span class="special">~</span><span class="identifier">typed_value_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="typed_value_base.html#idp709193200-bb"><span class="special">~</span><span class="identifier">typed_value_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="typed_value_base.html#idp682494832-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a class="link" href="typed_value_base.html#idp682495392-bb"><span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="comment">// <a class="link" href="typed_value_base.html#idp709191088-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a class="link" href="typed_value_base.html#idp709191648-bb"><span class="identifier">value_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439683792"></a><h2>Description</h2> +<a name="idp423433504"></a><h2>Description</h2> <p>Base class for all option that have a fixed type, and are willing to announce this type to the outside world. Any 'value_semantics' for which you want to find out the type can be dynamic_cast-ed to <a class="link" href="typed_value_base.html" title="Class typed_value_base">typed_value_base</a>. If conversion succeeds, the 'type' method can be called. </p> <div class="refsect2"> -<a name="idp439685552"></a><h3> +<a name="idp423435264"></a><h3> <a name="boost.program_options.typed_value_baseconstruct-copy-destruct"></a><code class="computeroutput">typed_value_base</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682496944-bb"></a><span class="special">~</span><span class="identifier">typed_value_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp709193200-bb"></a><span class="special">~</span><span class="identifier">typed_value_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp439692128"></a><h3> -<a name="idp682494832-bb"></a><code class="computeroutput">typed_value_base</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a name="idp682495392-bb"></a><span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li></ol></div> +<a name="idp423441840"></a><h3> +<a name="idp709191088-bb"></a><code class="computeroutput">typed_value_base</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">type_info</span> <span class="special">&</span> <a name="idp709191648-bb"></a><span class="identifier">value_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/program_options/unknown_option.html b/doc/html/boost/program_options/unknown_option.html index 4d59d78336..bdcdec045b 100644 --- a/doc/html/boost/program_options/unknown_option.html +++ b/doc/html/boost/program_options/unknown_option.html @@ -38,20 +38,20 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="unknown_option.html#boost.program_options.unknown_optionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="unknown_option.html#idp682132080-bb"><span class="identifier">unknown_option</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="unknown_option.html#idp682133344-bb"><span class="special">~</span><span class="identifier">unknown_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="unknown_option.html#idp708843136-bb"><span class="identifier">unknown_option</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="unknown_option.html#idp708844400-bb"><span class="special">~</span><span class="identifier">unknown_option</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp436963072"></a><h2>Description</h2> +<a name="idp420814240"></a><h2>Description</h2> <p>Class thrown when option name is not recognized. </p> <div class="refsect2"> -<a name="idp436963808"></a><h3> +<a name="idp420814976"></a><h3> <a name="boost.program_options.unknown_optionconstruct-copy-destruct"></a><code class="computeroutput">unknown_option</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682132080-bb"></a><span class="identifier">unknown_option</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682133344-bb"></a><span class="special">~</span><span class="identifier">unknown_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708843136-bb"></a><span class="identifier">unknown_option</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708844400-bb"></a><span class="special">~</span><span class="identifier">unknown_option</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/program_options/untyped_value.html b/doc/html/boost/program_options/untyped_value.html index 0ce05c284f..da77a5f84a 100644 --- a/doc/html/boost/program_options/untyped_value.html +++ b/doc/html/boost/program_options/untyped_value.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semanti_idp682459088.html" title="Class value_semantic_codecvt_helper<wchar_t>"> +<link rel="prev" href="value_semanti_idp709157248.html" title="Class value_semantic_codecvt_helper<wchar_t>"> <link rel="next" href="typed_value_base.html" title="Class typed_value_base"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp682459088.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semanti_idp709157248.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.untyped_value"></a><div class="titlepage"></div> @@ -38,69 +38,64 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="untyped_value.html#boost.program_options.untyped_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="untyped_value.html#idp682491776-bb"><span class="identifier">untyped_value</span></a><span class="special">(</span><span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="untyped_value.html#idp709188032-bb"><span class="identifier">untyped_value</span></a><span class="special">(</span><span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="untyped_value.html#idp682471312-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="untyped_value.html#idp682471872-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp682473760-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp682475648-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp682477536-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp682479440-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp682481392-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp682483248-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp682486624-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp682489120-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="untyped_value.html#idp709169472-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="untyped_value.html#idp709170032-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp709171920-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="untyped_value.html#idp709173808-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp709175696-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp709177648-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp709179504-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="untyped_value.html#idp709182880-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="untyped_value.html#idp709185376-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439579120"></a><h2>Description</h2> +<a name="idp423335120"></a><h2>Description</h2> <p>Class which specifies a simple handling of a value: the value will have string type and only one token is allowed. </p> <div class="refsect2"> -<a name="idp439579920"></a><h3> +<a name="idp423335920"></a><h3> <a name="boost.program_options.untyped_valueconstruct-copy-destruct"></a><code class="computeroutput">untyped_value</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682491776-bb"></a><span class="identifier">untyped_value</span><span class="special">(</span><span class="keyword">bool</span> zero_tokens <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp709188032-bb"></a><span class="identifier">untyped_value</span><span class="special">(</span><span class="keyword">bool</span> zero_tokens <span class="special">=</span> <span class="keyword">false</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp439587904"></a><h3> -<a name="idp682471312-bb"></a><code class="computeroutput">untyped_value</code> public member functions</h3> +<a name="idp423343824"></a><h3> +<a name="idp709169472-bb"></a><code class="computeroutput">untyped_value</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682471872-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp709170032-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the name of the option. The name is only meaningful for automatic help message. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp682473760-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp709171920-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>The minimum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp682475648-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp709173808-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>The maximum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682477536-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> -<p>Returns true if the option should only take adjacent token, not one from further command-line arguments. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682479440-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp709175696-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682481392-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp709177648-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if value must be given. Non-optional value </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp682483248-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> +<a name="idp709179504-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>If 'value_store' is already initialized, or new_tokens has more than one elements, throws. Otherwise, assigns the first string from 'new_tokens' to 'value_store', without any modifications. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682486624-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp709182880-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Does nothing. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp682489120-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp709185376-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Does nothing. </p> </li> </ol></div> @@ -117,7 +112,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp682459088.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semanti_idp709157248.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="typed_value_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/validation_error.html b/doc/html/boost/program_options/validation_error.html index 9d27bbeb9b..ddb06d8fb2 100644 --- a/doc/html/boost/program_options/validation_error.html +++ b/doc/html/boost/program_options/validation_error.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> -<link rel="prev" href="invalid_comma_idp682162800.html" title="Class invalid_command_line_syntax"> +<link rel="prev" href="invalid_comma_idp708873856.html" title="Class invalid_command_line_syntax"> <link rel="next" href="invalid_option_value.html" title="Class invalid_option_value"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="invalid_comma_idp682162800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="invalid_comma_idp708873856.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.validation_error"></a><div class="titlepage"></div> @@ -42,33 +42,33 @@ at_least_one_value_required, invalid_bool_value, invalid_option_value, invalid_option <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="validation_error.html#boost.program_options.validation_errorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="validation_error.html#idp682174208-bb"><span class="identifier">validation_error</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> + <a class="link" href="validation_error.html#idp708885264-bb"><span class="identifier">validation_error</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="validation_error.html#idp682178112-bb"><span class="special">~</span><span class="identifier">validation_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="validation_error.html#idp708889168-bb"><span class="special">~</span><span class="identifier">validation_error</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="validation_error.html#idp682178400-bb">protected member functions</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="validation_error.html#idp682178976-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="validation_error.html#idp708889456-bb">protected member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="validation_error.html#idp708890032-bb"><span class="identifier">get_template</span></a><span class="special">(</span><span class="identifier">kind_t</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp437327440"></a><h2>Description</h2> +<a name="idp421178256"></a><h2>Description</h2> <p>Class thrown when value of option is incorrect. </p> <div class="refsect2"> -<a name="idp437328176"></a><h3> +<a name="idp421178992"></a><h3> <a name="boost.program_options.validation_errorconstruct-copy-destruct"></a><code class="computeroutput">validation_error</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682174208-bb"></a><span class="identifier">validation_error</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span> +<li class="listitem"><pre class="literallayout"><a name="idp708885264-bb"></a><span class="identifier">validation_error</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> option_name <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> original_token <span class="special">=</span> <span class="string">""</span><span class="special">,</span> <span class="keyword">int</span> option_style <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682178112-bb"></a><span class="special">~</span><span class="identifier">validation_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp708889168-bb"></a><span class="special">~</span><span class="identifier">validation_error</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp437351536"></a><h3> -<a name="idp682178400-bb"></a><code class="computeroutput">validation_error</code> protected member functions</h3> +<a name="idp421202224"></a><h3> +<a name="idp708889456-bb"></a><code class="computeroutput">validation_error</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682178976-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp708890032-bb"></a><span class="identifier">get_template</span><span class="special">(</span><span class="identifier">kind_t</span> kind<span class="special">)</span><span class="special">;</span></pre> <p>Used to convert kind_t to a related error text </p> </li></ol></div> </div> @@ -84,7 +84,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="invalid_comma_idp682162800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="invalid_comma_idp708873856.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.errors_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="invalid_option_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/value_idp682542144.html b/doc/html/boost/program_options/value_idp709237120.html index 8edf7c3106..cf6bd4b0fe 100644 --- a/doc/html/boost/program_options/value_idp682542144.html +++ b/doc/html/boost/program_options/value_idp709237120.html @@ -24,7 +24,7 @@ <a accesskey="p" href="typed_value.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="wvalue.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.value_idp682542144"></a><div class="titlepage"></div> +<a name="boost.program_options.value_idp709237120"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function value</span></h2> <p>boost::program_options::value</p> @@ -36,7 +36,7 @@ <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">*</span> <span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">*</span> <span class="identifier">value</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> v<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440043248"></a><h2>Description</h2> +<a name="idp423782592"></a><h2>Description</h2> <p>Creates a typed_value<T> instance. This function is the primary method to create <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code> instance for a specific type, which can later be passed to '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructor. The second overload is used when it's additionally desired to store the value of option into program variable. </p> </div> </div> diff --git a/doc/html/boost/program_options/value_semanti_idp682446592.html b/doc/html/boost/program_options/value_semanti_idp709144752.html index 349552e35d..9621fffab1 100644 --- a/doc/html/boost/program_options/value_semanti_idp682446592.html +++ b/doc/html/boost/program_options/value_semanti_idp709144752.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> <link rel="prev" href="value_semantic.html" title="Class value_semantic"> -<link rel="next" href="value_semanti_idp682448368.html" title="Class value_semantic_codecvt_helper<char>"> +<link rel="next" href="value_semanti_idp709146528.html" title="Class value_semantic_codecvt_helper<char>"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semantic.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp682448368.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semantic.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp709146528.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.value_semanti_idp682446592"></a><div class="titlepage"></div> +<a name="boost.program_options.value_semanti_idp709144752"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class template value_semantic_codecvt_helper</span></h2> <p>boost::program_options::value_semantic_codecvt_helper</p> @@ -33,16 +33,16 @@ <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="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> charT<span class="special">></span> -<span class="keyword">class</span> <a class="link" href="value_semanti_idp682446592.html" title="Class template value_semantic_codecvt_helper">value_semantic_codecvt_helper</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="value_semanti_idp709144752.html" title="Class template value_semantic_codecvt_helper">value_semantic_codecvt_helper</a> <span class="special">{</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439319808"></a><h2>Description</h2> +<a name="idp423081152"></a><h2>Description</h2> <p>Helper class which perform necessary character conversions in the 'parse' method and forwards the data further. </p> <div class="refsect2"> -<a name="idp439320608"></a><h3>Specializations</h3> +<a name="idp423081952"></a><h3>Specializations</h3> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> -<li class="listitem"><p><a class="link" href="value_semanti_idp682448368.html" title="Class value_semantic_codecvt_helper<char>">Class value_semantic_codecvt_helper<char></a></p></li> -<li class="listitem"><p><a class="link" href="value_semanti_idp682459088.html" title="Class value_semantic_codecvt_helper<wchar_t>">Class value_semantic_codecvt_helper<wchar_t></a></p></li> +<li class="listitem"><p><a class="link" href="value_semanti_idp709146528.html" title="Class value_semantic_codecvt_helper<char>">Class value_semantic_codecvt_helper<char></a></p></li> +<li class="listitem"><p><a class="link" href="value_semanti_idp709157248.html" title="Class value_semantic_codecvt_helper<wchar_t>">Class value_semantic_codecvt_helper<wchar_t></a></p></li> </ul></div> </div> </div> @@ -57,7 +57,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semantic.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp682448368.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semantic.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp709146528.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/value_semanti_idp682448368.html b/doc/html/boost/program_options/value_semanti_idp709146528.html index 77d00f41e6..a7430ef7d6 100644 --- a/doc/html/boost/program_options/value_semanti_idp682448368.html +++ b/doc/html/boost/program_options/value_semanti_idp709146528.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semanti_idp682446592.html" title="Class template value_semantic_codecvt_helper"> -<link rel="next" href="value_semanti_idp682459088.html" title="Class value_semantic_codecvt_helper<wchar_t>"> +<link rel="prev" href="value_semanti_idp709144752.html" title="Class template value_semantic_codecvt_helper"> +<link rel="next" href="value_semanti_idp709157248.html" title="Class value_semantic_codecvt_helper<wchar_t>"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp682446592.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp682459088.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semanti_idp709144752.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp709157248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.value_semanti_idp682448368"></a><div class="titlepage"></div> +<a name="boost.program_options.value_semanti_idp709146528"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class value_semantic_codecvt_helper<char></span></h2> <p>boost::program_options::value_semantic_codecvt_helper<char></p> @@ -33,37 +33,37 @@ <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="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="value_semanti_idp682448368.html" title="Class value_semantic_codecvt_helper<char>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">char</span><span class="special">></span> <span class="special">:</span> +<span class="keyword">class</span> <a class="link" href="value_semanti_idp709146528.html" title="Class value_semantic_codecvt_helper<char>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">char</span><span class="special">></span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">value_semantic</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="value_semanti_idp682448368.html#idp682450736-bb">private member functions</a></span> + <span class="comment">// <a class="link" href="value_semanti_idp709146528.html#idp709148896-bb">private member functions</a></span> <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semanti_idp682448368.html#idp682451312-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="value_semanti_idp709146528.html#idp709149472-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="value_semanti_idp682448368.html#idp682455568-bb">protected member functions</a></span> + <span class="comment">// <a class="link" href="value_semanti_idp709146528.html#idp709153728-bb">protected member functions</a></span> <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semanti_idp682448368.html#idp682456144-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <a class="link" href="value_semanti_idp709146528.html#idp709154304-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439371248"></a><h2>Description</h2> +<a name="idp423132464"></a><h2>Description</h2> <p>Helper conversion class for values that accept ascii strings as input. Overrides the 'parse' method and defines new 'xparse' method taking std::string. Depending on whether input to parse is ascii or UTF8, will pass it to xparse unmodified, or with UTF8->ascii conversion. </p> <div class="refsect2"> -<a name="idp439372448"></a><h3> -<a name="idp682450736-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> private member functions</h3> +<a name="idp423133664"></a><h3> +<a name="idp709148896-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp682451312-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> +<a name="idp709149472-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> <span class="keyword">bool</span> utf8<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp439391456"></a><h3> -<a name="idp682455568-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> protected member functions</h3> +<a name="idp423152608"></a><h3> +<a name="idp709153728-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp682456144-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> +<a name="idp709154304-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li></ol></div> </div> </div> @@ -78,7 +78,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp682446592.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp682459088.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semanti_idp709144752.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp709157248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/value_semanti_idp682459088.html b/doc/html/boost/program_options/value_semanti_idp709157248.html index 7e10ad9a7d..dae2cd4a5a 100644 --- a/doc/html/boost/program_options/value_semanti_idp682459088.html +++ b/doc/html/boost/program_options/value_semanti_idp709157248.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_semanti_idp682448368.html" title="Class value_semantic_codecvt_helper<char>"> +<link rel="prev" href="value_semanti_idp709146528.html" title="Class value_semantic_codecvt_helper<char>"> <link rel="next" href="untyped_value.html" title="Class untyped_value"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp682448368.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="untyped_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semanti_idp709146528.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="untyped_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.program_options.value_semanti_idp682459088"></a><div class="titlepage"></div> +<a name="boost.program_options.value_semanti_idp709157248"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class value_semantic_codecvt_helper<wchar_t></span></h2> <p>boost::program_options::value_semantic_codecvt_helper<wchar_t></p> @@ -33,37 +33,37 @@ <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="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>">boost/program_options/value_semantic.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="value_semanti_idp682459088.html" title="Class value_semantic_codecvt_helper<wchar_t>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span> <span class="special">:</span> +<span class="keyword">class</span> <a class="link" href="value_semanti_idp709157248.html" title="Class value_semantic_codecvt_helper<wchar_t>">value_semantic_codecvt_helper</a><span class="special"><</span><span class="keyword">wchar_t</span><span class="special">></span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">program_options</span><span class="special">::</span><span class="identifier">value_semantic</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="value_semanti_idp682459088.html#idp682461440-bb">private member functions</a></span> + <span class="comment">// <a class="link" href="value_semanti_idp709157248.html#idp709159600-bb">private member functions</a></span> <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semanti_idp682459088.html#idp682462016-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="value_semanti_idp709157248.html#idp709160176-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="value_semanti_idp682459088.html#idp682466272-bb">protected member functions</a></span> + <span class="comment">// <a class="link" href="value_semanti_idp709157248.html#idp709164432-bb">protected member functions</a></span> <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semanti_idp682459088.html#idp682466848-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">wstring</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <a class="link" href="value_semanti_idp709157248.html#idp709165008-bb"><span class="identifier">xparse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">wstring</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439457824"></a><h2>Description</h2> +<a name="idp423218848"></a><h2>Description</h2> <p>Helper conversion class for values that accept ascii strings as input. Overrides the 'parse' method and defines new 'xparse' method taking std::wstring. Depending on whether input to parse is ascii or UTF8, will recode input to Unicode, or pass it unmodified. </p> <div class="refsect2"> -<a name="idp439458768"></a><h3> -<a name="idp682461440-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> private member functions</h3> +<a name="idp423219792"></a><h3> +<a name="idp709159600-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp682462016-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> +<a name="idp709160176-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> <span class="keyword">bool</span> utf8<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp439477840"></a><h3> -<a name="idp682466272-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> protected member functions</h3> +<a name="idp423238800"></a><h3> +<a name="idp709164432-bb"></a><code class="computeroutput">value_semantic_codecvt_helper</code> protected member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp682466848-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> +<a name="idp709165008-bb"></a><span class="identifier">xparse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">wstring</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre></li></ol></div> </div> </div> @@ -78,7 +78,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_semanti_idp682448368.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="untyped_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_semanti_idp709146528.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="untyped_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/value_semantic.html b/doc/html/boost/program_options/value_semantic.html index 5f2a85ef89..381b193ba4 100644 --- a/doc/html/boost/program_options/value_semantic.html +++ b/doc/html/boost/program_options/value_semantic.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="positional_op_idp682411312.html" title="Class positional_options_description"> -<link rel="next" href="value_semanti_idp682446592.html" title="Class template value_semantic_codecvt_helper"> +<link rel="prev" href="positional_op_idp709111376.html" title="Class positional_options_description"> +<link rel="next" href="value_semanti_idp709144752.html" title="Class template value_semantic_codecvt_helper"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="positional_op_idp682411312.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp682446592.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="positional_op_idp709111376.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp709144752.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.value_semantic"></a><div class="titlepage"></div> @@ -36,70 +36,65 @@ <span class="keyword">class</span> <a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="value_semantic.html#boost.program_options.value_semanticconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="value_semantic.html#idp682446304-bb"><span class="special">~</span><span class="identifier">value_semantic</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="value_semantic.html#idp709144464-bb"><span class="special">~</span><span class="identifier">value_semantic</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="value_semantic.html#idp682424976-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="value_semantic.html#idp682425536-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#idp682427424-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#idp682429312-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp682431200-bb"><span class="identifier">adjacent_tokens_only</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp682433104-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp682435056-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="comment">// <a class="link" href="value_semantic.html#idp709125040-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="value_semantic.html#idp709125600-bb"><span class="identifier">name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#idp709127488-bb"><span class="identifier">min_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a class="link" href="value_semantic.html#idp709129376-bb"><span class="identifier">max_tokens</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp709131264-bb"><span class="identifier">is_composing</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp709133216-bb"><span class="identifier">is_required</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="keyword">virtual</span> <span class="keyword">void</span> - <a class="link" href="value_semantic.html#idp682436912-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp682441008-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> - <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="value_semantic.html#idp682443616-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <a class="link" href="value_semantic.html#idp709135072-bb"><span class="identifier">parse</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="value_semantic.html#idp709139168-bb"><span class="identifier">apply_default</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> + <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="value_semantic.html#idp709141776-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp439216960"></a><h2>Description</h2> +<a name="idp422985760"></a><h2>Description</h2> <p>Class which specifies how the option's value is to be parsed and converted into C++ types. </p> <div class="refsect2"> -<a name="idp439217744"></a><h3> +<a name="idp422986544"></a><h3> <a name="boost.program_options.value_semanticconstruct-copy-destruct"></a><code class="computeroutput">value_semantic</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp682446304-bb"></a><span class="special">~</span><span class="identifier">value_semantic</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp709144464-bb"></a><span class="special">~</span><span class="identifier">value_semantic</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp439224240"></a><h3> -<a name="idp682424976-bb"></a><code class="computeroutput">value_semantic</code> public member functions</h3> +<a name="idp422992912"></a><h3> +<a name="idp709125040-bb"></a><code class="computeroutput">value_semantic</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp682425536-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="idp709125600-bb"></a><span class="identifier">name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>Returns the name of the option. The name is only meaningful for automatic help message. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp682427424-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp709127488-bb"></a><span class="identifier">min_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>The minimum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp682429312-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">unsigned</span> <a name="idp709129376-bb"></a><span class="identifier">max_tokens</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>The maximum number of tokens for this option that should be present on the command line. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682431200-bb"></a><span class="identifier">adjacent_tokens_only</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> -<p>Returns true if the option should only take adjacent token, not one from further command-line arguments. </p> -</li> -<li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682433104-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp709131264-bb"></a><span class="identifier">is_composing</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682435056-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp709133216-bb"></a><span class="identifier">is_required</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>Returns true if value must be given. Non-optional value </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> -<a name="idp682436912-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> +<a name="idp709135072-bb"></a><span class="identifier">parse</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">,</span> <span class="keyword">const</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">string</span> <span class="special">></span> <span class="special">&</span> new_tokens<span class="special">,</span> <span class="keyword">bool</span> utf8<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>Parses a group of tokens that specify a value of option. Stores the result in 'value_store', using whatever representation is desired. May be be called several times if value of the same option is specified more than once. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp682441008-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp709139168-bb"></a><span class="identifier">apply_default</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>Called to assign default value to 'value_store'. Returns true if default value is assigned, and false if no default value exists. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp682443616-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp709141776-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> value_store<span class="special">)</span> <span class="keyword">const</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span></pre> <p>Called when final value of an option is determined. </p> </li> </ol></div> @@ -116,7 +111,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="positional_op_idp682411312.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp682446592.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="positional_op_idp709111376.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="value_semanti_idp709144752.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/variable_value.html b/doc/html/boost/program_options/variable_value.html index c2472a0ab4..542829dc11 100644 --- a/doc/html/boost/program_options/variable_value.html +++ b/doc/html/boost/program_options/variable_value.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> -<link rel="prev" href="bool_switch.html" title="Function bool_switch"> +<link rel="prev" href="basic_parsed_options.html" title="Class template basic_parsed_options"> <link rel="next" href="abstract_variables_map.html" title="Class abstract_variables_map"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_parsed_options.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.variable_value"></a><div class="titlepage"></div> @@ -36,67 +36,67 @@ <span class="keyword">class</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="variable_value.html#boost.program_options.variable_valueconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="variable_value.html#idp682578640-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="variable_value.html#idp682578928-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variable_value.html#idp709278848-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variable_value.html#idp709279136-bb"><span class="identifier">variable_value</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variable_value.html#idp682562400-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="variable_value.html#idp709262608-bb">friend functions</a></span> <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> - <a class="link" href="variable_value.html#idp682562960-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variable_value.html#idp709263168-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variable_value.html#idp682567360-bb">public member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp682567920-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp682570384-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp682572624-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp682574048-bb"><span class="identifier">defaulted</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp682575648-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp682577200-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="variable_value.html#idp709267568-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp709268128-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp709270592-bb"><span class="identifier">as</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp709272832-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="variable_value.html#idp709274256-bb"><span class="identifier">defaulted</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp709275856-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a class="link" href="variable_value.html#idp709277408-bb"><span class="identifier">value</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440208912"></a><h2>Description</h2> +<a name="idp423985824"></a><h2>Description</h2> <p>Class holding value of option. Contains details about how the value is set and allows to conveniently obtain the value. </p> <div class="refsect2"> -<a name="idp440209728"></a><h3> +<a name="idp423986640"></a><h3> <a name="boost.program_options.variable_valueconstruct-copy-destruct"></a><code class="computeroutput">variable_value</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682578640-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682578928-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> xv<span class="special">,</span> <span class="keyword">bool</span> xdefaulted<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp709278848-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp709279136-bb"></a><span class="identifier">variable_value</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> xv<span class="special">,</span> <span class="keyword">bool</span> xdefaulted<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp440223952"></a><h3> -<a name="idp682562400-bb"></a><code class="computeroutput">variable_value</code> friend functions</h3> +<a name="idp424000864"></a><h3> +<a name="idp709262608-bb"></a><code class="computeroutput">variable_value</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> -<a name="idp682562960-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span></pre> +<a name="idp709263168-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span></pre> <p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp440240032"></a><h3> -<a name="idp682567360-bb"></a><code class="computeroutput">variable_value</code> public member functions</h3> +<a name="idp424016944"></a><h3> +<a name="idp709267568-bb"></a><code class="computeroutput">variable_value</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp682567920-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp709268128-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>If stored value if of type T, returns that value. Otherwise, throws boost::bad_any_cast exception. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp682570384-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">T</span> <span class="special">&</span> <a name="idp709270592-bb"></a><span class="identifier">as</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp682572624-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if no value is stored. </li> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp709272832-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns true if no value is stored. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp682574048-bb"></a><span class="identifier">defaulted</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp709274256-bb"></a><span class="identifier">defaulted</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if the value was not explicitly given, but has default value. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp682575648-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp709275856-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the contained value. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp682577200-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">any</span> <span class="special">&</span> <a name="idp709277408-bb"></a><span class="identifier">value</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the contained value. </p> </li> </ol></div> @@ -113,7 +113,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="bool_switch.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_parsed_options.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="abstract_variables_map.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/variables_map.html b/doc/html/boost/program_options/variables_map.html index 021c8c4bc8..32059a6d3c 100644 --- a/doc/html/boost/program_options/variables_map.html +++ b/doc/html/boost/program_options/variables_map.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.variables_map_hpp" title="Header <boost/program_options/variables_map.hpp>"> <link rel="prev" href="abstract_variables_map.html" title="Class abstract_variables_map"> -<link rel="next" href="store_idp682615248.html" title="Function store"> +<link rel="next" href="store_idp709315296.html" title="Function store"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp682615248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp709315296.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.variables_map"></a><div class="titlepage"></div> @@ -38,58 +38,58 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="variables_map.html#boost.program_options.variables_mapconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="variables_map.html#idp682604672-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="variables_map.html#idp682604960-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variables_map.html#idp709304880-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variables_map.html#idp709305168-bb"><span class="identifier">variables_map</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variables_map.html#idp682600000-bb">public member functions</a></span> - <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp682600560-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="variables_map.html#idp682602816-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="variables_map.html#idp682603664-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="variables_map.html#idp709300208-bb">public member functions</a></span> + <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp709300768-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="variables_map.html#idp709303024-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="variables_map.html#idp709303872-bb"><span class="identifier">notify</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variables_map.html#idp682606384-bb">private member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp682606960-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="variables_map.html#idp709306592-bb">private member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a class="link" href="variables_map.html#idp709307168-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="variables_map.html#idp682610128-bb">friend functions</a></span> + <span class="comment">// <a class="link" href="variables_map.html#idp709310336-bb">friend functions</a></span> <span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> - <a class="link" href="variables_map.html#idp682610688-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="variables_map.html#idp709310896-bb"><span class="identifier">store</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">bool</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440452448"></a><h2>Description</h2> +<a name="idp424229152"></a><h2>Description</h2> <p>Concrete variables map which store variables in real map.</p> <p>This class is derived from std::map<std::string, variable_value>, so you can use all map operators to examine its content. </p> <div class="refsect2"> -<a name="idp440453664"></a><h3> +<a name="idp424230448"></a><h3> <a name="boost.program_options.variables_mapconstruct-copy-destruct"></a><code class="computeroutput">variables_map</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp682604672-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp682604960-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp709304880-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp709305168-bb"></a><span class="identifier">variables_map</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="abstract_variables_map.html" title="Class abstract_variables_map">abstract_variables_map</a> <span class="special">*</span> next<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp440465536"></a><h3> -<a name="idp682600000-bb"></a><code class="computeroutput">variables_map</code> public member functions</h3> +<a name="idp424242320"></a><h3> +<a name="idp709300208-bb"></a><code class="computeroutput">variables_map</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp682600560-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp682602816-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp682603664-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp709300768-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp709303024-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp709303872-bb"></a><span class="identifier">notify</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp440486928"></a><h3> -<a name="idp682606384-bb"></a><code class="computeroutput">variables_map</code> private member functions</h3> +<a name="idp424263840"></a><h3> +<a name="idp709306592-bb"></a><code class="computeroutput">variables_map</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp682606960-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <a class="link" href="variable_value.html" title="Class variable_value">variable_value</a> <span class="special">&</span> <a name="idp709307168-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <span class="special">&</span> name<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Implementation of abstract_variables_map::get which does 'find' in *this. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp440499776"></a><h3> -<a name="idp682610128-bb"></a><code class="computeroutput">variables_map</code> friend functions</h3> +<a name="idp424276688"></a><h3> +<a name="idp709310336-bb"></a><code class="computeroutput">variables_map</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">BOOST_PROGRAM_OPTIONS_DECL</span> <span class="keyword">void</span> -<a name="idp682610688-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> xm<span class="special">,</span> +<a name="idp709310896-bb"></a><span class="identifier">store</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a><span class="special"><</span> <span class="keyword">char</span> <span class="special">></span> <span class="special">&</span> options<span class="special">,</span> <a class="link" href="variables_map.html" title="Class variables_map">variables_map</a> <span class="special">&</span> xm<span class="special">,</span> <span class="keyword">bool</span> utf8<span class="special">)</span><span class="special">;</span></pre> <p>Stores in 'm' all options that are defined in 'options'. If 'm' already has a non-defaulted value of an option, that value is not changed, even if 'options' specify some value. </p> </li></ol></div> @@ -106,7 +106,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp682615248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="abstract_variables_map.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.variables_map_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="store_idp709315296.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/program_options/wvalue.html b/doc/html/boost/program_options/wvalue.html index 2085ce1710..8b0a9db1bf 100644 --- a/doc/html/boost/program_options/wvalue.html +++ b/doc/html/boost/program_options/wvalue.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../program_options/reference.html#header.boost.program_options.value_semantic_hpp" title="Header <boost/program_options/value_semantic.hpp>"> -<link rel="prev" href="value_idp682542144.html" title="Function value"> +<link rel="prev" href="value_idp709237120.html" title="Function value"> <link rel="next" href="bool_switch.html" title="Function bool_switch"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_idp682542144.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="bool_switch.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_idp709237120.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="bool_switch.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.program_options.wvalue"></a><div class="titlepage"></div> @@ -36,7 +36,7 @@ <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">*</span> <span class="identifier">wvalue</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="typed_value.html" title="Class template typed_value">typed_value</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">wchar_t</span> <span class="special">></span> <span class="special">*</span> <span class="identifier">wvalue</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> v<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp440070736"></a><h2>Description</h2> +<a name="idp423810064"></a><h2>Description</h2> <p>Creates a typed_value<T> instance. This function is the primary method to create <code class="computeroutput"><a class="link" href="value_semantic.html" title="Class value_semantic">value_semantic</a></code> instance for a specific type, which can later be passed to '<code class="computeroutput"><a class="link" href="option_description.html" title="Class option_description">option_description</a></code>' constructor. </p> </div> </div> @@ -50,7 +50,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="value_idp682542144.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="bool_switch.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="value_idp709237120.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.value_semantic_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="bool_switch.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |