Safe Haskell	None
Language	Haskell2010

Rainbox.Core

Description

Contains the innards of Rainbox. You shouldn't need anything in here. Some functions here are partial or have undefined results if their inputs don't respect particular invariants.

Synopsis

Documentation

data Alignment a #

Alignment. Used in conjunction with Horizontal and Vertical, this determines how a payload aligns with the axis of a Box.

Constructors

Center
NonCenter a

Instances

Functor Alignment #
Methods fmap :: (a -> b) -> Alignment a -> Alignment b # (<$) :: a -> Alignment b -> Alignment a #
Foldable Alignment #
Methods fold :: Monoid m => Alignment m -> m # foldMap :: Monoid m => (a -> m) -> Alignment a -> m # foldr :: (a -> b -> b) -> b -> Alignment a -> b # foldr' :: (a -> b -> b) -> b -> Alignment a -> b # foldl :: (b -> a -> b) -> b -> Alignment a -> b # foldl' :: (b -> a -> b) -> b -> Alignment a -> b # foldr1 :: (a -> a -> a) -> Alignment a -> a # foldl1 :: (a -> a -> a) -> Alignment a -> a # toList :: Alignment a -> [a] # null :: Alignment a -> Bool # length :: Alignment a -> Int # elem :: Eq a => a -> Alignment a -> Bool # maximum :: Ord a => Alignment a -> a # minimum :: Ord a => Alignment a -> a # sum :: Num a => Alignment a -> a # product :: Num a => Alignment a -> a #
Traversable Alignment #
Methods traverse :: Applicative f => (a -> f b) -> Alignment a -> f (Alignment b) # sequenceA :: Applicative f => Alignment (f a) -> f (Alignment a) # mapM :: Monad m => (a -> m b) -> Alignment a -> m (Alignment b) # sequence :: Monad m => Alignment (m a) -> m (Alignment a) #
Eq a => Eq (Alignment a) #
Methods (==) :: Alignment a -> Alignment a -> Bool # (/=) :: Alignment a -> Alignment a -> Bool #
Ord a => Ord (Alignment a) #
Methods compare :: Alignment a -> Alignment a -> Ordering # (<) :: Alignment a -> Alignment a -> Bool # (<=) :: Alignment a -> Alignment a -> Bool # (>) :: Alignment a -> Alignment a -> Bool # (>=) :: Alignment a -> Alignment a -> Bool # max :: Alignment a -> Alignment a -> Alignment a # min :: Alignment a -> Alignment a -> Alignment a #
Show a => Show (Alignment a) #
Methods showsPrec :: Int -> Alignment a -> ShowS # show :: Alignment a -> String # showList :: [Alignment a] -> ShowS #
Monoid (Alignment a) #	`mempty` is `center`. `mappend` takes the rightmost non-`center` value.
Methods mempty :: Alignment a # mappend :: Alignment a -> Alignment a -> Alignment a # mconcat :: [Alignment a] -> Alignment a #

data Horizontal #

Determines how a payload aligns with a horizontal axis.

Constructors

Top
Bottom

Instances

Eq Horizontal #
Methods (==) :: Horizontal -> Horizontal -> Bool # (/=) :: Horizontal -> Horizontal -> Bool #
Ord Horizontal #
Methods compare :: Horizontal -> Horizontal -> Ordering # (<) :: Horizontal -> Horizontal -> Bool # (<=) :: Horizontal -> Horizontal -> Bool # (>) :: Horizontal -> Horizontal -> Bool # (>=) :: Horizontal -> Horizontal -> Bool # max :: Horizontal -> Horizontal -> Horizontal # min :: Horizontal -> Horizontal -> Horizontal #
Show Horizontal #
Methods showsPrec :: Int -> Horizontal -> ShowS # show :: Horizontal -> String # showList :: [Horizontal] -> ShowS #
Orientation Horizontal #
Methods rodRows :: Box Horizontal -> RodRows # spacer :: Radiant -> Int -> Box Horizontal # spreader :: Alignment Horizontal -> Int -> Box Horizontal #
UpDown (Box Horizontal) #
Methods above :: Box Horizontal -> Int # below :: Box Horizontal -> Int #
UpDown (Payload Horizontal) #
Methods above :: Payload Horizontal -> Int # below :: Payload Horizontal -> Int #
HasWidth (Box Horizontal) #
Methods width :: Box Horizontal -> Int #
HasHeight (Box Horizontal) #
Methods height :: Box Horizontal -> Int #

