text.py

   1 # Copyright (C) 2002-2013 Jörg Lehmann <joergl@users.sourceforge.net>
   2 # Copyright (C) 2003-2011 Michael Schindler <m-schindler@users.sourceforge.net>
   3 # Copyright (C) 2002-2013 André Wobst <wobsta@users.sourceforge.net>
   4 #
   5 # This file is part of PyX (http://pyx.sourceforge.net/).
   6 #
   7 # PyX is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 2 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # PyX is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with PyX; if not, write to the Free Software
  19 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  20
  21 import atexit, errno, functools, glob, inspect, io, itertools, logging, os
  22 import queue, re, shutil, sys, tempfile, textwrap, threading
  23
  24 from pyx import config, unit, box, baseclasses, trafo, version, attr, style, path
  25 from pyx import bbox as bboxmodule
  26 from pyx.dvi import dvifile
  27
  28 logger = logging.getLogger("pyx")
  29
  30
  31 def indent_text(text):
  32     "Prepends two spaces to each line in text."
  33     return "".join("  " + line for line in text.splitlines(True))
  34
  35
  36 def remove_string(p, s):
  37     """Removes a string from a string.
  38
  39     The function removes the first occurrence of a string in another string.
  40
  41     :param str p: string to be removed
  42     :param str s: string to be searched
  43     :returns: tuple of the result string and a success boolean (``True`` when
  44         the string was removed)
  45     :rtype: tuple of str and bool
  46
  47     Example:
  48         >>> remove_string("XXX", "abcXXXdefXXXghi")
  49         ('abcdefXXXghi', True)
  50
  51     """
  52     r = s.replace(p, '', 1)
  53     return r, r != s
  54
  55
  56 def remove_pattern(p, s, ignore_nl=True):
  57     r"""Removes a pattern from a string.
  58
  59     The function removes the first occurence of the pattern from a string. It
  60     returns a tuple of the resulting string and the matching object (or
  61     ``None``, if the pattern did not match).
  62
  63     :param re.regex p: pattern to be removed
  64     :param str s: string to be searched
  65     :param bool ignore_nl: When ``True``, newlines in the string are ignored
  66         during the pattern search. The returned string will still contain all
  67         newline characters outside of the matching part of the string, whereas
  68         the returned matching object will not contain the newline characters
  69         inside of the matching part of the string.
  70     :returns: the result string and the match object or ``None`` if
  71         search failed
  72     :rtype: tuple of str and (re.match or None)
  73
  74     Example:
  75         >>> r, m = remove_pattern(re.compile("XXX"), 'ab\ncXX\nXdefXX\nX')
  76         >>> r
  77         'ab\ncdefXX\nX'
  78         >>> m.string[m.start():m.end()]
  79         'XXX'
  80
  81     """
  82     if ignore_nl:
  83         r = s.replace('\n', '')
  84         has_nl = r != s
  85     else:
  86         r = s
  87         has_nl = False
  88     m = p.search(r)
  89     if m:
  90         s_start = r_start = m.start()
  91         s_end = r_end = m.end()
  92         if has_nl:
  93             j = 0
  94             for c in s:
  95                 if c == '\n':
  96                     if j < r_end:
  97                         s_end += 1
  98                         if j <= r_start:
  99                             s_start += 1
 100                 else:
 101                     j += 1
 102         return s[:s_start] + s[s_end:], m
 103     return s, None
 104
 105
 106 def index_all(c, s):
 107     """Return list of positions of a character in a string.
 108
 109     Example:
 110         >>> index_all("X", "abXcdXef")
 111         [2, 5]
 112
 113     """
 114     assert len(c) == 1
 115     return [i for i, x in enumerate(s) if x == c]
 116
 117
 118 def pairwise(i):
 119     """Returns iterator over pairs of data from an iterable.
 120
 121     Example:
 122         >>> list(pairwise([1, 2, 3]))
 123         [(1, 2), (2, 3)]
 124
 125     """
 126     a, b = itertools.tee(i)
 127     next(b, None)
 128     return zip(a, b)
 129
 130
 131 def remove_nested_brackets(s, openbracket="(", closebracket=")", quote='"'):
 132     """Remove nested brackets
 133
 134     Return a modified string with all nested brackets 1 removed, i.e. only
 135     keep the first bracket nesting level. In case an opening bracket is
 136     immediately followed by a quote, the quoted string is left untouched,
 137     even if it contains brackets. The use-case for that are files in the
 138     folder "Program Files (x86)".
 139
 140     If the bracket nesting level is broken (unbalanced), the unmodified
 141     string is returned.
 142
 143     Example:
 144         >>> remove_nested_brackets('aaa("bb()bb" cc(dd(ee))ff)ggg'*2)
 145         'aaa("bb()bb" ccff)gggaaa("bb()bb" ccff)ggg'
 146
 147     """
 148     openpos = index_all(openbracket, s)
 149     closepos = index_all(closebracket, s)
 150     if quote is not None:
 151         quotepos = index_all(quote, s)
 152         for openquote, closequote in pairwise(quotepos):
 153              if openquote-1 in openpos:
 154                  # ignore brackets in quoted string
 155                  openpos = [pos for pos in openpos
 156                             if not (openquote < pos < closequote)]
 157                  closepos = [pos for pos in closepos
 158                              if not (openquote < pos < closequote)]
 159     if len(openpos) != len(closepos):
 160         # unbalanced brackets
 161         return s
 162
 163     # keep the original string in case we need to return due to broken nesting levels
 164     r = s
 165
 166     level = 0
 167     # Iterate over the bracket positions from the end.
 168     # We go reversely to be able to immediately remove nested bracket levels
 169     # without influencing bracket positions yet to come in the loop.
 170     for pos, leveldelta in sorted(itertools.chain(zip(openpos, itertools.repeat(-1)),
 171                                                   zip(closepos, itertools.repeat(1))),
 172                                   reverse=True):
 173         # the current bracket nesting level
 174         level += leveldelta
 175         if level < 0:
 176             # unbalanced brackets
 177             return s
 178         if leveldelta == 1 and level == 2:
 179             # a closing bracket to cut after
 180             endpos = pos+1
 181         if leveldelta == -1 and level == 1:
 182             # an opening bracket to cut at -> remove
 183             r = r[:pos] + r[endpos:]
 184     return r
 185
 186
 187 class TexResultError(ValueError):
 188     "Error raised by :class:`texmessage` parsers."
 189     pass
 190
 191
 192 class texmessage:
 193     """Collection of TeX output parsers.
 194
 195     This class is not meant to be instanciated. Instead, it serves as a
 196     namespace for TeX output parsers, which are functions receiving a TeX
 197     output and returning parsed output.
 198
 199     In addition, this class also contains some generator functions (namely
 200     :attr:`texmessage.no_file` and :attr:`texmessage.pattern`), which return a
 201     function according to the given parameters. They are used to generate some
 202     of the parsers in this class and can be used to create others as well.
 203     """
 204
 205     start_pattern = re.compile(r"This is [-0-9a-zA-Z\s_]*TeX")
 206
 207     @staticmethod
 208     def start(msg):
 209         r"""Validate TeX/LaTeX startup message including scrollmode test.
 210
 211         Example:
 212             >>> texmessage.start(r'''
 213             ... This is e-TeX (version)
 214             ... *! Undefined control sequence.
 215             ... <*> \raiseerror
 216             ...                %
 217             ... ''')
 218             ''
 219
 220         """
 221         # check for "This is e-TeX" etc.
 222         if not texmessage.start_pattern.search(msg):
 223             raise TexResultError("TeX startup failed")
 224
 225         # check for \raiseerror -- just to be sure that communication works
 226         new = msg.split("*! Undefined control sequence.\n<*> \\raiseerror\n               %\n", 1)[-1]
 227         if msg == new:
 228             raise TexResultError("TeX scrollmode check failed")
 229         return new
 230
 231     @staticmethod
 232     def no_file(fileending, qualname=None):
 233         "Generator function to ignore the missing file message for fileending."
 234         def check(msg):
 235             "Ignore the missing {} file message."
 236             return msg.replace("No file texput.%s." % fileending, "").replace("No file %s%stexput.%s." % (os.curdir, os.sep, fileending), "")
 237         check.__doc__ = check.__doc__.format(fileending)
 238         if qualname is not None:
 239             check.__qualname__ = qualname
 240         return check
 241
 242     no_aux = staticmethod(no_file.__func__("aux", "texmessage.no_aux"))
 243     no_nav = staticmethod(no_file.__func__("nav", "texmessage.no_nav"))
 244
 245     aux_pattern = re.compile(r'\(([^()]+\.aux|"[^"]+\.aux")\)')
 246     log_pattern = re.compile(r"Transcript written on .*texput\.log\.", re.DOTALL)
 247
 248     @staticmethod
 249     def end(msg):
 250         "Validate TeX shutdown message."
 251         msg = re.sub(texmessage.aux_pattern, "", msg).replace("(see the transcript file for additional information)", "")
 252
 253         # check for "Transcript written on ...log."
 254         msg, m = remove_pattern(texmessage.log_pattern, msg)
 255         if not m:
 256             raise TexResultError("TeX logfile message expected")
 257         return msg
 258
 259     quoted_file_pattern = re.compile(r'\("(?P<filename>[^"]+)".*?\)')
 260     file_pattern = re.compile(r'\((?P<filename>[^"][^ )]*).*?\)', re.DOTALL)
 261
 262     @staticmethod
 263     def load(msg):
 264         """Ignore file loading messages.
 265
 266         Removes text starting with a round bracket followed by a filename
 267         ignoring all further text until the corresponding closing bracket.
 268         Quotes and/or line breaks in the filename are handled as needed for TeX
 269         output.
 270
 271         Without quoting the filename, the necessary removal of line breaks is
 272         not well defined and the different possibilities are tested to check
 273         whether one solution is ok. The last of the examples below checks this
 274         behavior.
 275
 276         Examples:
 277             >>> texmessage.load(r'''other (text.py) things''')
 278             'other  things'
 279             >>> texmessage.load(r'''other ("text.py") things''')
 280             'other  things'
 281             >>> texmessage.load(r'''other ("tex
 282             ... t.py" further (ignored)
 283             ... text) things''')
 284             'other  things'
 285             >>> texmessage.load(r'''other (t
 286             ... ext
 287             ... .py
 288             ... fur
 289             ... ther (ignored) text) things''')
 290             'other  things'
 291
 292         """
 293         r = remove_nested_brackets(msg)
 294         r, m = remove_pattern(texmessage.quoted_file_pattern, r)
 295         while m:
 296             if not os.path.isfile(config.get("text", "chroot", "") + m.group("filename")):
 297                 return msg
 298             r, m = remove_pattern(texmessage.quoted_file_pattern, r)
 299         r, m = remove_pattern(texmessage.file_pattern, r, ignore_nl=False)
 300         while m:
 301             for filename in itertools.accumulate(m.group("filename").split("\n")):
 302                 if os.path.isfile(config.get("text", "chroot", "") + filename):
 303                     break
 304             else:
 305                 return msg
 306             r, m = remove_pattern(texmessage.file_pattern, r, ignore_nl=False)
 307         return r
 308
 309     quoted_def_pattern = re.compile(r'\("(?P<filename>[^"]+\.(fd|def))"\)')
 310     def_pattern = re.compile(r'\((?P<filename>[^"][^ )]*\.(fd|def))\)')
 311
 312     @staticmethod
 313     def load_def(msg):
 314         "Ignore font definition (``*.fd`` and ``*.def``) loading messages."
 315         r = msg
 316         for p in [texmessage.quoted_def_pattern, texmessage.def_pattern]:
 317             r, m = remove_pattern(p, r)
 318             while m:
 319                 if not os.path.isfile(config.get("text", "chroot", "") + m.group("filename")):
 320                     return msg
 321                 r, m = remove_pattern(texmessage.quoted_file_pattern, r)
 322         return r
 323
 324     quoted_graphics_pattern = re.compile(r'<"(?P<filename>[^"]+\.eps)">')
 325     graphics_pattern = re.compile(r'<(?P<filename>[^"][^>]*\.eps)>')
 326
 327     @staticmethod
 328     def load_graphics(msg):
 329         "Ignore graphics file (``*.eps``) loading messages."
 330         r = msg
 331         for p in [texmessage.quoted_graphics_pattern, texmessage.graphics_pattern]:
 332             r, m = remove_pattern(p, r)
 333             while m:
 334                 if not os.path.isfile(config.get("text", "chroot", "") + m.group("filename")):
 335                     return msg
 336                 r, m = remove_pattern(texmessage.quoted_file_pattern, r)
 337         return r
 338
 339     @staticmethod
 340     def ignore(msg):
 341         """Ignore all messages.
 342
 343         Should be used as a last resort only. You should write a proper TeX
 344         output parser function for the output you observe.
 345
 346         """
 347         return ""
 348
 349     @staticmethod
 350     def warn(msg):
 351         """Warn about all messages.
 352
 353         Similar to :attr:`ignore`, but writing a warning to the logger about
 354         the TeX output. This is considered to be better when you need to get it
 355         working quickly as you will still be prompted about the unresolved
 356         output, while the processing continues.
 357
 358         """
 359         if msg:
 360              logger.warning("ignoring TeX warnings:\n%s" % indent_text(msg.rstrip()))
 361         return ""
 362
 363     @staticmethod
 364     def pattern(p, warning, qualname=None):
 365         "Warn by regular expression pattern matching."
 366         def check(msg):
 367             "Warn about {}."
 368             msg, m = remove_pattern(p, msg, ignore_nl=False)
 369             while m:
 370                 logger.warning("ignoring %s:\n%s" % (warning, m.string[m.start(): m.end()].rstrip()))
 371                 msg, m = remove_pattern(p, msg, ignore_nl=False)
 372             return msg
 373         check.__doc__ = check.__doc__.format(warning)
 374         if qualname is not None:
 375             check.__qualname__ = qualname
 376         return check
 377
 378     box_warning = staticmethod(pattern.__func__(re.compile(r"^(Overfull|Underfull) \\[hv]box.*$(\n^..*$)*\n^$\n", re.MULTILINE),
 379                                "overfull/underfull box", qualname="texmessage.box_warning"))
 380     font_warning = staticmethod(pattern.__func__(re.compile(r"^LaTeX Font Warning: .*$(\n^\(Font\).*$)*", re.MULTILINE),
 381                                 "font substitutions of NFSS", qualname="texmessage.font_warning"))
 382     package_warning = staticmethod(pattern.__func__(re.compile(r"^package\s+(?P<packagename>\S+)\s+warning\s*:[^\n]+(?:\n\(?(?P=packagename)\)?[^\n]*)*", re.MULTILINE | re.IGNORECASE),
 383                                    "generic package messages", qualname="texmessage.package_warning"))
 384     rerun_warning = staticmethod(pattern.__func__(re.compile(r"^(LaTeX Warning: Label\(s\) may have changed\. Rerun to get cross-references right\s*\.)$", re.MULTILINE),
 385                                  "rerun required message", qualname="texmessage.rerun_warning"))
 386     nobbl_warning = staticmethod(pattern.__func__(re.compile(r"^[\s\*]*(No file .*\.bbl.)\s*", re.MULTILINE),
 387                                  "no-bbl message", qualname="texmessage.nobbl_warning"))
 388
 389
 390 ###############################################################################
 391 # textattrs
 392 ###############################################################################
 393
 394 _textattrspreamble = ""
 395
 396 class textattr:
 397     "a textattr defines a apply method, which modifies a (La)TeX expression"
 398
 399 class _localattr: pass
 400
 401 _textattrspreamble += r"""\gdef\PyXFlushHAlign{0}%
 402 \def\PyXragged{%
 403 \leftskip=0pt plus \PyXFlushHAlign fil%
 404 \rightskip=0pt plus 1fil%
 405 \advance\rightskip0pt plus -\PyXFlushHAlign fil%
 406 \parfillskip=0pt%
 407 \pretolerance=9999%
 408 \tolerance=9999%
 409 \parindent=0pt%
 410 \hyphenpenalty=9999%
 411 \exhyphenpenalty=9999}%
 412 """
 413
 414 class boxhalign(attr.exclusiveattr, textattr, _localattr):
 415
 416     def __init__(self, aboxhalign):
 417         self.boxhalign = aboxhalign
 418         attr.exclusiveattr.__init__(self, boxhalign)
 419
 420     def apply(self, expr):
 421         return r"\gdef\PyXBoxHAlign{%.5f}%s" % (self.boxhalign, expr)
 422
 423 boxhalign.left = boxhalign(0)
 424 boxhalign.center = boxhalign(0.5)
 425 boxhalign.right = boxhalign(1)
 426 # boxhalign.clear = attr.clearclass(boxhalign) # we can't defined a clearclass for boxhalign since it can't clear a halign's boxhalign
 427
 428
 429 class flushhalign(attr.exclusiveattr, textattr, _localattr):
 430
 431     def __init__(self, aflushhalign):
 432         self.flushhalign = aflushhalign
 433         attr.exclusiveattr.__init__(self, flushhalign)
 434
 435     def apply(self, expr):
 436         return r"\gdef\PyXFlushHAlign{%.5f}\PyXragged{}%s" % (self.flushhalign, expr)
 437
 438 flushhalign.left = flushhalign(0)
 439 flushhalign.center = flushhalign(0.5)
 440 flushhalign.right = flushhalign(1)
 441 # flushhalign.clear = attr.clearclass(flushhalign) # we can't defined a clearclass for flushhalign since it couldn't clear a halign's flushhalign
 442
 443
 444 class halign(boxhalign, flushhalign, _localattr):
 445
 446     def __init__(self, aboxhalign, aflushhalign):
 447         self.boxhalign = aboxhalign
 448         self.flushhalign = aflushhalign
 449         attr.exclusiveattr.__init__(self, halign)
 450
 451     def apply(self, expr):
 452         return r"\gdef\PyXBoxHAlign{%.5f}\gdef\PyXFlushHAlign{%.5f}\PyXragged{}%s" % (self.boxhalign, self.flushhalign, expr)
 453
 454 halign.left = halign(0, 0)
 455 halign.center = halign(0.5, 0.5)
 456 halign.right = halign(1, 1)
 457 halign.clear = attr.clearclass(halign)
 458 halign.boxleft = boxhalign.left
 459 halign.boxcenter = boxhalign.center
 460 halign.boxright = boxhalign.right
 461 halign.flushleft = halign.raggedright = flushhalign.left
 462 halign.flushcenter = halign.raggedcenter = flushhalign.center
 463 halign.flushright = halign.raggedleft = flushhalign.right
 464
 465
 466 class _mathmode(attr.attr, textattr, _localattr):
 467     "math mode"
 468
 469     def apply(self, expr):
 470         return r"$\displaystyle{%s}$" % expr
 471
 472 mathmode = _mathmode()
 473 clearmathmode = attr.clearclass(_mathmode)
 474
 475
 476 class _phantom(attr.attr, textattr, _localattr):
 477     "phantom text"
 478
 479     def apply(self, expr):
 480         return r"\phantom{%s}" % expr
 481
 482 phantom = _phantom()
 483 clearphantom = attr.clearclass(_phantom)
 484
 485
 486 _textattrspreamble += "\\newbox\\PyXBoxVBox%\n\\newdimen\\PyXDimenVBox%\n"
 487
 488 class parbox_pt(attr.sortbeforeexclusiveattr, textattr):
 489
 490     top = 1
 491     middle = 2
 492     bottom = 3
 493
 494     def __init__(self, width, baseline=top):
 495         self.width = width * 72.27 / (unit.scale["x"] * 72)
 496         self.baseline = baseline
 497         attr.sortbeforeexclusiveattr.__init__(self, parbox_pt, [_localattr])
 498
 499     def apply(self, expr):
 500         if self.baseline == self.top:
 501             return r"\linewidth=%.5ftruept\vtop{\hsize=\linewidth\textwidth=\linewidth{}%s}" % (self.width, expr)
 502         elif self.baseline == self.middle:
 503             return r"\linewidth=%.5ftruept\setbox\PyXBoxVBox=\hbox{{\vtop{\hsize=\linewidth\textwidth=\linewidth{}%s}}}\PyXDimenVBox=0.5\dp\PyXBoxVBox\setbox\PyXBoxVBox=\hbox{{\vbox{\hsize=\linewidth\textwidth=\linewidth{}%s}}}\advance\PyXDimenVBox by -0.5\dp\PyXBoxVBox\lower\PyXDimenVBox\box\PyXBoxVBox" % (self.width, expr, expr)
 504         elif self.baseline == self.bottom:
 505             return r"\linewidth=%.5ftruept\vbox{\hsize=\linewidth\textwidth=\linewidth{}%s}" % (self.width, expr)
 506         else:
 507             ValueError("invalid baseline argument")
 508
 509 parbox_pt.clear = attr.clearclass(parbox_pt)
 510
 511 class parbox(parbox_pt):
 512
 513     def __init__(self, width, **kwargs):
 514         parbox_pt.__init__(self, unit.topt(width), **kwargs)
 515
 516 parbox.clear = parbox_pt.clear
 517
 518
 519 _textattrspreamble += "\\newbox\\PyXBoxVAlign%\n\\newdimen\\PyXDimenVAlign%\n"
 520
 521 class valign(attr.sortbeforeexclusiveattr, textattr):
 522
 523     def __init__(self, avalign):
 524         self.valign = avalign
 525         attr.sortbeforeexclusiveattr.__init__(self, valign, [parbox_pt, _localattr])
 526
 527     def apply(self, expr):
 528         return r"\setbox\PyXBoxVAlign=\hbox{{%s}}\PyXDimenVAlign=%.5f\ht\PyXBoxVAlign\advance\PyXDimenVAlign by -%.5f\dp\PyXBoxVAlign\lower\PyXDimenVAlign\box\PyXBoxVAlign" % (expr, 1-self.valign, self.valign)
 529
 530 valign.top = valign(0)
 531 valign.middle = valign(0.5)
 532 valign.bottom = valign(1)
 533 valign.clear = valign.baseline = attr.clearclass(valign)
 534
 535
 536 _textattrspreamble += "\\newdimen\\PyXDimenVShift%\n"
 537
 538 class _vshift(attr.sortbeforeattr, textattr):
 539
 540     def __init__(self):
 541         attr.sortbeforeattr.__init__(self, [valign, parbox_pt, _localattr])
 542
 543     def apply(self, expr):
 544         return r"%s\setbox0\hbox{{%s}}\lower\PyXDimenVShift\box0" % (self.setheightexpr(), expr)
 545
 546 class vshift(_vshift):
 547     "vertical down shift by a fraction of a character height"
 548
 549     def __init__(self, lowerratio, heightstr="0"):
 550         _vshift.__init__(self)
 551         self.lowerratio = lowerratio
 552         self.heightstr = heightstr
 553
 554     def setheightexpr(self):
 555         return r"\setbox0\hbox{{%s}}\PyXDimenVShift=%.5f\ht0" % (self.heightstr, self.lowerratio)
 556
 557 class _vshiftmathaxis(_vshift):
 558     "vertical down shift by the height of the math axis"
 559
 560     def setheightexpr(self):
 561         return r"\setbox0\hbox{$\vcenter{\vrule width0pt}$}\PyXDimenVShift=\ht0"
 562
 563
 564 vshift.bottomzero = vshift(0)
 565 vshift.middlezero = vshift(0.5)
 566 vshift.topzero = vshift(1)
 567 vshift.mathaxis = _vshiftmathaxis()
 568 vshift.clear = attr.clearclass(_vshift)
 569
 570
 571 defaultsizelist = ["normalsize", "large", "Large", "LARGE", "huge", "Huge",
 572 None, "tiny", "scriptsize", "footnotesize", "small"]
 573
 574 class size(attr.sortbeforeattr, textattr):
 575     "font size"
 576
 577     def __init__(self, sizeindex=None, sizename=None, sizelist=defaultsizelist):
 578         if (sizeindex is None and sizename is None) or (sizeindex is not None and sizename is not None):
 579             raise ValueError("either specify sizeindex or sizename")
 580         attr.sortbeforeattr.__init__(self, [_mathmode, _vshift])
 581         if sizeindex is not None:
 582             if sizeindex >= 0 and sizeindex < sizelist.index(None):
 583                 self.size = sizelist[sizeindex]
 584             elif sizeindex < 0 and sizeindex + len(sizelist) > sizelist.index(None):
 585                 self.size = sizelist[sizeindex]
 586             else:
 587                 raise IndexError("index out of sizelist range")
 588         else:
 589             self.size = sizename
 590
 591     def apply(self, expr):
 592         return r"\%s{}%s" % (self.size, expr)
 593
 594 size.tiny = size(-4)
 595 size.scriptsize = size.script = size(-3)
 596 size.footnotesize = size.footnote = size(-2)
 597 size.small = size(-1)
 598 size.normalsize = size.normal = size(0)
 599 size.large = size(1)
 600 size.Large = size(2)
 601 size.LARGE = size(3)
 602 size.huge = size(4)
 603 size.Huge = size(5)
 604 size.clear = attr.clearclass(size)
 605
 606
 607 ###############################################################################
 608 # texrunner
 609 ###############################################################################
 610
 611
 612 class MonitorOutput(threading.Thread):
 613
 614     def __init__(self, name, output):
 615         """Deadlock-safe output stream reader and monitor.
 616
 617         An instance of this class creates a thread to continously read lines
 618         from a stream. By that a deadlock due to a full pipe is prevented. In
 619         addition, the stream content can be monitored for containing a certain
 620         string (see :meth:`expect` and :meth:`wait`) and return all the
 621         collected output (see :meth:`read`).
 622
 623         :param string name: name to be used while logging in :meth:`wait` and
 624             :meth:`done`
 625         :param file output: output stream
 626
 627         """
 628         self.output = output
 629         self._expect = queue.Queue(1)
 630         self._received = threading.Event()
 631         self._output = queue.Queue()
 632         threading.Thread.__init__(self, name=name)
 633         self.daemon = True
 634         self.start()
 635
 636     def expect(self, s):
 637         """Expect a string on a **single** line in the output.
 638
 639         This method must be called **before** the output occurs, i.e. before
 640         the input is written to the TeX/LaTeX process.
 641
 642         :param s: expected string or ``None`` if output is expected to become
 643             empty
 644         :type s: str or None
 645
 646         """
 647         self._expect.put_nowait(s)
 648
 649     def read(self):
 650         """Read all output collected since its previous call.
 651
 652         The output reading should be synchronized by the :meth:`expect`
 653         and :meth:`wait` methods.
 654
 655         :returns: collected output from the stream
 656         :rtype: str
 657
 658         """
 659         l = []
 660         try:
 661             while True:
 662                 l.append(self._output.get_nowait())
 663         except queue.Empty:
 664             pass
 665         return "".join(l).replace("\r\n", "\n").replace("\r", "\n")
 666
 667     def _wait(self, waiter, checker):
 668         """Helper method to implement :meth:`wait` and :meth:`done`.
 669
 670         Waits for an event using the *waiter* and *checker* functions while
 671         providing user feedback to the ``pyx``-logger using the warning level
 672         according to the ``wait`` and ``showwait`` from the ``text`` section of
 673         the pyx :mod:`config`.
 674
 675         :param function waiter: callback to wait for (the function gets called
 676             with a timeout parameter)
 677         :param function checker: callback returing ``True`` if
 678             waiting was successful
 679         :returns: ``True`` when wait was successful
 680         :rtype: bool
 681
 682         """
 683         wait = config.getint("text", "wait", 60)
 684         showwait = config.getint("text", "showwait", 5)
 685         if showwait:
 686             waited = 0
 687             hasevent = False
 688             while waited < wait and not hasevent:
 689                 if wait - waited > showwait:
 690                     waiter(showwait)
 691                     waited += showwait
 692                 else:
 693                     waiter(wait - waited)
 694                     waited += wait - waited
 695                 hasevent = checker()
 696                 if not hasevent:
 697                     if waited < wait:
 698                         logger.warning("Still waiting for {} "
 699                                        "after {} (of {}) seconds..."
 700                                        .format(self.name, waited, wait))
 701                     else:
 702                         logger.warning("The timeout of {} seconds expired "
 703                                        "and {} did not respond."
 704                                        .format(waited, self.name))
 705             return hasevent
 706         else:
 707             waiter(wait)
 708             return checker()
 709
 710     def wait(self):
 711         """Wait for the expected output to happen.
 712
 713         Waits either until a line containing the string set by the previous
 714         :meth:`expect` call is found, or a timeout occurs.
 715
 716         :returns: ``True`` when the expected string was found
 717         :rtype: bool
 718
 719         """
 720         r = self._wait(self._received.wait, self._received.isSet)
 721         if r:
 722             self._received.clear()
 723         return r
 724
 725     def done(self):
 726         """Waits until the output becomes empty.
 727
 728         Waits either until the output becomes empty, or a timeout occurs.
 729         The generated output can still be catched by :meth:`read` after
 730         :meth:`done` was successful.
 731
 732         In the proper workflow :meth:`expect` should be called with ``None``
 733         before the output completes, as otherwise a ``ValueError`` is raised
 734         in the :meth:`run`.
 735
 736         :returns: ``True`` when the output has become empty
 737         :rtype: bool
 738
 739         """
 740         return self._wait(self.join, lambda self=self: not self.is_alive())
 741
 742     def _readline(self):
 743         """Read a line from the output.
 744
 745         To be used **inside** the thread routine only.
 746
 747         :returns: one line of the output as a string
 748         :rtype: str
 749
 750         """
 751         while True:
 752             try:
 753                 return self.output.readline()
 754             except IOError as e:
 755                 if e.errno != errno.EINTR:
 756                      raise
 757
 758     def run(self):
 759         """Thread routine.
 760
 761         **Not** to be called from outside.
 762
 763         :raises ValueError: output becomes empty while some string is expected
 764
 765         """
 766         expect = None
 767         while True:
 768             line = self._readline()
 769             if expect is None:
 770                 try:
 771                     expect = self._expect.get_nowait()
 772                 except queue.Empty:
 773                     pass
 774             if not line:
 775                 break
 776             self._output.put(line)
 777             if expect is not None:
 778                 found = line.find(expect)
 779                 if found != -1:
 780                     self._received.set()
 781                     expect = None
 782         self.output.close()
 783         if expect is not None:
 784             raise ValueError("{} finished unexpectedly".format(self.name))
 785
 786
 787 class textbox_pt(box.rect, baseclasses.canvasitem):
 788
 789
 790     def __init__(self, x_pt, y_pt, left_pt, right_pt, height_pt, depth_pt, do_finish, fontmap, singlecharmode, fillstyles):
 791         """Text output.
 792
 793         An instance of this class contains the text output generated by PyX. It
 794         is a :class:`baseclasses.canvasitem` and thus can be inserted into a
 795         canvas.
 796
 797         .. A text has a center (x_pt, y_pt) as well as extents in x-direction
 798         .. (left_pt and right_pt) and y-direction (hight_pt and depth_pt). The
 799         .. textbox positions the output accordingly and scales it by the
 800         .. x-scale from the :mod:`unit`.
 801
 802         .. :param float x_pt: x coordinate of the center in pts
 803         .. :param float y_pt: y coordinate of the center in pts
 804         .. :param float left_pt: unscaled left extent in pts
 805         .. :param float right_pt: unscaled right extent in pts
 806         .. :param float height_pt: unscaled height in pts
 807         .. :param float depth_pt: unscaled depth in pts
 808         .. :param function do_finish: callable to execute :meth:`readdvipage`
 809         .. :param fontmap: force a fontmap to be used (instead of the default
 810         ..     depending on the output format)
 811         .. :type fontmap: None or fontmap
 812         .. :param bool singlecharmode: position each character separately
 813         .. :param fillstyles: fill styles to be applied
 814         .. :type fillstyles: list of fillstyles
 815
 816         """
 817         self.left = left_pt*unit.x_pt       #: left extent of the text (PyX length)
 818         self.right = right_pt*unit.x_pt     #: right extent of the text (PyX length)
 819         self.width = self.left + self.right #: width of the text (PyX length)
 820         self.height = height_pt*unit.x_pt   #: height of the text (PyX length)
 821         self.depth = depth_pt*unit.x_pt     #: height of the text (PyX length)
 822
 823         self.do_finish = do_finish
 824         self.fontmap = fontmap
 825         self.singlecharmode = singlecharmode
 826         self.fillstyles = fillstyles
 827
 828         self.texttrafo = trafo.scale(unit.scale["x"]).translated_pt(x_pt, y_pt)
 829         box.rect_pt.__init__(self, x_pt - left_pt*unit.scale["x"], y_pt - depth_pt*unit.scale["x"],
 830                                    (left_pt + right_pt)*unit.scale["x"],
 831                                    (depth_pt + height_pt)*unit.scale["x"],
 832                                    abscenter_pt = (left_pt*unit.scale["x"], depth_pt*unit.scale["x"]))
 833
 834         self._dvicanvas = None
 835
 836     def transform(self, *trafos):
 837         box.rect.transform(self, *trafos)
 838         for trafo in trafos:
 839             self.texttrafo = trafo * self.texttrafo
 840         if self._dvicanvas is not None:
 841             for trafo in trafos:
 842                 self._dvicanvas.trafo = trafo * self._dvicanvas.trafo
 843
 844     def readdvipage(self, dvifile, page):
 845         self._dvicanvas = dvifile.readpage([ord("P"), ord("y"), ord("X"), page, 0, 0, 0, 0, 0, 0],
 846                                            fontmap=self.fontmap, singlecharmode=self.singlecharmode, attrs=[self.texttrafo] + self.fillstyles)
 847
 848     @property
 849     def dvicanvas(self):
 850         if self._dvicanvas is None:
 851             self.do_finish()
 852         return self._dvicanvas
 853
 854     def marker(self, name):
 855         """Return the position of a marker.
 856
 857         :param str name: name of the marker
 858         :returns: position of the marker
 859         :rtype: tuple of two PyX lengths
 860
 861         This method returns the position of the marker of the given name
 862         within, previously defined by the ``\\PyXMarker{name}`` macro in the
 863         typeset text. Please do not use the ``@`` character within your name to
 864         prevent name clashes with PyX internal uses (although we don’t the
 865         marker feature internally right now).
 866
 867         Similar to generating actual output, the marker function accesses the
 868         DVI output, stopping. The :ref:`texipc` feature will allow for this access
 869         without stopping the TeX interpreter.
 870
 871         """
 872         return self.texttrafo.apply(*self.dvicanvas.markers[name])
 873
 874     def textpath(self):
 875         textpath = path.path()
 876         for item in self.dvicanvas.items:
 877             textpath += item.textpath()
 878         return textpath.transformed(self.texttrafo)
 879
 880     def processPS(self, file, writer, context, registry, bbox):
 881         abbox = bboxmodule.empty()
 882         self.dvicanvas.processPS(file, writer, context, registry, abbox)
 883         bbox += box.rect.bbox(self)
 884
 885     def processPDF(self, file, writer, context, registry, bbox):
 886         abbox = bboxmodule.empty()
 887         self.dvicanvas.processPDF(file, writer, context, registry, abbox)
 888         bbox += box.rect.bbox(self)
 889
 890
 891 class _marker:
 892     pass
 893
 894
 895 class errordetail:
 896     "Constants defining the verbosity of the :exc:`TexResultError`."
 897     none = 0    #: Without any input and output.
 898     default = 1 #: Input and parsed output shortend to 5 lines.
 899     full = 2    #: Full input and unparsed as well as parsed output.
 900
 901
 902 class Tee(object):
 903
 904     def __init__(self, *files):
 905         """Apply write, flush, and close to each of the given files."""
 906         self.files = files
 907
 908     def write(self, data):
 909         for file in self.files:
 910             file.write(data)
 911
 912     def flush(self):
 913         for file in self.files:
 914             file.flush()
 915
 916     def close(self):
 917         for file in self.files:
 918             file.close()
 919
 920 # The texrunner state represents the next (or current) execute state.
 921 STATE_START, STATE_PREAMBLE, STATE_TYPESET, STATE_DONE = range(4)
 922 PyXBoxPattern = re.compile(r"PyXBox:page=(?P<page>\d+),lt=(?P<lt>-?\d*((\d\.?)|(\.?\d))\d*)pt,rt=(?P<rt>-?\d*((\d\.?)|(\.?\d))\d*)pt,ht=(?P<ht>-?\d*((\d\.?)|(\.?\d))\d*)pt,dp=(?P<dp>-?\d*((\d\.?)|(\.?\d))\d*)pt:")
 923 dvi_pattern = re.compile(r"Output written on .*texput\.dvi \((?P<page>\d+) pages?, \d+ bytes\)\.", re.DOTALL)
 924
 925 class TexDoneError(Exception):
 926     pass
 927
 928
 929 class SingleRunner:
 930
 931     #: default :class:`texmessage` parsers at interpreter startup
 932     texmessages_start_default = [texmessage.start]
 933     #: default :class:`texmessage` parsers at interpreter shutdown
 934     texmessages_end_default = [texmessage.end, texmessage.font_warning, texmessage.rerun_warning, texmessage.nobbl_warning]
 935     #: default :class:`texmessage` parsers for preamble output
 936     texmessages_preamble_default = [texmessage.load]
 937     #: default :class:`texmessage` parsers for typeset output
 938     texmessages_run_default = [texmessage.font_warning, texmessage.box_warning, texmessage.package_warning,
 939                                       texmessage.load_def, texmessage.load_graphics]
 940
 941     def __init__(self, cmd,
 942                        texenc="ascii",
 943                        usefiles=[],
 944                        texipc=config.getboolean("text", "texipc", 0),
 945                        copyinput=None,
 946                        dvitype=False,
 947                        errordetail=errordetail.default,
 948                        texmessages_start=[],
 949                        texmessages_end=[],
 950                        texmessages_preamble=[],
 951                        texmessages_run=[]):
 952         """Base class for the TeX interface.
 953
 954         .. note:: This class cannot be used directly. It is the base class for
 955                   all texrunners and provides most of the implementation.
 956                   Still, to the end user the parameters except for *cmd*
 957                   are important, as they are preserved in derived classes
 958                   usually.
 959
 960         :param cmd: command and arguments to start the TeX interpreter
 961         :type cmd: list of str
 962         :param str texenc: encoding to use in the communication with the TeX
 963             interpreter
 964         :param usefiles: list of supplementary files to be copied to and from
 965             the temporary working directory (see :ref:`debug` for usage
 966             details)
 967         :type usefiles: list of str
 968         :param bool texipc: :ref:`texipc` flag.
 969         :param copyinput: filename or file to be used to store a copy of all
 970             the input passed to the TeX interpreter
 971         :type copyinput: None or str or file
 972         :param bool dvitype: flag to turn on dvitype-like output
 973         :param errordetail: verbosity of the :exc:`TexResultError`
 974         :type errordetail: :class:`errordetail`
 975         :param texmessages_start: additional message parsers at interpreter
 976             startup
 977         :type texmessages_start: list of :class:`texmessage` parsers
 978         :param texmessages_end: additional message parsers at interpreter
 979             shutdown
 980         :type texmessages_end: list of :class:`texmessage` parsers
 981         :param texmessages_preamble: additional message parsers for preamble
 982             output
 983         :type texmessages_preamble: list of :class:`texmessage` parsers
 984         :param texmessages_run: additional message parsers for typset output
 985         :type texmessages_run: list of :class:`texmessage` parsers
 986
 987         """
 988         self.cmd = cmd
 989         self.texenc = texenc
 990         self.usefiles = usefiles
 991         self.texipc = texipc
 992         self.copyinput = copyinput
 993         self.dvitype = dvitype
 994         self.errordetail = errordetail
 995         self.texmessages_start = texmessages_start
 996         self.texmessages_end = texmessages_end
 997         self.texmessages_preamble = texmessages_preamble
 998         self.texmessages_run = texmessages_run
 999
