CalamityCommands.Parser

Something that can parse user input

Documentation

class Typeable a => ParameterParser (a :: Type) c r where

A typeclass for things that can be parsed as parameters to commands.

Any type that is an instance of ParamerParser can be used in the type level parameter ps of command, buildCommand, etc.

Minimal complete definition

parameterDescription, parse

Associated Types

type ParserResult a

type ParserResult a = a

Methods

parameterInfo :: ParameterInfo

default parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult a)

Instances

ParameterParser Float c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult Float

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult Float)

ParameterParser Int c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult Int

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult Int)

ParameterParser Integer c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult Integer

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult Integer)

ParameterParser Natural c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult Natural

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult Natural)

ParameterParser Word c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult Word

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult Word)

ParameterParser () c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult ()

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult ())

ParameterParser Text c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult Text

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text0

parse :: Sem (ParserEffs c r) (ParserResult Text)

ParameterParser Text c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult Text

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult Text)

ParameterParser a c r => ParameterParser [a] c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult [a]

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult [a])

ParameterParser a c r => ParameterParser (Maybe a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (Maybe a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (Maybe a))

(ParameterParser a c r, Typeable a) => ParameterParser (NonEmpty a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (NonEmpty a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (NonEmpty a))

(Semigroup (ParserResult a), ParameterParser a c r) => ParameterParser (KleenePlusConcat a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleenePlusConcat a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleenePlusConcat a))

ParameterParser (KleenePlusConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text0

parse :: Sem (ParserEffs c r) (ParserResult (KleenePlusConcat Text))

ParameterParser (KleenePlusConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleenePlusConcat Text))

(Monoid (ParserResult a), ParameterParser a c r) => ParameterParser (KleeneStarConcat a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleeneStarConcat a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleeneStarConcat a))

ParameterParser (KleeneStarConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text0

parse :: Sem (ParserEffs c r) (ParserResult (KleeneStarConcat Text))

ParameterParser (KleeneStarConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleeneStarConcat Text))

(ParameterParser a c r, ParameterParser b c r) => ParameterParser (Either a b) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (Either a b)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (Either a b))

(ParameterParser a c r, ParameterParser b c r) => ParameterParser (a, b) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (a, b)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (a, b))

(KnownSymbol s, ParameterParser a c r) => ParameterParser (Named s a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (Named s a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (Named s a))

data Named (s :: Symbol) (a :: Type)

A named parameter, used to attach the name s to a type in the command's help output

Instances

(KnownSymbol s, ParameterParser a c r) => ParameterParser (Named s a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (Named s a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (Named s a))

type ParserResult (Named s a)

Defined in CalamityCommands.Parser

type ParserResult (Named s a) = ParserResult a

data KleeneStarConcat (a :: Type)

A parser that consumes zero or more of a then concatenates them together.

KleeneStarConcat Text therefore consumes all remaining input.

Instances

(Monoid (ParserResult a), ParameterParser a c r) => ParameterParser (KleeneStarConcat a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleeneStarConcat a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleeneStarConcat a))

ParameterParser (KleeneStarConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text0

parse :: Sem (ParserEffs c r) (ParserResult (KleeneStarConcat Text))

ParameterParser (KleeneStarConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleeneStarConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleeneStarConcat Text))

type ParserResult (KleeneStarConcat a)

Defined in CalamityCommands.Parser

type ParserResult (KleeneStarConcat a) = ParserResult a

type ParserResult (KleeneStarConcat Text)

Defined in CalamityCommands.Parser

type ParserResult (KleeneStarConcat Text) = ParserResult Text

type ParserResult (KleeneStarConcat Text)

Defined in CalamityCommands.Parser

type ParserResult (KleeneStarConcat Text) = ParserResult Text

data KleenePlusConcat (a :: Type)

A parser that consumes one or more of a then concatenates them together.

KleenePlusConcat Text therefore consumes all remaining input.

Instances

(Semigroup (ParserResult a), ParameterParser a c r) => ParameterParser (KleenePlusConcat a) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleenePlusConcat a)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleenePlusConcat a))