data Vertical #

Determines how a payload aligns with a vertical axis.

Constructors

Port
Starboard

Instances

Eq Vertical #
Methods (==) :: Vertical -> Vertical -> Bool # (/=) :: Vertical -> Vertical -> Bool #
Ord Vertical #
Methods compare :: Vertical -> Vertical -> Ordering # (<) :: Vertical -> Vertical -> Bool # (<=) :: Vertical -> Vertical -> Bool # (>) :: Vertical -> Vertical -> Bool # (>=) :: Vertical -> Vertical -> Bool # max :: Vertical -> Vertical -> Vertical # min :: Vertical -> Vertical -> Vertical #
Show Vertical #
Methods showsPrec :: Int -> Vertical -> ShowS # show :: Vertical -> String # showList :: [Vertical] -> ShowS #
Orientation Vertical #
Methods rodRows :: Box Vertical -> RodRows # spacer :: Radiant -> Int -> Box Vertical # spreader :: Alignment Vertical -> Int -> Box Vertical #
LeftRight (Box Vertical) #
Methods port :: Box Vertical -> Int # starboard :: Box Vertical -> Int #
LeftRight (Payload Vertical) #
Methods port :: Payload Vertical -> Int # starboard :: Payload Vertical -> Int #
HasWidth (Box Vertical) #
Methods width :: Box Vertical -> Int #
HasHeight (Box Vertical) #
Methods height :: Box Vertical -> Int #

center :: Alignment a #

Place this payload so that it is centered on the vertical axis or horizontal axis.

centerH :: Alignment Horizontal #

Center horizontally; like center, but monomorphic.

centerV :: Alignment Vertical #

Center vertically; like center, but monomorphic.

left :: Alignment Vertical #

Place this payload's left edge on the vertical axis.

right :: Alignment Vertical #

Place this payload's right edge on the vertical axis.

top :: Alignment Horizontal #

Place this payload's top edge on the horizontal axis.

bottom :: Alignment Horizontal #

Place this payload's bottom edge on the horizontal axis.

newtype Height #

A count of rows.

Constructors

Height Int

Instances

Eq Height #
Methods (==) :: Height -> Height -> Bool # (/=) :: Height -> Height -> Bool #
Ord Height #
Methods compare :: Height -> Height -> Ordering # (<) :: Height -> Height -> Bool # (<=) :: Height -> Height -> Bool # (>) :: Height -> Height -> Bool # (>=) :: Height -> Height -> Bool # max :: Height -> Height -> Height # min :: Height -> Height -> Height #
Show Height #
Methods showsPrec :: Int -> Height -> ShowS # show :: Height -> String # showList :: [Height] -> ShowS #
HasHeight Height #
Methods height :: Height -> Int #

newtype Width #

A count of columns.

Constructors

Width Int

Instances

Eq Width #
Methods (==) :: Width -> Width -> Bool # (/=) :: Width -> Width -> Bool #
Ord Width #
Methods compare :: Width -> Width -> Ordering # (<) :: Width -> Width -> Bool # (<=) :: Width -> Width -> Bool # (>) :: Width -> Width -> Bool # (>=) :: Width -> Width -> Bool # max :: Width -> Width -> Width # min :: Width -> Width -> Width #
Show Width #
Methods showsPrec :: Int -> Width -> ShowS # show :: Width -> String # showList :: [Width] -> ShowS #
HasWidth Width #
Methods width :: Width -> Int #

class HasHeight a where #

Minimal complete definition

height

Methods

height :: a -> Int #

Instances

HasHeight RodRows #
Methods height :: RodRows -> Int #
HasHeight Core #
Methods height :: Core -> Int #
HasHeight Height #
Methods height :: Height -> Int #
HasHeight (Chunk a) #
Methods height :: Chunk a -> Int #
HasHeight (Box Vertical) #
Methods height :: Box Vertical -> Int #
HasHeight (Box Horizontal) #
Methods height :: Box Horizontal -> Int #
HasHeight (Payload a) #
Methods height :: Payload a -> Int #
(HasHeight a, HasHeight b) => HasHeight (Either a b) #
Methods height :: Either a b -> Int #

