reportlab/pdfbase/pdfdoc.py
author rgbecker
Wed, 17 Jan 2007 18:25:03 +0000
changeset 2730 b3fc23a74fd1
parent 2679 b8464568f5e2
child 2737 7aa9f936102b
permissions -rwxr-xr-x
reportlab: Dirk Holtwick's editor's fixes :)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2332
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2274
diff changeset
     1
#Copyright ReportLab Europe Ltd. 2000-2004
494
54257447cfe9 Changed to indirect copyright
rgbecker
parents: 484
diff changeset
     2
#see license.txt for license details
2332
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2274
diff changeset
     3
#history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/pdfbase/pdfdoc.py
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2274
diff changeset
     4
__version__=''' $Id$ '''
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
     5
__doc__="""
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
     6
The module pdfdoc.py handles the 'outer structure' of PDF documents, ensuring that
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
     7
all objects are properly cross-referenced and indexed to the nearest byte.  The
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
     8
'inner structure' - the page descriptions - are presumed to be generated before
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
     9
each page is saved.
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
    10
pdfgen.py calls this and provides a 'canvas' object to handle page marking operators.
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
    11
piddlePDF calls pdfgen and offers a high-level interface.
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
    12
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    13
The classes within this generally mirror structures in the PDF file
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    14
and are not part of any public interface.  Instead, canvas and font
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    15
classes are made available elsewhere for users to manipulate.
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
    16
"""
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
    17
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2571
diff changeset
    18
import string, types, binascii, codecs
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    19
from reportlab.pdfbase import pdfutils
2067
ae4fe8b9c3f4 Now deterministically formats all numbers
andy_robinson
parents: 2045
diff changeset
    20
from reportlab.pdfbase.pdfutils import LINEEND # this constant needed in both
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    21
from reportlab import rl_config
2067
ae4fe8b9c3f4 Now deterministically formats all numbers
andy_robinson
parents: 2045
diff changeset
    22
from reportlab.lib.utils import import_zlib, open_for_read, fp_str
2595
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
    23
from reportlab.pdfbase import pdfmetrics
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    24
1653
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    25
from sys import platform
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    26
try:
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    27
    from sys import version_info
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    28
except: # pre-2.0
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    29
    # may be inaccurate but will at least
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    30
    #work in anything which seeks to format
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    31
    # version_info into a string
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    32
    version_info = (1,5,2,'unknown',0)
87b869faf50f Fixed 1.5-breakage (we imported sys.version_info which did not exist then)
andy_robinson
parents: 1635
diff changeset
    33
1622
dafbc4bbcb36 Added Dinu's Jython 2.1 workaround
rgbecker
parents: 1605
diff changeset
    34
if platform[:4] == 'java' and version_info[:2] == (2, 1):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1653
diff changeset
    35
    # workaround for list()-bug in Jython 2.1 (should be fixed in 2.2)
1622
dafbc4bbcb36 Added Dinu's Jython 2.1 workaround
rgbecker
parents: 1605
diff changeset
    36
    def list(sequence):
dafbc4bbcb36 Added Dinu's Jython 2.1 workaround
rgbecker
parents: 1605
diff changeset
    37
        def f(x):
dafbc4bbcb36 Added Dinu's Jython 2.1 workaround
rgbecker
parents: 1605
diff changeset
    38
            return x
dafbc4bbcb36 Added Dinu's Jython 2.1 workaround
rgbecker
parents: 1605
diff changeset
    39
        return map(f, sequence)
dafbc4bbcb36 Added Dinu's Jython 2.1 workaround
rgbecker
parents: 1605
diff changeset
    40
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    41
class PDFError(Exception):
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    42
    pass
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
    43
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    44
# set this flag to get more vertical whitespace (and larger files)
1363
92e3fb40a784 Asian fonts now all working in major encodings, and partly documented
andy_robinson
parents: 1317
diff changeset
    45
LongFormat = 1
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    46
##if LongFormat: (doesn't work)
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    47
##    pass
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    48
##else:
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    49
##    LINEEND = "\n" # no wasteful carriage returns!
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    50
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    51
# __InternalName__ is a special attribute that can only be set by the Document arbitrator
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    52
__InternalName__ = "__InternalName__"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    53
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    54
# __RefOnly__ marks reference only elements that must be formatted on top level
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    55
__RefOnly__ = "__RefOnly__"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    56
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    57
# __Comment__ provides a (one line) comment to inline with an object ref, if present
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    58
#   if it is more than one line then percentize it...
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    59
__Comment__ = "__Comment__"
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    60
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    61
# If DoComments is set then add helpful (space wasting) comment lines to PDF files
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    62
DoComments = 1
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    63
if not LongFormat:
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
    64
    DoComments = 0
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    65
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    66
# name for standard font dictionary
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    67
BasicFonts = "BasicFonts"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    68
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    69
# name for the pages object
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    70
Pages = "Pages"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    71
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    72
### generic utilities
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    73
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    74
# for % substitutions
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    75
LINEENDDICT = {"LINEEND": LINEEND, "PERCENT": "%"}
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
    76
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
    77
from types import InstanceType
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
    78
def format(element, document, toplevel=0, InstanceType=InstanceType):
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    79
    """Indirection step for formatting.
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    80
       Ensures that document parameters alter behaviour
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    81
       of formatting for all elements.
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    82
    """
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
    83
    t=type(element)
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
    84
    if t is InstanceType:
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    85
        if not toplevel and hasattr(element, __RefOnly__):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    86
            # the object cannot be a component at non top level.
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    87
            # make a reference to it and return it's format
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
    88
            return document.Reference(element).format(document)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    89
        else:
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
    90
            f = element.format(document)
2273
82f026361b70 Fix bug introduced during transparency/ImageReader changes
rgbecker
parents: 2234
diff changeset
    91
            if not rl_config.invariant and DoComments and hasattr(element, __Comment__):
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    92
                f = "%s%s%s%s" % ("% ", element.__Comment__, LINEEND, f)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    93
            return f
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
    94
    elif t in (float, int):
2067
ae4fe8b9c3f4 Now deterministically formats all numbers
andy_robinson
parents: 2045
diff changeset
    95
        #use a controlled number formatting routine
ae4fe8b9c3f4 Now deterministically formats all numbers
andy_robinson
parents: 2045
diff changeset
    96
        #instead of str, so Jython/Python etc do not differ
ae4fe8b9c3f4 Now deterministically formats all numbers
andy_robinson
parents: 2045
diff changeset
    97
        return fp_str(element)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    98
    else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
    99
        return str(element)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   100
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   101
def xObjectName(externalname):
1560
382bbd1f20ae revert to older internal name for backward compatibility
rgbecker
parents: 1554
diff changeset
   102
    return "FormXob.%s" % externalname
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   103
1605
fb7c31cc48d1 backwards compatible name
aaron_watters
parents: 1578
diff changeset
   104
# backwards compatibility
fb7c31cc48d1 backwards compatible name
aaron_watters
parents: 1578
diff changeset
   105
formName = xObjectName
fb7c31cc48d1 backwards compatible name
aaron_watters
parents: 1578
diff changeset
   106
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   107
# no encryption
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   108
class NoEncryption:
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   109
    def encode(self, t):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   110
        "encode a string, stream, text"
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   111
        return t
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   112
    def prepare(self, document):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   113
        # get ready to do encryption
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   114
        pass
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   115
    def register(self, objnum, version):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   116
        # enter a new direct object
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   117
        pass
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   118
    def info(self):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   119
        # the representation of self in file if any (should be None or PDFDict)
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   120
        return None
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   121
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   122
class DummyDoc:
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   123
    "used to bypass encryption when required"
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   124
    encrypt = NoEncryption()
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   125
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   126
### the global document structure manager
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   127
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   128
class PDFDocument:
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   129
    _ID = None
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   130
    objectcounter = 0
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   131
    inObject = None
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   132
    # set this to define filters
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   133
    defaultStreamFilters = None
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   134
    encrypt = NoEncryption() # default no encryption
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   135
    pageCounter = 1
