###############################################################################
#
# 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: doctemplate.py,v $
# Revision 1.27 2000/07/10 11:58:35 andy_robinson
# Pre-incrementing bug fixed
#
# Revision 1.26 2000/07/07 16:21:12 rgbecker
# Cosmetics
#
# Revision 1.25 2000/07/06 12:40:37 rgbecker
# Push canvas into flowables during wrap/split
#
# Revision 1.24 2000/07/05 12:22:21 rgbecker
# Force _calc in SimpleDocTemplae.build
#
# Revision 1.23 2000/07/03 15:39:51 rgbecker
# Documentation fixes
#
# Revision 1.22 2000/06/28 14:52:43 rgbecker
# Documentation changes
#
# Revision 1.21 2000/06/26 15:58:22 rgbecker
# Simple fix to widths problem
#
# Revision 1.20 2000/06/21 12:27:42 rgbecker
# remove UserDocTemplate, but add Andy's hook methods
#
# Revision 1.19 2000/06/20 21:56:17 andy_robinson
# re-synching after sourceforge went weird
#
# Revision 1.18 2000/06/19 23:51:23 andy_robinson
# Added UserDocTemplate class, and paragraph.getPlainText()
#
# Revision 1.17 2000/06/19 11:14:03 andy_robinson
# Global sequencer put in the 'story builder'.
#
# Revision 1.16 2000/06/16 13:49:20 aaron_watters
# new build parameters to allow alternate filename and canvas implementation
# (in order to support slideshow summary mode, for example, or embedding one
# document in another).
#
# Revision 1.15 2000/06/13 13:03:31 aaron_watters
# more documentation changes
#
# Revision 1.14 2000/06/01 16:27:56 rgbecker
# pageSize is wrong at present
#
# Revision 1.13 2000/06/01 15:23:06 rgbecker
# Platypus re-organisation
#
# Revision 1.12 2000/05/26 10:27:37 rgbecker
# Fixed infinite recursion bug
#
# Revision 1.11 2000/05/17 22:17:38 rgbecker
# Renamed BasicFrame to Frame
#
# Revision 1.10 2000/05/17 16:29:40 rgbecker
# Removal of SimpleFrame
#
# Revision 1.9 2000/05/17 15:37:33 rgbecker
# Changes related to removal of SimpleFlowDocument
#
# Revision 1.8 2000/05/16 16:15:16 rgbecker
# Changes related to removal of SimpleFlowDocument
#
# Revision 1.7 2000/05/16 14:28:55 rgbecker
# Fixes/Changes to get testplatypus to work with new framework
#
# Revision 1.6 2000/05/15 15:07:32 rgbecker
# Added drawPage
#
# Revision 1.5 2000/05/13 08:33:53 rgbecker
# fix typo in import
#
# Revision 1.4 2000/05/12 16:21:02 rgbecker
# _donothing explicit import
#
# Revision 1.3 2000/05/12 14:53:38 rgbecker
# Handle splitting error in build
#
# Revision 1.2 2000/05/12 14:45:31 rgbecker
# Single actions only in ActionFlowables
#
# Revision 1.1 2000/05/12 12:53:33 rgbecker
# Initial try at a document template class
#
__version__=''' $Id: doctemplate.py,v 1.27 2000/07/10 11:58:35 andy_robinson Exp $ '''
__doc__="""
This module contains the core structure of platypus.
Platypus constructs documents. Document styles are determined by DocumentTemplates.
Each DocumentTemplate contains one or more PageTemplates which defines the look of the
pages of the document.
Each PageTemplate has a procedure for drawing the "non-flowing" part of the page
(for example the header, footer, page number, fixed logo graphic, watermark, etcetera) and
a set of Frames which enclose the flowing part of the page (for example the paragraphs,
tables, or non-fixed diagrams of the text).
A document is built when a DocumentTemplate is fed a sequence of Flowables.
The action of the build consumes the flowables in order and places them onto
frames on pages as space allows. When a frame runs out of space the next frame
of the page is used. If no frame remains a new page is created. A new page
can also be created if a page break is forced.
The special invisible flowable NextPageTemplate can be used to specify
the page template for the next page (which by default is the one being used
for the current frame).
"""
from reportlab.platypus.flowables import *
from reportlab.platypus.paragraph import Paragraph
from reportlab.platypus.frames import Frame
import reportlab.lib.sequencer
from types import *
import sys
def _doNothing(canvas, doc):
"Dummy callback for onPage"
pass
class ActionFlowable(Flowable):
'''This Flowable is never drawn, it can be used for data driven controls
For example to change a page template (from one column to two, for example)
use NextPageTemplate which creates an ActionFlowable.
'''
def __init__(self,action=[]):
if type(action) not in (ListType, TupleType):
action = (action,)
self.action = action
def wrap(self, availWidth, availHeight):
'''Should never be called.'''
raise NotImplementedError
def draw(self):
'''Should never be called.'''
raise NotImplementedError
def apply(self,doc):
'''
This is called by the doc.build processing to allow the instance to
implement its behaviour
'''
action = self.action[0]
args = tuple(self.action[1:])
arn = 'handle_'+action
try:
apply(getattr(doc,arn), args)
except AttributeError, aerr:
if aerr.args[0]==arn:
raise NotImplementedError, "Can't handle ActionFlowable(%s)" % action
else:
raise
except "bogus":
t, v, None = sys.exc_info()
raise t, "%s\n handle_%s args=%s"%(v,action,args)
def __call__(self):
return self
FrameBreak = ActionFlowable('frameEnd')
PageBegin = ActionFlowable('pageBegin')
class NextPageTemplate(ActionFlowable):
"""When you get to the next page, use the template specified (change to two column, for example) """
def __init__(self,pt):
ActionFlowable.__init__(self,('nextPageTemplate',pt))
class PageTemplate:
"""
essentially a list of Frames and an onPage routine to call at the start
of a page when this is selected. onPageEnd gets called at the end.
derived classes can also implement beforeDrawPage and afterDrawPage if they want
"""
def __init__(self,id=None,frames=[],onPage=_doNothing, onPageEnd=_doNothing):
if type(frames) not in (ListType,TupleType): frames = [frames]
assert filter(lambda x: not isinstance(x,Frame), frames)==[], "frames argument error"
self.id = id
self.frames = frames
self.onPage = onPage
self.onPageEnd = onPageEnd
def beforeDrawPage(self,canv,doc):
"""Override this if you want additional functionality or prefer
a class based page routine. Called before any flowables for
this page are processed."""
pass
def afterDrawPage(self, canv, doc):
"""This is called after the last flowable for the page has
been processed. You might use this if the page header or
footer needed knowledge of what flowables were drawn on
this page."""
pass
class BaseDocTemplate:
"""
First attempt at defining a document template class.
The basic idea is simple.
0) The document has a list of data associated with it
this data should derive from flowables. We'll have
special classes like PageBreak, FrameBreak to do things
like forcing a page end etc.
1) The document has one or more page templates.
2) Each page template has one or more frames.
3) The document class provides base methods for handling the
story events and some reasonable methods for getting the
story flowables into the frames.
4) The document instances can override the base handler routines.
Most of the methods for this class are not called directly by the user,
but in some advanced usages they may need to be overridden via subclassing.
EXCEPTION: doctemplate.build(...) must be called for most reasonable uses
since it builds a document using the page template.
Each document template builds exactly one document into a file specified
by the filename argument on initialization.
Possible keyword arguments for the initialization:
pageTemplates: A list of templates. Must be nonempty. Names
assigned to the templates are used for referring to them so no two used
templates should have the same name. For example you might want one template
for a title page, one for a section first page, one for a first page of
a chapter and two more for the interior of a chapter on odd and even pages.
If this argument is omitted then at least one pageTemplate should be provided
using the addPageTemplates method before the document is built.
showBoundary: if set draw a box around the frame boundaries.
leftMargin:
rightMargin:
topMargin:
bottomMargin: Margin sizes in points (default 1 inch)
These margins may be overridden by the pageTemplates. They are primarily of interest
for the SimpleDocumentTemplate subclass.
allowSplitting: If set flowables (eg, paragraphs) may be split across frames or pages
(default: 1)
title: Internal title for document (does not automatically display on any page)
author: Internal author for document (does not automatically display on any page)
"""
_initArgs = { 'pagesize':DEFAULT_PAGE_SIZE,
'pageTemplates':[],
'showBoundary':0,
'leftMargin':inch,
'rightMargin':inch,
'topMargin':inch,
'bottomMargin':inch,
'allowSplitting':1,
'title':None,
'author':None,
'_pageBreakQuick':1}
_invalidInitArgs = ()
def __init__(self, filename, **kw):
"""create a document template bound to a filename (see class documentation for keyword arguments)"""
self.filename = filename
for k in self._initArgs.keys():
if not kw.has_key(k):
v = self._initArgs[k]
else:
if k in self._invalidInitArgs:
raise ValueError, "Invalid argument %s" % k
v = kw[k]
setattr(self,k,v)
p = self.pageTemplates
self.pageTemplates = []
self.addPageTemplates(p)
self._calc()
self.afterInit()
def _calc(self):
self._rightMargin = self.pagesize[0] - self.rightMargin
self._topMargin = self.pagesize[1] - self.topMargin
self.width = self._rightMargin - self.leftMargin
self.height = self._topMargin - self.bottomMargin
def clean_hanging(self):
'handle internal postponed actions'
while len(self._hanging):
self.handle_flowable(self._hanging)
def addPageTemplates(self,pageTemplates):
'add one or a sequence of pageTemplates'
if type(pageTemplates) not in (ListType,TupleType):
pageTemplates = [pageTemplates]
assert filter(lambda x: not isinstance(x,PageTemplate), pageTemplates)==[], "pageTemplates argument error"
for t in pageTemplates:
self.pageTemplates.append(t)
def handle_documentBegin(self):
'''implement actions at beginning of document'''
self._hanging = [PageBegin]
self.pageTemplate = self.pageTemplates[0]
self.page = 0
self.beforeDocument()
def handle_pageBegin(self):
'''Perform actions required at beginning of page.
shouldn't normally be called directly'''
self.page = self.page + 1
self.pageTemplate.beforeDrawPage(self.canv,self)
self.pageTemplate.onPage(self.canv,self)
self.beforePage()
if hasattr(self,'_nextFrameIndex'):
del self._nextFrameIndex
self.frame = self.pageTemplate.frames[0]
self.handle_frameBegin()
def handle_pageEnd(self):
''' show the current page
check the next page template
hang a page begin
'''
self.pageTemplate.afterDrawPage(self.canv, self)
self.pageTemplate.onPageEnd(self.canv, self)
self.afterPage()
self.canv.showPage()
if hasattr(self,'_nextPageTemplateIndex'):
self.pageTemplate = self.pageTemplates[self._nextPageTemplateIndex]
del self._nextPageTemplateIndex
self._hanging.append(PageBegin)
def handle_pageBreak(self):
'''some might choose not to end all the frames'''
if self._pageBreakQuick:
self.handle_pageEnd()
else:
n = len(self._hanging)
while len(self._hanging)==n:
self.handle_frameEnd()
def handle_frameBegin(self,*args):
'''What to do at the beginning of a page'''
self.frame._reset()
if self.showBoundary or self.frame.showBoundary:
self.frame.drawBoundary(self.canv)
def handle_frameEnd(self):
''' Handles the semantics of the end of a frame. This includes the selection of
the next frame or if this is the last frame then invoke pageEnd.
'''
if hasattr(self,'_nextFrameIndex'):
frame = self.pageTemplate.frames[self._nextFrameIndex]
del self._nextFrameIndex
self.handle_frameBegin()
elif hasattr(self.frame,'lastFrame') or self.frame is self.pageTemplate.frames[-1]:
self.handle_pageEnd()
self.frame = None
else:
f = self.frame
self.frame = self.pageTemplate.frames[self.pageTemplate.frames.index(f) + 1]
self.handle_frameBegin()
def handle_nextPageTemplate(self,pt):
'''On endPage chenge to the page template with name or index pt'''
if type(pt) is StringType:
for t in self.pageTemplates:
if t.id == pt:
self._nextPageTemplateIndex = self.pageTemplates.index(t)
return
raise ValueError, "can't find template('%s')"%pt
elif type(pt) is IntType:
self._nextPageTemplateIndex = pt
else:
raise TypeError, "argument pt should be string or integer"
def handle_nextFrame(self,fx):
'''On endFrame chenge to the frame with name or index fx'''
if type(fx) is StringType:
for f in self.pageTemplate.frames:
if f.id == fx:
self._nextFrameIndex = self.pageTemplate.frames.index(f)
return
raise ValueError, "can't find frame('%s')"%fx
elif type(fx) is IntType:
self._nextFrameIndex = fx
else:
raise TypeError, "argument fx should be string or integer"
def handle_currentFrame(self,fx):
'''chenge to the frame with name or index fx'''
if type(fx) is StringType:
for f in self.pageTemplate.frames:
if f.id == fx:
self._nextFrameIndex = self.pageTemplate.frames.index(f)
return
raise ValueError, "can't find frame('%s')"%fx
elif type(fx) is IntType:
self._nextFrameIndex = fx
else:
raise TypeError, "argument fx should be string or integer"
def handle_flowable(self,flowables):
'''try to handle one flowable from the front of list flowables.'''
#allow document a chance to look at, modify or ignore
#the object(s) about to be processed
self.filterFlowables(flowables)
f = flowables[0]
del flowables[0]
if f is None:
return
if isinstance(f,PageBreak):
self.handle_pageBreak()
self.afterFlowable(f)
elif isinstance(f,ActionFlowable):
f.apply(self)
self.afterFlowable(f)
else:
#general case we have to do something
if self.frame.add(f, self.canv, trySplit=self.allowSplitting):
self.afterFlowable(f)
else:
if self.allowSplitting:
# see if this is a splittable thing
S = self.frame.split(f,self.canv)
n = len(S)
else:
n = 0
if n:
if self.frame.add(S[0], self.canv, trySplit=0):
self.afterFlowable(f)
else:
raise "LayoutError", "splitting error"
del S[0]
for f in xrange(n-1):
flowables.insert(f,S[f]) # put split flowables back on the list
else:
if hasattr(f,'postponed'):
raise "LayoutError", "Flowable too large"
f.postponed = 1
flowables.insert(0,f) # put the flowable back
self.handle_frameEnd()
#these are provided so that deriving classes can refer to them
_handle_documentBegin = handle_documentBegin
_handle_pageBegin = handle_pageBegin
_handle_pageEnd = handle_pageEnd
_handle_frameBegin = handle_frameBegin
_handle_frameEnd = handle_frameEnd
_handle_flowable = handle_flowable
_handle_nextPageTemplate = handle_nextPageTemplate
_handle_currentFrame = handle_currentFrame
_handle_nextFrame = handle_nextFrame
def _startBuild(self, filename=None, canvasmaker=canvas.Canvas):
self._calc()
self.canv = canvasmaker(filename or self.filename)
self.handle_documentBegin()
def _endBuild(self):
if self._hanging!=[] and self._hanging[-1] is PageBegin:
del self._hanging[-1]
self.clean_hanging()
else:
self.clean_hanging()
self.handle_pageBreak()
self.canv.save()
#AR - hack - for some reason a document did not
#have these:
#if hasattr(self, 'frame'): del self.frame
#if hasattr(self, 'pageTemplate'): del self.pageTemplate
del self.frame, self.pageTemplate
def build(self, flowables, filename=None, canvasmaker=canvas.Canvas):
"""Build the document from a list of flowables.
If the filename argument is provided then that filename is used
rather than the one provided upon initialization.
If the canvasmaker argument is provided then it will be used
instead of the default. For example a slideshow might use
an alternate canvas which places 6 slides on a page (by
doing translations, scalings and redefining the page break
operations).
"""
#assert filter(lambda x: not isinstance(x,Flowable), flowables)==[], "flowables argument error"
self._startBuild(filename,canvasmaker)
while len(flowables):
self.clean_hanging()
self.handle_flowable(flowables)
self._endBuild()
#these are pure virtuals override in derived classes
#NB these get called at suitable places by the base class
#so if you derive and override the handle_xxx methods
#it's up to you to ensure that they maintain the needed consistency
def afterInit(self):
"""This is called after initialisation of the base class."""
pass
def beforeDocument(self):
"""This is called before any processing is
done on the document."""
pass
def beforePage(self):
"""This is called at the beginning of page
processing, and immediately before the
beforeDrawPage method of the current page
template."""
pass
def afterPage(self):
"""This is called after page processing, and
immediately after the afterDrawPage method
of the current page template."""
pass
def filterFlowables(self,flowables):
'''called to filter flowables at the start of the main handle_flowable method.
Upon return if flowables[0] has been set to None it is discarded and the main
method returns.
'''
pass
def afterFlowable(self, flowable):
'''called after a flowable has been rendered'''
pass
class SimpleDocTemplate(BaseDocTemplate):
"""A special case document template that will handle many simple documents.
See documentation for BaseDocTemplate. No pageTemplates are required
for this special case. A page templates are inferred from the
margin information and the onFirstPage, onLaterPages arguments to the build method.
A document which has all pages with the same look except for the first
page may can be built using this special approach.
"""
_invalidInitArgs = ('pageTemplates',)
def handle_pageBegin(self):
'''override base method to add a change of page template after the firstpage.
'''
self._handle_pageBegin()
self._handle_nextPageTemplate('Later')
def build(self,flowables,onFirstPage=_doNothing, onLaterPages=_doNothing):
"""build the document using the flowables. Annotate the first page using the onFirstPage
function and later pages using the onLaterPages function. The onXXX pages should follow
the signature
def myOnFirstPage(canvas, document):
# do annotations and modify the document
...
The functions can do things like draw logos, page numbers,
footers, etcetera. They can use external variables to vary
the look (for example providing page numbering or section names).
"""
self._calc() #in case we changed margins sizes etc
frameT = Frame(self.leftMargin, self.bottomMargin, self.width, self.height, id='normal')
self.addPageTemplates([PageTemplate(id='First',frames=frameT, onPage=onFirstPage),
PageTemplate(id='Later',frames=frameT, onPage=onLaterPages)])
if onFirstPage is _doNothing and hasattr(self,'onFirstPage'):
self.pageTemplates[0].beforeDrawPage = self.onFirstPage
if onLaterPages is _doNothing and hasattr(self,'onLaterPages'):
self.pageTemplates[1].beforeDrawPage = self.onLaterPages
BaseDocTemplate.build(self,flowables)
if __name__ == '__main__':
##########################################################
##
## testing
##
##########################################################
def randomText():
#this may or may not be appropriate in your company
from random import randint, choice
RANDOMWORDS = ['strategic','direction','proactive',
'reengineering','forecast','resources',
'forward-thinking','profit','growth','doubletalk',
'venture capital','IPO']
sentences = 5
output = ""
for sentenceno in range(randint(1,5)):
output = output + 'Blah'
for wordno in range(randint(10,25)):
if randint(0,4)==0:
word = choice(RANDOMWORDS)
else:
word = 'blah'
output = output + ' ' +word
output = output+'.'
return output
def myFirstPage(canvas, doc):
canvas.saveState()
canvas.setStrokeColor(red)
canvas.setLineWidth(5)
canvas.line(66,72,66,PAGE_HEIGHT-72)
canvas.setFont('Times-Bold',24)
canvas.drawString(108, PAGE_HEIGHT-108, "PLATYPUS")
canvas.setFont('Times-Roman',12)
canvas.drawString(4 * inch, 0.75 * inch, "First Page")
canvas.restoreState()
def myLaterPages(canvas, doc):
canvas.saveState()
canvas.setStrokeColor(red)
canvas.setLineWidth(5)
canvas.line(66,72,66,PAGE_HEIGHT-72)
canvas.setFont('Times-Roman',12)
canvas.drawString(4 * inch, 0.75 * inch, "Page %d" % doc.page)
canvas.restoreState()
def run():
objects_to_draw = []
from reportlab.lib.styles import ParagraphStyle
#from paragraph import Paragraph
from doctemplate import SimpleDocTemplate
#need a style
normal = ParagraphStyle('normal')
normal.firstLineIndent = 18
normal.spaceBefore = 6
import random
for i in range(15):
height = 0.5 + (2*random.random())
box = XBox(6 * inch, height * inch, 'Box Number %d' % i)
objects_to_draw.append(box)
para = Paragraph(randomText(), normal)
objects_to_draw.append(para)
SimpleDocTemplate('doctemplate.pdf').build(objects_to_draw,
onFirstPage=myFirstPage,onLaterPages=myLaterPages)
run()