vim-rana-local/plugin/packages/wakatime/packages/pygments_py2/pygments/formatters/rtf.py

148 lines
4.9 KiB
Python
Raw Normal View History

2013-09-22 23:22:11 +00:00
# -*- coding: utf-8 -*-
"""
pygments.formatters.rtf
~~~~~~~~~~~~~~~~~~~~~~~
A formatter that generates RTF files.
2014-12-01 06:19:45 +00:00
:copyright: Copyright 2006-2014 by the Pygments team, see AUTHORS.
2013-09-22 23:22:11 +00:00
:license: BSD, see LICENSE for details.
"""
from pygments.formatter import Formatter
2014-12-01 06:19:45 +00:00
from pygments.util import get_int_opt, _surrogatepair
2013-09-22 23:22:11 +00:00
__all__ = ['RtfFormatter']
class RtfFormatter(Formatter):
"""
Format tokens as RTF markup. This formatter automatically outputs full RTF
documents with color information and other useful stuff. Perfect for Copy and
2014-12-01 06:19:45 +00:00
Paste into Microsoft(R) Word(R) documents.
2013-09-22 23:22:11 +00:00
2014-12-01 06:19:45 +00:00
Please note that ``encoding`` and ``outencoding`` options are ignored.
The RTF format is ASCII natively, but handles unicode characters correctly
thanks to escape sequences.
.. versionadded:: 0.6
2013-09-22 23:22:11 +00:00
Additional options accepted:
`style`
The style to use, can be a string or a Style subclass (default:
``'default'``).
`fontface`
The used font famliy, for example ``Bitstream Vera Sans``. Defaults to
some generic font which is supposed to have fixed width.
2014-12-01 06:19:45 +00:00
`fontsize`
Size of the font used. Size is specified in half points. The
default is 24 half-points, giving a size 12 font.
.. versionadded:: 2.0
2013-09-22 23:22:11 +00:00
"""
name = 'RTF'
aliases = ['rtf']
filenames = ['*.rtf']
def __init__(self, **options):
2014-12-01 06:19:45 +00:00
r"""
2013-09-22 23:22:11 +00:00
Additional options accepted:
``fontface``
Name of the font used. Could for example be ``'Courier New'``
to further specify the default which is ``'\fmodern'``. The RTF
specification claims that ``\fmodern`` are "Fixed-pitch serif
and sans serif fonts". Hope every RTF implementation thinks
the same about modern...
2014-12-01 06:19:45 +00:00
2013-09-22 23:22:11 +00:00
"""
Formatter.__init__(self, **options)
self.fontface = options.get('fontface') or ''
2014-12-01 06:19:45 +00:00
self.fontsize = get_int_opt(options, 'fontsize', 0)
2013-09-22 23:22:11 +00:00
def _escape(self, text):
2014-12-01 06:19:45 +00:00
return text.replace(u'\\', u'\\\\') \
.replace(u'{', u'\\{') \
.replace(u'}', u'\\}')
2013-09-22 23:22:11 +00:00
def _escape_text(self, text):
# empty strings, should give a small performance improvment
if not text:
2014-12-01 06:19:45 +00:00
return u''
2013-09-22 23:22:11 +00:00
# escape text
text = self._escape(text)
buf = []
for c in text:
2014-12-01 06:19:45 +00:00
cn = ord(c)
if cn < (2**7):
# ASCII character
2013-09-22 23:22:11 +00:00
buf.append(str(c))
2014-12-01 06:19:45 +00:00
elif (2**7) <= cn < (2**16):
# single unicode escape sequence
buf.append(u'{\\u%d}' % cn)
elif (2**16) <= cn:
# RTF limits unicode to 16 bits.
# Force surrogate pairs
buf.append(u'{\\u%d}{\\u%d}' % _surrogatepair(cn))
2013-09-22 23:22:11 +00:00
2014-12-01 06:19:45 +00:00
return u''.join(buf).replace(u'\n', u'\\par\n')
2013-09-22 23:22:11 +00:00
def format_unencoded(self, tokensource, outfile):
# rtf 1.8 header
2014-12-01 06:19:45 +00:00
outfile.write(u'{\\rtf1\\ansi\\uc0\\deff0'
u'{\\fonttbl{\\f0\\fmodern\\fprq1\\fcharset0%s;}}'
u'{\\colortbl;' % (self.fontface and
u' ' + self._escape(self.fontface) or
u''))
2013-09-22 23:22:11 +00:00
# convert colors and save them in a mapping to access them later.
color_mapping = {}
offset = 1
for _, style in self.style:
for color in style['color'], style['bgcolor'], style['border']:
if color and color not in color_mapping:
color_mapping[color] = offset
2014-12-01 06:19:45 +00:00
outfile.write(u'\\red%d\\green%d\\blue%d;' % (
2013-09-22 23:22:11 +00:00
int(color[0:2], 16),
int(color[2:4], 16),
int(color[4:6], 16)
))
offset += 1
2014-12-01 06:19:45 +00:00
outfile.write(u'}\\f0 ')
if self.fontsize:
outfile.write(u'\\fs%d' % (self.fontsize))
2013-09-22 23:22:11 +00:00
# highlight stream
for ttype, value in tokensource:
while not self.style.styles_token(ttype) and ttype.parent:
ttype = ttype.parent
style = self.style.style_for_token(ttype)
buf = []
if style['bgcolor']:
2014-12-01 06:19:45 +00:00
buf.append(u'\\cb%d' % color_mapping[style['bgcolor']])
2013-09-22 23:22:11 +00:00
if style['color']:
2014-12-01 06:19:45 +00:00
buf.append(u'\\cf%d' % color_mapping[style['color']])
2013-09-22 23:22:11 +00:00
if style['bold']:
2014-12-01 06:19:45 +00:00
buf.append(u'\\b')
2013-09-22 23:22:11 +00:00
if style['italic']:
2014-12-01 06:19:45 +00:00
buf.append(u'\\i')
2013-09-22 23:22:11 +00:00
if style['underline']:
2014-12-01 06:19:45 +00:00
buf.append(u'\\ul')
2013-09-22 23:22:11 +00:00
if style['border']:
2014-12-01 06:19:45 +00:00
buf.append(u'\\chbrdr\\chcfpat%d' %
2013-09-22 23:22:11 +00:00
color_mapping[style['border']])
2014-12-01 06:19:45 +00:00
start = u''.join(buf)
2013-09-22 23:22:11 +00:00
if start:
2014-12-01 06:19:45 +00:00
outfile.write(u'{%s ' % start)
2013-09-22 23:22:11 +00:00
outfile.write(self._escape_text(value))
if start:
2014-12-01 06:19:45 +00:00
outfile.write(u'}')
2013-09-22 23:22:11 +00:00
2014-12-01 06:19:45 +00:00
outfile.write(u'}')