-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Library for parsing, constructing, and printing BBCode
--   
--   This is a set of utilities for: Parsing BBCode into AST(providing
--   related types), Building BBCode AST with simple DSL based on Semigroup
--   and functions. Currently this library can only be used with a very
--   specific BBCode dialect used on a resource I won't name.
@package bbcode
@version 0.1.0.2


-- | Usually you only need to import that module, which reexports most of
--   the functionality.
--   
--   If you need <tt>lens</tt> definitions for types, import
--   <a>Text.BBCode.Lens</a>
--   
--   If you need interface to parsing, see <a>Text.BBCode.Parser</a>
module Text.BBCode

-- | Newline
--   
--   <pre>
--   nl == 'text' "\n"
--   </pre>
nl :: BBCode

-- | Horizontal line
--   
--   <pre>
--   hr == 'ElVoid' 'HR'
--   </pre>
hr :: BBCode

-- | Line break
--   
--   <pre>
--   br == 'ElVoid' 'BR'
--   </pre>
br :: BBCode

-- | <pre>
--   clear == 'ElVoid' 'Clear'
--   </pre>
clear :: BBCode

-- | Notice it is not a function, but a value.
--   
--   <tt>listEl</tt> represents "[*]"
--   
--   <pre>
--   listEl == 'ElVoid' 'ListElement'
--   </pre>
listEl :: BBCode

-- | <pre>
--   text == 'ElText'
--   </pre>
text :: Text -> BBCode

-- | Wrap <tt>[<a>BBCode</a>]</tt> in <a>ElDocument</a>
doc :: [BBCode] -> BBCode

-- | <a>intersperse</a> list with <a>nl</a> and wrap it in
--   <a>ElDocument</a>
docNL :: [BBCode] -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
bold :: BBCode -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
italic :: BBCode -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
underline :: BBCode -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
strikethrough :: BBCode -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
indent :: BBCode -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
nfo :: BBCode -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
oneline :: BBCode -> BBCode

-- | <a>Code</a> element contains plain text
code :: Text -> BBCode

-- | <a>Preformatted</a> element contains plain text
pre :: Text -> BBCode

-- | <a>bold</a>, <a>italic</a>, <a>underline</a>, and all the rest
--   functions <tt><a>BBCode</a> -&gt; <a>BBCode</a></tt> work the same way
--   by wrapping argument in another element.
box :: BBCode -> BBCode

-- | Takes image URL
image :: Text -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
quote :: BBCode -> BBCode

-- | bold, italic, underline, and all the rest functions <tt><a>BBCode</a>
--   -&gt; <a>BBCode</a></tt> work the same way by wrapping argument in
--   another element.
spoiler :: BBCode -> BBCode

-- | Each element of list is prepended with <tt>listElement</tt>, meaning
--   you can't create list with contents but without elements
--   
--   <pre>
--   &gt;&gt;&gt; list [bold "10", italic "15"]
--   ElSimple List (ElDocument [ElVoid ListElement,ElSimple Bold (ElText "10"),ElVoid ListElement,ElSimple Italic (ElText "15")])
--   </pre>
list :: [BBCode] -> BBCode

-- | Like <a>box</a> but with alignment argument
boxAlign :: BoxPosition -> BBCode -> BBCode

-- | Like <a>image</a> but with alignment argument
imageAlign :: ImagePosition -> Text -> BBCode

-- | Named quote
quoteNamed :: Text -> BBCode -> BBCode

-- | Named spoiler
spoilerNamed :: Text -> BBCode -> BBCode

-- | Ordered list
--   
--   <pre>
--   &gt;&gt;&gt; listFlavor LatinUpper [bold "I am bald", boxAlign BoxRight "get boxxxed"]
--   ElArg List "A" (ElDocument [ElVoid ListElement,ElSimple Bold (ElText "I am bald"),ElVoid ListElement,ElArg Box "right" (ElText "get boxxxed")])
--   </pre>
listFlavor :: Foldable t => ListFlavor -> t BBCode -> BBCode

