Text.BBCode

Usually you only need to import that module, which reexports most of the functionality.

If you need lens definitions for types, import Text.BBCode.Lens

If you need interface to parsing, see Text.BBCode.Parser

Builder

Functions for constructing AST in a more elegant way than directly using type constructors.

This wrappers are usually no more than partially applied data constructors. An exception to that is list and listFlavor functions, which adds listEl before each element. This is implementation detail and shouldn't bother you unless you work with AST directly

Void elements

Void elements' data constructors only specify the type of the element(e.g. HR, Clear, ...), such element don't have any content unlike other types of elements.

see ElVoid

nl :: BBCode

Newline

nl == 'text' "\n"

hr :: BBCode

Horizontal line

hr == 'ElVoid' 'HR'

br :: BBCode

Line break

br == 'ElVoid' 'BR'

clear :: BBCode

clear == 'ElVoid' 'Clear'

listEl :: BBCode

Notice it is not a function, but a value.

listEl represents "[*]"

listEl == 'ElVoid' 'ListElement'

Simple elements

Simple elements have contents, usually BBCode. text is not actually a simple element builder and included here just for convenience

see ElSimple

text :: Text -> BBCode

text == 'ElText'

doc :: [BBCode] -> BBCode

Wrap [BBCode] in ElDocument

docNL :: [BBCode] -> BBCode

intersperse list with nl and wrap it in ElDocument

bold :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

italic :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

underline :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

strikethrough :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

indent :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

nfo :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

oneline :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

code :: Text -> BBCode

Code element contains plain text

pre :: Text -> BBCode

Preformatted element contains plain text

box :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

image :: Text -> BBCode

Takes image URL

quote :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

spoiler :: BBCode -> BBCode

bold, italic, underline, and all the rest functions BBCode -> BBCode work the same way by wrapping argument in another element.

list :: [BBCode] -> BBCode

Each element of list is prepended with listElement, meaning you can't create list with contents but without elements

>>> list [bold "10", italic "15"]
ElSimple List (ElDocument [ElVoid ListElement,ElSimple Bold (ElText "10"),ElVoid ListElement,ElSimple Italic (ElText "15")])

Elements with an argument

Apart from having contents, following elements also have argument. It can indicate position, color, or something else.

see ElArg

boxAlign :: BoxPosition -> BBCode -> BBCode

Like box but with alignment argument

imageAlign :: ImagePosition -> Text -> BBCode

Like image but with alignment argument

quoteNamed :: Text -> BBCode -> BBCode

Named quote

spoilerNamed :: Text -> BBCode -> BBCode

Named spoiler

listFlavor :: Foldable t => ListFlavor -> t BBCode -> BBCode

Ordered list

>>> 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")])

color :: Text -> BBCode -> BBCode

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

url :: Text -> BBCode -> BBCode

Create a hyperlink

first argument is expected to be valid URL

size :: Natural -> BBCode -> BBCode

Change font size of inner bbcode

arg ∈ [10, 29] and arg is natural

align :: AlignPosition -> BBCode -> BBCode

font :: Text -> BBCode -> BBCode

Change font of inner BBCode

argument should be a valid font name

Types

data BBCode where

BBCode AST

Constructors

ElVoid :: El -> BBCode

Element that has neither closing part nor arguments

ElVoid HR represents "[hr]"

ElSimple :: El -> BBCode -> BBCode

Element that has closing part but no arguments

ElSimple Bold (ElText "abc") represents "[b]abc[/b]"

ElArg :: El -> Text -> BBCode -> BBCode

Element that has closing part and exactly one argument

ElArg Color "red" (ElText "I am red") represents "[color=red]I am red[/color]"

ElText :: Text -> BBCode

Plain text

ElText "I am text" represents "I am text"@

ElDocument :: [BBCode] -> BBCode

Just a list of BBCode elements, just as type signature says.

ElDocument [ElSimple Bold (ElText "Bold not bald"), ElText "legit text"] represents "[b]Bold not bald[/b]legit text"

Instances

IsString BBCode

Allows easier BBCode construction

>>> ElSimple Bold "I am bold"
ElSimple Bold (ElText "I am bold")

Recall that ElSimple takes El and BBCode, but not Text

Defined in Text.BBCode.Internal.Types

Methods

fromString :: String -> BBCode

Monoid BBCode

Identity is defined as zero-width Text

>>> mempty :: BBCode
ElText ""

Defined in Text.BBCode.Internal.Types

Methods

mempty :: BBCode

mappend :: BBCode -> BBCode -> BBCode

mconcat :: [BBCode] -> BBCode

Semigroup BBCode

Defined in Text.BBCode.Internal.Types

Methods

(<>) :: BBCode -> BBCode -> BBCode

sconcat :: NonEmpty BBCode -> BBCode

stimes :: Integral b => b -> BBCode -> BBCode

Show BBCode

Don't use it to render BBCode!

Defined in Text.BBCode.Internal.Types

Methods

showsPrec :: Int -> BBCode -> ShowS

show :: BBCode -> String

showList :: [BBCode] -> ShowS

Eq BBCode

Defined in Text.BBCode.Internal.Types

Methods

(==) :: BBCode -> BBCode -> Bool

(/=) :: BBCode -> BBCode -> Bool

data El

Type of an element. BBCode declares three constructors for elements: ElVoid, ElSimple, ElArg. But El 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 BBCode constuctors and El values, that means you can create ElSimple HR (ElText "smth") but that would make no sense. pretty would emit a runtime error if you try to pass such value.

Constructors

HR

void element

BR

void element

Clear

void element

ListElement

void element

Bold

simple element

Italic

simple element

Underline

simple element

Strikethrough

