Copyright	(c) Sebastian Witte
License	Apache-2.0
Maintainer	[email protected]
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Neovim.Plugin.Classes

Description

Synopsis

data FunctionalityDescription
newtype FunctionName = F Text
newtype NeovimEventId = NeovimEventId Text
newtype SubscriptionId = SubscriptionId Int64
data Subscription = Subscription {
- subId :: SubscriptionId
- subEventId :: NeovimEventId
- subAction :: [Object] -> IO ()
}
newtype NvimMethod = NvimMethod {
- nvimMethodName :: Text
}
data Synchronous
- = Async
- | Sync
data CommandOption
- = CmdSync Synchronous
- | CmdRegister
- | CmdNargs String
- | CmdRange RangeSpecification
- | CmdCount Word
- | CmdBang
- | CmdComplete String
data CommandOptions
data RangeSpecification
- = CurrentLine
- | WholeFile
- | RangeCount Int
data CommandArguments = CommandArguments {
- bang :: Maybe Bool
- range :: Maybe (Int, Int)
- count :: Maybe Int
- register :: Maybe String
}
getCommandOptions :: CommandOptions -> [CommandOption]
mkCommandOptions :: [CommandOption] -> CommandOptions
data AutocmdOptions = AutocmdOptions {
- acmdPattern :: String
- acmdNested :: Bool
- acmdGroup :: Maybe String
}
class HasFunctionName a where
- name :: a -> FunctionName
- nvimMethod :: a -> NvimMethod

Documentation

data FunctionalityDescription Source #

Functionality specific functional description entries.

All fields which are directly specified in these constructors are not optional, but can partialy be generated via the Template Haskell functions. The last field is a data type that contains all relevant options with sensible defaults, hence def can be used as an argument.

Constructors

Function FunctionName Synchronous

Exported function. Callable via call name(arg1,arg2).

Name of the function (must start with an uppercase letter)
Option to indicate how neovim should behave when calling this function

Command FunctionName CommandOptions

Exported Command. Callable via :Name arg1 arg2.

Name of the command (must start with an uppercase letter)
Options to configure neovim's behavior for calling the command

Autocmd Text FunctionName Synchronous AutocmdOptions

Exported autocommand. Will call the given function if the type and filter match.

NB: Since we are registering this on the Haskell side of things, the number of accepted arguments should be 0.

Type of the autocmd (e.g. "BufWritePost")
Name for the function to call
Whether to use rpcrequest or rpcnotify
Options for the autocmd (use def here if you don't want to change anything)

Instances

Instances details

Generic FunctionalityDescription Source #

Instance details

Enum SubscriptionId Source #
Instance details Defined in Neovim.Plugin.Classes Methods succ :: SubscriptionId -> SubscriptionId # pred :: SubscriptionId -> SubscriptionId # toEnum :: Int -> SubscriptionId # fromEnum :: SubscriptionId -> Int # enumFrom :: SubscriptionId -> [SubscriptionId] # enumFromThen :: SubscriptionId -> SubscriptionId -> [SubscriptionId] # enumFromTo :: SubscriptionId -> SubscriptionId -> [SubscriptionId] # enumFromThenTo :: SubscriptionId -> SubscriptionId -> SubscriptionId -> [SubscriptionId] #
Read SubscriptionId Source #
Instance details Defined in Neovim.Plugin.Classes Methods readsPrec :: Int -> ReadS SubscriptionId # readList :: ReadS [SubscriptionId] # readPrec :: ReadPrec SubscriptionId # readListPrec :: ReadPrec [SubscriptionId] #
Show SubscriptionId Source #
Instance details Defined in Neovim.Plugin.Classes Methods showsPrec :: Int -> SubscriptionId -> ShowS # show :: SubscriptionId -> String # showList :: [SubscriptionId] -> ShowS #
Eq SubscriptionId Source #
Instance details Defined in Neovim.Plugin.Classes Methods (==) :: SubscriptionId -> SubscriptionId -> Bool # (/=) :: SubscriptionId -> SubscriptionId -> Bool #
Ord SubscriptionId Source #
Instance details Defined in Neovim.Plugin.Classes Methods compare :: SubscriptionId -> SubscriptionId -> Ordering # (<) :: SubscriptionId -> SubscriptionId -> Bool # (<=) :: SubscriptionId -> SubscriptionId -> Bool # (>) :: SubscriptionId -> SubscriptionId -> Bool # (>=) :: SubscriptionId -> SubscriptionId -> Bool # max :: SubscriptionId -> SubscriptionId -> SubscriptionId # min :: SubscriptionId -> SubscriptionId -> SubscriptionId #

Subscription
Fields subId :: SubscriptionId subEventId :: NeovimEventId subAction :: [Object] -> IO ()

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.

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 `WholeFile`, "," for line and ",123" for 123 lines.
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: "!"
CmdComplete String	Verbatim string passed to the `-complete=` command attribute

CurrentLine	The line the cursor is at when the command is invoked.
WholeFile	Let the command operate on every line of the file.
RangeCount Int	Let the command operate on each line in the given range.

AutocmdOptions
Fields acmdPattern :: String Pattern to match on. (default: "*") acmdNested :: Bool Nested autocmd. (default: False) See `:h autocmd-nested` acmdGroup :: Maybe String Group in which the autocmd should be registered.

HasFunctionName FunctionalityDescription Source #
Instance details Defined in Neovim.Plugin.Classes Methods name :: FunctionalityDescription -> FunctionName Source # nvimMethod :: FunctionalityDescription -> NvimMethod Source #
HasFunctionName (ExportedFunctionality env) Source #
Instance details Defined in Neovim.Plugin.Internal Methods name :: ExportedFunctionality env -> FunctionName Source # nvimMethod :: ExportedFunctionality env -> NvimMethod Source #