| Copyright | (c) Sebastian Witte |
|---|---|
| License | Apache-2.0 |
| Maintainer | woozletoff@gmail.com |
| Stability | experimental |
| Portability | GHC |
| Safe Haskell | None |
| Language | Haskell2010 |
Neovim.Plugin
Description
- startPluginThreads :: Config StartupConfig -> [Neovim StartupConfig NeovimPlugin] -> IO (Either (Doc AnsiStyle) ([FunctionMapEntry], [Async ()]))
- type StartupConfig = StartupConfig NeovimConfig
- wrapPlugin :: Applicative m => Plugin env -> m NeovimPlugin
- data NeovimPlugin
- data Plugin env = Plugin {
- environment :: env
- exports :: [ExportedFunctionality env]
- data Synchronous
- data CommandOption
- addAutocmd :: ByteString -> AutocmdOptions -> Neovim env () -> Neovim env (Maybe (Either (Neovim anyEnv ()) ReleaseKey))
- registerPlugin :: (FunctionMapEntry -> Neovim env ()) -> FunctionalityDescription -> ([Object] -> Neovim env Object) -> TQueue SomeMessage -> TVar (Map FunctionName ([Object] -> Neovim env Object)) -> Neovim env (Maybe FunctionMapEntry)
Documentation
startPluginThreads :: Config StartupConfig -> [Neovim StartupConfig NeovimPlugin] -> IO (Either (Doc AnsiStyle) ([FunctionMapEntry], [Async ()])) Source #
wrapPlugin :: Applicative m => Plugin env -> m NeovimPlugin Source #
Wrap a Plugin in some nice blankets, so that we can put them in a simple
list.
data NeovimPlugin Source #
Plugin values are wraped inside this data type via wrapPlugin so that
we can put plugins in an ordinary list.
This data type contains meta information for the plugin manager.
Constructors
| Plugin | |
Fields
| |
data Synchronous Source #
This option detemines how neovim should behave when calling some functionality on a remote host.
Constructors
| Async | Call the functionality entirely for its side effects and do not wait for it to finish. Calling a functionality with this flag set is completely asynchronous and nothing is really expected to happen. This is why a call like this is called notification on the neovim side of things. |
| Sync | Call the function and wait for its result. This is only synchronous on the neovim side. This means that the GUI will (probably) not allow any user input until a reult is received. |
Instances
data CommandOption Source #
Options for commands.
Some command can also be described by using the OverloadedString extensions.
This means that you can write a literal String inside your source file in
place for a CommandOption value. See the documentation for each value on
how these strings should look like (Both versions are compile time checked.)
Constructors
| CmdSync Synchronous | Stringliteral "sync" or "async" |
| CmdRegister | Register passed to the command. Stringliteral: |
| CmdNargs String | Command takes a specific amount of arguments Automatically set via template haskell functions. You really shouldn't use this option yourself unless you have to. |
| CmdRange RangeSpecification | Determines how neovim passes the range. Stringliterals: "%" for |
| CmdCount Word | Command handles a count. The argument defines the default count. Stringliteral: string of numbers (e.g. "132") |
| CmdBang | Command handles a bang Stringliteral: "!" |
Arguments
| :: ByteString | The event to register to (e.g. BufWritePost) |
| -> AutocmdOptions | |
| -> Neovim env () | Fully applied function to register |
| -> Neovim env (Maybe (Either (Neovim anyEnv ()) ReleaseKey)) | A |
Register an autocmd in the current context. This means that, if you are currently in a stateful plugin, the function will be called in the current thread and has access to the configuration and state of this thread. .
Note that the function you pass must be fully applied.
registerPlugin :: (FunctionMapEntry -> Neovim env ()) -> FunctionalityDescription -> ([Object] -> Neovim env Object) -> TQueue SomeMessage -> TVar (Map FunctionName ([Object] -> Neovim env Object)) -> Neovim env (Maybe FunctionMapEntry) Source #