RubyGems - ruby-vpi - Versions diffs - 21.0.0 → 21.1.0 - Mend

ruby-vpi 21.0.0 → 21.1.0

Files changed (622) hide show

data/doc/api/ruby/classes/RubyVPI.src/M000027.html ADDED

@@ -0,0 +1,19 @@
+<?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>
+<head>
+  <title>resume (RubyVPI)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 14</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">resume</span> <span class="ruby-identifier">aCallback</span>
+      <span class="ruby-ivar">@@userRun</span>.<span class="ruby-identifier">enq</span> <span class="ruby-identifier">aCallback</span>
+      <span class="ruby-identifier">attach</span>
+    <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/api/ruby/classes/RubyVPI.src/M000028.html CHANGED

@@ -5,15 +5,15 @@
 <html>
 <head>
-  <title>resume (RubyVPI)</title>
+  <title>pause (RubyVPI)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 14</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">resume</span> <span class="ruby-identifier">aCallback</span>
-      <span class="ruby-ivar">@@userRun</span>.<span class="ruby-identifier">enq</span> <span class="ruby-identifier">aCallback</span>
-      <span class="ruby-identifier">attach</span>
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 22</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pause</span>
+      <span class="ruby-identifier">detach</span>
+      <span class="ruby-ivar">@@userRun</span>.<span class="ruby-identifier">deq</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/api/ruby/classes/RubyVPI.src/M000029.html CHANGED

@@ -5,15 +5,14 @@
 <html>
 <head>
-  <title>pause (RubyVPI)</title>
+  <title>detach (RubyVPI)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 22</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pause</span>
-      <span class="ruby-identifier">detach</span>
-      <span class="ruby-ivar">@@userRun</span>.<span class="ruby-identifier">deq</span>
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 30</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">detach</span>
+      <span class="ruby-ivar">@@hostRun</span>.<span class="ruby-identifier">enq</span> <span class="ruby-keyword kw">nil</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/api/ruby/classes/RubyVPI.src/M000030.html CHANGED

@@ -5,14 +5,14 @@
 <html>
 <head>
-  <title>detach (RubyVPI)</title>
+  <title>attach (RubyVPI)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 30</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">detach</span>
-      <span class="ruby-ivar">@@hostRun</span>.<span class="ruby-identifier">enq</span> <span class="ruby-keyword kw">nil</span>
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 37</span>
+    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">attach</span>
+      <span class="ruby-ivar">@@hostRun</span>.<span class="ruby-identifier">deq</span>
     <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/api/ruby/classes/RubyVPI.src/M000031.html CHANGED

@@ -5,14 +5,38 @@
 <html>
 <head>
