Graphics.PDF.Typesetting

Experimental typesetting. It is a work in progress

Types

Boxes

class Box a where

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

Minimal complete definition

boxWidth, boxHeight, boxDescent

Methods

boxWidth :: a -> PDFFloat

Box width

boxHeight :: a -> PDFFloat

Box height

boxDescent :: a -> PDFFloat

Distance between box bottom and box baseline

boxAscent :: a -> PDFFloat

Distance between box top and box baseline

Instances

Box BoxDimension

Methods

boxWidth :: BoxDimension -> PDFFloat

boxHeight :: BoxDimension -> PDFFloat

boxDescent :: BoxDimension -> PDFFloat

boxAscent :: BoxDimension -> PDFFloat

Box (VBox ps s)

Methods

boxWidth :: VBox ps s -> PDFFloat

boxHeight :: VBox ps s -> PDFFloat

boxDescent :: VBox ps s -> PDFFloat

boxAscent :: VBox ps s -> PDFFloat

class DisplayableBox a where

A box that can be displayed

Minimal complete definition

strokeBox

Methods

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

Draw a box

Instances

ParagraphStyle ps s => DisplayableBox (VBox ps s)

Methods

strokeBox :: VBox ps s -> PDFFloat -> PDFFloat -> Draw ()

data Letter s

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)

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)

Dimension of a box : width, height and descent

Styles

class ComparableStyle a => Style a where

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

Minimal complete definition

textStyle

Methods

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

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

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

textStyle :: a -> TextStyle

updateStyle :: a -> a

A style may contain data changed from word to word

styleHeight :: a -> PDFFloat

A style may change the height of words

Default implementation
styleHeight = getHeight . textFont . textStyle

styleDescent :: a -> PDFFloat

A style may change the descent of lines

Default implementation
styleDescent = getDescent . textFont . textStyle

Instances

Style StandardStyle

Methods

sentenceStyle :: StandardStyle -> Maybe (Rectangle -> Draw b -> Draw ())

wordStyle :: StandardStyle -> Maybe (Rectangle -> StyleFunction -> Draw b -> Draw ())

textStyle :: StandardStyle -> TextStyle

updateStyle :: StandardStyle -> StandardStyle

styleHeight :: StandardStyle -> PDFFloat

styleDescent :: StandardStyle -> PDFFloat

data TextStyle

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

Methods

(==) :: TextStyle -> TextStyle -> Bool

(/=) :: TextStyle -> TextStyle -> Bool

data StyleFunction

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

Methods

(==) :: StyleFunction -> StyleFunction -> Bool

(/=) :: StyleFunction -> StyleFunction -> Bool

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

Paragraph style

Methods

lineWidth :: a -> PDFFloat -> Int -> PDFFloat

Width of the line of the paragraph

linePosition :: a -> PDFFloat -> Int -> PDFFloat

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

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

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

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

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 ())

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

Instances

ParagraphStyle StandardParagraphStyle StandardStyle

Methods

lineWidth :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat

linePosition :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat

interline :: StandardParagraphStyle -> Maybe (Rectangle -> Draw ())

paragraphChange :: StandardParagraphStyle -> Int -> [Letter StandardStyle] -> (StandardParagraphStyle, [Letter StandardStyle])

paragraphStyle :: StandardParagraphStyle -> Maybe (Rectangle -> Draw b -> Draw ())

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

A MonadStyle where some typesetting operators can be used

Minimal complete definition

setStyle, currentStyle, addBox, glue, unstyledGlue

Methods

setStyle :: s -> m ()

Set the current text style

currentStyle :: m s

Get the current text style

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

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 ()

Add a glue using the current style

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

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

Instances

Style s => MonadStyle s (Para s)

Methods

setStyle :: s -> Para s ()

currentStyle :: Para s s

addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> Para s ()

glue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s ()

unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s ()

Style s => MonadStyle s (TM ps s)

Methods

setStyle :: s -> TM ps s ()

currentStyle :: TM ps s s

addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> TM ps s ()

glue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s ()

unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s ()

class ComparableStyle a where

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

Minimal complete definition

isSameStyleAs

Methods

isSameStyleAs :: a -> a -> Bool

Instances

ComparableStyle StandardParagraphStyle

Methods

isSameStyleAs :: StandardParagraphStyle -> StandardParagraphStyle -> Bool

ComparableStyle StandardStyle

Methods

isSameStyleAs :: StandardStyle -> StandardStyle -> Bool

Typesetting monads

data Para s a

Instances

MonadState s (Para s)

Methods

get :: Para s s

put :: s -> Para s ()

state :: (s -> (a, s)) -> Para s a

Style s => MonadStyle s (Para s)

Methods

setStyle :: s -> Para s ()

currentStyle :: Para s s

addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> Para s ()

glue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s ()

unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> Para s ()

Monad (Para s)

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)

Methods

fmap :: (a -> b) -> Para s a -> Para s b

(<$) :: a -> Para s b -> Para s a

Applicative (Para s)

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)

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

Instances

Style s => MonadStyle s (TM ps s)

Methods

setStyle :: s -> TM ps s ()

currentStyle :: TM ps s s

addBox :: (Show a, DisplayableBox a, Box a) => a -> PDFFloat -> PDFFloat -> PDFFloat -> TM ps s ()

glue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s ()

unstyledGlue :: PDFFloat -> PDFFloat -> PDFFloat -> TM ps s ()

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

Monad (TM ps s)

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)

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)

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

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)

