Imported Upstream version 6.2.1upstream/6.2.1

1 files changed, 109 insertions, 0 deletions

diff --git a/nikola/plugins/compile/rest/listing.py b/nikola/plugins/compile/rest/listing.py
new file mode 100644
index 0000000..31975bb
--- /dev/null
+++ b/nikola/plugins/compile/rest/listing.py
@@ -0,0 +1,109 @@
+# -*- coding: utf-8 -*-
+
+# Copyright © 2012-2013 Roberto Alsina and others.
+
+# Permission is hereby granted, free of charge, to any
+# person obtaining a copy of this software and associated
+# documentation files (the "Software"), to deal in the
+# Software without restriction, including without limitation
+# the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the
+# Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice
+# shall be included in all copies or substantial portions of
+# the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
+# OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+# OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+""" Define and register a listing directive using the existing CodeBlock """
+
+
+from __future__ import unicode_literals
+from codecs import open as codecs_open  # for patching purposes
+import os
+try:
+    from urlparse import urlunsplit
+except ImportError:
+    from urllib.parse import urlunsplit  # NOQA
+
+from docutils import core
+from docutils import nodes
+from docutils.parsers.rst import Directive, directives
+from docutils.parsers.rst.directives.misc import Include
+try:
+    from docutils.parsers.rst.directives.body import CodeBlock
+except ImportError:  # docutils < 0.9 (Debian Sid For The Loss)
+    class CodeBlock(Directive):
+        required_arguments = 1
+        has_content = True
+        CODE = '<pre>{0}</pre>'
+
+        def run(self):
+            """ Required by the Directive interface. Create docutils nodes """
+            return [nodes.raw('', self.CODE.format('\n'.join(self.content)), format='html')]
+    directives.register_directive('code', CodeBlock)
+
+
+from nikola.plugin_categories import RestExtension
+
+
+class Plugin(RestExtension):
+
+    name = "rest_listing"
+
+    def set_site(self, site):
+        self.site = site
+        # Even though listings don't use CodeBlock anymore, I am
+        # leaving these to make the code directive work with
+        # docutils < 0.9
+        directives.register_directive('code-block', CodeBlock)
+        directives.register_directive('sourcecode', CodeBlock)
+        directives.register_directive('listing', Listing)
+        return super(Plugin, self).set_site(site)
+
+
+class Listing(Include):
+    """ listing directive: create a highlighted block of code from a file in listings/
+
+    Usage:
+
+        .. listing:: nikola.py python
+           :number-lines:
+
+    """
+    has_content = False
+    required_arguments = 1
+    optional_arguments = 1
+
+    def run(self):
+        fname = self.arguments.pop(0)
+        lang = self.arguments.pop(0)
+        fpath = os.path.join('listings', fname)
+        self.arguments.insert(0, fpath)
+        self.options['code'] = lang
+        with codecs_open(fpath, 'rb+', 'utf8') as fileobject:
+            self.content = fileobject.read().splitlines()
+        self.state.document.settings.record_dependencies.add(fpath)
+        target = urlunsplit(("link", 'listing', fname, '', ''))
+        generated_nodes = (
+            [core.publish_doctree('`{0} <{1}>`_'.format(fname, target))[0]])
+        generated_nodes += self.get_code_from_file(fileobject)
+        return generated_nodes
+
+    def get_code_from_file(self, data):
+        """ Create CodeBlock nodes from file object content """
+        return super(Listing, self).run()
+
+    def assert_has_content(self):
+        """ Listing has no content, override check from superclass """
+        pass