Safe Haskell	Safe-Inferred
Language	GHC2021

Text.BBCode.Parser

Synopsis

type Parser a = ParsecT Void Text (Reader [El]) a
runParserEnv :: ParsecT e s (Reader r) a -> r -> s -> Either (ParseErrorBundle s e) a
runParserMaybeEnv :: ParsecT e s (Reader r) a -> r -> s -> Maybe a
parseTestEnv :: Show a => Parser a -> Text -> IO ()
parsers :: Map El [Parser BBCode]
bbcode :: Parser BBCode
bbcode1 :: Parser BBCode
hr :: Parser BBCode
br :: Parser BBCode
clear :: Parser BBCode
bold :: Parser BBCode
italic :: Parser BBCode
underline :: Parser BBCode
strikethrough :: Parser BBCode
indent :: Parser BBCode
nfo :: Parser BBCode
oneline :: Parser BBCode
everythingInElement :: El -> Parser BBCode
code :: Parser BBCode
preformatted :: Parser BBCode
box :: Parser BBCode
boxAlign :: Parser BBCode
image :: Parser BBCode
imageAlign :: Parser BBCode
quote :: Parser BBCode
quoteNamed :: Parser BBCode
spoiler :: Parser BBCode
spoilerNamed :: Parser BBCode
listElement :: Parser BBCode
list :: Parser BBCode
listFlavor :: Parser BBCode
colorName :: Parser BBCode
colorHex :: Parser BBCode
url :: Parser BBCode
size :: Parser BBCode
align :: Parser BBCode
font :: Parser BBCode
plaintext :: Parser BBCode

Documentation

type Parser a = ParsecT Void Text (Reader [El]) a Source #

Parser with reader transformer inside.

Reader environment contains current context for element.

It is used for oneline because "[oneline][oneline][/oneline][/oneline]" should produce error. Same with nfo

Also used by plaintext to end parsing on closing element of current environment.

>>> parseTestEnv bbcode "[i]Bread[/b][/i]"
ElSimple Italic (ElText "Bread[/b]")

Notice it parsed "[/b]". plaintext finishes parsing only on closing element that matches last parsed opening

runParserEnv :: ParsecT e s (Reader r) a -> r -> s -> Either (ParseErrorBundle s e) a Source #

runParser specialized for Parser

runParserMaybeEnv :: ParsecT e s (Reader r) a -> r -> s -> Maybe a Source #

parseMaybe specialized for Parser

parseTestEnv :: Show a => Parser a -> Text -> IO () Source #

parseTest specialized for Parser. Passes empty list to inner reader monad

parsers :: Map El [Parser BBCode] Source #

All parsers used by bbcode and bbcode1

Keys are element names and values are associated element parsers.

Values are lists because some elements have optional element. That means they are two separate parsers, e.g. Box element parsers are box (simple element) and boxAlign (element with parameter)

bbcode :: Parser BBCode Source #

Parse zero or more BBCode elements Doesn't necessarily return value wrapped in ElDocument, it returns (mempty :: BBCode) if it parses no elements, or just element if parses just one element. Otherwise it is ElDocument

bbcode1 :: Parser BBCode Source #

Similar to bbcode but parses one or more elements

hr :: Parser BBCode Source #

br :: Parser BBCode Source #

clear :: Parser BBCode Source #

bold :: Parser BBCode Source #

italic :: Parser BBCode Source #

underline :: Parser BBCode Source #

strikethrough :: Parser BBCode Source #

indent :: Parser BBCode Source #

nfo :: Parser BBCode Source #

oneline :: Parser BBCode Source #