NVIM REFERENCE MANUAL by Thiago de Arruda Type |gO| to see the table of contents. https://github.com/msgpack-rpc/msgpack-rpc/blob/master/spec.md https://github.com/msgpack/msgpack/blob/0b8f5ac/spec.md

• Call any API function
• Listen for events
• Receive remote calls from Nvim nvim --listen 127.0.0.1:6666 #!/usr/bin/env ruby

  Requires msgpack-rpc: gem install msgpack-rpc

  To run this script, execute it from a running Nvim instance (notice the

  trailing '&' which is required since Nvim won't process events while

  running a blocking command):

  :!./hello.rb &

  Or from another shell by setting NVIM_LISTEN_ADDRESS:

  $ NVIM_LISTEN_ADDRESS=[address] ./hello.rb

  require 'msgpack/rpc' require 'msgpack/rpc/transport/unix' nvim = MessagePack::RPC::Client.new(MessagePack::RPC::UNIXTransport.new, ENV['NVIM_LISTEN_ADDRESS']) result = nvim.call(:nvim_command, 'echo "hello world!"')

  from pynvim import attach nvim = attach('socket', path='[address]') nvim.command('echo "hello world!"') let nvim = jobstart(['nvim', '--embed'], {'rpc': v:true}) echo rpcrequest(nvim, 'nvim_eval', '"Hello " . "world!"') call jobstop(nvim) API Type C type

Nil Boolean bool Integer (signed 64-bit integer) int64_t Float (IEEE 754 double precision) double String {char* data, size_t size} struct Array Dictionary (msgpack: map) Object Note: empty Array is accepted as a valid argument for Dictionary parameter. These are integer typedefs discriminated as separate Object subtypes. They can be treated as opaque integers, but are mutually incompatible: Buffer may be passed as an integer but not as Window or Tabpage. The EXT object data is the (integer) object handle. The EXT type codes given in the |api-metadata| types key are stable: they will not change and are thus forward-compatible. EXT Type C type Data

Buffer enum value kObjectTypeBuffer |bufnr()| Window enum value kObjectTypeWindow |window-ID| Tabpage enum value kObjectTypeTabpage internal handle |nvim_get_mark()| |nvim_buf_get_mark()| |nvim_buf_set_mark()| |nvim_win_get_cursor()| |nvim_win_set_cursor()| |nvim_buf_del_extmark()| |nvim_buf_get_extmark_by_id()| |nvim_buf_get_extmarks()| |nvim_buf_set_extmark()| (version.api_prerelease && fn.since == version.api_level) describing the return value and parameters.

• Container types may be decorated with type/size constraints, e.g. ArrayOf(Buffer) or ArrayOf(Integer, 2).
• Functions considered to be methods that operate on instances of Nvim special types (msgpack EXT) have the "method=true" flag. The receiver type is that of the first argument. Method names are prefixed with nvim_ plus a type name, e.g. nvim_buf_get_lines is the get_lines method of a Buffer instance. |dev-api|
• Global functions have the "method=false" flag and are prefixed with just nvim_, e.g. nvim_get_buffers.

1. Connect to a running Nvim instance and call |nvim_get_api_info()| via msgpack-RPC. This is best for clients written in dynamic languages which can define functions at runtime.
2. Start Nvim with |--api-info|. Useful for statically-compiled clients. Example (requires Python "pyyaml" and "msgpack-python" modules): nvim --api-info | python -c 'import msgpack, sys, yaml; print yaml.dump(msgpack.unpackb(sys.stdin.read()))'
3. Use the |api_info()| Vimscript function. :lua print(vim.inspect(vim.fn.api_info())) Example using |filter()| to exclude non-deprecated API functions: :new|put =map(filter(api_info().functions, '!has_key(v:val,''deprecated_since'')'), 'v:val.name')