simple element

Indent

simple element

NFO

simple element

Oneline

simple element

Code

simple element

Preformatted

simple element

Box

element with optional argument

Image

element with optional argument

Quote

element with optional argument

Spoiler

element with optional argument

List

element with optional argument

Color

element with one argument

URL

element with one argument

Size

element with one argument

Align

element with one argument

Font

element with one argument

Instances

Bounded El

Addition to Enum instance

Defined in Text.BBCode.Internal.Types

Methods

minBound :: El

maxBound :: El

Enum El

Allows internal module to quickly list elements of different categories (Void, Simple, Optional, One)

Defined in Text.BBCode.Internal.Types

Methods

succ :: El -> El

pred :: El -> El

toEnum :: Int -> El

fromEnum :: El -> Int

enumFrom :: El -> [El]

enumFromThen :: El -> El -> [El]

enumFromTo :: El -> El -> [El]

enumFromThenTo :: El -> El -> El -> [El]

Show El

Defined in Text.BBCode.Internal.Types

Methods

showsPrec :: Int -> El -> ShowS

show :: El -> String

showList :: [El] -> ShowS

Eq El

Defined in Text.BBCode.Internal.Types

Methods

(==) :: El -> El -> Bool

(/=) :: El -> El -> Bool

Ord El

Allows having Map with key type El (used in Parser)

Defined in Text.BBCode.Internal.Types

Methods

compare :: El -> El -> Ordering

(<) :: El -> El -> Bool

(<=) :: El -> El -> Bool

(>) :: El -> El -> Bool

(>=) :: El -> El -> Bool

max :: El -> El -> El

min :: El -> El -> El

class IsArgument a where

Used for building BBCode safely. Instead of passing Text to builder functions, you pass values of types that implement IsArgument. Then toArgument is used to convert that value to Text.

Methods

toArgument :: a -> Text

Instances

IsArgument AlignPosition

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: AlignPosition -> Text

IsArgument BoxPosition

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: BoxPosition -> Text

IsArgument ImagePosition

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: ImagePosition -> Text

IsArgument ListFlavor

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: ListFlavor -> Text

data ListFlavor where

Argument to listFlavor

Constructors

Roman :: ListFlavor

Numeric 1, 2, 3,..

ArabicUpper :: ListFlavor

Arabic I, II, III,..

ArabicLower :: ListFlavor

Arabic i, ii, iii,..

LatinUpper :: ListFlavor

Alphabetical A, B, C,..

LatinLower :: ListFlavor

Alphabetical a, b, c,..

Instances

Show ListFlavor

Defined in Text.BBCode.Internal.Types

Methods

showsPrec :: Int -> ListFlavor -> ShowS

show :: ListFlavor -> String

showList :: [ListFlavor] -> ShowS

IsArgument ListFlavor

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: ListFlavor -> Text

Eq ListFlavor

Defined in Text.BBCode.Internal.Types

Methods

(==) :: ListFlavor -> ListFlavor -> Bool

(/=) :: ListFlavor -> ListFlavor -> Bool

Alignment and position

There are three different position types because align, image, boxAlign all have different sets of valid positions. You can notice that all these types have different number of valid positions.

data AlignPosition where

Argument to align

Constructors

AlignLeft :: AlignPosition

AlignRight :: AlignPosition

AlignCenter :: AlignPosition

AlignJustify :: AlignPosition

Instances

Show AlignPosition

Defined in Text.BBCode.Internal.Types

Methods

showsPrec :: Int -> AlignPosition -> ShowS

show :: AlignPosition -> String

showList :: [AlignPosition] -> ShowS

IsArgument AlignPosition

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: AlignPosition -> Text

Eq AlignPosition

Defined in Text.BBCode.Internal.Types

Methods

(==) :: AlignPosition -> AlignPosition -> Bool

(/=) :: AlignPosition -> AlignPosition -> Bool

data ImagePosition where

Argument to imageAlign

Constructors

ImageLeft :: ImagePosition

ImageRight :: ImagePosition

Instances

Show ImagePosition

Defined in Text.BBCode.Internal.Types

Methods

showsPrec :: Int -> ImagePosition -> ShowS

show :: ImagePosition -> String

showList :: [ImagePosition] -> ShowS

IsArgument ImagePosition

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: ImagePosition -> Text

Eq ImagePosition

Defined in Text.BBCode.Internal.Types

Methods

(==) :: ImagePosition -> ImagePosition -> Bool

(/=) :: ImagePosition -> ImagePosition -> Bool

data BoxPosition where

Argument to boxAlign

Constructors

BoxLeft :: BoxPosition

BoxCenter :: BoxPosition

BoxRight :: BoxPosition

Instances

Show BoxPosition

Defined in Text.BBCode.Internal.Types

Methods

showsPrec :: Int -> BoxPosition -> ShowS

show :: BoxPosition -> String

showList :: [BoxPosition] -> ShowS

IsArgument BoxPosition

Defined in Text.BBCode.Internal.Types

Methods

toArgument :: BoxPosition -> Text

Eq BoxPosition

Defined in Text.BBCode.Internal.Types

Methods

(==) :: BoxPosition -> BoxPosition -> Bool

(/=) :: BoxPosition -> BoxPosition -> Bool

Pretty-printer

pretty :: BBCode -> Text

Serialize BBCode AST

Parsing pretty x should give you x, 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

>>> pretty $ ElSimple HR "abc"
Prelude.undefined

Parser

A small part of Text.BBCode.Parser. Dedicated module has an interface to parsing specific elements as well as different parser runners.

These should be sufficient for parsing whole document.

bbcode :: Parser BBCode

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

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

parseMaybe specialized for Parser