1838
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   136
    def __init__(self,
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   137
                 dummyoutline=0,
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   138
                 compression=rl_config.pageCompression,
2476
19fb0900fba1 pdfdoc.py: minor changes to simplify PDFInfoL/U in other apps
rgbecker
parents: 2378
diff changeset
   139
                 invariant=rl_config.invariant,
19fb0900fba1 pdfdoc.py: minor changes to simplify PDFInfoL/U in other apps
rgbecker
parents: 2378
diff changeset
   140
                 filename=None):
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   141
1838
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   142
        # allow None value to be passed in to mean 'give system defaults'
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   143
        if invariant is None:
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   144
            self.invariant = rl_config.invariant
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   145
        else:
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   146
            self.invariant = invariant
1635
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   147
        self.setCompression(compression)
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   148
        # signature for creating PDF ID
1977
74967fd03ed4 Fix up invariance
rgbecker
parents: 1965
diff changeset
   149
        import md5
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   150
        sig = self.signature = md5.new()
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   151
        sig.update("a reportlab document")
1977
74967fd03ed4 Fix up invariance
rgbecker
parents: 1965
diff changeset
   152
        if not self.invariant:
1987
b2401bcddd6d Finally commit changes to allow invariant pdfencryption to work properly
rgbecker
parents: 1985
diff changeset
   153
            cat = _getTimeStamp()
b2401bcddd6d Finally commit changes to allow invariant pdfencryption to work properly
rgbecker
parents: 1985
diff changeset
   154
        else:
b2401bcddd6d Finally commit changes to allow invariant pdfencryption to work properly
rgbecker
parents: 1985
diff changeset
   155
            cat = 946684800.0
b2401bcddd6d Finally commit changes to allow invariant pdfencryption to work properly
rgbecker
parents: 1985
diff changeset
   156
        sig.update(repr(cat)) # initialize with timestamp digest
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   157
        # mapping of internal identifier ("Page001") to PDF objectnumber and generation number (34, 0)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   158
        self.idToObjectNumberAndVersion = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   159
        # mapping of internal identifier ("Page001") to PDF object (PDFPage instance)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   160
        self.idToObject = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   161
        # internal id to file location
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   162
        self.idToOffset = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   163
        # number to id
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   164
        self.numberToId = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   165
        cat = self.Catalog = self._catalog = PDFCatalog()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   166
        pages = self.Pages = PDFPages()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   167
        cat.Pages = pages
483
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   168
        if dummyoutline:
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   169
            outlines = PDFOutlines0()
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   170
        else:
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   171
            outlines = PDFOutlines()
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   172
        self.Outlines = self.outline = outlines
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   173
        cat.Outlines = outlines
603
a6f460e53b00 forms in forms now work
aaron_watters
parents: 595
diff changeset
   174
        self.info = PDFInfo()
1838
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   175
        self.info.invariant = self.invariant
591
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   176
        #self.Reference(self.Catalog)
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   177
        #self.Reference(self.Info)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   178
        self.fontMapping = {}
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   179
        #make an empty font dictionary
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   180
        DD = PDFDictionary({})
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   181
        DD.__Comment__ = "The standard fonts dictionary"
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   182
        DDR = self.Reference(DD, BasicFonts)
1635
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   183
        self.delayedFonts = []
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   184
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   185
    def setCompression(self, onoff):
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   186
        # XXX: maybe this should also set self.defaultStreamFilters?
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   187
        self.compression = onoff
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   188
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   189
    def updateSignature(self, thing):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   190
        "add information to the signature"
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   191
        if self._ID: return # but not if its used already!
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   192
        self.signature.update(str(thing))
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   193
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   194
    def ID(self):
1838
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   195
        "A unique fingerprint for the file (unless in invariant mode)"
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   196
        if self._ID:
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   197
            return self._ID
1985
20a5484dd812 Fix up for 1.1.4 PIL palette access
rgbecker
parents: 1977
diff changeset
   198
        digest = self.signature.digest()
20a5484dd812 Fix up for 1.1.4 PIL palette access
rgbecker
parents: 1977
diff changeset
   199
        doc = DummyDoc()
2595
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   200
        ID = PDFString(digest,enc='raw')
1985
20a5484dd812 Fix up for 1.1.4 PIL palette access
rgbecker
parents: 1977
diff changeset
   201
        IDs = ID.format(doc)
20a5484dd812 Fix up for 1.1.4 PIL palette access
rgbecker
parents: 1977
diff changeset
   202
        self._ID = "%s %% ReportLab generated PDF document -- digest (http://www.reportlab.com) %s [%s %s] %s" % (
1838
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   203
                LINEEND, LINEEND, IDs, IDs, LINEEND)
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   204
        return self._ID
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   205
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   206
    def SaveToFile(self, filename, canvas):
1965
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   207
        if callable(getattr(filename, "write",None)):
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   208
            myfile = 0
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   209
            f = filename
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   210
            filename = str(getattr(filename,'name',''))
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   211
        else :
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   212
            myfile = 1
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   213
            filename = str(filename)
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   214
            f = open(filename, "wb")
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   215
        f.write(self.GetPDFData(canvas))
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   216
        if myfile:
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   217
            f.close()
2010
83e136234c0f Added import of os
rgbecker
parents: 2009
diff changeset
   218
            import os
2009
a6f1bd476301 Slight change to markfilename usage
rgbecker
parents: 1987
diff changeset
   219
            if os.name=='mac':
a6f1bd476301 Slight change to markfilename usage
rgbecker
parents: 1987
diff changeset
   220
                from reportlab.lib.utils import markfilename
a6f1bd476301 Slight change to markfilename usage
rgbecker
parents: 1987
diff changeset
   221
                markfilename(filename) # do platform specific file junk
1965
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   222
        if getattr(canvas,'_verbosity',None): print 'saved', filename
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   223
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   224
    def GetPDFData(self, canvas):
1635
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   225
        # realize delayed fonts
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   226
        for fnt in self.delayedFonts:
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   227
            fnt.addObjects(self)
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   228
        # add info stuff to signature
1838
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1799
diff changeset
   229
        self.info.invariant = self.invariant
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   230
        self.info.digest(self.signature)
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   231
        ### later: maybe add more info to sig?
483
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   232
        # prepare outline
591
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   233
        self.Reference(self.Catalog)
603
a6f460e53b00 forms in forms now work
aaron_watters
parents: 595
diff changeset
   234
        self.Reference(self.info)
483
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   235
        outline = self.outline
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
   236
        outline.prepare(self, canvas)
