<!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: csAnsiParser Class 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 class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csAnsiParser Class Reference<br>
<small>
[<a class="el" href="group__util.html">Utilities</a>]</small>
</h1><!-- doxytag: class="csAnsiParser" -->Helper to parse a string for ANSI codes.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ansiparse_8h-source.html">csutil/ansiparse.h</a>></code>
<p>
<p>
<a href="classcsAnsiParser-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0">Command</a> { <br>
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a09280b4ed97dcbd0402e3a34242ca1639">cmdUnknown</a>,
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a00fbd161df8847ce668e9753800c69f52">cmdFormatAttrReset</a>,
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a08153dc8904d5b2ff1307e05ee71b9d08">cmdFormatAttrEnable</a>,
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0f8f58bae0d55db7e7bd21bdcd1543cc8">cmdFormatAttrDisable</a>,
<br>
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a042c3f53281d8e4c554da647e9ad657cb">cmdFormatAttrForeground</a>,
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0890f0ee802952d5b59999a04dea2a089">cmdFormatAttrBackground</a>,
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a02b5a1ea6e5384ad65a6ea750dc293b87">cmdClearScreen</a>,
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0073550261fe0f54efcbefeb9fd09cb9e">cmdClearLine</a>,
<br>
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0fa7fd47c7b37898827427ba8ecda4385">cmdCursorSetPosition</a>,
<a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a02d61b66cc824db535c6fc7c58203243a">cmdCursorMoveRelative</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Identifier for the ANSI command. <a href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c">CommandClass</a> { <br>
<a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c3d56c807b4e666efc34e8cb47229a2a2">classNone</a>,
<a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c57cc8e863fc0798209a80432038e0d46">classUnknown</a>,
<a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c51d444625a2df9be1562e867f130343b">classFormat</a>,
<a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14cdf1e57426fb0b53f2f256c65cf6e29d1">classClear</a>,
<br>
<a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14cadfa89111be5826638252624059dfe17">classCursor</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Classification of the command sequence. <a href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f">FormatAttr</a> { <br>
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f478a9040a4ab7232acda1051d250d2a7">attrBold</a>,
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f09d2971728a81e7739930700274a916d">attrItalics</a>,
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f5bc3258e3ccbae8f49a6cbd2a350d5c3">attrUnderline</a>,
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f1d48e1ac2bc210111627ab986272b358">attrBlink</a>,
<br>
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f94920104605144deb3a6e56b8cf58370">attrReverse</a>,
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4fd9efc8048abec925fb97ad9d66cba8e7">attrStrikethrough</a>,
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f47b2979e61861d602a83d123ac72906f">attrDim</a>,
<a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f022b37c307458b00da058e43a75a090e">attrInvisible</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Types of attributes in the cmdFormatAttrEnable/cmdFormatAttrBackground command. <a href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef">FormatColor</a> { <br>
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef41bee08d377617cc094ca20636ca5846">colNone</a> = -1,
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003efed9fbbf5f1f1c07341eafc263b5fb9b0">colBlack</a>,
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef3a18966e693044ee8db145c5236cca4e">colRed</a>,
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef609c119cf39228db92c06ef959fbf550">colGreen</a>,
<br>
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003efe1dbaac328ca756db76f7401fa9150fc">colYellow</a>,
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef15d572370d3a58b32a768bb19b164d02">colBlue</a>,
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef223fea652f8540072fbd3e6e5f8beaf9">colMagenta</a>,
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef5db89a5232714e0749ec9910f4f3b399">colCyan</a>,
<br>
<a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003eff8d77bdbd6b75b9597a626cbb5cdaf1f">colWhite</a>
<br>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Values for foreground/background color. <a href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnsiParser.html#636d022fe5369bea3a9005f11005cead">DecodeCommand</a> (const char *&cmd, size_t &cmdLen, <a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0">Command</a> &command, <a class="el" href="structcsAnsiParser_1_1CommandParams.html">CommandParams</a> &commandParams)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Decode an ANSI code sequence. <a href="#636d022fe5369bea3a9005f11005cead"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsAnsiParser.html#a60deffe6d9de354d87276f3609bfa10">ParseAnsi</a> (const char *str, size_t &ansiCommandLen, <a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c">CommandClass</a> &cmdClass, size_t &textLen)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse a string for ANSI codes. <a href="#a60deffe6d9de354d87276f3609bfa10"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structcsAnsiParser_1_1CommandParams.html">CommandParams</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parameters to ANSI command. <a href="structcsAnsiParser_1_1CommandParams.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="structcsAnsiParser_1_1CursorParams.html">CursorParams</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Helper to parse a string for ANSI codes.
<p>Definition at line <a class="el" href="ansiparse_8h-source.html#l00033">33</a> of file <a class="el" href="ansiparse_8h-source.html">ansiparse.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a0"></a><!-- doxytag: member="csAnsiParser::Command" ref="5e0169d838a8621d116dc08b6b36c7a0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0">csAnsiParser::Command</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Identifier for the ANSI command.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a09280b4ed97dcbd0402e3a34242ca1639"></a><!-- doxytag: member="cmdUnknown" ref="5e0169d838a8621d116dc08b6b36c7a09280b4ed97dcbd0402e3a34242ca1639" args="" -->cmdUnknown</em> </td><td>
Command was unrecognized. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a00fbd161df8847ce668e9753800c69f52"></a><!-- doxytag: member="cmdFormatAttrReset" ref="5e0169d838a8621d116dc08b6b36c7a00fbd161df8847ce668e9753800c69f52" args="" -->cmdFormatAttrReset</em> </td><td>
Reset all attributes. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a08153dc8904d5b2ff1307e05ee71b9d08"></a><!-- doxytag: member="cmdFormatAttrEnable" ref="5e0169d838a8621d116dc08b6b36c7a08153dc8904d5b2ff1307e05ee71b9d08" args="" -->cmdFormatAttrEnable</em> </td><td>
'Enable attribute' </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a0f8f58bae0d55db7e7bd21bdcd1543cc8"></a><!-- doxytag: member="cmdFormatAttrDisable" ref="5e0169d838a8621d116dc08b6b36c7a0f8f58bae0d55db7e7bd21bdcd1543cc8" args="" -->cmdFormatAttrDisable</em> </td><td>
'Disable attribute' </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a042c3f53281d8e4c554da647e9ad657cb"></a><!-- doxytag: member="cmdFormatAttrForeground" ref="5e0169d838a8621d116dc08b6b36c7a042c3f53281d8e4c554da647e9ad657cb" args="" -->cmdFormatAttrForeground</em> </td><td>
'Set foreground color' </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a0890f0ee802952d5b59999a04dea2a089"></a><!-- doxytag: member="cmdFormatAttrBackground" ref="5e0169d838a8621d116dc08b6b36c7a0890f0ee802952d5b59999a04dea2a089" args="" -->cmdFormatAttrBackground</em> </td><td>
'Set background color' </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a02b5a1ea6e5384ad65a6ea750dc293b87"></a><!-- doxytag: member="cmdClearScreen" ref="5e0169d838a8621d116dc08b6b36c7a02b5a1ea6e5384ad65a6ea750dc293b87" args="" -->cmdClearScreen</em> </td><td>
'Clear screen' </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a0073550261fe0f54efcbefeb9fd09cb9e"></a><!-- doxytag: member="cmdClearLine" ref="5e0169d838a8621d116dc08b6b36c7a0073550261fe0f54efcbefeb9fd09cb9e" args="" -->cmdClearLine</em> </td><td>
'Clear end of line' </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a0fa7fd47c7b37898827427ba8ecda4385"></a><!-- doxytag: member="cmdCursorSetPosition" ref="5e0169d838a8621d116dc08b6b36c7a0fa7fd47c7b37898827427ba8ecda4385" args="" -->cmdCursorSetPosition</em> </td><td>
'Set cursor position' </td></tr>
<tr><td valign="top"><em><a class="anchor" name="5e0169d838a8621d116dc08b6b36c7a02d61b66cc824db535c6fc7c58203243a"></a><!-- doxytag: member="cmdCursorMoveRelative" ref="5e0169d838a8621d116dc08b6b36c7a02d61b66cc824db535c6fc7c58203243a" args="" -->cmdCursorMoveRelative</em> </td><td>
Move cursor specified number of lines and columns relative to current position. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ansiparse_8h-source.html#l00037">37</a> of file <a class="el" href="ansiparse_8h-source.html">ansiparse.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="aad88e11bf47c66db29e97380a2ce14c"></a><!-- doxytag: member="csAnsiParser::CommandClass" ref="aad88e11bf47c66db29e97380a2ce14c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c">csAnsiParser::CommandClass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Classification of the command sequence.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="aad88e11bf47c66db29e97380a2ce14c3d56c807b4e666efc34e8cb47229a2a2"></a><!-- doxytag: member="classNone" ref="aad88e11bf47c66db29e97380a2ce14c3d56c807b4e666efc34e8cb47229a2a2" args="" -->classNone</em> </td><td>
No ANSI sequence was found. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="aad88e11bf47c66db29e97380a2ce14c57cc8e863fc0798209a80432038e0d46"></a><!-- doxytag: member="classUnknown" ref="aad88e11bf47c66db29e97380a2ce14c57cc8e863fc0798209a80432038e0d46" args="" -->classUnknown</em> </td><td>
An ANSI sequence was found, but not recognized. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="aad88e11bf47c66db29e97380a2ce14c51d444625a2df9be1562e867f130343b"></a><!-- doxytag: member="classFormat" ref="aad88e11bf47c66db29e97380a2ce14c51d444625a2df9be1562e867f130343b" args="" -->classFormat</em> </td><td>
A formatting sequence was found. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="aad88e11bf47c66db29e97380a2ce14cdf1e57426fb0b53f2f256c65cf6e29d1"></a><!-- doxytag: member="classClear" ref="aad88e11bf47c66db29e97380a2ce14cdf1e57426fb0b53f2f256c65cf6e29d1" args="" -->classClear</em> </td><td>
A screen clear sequence was found. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="aad88e11bf47c66db29e97380a2ce14cadfa89111be5826638252624059dfe17"></a><!-- doxytag: member="classCursor" ref="aad88e11bf47c66db29e97380a2ce14cadfa89111be5826638252624059dfe17" args="" -->classCursor</em> </td><td>
A cursor movement sequence was found. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ansiparse_8h-source.html#l00061">61</a> of file <a class="el" href="ansiparse_8h-source.html">ansiparse.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f"></a><!-- doxytag: member="csAnsiParser::FormatAttr" ref="17df6b7c32f650c1fcdd8839a2401c4f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f">csAnsiParser::FormatAttr</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Types of attributes in the cmdFormatAttrEnable/cmdFormatAttrBackground command.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f478a9040a4ab7232acda1051d250d2a7"></a><!-- doxytag: member="attrBold" ref="17df6b7c32f650c1fcdd8839a2401c4f478a9040a4ab7232acda1051d250d2a7" args="" -->attrBold</em> </td><td>
'Bold' attribute </td></tr>
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f09d2971728a81e7739930700274a916d"></a><!-- doxytag: member="attrItalics" ref="17df6b7c32f650c1fcdd8839a2401c4f09d2971728a81e7739930700274a916d" args="" -->attrItalics</em> </td><td>
'Italics' attribute </td></tr>
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f5bc3258e3ccbae8f49a6cbd2a350d5c3"></a><!-- doxytag: member="attrUnderline" ref="17df6b7c32f650c1fcdd8839a2401c4f5bc3258e3ccbae8f49a6cbd2a350d5c3" args="" -->attrUnderline</em> </td><td>
'Underline' attribute </td></tr>
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f1d48e1ac2bc210111627ab986272b358"></a><!-- doxytag: member="attrBlink" ref="17df6b7c32f650c1fcdd8839a2401c4f1d48e1ac2bc210111627ab986272b358" args="" -->attrBlink</em> </td><td>
'Blink' attribute </td></tr>
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f94920104605144deb3a6e56b8cf58370"></a><!-- doxytag: member="attrReverse" ref="17df6b7c32f650c1fcdd8839a2401c4f94920104605144deb3a6e56b8cf58370" args="" -->attrReverse</em> </td><td>
'Reverse' attribute </td></tr>
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4fd9efc8048abec925fb97ad9d66cba8e7"></a><!-- doxytag: member="attrStrikethrough" ref="17df6b7c32f650c1fcdd8839a2401c4fd9efc8048abec925fb97ad9d66cba8e7" args="" -->attrStrikethrough</em> </td><td>
'Strikethrough' attribute </td></tr>
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f47b2979e61861d602a83d123ac72906f"></a><!-- doxytag: member="attrDim" ref="17df6b7c32f650c1fcdd8839a2401c4f47b2979e61861d602a83d123ac72906f" args="" -->attrDim</em> </td><td>
'Dim' attribute </td></tr>
<tr><td valign="top"><em><a class="anchor" name="17df6b7c32f650c1fcdd8839a2401c4f022b37c307458b00da058e43a75a090e"></a><!-- doxytag: member="attrInvisible" ref="17df6b7c32f650c1fcdd8839a2401c4f022b37c307458b00da058e43a75a090e" args="" -->attrInvisible</em> </td><td>
'Invisible' attribute </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ansiparse_8h-source.html#l00078">78</a> of file <a class="el" href="ansiparse_8h-source.html">ansiparse.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003ef"></a><!-- doxytag: member="csAnsiParser::FormatColor" ref="a8fc920cc044ff4caadcb72f0b0003ef" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef">csAnsiParser::FormatColor</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Values for foreground/background color.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003ef41bee08d377617cc094ca20636ca5846"></a><!-- doxytag: member="colNone" ref="a8fc920cc044ff4caadcb72f0b0003ef41bee08d377617cc094ca20636ca5846" args="" -->colNone</em> </td><td>
None specified. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003efed9fbbf5f1f1c07341eafc263b5fb9b0"></a><!-- doxytag: member="colBlack" ref="a8fc920cc044ff4caadcb72f0b0003efed9fbbf5f1f1c07341eafc263b5fb9b0" args="" -->colBlack</em> </td><td>
Black. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003ef3a18966e693044ee8db145c5236cca4e"></a><!-- doxytag: member="colRed" ref="a8fc920cc044ff4caadcb72f0b0003ef3a18966e693044ee8db145c5236cca4e" args="" -->colRed</em> </td><td>
Red. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003ef609c119cf39228db92c06ef959fbf550"></a><!-- doxytag: member="colGreen" ref="a8fc920cc044ff4caadcb72f0b0003ef609c119cf39228db92c06ef959fbf550" args="" -->colGreen</em> </td><td>
Green. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003efe1dbaac328ca756db76f7401fa9150fc"></a><!-- doxytag: member="colYellow" ref="a8fc920cc044ff4caadcb72f0b0003efe1dbaac328ca756db76f7401fa9150fc" args="" -->colYellow</em> </td><td>
Yellow. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003ef15d572370d3a58b32a768bb19b164d02"></a><!-- doxytag: member="colBlue" ref="a8fc920cc044ff4caadcb72f0b0003ef15d572370d3a58b32a768bb19b164d02" args="" -->colBlue</em> </td><td>
Blue. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003ef223fea652f8540072fbd3e6e5f8beaf9"></a><!-- doxytag: member="colMagenta" ref="a8fc920cc044ff4caadcb72f0b0003ef223fea652f8540072fbd3e6e5f8beaf9" args="" -->colMagenta</em> </td><td>
Magenta. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003ef5db89a5232714e0749ec9910f4f3b399"></a><!-- doxytag: member="colCyan" ref="a8fc920cc044ff4caadcb72f0b0003ef5db89a5232714e0749ec9910f4f3b399" args="" -->colCyan</em> </td><td>
Cyan. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="a8fc920cc044ff4caadcb72f0b0003eff8d77bdbd6b75b9597a626cbb5cdaf1f"></a><!-- doxytag: member="colWhite" ref="a8fc920cc044ff4caadcb72f0b0003eff8d77bdbd6b75b9597a626cbb5cdaf1f" args="" -->colWhite</em> </td><td>
White. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="ansiparse_8h-source.html#l00098">98</a> of file <a class="el" href="ansiparse_8h-source.html">ansiparse.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="636d022fe5369bea3a9005f11005cead"></a><!-- doxytag: member="csAnsiParser::DecodeCommand" ref="636d022fe5369bea3a9005f11005cead" args="(const char *&cmd, size_t &cmdLen, Command &command, CommandParams &commandParams)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool csAnsiParser::DecodeCommand </td>
<td>(</td>
<td class="paramtype">const char *& </td>
<td class="paramname"> <em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname"> <em>cmdLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0">Command</a> & </td>
<td class="paramname"> <em>command</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcsAnsiParser_1_1CommandParams.html">CommandParams</a> & </td>
<td class="paramname"> <em>commandParams</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Decode an ANSI code sequence.
<p>
Decodes a part of an ANSI code sequence, if known. <dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Multiple sequences might occur, repeated call this function until <code>false</code> is returned. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>cmd</em> </td><td>String to decode. Updated to point to the start of the next sequence part. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cmdLen</em> </td><td>Returns length of the command in chars. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>command</em> </td><td>The decoded command. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>commandParams</em> </td><td>Parameters for the decoded command. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether the decoding was successful. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a60deffe6d9de354d87276f3609bfa10"></a><!-- doxytag: member="csAnsiParser::ParseAnsi" ref="a60deffe6d9de354d87276f3609bfa10" args="(const char *str, size_t &ansiCommandLen, CommandClass &cmdClass, size_t &textLen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static bool csAnsiParser::ParseAnsi </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname"> <em>ansiCommandLen</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c">CommandClass</a> & </td>
<td class="paramname"> <em>cmdClass</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t & </td>
<td class="paramname"> <em>textLen</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse a string for ANSI codes.
<p>
Looks if a string contains an ANSI code sequence at the beginning. If yes, the ansiCommandLen parameter is filled with the length of the sequence. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>String to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ansiCommandLen</em> </td><td>Returns number of chars that the ANSI command takes up. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cmdClass</em> </td><td>Returns the ANSI command class. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>textLen</em> </td><td>Contains the number of chars up to the next ANSI sequence or the end of the string of no sequence was found. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Whether the parsing was successful. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="ansiparse_8h-source.html">ansiparse.h</a></ul>
<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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
237
