<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>vrq: /net/fileserver/nas/home/mdh/vrq/src/cbackend.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<table border="0" cellspacing="0" cellpadding="0" width="100%">
<tr>
<td width="180"><a href="index.html"><img src="vrq.png" width="150" height="100" border="0" alt="vrq"></a></td>
<td background="top_bg.png" align="right" width="100%">
<img src="glyth.png" width="500" height="100" border="0" alt="">
</td>
</tr>
<tr>
<td background="#FFFFFF" align="right" width="50" height="4"></td>
</tr>
</table>
</head><body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>/net/fileserver/nas/home/mdh/vrq/src/cbackend.h</h1> </div>
</div>
<div class="contents">
<a href="cbackend_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) 1997-2007, Mark Hummel</span>
<a name="l00003"></a>00003 <span class="comment"> * This file is part of Vrq.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * Vrq is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> * modify it under the terms of the GNU General Public</span>
<a name="l00007"></a>00007 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> * version 2 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Vrq is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> * General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU General Public</span>
<a name="l00016"></a>00016 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, </span>
<a name="l00018"></a>00018 <span class="comment"> * Boston, MA 02110-1301 USA</span>
<a name="l00019"></a>00019 <span class="comment"> *****************************************************************************</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="comment">/******************************************************************************</span>
<a name="l00022"></a>00022 <span class="comment"> *</span>
<a name="l00023"></a>00023 <span class="comment"> *</span>
<a name="l00024"></a>00024 <span class="comment"> * cbackend.hpp</span>
<a name="l00025"></a>00025 <span class="comment"> * - abstract class definition for code generators </span>
<a name="l00026"></a>00026 <span class="comment"> *</span>
<a name="l00027"></a>00027 <span class="comment"> ******************************************************************************</span>
<a name="l00028"></a>00028 <span class="comment"> */</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef CBACKEND_HPP</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define CBACKEND_HPP</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <stdio.h></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="glue_8h.html">glue.h</a>"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include <list></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <map></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <string></span>
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">using namespace </span>std;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keyword">class </span><a class="code" href="classCNode.html" title="Primary data structure representing parse tree nodes.">CNode</a>;
<a name="l00042"></a>00042 <span class="keyword">class </span><a class="code" href="classCModule.html">CModule</a>;
<a name="l00043"></a>00043 <span class="keyword">class </span><a class="code" href="classCInstance.html" title="Declaration object for module and gate instances.">CInstance</a>;
<a name="l00044"></a>00044 <span class="keyword">class </span><a class="code" href="classCObstack.html" title="Bulk object allocation object.">CObstack</a>;
<a name="l00045"></a>00045
<a name="l00178"></a><a class="code" href="classCElement.html">00178</a> <span class="keyword">class </span><a class="code" href="classCElement.html" title="An element of compilation passed to and from plugins.">CElement</a>
<a name="l00179"></a>00179 {
<a name="l00180"></a>00180 <span class="keyword">private</span>:
<a name="l00181"></a>00181 <span class="keywordtype">string</span> filename; <span class="comment">// Optional filename for compilation unit</span>
<a name="l00182"></a>00182 <span class="keywordtype">int</span> filenameValid; <span class="comment">// non-zero to indicate filename is valid</span>
<a name="l00183"></a>00183 <a class="code" href="classCNode.html" title="Primary data structure representing parse tree nodes.">CNode</a>* code; <span class="comment">// parse tree pointer for compilation unit</span>
<a name="l00184"></a>00184 <span class="keyword">public</span>:
<a name="l00191"></a><a class="code" href="classCElement.html#a72b39e0414701c31504ce3cac3257a9a">00191</a> <a class="code" href="classCElement.html" title="An element of compilation passed to and from plugins.">CElement</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* filename, <span class="keywordtype">int</span> filenameValid, <a class="code" href="classCNode.html" title="Primary data structure representing parse tree nodes.">CNode</a>* code ) :
<a name="l00192"></a>00192 filename(filename),
<a name="l00193"></a>00193 filenameValid( filenameValid ),
<a name="l00194"></a>00194 code(code ) {}
<a name="l00200"></a><a class="code" href="classCElement.html#a707858c878c795d4765c05ea85be889a">00200</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classCElement.html#a707858c878c795d4765c05ea85be889a" title="Access method for filename tagging this compilation unit.">Filename</a>() { <span class="keywordflow">return</span> filenameValid ? filename.c_str() : NULL; }
<a name="l00205"></a><a class="code" href="classCElement.html#a28e41925988db561f13b6ae33df4e834">00205</a> <a class="code" href="classCNode.html" title="Primary data structure representing parse tree nodes.">CNode</a>* <a class="code" href="classCElement.html#a28e41925988db561f13b6ae33df4e834" title="Access method for parse tree for this compilation unit.">Code</a>() { <span class="keywordflow">return</span> code; }
<a name="l00210"></a><a class="code" href="classCElement.html#a0c2cc8f6b88c30aa6ebcdd1685c7b45a">00210</a> <span class="keywordtype">void</span> <a class="code" href="classCElement.html#a0c2cc8f6b88c30aa6ebcdd1685c7b45a" title="Method to set parse tree for this compilation unit.">Code</a>( <a class="code" href="classCNode.html" title="Primary data structure representing parse tree nodes.">CNode</a>* code ) { this->code = code; }
<a name="l00211"></a>00211 };
<a name="l00212"></a>00212
<a name="l00216"></a><a class="code" href="classCBackendException.html">00216</a> <span class="keyword">class </span><a class="code" href="classCBackendException.html" title="Base class for exceptions that can be thrown by backend plugins.">CBackendException</a> {};
<a name="l00221"></a><a class="code" href="classCBackendAbort.html">00221</a> <span class="keyword">class </span><a class="code" href="classCBackendAbort.html" title="Exception thrown by CBackend::Process when plugin aborts due to an internal error.">CBackendAbort</a> : <a class="code" href="classCBackendException.html" title="Base class for exceptions that can be thrown by backend plugins.">CBackendException</a> {};
<a name="l00226"></a><a class="code" href="classCBackendExit.html">00226</a> <span class="keyword">class </span><a class="code" href="classCBackendExit.html" title="Exception thrown by CBackend::Process when plugin terminates early without an error.">CBackendExit</a> : <a class="code" href="classCBackendException.html" title="Base class for exceptions that can be thrown by backend plugins.">CBackendException</a> {};
<a name="l00231"></a><a class="code" href="classCBackendFail.html">00231</a> <span class="keyword">class </span><a class="code" href="classCBackendFail.html" title="Exception thrown by CBackend::Process when plugin terminates early with an error.">CBackendFail</a> : <a class="code" href="classCBackendException.html" title="Base class for exceptions that can be thrown by backend plugins.">CBackendException</a> {};
<a name="l00232"></a>00232
<a name="l00249"></a><a class="code" href="classCBackend.html">00249</a> <span class="keyword">class </span><a class="code" href="classCBackend.html" title="This is the abstract class to overload to create new backend tools.">CBackend</a>
<a name="l00250"></a>00250 {
<a name="l00251"></a>00251 <span class="keyword">protected</span>:
<a name="l00252"></a><a class="code" href="classCBackend.html#a8b744fe29b1fb0a6bc4645238652c90c">00252</a> list<string> switches;
<a name="l00253"></a><a class="code" href="classCBackend.html#ad72312994d56d43bdf34cf2ef63fab98">00253</a> map<string,string> switchDescription;
<a name="l00254"></a>00254 <span class="keyword">public</span>:
<a name="l00259"></a>00259 <span class="keyword">virtual</span> <span class="keywordtype">char</span>* GetToolName( <span class="keywordtype">void</span> ) = 0;
<a name="l00264"></a>00264 <span class="keyword">virtual</span> <span class="keywordtype">char</span>* GetToolDescription( <span class="keywordtype">void</span> ) = 0;
<a name="l00271"></a><a class="code" href="classCBackend.html#a36b29adef17eda48d42a661665d2c851">00271</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#a36b29adef17eda48d42a661665d2c851" title="Override this method if the plugin accepts arbitrary plusargs: ie +argName[=argValue] or +argName[+ar...">AcceptAllPlusArgs</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> FALSE; }
<a name="l00277"></a><a class="code" href="classCBackend.html#a8cac4846905cfecbbd5a87af8030923b">00277</a> <span class="keyword">virtual</span> list<string>& <a class="code" href="classCBackend.html#a8cac4846905cfecbbd5a87af8030923b" title="Access method for list of switches.">GetSwitches</a>( <span class="keywordtype">void</span> ) {<span class="keywordflow">return</span> switches;}
<a name="l00284"></a><a class="code" href="classCBackend.html#a20f866dfe69bd1d73ba4f919dd5e7290">00284</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetSwitchDescription( <span class="keyword">const</span> <span class="keywordtype">char</span>* sw )
<a name="l00285"></a>00285 {
<a name="l00286"></a>00286 MASSERT( switchDescription.find(sw) !=
<a name="l00287"></a>00287 switchDescription.end() );
<a name="l00288"></a>00288 <span class="keywordflow">return</span> switchDescription[sw].c_str();
<a name="l00289"></a>00289 }
<a name="l00296"></a><a class="code" href="classCBackend.html#ad24fdef8ec7199099f594d45b8ff1738">00296</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> RegisterSwitch( <span class="keyword">const</span> <span class="keywordtype">char</span>* switchName,
<a name="l00297"></a>00297 <span class="keyword">const</span> <span class="keywordtype">char</span>* description )
<a name="l00298"></a>00298 {
<a name="l00299"></a>00299 switches.push_back( switchName );
<a name="l00300"></a>00300 switchDescription[switchName] = description;
<a name="l00301"></a>00301 }
<a name="l00308"></a><a class="code" href="classCBackend.html#af3dede7025f3d6647a93529242e06709">00308</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#af3dede7025f3d6647a93529242e06709" title="Method to control if plugin requires all module definitions to be resolved.">RequireModuleResolution</a>() { <span class="keywordflow">return</span> TRUE; }
<a name="l00315"></a>00315 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ResolveModules() = 0;
<a name="l00323"></a>00323 <span class="keyword">virtual</span> <span class="keywordtype">int</span> ResolveInstance( <a class="code" href="classCModule.html">CModule</a>* module, <a class="code" href="classCInstance.html" title="Declaration object for module and gate instances.">CInstance</a>* inst ) = 0;
<a name="l00332"></a><a class="code" href="classCBackend.html#a093309b720b69958c993de14eb040803">00332</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#a093309b720b69958c993de14eb040803" title="Method to control if plugin should be hidden, in this case it will not appear in the help but will it...">HideTool</a>() { <span class="keywordflow">return</span> FALSE; }
<a name="l00343"></a><a class="code" href="classCBackend.html#afade5208bdd60c6f381244d3a65fd44f">00343</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#afade5208bdd60c6f381244d3a65fd44f" title="Method to control how parser handles vrq comment based pragmas: ie // vrq translate_on/off Note: the ...">IgnoreVrqComments</a>() { <span class="keywordflow">return</span> FALSE; }
<a name="l00348"></a>00348 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Activate() = 0;
<a name="l00361"></a>00361 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Process( list<CElement>& inputList,
<a name="l00362"></a>00362 list<CElement>& outputList ) = 0;
<a name="l00363"></a>00363 };
<a name="l00364"></a>00364
<a name="l00365"></a>00365 <span class="preprocessor">#endif // CBACKEND_HPP</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
ffa1e6f5ad04360808fe8840fe3ba036
>
files
>
62
