pyx/pswriter.py

   1 # -*- encoding: utf-8 -*-
   2 #
   3 #
   4 # Copyright (C) 2005-2011 Jörg Lehmann <joergl@users.sourceforge.net>
   5 # Copyright (C) 2005-2011 André Wobst <wobsta@users.sourceforge.net>
   6 #
   7 # This file is part of PyX (http://pyx.sourceforge.net/).
   8 #
   9 # PyX is free software; you can redistribute it and/or modify
  10 # it under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 2 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # PyX is distributed in the hope that it will be useful,
  15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with PyX; if not, write to the Free Software
  21 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  22
  23 import io, copy, time, math
  24 from . import bbox, config, style, version, unit, trafo, writer
  25
  26
  27 class PSregistry:
  28
  29     def __init__(self):
  30         # in order to keep a consistent order of the registered resources we
  31         # not only store them in a hash but also keep an ordered list (up to a
  32         # possible merging of resources, in which case the first instance is
  33         # kept)
  34         self.resourceshash = {}
  35         self.resourceslist = []
  36
  37     def add(self, resource):
  38         rkey = (resource.type, resource.id)
  39         if rkey in self.resourceshash:
  40            self.resourceshash[rkey].merge(resource)
  41         else:
  42            self.resourceshash[rkey] = resource
  43            self.resourceslist.append(resource)
  44
  45     def mergeregistry(self, registry):
  46         for resource in registry.resources:
  47             self.add(resource)
  48
  49     def output(self, file, writer):
  50         """ write all PostScript code of the prolog resources """
  51         for resource in self.resourceslist:
  52             resource.output(file, writer, self)
  53
  54 #
  55 # Abstract base class
  56 #
  57
  58 class PSresource:
  59
  60     """ a PostScript resource """
  61
  62     def __init__(self, type, id):
  63         # Every PSresource has to have a type and a unique id.
  64         # Resources with the same type and id will be merged
  65         # when they are registered in the PSregistry
  66         self.type = type
  67         self.id = id
  68
  69     def merge(self, other):
  70         """ merge self with other, which has to be a resource of the same type and with
  71         the same id"""
  72         pass
  73
  74     def output(self, file, writer, registry):
  75         raise NotImplementedError("output not implemented for %s" % repr(self))
  76
  77 class PSdefinition(PSresource):
  78
  79     """ PostScript function definition included in the prolog """
  80
  81     def __init__(self, id, body):
  82         self.type = "definition"
  83         self.id = id
  84         self.body = body
  85
  86     def output(self, file, writer, registry):
  87         file.write("%%%%BeginResource: %s\n" % self.id)
  88         file.write_bytes(self.body)
  89         file.write(" /%s exch def\n" % self.id)
  90         file.write("%%EndResource\n")
  91
  92 #
  93 # Writers
  94 #
  95
  96 class _PSwriter:
  97
  98     def __init__(self, title=None, strip_fonts=True, text_as_path=False, mesh_as_bitmap=False, mesh_as_bitmap_resolution=300):
  99         self._fontmap = None
 100         self.title = title
 101         self.strip_fonts = strip_fonts
 102         self.text_as_path = text_as_path
 103         self.mesh_as_bitmap = mesh_as_bitmap
 104         self.mesh_as_bitmap_resolution = mesh_as_bitmap_resolution
 105
 106         # dictionary mapping font names to dictionaries mapping encoding names to encodings
 107         # encodings themselves are mappings from glyphnames to codepoints
 108         self.encodings = {}
 109
 110     def writeinfo(self, file):
 111         file.write("%%%%Creator: PyX %s\n" % version.version)
 112         if self.title is not None:
 113             file.write("%%%%Title: %s\n" % self.title)
 114         file.write("%%%%CreationDate: %s\n" %
 115                    time.asctime(time.localtime(time.time())))
 116
 117     def getfontmap(self):
 118         if self._fontmap is None:
 119             # late import due to cyclic dependency
 120             from pyx.dvi import mapfile
 121             fontmapfiles = config.getlist("text", "psfontmaps", ["psfonts.map"])
 122             self._fontmap = mapfile.readfontmap(fontmapfiles)
 123         return self._fontmap
 124
 125
 126 class EPSwriter(_PSwriter):
 127
 128     def __init__(self, document, file, **kwargs):
 129         _PSwriter.__init__(self, **kwargs)
 130         file = writer.writer(file)
 131
 132         if len(document.pages) != 1:
 133             raise ValueError("EPS file can be constructed out of a single page document only")
 134         page = document.pages[0]
 135         canvas = page.canvas
 136
 137         pagefile = writer.writer(io.BytesIO())
 138         registry = PSregistry()
 139         acontext = context()
 140         pagebbox = bbox.empty()
 141
 142         page.processPS(pagefile, self, acontext, registry, pagebbox)
 143
 144         file.write("%!PS-Adobe-3.0 EPSF-3.0\n")
 145         if pagebbox:
 146             file.write("%%%%BoundingBox: %d %d %d %d\n" % pagebbox.lowrestuple_pt())
 147             file.write("%%%%HiResBoundingBox: %g %g %g %g\n" % pagebbox.highrestuple_pt())
 148         self.writeinfo(file)
 149         file.write("%%EndComments\n")
 150
 151         file.write("%%BeginProlog\n")
 152         registry.output(file, self)
 153         file.write("%%EndProlog\n")
 154
 155         file.write_bytes(pagefile.file.getvalue())
 156
 157         file.write("showpage\n")
 158         file.write("%%Trailer\n")
 159         file.write("%%EOF\n")
 160
 161
 162 class PSwriter(_PSwriter):
 163
 164     def __init__(self, document, file, writebbox=False, **kwargs):
 165         _PSwriter.__init__(self, **kwargs)
 166         file = writer.writer(file)
 167
 168         # We first have to process the content of the pages, writing them into the stream pagesfile
 169         # Doing so, we fill the registry and also calculate the page bounding boxes, which are
 170         # stored in page._bbox for every page
 171         pagesfile = writer.writer(io.BytesIO())
 172         registry = PSregistry()
 173
 174         # calculated bounding boxes of the whole document
 175         documentbbox = bbox.empty()
 176
 177         for nr, page in enumerate(document.pages):
 178             # process contents of page
 179             pagefile = writer.writer(io.BytesIO())
 180             acontext = context()
 181             pagebbox = bbox.empty()
 182             page.processPS(pagefile, self, acontext, registry, pagebbox)
 183
 184             documentbbox += pagebbox
 185
 186             pagesfile.write("%%%%Page: %s %d\n" % (page.pagename is None and str(nr+1) or page.pagename, nr+1))
 187             if page.paperformat:
 188                 pagesfile.write("%%%%PageMedia: %s\n" % page.paperformat.name)
 189             pagesfile.write("%%%%PageOrientation: %s\n" % (page.rotated and "Landscape" or "Portrait"))
 190             if pagebbox and writebbox:
 191                 pagesfile.write("%%%%PageBoundingBox: %d %d %d %d\n" % pagebbox.lowrestuple_pt())
 192
 193             # page setup section
 194             pagesfile.write("%%BeginPageSetup\n")
 195             pagesfile.write("/pgsave save def\n")
 196
 197             pagesfile.write("%%EndPageSetup\n")
 198             pagesfile.write_bytes(pagefile.file.getvalue())
 199             pagesfile.write("pgsave restore\n")
 200             pagesfile.write("showpage\n")
 201             pagesfile.write("%%PageTrailer\n")
 202
 203         file.write("%!PS-Adobe-3.0\n")
 204         if documentbbox and writebbox:
 205             file.write("%%%%BoundingBox: %d %d %d %d\n" % documentbbox.lowrestuple_pt())
 206             file.write("%%%%HiResBoundingBox: %g %g %g %g\n" % documentbbox.highrestuple_pt())
 207         self.writeinfo(file)
 208
 209         # required paper formats
 210         paperformats = {}
 211         for page in document.pages:
 212             if page.paperformat:
 213                 paperformats[page.paperformat] = page.paperformat
 214
 215         first = 1
 216         for paperformat in list(paperformats.values()):
 217             if first:
 218                 file.write("%%DocumentMedia: ")
 219                 first = 0
 220             else:
 221                 file.write("%%+ ")
 222             file.write("%s %d %d 75 white ()\n" % (paperformat.name,
 223                                                    unit.topt(paperformat.width),
 224                                                    unit.topt(paperformat.height)))
 225
 226         # file.write(%%DocumentNeededResources: ") # register not downloaded fonts here
 227
 228         file.write("%%%%Pages: %d\n" % len(document.pages))
 229         file.write("%%PageOrder: Ascend\n")
 230         file.write("%%EndComments\n")
 231
 232         # document defaults section
 233         #file.write("%%BeginDefaults\n")
 234         #file.write("%%EndDefaults\n")
 235
 236         # document prolog section
 237         file.write("%%BeginProlog\n")
 238         registry.output(file, self)
 239         file.write("%%EndProlog\n")
 240
 241         # document setup section
 242         #file.write("%%BeginSetup\n")
 243         #file.write("%%EndSetup\n")
 244
 245         file.write_bytes(pagesfile.file.getvalue())
 246
 247         file.write("%%Trailer\n")
 248         file.write("%%EOF\n")
 249
 250
 251 class context:
 252
 253     def __init__(self):
 254         self.linewidth_pt = None
 255         self.colorspace = None
 256         self.selectedfont = None
 257         self.fillrule = 0
 258
 259     def __call__(self, **kwargs):
 260         newcontext = copy.copy(self)
 261         for key, value in list(kwargs.items()):
 262             setattr(newcontext, key, value)
 263         return newcontext