Neovim.Plugin.Internal

Documentation

newtype ExportedFunctionality r st

This data type is used in the plugin registration to properly register the functions.

Constructors

EF (FunctionalityDescription, [Object] -> Neovim r st Object)

Instances

HasFunctionName (ExportedFunctionality r st)

Methods

name :: ExportedFunctionality r st -> FunctionName

data StatefulFunctionality r st

This datatype contains the initial state (mutable and immutable) for the functionalities defined here.

Constructors

StatefulFunctionality

Fields

• readOnly :: r
• writable :: st
• functionalities :: [ExportedFunctionality r st]

getFunction :: ExportedFunctionality r st -> [Object] -> Neovim r st Object

Extract the function of an ExportedFunctionality.

getDescription :: ExportedFunctionality r st -> FunctionalityDescription

Extract the description of an ExportedFunctionality.

data NeovimPlugin

Plugin values are wraped inside this data type via wrapPlugin so that we can put plugins in an ordinary list.

Constructors

NeovimPlugin (Plugin r st)

data Plugin r st

This data type contains meta information for the plugin manager.

Constructors

Plugin

Fields

• exports :: [ExportedFunctionality () ()]
• statefulExports :: [StatefulFunctionality r st]

wrapPlugin :: Applicative m => Plugin r st -> m NeovimPlugin

Wrap a Plugin in some nice blankets, so that we can put them in a simple list.