Copyright	(c) 2006-2016, alpheccar.org
License	BSD-style
Maintainer	misc@NOSPAMalpheccar.org
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Graphics.PDF.Typesetting

Contents

Types
Functions
Settings (similar to TeX ones)
- Line breaking settings
- Vertical mode settings
Styles

Description

Experimental typesetting. It is a work in progress

Synopsis

Types

Boxes

class Box a where Source #

A box is an object with dimensions and used in the typesetting process

Minimal complete definition

boxWidth, boxHeight, boxDescent

Methods

boxWidth :: a -> PDFFloat Source #

Box width

boxHeight :: a -> PDFFloat Source #

Box height

boxDescent :: a -> PDFFloat Source #

Distance between box bottom and box baseline

boxAscent :: a -> PDFFloat Source #

Distance between box top and box baseline

Instances

Box BoxDimension Source #
Methods boxWidth :: BoxDimension -> PDFFloat Source # boxHeight :: BoxDimension -> PDFFloat Source # boxDescent :: BoxDimension -> PDFFloat Source # boxAscent :: BoxDimension -> PDFFloat Source #
Box (VBox ps s) Source #
Methods boxWidth :: VBox ps s -> PDFFloat Source # boxHeight :: VBox ps s -> PDFFloat Source # boxDescent :: VBox ps s -> PDFFloat Source # boxAscent :: VBox ps s -> PDFFloat Source #

class DisplayableBox a where Source #

A box that can be displayed

Minimal complete definition

strokeBox

Methods

strokeBox :: a -> PDFFloat -> PDFFloat -> Draw () Source #

Draw a box

Instances

ParagraphStyle ps s => DisplayableBox (VBox ps s) Source #
Methods strokeBox :: VBox ps s -> PDFFloat -> PDFFloat -> Draw () Source #

data Letter s Source #

A letter which can be anything. Sizes are widths and for glue the dilation and compression factors For the generic letter, height and descent are also provided

Constructors

Letter BoxDimension !AnyBox !(Maybe s)	Any box as a letter
Glue !PDFFloat !PDFFloat !PDFFloat !(Maybe s)	A glue with style to know if it is part of the same sentence
FlaggedPenalty !PDFFloat !Int !s	Hyphen point
Penalty !Int	Penalty
AChar !s !Char !PDFFloat	A char
Kern !PDFFloat !(Maybe s)	A kern : non dilatable and non breakable glue

Instances

Show (Letter s) Source #
Methods showsPrec :: Int -> Letter s -> ShowS # show :: Letter s -> String # showList :: [Letter s] -> ShowS #
MonadWriter [Letter s] (Para s) #
Methods writer :: (a, [Letter s]) -> Para s a # tell :: [Letter s] -> Para s () # listen :: Para s a -> Para s (a, [Letter s]) # pass :: Para s (a, [Letter s] -> [Letter s]) -> Para s a #

type BoxDimension = (PDFFloat, PDFFloat, PDFFloat) Source #

Dimension of a box : width, height and descent

Styles

class ComparableStyle a => Style a where Source #

Style of text (sentences and words). Minimum definition textStyle

Minimal complete definition

textStyle

Methods

sentenceStyle :: a -> Maybe (Rectangle -> Draw b -> Draw ()) Source #

Modify the look of a sentence (sequence of words using the same style on a line)

wordStyle :: a -> Maybe (Rectangle -> StyleFunction -> Draw b -> Draw ()) Source #

textStyle :: a -> TextStyle Source #

updateStyle :: a -> a Source #

A style may contain data changed from word to word

styleHeight :: a -> PDFFloat Source #

A style may change the height of words

Default implementation
styleHeight = getHeight . textFont . textStyle

styleDescent :: a -> PDFFloat Source #

A style may change the descent of lines

Default implementation
styleDescent = getDescent . textFont . textStyle

Instances