class HasWidth a where #

Minimal complete definition

width

Methods

width :: a -> Int #

Instances

HasWidth RodRows #
Methods width :: RodRows -> Int #
HasWidth Rod #
Methods width :: Rod -> Int #
HasWidth Core #
Methods width :: Core -> Int #
HasWidth Width #
Methods width :: Width -> Int #
HasWidth (Chunk Text) #
Methods width :: Chunk Text -> Int #
HasWidth (Box Vertical) #
Methods width :: Box Vertical -> Int #
HasWidth (Box Horizontal) #
Methods width :: Box Horizontal -> Int #
HasWidth (Payload a) #
Methods width :: Payload a -> Int #
(HasWidth a, HasWidth b) => HasWidth (Either a b) #
Methods width :: Either a b -> Int #

newtype Core #

A Core is either a single Chunk or, if the box is blank, is merely a height and a width.

Constructors

Core (Either (Chunk Text) (Height, Width))

Instances

Eq Core #
Methods (==) :: Core -> Core -> Bool # (/=) :: Core -> Core -> Bool #
Ord Core #
Methods compare :: Core -> Core -> Ordering # (<) :: Core -> Core -> Bool # (<=) :: Core -> Core -> Bool # (>) :: Core -> Core -> Bool # (>=) :: Core -> Core -> Bool # max :: Core -> Core -> Core # min :: Core -> Core -> Core #
Show Core #
Methods showsPrec :: Int -> Core -> ShowS # show :: Core -> String # showList :: [Core] -> ShowS #
HasWidth Core #
Methods width :: Core -> Int #
HasHeight Core #
Methods height :: Core -> Int #

newtype Rod #

An intermediate type used in rendering; it consists either of text Chunk or of a number of spaces coupled with a background color.

Constructors

Rod (Either (Int, Radiant) (Chunk Text))

Instances

Eq Rod #
Methods (==) :: Rod -> Rod -> Bool # (/=) :: Rod -> Rod -> Bool #
Ord Rod #
Methods compare :: Rod -> Rod -> Ordering # (<) :: Rod -> Rod -> Bool # (<=) :: Rod -> Rod -> Bool # (>) :: Rod -> Rod -> Bool # (>=) :: Rod -> Rod -> Bool # max :: Rod -> Rod -> Rod # min :: Rod -> Rod -> Rod #
Show Rod #
Methods showsPrec :: Int -> Rod -> ShowS # show :: Rod -> String # showList :: [Rod] -> ShowS #
HasWidth Rod #
Methods width :: Rod -> Int #

data RodRows #

A list of screen rows; each screen row is a Seq of Rod.

A RodRows with width but no height does nothing if rendered alone, but it can affect the width of other RodRows if combined with them.

Constructors

RodRowsWithHeight (Seq (Seq Rod))

Each outer Seq represents a single screen row. Each Seq has a height of 1.

The outer Seq must have a length of at least 1, even if the inner Seq is empty. If the outer Seq has a length of zero, undefined behavior occurs. For a RodRows with no height and no width, use RodRowsNoHeight.

RodRowsNoHeight Int

A RodRows that has no height. If the Int is less than 1, the RodRows has no width and no height. Otherwise, the RodRows has no height but has the given width.

Instances

Eq RodRows #
Methods (==) :: RodRows -> RodRows -> Bool # (/=) :: RodRows -> RodRows -> Bool #
Ord RodRows #
Methods compare :: RodRows -> RodRows -> Ordering # (<) :: RodRows -> RodRows -> Bool # (<=) :: RodRows -> RodRows -> Bool # (>) :: RodRows -> RodRows -> Bool # (>=) :: RodRows -> RodRows -> Bool # max :: RodRows -> RodRows -> RodRows # min :: RodRows -> RodRows -> RodRows #
Show RodRows #
Methods showsPrec :: Int -> RodRows -> ShowS # show :: RodRows -> String # showList :: [RodRows] -> ShowS #
HasWidth RodRows #
Methods width :: RodRows -> Int #
HasHeight RodRows #
Methods height :: RodRows -> Int #

