Fix maxlens when signal is a boolean. Also fix old bug in IPython

output.

Bug was that it was using the width of the wire name, rather than the
wire, to determine if the wire was a boolean (1 bit) or not.

Author: mdko

pyrtl/visualization.py

@@ -481,14 +481,15 @@ def trace_to_html(simtrace, trace_list=None, sortkey=None, repr_func=hex):
 
     wave_template = (
         """\
-        <script type="WaveDrom">
-        { signal : [
-        %s
-        ],
-        config: {hscale: %d }}
-        </script>
-
-        """
+<script type="WaveDrom">
+{
+  signal : [
+%s
+  ],
+  config: { hscale: %d }
+}
+</script>
+"""
     )
 
     vallens = []  # For determining longest value length
@@ -501,7 +502,7 @@ def extract(w):
             if last == value:
                 wavelist.append('.')
             else:
-                if len(w) == 1:
+                if len(simtrace._wires[w]) == 1:
                     wavelist.append(str(value))
                 else:
                     wavelist.append('=')
@@ -510,14 +511,15 @@ def extract(w):
 
         wavestring = ''.join(wavelist)
         datastring = ', '.join(['"%s"' % repr_func(data) for data in datalist])
-        vallens.extend([len(repr_func(data)) for data in datalist])
-        if len(w) == 1:
+        if len(simtrace._wires[w]) == 1:
+            vallens.append(1)  # all are the same length
             return bool_signal_template % (w, wavestring)
         else:
+            vallens.extend([len(repr_func(data)) for data in datalist])
             return int_signal_template % (w, wavestring, datastring)
 
-    bool_signal_template = '{ name: "%s",  wave: "%s" },'
-    int_signal_template = '{ name: "%s",  wave: "%s", data: [%s] },'
+    bool_signal_template = '    { name: "%s",  wave: "%s" },'
+    int_signal_template = '    { name: "%s",  wave: "%s", data: [%s] },'
     signals = [extract(w) for w in trace_list]
     all_signals = '\n'.join(signals)
     maxvallen = max(vallens)

tests/test_visualization.py

@@ -340,6 +340,68 @@ def test_one_bit_adder_matches_expected(self):
 
         htmlstring = pyrtl.trace_to_html(sim_trace)  # tests if it compiles or not
 
+    def test_trace_to_html(self):
+        i = pyrtl.Input(1, 'i')
+        o = pyrtl.Output(2, 'o')
+        o <<= i + 1
+
+        sim = pyrtl.Simulation()
+        sim.step_multiple({'i': '0100110'})
+        htmlstring = pyrtl.trace_to_html(sim.tracer)
+        expected = (
+            '<script type="WaveDrom">\n'
+            '{\n'
+            '  signal : [\n'
+            '    { name: "i",  wave: "010.1.0" },\n'
+            '    { name: "o",  wave: "===.=.=", data: ["0x1", "0x2", "0x1", "0x2", "0x1"] },\n'
+            '  ],\n'
+            '  config: { hscale: 1 }\n'
+            '}\n'
+            '</script>\n'
+        )
+        self.assertEqual(htmlstring, expected)
+
+    def test_trace_to_html_repr_func(self):
+        i = pyrtl.Input(1, 'i')
+        o = pyrtl.Output(2, 'o')
+        o <<= i + 1
+
+        sim = pyrtl.Simulation()
+        sim.step_multiple({'i': '0100110'})
+        htmlstring = pyrtl.trace_to_html(sim.tracer, repr_func=bin)
+        expected = (
+            '<script type="WaveDrom">\n'
+            '{\n'
+            '  signal : [\n'
+            '    { name: "i",  wave: "010.1.0" },\n'
+            '    { name: "o",  wave: "===.=.=", data: ["0b1", "0b10", "0b1", "0b10", "0b1"] },\n'
+            '  ],\n'
+            '  config: { hscale: 1 }\n'
+            '}\n'
+            '</script>\n'
+        )
+        self.assertEqual(htmlstring, expected)
+
+    def test_trace_to_html_repr_func_2(self):
+        i = pyrtl.Input(1, 'i')
+        o = pyrtl.Output(2, 'o')
+        o <<= i + 1
+
+        sim = pyrtl.Simulation()
+        sim.step_multiple({'i': '0100110'})
+        htmlstring = pyrtl.trace_to_html(sim.tracer, repr_func=bin)
+        expected = (
+            '<script type="WaveDrom">\n'
+            '{\n'
+            '  signal : [\n'
+            '    { name: "i",  wave: "010.1.0" },\n'
+            '    { name: "o",  wave: "===.=.=", data: ["0b1", "0b10", "0b1", "0b10", "0b1"] },\n'
+            '  ],\n'
+            '  config: { hscale: 1 }\n'
+            '}\n'
+            '</script>\n'
+        )
+        self.assertEqual(htmlstring, expected)
 
 if __name__ == "__main__":
     unittest.main()