Safe Haskell	Safe-Inferred
Language	Haskell2010

Ribosome.Handler

Synopsis

data CompleteStyle
- = CompleteFiltered
- | CompleteUnfiltered
newtype AutocmdEvents = AutocmdEvents {
- unAutocmdEvent :: [Text]
}
newtype AutocmdPatterns = AutocmdPatterns {
- unAutocmdPattern :: [Text]
}
newtype AutocmdGroup = AutocmdGroup {
- unAutocmdGroup :: Text
}
data AutocmdOptions = AutocmdOptions {
- target :: Either AutocmdBuffer AutocmdPatterns
- nested :: Bool
- once :: Bool
- group :: Maybe AutocmdGroup
}
data CommandCompletion
- = CompleteBuiltin Text
- | CompleteHandler CompleteStyle RpcName
data CommandOptions = CommandOptions {
- basic :: Map Text Object
- completion :: Maybe CommandCompletion
}
data RpcType
completeBuiltin :: forall (r :: [(Type -> Type) -> Type -> Type]). Text -> RpcHandler r -> RpcHandler r
completeWith :: forall (r :: [(Type -> Type) -> Type -> Type]). CompleteStyle -> (Text -> Text -> Int -> Handler r [Text]) -> RpcHandler r -> [RpcHandler r]
completeCustom :: forall (r :: [(Type -> Type) -> Type -> Type]). RpcName -> (Text -> Text -> Int -> Handler r [Text]) -> CompleteStyle -> RpcHandler r
complete :: forall (r :: [(Type -> Type) -> Type -> Type]). CommandCompletion -> RpcHandler r -> RpcHandler r

Documentation

data CompleteStyle #

Neovim command completion can be designated as returning all items that may be completed regardless of the current word (CompleteUnfiltered) or only those that match the current word (CompleteFiltered).

Constructors

CompleteFiltered	Completion returns matching items.
CompleteUnfiltered	Completion returns all items.

Instances

Instances details

Show CompleteStyle
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> CompleteStyle -> ShowS # show :: CompleteStyle -> String # showList :: [CompleteStyle] -> ShowS #
Eq CompleteStyle
Instance details Defined in Ribosome.Host.Data.RpcType Methods (==) :: CompleteStyle -> CompleteStyle -> Bool # (/=) :: CompleteStyle -> CompleteStyle -> Bool #

newtype AutocmdEvents #

A set of autocmd event specifiers, like BufEnter, used to create and trigger autocmds.

Constructors

AutocmdEvents
Fields unAutocmdEvent :: [Text]

Instances

Instances details

