kr.motd.maven.sphinx.dist.CommonMark.render.renderer.py Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sphinx-maven-plugin Show documentation

Maven plugin that creates the site with Sphinx

There is a newer version: 2.10.0

from __future__ import unicode_literals


class Renderer(object):
    def render(self, ast):
        """Walks the AST and calls member methods for each Node type.

        @param ast {Node} The root of the abstract syntax tree.
        """
        walker = ast.walker()

        self.buf = ''
        self.last_out = '\n'

        event = walker.nxt()
        while event is not None:
            type_ = event['node'].t
            if hasattr(self, type_):
                getattr(self, type_)(event['node'], event['entering'])
            event = walker.nxt()

        return self.buf

    def lit(self, s):
        """Concatenate a literal string to the buffer.

        @param str {String} The string to concatenate.
        """
        self.buf += s
        self.last_out = s

    def cr(self):
        if self.last_out != '\n':
            self.lit('\n')

    def out(self, s):
        """Concatenate a string to the buffer possibly escaping the content.

        Concrete renderer implementations should override this method.

        @param str {String} The string to concatenate.
        """
        self.lit(s)