Merge pull request #41 from bzindovic/bzindovic-part13-clarity-fix

[rust-101.git] / pycco-rs

diff --git a/pycco-rs b/pycco-rs
index 2e10184c26fddfacf198c6f18d3329a718bcda1b..3e6b29d213273d596dda4a5f03c40c24c07da9a1 100755 (executable)
--- a/pycco-rs
+++ b/pycco-rs
@@ -1,32 +1,49 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # A little wrapper around pycco, to add Rust support.
 import pycco, pycco_resources
 from pygments import lexers, formatters
-import re
+import sys, re
+
+# helper functions
+def patch_html(source, marker, new_text):
+    '''Find the [marker] in [source], and insert [new_text] after it.'''
+    assert source.count(marker) == 1
+    return source.replace(marker, marker + new_text, 1)
 
 # now, monkey-patch pycco for Rust support
-pycco.main.languages[".rs"] = { "name": "rust", "symbol": "//"}
-for ext, l in pycco.main.languages.items():
+pycco.main.supported_languages[".rs"] = { "name": "rust", "comment_symbol": "//"}
+for ext, l in pycco.main.supported_languages.items():
     # Does the line begin with a comment?
-    l["comment_matcher"] = re.compile(r"^\s*" + l["symbol"] + "\s?")
+    l["comment_matcher"] = re.compile(r"^\s*" + l["comment_symbol"] + "\s?")
     # The dividing token we feed into Pygments, to delimit the boundaries between
     # sections.
-    l["divider_text"] = "\n" + l["symbol"] + "DIVIDER\n"
+    l["divider_text"] = "\n" + l["comment_symbol"] + "DIVIDER\n"
     # The mirror of `divider_text` that we expect Pygments to return. We can split
     # on this to recover the original sections.
-    l["divider_html"] = re.compile(r'\n*<span class="c[1]?">' + l["symbol"] + 'DIVIDER</span>\n*')
+    l["divider_html"] = re.compile(r'\n*<span class="c[1]?">' + l["comment_symbol"] + 'DIVIDER</span>\n*')
     # Get the Pygments Lexer for this language.
     l["lexer"] = lexers.get_lexer_by_name(l["name"])
-# and monkey-patch for a custom CSS file
-html_src = pycco_resources.html
-
-css_marker = '<link rel="stylesheet" href="{{ stylesheet }}">'
-custom_css = '<link rel="stylesheet" href="pycco_custom.css"><meta name="viewport" content="width=device-width">'
-html_src = html_src.replace(css_marker, css_marker+custom_css, 1)
-
-title_marker = '<title>'
-html_src = html_src.replace(title_marker, title_marker + 'Rust-101: ', 1)
 
-pycco_resources.pycco_template = pycco_resources.template(html_src)
+# and monkey-patch the function generating the output to do some post-processing
+generate_documentation_orig = pycco.main.generate_documentation
+generate_documentation_called = False
+def generate_documentation(*args, **kwargs):
+    global generate_documentation_called
+    generate_documentation_called = True
+    result = generate_documentation_orig(*args, **kwargs)
+    # now patch it
+    result = patch_html(result, b'<link rel="stylesheet" href="pycco.css">',
+                        b'<link rel="stylesheet" href="pycco_custom.css"><meta name="viewport" content="width=device-width">')
+    result = patch_html(result, b'<title>', b'Rust-101: ')
+    ## remove empty code blocks
+    result = re.sub(b'''<div class='code'>
+ *<div class="highlight"><pre>(<span></span>)?</pre></div>
+ *</div>''', b'<!-- empty code block -->', result)
+    # done
+    return result
+pycco.main.generate_documentation = generate_documentation
 
+# call pycco
+assert len(sys.argv) == 2
 pycco.main.main()
+assert generate_documentation_called