diff options
Diffstat (limited to 'src/nvim/getchar.c')
| -rw-r--r-- | src/nvim/getchar.c | 2702 |
1 files changed, 477 insertions, 2225 deletions
diff --git a/src/nvim/getchar.c b/src/nvim/getchar.c index 5565e17597..00372d4f3d 100644 --- a/src/nvim/getchar.c +++ b/src/nvim/getchar.c @@ -1,14 +1,8 @@ // This is an open source non-commercial project. Dear PVS-Studio, please check // it. PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com -/* - * getchar.c - * - * functions related with getting a character from the user/mapping/redo/... - * - * manipulations with redo buffer and stuff buffer - * mappings and abbreviations - */ +// getchar.c: Code related to getting a character from the user or a script +// file, manipulations with redo buffer and stuff buffer. #include <assert.h> #include <inttypes.h> @@ -22,18 +16,15 @@ #include "nvim/charset.h" #include "nvim/cursor.h" #include "nvim/edit.h" -#include "nvim/eval.h" #include "nvim/event/loop.h" -#include "nvim/ex_docmd.h" #include "nvim/ex_getln.h" -#include "nvim/ex_session.h" -#include "nvim/func_attr.h" #include "nvim/garray.h" #include "nvim/getchar.h" #include "nvim/input.h" -#include "nvim/keymap.h" +#include "nvim/keycodes.h" #include "nvim/lua/executor.h" #include "nvim/main.h" +#include "nvim/mapping.h" #include "nvim/mbyte.h" #include "nvim/memline.h" #include "nvim/memory.h" @@ -46,7 +37,6 @@ #include "nvim/os/input.h" #include "nvim/os/os.h" #include "nvim/plines.h" -#include "nvim/regexp.h" #include "nvim/screen.h" #include "nvim/state.h" #include "nvim/strings.h" @@ -54,30 +44,22 @@ #include "nvim/undo.h" #include "nvim/vim.h" - /// Index in scriptin static int curscript = 0; FileDescriptor *scriptin[NSCRIPT] = { NULL }; -/* - * These buffers are used for storing: - * - stuffed characters: A command that is translated into another command. - * - redo characters: will redo the last change. - * - recorded characters: for the "q" command. - * - * The bytes are stored like in the typeahead buffer: - * - K_SPECIAL introduces a special key (two more bytes follow). A literal - * K_SPECIAL is stored as K_SPECIAL KS_SPECIAL KE_FILLER. - * - CSI introduces a GUI termcap code (also when gui.in_use is FALSE, - * otherwise switching the GUI on would make mappings invalid). - * A literal CSI is stored as CSI KS_EXTRA KE_CSI. - * These translations are also done on multi-byte characters! - * - * Escaping CSI bytes is done by the system-specific input functions, called - * by ui_inchar(). - * Escaping K_SPECIAL is done by inchar(). - * Un-escaping is done by vgetc(). - */ +// These buffers are used for storing: +// - stuffed characters: A command that is translated into another command. +// - redo characters: will redo the last change. +// - recorded characters: for the "q" command. +// +// The bytes are stored like in the typeahead buffer: +// - K_SPECIAL introduces a special key (two more bytes follow). A literal +// K_SPECIAL is stored as K_SPECIAL KS_SPECIAL KE_FILLER. +// These translations are also done on multi-byte characters! +// +// Escaping K_SPECIAL is done by inchar(). +// Un-escaping is done by vgetc(). #define MINIMAL_SIZE 20 // minimal size for b_str @@ -99,26 +81,6 @@ static int typeahead_char = 0; // typeahead char that's not flushed */ static int block_redo = FALSE; -// Make a hash value for a mapping. -// "mode" is the lower 4 bits of the State for the mapping. -// "c1" is the first character of the "lhs". -// Returns a value between 0 and 255, index in maphash. -// Put Normal/Visual mode mappings mostly separately from Insert/Cmdline mode. -#define MAP_HASH(mode, \ - c1) (((mode) & \ - (NORMAL + VISUAL + SELECTMODE + \ - OP_PENDING + TERM_FOCUS)) ? (c1) : ((c1) ^ 0x80)) - -// Each mapping is put in one of the MAX_MAPHASH hash lists, -// to speed up finding it. -static mapblock_T *(maphash[MAX_MAPHASH]); -static bool maphash_valid = false; - -/* - * List used for abbreviations. - */ -static mapblock_T *first_abbr = NULL; // first entry in abbrlist - static int KeyNoremap = 0; // remapping flags /* @@ -170,10 +132,11 @@ void free_buff(buffheader_T *buf) xfree(p); } buf->bh_first.b_next = NULL; + buf->bh_curr = NULL; } /// Return the contents of a buffer as a single string. -/// K_SPECIAL and CSI in the returned string are escaped. +/// K_SPECIAL in the returned string is escaped. /// /// @param dozero count == zero is not an error static char_u *get_buffcont(buffheader_T *buffer, int dozero) @@ -202,11 +165,9 @@ static char_u *get_buffcont(buffheader_T *buffer, int dozero) return p; } -/* - * Return the contents of the record buffer as a single string - * and clear the record buffer. - * K_SPECIAL and CSI in the returned string are escaped. - */ +/// Return the contents of the record buffer as a single string +/// and clear the record buffer. +/// K_SPECIAL in the returned string is escaped. char_u *get_recorded(void) { char_u *p; @@ -236,10 +197,8 @@ char_u *get_recorded(void) return p; } -/* - * Return the contents of the redo buffer as a single string. - * K_SPECIAL and CSI in the returned string are escaped. - */ +/// Return the contents of the redo buffer as a single string. +/// K_SPECIAL in the returned string is escaped. char_u *get_inserted(void) { return get_buffcont(&redobuff, FALSE); @@ -247,7 +206,7 @@ char_u *get_inserted(void) /// Add string after the current block of the given buffer /// -/// K_SPECIAL and CSI should have been escaped already. +/// K_SPECIAL should have been escaped already. /// /// @param[out] buf Buffer to add to. /// @param[in] s String to add. @@ -295,9 +254,23 @@ static void add_buff(buffheader_T *const buf, const char *const s, ptrdiff_t sle } } -/* - * Add number "n" to buffer "buf". - */ +/// Delete "slen" bytes from the end of "buf". +/// Only works when it was just added. +static void delete_buff_tail(buffheader_T *buf, int slen) +{ + int len; + + if (buf->bh_curr == NULL) { + return; // nothing to delete + } + len = (int)STRLEN(buf->bh_curr->b_str); + if (len >= slen) { + buf->bh_curr->b_str[len - slen] = NUL; + buf->bh_space += (size_t)slen; + } +} + +/// Add number "n" to buffer "buf". static void add_num_buff(buffheader_T *buf, long n) { char number[32]; @@ -305,10 +278,8 @@ static void add_num_buff(buffheader_T *buf, long n) add_buff(buf, number, -1L); } -/* - * Add character 'c' to buffer "buf". - * Translates special keys, NUL, CSI, K_SPECIAL and multibyte characters. - */ +/// Add character 'c' to buffer "buf". +/// Translates special keys, NUL, K_SPECIAL and multibyte characters. static void add_char_buff(buffheader_T *buf, int c) { uint8_t bytes[MB_MAXBYTES + 1]; @@ -317,7 +288,7 @@ static void add_char_buff(buffheader_T *buf, int c) if (IS_SPECIAL(c)) { len = 1; } else { - len = utf_char2bytes(c, bytes); + len = utf_char2bytes(c, (char *)bytes); } for (int i = 0; i < len; i++) { @@ -340,12 +311,10 @@ static void add_char_buff(buffheader_T *buf, int c) } } -/* - * Get one byte from the read buffers. Use readbuf1 one first, use readbuf2 - * if that one is empty. - * If advance == TRUE go to the next char. - * No translation is done K_SPECIAL and CSI are escaped. - */ +/// Get one byte from the read buffers. Use readbuf1 one first, use readbuf2 +/// if that one is empty. +/// If advance == TRUE go to the next char. +/// No translation is done K_SPECIAL is escaped. static int read_readbuffers(int advance) { int c; @@ -397,6 +366,7 @@ static void start_stuff(void) * Return TRUE if the stuff buffer is empty. */ int stuff_empty(void) + FUNC_ATTR_PURE { return (readbuf1.bh_first.b_next == NULL && readbuf2.bh_first.b_next == NULL); } @@ -406,6 +376,7 @@ int stuff_empty(void) * redbuf2. */ int readbuf1_empty(void) + FUNC_ATTR_PURE { return (readbuf1.bh_first.b_next == NULL); } @@ -428,8 +399,7 @@ void flush_buffers(flush_buffers_T flush_typeahead) init_typebuf(); start_stuff(); - while (read_readbuffers(TRUE) != NUL) { - } + while (read_readbuffers(true) != NUL) {} if (flush_typeahead == FLUSH_MINIMAL) { // remove mapped characters at the start only @@ -441,8 +411,7 @@ void flush_buffers(flush_buffers_T flush_typeahead) // We have to get all characters, because we may delete the first // part of an escape sequence. In an xterm we get one char at a // time and we have to get them all. - while (inchar(typebuf.tb_buf, typebuf.tb_buflen - 1, 10L) != 0) { - } + while (inchar(typebuf.tb_buf, typebuf.tb_buflen - 1, 10L) != 0) {} } typebuf.tb_off = MAXMAPLEN; typebuf.tb_len = 0; @@ -492,8 +461,7 @@ void CancelRedo(void) redobuff = old_redobuff; old_redobuff.bh_first.b_next = NULL; start_stuff(); - while (read_readbuffers(TRUE) != NUL) { - } + while (read_readbuffers(true) != NUL) {} } } @@ -524,10 +492,8 @@ void restoreRedobuff(save_redo_T *save_redo) old_redobuff = save_redo->sr_old_redobuff; } -/* - * Append "s" to the redo buffer. - * K_SPECIAL and CSI should already have been escaped. - */ +/// Append "s" to the redo buffer. +/// K_SPECIAL should already have been escaped. void AppendToRedobuff(const char *s) { if (!block_redo) { @@ -536,22 +502,22 @@ void AppendToRedobuff(const char *s) } /// Append to Redo buffer literally, escaping special characters with CTRL-V. -/// K_SPECIAL and CSI are escaped as well. +/// K_SPECIAL is escaped as well. /// /// @param str String to append /// @param len Length of `str` or -1 for up to the NUL. -void AppendToRedobuffLit(const char_u *str, int len) +void AppendToRedobuffLit(const char *str, int len) { if (block_redo) { return; } - const char *s = (const char *)str; - while (len < 0 ? *s != NUL : s - (const char *)str < len) { + const char *s = str; + while (len < 0 ? *s != NUL : s - str < len) { // Put a string of normal characters in the redo buffer (that's // faster). const char *start = s; - while (*s >= ' ' && *s < DEL && (len < 0 || s - (const char *)str < len)) { + while (*s >= ' ' && *s < DEL && (len < 0 || s - str < len)) { s++; } @@ -564,7 +530,7 @@ void AppendToRedobuffLit(const char_u *str, int len) add_buff(&redobuff, start, (long)(s - start)); } - if (*s == NUL || (len >= 0 && s - (const char *)str >= len)) { + if (*s == NUL || (len >= 0 && s - str >= len)) { break; } @@ -584,10 +550,8 @@ void AppendToRedobuffLit(const char_u *str, int len) } } -/* - * Append a character to the redo buffer. - * Translates special keys, NUL, CSI, K_SPECIAL and multibyte characters. - */ +/// Append a character to the redo buffer. +/// Translates special keys, NUL, K_SPECIAL and multibyte characters. void AppendCharToRedobuff(int c) { if (!block_redo) { @@ -605,17 +569,15 @@ void AppendNumberToRedobuff(long n) } } -/* - * Append string "s" to the stuff buffer. - * CSI and K_SPECIAL must already have been escaped. - */ +/// Append string "s" to the stuff buffer. +/// K_SPECIAL must already have been escaped. void stuffReadbuff(const char *s) { add_buff(&readbuf1, s, -1L); } /// Append string "s" to the redo stuff buffer. -/// @remark CSI and K_SPECIAL must already have been escaped. +/// @remark K_SPECIAL must already have been escaped. void stuffRedoReadbuff(const char *s) { add_buff(&readbuf2, s, -1L); @@ -626,11 +588,9 @@ void stuffReadbuffLen(const char *s, long len) add_buff(&readbuf1, s, len); } -/* - * Stuff "s" into the stuff buffer, leaving special key codes unmodified and - * escaping other K_SPECIAL and CSI bytes. - * Change CR, LF and ESC into a space. - */ +/// Stuff "s" into the stuff buffer, leaving special key codes unmodified and +/// escaping other K_SPECIAL bytes. +/// Change CR, LF and ESC into a space. void stuffReadbuffSpec(const char *s) { while (*s != NUL) { @@ -639,7 +599,7 @@ void stuffReadbuffSpec(const char *s) stuffReadbuffLen(s, 3); s += 3; } else { - int c = mb_ptr2char_adv((const char_u **)&s); + int c = mb_cptr2char_adv((const char_u **)&s); if (c == CAR || c == NL || c == ESC) { c = ' '; } @@ -648,10 +608,8 @@ void stuffReadbuffSpec(const char *s) } } -/* - * Append a character to the stuff buffer. - * Translates special keys, NUL, CSI, K_SPECIAL and multibyte characters. - */ +/// Append a character to the stuff buffer. +/// Translates special keys, NUL, K_SPECIAL and multibyte characters. void stuffcharReadbuff(int c) { add_char_buff(&readbuf1, c); @@ -665,12 +623,12 @@ void stuffnumReadbuff(long n) add_num_buff(&readbuf1, n); } -// Read a character from the redo buffer. Translates K_SPECIAL, CSI and -// multibyte characters. -// The redo buffer is left as it is. -// If init is true, prepare for redo, return FAIL if nothing to redo, OK -// otherwise. -// If old_redo is true, use old_redobuff instead of redobuff. +/// Read a character from the redo buffer. Translates K_SPECIAL and +/// multibyte characters. +/// The redo buffer is left as it is. +/// If init is true, prepare for redo, return FAIL if nothing to redo, OK +/// otherwise. +/// If old_redo is true, use old_redobuff instead of redobuff. static int read_redo(bool init, bool old_redo) { static buffblock_T *bp; @@ -711,7 +669,7 @@ static int read_redo(bool init, bool old_redo) buf[i] = (char_u)c; if (i == n - 1) { // last byte of a character if (n != 1) { - c = utf_ptr2char(buf); + c = utf_ptr2char((char *)buf); } break; } @@ -724,9 +682,9 @@ static int read_redo(bool init, bool old_redo) return c; } -// Copy the rest of the redo buffer into the stuff buffer (in a slow way). -// If old_redo is true, use old_redobuff instead of redobuff. -// The escaped K_SPECIAL and CSI are copied without translation. +/// Copy the rest of the redo buffer into the stuff buffer (in a slow way). +/// If old_redo is true, use old_redobuff instead of redobuff. +/// The escaped K_SPECIAL is copied without translation. static void copy_redo(bool old_redo) { int c; @@ -813,7 +771,7 @@ int start_redo_ins(void) // skip the count and the command character while ((c = read_redo(false, false)) != NUL) { - if (vim_strchr((char_u *)"AaIiRrOo", c) != NULL) { + if (vim_strchr("AaIiRrOo", c) != NULL) { if (c == 'O' || c == 'o') { add_buff(&readbuf2, NL_STR, -1L); } @@ -849,12 +807,10 @@ static void init_typebuf(void) } } -void init_default_mappings(void) +/// @return true when keys cannot be remapped. +bool noremap_keys(void) { - add_map((char_u *)"Y y$", NORMAL, true); - add_map((char_u *)"<C-L> <Cmd>nohlsearch<Bar>diffupdate<CR><C-L>", NORMAL, true); - add_map((char_u *)"<C-U> <C-G>u<C-U>", INSERT, true); - add_map((char_u *)"<C-W> <C-G>u<C-W>", INSERT, true); + return KeyNoremap & (RM_NONE|RM_SCRIPT); } // Insert a string in position 'offset' in the typeahead buffer (for "@r" @@ -874,13 +830,11 @@ void init_default_mappings(void) // If silent is true, cmd_silent is set when the characters are obtained. // // return FAIL for failure, OK otherwise -int ins_typebuf(char_u *str, int noremap, int offset, bool nottyped, bool silent) +int ins_typebuf(char *str, int noremap, int offset, bool nottyped, bool silent) { char_u *s1, *s2; - int newlen; int addlen; int i; - int newoff; int val; int nrm; @@ -906,13 +860,15 @@ int ins_typebuf(char_u *str, int noremap, int offset, bool nottyped, bool silent // In typebuf.tb_buf there must always be room for 3 * (MAXMAPLEN + 4) // characters. We add some extra room to avoid having to allocate too // often. - newoff = MAXMAPLEN + 4; - newlen = typebuf.tb_len + addlen + newoff + 4 * (MAXMAPLEN + 4); - if (newlen < 0) { // string is getting too long + int newoff = MAXMAPLEN + 4; + int extra = addlen + newoff + 4 * (MAXMAPLEN + 4); + if (typebuf.tb_len > 2147483674 - extra) { + // string is getting too long for 32 bit int emsg(_(e_toocompl)); // also calls flush_buffers setcursor(); return FAIL; } + int newlen = typebuf.tb_len + extra; s1 = xmalloc((size_t)newlen); s2 = xmalloc((size_t)newlen); typebuf.tb_buflen = newlen; @@ -992,36 +948,20 @@ int ins_typebuf(char_u *str, int noremap, int offset, bool nottyped, bool silent return OK; } -/* - * Put character "c" back into the typeahead buffer. - * Can be used for a character obtained by vgetc() that needs to be put back. - * Uses cmd_silent, KeyTyped and KeyNoremap to restore the flags belonging to - * the char. - */ -void ins_char_typebuf(int c) +/// Put character "c" back into the typeahead buffer. +/// Can be used for a character obtained by vgetc() that needs to be put back. +/// Uses cmd_silent, KeyTyped and KeyNoremap to restore the flags belonging to +/// the char. +/// +/// @return the length of what was inserted +int ins_char_typebuf(int c, int modifiers) { - char_u buf[MB_MAXBYTES + 1]; - if (IS_SPECIAL(c)) { - buf[0] = K_SPECIAL; - buf[1] = (char_u)K_SECOND(c); - buf[2] = (char_u)K_THIRD(c); - buf[3] = NUL; - } else { - buf[utf_char2bytes(c, buf)] = NUL; - char_u *p = buf; - while (*p) { - if ((uint8_t)(*p) == CSI || (uint8_t)(*p) == K_SPECIAL) { - bool is_csi = (uint8_t)(*p) == CSI; - memmove(p + 3, p + 1, STRLEN(p + 1) + 1); - *p++ = K_SPECIAL; - *p++ = is_csi ? KS_EXTRA : KS_SPECIAL; - *p++ = is_csi ? KE_CSI : KE_FILLER; - } else { - p++; - } - } - } - (void)ins_typebuf(buf, KeyNoremap, 0, !KeyTyped, cmd_silent); + char_u buf[MB_MAXBYTES * 3 + 4]; + unsigned int len = special_to_buf(c, modifiers, true, buf); + assert(len < sizeof(buf)); + buf[len] = NUL; + (void)ins_typebuf((char *)buf, KeyNoremap, 0, !KeyTyped, cmd_silent); + return (int)len; } /// Return TRUE if the typeahead buffer was changed (while waiting for a @@ -1034,10 +974,10 @@ void ins_char_typebuf(int c) /// /// @param tb_change_cnt old value of typebuf.tb_change_cnt bool typebuf_changed(int tb_change_cnt) + FUNC_ATTR_PURE { return tb_change_cnt != 0 && (typebuf.tb_change_cnt != tb_change_cnt - || typebuf_was_filled - ); + || typebuf_was_filled); } /* @@ -1045,6 +985,7 @@ bool typebuf_changed(int tb_change_cnt) * not been typed (result from a mapping or come from ":normal"). */ int typebuf_typed(void) + FUNC_ATTR_PURE { return typebuf.tb_maplen == 0; } @@ -1053,6 +994,7 @@ int typebuf_typed(void) * Return the number of characters that are mapped (or not typed). */ int typebuf_maplen(void) + FUNC_ATTR_PURE { return typebuf.tb_maplen; } @@ -1181,6 +1123,18 @@ static void gotchars(const char_u *chars, size_t len) maptick++; } +/// Undo the last gotchars() for "len" bytes. To be used when putting a typed +/// character back into the typeahead buffer, thus gotchars() will be called +/// again. +/// Only affects recorded characters. +void ungetchars(int len) +{ + if (reg_recording != 0) { + delete_buff_tail(&recordbuff, len); + last_recorded_len -= (size_t)len; + } +} + /* * Sync undo. Called when typed characters are obtained from the typeahead * buffer, or when a menu is used. @@ -1191,7 +1145,7 @@ static void gotchars(const char_u *chars, size_t len) */ void may_sync_undo(void) { - if ((!(State & (INSERT + CMDLINE)) || arrow_used) + if ((!(State & (MODE_INSERT | MODE_CMDLINE)) || arrow_used) && scriptin[curscript] == NULL) { u_sync(false); } @@ -1250,7 +1204,14 @@ static int old_mod_mask; // mod_mask for ungotten character static int old_mouse_grid; // mouse_grid related to old_char static int old_mouse_row; // mouse_row related to old_char static int old_mouse_col; // mouse_col related to old_char +static int old_KeyStuffed; // whether old_char was stuffed +static bool can_get_old_char(void) +{ + // If the old character was not stuffed and characters have been added to + // the stuff buffer, need to first get the stuffed characters instead. + return old_char != -1 && (old_KeyStuffed || stuff_empty()); +} /* * Save all three kinds of typeahead, so that the user must type at a prompt. @@ -1338,14 +1299,12 @@ void openscript(char_u *name, bool directly) int oldcurscript; int save_State = State; int save_restart_edit = restart_edit; - int save_insertmode = p_im; int save_finish_op = finish_op; int save_msg_scroll = msg_scroll; - State = NORMAL; + State = MODE_NORMAL; msg_scroll = false; // no msg scrolling in Normal mode restart_edit = 0; // don't go to Insert mode - p_im = false; // don't use 'insertmode' clear_oparg(&oa); finish_op = false; @@ -1359,7 +1318,6 @@ void openscript(char_u *name, bool directly) State = save_State; msg_scroll = save_msg_scroll; restart_edit = save_restart_edit; - p_im = save_insertmode; finish_op = save_finish_op; } } @@ -1393,6 +1351,7 @@ void close_all_scripts(void) * Return TRUE when reading keys from a script file. */ int using_script(void) + FUNC_ATTR_PURE { return scriptin[curscript] != NULL; } @@ -1427,15 +1386,35 @@ static void updatescript(int c) } } -/* - * Get the next input character. - * Can return a special key or a multi-byte character. - * Can return NUL when called recursively, use safe_vgetc() if that's not - * wanted. - * This translates escaped K_SPECIAL and CSI bytes to a K_SPECIAL or CSI byte. - * Collects the bytes of a multibyte character into the whole character. - * Returns the modifiers in the global "mod_mask". - */ +/// Merge "modifiers" into "c_arg". +int merge_modifiers(int c_arg, int *modifiers) +{ + int c = c_arg; + + if (*modifiers & MOD_MASK_CTRL) { + if ((c >= '`' && c <= 0x7f) || (c >= '@' && c <= '_')) { + c &= 0x1f; + if (c == NUL) { + c = K_ZERO; + } + } else if (c == '6') { + // CTRL-6 is equivalent to CTRL-^ + c = 0x1e; + } + if (c != c_arg) { + *modifiers &= ~MOD_MASK_CTRL; + } + } + return c; +} + +/// Get the next input character. +/// Can return a special key or a multi-byte character. +/// Can return NUL when called recursively, use safe_vgetc() if that's not +/// wanted. +/// This translates escaped K_SPECIAL bytes to a K_SPECIAL byte. +/// Collects the bytes of a multibyte character into the whole character. +/// Returns the modifiers in the global "mod_mask". int vgetc(void) { int c, c2; @@ -1453,7 +1432,7 @@ int vgetc(void) * If a character was put back with vungetc, it was already processed. * Return it directly. */ - if (old_char != -1) { + if (can_get_old_char()) { c = old_char; old_char = -1; mod_mask = old_mod_mask; @@ -1461,25 +1440,39 @@ int vgetc(void) mouse_row = old_mouse_row; mouse_col = old_mouse_col; } else { - mod_mask = 0x0; - last_recorded_len = 0; + // number of characters recorded from the last vgetc() call + static size_t last_vgetc_recorded_len = 0; + + mod_mask = 0; + vgetc_mod_mask = 0; + vgetc_char = 0; + + // last_recorded_len can be larger than last_vgetc_recorded_len + // if peeking records more + last_recorded_len -= last_vgetc_recorded_len; + for (;;) { // this is done twice if there are modifiers bool did_inc = false; if (mod_mask) { // no mapping after modifier has been read no_mapping++; + allow_keys++; did_inc = true; // mod_mask may change value } c = vgetorpeek(true); if (did_inc) { no_mapping--; + allow_keys--; } // Get two extra bytes for special keys if (c == K_SPECIAL) { + int save_allow_keys = allow_keys; no_mapping++; + allow_keys = 0; // make sure BS is not found c2 = vgetorpeek(true); // no mapping for these chars c = vgetorpeek(true); no_mapping--; + allow_keys = save_allow_keys; if (c2 == KS_MODIFIER) { mod_mask = c; continue; @@ -1552,12 +1545,16 @@ int vgetc(void) } break; + case K_KUP: case K_XUP: c = K_UP; break; + case K_KDOWN: case K_XDOWN: c = K_DOWN; break; + case K_KLEFT: case K_XLEFT: c = K_LEFT; break; + case K_KRIGHT: case K_XRIGHT: c = K_RIGHT; break; } @@ -1572,34 +1569,37 @@ int vgetc(void) buf[i] = (char_u)vgetorpeek(true); if (buf[i] == K_SPECIAL) { // Must be a K_SPECIAL - KS_SPECIAL - KE_FILLER sequence, - // which represents a K_SPECIAL (0x80), - // or a CSI - KS_EXTRA - KE_CSI sequence, which represents - // a CSI (0x9B), - // of a K_SPECIAL - KS_EXTRA - KE_CSI, which is CSI too. - c = vgetorpeek(true); - if (vgetorpeek(true) == KE_CSI && c == KS_EXTRA) { - buf[i] = CSI; - } + // which represents a K_SPECIAL (0x80). + (void)vgetorpeek(true); // skip KS_SPECIAL + (void)vgetorpeek(true); // skip KE_FILLER } } no_mapping--; - c = utf_ptr2char(buf); + c = utf_ptr2char((char *)buf); + } + + if (vgetc_char == 0) { + vgetc_mod_mask = mod_mask; + vgetc_char = c; } // If mappings are enabled (i.e., not Ctrl-v) and the user directly typed // something with a meta- or alt- modifier that was not mapped, interpret // <M-x> as <Esc>x rather than as an unbound meta keypress. #8213 // In Terminal mode, however, this is not desirable. #16220 - if (!no_mapping && KeyTyped && !(State & TERM_FOCUS) + if (!no_mapping && KeyTyped && !(State & MODE_TERMINAL) && (mod_mask == MOD_MASK_ALT || mod_mask == MOD_MASK_META)) { mod_mask = 0; - ins_char_typebuf(c); - ins_char_typebuf(ESC); + int len = ins_char_typebuf(c, 0); + (void)ins_char_typebuf(ESC, 0); + ungetchars(len + 3); // The ALT/META modifier takes three more bytes continue; } break; } + + last_vgetc_recorded_len = last_recorded_len; } /* @@ -1654,7 +1654,7 @@ int plain_vgetc(void) */ int vpeekc(void) { - if (old_char != -1) { + if (can_get_old_char()) { return old_char; } return vgetorpeek(false); @@ -1697,11 +1697,101 @@ typedef enum { map_result_nomatch, // no matching mapping, get char } map_result_T; +/// Put "string[new_slen]" in typebuf. +/// Remove "slen" bytes. +/// @return FAIL for error, OK otherwise. +static int put_string_in_typebuf(int offset, int slen, char_u *string, int new_slen) +{ + int extra = new_slen - slen; + string[new_slen] = NUL; + if (extra < 0) { + // remove matched chars, taking care of noremap + del_typebuf(-extra, offset); + } else if (extra > 0) { + // insert the extra space we need + if (ins_typebuf((char *)string + slen, REMAP_YES, offset, false, false) == FAIL) { + return FAIL; + } + } + // Careful: del_typebuf() and ins_typebuf() may have reallocated + // typebuf.tb_buf[]! + memmove(typebuf.tb_buf + typebuf.tb_off + offset, string, (size_t)new_slen); + return OK; +} + +/// Check if the bytes at the start of the typeahead buffer are a character used +/// in Insert mode completion. This includes the form with a CTRL modifier. +static bool at_ins_compl_key(void) +{ + char_u *p = typebuf.tb_buf + typebuf.tb_off; + int c = *p; + + if (typebuf.tb_len > 3 && c == K_SPECIAL && p[1] == KS_MODIFIER && (p[2] & MOD_MASK_CTRL)) { + c = p[3] & 0x1f; + } + return (ctrl_x_mode_not_default() && vim_is_ctrl_x_key(c)) + || ((compl_cont_status & CONT_LOCAL) && (c == Ctrl_N || c == Ctrl_P)); +} + +/// Check if typebuf.tb_buf[] contains a modifer plus key that can be changed +/// into just a key, apply that. +/// Check from typebuf.tb_buf[typebuf.tb_off] to typebuf.tb_buf[typebuf.tb_off + "max_offset"]. +/// @return the length of the replaced bytes, 0 if nothing changed, -1 for error. +static int check_simplify_modifier(int max_offset) +{ + for (int offset = 0; offset < max_offset; offset++) { + if (offset + 3 >= typebuf.tb_len) { + break; + } + char_u *tp = typebuf.tb_buf + typebuf.tb_off + offset; + if (tp[0] == K_SPECIAL && tp[1] == KS_MODIFIER) { + // A modifier was not used for a mapping, apply it to ASCII + // keys. Shift would already have been applied. + int modifier = tp[2]; + int c = tp[3]; + int new_c = merge_modifiers(c, &modifier); + + if (new_c != c) { + if (offset == 0) { + // At the start: remember the character and mod_mask before + // merging, in some cases, e.g. at the hit-return prompt, + // they are put back in the typeahead buffer. + vgetc_char = c; + vgetc_mod_mask = tp[2]; + } + char_u new_string[MB_MAXBYTES]; + int len; + if (IS_SPECIAL(new_c)) { + new_string[0] = K_SPECIAL; + new_string[1] = (char_u)K_SECOND(new_c); + new_string[2] = (char_u)K_THIRD(new_c); + len = 3; + } else { + len = utf_char2bytes(new_c, (char *)new_string); + } + if (modifier == 0) { + if (put_string_in_typebuf(offset, 4, new_string, len) == FAIL) { + return -1; + } + } else { + tp[2] = (char_u)modifier; + if (put_string_in_typebuf(offset + 3, 1, new_string, len) == FAIL) { + return -1; + } + } + return len; + } + } + } + return 0; +} + /// Handle mappings in the typeahead buffer. /// - When something was mapped, return map_result_retry for recursive mappings. /// - When nothing mapped and typeahead has a character: return map_result_get. /// - When there is no match yet, return map_result_nomatch, need to get more /// typeahead. +/// - On failure (out of memory) return map_result_fail. static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) { mapblock_T *mp = NULL; @@ -1715,6 +1805,15 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) int keylen = *keylenp; int i; int local_State = get_real_state(); + bool is_plug_map = false; + + // If typehead starts with <Plug> then remap, even for a "noremap" mapping. + if (typebuf.tb_len >= 3 + && typebuf.tb_buf[typebuf.tb_off] == K_SPECIAL + && typebuf.tb_buf[typebuf.tb_off + 1] == KS_EXTRA + && typebuf.tb_buf[typebuf.tb_off + 2] == KE_PLUG) { + is_plug_map = true; + } // Check for a mappable key sequence. // Walk through one maphash[] list until we find an entry that matches. @@ -1728,27 +1827,25 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) // - waiting for a char with --more-- // - in Ctrl-X mode, and we get a valid char for that mode tb_c1 = typebuf.tb_buf[typebuf.tb_off]; - if (no_mapping == 0 && maphash_valid + if (no_mapping == 0 && (no_zero_mapping == 0 || tb_c1 != '0') - && (typebuf.tb_maplen == 0 - || (p_remap - && !(typebuf.tb_noremap[typebuf.tb_off] & (RM_NONE|RM_ABBR)))) - && !(p_paste && (State & (INSERT + CMDLINE))) - && !(State == HITRETURN && (tb_c1 == CAR || tb_c1 == ' ')) - && State != ASKMORE - && State != CONFIRM - && !((ctrl_x_mode_not_default() && vim_is_ctrl_x_key(tb_c1)) - || ((compl_cont_status & CONT_LOCAL) - && (tb_c1 == Ctrl_N || tb_c1 == Ctrl_P)))) { + && (typebuf.tb_maplen == 0 || is_plug_map + || (!(typebuf.tb_noremap[typebuf.tb_off] & (RM_NONE|RM_ABBR)))) + && !(p_paste && (State & (MODE_INSERT | MODE_CMDLINE))) + && !(State == MODE_HITRETURN && (tb_c1 == CAR || tb_c1 == ' ')) + && State != MODE_ASKMORE + && State != MODE_CONFIRM + && !at_ins_compl_key()) { if (tb_c1 == K_SPECIAL) { nolmaplen = 2; } else { - LANGMAP_ADJUST(tb_c1, !(State & (CMDLINE | INSERT)) && get_real_state() != SELECTMODE); + LANGMAP_ADJUST(tb_c1, ((State & (MODE_CMDLINE | MODE_INSERT)) == 0 + && get_real_state() != MODE_SELECT)); nolmaplen = 0; } // First try buffer-local mappings. - mp = curbuf->b_maphash[MAP_HASH(local_State, tb_c1)]; - mp2 = maphash[MAP_HASH(local_State, tb_c1)]; + mp = get_buf_maphash_list(local_State, tb_c1); + mp2 = get_maphash_list(local_State, tb_c1); if (mp == NULL) { // There are no buffer-local mappings. mp = mp2; @@ -1766,7 +1863,7 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) // for the current state. // Skip ":lmap" mappings if keys were mapped. if (mp->m_keys[0] == tb_c1 && (mp->m_mode & local_State) - && ((mp->m_mode & LANGMAP) == 0 || typebuf.tb_maplen == 0)) { + && ((mp->m_mode & MODE_LANGMAP) == 0 || typebuf.tb_maplen == 0)) { int nomap = nolmaplen; int c2; // find the match length of this mapping @@ -1790,7 +1887,7 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) char_u *p1 = mp->m_keys; char_u *p2 = (char_u *)mb_unescape((const char **)&p1); - if (p2 != NULL && MB_BYTE2LEN(tb_c1) > utfc_ptr2len(p2)) { + if (p2 != NULL && MB_BYTE2LEN(tb_c1) > utfc_ptr2len((char *)p2)) { mlen = 0; } @@ -1818,7 +1915,7 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) break; } } - if (n >= 0) { + if (!is_plug_map && n >= 0) { continue; } @@ -1831,8 +1928,8 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) } else if (keylen > mp_match_len || (keylen == mp_match_len && mp_match != NULL - && (mp_match->m_mode & LANGMAP) == 0 - && (mp->m_mode & LANGMAP) != 0)) { + && (mp_match->m_mode & MODE_LANGMAP) == 0 + && (mp->m_mode & MODE_LANGMAP) != 0)) { // found a longer match mp_match = mp; mp_match_len = keylen; @@ -1847,14 +1944,14 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) } // If no partly match found, use the longest full match. - if (keylen != KEYLEN_PART_MAP) { + if (keylen != KEYLEN_PART_MAP && mp_match != NULL) { mp = mp_match; keylen = mp_match_len; } } // Check for match with 'pastetoggle' - if (*p_pt != NUL && mp == NULL && (State & (INSERT|NORMAL))) { + if (*p_pt != NUL && mp == NULL && (State & (MODE_INSERT | MODE_NORMAL))) { bool match = typebuf_match_len(p_pt, &mlen); if (match) { // write chars to script file(s) @@ -1865,7 +1962,7 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) del_typebuf(mlen, 0); // remove the chars set_option_value("paste", !p_paste, NULL, 0); - if (!(State & INSERT)) { + if (!(State & MODE_INSERT)) { msg_col = 0; msg_row = Rows - 1; msg_clr_eos(); // clear ruler @@ -1886,17 +1983,54 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) } } - if ((mp == NULL || max_mlen >= mp_match_len) && keylen != KEYLEN_PART_MAP) { - // No matching mapping found or found a non-matching mapping that - // matches at least what the matching mapping matched - keylen = 0; - (void)keylen; // suppress clang/dead assignment - // If there was no mapping, use the character from the typeahead - // buffer right here. Otherwise, use the mapping (loop around). - if (mp == NULL) { + if ((mp == NULL || max_mlen > mp_match_len) && keylen != KEYLEN_PART_MAP) { + // When no matching mapping found or found a non-matching mapping that + // matches at least what the matching mapping matched: + // Try to include the modifier into the key when mapping is allowed. + if (no_mapping == 0 || allow_keys != 0) { + if (tb_c1 == K_SPECIAL + && (typebuf.tb_len < 2 + || (typebuf.tb_buf[typebuf.tb_off + 1] == KS_MODIFIER && typebuf.tb_len < 4))) { + // Incomplete modifier sequence: cannot decide whether to simplify yet. + keylen = KEYLEN_PART_KEY; + } else if (keylen == KEYLEN_PART_KEY && !*timedout) { + // If 'pastetoggle' matched partially, don't simplify. + // When the last characters were not typed, don't wait for a typed character to + // complete 'pastetoggle'. + if (typebuf.tb_len == typebuf.tb_maplen) { + keylen = 0; + } + } else { + // Try to include the modifier into the key. + keylen = check_simplify_modifier(max_mlen + 1); + if (keylen < 0) { + // ins_typebuf() failed + return map_result_fail; + } + } + } else { + keylen = 0; + } + if (keylen == 0) { // no simplication has been done + // If there was no mapping at all use the character from the + // typeahead buffer right here. + if (mp == NULL) { + *keylenp = keylen; + return map_result_get; // get character from typeahead + } + } + + if (keylen > 0) { // keys have been simplified *keylenp = keylen; - return map_result_get; // get character from typeahead + return map_result_retry; // try mapping again + } + + if (keylen < 0) { + // Incomplete key sequence: get some more characters. + assert(keylen == KEYLEN_PART_KEY); } else { + assert(mp != NULL); + // When a matching mapping was found use that one. keylen = mp_match_len; } } @@ -1904,13 +2038,10 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) // complete match if (keylen >= 0 && keylen <= typebuf.tb_len) { char_u *map_str = NULL; - int save_m_expr; - int save_m_noremap; - int save_m_silent; // Write chars to script file(s). // Note: :lmap mappings are written *after* being applied. #5658 - if (keylen > typebuf.tb_maplen && (mp->m_mode & LANGMAP) == 0) { + if (keylen > typebuf.tb_maplen && (mp->m_mode & MODE_LANGMAP) == 0) { gotchars(typebuf.tb_buf + typebuf.tb_off + typebuf.tb_maplen, (size_t)(keylen - typebuf.tb_maplen)); } @@ -1922,7 +2053,7 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) // The depth check catches ":map x y" and ":map y x". if (++*mapdepth >= p_mmd) { emsg(_("E223: recursive mapping")); - if (State & CMDLINE) { + if (State & MODE_CMDLINE) { redrawcmdline(); } else { setcursor(); @@ -1935,17 +2066,17 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) // In Select mode and a Visual mode mapping is used: Switch to Visual // mode temporarily. Append K_SELECT to switch back to Select mode. - if (VIsual_active && VIsual_select && (mp->m_mode & VISUAL)) { + if (VIsual_active && VIsual_select && (mp->m_mode & MODE_VISUAL)) { VIsual_select = false; - (void)ins_typebuf(K_SELECT_STRING, REMAP_NONE, 0, true, false); + (void)ins_typebuf((char *)K_SELECT_STRING, REMAP_NONE, 0, true, false); } // Copy the values from *mp that are used, because evaluating the // expression may invoke a function that redefines the mapping, thereby // making *mp invalid. - save_m_expr = mp->m_expr; - save_m_noremap = mp->m_noremap; - save_m_silent = mp->m_silent; + char save_m_expr = mp->m_expr; + int save_m_noremap = mp->m_noremap; + char save_m_silent = mp->m_silent; char_u *save_m_keys = NULL; // only saved when needed char_u *save_m_str = NULL; // only saved when needed LuaRef save_m_luaref = mp->m_luaref; @@ -1954,8 +2085,12 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) // expression. Also save and restore the command line // for "normal :". if (mp->m_expr) { - int save_vgetc_busy = vgetc_busy; + const int save_vgetc_busy = vgetc_busy; const bool save_may_garbage_collect = may_garbage_collect; + const int save_cursor_row = ui_current_row(); + const int save_cursor_col = ui_current_col(); + const handle_T save_cursor_grid = ui_cursor_grid(); + const int prev_did_emsg = did_emsg; vgetc_busy = 0; may_garbage_collect = false; @@ -1965,6 +2100,32 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) save_m_str = vim_strsave(mp->m_str); } map_str = eval_map_expr(mp, NUL); + + // The mapping may do anything, but we expect it to take care of + // redrawing. Do put the cursor back where it was. + ui_grid_cursor_goto(save_cursor_grid, save_cursor_row, save_cursor_col); + ui_flush(); + + // If an error was displayed and the expression returns an empty + // string, generate a <Nop> to allow for a redraw. + if (prev_did_emsg != did_emsg && (map_str == NULL || *map_str == NUL)) { + char_u buf[4]; + xfree(map_str); + buf[0] = K_SPECIAL; + buf[1] = KS_EXTRA; + buf[2] = KE_IGNORE; + buf[3] = NUL; + map_str = vim_strsave(buf); + if (State & MODE_CMDLINE) { + // redraw the command below the error + msg_didout = true; + if (msg_row < cmdline_row) { + msg_row = cmdline_row; + } + redrawcmd(); + } + } + vgetc_busy = save_vgetc_busy; may_garbage_collect = save_may_garbage_collect; } else { @@ -1982,7 +2143,7 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) // If this is a LANGMAP mapping, then we didn't record the keys // at the start of the function and have to record them now. - if (keylen > typebuf.tb_maplen && (mp->m_mode & LANGMAP) != 0) { + if (keylen > typebuf.tb_maplen && (mp->m_mode & MODE_LANGMAP) != 0) { gotchars(map_str, STRLEN(map_str)); } @@ -1994,7 +2155,7 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) } else { noremap = REMAP_SKIP; } - i = ins_typebuf(map_str, noremap, 0, true, cmd_silent || save_m_silent); + i = ins_typebuf((char *)map_str, noremap, 0, true, cmd_silent || save_m_silent); if (save_m_expr) { xfree(map_str); } @@ -2012,7 +2173,9 @@ static int handle_mapping(int *keylenp, bool *timedout, int *mapdepth) return map_result_nomatch; } -// unget one character (can only be done once!) +/// unget one character (can only be done once!) +/// If the character was stuffed, vgetc() will get it next time it is called. +/// Otherwise vgetc() will only get it when the stuff buffer is empty. void vungetc(int c) { old_char = c; @@ -2020,6 +2183,21 @@ void vungetc(int c) old_mouse_grid = mouse_grid; old_mouse_row = mouse_row; old_mouse_col = mouse_col; + old_KeyStuffed = KeyStuffed; +} + +/// When peeking and not getting a character, reg_executing cannot be cleared +/// yet, so set a flag to clear it later. +void check_end_reg_executing(bool advance) +{ + if (reg_executing != 0 && (typebuf.tb_maplen == 0 || pending_end_reg_executing)) { + if (advance) { + reg_executing = 0; + pending_end_reg_executing = false; + } else { + pending_end_reg_executing = true; + } + } } /// Gets a byte: @@ -2043,7 +2221,7 @@ void vungetc(int c) /// /// When `no_mapping` (global) is zero, checks for mappings in the current mode. /// Only returns one byte (of a multi-byte character). -/// K_SPECIAL and CSI may be escaped, need to get two more bytes then. +/// K_SPECIAL may be escaped, need to get two more bytes then. static int vgetorpeek(bool advance) { int c, c1; @@ -2076,9 +2254,7 @@ static int vgetorpeek(bool advance) init_typebuf(); start_stuff(); - if (advance && typebuf.tb_maplen == 0) { - reg_executing = 0; - } + check_end_reg_executing(advance); do { // get a character: 1. from the stuffbuffer if (typeahead_char != 0) { @@ -2105,13 +2281,19 @@ static int vgetorpeek(bool advance) // If a mapped key sequence is found we go back to the start to // try re-mapping. for (;;) { + check_end_reg_executing(advance); // os_breakcheck() is slow, don't use it too often when // inside a mapping. But call it each time for typed // characters. if (typebuf.tb_maplen) { line_breakcheck(); } else { + // os_breakcheck() can call input_enqueue() + if ((mapped_ctrl_c | curbuf->b_mapped_ctrl_c) & get_real_state()) { + ctrl_c_interrupts = false; + } os_breakcheck(); // check for CTRL-C + ctrl_c_interrupts = true; } int keylen = 0; if (got_int) { @@ -2124,7 +2306,7 @@ static int vgetorpeek(bool advance) // As a result typing CTRL-C in insert mode will // really insert a CTRL-C. if ((c || typebuf.tb_maplen) - && (State & (INSERT + CMDLINE))) { + && (State & (MODE_INSERT | MODE_CMDLINE))) { c = ESC; } else { c = Ctrl_C; @@ -2193,7 +2375,7 @@ static int vgetorpeek(bool advance) && !no_mapping && ex_normal_busy == 0 && typebuf.tb_maplen == 0 - && (State & INSERT) + && (State & MODE_INSERT) && (p_timeout || (keylen == KEYLEN_PART_KEY && p_ttimeout)) && (c = inchar(typebuf.tb_buf + typebuf.tb_off + typebuf.tb_len, 3, 25L)) == 0) { colnr_T col = 0, vcol; @@ -2221,7 +2403,7 @@ static int vgetorpeek(bool advance) curwin->w_wcol = vcol; } vcol += lbr_chartabsize(ptr, ptr + col, vcol); - col += utfc_ptr2len(ptr + col); + col += utfc_ptr2len((char *)ptr + col); } curwin->w_wrow = curwin->w_cline_row + curwin->w_wcol / curwin->w_width_inner; @@ -2242,7 +2424,7 @@ static int vgetorpeek(bool advance) // of a double-wide character. ptr = get_cursor_line_ptr(); col -= utf_head_off(ptr, ptr + col); - if (utf_ptr2cells(ptr + col) > 1) { + if (utf_ptr2cells((char *)ptr + col) > 1) { curwin->w_wcol--; } } @@ -2281,23 +2463,26 @@ static int vgetorpeek(bool advance) timedout = true; continue; } - // When 'insertmode' is set, ESC just beeps in Insert - // mode. Use CTRL-L to make edit() return. // In Ex-mode \n is compatible with original Vim behaviour. // For the command line only CTRL-C always breaks it. // For the cmdline window: Alternate between ESC and // CTRL-C: ESC for most situations and CTRL-C to close the // cmdline window. - if (p_im && (State & INSERT)) { - c = Ctrl_L; - } else if (exmode_active) { - c = '\n'; - } else if ((State & CMDLINE) || (cmdwin_type > 0 && tc == ESC)) { + if ((State & MODE_CMDLINE) || (cmdwin_type > 0 && tc == ESC)) { c = Ctrl_C; } else { c = ESC; } tc = c; + + // return 0 in normal_check() + if (pending_exmode_active) { + exmode_active = true; + } + + // no chars to block abbreviations for + typebuf.tb_no_abbr_cnt = 0; + break; } @@ -2310,7 +2495,7 @@ static int vgetorpeek(bool advance) // changed text so far. Also for when 'lazyredraw' is set and // redrawing was postponed because there was something in the // input buffer (e.g., termresponse). - if (((State & INSERT) != 0 || p_lz) && (State & CMDLINE) == 0 + if (((State & MODE_INSERT) != 0 || p_lz) && (State & MODE_CMDLINE) == 0 && advance && must_redraw != 0 && !need_wait_return) { update_screen(0); setcursor(); // put cursor back where it belongs @@ -2322,10 +2507,11 @@ static int vgetorpeek(bool advance) int showcmd_idx = 0; c1 = 0; if (typebuf.tb_len > 0 && advance && !exmode_active) { - if (((State & (NORMAL | INSERT)) || State == LANGMAP) && State != HITRETURN) { + if (((State & (MODE_NORMAL | MODE_INSERT)) || State == MODE_LANGMAP) + && State != MODE_HITRETURN) { // this looks nice when typing a dead character map - if (State & INSERT - && ptr2cells(typebuf.tb_buf + typebuf.tb_off + typebuf.tb_len - 1) == 1) { + if (State & MODE_INSERT + && ptr2cells((char *)typebuf.tb_buf + typebuf.tb_off + typebuf.tb_len - 1) == 1) { edit_putchar(typebuf.tb_buf[typebuf.tb_off + typebuf.tb_len - 1], false); setcursor(); // put cursor back where it belongs c1 = 1; @@ -2347,10 +2533,10 @@ static int vgetorpeek(bool advance) } // this looks nice when typing a dead character map - if ((State & CMDLINE) && cmdline_star == 0) { - char_u *p = typebuf.tb_buf + typebuf.tb_off + typebuf.tb_len - 1; - if (ptr2cells(p) == 1 && *p < 128) { - putcmdline((char)(*p), false); + if ((State & MODE_CMDLINE) && cmdline_star == 0) { + char *p = (char *)typebuf.tb_buf + typebuf.tb_off + typebuf.tb_len - 1; + if (ptr2cells(p) == 1 && (uint8_t)(*p) < 128) { + putcmdline(*p, false); c1 = 1; } } @@ -2358,8 +2544,8 @@ static int vgetorpeek(bool advance) // get a character: 3. from the user - get it if (typebuf.tb_len == 0) { - // timedout may have been set while waiting for a mapping - // that has a <Nop> RHS. + // timedout may have been set if a mapping with empty RHS + // fully matched while longer mappings timed out. timedout = false; } @@ -2385,10 +2571,10 @@ static int vgetorpeek(bool advance) pop_showcmd(); } if (c1 == 1) { - if (State & INSERT) { + if (State & MODE_INSERT) { edit_unputchar(); } - if (State & CMDLINE) { + if (State & MODE_CMDLINE) { unputcmdline(); } else { setcursor(); // put cursor back where it belongs @@ -2420,7 +2606,7 @@ static int vgetorpeek(bool advance) // The "INSERT" message is taken care of here: // if we return an ESC to exit insert mode, the message is deleted // if we don't return an ESC but deleted the message before, redisplay it - if (advance && p_smd && msg_silent == 0 && (State & INSERT)) { + if (advance && p_smd && msg_silent == 0 && (State & MODE_INSERT)) { if (c == ESC && !mode_deleted && !no_mapping && mode_displayed) { if (typebuf.tb_len && !KeyTyped) { redraw_cmdline = true; // delete mode later @@ -2456,7 +2642,7 @@ static int vgetorpeek(bool advance) /// 1. a scriptfile /// 2. the keyboard /// -/// As much characters as we can get (up to 'maxlen') are put in "buf" and +/// As many characters as we can get (up to 'maxlen') are put in "buf" and /// NUL terminated (buffer length must be 'maxlen' + 1). /// Minimum for "maxlen" is 3!!!! /// @@ -2491,7 +2677,7 @@ int inchar(char_u *buf, int maxlen, long wait_time) * recursive loop may result (write error in swapfile, hit-return, timeout * on char wait, flush swapfile, write error....). */ - if (State != HITRETURN) { + if (State != MODE_HITRETURN) { did_outofmem_msg = false; // display out of memory message (again) did_swapwrite_msg = false; // display swap file write error again } @@ -2529,12 +2715,12 @@ int inchar(char_u *buf, int maxlen, long wait_time) // Don't use buf[] here, closescript() may have freed typebuf.tb_buf[] // and buf may be pointing inside typebuf.tb_buf[]. if (got_int) { -#define DUM_LEN MAXMAPLEN * 3 + 3 +#define DUM_LEN (MAXMAPLEN * 3 + 3) char_u dum[DUM_LEN + 1]; for (;;) { len = os_inchar(dum, DUM_LEN, 0L, 0, NULL); - if (len == 0 || (len == 1 && dum[0] == 3)) { + if (len == 0 || (len == 1 && dum[0] == Ctrl_C)) { break; } } @@ -2573,7 +2759,7 @@ int fix_input_buffer(char_u *buf, int len) FUNC_ATTR_NONNULL_ALL { if (!using_script()) { - // Should not escape K_SPECIAL/CSI reading input from the user because vim + // Should not escape K_SPECIAL reading input from the user because vim // key codes keys are processed in input.c/input_enqueue. buf[len] = NUL; return len; @@ -2584,9 +2770,8 @@ int fix_input_buffer(char_u *buf, int len) char_u *p = buf; // Two characters are special: NUL and K_SPECIAL. - // Replace NUL by K_SPECIAL KS_ZERO KE_FILLER + // Replace NUL by K_SPECIAL KS_ZERO KE_FILLER // Replace K_SPECIAL by K_SPECIAL KS_SPECIAL KE_FILLER - // Replace CSI by K_SPECIAL KS_EXTRA KE_CSI for (i = len; --i >= 0; ++p) { if (p[0] == NUL || (p[0] == K_SPECIAL @@ -2603,1930 +2788,6 @@ int fix_input_buffer(char_u *buf, int len) return len; } -/// Replace termcodes in the given LHS and RHS and store the results into the -/// `lhs` and `rhs` of the given @ref MapArguments struct. -/// -/// `rhs` and `orig_rhs` will both point to new allocated buffers. `orig_rhs` -/// will hold a copy of the given `orig_rhs`. -/// -/// The `*_len` variables will be set appropriately. If the length of -/// the final `lhs` exceeds `MAXMAPLEN`, `lhs_len` will be set equal to the -/// original larger length and `lhs` will be truncated. -/// -/// If RHS is equal to "<Nop>", `rhs` will be the empty string, `rhs_len` -/// will be zero, and `rhs_is_noop` will be set to true. -/// -/// Any memory allocated by @ref replace_termcodes is freed before this function -/// returns. -/// -/// @param[in] orig_lhs Original mapping LHS, with characters to replace. -/// @param[in] orig_lhs_len `strlen` of orig_lhs. -/// @param[in] orig_rhs Original mapping RHS, with characters to replace. -/// @param[in] rhs_lua Lua reference for Lua maps. -/// @param[in] orig_rhs_len `strlen` of orig_rhs. -/// @param[in] cpo_flags See param docs for @ref replace_termcodes. -/// @param[out] mapargs MapArguments struct holding the replaced strings. -void set_maparg_lhs_rhs(const char_u *orig_lhs, const size_t orig_lhs_len, - const char_u *orig_rhs, const size_t orig_rhs_len, - LuaRef rhs_lua, int cpo_flags, MapArguments *mapargs) -{ - char_u *lhs_buf = NULL; - char_u *rhs_buf = NULL; - - // If mapping has been given as ^V<C_UP> say, then replace the term codes - // with the appropriate two bytes. If it is a shifted special key, unshift - // it too, giving another two bytes. - // - // replace_termcodes() may move the result to allocated memory, which - // needs to be freed later (*lhs_buf and *rhs_buf). - // replace_termcodes() also removes CTRL-Vs and sometimes backslashes. - char_u *replaced = replace_termcodes(orig_lhs, orig_lhs_len, &lhs_buf, - true, true, true, cpo_flags); - mapargs->lhs_len = STRLEN(replaced); - STRLCPY(mapargs->lhs, replaced, sizeof(mapargs->lhs)); - mapargs->rhs_lua = rhs_lua; - - if (rhs_lua == LUA_NOREF) { - mapargs->orig_rhs_len = orig_rhs_len; - mapargs->orig_rhs = xcalloc(mapargs->orig_rhs_len + 1, sizeof(char_u)); - STRLCPY(mapargs->orig_rhs, orig_rhs, mapargs->orig_rhs_len + 1); - - if (STRICMP(orig_rhs, "<nop>") == 0) { // "<Nop>" means nothing - mapargs->rhs = xcalloc(1, sizeof(char_u)); // single null-char - mapargs->rhs_len = 0; - mapargs->rhs_is_noop = true; - } else { - replaced = replace_termcodes(orig_rhs, orig_rhs_len, &rhs_buf, - false, true, true, cpo_flags); - mapargs->rhs_len = STRLEN(replaced); - mapargs->rhs_is_noop = false; - mapargs->rhs = xcalloc(mapargs->rhs_len + 1, sizeof(char_u)); - STRLCPY(mapargs->rhs, replaced, mapargs->rhs_len + 1); - } - } else { - char tmp_buf[64]; - // stores <lua>ref_no<cr> in map_str - mapargs->orig_rhs_len = (size_t)vim_snprintf(S_LEN(tmp_buf), "<LUA>%d<CR>", rhs_lua); - mapargs->orig_rhs = vim_strsave((char_u *)tmp_buf); - mapargs->rhs_len = (size_t)vim_snprintf(S_LEN(tmp_buf), "%c%c%c%d\r", K_SPECIAL, - (char_u)KEY2TERMCAP0(K_LUA), KEY2TERMCAP1(K_LUA), - rhs_lua); - mapargs->rhs = vim_strsave((char_u *)tmp_buf); - } - - xfree(lhs_buf); - xfree(rhs_buf); -} - -/// Parse a string of |:map-arguments| into a @ref MapArguments struct. -/// -/// Termcodes, backslashes, CTRL-V's, etc. inside the extracted {lhs} and -/// {rhs} are replaced by @ref set_maparg_lhs_rhs. -/// -/// rhs and orig_rhs in the returned mapargs will be set to null or a pointer -/// to allocated memory and should be freed even on error. -/// -/// @param[in] strargs String of map args, e.g. "<buffer> <expr><silent>". -/// May contain leading or trailing whitespace. -/// @param[in] is_unmap True, if strargs should be parsed like an |:unmap| -/// command. |:unmap| commands interpret *all* text to the -/// right of the last map argument as the {lhs} of the -/// mapping, i.e. a literal ' ' character is treated like -/// a "<space>", rather than separating the {lhs} from the -/// {rhs}. -/// @param[out] mapargs MapArguments struct holding all extracted argument -/// values. -/// @return 0 on success, 1 if invalid arguments are detected. -int str_to_mapargs(const char_u *strargs, bool is_unmap, MapArguments *mapargs) -{ - const char_u *to_parse = strargs; - to_parse = skipwhite(to_parse); - MapArguments parsed_args; // copy these into mapargs "all at once" when done - memset(&parsed_args, 0, sizeof(parsed_args)); - - // Accept <buffer>, <nowait>, <silent>, <expr>, <script>, and <unique> in - // any order. - while (true) { - if (STRNCMP(to_parse, "<buffer>", 8) == 0) { - to_parse = skipwhite(to_parse + 8); - parsed_args.buffer = true; - continue; - } - - if (STRNCMP(to_parse, "<nowait>", 8) == 0) { - to_parse = skipwhite(to_parse + 8); - parsed_args.nowait = true; - continue; - } - - if (STRNCMP(to_parse, "<silent>", 8) == 0) { - to_parse = skipwhite(to_parse + 8); - parsed_args.silent = true; - continue; - } - - // Ignore obsolete "<special>" modifier. - if (STRNCMP(to_parse, "<special>", 9) == 0) { - to_parse = skipwhite(to_parse + 9); - continue; - } - - if (STRNCMP(to_parse, "<script>", 8) == 0) { - to_parse = skipwhite(to_parse + 8); - parsed_args.script = true; - continue; - } - - if (STRNCMP(to_parse, "<expr>", 6) == 0) { - to_parse = skipwhite(to_parse + 6); - parsed_args.expr = true; - continue; - } - - if (STRNCMP(to_parse, "<unique>", 8) == 0) { - to_parse = skipwhite(to_parse + 8); - parsed_args.unique = true; - continue; - } - break; - } - - // Find the next whitespace character, call that the end of {lhs}. - // - // If a character (e.g. whitespace) is immediately preceded by a CTRL-V, - // "scan past" that character, i.e. don't "terminate" LHS with that character - // if it's whitespace. - // - // Treat backslash like CTRL-V when 'cpoptions' does not contain 'B'. - // - // With :unmap, literal white space is included in the {lhs}; there is no - // separate {rhs}. - const char_u *lhs_end = to_parse; - bool do_backslash = (vim_strchr(p_cpo, CPO_BSLASH) == NULL); - while (*lhs_end && (is_unmap || !ascii_iswhite(*lhs_end))) { - if ((lhs_end[0] == Ctrl_V || (do_backslash && lhs_end[0] == '\\')) - && lhs_end[1] != NUL) { - lhs_end++; // skip CTRL-V or backslash - } - lhs_end++; - } - - // {lhs_end} is a pointer to the "terminating whitespace" after {lhs}. - // Use that to initialize {rhs_start}. - const char_u *rhs_start = skipwhite(lhs_end); - - // Given {lhs} might be larger than MAXMAPLEN before replace_termcodes - // (e.g. "<Space>" is longer than ' '), so first copy into a buffer. - size_t orig_lhs_len = (size_t)(lhs_end - to_parse); - char_u *lhs_to_replace = xcalloc(orig_lhs_len + 1, sizeof(char_u)); - STRLCPY(lhs_to_replace, to_parse, orig_lhs_len + 1); - - size_t orig_rhs_len = STRLEN(rhs_start); - set_maparg_lhs_rhs(lhs_to_replace, orig_lhs_len, - rhs_start, orig_rhs_len, LUA_NOREF, - CPO_TO_CPO_FLAGS, &parsed_args); - - xfree(lhs_to_replace); - - *mapargs = parsed_args; - - if (parsed_args.lhs_len > MAXMAPLEN) { - return 1; - } - return 0; -} - -/// Sets or removes a mapping or abbreviation in buffer `buf`. -/// -/// @param maptype @see do_map -/// @param args Fully parsed and "preprocessed" arguments for the -/// (un)map/abbrev command. Termcodes should have already been -/// replaced; whitespace, `<` and `>` signs, etc. in {lhs} and -/// {rhs} are assumed to be literal components of the mapping. -/// @param mode @see do_map -/// @param is_abbrev @see do_map -/// @param buf Target Buffer -int buf_do_map(int maptype, MapArguments *args, int mode, bool is_abbrev, buf_T *buf) -{ - mapblock_T *mp, **mpp; - char_u *p; - int n; - int len = 0; // init for GCC - int did_it = false; - int did_local = false; - int round; - int retval = 0; - int hash; - int new_hash; - mapblock_T **abbr_table; - mapblock_T **map_table; - int noremap; - - map_table = maphash; - abbr_table = &first_abbr; - - // For ":noremap" don't remap, otherwise do remap. - if (maptype == 2) { - noremap = REMAP_NONE; - } else { - noremap = REMAP_YES; - } - - if (args->buffer) { - // If <buffer> was given, we'll be searching through the buffer's - // mappings/abbreviations, not the globals. - map_table = buf->b_maphash; - abbr_table = &buf->b_first_abbr; - } - if (args->script) { - noremap = REMAP_SCRIPT; - } - - validate_maphash(); - - bool has_lhs = (args->lhs[0] != NUL); - bool has_rhs = args->rhs_lua != LUA_NOREF || (args->rhs[0] != NUL) || args->rhs_is_noop; - - // check for :unmap without argument - if (maptype == 1 && !has_lhs) { - retval = 1; - goto theend; - } - - char_u *lhs = (char_u *)&args->lhs; - char_u *rhs = args->rhs; - char_u *orig_rhs = args->orig_rhs; - - // check arguments and translate function keys - if (has_lhs) { - len = (int)args->lhs_len; - if (len > MAXMAPLEN) { - retval = 1; - goto theend; - } - - if (is_abbrev && maptype != 1) { - // - // If an abbreviation ends in a keyword character, the - // rest must be all keyword-char or all non-keyword-char. - // Otherwise we won't be able to find the start of it in a - // vi-compatible way. - // - int same = -1; - - const int first = vim_iswordp(lhs); - int last = first; - p = lhs + utfc_ptr2len(lhs); - n = 1; - while (p < lhs + len) { - n++; // nr of (multi-byte) chars - last = vim_iswordp(p); // type of last char - if (same == -1 && last != first) { - same = n - 1; // count of same char type - } - p += utfc_ptr2len(p); - } - if (last && n > 2 && same >= 0 && same < n - 1) { - retval = 1; - goto theend; - } - // An abbreviation cannot contain white space. - for (n = 0; n < len; n++) { - if (ascii_iswhite(lhs[n])) { - retval = 1; - goto theend; - } - } // for - } - } - - if (has_lhs && has_rhs && is_abbrev) { // if we will add an abbreviation, - no_abbr = false; // reset flag that indicates there are no abbreviations - } - - if (!has_lhs || (maptype != 1 && !has_rhs)) { - msg_start(); - } - - // Check if a new local mapping wasn't already defined globally. - if (map_table == buf->b_maphash && has_lhs && has_rhs && maptype != 1) { - // need to loop over all global hash lists - for (hash = 0; hash < 256 && !got_int; hash++) { - if (is_abbrev) { - if (hash != 0) { // there is only one abbreviation list - break; - } - mp = first_abbr; - } else { - mp = maphash[hash]; - } - for (; mp != NULL && !got_int; mp = mp->m_next) { - // check entries with the same mode - if ((mp->m_mode & mode) != 0 - && mp->m_keylen == len - && args->unique - && STRNCMP(mp->m_keys, lhs, (size_t)len) == 0) { - if (is_abbrev) { - semsg(_("E224: global abbreviation already exists for %s"), - mp->m_keys); - } else { - semsg(_("E225: global mapping already exists for %s"), mp->m_keys); - } - retval = 5; - goto theend; - } - } - } - } - - // When listing global mappings, also list buffer-local ones here. - if (map_table != buf->b_maphash && !has_rhs && maptype != 1) { - // need to loop over all global hash lists - for (hash = 0; hash < 256 && !got_int; hash++) { - if (is_abbrev) { - if (hash != 0) { // there is only one abbreviation list - break; - } - mp = buf->b_first_abbr; - } else { - mp = buf->b_maphash[hash]; - } - for (; mp != NULL && !got_int; mp = mp->m_next) { - // check entries with the same mode - if ((mp->m_mode & mode) != 0) { - if (!has_lhs) { // show all entries - showmap(mp, true); - did_local = true; - } else { - n = mp->m_keylen; - if (STRNCMP(mp->m_keys, lhs, (size_t)(n < len ? n : len)) == 0) { - showmap(mp, true); - did_local = true; - } - } - } - } - } - } - - // Find an entry in the maphash[] list that matches. - // For :unmap we may loop two times: once to try to unmap an entry with a - // matching 'from' part, a second time, if the first fails, to unmap an - // entry with a matching 'to' part. This was done to allow ":ab foo bar" - // to be unmapped by typing ":unab foo", where "foo" will be replaced by - // "bar" because of the abbreviation. - for (round = 0; (round == 0 || maptype == 1) && round <= 1 - && !did_it && !got_int; round++) { - // need to loop over all hash lists - for (hash = 0; hash < 256 && !got_int; hash++) { - if (is_abbrev) { - if (hash > 0) { // there is only one abbreviation list - break; - } - mpp = abbr_table; - } else { - mpp = &(map_table[hash]); - } - for (mp = *mpp; mp != NULL && !got_int; mp = *mpp) { - if (!(mp->m_mode & mode)) { // skip entries with wrong mode - mpp = &(mp->m_next); - continue; - } - if (!has_lhs) { // show all entries - showmap(mp, map_table != maphash); - did_it = true; - } else { // do we have a match? - if (round) { // second round: Try unmap "rhs" string - n = (int)STRLEN(mp->m_str); - p = mp->m_str; - } else { - n = mp->m_keylen; - p = mp->m_keys; - } - if (STRNCMP(p, lhs, (size_t)(n < len ? n : len)) == 0) { - if (maptype == 1) { // delete entry - // Only accept a full match. For abbreviations we - // ignore trailing space when matching with the - // "lhs", since an abbreviation can't have - // trailing space. - if (n != len && (!is_abbrev || round || n > len - || *skipwhite(lhs + n) != NUL)) { - mpp = &(mp->m_next); - continue; - } - // We reset the indicated mode bits. If nothing is - // left the entry is deleted below. - mp->m_mode &= ~mode; - did_it = true; // remember we did something - } else if (!has_rhs) { // show matching entry - showmap(mp, map_table != maphash); - did_it = true; - } else if (n != len) { // new entry is ambiguous - mpp = &(mp->m_next); - continue; - } else if (args->unique) { - if (is_abbrev) { - semsg(_("E226: abbreviation already exists for %s"), p); - } else { - semsg(_("E227: mapping already exists for %s"), p); - } - retval = 5; - goto theend; - } else { // new rhs for existing entry - mp->m_mode &= ~mode; // remove mode bits - if (mp->m_mode == 0 && !did_it) { // reuse entry - XFREE_CLEAR(mp->m_str); - XFREE_CLEAR(mp->m_orig_str); - XFREE_CLEAR(mp->m_desc); - NLUA_CLEAR_REF(mp->m_luaref); - - mp->m_str = vim_strsave(rhs); - mp->m_orig_str = vim_strsave(orig_rhs); - mp->m_luaref = args->rhs_lua; - mp->m_noremap = noremap; - mp->m_nowait = args->nowait; - mp->m_silent = args->silent; - mp->m_mode = mode; - mp->m_expr = args->expr; - mp->m_script_ctx = current_sctx; - mp->m_script_ctx.sc_lnum += sourcing_lnum; - if (args->desc != NULL) { - mp->m_desc = xstrdup(args->desc); - } - did_it = true; - } - } - if (mp->m_mode == 0) { // entry can be deleted - mapblock_free(mpp); - continue; // continue with *mpp - } - - // May need to put this entry into another hash list. - new_hash = MAP_HASH(mp->m_mode, mp->m_keys[0]); - if (!is_abbrev && new_hash != hash) { - *mpp = mp->m_next; - mp->m_next = map_table[new_hash]; - map_table[new_hash] = mp; - - continue; // continue with *mpp - } - } - } - mpp = &(mp->m_next); - } - } - } - - if (maptype == 1) { // delete entry - if (!did_it) { - retval = 2; // no match - } else if (*lhs == Ctrl_C) { - // If CTRL-C has been unmapped, reuse it for Interrupting. - if (map_table == buf->b_maphash) { - buf->b_mapped_ctrl_c &= ~mode; - } else { - mapped_ctrl_c &= ~mode; - } - } - goto theend; - } - - if (!has_lhs || !has_rhs) { // print entries - if (!did_it && !did_local) { - if (is_abbrev) { - msg(_("No abbreviation found")); - } else { - msg(_("No mapping found")); - } - } - goto theend; // listing finished - } - - if (did_it) { // have added the new entry already - goto theend; - } - - // Get here when adding a new entry to the maphash[] list or abbrlist. - mp = xmalloc(sizeof(mapblock_T)); - - // If CTRL-C has been mapped, don't always use it for Interrupting. - if (*lhs == Ctrl_C) { - if (map_table == buf->b_maphash) { - buf->b_mapped_ctrl_c |= mode; - } else { - mapped_ctrl_c |= mode; - } - } - - mp->m_keys = vim_strsave(lhs); - mp->m_str = vim_strsave(rhs); - mp->m_orig_str = vim_strsave(orig_rhs); - mp->m_luaref = args->rhs_lua; - mp->m_keylen = (int)STRLEN(mp->m_keys); - mp->m_noremap = noremap; - mp->m_nowait = args->nowait; - mp->m_silent = args->silent; - mp->m_mode = mode; - mp->m_expr = args->expr; - mp->m_script_ctx = current_sctx; - mp->m_script_ctx.sc_lnum += sourcing_lnum; - mp->m_desc = NULL; - if (args->desc != NULL) { - mp->m_desc = xstrdup(args->desc); - } - - // add the new entry in front of the abbrlist or maphash[] list - if (is_abbrev) { - mp->m_next = *abbr_table; - *abbr_table = mp; - } else { - n = MAP_HASH(mp->m_mode, mp->m_keys[0]); - mp->m_next = map_table[n]; - map_table[n] = mp; - } - -theend: - return retval; -} - - -/// Set or remove a mapping or an abbreviation in the current buffer, OR -/// display (matching) mappings/abbreviations. -/// -/// ```vim -/// map[!] " show all key mappings -/// map[!] {lhs} " show key mapping for {lhs} -/// map[!] {lhs} {rhs} " set key mapping for {lhs} to {rhs} -/// noremap[!] {lhs} {rhs} " same, but no remapping for {rhs} -/// unmap[!] {lhs} " remove key mapping for {lhs} -/// abbr " show all abbreviations -/// abbr {lhs} " show abbreviations for {lhs} -/// abbr {lhs} {rhs} " set abbreviation for {lhs} to {rhs} -/// noreabbr {lhs} {rhs} " same, but no remapping for {rhs} -/// unabbr {lhs} " remove abbreviation for {lhs} -/// -/// for :map mode is NORMAL + VISUAL + SELECTMODE + OP_PENDING -/// for :map! mode is INSERT + CMDLINE -/// for :cmap mode is CMDLINE -/// for :imap mode is INSERT -/// for :lmap mode is LANGMAP -/// for :nmap mode is NORMAL -/// for :vmap mode is VISUAL + SELECTMODE -/// for :xmap mode is VISUAL -/// for :smap mode is SELECTMODE -/// for :omap mode is OP_PENDING -/// for :tmap mode is TERM_FOCUS -/// -/// for :abbr mode is INSERT + CMDLINE -/// for :iabbr mode is INSERT -/// for :cabbr mode is CMDLINE -/// ``` -/// -/// @param maptype 0 for |:map|, 1 for |:unmap|, 2 for |noremap|. -/// @param arg C-string containing the arguments of the map/abbrev -/// command, i.e. everything except the initial `:[X][nore]map`. -/// - Cannot be a read-only string; it will be modified. -/// @param mode Bitflags representing the mode in which to set the mapping. -/// See @ref get_map_mode. -/// @param is_abbrev True if setting an abbreviation, false otherwise. -/// -/// @return 0 on success. On failure, will return one of the following: -/// - 1 for invalid arguments -/// - 2 for no match -/// - 4 for out of mem (deprecated, WON'T HAPPEN) -/// - 5 for entry not unique -/// -int do_map(int maptype, char_u *arg, int mode, bool is_abbrev) -{ - MapArguments parsed_args; - int result = str_to_mapargs(arg, maptype == 1, &parsed_args); - switch (result) { - case 0: - break; - case 1: - // invalid arguments - goto free_and_return; - default: - assert(false && "Unknown return code from str_to_mapargs!"); - result = -1; - goto free_and_return; - } // switch - - result = buf_do_map(maptype, &parsed_args, mode, is_abbrev, curbuf); - -free_and_return: - xfree(parsed_args.rhs); - xfree(parsed_args.orig_rhs); - return result; -} - -/* - * Delete one entry from the abbrlist or maphash[]. - * "mpp" is a pointer to the m_next field of the PREVIOUS entry! - */ -static void mapblock_free(mapblock_T **mpp) -{ - mapblock_T *mp; - - mp = *mpp; - xfree(mp->m_keys); - NLUA_CLEAR_REF(mp->m_luaref); - XFREE_CLEAR(mp->m_str); - XFREE_CLEAR(mp->m_orig_str); - XFREE_CLEAR(mp->m_desc); - *mpp = mp->m_next; - xfree(mp); -} - -/* - * Initialize maphash[] for first use. - */ -static void validate_maphash(void) -{ - if (!maphash_valid) { - memset(maphash, 0, sizeof(maphash)); - maphash_valid = TRUE; - } -} - -/* - * Get the mapping mode from the command name. - */ -int get_map_mode(char_u **cmdp, bool forceit) -{ - char_u *p; - int modec; - int mode; - - p = *cmdp; - modec = *p++; - if (modec == 'i') { - mode = INSERT; // :imap - } else if (modec == 'l') { - mode = LANGMAP; // :lmap - } else if (modec == 'c') { - mode = CMDLINE; // :cmap - } else if (modec == 'n' && *p != 'o') { // avoid :noremap - mode = NORMAL; // :nmap - } else if (modec == 'v') { - mode = VISUAL + SELECTMODE; // :vmap - } else if (modec == 'x') { - mode = VISUAL; // :xmap - } else if (modec == 's') { - mode = SELECTMODE; // :smap - } else if (modec == 'o') { - mode = OP_PENDING; // :omap - } else if (modec == 't') { - mode = TERM_FOCUS; // :tmap - } else { - p--; - if (forceit) { - mode = INSERT + CMDLINE; // :map ! - } else { - mode = VISUAL + SELECTMODE + NORMAL + OP_PENDING; // :map - } - } - - *cmdp = p; - return mode; -} - -/* - * Clear all mappings or abbreviations. - * 'abbr' should be FALSE for mappings, TRUE for abbreviations. - */ -void map_clear_mode(char_u *cmdp, char_u *arg, int forceit, int abbr) -{ - int mode; - int local; - - local = (STRCMP(arg, "<buffer>") == 0); - if (!local && *arg != NUL) { - emsg(_(e_invarg)); - return; - } - - mode = get_map_mode(&cmdp, forceit); - map_clear_int(curbuf, mode, - local, - abbr); -} - -/// Clear all mappings in "mode". -/// -/// @param buf, buffer for local mappings -/// @param mode mode in which to delete -/// @param local true for buffer-local mappings -/// @param abbr true for abbreviations -void map_clear_int(buf_T *buf, int mode, bool local, bool abbr) -{ - mapblock_T *mp, **mpp; - int hash; - int new_hash; - - validate_maphash(); - - for (hash = 0; hash < 256; ++hash) { - if (abbr) { - if (hash > 0) { // there is only one abbrlist - break; - } - if (local) { - mpp = &buf->b_first_abbr; - } else { - mpp = &first_abbr; - } - } else { - if (local) { - mpp = &buf->b_maphash[hash]; - } else { - mpp = &maphash[hash]; - } - } - while (*mpp != NULL) { - mp = *mpp; - if (mp->m_mode & mode) { - mp->m_mode &= ~mode; - if (mp->m_mode == 0) { // entry can be deleted - mapblock_free(mpp); - continue; - } - /* - * May need to put this entry into another hash list. - */ - new_hash = MAP_HASH(mp->m_mode, mp->m_keys[0]); - if (!abbr && new_hash != hash) { - *mpp = mp->m_next; - if (local) { - mp->m_next = buf->b_maphash[new_hash]; - buf->b_maphash[new_hash] = mp; - } else { - mp->m_next = maphash[new_hash]; - maphash[new_hash] = mp; - } - continue; // continue with *mpp - } - } - mpp = &(mp->m_next); - } - } -} - -/// Return characters to represent the map mode in an allocated string -/// -/// @return [allocated] NUL-terminated string with characters. -char *map_mode_to_chars(int mode) - FUNC_ATTR_MALLOC FUNC_ATTR_NONNULL_RET -{ - garray_T mapmode; - - ga_init(&mapmode, 1, 7); - - if ((mode & (INSERT + CMDLINE)) == INSERT + CMDLINE) { - ga_append(&mapmode, '!'); // :map! - } else if (mode & INSERT) { - ga_append(&mapmode, 'i'); // :imap - } else if (mode & LANGMAP) { - ga_append(&mapmode, 'l'); // :lmap - } else if (mode & CMDLINE) { - ga_append(&mapmode, 'c'); // :cmap - } else if ((mode & (NORMAL + VISUAL + SELECTMODE + OP_PENDING)) - == NORMAL + VISUAL + SELECTMODE + OP_PENDING) { - ga_append(&mapmode, ' '); // :map - } else { - if (mode & NORMAL) { - ga_append(&mapmode, 'n'); // :nmap - } - if (mode & OP_PENDING) { - ga_append(&mapmode, 'o'); // :omap - } - if (mode & TERM_FOCUS) { - ga_append(&mapmode, 't'); // :tmap - } - if ((mode & (VISUAL + SELECTMODE)) == VISUAL + SELECTMODE) { - ga_append(&mapmode, 'v'); // :vmap - } else { - if (mode & VISUAL) { - ga_append(&mapmode, 'x'); // :xmap - } - if (mode & SELECTMODE) { - ga_append(&mapmode, 's'); // :smap - } - } - } - - ga_append(&mapmode, NUL); - return (char *)mapmode.ga_data; -} - -/// @param local true for buffer-local map -static void showmap(mapblock_T *mp, bool local) -{ - size_t len = 1; - - if (message_filtered(mp->m_keys) - && mp->m_str != NULL && message_filtered(mp->m_str)) { - return; - } - - if (msg_didout || msg_silent != 0) { - msg_putchar('\n'); - if (got_int) { // 'q' typed at MORE prompt - return; - } - } - - { - char *const mapchars = map_mode_to_chars(mp->m_mode); - msg_puts(mapchars); - len = strlen(mapchars); - xfree(mapchars); - } - - while (++len <= 3) { - msg_putchar(' '); - } - - // Display the LHS. Get length of what we write. - len = (size_t)msg_outtrans_special(mp->m_keys, true, 0); - do { - msg_putchar(' '); // padd with blanks - len++; - } while (len < 12); - - if (mp->m_noremap == REMAP_NONE) { - msg_puts_attr("*", HL_ATTR(HLF_8)); - } else if (mp->m_noremap == REMAP_SCRIPT) { - msg_puts_attr("&", HL_ATTR(HLF_8)); - } else { - msg_putchar(' '); - } - - if (local) { - msg_putchar('@'); - } else { - msg_putchar(' '); - } - - /* Use FALSE below if we only want things like <Up> to show up as such on - * the rhs, and not M-x etc, TRUE gets both -- webb */ - if (mp->m_luaref != LUA_NOREF) { - char msg[100]; - snprintf(msg, sizeof(msg), "<Lua function %d>", mp->m_luaref); - msg_puts_attr(msg, HL_ATTR(HLF_8)); - } else if (mp->m_str == NULL) { - msg_puts_attr("<Nop>", HL_ATTR(HLF_8)); - } else { - // Remove escaping of CSI, because "m_str" is in a format to be used - // as typeahead. - char_u *s = vim_strsave(mp->m_str); - vim_unescape_csi(s); - msg_outtrans_special(s, false, 0); - xfree(s); - } - - if (mp->m_desc != NULL) { - msg_puts("\n "); // Shift line to same level as rhs. - msg_puts(mp->m_desc); - } - if (p_verbose > 0) { - last_set_msg(mp->m_script_ctx); - } - ui_flush(); // show one line at a time -} - -/// Check if a map exists that has given string in the rhs -/// -/// Also checks mappings local to the current buffer. -/// -/// @param[in] str String which mapping must have in the rhs. Termcap codes -/// are recognized in this argument. -/// @param[in] modechars Mode(s) in which mappings are checked. -/// @param[in] abbr true if checking abbreviations in place of mappings. -/// -/// @return true if there is at least one mapping with given parameters. -bool map_to_exists(const char *const str, const char *const modechars, const bool abbr) - FUNC_ATTR_NONNULL_ALL FUNC_ATTR_WARN_UNUSED_RESULT FUNC_ATTR_PURE -{ - int mode = 0; - int retval; - - char_u *buf; - char_u *const rhs = replace_termcodes((const char_u *)str, strlen(str), &buf, - false, true, true, - CPO_TO_CPO_FLAGS); - -#define MAPMODE(mode, modechars, chr, modeflags) \ - do { \ - if (strchr(modechars, chr) != NULL) { \ - mode |= modeflags; \ - } \ - } while (0) - MAPMODE(mode, modechars, 'n', NORMAL); - MAPMODE(mode, modechars, 'v', VISUAL|SELECTMODE); - MAPMODE(mode, modechars, 'x', VISUAL); - MAPMODE(mode, modechars, 's', SELECTMODE); - MAPMODE(mode, modechars, 'o', OP_PENDING); - MAPMODE(mode, modechars, 'i', INSERT); - MAPMODE(mode, modechars, 'l', LANGMAP); - MAPMODE(mode, modechars, 'c', CMDLINE); -#undef MAPMODE - - retval = map_to_exists_mode((const char *)rhs, mode, abbr); - xfree(buf); - - return retval; -} - -/// Check if a map exists that has given string in the rhs -/// -/// Also checks mappings local to the current buffer. -/// -/// @param[in] rhs String which mapping must have in the rhs. Termcap codes -/// are recognized in this argument. -/// @param[in] mode Mode(s) in which mappings are checked. -/// @param[in] abbr true if checking abbreviations in place of mappings. -/// -/// @return true if there is at least one mapping with given parameters. -int map_to_exists_mode(const char *const rhs, const int mode, const bool abbr) -{ - mapblock_T *mp; - int hash; - bool exp_buffer = false; - - validate_maphash(); - - // Do it twice: once for global maps and once for local maps. - for (;;) { - for (hash = 0; hash < 256; hash++) { - if (abbr) { - if (hash > 0) { // There is only one abbr list. - break; - } - if (exp_buffer) { - mp = curbuf->b_first_abbr; - } else { - mp = first_abbr; - } - } else if (exp_buffer) { - mp = curbuf->b_maphash[hash]; - } else { - mp = maphash[hash]; - } - for (; mp; mp = mp->m_next) { - if ((mp->m_mode & mode) - && mp->m_str != NULL && strstr((char *)mp->m_str, rhs) != NULL) { - return true; - } - } - } - if (exp_buffer) { - break; - } - exp_buffer = true; - } - - return false; -} - -/* - * Used below when expanding mapping/abbreviation names. - */ -static int expand_mapmodes = 0; -static bool expand_isabbrev = false; -static bool expand_buffer = false; - -/// Work out what to complete when doing command line completion of mapping -/// or abbreviation names. -/// -/// @param forceit true if '!' given -/// @param isabbrev true if abbreviation -/// @param isunmap true if unmap/unabbrev command -char_u *set_context_in_map_cmd(expand_T *xp, char_u *cmd, char_u *arg, bool forceit, bool isabbrev, - bool isunmap, cmdidx_T cmdidx) -{ - if (forceit && cmdidx != CMD_map && cmdidx != CMD_unmap) { - xp->xp_context = EXPAND_NOTHING; - } else { - if (isunmap) { - expand_mapmodes = get_map_mode(&cmd, forceit || isabbrev); - } else { - expand_mapmodes = INSERT + CMDLINE; - if (!isabbrev) { - expand_mapmodes += VISUAL + SELECTMODE + NORMAL + OP_PENDING; - } - } - expand_isabbrev = isabbrev; - xp->xp_context = EXPAND_MAPPINGS; - expand_buffer = false; - for (;;) { - if (STRNCMP(arg, "<buffer>", 8) == 0) { - expand_buffer = true; - arg = skipwhite(arg + 8); - continue; - } - if (STRNCMP(arg, "<unique>", 8) == 0) { - arg = skipwhite(arg + 8); - continue; - } - if (STRNCMP(arg, "<nowait>", 8) == 0) { - arg = skipwhite(arg + 8); - continue; - } - if (STRNCMP(arg, "<silent>", 8) == 0) { - arg = skipwhite(arg + 8); - continue; - } - if (STRNCMP(arg, "<special>", 9) == 0) { - arg = skipwhite(arg + 9); - continue; - } - if (STRNCMP(arg, "<script>", 8) == 0) { - arg = skipwhite(arg + 8); - continue; - } - if (STRNCMP(arg, "<expr>", 6) == 0) { - arg = skipwhite(arg + 6); - continue; - } - break; - } - xp->xp_pattern = arg; - } - - return NULL; -} - -// Find all mapping/abbreviation names that match regexp "regmatch". -// For command line expansion of ":[un]map" and ":[un]abbrev" in all modes. -// Return OK if matches found, FAIL otherwise. -int ExpandMappings(regmatch_T *regmatch, int *num_file, char_u ***file) -{ - mapblock_T *mp; - int hash; - int count; - int round; - char_u *p; - int i; - - validate_maphash(); - - *num_file = 0; // return values in case of FAIL - *file = NULL; - - /* - * round == 1: Count the matches. - * round == 2: Build the array to keep the matches. - */ - for (round = 1; round <= 2; ++round) { - count = 0; - - for (i = 0; i < 7; i++) { - if (i == 0) { - p = (char_u *)"<silent>"; - } else if (i == 1) { - p = (char_u *)"<unique>"; - } else if (i == 2) { - p = (char_u *)"<script>"; - } else if (i == 3) { - p = (char_u *)"<expr>"; - } else if (i == 4 && !expand_buffer) { - p = (char_u *)"<buffer>"; - } else if (i == 5) { - p = (char_u *)"<nowait>"; - } else if (i == 6) { - p = (char_u *)"<special>"; - } else { - continue; - } - - if (vim_regexec(regmatch, p, (colnr_T)0)) { - if (round == 1) { - ++count; - } else { - (*file)[count++] = vim_strsave(p); - } - } - } - - for (hash = 0; hash < 256; ++hash) { - if (expand_isabbrev) { - if (hash > 0) { // only one abbrev list - break; // for (hash) - } - mp = first_abbr; - } else if (expand_buffer) { - mp = curbuf->b_maphash[hash]; - } else { - mp = maphash[hash]; - } - for (; mp; mp = mp->m_next) { - if (mp->m_mode & expand_mapmodes) { - p = translate_mapping(mp->m_keys, CPO_TO_CPO_FLAGS); - if (p != NULL && vim_regexec(regmatch, p, (colnr_T)0)) { - if (round == 1) { - ++count; - } else { - (*file)[count++] = p; - p = NULL; - } - } - xfree(p); - } - } // for (mp) - } // for (hash) - - if (count == 0) { // no match found - break; // for (round) - } - - if (round == 1) { - *file = (char_u **)xmalloc((size_t)count * sizeof(char_u *)); - } - } // for (round) - - if (count > 1) { - char_u **ptr1; - char_u **ptr2; - char_u **ptr3; - - // Sort the matches - sort_strings(*file, count); - - // Remove multiple entries - ptr1 = *file; - ptr2 = ptr1 + 1; - ptr3 = ptr1 + count; - - while (ptr2 < ptr3) { - if (STRCMP(*ptr1, *ptr2)) { - *++ptr1 = *ptr2++; - } else { - xfree(*ptr2++); - count--; - } - } - } - - *num_file = count; - return count == 0 ? FAIL : OK; -} - -// Check for an abbreviation. -// Cursor is at ptr[col]. -// When inserting, mincol is where insert started. -// For the command line, mincol is what is to be skipped over. -// "c" is the character typed before check_abbr was called. It may have -// ABBR_OFF added to avoid prepending a CTRL-V to it. -// -// Historic vi practice: The last character of an abbreviation must be an id -// character ([a-zA-Z0-9_]). The characters in front of it must be all id -// characters or all non-id characters. This allows for abbr. "#i" to -// "#include". -// -// Vim addition: Allow for abbreviations that end in a non-keyword character. -// Then there must be white space before the abbr. -// -// Return true if there is an abbreviation, false if not. -bool check_abbr(int c, char_u *ptr, int col, int mincol) -{ - int len; - int scol; // starting column of the abbr. - int j; - char_u *s; - char_u tb[MB_MAXBYTES + 4]; - mapblock_T *mp; - mapblock_T *mp2; - int clen = 0; // length in characters - bool is_id = true; - - if (typebuf.tb_no_abbr_cnt) { // abbrev. are not recursive - return false; - } - - // no remapping implies no abbreviation, except for CTRL-] - if ((KeyNoremap & (RM_NONE|RM_SCRIPT)) != 0 && c != Ctrl_RSB) { - return false; - } - - // Check for word before the cursor: If it ends in a keyword char all - // chars before it must be keyword chars or non-keyword chars, but not - // white space. If it ends in a non-keyword char we accept any characters - // before it except white space. - if (col == 0) { // cannot be an abbr. - return false; - } - - { - bool vim_abbr; - char_u *p = mb_prevptr(ptr, ptr + col); - if (!vim_iswordp(p)) { - vim_abbr = true; // Vim added abbr. - } else { - vim_abbr = false; // vi compatible abbr. - if (p > ptr) { - is_id = vim_iswordp(mb_prevptr(ptr, p)); - } - } - clen = 1; - while (p > ptr + mincol) { - p = mb_prevptr(ptr, p); - if (ascii_isspace(*p) || (!vim_abbr && is_id != vim_iswordp(p))) { - p += utfc_ptr2len(p); - break; - } - ++clen; - } - scol = (int)(p - ptr); - } - - if (scol < mincol) { - scol = mincol; - } - if (scol < col) { // there is a word in front of the cursor - ptr += scol; - len = col - scol; - mp = curbuf->b_first_abbr; - mp2 = first_abbr; - if (mp == NULL) { - mp = mp2; - mp2 = NULL; - } - for (; mp; - mp->m_next == NULL ? (mp = mp2, mp2 = NULL) : - (mp = mp->m_next)) { - int qlen = mp->m_keylen; - char_u *q = mp->m_keys; - int match; - - if (strchr((const char *)mp->m_keys, K_SPECIAL) != NULL) { - // Might have CSI escaped mp->m_keys. - q = vim_strsave(mp->m_keys); - vim_unescape_csi(q); - qlen = (int)STRLEN(q); - } - // find entries with right mode and keys - match = (mp->m_mode & State) - && qlen == len - && !STRNCMP(q, ptr, (size_t)len); - if (q != mp->m_keys) { - xfree(q); - } - if (match) { - break; - } - } - if (mp != NULL) { - /* - * Found a match: - * Insert the rest of the abbreviation in typebuf.tb_buf[]. - * This goes from end to start. - * - * Characters 0x000 - 0x100: normal chars, may need CTRL-V, - * except K_SPECIAL: Becomes K_SPECIAL KS_SPECIAL KE_FILLER - * Characters where IS_SPECIAL() == TRUE: key codes, need - * K_SPECIAL. Other characters (with ABBR_OFF): don't use CTRL-V. - * - * Character CTRL-] is treated specially - it completes the - * abbreviation, but is not inserted into the input stream. - */ - j = 0; - if (c != Ctrl_RSB) { - // special key code, split up - if (IS_SPECIAL(c) || c == K_SPECIAL) { - tb[j++] = K_SPECIAL; - tb[j++] = (char_u)K_SECOND(c); - tb[j++] = (char_u)K_THIRD(c); - } else { - if (c < ABBR_OFF && (c < ' ' || c > '~')) { - tb[j++] = Ctrl_V; // special char needs CTRL-V - } - // if ABBR_OFF has been added, remove it here. - if (c >= ABBR_OFF) { - c -= ABBR_OFF; - } - int newlen = utf_char2bytes(c, tb + j); - tb[j + newlen] = NUL; - // Need to escape K_SPECIAL. - char_u *escaped = vim_strsave_escape_csi(tb + j); - if (escaped != NULL) { - newlen = (int)STRLEN(escaped); - memmove(tb + j, escaped, (size_t)newlen); - j += newlen; - xfree(escaped); - } - } - tb[j] = NUL; - // insert the last typed char - (void)ins_typebuf(tb, 1, 0, true, mp->m_silent); - } - if (mp->m_expr) { - s = eval_map_expr(mp, c); - } else { - s = mp->m_str; - } - if (s != NULL) { - // insert the to string - (void)ins_typebuf(s, mp->m_noremap, 0, true, mp->m_silent); - // no abbrev. for these chars - typebuf.tb_no_abbr_cnt += (int)STRLEN(s) + j + 1; - if (mp->m_expr) { - xfree(s); - } - } - - tb[0] = Ctrl_H; - tb[1] = NUL; - len = clen; // Delete characters instead of bytes - while (len-- > 0) { // delete the from string - (void)ins_typebuf(tb, 1, 0, true, mp->m_silent); - } - return true; - } - } - return false; -} - -/// Evaluate the RHS of a mapping or abbreviations and take care of escaping -/// special characters. -/// -/// @param c NUL or typed character for abbreviation -static char_u *eval_map_expr(mapblock_T *mp, int c) -{ - char_u *res; - char_u *p = NULL; - char_u *expr = NULL; - char_u *save_cmd; - pos_T save_cursor; - int save_msg_col; - int save_msg_row; - - /* Remove escaping of CSI, because "str" is in a format to be used as - * typeahead. */ - if (mp->m_luaref == LUA_NOREF) { - expr = vim_strsave(mp->m_str); - vim_unescape_csi(expr); - } - - save_cmd = save_cmdline_alloc(); - - // Forbid changing text or using ":normal" to avoid most of the bad side - // effects. Also restore the cursor position. - textlock++; - ex_normal_lock++; - set_vim_var_char(c); // set v:char to the typed character - save_cursor = curwin->w_cursor; - save_msg_col = msg_col; - save_msg_row = msg_row; - if (mp->m_luaref != LUA_NOREF) { - Error err = ERROR_INIT; - Array args = ARRAY_DICT_INIT; - Object ret = nlua_call_ref(mp->m_luaref, NULL, args, true, &err); - if (ret.type == kObjectTypeString) { - p = (char_u *)xstrndup(ret.data.string.data, ret.data.string.size); - } - api_free_object(ret); - if (err.type != kErrorTypeNone) { - semsg_multiline("E5108: %s", err.msg); - api_clear_error(&err); - } - } else { - p = eval_to_string(expr, NULL, false); - xfree(expr); - } - textlock--; - ex_normal_lock--; - curwin->w_cursor = save_cursor; - msg_col = save_msg_col; - msg_row = save_msg_row; - - restore_cmdline_alloc(save_cmd); - - if (p == NULL) { - return NULL; - } - // Escape CSI in the result to be able to use the string as typeahead. - res = vim_strsave_escape_csi(p); - xfree(p); - - return res; -} - -/* - * Copy "p" to allocated memory, escaping K_SPECIAL and CSI so that the result - * can be put in the typeahead buffer. - */ -char_u *vim_strsave_escape_csi(char_u *p) -{ - // Need a buffer to hold up to three times as much. Four in case of an - // illegal utf-8 byte: - // 0xc0 -> 0xc3 - 0x80 -> 0xc3 K_SPECIAL KS_SPECIAL KE_FILLER - char_u *res = xmalloc(STRLEN(p) * 4 + 1); - char_u *d = res; - for (char_u *s = p; *s != NUL;) { - if (s[0] == K_SPECIAL && s[1] != NUL && s[2] != NUL) { - // Copy special key unmodified. - *d++ = *s++; - *d++ = *s++; - *d++ = *s++; - } else { - // Add character, possibly multi-byte to destination, escaping - // CSI and K_SPECIAL. Be careful, it can be an illegal byte! - d = add_char2buf(utf_ptr2char(s), d); - s += utf_ptr2len(s); - } - } - *d = NUL; - - return res; -} - -/* - * Remove escaping from CSI and K_SPECIAL characters. Reverse of - * vim_strsave_escape_csi(). Works in-place. - */ -void vim_unescape_csi(char_u *p) -{ - char_u *s = p, *d = p; - - while (*s != NUL) { - if (s[0] == K_SPECIAL && s[1] == KS_SPECIAL && s[2] == KE_FILLER) { - *d++ = K_SPECIAL; - s += 3; - } else if ((s[0] == K_SPECIAL || s[0] == CSI) - && s[1] == KS_EXTRA && s[2] == (int)KE_CSI) { - *d++ = CSI; - s += 3; - } else { - *d++ = *s++; - } - } - *d = NUL; -} - -/// Write map commands for the current mappings to an .exrc file. -/// Return FAIL on error, OK otherwise. -/// -/// @param buf buffer for local mappings or NULL -int makemap(FILE *fd, buf_T *buf) -{ - mapblock_T *mp; - char_u c1, c2, c3; - char_u *p; - char *cmd; - int abbr; - int hash; - bool did_cpo = false; - - validate_maphash(); - - // Do the loop twice: Once for mappings, once for abbreviations. - // Then loop over all map hash lists. - for (abbr = 0; abbr < 2; abbr++) { - for (hash = 0; hash < 256; hash++) { - if (abbr) { - if (hash > 0) { // there is only one abbr list - break; - } - if (buf != NULL) { - mp = buf->b_first_abbr; - } else { - mp = first_abbr; - } - } else { - if (buf != NULL) { - mp = buf->b_maphash[hash]; - } else { - mp = maphash[hash]; - } - } - - for (; mp; mp = mp->m_next) { - // skip script-local mappings - if (mp->m_noremap == REMAP_SCRIPT) { - continue; - } - - // skip lua mappings and mappings that contain a <SNR> (script-local thing), - // they probably don't work when loaded again - if (mp->m_luaref != LUA_NOREF) { - continue; - } - for (p = mp->m_str; *p != NUL; p++) { - if (p[0] == K_SPECIAL && p[1] == KS_EXTRA - && p[2] == (int)KE_SNR) { - break; - } - } - if (*p != NUL) { - continue; - } - - // It's possible to create a mapping and then ":unmap" certain - // modes. We recreate this here by mapping the individual - // modes, which requires up to three of them. - c1 = NUL; - c2 = NUL; - c3 = NUL; - if (abbr) { - cmd = "abbr"; - } else { - cmd = "map"; - } - switch (mp->m_mode) { - case NORMAL + VISUAL + SELECTMODE + OP_PENDING: - break; - case NORMAL: - c1 = 'n'; - break; - case VISUAL: - c1 = 'x'; - break; - case SELECTMODE: - c1 = 's'; - break; - case OP_PENDING: - c1 = 'o'; - break; - case NORMAL + VISUAL: - c1 = 'n'; - c2 = 'x'; - break; - case NORMAL + SELECTMODE: - c1 = 'n'; - c2 = 's'; - break; - case NORMAL + OP_PENDING: - c1 = 'n'; - c2 = 'o'; - break; - case VISUAL + SELECTMODE: - c1 = 'v'; - break; - case VISUAL + OP_PENDING: - c1 = 'x'; - c2 = 'o'; - break; - case SELECTMODE + OP_PENDING: - c1 = 's'; - c2 = 'o'; - break; - case NORMAL + VISUAL + SELECTMODE: - c1 = 'n'; - c2 = 'v'; - break; - case NORMAL + VISUAL + OP_PENDING: - c1 = 'n'; - c2 = 'x'; - c3 = 'o'; - break; - case NORMAL + SELECTMODE + OP_PENDING: - c1 = 'n'; - c2 = 's'; - c3 = 'o'; - break; - case VISUAL + SELECTMODE + OP_PENDING: - c1 = 'v'; - c2 = 'o'; - break; - case CMDLINE + INSERT: - if (!abbr) { - cmd = "map!"; - } - break; - case CMDLINE: - c1 = 'c'; - break; - case INSERT: - c1 = 'i'; - break; - case LANGMAP: - c1 = 'l'; - break; - case TERM_FOCUS: - c1 = 't'; - break; - default: - iemsg(_("E228: makemap: Illegal mode")); - return FAIL; - } - do { - // do this twice if c2 is set, 3 times with c3 */ - // When outputting <> form, need to make sure that 'cpo' - // is set to the Vim default. - if (!did_cpo) { - if (*mp->m_str == NUL) { // Will use <Nop>. - did_cpo = true; - } else { - const char specials[] = { (char)(uint8_t)K_SPECIAL, NL, NUL }; - if (strpbrk((const char *)mp->m_str, specials) != NULL - || strpbrk((const char *)mp->m_keys, specials) != NULL) { - did_cpo = true; - } - } - if (did_cpo) { - if (fprintf(fd, "let s:cpo_save=&cpo") < 0 - || put_eol(fd) < 0 - || fprintf(fd, "set cpo&vim") < 0 - || put_eol(fd) < 0) { - return FAIL; - } - } - } - if (c1 && putc(c1, fd) < 0) { - return FAIL; - } - if (mp->m_noremap != REMAP_YES && fprintf(fd, "nore") < 0) { - return FAIL; - } - if (fputs(cmd, fd) < 0) { - return FAIL; - } - if (buf != NULL && fputs(" <buffer>", fd) < 0) { - return FAIL; - } - if (mp->m_nowait && fputs(" <nowait>", fd) < 0) { - return FAIL; - } - if (mp->m_silent && fputs(" <silent>", fd) < 0) { - return FAIL; - } - if (mp->m_expr && fputs(" <expr>", fd) < 0) { - return FAIL; - } - - if (putc(' ', fd) < 0 - || put_escstr(fd, mp->m_keys, 0) == FAIL - || putc(' ', fd) < 0 - || put_escstr(fd, mp->m_str, 1) == FAIL - || put_eol(fd) < 0) { - return FAIL; - } - c1 = c2; - c2 = c3; - c3 = NUL; - } while (c1 != NUL); - } - } - } - if (did_cpo) { - if (fprintf(fd, "let &cpo=s:cpo_save") < 0 - || put_eol(fd) < 0 - || fprintf(fd, "unlet s:cpo_save") < 0 - || put_eol(fd) < 0) { - return FAIL; - } - } - return OK; -} - -// write escape string to file -// "what": 0 for :map lhs, 1 for :map rhs, 2 for :set -// -// return FAIL for failure, OK otherwise -int put_escstr(FILE *fd, char_u *strstart, int what) -{ - char_u *str = strstart; - int c; - - // :map xx <Nop> - if (*str == NUL && what == 1) { - if (fprintf(fd, "<Nop>") < 0) { - return FAIL; - } - return OK; - } - - for (; *str != NUL; str++) { - // Check for a multi-byte character, which may contain escaped - // K_SPECIAL and CSI bytes. - const char *p = mb_unescape((const char **)&str); - if (p != NULL) { - while (*p != NUL) { - if (fputc(*p++, fd) < 0) { - return FAIL; - } - } - --str; - continue; - } - - c = *str; - /* - * Special key codes have to be translated to be able to make sense - * when they are read back. - */ - if (c == K_SPECIAL && what != 2) { - int modifiers = 0; - if (str[1] == KS_MODIFIER) { - modifiers = str[2]; - str += 3; - c = *str; - } - if (c == K_SPECIAL) { - c = TO_SPECIAL(str[1], str[2]); - str += 2; - } - if (IS_SPECIAL(c) || modifiers) { // special key - if (fputs((char *)get_special_key_name(c, modifiers), fd) < 0) { - return FAIL; - } - continue; - } - } - - /* - * A '\n' in a map command should be written as <NL>. - * A '\n' in a set command should be written as \^V^J. - */ - if (c == NL) { - if (what == 2) { - if (fprintf(fd, "\\\026\n") < 0) { - return FAIL; - } - } else { - if (fprintf(fd, "<NL>") < 0) { - return FAIL; - } - } - continue; - } - - /* - * Some characters have to be escaped with CTRL-V to - * prevent them from misinterpreted in DoOneCmd(). - * A space, Tab and '"' has to be escaped with a backslash to - * prevent it to be misinterpreted in do_set(). - * A space has to be escaped with a CTRL-V when it's at the start of a - * ":map" rhs. - * A '<' has to be escaped with a CTRL-V to prevent it being - * interpreted as the start of a special key name. - * A space in the lhs of a :map needs a CTRL-V. - */ - if (what == 2 && (ascii_iswhite(c) || c == '"' || c == '\\')) { - if (putc('\\', fd) < 0) { - return FAIL; - } - } else if (c < ' ' || c > '~' || c == '|' - || (what == 0 && c == ' ') - || (what == 1 && str == strstart && c == ' ') - || (what != 2 && c == '<')) { - if (putc(Ctrl_V, fd) < 0) { - return FAIL; - } - } - if (putc(c, fd) < 0) { - return FAIL; - } - } - return OK; -} - -/// Check the string "keys" against the lhs of all mappings. -/// Return pointer to rhs of mapping (mapblock->m_str). -/// NULL when no mapping found. -/// -/// @param exact require exact match -/// @param ign_mod ignore preceding modifier -/// @param abbr do abbreviations -/// @param mp_ptr return: pointer to mapblock or NULL -/// @param local_ptr return: buffer-local mapping or NULL -char_u *check_map(char_u *keys, int mode, int exact, int ign_mod, int abbr, mapblock_T **mp_ptr, - int *local_ptr, int *rhs_lua) -{ - int len, minlen; - mapblock_T *mp; - *rhs_lua = LUA_NOREF; - - validate_maphash(); - - len = (int)STRLEN(keys); - for (int local = 1; local >= 0; local--) { - // loop over all hash lists - for (int hash = 0; hash < 256; hash++) { - if (abbr) { - if (hash > 0) { // there is only one list. - break; - } - if (local) { - mp = curbuf->b_first_abbr; - } else { - mp = first_abbr; - } - } else if (local) { - mp = curbuf->b_maphash[hash]; - } else { - mp = maphash[hash]; - } - for (; mp != NULL; mp = mp->m_next) { - /* skip entries with wrong mode, wrong length and not matching - * ones */ - if ((mp->m_mode & mode) && (!exact || mp->m_keylen == len)) { - char_u *s = mp->m_keys; - int keylen = mp->m_keylen; - if (ign_mod && keylen >= 3 - && s[0] == K_SPECIAL && s[1] == KS_MODIFIER) { - s += 3; - keylen -= 3; - } - minlen = keylen < len ? keylen : len; - if (STRNCMP(s, keys, minlen) == 0) { - if (mp_ptr != NULL) { - *mp_ptr = mp; - } - if (local_ptr != NULL) { - *local_ptr = local; - } - *rhs_lua = mp->m_luaref; - return mp->m_luaref == LUA_NOREF ? mp->m_str : NULL; - } - } - } - } - } - - return NULL; -} - - -/// Add a mapping. Unlike @ref do_map this copies the {map} argument, so -/// static or read-only strings can be used. -/// -/// @param map C-string containing the arguments of the map/abbrev command, -/// i.e. everything except the initial `:[X][nore]map`. -/// @param mode Bitflags representing the mode in which to set the mapping. -/// See @ref get_map_mode. -/// @param nore If true, make a non-recursive mapping. -void add_map(char_u *map, int mode, bool nore) -{ - char_u *s; - char_u *cpo_save = p_cpo; - - p_cpo = (char_u *)""; // Allow <> notation - // Need to put string in allocated memory, because do_map() will modify it. - s = vim_strsave(map); - (void)do_map(nore ? 2 : 0, s, mode, false); - xfree(s); - p_cpo = cpo_save; -} - -/// Translate an internal mapping/abbreviation representation into the -/// corresponding external one recognized by :map/:abbrev commands. -/// -/// This function is called when expanding mappings/abbreviations on the -/// command-line. -/// -/// It uses a growarray to build the translation string since the latter can be -/// wider than the original description. The caller has to free the string -/// afterwards. -/// -/// @param cpo_flags Value of various flags present in &cpo -/// -/// @return NULL when there is a problem. -static char_u *translate_mapping(char_u *str, int cpo_flags) -{ - garray_T ga; - ga_init(&ga, 1, 40); - - bool cpo_bslash = !(cpo_flags&FLAG_CPO_BSLASH); - - for (; *str; ++str) { - int c = *str; - if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL) { - int modifiers = 0; - if (str[1] == KS_MODIFIER) { - str++; - modifiers = *++str; - c = *++str; - } - - if (c == K_SPECIAL && str[1] != NUL && str[2] != NUL) { - c = TO_SPECIAL(str[1], str[2]); - if (c == K_ZERO) { - // display <Nul> as ^@ - c = NUL; - } - str += 2; - } - if (IS_SPECIAL(c) || modifiers) { // special key - ga_concat(&ga, (char *)get_special_key_name(c, modifiers)); - continue; // for (str) - } - } - - if (c == ' ' || c == '\t' || c == Ctrl_J || c == Ctrl_V - || (c == '\\' && !cpo_bslash)) { - ga_append(&ga, cpo_bslash ? Ctrl_V : '\\'); - } - - if (c) { - ga_append(&ga, (char)c); - } - } - ga_append(&ga, NUL); - return (char_u *)(ga.ga_data); -} - static bool typebuf_match_len(const uint8_t *str, int *mlen) { int i; @@ -4539,22 +2800,8 @@ static bool typebuf_match_len(const uint8_t *str, int *mlen) return str[i] == NUL; // matched the whole string } -/// Retrieve the mapblock at the index either globally or for a certain buffer -/// -/// @param index The index in the maphash[] -/// @param buf The buffer to get the maphash from. NULL for global -mapblock_T *get_maphash(int index, buf_T *buf) - FUNC_ATTR_PURE -{ - if (index >= MAX_MAPHASH) { - return NULL; - } - - return (buf == NULL) ? maphash[index] : buf->b_maphash[index]; -} - /// Get command argument for <Cmd> key -char_u *getcmdkeycmd(int promptc, void *cookie, int indent, bool do_concat) +char *getcmdkeycmd(int promptc, void *cookie, int indent, bool do_concat) { garray_T line_ga; int c1 = -1, c2; @@ -4590,7 +2837,6 @@ char_u *getcmdkeycmd(int promptc, void *cookie, int indent, bool do_concat) c1 = TO_SPECIAL(c1, c2); } - if (got_int) { aborted = true; } else if (c1 == '\r' || c1 == '\n') { @@ -4601,15 +2847,21 @@ char_u *getcmdkeycmd(int promptc, void *cookie, int indent, bool do_concat) // special case to give nicer error message emsg(e_cmdmap_repeated); aborted = true; - } else if (IS_SPECIAL(c1)) { - if (c1 == K_SNR) { - ga_concat(&line_ga, "<SNR>"); + } else if (c1 == K_SNR) { + ga_concat(&line_ga, "<SNR>"); + } else { + if (cmod != 0) { + ga_append(&line_ga, (char)K_SPECIAL); + ga_append(&line_ga, (char)KS_MODIFIER); + ga_append(&line_ga, (char)cmod); + } + if (IS_SPECIAL(c1)) { + ga_append(&line_ga, (char)K_SPECIAL); + ga_append(&line_ga, (char)K_SECOND(c1)); + ga_append(&line_ga, (char)K_THIRD(c1)); } else { - semsg(e_cmdmap_key, get_special_key_name(c1, cmod)); - aborted = true; + ga_append(&line_ga, (char)c1); } - } else { - ga_append(&line_ga, (char)c1); } cmod = 0; @@ -4621,7 +2873,7 @@ char_u *getcmdkeycmd(int promptc, void *cookie, int indent, bool do_concat) ga_clear(&line_ga); } - return (char_u *)line_ga.ga_data; + return line_ga.ga_data; } bool map_execute_lua(void) |