Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 27

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!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: csutil/ansiparse.h Source File (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&nbsp;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&nbsp;Pages</span></a></li>
  </ul>
</div>
<h1>csutil/ansiparse.h</h1><a href="ansiparse_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">    Copyright (C) 2005 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment">              (C) 2005 by Frank Richter</span>
<a name="l00004"></a>00004 <span class="comment">              (C) 2006 by Marten Svanfeldt</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">    This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment">    modify it under the terms of the GNU Library General Public</span>
<a name="l00008"></a>00008 <span class="comment">    License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment">    version 2 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"></span>
<a name="l00011"></a>00011 <span class="comment">    This library is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU</span>
<a name="l00014"></a>00014 <span class="comment">    Library General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">    You should have received a copy of the GNU Library General Public</span>
<a name="l00017"></a>00017 <span class="comment">    License along with this library; if not, write to the Free</span>
<a name="l00018"></a>00018 <span class="comment">    Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00019"></a>00019 <span class="comment">*/</span>
<a name="l00020"></a>00020 
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef __CS_CSUTIL_ANSIPARSE_H__</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define __CS_CSUTIL_ANSIPARSE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 
<a name="l00032"></a>00032 
<a name="l00033"></a><a class="code" href="classcsAnsiParser.html">00033</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsAnsiParser.html" title="Helper to parse a string for ANSI codes.">csAnsiParser</a>
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00037"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0">00037</a>   <span class="keyword">enum</span> <a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0" title="Identifier for the ANSI command.">Command</a>
<a name="l00038"></a>00038   {
<a name="l00040"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a09280b4ed97dcbd0402e3a34242ca1639">00040</a>     cmdUnknown,
<a name="l00042"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a00fbd161df8847ce668e9753800c69f52">00042</a>     cmdFormatAttrReset,
<a name="l00044"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a08153dc8904d5b2ff1307e05ee71b9d08">00044</a>     cmdFormatAttrEnable,
<a name="l00046"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0f8f58bae0d55db7e7bd21bdcd1543cc8">00046</a>     cmdFormatAttrDisable,
<a name="l00048"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a042c3f53281d8e4c554da647e9ad657cb">00048</a>     cmdFormatAttrForeground,
<a name="l00050"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0890f0ee802952d5b59999a04dea2a089">00050</a>     cmdFormatAttrBackground,
<a name="l00052"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a02b5a1ea6e5384ad65a6ea750dc293b87">00052</a>     cmdClearScreen,
<a name="l00054"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0073550261fe0f54efcbefeb9fd09cb9e">00054</a>     cmdClearLine,
<a name="l00056"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a0fa7fd47c7b37898827427ba8ecda4385">00056</a>     cmdCursorSetPosition,
<a name="l00058"></a><a class="code" href="classcsAnsiParser.html#5e0169d838a8621d116dc08b6b36c7a02d61b66cc824db535c6fc7c58203243a">00058</a>     cmdCursorMoveRelative
<a name="l00059"></a>00059   };
<a name="l00061"></a><a class="code" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c">00061</a>   <span class="keyword">enum</span> <a class="code" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c" title="Classification of the command sequence.">CommandClass</a>
<a name="l00062"></a>00062   {
<a name="l00064"></a><a class="code" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c3d56c807b4e666efc34e8cb47229a2a2">00064</a>     classNone,
<a name="l00066"></a><a class="code" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c57cc8e863fc0798209a80432038e0d46">00066</a>     classUnknown,
<a name="l00068"></a><a class="code" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14c51d444625a2df9be1562e867f130343b">00068</a>     classFormat,
<a name="l00070"></a><a class="code" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14cdf1e57426fb0b53f2f256c65cf6e29d1">00070</a>     classClear,
<a name="l00072"></a><a class="code" href="classcsAnsiParser.html#aad88e11bf47c66db29e97380a2ce14cadfa89111be5826638252624059dfe17">00072</a>     classCursor
<a name="l00073"></a>00073   };
<a name="l00078"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f">00078</a>   <span class="keyword">enum</span> <a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f" title="Types of attributes in the cmdFormatAttrEnable/cmdFormatAttrBackground command.">FormatAttr</a>
<a name="l00079"></a>00079   {
<a name="l00081"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f478a9040a4ab7232acda1051d250d2a7">00081</a>     attrBold,
<a name="l00083"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f09d2971728a81e7739930700274a916d">00083</a>     attrItalics,
<a name="l00085"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f5bc3258e3ccbae8f49a6cbd2a350d5c3">00085</a>     attrUnderline,
<a name="l00087"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f1d48e1ac2bc210111627ab986272b358">00087</a>     attrBlink,
<a name="l00089"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f94920104605144deb3a6e56b8cf58370">00089</a>     attrReverse,
<a name="l00091"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4fd9efc8048abec925fb97ad9d66cba8e7">00091</a>     attrStrikethrough,
<a name="l00093"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f47b2979e61861d602a83d123ac72906f">00093</a>     attrDim,
<a name="l00095"></a><a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f022b37c307458b00da058e43a75a090e">00095</a>     attrInvisible
<a name="l00096"></a>00096   };
<a name="l00098"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef">00098</a>   <span class="keyword">enum</span> <a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef" title="Values for foreground/background color.">FormatColor</a>
<a name="l00099"></a>00099   {
<a name="l00101"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef41bee08d377617cc094ca20636ca5846">00101</a>     colNone = -1,
<a name="l00103"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003efed9fbbf5f1f1c07341eafc263b5fb9b0">00103</a>     colBlack,
<a name="l00105"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef3a18966e693044ee8db145c5236cca4e">00105</a>     colRed,
<a name="l00107"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef609c119cf39228db92c06ef959fbf550">00107</a>     colGreen,
<a name="l00109"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003efe1dbaac328ca756db76f7401fa9150fc">00109</a>     colYellow,
<a name="l00111"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef15d572370d3a58b32a768bb19b164d02">00111</a>     colBlue,
<a name="l00113"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef223fea652f8540072fbd3e6e5f8beaf9">00113</a>     colMagenta,
<a name="l00115"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef5db89a5232714e0749ec9910f4f3b399">00115</a>     colCyan,
<a name="l00117"></a><a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003eff8d77bdbd6b75b9597a626cbb5cdaf1f">00117</a>     colWhite
<a name="l00118"></a>00118   };
<a name="l00119"></a><a class="code" href="structcsAnsiParser_1_1CursorParams.html">00119</a>   <span class="keyword">struct </span><a class="code" href="structcsAnsiParser_1_1CursorParams.html">CursorParams</a>
<a name="l00120"></a>00120   {
<a name="l00122"></a><a class="code" href="structcsAnsiParser_1_1CursorParams.html#9d268cd94cdfc6982b758011acdf23d1">00122</a>     <span class="keywordtype">int</span> x;
<a name="l00123"></a>00123 
<a name="l00125"></a><a class="code" href="structcsAnsiParser_1_1CursorParams.html#22be0c7ed7d45b7e00f3500190a77550">00125</a>     <span class="keywordtype">int</span> y;
<a name="l00126"></a>00126   };
<a name="l00128"></a><a class="code" href="structcsAnsiParser_1_1CommandParams.html">00128</a>   <span class="keyword">struct </span><a class="code" href="structcsAnsiParser_1_1CommandParams.html" title="Parameters to ANSI command.">CommandParams</a>
<a name="l00129"></a>00129   {
<a name="l00130"></a>00130     <span class="keyword">union</span>
<a name="l00131"></a>00131     {
<a name="l00133"></a><a class="code" href="structcsAnsiParser_1_1CommandParams.html#78afcfad1ad41ef21786e7812ae33850">00133</a>       <a class="code" href="classcsAnsiParser.html#a8fc920cc044ff4caadcb72f0b0003ef" title="Values for foreground/background color.">FormatColor</a> colorVal;
<a name="l00135"></a><a class="code" href="structcsAnsiParser_1_1CommandParams.html#8014d206187e4b019aa22aa5c411e41a">00135</a>       <a class="code" href="classcsAnsiParser.html#17df6b7c32f650c1fcdd8839a2401c4f" title="Types of attributes in the cmdFormatAttrEnable/cmdFormatAttrBackground command.">FormatAttr</a> attrVal;
<a name="l00137"></a><a class="code" href="structcsAnsiParser_1_1CommandParams.html#a5be475afa9a08877fef99d175dc13c9">00137</a>       <a class="code" href="structcsAnsiParser_1_1CursorParams.html">CursorParams</a> cursorVal;
<a name="l00138"></a>00138     };
<a name="l00139"></a>00139   };
<a name="l00153"></a>00153   <span class="keyword">static</span> <span class="keywordtype">bool</span> ParseAnsi (<span class="keyword">const</span> <span class="keywordtype">char</span>* str, <span class="keywordtype">size_t</span>&amp; ansiCommandLen, 
<a name="l00154"></a>00154     CommandClass&amp; cmdClass, <span class="keywordtype">size_t</span>&amp; textLen);
<a name="l00167"></a>00167   <span class="keyword">static</span> <span class="keywordtype">bool</span> DecodeCommand (<span class="keyword">const</span> <span class="keywordtype">char</span>*&amp; cmd, <span class="keywordtype">size_t</span>&amp; cmdLen, 
<a name="l00168"></a>00168     Command&amp; command, CommandParams&amp; commandParams);
<a name="l00169"></a>00169 };
<a name="l00170"></a>00170 
<a name="l00173"></a>00173 <span class="preprocessor">#endif // __CS_CSUTIL_ANSIPARSE_H__</span>
</pre></div><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>