The cl-neovim Reference Manual

Table of Contents

The cl-neovim Reference Manual

This is the cl-neovim Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:16:20 2018 GMT+0.

1 Introduction

cl-neovim

cl-neovim is a Neovim client library for writing Neovim plugins using Common Lisp.

Installation

Prerequisites for cl-neovim are SBCL along with Quicklisp, and libuv1-dev, which you should be able to install with your package manager or by manually compiling libuv.

cl-neovim is available from Quicklisp, so simply evaluating

* (ql:quickload :cl-neovim)

from your SBCL repl should properly load it and all the remaining dependencies.

Installing plugin host

The previous step only installed cl-neovim for usage from the REPL. The easiest way to also install lisp host (required to use plugins written in Common Lisp) is to use vim-plug. Add

Plug 'adolenc/cl-neovim'

into your init.vim, run :PlugInstall from within Neovim, restart Neovim and run :UpdateRemotePlugins. If everything worked correctly, calling :Lisp (print 42) command (after restarting one more time) should output 42 into your prompt.

If you are having trouble getting the host to work, and if you are using latest version of Neovim (≥ v0.1.5), you can call :CheckHealth lisp command from Neovim, which should help you debug your problems.

Using the package

To use the package from the REPL, first run Neovim and make it listen to some address:

$ NVIM_LISTEN_ADDRESS=/tmp/nvim nvim

start your SBCL REPL and enter:

* (ql:quickload :cl-neovim)
* (nvim:connect :file "/tmp/nvim") 
* (nvim:command "echo 'Hello from Common Lisp!'")

which should display "Hello from Common Lisp!" into your Neovim's prompt.

Example plugins

cl-neovim looks for lisp plugins inside $VIMRUNTIME/rplugin/lisp/ directory. Note that simply loading plugins in your init.vim is not enough -- the first time around (and every time your callback specifications change) you will need to run :UpdateRemotePlugins from within Neovim to register the plugins.

Simple plugin

The following is a (slightly convoluted) translation of python plugin example from :h remote-plugin-example; simply put it in $VIMRUNTIME/rplugin/lisp/sample-plugin.lisp:

