<!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>SphinxBase: include/sphinxbase/cmd_ln.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SphinxBase <span id="projectnumber">0.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('cmd__ln_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>include/sphinxbase/cmd_ln.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Command-line and other configurationparsing and handling.
<a href="#_details">More...</a></p>
<div class="textblock"><code>#include <stdio.h></code><br/>
<code>#include <stdarg.h></code><br/>
<code>#include <sphinxbase/sphinxbase_export.h></code><br/>
<code>#include <sphinxbase/prim_type.h></code><br/>
</div>
<p><a href="cmd__ln_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structarg__s.html">arg_s</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a98a8fc7c21a0832cd44e3a6e10844b1e"></a><!-- doxytag: member="cmd_ln.h::ARG_STRINGIFY" ref="a98a8fc7c21a0832cd44e3a6e10844b1e" args="(s)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a98a8fc7c21a0832cd44e3a6e10844b1e">ARG_STRINGIFY</a>(s)   ARG_STRINGIFY1(s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Helper macro to stringify enums and other non-string values for default arguments. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae71d493fb63447033e8797f44fe7bb8d"></a><!-- doxytag: member="cmd_ln.h::ARG_STRINGIFY1" ref="ae71d493fb63447033e8797f44fe7bb8d" args="(s)" -->
#define </td><td class="memItemRight" valign="bottom"><b>ARG_STRINGIFY1</b>(s)   #s</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a159e691c95089689cf9a8f85a67830a6"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_boolean_r" ref="a159e691c95089689cf9a8f85a67830a6" args="(c, n)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a159e691c95089689cf9a8f85a67830a6">cmd_ln_boolean_r</a>(c, n)   (cmd_ln_int_r(c,n) != 0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a boolean value from a command-line object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4984b45985a6c5e2b231cf1f9b44fe4"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_boolean_r" ref="ad4984b45985a6c5e2b231cf1f9b44fe4" args="(c, n, b)" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ad4984b45985a6c5e2b231cf1f9b44fe4">cmd_ln_set_boolean_r</a>(c, n, b)   (cmd_ln_set_int_r(c,n,(b)!=0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a boolean value in a command-line object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a744cba615ad615a3bb0fc309e0bfb4c8"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_int32_r" ref="a744cba615ad615a3bb0fc309e0bfb4c8" args="(c, n)" -->
#define </td><td class="memItemRight" valign="bottom"><b>cmd_ln_int32_r</b>(c, n)   cmd_ln_int_r(c,n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aac984a3d645ca2293a711dc77e9441e6"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_float32_r" ref="aac984a3d645ca2293a711dc77e9441e6" args="(c, n)" -->
#define </td><td class="memItemRight" valign="bottom"><b>cmd_ln_float32_r</b>(c, n)   (float32)cmd_ln_float_r(c,n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1ef54ed340feb9aa6cc0a32d4fe041e"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_float64_r" ref="ad1ef54ed340feb9aa6cc0a32d4fe041e" args="(c, n)" -->
#define </td><td class="memItemRight" valign="bottom"><b>cmd_ln_float64_r</b>(c, n)   (float64)cmd_ln_float_r(c,n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e2c787a885bf6dd5f17c2ba94670bb1"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_int32_r" ref="a4e2c787a885bf6dd5f17c2ba94670bb1" args="(c, n, i)" -->
#define </td><td class="memItemRight" valign="bottom"><b>cmd_ln_set_int32_r</b>(c, n, i)   cmd_ln_set_int_r(c,n,i)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6d8f136f938b0b997dbe4b5d4cbd7f6"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_float32_r" ref="ae6d8f136f938b0b997dbe4b5d4cbd7f6" args="(c, n, f)" -->
#define </td><td class="memItemRight" valign="bottom"><b>cmd_ln_set_float32_r</b>(c, n, f)   cmd_ln_set_float_r(c,n,(double)f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fc588ffad9586cad2bf4649a6a26269"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_float64_r" ref="a2fc588ffad9586cad2bf4649a6a26269" args="(c, n, f)" -->
#define </td><td class="memItemRight" valign="bottom"><b>cmd_ln_set_float64_r</b>(c, n, f)   cmd_ln_set_float_r(c,n,(double)f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a35020ed4f3aae151fc654dea22dda028">cmd_ln_exists</a>(name)   cmd_ln_exists_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test the existence of a command-line argument in the global set of definitions. <a href="#a35020ed4f3aae151fc654dea22dda028"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#aa332e626631dfa1b7d93267d1b2384ba">cmd_ln_access</a>(name)   cmd_ln_access_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the previously parsed value for the given argument name. <a href="#aa332e626631dfa1b7d93267d1b2384ba"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ab5bd3d0b7f28a485411da21a5e3984b3">cmd_ln_str</a>(name)   cmd_ln_str_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a string from the global command line. <a href="#ab5bd3d0b7f28a485411da21a5e3984b3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a5061e894a4b65597c046a49b2c61f28b">cmd_ln_str_list</a>(name)   cmd_ln_str_list_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an array of strings in the global command line. <a href="#a5061e894a4b65597c046a49b2c61f28b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ad3c5abaaeda4f3fd4462a24d41db7589">cmd_ln_int32</a>(name)   (int32)cmd_ln_int_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a 32-bit integer from the global command line. <a href="#ad3c5abaaeda4f3fd4462a24d41db7589"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a95b9ea6b4ef4a6ae9718b7df5fffdde8">cmd_ln_float32</a>(name)   (float32)cmd_ln_float_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a 32-bit float from the global command line. <a href="#a95b9ea6b4ef4a6ae9718b7df5fffdde8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a3468b03e9089e4b9b4ccd5b9e4347a9c">cmd_ln_float64</a>(name)   (float64)cmd_ln_float_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a 64-bit float from the global command line. <a href="#a3468b03e9089e4b9b4ccd5b9e4347a9c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a168e6f2cf367471406614a70d2b42ae8">cmd_ln_boolean</a>(name)   cmd_ln_boolean_r(cmd_ln_get(), name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a boolean from the global command line. <a href="#a168e6f2cf367471406614a70d2b42ae8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#add9cb281562711418b6c795f5a6eb206">cmd_ln_set_str</a>(n, s)   cmd_ln_set_str_r(cmd_ln_get(),n,s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in the global command line. <a href="#add9cb281562711418b6c795f5a6eb206"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ab63087898153823d7a7041669d60cfae">cmd_ln_set_int32</a>(n, i)   cmd_ln_set_int_r(cmd_ln_get(),n,i)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a 32-bit integer value in the global command line. <a href="#ab63087898153823d7a7041669d60cfae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a2642012877117ba59dec59d5bfdbbed1">cmd_ln_set_float32</a>(n, f)   cmd_ln_set_float_r(cmd_ln_get(),n,f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a 32-bit float in the global command line. <a href="#a2642012877117ba59dec59d5bfdbbed1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ae9b20503ea67f45dc43312d13068a127">cmd_ln_set_float64</a>(n, f)   cmd_ln_set_float_r(cmd_ln_get(),n,f)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a 64-bit float in the global command line. <a href="#ae9b20503ea67f45dc43312d13068a127"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#aa6ee66099aca6807d03c70a9d3e5f2a3">cmd_ln_set_boolean</a>(n, b)   cmd_ln_set_boolean_r(cmd_ln_get(),n,b)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a boolean value in the global command line. <a href="#aa6ee66099aca6807d03c70a9d3e5f2a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#aac4bb58af379a71fad4e1adc7fb4d476">cmd_ln_print_help</a>(f, d)   cmd_ln_print_help_r(cmd_ln_get(),f,d)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a help message listing the valid argument names, and the associated attributes as given in defn. <a href="#aac4bb58af379a71fad4e1adc7fb4d476"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Values for arg_t::type</div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1f031eb9c89fa1bcae95b1c7532fb3d"></a><!-- doxytag: member="cmd_ln.h::ARG_REQUIRED" ref="ab1f031eb9c89fa1bcae95b1c7532fb3d" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ab1f031eb9c89fa1bcae95b1c7532fb3d">ARG_REQUIRED</a>   (1<<0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bit indicating a required argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a59c01ad9c48f29ac877ba14dc90808de"></a><!-- doxytag: member="cmd_ln.h::ARG_INTEGER" ref="a59c01ad9c48f29ac877ba14dc90808de" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a59c01ad9c48f29ac877ba14dc90808de">ARG_INTEGER</a>   (1<<1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Integer argument (optional). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8a280a53349bdd41d15edb4fa37972f"></a><!-- doxytag: member="cmd_ln.h::ARG_FLOATING" ref="ac8a280a53349bdd41d15edb4fa37972f" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ac8a280a53349bdd41d15edb4fa37972f">ARG_FLOATING</a>   (1<<2)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Floating point argument (optional). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4de5ed5fcf59a18b24bc9f6449cc9356"></a><!-- doxytag: member="cmd_ln.h::ARG_STRING" ref="a4de5ed5fcf59a18b24bc9f6449cc9356" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a4de5ed5fcf59a18b24bc9f6449cc9356">ARG_STRING</a>   (1<<3)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">String argument (optional). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac7d08ff59bb6905c3375162e75913e88"></a><!-- doxytag: member="cmd_ln.h::ARG_BOOLEAN" ref="ac7d08ff59bb6905c3375162e75913e88" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ac7d08ff59bb6905c3375162e75913e88">ARG_BOOLEAN</a>   (1<<4)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Boolean (true/false) argument (optional). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0698bd0586e83569c1c0d86f072cfe13"></a><!-- doxytag: member="cmd_ln.h::ARG_STRING_LIST" ref="a0698bd0586e83569c1c0d86f072cfe13" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a0698bd0586e83569c1c0d86f072cfe13">ARG_STRING_LIST</a>   (1<<5)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Boolean (true/false) argument (optional). <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8186f2660ad6b63be15019598a8dbb36"></a><!-- doxytag: member="cmd_ln.h::REQARG_INTEGER" ref="a8186f2660ad6b63be15019598a8dbb36" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a8186f2660ad6b63be15019598a8dbb36">REQARG_INTEGER</a>   (ARG_INTEGER | ARG_REQUIRED)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required integer argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a92ac706b4ccd544ebea6e0ceaccf3873"></a><!-- doxytag: member="cmd_ln.h::REQARG_FLOATING" ref="a92ac706b4ccd544ebea6e0ceaccf3873" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a92ac706b4ccd544ebea6e0ceaccf3873">REQARG_FLOATING</a>   (ARG_FLOATING | ARG_REQUIRED)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required floating point argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abaf37a6c677dde76bb1a211b818541bb"></a><!-- doxytag: member="cmd_ln.h::REQARG_STRING" ref="abaf37a6c677dde76bb1a211b818541bb" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#abaf37a6c677dde76bb1a211b818541bb">REQARG_STRING</a>   (ARG_STRING | ARG_REQUIRED)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required string argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac98546cfe85afea642248ae3063c2258"></a><!-- doxytag: member="cmd_ln.h::REQARG_BOOLEAN" ref="ac98546cfe85afea642248ae3063c2258" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ac98546cfe85afea642248ae3063c2258">REQARG_BOOLEAN</a>   (ARG_BOOLEAN | ARG_REQUIRED)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Required boolean argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a7ca1061dca6e8d4e7882bcefe1d15722">ARG_INT32</a>   ARG_INTEGER</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ad9b1952e4f1def9ee6a88791375b3901">ARG_FLOAT32</a>   ARG_FLOATING</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#aceb617c8572cf5ad6257b35e6d8919e7">ARG_FLOAT64</a>   ARG_FLOATING</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a49a6267bbca65099157aad7c2adc52b3">REQARG_INT32</a>   (ARG_INT32 | ARG_REQUIRED)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a46a5db6810b67a506c6074a76f003798">REQARG_FLOAT32</a>   (ARG_FLOAT32 | ARG_REQUIRED)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a501b468ee6e97644b9ca75e4bf9cd1a8">REQARG_FLOAT64</a>   (ARG_FLOAT64 | ARG_REQUIRED)</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7555950a1a9a65eee866083bd8ce4301"></a><!-- doxytag: member="cmd_ln.h::arg_t" ref="a7555950a1a9a65eee866083bd8ce4301" args="" -->
typedef struct <a class="el" href="structarg__s.html">arg_s</a> </td><td class="memItemRight" valign="bottom"><b>arg_t</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0c78d3d751be17a8c2d58ee81ae21182"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_t" ref="a0c78d3d751be17a8c2d58ee81ae21182" args="" -->
typedef struct <a class="el" href="structcmd__ln__s.html">cmd_ln_s</a> </td><td class="memItemRight" valign="bottom"><b>cmd_ln_t</b></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#afdba0ab4dfe8a3ad9d49a6732bd62c42">cmd_ln_init</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *inout_cmdln, <a class="el" href="structarg__t.html">arg_t</a> const *defn, int32 strict,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> from NULL-terminated list of arguments. <a href="#afdba0ab4dfe8a3ad9d49a6732bd62c42"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a975f5bf7b6f4fc95f426d1979281f73b">cmd_ln_retain</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retain ownership of a command-line argument set. <a href="#a975f5bf7b6f4fc95f426d1979281f73b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a26707fc85e87d8999e368a680e7873cd">cmd_ln_free_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Release a command-line argument set and all associated strings. <a href="#a26707fc85e87d8999e368a680e7873cd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#aa5a3a9e49198d8fd0dd3424fb880b6b6">cmd_ln_parse_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *inout_cmdln, <a class="el" href="structarg__t.html">arg_t</a> const *defn, int32 argc, char *argv[], int32 strict)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a list of strings into argumetns. <a href="#aa5a3a9e49198d8fd0dd3424fb880b6b6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a57f54649952a07b8bef888af4e416550">cmd_ln_parse_file_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *inout_cmdln, <a class="el" href="structarg__t.html">arg_t</a> const *defn, char const *filename, int32 strict)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an arguments file by deliminating on " \r\t\n" and putting each tokens into an argv[] for <a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7" title="Non-reentrant version of cmd_ln_parse().">cmd_ln_parse()</a>. <a href="#a57f54649952a07b8bef888af4e416550"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8d204103a24e39efefda608db8d81f7"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_access_r" ref="ac8d204103a24e39efefda608db8d81f7" args="(cmd_ln_t *cmdln, char const *name)" -->
SPHINXBASE_EXPORT <a class="el" href="unionanytype__s.html">anytype_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ac8d204103a24e39efefda608db8d81f7">cmd_ln_access_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access the generic type union for a command line argument. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#af0aa15288e06fc8271298e4fa7cdc91a">cmd_ln_str_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a string from a command-line object. <a href="#af0aa15288e06fc8271298e4fa7cdc91a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT char const ** </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a8ef7df4f5749b5517f3a655566104a10">cmd_ln_str_list_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an array of strings from a command-line object. <a href="#a8ef7df4f5749b5517f3a655566104a10"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT long </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a3bf86d597effc163148fddf14c0d117a">cmd_ln_int_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve an integer from a command-line object. <a href="#a3bf86d597effc163148fddf14c0d117a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT double </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a2deca68514704cafbb7ec594b8ff38fe">cmd_ln_float_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a floating-point number from a command-line object. <a href="#a2deca68514704cafbb7ec594b8ff38fe"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a3868b219fd3eaf64e902db38145c1c59">cmd_ln_set_str_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name, char const *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string in a command-line object. <a href="#a3868b219fd3eaf64e902db38145c1c59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#afd5eef797f4786d7a1ddf4a64018cc7d">cmd_ln_set_int_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name, long iv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an integer in a command-line object. <a href="#afd5eef797f4786d7a1ddf4a64018cc7d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a71c02d36c1db0c1d4e6349bd253d9b59">cmd_ln_set_float_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name, double fv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a floating-point number in a command-line object. <a href="#a71c02d36c1db0c1d4e6349bd253d9b59"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ab4ad5ae130e3c2c042590b41768635e3">cmd_ln_exists_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, char const *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Re-entrant version of <a class="el" href="cmd__ln_8h.html#a35020ed4f3aae151fc654dea22dda028" title="Test the existence of a command-line argument in the global set of definitions.">cmd_ln_exists()</a>. <a href="#ab4ad5ae130e3c2c042590b41768635e3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a103dabd597830caf65ec4ef3fdc71a1a">cmd_ln_print_help_r</a> (<a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> *cmdln, FILE *fp, const <a class="el" href="structarg__t.html">arg_t</a> *defn)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a help message listing the valid argument names, and the associated attributes as given in defn. <a href="#a103dabd597830caf65ec4ef3fdc71a1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7">cmd_ln_parse</a> (const <a class="el" href="structarg__t.html">arg_t</a> *defn, int32 argc, char *argv[], int32 strict)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Non-reentrant version of <a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7" title="Non-reentrant version of cmd_ln_parse().">cmd_ln_parse()</a>. <a href="#a42447819b47aab58ee53f4745244f7f7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT int32 </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#ab7970c08288fae94d211a4252381bc61">cmd_ln_parse_file</a> (const <a class="el" href="structarg__t.html">arg_t</a> *defn, char const *filename, int32 strict)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse an arguments file by deliminating on " \r\t\n" and putting each tokens into an argv[] for <a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7" title="Non-reentrant version of cmd_ln_parse().">cmd_ln_parse()</a>. <a href="#ab7970c08288fae94d211a4252381bc61"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a7b06faa9f83eb8a2b045f8cfb6b67d36">cmd_ln_appl_enter</a> (int argc, char *argv[], char const *default_argfn, const <a class="el" href="structarg__t.html">arg_t</a> *defn)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Old application initialization routine for Sphinx3 code. <a href="#a7b06faa9f83eb8a2b045f8cfb6b67d36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a97d5edba5ad53d97a159ac8ab9234de7">cmd_ln_appl_exit</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalization routine corresponding to <a class="el" href="cmd__ln_8h.html#a7b06faa9f83eb8a2b045f8cfb6b67d36" title="Old application initialization routine for Sphinx3 code.">cmd_ln_appl_enter()</a>. <a href="#a97d5edba5ad53d97a159ac8ab9234de7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a6e10003b5e86ec317c1b78c0655972af">cmd_ln_get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the global <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> object used by non-re-entrant functions. <a href="#a6e10003b5e86ec317c1b78c0655972af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">SPHINXBASE_EXPORT void </td><td class="memItemRight" valign="bottom"><a class="el" href="cmd__ln_8h.html#a439d3f832f92ae655f1028445aa91602">cmd_ln_free</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the global command line, if any exists. <a href="#a439d3f832f92ae655f1028445aa91602"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Command-line and other configurationparsing and handling. </p>
<p>Configuration parameters, optionally parsed from the command line. </p>
<p>Definition in file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="ad9b1952e4f1def9ee6a88791375b3901"></a><!-- doxytag: member="cmd_ln.h::ARG_FLOAT32" ref="ad9b1952e4f1def9ee6a88791375b3901" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARG_FLOAT32   ARG_FLOATING</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000002">Deprecated:</a></b></dt><dd>Use ARG_FLOATING instead.</dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00148">148</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="aceb617c8572cf5ad6257b35e6d8919e7"></a><!-- doxytag: member="cmd_ln.h::ARG_FLOAT64" ref="aceb617c8572cf5ad6257b35e6d8919e7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARG_FLOAT64   ARG_FLOATING</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd>Use ARG_FLOATING instead.</dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00152">152</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7ca1061dca6e8d4e7882bcefe1d15722"></a><!-- doxytag: member="cmd_ln.h::ARG_INT32" ref="a7ca1061dca6e8d4e7882bcefe1d15722" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ARG_INT32   ARG_INTEGER</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd>Use ARG_INTEGER instead.</dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00144">144</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa332e626631dfa1b7d93267d1b2384ba"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_access" ref="aa332e626631dfa1b7d93267d1b2384ba" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_access</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   cmd_ln_access_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a pointer to the previously parsed value for the given argument name. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000013">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#ac8d204103a24e39efefda608db8d81f7" title="Access the generic type union for a command line argument.">cmd_ln_access_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00481">481</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a168e6f2cf367471406614a70d2b42ae8"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_boolean" ref="a168e6f2cf367471406614a70d2b42ae8" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_boolean</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   cmd_ln_boolean_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a boolean from the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000019">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a159e691c95089689cf9a8f85a67830a6" title="Retrieve a boolean value from a command-line object.">cmd_ln_boolean_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00526">526</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a35020ed4f3aae151fc654dea22dda028"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_exists" ref="a35020ed4f3aae151fc654dea22dda028" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_exists</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   cmd_ln_exists_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test the existence of a command-line argument in the global set of definitions. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000012">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#ab4ad5ae130e3c2c042590b41768635e3" title="Re-entrant version of cmd_ln_exists().">cmd_ln_exists_r()</a>.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the command line argument exists (i.e. it was one of the arguments defined in the call to <a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7" title="Non-reentrant version of cmd_ln_parse().">cmd_ln_parse()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00473">473</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a95b9ea6b4ef4a6ae9718b7df5fffdde8"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_float32" ref="a95b9ea6b4ef4a6ae9718b7df5fffdde8" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_float32</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   (float32)cmd_ln_float_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a 32-bit float from the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000017">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a2deca68514704cafbb7ec594b8ff38fe" title="Retrieve a floating-point number from a command-line object.">cmd_ln_float_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00512">512</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3468b03e9089e4b9b4ccd5b9e4347a9c"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_float64" ref="a3468b03e9089e4b9b4ccd5b9e4347a9c" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_float64</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   (float64)cmd_ln_float_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a 64-bit float from the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000018">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a2deca68514704cafbb7ec594b8ff38fe" title="Retrieve a floating-point number from a command-line object.">cmd_ln_float_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00519">519</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad3c5abaaeda4f3fd4462a24d41db7589"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_int32" ref="ad3c5abaaeda4f3fd4462a24d41db7589" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_int32</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   (int32)cmd_ln_int_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a 32-bit integer from the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000016">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a3bf86d597effc163148fddf14c0d117a" title="Retrieve an integer from a command-line object.">cmd_ln_int_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00505">505</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="aac4bb58af379a71fad4e1adc7fb4d476"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_print_help" ref="aac4bb58af379a71fad4e1adc7fb4d476" args="(f, d)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_print_help</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">f, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">d </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   cmd_ln_print_help_r(cmd_ln_get(),f,d)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print a help message listing the valid argument names, and the associated attributes as given in defn. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000025">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a103dabd597830caf65ec4ef3fdc71a1a" title="Print a help message listing the valid argument names, and the associated attributes as given in defn...">cmd_ln_print_help_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00571">571</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00494">cmd_ln_appl_enter()</a>.</p>
</div>
</div>
<a class="anchor" id="aa6ee66099aca6807d03c70a9d3e5f2a3"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_boolean" ref="aa6ee66099aca6807d03c70a9d3e5f2a3" args="(n, b)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_set_boolean</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">b </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   cmd_ln_set_boolean_r(cmd_ln_get(),n,b)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a boolean value in the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000024">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#ad4984b45985a6c5e2b231cf1f9b44fe4" title="Set a boolean value in a command-line object.">cmd_ln_set_boolean_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00562">562</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2642012877117ba59dec59d5bfdbbed1"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_float32" ref="a2642012877117ba59dec59d5bfdbbed1" args="(n, f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_set_float32</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">f </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   cmd_ln_set_float_r(cmd_ln_get(),n,f)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a 32-bit float in the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000022">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a71c02d36c1db0c1d4e6349bd253d9b59" title="Set a floating-point number in a command-line object.">cmd_ln_set_float_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00548">548</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae9b20503ea67f45dc43312d13068a127"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_float64" ref="ae9b20503ea67f45dc43312d13068a127" args="(n, f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_set_float64</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">f </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   cmd_ln_set_float_r(cmd_ln_get(),n,f)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a 64-bit float in the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000023">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a71c02d36c1db0c1d4e6349bd253d9b59" title="Set a floating-point number in a command-line object.">cmd_ln_set_float_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00555">555</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab63087898153823d7a7041669d60cfae"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_int32" ref="ab63087898153823d7a7041669d60cfae" args="(n, i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_set_int32</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">i </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   cmd_ln_set_int_r(cmd_ln_get(),n,i)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a 32-bit integer value in the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000021">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#afd5eef797f4786d7a1ddf4a64018cc7d" title="Set an integer in a command-line object.">cmd_ln_set_int_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00541">541</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="add9cb281562711418b6c795f5a6eb206"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_str" ref="add9cb281562711418b6c795f5a6eb206" args="(n, s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_set_str</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">n, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">s </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>   cmd_ln_set_str_r(cmd_ln_get(),n,s)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a string in the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000020">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a3868b219fd3eaf64e902db38145c1c59" title="Set a string in a command-line object.">cmd_ln_set_str_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00534">534</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="ab5bd3d0b7f28a485411da21a5e3984b3"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_str" ref="ab5bd3d0b7f28a485411da21a5e3984b3" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_str</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   cmd_ln_str_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a string from the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000014">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#af0aa15288e06fc8271298e4fa7cdc91a" title="Retrieve a string from a command-line object.">cmd_ln_str_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00489">489</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5061e894a4b65597c046a49b2c61f28b"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_str_list" ref="a5061e894a4b65597c046a49b2c61f28b" args="(name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define cmd_ln_str_list</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">name</td><td>)</td>
<td>   cmd_ln_str_list_r(cmd_ln_get(), name)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve an array of strings in the global command line. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000015">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a8ef7df4f5749b5517f3a655566104a10" title="Retrieve an array of strings from a command-line object.">cmd_ln_str_list_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00497">497</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a46a5db6810b67a506c6074a76f003798"></a><!-- doxytag: member="cmd_ln.h::REQARG_FLOAT32" ref="a46a5db6810b67a506c6074a76f003798" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define REQARG_FLOAT32   (ARG_FLOAT32 | ARG_REQUIRED)</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000005">Deprecated:</a></b></dt><dd>Use REQARG_FLOATING instead.</dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00160">160</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a501b468ee6e97644b9ca75e4bf9cd1a8"></a><!-- doxytag: member="cmd_ln.h::REQARG_FLOAT64" ref="a501b468ee6e97644b9ca75e4bf9cd1a8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define REQARG_FLOAT64   (ARG_FLOAT64 | ARG_REQUIRED)</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000006">Deprecated:</a></b></dt><dd>Use REQARG_FLOATING instead.</dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00164">164</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<a class="anchor" id="a49a6267bbca65099157aad7c2adc52b3"></a><!-- doxytag: member="cmd_ln.h::REQARG_INT32" ref="a49a6267bbca65099157aad7c2adc52b3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define REQARG_INT32   (ARG_INT32 | ARG_REQUIRED)</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>Use REQARG_INTEGER instead.</dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8h_source.html#l00156">156</a> of file <a class="el" href="cmd__ln_8h_source.html">cmd_ln.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="a7b06faa9f83eb8a2b045f8cfb6b67d36"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_appl_enter" ref="a7b06faa9f83eb8a2b045f8cfb6b67d36" args="(int argc, char *argv[], char const *default_argfn, const arg_t *defn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void cmd_ln_appl_enter </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 * </td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>default_argfn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structarg__t.html">arg_t</a> * </td>
<td class="paramname"><em>defn</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Old application initialization routine for Sphinx3 code. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000009">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">argc</td><td>In: Number of actual arguments </td></tr>
<tr><td class="paramname">argv</td><td>In: Number of actual arguments </td></tr>
<tr><td class="paramname">default_argfn</td><td>In: default argument file name </td></tr>
<tr><td class="paramname">defn</td><td>Command-line argument definition </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00494">494</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00494">cmd_ln_appl_enter()</a>, <a class="el" href="cmd__ln_8c_source.html#l00747">cmd_ln_parse()</a>, <a class="el" href="cmd__ln_8c_source.html#l00895">cmd_ln_parse_file()</a>, <a class="el" href="cmd__ln_8h_source.html#l00571">cmd_ln_print_help</a>, <a class="el" href="err_8h_source.html#l00147">E_INFO</a>, and <a class="el" href="err_8h_source.html#l00153">E_INFOCONT</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00494">cmd_ln_appl_enter()</a>.</p>
</div>
</div>
<a class="anchor" id="a97d5edba5ad53d97a159ac8ab9234de7"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_appl_exit" ref="a97d5edba5ad53d97a159ac8ab9234de7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void cmd_ln_appl_exit </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Finalization routine corresponding to <a class="el" href="cmd__ln_8h.html#a7b06faa9f83eb8a2b045f8cfb6b67d36" title="Old application initialization routine for Sphinx3 code.">cmd_ln_appl_enter()</a>. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000010">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00544">544</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00544">cmd_ln_appl_exit()</a>, and <a class="el" href="cmd__ln_8c_source.html#l01064">cmd_ln_free()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00544">cmd_ln_appl_exit()</a>.</p>
</div>
</div>
<a class="anchor" id="ab4ad5ae130e3c2c042590b41768635e3"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_exists_r" ref="ab4ad5ae130e3c2c042590b41768635e3" args="(cmd_ln_t *cmdln, char const *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int cmd_ln_exists_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Re-entrant version of <a class="el" href="cmd__ln_8h.html#a35020ed4f3aae151fc654dea22dda028" title="Test the existence of a command-line argument in the global set of definitions.">cmd_ln_exists()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>True if the command line argument exists (i.e. it was one of the arguments defined in the call to <a class="el" href="cmd__ln_8h.html#aa5a3a9e49198d8fd0dd3424fb880b6b6" title="Parse a list of strings into argumetns.">cmd_ln_parse_r()</a>. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00921">921</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00921">cmd_ln_exists_r()</a>, and <a class="el" href="hash__table_8c_source.html#l00309">hash_table_lookup()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00921">cmd_ln_exists_r()</a>, and <a class="el" href="ngram__model_8c_source.html#l00121">ngram_model_read()</a>.</p>
</div>
</div>
<a class="anchor" id="a2deca68514704cafbb7ec594b8ff38fe"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_float_r" ref="a2deca68514704cafbb7ec594b8ff38fe" args="(cmd_ln_t *cmdln, char const *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT double cmd_ln_float_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a floating-point number from a command-line object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdln</td><td>Command-line object. </td></tr>
<tr><td class="paramname">name</td><td>the command-line flag to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the float value associated with <code>name</code>, or 0.0 if <code>name</code> does not exist. You must use <a class="el" href="cmd__ln_8h.html#ab4ad5ae130e3c2c042590b41768635e3" title="Re-entrant version of cmd_ln_exists().">cmd_ln_exists_r()</a> to distinguish between cases where a value is legitimately zero and where the corresponding flag is unknown. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00971">971</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00930">cmd_ln_access_r()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00971">cmd_ln_float_r()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00971">cmd_ln_float_r()</a>.</p>
</div>
</div>
<a class="anchor" id="a439d3f832f92ae655f1028445aa91602"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_free" ref="a439d3f832f92ae655f1028445aa91602" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void cmd_ln_free </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free the global command line, if any exists. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000026">Deprecated:</a></b></dt><dd>Use the re-entrant API instead. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l01064">1064</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l01064">cmd_ln_free()</a>, and <a class="el" href="cmd__ln_8c_source.html#l01028">cmd_ln_free_r()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00544">cmd_ln_appl_exit()</a>, and <a class="el" href="cmd__ln_8c_source.html#l01064">cmd_ln_free()</a>.</p>
</div>
</div>
<a class="anchor" id="a26707fc85e87d8999e368a680e7873cd"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_free_r" ref="a26707fc85e87d8999e368a680e7873cd" args="(cmd_ln_t *cmdln)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int cmd_ln_free_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Release a command-line argument set and all associated strings. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>new reference count (0 if freed completely) </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l01028">1028</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="ckd__alloc_8c_source.html#l00241">ckd_free()</a>, <a class="el" href="cmd__ln_8c_source.html#l01028">cmd_ln_free_r()</a>, <a class="el" href="glist_8c_source.html#l00133">glist_free()</a>, <a class="el" href="glist_8h_source.html#l00109">gnode_ptr</a>, <a class="el" href="hash__table_8c_source.html#l00694">hash_table_free()</a>, <a class="el" href="hash__table_8c_source.html#l00622">hash_table_tolist()</a>, and <a class="el" href="hash__table_8h_source.html#l00155">hash_entry_s::val</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l01064">cmd_ln_free()</a>, <a class="el" href="cmd__ln_8c_source.html#l01028">cmd_ln_free_r()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00551">cmd_ln_parse_r()</a>.</p>
</div>
</div>
<a class="anchor" id="a6e10003b5e86ec317c1b78c0655972af"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_get" ref="a6e10003b5e86ec317c1b78c0655972af" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a>* cmd_ln_get </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve the global <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> object used by non-re-entrant functions. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000011">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API. </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>global <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> object. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00488">488</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00488">cmd_ln_get()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00488">cmd_ln_get()</a>.</p>
</div>
</div>
<a class="anchor" id="afdba0ab4dfe8a3ad9d49a6732bd62c42"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_init" ref="afdba0ab4dfe8a3ad9d49a6732bd62c42" args="(cmd_ln_t *inout_cmdln, arg_t const *defn, int32 strict,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a>* cmd_ln_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>inout_cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structarg__t.html">arg_t</a> const * </td>
<td class="paramname"><em>defn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>strict</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> from NULL-terminated list of arguments. </p>
<p>This function creates a <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> from a NULL-terminated list of argument strings. For example, to create the equivalent of passing "-hmm foodir -dsratio 2 -lm bar.lm" on the command-line:</p>
<p>config = cmd_ln_init(NULL, defs, TRUE, "-hmm", "foodir", "-dsratio", "2", "-lm", "bar.lm", NULL);</p>
<p>Note that for simplicity, <b>all</b> arguments are passed as strings, regardless of the actual underlying type.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">inout_cmdln</td><td>Previous command-line to update, or NULL to create a new one. </td></tr>
<tr><td class="paramname">defn</td><td>Array of argument name definitions, or NULL to allow any arguments. </td></tr>
<tr><td class="paramname">strict</td><td>Whether to fail on duplicate or unknown arguments. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A cmd_ln_t* containing the results of command line parsing, or NULL on failure. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00710">710</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, <a class="el" href="ckd__alloc_8h_source.html#l00264">ckd_salloc</a>, <a class="el" href="cmd__ln_8c_source.html#l00710">cmd_ln_init()</a>, and <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00710">cmd_ln_init()</a>.</p>
</div>
</div>
<a class="anchor" id="a3bf86d597effc163148fddf14c0d117a"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_int_r" ref="a3bf86d597effc163148fddf14c0d117a" args="(cmd_ln_t *cmdln, char const *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT long cmd_ln_int_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve an integer from a command-line object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdln</td><td>Command-line object. </td></tr>
<tr><td class="paramname">name</td><td>the command-line flag to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the integer value associated with <code>name</code>, or 0 if <code>name</code> does not exist. You must use <a class="el" href="cmd__ln_8h.html#ab4ad5ae130e3c2c042590b41768635e3" title="Re-entrant version of cmd_ln_exists().">cmd_ln_exists_r()</a> to distinguish between cases where a value is legitimately zero and where the corresponding flag is unknown. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00961">961</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00930">cmd_ln_access_r()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00961">cmd_ln_int_r()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00961">cmd_ln_int_r()</a>.</p>
</div>
</div>
<a class="anchor" id="a42447819b47aab58ee53f4745244f7f7"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_parse" ref="a42447819b47aab58ee53f4745244f7f7" args="(const arg_t *defn, int32 argc, char *argv[], int32 strict)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 cmd_ln_parse </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structarg__t.html">arg_t</a> * </td>
<td class="paramname"><em>defn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>strict</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Non-reentrant version of <a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7" title="Non-reentrant version of cmd_ln_parse().">cmd_ln_parse()</a>. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000007">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#aa5a3a9e49198d8fd0dd3424fb880b6b6" title="Parse a list of strings into argumetns.">cmd_ln_parse_r()</a>. </dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, <0 if error. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">defn</td><td>In: Array of argument name definitions </td></tr>
<tr><td class="paramname">argc</td><td>In: Number of actual arguments </td></tr>
<tr><td class="paramname">argv</td><td>In: Actual arguments </td></tr>
<tr><td class="paramname">strict</td><td>In: Fail on duplicate or unknown arguments, or no arguments? </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00747">747</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00747">cmd_ln_parse()</a>, <a class="el" href="cmd__ln_8c_source.html#l00551">cmd_ln_parse_r()</a>, and <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00494">cmd_ln_appl_enter()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00747">cmd_ln_parse()</a>.</p>
</div>
</div>
<a class="anchor" id="ab7970c08288fae94d211a4252381bc61"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_parse_file" ref="ab7970c08288fae94d211a4252381bc61" args="(const arg_t *defn, char const *filename, int32 strict)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT int32 cmd_ln_parse_file </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structarg__t.html">arg_t</a> * </td>
<td class="paramname"><em>defn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>strict</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse an arguments file by deliminating on " \r\t\n" and putting each tokens into an argv[] for <a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7" title="Non-reentrant version of cmd_ln_parse().">cmd_ln_parse()</a>. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000008">Deprecated:</a></b></dt><dd>This is deprecated in favor of the re-entrant API function <a class="el" href="cmd__ln_8h.html#a57f54649952a07b8bef888af4e416550" title="Parse an arguments file by deliminating on " \r\t\n" and putting each tokens into an argv[]...">cmd_ln_parse_file_r()</a>.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if successful, <0 on error. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">defn</td><td>In: Array of argument name definitions </td></tr>
<tr><td class="paramname">filename</td><td>In: A file that contains all the arguments </td></tr>
<tr><td class="paramname">strict</td><td>In: Fail on duplicate or unknown arguments, or no arguments? </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00895">895</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00895">cmd_ln_parse_file()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00765">cmd_ln_parse_file_r()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00494">cmd_ln_appl_enter()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00895">cmd_ln_parse_file()</a>.</p>
</div>
</div>
<a class="anchor" id="a57f54649952a07b8bef888af4e416550"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_parse_file_r" ref="a57f54649952a07b8bef888af4e416550" args="(cmd_ln_t *inout_cmdln, arg_t const *defn, char const *filename, int32 strict)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a>* cmd_ln_parse_file_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>inout_cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structarg__t.html">arg_t</a> const * </td>
<td class="paramname"><em>defn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>strict</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse an arguments file by deliminating on " \r\t\n" and putting each tokens into an argv[] for <a class="el" href="cmd__ln_8h.html#a42447819b47aab58ee53f4745244f7f7" title="Non-reentrant version of cmd_ln_parse().">cmd_ln_parse()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> containing the results of command line parsing, or NULL on failure. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">inout_cmdln</td><td>In/Out: Previous command-line to update, or NULL to create a new one. </td></tr>
<tr><td class="paramname">defn</td><td>In: Array of argument name definitions </td></tr>
<tr><td class="paramname">filename</td><td>In: A file that contains all the arguments </td></tr>
<tr><td class="paramname">strict</td><td>In: Fail on duplicate or unknown arguments, or no arguments? </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00765">765</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, <a class="el" href="ckd__alloc_8c_source.html#l00241">ckd_free()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00258">ckd_realloc</a>, <a class="el" href="ckd__alloc_8h_source.html#l00264">ckd_salloc</a>, <a class="el" href="cmd__ln_8c_source.html#l00765">cmd_ln_parse_file_r()</a>, <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>, and <a class="el" href="err_8h_source.html#l00164">E_WARN</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00895">cmd_ln_parse_file()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00765">cmd_ln_parse_file_r()</a>.</p>
</div>
</div>
<a class="anchor" id="aa5a3a9e49198d8fd0dd3424fb880b6b6"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_parse_r" ref="aa5a3a9e49198d8fd0dd3424fb880b6b6" args="(cmd_ln_t *inout_cmdln, arg_t const *defn, int32 argc, char *argv[], int32 strict)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a>* cmd_ln_parse_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>inout_cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structarg__t.html">arg_t</a> const * </td>
<td class="paramname"><em>defn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>argv</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32 </td>
<td class="paramname"><em>strict</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Parse a list of strings into argumetns. </p>
<p>Parse the given list of arguments (name-value pairs) according to the given definitions. Argument values can be retrieved in future using <a class="el" href="cmd__ln_8h.html#aa332e626631dfa1b7d93267d1b2384ba" title="Return a pointer to the previously parsed value for the given argument name.">cmd_ln_access()</a>. argv[0] is assumed to be the program name and skipped. Any unknown argument name causes a fatal error. The routine also prints the prevailing argument values (to stderr) after parsing.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>It is currently assumed that the strings in argv are allocated statically, or at least that they will be valid as long as the <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> returned from this function. Unpredictable behaviour will result if they are freed or otherwise become invalidated.</dd></dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A <a class="el" href="structcmd__ln__t.html" title="Opaque structure used to hold the results of command-line parsing.">cmd_ln_t</a> containing the results of command line parsing, or NULL on failure. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">inout_cmdln</td><td>In/Out: Previous command-line to update, or NULL to create a new one. </td></tr>
<tr><td class="paramname">defn</td><td>In: Array of argument name definitions </td></tr>
<tr><td class="paramname">argc</td><td>In: Number of actual arguments </td></tr>
<tr><td class="paramname">argv</td><td>In: Actual arguments </td></tr>
<tr><td class="paramname">strict</td><td>In: Fail on duplicate or unknown arguments, or no arguments? </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00551">551</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8h_source.html#l00102">ARG_REQUIRED</a>, <a class="el" href="cmd__ln_8h_source.html#l00114">ARG_STRING</a>, <a class="el" href="ckd__alloc_8h_source.html#l00248">ckd_calloc</a>, <a class="el" href="cmd__ln_8c_source.html#l01028">cmd_ln_free_r()</a>, <a class="el" href="cmd__ln_8c_source.html#l00551">cmd_ln_parse_r()</a>, <a class="el" href="cmd__ln_8c_source.html#l00911">cmd_ln_print_help_r()</a>, <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>, <a class="el" href="err_8h_source.html#l00147">E_INFO</a>, <a class="el" href="err_8h_source.html#l00153">E_INFOCONT</a>, <a class="el" href="err_8c_source.html#l00157">err_get_logfp()</a>, <a class="el" href="hash__table_8c_source.html#l00508">hash_table_enter()</a>, <a class="el" href="hash__table_8c_source.html#l00694">hash_table_free()</a>, <a class="el" href="hash__table_8c_source.html#l00309">hash_table_lookup()</a>, <a class="el" href="hash__table_8c_source.html#l00158">hash_table_new()</a>, and <a class="el" href="hash__table_8c_source.html#l00519">hash_table_replace()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00747">cmd_ln_parse()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00551">cmd_ln_parse_r()</a>.</p>
</div>
</div>
<a class="anchor" id="a103dabd597830caf65ec4ef3fdc71a1a"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_print_help_r" ref="a103dabd597830caf65ec4ef3fdc71a1a" args="(cmd_ln_t *cmdln, FILE *fp, const arg_t *defn)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void cmd_ln_print_help_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structarg__t.html">arg_t</a> * </td>
<td class="paramname"><em>defn</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print a help message listing the valid argument names, and the associated attributes as given in defn. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>In: File to which to print </td></tr>
<tr><td class="paramname">defn</td><td>In: Array of argument name definitions </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00911">911</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00911">cmd_ln_print_help_r()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00551">cmd_ln_parse_r()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00911">cmd_ln_print_help_r()</a>.</p>
</div>
</div>
<a class="anchor" id="a975f5bf7b6f4fc95f426d1979281f73b"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_retain" ref="a975f5bf7b6f4fc95f426d1979281f73b" args="(cmd_ln_t *cmdln)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT <a class="el" href="structcmd__ln__t.html">cmd_ln_t</a>* cmd_ln_retain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retain ownership of a command-line argument set. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to retained command-line argument set. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l01021">1021</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l01021">cmd_ln_retain()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l01021">cmd_ln_retain()</a>.</p>
</div>
</div>
<a class="anchor" id="a71c02d36c1db0c1d4e6349bd253d9b59"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_float_r" ref="a71c02d36c1db0c1d4e6349bd253d9b59" args="(cmd_ln_t *cmdln, char const *name, double fv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void cmd_ln_set_float_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>fv</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a floating-point number in a command-line object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdln</td><td>Command-line object. </td></tr>
<tr><td class="paramname">name</td><td>The command-line flag to set. </td></tr>
<tr><td class="paramname">fv</td><td>Integer value to set. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l01009">1009</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00930">cmd_ln_access_r()</a>, <a class="el" href="cmd__ln_8c_source.html#l01009">cmd_ln_set_float_r()</a>, and <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l01009">cmd_ln_set_float_r()</a>.</p>
</div>
</div>
<a class="anchor" id="afd5eef797f4786d7a1ddf4a64018cc7d"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_int_r" ref="afd5eef797f4786d7a1ddf4a64018cc7d" args="(cmd_ln_t *cmdln, char const *name, long iv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void cmd_ln_set_int_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>iv</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set an integer in a command-line object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdln</td><td>Command-line object. </td></tr>
<tr><td class="paramname">name</td><td>The command-line flag to set. </td></tr>
<tr><td class="paramname">iv</td><td>Integer value to set. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00997">997</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00930">cmd_ln_access_r()</a>, <a class="el" href="cmd__ln_8c_source.html#l00997">cmd_ln_set_int_r()</a>, and <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00997">cmd_ln_set_int_r()</a>.</p>
</div>
</div>
<a class="anchor" id="a3868b219fd3eaf64e902db38145c1c59"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_set_str_r" ref="a3868b219fd3eaf64e902db38145c1c59" args="(cmd_ln_t *cmdln, char const *name, char const *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT void cmd_ln_set_str_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>str</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a string in a command-line object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdln</td><td>Command-line object. </td></tr>
<tr><td class="paramname">name</td><td>The command-line flag to set. </td></tr>
<tr><td class="paramname">str</td><td>String value to set. The command-line object does not retain ownership of this pointer. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00981">981</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="ckd__alloc_8c_source.html#l00241">ckd_free()</a>, <a class="el" href="ckd__alloc_8h_source.html#l00264">ckd_salloc</a>, <a class="el" href="cmd__ln_8c_source.html#l00930">cmd_ln_access_r()</a>, <a class="el" href="cmd__ln_8c_source.html#l00981">cmd_ln_set_str_r()</a>, and <a class="el" href="err_8h_source.html#l00169">E_ERROR</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00981">cmd_ln_set_str_r()</a>.</p>
</div>
</div>
<a class="anchor" id="a8ef7df4f5749b5517f3a655566104a10"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_str_list_r" ref="a8ef7df4f5749b5517f3a655566104a10" args="(cmd_ln_t *cmdln, char const *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT char const** cmd_ln_str_list_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve an array of strings from a command-line object. </p>
<p>The command-line object retains ownership of this array, so you should not attempt to free it manually.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdln</td><td>Command-line object. </td></tr>
<tr><td class="paramname">name</td><td>the command-line flag to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the array of strings associated with <code>name</code>, or NULL if <code>name</code> does not exist. You must use <a class="el" href="cmd__ln_8h.html#ab4ad5ae130e3c2c042590b41768635e3" title="Re-entrant version of cmd_ln_exists().">cmd_ln_exists_r()</a> to distinguish between cases where a value is legitimately NULL and where the corresponding flag is unknown. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00951">951</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00930">cmd_ln_access_r()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00951">cmd_ln_str_list_r()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00951">cmd_ln_str_list_r()</a>.</p>
</div>
</div>
<a class="anchor" id="af0aa15288e06fc8271298e4fa7cdc91a"></a><!-- doxytag: member="cmd_ln.h::cmd_ln_str_r" ref="af0aa15288e06fc8271298e4fa7cdc91a" args="(cmd_ln_t *cmdln, char const *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">SPHINXBASE_EXPORT char const* cmd_ln_str_r </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcmd__ln__t.html">cmd_ln_t</a> * </td>
<td class="paramname"><em>cmdln</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve a string from a command-line object. </p>
<p>The command-line object retains ownership of this string, so you should not attempt to free it manually.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cmdln</td><td>Command-line object. </td></tr>
<tr><td class="paramname">name</td><td>the command-line flag to retrieve. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the string value associated with <code>name</code>, or NULL if <code>name</code> does not exist. You must use <a class="el" href="cmd__ln_8h.html#ab4ad5ae130e3c2c042590b41768635e3" title="Re-entrant version of cmd_ln_exists().">cmd_ln_exists_r()</a> to distinguish between cases where a value is legitimately NULL and where the corresponding flag is unknown. </dd></dl>
<p>Definition at line <a class="el" href="cmd__ln_8c_source.html#l00941">941</a> of file <a class="el" href="cmd__ln_8c_source.html">cmd_ln.c</a>.</p>
<p>References <a class="el" href="cmd__ln_8c_source.html#l00930">cmd_ln_access_r()</a>, and <a class="el" href="cmd__ln_8c_source.html#l00941">cmd_ln_str_r()</a>.</p>
<p>Referenced by <a class="el" href="cmd__ln_8c_source.html#l00941">cmd_ln_str_r()</a>.</p>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="cmd__ln_8h.html">cmd_ln.h</a> </li>
<li class="footer">Generated on Tue Apr 19 2011 for SphinxBase by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0b420d0fce195cf4115dc6a3be5c2da2
>
files
>
80