-- | Change color of inner BBCode First argument is either color name (e.g.
--   blue) or hex color(e.g. #333 or #151515)
color :: Text -> BBCode -> BBCode

-- | Create a hyperlink
--   
--   first argument is expected to be valid URL
url :: Text -> BBCode -> BBCode

-- | Change font size of inner bbcode
--   
--   <tt>arg</tt> ∈ [10, 29] and <tt>arg</tt> is natural
size :: Natural -> BBCode -> BBCode
align :: AlignPosition -> BBCode -> BBCode

-- | Change font of inner BBCode
--   
--   argument should be a valid font name
font :: Text -> BBCode -> BBCode

-- | BBCode AST
data BBCode

-- | Element that has neither closing part nor arguments
--   
--   <tt><a>ElVoid</a> <a>HR</a></tt> represents "[hr]"
[ElVoid] :: El -> BBCode

-- | Element that has closing part but no arguments
--   
--   <tt><a>ElSimple</a> <a>Bold</a> (<a>ElText</a> "abc")</tt> represents
--   <tt>"[b]abc[/b]"</tt>
[ElSimple] :: El -> BBCode -> BBCode

-- | Element that has closing part and exactly one argument
--   
--   <tt><a>ElArg</a> <a>Color</a> "red" (<a>ElText</a> "I am red")</tt>
--   represents <tt>"[color=red]I am red[/color]"</tt>
[ElArg] :: El -> Text -> BBCode -> BBCode

-- | Plain text
--   
--   <tt><a>ElText</a> "I am text" represents </tt>"I am text"@
[ElText] :: Text -> BBCode

-- | Just a list of BBCode elements, just as type signature says.
--   
--   <tt><a>ElDocument</a> [<a>ElSimple</a> <a>Bold</a> (<a>ElText</a>
--   "Bold not bald"), <a>ElText</a> "legit text"]</tt> represents
--   <tt>"[b]Bold not bald[/b]legit text"</tt>
[ElDocument] :: [BBCode] -> BBCode

-- | Type of an element. <a>BBCode</a> declares three constructors for
--   elements: <a>ElVoid</a>, <a>ElSimple</a>, <a>ElArg</a>. But <a>El</a>
--   can be split into four cateogories: 1) void elements, 2) simple
--   elements, 3) elements with optional argument, 4) element with one
--   argument
--   
--   There is no enforcement of combining <a>BBCode</a> constuctors and
--   <a>El</a> values, that means you can create <tt>ElSimple HR (ElText
--   "smth")</tt> but that would make no sense. <a>pretty</a> would emit a
--   runtime error if you try to pass such value.
data El

-- | void element
HR :: El

-- | void element
BR :: El

-- | void element
Clear :: El

-- | void element
ListElement :: El

-- | simple element
Bold :: El

-- | simple element
Italic :: El

-- | simple element
Underline :: El

-- | simple element
Strikethrough :: El

-- | simple element
Indent :: El

-- | simple element
NFO :: El

-- | simple element
Oneline :: El

-- | simple element
Code :: El

-- | simple element
Preformatted :: El

-- | element with optional argument
Box :: El

-- | element with optional argument
Image :: El

-- | element with optional argument
Quote :: El

-- | element with optional argument
Spoiler :: El

-- | element with optional argument
List :: El

-- | element with one argument
Color :: El

-- | element with one argument
URL :: El

-- | element with one argument
Size :: El

-- | element with one argument
Align :: El

-- | element with one argument
Font :: El

-- | Used for building BBCode safely. Instead of passing <a>Text</a> to
--   builder functions, you pass values of types that implement
--   <a>IsArgument</a>. Then <a>toArgument</a> is used to convert that
--   value to Text.
class IsArgument a
toArgument :: IsArgument a => a -> Text

-- | Argument to <a>listFlavor</a>
data ListFlavor

-- | Numeric 1, 2, 3,..
[Roman] :: ListFlavor

-- | Arabic I, II, III,..
[ArabicUpper] :: ListFlavor

-- | Arabic i, ii, iii,..
[ArabicLower] :: ListFlavor

-- | Alphabetical A, B, C,..
[LatinUpper] :: ListFlavor

-- | Alphabetical a, b, c,..
[LatinLower] :: ListFlavor

-- | Argument to <a>align</a>
data AlignPosition
[AlignLeft] :: AlignPosition
[AlignRight] :: AlignPosition
[AlignCenter] :: AlignPosition
[AlignJustify] :: AlignPosition

-- | Argument to <a>imageAlign</a>
data ImagePosition
[ImageLeft] :: ImagePosition
[ImageRight] :: ImagePosition

-- | Argument to <a>boxAlign</a>
data BoxPosition
[BoxLeft] :: BoxPosition
[BoxCenter] :: BoxPosition
[BoxRight] :: BoxPosition

