Sophie

Sophie

distrib > Mandriva > 2010.0 > x86_64 > by-pkgid > 9ac0f970b86472ed1e748202d2848da8 > files > 65

colorer-take5-docs-0-0.beta5.4mdv2010.0.x86_64.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>Colorer-take5 Library: FileTypeImpl 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>FileTypeImpl Class Reference<br>
<small>
[<a class="el" href="group__colorer__parsers.html">Parsers</a>]</small>
</h1><!-- doxytag: class="FileTypeImpl" --><!-- doxytag: inherits="FileType" --><p>Inheritance diagram for FileTypeImpl:
<p><center><img src="classFileTypeImpl.png" usemap="#FileTypeImpl_map" border="0" alt=""></center>
<map name="FileTypeImpl_map">
<area href="classFileType.html" alt="FileType" shape="rect" coords="0,0,83,24">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
File Type storage implementation. 
<p>
Contains different attributes of HRC file type. 
<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="53dacc30abe86bf6717221ba6aa0ba15"></a><!-- doxytag: member="FileTypeImpl::getName" ref="53dacc30abe86bf6717221ba6aa0ba15" args="()" -->
const <a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getName</b> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dea2aa7929424c74c71204fce529e39a"></a><!-- doxytag: member="FileTypeImpl::getGroup" ref="dea2aa7929424c74c71204fce529e39a" args="()" -->
const <a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getGroup</b> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b88d600068d456ca3045a2bbe531faa7"></a><!-- doxytag: member="FileTypeImpl::getDescription" ref="b88d600068d456ca3045a2bbe531faa7" args="()" -->
const <a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getDescription</b> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1058544b893ce164e5d912c4a2c00b17"></a><!-- doxytag: member="FileTypeImpl::getBaseScheme" ref="1058544b893ce164e5d912c4a2c00b17" args="()" -->
<a class="el" href="classScheme.html">Scheme</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getBaseScheme</b> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b91845aaf539a016f8705690890ae0ba"></a><!-- doxytag: member="FileTypeImpl::enumerateParameters" ref="b91845aaf539a016f8705690890ae0ba" args="(int idx)" -->
const <a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>enumerateParameters</b> (int idx)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="94275d424e097298e35b24e70ed5d726"></a><!-- doxytag: member="FileTypeImpl::getParameterDescription" ref="94275d424e097298e35b24e70ed5d726" args="(const String &amp;name)" -->
const <a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getParameterDescription</b> (const <a class="el" href="classString.html">String</a> &amp;name)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3cd8cc9c9f82f42ea9d2cdaa238461a"></a><!-- doxytag: member="FileTypeImpl::getParamValue" ref="a3cd8cc9c9f82f42ea9d2cdaa238461a" args="(const String &amp;name)" -->
const <a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getParamValue</b> (const <a class="el" href="classString.html">String</a> &amp;name)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acb11e8033d89429666db83a631a8c05"></a><!-- doxytag: member="FileTypeImpl::getParamDefaultValue" ref="acb11e8033d89429666db83a631a8c05" args="(const String &amp;name)" -->
const <a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>getParamDefaultValue</b> (const <a class="el" href="classString.html">String</a> &amp;name)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b7946a7bfe8557e88196f76cdce94de"></a><!-- doxytag: member="FileTypeImpl::setParamValue" ref="5b7946a7bfe8557e88196f76cdce94de" args="(const String &amp;name, const String *value)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setParamValue</b> (const <a class="el" href="classString.html">String</a> &amp;name, const <a class="el" href="classString.html">String</a> *value)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTypeImpl.html#795cb15b7f93458d3fa6d73458799a40">getPriority</a> (const <a class="el" href="classString.html">String</a> *fileName, const <a class="el" href="classString.html">String</a> *fileContent) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns total priority, accordingly to all it's choosers (filename and firstline choosers).  <a href="#795cb15b7f93458d3fa6d73458799a40"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c8f6a4eb469fccc2cdc36b0e858b30d"></a><!-- doxytag: member="FileTypeImpl::FileTypeImpl" ref="3c8f6a4eb469fccc2cdc36b0e858b30d" args="(HRCParserImpl *hrcParser)" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><b>FileTypeImpl</b> (<a class="el" href="classHRCParserImpl.html">HRCParserImpl</a> *hrcParser)</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8f2b417707841f94c347dcfd378de96"></a><!-- doxytag: member="FileTypeImpl::protoLoaded" ref="c8f2b417707841f94c347dcfd378de96" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTypeImpl.html#c8f2b417707841f94c347dcfd378de96">protoLoaded</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">is prototype component loaded <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4317e79efb457e6d450bbcc6f5092cd1"></a><!-- doxytag: member="FileTypeImpl::typeLoaded" ref="4317e79efb457e6d450bbcc6f5092cd1" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTypeImpl.html#4317e79efb457e6d450bbcc6f5092cd1">typeLoaded</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">is type component loaded <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0fabeed96d02a8e895b893fea4ae42e1"></a><!-- doxytag: member="FileTypeImpl::loadDone" ref="0fabeed96d02a8e895b893fea4ae42e1" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTypeImpl.html#0fabeed96d02a8e895b893fea4ae42e1">loadDone</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">is type references fully resolved <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0afc26520c994157c7ff079954ced7d"></a><!-- doxytag: member="FileTypeImpl::loadBroken" ref="b0afc26520c994157c7ff079954ced7d" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTypeImpl.html#b0afc26520c994157c7ff079954ced7d">loadBroken</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">is initial type load failed <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e96886b93ba0bbec6e033e64ee35f84e"></a><!-- doxytag: member="FileTypeImpl::inputSourceLoading" ref="e96886b93ba0bbec6e033e64ee35f84e" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFileTypeImpl.html#e96886b93ba0bbec6e033e64ee35f84e">inputSourceLoading</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">is this IS loading was started <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="13b7485918be605d73f70d2dd591752f"></a><!-- doxytag: member="FileTypeImpl::name" ref="13b7485918be605d73f70d2dd591752f" args="" -->
<a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>name</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9bce70bc53fb8dd3225b0b189f471ac1"></a><!-- doxytag: member="FileTypeImpl::group" ref="9bce70bc53fb8dd3225b0b189f471ac1" args="" -->
<a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>group</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="43fbce7b72d9f377e0ce8f8396563214"></a><!-- doxytag: member="FileTypeImpl::description" ref="43fbce7b72d9f377e0ce8f8396563214" args="" -->
<a class="el" href="classString.html">String</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>description</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="86a3b6a23fde184fb58050fda8dfa964"></a><!-- doxytag: member="FileTypeImpl::isPackage" ref="86a3b6a23fde184fb58050fda8dfa964" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>isPackage</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="379ee434b97879a1cc573a8248a548ef"></a><!-- doxytag: member="FileTypeImpl::hrcParser" ref="379ee434b97879a1cc573a8248a548ef" args="" -->
<a class="el" href="classHRCParserImpl.html">HRCParserImpl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>hrcParser</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c6ca8c39556807c838d6a91068decf0"></a><!-- doxytag: member="FileTypeImpl::baseScheme" ref="3c6ca8c39556807c838d6a91068decf0" args="" -->
<a class="el" href="classSchemeImpl.html">SchemeImpl</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>baseScheme</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1f03bda83aee7d500608607e4b2db440"></a><!-- doxytag: member="FileTypeImpl::chooserVector" ref="1f03bda83aee7d500608607e4b2db440" args="" -->
<a class="el" href="classVector.html">Vector</a>&lt; <a class="el" href="classFileTypeChooser.html">FileTypeChooser</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>chooserVector</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="17ea4652b9ae46969b46f026388e434b"></a><!-- doxytag: member="FileTypeImpl::paramDefaultHash" ref="17ea4652b9ae46969b46f026388e434b" args="" -->
<a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>paramDefaultHash</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d6da4a6c0b746e42c4ffa28c6a5989ab"></a><!-- doxytag: member="FileTypeImpl::paramHash" ref="d6da4a6c0b746e42c4ffa28c6a5989ab" args="" -->
<a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>paramHash</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e18c2292ff1015b65088420344a8acbf"></a><!-- doxytag: member="FileTypeImpl::paramDescriptionHash" ref="e18c2292ff1015b65088420344a8acbf" args="" -->
<a class="el" href="classHashtable.html">Hashtable</a>&lt; <a class="el" href="classString.html">String</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>paramDescriptionHash</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7edbb79fe404f923c0f87f6c3dc7331e"></a><!-- doxytag: member="FileTypeImpl::paramVector" ref="7edbb79fe404f923c0f87f6c3dc7331e" args="" -->
<a class="el" href="classVector.html">Vector</a>&lt; <a class="el" href="classString.html">String</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>paramVector</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="44d5440fc645c2463ab724803c02feb4"></a><!-- doxytag: member="FileTypeImpl::importVector" ref="44d5440fc645c2463ab724803c02feb4" args="" -->
<a class="el" href="classVector.html">Vector</a>&lt; <a class="el" href="classString.html">String</a> * &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><b>importVector</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="02a89865a66f18bee6b0b3c7cb6b911b"></a><!-- doxytag: member="FileTypeImpl::inputSource" ref="02a89865a66f18bee6b0b3c7cb6b911b" args="" -->
<a class="el" href="classInputSource.html">InputSource</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><b>inputSource</b></td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="795cb15b7f93458d3fa6d73458799a40"></a><!-- doxytag: member="FileTypeImpl::getPriority" ref="795cb15b7f93458d3fa6d73458799a40" args="(const String *fileName, const String *fileContent) const " --><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">double FileTypeImpl::getPriority           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classString.html">String</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>fileName</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="classString.html">String</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>fileContent</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const<code> [inline]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns total priority, accordingly to all it's choosers (filename and firstline choosers). 
<p>
All <code>fileContent</code> RE's are tested only if priority of previously computed <code>fileName</code> RE's is more, than zero. <dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>fileName</em>&nbsp;</td><td><a class="el" href="classString.html">String</a> representation of file name (without path). If null, method skips filename matching, and starts directly with fileContent matching. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>fileContent</em>&nbsp;</td><td>Some part of file's starting content (first line, for example). If null, skipped. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>Computed total filetype priority. </dd></dl>
    </td>
  </tr>
</table>

<br><br>
<center><small>
Colorer-take5 Library. Copyright &copy; 1999-2006 Igor Russkih.<br>
Generated at Fri Nov 24 17:13:12 2006 by doxygen 1.4.6.
</small><center>
    </BODY>
  </HTML>