ruby-vpi 8.2.0 → 9.0.0

data/history.html

@@ -2,37 +2,6 @@
   <link rel="stylesheet" type="text/css" href="style.css" />
 </head>
 
-	<h1 style="text-align: center;">Welcome to Ruby-VPI</h1>
-
-
-	<p>Ruby-VPI is a <a href="http://ruby-lang.org">Ruby interface</a> to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945">Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
-
-
-	<h2>Features</h2>
-
-
-	<ul>
-	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
-	</ul>
-
-
-	<ul>
-	<li>Utilize Ruby&#8217;s power and elegance. (<a href="http://www.ruby-doc.org/whyruby">Why choose Ruby?</a>)
-	<ul>
-	<li>Built-in support for unlimited length integers, regular expressions, networking, multi-threading, system calls, <em>ad infinium</em>!</li>
-		<li>Easy to use; doesn&#8217;t get in your way.</li>
-		<li>Makes programming <em>fun</em> again!</li>
-	</ul></li>
-	</ul>
-
-
-	<ul>
-	<li>Study, modify, or distribute this is free software, released under the <a href="http://www.gnu.org/copyleft/gpl.html"><span class="caps">GNU</span> General Public License</a>, as you see fit.</li>
-	</ul>
-
-
 <div class="variablelist">
 <dl>
 
@@ -144,6 +113,72 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p id="fn1"><sup>1</sup> C. Gross, &#8220;Explaining Open Source Version Numbers&#8221;, [Online document], 2005 Nov 28, [cited 2006 Aug 27], Available <span class="caps">HTTP</span>: <a href="http://ablog.apress.com/?p=738">http://ablog.apress.com/?p=738</a></p>
 
 
+	<h1>Version 9.0.0 (2006-10-28)</h1>
+
+
+	<h2>Summary</h2>
+
+
+	<p>This release improves the automated test generator and adds new content to the user manual.</p>
+
+
+	<h2>Acknowledgments</h2>
+
+
+	<p>Thanks to Matt Fischler for helping test and debug the installation of Ruby-VPI on Windows.</p>
+
+
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>The command-line options for <code>generate_test.rb</code> have changed. Run the command <code>generate_test.rb --help</code> for details.</li>
+	</ul>
+
+
+	<h2>Details</h2>
+
+
+	<ul>
+	<li>Test runners now attempt to resolve paths in <code>SIMULATOR_SOURCES</code> by searching for them within the directories specified in <code>SIMULATOR_INCLUDES</code>.</li>
+	</ul>
+
+
+	<ul>
+	<li>Synopsys <span class="caps">VCS</span> is now used in a better way (via the <code>-load</code> option).
+	<ul>
+	<li>The old <span class="caps">PLI</span> table file (<code>synopsys_vcs.tab</code>) has been removed.</li>
+		<li>The C extension has been revised accordingly.</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>The C extension now compiles without errors in Cygwin.</li>
+	</ul>
+
+
+	<ul>
+	<li>The automated test generator now:
+	<ul>
+	<li>Only creates output files when necessary.</li>
+		<li>Updates existing output files using <a href="./doc/usage.recommendations.html">text merging tools</a> if possible. (Refer to <code>MERGER</code> in the help information of <code>generate_test.rb</code>.)</li>
+		<li>Emits progress information similar to Ruby on Rails.</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>The user manual now:
+	<ul>
+	<li>Includes instructions for installing on Windows (via Cygwin).</li>
+		<li>Has a recommended software section, with links to text merging tools.</li>
+		<li>Uses the term <a href="http://en.wikipedia.org/wiki/XUnit">xUnit</a> instead of &#8220;unit test&#8221;.</li>
+		<li>Correctly spells &#8220;rSpec&#8221;.</li>
+	</ul></li>
+	</ul>
+
+
 	<h1>Version 8.2.0 (2006-10-24)</h1>
 
 
@@ -153,6 +188,12 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release simplifies configuration of generated tests.</p>
 
 
+	<h2>Acknowledgments</h2>
+
+
+	<p>Thanks to <a href="http://www.soe.ucsc.edu/classes/cmpe126/Fall06/">students in <span class="caps">CMPE</span>-126</a> for their constructive criticism.</p>
+
+
 	<h2>Notice</h2>
 
 

data/history.part.html