ParameterParser (KleenePlusConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text0

parse :: Sem (ParserEffs c r) (ParserResult (KleenePlusConcat Text))

ParameterParser (KleenePlusConcat Text) c r

Defined in CalamityCommands.Parser

Associated Types

type ParserResult (KleenePlusConcat Text)

Methods

parameterInfo :: ParameterInfo

parameterDescription :: Text

parse :: Sem (ParserEffs c r) (ParserResult (KleenePlusConcat Text))

type ParserResult (KleenePlusConcat a)

Defined in CalamityCommands.Parser

type ParserResult (KleenePlusConcat a) = ParserResult a

type ParserResult (KleenePlusConcat Text)

Defined in CalamityCommands.Parser

type ParserResult (KleenePlusConcat Text) = ParserResult Text

type ParserResult (KleenePlusConcat Text)

Defined in CalamityCommands.Parser

type ParserResult (KleenePlusConcat Text) = ParserResult Text

Parameter parsing utilities

type ParserEffs c r = State ParserState ': (Error (Text, Text) ': (Reader c ': r))

runCommandParser :: c -> Text -> Sem (ParserEffs c r) a -> Sem r (Either (Text, Text) a)

Run a command parser, ctx is the context, t is the text input

data ParserState

The current state of the parser, used so that the entire remaining input is available.

This is used instead of just concatenating parsers to allow for more flexibility, for example, this could be used to construct flag-style parsers that parse a parameter from anywhere in the input message.

Constructors

ParserState

Fields

• off :: Int

  The current offset, or where the next parser should start parsing at

• msg :: Text

  The input message ot parse

Instances

Show ParserState

Defined in CalamityCommands.Parser

Methods

showsPrec :: Int -> ParserState -> ShowS

show :: ParserState -> String

showList :: [ParserState] -> ShowS

Generic ParserState

Defined in CalamityCommands.Parser

Associated Types

type Rep ParserState :: Type -> Type

Methods

from :: ParserState -> Rep ParserState x

to :: Rep ParserState x -> ParserState

type Rep ParserState

Defined in CalamityCommands.Parser

type Rep ParserState = D1 ('MetaData "ParserState" "CalamityCommands.Parser" "calamity-commands-0.1.3.0-inplace" 'False) (C1 ('MetaCons "ParserState" 'PrefixI 'True) (S1 ('MetaSel ('Just "off") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "msg") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

parseMP

Arguments

:: Text

The name of the parser

-> ParsecT SpannedError Text (Sem (Reader c ': r)) a

The megaparsec parser

-> Sem (ParserEffs c r) a

Parse a paremeter using a MegaParsec parser.

On failure this constructs a nice-looking megaparsec error for the failed parameter.

data SpannedError

Constructors

SpannedError Text !Int !Int

Instances

Eq SpannedError

Defined in CalamityCommands.Parser

Methods

(==) :: SpannedError -> SpannedError -> Bool

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

Ord SpannedError

Defined in CalamityCommands.Parser

Methods

compare :: SpannedError -> SpannedError -> Ordering

(<) :: SpannedError -> SpannedError -> Bool

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

(>) :: SpannedError -> SpannedError -> Bool

(>=) :: SpannedError -> SpannedError -> Bool

max :: SpannedError -> SpannedError -> SpannedError

min :: SpannedError -> SpannedError -> SpannedError

Show SpannedError

Defined in CalamityCommands.Parser

Methods

showsPrec :: Int -> SpannedError -> ShowS

show :: SpannedError -> String

showList :: [SpannedError] -> ShowS

ShowErrorComponent SpannedError

Defined in CalamityCommands.Parser

Methods

showErrorComponent :: SpannedError -> String

errorComponentLen :: SpannedError -> Int