diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2017-12-27 19:30:23 +0100 |
|---|---|---|
| committer | Justin M. Keyes <justinkz@gmail.com> | 2018-06-11 00:08:27 +0200 |
| commit | f72f638f976347e2f14fc6ae5e5293c02d5ccfc1 (patch) | |
| tree | 260e270e1cdb9a60e63b52d170ce305e4150686a /src/nvim/api/vim.c | |
| parent | c69ea3b4b8aa8e6f3a756a49fc43a798b77f7eff (diff) | |
| download | rneovim-f72f638f976347e2f14fc6ae5e5293c02d5ccfc1.tar.gz rneovim-f72f638f976347e2f14fc6ae5e5293c02d5ccfc1.tar.bz2 rneovim-f72f638f976347e2f14fc6ae5e5293c02d5ccfc1.zip | |
doc: job/channel, misc #7783
doc: termios defaults. ref #6992
doc: :help shell-powershell
doc: provider: Python minimum version is 2.7, 3.4
doc: remove :!start special-case. #5844
doc: mention #7917 change which accepts empty Array for Dictionary parameter
doc: <Cmd> pseudokey
doc: lmap change #5658
doc: -s, -es
Diffstat (limited to 'src/nvim/api/vim.c')
| -rw-r--r-- | src/nvim/api/vim.c | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c index b3ae52602b..002d9da781 100644 --- a/src/nvim/api/vim.c +++ b/src/nvim/api/vim.c @@ -102,12 +102,13 @@ Dictionary nvim_get_hl_by_id(Integer hl_id, Boolean rgb, Error *err) return hl_get_attr_by_id(attrcode, rgb, err); } -/// Passes input keys to Nvim. +/// 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. /// /// @param keys to be typed -/// @param mode mapping options +/// @param mode behavior flags, see |feedkeys()| /// @param escape_csi If true, escape K_SPECIAL/CSI bytes in `keys` /// @see feedkeys() /// @see vim_strsave_escape_csi @@ -169,13 +170,12 @@ void nvim_feedkeys(String keys, String mode, Boolean escape_csi) } } -/// Passes keys to Nvim as raw user-input. +/// 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. /// -/// Unlike `nvim_feedkeys`, this uses a lower-level input buffer and the call -/// is not deferred. This is the most reliable way to send real user input. -/// /// @note |keycodes| like <CR> are translated, so "<" is special. /// To input a literal "<", send <LT>. /// |