ruby-vpi 11.1.1 → 12.0.0

data/ref/ruby/fr_method_index.html

@@ -21,7 +21,7 @@
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
     <a href="classes/XX/Document.html#M000082"><< (XX::Document)</a><br />
-    <a href="classes/Vpi/Handle.html#M000092">[] (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000094">[] (Vpi::Handle)</a><br />
     <a href="classes/FileUtils.html#M000084">collect_args (FileUtils)</a><br />
     <a href="classes/XX/Document.html#M000081">create (XX::Document)</a><br />
     <a href="classes/Table.html#M000026">doc (Table)</a><br />
@@ -29,15 +29,15 @@
     <a href="classes/Integer.html#M000020">ensure_min (Integer)</a><br />
     <a href="files/lib/ruby-vpi/runner_rb.html#M000004">expand_include_dir_options (lib/ruby-vpi/runner.rb)</a><br />
     <a href="classes/Integer.html#M000024">extend_sign (Integer)</a><br />
-    <a href="classes/Vpi/Handle.html#M000090">get_value (Vpi::Handle)</a><br />
-    <a href="classes/Vpi/Handle.html#M000089">get_value_wrapper (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000092">get_value (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000091">get_value_wrapper (Vpi::Handle)</a><br />
     <a href="classes/XX/HTML4/Strict.html#M000040">html4_ (XX::HTML4::Strict)</a><br />
     <a href="classes/XX/HTML4/Transitional.html#M000039">html4_ (XX::HTML4::Transitional)</a><br />
     <a href="classes/XX/HTML4.html#M000038">html4_ (XX::HTML4)</a><br />
     <a href="classes/XX/Markup.html#M000045">included (XX::Markup)</a><br />
     <a href="classes/RubyVpi.html#M000085">init_bench (RubyVpi)</a><br />
     <a href="classes/VerilogParser/Module/Port.html#M000008">input? (VerilogParser::Module::Port)</a><br />
-    <a href="classes/Vpi/Handle.html#M000093">inspect (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000095">inspect (Vpi::Handle)</a><br />
     <a href="classes/Integer.html#M000013">length (Integer)</a><br />
     <a href="classes/Integer.html#M000014">limit (Integer)</a><br />
     <a href="classes/Integer.html#M000012">log2 (Integer)</a><br />
@@ -45,15 +45,15 @@
     <a href="classes/Integer.html#M000016">mask (Integer)</a><br />
     <a href="classes/Integer.html#M000018">max (Integer)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000054">method_missing (XX::Markup::InstanceMethods)</a><br />
-    <a href="classes/Vpi/Handle.html#M000095">method_missing (Vpi::Handle)</a><br />
-    <a href="classes/VerilogParser/Module/Parameter.html#M000011">new (VerilogParser::Module::Parameter)</a><br />
+    <a href="classes/Vpi/Handle.html#M000097">method_missing (Vpi::Handle)</a><br />
+    <a href="classes/OutputInfo.html#M000030">new (OutputInfo)</a><br />
     <a href="classes/VerilogParser/Module/Port.html#M000007">new (VerilogParser::Module::Port)</a><br />
     <a href="classes/VerilogParser/Module.html#M000006">new (VerilogParser::Module)</a><br />
-    <a href="classes/ERB.html#M000036">new (ERB)</a><br />
+    <a href="classes/VerilogParser/Module/Parameter.html#M000011">new (VerilogParser::Module::Parameter)</a><br />
     <a href="classes/VerilogParser.html#M000005">new (VerilogParser)</a><br />
     <a href="classes/Template.html#M000032">new (Template)</a><br />
     <a href="classes/XX/Document.html#M000074">new (XX::Document)</a><br />
-    <a href="classes/OutputInfo.html#M000030">new (OutputInfo)</a><br />
+    <a href="classes/ERB.html#M000036">new (ERB)</a><br />
     <a href="files/bin/generate_test_rb.html#M000001">notify (bin/generate_test.rb)</a><br />
     <a href="files/lib/ruby-vpi/runner_rb.html#M000003">object_file_path (lib/ruby-vpi/runner.rb)</a><br />
     <a href="classes/VerilogParser/Module/Port.html#M000009">output? (VerilogParser::Module::Port)</a><br />
@@ -61,9 +61,9 @@
     <a href="classes/XX/Document.html#M000077">pop (XX::Document)</a><br />
     <a href="classes/XX/Document.html#M000080">pretty (XX::Document)</a><br />
     <a href="classes/XX/Document.html#M000076">push (XX::Document)</a><br />
-    <a href="classes/Vpi/Handle.html#M000091">put_value (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000093">put_value (Vpi::Handle)</a><br />
     <a href="classes/VerilogParser/Module/Port.html#M000010">reg? (VerilogParser::Module::Port)</a><br />
-    <a href="classes/Vpi/Handle/Property.html#M000096">resolve (Vpi::Handle::Property)</a><br />
+    <a href="classes/Vpi/Handle/Property.html#M000098">resolve (Vpi::Handle::Property)</a><br />
     <a href="classes/FileUtils.html#M000083">sh (FileUtils)</a><br />
     <a href="classes/Integer.html#M000025">split (Integer)</a><br />
     <a href="classes/String.html#M000035">to_f (String)</a><br />
@@ -72,21 +72,22 @@
     <a href="classes/Integer.html#M000017">to_mask (Integer)</a><br />
     <a href="classes/Integer.html#M000019">to_max (Integer)</a><br />
     <a href="classes/String.html#M000034">to_ruby_const_name (String)</a><br />
-    <a href="classes/Vpi/Handle.html#M000094">to_s (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000096">to_s (Vpi::Handle)</a><br />
     <a href="classes/XX/Document.html#M000079">to_str (XX::Document)</a><br />
     <a href="classes/Table.html#M000027">to_xhtml (Table)</a><br />
     <a href="classes/Table.html#M000029">to_xml (Table)</a><br />
     <a href="classes/XX/Document.html#M000075">top (XX::Document)</a><br />
     <a href="classes/XX/Document.html#M000078">tracking_additions (XX::Document)</a><br />
     <a href="classes/Integer.html#M000023">unpack (Integer)</a><br />
-    <a href="classes/RDoc.html#M000097">usage_from_file (RDoc)</a><br />
+    <a href="classes/RDoc.html#M000099">usage_from_file (RDoc)</a><br />
     <a href="classes/String.html#M000033">verilog_to_ruby (String)</a><br />
     <a href="classes/RubyVpi.html#M000086">with_coverage_analysis (RubyVpi)</a><br />
     <a href="files/bin/generate_test_rb.html#M000002">write_file (bin/generate_test.rb)</a><br />
+    <a href="classes/Vpi/Handle.html#M000088">x! (Vpi::Handle)</a><br />
     <a href="classes/Vpi/Handle.html#M000087">x? (Vpi::Handle)</a><br />
-    <a href="classes/XX/XHTML.html#M000041">xhtml_ (XX::XHTML)</a><br />
     <a href="classes/XX/XHTML/Strict.html#M000043">xhtml_ (XX::XHTML::Strict)</a><br />
     <a href="classes/XX/XHTML/Transitional.html#M000042">xhtml_ (XX::XHTML::Transitional)</a><br />
+    <a href="classes/XX/XHTML.html#M000041">xhtml_ (XX::XHTML)</a><br />
     <a href="classes/XX/XML.html#M000037">xml_ (XX::XML)</a><br />
     <a href="classes/XX/XMLish.html#M000044">xmlish_ (XX::XMLish)</a><br />
     <a href="classes/XX/Markup/ClassMethods.html#M000050">xx_ancestors (XX::Markup::ClassMethods)</a><br />
@@ -96,27 +97,28 @@
     <a href="classes/XX/Markup/InstanceMethods.html#M000065">xx_class (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000071">xx_config (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/ClassMethods.html#M000051">xx_config (XX::Markup::ClassMethods)</a><br />
-    <a href="classes/XX/Markup/InstanceMethods.html#M000072">xx_config_for (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/ClassMethods.html#M000052">xx_config_for (XX::Markup::ClassMethods)</a><br />
+    <a href="classes/XX/Markup/InstanceMethods.html#M000072">xx_config_for (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/ClassMethods.html#M000053">xx_configure (XX::Markup::ClassMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000073">xx_configure (XX::Markup::InstanceMethods)</a><br />
-    <a href="classes/XX/Markup/InstanceMethods.html#M000068">xx_define_tag_method (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/ClassMethods.html#M000048">xx_define_tag_method (XX::Markup::ClassMethods)</a><br />
+    <a href="classes/XX/Markup/InstanceMethods.html#M000068">xx_define_tag_method (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000067">xx_define_tmp_method (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/ClassMethods.html#M000047">xx_define_tmp_method (XX::Markup::ClassMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000058">xx_doc (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000060">xx_markup_ (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000063">xx_parse_attributes (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000064">xx_parse_yaml_attributes (XX::Markup::InstanceMethods)</a><br />
-    <a href="classes/XX/Markup/InstanceMethods.html#M000069">xx_remove_tag_method (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/ClassMethods.html#M000049">xx_remove_tag_method (XX::Markup::ClassMethods)</a><br />
+    <a href="classes/XX/Markup/InstanceMethods.html#M000069">xx_remove_tag_method (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000055">xx_tag_ (XX::Markup::InstanceMethods)</a><br />
-    <a href="classes/XX/Markup/ClassMethods.html#M000046">xx_tag_method_name (XX::Markup::ClassMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000066">xx_tag_method_name (XX::Markup::InstanceMethods)</a><br />
+    <a href="classes/XX/Markup/ClassMethods.html#M000046">xx_tag_method_name (XX::Markup::ClassMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000059">xx_text_ (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000056">xx_which (XX::Markup::InstanceMethods)</a><br />
     <a href="classes/XX/Markup/InstanceMethods.html#M000057">xx_with_doc_in_effect (XX::Markup::InstanceMethods)</a><br />
-    <a href="classes/Vpi/Handle.html#M000088">z? (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000090">z! (Vpi::Handle)</a><br />
+    <a href="classes/Vpi/Handle.html#M000089">z? (Vpi::Handle)</a><br />
   </div>
 </div>
 </body>

data/samp/counter/counter_rspec_bench.v

@@ -11,16 +11,13 @@ module counter_rspec_bench;
 
   // connect to the Ruby side of this bench
     initial begin
-      clock = 0;
-      $ruby_init("ruby", "-w", "-rubygems", "counter_rspec_bench.rb");
+      $ruby_init("ruby", "-rubygems", "counter_rspec_bench.rb");
     end
 
     always begin
-      #5 clock = ~clock;
-    end
-
-    always @(posedge clock) begin
+      #1 clock = 0;
       #1 $ruby_relay;
+      #1 clock = 1;
     end
 
 endmodule

data/samp/counter/counter_rspec_design.rb

@@ -2,7 +2,8 @@
 
 # This method resets the design under test.
 def Counter.reset!
+  # assert the reset signal for five clock cycles
   reset.intVal = 1
-  relay_verilog
+  5.times {relay_verilog}
   reset.intVal = 0
 end

data/samp/counter/counter_rspec_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 = [
   'counter.v',
   'counter_rspec_bench.v',
 ]
 
 # 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 = 'counter_rspec_bench'
 
 # 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/samp/counter/counter_rspec_spec.rb

@@ -12,12 +12,12 @@ context "A resetted counter's value" do
   end
 
   specify "should be zero" do
-    Counter.count.intVal.should_equal 0
+    Counter.count.intVal.should == 0
   end
 
   specify "should increment by one count upon each rising clock edge" do
     LIMIT.times do |i|
-      Counter.count.intVal.should_equal i
+      Counter.count.intVal.should == i
       relay_verilog # increment the counter
     end
   end
@@ -29,11 +29,11 @@ context "A counter with the maximum value" do
 
     # increment the counter to maximum value
     MAX.times {relay_verilog}
-    Counter.count.intVal.should_equal MAX
+    Counter.count.intVal.should == MAX
   end
 
   specify "should overflow upon increment" do
     relay_verilog # increment the counter
-    Counter.count.intVal.should_equal 0
+    Counter.count.intVal.should == 0
   end
 end

data/samp/counter/counter_xunit_bench.v

@@ -11,16 +11,13 @@ module counter_xunit_bench;
 
   // connect to the Ruby side of this bench
     initial begin
-      clock = 0;
-      $ruby_init("ruby", "-w", "-rubygems", "counter_xunit_bench.rb");
+      $ruby_init("ruby", "-rubygems", "counter_xunit_bench.rb");
     end
 
     always begin
-      #5 clock = ~clock;
-    end
-
-    always @(posedge clock) begin
+      #1 clock = 0;
       #1 $ruby_relay;
+      #1 clock = 1;
     end
 
 endmodule

data/samp/counter/counter_xunit_design.rb

@@ -2,7 +2,8 @@
 
 # This method resets the design under test.
 def Counter.reset!
+  # assert the reset signal for five clock cycles
   reset.intVal = 1
-  relay_verilog
+  5.times {relay_verilog}
   reset.intVal = 0
 end

data/samp/counter/counter_xunit_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 = [
   'counter.v',
   'counter_xunit_bench.v',
 ]
 
 # 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 = 'counter_xunit_bench'
 
 # 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/samp/pipelined_alu/hw5_unit_test_bench.v

@@ -16,16 +16,13 @@ module hw5_unit_test_bench;
 
   // connect to the Ruby side of this bench
     initial begin
-      clk = 0;
-      $ruby_init("ruby", "-w", "-rubygems", "hw5_unit_test_bench.rb");
+      $ruby_init("ruby", "-rubygems", "hw5_unit_test_bench.rb");
     end
 
     always begin
-      #5 clk = ~clk;
-    end
-
-    always @(posedge clk) begin
+      #1 clk = 0;
       #1 $ruby_relay;
+      #1 clk = 1;
     end
 
 endmodule

data/samp/pipelined_alu/hw5_unit_test_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 = [
   'hw5_unit.v',
   'hw5_unit_test_bench.v',
 ]
 
 # 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 = 'hw5_unit_test_bench'
 
 # 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'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: ruby-vpi
 version: !ruby/object:Gem::Version 
-  version: 11.1.1
-date: 2006-11-15 00:00:00 -08:00
+  version: 12.0.0
+date: 2006-12-07 00:00:00 -08:00
 summary: Ruby interface to Verilog VPI.
 require_paths: 
 - lib
@@ -37,8 +37,8 @@ files:
 - ref
 - doc
 - samp
-- gem_extconf.rb
 - index.html
+- gem_extconf.rb
 - ext/swig_vpi.i
 - ext/vlog.c
 - ext/Rakefile
@@ -314,31 +314,32 @@ files:
 - ref/ruby/classes/Vpi/Handle.src/M000091.html
 - ref/ruby/classes/Vpi/Handle.src/M000092.html
 - ref/ruby/classes/Vpi/Handle.src/M000093.html
+- ref/ruby/classes/Vpi/Handle.src/M000094.html
 - ref/ruby/classes/Vpi/Handle.src/M000095.html
+- ref/ruby/classes/Vpi/Handle.src/M000097.html
 - ref/ruby/classes/Vpi/Handle/Property.src
 - ref/ruby/classes/Vpi/Handle/Property.html
-- ref/ruby/classes/Vpi/Handle/Property.src/M000096.html
-- ref/ruby/classes/RDoc.src/M000097.html
+- ref/ruby/classes/Vpi/Handle/Property.src/M000098.html
+- ref/ruby/classes/RDoc.src/M000099.html
 - ref/ruby/classes/RubyVpi/Config.html
 - doc/Rakefile
 - doc/figures
 - doc/images
-- doc/readme.erb
-- doc/memo.erb
-- doc/manual.rb
-- doc/common.tpl
+- doc/manual.html
+- doc/LICENSE
 - doc/manual.erb
-- doc/lib
-- doc/intro.inc
-- doc/readme.html
+- doc/history.erb
+- doc/history.yml
+- doc/memo.erb
+- doc/readme.erb
 - doc/common.css
+- doc/history.html
+- doc/common.tpl
 - doc/history.rb
-- doc/history.erb
+- doc/intro.inc
+- doc/lib
 - doc/memo.html
-- doc/manual.html
-- doc/history.html
-- doc/history.yml
-- doc/LICENSE
+- doc/readme.html
 - doc/figures/ruby_init.png
 - doc/figures/ruby_relay.png
 - doc/figures/organization.png
@@ -389,11 +390,11 @@ files:
 - samp/counter/counter_rspec_spec.rb
 - samp/counter/counter_xunit_bench.rb
 - samp/counter/counter_xunit_runner.rake
-- samp/counter/counter_xunit_spec.rb
+- samp/counter/counter_rspec_bench.rb
 - samp/counter/counter_xunit_proto.rb
-- samp/counter/counter_rspec_design.rb
 - samp/counter/counter_rspec_bench.v
-- samp/counter/counter_rspec_bench.rb
+- samp/counter/counter_rspec_design.rb
+- samp/counter/counter_xunit_spec.rb
 - samp/counter/counter_rspec_runner.rake
 test_files: []
 

data/doc/manual.rb

@@ -1,5 +0,0 @@
-# This is a helper file that gets loaded before manual.erb is evaluated.
-
-@fixed_in_2_0_0 = note("Fixed in 2.0.0.") do
-  "This problem was fixed in release 2.0.0 (2006-04-17)."
-end