• Any such extensions are OPTIONAL: old clients may ignore them.
• Functions introduced in the development (unreleased) version MAY CHANGE. (Clients can dynamically check api_prerelease, etc. |api-metadata|) events.
• Any such new items are OPTIONAL: old clients may ignore them.
• Existing items will not be removed (after release). When the buffer text between {firstline} and {lastline} (end-exclusive, zero-indexed) were changed to the new text in the {linedata} list. The granularity is a line, i.e. if a single character is changed in the editor, the entire line is sent. When {changedtick} is |v:null| this means the screen lines (display) changed but not the buffer contents. {linedata} contains the changed screen lines. This happens when 'inccommand' shows a buffer preview. Properties:~ {buf} API buffer handle (buffer number) {changedtick} value of |b:changedtick| for the buffer. If you send an API command back to nvim you can check the value of |b:changedtick| as part of your request to ensure that no other changes have been made. {firstline} integer line number of the first line that was replaced. Zero-indexed: if line 1 was replaced then {firstline} will be 0, not 1. {firstline} is always less than or equal to the number of lines that were in the buffer before the lines were replaced. {lastline} integer line number of the first line that was not replaced (i.e. the range {firstline}, {lastline} is end-exclusive). Zero-indexed: if line numbers 2 to 5 were replaced, this will be 5 instead of 6. {lastline} is always be less than or equal to the number of lines that were in the buffer before the lines were replaced. {lastline} will be -1 if the event is part of the initial update after attaching. {linedata} list of strings containing the contents of the new buffer lines. Newline characters are omitted; empty lines are sent as empty strings. {more} boolean, true for a "multipart" change notification: the current change was chunked into multiple |nvim_buf_lines_event| notifications (e.g. because it was too big). When |b:changedtick| was incremented but no text was changed. Relevant for undo/redo. Properties:~ {buf} API buffer handle (buffer number) {changedtick} new value of |b:changedtick| for the buffer When buffer is detached (i.e. updates are disabled). Triggered explicitly by |nvim_buf_detach()| or implicitly in these cases:
• Buffer was |abandon|ed and 'hidden' is not set.
• Buffer was reloaded, e.g. with |:edit| or an external change triggered |:checktime| or 'autoread'.
• Generally: whenever the buffer contents are unloaded from memory. Properties:~ {buf} API buffer handle (buffer number) nvim_buf_lines_event[{buf}, {changedtick}, 0, -1, [""], v:false] nvim_buf_lines_event[{buf}, {changedtick}, 0, 0, ["line1", "line2"], v:false] nvim_buf_lines_event[{buf}, {changedtick}, {linenr}, {linenr} + 1, ["Hello world!"], v:false] nvim_buf_lines_event[{buf}, {changedtick}, 2, 22, [], v:false] nvim_buf_lines_event[{buf}, {changedtick}, 2, 5, ['pasted line 1', 'pasted line 2', 'pasted line 3', 'pasted line 4', 'pasted line 5', 'pasted line 6'], v:false ] nvim_buf_detach_event[{buf}] vim.api.nvim_buf_get_lines(buf, firstline, new_lastline, true) src = vim.new_highlight_source() buf = vim.current.buffer for i in range(5): buf.add_highlight("String",i,0,-1,src_id=src)

  some time later ...

  buf.clear_namespace(src) call nvim_buf_set_lines(0, 0, 0, v:true, ["test text"]) let src = nvim_buf_add_highlight(0, 0, "String", 1, 0, 4) call nvim_buf_add_highlight(0, src, "Identifier", 0, 5, -1) " some time later ... call nvim_buf_clear_namespace(0, src, 0, -1) let buf = nvim_create_buf(v:false, v:true) call nvim_buf_set_lines(buf, 0, -1, v:true, ["test", "text"]) let opts = {'relative': 'cursor', 'width': 10, 'height': 2, 'col': 0, \ 'row': 1, 'anchor': 'NW', 'style': 'minimal'} let win = nvim_open_win(buf, 0, opts) " optional: change highlight, otherwise Pmenu is used call nvim_win_set_option(win, 'winhl', 'Normal:MyHighlight') f o o b a r line contents 0 1 2 3 4 5 character positions (0-based) 0 1 2 3 4 5 6 extmark positions (0-based) f o o|b a r line (| = cursor) 3 extmark f o o z|b a r line (| = cursor) 4 extmark (after typing "z") f o o z b a r| line (| = cursor) 7 extmark f o o z b a r first line extmarks (none present) | second line (| = cursor) 0 extmark (after typing ) 01 2345678 0 ex|ample.. ^ extmark position let g:mark_ns = nvim_create_namespace('myplugin') let g:mark_id = nvim_buf_set_extmark(0, g:mark_ns, 0, 2, {}) echo nvim_buf_get_extmark_by_id(0, g:mark_ns, g:mark_id, {}) => [0, 2] echo nvim_buf_get_extmarks(0, g:mark_ns, 0, -1, {}) => [[1, 0, 2]] 0 12345678 0 e|ample.. ^ extmark position echo nvim_buf_get_extmark_by_id(0, g:mark_ns, g:mark_id, {}) => [0, 1] Note: Extmark "gravity" decides how it will shift after a text edit. See |nvim_buf_set_extmark()| TODO: Documentation TODO: Documentation Find files in runtime directories Attributes: ~ {fast} Parameters: ~ {pat} pattern of files to search for {all} whether to return all matches or only the first {options} is_lua: only search lua subdirs Return: ~ list of absolute paths to the found files Returns object given as argument. This API function is used for testing. One should not rely on its presence in plugins. Parameters: ~ {obj} Object to return. Return: ~ its argument. Returns array given as argument. This API function is used for testing. One should not rely on its presence in plugins. Parameters: ~ {arr} Array to return. Return: ~ its argument. Returns dictionary given as argument. This API function is used for testing. One should not rely on its presence in plugins. Parameters: ~ {dct} Dictionary to return. Return: ~ its argument. Returns floating-point value given as argument. This API function is used for testing. One should not rely on its presence in plugins. Parameters: ~ {flt} Value to return. Return: ~ its argument. TODO: Documentation TODO: Documentation TODO: Documentation Attributes: ~ {fast} Set active namespace for highlights. NB: this function can be called from async contexts, but the semantics are not yet well-defined. To start with |nvim_set_decoration_provider| on_win and on_line callbacks are explicitly allowed to change the namespace during a redraw cycle. Attributes: ~ {fast} Parameters: ~ {ns_id} the namespace to activate Gets internal stats. Return: ~ Map of various internal stats. Calls many API methods atomically. This has two main usages: 1. To perform several requests from an async context atomically, i.e. without interleaving redraws, RPC requests from other clients, or user interactions (however API methods may trigger autocommands or event processing which have such side-effects, e.g. |:sleep| may wake timers). 2. To minimize RPC overhead (roundtrips) of a sequence of many requests. Parameters: ~ {calls} an array of calls, where each call is described by an array with two elements: the request name, and an array of arguments. Return: ~ Array of two elements. The first is an array of return values. The second is NIL if all calls succeeded. If a call resulted in an error, it is a three-element array with the zero-based index of the call which resulted in an error, the error type and the error message. If an error occurred, the values from all preceding calls will still be returned. Send data to channel id . For a job, it writes it to the stdin of the process. For the stdio channel |channel-stdio|, it writes to Nvim's stdout. For an internal terminal instance (|nvim_open_term()|) it writes directly to terimal output. See |channel-bytes| for more information. This function writes raw data, not RPC messages. If the channel was created with rpc=true then the channel expects RPC messages, use |vim.rpcnotify()| and |vim.rpcrequest()| instead. Parameters: ~ {chan} id of the channel {data} data to write. 8-bit clean: can contain NUL bytes. Creates a new, empty, unnamed buffer. Parameters: ~ {listed} Sets 'buflisted' {scratch} Creates a "throwaway" |scratch-buffer| for temporary work (always 'nomodified'). Also sets 'nomodeline' on the buffer. Return: ~ Buffer handle, or 0 on error See also: ~ buf_open_scratch Deletes the current line. Attributes: ~ not allowed when |textlock| is active Unmaps a global |mapping| for the given mode. To unmap a buffer-local mapping, use |nvim_buf_del_keymap()|. See also: ~ |nvim_set_keymap()| Deletes a uppercase/file named mark. See |mark-motions|. Note: fails with error if a lowercase or buffer local named mark is used. Parameters: ~ {name} Mark name Return: ~ true if the mark was deleted, else false. See also: ~ |nvim_buf_del_mark()| |nvim_get_mark()| Removes a global (g:) variable. Parameters: ~ {name} Variable name Echo a message. Parameters: ~ {chunks} A list of [text, hl_group] arrays, each representing a text chunk with specified highlight. hl_group element can be omitted for no highlight. {history} if true, add to |message-history|. {opts} Optional parameters. Reserved for future use. Writes a message to the Vim error buffer. Does not append "\n", the message is buffered (won't display) until a linefeed is written. Parameters: ~ {str} Message Writes a message to the Vim error buffer. Appends "\n", so the buffer is flushed (and displayed). Parameters: ~ {str} Message See also: ~ nvim_err_write() Evaluates statusline string. Attributes: ~ {fast} Parameters: ~ {str} Statusline string (see 'statusline'). {opts} Optional parameters. • winid: (number) |window-ID| of the window to use as context for statusline. • maxwidth: (number) Maximum width of statusline. • fillchar: (string) Character to fill blank spaces in the statusline (see 'fillchars'). • highlights: (boolean) Return highlight information. • use_tabline: (boolean) Evaluate tabline instead of statusline. When |TRUE|, {winid} is ignored. Return: ~ Dictionary containing statusline information, with these keys: • str: (string) Characters that will be displayed on the statusline. • width: (number) Display width of the statusline. • highlights: Array containing highlight information of the statusline. Only included when the "highlights" key in {opts} is |TRUE|. Each element of the array is a |Dictionary| with these keys: • start: (number) Byte index (0-based) of first character that uses the highlight. • group: (string) Name of highlight group. Execute Lua code. Parameters (if any) are available as ... inside the chunk. The chunk can return a value. Only statements are executed. To evaluate an expression, prefix it with return : return my_function(...) Parameters: ~ {code} Lua code to execute {args} Arguments to the code Return: ~ Return value of Lua code if present or NIL. Sends input-keys to Nvim, subject to various quirks controlled by mode flags. This is a blocking call, unlike |nvim_input()|. On execution error: does not fail, but updates v:errmsg. To input sequences like use |nvim_replace_termcodes()| (typically with escape_csi=true) to replace |keycodes|, then pass the result to nvim_feedkeys(). Example: :let key = nvim_replace_termcodes("", v:true, v:false, v:true) :call nvim_feedkeys(key, 'n', v:true) Parameters: ~ {keys} to be typed {mode} behavior flags, see |feedkeys()| {escape_csi} If true, escape K_SPECIAL/CSI bytes in keys See also: ~ feedkeys() vim_strsave_escape_csi Gets the option information for all options. The dictionary has the full option names as keys and option metadata dictionaries as detailed at |nvim_get_option_info|. Return: ~ dictionary of all options Returns a 2-tuple (Array), where item 0 is the current channel id and item 1 is the |api-metadata| map (Dictionary). Return: ~ 2-tuple [{channel-id}, {api-metadata}] Attributes: ~ {fast} Gets information about a channel. Return: ~ Dictionary describing a channel, with these keys: • "id" Channel id. • "argv" (optional) Job arguments list. • "stream" Stream underlying the channel. • "stdio" stdin and stdout of this Nvim instance • "stderr" stderr of this Nvim instance • "socket" TCP/IP socket or named pipe • "job" Job with communication over its stdio. • "mode" How data received on the channel is interpreted. • "bytes" Send and receive raw bytes. • "terminal" |terminal| instance interprets ASCII sequences. • "rpc" |RPC| communication on the channel is active. • "pty" (optional) Name of pseudoterminal. On a POSIX system this is a device path like "/dev/pts/1". If the name is unknown, the key will still be present if a pty is used (e.g. for winpty on Windows). • "buffer" (optional) Buffer with connected |terminal| instance. • "client" (optional) Info about the peer (client on the other end of the RPC channel), if provided by it via |nvim_set_client_info()|. Returns the 24-bit RGB value of a |nvim_get_color_map()| color name or "#rrggbb" hexadecimal string. Example: :echo nvim_get_color_by_name("Pink") :echo nvim_get_color_by_name("#cbcbcb") Parameters: ~ {name} Color name or "#rrggbb" string Return: ~ 24-bit RGB value, or -1 for invalid argument. Returns a map of color names and RGB values. Keys are color names (e.g. "Aqua") and values are 24-bit RGB color values (e.g. 65535). Return: ~ Map of color names and RGB values. Gets a map of global (non-buffer-local) Ex commands. Currently only |user-commands| are supported, not builtin Ex commands. Parameters: ~ {opts} Optional parameters. Currently only supports {"builtin":false} Return: ~ Map of maps describing commands. Gets a map of the current editor state. Parameters: ~ {opts} Optional parameters. • types: List of |context-types| ("regs", "jumps", "bufs", "gvars", …) to gather, or empty for "all". Return: ~ map of global |context|. Gets the current buffer. Return: ~ Buffer handle Gets the current line. Return: ~ Current line string Gets the current tabpage. Return: ~ Tabpage handle Gets the current window. Return: ~ Window handle Gets a highlight definition by id. |hlID()| Parameters: ~ {hl_id} Highlight id as returned by |hlID()| {rgb} Export RGB colors Return: ~ Highlight definition map See also: ~ nvim_get_hl_by_name Gets a highlight definition by name. Parameters: ~ {name} Highlight group name {rgb} Export RGB colors Return: ~ Highlight definition map See also: ~ nvim_get_hl_by_id Gets a highlight group by name similar to |hlID()|, but allocates a new ID if not present. Gets a list of global (non-buffer-local) |mapping| definitions. Parameters: ~ {mode} Mode short-name ("n", "i", "v", ...) Return: ~ Array of maparg()-like dictionaries describing mappings. The "buffer" key is always zero. Return a tuple (row, col, buffer, buffername) representing the position of the uppercase/file named mark. See |mark-motions|. Marks are (1,0)-indexed. |api-indexing| Note: fails with error if a lowercase or buffer local named mark is used. Parameters: ~ {name} Mark name {opts} Optional parameters. Reserved for future use. Return: ~ 4-tuple (row, col, buffer, buffername), (0, 0, 0, '') if the mark is not set. See also: ~ |nvim_buf_set_mark()| |nvim_del_mark()| Gets the current mode. |mode()| "blocking" is true if Nvim is waiting for input. Return: ~ Dictionary { "mode": String, "blocking": Boolean } Attributes: ~ {fast} Gets an option value string. Parameters: ~ {name} Option name Return: ~ Option value (global) Gets the option information for one option Resulting dictionary has keys: • name: Name of the option (like 'filetype') • shortname: Shortened name of the option (like 'ft') • type: type of option ("string", "number" or "boolean") • default: The default value for the option • was_set: Whether the option was set. • last_set_sid: Last set script id (if any) • last_set_linenr: line number where option was set • last_set_chan: Channel where option was set (0 for local) • scope: one of "global", "win", or "buf" • global_local: whether win or buf option has a global value • commalist: List of comma separated values • flaglist: List of single char flags Parameters: ~ {name} Option name Return: ~ Option Information Gets info describing process pid . Return: ~ Map of process properties, or NIL if process not found. Gets the immediate children of process pid . Return: ~ Array of child process ids, empty if process not found. Find files in runtime directories 'name' can contain wildcards. For example nvim_get_runtime_file("colors/*.vim", true) will return all color scheme files. Always use forward slashes (/) in the search pattern for subdirectories regardless of platform. It is not an error to not find any files. An empty array is returned then. Attributes: ~ {fast} Parameters: ~ {name} pattern of files to search for {all} whether to return all matches or only the first Return: ~ list of absolute paths to the found files Gets a global (g:) variable. Parameters: ~ {name} Variable name Return: ~ Variable value Gets a v: variable. Parameters: ~ {name} Variable name Return: ~ Variable value Queues raw user-input. Unlike |nvim_feedkeys()|, this uses a low-level input buffer and the call is non-blocking (input is processed asynchronously by the eventloop). On execution error: does not fail, but updates v:errmsg. Note: |keycodes| like are translated, so "<" is special. To input a literal "<", send . Note: For mouse events use |nvim_input_mouse()|. The pseudokey form "<col,row>" is deprecated since |api-level| 6. Attributes: ~ {fast} Parameters: ~ {keys} to be typed Return: ~ Number of bytes actually written (can be fewer than requested if the buffer becomes full). Send mouse event from GUI. Non-blocking: does not wait on any result, but queues the event to be processed soon by the event loop. Note: Currently this doesn't support "scripting" multiple mouse events by calling it multiple times in a loop: the intermediate mouse positions will be ignored. It should be used to implement real-time mouse input in a GUI. The deprecated pseudokey form ("<col,row>") of |nvim_input()| has the same limitation. Attributes: ~ {fast} Parameters: ~ {button} Mouse button: one of "left", "right", "middle", "wheel". {action} For ordinary buttons, one of "press", "drag", "release". For the wheel, one of "up", "down", "left", "right". {modifier} String of modifiers each represented by a single char. The same specifiers are used as for a key press, except that the "-" separator is optional, so "C-A-", "c-a" and "CA" can all be used to specify Ctrl+Alt+click. {grid} Grid number if the client uses |ui-multigrid|, else 0. {row} Mouse row-position (zero-based, like redraw events) {col} Mouse column-position (zero-based, like redraw events) Gets the current list of buffer handles Includes unlisted (unloaded/deleted) buffers, like :ls! . Use |nvim_buf_is_loaded()| to check if a buffer is loaded. Return: ~ List of buffer handles Get information about all open channels. Return: ~ Array of Dictionaries, each describing a channel with the format specified at |nvim_get_chan_info()|. Gets the paths contained in 'runtimepath'. Return: ~ List of paths Gets the current list of tabpage handles. Return: ~ List of tabpage handles Gets a list of dictionaries representing attached UIs. Return: ~ Array of UI dictionaries, each with these keys: • "height" Requested height of the UI • "width" Requested width of the UI • "rgb" true if the UI uses RGB colors (false implies |cterm-colors|) • "ext_..." Requested UI extensions, see |ui-option| • "chan" Channel id of remote UI (not present for TUI) Gets the current list of window handles. Return: ~ List of window handles Sets the current editor state from the given |context| map. Parameters: ~ {dict} |Context| map. Notify the user with a message Relays the call to vim.notify . By default forwards your message in the echo area but can be overridden to trigger desktop notifications. Parameters: ~ {msg} Message to display to the user {log_level} The log level {opts} Reserved for future use. Open a terminal instance in a buffer By default (and currently the only option) the terminal will not be connected to an external process. Instead, input send on the channel will be echoed directly by the terminal. This is useful to display ANSI terminal sequences returned as part of a rpc message, or similar. Note: to directly initiate the terminal using the right size, display the buffer in a configured window before calling this. For instance, for a floating display, first create an empty buffer using |nvim_create_buf()|, then display it using |nvim_open_win()|, and then call this function. Then |nvim_chan_send()| can be called immediately to process sequences in a virtual terminal having the intended size. Parameters: ~ {buffer} the buffer to use (expected to be empty) {opts} Optional parameters. • on_input: lua callback for input sent, i e keypresses in terminal mode. Note: keypresses are sent raw as they would be to the pty master end. For instance, a carriage return is sent as a "\r", not as a "\n". |textlock| applies. It is possible to call |nvim_chan_send| directly in the callback however. ["input", term, bufnr, data] Return: ~ Channel id, or 0 on error Writes a message to the Vim output buffer. Does not append "\n", the message is buffered (won't display) until a linefeed is written. Parameters: ~ {str} Message Pastes at cursor, in any mode. Invokes the vim.paste handler, which handles each mode appropriately. Sets redo/undo. Faster than |nvim_input()|. Lines break at LF ("\n"). Errors ('nomodifiable', vim.paste() failure, …) are reflected in err but do not affect the return value (which is strictly decided by vim.paste() ). On error, subsequent calls are ignored ("drained") until the next paste is initiated (phase 1 or -1). Attributes: ~ not allowed when |textlock| is active Parameters: ~ {data} Multiline input. May be binary (containing NUL bytes). {crlf} Also break lines at CR and CRLF. {phase} -1: paste in a single call (i.e. without streaming). To "stream" a paste, call nvim_paste sequentially with these phase values: • 1: starts the paste (exactly once) • 2: continues the paste (zero or more times) • 3: ends the paste (exactly once) Return: ~ • true: Client may continue pasting. • false: Client must cancel the paste. Puts text at cursor, in any mode. Compare |:put| and |p| which are always linewise. Attributes: ~ not allowed when |textlock| is active Parameters: ~ {lines} |readfile()|-style list of lines. |channel-lines| {type} Edit behavior: any |getregtype()| result, or: • "b" |blockwise-visual| mode (may include width, e.g. "b3") • "c" |charwise| mode • "l" |linewise| mode • "" guess by contents, see |setreg()| {after} If true insert after cursor (like |p|), or before (like |P|). {follow} If true place cursor at end of inserted text. Replaces terminal codes and |keycodes| (, , ...) in a string with the internal representation. Parameters: ~ {str} String to be converted. {from_part} Legacy Vim parameter. Usually true. {do_lt} Also translate . Ignored if special is false. {special} Replace |keycodes|, e.g. becomes a "\n" char. See also: ~ replace_termcodes cpoptions Selects an item in the completion popupmenu. If |ins-completion| is not active this API call is silently ignored. Useful for an external UI using |ui-popupmenu| to control the popupmenu with the mouse. Can also be used in a mapping; use |:map-cmd| to ensure the mapping doesn't end completion mode. Parameters: ~ {item} Index (zero-based) of the item to select. Value of -1 selects nothing and restores the original text. {insert} Whether the selection should be inserted in the buffer. {finish} Finish the completion and dismiss the popupmenu. Implies insert . {opts} Optional parameters. Reserved for future use. Self-identifies the client. The client/plugin/application should call this after connecting, to provide hints about its identity and purpose, for debugging and orchestration. Can be called more than once; the caller should merge old info if appropriate. Example: library first identifies the channel, then a plugin using that library later identifies itself. Note: "Something is better than nothing". You don't need to include all the fields. Parameters: ~ {name} Short name for the connected client {version} Dictionary describing the version, with these (optional) keys: • "major" major version (defaults to 0 if not set, for no release yet) • "minor" minor version • "patch" patch number • "prerelease" string describing a prerelease, like "dev" or "beta1" • "commit" hash or similar identifier of commit {type} Must be one of the following values. Client libraries should default to "remote" unless overridden by the user. • "remote" remote client connected to Nvim. • "ui" gui frontend • "embedder" application using Nvim as a component (for example, IDE/editor implementing a vim mode). • "host" plugin host, typically started by nvim • "plugin" single plugin, started by nvim {methods} Builtin methods in the client. For a host, this does not include plugin methods which will be discovered later. The key should be the method name, the values are dicts with these (optional) keys (more keys may be added in future versions of Nvim, thus unknown keys are ignored. Clients must only use keys defined in this or later versions of Nvim): • "async" if true, send as a notification. If false or unspecified, use a blocking request • "nargs" Number of arguments. Could be a single integer or an array of two integers, minimum and maximum inclusive. {attributes} Arbitrary string:string map of informal client properties. Suggested keys: • "website": Client homepage URL (e.g. GitHub repository) • "license": License description ("Apache 2", "GPLv3", "MIT", …) • "logo": URI or path to image, preferably small logo or icon. .png or .svg format is preferred. Sets the current buffer. Attributes: ~ not allowed when |textlock| is active Parameters: ~ {buffer} Buffer handle Changes the global working directory. Parameters: ~ {dir} Directory path Sets the current line. Attributes: ~ not allowed when |textlock| is active Parameters: ~ {line} Line contents Sets the current tabpage. Attributes: ~ not allowed when |textlock| is active Parameters: ~ {tabpage} Tabpage handle Sets the current window. Attributes: ~ not allowed when |textlock| is active Parameters: ~ {window} Window handle Set a highlight group. TODO: ns_id = 0, should modify :highlight namespace TODO val should take update vs reset flag Parameters: ~ {ns_id} number of namespace for this highlight {name} highlight group name, like ErrorMsg {val} highlight definition map, like |nvim_get_hl_by_name|. in addition the following keys are also recognized: default : don't override existing definition, like hi default ctermfg : sets foreground of cterm color ctermbg : sets background of cterm color cterm : cterm attribute map. sets attributed for cterm colors. similer to hi cterm Note: by default cterm attributes are same as attributes of gui color Sets a global |mapping| for the given mode. To set a buffer-local mapping, use |nvim_buf_set_keymap()|. Unlike |:map|, leading/trailing whitespace is accepted as part of the {lhs} or {rhs}. Empty {rhs} is ||. |keycodes| are replaced as usual. Example: call nvim_set_keymap('n', ' ', '', {'nowait': v:true}) is equivalent to: nmap <Nop Parameters: ~ {mode} Mode short-name (map command prefix: "n", "i", "v", "x", …) or "!" for |:map!|, or empty string for |:map|. {lhs} Left-hand-side |{lhs}| of the mapping. {rhs} Right-hand-side |{rhs}| of the mapping. {opts} Optional parameters map. Accepts all |:map-arguments| as keys excluding || but including |noremap|. Values are Booleans. Unknown key is an error. Sets an option value. Parameters: ~ {name} Option name {value} New option value Sets a global (g:) variable. Parameters: ~ {name} Variable name {value} Variable value Sets a v: variable, if it is not readonly. Parameters: ~ {name} Variable name {value} Variable value Calculates the number of display cells occupied by text . counts as one cell. Parameters: ~ {text} Some text Return: ~ Number of cells Subscribes to event broadcasts. Parameters: ~ {event} Event type string Unsubscribes to event broadcasts. Parameters: ~ {event} Event type string Calls a VimL |Dictionary-function| with the given arguments. On execution error: fails with VimL error, does not update v:errmsg. Parameters: ~ {dict} Dictionary, or String evaluating to a VimL |self| dict {fn} Name of the function defined on the VimL dict {args} Function arguments packed in an Array Return: ~ Result of the function call Calls a VimL function with the given arguments. On execution error: fails with VimL error, does not update v:errmsg. Parameters: ~ {fn} Function to call {args} Function arguments packed in an Array Return: ~ Result of the function call Executes an ex-command. On execution error: fails with VimL error, does not update v:errmsg. Parameters: ~ {command} Ex-command string See also: ~ |nvim_exec()| Evaluates a VimL |expression|. Dictionaries and Lists are recursively expanded. On execution error: fails with VimL error, does not update v:errmsg. Parameters: ~ {expr} VimL expression string Return: ~ Evaluation result or expanded object Executes Vimscript (multiline block of Ex-commands), like anonymous |:source|. Unlike |nvim_command()| this function supports heredocs, script-scope (s:), etc. On execution error: fails with VimL error, does not update v:errmsg. Parameters: ~ {src} Vimscript code {output} Capture and return all (non-error, non-shell |:!|) output Return: ~ Output (non-error, non-shell |:!|) if output is true, else empty string. See also: ~ |execute()| |nvim_command()| Parse a VimL expression. Attributes: ~ {fast} Parameters: ~ {expr} Expression to parse. Always treated as a single line. {flags} Flags: • "m" if multiple expressions in a row are allowed (only the first one will be parsed), • "E" if EOC tokens are not allowed (determines whether they will stop parsing process or be recognized as an operator/space, though also yielding an error). • "l" when needing to start parsing with lvalues for ":let" or ":for". Common flag sets: • "m" to parse like for ":echo". • "E" to parse like for "=". • empty string for ":call". • "lm" to parse for ":let". {highlight} If true, return value will also include "highlight" key containing array of 4-tuples (arrays) (Integer, Integer, Integer, String), where first three numbers define the highlighted region and represent line, starting column and ending column (latter exclusive: one should highlight region [start_col, end_col)). Return: ~ • AST: top-level dictionary with these keys: • "error": Dictionary with error, present only if parser saw some error. Contains the following keys: • "message": String, error message in printf format, translated. Must contain exactly one "%.*s". • "arg": String, error message argument. • "len": Amount of bytes successfully parsed. With flags equal to "" that should be equal to the length of expr string. (“Successfully parsed” here means “participated in AST creation”, not “till the first error”.) • "ast": AST, either nil or a dictionary with these keys: • "type": node type, one of the value names from ExprASTNodeType stringified without "kExprNode" prefix. • "start": a pair [line, column] describing where node is "started" where "line" is always 0 (will not be 0 if you will be using nvim_parse_viml() on e.g. ":let", but that is not present yet). Both elements are Integers. • "len": “length” of the node. This and "start" are there for debugging purposes primary (debugging parser and providing debug information). • "children": a list of nodes described in top/"ast". There always is zero, one or two children, key will not be present if node has no children. Maximum number of children may be found in node_maxchildren array. • Local values (present only for certain nodes): • "scope": a single Integer, specifies scope for "Option" and "PlainIdentifier" nodes. For "Option" it is one of ExprOptScope values, for "PlainIdentifier" it is one of ExprVarScope values. • "ident": identifier (without scope, if any), present for "Option", "PlainIdentifier", "PlainKey" and "Environment" nodes. • "name": Integer, register name (one character) or -1. Only present for "Register" nodes. • "cmp_type": String, comparison type, one of the value names from ExprComparisonType, stringified without "kExprCmp" prefix. Only present for "Comparison" nodes. • "ccs_strategy": String, case comparison strategy, one of the value names from ExprCaseCompareStrategy, stringified without "kCCStrategy" prefix. Only present for "Comparison" nodes. • "augmentation": String, augmentation type for "Assignment" nodes. Is either an empty string, "Add", "Subtract" or "Concat" for "=", "+=", "-=" or ".=" respectively. • "invert": Boolean, true if result of comparison needs to be inverted. Only present for "Comparison" nodes. • "ivalue": Integer, integer value for "Integer" nodes. • "fvalue": Float, floating-point value for "Float" nodes. • "svalue": String, value for "SingleQuotedString" and "DoubleQuotedString" nodes. TODO: Documentation TODO: Documentation Activates buffer-update events on a channel, or as Lua callbacks. Example (Lua): capture buffer updates in a global events variable (use "print(vim.inspect(events))" to see its contents): events = {} vim.api.nvim_buf_attach(0, false, { on_lines=function(...) table.insert(events, {...}) end}) Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {send_buffer} True if the initial notification should contain the whole buffer: first notification will be nvim_buf_lines_event . Else the first notification will be nvim_buf_changedtick_event . Not for Lua callbacks. {opts} Optional parameters. • on_lines: Lua callback invoked on change. Return true to detach. Args: • the string "lines" • buffer handle • b:changedtick • first line that changed (zero-indexed) • last line that was changed • last line in the updated range • byte count of previous contents • deleted_codepoints (if utf_sizes is true) • deleted_codeunits (if utf_sizes is true) • on_bytes: lua callback invoked on change. This callback receives more granular information about the change compared to on_lines. Return true to detach. Args: • the string "bytes" • buffer handle • b:changedtick • start row of the changed text (zero-indexed) • start column of the changed text • byte offset of the changed text (from the start of the buffer) • old end row of the changed text • old end column of the changed text • old end byte length of the changed text • new end row of the changed text • new end column of the changed text • new end byte length of the changed text • on_changedtick: Lua callback invoked on changedtick increment without text change. Args: • the string "changedtick" • buffer handle • b:changedtick • on_detach: Lua callback invoked on detach. Args: • the string "detach" • buffer handle • on_reload: Lua callback invoked on reload. The entire buffer content should be considered changed. Args: • the string "detach" • buffer handle • utf_sizes: include UTF-32 and UTF-16 size of the replaced region, as args to on_lines . • preview: also attach to command preview (i.e. 'inccommand') events. Return: ~ False if attach failed (invalid parameter, or buffer isn't loaded); otherwise True. TODO: LUA_API_NO_EVAL See also: ~ |nvim_buf_detach()| |api-buffer-updates-lua| call a function with buffer as temporary current buffer This temporarily switches current buffer to "buffer". If the current window already shows "buffer", the window is not switched If a window inside the current tabpage (including a float) already shows the buffer One of these windows will be set as current window temporarily. Otherwise a temporary scratch window (called the "autocmd window" for historical reasons) will be used. This is useful e.g. to call vimL functions that only work with the current buffer/window currently, like |termopen()|. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {fun} Function to call inside the buffer (currently lua callable only) Return: ~ Return value of function. NB: will deepcopy lua values currently, use upvalues to send lua references in and out. Unmaps a buffer-local |mapping| for the given mode. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer See also: ~ |nvim_del_keymap()| Deletes a named mark in the buffer. See |mark-motions|. Note: only deletes marks set in the buffer, if the mark is not set in the buffer it will return false. Parameters: ~ {buffer} Buffer to set the mark on {name} Mark name Return: ~ true if the mark was deleted, else false. See also: ~ |nvim_buf_set_mark()| |nvim_del_mark()| Removes a buffer-scoped (b:) variable Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {name} Variable name Deletes the buffer. See |:bwipeout| Attributes: ~ not allowed when |textlock| is active Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {opts} Optional parameters. Keys: • force: Force deletion and ignore unsaved changes. • unload: Unloaded only, do not delete. See |:bunload| Deactivates buffer-update events on the channel. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer Return: ~ False if detach failed (because the buffer isn't loaded); otherwise True. See also: ~ |nvim_buf_attach()| |api-lua-detach| for detaching Lua callbacks Gets a changed tick of a buffer Parameters: ~ {buffer} Buffer handle, or 0 for current buffer Return: ~ b:changedtick value. Gets a map of buffer-local |user-commands|. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {opts} Optional parameters. Currently not used. Return: ~ Map of maps describing commands. Gets a list of buffer-local |mapping| definitions. Parameters: ~ {mode} Mode short-name ("n", "i", "v", ...) {buffer} Buffer handle, or 0 for current buffer Return: ~ Array of maparg()-like dictionaries describing mappings. The "buffer" key holds the associated buffer handle. Gets a line-range from the buffer. Indexing is zero-based, end-exclusive. Negative indices are interpreted as length+1+index: -1 refers to the index past the end. So to get the last element use start=-2 and end=-1. Out-of-bounds indices are clamped to the nearest valid value, unless strict_indexing is set. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {start} First line index {end} Last line index (exclusive) {strict_indexing} Whether out-of-bounds should be an error. Return: ~ Array of lines, or empty array for unloaded buffer. Returns a tuple (row,col) representing the position of the named mark. See |mark-motions|. Marks are (1,0)-indexed. |api-indexing| Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {name} Mark name Return: ~ (row, col) tuple, (0, 0) if the mark is not set, or is an uppercase/file mark set in another buffer. See also: ~ |nvim_buf_set_mark()| |nvim_buf_del_mark()| Gets the full file name for the buffer Parameters: ~ {buffer} Buffer handle, or 0 for current buffer Return: ~ Buffer name Returns the byte offset of a line (0-indexed). |api-indexing| Line 1 (index=0) has offset 0. UTF-8 bytes are counted. EOL is one byte. 'fileformat' and 'fileencoding' are ignored. The line index just after the last line gives the total byte-count of the buffer. A final EOL byte is counted if it would be written, see 'eol'. Unlike |line2byte()|, throws error for out-of-bounds indexing. Returns -1 for unloaded buffer. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {index} Line index Return: ~ Integer byte offset, or -1 for unloaded buffer. Gets a buffer option value Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {name} Option name Return: ~ Option value Gets a buffer-scoped (b:) variable. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {name} Variable name Return: ~ Variable value Checks if a buffer is valid and loaded. See |api-buffer| for more info about unloaded buffers. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer Return: ~ true if the buffer is valid and loaded, false otherwise. Checks if a buffer is valid. Note: Even if a buffer is valid it may have been unloaded. See |api-buffer| for more info about unloaded buffers. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer Return: ~ true if the buffer is valid, false otherwise. Gets the buffer line count Parameters: ~ {buffer} Buffer handle, or 0 for current buffer Return: ~ Line count, or 0 for unloaded buffer. |api-buffer| Sets a buffer-local |mapping| for the given mode. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer See also: ~ |nvim_set_keymap()| Sets (replaces) a line-range in the buffer. Indexing is zero-based, end-exclusive. Negative indices are interpreted as length+1+index: -1 refers to the index past the end. So to change or delete the last element use start=-2 and end=-1. To insert lines at a given index, set start and end to the same index. To delete a range of lines, set replacement to an empty array. Out-of-bounds indices are clamped to the nearest valid value, unless strict_indexing is set. Attributes: ~ not allowed when |textlock| is active Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {start} First line index {end} Last line index (exclusive) {strict_indexing} Whether out-of-bounds should be an error. {replacement} Array of lines to use as replacement Sets a named mark in the given buffer, all marks are allowed file/uppercase, visual, last change, etc. See |mark-motions|. Marks are (1,0)-indexed. |api-indexing| Note: Passing 0 as line deletes the mark Parameters: ~ {buffer} Buffer to set the mark on {name} Mark name {line} Line number {col} Column/row number {opts} Optional parameters. Reserved for future use. Return: ~ true if the mark was set, else false. See also: ~ |nvim_buf_del_mark()| |nvim_buf_get_mark()| Sets the full file name for a buffer Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {name} Buffer name Sets a buffer option value. Passing 'nil' as value deletes the option (only works if there's a global fallback) Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {name} Option name {value} Option value {replacement}) Sets (replaces) a range in the buffer This is recommended over nvim_buf_set_lines when only modifying parts of a line, as extmarks will be preserved on non-modified parts of the touched lines. Indexing is zero-based and end-exclusive. To insert text at a given index, set start and end ranges to the same index. To delete a range, set replacement to an array containing an empty string, or simply an empty array. Prefer nvim_buf_set_lines when adding or deleting entire lines only. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {start_row} First line index {start_column} First column {end_row} Last line index {end_column} Last column {replacement} Array of lines to use as replacement Sets a buffer-scoped (b:) variable Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {name} Variable name {value} Variable value {col_end}) Adds a highlight to buffer. Useful for plugins that dynamically generate highlights to a buffer (like a semantic highlighter or linter). The function adds a single highlight to a buffer. Unlike |matchaddpos()| highlights follow changes to line numbering (as lines are inserted/removed above the highlighted line), like signs and marks do. Namespaces are used for batch deletion/updating of a set of highlights. To create a namespace, use |nvim_create_namespace()| which returns a namespace id. Pass it in to this function as ns_id to add highlights to the namespace. All highlights in the same namespace can then be cleared with single call to |nvim_buf_clear_namespace()|. If the highlight never will be deleted by an API call, pass ns_id = -1 . As a shorthand, ns_id = 0 can be used to create a new namespace for the highlight, the allocated id is then returned. If hl_group is the empty string no highlight is added, but a new ns_id is still returned. This is supported for backwards compatibility, new code should use |nvim_create_namespace()| to create a new empty namespace. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {ns_id} namespace to use or -1 for ungrouped highlight {hl_group} Name of the highlight group to use {line} Line to highlight (zero-indexed) {col_start} Start of (byte-indexed) column range to highlight {col_end} End of (byte-indexed) column range to highlight, or -1 to highlight to end of line Return: ~ The ns_id that was used Clears namespaced objects (highlights, extmarks, virtual text) from a region. Lines are 0-indexed. |api-indexing| To clear the namespace in the entire buffer, specify line_start=0 and line_end=-1. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {ns_id} Namespace to clear, or -1 to clear all namespaces. {line_start} Start of range of lines to clear {line_end} End of range of lines to clear (exclusive) or -1 to clear to end of buffer. Removes an extmark. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {ns_id} Namespace id from |nvim_create_namespace()| {id} Extmark id Return: ~ true if the extmark was found, else false Gets the position (0-indexed) of an extmark. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {ns_id} Namespace id from |nvim_create_namespace()| {id} Extmark id {opts} Optional parameters. Keys: • details: Whether to include the details dict Return: ~ 0-indexed (row, col) tuple or empty list () if extmark id was absent Gets extmarks in "traversal order" from a |charwise| region defined by buffer positions (inclusive, 0-indexed |api-indexing|). Region can be given as (row,col) tuples, or valid extmark ids (whose positions define the bounds). 0 and -1 are understood as (0,0) and (-1,-1) respectively, thus the following are equivalent: nvim_buf_get_extmarks(0, my_ns, 0, -1, {}) nvim_buf_get_extmarks(0, my_ns, [0,0], [-1,-1], {}) If end is less than start , traversal works backwards. (Useful with limit , to get the first marks prior to a given position.) Example: local a = vim.api local pos = a.nvim_win_get_cursor(0) local ns = a.nvim_create_namespace('my-plugin') -- Create new extmark at line 1, column 1. local m1 = a.nvim_buf_set_extmark(0, ns, 0, 0, 0, {}) -- Create new extmark at line 3, column 1. local m2 = a.nvim_buf_set_extmark(0, ns, 0, 2, 0, {}) -- Get extmarks only from line 3. local ms = a.nvim_buf_get_extmarks(0, ns, {2,0}, {2,0}, {}) -- Get all marks in this buffer + namespace. local all = a.nvim_buf_get_extmarks(0, ns, 0, -1, {}) print(vim.inspect(ms)) Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {ns_id} Namespace id from |nvim_create_namespace()| {start} Start of range: a 0-indexed (row, col) or valid extmark id (whose position defines the bound). |api-indexing| {end} End of range (inclusive): a 0-indexed (row, col) or valid extmark id (whose position defines the bound). |api-indexing| {opts} Optional parameters. Keys: • limit: Maximum number of marks to return • details Whether to include the details dict Return: ~ List of [extmark_id, row, col] tuples in "traversal order". Creates or updates an extmark. To create a new extmark, pass id=0. The extmark id will be returned. To move an existing mark, pass its id. It is also allowed to create a new mark by passing in a previously unused id, but the caller must then keep track of existing and unused ids itself. (Useful over RPC, to avoid waiting for the return value.) Using the optional arguments, it is possible to use this to highlight a range of text, and also to associate virtual text to the mark. Parameters: ~ {buffer} Buffer handle, or 0 for current buffer {ns_id} Namespace id from |nvim_create_namespace()| {line} Line where to place the mark, 0-based. |api-indexing| {col} Column where to place the mark, 0-based. |api-indexing| {opts} Optional parameters. • id : id of the extmark to edit. • end_line : ending line of the mark, 0-based inclusive. • end_col : ending col of the mark, 0-based exclusive. • hl_group : name of the highlight group used to highlight this mark. • hl_eol : when true, for a multiline highlight covering the EOL of a line, continue the highlight for the rest of the screen line (just like for diff and cursorline highlight). • virt_text : virtual text to link to this mark. A list of [text, highlight] tuples, each representing a text chunk with specified highlight. highlight element can either be a a single highlight group, or an array of multiple highlight groups that will be stacked (highest priority last). A highlight group can be supplied either as a string or as an integer, the latter which can be obtained using |nvim_get_hl_id_by_name|. • virt_text_pos : position of virtual text. Possible values: • "eol": right after eol character (default) • "overlay": display over the specified column, without shifting the underlying text. • "right_align": display right aligned in the window. • virt_text_win_col : position the virtual text at a fixed window column (starting from the first text column) • virt_text_hide : hide the virtual text when the background text is selected or hidden due to horizontal scroll 'nowrap' • hl_mode : control how highlights are combined with the highlights of the text. Currently only affects virt_text highlights, but might affect hl_group in later versions. • "replace": only show the virt_text color. This is the default • "combine": combine with background text color • "blend": blend with background text color. • virt_lines : virtual lines to add next to this mark This should be an array over lines, where each line in turn is an array over [text, highlight] tuples. In general, buffer and window options do not affect the display of the text. In particular 'wrap' and 'linebreak' options do not take effect, so the number of extra screen lines will always match the size of the array. However the 'tabstop' buffer option is still used for hard tabs. By default lines are placed below the buffer line containing the mark. • virt_lines_above: place virtual lines above instead. • virt_lines_leftcol: Place extmarks in the leftmost column of the window, bypassing sign and number columns. • ephemeral : for use with |nvim_set_decoration_provider| callbacks. The mark will only be used for the current redraw cycle, and not be permantently stored in the buffer. • right_gravity : boolean that indicates the direction the extmark will be shifted in when new text is inserted (true for right, false for left). defaults to true. • end_right_gravity : boolean that indicates the direction the extmark end position (if it exists) will be shifted in when new text is inserted (true for right, false for left). Defaults to false. • priority: a priority value for the highlight group. For example treesitter highlighting uses a value of 100. Return: ~ Id of the created/updated extmark Creates a new or gets an existing one. Namespaces are used for buffer highlights and virtual text, see |nvim_buf_add_highlight()| and |nvim_buf_set_extmark()|. Namespaces can be named or anonymous. If name matches an existing namespace, the associated id is returned. If name is an empty string a new, anonymous namespace is created. Parameters: ~ {name} Namespace name or empty string Return: ~ Namespace id Gets existing, non-anonymous namespaces. Return: ~ dict that maps from names to namespace ids. Set or change decoration provider for a namespace This is a very general purpose interface for having lua callbacks being triggered during the redraw code. The expected usage is to set extmarks for the currently redrawn buffer. |nvim_buf_set_extmark| can be called to add marks on a per-window or per-lines basis. Use the ephemeral key to only use the mark for the current screen redraw (the callback will be called again for the next redraw ). Note: this function should not be called often. Rather, the callbacks themselves can be used to throttle unneeded callbacks. the on_start callback can return false to disable the provider until the next redraw. Similarly, return false in on_win will skip the on_lines calls for that window (but any extmarks set in on_win will still be used). A plugin managing multiple sources of decoration should ideally only set one provider, and merge the sources internally. You can use multiple ns_id for the extmarks set/modified inside the callback anyway. Note: doing anything other than setting extmarks is considered experimental. Doing things like changing options are not expliticly forbidden, but is likely to have unexpected consequences (such as 100% CPU consumption). doing vim.rpcnotify should be OK, but vim.rpcrequest is quite dubious for the moment. Parameters: ~ {ns_id} Namespace id from |nvim_create_namespace()| {opts} Callbacks invoked during redraw: • on_start: called first on each screen redraw ["start", tick] • on_buf: called for each buffer being redrawn (before window callbacks) ["buf", bufnr, tick] • on_win: called when starting to redraw a specific window. ["win", winid, bufnr, topline, botline_guess] • on_line: called for each buffer line being redrawn. (The interaction with fold lines is subject to change) ["win", winid, bufnr, row] • on_end: called at the end of a redraw cycle ["end", tick] Calls a function with window as temporary current window. Parameters: ~ {window} Window handle, or 0 for current window {fun} Function to call inside the window (currently lua callable only) Return: ~ Return value of function. NB: will deepcopy lua values currently, use upvalues to send lua references in and out. See also: ~ |win_execute()| |nvim_buf_call()| Closes the window (like |:close| with a |window-ID|). Attributes: ~ not allowed when |textlock| is active Parameters: ~ {window} Window handle, or 0 for current window {force} Behave like :close! The last window of a buffer with unwritten changes can be closed. The buffer will become hidden, even if 'hidden' is not set. Removes a window-scoped (w:) variable Parameters: ~ {window} Window handle, or 0 for current window {name} Variable name Gets the current buffer in a window Parameters: ~ {window} Window handle, or 0 for current window Return: ~ Buffer handle Gets the (1,0)-indexed cursor position in the window. |api-indexing| Parameters: ~ {window} Window handle, or 0 for current window Return: ~ (row, col) tuple Gets the window height Parameters: ~ {window} Window handle, or 0 for current window Return: ~ Height as a count of rows Gets the window number Parameters: ~ {window} Window handle, or 0 for current window Return: ~ Window number Gets a window option value Parameters: ~ {window} Window handle, or 0 for current window {name} Option name Return: ~ Option value Gets the window position in display cells. First position is zero. Parameters: ~ {window} Window handle, or 0 for current window Return: ~ (row, col) tuple with the window position Gets the window tabpage Parameters: ~ {window} Window handle, or 0 for current window Return: ~ Tabpage that contains the window Gets a window-scoped (w:) variable Parameters: ~ {window} Window handle, or 0 for current window {name} Variable name Return: ~ Variable value Gets the window width Parameters: ~ {window} Window handle, or 0 for current window Return: ~ Width as a count of columns Closes the window and hide the buffer it contains (like |:hide| with a |window-ID|). Like |:hide| the buffer becomes hidden unless another window is editing it, or 'bufhidden' is unload , delete or wipe as opposed to |:close| or |nvim_win_close|, which will close the buffer. Attributes: ~ not allowed when |textlock| is active Parameters: ~ {window} Window handle, or 0 for current window Checks if a window is valid Parameters: ~ {window} Window handle, or 0 for current window Return: ~ true if the window is valid, false otherwise Sets the current buffer in a window, without side-effects Attributes: ~ not allowed when |textlock| is active Parameters: ~ {window} Window handle, or 0 for current window {buffer} Buffer handle Sets the (1,0)-indexed cursor position in the window. |api-indexing| Parameters: ~ {window} Window handle, or 0 for current window {pos} (row, col) tuple representing the new position Sets the window height. This will only succeed if the screen is split horizontally. Parameters: ~ {window} Window handle, or 0 for current window {height} Height as a count of rows Sets a window option value. Passing 'nil' as value deletes the option(only works if there's a global fallback) Parameters: ~ {window} Window handle, or 0 for current window {name} Option name {value} Option value Sets a window-scoped (w:) variable Parameters: ~ {window} Window handle, or 0 for current window {name} Variable name {value} Variable value Sets the window width. This will only succeed if the screen is split vertically. Parameters: ~ {window} Window handle, or 0 for current window {width} Width as a count of columns Open a new window. Currently this is used to open floating and external windows. Floats are windows that are drawn above the split layout, at some anchor position in some other window. Floats can be drawn internally or by external GUI with the |ui-multigrid| extension. External windows are only supported with multigrid GUIs, and are displayed as separate top-level windows. For a general overview of floats, see |api-floatwin|. Exactly one of external and relative must be specified. The width and height of the new window must be specified. With relative=editor (row=0,col=0) refers to the top-left corner of the screen-grid and (row=Lines-1,col=Columns-1) refers to the bottom-right corner. Fractional values are allowed, but the builtin implementation (used by non-multigrid UIs) will always round down to nearest integer. Out-of-bounds values, and configurations that make the float not fit inside the main editor, are allowed. The builtin implementation truncates values so floats are fully within the main screen grid. External GUIs could let floats hover outside of the main window like a tooltip, but this should not be used to specify arbitrary WM screen positions. Example (Lua): window-relative float vim.api.nvim_open_win(0, false, {relative='win', row=3, col=3, width=12, height=3}) Example (Lua): buffer-relative float (travels as buffer is scrolled) vim.api.nvim_open_win(0, false, {relative='win', width=12, height=3, bufpos={100,10}}) Attributes: ~ not allowed when |textlock| is active Parameters: ~ {buffer} Buffer to display, or 0 for current buffer {enter} Enter the window (make it the current window) {config} Map defining the window configuration. Keys: • relative: Sets the window layout to "floating", placed at (row,col) coordinates relative to: • "editor" The global editor grid • "win" Window given by the win field, or current window. • "cursor" Cursor position in current window. • win: |window-ID| for relative="win". • anchor: Decides which corner of the float to place at (row,col): • "NW" northwest (default) • "NE" northeast • "SW" southwest • "SE" southeast • width: Window width (in character cells). Minimum of 1. • height: Window height (in character cells). Minimum of 1. • bufpos: Places float relative to buffer text (only when relative="win"). Takes a tuple of zero-indexed [line, column]. row and col if given are applied relative to this position, else they default to: • row=1 and col=0 if anchor is "NW" or "NE" • row=0 and col=0 if anchor is "SW" or "SE" (thus like a tooltip near the buffer text). • row: Row position in units of "screen cell height", may be fractional. • col: Column position in units of "screen cell width", may be fractional. • focusable: Enable focus by user actions (wincmds, mouse events). Defaults to true. Non-focusable windows can be entered by |nvim_set_current_win()|. • external: GUI should display the window as an external top-level window. Currently accepts no other positioning configuration together with this. • zindex: Stacking order. floats with higher zindex go on top on floats with lower indices. Must be larger than zero. The following screen elements have hard-coded z-indices: • 100: insert completion popupmenu • 200: message scrollback • 250: cmdline completion popupmenu (when wildoptions+=pum) The default value for floats are 50. In general, values below 100 are recommended, unless there is a good reason to overshadow builtin elements. • style: Configure the appearance of the window. Currently only takes one non-empty value: • "minimal" Nvim will display the window with many UI options disabled. This is useful when displaying a temporary float where the text should not be edited. Disables 'number', 'relativenumber', 'cursorline', 'cursorcolumn', 'foldcolumn', 'spell' and 'list' options. 'signcolumn' is changed to auto and 'colorcolumn' is cleared. The end-of-buffer region is hidden by setting eob flag of 'fillchars' to a space char, and clearing the |EndOfBuffer| region in 'winhighlight'. • border: Style of (optional) window border. This can either be a string or an array. The string values are • "none": No border (default). • "single": A single line box. • "double": A double line box. • "rounded": Like "single", but with rounded corners ("╭" etc.). • "solid": Adds padding by a single whitespace cell. • "shadow": A drop shadow effect by blending with the background. • If it is an array, it should have a length of eight or any divisor of eight. The array will specifify the eight chars building up the border in a clockwise fashion starting with the top-left corner. As an example, the double box style could be specified as [ "╔", "═" ,"╗", "║", "╝", "═", "╚", "║" ]. If the number of chars are less than eight, they will be repeated. Thus an ASCII border could be specified as [ "/", "-", "\", "|" ], or all chars the same as [ "x" ]. An empty string can be used to turn off a specific border, for instance, [ "", "", "", ">", "", "", "", "<" ] will only make vertical borders but not horizontal ones. By default, FloatBorder highlight is used, which links to VertSplit when not defined. It could also be specified by character: [ {"+", "MyCorner"}, {"x", "MyBorder"} ]. • noautocmd: If true then no buffer-related autocommand events such as |BufEnter|, |BufLeave| or |BufWinEnter| may fire from calling this function. Return: ~ Window handle, or 0 on error Gets window configuration. The returned value may be given to |nvim_open_win()|. relative is empty for normal windows. Parameters: ~ {window} Window handle, or 0 for current window Return: ~ Map defining the window configuration, see |nvim_open_win()| Configures window layout. Currently only for floating and external windows (including changing a split window to those layouts). When reconfiguring a floating window, absent option keys will not be changed. row / col and relative must be reconfigured together. Parameters: ~ {window} Window handle, or 0 for current window {config} Map defining the window configuration, see |nvim_open_win()| See also: ~ |nvim_open_win()| Removes a tab-scoped (t:) variable Parameters: ~ {tabpage} Tabpage handle, or 0 for current tabpage {name} Variable name Gets the tabpage number Parameters: ~ {tabpage} Tabpage handle, or 0 for current tabpage Return: ~ Tabpage number Gets a tab-scoped (t:) variable Parameters: ~ {tabpage} Tabpage handle, or 0 for current tabpage {name} Variable name Return: ~ Variable value Gets the current window in a tabpage Parameters: ~ {tabpage} Tabpage handle, or 0 for current tabpage Return: ~ Window handle Checks if a tabpage is valid Parameters: ~ {tabpage} Tabpage handle, or 0 for current tabpage Return: ~ true if the tabpage is valid, false otherwise Gets the windows in a tabpage Parameters: ~ {tabpage} Tabpage handle, or 0 for current tabpage Return: ~ List of windows in tabpage Sets a tab-scoped (t:) variable Parameters: ~ {tabpage} Tabpage handle, or 0 for current tabpage {name} Variable name {value} Variable value Activates UI events on the channel. Entry point of all UI clients. Allows |--embed| to continue startup. Implies that the client is ready to show the UI. Adds the client to the list of UIs. |nvim_list_uis()| Note: If multiple UI clients are attached, the global screen dimensions degrade to the smallest client. E.g. if client A requests 80x40 but client B requests 200x100, the global screen has size 80x40. Parameters: ~ {width} Requested screen columns {height} Requested screen rows {options} |ui-option| map Deactivates UI events on the channel. Removes the client from the list of UIs. |nvim_list_uis()| Tells Nvim the geometry of the popumenu, to align floating windows with an external popup menu. Note that this method is not to be confused with |nvim_ui_pum_set_height()|, which sets the number of visible items in the popup menu, while this function sets the bounding box of the popup menu, including visual elements such as borders and sliders. Floats need not use the same font size, nor be anchored to exact grid corners, so one can set floating-point numbers to the popup menu geometry. Parameters: ~ {width} Popupmenu width. {height} Popupmenu height. {row} Popupmenu row. {col} Popupmenu height. Tells Nvim the number of elements displaying in the popumenu, to decide and movement. Parameters: ~ {height} Popupmenu height, must be greater than zero. TODO: Documentation TODO: Documentation