Style StandardStyle Source #
Methods sentenceStyle :: StandardStyle -> Maybe (Rectangle -> Draw b -> Draw ()) Source # wordStyle :: StandardStyle -> Maybe (Rectangle -> StyleFunction -> Draw b -> Draw ()) Source # textStyle :: StandardStyle -> TextStyle Source # updateStyle :: StandardStyle -> StandardStyle Source # styleHeight :: StandardStyle -> PDFFloat Source # styleDescent :: StandardStyle -> PDFFloat Source #

data TextStyle Source #

Text style used by PDF operators

Constructors

TextStyle
Fields textFont :: !PDFFont textStrokeColor :: !Color textFillColor :: !Color textMode :: !TextMode penWidth :: !PDFFloat scaleSpace :: !PDFFloat Scaling factor for normal space size (scale also the dilation and compression factors) scaleDilatation :: !PDFFloat Scale the dilation factor of glues scaleCompression :: !PDFFloat Scale the compression factor of glues

Instances

Eq TextStyle Source #
Methods (==) :: TextStyle -> TextStyle -> Bool # (/=) :: TextStyle -> TextStyle -> Bool #

data StyleFunction Source #

What kind of style drawing function is required for a word when word styling is enabled

Constructors

DrawWord	Must style a word
DrawGlue	Must style a glue

Instances

Eq StyleFunction Source #
Methods (==) :: StyleFunction -> StyleFunction -> Bool # (/=) :: StyleFunction -> StyleFunction -> Bool #

class (ComparableStyle a, Style s) => ParagraphStyle a s | a -> s where Source #

Paragraph style

Methods

lineWidth :: a -> PDFFloat -> Int -> PDFFloat Source #

Width of the line of the paragraph

linePosition :: a -> PDFFloat -> Int -> PDFFloat Source #

Horizontal shift of the line position relatively to the left egde of the paragraph bounding box

interline :: a -> Maybe (Rectangle -> Draw ()) Source #

How to style the interline glues added in a paragraph by the line breaking algorithm

paragraphChange :: a -> Int -> [Letter s] -> (a, [Letter s]) Source #

Change the content of a paragraph before the line breaking algorithm is run. It may also change the style

paragraphStyle :: a -> Maybe (Rectangle -> Draw b -> Draw ()) Source #

Get the paragraph bounding box and the paragraph draw command to apply additional effects

Instances

ParagraphStyle StandardParagraphStyle StandardStyle Source #

class (Style s, Monad m) => MonadStyle s m | m -> s where Source #

A MonadStyle where some typesetting operators can be used

Minimal complete definition

setStyle, currentStyle, addBox, glue, unstyledGlue

Methods

setStyle :: s -> m () Source #

Set the current text style

currentStyle :: m s Source #

Get the current text style

addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> m () Source #

Add a box using the current mode (horizontal or vertical. The current style is always applied to the added box)

glue :: PDFFloat -> PDFFloat -> PDFFloat -> m () Source #

Add a glue using the current style

unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> m () Source #

Add a glue with no style (it is just a translation)

Instances

Style s => MonadStyle s (Para s) Source #
Methods setStyle :: s -> Para s () Source # currentStyle :: Para s s Source # addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> Para s () Source # glue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s () Source # unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s () Source #
Style s => MonadStyle s (TM ps s) Source #
Methods setStyle :: s -> TM ps s () Source # currentStyle :: TM ps s s Source # addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source # glue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source # unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source #

class ComparableStyle a where Source #

Used to compare two style without taking into account the style state

Minimal complete definition

isSameStyleAs

Methods

isSameStyleAs :: a -> a -> Bool Source #

Instances

ComparableStyle StandardParagraphStyle Source #
Methods isSameStyleAs :: StandardParagraphStyle -> StandardParagraphStyle -> Bool Source #
ComparableStyle StandardStyle Source #
Methods isSameStyleAs :: StandardStyle -> StandardStyle -> Bool Source #

Typesetting monads

data Para s a Source #

Instances

