Text.Madlibs

Main module exporting the relevant functions

Parsers for .mad files

parseTok :: FilePath -> [(Key, RandTok)] -> [Text] -> Text -> Either (ParseError Char Dec) RandTok

Parse text given a context

import qualified Data.Text.IO as TIO

f <- TIO.readFile "template.mad"
parseTok "filename.mad" [] [] f

parseTokM :: [Text] -> Parser (Context RandTok)

Parse text as a token + context (aka a reader monad with all the other functions)

runFile :: [Text] -> FilePath -> IO Text

Generate randomized text from a file conatining a template

parseFile

Arguments

:: [Text]

variables to substitute into the template

-> FilePath

folder

-> FilePath

filepath within folder

-> IO (Either (ParseError Char Dec) RandTok)

parsed RandTok

Parse a template file into the RandTok data type

makeTree :: [Text] -> FilePath -> FilePath -> IO (Either (ParseError Char Dec) RandTok)

Parse a template into a RandTok suitable to be displayed as a tree

Functions and constructs for the RandTok data type

run :: MonadRandom m => RandTok -> m Text

Generate randomized text from a RandTok

runText :: MonadRandom m => [Text] -> String -> Text -> m Text

Run based on text input, with nothing linked.

data RandTok

datatype for a token returning a random string

Constructors

List [(Prob, RandTok)]

Value Text

Instances

Eq RandTok

Methods

(==) :: RandTok -> RandTok -> Bool

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

Show RandTok

Methods

showsPrec :: Int -> RandTok -> ShowS

show :: RandTok -> String

showList :: [RandTok] -> ShowS

Monoid RandTok

Make RandTok a monoid so we can append them together nicely (since they do generate text).

(Value "Hello") <> (List [(0.5," you"), (0.5, " me")])
(List [(0.5,"Hello you"), (0.5, "Hello me")])

Methods

mempty :: RandTok

mappend :: RandTok -> RandTok -> RandTok

mconcat :: [RandTok] -> RandTok

Eq a => Eq (Context a)

Compare inside the state monad using only the underlying objects

Methods

(==) :: Context a -> Context a -> Bool

(/=) :: Context a -> Context a -> Bool

Types associated with the parser

type Context a = State [(Key, RandTok)] a

State monad providing context, i.e. function we've already called before

data SemanticError

Datatype for a semantic error

Constructors

NoReturn

CircularFunctionCalls Text Text

InsufficientArgs Int Int

DoubleDefinition Text

NoContext Text

Instances

Show SemanticError

display a SemanticError nicely with coloration & whatnot

Methods

showsPrec :: Int -> SemanticError -> ShowS

show :: SemanticError -> String

showList :: [SemanticError] -> ShowS

Exception SemanticError

Derived via our show instance;

Methods

toException :: SemanticError -> SomeException

fromException :: SomeException -> Maybe SemanticError

displayException :: SemanticError -> String

Command-line executable

runMadlang :: IO ()

Main program action