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 cStringIO, copy, time, math
  24 import bbox, config, style, version, unit, trafo
  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 self.resourceshash.has_key(rkey):
  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("%(body)s /%(id)s exch def\n" % self.__dict__)
  89         file.write("%%EndResource\n")
  90
  91 #
  92 # Writers
  93 #
  94
  95 class _PSwriter:
  96
  97     def __init__(self, title=None, strip_fonts=True, text_as_path=False, mesh_as_bitmap=False, mesh_as_bitmap_resolution=300):
  98         self._fontmap = None
  99         self.title = title
 100         self.strip_fonts = strip_fonts
 101         self.text_as_path = text_as_path
 102         self.mesh_as_bitmap = mesh_as_bitmap
 103         self.mesh_as_bitmap_resolution = mesh_as_bitmap_resolution
 104
 105         # dictionary mapping font names to dictionaries mapping encoding names to encodings
 106         # encodings themselves are mappings from glyphnames to codepoints
 107         self.encodings = {}
 108
 109     def writeinfo(self, file):
 110         file.write("%%%%Creator: PyX %s\n" % version.version)
 111         if self.title is not None:
 112             file.write("%%%%Title: %s\n" % self.title)
 113         file.write("%%%%CreationDate: %s\n" %
 114                    time.asctime(time.localtime(time.time())))
 115
 116     def getfontmap(self):
 117         if self._fontmap is None:
 118             # late import due to cyclic dependency
 119             from pyx.dvi import mapfile
 120             fontmapfiles = config.getlist("text", "psfontmaps", ["psfonts.map"])
 121             self._fontmap = mapfile.readfontmap(fontmapfiles)
 122         return self._fontmap
 123
 124
 125 class EPSwriter(_PSwriter):
 126
 127     def __init__(self, document, file, **kwargs):
 128         _PSwriter.__init__(self, **kwargs)
 129
 130         if len(document.pages) != 1:
 131             raise ValueError("EPS file can be constructed out of a single page document only")
 132         page = document.pages[0]
 133         canvas = page.canvas
 134
 135         pagefile = cStringIO.StringIO()
 136         registry = PSregistry()
 137         acontext = context()
 138         pagebbox = bbox.empty()
 139
 140         page.processPS(pagefile, self, acontext, registry, pagebbox)
 141
 142         file.write("%!PS-Adobe-3.0 EPSF-3.0\n")
 143         if pagebbox:
 144             file.write("%%%%BoundingBox: %d %d %d %d\n" % pagebbox.lowrestuple_pt())
 145             file.write("%%%%HiResBoundingBox: %g %g %g %g\n" % pagebbox.highrestuple_pt())
 146         self.writeinfo(file)
 147         file.write("%%EndComments\n")
 148
 149         file.write("%%BeginProlog\n")
 150         registry.output(file, self)
 151         file.write("%%EndProlog\n")
 152
 153         file.write(pagefile.getvalue())
 154         pagefile.close()
 155
 156         file.write("showpage\n")
 157         file.write("%%Trailer\n")
 158         file.write("%%EOF\n")
 159
 160
 161 class PSwriter(_PSwriter):
 162
 163     def __init__(self, document, file, writebbox=False, **kwargs):
 164         _PSwriter.__init__(self, **kwargs)
 165
 166         # We first have to process the content of the pages, writing them into the stream pagesfile
 167         # Doing so, we fill the registry and also calculate the page bounding boxes, which are
 168         # stored in page._bbox for every page
 169         pagesfile = cStringIO.StringIO()
 170         registry = PSregistry()
 171
 172         # calculated bounding boxes of the whole document
 173         documentbbox = bbox.empty()
 174
 175         for nr, page in enumerate(document.pages):
 176             # process contents of page
 177             pagefile = cStringIO.StringIO()
 178             acontext = context()
 179             pagebbox = bbox.empty()
 180             page.processPS(pagefile, self, acontext, registry, pagebbox)
 181
 182             documentbbox += pagebbox
 183
 184             pagesfile.write("%%%%Page: %s %d\n" % (page.pagename is None and str(nr+1) or page.pagename, nr+1))
 185             if page.paperformat:
 186                 pagesfile.write("%%%%PageMedia: %s\n" % page.paperformat.name)
 187             pagesfile.write("%%%%PageOrientation: %s\n" % (page.rotated and "Landscape" or "Portrait"))
 188             if pagebbox and writebbox:
 189                 pagesfile.write("%%%%PageBoundingBox: %d %d %d %d\n" % pagebbox.lowrestuple_pt())
 190
 191             # page setup section
 192             pagesfile.write("%%BeginPageSetup\n")
 193             pagesfile.write("/pgsave save def\n")
 194
 195             pagesfile.write("%%EndPageSetup\n")
 196             pagesfile.write(pagefile.getvalue())
 197             pagefile.close()
 198             pagesfile.write("pgsave restore\n")
 199             pagesfile.write("showpage\n")
 200             pagesfile.write("%%PageTrailer\n")
 201
 202         file.write("%!PS-Adobe-3.0\n")
 203         if documentbbox and writebbox:
 204             file.write("%%%%BoundingBox: %d %d %d %d\n" % documentbbox.lowrestuple_pt())
 205             file.write("%%%%HiResBoundingBox: %g %g %g %g\n" % documentbbox.highrestuple_pt())
 206         self.writeinfo(file)
 207
 208         # required paper formats
 209         paperformats = {}
 210         for page in document.pages:
 211             if page.paperformat:
 212                 paperformats[page.paperformat] = page.paperformat
 213
 214         first = 1
 215         for paperformat in paperformats.values():
 216             if first:
 217                 file.write("%%DocumentMedia: ")
 218                 first = 0
 219             else:
 220                 file.write("%%+ ")
 221             file.write("%s %d %d 75 white ()\n" % (paperformat.name,
 222                                                    unit.topt(paperformat.width),
 223                                                    unit.topt(paperformat.height)))
 224
 225         # file.write(%%DocumentNeededResources: ") # register not downloaded fonts here
 226
 227         file.write("%%%%Pages: %d\n" % len(document.pages))
 228         file.write("%%PageOrder: Ascend\n")
 229         file.write("%%EndComments\n")
 230
 231         # document defaults section
 232         #file.write("%%BeginDefaults\n")
 233         #file.write("%%EndDefaults\n")
 234
 235         # document prolog section
 236         file.write("%%BeginProlog\n")
 237         registry.output(file, self)
 238         file.write("%%EndProlog\n")
 239
 240         # document setup section
 241         #file.write("%%BeginSetup\n")
 242         #file.write("%%EndSetup\n")
 243
 244         file.write(pagesfile.getvalue())
 245         pagesfile.close()
 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
 258     def __call__(self, **kwargs):
 259         newcontext = copy.copy(self)
 260         for key, value in kwargs.items():
 261             setattr(newcontext, key, value)
 262         return newcontext