aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a04162.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/doxygen/nel/a04162.html')
-rw-r--r--docs/doxygen/nel/a04162.html100
1 files changed, 100 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a04162.html b/docs/doxygen/nel/a04162.html
new file mode 100644
index 00000000..131d7b21
--- /dev/null
+++ b/docs/doxygen/nel/a04162.html
@@ -0,0 +1,100 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: command.h File Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>command.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
+Management of runtime command line processing<p>
+<dl compact><dt><b>Id</b></dt><dd><a class="el" href="a04162.html">command.h</a>,v 1.28 2004/01/15 17:27:03 lecroart Exp </dd></dl>
+
+<p>
+Definition in file <a class="el" href="a05585.html">command.h</a>.
+<p>
+<code>#include "<a class="el" href="a06590.html">nel/misc/types_nl.h</a>"</code><br>
+<code>#include &lt;string&gt;</code><br>
+<code>#include &lt;map&gt;</code><br>
+<code>#include &lt;vector&gt;</code><br>
+<code>#include &lt;istream&gt;</code><br>
+<code>#include "<a class="el" href="a06462.html">nel/misc/stream.h</a>"</code><br>
+<code>#include "<a class="el" href="a05598.html">nel/misc/config_file.h</a>"</code><br>
+<code>#include "<a class="el" href="a05944.html">nel/misc/log.h</a>"</code><br>
+
+<p>
+<a href="a05585.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Namespaces</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>namespace &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a05378.html">NLMISC</a></td></tr>
+
+<tr><td colspan=2><br><h2>Defines</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>#define&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a04162.html#a0">NLMISC_COMMAND</a>(__name, __help, __args)</td></tr>
+
+</table>
+<hr><h2>Define Documentation</h2>
+<a class="anchor" name="a0" doxytag="command.h::NLMISC_COMMAND" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> #define NLMISC_COMMAND</td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">__name, <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>__help, <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>__args&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+<b>Value:</b><div class="fragment"><pre><span class="keyword">struct </span>__name##Class: <span class="keyword">public</span> NLMISC::ICommand \
+{ \
+ <a class="code" href="a06968.html">__name</a>##Class() : NLMISC::ICommand(#<a class="code" href="a06968.html">__name</a>,__help,__args) { } \
+ <span class="keyword">virtual</span> <span class="keywordtype">bool</span> execute(<span class="keyword">const</span> std::vector&lt;std::string&gt; &amp;args, <a class="code" href="a02813.html">NLMISC::CLog</a> &amp;log, <span class="keywordtype">bool</span> quiet, <span class="keywordtype">bool</span> human); \
+}; \
+<a class="code" href="a06968.html">__name</a>##Class <a class="code" href="a06968.html">__name</a>##Instance; \
+<span class="keywordtype">bool</span> <a class="code" href="a06968.html">__name</a>##Class::execute(<span class="keyword">const</span> std::vector&lt;std::string&gt; &amp;args, <a class="code" href="a02813.html">NLMISC::CLog</a> &amp;log, <span class="keywordtype">bool</span> quiet, <span class="keywordtype">bool</span> human)
+</pre></div>Create a function that can be call in realtime.<p>
+Example: <pre class="fragment"><div> <span class="comment">// I want to create a function that compute the square of the parameter and display the result</span>
+ <a class="code" href="a04162.html#a0">NLMISC_COMMAND</a>(square,<span class="stringliteral">"display the square of the parameter"</span>,<span class="stringliteral">"&lt;value&gt;"</span>)
+ {
+ <span class="comment">// check args, if there s not the right number of parameter, return bad</span>
+ <span class="keywordflow">if</span>(args.size() != 1) <span class="keywordflow">return</span> <span class="keyword">false</span>;
+ <span class="comment">// get the value</span>
+ <a class="code" href="a04558.html#a11">uint32</a> val = atoi(args[0].c_str());
+ <span class="comment">// display the result on the displayer</span>
+ log.<a class="code" href="a02813.html#NLNET_1_1CNetLoga7">displayNL</a>(<span class="stringliteral">"The square of %d is %d"</span>, val, val*val);
+ <span class="keywordflow">return</span> <span class="keyword">true</span>;
+ }
+</div></pre><p>
+Please use the same casing than for the function (first letter in lower case and after each word first letter in upper case) ie: myFunction, step, orderByName, lookAtThis<p>
+<dl compact><dt><b>Author:</b></dt><dd>Vianney Lecroart <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+Definition at line <a class="el" href="a05585.html#l00078">78</a> of file <a class="el" href="a05585.html">command.h</a>. </td>
+ </tr>
+</table>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 06:42:20 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>