1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
# -*- coding: utf-8 -*-
# Copyright © 2012-2014 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
# Add sphinx compatibility option
CodeBlock.option_spec['linenos'] = directives.unchanged
class FlexibleCodeBlock(CodeBlock):
def run(self):
if 'linenos' in self.options:
self.options['number-lines'] = self.options['linenos']
return super(FlexibleCodeBlock, self).run()
CodeBlock = FlexibleCodeBlock
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)
# Add sphinx compatibility option
listing_spec = Include.option_spec
listing_spec['linenos'] = directives.unchanged
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
option_spec = listing_spec
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
if 'linenos' in self.options:
self.options['number-lines'] = self.options['linenos']
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
|
