HDLRuby 2.5.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99c77fd470dae8d84cb066923fc8ed89d18e2aafa8bc826df85e03cae674c4e2
-  data.tar.gz: 4ef6902aec739f56c398bd653dc30f0dc03227799e1f54a9900b762d1a077aaa
+  metadata.gz: 53e83131d2fb3a3f03c085a3139a69d70f4422ade7be950d009e97e17bb92490
+  data.tar.gz: dcbbcbf3bd1e5aa43ac359e502dc0da6dec886d115371f3b2fceead01bcaa9d3
 SHA512:
-  metadata.gz: 8c9972c8567cb1fd496268c4385b7f3caa0bd8718769254542adeceafafdc26ed09d5ce7c47430e0b0732ecbcda4ea5d0220cf4bc7be9721faf5b99bf47057cf
-  data.tar.gz: d300640fdc354ed55f9210c95d4aee10e52768a59ac39a993b402d8da78dd091f31d97fe307fe96b729d9194b532bf958761070224663e3bf2cd37e165877c21
+  metadata.gz: 1656a5763fef86bd1b8c01eff8d377cc94ff3145889fd486fac99ac7d86b6f6671a30e040679f81da6a76bc08ee09ff5babd11cae72fc8adb721f0258e724fb9
+  data.tar.gz: 8f83372948477da9374abf302ab3910d73b434b22aa020b25071f2ed9127dc7ee95b3c6959952bd9ec008f1ff17327c7edc9e1b9584d1437a530a753b0886f4d

data/lib/HDLRuby/hdr_samples/dff_unit.rb

@@ -0,0 +1,54 @@
+# Testing HDLRuby unit test.
+# require 'hruby_unit.rb' 
+
+# Declare multiple simple dff-systems and their corresponding test.
+
+1.times do |i|
+
+    # A simple D-FF
+    system:"dff#{i}" do
+        input :clk, :rst, :d
+        output :q, :qb
+
+        qb <= ~q
+
+        par(clk.posedge) { q <= d & ~rst }
+    end
+
+    # Code for testing it.
+    Unit.system :"test_dff#{i}" do
+        inner :clk, :rst, :d, :q, :qb
+
+        send(:"dff#{i}",:dffI).(clk,rst,d,q,qb)
+
+        timed do
+            clk <= 0
+            rst <= 0
+            d   <= 0
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            rst <= 1
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            rst <= 0
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            d   <= 1
+            !10.ns
+            clk <= 1
+            !10.ns
+            clk <= 0
+            d   <= 0
+            !10.ns
+            clk <= 1
+            !10.ns
+        end
+    end
+end
+

data/lib/HDLRuby/hdrcc.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/ruby
 
 require 'fileutils'
+require 'tempfile'
 require 'HDLRuby'
 require 'HDLRuby/hruby_check.rb'
 # require 'ripper'
@@ -50,12 +51,21 @@ module HDLRuby
         # The required files.
         attr_reader :requires
 
-        # Creates a new loader for a +top_system+ system in file +top_file+
+        # Creates a new loader for a +top_system+ system in file +top_file_name+
         # from directory +dir+ with generic parameters +params+.
+        #
+        # NOTE: +top_file+ can either be a file or a file name.
         def initialize(top_system,top_file,dir,*params)
             # Sets the top and the looking directory.
             @top_system = top_system.to_s
-            @top_file = top_file.to_s
+            # @top_file can either be a file or a string giving the file name.
+            if top_file.respond_to?(:path) then
+                @top_file = top_file
+                @top_file_name = top_file.path
+            else
+                @top_file = nil
+                @top_file_name = top_file.to_s
+            end
             @dir = dir.to_s
             @params = params
 
@@ -82,31 +92,48 @@ module HDLRuby
         end
 
         # Loads a single +file+.
+        #
+        # NOTE: +file+ can either be a file or a file name.
         def read(file)
             # Resolve the file.
-            found = File.join(@dir,file)
-            unless File.exist?(found) then
-                founds = Dir.glob(@std_dirs.map {|path| File.join(path,file) })
-                if founds.empty? then
-                    # No standard file with this name, this is an error.
-                    raise "Unknown required file: #{file}."
-                else
-                    # A standard file is found, skip it since it does not
-                    # need to be read.
-                    # puts "Standard files: #{founds}"
-                    return false
+            if file.respond_to?(:read) then
+                found = file
+            else
+                found = File.join(@dir,file)
+                unless File.exist?(found) then
+                    founds = Dir.glob(@std_dirs.map do |path|
+                        File.join(path,file) 
+                    end)
+                    if founds.empty? then
+                        # No standard file with this name, this is an error.
+                        raise "Unknown required file: #{file}."
+                    else
+                        # A standard file is found, skip it since it does not
+                        # need to be read.
+                        # puts "Standard files: #{founds}"
+                        return false
+                    end
                 end
             end
             # Load the file.
-            # @texts << File.read(File.join(@dir,file) )
             @texts << File.read(found)
-            # @checks << Checker.new(@texts[-1],file)
-            @checks << Checker.new(@texts[-1],found)
+            if found.respond_to?(:path) then
+                @checks << Checker.new(@texts[-1],found.path)
+            else
+                @checks << Checker.new(@texts[-1])
+            end
             return true
         end
 
         # Loads all the files from +file+.
-        def read_all(file = @top_file)
+        def read_all(file = nil)
+            unless file then
+                if @top_file then
+                    file = @top_file
+                else
+                    file = @top_file_name
+                end
+            end
             # puts "read_all with file=#{file}"
             # Read the file
             # read(file)
