# HG changeset patch # User Bram Moolenaar # Date 1650822303 -7200 # Node ID d3c966c0cdf7db363ea94aa9a92d7e496e162b61 # Parent 1efc196073c25d1dd45f411a984f22c355b648e9 patch 8.2.4820: not simple programmatic way to find a specific mapping Commit: https://github.com/vim/vim/commit/659c240cf769925ff432b88df8719e7ace4629b0 Author: Ernie Rael Date: Sun Apr 24 18:40:28 2022 +0100 patch 8.2.4820: not simple programmatic way to find a specific mapping Problem: Not simple programmatic way to find a specific mapping. Solution: Add getmappings(). (Ernie Rael, closes https://github.com/vim/vim/issues/10273) diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -235,6 +235,7 @@ getline({lnum}) String line {lnum} of getline({lnum}, {end}) List lines {lnum} to {end} of current buffer getloclist({nr}) List list of location list items getloclist({nr}, {what}) Dict get specific location list properties +getmappings() List list of all mappings, a dict for each getmarklist([{buf}]) List list of global/local marks getmatches([{win}]) List list of current matches getmousepos() Dict last known mouse position @@ -3570,6 +3571,17 @@ getloclist({nr} [, {what}]) *getlocli :echo getloclist(5, {'filewinid': 0}) +getmappings() *getmappings()* + Returns a |List| of all mappings. Each List item is a |Dict|, + the same as what is returned by |maparg()|, see + |mapping-dict|. + + Example to show all mappings with 'MultiMatch' in rhs: > + vim9script + echo getmappings()->filter( + (_, m) => match(m.rhs, 'MultiMatch') >= 0) + + getmarklist([{buf}]) *getmarklist()* Without the {buf} argument returns a |List| with information about all the global marks. |mark| @@ -5262,7 +5274,7 @@ maparg({name} [, {mode} [, {abbr} [, {di When {dict} is there and it is |TRUE| return a dictionary containing all the information of the mapping with the - following items: + following items: *mapping-dict* "lhs" The {lhs} of the mapping as it would be typed "lhsraw" The {lhs} of the mapping as raw bytes "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt --- a/runtime/doc/usr_41.txt +++ b/runtime/doc/usr_41.txt @@ -1089,6 +1089,7 @@ Mappings and Menus: *mapping-funct digraph_getlist() get all |digraph|s digraph_set() register |digraph| digraph_setlist() register multiple |digraph|s + getmappings() get list of all mappings hasmapto() check if a mapping exists mapcheck() check if a matching mapping exists maparg() get rhs of a mapping diff --git a/src/evalfunc.c b/src/evalfunc.c --- a/src/evalfunc.c +++ b/src/evalfunc.c @@ -1871,6 +1871,8 @@ static funcentry_T global_functions[] = ret_getline, f_getline}, {"getloclist", 1, 2, 0, arg2_number_dict_any, ret_list_or_dict_1, f_getloclist}, + {"getmappings", 0, 0, 0, NULL, + ret_list_dict_any, f_getmappings}, {"getmarklist", 0, 1, FEARG_1, arg1_buffer, ret_list_dict_any, f_getmarklist}, {"getmatches", 0, 1, 0, arg1_number, diff --git a/src/map.c b/src/map.c --- a/src/map.c +++ b/src/map.c @@ -2274,6 +2274,42 @@ check_map( return NULL; } +/* + * Fill in the empty dictionary with items as defined by maparg builtin. + */ + static void +mapblock2dict( + mapblock_T *mp, + dict_T *dict, + char_u *lhsrawalt, // may be NULL + int buffer_local) // false if not buffer local mapping +{ + char_u *lhs = str2special_save(mp->m_keys, TRUE); + char_u *mapmode = map_mode_to_chars(mp->m_mode); + + dict_add_string(dict, "lhs", lhs); + vim_free(lhs); + dict_add_string(dict, "lhsraw", mp->m_keys); + if (lhsrawalt) + // Also add the value for the simplified entry. + dict_add_string(dict, "lhsrawalt", lhsrawalt); + dict_add_string(dict, "rhs", mp->m_orig_str); + dict_add_number(dict, "noremap", mp->m_noremap ? 1L : 0L); + dict_add_number(dict, "script", mp->m_noremap == REMAP_SCRIPT + ? 1L : 0L); + dict_add_number(dict, "expr", mp->m_expr ? 1L : 0L); + dict_add_number(dict, "silent", mp->m_silent ? 1L : 0L); + dict_add_number(dict, "sid", (long)mp->m_script_ctx.sc_sid); + dict_add_number(dict, "scriptversion", + (long)mp->m_script_ctx.sc_version); + dict_add_number(dict, "lnum", (long)mp->m_script_ctx.sc_lnum); + dict_add_number(dict, "buffer", (long)buffer_local); + dict_add_number(dict, "nowait", mp->m_nowait ? 1L : 0L); + dict_add_string(dict, "mode", mapmode); + + vim_free(mapmode); +} + static void get_maparg(typval_T *argvars, typval_T *rettv, int exact) { @@ -2346,40 +2382,67 @@ get_maparg(typval_T *argvars, typval_T * } else if (rettv_dict_alloc(rettv) != FAIL && rhs != NULL) - { - // Return a dictionary. - char_u *lhs = str2special_save(mp->m_keys, TRUE); - char_u *mapmode = map_mode_to_chars(mp->m_mode); - dict_T *dict = rettv->vval.v_dict; - - dict_add_string(dict, "lhs", lhs); - vim_free(lhs); - dict_add_string(dict, "lhsraw", mp->m_keys); - if (did_simplify) - // Also add the value for the simplified entry. - dict_add_string(dict, "lhsrawalt", mp_simplified->m_keys); - dict_add_string(dict, "rhs", mp->m_orig_str); - dict_add_number(dict, "noremap", mp->m_noremap ? 1L : 0L); - dict_add_number(dict, "script", mp->m_noremap == REMAP_SCRIPT - ? 1L : 0L); - dict_add_number(dict, "expr", mp->m_expr ? 1L : 0L); - dict_add_number(dict, "silent", mp->m_silent ? 1L : 0L); - dict_add_number(dict, "sid", (long)mp->m_script_ctx.sc_sid); - dict_add_number(dict, "scriptversion", - (long)mp->m_script_ctx.sc_version); - dict_add_number(dict, "lnum", (long)mp->m_script_ctx.sc_lnum); - dict_add_number(dict, "buffer", (long)buffer_local); - dict_add_number(dict, "nowait", mp->m_nowait ? 1L : 0L); - dict_add_string(dict, "mode", mapmode); - - vim_free(mapmode); - } + mapblock2dict(mp, rettv->vval.v_dict, + did_simplify ? mp_simplified->m_keys : NULL, buffer_local); vim_free(keys_buf); vim_free(alt_keys_buf); } /* + * "getmappings()" function + */ + void +f_getmappings(typval_T *argvars UNUSED, typval_T *rettv) +{ + dict_T *d; + mapblock_T *mp; + int buffer_local; + char_u *keys_buf; + int did_simplify; + int hash; + char_u *lhs; + const int flags = REPTERM_FROM_PART | REPTERM_DO_LT; + + if (rettv_list_alloc(rettv) != OK) + return; + + validate_maphash(); + + // Do it twice: once for global maps and once for local maps. + for (buffer_local = 0; buffer_local <= 1; ++buffer_local) + { + for (hash = 0; hash < 256; ++hash) + { + if (buffer_local) + mp = curbuf->b_maphash[hash]; + else + mp = maphash[hash]; + for (; mp; mp = mp->m_next) + { + if (mp->m_simplified) + continue; + if ((d = dict_alloc()) == NULL) + return; + if (list_append_dict(rettv->vval.v_list, d) == FAIL) + return; + + keys_buf = NULL; + did_simplify = FALSE; + + lhs = str2special_save(mp->m_keys, TRUE); + (void)replace_termcodes(lhs, &keys_buf, flags, &did_simplify); + vim_free(lhs); + + mapblock2dict(mp, d, + did_simplify ? keys_buf : NULL, buffer_local); + vim_free(keys_buf); + } + } + } +} + +/* * "maparg()" function */ void diff --git a/src/proto/map.pro b/src/proto/map.pro --- a/src/proto/map.pro +++ b/src/proto/map.pro @@ -17,6 +17,7 @@ int makemap(FILE *fd, buf_T *buf); int put_escstr(FILE *fd, char_u *strstart, int what); void check_map_keycodes(void); char_u *check_map(char_u *keys, int mode, int exact, int ign_mod, int abbr, mapblock_T **mp_ptr, int *local_ptr); +void f_getmappings(typval_T *argvars, typval_T *rettv); void f_maparg(typval_T *argvars, typval_T *rettv); void f_mapcheck(typval_T *argvars, typval_T *rettv); void f_mapset(typval_T *argvars, typval_T *rettv); diff --git a/src/testdir/test_maparg.vim b/src/testdir/test_maparg.vim --- a/src/testdir/test_maparg.vim +++ b/src/testdir/test_maparg.vim @@ -297,4 +297,76 @@ func Test_map_restore() endfunc +def Test_getmappings() + new + def ClearMaps() + mapclear | nmapclear | vmapclear | xmapclear | smapclear | omapclear + mapclear! | imapclear | lmapclear | cmapclear | tmapclear + mapclear | nmapclear | vmapclear + xmapclear | smapclear | omapclear + mapclear! | imapclear | lmapclear + cmapclear | tmapclear + enddef + + def AddMaps(new: list, accum: list) + if len(new) > 0 && new[0] != "No mapping found" + accum->extend(new) + endif + enddef + + ClearMaps() + assert_equal(0, len(getmappings())) + + # Set up some mappings. + map dup bar + map dup bufbar + map foo isfoo + vnoremap