<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>File: generate.rb</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="fileHeader">
<h1>generate.rb</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>bin/generate.rb
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Sat May 31 12:42:53 -0700 2008</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
Generates test skeletons from Verilog 2001/1995 module declarations.
</p>
<ul>
<li>The standard input stream is read if no input files are specified.
</li>
</ul>
<h1>Progress indicators</h1>
<table>
<tr><td valign="top">module:</td><td>A Verilog module has been identified.
</td></tr>
<tr><td valign="top">create:</td><td>A file is being created because it does not exist.
</td></tr>
<tr><td valign="top">skip:</td><td>A file is being skipped because it is already up to date.
</td></tr>
<tr><td valign="top">update:</td><td>A file will be updated because it is out of date. A text merging tool (see
MERGER) will be launched to transfer content from the old file (*.old) and
the new file (*.new) to the out of date file. If a text merging tool is not
specified, then you will have to do the merging by hand.
</td></tr>
</table>
<h1>Environment variables</h1>
<table>
<tr><td valign="top">MERGER:</td><td>A command that invokes a text merging tool with three arguments: (1) old
file, (2) new file, (3) output file. The tool‘s output should be
written to the output file.
</td></tr>
</table>
</div>
<div id="requires-list">
<h3 class="section-bar">Required files</h3>
<div class="name-list">
ruby-vpi
ruby-vpi/verilog_parser
fileutils
digest/sha1
ruby-vpi/erb
optparse
ruby-vpi/rdoc
</div>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">DESIGN_TEMPLATE</td>
<td>=</td>
<td class="context-item-value">Template.new('design.rb')</td>
<td width="3em"> </td>
<td class="context-item-desc">
obtain templates for output generation
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">PROTO_TEMPLATE</td>
<td>=</td>
<td class="context-item-value">Template.new('proto.rb')</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">SPEC_TEMPLATE</td>
<td>=</td>
<td class="context-item-value">Template.new('spec.rb')</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">RUNNER_TEMPLATE</td>
<td>=</td>
<td class="context-item-value">Template.new('runner.rake')</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">LOADER_TEMPLATE</td>
<td>=</td>
<td class="context-item-value">Template.new('loader.rb')</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>