<!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: Utility Routines</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><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>Utility Routines</h1> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#ga7b78ea35c9ff6a9aba4f580e038a7ba9">s2d</a> (char *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert char string to double. <a href="#ga7b78ea35c9ff6a9aba4f580e038a7ba9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#gadba73693074d75c740c6a68704ba71f0">d2s</a> (double d, <a class="el" href="classCObstack.html">CObstack</a> *heap)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert double to char string allocating storage on given heap. <a href="#gadba73693074d75c740c6a68704ba71f0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#gac536009e2095d02e437a6a2e725712a1">Identifier</a> (const char *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert a string representing an identifier to an escaped format for printing (if needed). <a href="#gac536009e2095d02e437a6a2e725712a1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#gaa9ed8216919d080497f1e3c4570707b0">VrqVersionString</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Plugins should not be using these. <a href="#gaa9ed8216919d080497f1e3c4570707b0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#ga44a3623c32bee4f118f4b2261dd051c8">GetPlusArg</a> (const char *prefix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get plusarg from command line that matches prefix. <a href="#ga44a3623c32bee4f118f4b2261dd051c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#gad170580563c106d0fba0b3b28605e482">GetPlusArgs</a> (const char *prefix, list< string > &args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get list of plusargs from command line that matche prefix. <a href="#gad170580563c106d0fba0b3b28605e482"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#gadd971894b9b512d4f47ad1db77a39b36">GetPluginPaths</a> (list< string > &paths)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get list of paths to where plugins may reside. <a href="#gadd971894b9b512d4f47ad1db77a39b36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMessage.html">Message</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#ga62829349326deaf109d8f7bbebef64c2">Message::RegisterWarning</a> (<a class="el" href="classCBackend.html">CBackend</a> *tool, Action_t defaultAction, const char *abbrev, const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register a warning message. <a href="#ga62829349326deaf109d8f7bbebef64c2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classMessage.html">Message</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#ga8a179fbaddce73f85b0de8e0a1ffec69">Message::RegisterError</a> (<a class="el" href="classCBackend.html">CBackend</a> *tool, const char *abbrev, const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Register an error message. <a href="#ga8a179fbaddce73f85b0de8e0a1ffec69"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#gab707bd2f52fa5d46028aa01c74225b3d">message</a> (struct <a class="el" href="structCoord__t.html">Coord_t</a> *location, <a class="el" href="classMessage.html">Message</a> *message,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print message. <a href="#gab707bd2f52fa5d46028aa01c74225b3d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#gae28b264fc971d8741b94feef009dc63b">vlogprintf</a> (const char *format, va_list args)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print to logfile. <a href="#gae28b264fc971d8741b94feef009dc63b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utilities.html#ga5736e2effe9561d98a4bd804727da6ad">logprintf</a> (const char *format,...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print to logfile. <a href="#ga5736e2effe9561d98a4bd804727da6ad"></a><br/></td></tr>
</table>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gadba73693074d75c740c6a68704ba71f0"></a><!-- doxytag: member="cnode.h::d2s" ref="gadba73693074d75c740c6a68704ba71f0" args="(double d, CObstack *heap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * d2s </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classCObstack.html">CObstack</a> * </td>
<td class="paramname"> <em>heap</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert double to char string allocating storage on given heap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>d</em> </td><td>double to convert. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>heap</em> </td><td>heap to use for allocation. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer to char string. </dd></dl>
</div>
</div>
<a class="anchor" id="gadd971894b9b512d4f47ad1db77a39b36"></a><!-- doxytag: member="main.h::GetPluginPaths" ref="gadd971894b9b512d4f47ad1db77a39b36" args="(list< string > &paths)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GetPluginPaths </td>
<td>(</td>
<td class="paramtype">list< string > & </td>
<td class="paramname"> <em>paths</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get list of paths to where plugins may reside. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>paths</em> </td><td>list of filesystem paths. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga44a3623c32bee4f118f4b2261dd051c8"></a><!-- doxytag: member="main.h::GetPlusArg" ref="ga44a3623c32bee4f118f4b2261dd051c8" args="(const char *prefix)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* GetPlusArg </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get plusarg from command line that matches prefix. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>to search for. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>complete plusarg text. </dd></dl>
</div>
</div>
<a class="anchor" id="gad170580563c106d0fba0b3b28605e482"></a><!-- doxytag: member="main.h::GetPlusArgs" ref="gad170580563c106d0fba0b3b28605e482" args="(const char *prefix, list< string > &args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void GetPlusArgs </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>prefix</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">list< string > & </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get list of plusargs from command line that matche prefix. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>prefix</em> </td><td>to search for. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>list to populate with matching plusargs. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gac536009e2095d02e437a6a2e725712a1"></a><!-- doxytag: member="csymbol.h::Identifier" ref="gac536009e2095d02e437a6a2e725712a1" args="(const char *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* Identifier </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a string representing an identifier to an escaped format for printing (if needed). </p>
<p>Verilog identifier escaping rules are used.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>text to check and convert if needed. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>converted text. Storage for this result may be from a shared static buffer and must be either used or copied immediately. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5736e2effe9561d98a4bd804727da6ad"></a><!-- doxytag: member="glue.h::logprintf" ref="ga5736e2effe9561d98a4bd804727da6ad" args="(const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void logprintf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print to logfile. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>format to use for output. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>additional arguments used by format. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gab707bd2f52fa5d46028aa01c74225b3d"></a><!-- doxytag: member="glue.h::message" ref="gab707bd2f52fa5d46028aa01c74225b3d" args="(struct Coord_t *location, Message *message,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void message </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structCoord__t.html">Coord_t</a> * </td>
<td class="paramname"> <em>location</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMessage.html">Message</a> * </td>
<td class="paramname"> <em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print message. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>location</em> </td><td>file coordinates to use in message. NULL if none. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>message object to use for message format. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>...</em> </td><td>additional arguments used by format. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga8a179fbaddce73f85b0de8e0a1ffec69"></a><!-- doxytag: member="Message::RegisterError" ref="ga8a179fbaddce73f85b0de8e0a1ffec69" args="(CBackend *tool, const char *abbrev, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classMessage.html">Message</a>* Message::RegisterError </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCBackend.html">CBackend</a> * </td>
<td class="paramname"> <em>tool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>abbrev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register an error message. </p>
<p>Policy is set to eERROR and cannot be changed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tool</em> </td><td>backend tool owning message, NULL for unowned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>abbrev</em> </td><td>message abbreviation. Must be unique per tool. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>format string for printing message. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>message object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga62829349326deaf109d8f7bbebef64c2"></a><!-- doxytag: member="Message::RegisterWarning" ref="ga62829349326deaf109d8f7bbebef64c2" args="(CBackend *tool, Action_t defaultAction, const char *abbrev, const char *format,...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classMessage.html">Message</a>* Message::RegisterWarning </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCBackend.html">CBackend</a> * </td>
<td class="paramname"> <em>tool</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classMessage.html#ab32daae480f3ef73a142ab35300820f9">Action_t</a> </td>
<td class="paramname"> <em>defaultAction</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>abbrev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Register a warning message. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>tool</em> </td><td>backend tool owning message, NULL for unowned. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defaultAction</em> </td><td>default message behavior. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>abbrev</em> </td><td>message abbreviation. Must be unique per tool. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>format string for printing message. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>message object. </dd></dl>
</div>
</div>
<a class="anchor" id="ga7b78ea35c9ff6a9aba4f580e038a7ba9"></a><!-- doxytag: member="cnode.h::s2d" ref="ga7b78ea35c9ff6a9aba4f580e038a7ba9" args="(char *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double s2d </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>s</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert char string to double. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>char pointer to string to convert. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>converted real. </dd></dl>
</div>
</div>
<a class="anchor" id="gae28b264fc971d8741b94feef009dc63b"></a><!-- doxytag: member="glue.h::vlogprintf" ref="gae28b264fc971d8741b94feef009dc63b" args="(const char *format, va_list args)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vlogprintf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"> <em>args</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print to logfile. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>format</em> </td><td>format to use for output. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>args</em> </td><td>variable argument list for values. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="gaa9ed8216919d080497f1e3c4570707b0"></a><!-- doxytag: member="main.h::VrqVersionString" ref="gaa9ed8216919d080497f1e3c4570707b0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* VrqVersionString </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Plugins should not be using these. </p>
<p>Get string containing vrq version number.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>char pointer to vrq version number. </dd></dl>
</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
>
392