MonadState s (Para s) Source #
Methods get :: Para s s # put :: s -> Para s () # state :: (s -> (a, s)) -> Para s a #
Style s => MonadStyle s (Para s) Source #
Methods setStyle :: s -> Para s () Source # currentStyle :: Para s s Source # addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> Para s () Source # glue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s () Source # unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s () Source #
Monad (Para s) Source #
Methods (>>=) :: Para s a -> (a -> Para s b) -> Para s b # (>>) :: Para s a -> Para s b -> Para s b # return :: a -> Para s a # fail :: String -> Para s a #
Functor (Para s) Source #
Methods fmap :: (a -> b) -> Para s a -> Para s b # (<$) :: a -> Para s b -> Para s a #
Applicative (Para s) Source #
Methods pure :: a -> Para s a # (<>) :: Para s (a -> b) -> Para s a -> Para s b # (>) :: Para s a -> Para s b -> Para s b # (<*) :: Para s a -> Para s b -> Para s a #
MonadWriter [Letter s] (Para s) Source #
Methods writer :: (a, [Letter s]) -> Para s a # tell :: [Letter s] -> Para s () # listen :: Para s a -> Para s (a, [Letter s]) # pass :: Para s (a, [Letter s] -> [Letter s]) -> Para s a #

data TM ps s a Source #

Instances

Style s => MonadStyle s (TM ps s) Source #
Methods setStyle :: s -> TM ps s () Source # currentStyle :: TM ps s s Source # addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source # glue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source # unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source #
MonadWriter [VBox ps s] (TM ps s) Source #
Methods writer :: (a, [VBox ps s]) -> TM ps s a # tell :: [VBox ps s] -> TM ps s () # listen :: TM ps s a -> TM ps s (a, [VBox ps s]) # pass :: TM ps s (a, [VBox ps s] -> [VBox ps s]) -> TM ps s a #
Monad (TM ps s) Source #
Methods (>>=) :: TM ps s a -> (a -> TM ps s b) -> TM ps s b # (>>) :: TM ps s a -> TM ps s b -> TM ps s b # return :: a -> TM ps s a # fail :: String -> TM ps s a #
Functor (TM ps s) Source #
Methods fmap :: (a -> b) -> TM ps s a -> TM ps s b # (<$) :: a -> TM ps s b -> TM ps s a #
Applicative (TM ps s) Source #
Methods pure :: a -> TM ps s a # (<>) :: TM ps s (a -> b) -> TM ps s a -> TM ps s b # (>) :: TM ps s a -> TM ps s b -> TM ps s b # (<*) :: TM ps s a -> TM ps s b -> TM ps s a #

Containers

data VBox ps s Source #

Instances

MonadWriter [VBox ps s] (TM ps s) #
Methods writer :: (a, [VBox ps s]) -> TM ps s a # tell :: [VBox ps s] -> TM ps s () # listen :: TM ps s a -> TM ps s (a, [VBox ps s]) # pass :: TM ps s (a, [VBox ps s] -> [VBox ps s]) -> TM ps s a #
Show (VBox ps s) Source #
Methods showsPrec :: Int -> VBox ps s -> ShowS # show :: VBox ps s -> String # showList :: [VBox ps s] -> ShowS #
ParagraphStyle ps s => DisplayableBox (VBox ps s) Source #
Methods strokeBox :: VBox ps s -> PDFFloat -> PDFFloat -> Draw () Source #
Box (VBox ps s) Source #
Methods boxWidth :: VBox ps s -> PDFFloat Source # boxHeight :: VBox ps s -> PDFFloat Source # boxDescent :: VBox ps s -> PDFFloat Source # boxAscent :: VBox ps s -> PDFFloat Source #

data VerState s Source #

Constructors

VerState
Fields baselineskip :: !(PDFFloat, PDFFloat, PDFFloat) Default value (12,0.17,0.0) lineskip :: !(PDFFloat, PDFFloat, PDFFloat) Default value (3.0,0.33,0.0) lineskiplimit :: !PDFFloat Default value 2 currentParagraphStyle :: !s

data Container ps s Source #

Container for vboxes (x,y,width,maxheight,height,currenty,current z, tolerance para) tolerance para means a paragraph is not started if too close from the bottom edge of the box

data Justification Source #