1965
02ef6a007f0b David Fraser's GetPDFData patch (to avoid unwanted StringIOs
rgbecker
parents: 1903
diff changeset
   237
        return self.format()
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   238
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   239
    def inPage(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   240
        """specify the current object as a page (enables reference binding and other page features)"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   241
        if self.inObject is not None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   242
            if self.inObject=="page": return
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   243
            raise ValueError, "can't go in page already in object %s" % self.inObject
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   244
        self.inObject = "page"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   245
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   246
    def inForm(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   247
        """specify that we are in a form xobject (disable page features, etc)"""
742
df72775fc33d fixed minor bug in forms handling
aaron_watters
parents: 724
diff changeset
   248
        # don't need this check anymore since going in a form pushes old context at canvas level.
df72775fc33d fixed minor bug in forms handling
aaron_watters
parents: 724
diff changeset
   249
        #if self.inObject not in ["form", None]:
df72775fc33d fixed minor bug in forms handling
aaron_watters
parents: 724
diff changeset
   250
        #    raise ValueError, "can't go in form already in object %s" % self.inObject
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   251
        self.inObject = "form"
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   252
        # don't need to do anything else, I think...
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   253
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   254
    def getInternalFontName(self, psfontname):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   255
        fm = self.fontMapping
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   256
        if fm.has_key(psfontname):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   257
            return fm[psfontname]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   258
        else:
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   259
            try:
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   260
                # does pdfmetrics know about it? if so, add
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   261
                fontObj = pdfmetrics.getFont(psfontname)
2678
38d18a697cd0 reportlab: Python2.5 changes + minor cosmetics and improvements
rgbecker
parents: 2666
diff changeset
   262
                if fontObj._dynamicFont:
1635
45fec4b75ae3 Added Marius Gedminas' TTF support
rgbecker
parents: 1634
diff changeset
   263
                    raise PDFError, "getInternalFontName(%s) called for a dynamic font" % repr(psfontname)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   264
                fontObj.addObjects(self)
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   265
                #self.addFont(fontObj)
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   266
                return fm[psfontname]
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   267
            except KeyError:
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   268
                raise PDFError, "Font %s not known!" % repr(psfontname)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   269
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   270
    def thisPageName(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   271
        return "Page"+repr(self.pageCounter)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   272
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   273
    def thisPageRef(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   274
        return PDFObjectReference(self.thisPageName())
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   275
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   276
    def addPage(self, page):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   277
        name = self.thisPageName()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   278
        self.Reference(page, name)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   279
        self.Pages.addPage(page)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   280
        self.pageCounter = self.pageCounter+1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   281
        self.inObject = None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   282
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   283
    def addForm(self, name, form):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   284
        """add a Form XObject."""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   285
        # XXX should check that name is a legal PDF name
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   286
        if self.inObject != "form":
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   287
            self.inForm()
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   288
        self.Reference(form, xObjectName(name))
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   289
        self.inObject = None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   290
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   291
    def annotationName(self, externalname):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   292
        return "Annot.%s"%externalname
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   293
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   294
    def addAnnotation(self, name, annotation):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   295
        self.Reference(annotation, self.annotationName(name))
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   296
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   297
    def refAnnotation(self, name):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   298
        internalname = self.annotationName(name)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   299
        return PDFObjectReference(internalname)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   300
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   301
    def setTitle(self, title):
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   302
        "embeds in PDF file"
2666
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   303
        if title is None:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   304
            self.info.title = '(anonymous)'
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   305
        else:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   306
            self.info.title = title
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   307
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   308
    def setAuthor(self, author):
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   309
        "embedded in PDF file"
2666
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   310
        #allow resetting to clear it
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   311
        if author is None:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   312
            self.info.author = '(anonymous)'
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   313
        else:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   314
            self.info.author = author
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   315
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   316
    def setSubject(self, subject):
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   317
        "embeds in PDF file"
2666
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   318
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   319
        #allow resetting to clear it
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   320
        if subject is None:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   321
            self.info.subject = '(unspecified)'
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   322
        else:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   323
            self.info.subject = subject
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   324
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   325
    def setKeywords(self, keywords):
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   326
        "embeds a string containing keywords in PDF file"
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   327
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   328
        #allow resetting to clear it but ensure it's a string
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   329
        if keywords is None:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   330
            self.info.keywords = ''
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   331
        else:
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   332
            self.info.keywords = keywords
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   333
2595
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   334
    def setDateFormatter(self, dateFormatter):
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   335
        self.info._dateFormatter = dateFormatter
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   336
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   337
    def getAvailableFonts(self):
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   338
        fontnames = self.fontMapping.keys()
1151
431ef9e78aae "the 14 std fonts" should always be "available"
aaron_watters
parents: 1063
diff changeset
   339
        # the standard 14 are also always available! (even if not initialized yet)
431ef9e78aae "the 14 std fonts" should always be "available"
aaron_watters
parents: 1063
diff changeset
   340
        import _fontdata
431ef9e78aae "the 14 std fonts" should always be "available"
aaron_watters
parents: 1063
diff changeset
   341
        for name in _fontdata.standardFonts:
431ef9e78aae "the 14 std fonts" should always be "available"
aaron_watters
parents: 1063
diff changeset
   342
            if name not in fontnames:
431ef9e78aae "the 14 std fonts" should always be "available"
aaron_watters
parents: 1063
diff changeset
   343
                fontnames.append(name)
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   344
        fontnames.sort()
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   345
        return fontnames
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
   346
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   347
    def format(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   348
        # register the Catalog/INfo and then format the objects one by one until exhausted
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   349
        # (possible infinite loop if there is a bug that continually makes new objects/refs...)
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   350
        # Prepare encryption
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   351
        self.encrypt.prepare(self)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   352
        cat = self.Catalog
603
a6f460e53b00 forms in forms now work
aaron_watters
parents: 595
diff changeset
   353
        info = self.info
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   354
        self.Reference(self.Catalog)
603
a6f460e53b00 forms in forms now work
aaron_watters
parents: 595
diff changeset
   355
        self.Reference(self.info)
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   356
        # register the encryption dictionary if present
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   357
        encryptref = None
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   358
        encryptinfo = self.encrypt.info()
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   359
        if encryptinfo:
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   360
            encryptref = self.Reference(encryptinfo)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   361
        # make std fonts (this could be made optional
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   362
        counter = 0 # start at first object (object 1 after preincrement)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   363
        ids = [] # the collection of object ids in object number order
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   364
        numbertoid = self.numberToId
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   365
        idToNV = self.idToObjectNumberAndVersion
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   366
        idToOb = self.idToObject
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   367
        idToOf = self.idToOffset
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   368
        ### note that new entries may be "appended" DURING FORMATTING
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   369
        done = None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   370
        File = PDFFile() # output collector
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   371
        while done is None:
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2571
diff changeset
   372
            counter += 1 # do next object...
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   373
            if numbertoid.has_key(counter):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   374
                id = numbertoid[counter]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   375
                #printidToOb
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   376
                obj = idToOb[id]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   377
                IO = PDFIndirectObject(id, obj)
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   378
                # register object number and version
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   379
                #encrypt.register(id,
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   380
                IOf = IO.format(self)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   381
                # add a comment to the PDF output
2273
82f026361b70 Fix bug introduced during transparency/ImageReader changes
rgbecker
parents: 2234
diff changeset
   382
                if not rl_config.invariant and DoComments:
1840
9c20e252dcd2 Fixed how object comments are formatted - could not always __class___.__name__
andy_robinson
parents: 1838
diff changeset
   383
                    try:
9c20e252dcd2 Fixed how object comments are formatted - could not always __class___.__name__
andy_robinson
parents: 1838
diff changeset
   384
                        classname = obj.__class__.__name__
9c20e252dcd2 Fixed how object comments are formatted - could not always __class___.__name__
andy_robinson
parents: 1838
diff changeset
   385
                    except:
9c20e252dcd2 Fixed how object comments are formatted - could not always __class___.__name__
andy_robinson
parents: 1838
diff changeset
   386
                        classname = repr(obj)
9c20e252dcd2 Fixed how object comments are formatted - could not always __class___.__name__
andy_robinson
parents: 1838
diff changeset
   387
                    File.add("%% %s: class %s %s" % (repr(id), classname[:50], LINEEND))
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   388
                offset = File.add(IOf)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   389
                idToOf[id] = offset
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   390
                ids.append(id)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   391
            else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   392
                done = 1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   393
        # sanity checks (must happen AFTER formatting)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   394
        lno = len(numbertoid)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   395
        if counter-1!=lno:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   396
            raise ValueError, "counter %s doesn't match number to id dictionary %s" %(counter, lno)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   397
        # now add the xref
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   398
        xref = PDFCrossReferenceTable()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   399
        xref.addsection(0, ids)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   400
        xreff = xref.format(self)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   401
        xrefoffset = File.add(xreff)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   402
        # now add the trailer
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   403
        trailer = PDFTrailer(
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   404
            startxref = xrefoffset,
1309
2b674954263d /Size in Trailer off by one.
aaron_watters
parents: 1179
diff changeset
   405
            Size = lno+1,
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   406
            Root = self.Reference(cat),
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   407
            Info = self.Reference(info),
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   408
            Encrypt = encryptref,
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   409
            ID = self.ID(),
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   410
            )
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   411
        trailerf = trailer.format(self)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   412
        File.add(trailerf)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   413
        # return string format for pdf file
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   414
        return File.format(self)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   415
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   416
    def hasForm(self, name):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   417
        """test for existence of named form"""
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   418
        internalname = xObjectName(name)
1395
65c2c66a3a1b canvas.hasForm now gives honest answers.
andy_robinson
parents: 1363
diff changeset
   419
        return self.idToObject.has_key(internalname)
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   420
2679
b8464568f5e2 tweaks to support PDF art boxes
andy
parents: 2678
diff changeset
   421
    def getFormBBox(self, name, boxType="MediaBox"):
b8464568f5e2 tweaks to support PDF art boxes
andy
parents: 2678
diff changeset
   422
        """get the declared bounding box of the form as a list.
b8464568f5e2 tweaks to support PDF art boxes
andy
parents: 2678
diff changeset
   423
        If you specify a different PDF box definition (e.g. the
b8464568f5e2 tweaks to support PDF art boxes
andy
parents: 2678
diff changeset
   424
        ArtBox) and it has one, that's what you'll get."""
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   425
        internalname = xObjectName(name)
1430
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   426
        if self.idToObject.has_key(internalname):
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   427
            theform = self.idToObject[internalname]
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   428
            if isinstance(theform, PDFFormXObject):
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   429
                # internally defined form
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   430
                return theform.BBoxList()
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   431
            elif isinstance(theform, PDFStream):
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   432
                # externally defined form
2679
b8464568f5e2 tweaks to support PDF art boxes
andy
parents: 2678
diff changeset
   433
                return list(theform.dictionary.dict[boxType].sequence)
1430
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   434
            else:
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   435
                raise ValueError, "I don't understand the form instance %s" % repr(name)
1ba38d150a9e support for getting form bounding boxes
aaron_watters
parents: 1395
diff changeset
   436
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   437
    def getXObjectName(self, name):
1395
65c2c66a3a1b canvas.hasForm now gives honest answers.
andy_robinson
parents: 1363
diff changeset
   438
        """Lets canvas find out what form is called internally.
65c2c66a3a1b canvas.hasForm now gives honest answers.
andy_robinson
parents: 1363
diff changeset
   439
        Never mind whether it is defined yet or not."""
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   440
        return xObjectName(name)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   441
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   442
    def xobjDict(self, formnames):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   443
        """construct an xobject dict (for inclusion in a resource dict, usually)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   444
           from a list of form names (images not yet supported)"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   445
        D = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   446
        for name in formnames:
1552
f83acda4ec71 expanded docco and fixed 'natural size'
andy_robinson
parents: 1510
diff changeset
   447
            internalname = xObjectName(name)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   448
            reference = PDFObjectReference(internalname)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   449
            D[internalname] = reference
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   450
        #print "xobjDict D", D
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   451
        return PDFDictionary(D)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   452
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   453
    def Reference(self, object, name=None, InstanceType=InstanceType):
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   454
        ### note references may "grow" during the final formatting pass: don't use d.keys()!
628
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   455
        # don't make references to other references, or non instances, unless they are named!
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   456
        #print"object type is ", type(object)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   457
        tob = type(object)
628
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   458
        idToObject = self.idToObject
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   459
        if name is None and (
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   460
            (tob is not InstanceType) or (tob is InstanceType and object.__class__ is PDFObjectReference)):
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   461
            return object
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   462
        if hasattr(object, __InternalName__):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   463
            # already registered
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   464
            intname = object.__InternalName__
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   465
            if name is not None and name!=intname:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   466
                raise ValueError, "attempt to reregister object %s with new name %s" % (
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   467
                    repr(intname), repr(name))
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   468
            if not idToObject.has_key(intname):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   469
                raise ValueError, "object named but not registered"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   470
            return PDFObjectReference(intname)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   471
        # otherwise register the new object
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   472
        objectcounter = self.objectcounter = self.objectcounter+1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   473
        if name is None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   474
            name = "R"+repr(objectcounter)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   475
        if idToObject.has_key(name):
628
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   476
            other = idToObject[name]
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   477
            if other!=object:
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   478
                raise ValueError, "redefining named object: "+repr(name)
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   479
            return PDFObjectReference(name)
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   480
        if tob is InstanceType:
7f5cd20a02f1 very subtle bug that is only hit by pagecatcher: indirect references to integers now work.
aaron_watters
parents: 603
diff changeset
   481
            object.__InternalName__ = name
591
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   482
        #print "name", name, "counter", objectcounter
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   483
        self.idToObjectNumberAndVersion[name] = (objectcounter, 0)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   484
        self.numberToId[objectcounter] = name
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   485
        idToObject[name] = object
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   486
        return PDFObjectReference(name)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   487
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   488
### chapter 4 Objects
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   489
PDFtrue = "true"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   490
PDFfalse = "false"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   491
PDFnull = "null"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   492
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   493
class PDFText:
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   494
    def __init__(self, t):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   495
        self.t = t
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   496
    def format(self, document):
2477
704e05bad378 pdfdoc.py: minor changes to bring into line with TBlatter's early serializer version
rgbecker
parents: 2476
diff changeset
   497
        result = binascii.hexlify(document.encrypt.encode(self.t))
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   498
        return "<%s>" % result
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   499
    def __str__(self):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   500
        dummydoc = DummyDoc()
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   501
        return self.format(dummydoc)
1014
ba7f9c1294ea added missing PDFText() function for consistency (needed by pagecatcher)
aaron_watters
parents: 873
diff changeset
   502
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   503
def PDFnumber(n):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   504
    return n
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   505
2517
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   506
import re
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   507
_re_cleanparens=re.compile('[^()]')
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   508
del re
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   509
def _isbalanced(s):
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   510
    '''test whether a string is balanced in parens'''
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   511
    s = _re_cleanparens.sub('',s)
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   512
    n = 0
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   513
    for c in s:
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   514
        if c=='(': n+=1
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   515
        else:
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   516
            n -= 1
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   517
            if n<0: return 0
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   518
    return not n and 1 or 0
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   519
2595
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   520
def _checkPdfdoc(utext):
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   521
    '''return true if no Pdfdoc encoding errors'''
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   522
    try:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   523
        utext.encode('pdfdoc')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   524
        return 1
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   525
    except UnicodeEncodeError, e:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   526
        return 0
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   527
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   528
class PDFString:
2595
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   529
    def __init__(self, s, escape=1, enc='auto'):
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   530
        '''s can be unicode/utf8 or a PDFString
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   531
        if escape is true then the output will be passed through escape
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   532
        if enc is raw then the string will be left alone
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   533
        if enc is auto we'll try and automatically adapt to utf_16_be if the
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   534
        effective string is not entirely in pdfdoc
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   535
        '''
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   536
        if isinstance(s,PDFString):
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   537
            self.s = s.s
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   538
            self.escape = s.escape
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   539
            self.enc = s.enc
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   540
        else:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   541
            self.s = s
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   542
            self.escape = escape
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   543
            self.enc = enc
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   544
    def format(self, document):
2517
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   545
        s = self.s
2595
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   546
        enc = getattr(self,'enc','auto')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   547
        if type(s) is str:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   548
            if enc is 'auto':
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   549
                try:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   550
                    u = s.decode('utf8')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   551
                except:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   552
                    print s
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   553
                    raise
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   554
                if _checkPdfdoc(u):
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   555
                    s = u.encode('pdfdoc')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   556
                else:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   557
                    s = codecs.BOM_UTF16_BE+u.encode('utf_16_be')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   558
        elif type(s) is unicode:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   559
            if enc is 'auto':
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   560
                if _checkPdfdoc(s):
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   561
                    s = s.encode('pdfdoc')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   562
                else:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   563
                    s = codecs.BOM_UTF16_BE+s.encode('utf_16_be')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   564
            else:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   565
                s = codecs.BOM_UTF16_BE+s.encode('utf_16_be')
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   566
        else:
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   567
            raise ValueError('PDFString argument must be str/unicode not %s' % type(s))
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
   568
2524
7e6da7c7fe2c merge stable 2687:2688 pdfdoc.py: attempt to robustify escape attribute access
rgbecker
parents: 2517
diff changeset
   569
        escape = getattr(self,'escape',1)
2517
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   570
        if not isinstance(document.encrypt,NoEncryption):
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   571
            s = document.encrypt.encode(s)
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   572
            escape = 1
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   573
        if escape:
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   574
            try:
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   575
                es = "(%s)" % pdfutils._escape(s)
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   576
            except:
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   577
                raise ValueError("cannot escape %s %s" % (s, repr(s)))
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   578
            if escape&2:
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   579
                es = es.replace('\\012','\n')
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   580
            if escape&4 and _isbalanced(s): 
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   581
                es = es.replace('\\(','(').replace('\\)',')')
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   582
            return es
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   583
        else:
c8f07edb561d pdfdoc: allow special escaping in Annotations and PDFString
rgbecker
parents: 2487
diff changeset
   584
            return '(%s)' % s
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   585
    def __str__(self):
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   586
        return "(%s)" % pdfutils._escape(self.s)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   587
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   588
def PDFName(data,lo=chr(0x21),hi=chr(0x7e)):
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   589
    # might need to change this to class for encryption
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   590
    #  NOTE: RESULT MUST ALWAYS SUPPORT MEANINGFUL COMPARISONS (EQUALITY) AND HASH
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   591
    # first convert the name
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   592
    L = list(data)
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   593
    for i,c in enumerate(L):
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   594
        if c<lo or c>hi or c in "%()<>{}[]#":
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   595
            L[i] = "#"+hex(ord(c))[2:] # forget the 0x thing...
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   596
    return "/"+(''.join(L))
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   597
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   598
class PDFDictionary:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   599
    multiline = LongFormat
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   600
    def __init__(self, dict=None):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   601
        """dict should be namestring to value eg "a": 122 NOT pdfname to value NOT "/a":122"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   602
        if dict is None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   603
            self.dict = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   604
        else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   605
            self.dict = dict.copy()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   606
    def __setitem__(self, name, value):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   607
        self.dict[name] = value
2730
b3fc23a74fd1 reportlab: Dirk Holtwick's editor's fixes :)
rgbecker
parents: 2679
diff changeset
   608
    def Reference(self, name, document):
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   609
        self.dict[name] = document.Reference(self.dict[name])
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   610
    def format(self, document,IND=LINEEND+' '):
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   611
        dict = self.dict
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   612
        keys = dict.keys()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   613
        keys.sort()
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   614
        L = [(format(PDFName(k),document)+" "+format(dict[k],document)) for k in keys]
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   615
        if self.multiline:
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   616
            L = IND.join(L)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   617
        else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   618
            # break up every 6 elements anyway
2540
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   619
            t=L.insert
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   620
            for i in xrange(6, len(L), 6):
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   621
                t(i,LINEEND)
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   622
            L = " ".join(L)
fadac956b695 pdfdoc.py: speed improvements
rgbecker
parents: 2524
diff changeset
   623
        return "<< %s >>" % L
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   624
2666
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   625
    def copy(self):
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   626
        return PDFDictionary(self.dict)
a72c25280be2 facilitating saving info dictionary
andy
parents: 2595
diff changeset
   627
    
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   628
# stream filters are objects to support round trip and
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   629
# possibly in the future also support parameters
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   630
class PDFStreamFilterZCompress:
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   631
    pdfname = "FlateDecode"
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   632
    def encode(self, text):
674
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   633
        from reportlab.lib.utils import import_zlib
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   634
        zlib = import_zlib()
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   635
        if not zlib: raise ImportError, "cannot z-compress zlib unavailable"
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   636
        return zlib.compress(text)
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   637
    def decode(self, encoded):
674
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   638
        from reportlab.lib.utils import import_zlib
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   639
        zlib = import_zlib()
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   640
        if not zlib: raise ImportError, "cannot z-decompress zlib unavailable"
c25a9dbfc27a Improved ImportError handling
rgbecker
parents: 628
diff changeset
   641
        return zlib.decompress(encoded)
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   642
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   643
# need only one of these, unless we implement parameters later
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   644
PDFZCompress = PDFStreamFilterZCompress()
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   645
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   646
class PDFStreamFilterBase85Encode:
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   647
    pdfname = "ASCII85Decode"
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   648
    def encode(self, text):
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   649
        from pdfutils import _AsciiBase85Encode, _wrap
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   650
        return _wrap(_AsciiBase85Encode(text))
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   651
    def decode(self, text):
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   652
        from pdfutils import _AsciiBase85Decode
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   653
        return _AsciiBase85Decode(text)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   654
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   655
# need only one of these too
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   656
PDFBase85Encode = PDFStreamFilterBase85Encode()
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   657
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   658
STREAMFMT = ("%(dictionary)s%(LINEEND)s" # dictionary
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   659
             "stream" # stream keyword
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   660
             "%(LINEEND)s" # a line end (could be just a \n)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   661
             "%(content)s" # the content, with no lineend
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   662
             "endstream%(LINEEND)s" # the endstream keyword
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   663
             )
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   664
class PDFStream:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   665
    '''set dictionary elements explicitly stream.dictionary[name]=value'''
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   666
    ### compression stuff not implemented yet
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   667
    __RefOnly__ = 1 # must be at top level
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   668
    def __init__(self, dictionary=None, content=None):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   669
        if dictionary is None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   670
            dictionary = PDFDictionary()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   671
        self.dictionary = dictionary
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   672
        self.content = content
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   673
        self.filters = None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   674
    def format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   675
        dictionary = self.dictionary
591
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   676
        # copy it for modification
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   677
        dictionary = PDFDictionary(dictionary.dict.copy())
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   678
        content = self.content
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   679
        filters = self.filters
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   680
        if self.content is None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   681
            raise ValueError, "stream content not set"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   682
        if filters is None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   683
            filters = document.defaultStreamFilters
591
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   684
        # only apply filters if they haven't been applied elsewhere
603
a6f460e53b00 forms in forms now work
aaron_watters
parents: 595
diff changeset
   685
        if filters is not None and not dictionary.dict.has_key("Filter"):
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   686
            # apply filters in reverse order listed
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   687
            rf = list(filters)
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   688
            rf.reverse()
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   689
            fnames = []
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   690
            for f in rf:
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   691
                #print "*****************content:"; print repr(content[:200])
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   692
                #print "*****************filter", f.pdfname
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   693
                content = f.encode(content)
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   694
                fnames.insert(0, PDFName(f.pdfname))
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   695
            #print "*****************finally:"; print content[:200]
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   696
            #print "****** FILTERS", fnames
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   697
            #stop
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   698
            dictionary["Filter"] = PDFArray(fnames)
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   699
        # "stream encoding is done after all filters have been applied"
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   700
        content = document.encrypt.encode(content)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   701
        fc = format(content, document)
591
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   702
        #print "type(content)", type(content), len(content), type(self.dictionary)
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   703
        lc = len(content)
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   704
        #if fc!=content: burp
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   705
        # set dictionary length parameter
591
8ab476fd7d96 minor changes to support pdfparse
aaron_watters
parents: 504
diff changeset
   706
        dictionary["Length"] = lc
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   707
        fd = format(dictionary, document)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   708
        sdict = LINEENDDICT.copy()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   709
        sdict["dictionary"] = fd
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   710
        sdict["content"] = fc
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   711
        return STREAMFMT % sdict
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   712
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   713
def teststream(content=None):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   714
    #content = "" # test
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   715
    if content is None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   716
        content = teststreamcontent
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   717
    content = string.strip(content)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   718
    content = string.replace(content, "\n", LINEEND) + LINEEND
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   719
    S = PDFStream()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   720
    S.content = content
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
   721
    S.filters = [PDFBase85Encode, PDFZCompress]
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   722
    # nothing else needed...
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   723
    S.__Comment__ = "test stream"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   724
    return S
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   725
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   726
teststreamcontent = """
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   727
1 0 0 1 0 0 cm BT /F9 12 Tf 14.4 TL ET
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   728
1.00 0.00 1.00 rg
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   729
n 72.00 72.00 432.00 648.00 re B*
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   730
"""
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   731
class PDFArray:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   732
    multiline = LongFormat
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   733
    def __init__(self, sequence):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   734
        self.sequence = list(sequence)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   735
    def References(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   736
        """make all objects in sequence references"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   737
        self.sequence = map(document.Reference, self.sequence)
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   738
    def format(self, document, IND=LINEEND+' '):
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   739
        L = [format(e, document) for e in self.sequence]
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   740
        if self.multiline:
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   741
            L = IND.join(L)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   742
        else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   743
            # break up every 10 elements anyway
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   744
            breakline = LINEEND+" "
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   745
            for i in xrange(10, len(L), 10):
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   746
                L.insert(i,breakline)
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   747
            L = ' '.join(L)
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   748
        return "[ %s ]" % L
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   749
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   750
INDIRECTOBFMT = ("%(n)s %(v)s obj%(LINEEND)s"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   751
                 "%(content)s" "%(LINEEND)s"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   752
                 "endobj" "%(LINEEND)s")
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   753
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   754
class PDFIndirectObject:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   755
    __RefOnly__ = 1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   756
    def __init__(self, name, content):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   757
        self.name = name
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   758
        self.content = content
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   759
    def format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   760
        name = self.name
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   761
        (n, v) = document.idToObjectNumberAndVersion[name]
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   762
        # set encryption parameters
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   763
        document.encrypt.register(n, v)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   764
        content = self.content
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   765
        fcontent = format(content, document, toplevel=1) # yes this is at top level
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   766
        sdict = LINEENDDICT.copy()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   767
        sdict["n"] = n
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   768
        sdict["v"] = v
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   769
        sdict["content"] = fcontent
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   770
        return INDIRECTOBFMT % sdict
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   771
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   772
class PDFObjectReference:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   773
    def __init__(self, name):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   774
        self.name = name
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   775
    def format(self, document):
1317
2c0575047463 allow forms to be forward references (to allow table of contents, eg).
aaron_watters
parents: 1309
diff changeset
   776
        try:
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   777
            return "%s %s R" % document.idToObjectNumberAndVersion[self.name]
1317
2c0575047463 allow forms to be forward references (to allow table of contents, eg).
aaron_watters
parents: 1309
diff changeset
   778
        except:
2541
495aea8213fb pdfdoc.py: more optimisations
rgbecker
parents: 2540
diff changeset
   779
            raise KeyError, "forward reference to %s not resolved upon final formatting" % repr(self.name)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   780
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   781
### chapter 5
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
   782
# Following Ken Lunde's advice and the PDF spec, this includes
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
   783
# some high-order bytes.  I chose the characters for Tokyo
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
   784
# in Shift-JIS encoding, as these cannot be mistaken for
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
   785
# any other encoding, and we'll be able to tell if something
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
   786
# has run our PDF files through a dodgy Unicode conversion.
1063
378a0f553608 cosmetics
aaron_watters
parents: 1062
diff changeset
   787
PDFHeader = (
378a0f553608 cosmetics
aaron_watters
parents: 1062
diff changeset
   788
"%PDF-1.3"+LINEEND+
378a0f553608 cosmetics
aaron_watters
parents: 1062
diff changeset
   789
"%\223\214\213\236 ReportLab Generated PDF document http://www.reportlab.com"+LINEEND)
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
   790
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   791
class PDFFile:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   792
    ### just accumulates strings: keeps track of current offset
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   793
    def __init__(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   794
        self.strings = []
2477
704e05bad378 pdfdoc.py: minor changes to bring into line with TBlatter's early serializer version
rgbecker
parents: 2476
diff changeset
   795
        self.write = self.strings.append
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   796
        self.offset = 0
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   797
        self.add(PDFHeader)
2477
704e05bad378 pdfdoc.py: minor changes to bring into line with TBlatter's early serializer version
rgbecker
parents: 2476
diff changeset
   798
704e05bad378 pdfdoc.py: minor changes to bring into line with TBlatter's early serializer version
rgbecker
parents: 2476
diff changeset
   799
    def closeOrReset(self):
704e05bad378 pdfdoc.py: minor changes to bring into line with TBlatter's early serializer version
rgbecker
parents: 2476
diff changeset
   800
        pass
704e05bad378 pdfdoc.py: minor changes to bring into line with TBlatter's early serializer version
rgbecker
parents: 2476
diff changeset
   801
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   802
    def add(self, s):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   803
        """should be constructed as late as possible, return position where placed"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   804
        result = self.offset
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   805
        self.offset = result+len(s)
2477
704e05bad378 pdfdoc.py: minor changes to bring into line with TBlatter's early serializer version
rgbecker
parents: 2476
diff changeset
   806
        self.write(s)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   807
        return result
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   808
    def format(self, document):
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   809
        strings = map(str, self.strings) # final conversion, in case of lazy objects
2359
d7991ae46607 pdfdoc: fix rare bug (exposed in tinyrml)
rgbecker
parents: 2332
diff changeset
   810
        return string.join(strings, "")
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   811
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   812
XREFFMT = '%0.10d %0.5d n'
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   813
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   814
class PDFCrossReferenceSubsection:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   815
    def __init__(self, firstentrynumber, idsequence):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   816
        self.firstentrynumber = firstentrynumber
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   817
        self.idsequence = idsequence
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   818
    def format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   819
        """id sequence should represent contiguous object nums else error. free numbers not supported (yet)"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   820
        firstentrynumber = self.firstentrynumber
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   821
        idsequence = self.idsequence
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   822
        entries = list(idsequence)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   823
        nentries = len(idsequence)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   824
        # special case: object number 0 is always free
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   825
        taken = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   826
        if firstentrynumber==0:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   827
            taken[0] = "standard free entry"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   828
            nentries = nentries+1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   829
            entries.insert(0, "0000000000 65535 f")
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   830
        idToNV = document.idToObjectNumberAndVersion
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   831
        idToOffset = document.idToOffset
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   832
        lastentrynumber = firstentrynumber+nentries-1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   833
        for id in idsequence:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   834
            (num, version) = idToNV[id]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   835
            if taken.has_key(num):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   836
                raise ValueError, "object number collision %s %s %s" % (num, repr(id), repr(taken[id]))
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   837
            if num>lastentrynumber or num<firstentrynumber:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   838
                raise ValueError, "object number %s not in range %s..%s" % (num, firstentrynumber, lastentrynumber)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   839
            # compute position in list
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   840
            rnum = num-firstentrynumber
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   841
            taken[num] = id
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   842
            offset = idToOffset[id]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   843
            entries[num] = XREFFMT % (offset, version)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   844
        # now add the initial line
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   845
        firstline = "%s %s" % (firstentrynumber, nentries)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   846
        entries.insert(0, firstline)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   847
        # make sure it ends with a LINEEND
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   848
        entries.append("")
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   849
        if LINEEND=="\n" or LINEEND=="\r":
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   850
            reflineend = " "+LINEEND # as per spec
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   851
        elif LINEEND=="\r\n":
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   852
            reflineend = LINEEND
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   853
        else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   854
            raise ValueError, "bad end of line! %s" % repr(LINEEND)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   855
        return string.join(entries, LINEEND)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   856
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   857
class PDFCrossReferenceTable:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   858
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   859
    def __init__(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   860
        self.sections = []
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   861
    def addsection(self, firstentry, ids):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   862
        section = PDFCrossReferenceSubsection(firstentry, ids)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   863
        self.sections.append(section)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   864
    def format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   865
        sections = self.sections
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   866
        if not sections:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   867
            raise ValueError, "no crossref sections"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   868
        L = ["xref"+LINEEND]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   869
        for s in self.sections:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   870
            fs = format(s, document)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   871
            L.append(fs)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   872
        return string.join(L, "")
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   873
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   874
TRAILERFMT = ("trailer%(LINEEND)s"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   875
              "%(dict)s%(LINEEND)s"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   876
              "startxref%(LINEEND)s"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   877
              "%(startxref)s%(LINEEND)s"
873
62ba1388703d New font embedding stuff.
rgbecker
parents: 742
diff changeset
   878
              "%(PERCENT)s%(PERCENT)sEOF%(LINEEND)s")
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   879
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   880
class PDFTrailer:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   881
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   882
    def __init__(self, startxref, Size=None, Prev=None, Root=None, Info=None, ID=None, Encrypt=None):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   883
        self.startxref = startxref
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   884
        if Size is None or Root is None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   885
            raise ValueError, "Size and Root keys required"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   886
        dict = self.dict = PDFDictionary()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   887
        for (n,v) in [("Size", Size), ("Prev", Prev), ("Root", Root),
1062
c6dec1c5a962 extensions to support encryption plugins
aaron_watters
parents: 1014
diff changeset
   888
                      ("Info", Info), ("ID", ID), ("Encrypt", Encrypt)]:
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   889
            if v is not None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   890
                dict[n] = v
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   891
    def format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   892
        fdict = format(self.dict, document)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   893
        D = LINEENDDICT.copy()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   894
        D["dict"] = fdict
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   895
        D["startxref"] = self.startxref
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   896
        return TRAILERFMT % D
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   897
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   898
#### XXXX skipping incremental update,
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   899
#### encryption
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   900
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   901
#### chapter 6, doc structure
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   902
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   903
class PDFCatalog:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   904
    __Comment__ = "Document Root"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   905
    __RefOnly__ = 1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   906
    # to override, set as attributes
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   907
    __Defaults__ = {"Type": PDFName("Catalog"),
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   908
                "PageMode": PDFName("UseNone"),
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   909
                }
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   910
    __NoDefault__ = string.split("""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   911
        Dests Outlines Pages Threads AcroForm Names OpenActions PageMode URI
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   912
        ViewerPreferences PageLabels PageLayout JavaScript StructTreeRoot SpiderInfo"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   913
                                 )
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   914
    __Refs__ = __NoDefault__ # make these all into references, if present
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   915
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   916
    def format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   917
        self.check_format(document)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   918
        defaults = self.__Defaults__
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   919
        Refs = self.__Refs__
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   920
        D = {}
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   921
        for k in defaults.keys():
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   922
            default = defaults[k]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   923
            v = None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   924
            if hasattr(self, k) and getattr(self,k) is not None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   925
                v = getattr(self, k)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   926
            elif default is not None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   927
                v = default
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   928
            if v is not None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   929
                D[k] = v
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   930
        for k in self.__NoDefault__:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   931
            if hasattr(self, k):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   932
                v = getattr(self,k)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   933
                if v is not None:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   934
                    D[k] = v
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   935
        # force objects to be references where required
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   936
        for k in Refs:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   937
            if D.has_key(k):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   938
                #print"k is", k, "value", D[k]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   939
                D[k] = document.Reference(D[k])
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   940
        dict = PDFDictionary(D)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   941
        return format(dict, document)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   942
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   943
    def showOutline(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   944
        self.PageMode = PDFName("UseOutlines")
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   945
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   946
    def showFullScreen(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   947
        self.PageMode = PDFName("FullScreen")
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
   948
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   949
    def check_format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   950
        """for use in subclasses"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   951
        pass
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   952
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   953
# not yet implementing
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   954
#  ViewerPreferences, PageLabelDictionaries,
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   955
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   956
class PDFPages(PDFCatalog):
2229
99cb312c5269 Fix transparency & jpeg behaviour
rgbecker
parents: 2200
diff changeset
   957
    """PAGES TREE WITH ONE INTERNAL NODE, FOR "BALANCING" CHANGE IMPLEMENTATION"""
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   958
    __Comment__ = "page tree"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   959
    __RefOnly__ = 1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   960
    # note: could implement page attribute inheritance...
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   961
    __Defaults__ = {"Type": PDFName("Pages"),
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   962
                    }
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   963
    __NoDefault__ = string.split("Kids Count Parent")
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   964
    __Refs__ = ["Parent"]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   965
    def __init__(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   966
        self.pages = []
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   967
    def __getitem__(self, item):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   968
        return self.pages[item]
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   969
    def addPage(self, page):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   970
        self.pages.append(page)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   971
    def check_format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   972
        # convert all pages to page references
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   973
        pages = self.pages
2229
99cb312c5269 Fix transparency & jpeg behaviour
rgbecker
parents: 2200
diff changeset
   974
        kids = PDFArray(pages)
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   975
        # make sure all pages are references
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   976
        kids.References(document)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   977
        self.Kids = kids
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   978
        self.Count = len(pages)
2678
38d18a697cd0 reportlab: Python2.5 changes + minor cosmetics and improvements
rgbecker
parents: 2666
diff changeset
   979
 
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   980
class PDFPage(PDFCatalog):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   981
    __Comment__ = "Page dictionary"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   982
    # all PDF attributes can be set explicitly
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   983
    # if this flag is set, the "usual" behavior will be suppressed
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   984
    Override_default_compilation = 0
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   985
    __RefOnly__ = 1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   986
    __Defaults__ = {"Type": PDFName("Page"),
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   987
                   # "Parent": PDFObjectReference(Pages),  # no! use document.Pages
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   988
                    }
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   989
    __NoDefault__ = string.split(""" Parent
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   990
        MediaBox Resources Contents CropBox Rotate Thumb Annots B Dur Hid Trans AA
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   991
        PieceInfo LastModified SeparationInfo ArtBox TrimBox BleedBox ID PZ
500
58d712fef651 Fixed page transitions; extended Pythonpoint
andy_robinson
parents: 494
diff changeset
   992
        Trans
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   993
    """)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   994
    __Refs__ = string.split("""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   995
        Contents Parent ID
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   996
    """)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   997
    pagewidth = 595
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   998
    pageheight = 842
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
   999
    stream = None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1000
    hasImages = 0
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1001
    compression = 0
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1002
    XObjects = None
500
58d712fef651 Fixed page transitions; extended Pythonpoint
andy_robinson
parents: 494
diff changeset
  1003
    Trans = None
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1004
    # transitionstring?
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1005
    # xobjects?
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1006
    # annotations
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1007
    def __init__(self):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1008
        # set all nodefaults to None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1009
        for name in self.__NoDefault__:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1010
            setattr(self, name, None)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1011
    def setCompression(self, onoff):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1012
        self.compression = onoff
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1013
    def setStream(self, code):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1014
        if self.Override_default_compilation:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1015
            raise ValueError, "overridden! must set stream explicitly"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1016
        from types import ListType
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1017
        if type(code) is ListType:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1018
            code = string.join(code, LINEEND)+LINEEND
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1019
        self.stream = code
500
58d712fef651 Fixed page transitions; extended Pythonpoint
andy_robinson
parents: 494
diff changeset
  1020
58d712fef651 Fixed page transitions; extended Pythonpoint
andy_robinson
parents: 494
diff changeset
  1021
    def setPageTransition(self, tranDict):
58d712fef651 Fixed page transitions; extended Pythonpoint
andy_robinson
parents: 494
diff changeset
  1022
        self.Trans = PDFDictionary(tranDict)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1023
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1024
    def check_format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1025
        # set up parameters unless usual behaviour is suppressed
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1026
        if self.Override_default_compilation:
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1027
            return
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1028
        self.MediaBox = self.MediaBox or PDFArray([0, 0, self.pagewidth, self.pageheight])
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1029
        if not self.Annots:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1030
            self.Annots = None
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1031
        else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1032
            #print self.Annots
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1033
            #raise ValueError, "annotations not reimplemented yet"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1034
            if type(self.Annots) is not types.InstanceType:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1035
                self.Annots = PDFArray(self.Annots)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1036
        if not self.Contents:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1037
            stream = self.stream
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1038
            if not stream:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1039
                self.Contents = teststream()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1040
            else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1041
                S = PDFStream()
484
cc20a344973c Aaron's latest update from the newslist
rgbecker
parents: 483
diff changeset
  1042
                if self.compression:
1679
e77be1edcd61 Fixed page stream filter order (Thanks Bernhard)
andy_robinson
parents: 1677
diff changeset
  1043
                    S.filters = [PDFBase85Encode, PDFZCompress]
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1044
                S.content = stream
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1045
                S.__Comment__ = "page stream"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1046
                self.Contents = S
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1047
        if not self.Resources:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1048
            resources = PDFResourceDictionary()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1049
            # fonts!
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1050
            resources.basicFonts()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1051
            if self.hasImages:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1052
                resources.allProcs()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1053
            else:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1054
                resources.basicProcs()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1055
            if self.XObjects:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1056
                #print "XObjects", self.XObjects.dict
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1057
                resources.XObject = self.XObjects
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1058
            self.Resources = resources
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1059
        if not self.Parent:
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1060
            pages = document.Pages
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1061
            self.Parent = document.Reference(pages)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1062
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1063
def testpage(document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1064
    P = PDFPage()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1065
    P.Contents = teststream()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1066
    pages = document.Pages
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1067
    P.Parent = document.Reference(pages)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1068
    P.MediaBox = PDFArray([0, 0, 595, 841])
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1069
    resources = PDFResourceDictionary()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1070
    resources.allProcs() # enable all procsets
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1071
    resources.basicFonts()
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1072
    P.Resources = resources
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1073
    pages.addPage(P)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1074
483
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
  1075
#### DUMMY OUTLINES IMPLEMENTATION FOR testing
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1076
DUMMYOUTLINE = """
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1077
<<
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1078
  /Count
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1079
      0
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1080
  /Type
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1081
      /Outlines
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1082
>>"""
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1083
483
c4c3969d1e30 undid last checkin and added an option for a default outline (different fix)
aaron_watters
parents: 482
diff changeset
  1084
class PDFOutlines0:
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1085
    __Comment__ = "TEST OUTLINE!"
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1086
    text = string.replace(DUMMYOUTLINE, "\n", LINEEND)
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1087
    __RefOnly__ = 1
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1088
    def format(self, document):
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1089
        return self.text
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1090
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1091
class OutlineEntryObject:
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1092
    "an entry in an outline"
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1093
    Title = Dest = Parent = Prev = Next = First = Last = Count = None
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1094
    def format(self, document):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1095
        D = {}
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1096
        D["Title"] = PDFString(self.Title)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1097
        D["Parent"] = self.Parent
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1098
        D["Dest"] = self.Dest
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1099
        for n in ("Prev", "Next", "First", "Last", "Count"):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1100
            v = getattr(self, n)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1101
            if v is not None:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1102
                D[n] = v
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1103
        PD = PDFDictionary(D)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1104
        return PD.format(document)
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
  1105
481
136669babedf complete revision of pdfdoc. Not finished (compression missing, testing needed)
aaron_watters
parents: 479
diff changeset
  1106
class PDFOutlines:
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1107
    """takes a recursive list of outline destinations
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1108
       like
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1109
           out = PDFOutline1()
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1110
           out.setNames(canvas, # requires canvas for name resolution
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1111
             "chapter1dest",
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1112
             ("chapter2dest",
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1113
              ["chapter2section1dest",
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1114
               "chapter2section2dest",
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1115
               "chapter2conclusiondest"]
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1116
             ), # end of chapter2 description
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1117
             "chapter3dest",
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1118
             ("chapter4dest", ["c4s1", "c4s2"])
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1119
             )
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1120
       Higher layers may build this structure incrementally. KISS at base level.
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1121
    """
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1122
    # first attempt, many possible features missing.
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1123
    #no init for now
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1124
    mydestinations = ready = None
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1125
    counter = 0
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1126
    currentlevel = -1 # ie, no levels yet
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1127
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1128
    def __init__(self):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1129
        self.destinationnamestotitles = {}
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1130
        self.destinationstotitles = {}
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1131
        self.levelstack = []
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1132
        self.buildtree = []
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1133
        self.closedict = {} # dictionary of "closed" destinations in the outline
0
f19e0a2433ab Initial revision
gmcm
parents:
diff changeset
  1134
2595
ffb020e8ab50 reportlab: PDFString vs Unicode changes
rgbecker
parents: 2575
diff changeset
  1135
    def addOutlineEntry(self, destinationname, level=0, title=None, closed=None):
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1136
        """destinationname of None means "close the tree" """
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1137
        from types import IntType, TupleType
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1138
        if destinationname is None and level!=0:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1139
            raise ValueError, "close tree must have level of 0"
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1140
        if type(level) is not IntType: raise ValueError, "level must be integer, got %s" % type(level)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1141
        if level<0: raise ValueError, "negative levels not allowed"
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1142
        if title is None: title = destinationname
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1143
        currentlevel = self.currentlevel
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1144
        stack = self.levelstack
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1145
        tree = self.buildtree
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1146
        # adjust currentlevel and stack to match level
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1147
        if level>currentlevel:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1148
            if level>currentlevel+1:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1149
                raise ValueError, "can't jump from outline level %s to level %s, need intermediates" %(currentlevel, level)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1150
            level = currentlevel = currentlevel+1
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1151
            stack.append([])
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1152
        while level<currentlevel:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1153
            # pop off levels to match
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1154
            current = stack[-1]
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1155
            del stack[-1]
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1156
            previous = stack[-1]
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1157
            lastinprevious = previous[-1]
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1158
            if type(lastinprevious) is TupleType:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1159
                (name, sectionlist) = lastinprevious
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1160
                raise ValueError, "cannot reset existing sections: " + repr(lastinprevious)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1161
            else:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1162
                name = lastinprevious
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1163
                sectionlist = current
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1164
                previous[-1] = (name, sectionlist)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1165
            #sectionlist.append(current)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1166
            currentlevel = currentlevel-1
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1167
        if destinationname is None: return
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1168
        stack[-1].append(destinationname)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1169
        self.destinationnamestotitles[destinationname] = title
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1170
        if closed: self.closedict[destinationname] = 1
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1171
        self.currentlevel = level
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1172
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1173
    def setDestinations(self, destinationtree):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1174
        self.mydestinations = destinationtree
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1175
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1176
    def format(self, document):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1177
        D = {}
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1178
        D["Type"] = PDFName("Outlines")
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1179
        c = self.count
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1180
        D["Count"] = c
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1181
        if c!=0:
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1182
            D["First"] = self.first
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1183
            D["Last"] = self.last
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1184
        PD = PDFDictionary(D)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1185
        return PD.format(document)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1186
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1187
    def setNames(self, canvas, *nametree):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1188
        desttree = self.translateNames(canvas, nametree)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1189
        self.setDestinations(desttree)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1190
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1191
    def setNameList(self, canvas, nametree):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1192
        "Explicit list so I don't need to do apply(...) in the caller"
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1193
        desttree = self.translateNames(canvas, nametree)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1194
        self.setDestinations(desttree)
1577
ad1dd1f8e061 Jerome Alet's auto transparency patch
rgbecker
parents: 1576
diff changeset
  1195
681
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1196
    def translateNames(self, canvas, object):
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1197
        "recursively translate tree of names into tree of destinations"
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1198
        from types import StringType, ListType, TupleType
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: 674
diff changeset
  1199
        Ot = type(object)
934a4f24ea5d Added explicit font and encoding support
andy_robinson
parents: