ruby-vpi 11.1.1 → 12.0.0

data/bin/generate_test.rb

@@ -5,13 +5,12 @@
 #
 # = Progress indicators
 # module:: A Verilog module has been identified.
-# backup:: A backup copy of a file is being made.
 # create:: A file is being created because it does not exist.
 # skip:: A file is being skipped because it is already up to date.
-# update:: A file will be updated because it is out of date. A backup copy will be made before the file is updated. Use a text merging tool (see MERGER) or manually transfer any necessary information from the backup copy to the updated file.
+# update:: 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.
 #
 # = Environment variables
-# MERGER:: A command that invokes a text merging tool with two arguments: (1) old file, (2) new file. The tool's output should be written to the new file.
+# MERGER:: 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.
 
 
 =begin
@@ -53,16 +52,14 @@ def write_file aPath, aContent
     if oldDigest == newDigest
       notify :skip, aPath
     else
-      old, new = "#{aPath}.old", aPath
-
-      notify :backup, old
-      FileUtils.cp aPath, old, :preserve => true
-
       notify :update, aPath
+      cur, old, new = aPath, "#{aPath}.old", "#{aPath}.new"
+
+      FileUtils.cp cur, old, :preserve => true
       File.open(new, 'w') {|f| f << aContent}
 
       if m = ENV['MERGER']
-        system "#{m} #{old.inspect} #{new.inspect}"
+        system "#{m} #{old.inspect} #{new.inspect} #{cur.inspect}"
       end
     end
   else
@@ -91,7 +88,7 @@ class OutputInfo
   VERILOG_EXT = '.v'
   RUNNER_EXT = '.rake'
 
-  SPEC_FORMATS = [:rSpec, :xUnit, :generic]
+  SPEC_FORMATS = [:rSpec, :tSpec, :xUnit, :generic]
 
   attr_reader :verilogBenchName, :verilogBenchPath, :rubyBenchName, :rubyBenchPath, :designName, :designClassName, :designPath, :specName, :specClassName, :specFormat, :specPath, :rubyVpiPath, :runnerName, :runnerPath, :protoName, :protoPath
 
@@ -163,7 +160,7 @@ if File.basename($0) == File.basename(__FILE__)
       exit
     end
 
-    opts.on '--xunit', 'use xUnit specification format' do |val|
+    opts.on '--xunit', '--test-unit', 'use xUnit (Test::Unit) specification format' do |val|
       optSpecFmt = :xUnit if val
     end
 
@@ -171,6 +168,10 @@ if File.basename($0) == File.basename(__FILE__)
       optSpecFmt = :rSpec if val
     end
 
+    opts.on '--tspec', '--test-spec', 'use test/spec specification format' do |val|
+      optSpecFmt = :tSpec if val
+    end
+
     opts.on '-n', '--name NAME', 'insert NAME into the names of generated files' do |val|
       optTestName = val
     end

data/bin/generate_test_tpl/bench.rb

@@ -2,7 +2,3 @@
 
 require 'ruby-vpi'
 RubyVpi.init_bench :<%= aOutputInfo.designClassName %>, :<%= aOutputInfo.specFormat %>
-<% if aOutputInfo.specFormat == :generic %>
-
-<%= aOutputInfo.specClassName + '.new' %>
-<% end %>

data/bin/generate_test_tpl/bench.v

@@ -30,16 +30,13 @@ module <%= aOutputInfo.verilogBenchName %>;
 
   // connect to the Ruby side of this bench
     initial begin
-      <%= clockSignal %> = 0;
-      $ruby_init("ruby", "-w", "-rubygems", <%= aOutputInfo.rubyBenchPath.inspect %>);
+      $ruby_init("ruby", "-rubygems", <%= aOutputInfo.rubyBenchPath.inspect %>);
     end
 
     always begin
-      #5 <%= clockSignal %> = ~<%= clockSignal %>;
-    end
-
-    always @(posedge <%= clockSignal %>) begin
+      #1 <%= clockSignal %> = 0;
       #1 $ruby_relay;
+      #1 <%= clockSignal %> = 1;
     end
 
 endmodule

data/bin/generate_test_tpl/runner.rake

@@ -1,21 +1,27 @@
 # This file runs the test.
 
-# These are source files that are to be compiled.
+# These are Verilog source files that need to be loaded
+# by the simulator before they can be simulated.
 SIMULATOR_SOURCES = [
   '<%= aModuleInfo.name %>.v',
   '<%= aOutputInfo.verilogBenchPath %>',
 ]
 
 # These are paths to directories which contain the
