Converter.Internal

Documentation

newtype Pretty a

A wrapper for prettyprinting strings

Constructors

Pretty String

Instances

Show a => Show (Pretty a)

Defined in Converter.Internal

Methods

showsPrec :: Int -> Pretty a -> ShowS

show :: Pretty a -> String

showList :: [Pretty a] -> ShowS

class Show a => PrettyPrint a where

A class for prettyprinting data on multiple lines in haddocks.

It's not meant to be used outside of this library.

Methods

pp :: a -> Pretty String

A printing function

It's not meant to be used outside of this library.

Instances

PrettyPrint Tokens

Defined in Converter

Methods

pp :: Tokens -> Pretty String

PrettyPrint Text

Defined in Converter.Internal

Methods

pp :: Text -> Pretty String

PrettyPrint String

Defined in Converter.Internal

Methods

pp :: String -> Pretty String

PrettyPrint (Config User)

Defined in Converter

Methods

pp :: Config User -> Pretty String

escapedHash :: Text

Escaped hash character

hash :: Text

Hash character

dropLen :: Text -> Text -> Text

Drop a prefix of a line with length of a given line

startsWith :: Text -> Text -> Bool

Check if a list starts with a given list

endsWith :: Text -> Text -> Bool

Check if a list ends with a given list

stripEnds :: Text -> Text -> Text -> Text

Drop leading spaces and drop at each end of a Text the number of characters as in the supplied prefix and suffix.

stripSpaces :: Text -> Text

Drop spaces at the start and the end of a Text.

stripList :: Eq a => a -> [a] -> [a]

Strip the given value from the beginning and the end of a list.

indentN :: Int -> Text -> Text

Pad a Text with a given number of spaces

constructorName :: Data a => a -> String

Show the name of a constructor.

stripEmpties :: [Text] -> [Text]

Remove empty lines from the beginning and the end of a list.

dropEmpties :: [Text] -> [Text]

Drop leading empty strings

isEnclosedWith :: Text -> Text -> Text -> Bool

Check if a line without leading spaces is surrounded by the given Texts.

countSpaces :: Text -> Int

Count leading spaces in a Text.

errorEmptyCommentAt :: Show a1 => a1 -> a2

Show error with line number for a token. errorEmptyCommentAt :: Int -> String

prependTexComment :: Text -> Text

Prepend start of a TeX comment ('% ') to a Text.

dropTexComment :: Show a => Text -> a -> Text

Drop start of a TeX comment from a Text.

texComment :: Text

Start a TeX comment.

texCommentSpace :: Text

Start a TeX comment plus a space.

lhsComment :: Text

Start a Literate Haskell comment.

lhsCommentSpace :: Text

Start a Literate Haskell comment plus a space.

lhsHsCode :: Text

Start a Literate Haskell line of Haskell code.

lhsHsCodeSpace :: Text

Start a Literate Haskell line of Haskell code plus a space.

prependLhsComment :: Text -> Text

Prepend start of a TeX comment ('% ') to a Text.

dropLhsComment :: Show a => Text -> a -> Text

Drop start of a TeX comment from a Text.

lhsUnescapeHash :: Text -> Text

Replace "\#" with "#" in a Text prefix.

lhsEscapeHash :: Text -> Text

Replace "#" with "\#" in a Text prefix.

mdCommentOpen :: Text

Open a Markdown comment.

mdCommentClose :: Text

Close a Markdown comment.

mdCommentOpenSpace :: Text

Open a Markdown comment plus a space.

mdCommentCloseSpace :: Text

A space plus close a Markdown comment.

stripMdComment :: Text -> Text

Strip comment markers from a Text.

isMdComment :: Text -> Bool

Check if a line is a Markdown comment.

hsCommentOpen :: Text

Open a Haskell multi-line comment.

hsCommentOpenSpace :: Text

Open a Haskell multi-line comment plus a space.

hsCommentClose :: Text

Close a Haskell multi-line comment.

hsCommentCloseSpace :: Text

A space plus close a Haskell multi-line comment.

stripHsComment :: Text -> Text

Drop leading spaces and drop at each end of a Text the number of characters as in the supplied prefix and suffix.

isHsComment :: Text -> Bool

Check if a line without leading zeros is a multi-line Haskell comment