Ribosome.Host.Handler.Command

Compute the command options and arguments based on handler function parameters.

Documentation

data ArgCount

Represents the value for the command option -nargs.

Constructors

Zero

-nargs=0

MinZero

-nargs=*

MinOne

-nargs=+

Instances

Show ArgCount

Defined in Ribosome.Host.Handler.Command

Methods

showsPrec :: Int -> ArgCount -> ShowS

show :: ArgCount -> String

showList :: [ArgCount] -> ShowS

Eq ArgCount

Defined in Ribosome.Host.Handler.Command

Methods

(==) :: ArgCount -> ArgCount -> Bool

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

data OptionState

Determines how different special command handler parameter types may interact.

Constructors

OptionState

Fields

• allowed :: Bool

  Are special option parameters allowed at this position?

• minArgs :: ArgCount

  The minimum number of arguments that are expected

• argsConsumed :: Maybe Type

  Have all arguments been consumed, by types like ArgList?

class SpecialParam (state :: OptionState) (a :: Type) where

Determine the command options and arguments that need to be specified when registering a command, for a special command option parameter.

See Command params for the list of supported special types.

Minimal complete definition

Nothing

Associated Types

type TransSpecial state a :: OptionState

type TransSpecial s _ = s

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

Instances

BeforeRegular al Bang => SpecialParam ('OptionState al c ac) Bang

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al c ac) Bang :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

BeforeRegular al Bar => SpecialParam ('OptionState al c ac) Bar

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al c ac) Bar :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

BeforeRegular al CommandMods => SpecialParam ('OptionState al c ac) CommandMods

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al c ac) CommandMods :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

BeforeRegular al CommandRegister => SpecialParam ('OptionState al c ac) CommandRegister

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al c ac) CommandRegister :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

SpecialParam ('OptionState al count ('Nothing :: Maybe Type)) Args

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count 'Nothing) Args :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

SpecialParam ('OptionState al count ac) ArgList

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count ac) ArgList :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

(BeforeRegular al (Range rs), RangeStyleOpt rs) => SpecialParam ('OptionState al c ac) (Range rs)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al c ac) (Range rs) :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

SpecialParam ('OptionState al count ('Nothing :: Maybe Type)) (Options a)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count 'Nothing) (Options a) :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

SpecialParam ('OptionState al count ac) (JsonArgs a)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransSpecial ('OptionState al count ac) (JsonArgs a) :: OptionState

Methods

specialOpt :: Map Text Object

specialArg :: Maybe Text

type family BeforeRegular (allowed :: Bool) (a :: Type) :: Constraint where ...

Emit a compile error if a special command option type is used as a handler parameter after a regular, value parameter.

The parameter allowed is set to False when the first non-option parameter is encountered.

Equations

BeforeRegular 'False a = TypeError (("Command option type " <> a) <> " may not come after non-option") ~ ()

BeforeRegular 'True _ = ()

class RegularParam (state :: OptionState) (isMaybe :: Bool) a

Determines whether a regular, value parameter is allowed (it isn't after types like ArgList that consume all remaining arguments), and increases the minimum argument count if the parameter isn't Maybe.

Associated Types

type TransRegular state isMaybe a :: OptionState

Instances

RegularParam ('OptionState al count ('Just consumer)) m (a :: k)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransRegular ('OptionState al count ('Just consumer)) m a :: OptionState

RegularParam ('OptionState al count ('Nothing :: Maybe Type)) 'False (a :: k)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransRegular ('OptionState al count 'Nothing) 'False a :: OptionState

RegularParam ('OptionState al count ('Nothing :: Maybe Type)) 'True (Maybe a :: Type)

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransRegular ('OptionState al count 'Nothing) 'True (Maybe a) :: OptionState

class CommandParam (special :: Bool) (state :: OptionState) (a :: Type) where

Determine the command option and parameter that a handler parameter type requires, if any.

Minimal complete definition

Nothing

Associated Types

type TransState special state a :: OptionState

Transition the current OptionState.

Methods

paramOpt :: Map Text Object

paramArg :: Maybe Text

Instances

RegularParam state (IsMaybe a) a => CommandParam 'False state a

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransState 'False state a :: OptionState

Methods

paramOpt :: Map Text Object

paramArg :: Maybe Text

SpecialParam state a => CommandParam 'True state a

Defined in Ribosome.Host.Handler.Command

Associated Types

type TransState 'True state a :: OptionState

Methods

paramOpt :: Map Text Object

paramArg :: Maybe Text

class CommandHandler (state :: OptionState) (h :: Type) where

Derive the command options and arguments that should be used when registering the Neovim command, from the parameters of the handler function.

See Command params for the list of supported special types.

The parameter state is a type level value that determines which parameter types may be used after another and counts the number of command arguments that are required or allowed. It is transitioned by families in the classes CommandParam, SpecialParam and RegularParam.

Methods

commandOptions :: (Map Text Object, [Text])

Return the list of command options and special arguments determined by the handler function's parameters.

Instances

(special ~ CommandSpecial a, next ~ TransState special state a, CommandParam special state a, CommandHandler next b) => CommandHandler state (a -> b)

Defined in Ribosome.Host.Handler.Command

Methods

commandOptions :: (Map Text Object, [Text])

CommandHandler ('OptionState _a 'MinOne c) (Sem r a)

Defined in Ribosome.Host.Handler.Command

Methods

commandOptions :: (Map Text Object, [Text])

CommandHandler ('OptionState _a 'MinZero c) (Sem r a)

Defined in Ribosome.Host.Handler.Command

Methods

commandOptions :: (Map Text Object, [Text])

CommandHandler ('OptionState _a 'Zero c) (Sem r a)

Defined in Ribosome.Host.Handler.Command

Methods

commandOptions :: (Map Text Object, [Text])