rodRowsFromCore :: Radiant -> Core -> RodRows #

Convert a Core to a Seq of Rod for rendering.

chunksFromRodRows :: RodRows -> Seq (Seq (Chunk Text)) #

Converts a RodRows to a nested Seq of Chunk in preparation for rendering. Newlines are added to the end of each line.

data Payload a #

A Payload holds a RodRows, which determines the number and content of the screen rows. The Payload also has an Alignment, which specifies how the payload aligns with the axis. Whether the Alignment is Horizontal or Vertical determines the orientation of the Payload. The Payload also contains a background color, which is type Radiant. The background color extends continuously from the Payload in both directions that are perpendicular to the axis.

Constructors

Payload (Alignment a) Radiant (Either RodRows Core)

Instances

Eq a => Eq (Payload a) #
Methods (==) :: Payload a -> Payload a -> Bool # (/=) :: Payload a -> Payload a -> Bool #
Ord a => Ord (Payload a) #
Methods compare :: Payload a -> Payload a -> Ordering # (<) :: Payload a -> Payload a -> Bool # (<=) :: Payload a -> Payload a -> Bool # (>) :: Payload a -> Payload a -> Bool # (>=) :: Payload a -> Payload a -> Bool # max :: Payload a -> Payload a -> Payload a # min :: Payload a -> Payload a -> Payload a #
Show a => Show (Payload a) #
Methods showsPrec :: Int -> Payload a -> ShowS # show :: Payload a -> String # showList :: [Payload a] -> ShowS #
UpDown (Payload Horizontal) #
Methods above :: Payload Horizontal -> Int # below :: Payload Horizontal -> Int #
LeftRight (Payload Vertical) #
Methods port :: Payload Vertical -> Int # starboard :: Payload Vertical -> Int #
HasWidth (Payload a) #
Methods width :: Payload a -> Int #
HasHeight (Payload a) #
Methods height :: Payload a -> Int #

addVerticalPadding :: Box Horizontal -> Seq RodRows #

Adds padding to the top and bottom of each Payload. A Payload with a Core is converted to a RodRows and has padding added; a Payload with a RodRows has necessary padding added to the top and bottom. The number of elements in the resulting Seq is the same as the number of elements in the input Seq; no merging is performed.

horizontalMerge :: Seq RodRows -> RodRows #

Merges multiple horizontal RodRows into a single RodRows. All RodRows must already have been the same height; if they are not the same height, undefined behavior occurs.

split :: Int -> (Int, Int) #

Split a number into two parts, so that the sum of the two parts is equal to the original number.

addHorizontalPadding :: Box Vertical -> Seq RodRows #

Adds padding to the left and right of each Payload. A Payload with a Core is converted to a RodRows and has padding added; a Payload with a RodRows has necessary padding added to the left and right. The number of elements in the resulting Seq is the same as the number of elements in the input Seq; no merging is performed.

verticalMerge :: Seq RodRows -> RodRows #

Merge multiple vertical RodRows into a single RodRows. Each RodRows should already be the same width.

newtype Box a #

A Box is the central building block. It consists of zero or more payloads; each payload has the same orientation, which is either Horizontal or Vertical. This orientation also determines the orientation of the entire Box.

A Box is a Monoid so you can combine them using the usual monoid functions. For a Box Vertical, the leftmost values added with mappend are at the top of the Box; for a Box Horizontal, the leftmost values added with mappend are on the left side of the Box.

Constructors

Box (Seq (Payload a))

Instances