-  <title>attach (RubyVPI)</title>
+  <title>load_test (RubyVPI)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/boot/relay.rb, line 37</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">attach</span>
-      <span class="ruby-ivar">@@hostRun</span>.<span class="ruby-identifier">deq</span>
-    <span class="ruby-keyword kw">end</span></pre>
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi.rb, line 51</span>
+  <span class="ruby-keyword kw">def</span> <span class="ruby-constant">RubyVPI</span>.<span class="ruby-identifier">load_test</span> <span class="ruby-identifier">aDesignHandleOrPath</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">aTestFilePaths</span>
+    <span class="ruby-comment cmt"># access the design under test</span>
+    <span class="ruby-identifier">design</span> =
+      <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">aDesignHandleOrPath</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">VPI</span><span class="ruby-operator">::</span><span class="ruby-constant">Handle</span>
+        <span class="ruby-identifier">aDesignHandleOrPath</span>
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-constant">VPI</span>.<span class="ruby-identifier">vpi_handle_by_name</span>(<span class="ruby-identifier">aDesignHandleOrPath</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-keyword kw">nil</span>)
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">&quot;cannot access the design under test: #{aDesignHandleOrPath.inspect}&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">design</span>
+    <span class="ruby-comment cmt"># create a sandbox</span>
+    <span class="ruby-identifier">sandbox</span> = <span class="ruby-constant">Module</span>.<span class="ruby-identifier">new</span>
+    <span class="ruby-identifier">sandbox</span>.<span class="ruby-identifier">const_set</span> <span class="ruby-identifier">:DUT</span>, <span class="ruby-identifier">design</span>
+    <span class="ruby-identifier">sandboxBinding</span> = <span class="ruby-identifier">sandbox</span>.<span class="ruby-identifier">module_eval</span>(<span class="ruby-value str">'binding'</span>)
+    <span class="ruby-comment cmt"># load files into sandbox</span>
+    <span class="ruby-identifier">aTestFilePaths</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">uniq</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
+      <span class="ruby-keyword kw">if</span> <span class="ruby-constant">HAVE_RUBY_19X</span>
+        <span class="ruby-identifier">eval</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">sandboxBinding</span>, <span class="ruby-identifier">path</span>
+      <span class="ruby-keyword kw">else</span>
+        <span class="ruby-identifier">sandbox</span>.<span class="ruby-identifier">module_eval</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">path</span>), <span class="ruby-identifier">path</span>
+      <span class="ruby-keyword kw">end</span>
+    <span class="ruby-keyword kw">end</span>
+    <span class="ruby-identifier">sandbox</span>
+  <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/doc/api/ruby/classes/RubyVPI/SIMULATORS.html CHANGED

@@ -76,7 +76,7 @@
       <h3 class="section-bar">Methods</h3>
       <div class="name-list">
-      <a href="#M000033">find_by_id</a>&nbsp;&nbsp;
+      <a href="#M000032">find_by_id</a>&nbsp;&nbsp;
       </div>
     </div>
@@ -98,12 +98,12 @@
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
-      <div id="method-M000033" class="method-detail">
-        <a name="M000033"></a>
+      <div id="method-M000032" class="method-detail">
+        <a name="M000032"></a>
         <div class="method-heading">
-          <a href="SIMULATORS.src/M000033.html" target="Code" class="method-signature"
-            onclick="popupCode('SIMULATORS.src/M000033.html');return false;">
+          <a href="SIMULATORS.src/M000032.html" target="Code" class="method-signature"
+            onclick="popupCode('SIMULATORS.src/M000032.html');return false;">
           <span class="method-name">find_by_id</span><span class="method-args">(aSimId)</span>
           </a>
         </div>

data/doc/api/ruby/classes/RubyVPI/SIMULATORS.src/{M000033.html → M000032.html} RENAMED

File without changes

data/doc/api/ruby/classes/RubyVPI/SchedulerClass/Routine.html ADDED

