<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: cstool/identstrings.h File Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>cstool/identstrings.h File Reference</h1>Set of helper macros to obtain the names of identifiers. <a href="#_details">More...</a> <p> <code>#include "<a class="el" href="csstring_8h-source.html">csutil/csstring.h</a>"</code><br> <p> <a href="identstrings_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Classes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsIdentStrings.html">csIdentStrings</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Helper class that contains a list of identifiers and their names. <a href="classcsIdentStrings.html#_details">More...</a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsIdentStrings_1_1csIdentString.html">csIdentStrings::csIdentString</a></td></tr> <tr><td colspan="2"><br><h2>Defines</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="identstrings_8h.html#a9b22e7a4ffbbe1a427eb9d705471fcc">CS_IDENT_STRING</a>(Ident) {Ident, #Ident},</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Entry in the identifier list. <a href="#a9b22e7a4ffbbe1a427eb9d705471fcc"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="identstrings_8h.html#e537223d77ea1ab53318b0beb6c22bba">CS_IDENT_STRING_EXPLICIT</a>(Ident, Str) {Ident, str},</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Entry in the identifier list, but with an explicitly set name. <a href="#e537223d77ea1ab53318b0beb6c22bba"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="identstrings_8h.html#e43e1de1fc248efff2949a42c87df573">CS_IDENT_STRING_LIST</a>(ListName) static const <a class="el" href="structcsIdentStrings_1_1csIdentString.html">csIdentStrings::csIdentString</a> ListName##_strings[] = {</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Begin an identifier list. <a href="#e43e1de1fc248efff2949a42c87df573"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="identstrings_8h.html#7284e05bee2646be47976076beefb661">CS_IDENT_STRING_LIST_END</a>(ListName)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">End an identifier list. <a href="#7284e05bee2646be47976076beefb661"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Set of helper macros to obtain the names of identifiers. <p> <p>Definition in file <a class="el" href="identstrings_8h-source.html">identstrings.h</a>.</p> <hr><h2>Define Documentation</h2> <a class="anchor" name="a9b22e7a4ffbbe1a427eb9d705471fcc"></a><!-- doxytag: member="identstrings.h::CS_IDENT_STRING" ref="a9b22e7a4ffbbe1a427eb9d705471fcc" args="(Ident)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define CS_IDENT_STRING </td> <td>(</td> <td class="paramtype">Ident </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> {Ident, #Ident},</td> </tr> </table> </div> <div class="memdoc"> <p> Entry in the identifier list. <p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The identifiers <b>*must*</b> be sorted in increasing order. </dd></dl> <p>Definition at line <a class="el" href="identstrings_8h-source.html#l00098">98</a> of file <a class="el" href="identstrings_8h-source.html">identstrings.h</a>.</p> </div> </div><p> <a class="anchor" name="e537223d77ea1ab53318b0beb6c22bba"></a><!-- doxytag: member="identstrings.h::CS_IDENT_STRING_EXPLICIT" ref="e537223d77ea1ab53318b0beb6c22bba" args="(Ident, Str)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define CS_IDENT_STRING_EXPLICIT </td> <td>(</td> <td class="paramtype">Ident, <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">Str </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> {Ident, str},</td> </tr> </table> </div> <div class="memdoc"> <p> Entry in the identifier list, but with an explicitly set name. <p> <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>The identifiers <b>*must*</b> be sorted in increasing order. </dd></dl> <p>Definition at line <a class="el" href="identstrings_8h-source.html#l00103">103</a> of file <a class="el" href="identstrings_8h-source.html">identstrings.h</a>.</p> </div> </div><p> <a class="anchor" name="e43e1de1fc248efff2949a42c87df573"></a><!-- doxytag: member="identstrings.h::CS_IDENT_STRING_LIST" ref="e43e1de1fc248efff2949a42c87df573" args="(ListName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define CS_IDENT_STRING_LIST </td> <td>(</td> <td class="paramtype">ListName </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"> static const <a class="el" href="structcsIdentStrings_1_1csIdentString.html">csIdentStrings::csIdentString</a> ListName##_strings[] = {</td> </tr> </table> </div> <div class="memdoc"> <p> Begin an identifier list. <p> <code>ListName</code> is the identifier of the generated <a class="el" href="classcsIdentStrings.html" title="Helper class that contains a list of identifiers and their names.">csIdentStrings</a> object. <p> Example: <div class="fragment"><pre class="fragment"> <a class="code" href="identstrings_8h.html#e43e1de1fc248efff2949a42c87df573" title="Begin an identifier list.">CS_IDENT_STRING_LIST</a>(FooNames) <a class="code" href="identstrings_8h.html#a9b22e7a4ffbbe1a427eb9d705471fcc" title="Entry in the identifier list.">CS_IDENT_STRING</a>(FOO_BAR) <a class="code" href="identstrings_8h.html#a9b22e7a4ffbbe1a427eb9d705471fcc" title="Entry in the identifier list.">CS_IDENT_STRING</a>(FOO_BAZ) <a class="code" href="identstrings_8h.html#7284e05bee2646be47976076beefb661" title="End an identifier list.">CS_IDENT_STRING_LIST_END</a>(FooNames) </pre></div> From code, use like: <div class="fragment"><pre class="fragment"> <a class="code" href="group__util.html#gd4b0fa911161355ff8284407897d2537" title="CS version of printf.">csPrintf</a> (<span class="stringliteral">"%s\n"</span>, FooNames.StringForIdent (foo)); </pre></div> <p>Definition at line <a class="el" href="identstrings_8h-source.html#l00092">92</a> of file <a class="el" href="identstrings_8h-source.html">identstrings.h</a>.</p> </div> </div><p> <a class="anchor" name="7284e05bee2646be47976076beefb661"></a><!-- doxytag: member="identstrings.h::CS_IDENT_STRING_LIST_END" ref="7284e05bee2646be47976076beefb661" args="(ListName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define CS_IDENT_STRING_LIST_END </td> <td>(</td> <td class="paramtype">ListName </td> <td class="paramname"> </td> <td> ) </td> <td width="100%"></td> </tr> </table> </div> <div class="memdoc"> <p> <b>Value:</b><div class="fragment"><pre class="fragment">{0, 0} \ }; \ <a class="code" href="cssysdef_8h.html#61813b56c11d1bd8486ad2ced24348d9" title="Implement a file-scoped static variable that is created on demand.">CS_IMPLEMENT_STATIC_VAR</a>(Get##ListName##Scratch, <a class="code" href="classcsString.html" title="Thin wrapper around csStringFast&lt;&gt; with its default buffer size.">csString</a>, ()) \ <span class="keyword">static</span> <a class="code" href="classcsIdentStrings.html" title="Helper class that contains a list of identifiers and their names.">csIdentStrings</a> ListName (ListName##_strings, \ Get##ListName##Scratch(), \ (<span class="keyword">sizeof</span> (ListName##_strings) / <span class="keyword">sizeof</span> (<a class="code" href="structcsIdentStrings_1_1csIdentString.html">csIdentStrings::csIdentString</a>)) - 1); </pre></div>End an identifier list. <p> <p>Definition at line <a class="el" href="identstrings_8h-source.html#l00107">107</a> of file <a class="el" href="identstrings_8h-source.html">identstrings.h</a>.</p> </div> </div><p> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>