Eq a => Eq (Box a) #
Methods (==) :: Box a -> Box a -> Bool # (/=) :: Box a -> Box a -> Bool #
Ord a => Ord (Box a) #
Methods compare :: Box a -> Box a -> Ordering # (<) :: Box a -> Box a -> Bool # (<=) :: Box a -> Box a -> Bool # (>) :: Box a -> Box a -> Bool # (>=) :: Box a -> Box a -> Bool # max :: Box a -> Box a -> Box a # min :: Box a -> Box a -> Box a #
Show a => Show (Box a) #
Methods showsPrec :: Int -> Box a -> ShowS # show :: Box a -> String # showList :: [Box a] -> ShowS #
Monoid (Box a) #
Methods mempty :: Box a # mappend :: Box a -> Box a -> Box a # mconcat :: [Box a] -> Box a #
UpDown (Box Horizontal) #
Methods above :: Box Horizontal -> Int # below :: Box Horizontal -> Int #
LeftRight (Box Vertical) #
Methods port :: Box Vertical -> Int # starboard :: Box Vertical -> Int #
HasWidth (Box Vertical) #
Methods width :: Box Vertical -> Int #
HasWidth (Box Horizontal) #
Methods width :: Box Horizontal -> Int #
HasHeight (Box Vertical) #
Methods height :: Box Vertical -> Int #
HasHeight (Box Horizontal) #
Methods height :: Box Horizontal -> Int #

class Orientation a where #

This typeclass is responsible for transforming a Box into Rainbow Chunk so they can be printed to your screen. This requires adding appropriate whitespace with the right colors, as well as adding newlines in the right places.

Minimal complete definition

rodRows, spacer, spreader

Methods

rodRows :: Box a -> RodRows #

spacer :: Radiant -> Int -> Box a #

Builds a one-dimensional box of the given size; its single dimension is parallel to the axis. When added to a box, it will insert blank space of the given length. For a Box Horizontal, this produces a horizontal line; for a Box Vertical, a vertical line.

spreader :: Alignment a -> Int -> Box a #

Builds a one-dimensional box of the given size; its single dimension is perpendicular to the axis. This can be used to make a Box Vertical wider or a Box Horizontal taller.

Instances

Orientation Vertical #
Methods rodRows :: Box Vertical -> RodRows # spacer :: Radiant -> Int -> Box Vertical # spreader :: Alignment Vertical -> Int -> Box Vertical #
Orientation Horizontal #
Methods rodRows :: Box Horizontal -> RodRows # spacer :: Radiant -> Int -> Box Horizontal # spreader :: Alignment Horizontal -> Int -> Box Horizontal #

class LeftRight a where #

Things that are oriented around a vertical axis.

Minimal complete definition

port, starboard

Methods

port :: a -> Int #

Length to the left of the vertical axis.

starboard :: a -> Int #

Length to the right of the vertical axis.

Instances

LeftRight (Box Vertical) #
Methods port :: Box Vertical -> Int # starboard :: Box Vertical -> Int #
LeftRight (Payload Vertical) #
Methods port :: Payload Vertical -> Int # starboard :: Payload Vertical -> Int #

class UpDown a where #

Things that are oriented around a horizontal axis.

Minimal complete definition

above, below

Methods

above :: a -> Int #

Number of lines above the horizontal axis.

below :: a -> Int #

Number of lines below the horizontal axis.

Instances

UpDown (Box Horizontal) #
Methods above :: Box Horizontal -> Int # below :: Box Horizontal -> Int #
UpDown (Payload Horizontal) #
Methods above :: Payload Horizontal -> Int # below :: Payload Horizontal -> Int #

fromChunk #

Arguments

:: Alignment a
-> Radiant	Background color. The background color in the `Chunk` is not changed; this background is used if the `Payload` must be padded later on.
-> Chunk Text
-> Box a

Construct a box from a single Chunk.

blank #

Arguments

:: Alignment a
-> Radiant	Color for the blank area.
-> Height
-> Width
-> Box a

Construct a blank box. Useful for adding in background spacers. For functions that build one-dimensional boxes, see spacer and spreader.

wrap #

Arguments

:: Orientation a
=> Alignment b	Alignment for new `Box`. This also determines whether the new `Box` is `Horizontal` or `Vertical`.
-> Radiant	Background color for new box
-> Box a
-> Box b

Wrap a Box in another Box. Useful for changing a Horizontal Box to a Vertical one, or simply for putting a Box inside another one to control size and background color.

render :: Orientation a => Box a -> Seq (Chunk Text) #

Convert a box to a Seq of Chunk in preparation for rendering. Use toList to convert the Seq of Chunk to a list so that you can print it using the functions in Rainbow.

data Cell #

A single cell in a spreadsheet-like grid.

Constructors

Cell

Fields