Constructors

FullJustification
Centered
LeftJustification
RightJustification

Instances

Eq Justification Source #
Methods (==) :: Justification -> Justification -> Bool # (/=) :: Justification -> Justification -> Bool #

data Orientation Source #

Constructors

E
W
N
S
NE
NW
SE
SW

Instances

Eq Orientation Source #
Methods (==) :: Orientation -> Orientation -> Bool # (/=) :: Orientation -> Orientation -> Bool #
Show Orientation Source #
Methods showsPrec :: Int -> Orientation -> ShowS # show :: Orientation -> String # showList :: [Orientation] -> ShowS #

Functions

Text display

displayFormattedText Source #

Arguments

:: ParagraphStyle ps s
=> Rectangle	Text area
-> ps	default vertical style
-> s	Default horizontal style
-> TM ps s a	Typesetting monad
-> Draw a	Draw monad

Display a formatted text in a given bounding rectangle with a given default paragraph style, a given default text style. No clipping is taking place. Drawing stop when the last line is crossing the bounding rectangle in vertical direction

Text construction operators

txt :: Style s => String -> Para s () Source #

Add a text line

kern :: Style s => PDFFloat -> Para s () Source #

add a kern (space that can be dilated or compressed and on which no line breaking can occur)

addPenalty :: Int -> Para s () Source #

Add a penalty

mkLetter Source #

Arguments

:: (Show a, Box a, DisplayableBox a)
=> BoxDimension	Dimension of the box
-> Maybe s	Text style of the box (can use t)
-> a	Box
-> Letter s

Make a letter from any box

mkDrawBox :: Draw () -> DrawBox Source #

Make a drawing box. A box object containing a Draw value

Paragraph construction operators

forceNewLine :: Style s => Para s () Source #

For a newline and end the current paragraph

paragraph :: Style s => Para s a -> TM ps s a Source #

Add a new paragraph to the text

endPara :: Style s => Para s () Source #

startPara :: Style s => Para s () Source #

Functions useful to change the paragraph style

getParaStyle :: TM ps s ps Source #

Get the current paragraph style

setParaStyle :: ParagraphStyle ps s => ps -> TM ps s () Source #

Change the current paragraph style

Container

mkContainer Source #

Arguments

:: PDFFloat	x
-> PDFFloat	y
-> PDFFloat	width
-> PDFFloat	height
-> PDFFloat	Pargraph tolerance
-> Container ps s	New container

Create a empty container to constraint the amount of line that can be displayed

fillContainer Source #

Arguments

:: (ParagraphStyle ps s, ComparableStyle ps)
=> VerState ps	Vertical style for interline glues
-> Container ps s	Container
-> [VBox ps s]	VBox to add
-> (Draw (), Container ps s, [VBox ps s])	Component to draw, new container and remaining VBoxes due to overfull container

Fill a container with lines

defaultVerState :: s -> VerState s Source #

Default vertical state

Default values
baselineskip = (12,0.17,0.0)
lineskip = (3.0,0.33,0.0)
lineskiplimit = 2

getBoxes Source #

Arguments

:: ParagraphStyle ps s
=> ps	default vertical style
-> s	Default horizontal style
-> TM ps s a	Typesetting monad
-> [VBox ps s]	List of boxes

Return the list of Vboxes for a text

containerX :: Container ps s -> PDFFloat Source #

Container horizontal position

containerY :: Container ps s -> PDFFloat Source #

Container vertical position

containerWidth :: Container ps s -> PDFFloat Source #

Get the width of the container

containerHeight :: Container ps s -> PDFFloat Source #

Get the height of the container

containerContentHeight :: Container ps s -> PDFFloat Source #

Get the content height of the container with glue dilatation

containerContentRightBorder :: Container ps s -> PDFFloat Source #

Get the maximum right border of the container content (maybe bigger than container width due to overfull lines)

containerContentLeftBorder :: Container ps s -> PDFFloat Source #

Get the minimum left border of the container content

containerCurrentHeight :: Container ps s -> PDFFloat Source #