(defpackage #:sample-plugin
  (:use #:cl))
(in-package #:sample-plugin)

(defparameter *calls* 0 "Counter for calls.")

(defun increment-calls ()
  (if (= *calls* 5)
    (error "Too many calls!")
    (incf *calls*)))

(nvim:defcommand/s lisp-sample-cmd (&rest args &opts (range r) bang)
  (increment-calls)
  (setf (nvim:current-line) (format nil "Command: Called ~A times, args: ~A, range: ~A, bang: ~A" *calls* args r bang)))

(nvim:defautocmd/s buf-enter (filename)
  (declare (opts (pattern "*.lisp") (eval "expand(\"<afile>\")")))
  (increment-calls)
  (setf (nvim:current-line) (format nil "Autocmd: Called ~A times, file: ~A" *calls* filename))) 

(nvim:defun "LispSampleFun" (&rest args &opts (eval line-n))
  (declare (opts (eval "line(\".\")-1")))
  (increment-calls)
  (setf (nvim:current-line) (format nil "Function: Called ~A times, args: ~A, eval: ~A" *calls* args line-n)))

A more serious plugin

For plugins that require a more serious structure, cl-neovim registers .asd files in the root directory of the plugin, which means you can structure them as you wish. The only thing you will need is to add a rplugin/lisp/[plugin-name].lisp file which (quick)loads your plugin. For example:

;;;; lisp-sample-plugin.asd
(in-package #:cl-user)
(asdf:defsystem #:lisp-sample-plugin
  :depends-on (#:cl-neovim)
  :serial T
  :components ((:module "src"
                :components ((:file "package")
                             (:file "main")))))

;;;; src/package.lisp
(in-package :cl-user)
(defpackage #:lisp-sample-plugin
  (:use #:cl))

;;;; src/main.lisp
(in-package #:lisp-sample-plugin)

(nvim:defcommand sample-callback ()
  (setf (nvim:current-line) "Hi nvim!"))

;;;; rplugin/lisp/lisp-sample-plugin.lisp
(ql:quickload :lisp-sample-plugin)

Exported symbols

cl-neovim allows you to connect to Neovim using either named pipes via #'connect and it's :file parameter, or using tcp address if you specify :host and :port arguments instead. Function also binds the connection to the *nvim-instance* variable and returns an instance of nvim class, which you can optionally pass as the final argument to all of the functions below in case you need to be connected to multiple instances of Neovim at once.

Neovim's API

Package basically exports every function exposed by Neovim's api. You can find the full listing in package.lisp.

If you are familiar with the api Neovim exposes, some things in cl-neovim are renamed for nicer interface. Specifically:

• underscores are replaced with hyphens;
• names starting with vim have that prefix removed;
• predicates containing is have that replaced by suffix p;
• get and set are removed from names.

For example, vim_get_current_line is now just current-line, buffer_get_line becomes buffer-line and window_is_valid is window-valid-p.

Setter functions (those with set in their names) are implemented as inversions of their respective get counterparts via setf macro. So, to set current line to "some new line", you would use (setf (nvim:current-line) "some new line").

By default all the calls are synchronous, meaning they block the execution of the thread until Neovim returns the result. You can optionally use asynchronous versions by appending /a to the name; these calls won't block the thread, but they also ignore all the errors and return values.

If you want to manually call Neovim api functions (that is, by string), you can use #'call/s and #'call/a for synchronous and asynchronous calls respectively, where the first argument of either call is either a instance of nvim class that gets returned by #'connect, or t (and, equivalently, *nvim-instance*) for last connected instance.

Callbacks

Callbacks for Neovim are of the form:

callback-type name (args) documentation declare-opts? form*

callback-type  ::= defcommand   | defautocmd   | defun    ; asynchronous versions
                 | defcommand/s | defautocmd/s | defun/s  ; synchronous versions
args           ::= lambda-list [&opts args-opt*]?
args-opt       ::= option | (option alternative-name)
declare-opts   ::= (declare (opts declare-opt*))
declare-opt    ::= option | (option value)

callback-type specifies the type of callback registered with Neovim: defcommand for commands, defautocmd for autocommands and defun for functions. These functions are all asynchronous, meaning Neovim will call them and instantly return control back to the user, completely ignoring their return values and any errors. If you would like Neovim to block user input until your callback is done executing, use the /s variants.

name can be a string, in which case it is registered with Neovim verbatim, or a symbol, in which case the hyphen-separated-name is registered with Neovim as CamelCaseName.

args is basically just a regular lambda-list, but you can also append it with &opts keyword and specify names for arguments for additional options Neovim passes along with the regular arguments when called. args-opt production's options are, for:

• commands: (range | count) | bang | register | eval;
• autocmds: none (values from eval get passed as normal arguments into lambda-list); and
• functions: eval.

While these are full option names, you can also specify alternative names for them by wrapping them into a list of (option alternative-name). Unless you explicitly specify differently via declare-opts, these options get set to some common-sense default values.

declare-opts is a declaration used to let Neovim know about expected behaviour of the callback and explicitly tell it which options you want it to pass along in the calls. Valid options in declare-opt are for:

• commands: nargs | complete | (range | count) | bang | register | eval;
• autocmds: pattern | eval; and
• functions: range | eval.

Note that you can specify just the name of the option in which case default values are assumed, or an (option value) list if you want to assign custom values for options.

Tips for writing plugins

cl-neovim is slightly different from most other Neovim client libraries in that it allows the developer to use the full power of REPL to continuously run and test all code, including callbacks. So, while you can simply write plugins by constantly restarting Neovim (and calling :UpdateRemotePlugins when necessary), you can be much more efficient by:

• starting Neovim with NVIM_LISTEN_ADDRESS specified: $ NVIM_LISTEN_ADDRESS=/tmp/nvim nvim;
• connecting to it via REPL: * (nvim:connect :file "/tmp/nvim"); and
• writing your plugins as you would write other lisp programs by constantly evaluating your subprograms in REPL.

Evaluating the callbacks in the REPL will get them registered with the connected Neovim instance, and in order to test them, you can trigger them in Neovim and then use (nvim:listen-once) in REPL to listen to messages from Neovim. E.g. for the sample-callback we specified above, you would evaluate the (nvim:defcommand sample-callback ...) form in the REPL, run :SampleCallback from Neovim and evaluate (listen-once) in the REPL, after which line under cursor in Neovim should change to "Hi nvim!".

Because (listen-once) is slightly more work than one would like, I suggest you trigger the callback from the REPL itself -- that is by calling (nvim:command "SampleCallback") (or (nvim:call-function "SampleCallback" '()) for functions), which runs listen-once for you behind the scenes.

Debugging your plugins

Only 'printf' debugging is truly supported: printing to standard output from the REPL properly prints to the *standard-output*, but ignores it when plugin is ran using plugin host; that is unless Neovim is started with $NVIM_LISP_LOG_FILE set, in which case all the output is redirected to that file. Note that while plugin host should properly close the file when Neovim shuts down, if it for whatever reason fails to do so (or if you want instant updates to log file), simply use (force-output) after printing, so you don't lose buffered output.

Additionally you can set NVIM_LISP_LOG_LEVEL to DEBUG to log messages passed between cl-neovim and Neovim itself, or to DEBUG1 to also track actual bytes. If you want to see messages passed between Neovim and cl-neovim running in your REPL, you can manually enable logging by evaluating (nvim:enable-logging :level :debug) (or :debug1 for bytes).

Running tests

There are two aspects to testing cl-neovim: testing how it works from the REPL and how it works from host. To test REPL, run Neovim with $ NVIM_LISTEN_ADDRESS=/tmp/nvim nvim. Then, run REPL with same NVIM_LISTEN_ADDRESS specified, e.g. $ NVIM_LISTEN_ADDRESS=/tmp/nvim sbcl. After that, evaluate

* (ql:quickload :cl-neovim)
* (asdf:test-system :cl-neovim)

to actually run the tests.

On the other hand, to test the plugin host, you need to add

let g:lisp_host_enable_tests=1

to your init.vim (.nvimrc), run :UpdateRemotePlugins from Neovim, restart it, and finally run

: LispHostRunTests

from Neovim to run the tests. After you are done with testing the host, it is recommended that you remove the let g:lisp_host_enable_tests=1 line from your init.vim and run :UpdateRemotePlugins again, otherwise your Neovim will have a bunch of useless (auto)commands and functions registered.

Contributions

Are very welcome. I would be more than happy to merge pull requests or just hear your criticism/ideas to improve cl-neovim.

License

Copyright (c) 2015 Andrej Dolenc

Licensed under the MIT License

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-neovim

Author

Andrej Dolenc <andrej.dolenc@student.uni-lj.si>

License

MIT

Description

Common Lisp client for Neovim

Dependencies

• babel
• split-sequence
• form-fiddle
• cl-messagepack-rpc
• vom

Source

cl-neovim.asd (file)

Component

src (module)

3 Modules

Modules are listed depth-first from the system components tree.

3.1 cl-neovim/src

Parent

cl-neovim (system)

Location

src/

Components

• package.lisp (file)
• utils.lisp (file)
• vim-utils.lisp (file)
• cl-neovim.lisp (file)
• logging.lisp (file)
• repl.lisp (file)
• callbacks.lisp (file)
• api-generator.lisp (file)
• manual-api.lisp (file)
• generated-api.lisp (file)

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

4.1 Lisp

4.1.1 cl-neovim.asd

Location

cl-neovim.asd

Systems

cl-neovim (system)

4.1.2 cl-neovim/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

cl-neovim

4.1.3 cl-neovim/src/utils.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/utils.lisp

Internal Definitions

• alist-stable-intersection (function)
• make-alist (function)
• mklst (function)
• plist->string-hash (function)
• symbol-concat (function)
• symbol-name= (function)
• zip (function)

4.1.4 cl-neovim/src/vim-utils.lisp

Dependency

utils.lisp (file)

Parent

src (module)

Location

src/vim-utils.lisp

Internal Definitions

• symbol->vim-name (function)
• vim-name->symbol (function)

4.1.5 cl-neovim/src/cl-neovim.lisp

Dependency

vim-utils.lisp (file)

Parent

src (module)

Location

src/cl-neovim.lisp

Exported Definitions

• *nvim-instance* (special variable)
• call/a (function)
• call/s (function)
• connect (function)
• listen-once (function)

Internal Definitions

• %call (function)
• *captured-calls* (special variable)
• *nvim-extended-types* (special variable)
• *path* (special variable)
• *should-capture-calls* (special variable)
• *specs* (special variable)
• *using-host* (special variable)
• client-id (method)
• client-id (method)
• connect-stdio (function)
• nvim (class)
• parse-env-listen-address (function)

4.1.6 cl-neovim/src/logging.lisp

Dependency

cl-neovim.lisp (file)

Parent

src (module)

Location

src/logging.lisp

Exported Definitions

enable-logging (function)

Internal Definitions

*log-stream* (special variable)

4.1.7 cl-neovim/src/repl.lisp

Dependency

logging.lisp (file)

Parent

src (module)

Location

src/repl.lisp

Internal Definitions

• register-repl (function)
• register-repl-callback (function)

4.1.8 cl-neovim/src/callbacks.lisp

Dependency

repl.lisp (file)

Parent

src (module)

Location

src/callbacks.lisp

Exported Definitions

• defautocmd (macro)
• defautocmd/s (macro)
• defcommand (macro)
• defcommand/s (macro)
• defun (macro)
• defun/s (macro)

Internal Definitions

• *opts-conversions* (special variable)
• append-arglist-opts (function)
• calculate-nargs (function)
• construct-callback (function)
• extract-opts-declaration (function)
• fill-args-into-opts (function)
• fill-declare-opts (function)
• generate-arglist (function)
• generate-callback-name (function)
• generate-specs (function)
• ignored-variables (function)
• make-spec (function)
• redirect-output (macro)
• short-names (function)

4.1.9 cl-neovim/src/api-generator.lisp

Dependency

callbacks.lisp (file)

Parent

src (module)

Location

src/api-generator.lisp

Internal Definitions

• *arg-conversions* (special variable)
• *generated-api-file* (special variable)
• *here* (special variable)
• *manual-implementation* (special variable)
• clean-up-name (function)
• function-metadata (function)
• generate-api (function)
• mdata->lisp-function (function)
• parse-api (function)
• parse-parameters (function)
• predicatep (function)
• remove-shadowing-definitions (function)
• retrieve-api (function)
• setterp (function)

4.1.10 cl-neovim/src/manual-api.lisp

Dependency

api-generator.lisp (file)

Parent

src (module)

Location

src/manual-api.lisp

Exported Definitions

• buffer-number (function)
• buffer-number/a (function)
• call-atomic (macro)
• funcall (function)
• funcall/a (function)
• subscribe (function)
• subscribe/a (function)
• unsubscribe (function)
• unsubscribe/a (function)

Internal Definitions

def-/s-and-/a (macro)

4.1.11 cl-neovim/src/generated-api.lisp

Dependency

manual-api.lisp (file)

Parent

src (module)

Location

src/generated-api.lisp

Exported Definitions

• api-info (function)
• api-info/a (function)
• buffer-add-highlight (function)
• buffer-add-highlight/a (function)
• buffer-clear-highlight (function)
• buffer-clear-highlight/a (function)
• buffer-del-line (function)
• buffer-del-line/a (function)
• buffer-del-var (function)
• buffer-del-var/a (function)
• buffer-insert (function)
• buffer-insert/a (function)
• buffer-line (function)
• (setf buffer-line) (function)
• buffer-line-count (function)
• buffer-line-count/a (function)
• buffer-line-slice (function)
• (setf buffer-line-slice) (function)
• buffer-line-slice/a (function)
• (setf buffer-line-slice/a) (function)
• buffer-line/a (function)
• (setf buffer-line/a) (function)
• buffer-lines (function)
• (setf buffer-lines) (function)
• buffer-lines/a (function)
• (setf buffer-lines/a) (function)
• buffer-mark (function)
• buffer-mark/a (function)
• buffer-name (function)
• (setf buffer-name) (function)
• buffer-name/a (function)
• (setf buffer-name/a) (function)
• buffer-option (function)
• (setf buffer-option) (function)
• buffer-option/a (function)
• (setf buffer-option/a) (function)
• buffer-valid-p (function)
• buffer-valid-p/a (function)
• buffer-var (function)
• (setf buffer-var) (function)
• buffer-var/a (function)
• (setf buffer-var/a) (function)
• buffers (function)
• buffers/a (function)
• call-function (function)
• call-function/a (function)
• change-directory (function)
• change-directory/a (function)
• color-by-name (function)
• color-by-name/a (function)
• color-map (function)
• color-map/a (function)
• command (function)
• command-output (function)
• command-output/a (function)
• command/a (function)
• current-buffer (function)
• (setf current-buffer) (function)
• current-buffer/a (function)
• (setf current-buffer/a) (function)
• (setf current-dir) (function)
• (setf current-dir/a) (function)
• current-line (function)
• (setf current-line) (function)
• current-line/a (function)
• (setf current-line/a) (function)
• current-tabpage (function)
• (setf current-tabpage) (function)
• current-tabpage/a (function)
• (setf current-tabpage/a) (function)
• current-window (function)
• (setf current-window) (function)
• current-window/a (function)
• (setf current-window/a) (function)
• del-current-line (function)
• del-current-line/a (function)
• del-var (function)
• del-var/a (function)
• err-write (function)
• err-write/a (function)
• err-writeln (function)
• err-writeln/a (function)
• eval (function)
• eval/a (function)
• feedkeys (function)
• feedkeys/a (function)
• input (function)
• input/a (function)
• name-to-color (function)
• name-to-color/a (function)
• option (function)
• (setf option) (function)
• option/a (function)
• (setf option/a) (function)
• out-write (function)
• out-write/a (function)
• replace-termcodes (function)
• replace-termcodes/a (function)
• report-error (function)
• report-error/a (function)
• runtime-paths (function)
• runtime-paths/a (function)
• strwidth (function)
• strwidth/a (function)
• tabpage-del-var (function)
• tabpage-del-var/a (function)
• tabpage-number (function)
• tabpage-number/a (function)
• tabpage-valid-p (function)
• tabpage-valid-p/a (function)
• tabpage-var (function)
• (setf tabpage-var) (function)
• tabpage-var/a (function)
• (setf tabpage-var/a) (function)
• tabpage-window (function)
• tabpage-window/a (function)
• tabpage-windows (function)
• tabpage-windows/a (function)
• tabpages (function)
• tabpages/a (function)
• ui-attach (function)
• ui-attach/a (function)
• ui-detach (function)
• ui-detach/a (function)
• (setf ui-option) (function)
• (setf ui-option/a) (function)
• ui-try-resize (function)
• ui-try-resize/a (function)
• var (function)
• (setf var) (function)
• var/a (function)
• (setf var/a) (function)
• vvar (function)
• vvar/a (function)
• window-buffer (function)
• window-buffer/a (function)
• window-cursor (function)
• (setf window-cursor) (function)
• window-cursor/a (function)
• (setf window-cursor/a) (function)
• window-del-var (function)
• window-del-var/a (function)
• window-height (function)
• (setf window-height) (function)
• window-height/a (function)
• (setf window-height/a) (function)
• window-number (function)
• window-number/a (function)
• window-option (function)
• (setf window-option) (function)
• window-option/a (function)
• (setf window-option/a) (function)
• window-position (function)
• window-position/a (function)
• window-tabpage (function)
• window-tabpage/a (function)
• window-valid-p (function)
• window-valid-p/a (function)
• window-var (function)
• (setf window-var) (function)
• window-var/a (function)
• (setf window-var/a) (function)
• window-width (function)
• (setf window-width) (function)
• window-width/a (function)
• (setf window-width/a) (function)
• windows (function)
• windows/a (function)

5 Packages

Packages are listed by definition order.

5.1 cl-neovim

Source

package.lisp (file)

Nickname

nvim

Use List

• split-sequence
• form-fiddle
• messagepack-rpc
• common-lisp

Exported Definitions

• *nvim-instance* (special variable)
• api-info (function)
• api-info/a (function)
• buffer-add-highlight (function)
• buffer-add-highlight/a (function)
• buffer-clear-highlight (function)
• buffer-clear-highlight/a (function)
• buffer-del-line (function)
• buffer-del-line/a (function)
• buffer-del-var (function)
• buffer-del-var/a (function)
• buffer-insert (function)
• buffer-insert/a (function)
• buffer-line (function)
• (setf buffer-line) (function)
• buffer-line-count (function)
• buffer-line-count/a (function)
• buffer-line-slice (function)
• (setf buffer-line-slice) (function)
• buffer-line-slice/a (function)
• (setf buffer-line-slice/a) (function)
• buffer-line/a (function)
• (setf buffer-line/a) (function)
• buffer-lines (function)
• (setf buffer-lines) (function)
• buffer-lines/a (function)
• (setf buffer-lines/a) (function)
• buffer-mark (function)
• buffer-mark/a (function)
• buffer-name (function)
• (setf buffer-name) (function)
• buffer-name/a (function)
• (setf buffer-name/a) (function)
• buffer-number (function)
• buffer-number/a (function)
• buffer-option (function)
• (setf buffer-option) (function)
• buffer-option/a (function)
• (setf buffer-option/a) (function)
• buffer-valid-p (function)
• buffer-valid-p/a (function)
• buffer-var (function)
• (setf buffer-var) (function)
• buffer-var/a (function)
• (setf buffer-var/a) (function)
• buffers (function)
• buffers/a (function)
• call-atomic (macro)
• call-function (function)
• call-function/a (function)
• call/a (function)
• call/s (function)
• change-directory (function)
• change-directory/a (function)
• color-by-name (function)
• color-by-name/a (function)
• color-map (function)
• color-map/a (function)
• command (function)
• command-output (function)
• command-output/a (function)
• command/a (function)
• connect (function)
• current-buffer (function)
• (setf current-buffer) (function)
• current-buffer/a (function)
• (setf current-buffer/a) (function)
• (setf current-dir) (function)
• (setf current-dir/a) (function)
• current-line (function)
• (setf current-line) (function)
• current-line/a (function)
• (setf current-line/a) (function)
• current-tabpage (function)
• (setf current-tabpage) (function)
• current-tabpage/a (function)
• (setf current-tabpage/a) (function)
• current-window (function)
• (setf current-window) (function)
• current-window/a (function)
• (setf current-window/a) (function)
• defautocmd (macro)
• defautocmd/s (macro)
• defcommand (macro)
• defcommand/s (macro)
• defun (macro)
• defun/s (macro)
• del-current-line (function)
• del-current-line/a (function)
• del-var (function)
• del-var/a (function)
• enable-logging (function)
• err-write (function)
• err-write/a (function)
• err-writeln (function)
• err-writeln/a (function)
• eval (function)
• eval/a (function)
• feedkeys (function)
• feedkeys/a (function)
• funcall (function)
• funcall/a (function)
• input (function)
• input/a (function)
• listen-once (function)
• name-to-color (function)
• name-to-color/a (function)
• option (function)
• (setf option) (function)
• option/a (function)
• (setf option/a) (function)
• out-write (function)
• out-write/a (function)
• replace-termcodes (function)
• replace-termcodes/a (function)
• report-error (function)
• report-error/a (function)
• runtime-paths (function)
• runtime-paths/a (function)
• strwidth (function)
• strwidth/a (function)
• subscribe (function)
• subscribe/a (function)
• tabpage-del-var (function)
• tabpage-del-var/a (function)
• tabpage-number (function)
• tabpage-number/a (function)
• tabpage-valid-p (function)
• tabpage-valid-p/a (function)
• tabpage-var (function)
• (setf tabpage-var) (function)
• tabpage-var/a (function)
• (setf tabpage-var/a) (function)
• tabpage-window (function)
• tabpage-window/a (function)
• tabpage-windows (function)
• tabpage-windows/a (function)
• tabpages (function)
• tabpages/a (function)
• ui-attach (function)
• ui-attach/a (function)
• ui-detach (function)
• ui-detach/a (function)
• (setf ui-option) (function)
• (setf ui-option/a) (function)
• ui-try-resize (function)
• ui-try-resize/a (function)
• unsubscribe (function)
• unsubscribe/a (function)
• var (function)
• (setf var) (function)
• var/a (function)
• (setf var/a) (function)
• vvar (function)
• vvar/a (function)
• window-buffer (function)
• window-buffer/a (function)
• window-cursor (function)
• (setf window-cursor) (function)
• window-cursor/a (function)
• (setf window-cursor/a) (function)
• window-del-var (function)
• window-del-var/a (function)
• window-height (function)
• (setf window-height) (function)
• window-height/a (function)
• (setf window-height/a) (function)
• window-number (function)
• window-number/a (function)
• window-option (function)
• (setf window-option) (function)
• window-option/a (function)
• (setf window-option/a) (function)
• window-position (function)
• window-position/a (function)
• window-tabpage (function)
• window-tabpage/a (function)
• window-valid-p (function)
• window-valid-p/a (function)
• window-var (function)
• (setf window-var) (function)
• window-var/a (function)
• (setf window-var/a) (function)
• window-width (function)
• (setf window-width) (function)
• window-width/a (function)
• (setf window-width/a) (function)
• windows (function)
• windows/a (function)

Internal Definitions

• %call (function)
• *arg-conversions* (special variable)
• *captured-calls* (special variable)
• *generated-api-file* (special variable)
• *here* (special variable)
• *log-stream* (special variable)
• *manual-implementation* (special variable)
• *nvim-extended-types* (special variable)
• *opts-conversions* (special variable)
• *path* (special variable)
• *should-capture-calls* (special variable)
• *specs* (special variable)
• *using-host* (special variable)
• alist-stable-intersection (function)
• append-arglist-opts (function)
• calculate-nargs (function)
• clean-up-name (function)
• client-id (generic function)
• client-id (method)
• client-id (method)
• connect-stdio (function)
• construct-callback (function)
• def-/s-and-/a (macro)
• extract-opts-declaration (function)
• fill-args-into-opts (function)
• fill-declare-opts (function)
• function-metadata (function)
• generate-api (function)
• generate-arglist (function)
• generate-callback-name (function)
• generate-specs (function)
• ignored-variables (function)
• make-alist (function)
• make-spec (function)
• mdata->lisp-function (function)
• mklst (function)
• nvim (class)
• parse-api (function)
• parse-env-listen-address (function)
• parse-parameters (function)
• plist->string-hash (function)
• predicatep (function)
• redirect-output (macro)
• register-repl (function)
• register-repl-callback (function)
• remove-shadowing-definitions (function)
• retrieve-api (function)
• setterp (function)
• short-names (function)
• symbol->vim-name (function)
• symbol-concat (function)
• symbol-name= (function)
• vim-name->symbol (function)
• zip (function)

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *nvim-instance*

Binds to the last connection to neovim

Package

cl-neovim

Source

cl-neovim.lisp (file)

6.1.2 Macros

Macro: call-atomic (&optional INSTANCE) &rest BODY

Package

cl-neovim

Source

manual-api.lisp (file)

Macro: defautocmd NAME ARGS &body BODY

Package

cl-neovim

Source

callbacks.lisp (file)

Macro: defautocmd/s NAME ARGS &body BODY

Package

cl-neovim

Source

callbacks.lisp (file)

Macro: defcommand NAME ARGS &body BODY

Package

cl-neovim

Source

callbacks.lisp (file)

Macro: defcommand/s NAME ARGS &body BODY

Package

cl-neovim

Source

callbacks.lisp (file)

Macro: defun NAME ARGS &body BODY

Package

cl-neovim

Source

callbacks.lisp (file)

Macro: defun/s NAME ARGS &body BODY

Package

cl-neovim

Source

callbacks.lisp (file)

6.1.3 Functions

Function: api-info &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: api-info/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-add-highlight BUFFER SRC-ID HL-GROUP LINE COL-START COL-END &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-add-highlight/a BUFFER SRC-ID HL-GROUP LINE COL-START COL-END &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-clear-highlight BUFFER SRC-ID LINE-START LINE-END &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-clear-highlight/a BUFFER SRC-ID LINE-START LINE-END &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-del-line BUFFER INDEX &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-del-line/a BUFFER INDEX &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-del-var BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-del-var/a BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-insert BUFFER LNUM LINES &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-insert/a BUFFER LNUM LINES &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-line BUFFER INDEX &optional INSTANCE

Function: (setf buffer-line) LINE BUFFER INDEX &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-line-count BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-line-count/a BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-line-slice BUFFER START END INCLUDE-START INCLUDE-END &optional INSTANCE

Function: (setf buffer-line-slice) REPLACEMENT BUFFER START END INCLUDE-START INCLUDE-END &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-line-slice/a BUFFER START END INCLUDE-START INCLUDE-END &optional INSTANCE

Function: (setf buffer-line-slice/a) REPLACEMENT BUFFER START END INCLUDE-START INCLUDE-END &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-line/a BUFFER INDEX &optional INSTANCE

Function: (setf buffer-line/a) LINE BUFFER INDEX &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-lines BUFFER START END STRICT-INDEXING &optional INSTANCE

Function: (setf buffer-lines) REPLACEMENT BUFFER START END STRICT-INDEXING &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-lines/a BUFFER START END STRICT-INDEXING &optional INSTANCE

Function: (setf buffer-lines/a) REPLACEMENT BUFFER START END STRICT-INDEXING &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-mark BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-mark/a BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-name BUFFER &optional INSTANCE

Function: (setf buffer-name) NAME BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-name/a BUFFER &optional INSTANCE

Function: (setf buffer-name/a) NAME BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-number BUFFER &optional INSTANCE

Package

cl-neovim

Source

manual-api.lisp (file)

Function: buffer-number/a BUFFER &optional INSTANCE

Package

cl-neovim

Source

manual-api.lisp (file)

Function: buffer-option BUFFER NAME &optional INSTANCE

Function: (setf buffer-option) VALUE BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-option/a BUFFER NAME &optional INSTANCE

Function: (setf buffer-option/a) VALUE BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-valid-p BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-valid-p/a BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-var BUFFER NAME &optional INSTANCE

Function: (setf buffer-var) VALUE BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffer-var/a BUFFER NAME &optional INSTANCE

Function: (setf buffer-var/a) VALUE BUFFER NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffers &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: buffers/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: call-function FNAME ARGS &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: call-function/a FNAME ARGS &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: call/a INSTANCE COMMAND &rest ARGS

Send nvim command to neovim socket asynchronously, returning the control back to the caller immediately and discarding all return values/errors.

Package

cl-neovim

Source

cl-neovim.lisp (file)

Function: call/s INSTANCE COMMAND &rest ARGS

Send nvim command to neovim socket and return the result.

Package

cl-neovim

Source

cl-neovim.lisp (file)

Function: change-directory DIR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: change-directory/a DIR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: color-by-name NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: color-by-name/a NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: color-map &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: color-map/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: command COMMAND &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: command-output STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: command-output/a STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: command/a COMMAND &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: connect &rest ARGS &key HOST PORT FILE

Package

cl-neovim

Source

cl-neovim.lisp (file)

Function: current-buffer &optional INSTANCE

Function: (setf current-buffer) BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: current-buffer/a &optional INSTANCE

Function: (setf current-buffer/a) BUFFER &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: (setf current-dir) DIR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: (setf current-dir/a) DIR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: current-line &optional INSTANCE

Function: (setf current-line) LINE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: current-line/a &optional INSTANCE

Function: (setf current-line/a) LINE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: current-tabpage &optional INSTANCE

Function: (setf current-tabpage) TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: current-tabpage/a &optional INSTANCE

Function: (setf current-tabpage/a) TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: current-window &optional INSTANCE

Function: (setf current-window) WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: current-window/a &optional INSTANCE

Function: (setf current-window/a) WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: del-current-line &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: del-current-line/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: del-var NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: del-var/a NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: enable-logging &key STREAM LEVEL

Package

cl-neovim

Source

logging.lisp (file)

Function: err-write STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: err-write/a STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: err-writeln STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: err-writeln/a STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: eval EXPR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: eval/a EXPR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: feedkeys KEYS MODE ESCAPE-CSI &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: feedkeys/a KEYS MODE ESCAPE-CSI &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: funcall FN &rest ARGS

Package

cl-neovim

Source

manual-api.lisp (file)

Function: funcall/a FN &rest ARGS

Package

cl-neovim

Source

manual-api.lisp (file)

Function: input KEYS &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: input/a KEYS &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: listen-once &optional INSTANCE

Block execution listening for a new message for instance.

Package

cl-neovim

Source

cl-neovim.lisp (file)

Function: name-to-color NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: name-to-color/a NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: option NAME &optional INSTANCE

Function: (setf option) VALUE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: option/a NAME &optional INSTANCE

Function: (setf option/a) VALUE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: out-write STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: out-write/a STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: replace-termcodes STR FROM-PART DO-LT SPECIAL &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: replace-termcodes/a STR FROM-PART DO-LT SPECIAL &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: report-error STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: report-error/a STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: runtime-paths &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: runtime-paths/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: strwidth STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: strwidth/a STR &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: subscribe EVENT FUNCTION &optional INSTANCE

Package

cl-neovim

Source

manual-api.lisp (file)

Function: subscribe/a EVENT FUNCTION &optional INSTANCE

Package

cl-neovim

Source

manual-api.lisp (file)

Function: tabpage-del-var TABPAGE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-del-var/a TABPAGE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-number TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-number/a TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-valid-p TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-valid-p/a TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-var TABPAGE NAME &optional INSTANCE

Function: (setf tabpage-var) VALUE TABPAGE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-var/a TABPAGE NAME &optional INSTANCE

Function: (setf tabpage-var/a) VALUE TABPAGE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-window TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-window/a TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-windows TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpage-windows/a TABPAGE &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpages &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: tabpages/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: ui-attach WIDTH HEIGHT OPTIONS &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: ui-attach/a WIDTH HEIGHT OPTIONS &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: ui-detach &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: ui-detach/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: (setf ui-option) VALUE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: (setf ui-option/a) VALUE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: ui-try-resize WIDTH HEIGHT &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: ui-try-resize/a WIDTH HEIGHT &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: unsubscribe EVENT &optional INSTANCE

Package

cl-neovim

Source

manual-api.lisp (file)

Function: unsubscribe/a EVENT &optional INSTANCE

Package

cl-neovim

Source

manual-api.lisp (file)

Function: var NAME &optional INSTANCE

Function: (setf var) VALUE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: var/a NAME &optional INSTANCE

Function: (setf var/a) VALUE NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: vvar NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: vvar/a NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-buffer WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-buffer/a WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-cursor WINDOW &optional INSTANCE

Function: (setf window-cursor) POS WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-cursor/a WINDOW &optional INSTANCE

Function: (setf window-cursor/a) POS WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-del-var WINDOW NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-del-var/a WINDOW NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-height WINDOW &optional INSTANCE

Function: (setf window-height) HEIGHT WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-height/a WINDOW &optional INSTANCE

Function: (setf window-height/a) HEIGHT WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-number WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-number/a WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-option WINDOW NAME &optional INSTANCE

Function: (setf window-option) VALUE WINDOW NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-option/a WINDOW NAME &optional INSTANCE

Function: (setf window-option/a) VALUE WINDOW NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-position WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-position/a WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-tabpage WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-tabpage/a WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-valid-p WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-valid-p/a WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-var WINDOW NAME &optional INSTANCE

Function: (setf window-var) VALUE WINDOW NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-var/a WINDOW NAME &optional INSTANCE

Function: (setf window-var/a) VALUE WINDOW NAME &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-width WINDOW &optional INSTANCE

Function: (setf window-width) WIDTH WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: window-width/a WINDOW &optional INSTANCE

Function: (setf window-width/a) WIDTH WINDOW &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: windows &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

Function: windows/a &optional INSTANCE

Package

cl-neovim

Source

generated-api.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *arg-conversions*

Package

cl-neovim

Source

api-generator.lisp (file)

Special Variable: *captured-calls*

Calls captured when *should-capture-calls* is T.

Package

cl-neovim

Source

cl-neovim.lisp (file)

Special Variable: *generated-api-file*

Package

cl-neovim

Source

api-generator.lisp (file)

Special Variable: *here*

Package

cl-neovim

Source

api-generator.lisp (file)

Special Variable: *log-stream*

Package

cl-neovim

Source

logging.lisp (file)

Special Variable: *manual-implementation*

Package

cl-neovim

Source

api-generator.lisp (file)

Special Variable: *nvim-extended-types*

Package

cl-neovim

Source

cl-neovim.lisp (file)

Special Variable: *opts-conversions*

Package

cl-neovim

Source

callbacks.lisp (file)

Special Variable: *path*

Variable that gets set to path to plugin.

Package

cl-neovim

Source

cl-neovim.lisp (file)

Special Variable: *should-capture-calls*

Don’t forward calls to neovim and instead store them into *captured-calls*.

Package

cl-neovim

Source

cl-neovim.lisp (file)

Special Variable: *specs*

A list of all the specs nvim needs.

Package

cl-neovim

Source

cl-neovim.lisp (file)

Special Variable: *using-host*

Variable that host binds to T when it loads plugins.

Package

cl-neovim

Source

cl-neovim.lisp (file)

6.2.2 Macros

Macro: def-/s-and-/a FN-NAME ARGS &body BODY

Defines sync and async versions of fn-name functions at the same time. Replaces all occurences of symbol %call% with either call/s or call/a (depending on the version), appends /a to async variant and appends instance argument to arglist.

Package

cl-neovim

Source

manual-api.lisp (file)

Macro: redirect-output (&optional WHERE) &body BODY

Package

cl-neovim

Source

callbacks.lisp (file)

6.2.3 Functions

Function: %call INSTANCE FN-TYPE COMMAND &rest ARGS

Package

cl-neovim

Source

cl-neovim.lisp (file)

Function: alist-stable-intersection AS BS

Intersection between 2 association lists as and bs, where the order is the same as in as and the values are associations from as.

Package

cl-neovim

Source

utils.lisp (file)

Function: append-arglist-opts DECLARE-OPTS ARGLIST-OPTS

Package

cl-neovim

Source

callbacks.lisp (file)

Function: calculate-nargs LAMBDA-LIST

Package

cl-neovim

Source

callbacks.lisp (file)

Function: clean-up-name NAME &optional MODIFIERS REPLACEMENTS

Removes all substrings specified in modifiers from name and applies all replacements.

Package

cl-neovim

Source

api-generator.lisp (file)

Function: connect-stdio ()

Package

cl-neovim

Source

cl-neovim.lisp (file)

Function: construct-callback TYPE SYNC NVIM-OPTS REQUIRED-OPTS NAME ARGS-AND-OPTS BODY

Construct the callback, register it with proper name, and generate specs based on the arguments passed.

Package

cl-neovim

Source

callbacks.lisp (file)

Function: extract-opts-declaration DECLARATIONS

Package

cl-neovim

Source

callbacks.lisp (file)

Function: fill-args-into-opts ARGS DECLARE-OPTS NVIM-OPTS

Based on the value of nargs declaration either fill in and replace nargs with actual user expected arguments, or ignore them, and replace args with actual user arguments.

Package

cl-neovim

Source

callbacks.lisp (file)

Function: fill-declare-opts DECLARE-OPTS &key DEFAULT-NARGS

If user specified just ’[opt] in declare opts, fill it out with the default value. Don’t modify the opts that were defined along with their values ’([opt] [val]).

Package

cl-neovim

Source

callbacks.lisp (file)

Function: function-metadata F

Package

cl-neovim

Source

api-generator.lisp (file)

Function: generate-api &optional FILENAME

Package

cl-neovim

Source

api-generator.lisp (file)

Function: generate-arglist ARGS ARGS-OPTS DECLARE-OPTS NVIM-OPTS

Generate argument list that will properly parse neovim’s format of passed arguments.

Package

cl-neovim

Source

callbacks.lisp (file)

Function: generate-callback-name TYPE NAME SPEC-OPTS

Generate the callback name neovim will use when referring to this function/command/autocmd.

Package

cl-neovim

Source

callbacks.lisp (file)

Function: generate-specs DECLARE-OPTS TYPE

Generate the specs from declare opts user specified.

Package

cl-neovim

Source

callbacks.lisp (file)

Function: ignored-variables DECLARATIONS

Package

cl-neovim

Source

callbacks.lisp (file)

Function: make-alist LST

Wrap a list of symbols (or lists) to a list of lists with first element being symbol.

Package

cl-neovim

Source

utils.lisp (file)

Function: make-spec &key SYNC NAME TYPE OPTS

Package

cl-neovim

Source

callbacks.lisp (file)

Function: mdata->lisp-function &key NAME PARAMETERS &allow-other-keys

Create functions from the parsed nvim api (generated by api.lisp).

Package

cl-neovim

Source

api-generator.lisp (file)

Function: mklst OBJ

Package

cl-neovim

Source

utils.lisp (file)

Function: parse-api API

Package

cl-neovim

Source

api-generator.lisp (file)

Function: parse-env-listen-address ADDRESS

Package

cl-neovim

Source

cl-neovim.lisp (file)

Function: parse-parameters PARAMETERS

Extract names from nvim api’s metadata of arguments into a list of symbols.

Package

cl-neovim

Source

api-generator.lisp (file)

Function: plist->string-hash PLIST

Convert property list PLIST into hash table. Keys are transformed into lowercase strings.

Package

cl-neovim

Source

utils.lisp (file)

Function: predicatep NAME

Is name a predicate?

Package

cl-neovim

Source

api-generator.lisp (file)

Function: register-repl INSTANCE

Register repl with the running neovim instance.

Package

cl-neovim

Source

repl.lisp (file)

Function: register-repl-callback INSTANCE SPEC

Tell neovim about callback.

Package

cl-neovim

Source

repl.lisp (file)

Function: remove-shadowing-definitions PARSED-API

Package

cl-neovim

Source

api-generator.lisp (file)

Function: retrieve-api ()

Package

cl-neovim

Source

api-generator.lisp (file)

Function: setterp NAME

Is name a setter?

Package

cl-neovim

Source

api-generator.lisp (file)

Function: short-names ARGS

Return short names for &opts arguments

Package

cl-neovim

Source

callbacks.lisp (file)

Function: symbol->vim-name LISP-NAME

Convert lisp symbol into vim name. Basically turns hyphen-separated name into camelcase string.

Package

cl-neovim

Source

vim-utils.lisp (file)

Function: symbol-concat &rest SYMBOLS

Concatenate symbol names and return resulting symbol.

Package

cl-neovim

Source

utils.lisp (file)

Function: symbol-name= SYMBOL1 SYMBOL2

Compare two symbols by their name.

Package

cl-neovim

Source

utils.lisp (file)

Function: vim-name->symbol STR

Convert string into symbol.

Package

cl-neovim

Source

vim-utils.lisp (file)

Function: zip &rest LISTS

Package

cl-neovim

Source

utils.lisp (file)

6.2.4 Generic functions

Generic Function: client-id OBJECT

Package

cl-neovim

Methods

Method: client-id (INSTANCE nvim) before

Source

cl-neovim.lisp (file)

Method: client-id (NVIM nvim)

automatically generated reader method

Source

cl-neovim.lisp (file)

6.2.5 Classes

Class: nvim ()

Package

cl-neovim

Source

cl-neovim.lisp (file)

Direct superclasses

client (class)

Direct methods

• client-id (method)
• client-id (method)

Direct slots

Slot: client-id

Readers

client-id (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions