/usr/share/doc/libucommon-dev/a00148.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!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>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::shell::Option Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00142.html">shell</a>::<a class="el" href="a00148.html">Option</a>
</div>
</div>
<div class="contents">
<h1>ucc::shell::Option Class Reference</h1><!-- doxytag: class="ucc::shell::Option" --><!-- doxytag: inherits="ucc::OrderedObject" -->
<p>A base class used to create parsable shell options.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00204_source.html">shell.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::shell::Option:</div>
<div class="dynsection">
<div class="center"><img src="a00543.png" border="0" usemap="#ucc_1_1shell_1_1_option_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1shell_1_1_option_inherit__map" id="ucc_1_1shell_1_1_option_inherit__map">
<area shape="rect" id="node9" href="a00143.html" title="Character option for shell parsing." alt="" coords="716,5,855,35"/><area shape="rect" id="node11" href="a00145.html" title="Flag option for shell parsing." alt="" coords="719,59,852,88"/><area shape="rect" id="node13" href="a00147.html" title="Numeric option for shell parsing." alt="" coords="704,112,867,141"/><area shape="rect" id="node15" href="a00150.html" title="Text option for shell parsing." alt="" coords="712,165,859,195"/><area shape="rect" id="node2" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="332,85,476,115"/><area shape="rect" id="node4" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="148,85,281,115"/><area shape="rect" id="node6" href="a00093.html" title="A common base class for all managed objects." alt="" coords="5,85,99,115"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::shell::Option:</div>
<div class="dynsection">
<div class="center"><img src="a00544.png" border="0" usemap="#ucc_1_1shell_1_1_option_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1shell_1_1_option_coll__map" id="ucc_1_1shell_1_1_option_coll__map">
<area shape="rect" id="node2" href="a00100.html" title="A linked object base class for ordered objects." alt="" coords="5,187,149,216"/><area shape="rect" id="node9" href="a00099.html" title="An index container for maintaining an ordered list of objects." alt="" coords="93,299,232,328"/><area shape="rect" id="node4" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="11,96,144,125"/><area shape="rect" id="node6" href="a00093.html" title="A common base class for all managed objects." alt="" coords="31,5,124,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00148.html#a4ec60b6fa661cebf405f3653fa715cd2">assign</a> (const char *value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to send option into derived receiver. <a href="#a4ec60b6fa661cebf405f3653fa715cd2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00148.html#a6183c486a844501bd5cb9a74c1187455">Option</a> (char short_option=0, const char *long_option=NULL, const char *value_type=NULL, const char *help=NULL)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a shell parser option. <a href="#a6183c486a844501bd5cb9a74c1187455"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a423896e999d936e975937cb3504f1bb6"></a><!-- doxytag: member="ucc::shell::Option::first" ref="a423896e999d936e975937cb3504f1bb6" args="(void)" -->
static <a class="el" href="a00069.html">LinkedObject</a> * </td><td class="memItemRight" valign="bottom"><b>first</b> (void)</td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afe4b31878c8c8dfa3f9010e8ef263a6f"></a><!-- doxytag: member="ucc::shell::Option::help_string" ref="afe4b31878c8c8dfa3f9010e8ef263a6f" args="" -->
const char * </td><td class="memItemRight" valign="bottom"><b>help_string</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66304d05633723d84e7a3a34e7132c7a"></a><!-- doxytag: member="ucc::shell::Option::long_option" ref="a66304d05633723d84e7a3a34e7132c7a" args="" -->
const char * </td><td class="memItemRight" valign="bottom"><b>long_option</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abebb58339c1a980ad14651b7b97c7484"></a><!-- doxytag: member="ucc::shell::Option::short_option" ref="abebb58339c1a980ad14651b7b97c7484" args="" -->
char </td><td class="memItemRight" valign="bottom"><b>short_option</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b09e818b33258a5e5ed96a163b0afa3"></a><!-- doxytag: member="ucc::shell::Option::uses_option" ref="a0b09e818b33258a5e5ed96a163b0afa3" args="" -->
const char * </td><td class="memItemRight" valign="bottom"><b>uses_option</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A base class used to create parsable shell options. </p>
<p>The virtual is invoked when the shell option is detected. Both short and long forms of argument parsing are supported. An instance of a derived class is created to perform the argument parsing. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00204_source.html#l00279">279</a> of file <a class="el" href="a00204_source.html">shell.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6183c486a844501bd5cb9a74c1187455"></a><!-- doxytag: member="ucc::shell::Option::Option" ref="a6183c486a844501bd5cb9a74c1187455" args="(char short_option=0, const char *long_option=NULL, const char *value_type=NULL, const char *help=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ucc::shell::Option::Option </td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"> <em>short_option</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>long_option</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value_type</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>help</em> = <code>NULL</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a shell parser option. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>short_option</em> </td><td>for single character code. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>long_option</em> </td><td>for extended string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value_type</em> </td><td>if -x value or -long=yyy. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>help</em> </td><td>string, future use. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a4ec60b6fa661cebf405f3653fa715cd2"></a><!-- doxytag: member="ucc::shell::Option::assign" ref="a4ec60b6fa661cebf405f3653fa715cd2" args="(const char *value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* ucc::shell::Option::assign </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Used to send option into derived receiver. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>option that was received. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>NULL or error string to use. </dd></dl>
<p>Implemented in <a class="el" href="a00150.html#a91d895c0410961f7a4dd6521b0a4c48c">ucc::shell::stringopt</a>, <a class="el" href="a00143.html#a49aa2a13de8726b06d0afd57041ff169">ucc::shell::charopt</a>, and <a class="el" href="a00147.html#a7f619a6d4f9b27d66415f86a2155676a">ucc::shell::numericopt</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00204_source.html">shell.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:47 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|