Bricks.IndentedString

Indented string

newtype InStr

An "indented string literal," delimited by two single-quotes ''.

This type of literal is called "indented" because the parser automatically removes leading whitespace from the string (inStr'dedent), which makes it convenient to use these literals for multi-line strings within an indented expression without the whitespace from indentation ending up as part of the string.

Constructors

InStr

Fields

• inStr'toSeq :: Seq InStr'1

Instances

Show InStr

Methods

showsPrec :: Int -> InStr -> ShowS

show :: InStr -> String

showList :: [InStr] -> ShowS

Semigroup InStr

Methods

(<>) :: InStr -> InStr -> InStr

sconcat :: NonEmpty InStr -> InStr

stimes :: Integral b => b -> InStr -> InStr

Monoid InStr

Methods

mempty :: InStr

mappend :: InStr -> InStr -> InStr

mconcat :: [InStr] -> InStr

inStr'join :: InStr -> Str'Dynamic

Join InStrs with newlines interspersed.

inStr'level :: InStr -> Natural

Determine how many characters of whitespace to strip from an indented string.

inStr'dedent :: InStr -> InStr

Determine the minimum indentation of any nonempty line, and remove that many space characters from the front of every line.

inStr'trim :: InStr -> InStr

Remove any empty lines from the beginning or end of an indented string.

inStr'toList :: InStr -> [InStr'1]

Single line of an indented string

data InStr'1

One line of an InStr.

Constructors

InStr'1

Fields

• inStr'1'level :: Natural

  The number of leading space characters. We store this separately for easier implementation of inStr'dedent.

• inStr'1'str :: Str'Dynamic

  The rest of the line after any leading spaces.

Instances

Show InStr'1

Methods

showsPrec :: Int -> InStr'1 -> ShowS

show :: InStr'1 -> String

showList :: [InStr'1] -> ShowS

inStr'1'nonEmpty :: InStr'1 -> Bool

Determines whether an InStr'1 contains any non-space characters. The opposite of inStr'1'nonEmpty.

This is used to determine whether this line should be considered when calculating the number of space characters to strip in inStr'dedent.

inStr'1'empty :: InStr'1 -> Bool

The opposite of inStr'1'nonEmpty.

inStr'1'modifyLevel :: (Natural -> Natural) -> InStr'1 -> InStr'1

Modify an InStr by applying a function to its number of leading spaces.