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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
#
# This file is part of m.css.
#
# Copyright © 2017, 2018, 2019, 2020, 2021, 2022, 2023
# Vladimír Vondruš <mosra@centrum.cz>
#
# 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.
#
import copy
import html
import os
import re
from docutils import nodes, utils
from docutils.parsers import rst
from docutils.parsers.rst import directives
from docutils.parsers.rst.roles import set_classes
try:
import latex2svg
import latex2svgextra
except ImportError:
# While the above was enough to make things work with Pelican 4.2 and
# before (and also works with other m.css tools like the Python doc
# generator), Pelican 4.5.1+ needs the below (4.5.0 didn't work with
# namespaced plugins at all). See the comment in m.code for further info.
import sys
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
import latex2svg
import latex2svgextra
default_settings = {
'INPUT': '',
'M_MATH_RENDER_AS_CODE': False,
'M_MATH_CACHE_FILE': 'm.math.cache'
}
settings = None
def _is_math_figure(parent):
# The parent has to be a figure, marked as m-figure
if not isinstance(parent, nodes.figure): return False
if 'm-figure' not in parent.get('classes', []): return False
# And as a first visible node of such type
for child in parent:
if not isinstance(child, nodes.Invisible): return False
return True
class Math(rst.Directive):
option_spec = {'class': directives.class_option,
'name': directives.unchanged}
has_content = True
def run(self):
set_classes(self.options)
self.assert_has_content()
parent = self.state.parent
# Fallback rendering as code requested
if settings['M_MATH_RENDER_AS_CODE']:
# If this is a math figure, replace the figure CSS class to have a
# matching border
if _is_math_figure(parent):
parent['classes'][parent['classes'].index('m-figure')] = 'm-code-figure'
content = nodes.raw('', html.escape('\n'.join(self.content)), format='html')
pre = nodes.literal_block('')
pre.append(content)
return [pre]
content = '\n'.join(self.content)
_, svg = latex2svgextra.fetch_cached_or_render("$$" + content + "$$")
# If this is the first real node inside a math figure, put the SVG
# directly inside
if _is_math_figure(parent):
node = nodes.raw(self.block_text, latex2svgextra.patch(content, svg, None, ' class="{}"'.format(' '.join(['m-math'] + self.options.get('classes', [])))), format='html')
node.line = self.content_offset + 1
self.add_name(node)
return [node]
# Otherwise wrap it in a <div class="m-math">
node = nodes.raw(self.block_text, latex2svgextra.patch(content, svg, None, ''), format='html')
node.line = self.content_offset + 1
self.add_name(node)
container = nodes.container(**self.options)
container['classes'] += ['m-math']
container.append(node)
return [container]
def new_page(*args, **kwargs):
latex2svgextra.counter = 0
def math(role, rawtext, text, lineno, inliner, options={}, content=[]):
# In order to properly preserve backslashes (well, and backticks)
text = rawtext[rawtext.find('`') + 1:rawtext.rfind('`')]
# Fallback rendering as code requested
if settings['M_MATH_RENDER_AS_CODE']:
set_classes(options)
classes = []
if 'classes' in options:
classes += options['classes']
del options['classes']
content = nodes.raw('', html.escape(utils.unescape(text)), format='html')
node = nodes.literal(rawtext, '', **options)
node.append(content)
return [node], []
# Apply classes to the <svg> element instead of some outer <span>
set_classes(options)
classes = 'm-math'
if 'classes' in options:
classes += ' ' + ' '.join(options['classes'])
del options['classes']
depth, svg = latex2svgextra.fetch_cached_or_render("$" + text + "$")
attribs = ' class="{}"'.format(classes)
node = nodes.raw(rawtext, latex2svgextra.patch(text, svg, depth, attribs), format='html', **options)
return [node], []
def save_cache(*args, **kwargs):
if settings['M_MATH_CACHE_FILE']:
latex2svgextra.pickle_cache(settings['M_MATH_CACHE_FILE'])
def register_mcss(mcss_settings, hooks_pre_page, hooks_post_run, **kwargs):
global default_settings, settings
settings = copy.deepcopy(default_settings)
for key in settings.keys():
if key in mcss_settings: settings[key] = mcss_settings[key]
if settings['M_MATH_CACHE_FILE']:
settings['M_MATH_CACHE_FILE'] = os.path.join(settings['INPUT'], settings['M_MATH_CACHE_FILE'])
# Ensure that cache is unpickled again if M_MATH_CACHE_FILE is *not* set --
# otherwise tests will sporadically fail.
if settings['M_MATH_CACHE_FILE'] and os.path.exists(settings['M_MATH_CACHE_FILE']):
latex2svgextra.unpickle_cache(settings['M_MATH_CACHE_FILE'])
else:
latex2svgextra.unpickle_cache(None)
hooks_pre_page += [new_page]
hooks_post_run += [save_cache]
rst.directives.register_directive('math', Math)
rst.roles.register_canonical_role('math', math)
# Below is only Pelican-specific functionality. If Pelican is not found, these
# do nothing.
def _configure_pelican(pelicanobj):
register_mcss(mcss_settings=pelicanobj.settings, hooks_pre_page=[], hooks_post_run=[])
def register():
from pelican import signals
signals.initialized.connect(_configure_pelican)
signals.finalized.connect(save_cache)
signals.content_object_init.connect(new_page)
|