_rows :: Seq (Seq (Chunk Text))
The cell can have multiple rows of text; there is one Seq for each row of text.
_horizontal :: Alignment Horizontal
How this Cell should align compared to other Cell in its row.
_vertical :: Alignment Vertical
How this Cell should align compared to other Cell in its column.
_background :: Radiant
Background color for this cell. The background in the individual Chunk in the cellRows are not affected by cellBackground; instead, cellBackground determines the color of necessary padding that will be added so that the cells make a uniform table.

Instances

Eq Cell #
Methods (==) :: Cell -> Cell -> Bool # (/=) :: Cell -> Cell -> Bool #
Ord Cell #
Methods compare :: Cell -> Cell -> Ordering # (<) :: Cell -> Cell -> Bool # (<=) :: Cell -> Cell -> Bool # (>) :: Cell -> Cell -> Bool # (>=) :: Cell -> Cell -> Bool # max :: Cell -> Cell -> Cell # min :: Cell -> Cell -> Cell #
Show Cell #
Methods showsPrec :: Int -> Cell -> ShowS # show :: Cell -> String # showList :: [Cell] -> ShowS #
Monoid Cell #	`mappend` combines two `Cell` horizontally so they are side-by-side, left-to-right. The `_horizontal`, `_vertical`, and `_background` fields are combined using their respective `Monoid` instances. `mempty` uses the respective `mempty` value for each field.
Methods mempty :: Cell # mappend :: Cell -> Cell -> Cell # mconcat :: [Cell] -> Cell #

background :: Functor f => (Radiant -> f Radiant) -> Cell -> f Cell #

vertical :: Functor f => (Alignment Vertical -> f (Alignment Vertical)) -> Cell -> f Cell #

horizontal :: Functor f => (Alignment Horizontal -> f (Alignment Horizontal)) -> Cell -> f Cell #

rows :: Functor f => (Seq (Seq (Chunk Text)) -> f (Seq (Seq (Chunk Text)))) -> Cell -> f Cell #

separator :: Radiant -> Int -> Cell #

Creates a blank Cell with the given background color and width; useful for adding separators between columns.

tableByRows :: Seq (Seq Cell) -> Box Vertical #

Create a table where each inner Seq is a row of cells, from left to right. If necessary, blank cells are added to the end of a row to ensure that each row has the same number of cells as the longest row.

rowToBoxV :: Box Horizontal -> Box Vertical #

cellToBoxV :: Cell -> (Box Vertical, Alignment Horizontal, Radiant) #

toBoxH :: (Box Vertical, Alignment Horizontal, Radiant) -> Box Horizontal #

addWidthMap :: Seq (Seq (Box Vertical, b, c)) -> (Map Int (Int, Int), Seq (Seq (Box Vertical, b, c))) #

padBoxV :: Map Int (Int, Int) -> Seq (Seq (Box Vertical, a, b)) -> Seq (Seq (Box Vertical, a, b)) #

widestCellMap :: Seq (Seq (Box Vertical)) -> Map Int (Int, Int) #

tableByColumns :: Seq (Seq Cell) -> Box Horizontal #

Create a table where each inner Seq is a column of cells, from top to bottom. If necessary, blank cells are added to the end of a column to ensure that each column has the same number of cells as the longest column.

rowToBoxH :: Box Vertical -> Box Horizontal #

cellToBoxH :: Cell -> (Box Horizontal, Alignment Vertical, Radiant) #

addHeightMap :: Seq (Seq (Box Horizontal, b, c)) -> (Map Int (Int, Int), Seq (Seq (Box Horizontal, b, c))) #

tallestCellMap :: Seq (Seq (Box Horizontal)) -> Map Int (Int, Int) #

padBoxH :: Map Int (Int, Int) -> Seq (Seq (Box Horizontal, a, b)) -> Seq (Seq (Box Horizontal, a, b)) #

toBoxV :: (Box Horizontal, Alignment Vertical, Radiant) -> Box Vertical #

equalize :: a -> Seq (Seq a) -> Seq (Seq a) #

Ensures that each inner Seq is the same length by adding the given empty element where needed.

mconcatSeq :: Monoid a => Seq a -> a #

intersperse :: a -> Seq a -> Seq a #

Like intersperse in Data.List, but works on Seq.