Symantic.Document.Plain

Type Plain

newtype Plain d

Church encoded for performance concerns. Kind like ParsecT in megaparsec but a little bit different due to the use of PlainFit for implementing breakingSpace correctly when in the left hand side of (<>). Prepending is done using continuation, like in a difference list.

Constructors

Plain

Fields

• unPlain :: PlainInh d -> PlainState d -> ((d -> d, PlainState d) -> PlainFit d) -> PlainFit d

Instances

(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

(Show d, Spaceable d) => Show (Plain d)

Defined in Symantic.Document.Plain

Methods

showsPrec :: Int -> Plain d -> ShowS

show :: Plain d -> String

showList :: [Plain d] -> ShowS

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

Defined in Symantic.Document.Plain

Methods

fromString :: String -> Plain d

Semigroup d => Semigroup (Plain d)

Defined in Symantic.Document.Plain

Methods

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

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

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

Monoid d => Monoid (Plain d)

Defined in Symantic.Document.Plain

Methods

mempty :: Plain d

mappend :: Plain d -> Plain d -> Plain d

mconcat :: [Plain d] -> Plain d

Spaceable d => Justifiable (Plain d)

Defined in Symantic.Document.Plain

Methods

justify :: Plain d -> Plain d

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

(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

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

(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

(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

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

(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

runPlain :: Spaceable d => Plain d -> d

Type PlainState

data PlainState d

Constructors

PlainState

Fields

• plainState_buffer :: ![PlainChunk d]
• plainState_bufferStart :: !Column

  The Column from which the plainState_buffer must be written.

• plainState_bufferWidth :: !Width

  The Width of the plainState_buffer so far.

• plainState_breakIndent :: !Indent

  The amount of Indent added by breakspace that can be reached by breaking the space into a newlineJustifyingPlain.

Instances

Show d => Show (PlainState d)

Defined in Symantic.Document.Plain

Methods

showsPrec :: Int -> PlainState d -> ShowS

show :: PlainState d -> String

showList :: [PlainState d] -> ShowS

defPlainState :: PlainState d

Type PlainInh

data PlainInh d

Constructors

PlainInh

Fields

• plainInh_width :: !(Maybe Column)
• plainInh_justify :: !Bool
• plainInh_indent :: !Indent
• plainInh_indenting :: !(Plain d)
• plainInh_sgr :: ![SGR]

defPlainInh :: Spaceable d => PlainInh d

Type PlainFit

type PlainFit d = (d -> d) -> (d -> d) -> d

Double continuation to qualify the returned document as fitting or overflowing the given plainInh_width. It's like (Bool,d) in a normal style (a non continuation-passing-style).

Type PlainChunk

data PlainChunk d

Constructors

PlainChunk_Ignored !d

Ignored by the justification but kept in place. Used for instance to put ANSI sequences.

PlainChunk_Word !(Word d)

PlainChunk_Spaces !Width

spaces preserved to be interleaved correctly with PlainChunk_Ignored.

Instances

Show d => Show (PlainChunk d)

Defined in Symantic.Document.Plain

Methods

showsPrec :: Int -> PlainChunk d -> ShowS

show :: PlainChunk d -> String

showList :: [PlainChunk d] -> ShowS

Lengthable d => Lengthable (PlainChunk d)

Defined in Symantic.Document.Plain

Methods

width :: PlainChunk d -> Column

nullWidth :: PlainChunk d -> Bool

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

Defined in Symantic.Document.Plain

Methods

from :: [SGR] -> PlainChunk d

runPlainChunk :: Spaceable d => PlainChunk d -> d

flushlinePlain :: Spaceable d => Plain d

Commit plainState_buffer upto there, so that it won't be justified.

collapsePlainChunkSpaces :: PlainChunk d -> PlainChunk d

newlineJustifyingPlain :: Spaceable d => Plain d

Like newline, but justify plainState_buffer before.

Justifying

justifyLinePlain :: Spaceable d => PlainInh d -> PlainState d -> d

countWordsPlain :: [PlainChunk d] -> Natural

(countWordsPlain ps) returns the number of words in (ps) clearly separated by spaces.

justifyPadding :: Natural -> Natural -> [Natural]

(justifyPadding a b) returns the padding lengths to reach (a) in (b) pads, using the formula: (a == m*(q + q+1) + (r-'m)*(q+1) + (b-r-m)*q) where (q+1) and (q) are the two padding lengths used and (m = min (b-r) r).

A simple implementation of justifyPadding could be: justifyPadding a b = join (replicate m [q,q+1]) <> (replicate (r-m) (q+1) <> (replicate ((b-r)-m) q where (q,r) = adivModb m = min (b-r) r

padLinePlainChunkInits :: Spaceable d => Width -> (Natural, Natural, [PlainChunk d]) -> Line d

joinLinePlainChunk :: Monoid d => Spaceable d => [PlainChunk d] -> d

Just concat PlainChunks with no justification.

padLinePlainChunk :: Spaceable d => [PlainChunk d] -> [Width] -> d

Interleave PlainChunks with Widths from justifyPadding.

Escaping

plainSGR :: Semigroup d => From [SGR] d => SGR -> Plain d -> Plain d