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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MySQL++: mysqlpp::CommandLineBase Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MySQL++
 <span id="projectnumber">3.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="classmysqlpp_1_1CommandLineBase.html">CommandLineBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classmysqlpp_1_1CommandLineBase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::CommandLineBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Parses command line arguments and holds the results.
<a href="classmysqlpp_1_1CommandLineBase.html#details">More...</a></p>
<p><code>#include <<a class="el" href="cmdline_8h_source.html">cmdline.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for mysqlpp::CommandLineBase:</div>
<div class="dyncontent">
<div class="center"><img src="classmysqlpp_1_1CommandLineBase__inherit__graph.png" border="0" usemap="#mysqlpp_1_1CommandLineBase_inherit__map" alt="Inheritance graph"/></div>
<map name="mysqlpp_1_1CommandLineBase_inherit__map" id="mysqlpp_1_1CommandLineBase_inherit__map">
<area shape="rect" title="Parses command line arguments and holds the results." alt="" coords="59,5,255,31"/>
<area shape="rect" href="classmysqlpp_1_1examples_1_1CommandLine.html" title="Command line parsing mechanism for ../examples/*.cpp." alt="" coords="5,79,148,117"/>
<area shape="rect" href="classmysqlpp_1_1ssqlsxlat_1_1CommandLine.html" title="Command line parser for MySQL++'s ssqlsxlat tool." alt="" coords="172,79,302,117"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae8de28354623bd1541425f512d46b23a"><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#ae8de28354623bd1541425f512d46b23a">ArgumentList</a></td></tr>
<tr class="memdesc:ae8de28354623bd1541425f512d46b23a"><td class="mdescLeft"> </td><td class="mdescRight">Type for a list of arguments. <a href="#ae8de28354623bd1541425f512d46b23a">More...</a><br /></td></tr>
<tr class="separator:ae8de28354623bd1541425f512d46b23a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a15d9a9ce39ed7da69ece62472905d4c5"><td class="memItemLeft" align="right" valign="top"><a id="a15d9a9ce39ed7da69ece62472905d4c5"></a>
typedef ArgumentList::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a15d9a9ce39ed7da69ece62472905d4c5">ArgumentListIt</a></td></tr>
<tr class="memdesc:a15d9a9ce39ed7da69ece62472905d4c5"><td class="mdescLeft"> </td><td class="mdescRight">Iterator into ArgumentList. <br /></td></tr>
<tr class="separator:a15d9a9ce39ed7da69ece62472905d4c5"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa8efb9e02ee1ac9af845f726c293fc55"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classmysqlpp_1_1CommandLineBase.html#ae8de28354623bd1541425f512d46b23a">ArgumentList</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#aa8efb9e02ee1ac9af845f726c293fc55">extra_args</a> () const</td></tr>
<tr class="memdesc:aa8efb9e02ee1ac9af845f726c293fc55"><td class="mdescLeft"> </td><td class="mdescRight">Get reference to list of command line arguments past the last flag and its possible argument. <a href="#aa8efb9e02ee1ac9af845f726c293fc55">More...</a><br /></td></tr>
<tr class="separator:aa8efb9e02ee1ac9af845f726c293fc55"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cef39986e213b2e596602e8f505e773"><td class="memItemLeft" align="right" valign="top"><a id="a8cef39986e213b2e596602e8f505e773"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a8cef39986e213b2e596602e8f505e773">operator void *</a> () const</td></tr>
<tr class="memdesc:a8cef39986e213b2e596602e8f505e773"><td class="mdescLeft"> </td><td class="mdescRight">Return truthy value if command line was parsed successfully. <br /></td></tr>
<tr class="separator:a8cef39986e213b2e596602e8f505e773"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a36aff0ceccfb08be9b04717dc48ac706"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a36aff0ceccfb08be9b04717dc48ac706">CommandLineBase</a> (int argc, char *const argv[], const char *opts)</td></tr>
<tr class="memdesc:a36aff0ceccfb08be9b04717dc48ac706"><td class="mdescLeft"> </td><td class="mdescRight">Hidden ctor to prevent instantiation. <a href="#a36aff0ceccfb08be9b04717dc48ac706">More...</a><br /></td></tr>
<tr class="separator:a36aff0ceccfb08be9b04717dc48ac706"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a70bf4aaf7c80497bd36a51d2a31c87cd"><td class="memItemLeft" align="right" valign="top"><a id="a70bf4aaf7c80497bd36a51d2a31c87cd"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a70bf4aaf7c80497bd36a51d2a31c87cd">~CommandLineBase</a> ()</td></tr>
<tr class="memdesc:a70bf4aaf7c80497bd36a51d2a31c87cd"><td class="mdescLeft"> </td><td class="mdescRight">Hidden dtor to prevent instantiation. <br /></td></tr>
<tr class="separator:a70bf4aaf7c80497bd36a51d2a31c87cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2351077d0a931ee3ba9738464aaba0c6"><td class="memItemLeft" align="right" valign="top"><a id="a2351077d0a931ee3ba9738464aaba0c6"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a2351077d0a931ee3ba9738464aaba0c6">finish_parse</a> ()</td></tr>
<tr class="memdesc:a2351077d0a931ee3ba9738464aaba0c6"><td class="mdescLeft"> </td><td class="mdescRight">If object is still marked as "successful", save non-option arguments to extra_args_ list. Subclass ctor should call this after the <a class="el" href="classmysqlpp_1_1CommandLineBase.html#af8c430749d38637982a596e0e8efb670" title="Wrapper for getopt()">parse_next()</a> loop gets EOF. <br /></td></tr>
<tr class="separator:a2351077d0a931ee3ba9738464aaba0c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac7b0b1da54f84d332378a68f017d8cf1"><td class="memItemLeft" align="right" valign="top"><a id="ac7b0b1da54f84d332378a68f017d8cf1"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#ac7b0b1da54f84d332378a68f017d8cf1">option_argument</a> () const</td></tr>
<tr class="memdesc:ac7b0b1da54f84d332378a68f017d8cf1"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for getopt()'s optarg global. <br /></td></tr>
<tr class="separator:ac7b0b1da54f84d332378a68f017d8cf1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f361569f3197bea6a6c203dde6e151d"><td class="memItemLeft" align="right" valign="top"><a id="a0f361569f3197bea6a6c203dde6e151d"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a0f361569f3197bea6a6c203dde6e151d">option_index</a> () const</td></tr>
<tr class="memdesc:a0f361569f3197bea6a6c203dde6e151d"><td class="mdescLeft"> </td><td class="mdescRight">Accessor for getopt()'s optind global. <br /></td></tr>
<tr class="separator:a0f361569f3197bea6a6c203dde6e151d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59476f73810f50528f0c6cc681ab998c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a59476f73810f50528f0c6cc681ab998c">parse_error</a> (const char *message=0)</td></tr>
<tr class="memdesc:a59476f73810f50528f0c6cc681ab998c"><td class="mdescLeft"> </td><td class="mdescRight">Called by a subclass when encountering a command line parsing error. <a href="#a59476f73810f50528f0c6cc681ab998c">More...</a><br /></td></tr>
<tr class="separator:a59476f73810f50528f0c6cc681ab998c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af8c430749d38637982a596e0e8efb670"><td class="memItemLeft" align="right" valign="top"><a id="af8c430749d38637982a596e0e8efb670"></a>
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#af8c430749d38637982a596e0e8efb670">parse_next</a> () const</td></tr>
<tr class="memdesc:af8c430749d38637982a596e0e8efb670"><td class="mdescLeft"> </td><td class="mdescRight">Wrapper for getopt() <br /></td></tr>
<tr class="separator:af8c430749d38637982a596e0e8efb670"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5d620f5e364c55c813254aad693b08ec"><td class="memItemLeft" align="right" valign="top"><a id="a5d620f5e364c55c813254aad693b08ec"></a>
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#a5d620f5e364c55c813254aad693b08ec">print_usage</a> () const =0</td></tr>
<tr class="memdesc:a5d620f5e364c55c813254aad693b08ec"><td class="mdescLeft"> </td><td class="mdescRight">Show a message explaining the program's proper usage. <br /></td></tr>
<tr class="separator:a5d620f5e364c55c813254aad693b08ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae938c52719facf6b323d769178726d56"><td class="memItemLeft" align="right" valign="top"><a id="ae938c52719facf6b323d769178726d56"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#ae938c52719facf6b323d769178726d56">program_name</a> () const</td></tr>
<tr class="memdesc:ae938c52719facf6b323d769178726d56"><td class="mdescLeft"> </td><td class="mdescRight">Get the file name of the program's executable. <br /></td></tr>
<tr class="separator:ae938c52719facf6b323d769178726d56"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade5bf9dbcab332246ea2c4f8854071f1"><td class="memItemLeft" align="right" valign="top"><a id="ade5bf9dbcab332246ea2c4f8854071f1"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1CommandLineBase.html#ade5bf9dbcab332246ea2c4f8854071f1">successful</a> () const</td></tr>
<tr class="memdesc:ade5bf9dbcab332246ea2c4f8854071f1"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if nothing has gone wrong since calling the ctor. <br /></td></tr>
<tr class="separator:ade5bf9dbcab332246ea2c4f8854071f1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parses command line arguments and holds the results. </p>
<p>This class just contains common functionality and data structures; instantiable subclasses follow. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ae8de28354623bd1541425f512d46b23a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8de28354623bd1541425f512d46b23a">◆ </a></span>ArgumentList</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::vector<std::string> <a class="el" href="classmysqlpp_1_1CommandLineBase.html#ae8de28354623bd1541425f512d46b23a">mysqlpp::CommandLineBase::ArgumentList</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type for a list of arguments. </p>
<p>Public types </p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a36aff0ceccfb08be9b04717dc48ac706"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36aff0ceccfb08be9b04717dc48ac706">◆ </a></span>CommandLineBase()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mysqlpp::CommandLineBase::CommandLineBase </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char *const </td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>opts</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Hidden ctor to prevent instantiation. </p>
<p>Subclass interface </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa8efb9e02ee1ac9af845f726c293fc55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8efb9e02ee1ac9af845f726c293fc55">◆ </a></span>extra_args()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classmysqlpp_1_1CommandLineBase.html#ae8de28354623bd1541425f512d46b23a">ArgumentList</a>& mysqlpp::CommandLineBase::extra_args </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get reference to list of command line arguments past the last flag and its possible argument. </p>
<p>Public interface </p>
</div>
</div>
<a id="a59476f73810f50528f0c6cc681ab998c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59476f73810f50528f0c6cc681ab998c">◆ </a></span>parse_error()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void mysqlpp::CommandLineBase::parse_error </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>message</em> = <code>0</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by a subclass when encountering a command line parsing error. </p>
<p>Prints the passed message, calls subclass's <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a5d620f5e364c55c813254aad693b08ec" title="Show a message explaining the program's proper usage.">print_usage()</a>, and marks the object as no longer successful. </p>
<p class="reference">References <a class="el" href="classmysqlpp_1_1CommandLineBase.html#a5d620f5e364c55c813254aad693b08ec">print_usage()</a>.</p>
<p class="reference">Referenced by <a class="el" href="classmysqlpp_1_1examples_1_1CommandLine.html#a94a1168f204e8a945743b533393d0edf">mysqlpp::examples::CommandLine::CommandLine()</a>, and <a class="el" href="classmysqlpp_1_1ssqlsxlat_1_1CommandLine.html#a055b4f3a100607034f43159bc96d394d">mysqlpp::ssqlsxlat::CommandLine::CommandLine()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cmdline_8h_source.html">cmdline.h</a></li>
<li>cmdline.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:21 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|
