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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
|
# -*- coding: utf-8 -*-
"""
The MIT License (MIT)
Copyright © 2015-2016 Franklin "Snaipe" Mathieu <http://snai.pe/>
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.
"""
from __future__ import unicode_literals
from docutils import core, frontend, nodes, utils, writers, languages, io
from docutils.utils.error_reporting import SafeString
from docutils.transforms import writer_aux
from docutils.parsers.rst import roles
from copy import deepcopy, copy
from .wrap import wrap
from .table import TableSizeCalculator, TableWriter
from .unicode import ref_to_unicode, u
from .get_terminal_size import get_terminal_size
import shutil
COLORS = ('black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white')
STYLES = ('bold', 'dim', 'italic', 'underline', 'blink', 'blink-fast', 'inverse', 'conceal', 'strikethrough')
class ANSICodes(object):
@staticmethod
def get_color_code(code, fg):
FG = 30
BG = 40
FG_256 = 38
BG_256 = 48
if code in COLORS:
shift = FG if fg else BG
return str(shift + COLORS.index(code))
elif isinstance(code, int) and 0 <= code <= 255:
shift = FG_256 if fg else BG_256
return str(shift) + ';5;%d' % int(code)
elif not isinstance(code, str) and hasattr(code, "__len__") and len(code) == 3:
for c in code:
if not 0 <= c <= 255:
raise Exception('Invalid color "%s"' % code)
r, g, b = code
shift = FG_256 if fg else BG_256
return str(shift) + ';2;%d;%d;%d' % (int(r), int(g), int(b))
raise Exception('Invalid color "%s"' % code)
@staticmethod
def get_style_code(code):
if code in STYLES:
return str(1 + STYLES.index(code))
raise Exception('Invalid style "%s"' % code)
@staticmethod
def to_ansi(codes):
return '\x1b[' + ';'.join(codes) + 'm'
NONE = '0'
RESET = to_ansi.__func__(NONE)
from .functional import npartial
class ANSITranslator(nodes.NodeVisitor):
class Context(object):
def __init__(self):
self.output = ''
self.indent_level = 0
self.in_list = False
self.has_title = False
self.list_counter = 0
self.node_type = ''
class StyleContext(object):
def __init__(self):
self.styles = set()
self.fg = ANSICodes.NONE
self.bg = ANSICodes.NONE
def __init__(self, document, termsize=None, **options):
nodes.NodeVisitor.__init__(self, document)
self.document = document
self.output = ''
self.lines = ['']
self.line = 0
self.indent_width = 2
self.termsize = termsize or get_terminal_size((80,20))
self.options = options
self.references = []
self.refcount = 0
self.ctx = self.Context()
self.ctx_stack = []
self.style = self.StyleContext()
self.style_stack = []
def push_ctx(self, **kwargs):
self.ctx_stack.append(self.ctx)
self.ctx = deepcopy(self.ctx)
for k, v in kwargs.items():
setattr(self.ctx, k, v)
def pop_ctx(self):
self.ctx = self.ctx_stack.pop()
def push_style(self, fg=None, bg=None, styles=[]):
self.style_stack.append(self.style)
self.style = deepcopy(self.style)
if fg:
self.style.fg = ANSICodes.get_color_code(fg, True)
if bg:
self.style.bg = ANSICodes.get_color_code(bg, False)
self.style.styles |= {ANSICodes.get_style_code(s) for s in styles}
self._restyle()
def pop_style(self):
self.style = self.style_stack.pop()
reset = self.style.fg == ANSICodes.NONE and \
self.style.bg == ANSICodes.NONE and \
not self.style.styles
self._restyle(reset)
def append(self, *args, **kwargs):
try:
strict = kwargs['strict']
except KeyError:
strict = False
if len(self.lines[self.line]) == 0 and not strict:
self.lines[self.line] += ' ' * self.ctx.indent_level * self.indent_width
for a in args:
self.lines[self.line] += u(a)
def newline(self, n=1):
self.lines.extend([''] * n)
self.line += n
def prevline(self, n=1):
self.line -= n
def nextline(self, n=1):
self.line += n
def popline(self):
l = self.lines.pop(self.line)
self.line -= 1
return l
def replaceline(self, newline, strict=True):
if strict:
self.lines[self.line] = newline
else:
self.lines[self.line] = ''
self.append(newline)
def addlines(self, lines, strict=False):
if strict:
self.lines.extend(lines)
self.line += len(lines)
self.newline()
else:
for l in lines:
self.append(l)
self.newline()
def _restyle(self, reset=False):
if reset:
self.append(ANSICodes.RESET)
styles = list(self.style.styles)
if self.style.fg != ANSICodes.NONE:
styles.append(self.style.fg)
if self.style.bg != ANSICodes.NONE:
styles.append(self.style.bg)
if styles:
self.append(ANSICodes.to_ansi(styles))
def strip_empty_lines(self):
remove_last_n = 0
for x in self.lines[::-1]:
if len(x.strip()) != 0:
break
remove_last_n += 1
if remove_last_n != 0:
self.lines = self.lines[:-remove_last_n]
# Structural nodes
def visit_document(self, node):
self.push_ctx()
def _print_references(self):
if not self.references:
return
self.push_style(styles = ['bold'])
self.append('References:')
self.pop_style()
self.newline(2)
self.push_ctx(indent_level = self.ctx.indent_level + 1)
for ref in self.references:
self.append('[%s]: <' % ref[0])
self.push_style(fg = 'cyan', styles = ['underline'])
self.append(ref[1])
self.pop_style()
self.append('>')
self.newline()
self.references = []
self.pop_ctx()
def depart_document(self, node):
self._print_references()
self.depart_section(node)
self.pop_ctx()
self.strip_empty_lines()
self.output = '\n'.join(self.lines)
def wrap_current_line(self):
indent = self.ctx.indent_level * self.indent_width
sublines = wrap(self.curline, width = self.termsize[0] - indent,
subsequent_indent = ' ' * indent)
self.popline()
self.addlines(sublines, strict=True)
def depart_paragraph(self, node):
if self.options.get('wrap_paragraphs', True):
self.wrap_current_line()
if not self.ctx.in_list:
self.newline()
def visit_title(self, node):
self.push_style(styles=['bold'])
def depart_title(self, node):
self.pop_style()
self.push_ctx(has_title = True, indent_level = self.ctx.indent_level + 1)
self.newline(2)
def visit_subtitle(self, node):
self.prevline(2)
self.append(' - ')
def depart_subtitle(self, node):
self.nextline(2)
def visit_Text(self, node):
self.append(node.astext())
def depart_section(self, node):
if self.ctx.has_title:
self.pop_ctx()
def depart_transition(self, node):
indent = (self.ctx.indent_level + 2) * self.indent_width
char = '╌' if self.options['unicode'] else '-'
self.append(' ' * indent + char * (self.termsize[0] - 2 * indent) + ' ' * indent, strict=True)
self.newline(2)
def _get_uri(self, node):
uri = node.attributes.get('refuri', '')
if not uri:
uri = node.attributes.get('uri', '')
return uri
def visit_reference(self, node):
if self._get_uri(node) == node.astext().strip():
self.append('<')
self.push_style(fg = 'cyan', styles = ['underline'])
def depart_reference(self, node):
self.pop_style()
if self._get_uri(node) == node.astext().strip():
self.append('>')
else:
self.references.append((self.refcount, self._get_uri(node)))
if self.options['unicode'] and self.options.get('unicode_superscript', False):
self.append(ref_to_unicode(self.refcount))
else:
self.append(' [%s]' % self.refcount)
self.refcount += 1
# Style nodes
visit_strong = npartial(push_style, styles=['bold'])
depart_strong = npartial(pop_style)
visit_emphasis = npartial(push_style, styles=['italic'])
depart_emphasis = npartial(pop_style)
def visit_TextElement(self, node):
ansi_props = [x[5:] for x in node.attributes['classes'] if x.startswith('ansi-')]
style = {
'fg': next((x[3:] for x in ansi_props if x.startswith('fg-') and x[3:] in COLORS), None),
'bg': next((x[3:] for x in ansi_props if x.startswith('bg-') and x[3:] in COLORS), None),
'styles': (x for x in ansi_props if x in STYLES)
}
self.push_style(**style)
def depart_TextElement(self, node):
self.pop_style()
visit_inline = visit_TextElement
depart_inline = depart_TextElement
# Lists
def visit_enumerated_list(self, node):
strt = node.attributes.get('start', 1)
self.push_ctx(in_list = True,
list_counter = strt)
def depart_enumerated_list(self, node):
self.pop_ctx()
if not self.ctx.in_list:
self.newline()
def visit_bullet_list(self, node):
self.push_ctx(in_list = True,
list_counter = 0)
def depart_bullet_list(self, node):
self.pop_ctx()
if not self.ctx.in_list:
self.newline()
def visit_list_item(self, node):
if self.ctx.list_counter:
self.append(str(self.ctx.list_counter) + '. ')
self.ctx.list_counter += 1
else:
self.append('• ' if self.options['unicode'] else '* ')
self.push_ctx(indent_level = self.ctx.indent_level + 1)
def depart_list_item(self, node):
self.pop_ctx()
visit_definition_list = npartial(push_ctx, in_list=True, list_counter=0)
depart_definition_list = npartial(pop_ctx)
def visit_definition(self, node):
self.newline()
self.push_ctx(indent_level = self.ctx.indent_level + 1)
def depart_definition(self, node):
self.newline()
self.pop_ctx()
visit_option_list = npartial(push_ctx, in_list=True, list_counter=0)
depart_option_list = npartial(pop_ctx)
def depart_option(self, node):
self.append(' | ')
def depart_option_group(self, node):
self.replaceline(self.lines[self.line][:-3], strict=True)
self.push_ctx(indent_level = self.ctx.indent_level + 2)
self.newline()
def visit_option_argument(self, node):
self.append(' ')
def depart_option_list_item(self, node):
self.pop_ctx()
# Tables
def visit_table(self, node):
props = TableSizeCalculator(self.document)
node.walkabout(props)
writer = TableWriter(props, self.document, **self.options)
node.walkabout(writer)
self.addlines(writer.lines)
# Do not recurse
raise nodes.SkipChildren
def depart_table(self, node):
self.newline()
# Misc
def depart_image(self, node):
if type(node.parent) == nodes.figure:
self.visit_reference(node)
self.append('[' + node.attributes.get('alt', 'Image') + ']')
self.depart_reference(node)
self.newline()
else:
self.append('[' + node.attributes.get('alt', 'Image') + ']')
def depart_caption(self, node):
self.newline(2)
def visit_substitution_definition(self, node):
raise nodes.SkipChildren
def visit_comment(self, node):
raise nodes.SkipChildren
def depart_admonition(self, node):
if self.ctx.has_title:
self.pop_ctx()
def visit_block_quote(self, node):
self.push_ctx(indent_level = self.ctx.indent_level + 1)
def depart_block_quote(self, node):
self.pop_ctx()
def depart_literal_block(self, node):
sublines = self.curline.split('\n')
self.replaceline(sublines[0])
self.newline()
self.addlines(sublines[1:])
self.newline()
def depart_line(self, node):
if len(self.curline.strip()) == 0:
self.newline()
else:
self.wrap_current_line()
def visit_line_block(self, node):
indent = self.ctx.indent_level + (1 if self.ctx.node_type == 'line_block' else 0)
self.push_ctx(indent_level = indent, node_type = 'line_block')
def depart_line_block(self, node):
self.pop_ctx()
if self.ctx.node_type != 'line_block':
self.newline()
def __getattr__(self, name):
if name.startswith('visit_') or name.startswith('depart_'):
def noop(*args, **kwargs):
pass
return noop
if name == 'curline':
return self.lines[self.line]
raise AttributeError(name)
|