1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Class error_with_option_name</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>"> 10<link rel="prev" href="error_with_no_option_name.html" title="Class error_with_no_option_name"> 11<link rel="next" href="invalid_bool_value.html" title="Class invalid_bool_value"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="error_with_no_option_name.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_bool_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="refentry"> 27<a name="boost.program_options.error_with_option_name"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class error_with_option_name</span></h2> 30<p>boost::program_options::error_with_option_name</p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../program_options/reference.html#header.boost.program_options.errors_hpp" title="Header <boost/program_options/errors.hpp>">boost/program_options/errors.hpp</a>> 34 35</span> 36<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> 37<span class="keyword">public</span><span class="special">:</span> 38 <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> 39 <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_5-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> 40 <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> 41 <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_6-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> 42 43 <span class="comment">// <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4-bb">public member functions</a></span> 44 <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4_1-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> 45 <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4_2-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> 46 <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> 47 <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4_3-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> 48 <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4_4-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> 49 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4_5-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> 50 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4_6-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> 51 <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_4_7-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> 52 <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#id-1_3_31_9_5_1_1_4_4_8-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 53 54 <span class="comment">// <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_7-bb">protected member functions</a></span> 55 <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_7_1-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> 56 <span class="keyword">void</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_7_2-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> 57 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_7_3-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> 58 <span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a class="link" href="error_with_option_name.html#id-1_3_31_9_5_1_1_4_7_4-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> 59 60 <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> 61 <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> 62<span class="special">}</span><span class="special">;</span></pre></div> 63<div class="refsect1"> 64<a name="id-1.3.31.9.6.6.4"></a><h2>Description</h2> 65<p>Base class for most exceptions in the library.</p> 66<p>Substitutes the values for the parameter name placeholders in the template to create the human readable error message</p> 67<p>Placeholders are surrounded by % signs: example% Poor man's version of boost::format</p> 68<p>If a parameter name is absent, perform default substitutions instead so ugly placeholders are never left in-place.</p> 69<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> 70<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> 71<div class="refsect2"> 72<a name="id-1.3.31.9.6.6.4.8"></a><h3> 73<a name="boost.program_options.error_with_option_nameconstruct-copy-destruct"></a><code class="computeroutput">error_with_option_name</code> 74 public 75 construct/copy/destruct</h3> 76<div class="orderedlist"><ol class="orderedlist" type="1"> 77<li class="listitem"><pre class="literallayout"><a name="id-1_3_31_9_5_1_1_4_5-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> 78 <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> 79 <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> 80 <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> 81<li class="listitem"> 82<pre class="literallayout"><a name="id-1_3_31_9_5_1_1_4_6-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> 83<p>gcc says that throw specification on dtor is loosened without this line </p> 84</li> 85</ol></div> 86</div> 87<div class="refsect2"> 88<a name="id-1.3.31.9.6.6.4.9"></a><h3> 89<a name="id-1_3_31_9_5_1_1_4_4-bb"></a><code class="computeroutput">error_with_option_name</code> public member functions</h3> 90<div class="orderedlist"><ol class="orderedlist" type="1"> 91<li class="listitem"> 92<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_4_1-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> 93 <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> 94<p>Substitute parameter_name->value to create the error message from the error template </p> 95</li> 96<li class="listitem"> 97<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_4_2-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> 98 <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> 99<p>If the parameter is missing, then make the from->to substitution instead </p> 100</li> 101<li class="listitem"> 102<pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_4_3-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> 103 <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> 104<p>Add context to an exception </p> 105</li> 106<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_4_4-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> 107<li class="listitem"> 108<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_4_5-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> 109<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> 110</li> 111<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_5_1_1_4_4_6-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> 112<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_4_7-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> 113<li class="listitem"> 114<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="id-1_3_31_9_5_1_1_4_4_8-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> 115<p>Creates the error_message on the fly Currently a thin wrapper for substitute_placeholders() </p> 116</li> 117</ol></div> 118</div> 119<div class="refsect2"> 120<a name="id-1.3.31.9.6.6.4.10"></a><h3> 121<a name="id-1_3_31_9_5_1_1_4_7-bb"></a><code class="computeroutput">error_with_option_name</code> protected member functions</h3> 122<div class="orderedlist"><ol class="orderedlist" type="1"> 123<li class="listitem"> 124<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_7_1-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> 125<p>Makes all substitutions using the template </p> 126</li> 127<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="id-1_3_31_9_5_1_1_4_7_2-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> 128<li class="listitem"> 129<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_5_1_1_4_7_3-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> 130<p>Construct option name in accordance with the appropriate prefix style: i.e. long dash or short slash etc </p> 131</li> 132<li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="id-1_3_31_9_5_1_1_4_7_4-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> 133</ol></div> 134</div> 135<div class="refsect2"> 136<a name="id-1.3.31.9.6.6.4.11"></a><h3> 137<a name="boost.program_options.error_with_option_namepublic-data-members"></a><code class="computeroutput">error_with_option_name</code> 138 public 139 public data members</h3> 140<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 141<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span> <a name="boost.program_options.error_with_option_name.m_error_template"></a><span class="identifier">m_error_template</span><span class="special">;</span></pre> 142<p>template with placeholders </p> 143</li></ol></div> 144</div> 145</div> 146</div> 147<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 148<td align="left"></td> 149<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0. 150 (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at 151 <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 152 </p> 153</div></td> 154</tr></table> 155<hr> 156<div class="spirit-nav"> 157<a accesskey="p" href="error_with_no_option_name.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_bool_value.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 158</div> 159</body> 160</html> 161
