<!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.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>
<h1>/net/fileserver/nas/home/mdh/vrq/src/cbackend.h</h1><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
<a name="l00172"></a><a class="code" href="classCElement.html">00172</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="l00173"></a>00173 {
<a name="l00174"></a>00174 <span class="keyword">private</span>:
<a name="l00175"></a>00175 <span class="keywordtype">string</span> filename; <span class="comment">// Optional filename for compilation unit</span>
<a name="l00176"></a>00176 <span class="keywordtype">int</span> filenameValid; <span class="comment">// non-zero to indicate filename is valid</span>
<a name="l00177"></a>00177 <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="l00178"></a>00178 <span class="keyword">public</span>:
<a name="l00185"></a><a class="code" href="classCElement.html#72b39e0414701c31504ce3cac3257a9a">00185</a> <a class="code" href="classCElement.html#72b39e0414701c31504ce3cac3257a9a" title="Constructor for class.">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="l00186"></a>00186 filename(filename),
<a name="l00187"></a>00187 filenameValid( filenameValid ),
<a name="l00188"></a>00188 code(code ) {}
<a name="l00194"></a><a class="code" href="classCElement.html#707858c878c795d4765c05ea85be889a">00194</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classCElement.html#707858c878c795d4765c05ea85be889a" title="Access method for filename tagging this compilation unit.">Filename</a>() { <span class="keywordflow">return</span> filenameValid ? filename.c_str() : NULL; }
<a name="l00199"></a><a class="code" href="classCElement.html#28e41925988db561f13b6ae33df4e834">00199</a> <a class="code" href="classCNode.html" title="Primary data structure representing parse tree nodes.">CNode</a>* <a class="code" href="classCElement.html#28e41925988db561f13b6ae33df4e834" title="Access method for parse tree for this compilation unit.">Code</a>() { <span class="keywordflow">return</span> code; }
<a name="l00204"></a><a class="code" href="classCElement.html#0c2cc8f6b88c30aa6ebcdd1685c7b45a">00204</a> <span class="keywordtype">void</span> <a class="code" href="classCElement.html#28e41925988db561f13b6ae33df4e834" title="Access method for 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="l00205"></a>00205 };
<a name="l00206"></a>00206
<a name="l00210"></a><a class="code" href="classCBackendException.html">00210</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="l00215"></a><a class="code" href="classCBackendAbort.html">00215</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="l00220"></a><a class="code" href="classCBackendExit.html">00220</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="l00225"></a><a class="code" href="classCBackendFail.html">00225</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="l00226"></a>00226
<a name="l00243"></a><a class="code" href="classCBackend.html">00243</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="l00244"></a>00244 {
<a name="l00245"></a>00245 <span class="keyword">protected</span>:
<a name="l00246"></a><a class="code" href="classCBackend.html#8b744fe29b1fb0a6bc4645238652c90c">00246</a> list<string> <a class="code" href="classCBackend.html#8b744fe29b1fb0a6bc4645238652c90c">switches</a>;
<a name="l00247"></a><a class="code" href="classCBackend.html#d72312994d56d43bdf34cf2ef63fab98">00247</a> map<string,string> <a class="code" href="classCBackend.html#d72312994d56d43bdf34cf2ef63fab98" title="list of plugin command line switches">switchDescription</a>;
<a name="l00248"></a>00248 <span class="keyword">public</span>:
<a name="l00253"></a>00253 <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classCBackend.html#0de276c9fc23c4abe52c7407c8aee8ab" title="map of switch to its description">GetToolName</a>( <span class="keywordtype">void</span> ) = 0;
<a name="l00258"></a>00258 <span class="keyword">virtual</span> <span class="keywordtype">char</span>* <a class="code" href="classCBackend.html#157dec831229604dc32a64a7332959b2" title="Access method for tool description use in vrq help.">GetToolDescription</a>( <span class="keywordtype">void</span> ) = 0;
<a name="l00265"></a><a class="code" href="classCBackend.html#36b29adef17eda48d42a661665d2c851">00265</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#36b29adef17eda48d42a661665d2c851" title="Override this method if the plugin accepts arbitrary plusargs: ie +argName[=argValue]...">AcceptAllPlusArgs</a>( <span class="keywordtype">void</span> ) { <span class="keywordflow">return</span> FALSE; }
<a name="l00271"></a><a class="code" href="classCBackend.html#8cac4846905cfecbbd5a87af8030923b">00271</a> <span class="keyword">virtual</span> list<string>& <a class="code" href="classCBackend.html#8cac4846905cfecbbd5a87af8030923b" title="Access method for list of switches.">GetSwitches</a>( <span class="keywordtype">void</span> ) {<span class="keywordflow">return</span> <a class="code" href="classCBackend.html#8b744fe29b1fb0a6bc4645238652c90c">switches</a>;}
<a name="l00278"></a><a class="code" href="classCBackend.html#20f866dfe69bd1d73ba4f919dd5e7290">00278</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classCBackend.html#20f866dfe69bd1d73ba4f919dd5e7290" title="Method to get the help text for a switch using the switch name as a key.">GetSwitchDescription</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* sw )
<a name="l00279"></a>00279 {
<a name="l00280"></a>00280 <a class="code" href="group__utilities.html#g6dbd4cb0f492800d40e2cad42a0ea250" title="Add invariant checks to code.">MASSERT</a>( <a class="code" href="classCBackend.html#d72312994d56d43bdf34cf2ef63fab98" title="list of plugin command line switches">switchDescription</a>.find(sw) !=
<a name="l00281"></a>00281 <a class="code" href="classCBackend.html#d72312994d56d43bdf34cf2ef63fab98" title="list of plugin command line switches">switchDescription</a>.end() );
<a name="l00282"></a>00282 <span class="keywordflow">return</span> <a class="code" href="classCBackend.html#d72312994d56d43bdf34cf2ef63fab98" title="list of plugin command line switches">switchDescription</a>[sw].c_str();
<a name="l00283"></a>00283 }
<a name="l00290"></a><a class="code" href="classCBackend.html#d24fdef8ec7199099f594d45b8ff1738">00290</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCBackend.html#d24fdef8ec7199099f594d45b8ff1738" title="Method shortcut to register tool switches with vrq&#39;s help system.">RegisterSwitch</a>( <span class="keyword">const</span> <span class="keywordtype">char</span>* switchName,
<a name="l00291"></a>00291 <span class="keyword">const</span> <span class="keywordtype">char</span>* description )
<a name="l00292"></a>00292 {
<a name="l00293"></a>00293 <a class="code" href="classCBackend.html#8b744fe29b1fb0a6bc4645238652c90c">switches</a>.push_back( switchName );
<a name="l00294"></a>00294 <a class="code" href="classCBackend.html#d72312994d56d43bdf34cf2ef63fab98" title="list of plugin command line switches">switchDescription</a>[switchName] = description;
<a name="l00295"></a>00295 }
<a name="l00302"></a>00302 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#3b5802632eccaab19f8c9b691de06b84" title="Method to control if plugin requires all module definitions to be searched for and...">ResolveModules</a>() = 0;
<a name="l00310"></a>00310 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#f82919cc5d2da30361078cc13bf71ec9" title="Method to control the resolution of individual module instances.">ResolveInstance</a>( <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="l00319"></a><a class="code" href="classCBackend.html#093309b720b69958c993de14eb040803">00319</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#093309b720b69958c993de14eb040803" title="Method to control if plugin should be hidden, in this case it will not appear in...">HideTool</a>() { <span class="keywordflow">return</span> FALSE; }
<a name="l00330"></a><a class="code" href="classCBackend.html#fade5208bdd60c6f381244d3a65fd44f">00330</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classCBackend.html#fade5208bdd60c6f381244d3a65fd44f" title="Method to control how parser handles vrq comment based pragmas: ie // vrq translate_on/off...">IgnoreVrqComments</a>() { <span class="keywordflow">return</span> FALSE; }
<a name="l00335"></a>00335 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCBackend.html#5fb7f8ac17c408e80eb7221d99fa4bdd" title="Method to initialize the plugin.">Activate</a>() = 0;
<a name="l00348"></a>00348 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCBackend.html#2562e4cfcc84c34f01db9372cbf86d6f" title="Method to implement plugin function.">Process</a>( list<CElement>& inputList,
<a name="l00349"></a>00349 list<CElement>& outputList ) = 0;
<a name="l00350"></a>00350 };
<a name="l00351"></a>00351
<a name="l00352"></a>00352 <span class="preprocessor">#endif // CBACKEND_HPP</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Oct 21 18:05:32 2009 for vrq by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
ffa1e6f5ad04360808fe8840fe3ba036
>
files
>
60