-- | Serialize BBCode AST
--   
--   Parsing <tt><a>pretty</a> x</tt> should give you <tt>x</tt>, but
--   currently that rarely works mostly because of whitespaces. Whitespaces
--   are appended when prettifying, but not stripped when parsing. This
--   leads to redundant whitespaces in parsed AST
--   
--   Can cause error at runtime if unrepresentable element is passed
--   
--   <pre>
--   &gt;&gt;&gt; pretty $ ElSimple HR "abc"
--   Prelude.undefined
--   </pre>
pretty :: BBCode -> Text

-- | Parse zero or more BBCode elements Doesn't necessarily return value
--   wrapped in <a>ElDocument</a>, it returns <tt>(<a>mempty</a> ::
--   BBCode)</tt> if it parses no elements, or just element if parses just
--   one element. Otherwise it is <a>ElDocument</a>
bbcode :: Parser BBCode

-- | <a>parseMaybe</a> specialized for <a>Parser</a>
runParserMaybeEnv :: ParsecT e s (Reader r) a -> r -> s -> Maybe a

module Text.BBCode.Lens
_ElArg :: Prism' BBCode (El, Text, BBCode)
_ElDocument :: Prism' BBCode [BBCode]
_ElSimple :: Prism' BBCode (El, BBCode)
_ElText :: Prism' BBCode Text
_ElVoid :: Prism' BBCode El
_AlignCenter :: Prism' AlignPosition ()
_AlignJustify :: Prism' AlignPosition ()
_AlignLeft :: Prism' AlignPosition ()
_AlignRight :: Prism' AlignPosition ()
_ArabicLower :: Prism' ListFlavor ()
_ArabicUpper :: Prism' ListFlavor ()
_LatinLower :: Prism' ListFlavor ()
_LatinUpper :: Prism' ListFlavor ()
_Roman :: Prism' ListFlavor ()
_ImageLeft :: Prism' ImagePosition ()
_ImageRight :: Prism' ImagePosition ()
_Align :: Prism' El ()
_BR :: Prism' El ()
_Bold :: Prism' El ()
_Box :: Prism' El ()
_Clear :: Prism' El ()
_Code :: Prism' El ()
_Color :: Prism' El ()
_Font :: Prism' El ()
_HR :: Prism' El ()
_Image :: Prism' El ()
_Indent :: Prism' El ()
_Italic :: Prism' El ()
_List :: Prism' El ()
_ListElement :: Prism' El ()
_NFO :: Prism' El ()
_Oneline :: Prism' El ()
_Preformatted :: Prism' El ()
_Quote :: Prism' El ()
_Size :: Prism' El ()
_Spoiler :: Prism' El ()
_Strikethrough :: Prism' El ()
_URL :: Prism' El ()
_Underline :: Prism' El ()

module Text.BBCode.Parser

-- | Parser with reader transformer inside.
--   
--   Reader environment contains current context for element.
--   
--   It is used for <a>oneline</a> because
--   <tt>"[oneline][oneline][/oneline][/oneline]"</tt> should produce
--   error. Same with <a>nfo</a>
--   
--   Also used by <a>plaintext</a> to end parsing on closing element of
--   current environment.
--   
--   <pre>
--   &gt;&gt;&gt; parseTestEnv bbcode "[i]Bread[/b][/i]"
--   ElSimple Italic (ElText "Bread[/b]")
--   </pre>
--   
--   Notice it parsed <tt>"[/b]"</tt>. <a>plaintext</a> finishes parsing
--   only on closing element that matches last parsed opening
type Parser a = ParsecT Void Text (Reader [El]) a

-- | <a>runParser</a> specialized for <a>Parser</a>
runParserEnv :: ParsecT e s (Reader r) a -> r -> s -> Either (ParseErrorBundle s e) a

-- | <a>parseMaybe</a> specialized for <a>Parser</a>
runParserMaybeEnv :: ParsecT e s (Reader r) a -> r -> s -> Maybe a

-- | <a>parseTest</a> specialized for <a>Parser</a>. Passes empty list to
--   inner reader monad
parseTestEnv :: Show a => Parser a -> Text -> IO ()

-- | All parsers used by <a>bbcode</a> and <a>bbcode1</a>
--   
--   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. <a>Box</a> element parsers
--   are <a>box</a> (simple element) and <a>boxAlign</a> (element with
--   parameter)
parsers :: Map El [Parser BBCode]

-- | Parse zero or more BBCode elements Doesn't necessarily return value
--   wrapped in <a>ElDocument</a>, it returns <tt>(<a>mempty</a> ::
--   BBCode)</tt> if it parses no elements, or just element if parses just
--   one element. Otherwise it is <a>ElDocument</a>
bbcode :: Parser BBCode

-- | Similar to <a>bbcode</a> but parses one or more elements
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