Get the current height of the container without glue dilatation

containerContentRectangle :: Container ps s -> Rectangle Source #

Return the rectangle containing the text after formatting and glue dilatation

drawTextBox Source #

Arguments

:: (ParagraphStyle ps s, Style s)
=> PDFFloat	x
-> PDFFloat	y
-> PDFFloat	width limit
-> PDFFloat	height limit
-> Orientation
-> ps	default vertical style
-> s	Default horizontal style
-> TM ps s a	Typesetting monad
-> (Rectangle, Draw ())

Draw a text box with relative position. Useful for labels

Settings (similar to TeX ones)

Line breaking settings

setFirstPassTolerance :: PDFFloat -> TM ps s () Source #

setSecondPassTolerance :: PDFFloat -> TM ps s () Source #

setHyphenPenaltyValue :: Int -> TM ps s () Source #

setFitnessDemerit :: PDFFloat -> TM ps s () Source #

setHyphenDemerit :: PDFFloat -> TM ps s () Source #

setLinePenalty :: PDFFloat -> TM ps s () Source #

getFirstPassTolerance :: TM ps s PDFFloat Source #

getSecondPassTolerance :: TM ps s PDFFloat Source #

getHyphenPenaltyValue :: TM ps s Int Source #

getFitnessDemerit :: TM ps s PDFFloat Source #

getHyphenDemerit :: TM ps s PDFFloat Source #

getLinePenalty :: TM ps s PDFFloat Source #

setJustification Source #

Arguments

:: Justification	Centered, left or fully justified
-> TM ps s ()

Vertical mode settings

setBaseLineSkip :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source #

setLineSkipLimit :: PDFFloat -> TM ps s () Source #

setLineSkip :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s () Source #

getBaseLineSkip :: TM ps s (PDFFloat, PDFFloat, PDFFloat) Source #

getLineSkipLimit :: TM ps s PDFFloat Source #

getLineSkip :: TM ps s (PDFFloat, PDFFloat, PDFFloat) Source #

Styles

data StandardStyle Source #

Standard styles for sentences

Constructors

Font PDFFont Color Color

Instances

Style StandardStyle Source #
Methods sentenceStyle :: StandardStyle -> Maybe (Rectangle -> Draw b -> Draw ()) Source # wordStyle :: StandardStyle -> Maybe (Rectangle -> StyleFunction -> Draw b -> Draw ()) Source # textStyle :: StandardStyle -> TextStyle Source # updateStyle :: StandardStyle -> StandardStyle Source # styleHeight :: StandardStyle -> PDFFloat Source # styleDescent :: StandardStyle -> PDFFloat Source #
ComparableStyle StandardStyle Source #
Methods isSameStyleAs :: StandardStyle -> StandardStyle -> Bool Source #
ParagraphStyle StandardParagraphStyle StandardStyle Source #
Methods lineWidth :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat Source # linePosition :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat Source # interline :: StandardParagraphStyle -> Maybe (Rectangle -> Draw ()) Source # paragraphChange :: StandardParagraphStyle -> Int -> [Letter StandardStyle] -> (StandardParagraphStyle, [Letter StandardStyle]) Source # paragraphStyle :: StandardParagraphStyle -> Maybe (Rectangle -> Draw b -> Draw ()) Source #

data StandardParagraphStyle Source #

Standard styles for paragraphs

Constructors

NormalParagraph

Instances

ComparableStyle StandardParagraphStyle Source #
Methods isSameStyleAs :: StandardParagraphStyle -> StandardParagraphStyle -> Bool Source #
ParagraphStyle StandardParagraphStyle StandardStyle Source #
Methods lineWidth :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat Source # linePosition :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat Source # interline :: StandardParagraphStyle -> Maybe (Rectangle -> Draw ()) Source # paragraphChange :: StandardParagraphStyle -> Int -> [Letter StandardStyle] -> (StandardParagraphStyle, [Letter StandardStyle]) Source # paragraphStyle :: StandardParagraphStyle -> Maybe (Rectangle -> Draw b -> Draw ()) Source #