<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Ruby-VPI: common.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>common.h File Reference</h1>Things common to all Ruby-VPI code. <a href="#_details">More...</a>
<p>
<code>#include <stddef.h></code><br>
<code>#include "<a class="el" href="verilog_8h.html">verilog.h</a>"</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#a2ee406785247606fd3daddbed14cbaf">common_printf</a>(...) vpi_printf("Ruby-VPI: "); vpi_printf(__VA_ARGS__); vpi_printf("\n");</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line. <a href="#a2ee406785247606fd3daddbed14cbaf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#b893acfcde84304686f3726f7949a84a">common_debug</a>(...)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A wrapper for <a class="el" href="common_8h.html#a2ee406785247606fd3daddbed14cbaf" title="A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI...">common_printf()</a> which marks the given message as being debugging output. <a href="#b893acfcde84304686f3726f7949a84a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#f30d3fc89fbb3ed2aab2f5904ab76815">common_boolToStr</a>(aBoolExpr) ( (aBoolExpr) ? "true" : "false" )</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the string "true" if the given boolean expression is true. <a href="#f30d3fc89fbb3ed2aab2f5904ab76815"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">bool</a> { <a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c">false</a> = 0,
<a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b">true</a> = 1
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A boolean variable with two possible values: true and false. <a href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Things common to all Ruby-VPI code.
<p>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="f30d3fc89fbb3ed2aab2f5904ab76815"></a><!-- doxytag: member="common.h::common_boolToStr" ref="f30d3fc89fbb3ed2aab2f5904ab76815" args="(aBoolExpr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define common_boolToStr </td>
<td>(</td>
<td class="paramtype">aBoolExpr </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> ( (aBoolExpr) ? "true" : "false" )</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the string "true" if the given boolean expression is true.
<p>
Otherwise returns the string "false".
</div>
</div><p>
<a class="anchor" name="b893acfcde84304686f3726f7949a84a"></a><!-- doxytag: member="common.h::common_debug" ref="b893acfcde84304686f3726f7949a84a" args="(...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define common_debug </td>
<td>(</td>
<td class="paramtype"> <em>...</em> </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A wrapper for <a class="el" href="common_8h.html#a2ee406785247606fd3daddbed14cbaf" title="A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI...">common_printf()</a> which marks the given message as being debugging output.
<p>
</div>
</div><p>
<a class="anchor" name="a2ee406785247606fd3daddbed14cbaf"></a><!-- doxytag: member="common.h::common_printf" ref="a2ee406785247606fd3daddbed14cbaf" args="(...)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define common_printf </td>
<td>(</td>
<td class="paramtype"> <em>...</em> </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> vpi_printf("Ruby-VPI: "); vpi_printf(__VA_ARGS__); vpi_printf("\n");</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A wrapper for vpi_printf() which marks the given message as being emitted from Ruby-VPI and ends the message with a new line.
<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>...</em> </td><td>Arguments to vpi_printf() </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="f6a258d8f3ee5206d682d799316314b1"></a><!-- doxytag: member="common.h::bool" ref="f6a258d8f3ee5206d682d799316314b1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="common_8h.html#f6a258d8f3ee5206d682d799316314b1">bool</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A boolean variable with two possible values: true and false.
<p>
Pass aroung this value instead of zero and non-zero integers. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c"></a><!-- doxytag: member="false" ref="f6a258d8f3ee5206d682d799316314b1e9de385ef6fe9bf3360d1038396b884c" args="" -->false</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b"></a><!-- doxytag: member="true" ref="f6a258d8f3ee5206d682d799316314b108f175a5505a10b9ed657defeb050e4b" args="" -->true</em> </td><td>
</td></tr>
</table>
</dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jan 27 22:47:05 2008 for Ruby-VPI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>