<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: ConsoleTools Class Reference</title>
<link href="../styles/styles.css" rel="stylesheet" type="text/css">
<link href="../styles/doc.css" rel="stylesheet" type="text/css">
<link rel="icon" href="../images/logo-small-api.png"/>
</head>
<body>
<div align='center'>
<a href="../index.html">Home</a> |
<a href="modules.html">Modules</a> |
<a href="hierarchy.html">Class Hierarchy</a> |
<a href="classes.html">Alphabetical List</a> |
<a href="annotated.html">Compound List</a> |
<a href="pages.html">Related Pages</a>
</div>
<!-- Generated by Doxygen 1.4.6 -->
<h1>ConsoleTools Class Reference<br>
<small>
[<a class="el" href="group__colorer__viewer.html">Viewer/streaming</a>]</small>
</h1><!-- doxytag: class="ConsoleTools" --><hr><a name="_details"></a><h2>Detailed Description</h2>
Console colorer application.
<p>
Implements command-line interface, and allows to generate colored html sources, view text files in console window(win32 only) and to check HRC database integrity.
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f17450131652ee5177a38b95d7aa0c3e"></a><!-- doxytag: member="ConsoleTools::setCopyrightHeader" ref="f17450131652ee5177a38b95d7aa0c3e" args="(bool use)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#f17450131652ee5177a38b95d7aa0c3e">setCopyrightHeader</a> (bool use)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is copyright header present in html output. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="edc01e6587805cec1841085a8493f330"></a><!-- doxytag: member="ConsoleTools::setHtmlEscaping" ref="edc01e6587805cec1841085a8493f330" args="(bool use)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#edc01e6587805cec1841085a8493f330">setHtmlEscaping</a> (bool use)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is HTML characters escaping done by <a class="el" href="classHtmlEscapesWriter.html">HtmlEscapesWriter</a> class. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1a3cd219240cec15ee10a277d69542dc"></a><!-- doxytag: member="ConsoleTools::setBomOutput" ref="1a3cd219240cec15ee10a277d69542dc" args="(bool use)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#1a3cd219240cec15ee10a277d69542dc">setBomOutput</a> (bool use)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is BOM outputted into result stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10eef777c41da741ded222a092ddde15"></a><!-- doxytag: member="ConsoleTools::setHtmlWrapping" ref="10eef777c41da741ded222a092ddde15" args="(bool use)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#10eef777c41da741ded222a092ddde15">setHtmlWrapping</a> (bool use)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Is HTML text header and footer are printed in HTML result. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3326f2b17d208698a758c502b63e746e"></a><!-- doxytag: member="ConsoleTools::setTypeDescription" ref="3326f2b17d208698a758c502b63e746e" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#3326f2b17d208698a758c502b63e746e">setTypeDescription</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Alternative HRC type description for type selection. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e2d79c15c01eb379d819be069cc3e082"></a><!-- doxytag: member="ConsoleTools::setInputFileName" ref="e2d79c15c01eb379d819be069cc3e082" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#e2d79c15c01eb379d819be069cc3e082">setInputFileName</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">File name, used as input source. Could be URL. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16ce34c2a7d7f556e818f3c0a0a4e932"></a><!-- doxytag: member="ConsoleTools::setOutputFileName" ref="16ce34c2a7d7f556e818f3c0a0a4e932" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#16ce34c2a7d7f556e818f3c0a0a4e932">setOutputFileName</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Optional file name, used for output. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="069eaf84ce5bef7129762eedda055516"></a><!-- doxytag: member="ConsoleTools::setInputEncoding" ref="069eaf84ce5bef7129762eedda055516" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#069eaf84ce5bef7129762eedda055516">setInputEncoding</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Input Characters Encoding. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4f500d4ecfa615b18e782877bd95cefc"></a><!-- doxytag: member="ConsoleTools::setOutputEncoding" ref="4f500d4ecfa615b18e782877bd95cefc" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#4f500d4ecfa615b18e782877bd95cefc">setOutputEncoding</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Output Characters Encoding. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8cd6037bfb50a3493125cc65f5623336"></a><!-- doxytag: member="ConsoleTools::setCatalogPath" ref="8cd6037bfb50a3493125cc65f5623336" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#8cd6037bfb50a3493125cc65f5623336">setCatalogPath</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Optional path to base catalog.xml. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43d1a1aac5fe494c9d8db1874835d129"></a><!-- doxytag: member="ConsoleTools::setHRDName" ref="43d1a1aac5fe494c9d8db1874835d129" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#43d1a1aac5fe494c9d8db1874835d129">setHRDName</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Optional HRD instance name, used to perform parsing. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cda527c52853b4e4f99e58f9dbd11a7a"></a><!-- doxytag: member="ConsoleTools::setLinkSource" ref="cda527c52853b4e4f99e58f9dbd11a7a" args="(const String &str)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#cda527c52853b4e4f99e58f9dbd11a7a">setLinkSource</a> (const <a class="el" href="classString.html">String</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets linking datasource into this filename. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="89044482fdb62dd29933f3cfdc815d92"></a><!-- doxytag: member="ConsoleTools::addLineNumbers" ref="89044482fdb62dd29933f3cfdc815d92" args="(bool add)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#89044482fdb62dd29933f3cfdc815d92">addLineNumbers</a> (bool add)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">If true, result file will have line numbers before each line. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#ac09fe4533decdd1b6fd1d7e9e82d6a4">RETest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Regular Expressions tests. <a href="#ac09fe4533decdd1b6fd1d7e9e82d6a4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#6750ff5d56f02076348f379a684f783b">profile</a> (int loopCount)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Runs parser in profile mode. <a href="#6750ff5d56f02076348f379a684f783b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="04da86679e754cf34c02ef6898d35fe7"></a><!-- doxytag: member="ConsoleTools::listTypes" ref="04da86679e754cf34c02ef6898d35fe7" args="(bool load, bool useNames)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#04da86679e754cf34c02ef6898d35fe7">listTypes</a> (bool load, bool useNames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lists all available HRC types and optionally tries to load them. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="47c5ed8fc1fe462fbb716659c264b25c"></a><!-- doxytag: member="ConsoleTools::selectType" ref="47c5ed8fc1fe462fbb716659c264b25c" args="(HRCParser *hrcParser, LineSource *lineSource)" -->
<a class="el" href="classFileType.html">FileType</a> * </td><td class="memItemRight" valign="bottom"><b>selectType</b> (<a class="el" href="classHRCParser.html">HRCParser</a> *hrcParser, <a class="el" href="classLineSource.html">LineSource</a> *lineSource)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="861fdddaf8e0edd1ce2bb55552062fd3"></a><!-- doxytag: member="ConsoleTools::viewFile" ref="861fdddaf8e0edd1ce2bb55552062fd3" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#861fdddaf8e0edd1ce2bb55552062fd3">viewFile</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Views file in console window, using <a class="el" href="classTextConsoleViewer.html">TextConsoleViewer</a> class. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="043ee8fda363866ba8e0a0c2f245ddc9"></a><!-- doxytag: member="ConsoleTools::forward" ref="043ee8fda363866ba8e0a0c2f245ddc9" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#043ee8fda363866ba8e0a0c2f245ddc9">forward</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Simply forwards input text to output, using passed encoding information. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classConsoleTools.html#82f972db901f334767900cfb3d39e91d">genOutput</a> (bool useTokens=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generates HTML-ized output of file. <a href="#82f972db901f334767900cfb3d39e91d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f9f62129b16afc0166998c44c66f9de"></a><!-- doxytag: member="ConsoleTools::genTokenOutput" ref="1f9f62129b16afc0166998c44c66f9de" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>genTokenOutput</b> ()</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ac09fe4533decdd1b6fd1d7e9e82d6a4"></a><!-- doxytag: member="ConsoleTools::RETest" ref="ac09fe4533decdd1b6fd1d7e9e82d6a4" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ConsoleTools::RETest </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Regular Expressions tests.
<p>
Reads RE and expression from stdin, and checks expression against RE. Outputs all matched brackets. </td>
</tr>
</table>
<a class="anchor" name="6750ff5d56f02076348f379a684f783b"></a><!-- doxytag: member="ConsoleTools::profile" ref="6750ff5d56f02076348f379a684f783b" args="(int loopCount)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ConsoleTools::profile </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>loopCount</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Runs parser in profile mode.
<p>
Does everything, -h makes, but makes possible repeat loops and produces no output. Prints into standard output number of msecs, used.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>loopCount</em> </td><td>Number of times to repeat file's parsing. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="82f972db901f334767900cfb3d39e91d"></a><!-- doxytag: member="ConsoleTools::genOutput" ref="82f972db901f334767900cfb3d39e91d" args="(bool useTokens=false)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ConsoleTools::genOutput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> <em>useTokens</em> = <code>false</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Generates HTML-ized output of file.
<p>
Uses <code>'rgb'</code> HRD class to dynamically create HTML tags, or <code>'text'</code> HRD class to use specified in HRD file starting and ending sequences. </td>
</tr>
</table>
<br><br>
<center><small>
Colorer-take5 Library. Copyright © 1999-2006 Igor Russkih.<br>
Generated at Fri Nov 24 17:13:12 2006 by doxygen 1.4.6.
</small><center>
</BODY>
</HTML>