Methods

showsPrec :: Int -> VBox ps s -> ShowS

show :: VBox ps s -> String

showList :: [VBox ps s] -> ShowS

ParagraphStyle ps s => DisplayableBox (VBox ps s)

Methods

strokeBox :: VBox ps s -> PDFFloat -> PDFFloat -> Draw ()

Box (VBox ps s)

Methods

boxWidth :: VBox ps s -> PDFFloat

boxHeight :: VBox ps s -> PDFFloat

boxDescent :: VBox ps s -> PDFFloat

boxAscent :: VBox ps s -> PDFFloat

data VerState s

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

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

Constructors

FullJustification

Centered

LeftJustification

RightJustification

Instances

Eq Justification

Methods

(==) :: Justification -> Justification -> Bool

(/=) :: Justification -> Justification -> Bool

data Orientation

Constructors

E

W

N

S

NE

NW

SE

SW

Instances

Eq Orientation

Methods

(==) :: Orientation -> Orientation -> Bool

(/=) :: Orientation -> Orientation -> Bool

Show Orientation

Methods

showsPrec :: Int -> Orientation -> ShowS

show :: Orientation -> String

showList :: [Orientation] -> ShowS

Functions

Text display

displayFormattedText

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 ()

Add a text line

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

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

addPenalty :: Int -> Para s ()

Add a penalty

mkLetter

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

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

Paragraph construction operators

forceNewLine :: Style s => Para s ()

For a newline and end the current paragraph

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

Add a new paragraph to the text

endPara :: Style s => Para s ()

startPara :: Style s => Para s ()

Functions useful to change the paragraph style

getParaStyle :: TM ps s ps

Get the current paragraph style

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

Change the current paragraph style

Container

mkContainer

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

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

Default vertical state

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

getBoxes

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

Container horizontal position

containerY :: Container ps s -> PDFFloat

Container vertical position

containerWidth :: Container ps s -> PDFFloat

Get the width of the container

containerHeight :: Container ps s -> PDFFloat

Get the height of the container

containerContentHeight :: Container ps s -> PDFFloat

Get the content height of the container with glue dilatation

containerContentRightBorder :: Container ps s -> PDFFloat

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

containerContentLeftBorder :: Container ps s -> PDFFloat

Get the minimum left border of the container content

containerCurrentHeight :: Container ps s -> PDFFloat

Get the current height of the container without glue dilatation

containerContentRectangle :: Container ps s -> Rectangle

Return the rectangle containing the text after formatting and glue dilatation

drawTextBox

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 ()

setSecondPassTolerance :: PDFFloat -> TM ps s ()

setHyphenPenaltyValue :: Int -> TM ps s ()

setFitnessDemerit :: PDFFloat -> TM ps s ()

setHyphenDemerit :: PDFFloat -> TM ps s ()

setLinePenalty :: PDFFloat -> TM ps s ()

getFirstPassTolerance :: TM ps s PDFFloat

getSecondPassTolerance :: TM ps s PDFFloat

getHyphenPenaltyValue :: TM ps s Int

getFitnessDemerit :: TM ps s PDFFloat

getHyphenDemerit :: TM ps s PDFFloat

getLinePenalty :: TM ps s PDFFloat

setJustification

Arguments

:: Justification

Centered, left or fully justified

-> TM ps s ()

Vertical mode settings

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

setLineSkipLimit :: PDFFloat -> TM ps s ()

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

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

getLineSkipLimit :: TM ps s PDFFloat

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

Styles

data StandardStyle

Standard styles for sentences

Constructors

Font PDFFont Color Color

Instances

Style StandardStyle

Methods

sentenceStyle :: StandardStyle -> Maybe (Rectangle -> Draw b -> Draw ())

wordStyle :: StandardStyle -> Maybe (Rectangle -> StyleFunction -> Draw b -> Draw ())

textStyle :: StandardStyle -> TextStyle

updateStyle :: StandardStyle -> StandardStyle

styleHeight :: StandardStyle -> PDFFloat

styleDescent :: StandardStyle -> PDFFloat

ComparableStyle StandardStyle

Methods

isSameStyleAs :: StandardStyle -> StandardStyle -> Bool

ParagraphStyle StandardParagraphStyle StandardStyle

Methods

lineWidth :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat

linePosition :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat

interline :: StandardParagraphStyle -> Maybe (Rectangle -> Draw ())

paragraphChange :: StandardParagraphStyle -> Int -> [Letter StandardStyle] -> (StandardParagraphStyle, [Letter StandardStyle])

paragraphStyle :: StandardParagraphStyle -> Maybe (Rectangle -> Draw b -> Draw ())

data StandardParagraphStyle

Standard styles for paragraphs

Constructors

NormalParagraph

Instances

ComparableStyle StandardParagraphStyle

Methods

isSameStyleAs :: StandardParagraphStyle -> StandardParagraphStyle -> Bool

ParagraphStyle StandardParagraphStyle StandardStyle

Methods

lineWidth :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat

linePosition :: StandardParagraphStyle -> PDFFloat -> Int -> PDFFloat

interline :: StandardParagraphStyle -> Maybe (Rectangle -> Draw ())

paragraphChange :: StandardParagraphStyle -> Int -> [Letter StandardStyle] -> (StandardParagraphStyle, [Letter StandardStyle])

paragraphStyle :: StandardParagraphStyle -> Maybe (Rectangle -> Draw b -> Draw ())