@@ -18,6 +18,72 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p id="fn1"><sup>1</sup> C. Gross, &#8220;Explaining Open Source Version Numbers&#8221;, [Online document], 2005 Nov 28, [cited 2006 Aug 27], Available <span class="caps">HTTP</span>: <a href="http://ablog.apress.com/?p=738">http://ablog.apress.com/?p=738</a></p>
 
 
+	<h1>Version 9.0.0 (2006-10-28)</h1>
+
+
+	<h2>Summary</h2>
+
+
+	<p>This release improves the automated test generator and adds new content to the user manual.</p>
+
+
+	<h2>Acknowledgments</h2>
+
+
+	<p>Thanks to Matt Fischler for helping test and debug the installation of Ruby-VPI on Windows.</p>
+
+
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>The command-line options for <code>generate_test.rb</code> have changed. Run the command <code>generate_test.rb --help</code> for details.</li>
+	</ul>
+
+
+	<h2>Details</h2>
+
+
+	<ul>
+	<li>Test runners now attempt to resolve paths in <code>SIMULATOR_SOURCES</code> by searching for them within the directories specified in <code>SIMULATOR_INCLUDES</code>.</li>
+	</ul>
+
+
+	<ul>
+	<li>Synopsys <span class="caps">VCS</span> is now used in a better way (via the <code>-load</code> option).
+	<ul>
+	<li>The old <span class="caps">PLI</span> table file (<code>synopsys_vcs.tab</code>) has been removed.</li>
+		<li>The C extension has been revised accordingly.</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>The C extension now compiles without errors in Cygwin.</li>
+	</ul>
+
+
+	<ul>
+	<li>The automated test generator now:
+	<ul>
+	<li>Only creates output files when necessary.</li>
+		<li>Updates existing output files using <a href="./doc/usage.recommendations.html">text merging tools</a> if possible. (Refer to <code>MERGER</code> in the help information of <code>generate_test.rb</code>.)</li>
+		<li>Emits progress information similar to Ruby on Rails.</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>The user manual now:
+	<ul>
+	<li>Includes instructions for installing on Windows (via Cygwin).</li>
+		<li>Has a recommended software section, with links to text merging tools.</li>
+		<li>Uses the term <a href="http://en.wikipedia.org/wiki/XUnit">xUnit</a> instead of &#8220;unit test&#8221;.</li>
+		<li>Correctly spells &#8220;rSpec&#8221;.</li>
+	</ul></li>
+	</ul>
+
+
 	<h1>Version 8.2.0 (2006-10-24)</h1>
 
 
@@ -27,6 +93,12 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release simplifies configuration of generated tests.</p>
 
 
+	<h2>Acknowledgments</h2>
+
+
+	<p>Thanks to <a href="http://www.soe.ucsc.edu/classes/cmpe126/Fall06/">students in <span class="caps">CMPE</span>-126</a> for their constructive criticism.</p>
+
+
 	<h2>Notice</h2>
 
 

data/lib/ruby-vpi.rb

@@ -56,4 +56,20 @@ module RubyVpi
 
     require "#{aTestPrefix}_spec.rb"
   end
+
+  module Config
+    PROJECT_ID = 'ruby-vpi'
+    PROJECT_NAME = 'Ruby-VPI'
+    PROJECT_URL = "http://#{PROJECT_ID}.rubyforge.org"
+    PROJECT_SUMMARY = "Ruby interface to Verilog VPI."
+    PROJECT_DETAIL = "#{PROJECT_NAME} is a #{PROJECT_SUMMARY}. It lets you create complex Verilog test benches easily and wholly in Ruby."
+
+    Simulator = Struct.new(:id, :name, :compiler_args, :linker_args)
+    SIMULATORS = [
+      Simulator.new(:cver, 'GPL Cver', '-DPRAGMATIC_CVER', ''),
+      Simulator.new(:ivl, 'Icarus Verilog', '-DICARUS_VERILOG', ''),
+      Simulator.new(:vcs, 'Synopsys VCS', '-DSYNOPSYS_VCS', ''),
+      Simulator.new(:vsim, 'Mentor Modelsim', '-DMENTOR_MODELSIM', ''),
+    ]
+  end
 end

data/lib/ruby-vpi/runner.rb

@@ -4,9 +4,6 @@
 # SIMULATOR_SOURCES:: Array of paths to source files needed by the simulator.
 # SIMULATOR_TARGET:: Name of the Verilog module to be simulated.
 # SIMULATOR_ARGS:: A hash containing keys for each simulator task (same as Rakefile task names) and values containing command-line arguments for each simulator.
-#
-# = Usage
-# When using one simulator after another, ensure that Ruby-VPI is properly compiled for the new simulator by invoking the _clobber_ cleaning task.
 
 =begin
   Copyright 2006 Suraj N. Kurapati