-# sources listed above, their dependencies, or both.
+# sources listed above, the files they `include, or both.
 SIMULATOR_INCLUDES = []
 
 # This specifies the "top module" that is to be simulated.
 SIMULATOR_TARGET = '<%= aOutputInfo.verilogBenchName %>'
 
 # These are command-line arguments for the simulator.
-# They can be specified as a string or an array of strings.
-SIMULATOR_ARGS = {
+# They can be specified as a string or an array of strings:
+#
+#   :cver => "this is one single argument",
+#   :cver => ['these', 'are', 'separate', 'arguments'],
+#   :cver => %w[these are also separate arguments],
+#
+SIMULATOR_ARGUMENTS = {
   # GPL Cver
   :cver => '',
 
@@ -29,4 +35,14 @@ SIMULATOR_ARGS = {
   :vsim => '',
 }
 
+# This task is invoked _before_ the simulator runs.
+# It can be used to make preprations, such as converting
+# Verilog header files into Ruby, for the simulation.
+task :setup do
+  # To learn how to write Rake tasks, please see:
+  # http://docs.rubyrake.org/read/chapter/4#page16
+end
+
+# This command loads the Ruby-VPI runner template, which
+# runs the simulator according to the information above.
 require 'ruby-vpi/runner'

data/bin/generate_test_tpl/spec.rb

@@ -11,13 +11,14 @@ class <%= aOutputInfo.specClassName %> < Test::Unit::TestCase
 <% aModuleInfo.ports.each do |port| %>
 
   def test_<%= port.name %>
+    # assert <%= aOutputInfo.designClassName %>.<%= port.name %> ..., "<%= port.name %> should ..."
   end
 <% end %>
 end
 <%
-   when :rSpec
+   when :rSpec, :tSpec
 %>
-context "A new <%= aOutputInfo.designClassName %>" do
+context "A resetted <%= aOutputInfo.designClassName %>" do
   setup do
     <%= aOutputInfo.designClassName %>.reset!
   end
@@ -29,11 +30,8 @@ end
 <%
   else
 %>
-class <%= aOutputInfo.specClassName %>
-  def initialize
-    <%= aOutputInfo.designClassName %>.reset!
-  end
-end
+<%= aOutputInfo.designClassName %>.reset!
+# raise "should ..." unless <%= aOutputInfo.designClassName %> ...
 <%
   end
 %>

data/doc/common.css

@@ -2,141 +2,156 @@ body {
   font-family: sans-serif;
   line-height: 2em;
 
-  margin-left: 30%;
-  margin-right: 10%;
+  margin-left: 275px;
+  margin-right: 50px;
   margin-bottom: 5em;
+  max-width: 600px;
 }
 
+
 /* headings */
-  th, h1, h2, h3, h4, h5, h6, .title {
-    font-family: serif;
-  }
 
-  h1, h2, h3, h4, h5, h6 {
-    margin-top: 5em;
-    padding: 0.5em;
-  }
+th, h1, h2, h3, h4, h5, h6, .title {
+  font-family: serif;
+}
 
-  h1, h2, h3 {
-    text-align: center;
-  }
+h1, h2, h3, h4, h5, h6 {
+  margin-top: 5em;
+  padding: 0.5em;
+}
 
-  h1 {
-    padding: 1em;
-    background-color: mistyrose;
-  }
+h1, h2, h3 {
+  text-align: center;
+}
 
-  h2 {
-    background-color: bisque;
-  }
+h1 {
+  padding: 1em;
+  background-color: mistyrose;
+}
+
+h2 {
+  background-color: bisque;
+}
+
+h3 {
+  background-color: oldlace;
+}
 
-  h3 {
-    background-color: oldlace;
-  }
 
 /* table of contents */
 
-  #navigation {
-    position: fixed;
-    left: 0px;
-    top: 0px;
-    bottom: 0px;
+#navigation {
+  position: fixed;
+  left: 0px;
+  top: 0px;
+  bottom: 0px;
 
-    width: 20%;
-    padding: 1em;
-    overflow: auto;
+  max-width: 200px;
+  padding: 1em;
+  overflow: auto;
 
-    background-color: white;
-  }
+  background-color: white;
+}
 
-  #navigation li {
-    margin-left: -1em;
-  }
+#navigation h1, #navigation h2, #navigation h3, #navigation h4, #navigation h5, #navigation h6 {
+  font-size: smaller;
+}
+
+#navigation li {
+  margin-left: -1.25em;
+}
 
