| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Rainbox.Box
Contents
Description
Working with Box.
A Box is a rectangular block of text. You can paste Box
together to create new rectangles, and you can grow or reduce
existing Box to create new Boxes.
There are only six primitive functions that make a Box:
blank- formats a blank box with nothing but a (possibly) colorful background. Useful to paste to otherBoxto provide white space.chunks- Makes a box out of RainbowChunk.catH- pasteBoxtogether horizontallycatV- pasteBoxtogether verticallyviewH- view aBox, keeping the same height but possibly trimming the widthviewV- view aBox, keeping the same width but possibly trimming the height
The other functions use these building blocks to do other useful things.
There are many crude diagrams in the Haddock documentation. A
dash means a character with data; a period means a blank
character. When you print your Box, the blank characters will
have the appropriate background color.
- newtype Height = Height {}
- height :: Box -> Int
- newtype Width = Width {}
- class HasWidth a where
- data Align a
- data Vert
- data Horiz
- center :: Align a
- top :: Align Vert
- bottom :: Align Vert
- left :: Align Horiz
- right :: Align Horiz
- newtype Bar = Bar {}
- barToBox :: Bar -> Box
- barsToBox :: Radiant -> Align Horiz -> [Bar] -> Box
- data Box
- unBox :: Box -> BoxP
- blank :: Radiant -> Height -> Width -> Box
- blankH :: Radiant -> Int -> Box
- blankV :: Radiant -> Int -> Box
- chunks :: [Chunk] -> Box
- chunk :: Chunk -> Box
- catH :: Radiant -> Align Vert -> [Box] -> Box
- catV :: Radiant -> Align Horiz -> [Box] -> Box
- sepH :: Radiant -> Int -> Align Vert -> [Box] -> Box
- sepV :: Radiant -> Int -> Align Horiz -> [Box] -> Box
- punctuateH :: Radiant -> Align Vert -> Box -> [Box] -> Box
- punctuateV :: Radiant -> Align Horiz -> Box -> [Box] -> Box
- view :: Height -> Width -> Align Vert -> Align Horiz -> Box -> Box
- viewH :: Int -> Align Horiz -> Box -> Box
- viewV :: Int -> Align Vert -> Box -> Box
- grow :: Radiant -> Height -> Width -> Align Vert -> Align Horiz -> Box -> Box
- growH :: Radiant -> Int -> Align Horiz -> Box -> Box
- growV :: Radiant -> Int -> Align Vert -> Box -> Box
- column :: Radiant -> Align Horiz -> [Box] -> [Box]
- resize :: Radiant -> Height -> Width -> Align Vert -> Align Horiz -> Box -> Box
- resizeH :: Radiant -> Int -> Align Horiz -> Box -> Box
- resizeV :: Radiant -> Int -> Align Vert -> Box -> Box
- render :: Box -> [Chunk]
- printBox :: Box -> IO ()
Height and columns
A count of rows
A count of columns
Alignment
Box properties
Occupies a single row on screen. The Chunks you place in a
Bar should not have any control characters such as newlines or
tabs, as rainbox assumes that each character in a Bar takes up
one screen column and that each character does not create
newlines. Leave newline handling up to rainbox. However,
rainbox will not check to make sure that your inputs do not
contain newlines, tabs, or other spurious characters. Similarly, use of
combining characters will create unexpected results, as Rainbox
will see something that takes up (for instance) two characters
and think it takes up two screen columns, when in reality it will
take up only one screen column. So, if you need accented
characters, use a single Unicode code point, not two code points.
For example, for é, use U+00E9, not U+0065 and U+0301.
A Box has a width in columns and a height in rows. Its
height and width both are always at least zero. It can have
positive height even if its width is zero, and it can have
positive width even if its height is zero.
Each row in a Box always has the same number of characters; a
Box with zero height has no characters but still has a certain
width.
Making Boxes
A blank horizontal box with a given width and no height.
A blank vertical box with a given length.
Pasting Boxes together
Merge several Box horizontally into one Box. That is, with alignment set to ATop:
--- ------- ---- --- ------- ---
becomes
-------------- ----------.... ---...........
With alignment set to ABottom, becomes
---........... ----------.... --------------
sepH sep a bs lays out bs horizontally with alignment a,
with sep amount of space in between each.
sepV sep a bs lays out bs vertically with alignment a,
with sep amount of space in between each.
punctuateH a p bs horizontally lays out the boxes bs with a
copy of p interspersed between each.
A vertical version of punctuateH.
Viewing Boxes
viewV :: Int -> Align Vert -> Box -> Box Source
View a Box, possibly shrinking it. You set the size of your
viewport and how it is oriented relative to the Box as a whole.
The Box returned may be smaller than the argument Box, but it
will never be bigger.
Examples:
>>>:set -XOverloadedStrings>>>let box = catV defaultBackground top [ "ab", "cd" ]>>>printBox . view (Height 1) (Width 1) left top $ boxa
>>>printBox . view (Height 1) (Width 1) right bottom $ boxd
Growing Boxes
Grow a box. Each dimension of the result Box is never smaller
than the corresponding dimension of the input Box. Analogous to
view, so you give the resulting dimensions that you want. The
alignment is analogous to view; for instance, if you specify
that the alignment is top and left, the extra padding is
added to the right and bottom sides of the resulting Box.
Grow a Box horizontally.
Grow a Box vertically.
Resizing
Resize horizontally.
Resize vertically.