<!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: ucommon/shell.h File 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><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ucommon/shell.h File Reference</h1>
<p>Generic shell parsing and application services.
<a href="#_details">More...</a></p>
<code>#include <<a class="el" href="a00201_source.html">ucommon/string.h</a>></code><br/>
<code>#include <<a class="el" href="a00190_source.html">ucommon/memory.h</a>></code><br/>
<code>#include <<a class="el" href="a00180_source.html">ucommon/buffer.h</a>></code><br/>
<div class="dynheader">
Include dependency graph for shell.h:</div>
<div class="dynsection">
<div class="center"><img src="a00258.png" border="0" usemap="#ucommon_2shell_8h_map" alt=""/></div>
<map name="ucommon_2shell_8h_map" id="ucommon_2shell_8h">
<area shape="rect" id="node3" href="a00201.html" title="A common string class and character string support functions." alt="" coords="1652,304,1833,331"/><area shape="rect" id="node49" href="a00190.html" title="Private heaps, pools, and associations." alt="" coords="889,304,1071,331"/><area shape="rect" id="node57" href="a00180.html" title="Classes which use the buffer protocol to stream data." alt="" coords="1249,80,1431,107"/><area shape="rect" id="node5" href="a00194.html" title="Various miscellaneous platform specific headers and defines." alt="" coords="1167,603,1369,629"/><area shape="rect" id="node28" href="a00186.html" title="Generic templates for C++." alt="" coords="1635,528,1837,555"/><area shape="rect" id="node36" href="a00195.html" title="Abstract interfaces and support." alt="" coords="1312,379,1523,405"/><area shape="rect" id="node39" href="a00192.html" title="A common object base class with auto-pointer support." alt="" coords="1507,453,1688,480"/><area shape="rect" id="node53" href="a00188.html" title="Linked objects, lists, templates, and containers." alt="" coords="1107,379,1288,405"/><area shape="rect" id="node61" href="a00198.html" title="Common socket class and address manipulation." alt="" coords="1905,229,2087,256"/><area shape="rect" id="node97" href="a00185.html" title="Thread-aware file system manipulation class." alt="" coords="1259,155,1421,181"/><area shape="rect" id="node63" href="a00203.html" title="Realtime timers and timer queues." alt="" coords="660,304,841,331"/><area shape="rect" id="node101" href="a00202.html" title="Thread classes and sychronization objects." alt="" coords="521,229,703,256"/><area shape="rect" id="node104" href="a00177.html" title="Locking classes for member function automatic operations." alt="" coords="459,453,640,480"/></map>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dynsection">
<div class="center"><img src="a00259.png" border="0" usemap="#ucommon_2shell_8hdep_map" alt=""/></div>
<map name="ucommon_2shell_8hdep_map" id="ucommon_2shell_8hdep">
<area shape="rect" id="node3" href="a00204.html" title="Top level include file for the GNU uCommon C++ core library." alt="" coords="5,80,197,107"/><area shape="rect" id="node5" href="a00196.html" title="This library holds basic cryptographic functions and secure socket support for use..." alt="" coords="11,155,192,181"/></map>
</div>
<p><a href="a00197_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00129.html">ucommon::shell</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A utility class for generic shell operations. <a href="a00129.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00130.html">ucommon::shell::charopt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Character option for shell parsing. <a href="a00130.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00131.html">ucommon::shell::counteropt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Counter option for shell parsing. <a href="a00131.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00132.html">ucommon::shell::errormap</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A class to redefine error messages. <a href="a00132.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00133.html">ucommon::shell::flagopt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flag option for shell parsing. <a href="a00133.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00134.html">ucommon::shell::groupopt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Grouping option. <a href="a00134.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00135.html">ucommon::shell::iobuf</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process pipe with I/O buffering. <a href="a00135.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00136.html">ucommon::shell::numericopt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Numeric option for shell parsing. <a href="a00136.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00137.html">ucommon::shell::Option</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A base class used to create parsable shell options. <a href="a00137.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00138.html">ucommon::shell::pipeio</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A class to control a process that is piped. <a href="a00138.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00139.html">ucommon::shell::stringopt</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Text option for shell parsing. <a href="a00139.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html">ucommon</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Common namespace for all ucommon objects. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2a21f8ca68c25d9ea196f28883a115e3"></a><!-- doxytag: member="shell.h::INVALID_PID_VALUE" ref="a2a21f8ca68c25d9ea196f28883a115e3" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>INVALID_PID_VALUE</b> -1</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43325a3985e498a2de91a046edd496ae"></a><!-- doxytag: member="shell.h::shell_t" ref="a43325a3985e498a2de91a046edd496ae" args="" -->
typedef shell </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#a43325a3985e498a2de91a046edd496ae">ucommon::shell_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convenience type to manage and pass shell objects. <br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b231c230b9e4b568e158acadd044098"></a><!-- doxytag: member="shell.h::_STR" ref="a8b231c230b9e4b568e158acadd044098" args="(String &s)" -->
char * </td><td class="memItemRight" valign="bottom"><b>ucommon::_STR</b> (String &s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00208.html#afbf255b5ca1f4a456179441d8ade34d6">ucommon::_TEXT</a> (char *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abusive compilers. <a href="#afbf255b5ca1f4a456179441d8ade34d6"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Generic shell parsing and application services. </p>
<p>Definition in file <a class="el" href="a00197_source.html">shell.h</a>.</p>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:39:12 2011 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>