@@ -174,7 +201,7 @@ module HDLRuby
                     # Maybe it is a parse error, look for it.
                     bind = TOPLEVEL_BINDING.clone
                     eval("require 'HDLRuby'\n\nconfigure_high\n\n",bind)
-                    eval(@texts[0],bind,@top_file,1)
+                    eval(@texts[0],bind,@top_file_name,1)
                     # No parse error found.
                     raise "Cannot find a top system." unless @top_system
                 end
@@ -183,7 +210,7 @@ module HDLRuby
             bind = TOPLEVEL_BINDING.clone
             eval("require 'HDLRuby'\n\nconfigure_high\n\n",bind)
             # Process it.
-            eval(@texts[0],bind,@top_file,1)
+            eval(@texts[0],bind,@top_file_name,1)
             # Get the resulting instance
             if @params.empty? then
                 # There is no generic parameter
@@ -310,6 +337,9 @@ $optparse = OptionParser.new do |opts|
     opts.on("-D", "--debug","Set the HDLRuby debug mode") do |d|
         $options[:debug] = d
     end
+    opts.on("-T","--test","Compile the unit tests.") do |t|
+        $options[:test] = t
+    end
     opts.on("-t", "--top system", "Specify the top system to process") do|t|
         $options[:top] = t
     end
@@ -370,6 +400,19 @@ if $input == nil then
     exit
 end
 
+if ($options[:test]) then
+    $top = "__test__"
+    # Generate the unit test file.
+    $test_file = Tempfile.new('tester.rb',Dir.getwd)
+    $test_file.write("require 'hruby_unit.rb'\nrequire_relative '#{$input}'\n\n" +
+                    "HDLRuby::Unit.test(\"#{$top}\")\n")
+    # $test_file.rewind
+    # puts $test_file.read
+    $test_file.rewind
+    # It is the new input file.
+    $input = $test_file
+end
+
 # Open the output.
 if $output then
     if $options[:multiple] then
@@ -394,6 +437,12 @@ $loader = HDRLoad.new($top,$input,$options[:directory].to_s,*$params)
 $loader.read_all
 $loader.check_all
 
+# Remove the test file if any, it is not needed any longer.
+if $test_file then
+    $test_file.close
+    $test_file.unlink 
+end
+
 if $options[:syntax] then
     if $options[:multiple] then
         raise "Multiple files generation mode not supported for syntax tree output."

data/lib/HDLRuby/hruby_high.rb

@@ -3810,7 +3810,7 @@ module HDLRuby::High
             timeBehaviorL = HDLRuby::Low::TimeBehavior.new(blockL)
             # For debugging: set the source high object 
             timeBehaviorL.properties[:low2high] = self.hdr_id
-            eventLs.each(&behaviorL.method(:add_event))
+            eventLs.each(&timeBehaviorL.method(:add_event))
             return timeBehaviorL
         end
     end

data/lib/HDLRuby/hruby_unit.rb

@@ -0,0 +1,43 @@
+require "HDLRuby/hruby_high"
+
+
+
+##
+# Library for building unit test systems.
+#
+########################################################################
+module HDLRuby::Unit
+
+    ## The HDLRuby unit test error class.
+    class UnitError < ::StandardError
+    end
+
+    # The set of the unit systems by name.
+    @@unit_systems = {}
+
+    # Declares system +name+ for unit testing.
+    # The system is built by executing +ruby_block+.
+    #
+    # NOTE: the name of the system is not registered within the HDLRuby
+    #       namespace since it is not meant to be used directly.
+    def self.system(name,&ruby_block)
+        # Ensure name is a symbol.
+        name = name.to_s.to_sym
+        # Check if the name is already used or not.
+        if @@unit_systems.key?(name) then
+            raise UnitError, "Unit test system #{name} already declared."
+        end
+        @@unit_systems[name] = HDLRuby::High.system(&ruby_block)
+    end
+
+
+    # Create a system named +test_name+ executing all the unit tests.
+    def self.test(test_name = "test")
+        # Declare the system.
+        HDLRuby::High.system test_name do
+            @@unit_systems.each do |name,sys|
+                sys.instantiate(name)
+            end
+        end
+    end
+end

data/lib/HDLRuby/version.rb

@@ -1,3 +1,3 @@
 module HDLRuby
-  VERSION = "2.5.0"
+  VERSION = "2.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: HDLRuby
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.1
 platform: ruby
 authors:
 - Lovic Gauthier
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-15 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - lib/HDLRuby/hdr_samples/dff_bench.rb
 - lib/HDLRuby/hdr_samples/dff_counter.rb
 - lib/HDLRuby/hdr_samples/dff_properties.rb
+- lib/HDLRuby/hdr_samples/dff_unit.rb
 - lib/HDLRuby/hdr_samples/include.rb
 - lib/HDLRuby/hdr_samples/instance_open.rb
 - lib/HDLRuby/hdr_samples/linear_test.rb
@@ -231,6 +232,7 @@ files:
 - lib/HDLRuby/hruby_serializer.rb
 - lib/HDLRuby/hruby_tools.rb
 - lib/HDLRuby/hruby_types.rb
+- lib/HDLRuby/hruby_unit.rb
 - lib/HDLRuby/hruby_values.rb
 - lib/HDLRuby/hruby_verilog.rb
 - lib/HDLRuby/hruby_verilog_name.rb