Česky
Kamil Dudka

Share Library (C++)

File detail

Name:DownloadclassShare_1_1ArgParser.html [Download]
Location: sharelib > api
Size:13.8 KB
Last modification:2022-09-09 13:06

Source code

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ShareLibrary: Share::ArgParser Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespaceShare.html">Share</a>::<a class="el" href="classShare_1_1ArgParser.html">ArgParser</a></div>
<h1>Share::ArgParser Class Reference<br>
<small>
[<a class="el" href="group__sharectl.html">sharectl utility</a>]</small>
</h1><!-- doxytag: class="Share::ArgParser" -->Parser for commnad-line arguments of sharectl utility.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sharectl_8h-source.html">sharectl.h</a>&gt;</code>
<p>
Collaboration diagram for Share::ArgParser:<p><center><img src="classShare_1_1ArgParser__coll__graph.png" border="0" usemap="#Share_1_1ArgParser__coll__map" alt="Collaboration graph"></center>
<map name="Share_1_1ArgParser__coll__map">
<area shape="rect" title="STL class." alt="" coords="57,83,151,109"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classShare_1_1ArgParser-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2">Action</a> { <br>
&nbsp;&nbsp;<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2e162fef37720444fef977200bf02eb9c">NONE</a> =  0, 
<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e229244f580d494fad10f0965676942f01">HELP</a>, 
<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e24b0bc4bda952a0ee3dd02223472ba5ba">CREATE</a>, 
<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e25448072b75a9bdfe2cb1352cc06eefcb">CREATE_AND_WAIT</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2247f671b29ab12f758df08b44cb084b3">NOTIFY_ATTACH</a>, 
<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2ca55162b62532a0275132a3b3ea0f2b2">NOTIFY_DETACH</a>, 
<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e28f78c15527a51b66a1f91d5bd685aefb">UNLINK</a>, 
<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e231f83a3e73f5e9e12423044f5dc69be6">FORCE_DESTORY</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2f83bc04f0e91884858d9d3fca2eaabf8">ALLOC</a>, 
<a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2c11895814cb8bac09998bc69aa476a29">FREE</a>
<br>
 }</td></tr>
 
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">commnad-line switches enumeration  <a href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgParser.html#a14cf01392c9efe67ad078163b80bb98">ArgParser</a> (int argc, char *argv[])  throw (ShareException)</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgParser.html#0ef3360f7695cb1b18e2510b4add0ba7">isNewSegment</a> ()</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgParser.html#acadcaf82fb2a3d2f81ddc9c049eb51d">name</a> ()</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgParser.html#e9bde6bad8d5d0cfd53e01816cb6bf5a">size</a> ()</td></tr>
 
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2">Action</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgParser.html#a2143c3c15f91599029f15518b34a1ca">action</a> ()</td></tr>
 
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Parser for commnad-line arguments of sharectl utility. 
<p>
 
