Symantic.Document.API

Helper types

type Column = Natural

type Indent = Column

type Width = Natural

Type Line

newtype Line d

Constructors

Line d

Instances

Eq d => Eq (Line d)

Defined in Symantic.Document.API

Methods

(==) :: Line d -> Line d -> Bool

(/=) :: Line d -> Line d -> Bool

Show d => Show (Line d)

Defined in Symantic.Document.API

Methods

showsPrec :: Int -> Line d -> ShowS

show :: Line d -> String

showList :: [Line d] -> ShowS

Lengthable d => Lengthable (Line d)

Defined in Symantic.Document.API

Methods

width :: Line d -> Column

nullWidth :: Line d -> Bool

From d Builder => From (Line d) Builder

Defined in Symantic.Document.API

Methods

from :: Line d -> Builder

From d Text => From (Line d) Text

Defined in Symantic.Document.API

Methods

from :: Line d -> Text

From d String => From (Line d) String

Defined in Symantic.Document.API

Methods

from :: Line d -> String

(From (Word s) d, Lengthable s, Spaceable d, Splitable s) => From (Line s) (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: Line s -> Plain d

unLine :: Line d -> d

Type Word

newtype Word d

Constructors

Word d

Instances

Eq d => Eq (Word d)

Defined in Symantic.Document.API

Methods

(==) :: Word d -> Word d -> Bool

(/=) :: Word d -> Word d -> Bool

Show d => Show (Word d)

Defined in Symantic.Document.API

Methods

showsPrec :: Int -> Word d -> ShowS

show :: Word d -> String

showList :: [Word d] -> ShowS

Semigroup d => Semigroup (Word d)

Defined in Symantic.Document.API

Methods

(<>) :: Word d -> Word d -> Word d

sconcat :: NonEmpty (Word d) -> Word d

stimes :: Integral b => b -> Word d -> Word d

Lengthable d => Lengthable (Word d)

Defined in Symantic.Document.API

Methods

width :: Word d -> Column

nullWidth :: Word d -> Bool

From d Builder => From (Word d) Builder

Defined in Symantic.Document.API

Methods

from :: Word d -> Builder

From d Text => From (Word d) Text

Defined in Symantic.Document.API

Methods

from :: Word d -> Text

From d String => From (Word d) String

Defined in Symantic.Document.API

Methods

from :: Word d -> String

From [SGR] d => From [SGR] (Word d)

Defined in Symantic.Document.API

Methods

from :: [SGR] -> Word d

(From (Word s) d, Semigroup d, Lengthable s) => From (Word s) (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: Word s -> Plain d

unWord :: Word d -> d

Class From

class From a d where

Minimal complete definition

Nothing

Methods

from :: a -> d

from :: From String d => Show a => a -> d

Instances

From Char String

Defined in Symantic.Document.API

Methods

from :: Char -> String

From Char Builder

Defined in Symantic.Document.API

Methods

from :: Char -> Builder

From Char Text

Defined in Symantic.Document.API

Methods

from :: Char -> Text

From (Line String) d => From Int d

Defined in Symantic.Document.API

Methods

from :: Int -> d

From (Line String) d => From Integer d

Defined in Symantic.Document.API

Methods

from :: Integer -> d

From (Line String) d => From Natural d

Defined in Symantic.Document.API

Methods

from :: Natural -> d

From String String

Defined in Symantic.Document.API

Methods

from :: String -> String

From String Builder

Defined in Symantic.Document.API

Methods

from :: String -> Builder

From String Text

Defined in Symantic.Document.API

Methods

from :: String -> Text

From Builder Builder

Defined in Symantic.Document.API

Methods

from :: Builder -> Builder

From Text String

Defined in Symantic.Document.API

Methods

from :: Text -> String

From Text Builder

Defined in Symantic.Document.API

Methods

from :: Text -> Builder

From Text Text

Defined in Symantic.Document.API

Methods

from :: Text0 -> Text

From Text String

Defined in Symantic.Document.API

Methods

from :: Text -> String

From Text Builder

Defined in Symantic.Document.API

Methods

from :: Text -> Builder

From Text Text

Defined in Symantic.Document.API

Methods

from :: Text -> Text

(From (Word Char) d, Spaceable d) => From Char (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: Char -> Plain d

(From (Word String) d, Spaceable d) => From String (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: String -> Plain d

(From (Word Text) d, Spaceable d) => From Text (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: Text -> Plain d

(From (Word Text) d, Spaceable d) => From Text (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: Text -> Plain d

From [SGR] String

Defined in Symantic.Document.API

Methods

from :: [SGR] -> String

From [SGR] Builder

Defined in Symantic.Document.API

Methods

from :: [SGR] -> Builder

From [SGR] Text

Defined in Symantic.Document.API

Methods

from :: [SGR] -> Text

From d Builder => From (Word d) Builder

Defined in Symantic.Document.API

Methods

from :: Word d -> Builder

From d Text => From (Word d) Text

Defined in Symantic.Document.API

Methods

from :: Word d -> Text

From d String => From (Word d) String

Defined in Symantic.Document.API

Methods

from :: Word d -> String

From d Builder => From (Line d) Builder

Defined in Symantic.Document.API

Methods

from :: Line d -> Builder

From d Text => From (Line d) Text

Defined in Symantic.Document.API

Methods

from :: Line d -> Text

From d String => From (Line d) String

Defined in Symantic.Document.API

Methods

from :: Line d -> String

From [SGR] d => From [SGR] (Word d)

Defined in Symantic.Document.API

Methods

from :: [SGR] -> Word d

From [SGR] d => From [SGR] (PlainChunk d)

Defined in Symantic.Document.Plain

Methods

from :: [SGR] -> PlainChunk d

(From [SGR] d, Semigroup d) => From [SGR] (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: [SGR] -> Plain d

(From (Word s) d, Semigroup d, Lengthable s) => From (Word s) (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: Word s -> Plain d

(From (Word s) d, Lengthable s, Spaceable d, Splitable s) => From (Line s) (Plain d)

Defined in Symantic.Document.Plain

Methods

from :: Line s -> Plain d

runTextBuilder :: Builder -> Text

Class Lengthable

class Lengthable d where

Minimal complete definition

width

Methods

width :: d -> Column

nullWidth :: d -> Bool

Instances

Lengthable Char

Defined in Symantic.Document.API

Methods

width :: Char -> Column

nullWidth :: Char -> Bool

Lengthable String

Defined in Symantic.Document.API

Methods

width :: String -> Column

nullWidth :: String -> Bool

Lengthable Text

Defined in Symantic.Document.API

Methods

width :: Text -> Column

nullWidth :: Text -> Bool

Lengthable Text

Defined in Symantic.Document.API

Methods

width :: Text -> Column

nullWidth :: Text -> Bool

Lengthable d => Lengthable (Word d)

Defined in Symantic.Document.API

Methods

width :: Word d -> Column

nullWidth :: Word d -> Bool

Lengthable d => Lengthable (Line d)

Defined in Symantic.Document.API

Methods

width :: Line d -> Column

nullWidth :: Line d -> Bool

Lengthable d => Lengthable (PlainChunk d)

Defined in Symantic.Document.Plain

Methods

width :: PlainChunk d -> Column

nullWidth :: PlainChunk d -> Bool

Class Spaceable

class Monoid d => Spaceable d where

Minimal complete definition

Nothing

Methods

newline :: d

space :: d

newline :: Spaceable (UnTrans d) => Trans d => d

space :: Spaceable (UnTrans d) => Trans d => d

spaces :: Column -> d

spaces ind = replicate ind space

spaces :: Monoid d => Column -> d

spaces ind = replicate ind space

unlines :: Foldable f => f (Line d) -> d

unwords :: Foldable f => Functor f => f (Word d) -> d

catLines :: Foldable f => Functor f => f (Line d) -> d

Like unlines but without the trailing newline.

(<+>) :: d -> d -> d infixr 6

x <+> y = x <> space <> y

(</>) :: d -> d -> d infixr 6

x </> y = x <> newline <> y

catH :: Foldable f => f d -> d

catV :: Foldable f => f d -> d

Instances

Spaceable String

Defined in Symantic.Document.API

Methods

newline :: String

space :: String

spaces :: Column -> String

unlines :: Foldable f => f (Line String) -> String

unwords :: (Foldable f, Functor f) => f (Word String) -> String

catLines :: (Foldable f, Functor f) => f (Line String) -> String

(<+>) :: String -> String -> String

(</>) :: String -> String -> String

catH :: Foldable f => f String -> String

catV :: Foldable f => f String -> String

Spaceable Builder

Defined in Symantic.Document.API

Methods

newline :: Builder

space :: Builder

spaces :: Column -> Builder

unlines :: Foldable f => f (Line Builder) -> Builder

unwords :: (Foldable f, Functor f) => f (Word Builder) -> Builder

catLines :: (Foldable f, Functor f) => f (Line Builder) -> Builder

(<+>) :: Builder -> Builder -> Builder

(</>) :: Builder -> Builder -> Builder

catH :: Foldable f => f Builder -> Builder

catV :: Foldable f => f Builder -> Builder

Spaceable Text

Defined in Symantic.Document.API

Methods

newline :: Text

space :: Text

spaces :: Column -> Text

unlines :: Foldable f => f (Line Text) -> Text

unwords :: (Foldable f, Functor f) => f (Word Text) -> Text

catLines :: (Foldable f, Functor f) => f (Line Text) -> Text

(<+>) :: Text -> Text -> Text

(</>) :: Text -> Text -> Text

catH :: Foldable f => f Text -> Text

catV :: Foldable f => f Text -> Text

Spaceable d => Spaceable (Plain d)

Defined in Symantic.Document.Plain

Methods

newline :: Plain d

space :: Plain d

spaces :: Column -> Plain d

unlines :: Foldable f => f (Line (Plain d)) -> Plain d

unwords :: (Foldable f, Functor f) => f (Word (Plain d)) -> Plain d

catLines :: (Foldable f, Functor f) => f (Line (Plain d)) -> Plain d

(<+>) :: Plain d -> Plain d -> Plain d

(</>) :: Plain d -> Plain d -> Plain d

catH :: Foldable f => f (Plain d) -> Plain d

catV :: Foldable f => f (Plain d) -> Plain d

intercalate :: (Foldable f, Monoid d) => d -> f d -> d

replicate :: Monoid d => Int -> d -> d

between :: Semigroup d => d -> d -> d -> d

parens :: Semigroup d => From (Word Char) d => d -> d

braces :: Semigroup d => From (Word Char) d => d -> d

brackets :: Semigroup d => From (Word Char) d => d -> d

angles :: Semigroup d => From (Word Char) d => d -> d

Class Splitable

class (Lengthable d, Monoid d) => Splitable d where

Minimal complete definition

tail, break

Methods

tail :: d -> Maybe d

break :: (Char -> Bool) -> d -> (d, d)

span :: (Char -> Bool) -> d -> (d, d)

lines :: d -> [Line d]

words :: d -> [Word d]

linesNoEmpty :: d -> [Line d]

wordsNoEmpty :: d -> [Word d]

splitOnChar :: (Char -> Bool) -> d -> [d]

splitOnCharNoEmpty :: (Char -> Bool) -> d -> [d]

Instances

Splitable String

Defined in Symantic.Document.API

Methods

tail :: String -> Maybe String

break :: (Char -> Bool) -> String -> (String, String)

span :: (Char -> Bool) -> String -> (String, String)

lines :: String -> [Line String]

words :: String -> [Word String]

linesNoEmpty :: String -> [Line String]

wordsNoEmpty :: String -> [Word String]

splitOnChar :: (Char -> Bool) -> String -> [String]

splitOnCharNoEmpty :: (Char -> Bool) -> String -> [String]

Splitable Text

Defined in Symantic.Document.API

Methods

tail :: Text -> Maybe Text

break :: (Char -> Bool) -> Text -> (Text, Text)

span :: (Char -> Bool) -> Text -> (Text, Text)

lines :: Text -> [Line Text]

words :: Text -> [Word Text]

linesNoEmpty :: Text -> [Line Text]

wordsNoEmpty :: Text -> [Word Text]

splitOnChar :: (Char -> Bool) -> Text -> [Text]

splitOnCharNoEmpty :: (Char -> Bool) -> Text -> [Text]

Splitable Text

Defined in Symantic.Document.API

Methods

tail :: Text -> Maybe Text

break :: (Char -> Bool) -> Text -> (Text, Text)

span :: (Char -> Bool) -> Text -> (Text, Text)

lines :: Text -> [Line Text]

words :: Text -> [Word Text]

linesNoEmpty :: Text -> [Line Text]

wordsNoEmpty :: Text -> [Word Text]

splitOnChar :: (Char -> Bool) -> Text -> [Text]

splitOnCharNoEmpty :: (Char -> Bool) -> Text -> [Text]

Class Decorable

class Decorable d where

Minimal complete definition

Nothing

Methods

bold :: d -> d

underline :: d -> d

italic :: d -> d

bold :: Decorable (UnTrans d) => Trans d => d -> d

underline :: Decorable (UnTrans d) => Trans d => d -> d

italic :: Decorable (UnTrans d) => Trans d => d -> d

Instances

(Semigroup d, From [SGR] d) => Decorable (Plain d)

Defined in Symantic.Document.Plain

Methods

bold :: Plain d -> Plain d

underline :: Plain d -> Plain d

italic :: Plain d -> Plain d

Class Colorable16

class Colorable16 d where

Minimal complete definition

Nothing

Methods

reverse :: d -> d

black :: d -> d

red :: d -> d

green :: d -> d

yellow :: d -> d

blue :: d -> d

magenta :: d -> d

cyan :: d -> d

white :: d -> d

blacker :: d -> d

redder :: d -> d

greener :: d -> d

yellower :: d -> d

bluer :: d -> d

magentaer :: d -> d

cyaner :: d -> d

whiter :: d -> d

onBlack :: d -> d

onRed :: d -> d

onGreen :: d -> d

onYellow :: d -> d

onBlue :: d -> d

onMagenta :: d -> d

onCyan :: d -> d

onWhite :: d -> d

onBlacker :: d -> d

onRedder :: d -> d

onGreener :: d -> d

onYellower :: d -> d

onBluer :: d -> d

onMagentaer :: d -> d

onCyaner :: d -> d

onWhiter :: d -> d

reverse :: Colorable16 (UnTrans d) => Trans d => d -> d

black :: Colorable16 (UnTrans d) => Trans d => d -> d

red :: Colorable16 (UnTrans d) => Trans d => d -> d

green :: Colorable16 (UnTrans d) => Trans d => d -> d

yellow :: Colorable16 (UnTrans d) => Trans d => d -> d

blue :: Colorable16 (UnTrans d) => Trans d => d -> d

magenta :: Colorable16 (UnTrans d) => Trans d => d -> d

cyan :: Colorable16 (UnTrans d) => Trans d => d -> d

white :: Colorable16 (UnTrans d) => Trans d => d -> d

blacker :: Colorable16 (UnTrans d) => Trans d => d -> d

redder :: Colorable16 (UnTrans d) => Trans d => d -> d

greener :: Colorable16 (UnTrans d) => Trans d => d -> d

yellower :: Colorable16 (UnTrans d) => Trans d => d -> d

bluer :: Colorable16 (UnTrans d) => Trans d => d -> d

magentaer :: Colorable16 (UnTrans d) => Trans d => d -> d

cyaner :: Colorable16 (UnTrans d) => Trans d => d -> d

whiter :: Colorable16 (UnTrans d) => Trans d => d -> d

onBlack :: Colorable16 (UnTrans d) => Trans d => d -> d

onRed :: Colorable16 (UnTrans d) => Trans d => d -> d

onGreen :: Colorable16 (UnTrans d) => Trans d => d -> d

onYellow :: Colorable16 (UnTrans d) => Trans d => d -> d

onBlue :: Colorable16 (UnTrans d) => Trans d => d -> d

onMagenta :: Colorable16 (UnTrans d) => Trans d => d -> d

onCyan :: Colorable16 (UnTrans d) => Trans d => d -> d

onWhite :: Colorable16 (UnTrans d) => Trans d => d -> d

onBlacker :: Colorable16 (UnTrans d) => Trans d => d -> d

onRedder :: Colorable16 (UnTrans d) => Trans d => d -> d

onGreener :: Colorable16 (UnTrans d) => Trans d => d -> d

onYellower :: Colorable16 (UnTrans d) => Trans d => d -> d

onBluer :: Colorable16 (UnTrans d) => Trans d => d -> d

onMagentaer :: Colorable16 (UnTrans d) => Trans d => d -> d

onCyaner :: Colorable16 (UnTrans d) => Trans d => d -> d

onWhiter :: Colorable16 (UnTrans d) => Trans d => d -> d

Instances

Colorable16 String

For debugging purposes.

Defined in Symantic.Document.API

Methods

reverse :: String -> String

black :: String -> String

red :: String -> String

green :: String -> String

yellow :: String -> String

blue :: String -> String

magenta :: String -> String

cyan :: String -> String

white :: String -> String

blacker :: String -> String

redder :: String -> String

greener :: String -> String

yellower :: String -> String

bluer :: String -> String

magentaer :: String -> String

cyaner :: String -> String

whiter :: String -> String

onBlack :: String -> String

onRed :: String -> String

onGreen :: String -> String

onYellow :: String -> String

onBlue :: String -> String

onMagenta :: String -> String

onCyan :: String -> String

onWhite :: String -> String

onBlacker :: String -> String

onRedder :: String -> String

onGreener :: String -> String

onYellower :: String -> String

onBluer :: String -> String

onMagentaer :: String -> String

onCyaner :: String -> String

onWhiter :: String -> String

(Semigroup d, From [SGR] d) => Colorable16 (Plain d)

Defined in Symantic.Document.Plain

Methods

reverse :: Plain d -> Plain d

black :: Plain d -> Plain d

red :: Plain d -> Plain d

green :: Plain d -> Plain d

yellow :: Plain d -> Plain d

blue :: Plain d -> Plain d

magenta :: Plain d -> Plain d

cyan :: Plain d -> Plain d

white :: Plain d -> Plain d

blacker :: Plain d -> Plain d

redder :: Plain d -> Plain d

greener :: Plain d -> Plain d

yellower :: Plain d -> Plain d

bluer :: Plain d -> Plain d

magentaer :: Plain d -> Plain d

cyaner :: Plain d -> Plain d

whiter :: Plain d -> Plain d

onBlack :: Plain d -> Plain d

onRed :: Plain d -> Plain d

onGreen :: Plain d -> Plain d

onYellow :: Plain d -> Plain d

onBlue :: Plain d -> Plain d

onMagenta :: Plain d -> Plain d

onCyan :: Plain d -> Plain d

onWhite :: Plain d -> Plain d

onBlacker :: Plain d -> Plain d

onRedder :: Plain d -> Plain d

onGreener :: Plain d -> Plain d

onYellower :: Plain d -> Plain d

onBluer :: Plain d -> Plain d

onMagentaer :: Plain d -> Plain d

onCyaner :: Plain d -> Plain d

onWhiter :: Plain d -> Plain d

xmlSGR :: Semigroup d => From String d => String -> d -> d

For debugging purposes.

Class Indentable

class Spaceable d => Indentable d where

Minimal complete definition

Nothing

Methods

align :: d -> d

(align d) make d uses current Column as Indent level.

setIndent :: d -> Indent -> d -> d

(setIndent p ind d) make d uses ind as Indent level. Using p as Indent text.

incrIndent :: d -> Indent -> d -> d

(incrIndent p ind d) make d uses current Indent plus ind as Indent level. Appending p to the current Indent text.

hang :: Indent -> d -> d

fill :: Width -> d -> d

(fill w d) write d, then if d is not wider than w, write the difference with spaces.

fillOrBreak :: Width -> d -> d

(fillOrBreak w d) write d, then if d is not wider than w, write the difference with spaces otherwise write a newline indented to to the start Column of d plus w.

align :: Indentable (UnTrans d) => Trans d => d -> d

(align d) make d uses current Column as Indent level.

incrIndent :: Indentable (UnTrans d) => Trans d => d -> Indent -> d -> d

(incrIndent p ind d) make d uses current Indent plus ind as Indent level. Appending p to the current Indent text.

setIndent :: Indentable (UnTrans d) => Trans d => d -> Indent -> d -> d

(setIndent p ind d) make d uses ind as Indent level. Using p as Indent text.

fill :: Indentable (UnTrans d) => Trans d => Width -> d -> d

(fill w d) write d, then if d is not wider than w, write the difference with spaces.

fillOrBreak :: Indentable (UnTrans d) => Trans d => Width -> d -> d

(fillOrBreak w d) write d, then if d is not wider than w, write the difference with spaces otherwise write a newline indented to to the start Column of d plus w.

Instances

Spaceable d => Indentable (Plain d)

Defined in Symantic.Document.Plain

Methods

align :: Plain d -> Plain d

setIndent :: Plain d -> Indent -> Plain d -> Plain d

incrIndent :: Plain d -> Indent -> Plain d -> Plain d

hang :: Indent -> Plain d -> Plain d

fill :: Width -> Plain d -> Plain d

fillOrBreak :: Width -> Plain d -> Plain d

class Listable d where

Minimal complete definition

Nothing

Methods

ul :: Traversable f => f d -> d

ol :: Traversable f => f d -> d

ul :: Listable (UnTrans d) => Trans d => Traversable f => f d -> d

ol :: Listable (UnTrans d) => Trans d => Traversable f => f d -> d

Instances

(Spaceable d, From (Word Char) d, From (Word String) d) => Listable (Plain d)

Defined in Symantic.Document.Plain

Methods

ul :: Traversable f => f (Plain d) -> Plain d

ol :: Traversable f => f (Plain d) -> Plain d

Class Wrappable

class Wrappable d where

Minimal complete definition

setWidth

Methods

setWidth :: Maybe Width -> d -> d

breakpoint :: d

breakspace :: d

breakalt :: d -> d -> d

endline :: d

breakpoint :: Wrappable (UnTrans d) => Trans d => d

breakspace :: Wrappable (UnTrans d) => Trans d => d

breakalt :: Wrappable (UnTrans d) => Trans d => d -> d -> d

endline :: Wrappable (UnTrans d) => Trans d => d

Instances

Spaceable d => Wrappable (Plain d)

Defined in Symantic.Document.Plain

Methods

setWidth :: Maybe Width -> Plain d -> Plain d

breakpoint :: Plain d

breakspace :: Plain d

breakalt :: Plain d -> Plain d -> Plain d

endline :: Plain d

Class Justifiable

class Justifiable d where

Methods

justify :: d -> d

Instances

Spaceable d => Justifiable (Plain d)

Defined in Symantic.Document.Plain

Methods

justify :: Plain d -> Plain d

Class Trans

class Trans repr where

Minimal complete definition

noTrans, unTrans

Associated Types

type UnTrans repr :: *

Return the underlying repr of the transformer.

Methods

noTrans :: UnTrans repr -> repr

Lift a repr to the transformer's.

unTrans :: repr -> UnTrans repr

Unlift a repr from the transformer's.

noTrans1 :: (UnTrans repr -> UnTrans repr) -> repr -> repr

Identity transformation for a unary symantic method.

noTrans2 :: (UnTrans repr -> UnTrans repr -> UnTrans repr) -> repr -> repr -> repr

Identity transformation for a binary symantic method.

noTrans3 :: (UnTrans repr -> UnTrans repr -> UnTrans repr -> UnTrans repr) -> repr -> repr -> repr -> repr

Identity transformation for a ternary symantic method.