@@ -36,18 +33,41 @@
 
   SIMULATOR_INCLUDES = [] unless defined? SIMULATOR_INCLUDES
 
+# resolve paths to sources by searching include directories
+  SIMULATOR_SOURCES.map! do |src|
+    unless File.exist? src
+      SIMULATOR_INCLUDES.each do |dir|
+        path = File.join(dir, src)
+
+        if File.exist? path
+          src = path
+          break
+        end
+      end
+    end
+
+    src
+  end
+
 
 require 'rake/clean'
+require 'ruby-vpi'
 require 'ruby-vpi/rake'
 
+include RubyVpi::Config
+
 OBJECT_PATH = File.join(File.dirname(__FILE__), '..', '..', 'obj')
-VCS_TAB_FILE = File.join(File.dirname(__FILE__), 'synopsys_vcs.tab')
+BOOTSTAP_FUNC = 'vlog_startup_routines_bootstrap'
 
 
 # Returns the path to the Ruby-VPI object file for the given simulator.
-def object_file_path aSimId, aShared = false
-  path = File.join(OBJECT_PATH, "ruby-vpi.#{aSimId}.#{aShared ? 'so' : 'o'}")
-  raise "Object file #{path.inspect} is missing.\n Rebuild Ruby-VPI to generate the missing file." unless File.exist? path
+def object_file_path aSimId
+  path = File.join(OBJECT_PATH, "#{PROJECT_ID}.#{aSimId}.so")
+
+  unless File.exist? path
+    raise "Object file #{path.inspect} is missing. Rebuild #{PROJECT_NAME}."
+  end
+
   path
 end
 
@@ -74,7 +94,7 @@ end
 
 desc "Simulate with GPL Cver."
 task :cver do
-  sh 'cver', SIMULATOR_ARGS[:cver], "+loadvpi=#{object_file_path(:cver, true)}:vlog_startup_routines_bootstrap", expand_include_dir_options(:cver), SIMULATOR_SOURCES
+  sh 'cver', SIMULATOR_ARGS[:cver], "+loadvpi=#{object_file_path(:cver)}:#{BOOTSTAP_FUNC}", expand_include_dir_options(:cver), SIMULATOR_SOURCES
 end
 
 CLOBBER.include 'verilog.log'
@@ -82,8 +102,8 @@ CLOBBER.include 'verilog.log'
 
 desc "Simulate with Icarus Verilog."
 task :ivl do
-  cp object_file_path(:ivl, true), 'ruby-vpi.vpi'
-  sh 'iverilog', SIMULATOR_ARGS[:ivl], %w(-y. -mruby-vpi), expand_include_dir_options(:ivl), SIMULATOR_SOURCES
+  cp object_file_path(:ivl), 'ruby-vpi.vpi'
+  sh 'iverilog', SIMULATOR_ARGS[:ivl], '-mruby-vpi', expand_include_dir_options(:ivl), SIMULATOR_SOURCES
   sh 'vvp -M. a.out'
 end
 
@@ -91,10 +111,8 @@ CLEAN.include 'ruby-vpi.vpi', 'a.out'
 
 
 desc "Simulate with Synopsys VCS."
-task :vcs => VCS_TAB_FILE do
-  require 'rbconfig'
-
-  sh 'vcs', SIMULATOR_ARGS[:vcs], %w(-R +v2k +vpi -LDFLAGS), File.expand_path(object_file_path(:vcs)), "-L#{Config::CONFIG['libdir']}", Config::CONFIG['LIBRUBYARG'], '-lpthread', '-P', VCS_TAB_FILE, expand_include_dir_options(:vcs), SIMULATOR_SOURCES
+task :vcs do
+  sh %w(vcs -R +v2k +vpi), SIMULATOR_ARGS[:vcs], '-load', "#{object_file_path(:vcs)}:#{BOOTSTAP_FUNC}", expand_include_dir_options(:vcs), SIMULATOR_SOURCES
 end
 
 CLEAN.include 'csrc', 'simv*'
@@ -103,8 +121,8 @@ CLEAN.include 'csrc', 'simv*'
 desc "Simulate with Mentor Modelsim."
 task :vsim do
   sh 'vlib work'
