Neovim.API.Parser

Documentation

data NeovimAPI

This data type represents the top-level structure of the nvim --api-info output.

Constructors

NeovimAPI

Fields

• errorTypes :: [(String, Int64)]

  The error types are defined by a name and an identifier.

• customTypes :: [(String, Int64)]

  Extension types defined by neovim.

• functions :: [NeovimFunction]

  The remotely executable functions provided by the neovim api.

Instances

Show NeovimAPI

Methods

showsPrec :: Int -> NeovimAPI -> ShowS

show :: NeovimAPI -> String

showList :: [NeovimAPI] -> ShowS

data NeovimFunction

This data type contains simple information about a function as received throudh the nvim --api-info command.

Constructors

NeovimFunction

Fields

• name :: String

  function name

• parameters :: [(NeovimType, String)]

  A list of type name and variable name.

• canFail :: Bool

  Indicator whether the function can fail/throws exceptions.

• async :: Bool

  Indicator whether the this function is asynchronous.

• returnType :: NeovimType

  Functions return type.

Instances

Show NeovimFunction

Methods

showsPrec :: Int -> NeovimFunction -> ShowS

show :: NeovimFunction -> String

showList :: [NeovimFunction] -> ShowS

data NeovimType

Constructors

SimpleType String

NestedType NeovimType (Maybe Int)

Void

Instances

Eq NeovimType

Methods

(==) :: NeovimType -> NeovimType -> Bool

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

Show NeovimType

Methods

showsPrec :: Int -> NeovimType -> ShowS

show :: NeovimType -> String

showList :: [NeovimType] -> ShowS

parseAPI :: IO (Either Doc NeovimAPI)

Run nvim --api-info and parse its output.