###############################################################################

#

#	ReportLab Public License Version 1.0

#

#   Except for the change of names the spirit and intention of this

#   license is the same as that of Python

#

#	(C) Copyright ReportLab Inc. 1998-2000.

#

#

# All Rights Reserved

#

# Permission to use, copy, modify, and distribute this software and its

# documentation for any purpose and without fee is hereby granted, provided

# that the above copyright notice appear in all copies and that both that

# copyright notice and this permission notice appear in supporting

# documentation, and that the name of ReportLab not be used

# in advertising or publicity pertaining to distribution of the software

# without specific, written prior permission. 

# 

#

# Disclaimer

#

# ReportLab Inc. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS

# SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,

# IN NO EVENT SHALL ReportLab BE LIABLE FOR ANY SPECIAL, INDIRECT

# OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS

# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR

# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR

# PERFORMANCE OF THIS SOFTWARE. 

#

###############################################################################

#	$Log: canvas.py,v $

#	Revision 1.50  2000/09/01 12:13:26  rgbecker

#	Improved optimisation checks

#	Revision 1.49  2000/08/31 23:34:36  rgbecker

#	Fix transform optimisation

#	

#	Revision 1.48  2000/08/20 21:39:50  andy_robinson

#	Changed an argument syntax for clarity

#	

#	Revision 1.47  2000/08/17 15:50:36  rgbecker

#	Various brutal changes to paragraph, canvas and textobject for speed/size

#	

#	Revision 1.46  2000/08/01 11:28:33  rgbecker

#	Converted to using fp_str

#	

#	Revision 1.45  2000/07/31 12:03:23  rgbecker

#	B Herzog fix to dimension formats

#	

#	Revision 1.44  2000/07/28 00:00:41  rgbecker

#	Bernhard herzog inspired fixes

#	

#	Revision 1.43  2000/06/30 15:27:55  rgbecker

#	Allow for non-caching of images

#	

#	Revision 1.42  2000/06/26 15:58:22  rgbecker

#	Simple fix to widths problem

#	

#	Revision 1.41  2000/06/09 16:18:19  andy_robinson

#	Doc strings, sequencer

#	

#	Revision 1.40  2000/06/09 01:45:22  aaron_watters

#	Lots of documentation additions and changes.

#	

#	Revision 1.39  2000/06/01 15:23:06  rgbecker

#	Platypus re-organisation

#	

#	Revision 1.38  2000/05/26 09:44:40  rgbecker

#	generalised colors slightly

#	

#	Revision 1.37  2000/05/23 14:06:45  andy_robinson

#	Preformatted objects now know how to split themselves.

#	

#	Revision 1.36  2000/05/18 17:11:12  aaron_watters

#	removed 0's on stable linkage and outline operations.

#	

#	Revision 1.35  2000/05/18 09:05:08  andy_robinson

#	Resynchronization

#	

#	Revision 1.34  2000/04/28 17:33:44  andy_robinson

#	Added font encoding support and changed default encoding to WinAnsi

#	

#	Revision 1.33  2000/04/28 14:18:16  rgbecker

#	Use str(filename) not '<Unknown>'

#	

#	Revision 1.32  2000/04/28 13:37:40  rgbecker

#	Fix verbose filename print when it's actually a file type object

#	

#	Revision 1.31  2000/04/28 09:10:20  rgbecker

#	Changed zlib error handling

#	

#	Revision 1.30  2000/04/25 20:20:13  aaron_watters

#	Added support for closed outline entries

#	

#	Revision 1.29  2000/04/18 19:52:35  aaron_watters

#	eliminated inForm/inPage apis in favor of only beginForm..endForm

#	(page mode is automatically inferred when page-only operations are

#	attempted...)

#	

#	Revision 1.28  2000/04/15 14:58:32  aaron_watters

#	Completed addOutlineEntry0 api

#	

#	Revision 1.27  2000/04/14 11:28:32  andy_robinson

#	Removed illegal append statement usage in canvas.grid()

#	

#	Revision 1.26  2000/04/12 16:26:51  rgbecker

#	XML Tagged Paragraph parser changes

#	

#	Revision 1.25  2000/04/10 09:21:21  andy_robinson

#	Color methods in textobject and canvas now synchronised.

#	Added 'verbosity' keyword to allow hiding of 'save myfile.pdf' messages.

#	

#	Revision 1.24  2000/04/06 09:52:02  andy_robinson

#	Removed some old comments; tweaks to experimental Outline methods.

#	