1000         self.state = STATE_START
1001         self.executeid = 0
1002         self.page = 0
1003
1004         self.needdvitextboxes = [] # when texipc-mode off
1005         self.dvifile = None
1006
1007     def _cleanup(self):
1008         """Clean-up TeX interpreter and tmp directory.
1009
1010         This funtion is hooked up in atexit to quit the TeX interpreter, to
1011         save the contents of usefiles, and to remove the temporary directory.
1012
1013         """
1014         try:
1015             if self.state > STATE_START:
1016                 if self.state < STATE_DONE:
1017                     self.do_finish()
1018                     if self.state < STATE_DONE: # cleanup while TeX is still running?
1019                         self.texoutput.expect(None)
1020                         self.force_done()
1021                         for f, msg in [(self.texinput.close, "We tried to communicate to %s to quit itself, but this seem to have failed. Trying by terminate signal now ...".format(self.name)),
1022                                        (self.popen.terminate, "Failed, too. Trying by kill signal now ..."),
1023                                        (self.popen.kill, "We tried very hard to get rid of the %s process, but we ultimately failed (as far as we can tell). Sorry.".format(self.name))]:
1024                             f()
1025                             if self.texoutput.done():
1026                                 break
1027                             logger.warning(msg)
1028                 for usefile in self.usefiles:
1029                     extpos = usefile.rfind(".")
1030                     try:
1031                         os.rename(os.path.join(self.tmpdir, "texput" + usefile[extpos:]), usefile)
1032                     except EnvironmentError:
1033                         logger.warning("Could not save '{}'.".format(usefile))
1034                         if os.path.isfile(usefile):
1035                             try:
1036                                 os.unlink(usefile)
1037                             except EnvironmentError:
1038                                 logger.warning("Failed to remove spurious file '{}'.".format(usefile))
1039         finally:
1040             shutil.rmtree(self.tmpdir, ignore_errors=True)
1041
1042     def _execute(self, expr, texmessages, oldstate, newstate):
1043         """Execute TeX expression.
1044
1045         :param str expr: expression to be passed to TeX
1046         :param texmessages: message parsers to analyse the textual output of
1047             TeX
1048         :type texmessages: list of :class:`texmessage` parsers
1049         :param int oldstate: state of the TeX interpreter prior to the
1050             expression execution
1051         :param int newstate: state of the TeX interpreter after to the
1052             expression execution
1053
1054         """
1055         assert STATE_PREAMBLE <= oldstate <= STATE_TYPESET
1056         assert oldstate == self.state
1057         assert newstate >= oldstate
1058         if newstate == STATE_DONE:
1059             self.texoutput.expect(None)
1060             self.texinput.write(expr)
1061         else:
1062             if oldstate == newstate == STATE_TYPESET:
1063                 self.page += 1
1064                 expr = "\\ProcessPyXBox{%s%%\n}{%i}" % (expr, self.page)
1065             self.executeid += 1
1066             self.texoutput.expect("PyXInputMarker:executeid=%i:" % self.executeid)
1067             expr += "%%\n\\PyXInput{%i}%%\n" % self.executeid
1068             self.texinput.write(expr)
1069         self.texinput.flush()
1070         self.state = newstate
1071         if newstate == STATE_DONE:
1072             wait_ok = self.texoutput.done()
1073         else:
1074             wait_ok = self.texoutput.wait()
1075         try:
1076             parsed = unparsed = self.texoutput.read()
1077             if not wait_ok:
1078                 raise TexResultError("TeX didn't respond as expected within the timeout period.")
1079             if newstate != STATE_DONE:
1080                 parsed, m = remove_string("PyXInputMarker:executeid=%s:" % self.executeid, parsed)
1081                 if not m:
1082                     raise TexResultError("PyXInputMarker expected")
1083                 if oldstate == newstate == STATE_TYPESET:
1084                     parsed, m = remove_pattern(PyXBoxPattern, parsed, ignore_nl=False)
1085                     if not m:
1086                         raise TexResultError("PyXBox expected")
1087                     if m.group("page") != str(self.page):
1088                         raise TexResultError("Wrong page number in PyXBox")
1089                     extent_pt = [float(x)*72/72.27 for x in m.group("lt", "rt", "ht", "dp")]
1090                     parsed, m = remove_string("[80.121.88.%s]" % self.page, parsed)
1091                     if not m:
1092                         raise TexResultError("PyXPageOutMarker expected")
1093             else:
1094                 # check for "Output written on ...dvi (1 page, 220 bytes)."
1095                 if self.page:
1096                     parsed, m = remove_pattern(dvi_pattern, parsed)
1097                     if not m:
1098                         raise TexResultError("TeX dvifile messages expected")
1099                     if m.group("page") != str(self.page):
1100                         raise TexResultError("wrong number of pages reported")
1101                 else:
1102                     parsed, m = remove_string("No pages of output.", parsed)
1103                     if not m:
1104                         raise TexResultError("no dvifile expected")
1105
1106             for t in texmessages:
1107                 parsed = t(parsed)
1108             if parsed.replace(r"(Please type a command or say `\end')", "").replace(" ", "").replace("*\n", "").replace("\n", ""):
1109                 raise TexResultError("unhandled TeX response (might be an error)")
1110         except TexResultError as e:
1111             if self.errordetail > errordetail.none:
1112                 def add(msg): e.args = (e.args[0] + msg,)
1113                 add("\nThe expression passed to TeX was:\n{}".format(indent_text(expr.rstrip())))
1114                 if self.errordetail == errordetail.full:
1115                     add("\nThe return message from TeX was:\n{}".format(indent_text(unparsed.rstrip())))
1116                 if self.errordetail == errordetail.default:
1117                     if parsed.count('\n') > 6:
1118                         parsed = "\n".join(parsed.split("\n")[:5] + ["(cut after 5 lines; use errordetail.full for all output)"])
1119                 add("\nAfter parsing the return message from TeX, the following was left:\n{}".format(indent_text(parsed.rstrip())))
1120             raise e
1121         if oldstate == newstate == STATE_TYPESET:
1122             return extent_pt
1123
1124     def do_start(self):
1125         """Setup environment and start TeX interpreter."""
1126         assert self.state == STATE_START
1127         self.state = STATE_PREAMBLE
1128
1129         chroot = config.get("text", "chroot", "")
1130         if chroot:
1131             chroot_tmpdir = config.get("text", "tmpdir", "/tmp")
1132             chroot_tmpdir_rel = os.path.relpath(chroot_tmpdir, os.sep)
1133             base_tmpdir = os.path.join(chroot, chroot_tmpdir_rel)
1134         else:
1135             base_tmpdir = config.get("text", "tmpdir", None)
1136         self.tmpdir = tempfile.mkdtemp(prefix="pyx", dir=base_tmpdir)
1137         atexit.register(self._cleanup)
1138         for usefile in self.usefiles:
1139             extpos = usefile.rfind(".")
1140             try:
1141                 os.rename(usefile, os.path.join(self.tmpdir, "texput" + usefile[extpos:]))
1142             except OSError:
1143                 pass
1144         if chroot:
1145             tex_tmpdir = os.sep + os.path.relpath(self.tmpdir, chroot)
1146         else:
1147             tex_tmpdir = self.tmpdir
1148         cmd = self.cmd + ['--output-directory', tex_tmpdir]
1149         if self.texipc:
1150             cmd.append("--ipc")
1151         self.popen = config.Popen(cmd, stdin=config.PIPE, stdout=config.PIPE, stderr=config.STDOUT, bufsize=0)
1152         self.texinput = io.TextIOWrapper(self.popen.stdin, encoding=self.texenc)
1153         if self.copyinput:
1154             try:
1155                 self.copyinput.write
1156             except AttributeError:
1157                 self.texinput = Tee(open(self.copyinput, "w", encoding=self.texenc), self.texinput)
1158             else:
1159                 self.texinput = Tee(self.copyinput, self.texinput)
1160         self.texoutput = MonitorOutput(self.name, io.TextIOWrapper(self.popen.stdout, encoding=self.texenc))
1161         self._execute("\\scrollmode\n\\raiseerror%\n" # switch to and check scrollmode
1162                       "\\def\\PyX{P\\kern-.3em\\lower.5ex\hbox{Y}\kern-.18em X}%\n" # just the PyX Logo
1163                       "\\gdef\\PyXBoxHAlign{0}%\n" # global PyXBoxHAlign (0.0-1.0) for the horizontal alignment, default to 0
1164                       "\\newbox\\PyXBox%\n" # PyXBox will contain the output
1165                       "\\newbox\\PyXBoxHAligned%\n" # PyXBox will contain the horizontal aligned output
1166                       "\\newdimen\\PyXDimenHAlignLT%\n" # PyXDimenHAlignLT/RT will contain the left/right extent
1167                       "\\newdimen\\PyXDimenHAlignRT%\n" +
1168                       _textattrspreamble + # insert preambles for textattrs macros
1169                       "\\long\\def\\ProcessPyXBox#1#2{%\n" # the ProcessPyXBox definition (#1 is expr, #2 is page number)
1170                       "\\setbox\\PyXBox=\\hbox{{#1}}%\n" # push expression into PyXBox
1171                       "\\PyXDimenHAlignLT=\\PyXBoxHAlign\\wd\\PyXBox%\n" # calculate the left/right extent
1172                       "\\PyXDimenHAlignRT=\\wd\\PyXBox%\n"
1173                       "\\advance\\PyXDimenHAlignRT by -\\PyXDimenHAlignLT%\n"
1174                       "\\gdef\\PyXBoxHAlign{0}%\n" # reset the PyXBoxHAlign to the default 0
1175                       "\\immediate\\write16{PyXBox:page=#2," # write page and extents of this box to stdout
1176                                                   "lt=\\the\\PyXDimenHAlignLT,"
1177                                                   "rt=\\the\\PyXDimenHAlignRT,"
1178                                                   "ht=\\the\\ht\\PyXBox,"
1179                                                   "dp=\\the\\dp\\PyXBox:}%\n"
1180                       "\\setbox\\PyXBoxHAligned=\\hbox{\\kern-\\PyXDimenHAlignLT\\box\\PyXBox}%\n" # align horizontally
1181                       "\\ht\\PyXBoxHAligned0pt%\n" # baseline alignment (hight to zero)
1182                       "{\\count0=80\\count1=121\\count2=88\\count3=#2\\shipout\\box\\PyXBoxHAligned}}%\n" # shipout PyXBox to Page 80.121.88.<page number>
1183                       "\\def\\PyXInput#1{\\immediate\\write16{PyXInputMarker:executeid=#1:}}%\n" # write PyXInputMarker to stdout
1184                       "\\def\\PyXMarker#1{\\hskip0pt\\special{PyX:marker #1}}%", # write PyXMarker special into the dvi-file
1185                       self.texmessages_start_default + self.texmessages_start, STATE_PREAMBLE, STATE_PREAMBLE)
1186
1187     def do_preamble(self, expr, texmessages):
1188         """Ensure preamble mode and execute expr."""
1189         if self.state < STATE_PREAMBLE:
1190             self.do_start()
1191         self._execute(expr, texmessages, STATE_PREAMBLE, STATE_PREAMBLE)
1192
1193     def do_typeset(self, expr, texmessages):
1194         """Ensure typeset mode and typeset expr."""
1195         if self.state < STATE_PREAMBLE:
1196             self.do_start()
1197         if self.state < STATE_TYPESET:
1198             self.go_typeset()
1199         return self._execute(expr, texmessages, STATE_TYPESET, STATE_TYPESET)
1200
1201     def do_finish(self):
1202         """Teardown TeX interpreter and cleanup environment."""
1203         if self.state == STATE_DONE:
1204             return
1205         if self.state < STATE_TYPESET:
1206             self.go_typeset()
1207         self.go_finish()
1208         assert self.state == STATE_DONE
1209         self.texinput.close()            # close the input queue and
1210         self.texoutput.done()            # wait for finish of the output
1211
1212         if self.needdvitextboxes:
1213             dvifilename = os.path.join(self.tmpdir, "texput.dvi")
1214             self.dvifile = dvifile.DVIfile(dvifilename, debug=self.dvitype)
1215             page = 1
1216             for box in self.needdvitextboxes:
1217                 box.readdvipage(self.dvifile, page)
1218                 page += 1
1219         if self.dvifile is not None and self.dvifile.readpage(None) is not None:
1220             raise ValueError("end of dvifile expected but further pages follow")
1221
1222         atexit.unregister(self._cleanup)
1223         self._cleanup()
1224
1225     def preamble(self, expr, texmessages=[]):
1226         """Execute a preamble.
1227
1228         :param str expr: expression to be executed
1229         :param texmessages: additional message parsers
1230         :type texmessages: list of :class:`texmessage` parsers
1231
1232         Preambles must not generate output, but are used to load files, perform
1233         settings, define macros, *etc*. In LaTeX mode, preambles are executed
1234         before ``\\begin{document}``. The method can be called multiple times,
1235         but only prior to :meth:`SingleRunner.text` and
1236         :meth:`SingleRunner.text_pt`.
1237
1238         """
1239         texmessages = self.texmessages_preamble_default + self.texmessages_preamble + texmessages
1240         self.do_preamble(expr, texmessages)
1241
1242     def text_pt(self, x_pt, y_pt, expr, textattrs=[], texmessages=[], fontmap=None, singlecharmode=False):
1243         """Typeset text.
1244
1245         :param float x_pt: x position in pts
1246         :param float y_pt: y position in pts
1247         :param str expr: text to be typeset
1248         :param textattrs: styles and attributes to be applied to the text
1249         :type textattrs: list of  :class:`textattr, :class:`trafo.trafo_pt`,
1250             and :class:`style.fillstyle`
1251         :param texmessages: additional message parsers
1252         :type texmessages: list of :class:`texmessage` parsers
1253         :param fontmap: force a fontmap to be used (instead of the default
1254             depending on the output format)
1255         :type fontmap: None or fontmap
1256         :param bool singlecharmode: position each character separately
1257         :returns: text output insertable into a canvas.
1258         :rtype: :class:`textbox_pt`
1259         :raises: :exc:`TexDoneError`: when the TeX interpreter has been
1260             terminated already.
1261
1262         """
1263         if self.state == STATE_DONE:
1264             raise TexDoneError("typesetting process was terminated already")
1265         textattrs = attr.mergeattrs(textattrs) # perform cleans
1266         attr.checkattrs(textattrs, [textattr, trafo.trafo_pt, style.fillstyle])
1267         trafos = attr.getattrs(textattrs, [trafo.trafo_pt])
1268         fillstyles = attr.getattrs(textattrs, [style.fillstyle])
1269         textattrs = attr.getattrs(textattrs, [textattr])
1270         for ta in textattrs[::-1]:
1271             expr = ta.apply(expr)
1272         first = self.state < STATE_TYPESET
1273         left_pt, right_pt, height_pt, depth_pt = self.do_typeset(expr, self.texmessages_run_default + self.texmessages_run + texmessages)
1274         if self.texipc and first:
1275             self.dvifile = dvifile.DVIfile(os.path.join(self.tmpdir, "texput.dvi"), debug=self.dvitype)
1276         box = textbox_pt(x_pt, y_pt, left_pt, right_pt, height_pt, depth_pt, self.do_finish, fontmap, singlecharmode, fillstyles)
1277         for t in trafos:
1278             box.reltransform(t) # TODO: should trafos really use reltransform???
1279                                 #       this is quite different from what we do elsewhere!!!
1280                                 #       see https://sourceforge.net/mailarchive/forum.php?thread_id=9137692&forum_id=23700
1281         if self.texipc:
1282             box.readdvipage(self.dvifile, self.page)
1283         else:
1284             self.needdvitextboxes.append(box)
1285         return box
1286
1287     def text(self, x, y, *args, **kwargs):
1288         """Typeset text.
1289
1290         This method is identical to :meth:`text_pt` with the only difference of
1291         using PyX lengths to position the output.
1292
1293         :param x: x position
1294         :type x: PyX length
1295         :param y: y position
1296         :type y: PyX length
1297
1298         """
1299         return self.text_pt(unit.topt(x), unit.topt(y), *args, **kwargs)
1300
1301
1302 class SingleTexRunner(SingleRunner):
1303
1304     def __init__(self, cmd=config.getlist("text", "tex", ["tex"]), lfs="10pt", **kwargs):
1305         """Plain TeX interface.
1306
1307         This class adjusts the :class:`SingleRunner` to use plain TeX.
1308
1309         :param cmd: command and arguments to start the TeX interpreter
1310         :type cmd: list of str
1311         :param lfs: resemble LaTeX font settings within plain TeX by loading a
1312             lfs-file
1313         :type lfs: str or None
1314         :param kwargs: additional arguments passed to :class:`SingleRunner`
1315
1316         An lfs-file is a file defining a set of font commands like ``\\normalsize``
1317         by font selection commands in plain TeX. Several of those files
1318         resembling standard settings of LaTeX are distributed along with PyX in
1319         the ``pyx/data/lfs`` directory. This directory also contains a LaTeX
1320         file to create lfs files for different settings (LaTeX class, class
1321         options, and style files).
1322
1323         """
1324         super().__init__(cmd=cmd, **kwargs)
1325         self.lfs = lfs
1326         self.name = "TeX"
1327
1328     def go_typeset(self):
1329         assert self.state == STATE_PREAMBLE
1330         self.state = STATE_TYPESET
1331
1332     def go_finish(self):
1333         self._execute("\\end%\n", self.texmessages_end_default + self.texmessages_end, STATE_TYPESET, STATE_DONE)
1334
1335     def force_done(self):
1336         self.texinput.write("\n\\end\n")
1337
1338     def do_start(self):
1339         super().do_start()
1340         if self.lfs:
1341             if not self.lfs.endswith(".lfs"):
1342                 self.lfs = "%s.lfs" % self.lfs
1343             with config.open(self.lfs, []) as lfsfile:
1344                 lfsdef = lfsfile.read().decode("ascii")
1345             self._execute(lfsdef, [], STATE_PREAMBLE, STATE_PREAMBLE)
1346             self._execute("\\normalsize%\n", [], STATE_PREAMBLE, STATE_PREAMBLE)
1347         self._execute("\\newdimen\\linewidth\\newdimen\\textwidth%\n", [], STATE_PREAMBLE, STATE_PREAMBLE)
1348
1349
1350 class SingleLatexRunner(SingleRunner):
1351
1352     #: default :class:`texmessage` parsers at LaTeX class loading
1353     texmessages_docclass_default = [texmessage.load]
1354     #: default :class:`texmessage` parsers at ``\begin{document}``
1355     texmessages_begindoc_default = [texmessage.load, texmessage.no_aux]
1356
1357     def __init__(self, cmd=config.getlist("text", "latex", ["latex"]),
1358                        docclass="article", docopt=None, pyxgraphics=True,
1359                        texmessages_docclass=[], texmessages_begindoc=[], **kwargs):
1360         """LaTeX interface.
1361
1362         This class adjusts the :class:`SingleRunner` to use LaTeX.
1363
1364         :param cmd: command and arguments to start the TeX interpreter
1365             in LaTeX mode
1366         :type cmd: list of str
1367         :param str docclass: document class
1368         :param docopt: document loading options
1369         :type docopt: str or None
1370         :param bool pyxgraphics: activate graphics bundle support, see
1371             :ref:`pyxgraphics`
1372         :param texmessages_docclass: additional message parsers at LaTeX class
1373             loading
1374         :type texmessages_docclass: list of :class:`texmessage` parsers
1375         :param texmessages_begindoc: additional message parsers at
1376             ``\\begin{document}``
1377         :type texmessages_begindoc: list of :class:`texmessage` parsers
1378         :param kwargs: additional arguments passed to :class:`SingleRunner`
1379
1380         """
1381         super().__init__(cmd=cmd, **kwargs)
1382         self.docclass = docclass
1383         self.docopt = docopt
1384         self.pyxgraphics = pyxgraphics
1385         self.texmessages_docclass = texmessages_docclass
1386         self.texmessages_begindoc = texmessages_begindoc
1387         self.name = "LaTeX"
1388
1389     def go_typeset(self):
1390         self._execute("\\begin{document}", self.texmessages_begindoc_default + self.texmessages_begindoc, STATE_PREAMBLE, STATE_TYPESET)
1391
1392     def go_finish(self):
1393         self._execute("\\end{document}%\n", self.texmessages_end_default + self.texmessages_end, STATE_TYPESET, STATE_DONE)
1394
1395     def force_done(self):
1396         self.texinput.write("\n\\catcode`\\@11\\relax\\@@end\n")
1397
1398     def do_start(self):
1399         super().do_start()
1400         if self.pyxgraphics:
1401             with config.open("pyx.def", []) as source, open(os.path.join(self.tmpdir, "pyx.def"), "wb") as dest:
1402                 dest.write(source.read())
1403             self._execute("\\makeatletter%\n"
1404                           "\\let\\saveProcessOptions=\\ProcessOptions%\n"
1405                           "\\def\\ProcessOptions{%\n"
1406                           "\\def\\Gin@driver{" + self.tmpdir.replace(os.sep, "/") + "/pyx.def}%\n"
1407                           "\\def\\c@lor@namefile{dvipsnam.def}%\n"
1408                           "\\saveProcessOptions}%\n"
1409                           "\\makeatother",
1410                           [], STATE_PREAMBLE, STATE_PREAMBLE)
1411         if self.docopt is not None:
1412             self._execute("\\documentclass[%s]{%s}" % (self.docopt, self.docclass),
1413                           self.texmessages_docclass_default + self.texmessages_docclass, STATE_PREAMBLE, STATE_PREAMBLE)
1414         else:
1415             self._execute("\\documentclass{%s}" % self.docclass,
1416                           self.texmessages_docclass_default + self.texmessages_docclass, STATE_PREAMBLE, STATE_PREAMBLE)
1417
1418
1419 def reset_for_tex_done(f):
1420     @functools.wraps(f)
1421     def wrapped(self, *args, **kwargs):
1422         try:
1423             return f(self, *args, **kwargs)
1424         except TexDoneError:
1425             self.reset(reinit=True)
1426             return f(self, *args, **kwargs)
1427     return wrapped
1428
1429
1430 class MultiRunner:
1431
1432     def __init__(self, cls, *args, **kwargs):
1433         """A restartable :class:`SingleRunner` class
1434
1435         :param cls: the class being wrapped
1436         :type cls: :class:`SingleRunner` class
1437         :param list args: args at class instantiation
1438         :param dict kwargs: keyword args at at class instantiation
1439
1440         """
1441         self.cls = cls
1442         self.args = args
1443         self.kwargs = kwargs
1444         self.reset()
1445
1446     def preamble(self, expr, texmessages=[]):
1447         "resembles :meth:`SingleRunner.preamble`"
1448         self.preambles.append((expr, texmessages))
1449         self.instance.preamble(expr, texmessages)
1450
1451     @reset_for_tex_done
1452     def text_pt(self, *args, **kwargs):
1453         "resembles :meth:`SingleRunner.text_pt`"
1454         return self.instance.text_pt(*args, **kwargs)
1455
1456     @reset_for_tex_done
1457     def text(self, *args, **kwargs):
1458         "resembles :meth:`SingleRunner.text`"
1459         return self.instance.text(*args, **kwargs)
1460
1461     def reset(self, reinit=False):
1462         """Start a new :class:`SingleRunner` instance
1463
1464         :param bool reinit: replay :meth:`preamble` calls on the new instance
1465
1466         After executing this function further preamble calls are allowed,
1467         whereas once a text output has been created, :meth:`preamble` calls are
1468         forbidden.
1469
1470         """
1471         self.instance = self.cls(*self.args, **self.kwargs)
1472         if reinit:
1473             for expr, texmessages in self.preambles:
1474                 self.instance.preamble(expr, texmessages)
1475         else:
1476             self.preambles = []
1477
1478
1479 class TexRunner(MultiRunner):
1480
1481     def __init__(self, *args, **kwargs):
1482         """A restartable :class:`SingleTexRunner` class
1483
1484         :param list args: args at class instantiation
1485         :param dict kwargs: keyword args at at class instantiation
1486
1487         """
1488         super().__init__(SingleTexRunner, *args, **kwargs)
1489
1490
1491 class LatexRunner(MultiRunner):
1492
1493     def __init__(self, *args, **kwargs):
1494         """A restartable :class:`SingleLatexRunner` class
1495
1496         :param list args: args at class instantiation
1497         :param dict kwargs: keyword args at at class instantiation
1498
1499         """
1500         super().__init__(SingleLatexRunner, *args, **kwargs)
1501
1502
1503 # old, deprecated names:
1504 texrunner = TexRunner
1505 latexrunner = LatexRunner
1506
1507 # module level interface documentation for autodoc
1508 # the actual values are setup by the set function
1509
1510 #: the current :class:`MultiRunner` instance for the module level functions
1511 default_runner = None
1512
1513 #: default_runner.preamble (bound method)
1514 preamble = None
1515
1516 #: default_runner.text_pt (bound method)
1517 text_pt = None
1518
1519 #: default_runner.text (bound method)
1520 text = None
1521
1522 #: default_runner.reset (bound method)
1523 reset = None
1524
1525 def set(cls=TexRunner, mode=None, *args, **kwargs):
1526     """Setup a new module level :class:`MultiRunner`
1527
1528     :param cls: the module level :class:`MultiRunner` to be used, i.e.
1529         :class:`TexRunner` or :class:`LatexRunner`
1530     :type cls: :class:`MultiRunner` object, not instance
1531     :param mode: ``"tex"`` for :class:`TexRunner` or ``"latex"`` for
1532         :class:`LatexRunner` with arbitraty capitalization, overwriting the cls
1533         value
1534
1535         :deprecated: use the cls argument instead
1536     :type mode: str or None
1537     :param list args: args at class instantiation
1538     :param dict kwargs: keyword args at at class instantiation
1539
1540     """
1541     # note: defaulttexrunner is deprecated
1542     global default_runner, defaulttexrunner, reset, preamble, text, text_pt
1543     if mode is not None:
1544         logger.warning("mode setting is deprecated, use the cls argument instead")
1545         cls = {"tex": TexRunner, "latex": LatexRunner}[mode.lower()]
1546     default_runner = defaulttexrunner = cls(*args, **kwargs)
1547     preamble = default_runner.preamble
1548     text_pt = default_runner.text_pt
1549     text = default_runner.text
1550     reset = default_runner.reset
1551
1552 # initialize default_runner
1553 set()
1554
1555
1556 def escapestring(s, replace={" ": "~",
1557                              "$": "\\$",
1558                              "&": "\\&",
1559                              "#": "\\#",
1560                              "_": "\\_",
1561                              "%": "\\%",
1562                              "^": "\\string^",
1563                              "~": "\\string~",
1564                              "<": "{$<$}",
1565                              ">": "{$>$}",
1566                              "{": "{$\{$}",
1567                              "}": "{$\}$}",
1568                              "\\": "{$\setminus$}",
1569                              "|": "{$\mid$}"}):
1570     "Escapes ASCII characters such that they can be typeset by TeX/LaTeX"""
1571     i = 0
1572     while i < len(s):
1573         if not 32 <= ord(s[i]) < 127:
1574             raise ValueError("escapestring function handles ascii strings only")
1575         c = s[i]
1576         try:
1577             r = replace[c]
1578         except KeyError:
1579             i += 1
1580         else:
1581             s = s[:i] + r + s[i+1:]
1582             i += len(r)
1583     return s