Merge pull request #394 from pllab/html-trace-update

Fix html trace visualization when value is a boolean and/or supplied …

Author: mdko

pyrtl/simulation.py

@@ -7,6 +7,7 @@
 import numbers
 import collections
 import copy
+import six
 
 from .pyrtlexceptions import PyrtlError, PyrtlInternalError
 from .core import working_block, PostSynthBlock, _PythonSanitizer
@@ -627,9 +628,18 @@ def step_multiple(self, provided_inputs={}, expected_outputs={}, nsteps=None,
                 "any expected outputs must have a supplied value "
                 "each step of simulation")
 
+        def to_num(v):
+            if isinstance(v, six.string_types):
+                # Don't use infer_val_and_bitwidth because they aren't in
+                # Verilog-style format, but are instead in plain decimal.
+                return int(v)
+            # Don't just call int(v) on all of them since it's nice
+            # to retain class info if they were a subclass of int.
+            return v
+
         failed = []
         for i in range(nsteps):
-            self.step({w: int(v[i]) for w, v in provided_inputs.items()})
+            self.step({w: to_num(v[i]) for w, v in provided_inputs.items()})
 
             for expvar in expected_outputs.keys():
                 expected = int(expected_outputs[expvar][i])

pyrtl/visualization.py

@@ -504,31 +504,31 @@ def extract(w):
         wavelist = []
         datalist = []
         last = None
+
         for i, value in enumerate(trace[w]):
             if last == value:
                 wavelist.append('.')
             else:
-                if len(simtrace._wires[w]) == 1:
-                    wavelist.append(str(value))
+                f = repr_per_name.get(w)
+                if f is not None:
+                    wavelist.append('=')
+                    datalist.append(str(f(value)))
+                elif len(simtrace._wires[w]) == 1:
+                    # int() to convert True/False to 0/1
+                    wavelist.append(str(int(value)))
                 else:
                     wavelist.append('=')
-                    datalist.append((value, w))
-                last = value
+                    datalist.append(str(repr_func(value)))
 
-        def to_str(v, name):
-            f = repr_per_name.get(name)
-            if f is not None:
-                return str(f(v))
-            else:
-                return str(repr_func(v))
+                last = value
 
         wavestring = ''.join(wavelist)
-        datastring = ', '.join(['"%s"' % to_str(data, name) for data, name in datalist])
-        if len(simtrace._wires[w]) == 1:
+        datastring = ', '.join(['"%s"' % data for data in datalist])
+        if repr_per_name.get(w) is None and len(simtrace._wires[w]) == 1:
             vallens.append(1)  # all are the same length
             return bool_signal_template % (w, wavestring)
         else:
-            vallens.extend([len(to_str(data, name)) for data, name in datalist])
+            vallens.extend([len(data) for data in datalist])
             return int_signal_template % (w, wavestring, datastring)
 
     bool_signal_template = '    { name: "%s",  wave: "%s" },'

tests/test_visualization.py

@@ -2,7 +2,6 @@
 import random
 import io
 import pyrtl
-from .test_importexport import full_adder_blif
 
 
 graphviz_string_detailed = """\
@@ -177,16 +176,19 @@ def setUp(self):
         pyrtl.reset_working_block()
 
     def test_output_to_tgf_does_not_throw_error(self):
+        from .test_importexport import full_adder_blif
         with io.StringIO() as vfile:
             pyrtl.input_from_blif(full_adder_blif)
             pyrtl.output_to_trivialgraph(vfile)
 
     def test_output_to_graphviz_does_not_throw_error(self):
+        from .test_importexport import full_adder_blif
         with io.StringIO() as vfile:
             pyrtl.input_from_blif(full_adder_blif)
             pyrtl.output_to_graphviz(vfile)
 
     def test_output_to_graphviz_with_custom_namer_does_not_throw_error(self):
+        from .test_importexport import full_adder_blif
         with io.StringIO() as vfile:
             pyrtl.input_from_blif(full_adder_blif)
             timing = pyrtl.TimingAnalysis()
@@ -426,6 +428,44 @@ class Foo(IntEnum):
         )
         self.assertEqual(htmlstring, expected)
 
+    def test_trace_to_html_repr_per_name_enum_is_bool(self):
+        from enum import IntEnum
+
+        class Foo(IntEnum):
+            A = 0
+            B = 1
+
+        i = pyrtl.Input(2, 'i')
+        state = pyrtl.Register(max(Foo).bit_length(), name='state')
+        o = pyrtl.Output(name='o')
+        o <<= state
+
+        with pyrtl.conditional_assignment:
+            with i == 0b01:
+                state.next |= Foo.A
+            with i == 0b10:
+                state.next |= Foo.B
+
+        sim = pyrtl.Simulation()
+        sim.step_multiple({
+            'i': [1, 2, 1, 2, 2]
+        })
+
+        htmlstring = pyrtl.trace_to_html(sim.tracer, repr_per_name={'state': Foo})
+        expected = (
+            '<script type="WaveDrom">\n'
+            '{\n'
+            '  signal : [\n'
+            '    { name: "i",  wave: "====.", data: ["0x1", "0x2", "0x1", "0x2"] },\n'
+            '    { name: "o",  wave: "0.101" },\n'
+            '    { name: "state",  wave: "=.===", data: ["Foo.A", "Foo.B", "Foo.A", "Foo.B"] },\n'
+            '  ],\n'
+            '  config: { hscale: 2 }\n'
+            '}\n'
+            '</script>\n'
+        )
+        self.assertEqual(htmlstring, expected)
+
 
 if __name__ == "__main__":
     unittest.main()