#	Revision 1.23  2000/04/05 16:26:36  rgbecker

#	Fixes to setFill/StrokeColor

#	

#	Revision 1.22  2000/04/05 16:21:02  rgbecker

#	Added _SeqTypes for efficiency

#	

#	Revision 1.21  2000/04/05 16:15:11  rgbecker

#	Made setFill/StrokeColor polymorphic

#	

#	Revision 1.20  2000/04/03 09:36:15  andy_robinson

#	Using trailing zero convention for new form and link API

#	

#	Revision 1.19  2000/04/02 02:53:49  aaron_watters

#	added support for outline trees

#	

#	Revision 1.18  2000/03/26 20:45:01  aaron_watters

#	added beginForm..endForm and fixed some naming convention issues.

#	

#	Revision 1.17  2000/03/24 21:02:21  aaron_watters

#	added support for destinations, forms, linkages

#	

#	Revision 1.15  2000/03/10 21:46:04  andy_robinson

#	fixed typo in setDash

#	

#	Revision 1.14  2000/03/08 13:40:03  andy_robinson

#	Canvas has two methods setFillColor(aColor) and setStrokeColor(aColor)

#	which accepts color objects directly.

#	

#	Revision 1.13  2000/03/06 20:06:36  rgbecker

#	Typo self._currentPageHasImages = 1

#	

#	Revision 1.12  2000/03/02 12:58:58  rgbecker

#	Remove over officious import checks Imag/zlib

#	

#	Revision 1.11  2000/03/02 10:28:54  rgbecker

#	[].extend illegal in 1.5.1

#	

#	Revision 1.10  2000/02/24 17:28:13  andy_robinson

#	Added methods setFillGray(g), setStrokeGray(g) where 0 <= g <= 1

#	

#	Revision 1.9  2000/02/24 09:12:55  andy_robinson

#	

#	Removed some constants which are no longer used.

#	

#	Revision 1.8  2000/02/20 14:43:27  rgbecker

#	_currentPageHasImages = 0 in init

#	

#	Revision 1.7  2000/02/20 11:08:56  rgbecker

#	Canvas.setPageSize fix

#	

#	Revision 1.6  2000/02/17 15:26:28  rgbecker

#	Change page compression default

#	

#	Revision 1.5  2000/02/17 02:08:04  rgbecker

#	Docstring & other fixes

#	

#	Revision 1.4  2000/02/16 09:42:50  rgbecker

#	Conversion to reportlab package

#	

#	Revision 1.3  2000/02/15 17:55:59  rgbecker

#	License text fixes

#	

#	Revision 1.2  2000/02/15 15:47:09  rgbecker

#	Added license, __version__ and Logi comment

#	

__doc__=""" 

PDFgen is a library to generate PDF files containing text and graphics.  It is the 

foundation for a complete reporting solution in Python.  It is also the

foundation for piddlePDF, the PDF back end for PIDDLE.

Documentation is a little slim right now; run then look at testpdfgen.py

to get a clue.

Progress Reports:

8.83, 2000-01-13, gmcm:

    Packagizing:

        renamed from pdfgen.py to canvas.py

        broke out PDFTextObject to textobject.py

        broke out PDFPathObject to pathobject.py

        placed all three in a package directory named pdfgen

0.82, 1999-10-27, AR:

        Fixed some bugs on printing to Postscript.  Added 'Text Object'

        analogous to Path Object to control entry and exit from text mode.

        Much simpler clipping API.  All verified to export Postscript and

        redistill.

        One limitation still - clipping to text paths is fine in Acrobat

        but not in Postscript (any level)

0.81,1999-10-13, AR:

        Adding RoundRect; changed all format strings to use %0.2f instead of %s,

        so we don't get exponentials in the output.

0.8,1999-10-07, AR:  all changed!

"""

##  0.81    1999-10-13:

##                

##

##

import os

import sys

import string

import time

import tempfile

import cStringIO

from types import *

from math import sin, cos, tan, pi, ceil

from reportlab.pdfbase import pdfutils

from reportlab.pdfbase import pdfdoc

from reportlab.pdfbase import pdfmetrics

from reportlab.pdfgen  import pdfgeom, pathobject, textobject

from reportlab.lib.colors import ColorType, toColor

try:

	import zlib

except ImportError:

	zlib = None

from reportlab.lib.utils import fp_str

_SeqTypes=(TupleType,ListType)

# Robert Kern

# Constants for closing paths.

# May be useful if one changes 'arc' and 'rect' to take a

# default argument that tells how to close the path.