IsString AutocmdEvents
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromString :: String -> AutocmdEvents #
Generic AutocmdEvents
Instance details Defined in Ribosome.Host.Data.RpcType Associated Types type Rep AutocmdEvents :: Type -> Type # Methods from :: AutocmdEvents -> Rep AutocmdEvents x # to :: Rep AutocmdEvents x -> AutocmdEvents #
Show AutocmdEvents
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> AutocmdEvents -> ShowS # show :: AutocmdEvents -> String # showList :: [AutocmdEvents] -> ShowS #
Eq AutocmdEvents
Instance details Defined in Ribosome.Host.Data.RpcType Methods (==) :: AutocmdEvents -> AutocmdEvents -> Bool # (/=) :: AutocmdEvents -> AutocmdEvents -> Bool #
MsgpackDecode AutocmdEvents
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdEvents #
MsgpackEncode AutocmdEvents
Instance details Defined in Ribosome.Host.Data.RpcType Methods toMsgpack :: AutocmdEvents -> Object #
type Rep AutocmdEvents
Instance details Defined in Ribosome.Host.Data.RpcType type Rep AutocmdEvents = D1 ('MetaData "AutocmdEvents" "Ribosome.Host.Data.RpcType" "ribosome-host-0.9.9.9-4n86eC1033RAA2pmC2T1m9" 'True) (C1 ('MetaCons "AutocmdEvents" 'PrefixI 'True) (S1 ('MetaSel ('Just "unAutocmdEvent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

newtype AutocmdPatterns #

A file pattern like *.hs that defines the files in which an autocmd should be triggered.

If the AutocmdEvents contain User, this denotes the custom event name.

Constructors

AutocmdPatterns
Fields unAutocmdPattern :: [Text]

Instances

Instances details

IsString AutocmdPatterns
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromString :: String -> AutocmdPatterns #
Show AutocmdPatterns
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> AutocmdPatterns -> ShowS # show :: AutocmdPatterns -> String # showList :: [AutocmdPatterns] -> ShowS #
Default AutocmdPatterns
Instance details Defined in Ribosome.Host.Data.RpcType Methods def :: AutocmdPatterns #
Eq AutocmdPatterns
Instance details Defined in Ribosome.Host.Data.RpcType Methods (==) :: AutocmdPatterns -> AutocmdPatterns -> Bool # (/=) :: AutocmdPatterns -> AutocmdPatterns -> Bool #
MsgpackDecode AutocmdPatterns
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdPatterns #
MsgpackEncode AutocmdPatterns
Instance details Defined in Ribosome.Host.Data.RpcType Methods toMsgpack :: AutocmdPatterns -> Object #

newtype AutocmdGroup #

An autocmd group.

Constructors

AutocmdGroup
Fields unAutocmdGroup :: Text

Instances

Instances details

IsString AutocmdGroup
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromString :: String -> AutocmdGroup #
Show AutocmdGroup
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> AutocmdGroup -> ShowS # show :: AutocmdGroup -> String # showList :: [AutocmdGroup] -> ShowS #
Eq AutocmdGroup
Instance details Defined in Ribosome.Host.Data.RpcType Methods (==) :: AutocmdGroup -> AutocmdGroup -> Bool # (/=) :: AutocmdGroup -> AutocmdGroup -> Bool #
Ord AutocmdGroup
Instance details Defined in Ribosome.Host.Data.RpcType Methods compare :: AutocmdGroup -> AutocmdGroup -> Ordering # (<) :: AutocmdGroup -> AutocmdGroup -> Bool # (<=) :: AutocmdGroup -> AutocmdGroup -> Bool # (>) :: AutocmdGroup -> AutocmdGroup -> Bool # (>=) :: AutocmdGroup -> AutocmdGroup -> Bool # max :: AutocmdGroup -> AutocmdGroup -> AutocmdGroup # min :: AutocmdGroup -> AutocmdGroup -> AutocmdGroup #
MsgpackDecode AutocmdGroup
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromMsgpack :: Object -> Either DecodeError AutocmdGroup #
MsgpackEncode AutocmdGroup
Instance details Defined in Ribosome.Host.Data.RpcType Methods toMsgpack :: AutocmdGroup -> Object #

data AutocmdOptions #

The options with which an autocmd may be defined.

See :help :autocmd.

Constructors

AutocmdOptions
Fields target :: Either AutocmdBuffer AutocmdPatterns nested :: Bool once :: Bool group :: Maybe AutocmdGroup

Instances

Instances details

IsString AutocmdOptions
Instance details Defined in Ribosome.Host.Data.RpcType Methods fromString :: String -> AutocmdOptions #
Generic AutocmdOptions
Instance details Defined in Ribosome.Host.Data.RpcType Associated Types type Rep AutocmdOptions :: Type -> Type # Methods from :: AutocmdOptions -> Rep AutocmdOptions x # to :: Rep AutocmdOptions x -> AutocmdOptions #
Show AutocmdOptions
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> AutocmdOptions -> ShowS # show :: AutocmdOptions -> String # showList :: [AutocmdOptions] -> ShowS #
Default AutocmdOptions
Instance details Defined in Ribosome.Host.Data.RpcType Methods def :: AutocmdOptions #
Eq AutocmdOptions
Instance details Defined in Ribosome.Host.Data.RpcType Methods (==) :: AutocmdOptions -> AutocmdOptions -> Bool # (/=) :: AutocmdOptions -> AutocmdOptions -> Bool #
type Rep AutocmdOptions
Instance details Defined in Ribosome.Host.Data.RpcType type Rep AutocmdOptions = D1 ('MetaData "AutocmdOptions" "Ribosome.Host.Data.RpcType" "ribosome-host-0.9.9.9-4n86eC1033RAA2pmC2T1m9" 'False) (C1 ('MetaCons "AutocmdOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "target") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either AutocmdBuffer AutocmdPatterns)) :: S1 ('MetaSel ('Just "nested") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "once") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "group") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AutocmdGroup)))))

data CommandCompletion #

The completion to use for a command.

Constructors

CompleteBuiltin Text	Complete with one of the builtin completions, see `:help :command-completion`.
CompleteHandler CompleteStyle RpcName	Complete with an RPC handler defined by a plugin.

Instances

Instances details

Show CommandCompletion
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> CommandCompletion -> ShowS # show :: CommandCompletion -> String # showList :: [CommandCompletion] -> ShowS #
Eq CommandCompletion
Instance details Defined in Ribosome.Host.Data.RpcType Methods (==) :: CommandCompletion -> CommandCompletion -> Bool # (/=) :: CommandCompletion -> CommandCompletion -> Bool #

data CommandOptions #

Options for an RPC command on the Neovim side, consisting of the options described at :help :command-attributes and an optional completion handler.

Constructors

CommandOptions
Fields basic :: Map Text Object completion :: Maybe CommandCompletion

Instances

Instances details

Show CommandOptions
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> CommandOptions -> ShowS # show :: CommandOptions -> String # showList :: [CommandOptions] -> ShowS #

data RpcType #

The type of RPC handler and its options.

Constructors

Function
Command CommandOptions CommandArgs
Autocmd AutocmdEvents AutocmdOptions

Instances

Instances details

Generic RpcType
Instance details Defined in Ribosome.Host.Data.RpcType Associated Types type Rep RpcType :: Type -> Type # Methods from :: RpcType -> Rep RpcType x # to :: Rep RpcType x -> RpcType #
Show RpcType
Instance details Defined in Ribosome.Host.Data.RpcType Methods showsPrec :: Int -> RpcType -> ShowS # show :: RpcType -> String # showList :: [RpcType] -> ShowS #
type Rep RpcType
Instance details Defined in Ribosome.Host.Data.RpcType type Rep RpcType = D1 ('MetaData "RpcType" "Ribosome.Host.Data.RpcType" "ribosome-host-0.9.9.9-4n86eC1033RAA2pmC2T1m9" 'False) (C1 ('MetaCons "Function" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Command" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommandOptions) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CommandArgs)) :+: C1 ('MetaCons "Autocmd" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AutocmdEvents) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AutocmdOptions))))

completeBuiltin :: forall (r :: [(Type -> Type) -> Type -> Type]). Text -> RpcHandler r -> RpcHandler r #

Configure the given RpcHandler to use the specified builtin completion.

completeWith :: forall (r :: [(Type -> Type) -> Type -> Type]). CompleteStyle -> (Text -> Text -> Int -> Handler r [Text]) -> RpcHandler r -> [RpcHandler r] #

Add command line completion to another RpcHandler by creating a new handler that calls the given function to obtain possible completions.

completeCustom :: forall (r :: [(Type -> Type) -> Type -> Type]). RpcName -> (Text -> Text -> Int -> Handler r [Text]) -> CompleteStyle -> RpcHandler r #

Create a completion handler that can be used by another handler by wrapping it with complete, using the same RpcName.

complete :: forall (r :: [(Type -> Type) -> Type -> Type]). CommandCompletion -> RpcHandler r -> RpcHandler r #

Add the given completion to an RpcHandler.