| Copyright | (c) Brent Yorgey 2009 |
|---|---|
| License | BSD-style (see LICENSE) |
| Maintainer | byorgey@cis.upenn.edu |
| Stability | experimental |
| Portability | portable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell98 |
Text.PrettyPrint.Boxes
Description
A pretty-printing library for laying out text in two dimensions, using a simple box model.
- data Box
- nullBox :: Box
- emptyBox :: Int -> Int -> Box
- char :: Char -> Box
- text :: String -> Box
- para :: Alignment -> Int -> String -> Box
- columns :: Alignment -> Int -> Int -> String -> [Box]
- (<>) :: Box -> Box -> Box
- (<+>) :: Box -> Box -> Box
- hcat :: Alignment -> [Box] -> Box
- hsep :: Int -> Alignment -> [Box] -> Box
- (//) :: Box -> Box -> Box
- (/+/) :: Box -> Box -> Box
- vcat :: Alignment -> [Box] -> Box
- vsep :: Int -> Alignment -> [Box] -> Box
- punctuateH :: Alignment -> Box -> [Box] -> Box
- punctuateV :: Alignment -> Box -> [Box] -> Box
- data Alignment
- left :: Alignment
- right :: Alignment
- top :: Alignment
- bottom :: Alignment
- center1 :: Alignment
- center2 :: Alignment
- moveLeft :: Int -> Box -> Box
- moveRight :: Int -> Box -> Box
- moveUp :: Int -> Box -> Box
- moveDown :: Int -> Box -> Box
- alignHoriz :: Alignment -> Int -> Box -> Box
- alignVert :: Alignment -> Int -> Box -> Box
- align :: Alignment -> Alignment -> Int -> Int -> Box -> Box
- rows :: Box -> Int
- cols :: Box -> Int
- render :: Box -> String
- printBox :: Box -> IO ()
Constructing boxes
The basic data type. A box has a specified size and some sort of contents.
emptyBox :: Int -> Int -> Box Source
emptyBox r c is an empty box with r rows and c columns.
Useful for effecting more fine-grained positioning of other
boxes, by inserting empty boxes of the desired size in between
them.
para :: Alignment -> Int -> String -> Box Source
para algn w t is a box of width w, containing text t,
aligned according to algn, flowed to fit within the given
width.
columns :: Alignment -> Int -> Int -> String -> [Box] Source
columns w h t is a list of boxes, each of width w and height
at most h, containing text t flowed into as many columns as
necessary.
Layout of boxes
(<>) :: Box -> Box -> Box Source
Paste two boxes together horizontally, using a default (top) alignment.
(<+>) :: Box -> Box -> Box Source
Paste two boxes together horizontally with a single intervening column of space, using a default (top) alignment.
hcat :: Alignment -> [Box] -> Box Source
Glue a list of boxes together horizontally, with the given alignment.
hsep :: Int -> Alignment -> [Box] -> Box Source
hsep sep a bs lays out bs horizontally with alignment a,
with sep amount of space in between each.
(//) :: Box -> Box -> Box Source
Paste two boxes together vertically, using a default (left) alignment.
(/+/) :: Box -> Box -> Box Source
Paste two boxes together vertically with a single intervening row of space, using a default (left) alignment.
vcat :: Alignment -> [Box] -> Box Source
Glue a list of boxes together vertically, with the given alignment.
vsep :: Int -> Alignment -> [Box] -> Box Source
vsep sep a bs lays out bs vertically with alignment a,
with sep amount of space in between each.
punctuateH :: Alignment -> Box -> [Box] -> Box Source
punctuateH a p bs horizontally lays out the boxes bs with a
copy of p interspersed between each.
punctuateV :: Alignment -> Box -> [Box] -> Box Source
A vertical version of punctuateH.
Alignment
Data type for specifying the alignment of boxes.
Align boxes centered, but biased to the left/top in case of unequal parities.
Align boxes centered, but biased to the right/bottom in case of unequal parities.
moveLeft :: Int -> Box -> Box Source
Move a box left by putting it in a larger box with extra columns, aligned left. Note that the name of this function is something of a white lie, as this will only result in the box being moved left by the specified amount if it is already in a larger right-aligned context.
moveRight :: Int -> Box -> Box Source
Move a box right by putting it in a larger box with extra
columns, aligned right. See the disclaimer for moveLeft.
moveUp :: Int -> Box -> Box Source
Move a box "up" by putting it in a larger box with extra rows,
aligned to the top. See the disclaimer for moveLeft.
moveDown :: Int -> Box -> Box Source
Move a box down by putting it in a larger box with extra rows,
aligned to the bottom. See the disclaimer for moveLeft.
alignHoriz :: Alignment -> Int -> Box -> Box Source
alignHoriz algn n bx creates a box of width n, with the
contents and height of bx, horizontally aligned according to
algn.
alignVert :: Alignment -> Int -> Box -> Box Source
alignVert algn n bx creates a box of height n, with the
contents and width of bx, vertically aligned according to
algn.
align :: Alignment -> Alignment -> Int -> Int -> Box -> Box Source
align ah av r c bx creates an r x c box with the contents
of bx, aligned horizontally according to ah and vertically
according to av.