Merge pull request trentm#477 from Crozzers/feature-wavedrom-support

nicholasserra · web-flow · commit d6651a449317 · 2022-09-29T18:57:46.000-04:00
Feature wavedrom support
diff --git a/CHANGES.md b/CHANGES.md
@@ -2,7 +2,7 @@
 
 ## python-markdown2 2.4.6 (not yet released)
 
-(nothing yet)
+- [pull #477] Feature wavedrom support
 
 
 ## python-markdown2 2.4.5
diff --git a/lib/markdown2.py b/lib/markdown2.py
@@ -90,6 +90,7 @@
   on Extras.
 * wiki-tables: Google Code Wiki-style tables. See
   <http://code.google.com/p/support/wiki/WikiSyntax#Tables>.
+* wavedrom: Support for generating Wavedrom digital timing diagrams
 * xml: Passes one-liner processing instructions and namespaced XML tags.
 """
 
@@ -347,6 +348,9 @@ def convert(self, text):
 
         text = self.preprocess(text)
 
+        if 'wavedrom' in self.extras:
+            text = self._do_wavedrom_blocks(text)
+
         if "fenced-code-blocks" in self.extras and not self.safe_mode:
             text = self._do_fenced_code_blocks(text)
 
@@ -1011,6 +1015,9 @@ def _run_block_gamut(self, text):
         if 'admonitions' in self.extras:
             text = self._do_admonitions(text)
 
+        if 'wavedrom' in self.extras:
+            text = self._do_wavedrom_blocks(text)
+
         if "fenced-code-blocks" in self.extras:
             text = self._do_fenced_code_blocks(text)
 
@@ -2084,6 +2091,42 @@ def _encode_code(self, text):
         self._code_table[text] = hashed
         return hashed
 
+    def _wavedrom_block_sub(self, match):
+        # if this isn't a wavedrom diagram block, exit now
+        if match.group(2) != 'wavedrom':
+            return match.string[match.start():match.end()]
+
+        # dedent the block for processing
+        lead_indent, waves = self._uniform_outdent(match.group(3))
+        # default tags to wrap the wavedrom block in
+        open_tag, close_tag = '<script type="WaveDrom">\n', '</script>'
+
+        # check if the user would prefer to have the SVG embedded directly
+        if not isinstance(self.extras['wavedrom'], dict):
+            embed_svg = True
+        else:
+            # default behaviour is to embed SVGs
+            embed_svg = self.extras['wavedrom'].get('prefer_embed_svg', True)
+
+        if embed_svg:
+            try:
+                import wavedrom
+                waves = wavedrom.render(waves).tostring()
+                open_tag, close_tag = '<div>', '\n</div>'
+            except ImportError:
+                pass
+
+        # hash SVG to prevent <> chars being messed with
+        self._escape_table[waves] = _hash_text(waves)
+
+        return self._uniform_indent(
+            '\n%s%s%s\n' % (open_tag, self._escape_table[waves], close_tag),
+            lead_indent, include_empty_lines=True
+        )
+
+    def _do_wavedrom_blocks(self, text):
+        return self._fenced_code_block_re.sub(self._wavedrom_block_sub, text)
+
     _admonitions = r'admonition|attention|caution|danger|error|hint|important|note|tip|warning'
     _admonitions_re = re.compile(r'''
         ^(\ *)\.\.\ (%s)::\ *                # $1 leading indent, $2 the admonition
diff --git a/setup.py b/setup.py
@@ -31,7 +31,8 @@
 """
 
 extras_require = {
-    "code_syntax_highlighting": ["pygments>=2.7.3"]
+    "code_syntax_highlighting": ["pygments>=2.7.3"],
+    "wavedrom": ["wavedrom; python_version>='3.7'"]
 }
 # nested listcomp to combine all optional extras into convenient "all" option
 extras_require["all"] = [i for v in tuple(extras_require.values()) for i in v]
diff --git a/test/test.py b/test/test.py
@@ -4,11 +4,11 @@
 
 """The markdown2 test suite entry point."""
 
+import importlib
 import os
 from os.path import join, abspath, dirname
 import sys
 import logging
-
 import testlib
 
 log = logging.getLogger("test")
@@ -37,11 +37,12 @@ def setup():
 
     setup()
     default_tags = []
-    try:
-        import pygments  # noqa
-    except ImportError:
-        log.warning("skipping pygments tests ('pygments' module not found)")
-        default_tags.append("-pygments")
+    for extra_lib in ('pygments', 'wavedrom'):
+        try:
+            importlib.import_module(extra_lib)
+        except ImportError:
+            log.warning("skipping %s tests ('%s' module not found)" % (extra_lib, extra_lib))
+            default_tags.append("-%s" % extra_lib)
 
     retval = testlib.harness(testdir_from_ns=testdir_from_ns,
                              default_tags=default_tags)
diff --git a/test/tm-cases/wavedrom.html b/test/tm-cases/wavedrom.html
diff --git a/test/tm-cases/wavedrom.opts b/test/tm-cases/wavedrom.opts
@@ -0,0 +1 @@
+{"extras": ["wavedrom"]}
diff --git a/test/tm-cases/wavedrom.tags b/test/tm-cases/wavedrom.tags
@@ -0,0 +1 @@
+extra wavedrom
diff --git a/test/tm-cases/wavedrom.text b/test/tm-cases/wavedrom.text
@@ -0,0 +1,24 @@
+Here is a basic wavedrom diagram:
+```wavedrom
+{ "signal": [{ "name": "Alfa", "wave": "01.zx=ud.23.456789" }] }
+```
+
+And here is a more complex one, inside of a list
+
+* More complex diagram
+  * Inside of nested list
+    ```wavedrom
+    { signal: [
+        { name: "pclk", wave: 'p.......' },
+        { name: "Pclk", wave: 'P.......' },
+        { name: "nclk", wave: 'n.......' },
+        { name: "Nclk", wave: 'N.......' },
+        {},
+        { name: 'clk0', wave: 'phnlPHNL' },
+        { name: 'clk1', wave: 'xhlhLHl.' },
+        { name: 'clk2', wave: 'hpHplnLn' },
+        { name: 'clk3', wave: 'nhNhplPl' },
+        { name: 'clk4', wave: 'xlh.L.Hx' },
+    ]}
+    ```
+  * Making sure not to break indentation
diff --git a/test/tm-cases/wavedrom_no_embed.html b/test/tm-cases/wavedrom_no_embed.html
@@ -0,0 +1,29 @@
+<p>Here is a basic wavedrom diagram:</p>
+
+<script type="WaveDrom">
+{ "signal": [{ "name": "Alfa", "wave": "01.zx=ud.23.456789" }] }
+</script>
+
+<p>And here is a more complex one, inside of a list</p>
+
+<ul>
+<li>More complex diagram
+<ul>
+<li>Inside of nested list <br />
+<script type="WaveDrom">
+{ signal: [
+    { name: "pclk", wave: 'p.......' },
+    { name: "Pclk", wave: 'P.......' },
+    { name: "nclk", wave: 'n.......' },
+    { name: "Nclk", wave: 'N.......' },
+    {},
+    { name: 'clk0', wave: 'phnlPHNL' },
+    { name: 'clk1', wave: 'xhlhLHl.' },
+    { name: 'clk2', wave: 'hpHplnLn' },
+    { name: 'clk3', wave: 'nhNhplPl' },
+    { name: 'clk4', wave: 'xlh.L.Hx' },
+]}
+</script></li>
+<li>Making sure not to break indentation</li>
+</ul></li>
+</ul>
diff --git a/test/tm-cases/wavedrom_no_embed.opts b/test/tm-cases/wavedrom_no_embed.opts
@@ -0,0 +1 @@
+{"extras": {"wavedrom": {"prefer_embed_svg": False}}}
diff --git a/test/tm-cases/wavedrom_no_embed.tags b/test/tm-cases/wavedrom_no_embed.tags
@@ -0,0 +1 @@
+extra wavedrom
diff --git a/test/tm-cases/wavedrom_no_embed.text b/test/tm-cases/wavedrom_no_embed.text
@@ -0,0 +1,24 @@
+Here is a basic wavedrom diagram:
+```wavedrom
+{ "signal": [{ "name": "Alfa", "wave": "01.zx=ud.23.456789" }] }
+```
+
+And here is a more complex one, inside of a list
+
+* More complex diagram
+  * Inside of nested list
+    ```wavedrom
+    { signal: [
+        { name: "pclk", wave: 'p.......' },
+        { name: "Pclk", wave: 'P.......' },
+        { name: "nclk", wave: 'n.......' },
+        { name: "Nclk", wave: 'N.......' },
+        {},
+        { name: 'clk0', wave: 'phnlPHNL' },
+        { name: 'clk1', wave: 'xhlhLHl.' },
+        { name: 'clk2', wave: 'hpHplnLn' },
+        { name: 'clk3', wave: 'nhNhplPl' },
+        { name: 'clk4', wave: 'xlh.L.Hx' },
+    ]}
+    ```
+  * Making sure not to break indentation

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,8 @@`
`31`	`31`	`"""`
`32`	`32`
`33`	`33`	`extras_require = {`
`34`		`- "code_syntax_highlighting": ["pygments>=2.7.3"]`
	`34`	`+ "code_syntax_highlighting": ["pygments>=2.7.3"],`
	`35`	`+ "wavedrom": ["wavedrom; python_version>='3.7'"]`
`35`	`36`	`}`
`36`	`37`	`# nested listcomp to combine all optional extras into convenient "all" option`
`37`	`38`	`extras_require["all"] = [i for v in tuple(extras_require.values()) for i in v]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"extras": {"wavedrom": {"prefer_embed_svg": False}}}`