-  sh 'vlog', SIMULATOR_ARGS[:vsim], expand_include_dir_options(:vsim), SIMULATOR_SOURCES
-  sh 'vsim', '-c', SIMULATOR_TARGET, '-pli', object_file_path(:vsim, true), '-do', 'run -all'
+  sh 'vlog', expand_include_dir_options(:vsim), SIMULATOR_SOURCES
+  sh 'vsim', SIMULATOR_ARGS[:vsim], '-c', SIMULATOR_TARGET, '-pli', object_file_path(:vsim), '-do', 'run -all'
 end
 
 CLEAN.include 'work'

data/memo.html

@@ -2,37 +2,6 @@
   <link rel="stylesheet" type="text/css" href="style.css" />
 </head>
 
-	<h1 style="text-align: center;">Welcome to Ruby-VPI</h1>
-
-
-	<p>Ruby-VPI is a <a href="http://ruby-lang.org">Ruby interface</a> to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945">Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
-
-
-	<h2>Features</h2>
-
-
-	<ul>
-	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
-	</ul>
-
-
-	<ul>
-	<li>Utilize Ruby&#8217;s power and elegance. (<a href="http://www.ruby-doc.org/whyruby">Why choose Ruby?</a>)
-	<ul>
-	<li>Built-in support for unlimited length integers, regular expressions, networking, multi-threading, system calls, <em>ad infinium</em>!</li>
-		<li>Easy to use; doesn&#8217;t get in your way.</li>
-		<li>Makes programming <em>fun</em> again!</li>
-	</ul></li>
-	</ul>
-
-
-	<ul>
-	<li>Study, modify, or distribute this is free software, released under the <a href="http://www.gnu.org/copyleft/gpl.html"><span class="caps">GNU</span> General Public License</a>, as you see fit.</li>
-	</ul>
-
-
 <div class="variablelist">
 <dl>
 

data/readme.html

@@ -2,37 +2,6 @@
   <link rel="stylesheet" type="text/css" href="style.css" />
 </head>
 
-	<h1 style="text-align: center;">Welcome to Ruby-VPI</h1>
-
-
-	<p>Ruby-VPI is a <a href="http://ruby-lang.org">Ruby interface</a> to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945">Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
-
-
-	<h2>Features</h2>
-
-
-	<ul>
-	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
-	</ul>
-
-
-	<ul>
-	<li>Utilize Ruby&#8217;s power and elegance. (<a href="http://www.ruby-doc.org/whyruby">Why choose Ruby?</a>)
-	<ul>
-	<li>Built-in support for unlimited length integers, regular expressions, networking, multi-threading, system calls, <em>ad infinium</em>!</li>
-		<li>Easy to use; doesn&#8217;t get in your way.</li>
-		<li>Makes programming <em>fun</em> again!</li>
-	</ul></li>
-	</ul>
-
-
-	<ul>
-	<li>Study, modify, or distribute this is free software, released under the <a href="http://www.gnu.org/copyleft/gpl.html"><span class="caps">GNU</span> General Public License</a>, as you see fit.</li>
-	</ul>
-
-
 <div class="variablelist">
 <dl>
 
@@ -124,6 +93,37 @@ Ask for help, give feedback, or discuss.</p>
 </div>
 </div>
 
+	<h1 style="text-align: center;">Welcome to Ruby-VPI</h1>
+
+
+	<p>Ruby-VPI is a <a href="http://ruby-lang.org">Ruby interface</a> to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945">Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
+
+
+	<h2>Features</h2>
+
+
+	<ul>
+	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
+		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
+		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
+	</ul>
+
+
+	<ul>
+	<li>Utilize Ruby&#8217;s power and elegance. (<a href="http://www.ruby-doc.org/whyruby">Why choose Ruby?</a>)
+	<ul>
+	<li>Built-in support for unlimited length integers, regular expressions, networking, multi-threading, system calls, <em>ad infinium</em>!</li>
+		<li>Easy to use; doesn&#8217;t get in your way.</li>
+		<li>Makes programming <em>fun</em> again!</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>Study, modify, or distribute this free software in accordance with the <a href="http://www.gnu.org/copyleft/gpl.html"><span class="caps">GNU</span> General Public License</a>.</li>
+	</ul>
+
+
 	<h1>Getting started</h1>
 
 
@@ -147,10 +147,10 @@ Ask for help, give feedback, or discuss.</p>
 	</ul>
 
 
-	<h1>Compiling from source</h1>
+	<h1>Building release packages</h1>
 
 
-	<p>In addition to the <a href="./doc/usage.requirements.html">normal requirements</a>, you need the following software to compile from source:</p>
+	<p>In addition to the <a href="./doc/usage.requirements.html">normal requirements</a>, you need the following software to build release packages:</p>
 
 
 	<ul>