<p>
Definition at line <a class="el" href="sharectl_8h-source.html#l00024">24</a> of file <a class="el" href="sharectl_8h-source.html">sharectl.h</a>.<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e2"></a><!-- doxytag: member="Share::ArgParser::Action" ref="59f1ac618c56b18fdd7abc656b1e81e2" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2">Share::ArgParser::Action</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
commnad-line switches enumeration 
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e2e162fef37720444fef977200bf02eb9c"></a><!-- doxytag: member="NONE" ref="59f1ac618c56b18fdd7abc656b1e81e2e162fef37720444fef977200bf02eb9c" args="" -->NONE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e229244f580d494fad10f0965676942f01"></a><!-- doxytag: member="HELP" ref="59f1ac618c56b18fdd7abc656b1e81e229244f580d494fad10f0965676942f01" args="" -->HELP</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e24b0bc4bda952a0ee3dd02223472ba5ba"></a><!-- doxytag: member="CREATE" ref="59f1ac618c56b18fdd7abc656b1e81e24b0bc4bda952a0ee3dd02223472ba5ba" args="" -->CREATE</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e25448072b75a9bdfe2cb1352cc06eefcb"></a><!-- doxytag: member="CREATE_AND_WAIT" ref="59f1ac618c56b18fdd7abc656b1e81e25448072b75a9bdfe2cb1352cc06eefcb" args="" -->CREATE_AND_WAIT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e2247f671b29ab12f758df08b44cb084b3"></a><!-- doxytag: member="NOTIFY_ATTACH" ref="59f1ac618c56b18fdd7abc656b1e81e2247f671b29ab12f758df08b44cb084b3" args="" -->NOTIFY_ATTACH</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e2ca55162b62532a0275132a3b3ea0f2b2"></a><!-- doxytag: member="NOTIFY_DETACH" ref="59f1ac618c56b18fdd7abc656b1e81e2ca55162b62532a0275132a3b3ea0f2b2" args="" -->NOTIFY_DETACH</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e28f78c15527a51b66a1f91d5bd685aefb"></a><!-- doxytag: member="UNLINK" ref="59f1ac618c56b18fdd7abc656b1e81e28f78c15527a51b66a1f91d5bd685aefb" args="" -->UNLINK</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e231f83a3e73f5e9e12423044f5dc69be6"></a><!-- doxytag: member="FORCE_DESTORY" ref="59f1ac618c56b18fdd7abc656b1e81e231f83a3e73f5e9e12423044f5dc69be6" args="" -->FORCE_DESTORY</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e2f83bc04f0e91884858d9d3fca2eaabf8"></a><!-- doxytag: member="ALLOC" ref="59f1ac618c56b18fdd7abc656b1e81e2f83bc04f0e91884858d9d3fca2eaabf8" args="" -->ALLOC</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="59f1ac618c56b18fdd7abc656b1e81e2c11895814cb8bac09998bc69aa476a29"></a><!-- doxytag: member="FREE" ref="59f1ac618c56b18fdd7abc656b1e81e2c11895814cb8bac09998bc69aa476a29" args="" -->FREE</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>
 
<p>
Definition at line <a class="el" href="sharectl_8h-source.html#l00029">29</a> of file <a class="el" href="sharectl_8h-source.html">sharectl.h</a>.
</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a14cf01392c9efe67ad078163b80bb98"></a><!-- doxytag: member="Share::ArgParser::ArgParser" ref="a14cf01392c9efe67ad078163b80bb98" args="(int argc, char *argv[])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Share::ArgParser::ArgParser           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>argc</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>argv</em>[]</td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%">  throw (<a class="el" href="classShare_1_1ShareException.html">ShareException</a>)</td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>argc</em>&nbsp;</td><td>Synonymous argument from main() function. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>argv</em>&nbsp;</td><td>Synonymous argument from main() function. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classShare_1_1ShareException.html" title="General exception carrying text message inside.">ShareException</a></em>&nbsp;</td><td>Library-specific exception derived from std::bad_alloc </td></tr>
  </table>
</dl>
 
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0ef3360f7695cb1b18e2510b4add0ba7"></a><!-- doxytag: member="Share::ArgParser::isNewSegment" ref="0ef3360f7695cb1b18e2510b4add0ba7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Share::ArgParser::isNewSegment           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return true if new segment should be created. </dd></dl>
 
</div>
</div><p>
<a class="anchor" name="acadcaf82fb2a3d2f81ddc9c049eb51d"></a><!-- doxytag: member="Share::ArgParser::name" ref="acadcaf82fb2a3d2f81ddc9c049eb51d" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* Share::ArgParser::name           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return segment name parsed from command-lnie. </dd></dl>
 
</div>
</div><p>
<a class="anchor" name="e9bde6bad8d5d0cfd53e01816cb6bf5a"></a><!-- doxytag: member="Share::ArgParser::size" ref="e9bde6bad8d5d0cfd53e01816cb6bf5a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t Share::ArgParser::size           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return size argument parsed from command-lnie. </dd></dl>
 
</div>
</div><p>
<a class="anchor" name="a2143c3c15f91599029f15518b34a1ca"></a><!-- doxytag: member="Share::ArgParser::action" ref="a2143c3c15f91599029f15518b34a1ca" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classShare_1_1ArgParser.html#59f1ac618c56b18fdd7abc656b1e81e2">Action</a> Share::ArgParser::action           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">
 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return action(switch) argument parsed from command-lnie. </dd></dl>
 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>sharectl/<a class="el" href="sharectl_8h-source.html">sharectl.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 26 17:43:03 2007 for ShareLibrary by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>