@@ -0,0 +1,235 @@
+<?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>Class: RubyVPI::SchedulerClass::Routine</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="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">RubyVPI::SchedulerClass::Routine</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/ruby-vpi/core/scheduler_rb.html">
+                lib/ruby-vpi/core/scheduler.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="../../Object.html">
+                Object
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+    <div id="description">
+      <p>
+Represents Verilog&#8216;s &quot;process block&quot; construct (a coroutine
+or concurrent process), which is used as the body of an &quot;initial&quot;
+or &quot;forever&quot; block.
+</p>
+    </div>
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000037">done?</a>&nbsp;&nbsp;
+      <a href="#M000033">new</a>&nbsp;&nbsp;
+      <a href="#M000034">pause</a>&nbsp;&nbsp;
+      <a href="#M000035">pause?</a>&nbsp;&nbsp;
+      <a href="#M000036">resume</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000033" class="method-detail">
+        <a name="M000033"></a>
+        <div class="method-heading">
+          <a href="Routine.src/M000033.html" target="Code" class="method-signature"
+            onclick="popupCode('Routine.src/M000033.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(*aLogicArgs, &amp;aLogicBody)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000037" class="method-detail">
+        <a name="M000037"></a>
+        <div class="method-heading">
+          <a href="Routine.src/M000037.html" target="Code" class="method-signature"
+            onclick="popupCode('Routine.src/M000037.html');return false;">
+          <span class="method-name">done?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if this process block is finished (it cannot be resumed
+anymore).
+</p>
+<p>
+Must be called from <b>outside</b> the logic of this process block.
+</p>
+        </div>
+      </div>
+      <div id="method-M000034" class="method-detail">
+        <a name="M000034"></a>
+        <div class="method-heading">
+          <a href="Routine.src/M000034.html" target="Code" class="method-signature"
+            onclick="popupCode('Routine.src/M000034.html');return false;">
+          <span class="method-name">pause</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Pauses the execution of this process block.
+</p>
+<p>
+Must be called from <b>inside</b> the logic of this process block.
+</p>
+        </div>
+      </div>
+      <div id="method-M000035" class="method-detail">
+        <a name="M000035"></a>
+        <div class="method-heading">
+          <a href="Routine.src/M000035.html" target="Code" class="method-signature"
+            onclick="popupCode('Routine.src/M000035.html');return false;">
+          <span class="method-name">pause?</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Returns true if this process block is currently paused and can thus be
+resumed.
+</p>
+<p>
+Must be called from <b>outside</b> the logic of this process block.
+</p>
+        </div>
+      </div>
+      <div id="method-M000036" class="method-detail">
+        <a name="M000036"></a>
+        <div class="method-heading">
+          <a href="Routine.src/M000036.html" target="Code" class="method-signature"
+            onclick="popupCode('Routine.src/M000036.html');return false;">
+          <span class="method-name">resume</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+          <p>
+Resumes the execution of this process block.
+</p>
+<p>
+Must be called from <b>outside</b> the logic of this process block.
+</p>
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>

data/doc/api/ruby/classes/RubyVPI/SchedulerClass/Routine.src/M000033.html ADDED

@@ -0,0 +1,23 @@
+<?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>
+<head>
+  <title>new (RubyVPI::SchedulerClass::Routine)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/core/scheduler.rb, line 116</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-operator">*</span><span class="ruby-identifier">aLogicArgs</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">aLogicBody</span>
+        <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">block_given?</span>
+        <span class="ruby-ivar">@gen</span> = <span class="ruby-constant">Generator</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-ivar">@ctl</span><span class="ruby-operator">|</span>
+          <span class="ruby-identifier">pause</span> <span class="ruby-comment cmt"># until we are ready to begin</span>
+          <span class="ruby-identifier">aLogicBody</span>.<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">aLogicArgs</span>)
+        <span class="ruby-keyword kw">end</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/api/ruby/classes/RubyVPI/SchedulerClass/Routine.src/M000034.html ADDED

@@ -0,0 +1,18 @@
+<?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>
+<head>
+  <title>pause (RubyVPI::SchedulerClass::Routine)</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/core/scheduler.rb, line 128</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pause</span>
+        <span class="ruby-ivar">@ctl</span>.<span class="ruby-identifier">yield</span> <span class="ruby-keyword kw">nil</span>
+      <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>

data/doc/api/ruby/classes/{VerilogParser/Module/Port.src/M000008.html → RubyVPI/SchedulerClass/Routine.src/M000035.html} RENAMED

@@ -5,14 +5,14 @@
 <html>
 <head>
-  <title>output? (VerilogParser::Module::Port)</title>
+  <title>pause? (RubyVPI::SchedulerClass::Routine)</title>
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
   <link rel="stylesheet" href="../../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/verilog_parser.rb, line 60</span>
-      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">output?</span>
-        <span class="ruby-ivar">@type</span> <span class="ruby-operator">!=</span> <span class="ruby-value str">'input'</span>
+  <pre><span class="ruby-comment cmt"># File lib/ruby-vpi/core/scheduler.rb, line 136</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pause?</span>
+        <span class="ruby-ivar">@gen</span>.<span class="ruby-identifier">next?</span>
       <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>