# That way we can draw filled shapes.

FILL_EVEN_ODD = 0

FILL_NON_ZERO = 1

    #this is used by path-closing routines.

    #map stroke, fill, fillmode -> operator

    # fillmode: 1 = non-Zero (obviously), 0 = evenOdd

PATH_OPS = {(0, 0, FILL_EVEN_ODD) : 'n',  #no op

            (0, 0, FILL_NON_ZERO) : 'n',  #no op

            (1, 0, FILL_EVEN_ODD) : 'S',  #stroke only

            (1, 0, FILL_NON_ZERO) : 'S',  #stroke only

            (0, 1, FILL_EVEN_ODD) : 'f*',  #Fill only

            (0, 1, FILL_NON_ZERO) : 'f',  #Fill only

            (1, 1, FILL_EVEN_ODD) : 'B*',  #Stroke and Fill

            (1, 1, FILL_NON_ZERO) : 'B',  #Stroke and Fill

            }

class Canvas:

    """This class is the programmer's interface to the PDF file format.  Methods

    are (or will be) provided here to do just about everything PDF can do.

    The underlying model to the canvas concept is that of a graphics state machine

    that at any given point in time has a current font, fill color (for figure

    interiors), stroke color (for figure borders), line width and geometric transform, among

    many other characteristics.

    Canvas methods generally either draw something (like canvas.line) using the

    current state of the canvas or change some component of the canvas

    state (like canvas.setFont).  The current state can be saved and restored

    using the saveState/restoreState methods.

    Objects are "painted" in the order they are drawn so if, for example

    two rectangles overlap the last draw will appear "on top".  PDF form

    objects (supported here) are used to draw complex drawings only once,

    for possible repeated use.

    There are other features of canvas which are not visible when printed,

    such as outlines and bookmarks which are used for navigating a document

    in a viewer.

    Here is a very silly example usage which generates a Hello World pdf document.

    from reportlab.pdfgen import canvas

    c = canvas.Canvas("hello.pdf")

    # move the origin up and to the left

    c.translate(inch,inch) 

    # define a large font

    c.setFont("Helvetica", 80)

    # choose some colors

    c.setStrokeColorRGB(0.2,0.5,0.3)

    c.setFillColorRGB(1,0,1)

    # draw a rectangle

    c.rect(inch,inch,6*inch,9*inch, fill=1)

    # make text go straight up

    c.rotate(90)

    # change color

    c.setFillColorRGB(0,0,0.77)

    # say hello (note after rotate the y coord needs to be negative!)

    c.drawString(3*inch, -3*inch, "Hello World")

    c.showPage()

    c.save()

    """

    def __init__(self,filename,

                 pagesize=(595.27,841.89),

                 bottomup = 1,

                 pageCompression=0,

				 encoding=pdfdoc.DEFAULT_ENCODING,

                 verbosity=0):

        """Create a canvas of a given size. etc.

        Most of the attributes are private - we will use set/get methods

        as the preferred interface.  Default page size is A4."""

        self._filename = filename

        self._doc = pdfdoc.PDFDocument(encoding)

        #this only controls whether it prints 'saved ...' - 0 disables

        self._verbosity = verbosity

        self._pagesize = pagesize

        #self._currentPageHasImages = 0

        self._pageTransitionString = ''

        self._destinations = {} # dictionary of destinations for cross indexing.

        self.setPageCompression(pageCompression)

        self._pageNumber = 1   # keep a count

        #self3 = []    #where the current page's marking operators accumulate

        self._restartAccumulators()  # restart all accumulation state (generalized, arw)

        self._annotationCount = 0

        self._outlines = [] # list for a name tree

        #PostScript has the origin at bottom left. It is easy to achieve a top-

        #down coord system by translating to the top of the page and setting y

        #scale to -1, but then text is inverted.  So self.bottomup is used

        #to also set the text matrix accordingly.  You can now choose your

        #drawing coordinates.

        self.bottomup = bottomup

        self._make_preamble()

        #initial graphics state

        self._x = 0

        self._y = 0

        self._fontname = 'Times-Roman'

        self._fontsize = 12

        self._textMode = 0  #track if between BT/ET

        self._leading = 14.4

        self._currentMatrix = (1., 0., 0., 1., 0., 0.)

        self._fillMode = 0   #even-odd

        #text state        

        self._charSpace = 0

        self._wordSpace = 0

        self._horizScale = 100

        self._textRenderMode = 0

        self._rise = 0

        self._textLineMatrix = (1., 0., 0., 1., 0., 0.)

        self._textMatrix = (1., 0., 0., 1., 0., 0.)

        # line drawing        

        self._lineCap = 0

        self._lineJoin = 0

        self._lineDash = None  #not done

        self._lineWidth = 0

        self._mitreLimit = 0

        self._fillColorRGB = (0,0,0)

        self._strokeColorRGB = (0,0,0)

    def _make_preamble(self):

        if self.bottomup:

            #set initial font

            self._preamble = '1 0 0 1 0 0 cm BT /F9 12 Tf 14.4 TL ET'

        else:

            #switch coordinates, flip text and set font

            self._preamble = '1 0 0 -1 0 %s cm BT /F9 12 Tf 14.4 TL ET' % fp_str(self._pagesize[1])

    def _escape(self, s):

        """PDF escapes are like Python ones, but brackets need slashes before them too.

        Use Python's repr function and chop off the quotes first"""

        s = repr(s)[1:-1]

        s = string.replace(s, '(','\(')

        s = string.replace(s, ')','\)')

        return s

    #info functions - non-standard

    def setAuthor(self, author):

        """identify the author for invisible embedding inside the PDF document.

           the author annotation will appear in the the text of the file but will

           not automatically be seen when the document is viewed."""

        self._doc.setAuthor(author)

    def addOutlineEntry(self, title, key, level=0, closed=None):

        """Adds a new entry to the outline at given level.  If LEVEL not specified,

        entry goes at the top level.  If level specified, it must be

        no more than 1 greater than the outline level in the last call.

        The key must be the (unique) name of a bookmark.

        the title is the (non-unique) name to be displayed for the entry.

        If closed is set then the entry should show no subsections by default

        when displayed.

        Example

           c.addOutlineEntry("first section", "section1")

           c.addOutlineEntry("introduction", "s1s1", 1, closed=1)

           c.addOutlineEntry("body", "s1s2", 1)

           c.addOutlineEntry("detail1", "s1s2s1", 2)

           c.addOutlineEntry("detail2", "s1s2s2", 2)

           c.addOutlineEntry("conclusion", "s1s3", 1)

           c.addOutlineEntry("further reading", "s1s3s1", 2)

           c.addOutlineEntry("second section", "section1")

           c.addOutlineEntry("introduction", "s2s1", 1)

           c.addOutlineEntry("body", "s2s2", 1, closed=1)

           c.addOutlineEntry("detail1", "s2s2s1", 2)

           c.addOutlineEntry("detail2", "s2s2s2", 2)

           c.addOutlineEntry("conclusion", "s2s3", 1)

           c.addOutlineEntry("further reading", "s2s3s1", 2)

        generated outline looks like

            - first section

            |- introduction

            |- body

            |  |- detail1

            |  |- detail2

            |- conclusion

            |  |- further reading

            - second section

            |- introduction

            |+ body

            |- conclusion

            |  |- further reading

        Note that the second "body" is closed.

        Note that you can jump from level 5 to level 3 but not

        from 3 to 5: instead you need to provide all intervening

        levels going down (4 in this case).  Note that titles can

        collide but keys cannot.

        """

        #to be completed

        #self._outlines.append(title)

        self._doc.outline.addOutlineEntry(key, level, title, closed=closed)

    def setOutlineNames0(self, *nametree):   # keep this for now (?)

        """nametree should can be a recursive tree like so

           c.setOutlineNames(

             "chapter1dest",

             ("chapter2dest",

              ["chapter2section1dest",

               "chapter2section2dest",

               "chapter2conclusiondest"]

             ), # end of chapter2 description

             "chapter3dest",

             ("chapter4dest", ["c4s1", "c4s2"])

             )

          each of the string names inside must be bound to a bookmark

          before the document is generated.

        """

        #print nametree

        apply(self._doc.outline.setNames, (self,)+nametree)

    def setTitle(self, title):

        """write a title into the PDF file that won't automatically display

           in the document itself."""

        self._doc.setTitle(title)

    def setSubject(self, subject):

        """write a subject into the PDF file that won't automatically display

           in the document itself."""

        self._doc.setSubject(subject)

    def pageHasData(self):

        "Info function - app can call it after showPage to see if it needs a save"

        return len(self._code) == 0

    def showOutline(self):

        "Specify that Acrobat Reader should start with the outline tree visible"

        self._doc._catalog.showOutline()

    def showPage(self):

        """Close the current page and possibly start on a new page."""

        page = pdfdoc.PDFPage()