Data.Char.BoxDrawing

Box border type

data Drawing

A box border which can be rendered to a terminal given a BoxDrawingStyle

Use the Monoid and Semigroup instances to combine box borders.

The internal representation is just a Word8; the least-significant four bits specify the base directions of the box drawing (up, down, left, or right), and the most-significant four bits specify the style (see rounded, dashed2, etc) which has its own special logic for how styles can be combined.

Instances

Monoid Drawing

Defined in Data.Char.BoxDrawing

Methods

mempty :: Drawing

mappend :: Drawing -> Drawing -> Drawing

mconcat :: [Drawing] -> Drawing

Semigroup Drawing

Defined in Data.Char.BoxDrawing

Methods

(<>) :: Drawing -> Drawing -> Drawing

sconcat :: NonEmpty Drawing -> Drawing

stimes :: Integral b => b -> Drawing -> Drawing

Eq Drawing

Defined in Data.Char.BoxDrawing

Methods

(==) :: Drawing -> Drawing -> Bool

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

Ord Drawing

Defined in Data.Char.BoxDrawing

Methods

compare :: Drawing -> Drawing -> Ordering

(<) :: Drawing -> Drawing -> Bool

(<=) :: Drawing -> Drawing -> Bool

(>) :: Drawing -> Drawing -> Bool

(>=) :: Drawing -> Drawing -> Bool

max :: Drawing -> Drawing -> Drawing

min :: Drawing -> Drawing -> Drawing

render :: BoxDrawingStyle -> Drawing -> Char

Render a Drawing given the style

lookup :: BoxDrawingStyle -> Char -> Maybe Drawing

Lookup a character given the style

read :: BoxDrawingStyle -> Char -> Drawing

Given a box drawing style and a character, determine what Drawing the character is. On error, returns an empty Drawing

overlay :: BoxDrawingStyle -> Drawing -> Char -> Char

Get the character that best represents visually overlaying the given box drawing and a character.

Box drawing styles

data BoxDrawingStyle

A border style such as ASCII or unicode. Describes how to turn a Drawing into an actual character for rendering, or to lookup a character from a buffer into a Drawing for combining different border characters

ascii :: BoxDrawingStyle

A basic box-drawing style that uses |, +, and -

unicode :: BoxDrawingStyle

An advanced box-drawing style that supports all the drawing primitives provided in this module

Drawings

Base primitives

Use the Semigroup instance to combine box Drawing.

up :: Drawing

down :: Drawing

left :: Drawing

right :: Drawing

Combinations

These are pre-made combinations of up, down, left, and right.

horizontal :: Drawing

vertical :: Drawing

cornerTL :: Drawing

cornerTR :: Drawing

cornerBR :: Drawing

cornerBL :: Drawing

intersectFull :: Drawing

intersectL :: Drawing

intersectR :: Drawing

intersectT :: Drawing

intersectB :: Drawing

Box drawing modifiers

Combine these using the Semigroup instance with another Drawing to set its style, such as heavy, dashed, etc. - only relevant for the style unicode and has no effect for the style ascii.

heavy :: Drawing

heavyHoriz :: Drawing

heavyVert :: Drawing

dashed2 :: Drawing

dashed3 :: Drawing

double :: Drawing

doubleHoriz :: Drawing

doubleVert :: Drawing

rounded :: Drawing