Client.Commands.Recognizer

This module implements a trie for recognizing valid commands. This allows entered strings to be classified as either a valid command (with an associated value), the prefix of a valid command, or invalid.

Documentation

data Recognizer a

A map from Text values to a values that is capable of yielding more detailed information when looking up keys that are not actually in the map.

Instances

Functor Recognizer

Methods

fmap :: (a -> b) -> Recognizer a -> Recognizer b

(<$) :: a -> Recognizer b -> Recognizer a

Show a => Show (Recognizer a)

Methods

showsPrec :: Int -> Recognizer a -> ShowS

show :: Recognizer a -> String

showList :: [Recognizer a] -> ShowS

Monoid (Recognizer a)

Methods

mempty :: Recognizer a

mappend :: Recognizer a -> Recognizer a -> Recognizer a

mconcat :: [Recognizer a] -> Recognizer a

recognize :: Text -> Recognizer a -> Recognition a

Attempt to recognize a string, yielding a Recognition result.

data Recognition a

Possible results of recognizing text.

Constructors

Exact a

text matched exactly, yielding the given value

Prefix [Text]

text would be recognized if joined to the given suffixes

Invalid

text could not possibly be recognized

Instances

Functor Recognition

Methods

fmap :: (a -> b) -> Recognition a -> Recognition b

(<$) :: a -> Recognition b -> Recognition a

Show a => Show (Recognition a)

Methods

showsPrec :: Int -> Recognition a -> ShowS

show :: Recognition a -> String

showList :: [Recognition a] -> ShowS

fromCommands :: [(Text, a)] -> Recognizer a

Create a Recognizer from an association list. If a key appears twice, the earliest associated value will be used.

addCommand :: Text -> a -> Recognizer a -> Recognizer a

Add a key-value pair to a Recognizer. This will override the value already present if one exists.

keys :: Recognizer a -> [Text]

Compute all strings that will be recognized by a Recognizer.