1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class template basic_command_line_parser</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<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_wc_id903122.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">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_parsed_options_wc_id903122.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="collect_unrecognized_mode.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="refentry" title="Class template basic_command_line_parser">
<a name="boost.program_options.basic_command_line_parser"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class template basic_command_line_parser</span></h2>
<p>boost::program_options::basic_command_line_parser</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="emphasis"><em>// 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>>
</em></span><span class="bold"><strong>template</strong></span><<span class="bold"><strong>typename</strong></span> charT>
<span class="bold"><strong>class</strong></span> <a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> {
<span class="bold"><strong>public</strong></span>:
<span class="emphasis"><em>// <a class="link" href="basic_command_line_parser.html#boost.program_options.basic_command_line_parserconstruct-copy-destruct">construct/copy/destruct</a></em></span>
<a class="link" href="basic_command_line_parser.html#id903350-bb">basic_command_line_parser</a>(<span class="bold"><strong>const</strong></span> std::vector< std::basic_string< charT > > &);
<a class="link" href="basic_command_line_parser.html#id903362-bb">basic_command_line_parser</a>(<span class="bold"><strong>int</strong></span>, charT *);
<span class="emphasis"><em>// <a class="link" href="basic_command_line_parser.html#id903223-bb">public member functions</a></em></span>
<span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a class="link" href="basic_command_line_parser.html#id903226-bb">options</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> &) ;
<span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span>
<a class="link" href="basic_command_line_parser.html#id903248-bb">positional</a>(<span class="bold"><strong>const</strong></span> <a class="link" href="positional_options_desc_id883731.html" title="Class positional_options_description">positional_options_description</a> &) ;
<span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a class="link" href="basic_command_line_parser.html#id903269-bb">style</a>(<span class="bold"><strong>int</strong></span>) ;
<span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a class="link" href="basic_command_line_parser.html#id903286-bb">extra_parser</a>(ext_parser) ;
<span class="type"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>< charT ></span> <a class="link" href="basic_command_line_parser.html#id903304-bb">run</a>() ;
<span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a class="link" href="basic_command_line_parser.html#id903317-bb">allow_unregistered</a>() ;
<span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a class="link" href="basic_command_line_parser.html#id903336-bb">extra_style_parser</a>(style_parser) ;
};</pre></div>
<div class="refsect1" title="Description">
<a name="id1430436"></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 nuber 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" title="basic_command_line_parser public construct/copy/destruct">
<a name="id1430457"></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="id903350-bb"></a>basic_command_line_parser(<span class="bold"><strong>const</strong></span> std::vector< std::basic_string< charT > > & args);</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="id903362-bb"></a>basic_command_line_parser(<span class="bold"><strong>int</strong></span> argc, charT * argv);</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" title="basic_command_line_parser public member functions">
<a name="id1430526"></a><h3>
<a name="id903223-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"><span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a name="id903226-bb"></a>options(<span class="bold"><strong>const</strong></span> <a class="link" href="options_description.html" title="Class options_description">options_description</a> & desc) ;</pre>
<p>Sets options descriptions to use. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span>
<a name="id903248-bb"></a>positional(<span class="bold"><strong>const</strong></span> <a class="link" href="positional_options_desc_id883731.html" title="Class positional_options_description">positional_options_description</a> & desc) ;</pre>
<p>Sets positional options description to use. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a name="id903269-bb"></a>style(<span class="bold"><strong>int</strong></span>) ;</pre>
<p>Sets the command line style. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a name="id903286-bb"></a>extra_parser(ext_parser) ;</pre>
<p>Sets the extra parsers. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><a class="link" href="basic_parsed_options.html" title="Class template basic_parsed_options">basic_parsed_options</a>< charT ></span> <a name="id903304-bb"></a>run() ;</pre>
<p>Parses the options and returns the result of parsing. Throws on error. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a name="id903317-bb"></a>allow_unregistered() ;</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"><span class="type"><a class="link" href="basic_command_line_parser.html" title="Class template basic_command_line_parser">basic_command_line_parser</a> &</span> <a name="id903336-bb"></a>extra_style_parser(style_parser s) ;</pre></li>
</ol></div>
</div>
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2002-2004 Vladimir Prus<p>Distributed under the Boost Software License, Version 1.0.
(See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
<a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="basic_parsed_options_wc_id903122.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../program_options/reference.html#header.boost.program_options.parsers_hpp"><img src="../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="collect_unrecognized_mode.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