-  #navigation h1 {
-    padding: 0.5em;
-    margin-top: 0px;
-  }
 
 /* admonitions */
-  .admonition {
-    border: thin solid steelblue;
-    background-color: aliceblue;
-    padding: 1em;
-  }
 
-  .admonition img {
-    margin-right: 2em;
-  }
+.admonition {
+  border: thin solid steelblue;
+  background-color: aliceblue;
+  padding: 1em;
+  padding-top: 0px;
+}
+
+.admonition img {
+  margin-right: 2em;
+}
+
 
 /* source code */
-  tt {
-    font-weight: bold;
-    background-color: lemonchiffon;
-  }
 
-  pre, blockquote .code {
-    padding: 1em;
-    line-height: normal;
-    overflow: auto;
-    display: block;
-  }
+tt {
+  font-weight: bold;
+  background-color: lemonchiffon;
+}
 
-  pre {
-    border: thin solid darkgray;
-    background-color: whitesmoke;
-  }
+pre, blockquote .code {
+  padding: 1em;
+  line-height: normal;
+  overflow: auto;
+  display: block;
+}
 
-  .code {
-    border: thin solid darkkhaki;
-    background-color: ivory;
-  }
+pre {
+  border: thin solid darkgray;
+  background-color: whitesmoke;
+}
+
+.code {
+  border: thin solid darkkhaki;
+  background-color: ivory;
+}
 
 
 /* tables */
-  th, td {
-    padding: 1em;
-    border: thin solid silver;
-  }
 
-  th {
-    background-color: whitesmoke;
-  }
+th, td {
+  padding: 1em;
+  border: thin solid silver;
+}
+
+th {
+  background-color: whitesmoke;
+}
+
 
 /* formal blocks; see http://www.sagehill.net/docbookxsl/FormalTitles.html */
-  .formal {
-    margin: 1em;
-  }
 
-  .title {
-    display: block;
-    font-size: large;
-  }
+.formal {
+  margin: 1em;
+}
 
-  .formal .title {
-    text-align: center
-  }
+.title {
+  display: block;
+  font-size: large;
+}
 
-  /* center-align any tables and images */
-    .formal table, .formal img, #navigation img {
-      margin-left: auto;
-      margin-right: auto;
-    }
+.formal .title {
+  text-align: center
+}
 
-    .formal img, #navigation img {
-      display: block;
-    }
 
-/* misc. */
-  .cover-page {
-    text-align: center;
+  /* center-align any tables and images */
+
+  .formal table, .formal img, #navigation img {
+    margin-left: auto;
+    margin-right: auto;
   }
 
-  a img {
-    border: none;
+  .formal img, #navigation img {
+    display: block;
   }
 
 
+/* misc. */
+
+.cover-page {
+  text-align: center;
+}
+
+a img {
+  border: none;
+}
+
+
   /* extra spacing before big block elements */
 
   .admonition, .figure {

data/doc/common.tpl

@@ -16,7 +16,7 @@
     <title><%= page_title %></title>
   </head>
   <body>
-<% if table_of_contents %>
+  <% if table_of_contents %>
     <div id="navigation">
       <%= %{"!images/home.png(project home)!":readme.html}.redcloth %>
 
@@ -26,24 +26,23 @@
           %{#{'*' * h.depth} "#{h.title}":##{h.anchor}}
         end.join("\n").redcloth
       %>
-<%
-    @blocks.keys.sort_by {|k| k.to_s}.each do |type|
-      list = @blocks[type]
 
-      unless list.empty?
-%>
-      <h2><%= type.to_s.capitalize %>s</h2>
-<%=
-      list.inject('') do |memo, block|
-        memo << "# #{(block.title || block.anchor).inspect}:##{block.anchor}\n"
-      end.redcloth
-%>
-<%
-    end
-  end
-%>
+      <% DocProxy::CATEGORIES.each_pair do |cat, types| %>
+        <h1><%= cat.to_s.capitalize %>s</h1>
+
+        <% types.each do |type| list = @blocks[type] %>
+          <% unless list.empty? %>
+            <h2><%= type.to_s.capitalize %>s</h2>
+            <%=
+              list.inject('') do |memo, block|
+                memo << "# #{(block.title || block.anchor).inspect}:##{block.anchor}\n"
+              end.redcloth
+            %>
+          <% end %>
+        <% end %>
+      <% end %>
     </div>
-<% end %>
+  <% end %>
     <%= content.to_html %>
   </body>
 </html>