From d4dbfb092b370bced6728e07a38661a579ff5e4b Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Thu, 9 Nov 2023 19:36:58 +0800 Subject: vim-patch:8.2.4825: can only get a list of mappings Problem: Can only get a list of mappings. Solution: Add the optional {abbr} argument. (Ernie Rael, closes vim/vim#10277) Rename to maplist(). Rename test file. https://github.com/vim/vim/commit/09661203ecefbee6a6f09438afcff1843e9dbfb4 Co-authored-by: Ernie Rael --- runtime/doc/builtin.txt | 24 +- runtime/doc/usr_41.txt | 2 +- runtime/lua/vim/_meta/vimfn.lua | 28 +- src/nvim/eval.lua | 36 +-- src/nvim/mapping.c | 14 +- test/old/testdir/test_map_functions.vim | 463 ++++++++++++++++++++++++++++++++ test/old/testdir/test_maparg.vim | 447 ------------------------------ 7 files changed, 523 insertions(+), 491 deletions(-) create mode 100644 test/old/testdir/test_map_functions.vim delete mode 100644 test/old/testdir/test_maparg.vim diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 6b34a49891..5d21b405df 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -2612,16 +2612,6 @@ getloclist({nr} [, {what}]) *getloclist()* 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: > - echo getmappings()->filter({_, m -> - \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0 - \ }) - getmarklist([{buf}]) *getmarklist()* Without the {buf} argument returns a |List| with information about all the global marks. |mark| @@ -4143,7 +4133,8 @@ maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* When {dict} is omitted or zero: Return the rhs of mapping {name} in mode {mode}. The returned String has special characters translated like in the output of the ":map" command - listing. + listing. When {dict} is TRUE a dictionary is returned, see + below. To get a list of all mappings see |maplist()|. When there is no mapping for {name}, an empty String is returned if {dict} is FALSE, otherwise returns an empty Dict. @@ -4237,6 +4228,17 @@ mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* < This avoids adding the "_vv" mapping when there already is a mapping for "_v" or for "_vvv". +maplist([{abbr}]) *maplist()* + Returns a |List| of all mappings. Each List item is a |Dict|, + the same as what is returned by |maparg()|, see + |mapping-dict|. When {abbr} is there and it is |TRUE| use + abbreviations instead of mappings. + + Example to show all mappings with "MultiMatch" in rhs: >vim + echo maplist()->filter({_, m -> + \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0 + \ }) + mapnew({expr1}, {expr2}) *mapnew()* Like |map()| but instead of replacing items in {expr1} a new List or Dictionary is created and returned. {expr1} remains diff --git a/runtime/doc/usr_41.txt b/runtime/doc/usr_41.txt index 9fe81f56b6..e206a804f4 100644 --- a/runtime/doc/usr_41.txt +++ b/runtime/doc/usr_41.txt @@ -1012,10 +1012,10 @@ Mappings and Menus: *mapping-functions* 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 + maplist() get list of all mappings mapset() restore a mapping menu_info() get information about a menu item wildmenumode() check if the wildmode is active diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index f54606b225..3293b71977 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -3175,18 +3175,6 @@ function vim.fn.getline(lnum, end_) end --- @return any function vim.fn.getloclist(nr, what) end ---- 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: > ---- echo getmappings()->filter({_, m -> ---- \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0 ---- \ }) ---- ---- @return any -function vim.fn.getmappings() end - --- Without the {buf} argument returns a |List| with information --- about all the global marks. |mark| --- @@ -5006,7 +4994,8 @@ function vim.fn.map(expr1, expr2) end --- When {dict} is omitted or zero: Return the rhs of mapping --- {name} in mode {mode}. The returned String has special --- characters translated like in the output of the ":map" command ---- listing. +--- listing. When {dict} is TRUE a dictionary is returned, see +--- below. To get a list of all mappings see |maplist()|. --- --- When there is no mapping for {name}, an empty String is --- returned if {dict} is FALSE, otherwise returns an empty Dict. @@ -5112,6 +5101,19 @@ function vim.fn.maparg(name, mode, abbr, dict) end --- @return any function vim.fn.mapcheck(name, mode, abbr) end +--- Returns a |List| of all mappings. Each List item is a |Dict|, +--- the same as what is returned by |maparg()|, see +--- |mapping-dict|. When {abbr} is there and it is |TRUE| use +--- abbreviations instead of mappings. +--- +--- Example to show all mappings with "MultiMatch" in rhs: >vim +--- echo maplist()->filter({_, m -> +--- \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0 +--- \ }) +--- +--- @return any +function vim.fn.maplist() end + --- Like |map()| but instead of replacing items in {expr1} a new --- List or Dictionary is created and returned. {expr1} remains --- unchanged. Items can still be changed by {expr2}, if you diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua index 5aa4d65362..de7fb53455 100644 --- a/src/nvim/eval.lua +++ b/src/nvim/eval.lua @@ -3957,22 +3957,6 @@ M.funcs = { params = { { 'nr', 'integer' }, { 'what', 'any' } }, signature = 'getloclist({nr} [, {what}])', }, - getmappings = { - args = 0, - desc = [[ - 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: > - echo getmappings()->filter({_, m -> - \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0 - \ }) - ]], - name = 'getmappings', - params = {}, - signature = 'getmappings()' - }, getmarklist = { args = { 0, 1 }, base = 1, @@ -6158,7 +6142,8 @@ M.funcs = { When {dict} is omitted or zero: Return the rhs of mapping {name} in mode {mode}. The returned String has special characters translated like in the output of the ":map" command - listing. + listing. When {dict} is TRUE a dictionary is returned, see + below. To get a list of all mappings see |maplist()|. When there is no mapping for {name}, an empty String is returned if {dict} is FALSE, otherwise returns an empty Dict. @@ -6271,6 +6256,23 @@ M.funcs = { params = { { 'name', 'string' }, { 'mode', 'string' }, { 'abbr', 'any' } }, signature = 'mapcheck({name} [, {mode} [, {abbr}]])', }, + maplist = { + args = { 0, 1 }, + desc = [[ + Returns a |List| of all mappings. Each List item is a |Dict|, + the same as what is returned by |maparg()|, see + |mapping-dict|. When {abbr} is there and it is |TRUE| use + abbreviations instead of mappings. + + Example to show all mappings with "MultiMatch" in rhs: >vim + echo maplist()->filter({_, m -> + \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0 + \ }) + ]], + name = 'maplist', + params = {}, + signature = 'maplist([{abbr}])' + }, mapnew = { args = 2, base = 1, diff --git a/src/nvim/mapping.c b/src/nvim/mapping.c index 2cc469feec..905e742f51 100644 --- a/src/nvim/mapping.c +++ b/src/nvim/mapping.c @@ -2282,9 +2282,10 @@ void f_mapset(typval_T *argvars, typval_T *rettv, EvalFuncData fptr) } /// "maplist()" function -void f_getmappings(typval_T *argvars, typval_T *rettv, EvalFuncData fptr) +void f_maplist(typval_T *argvars, typval_T *rettv, EvalFuncData fptr) { const int flags = REPTERM_FROM_PART | REPTERM_DO_LT; + const bool abbr = argvars[0].v_type != VAR_UNKNOWN && tv_get_bool(&argvars[0]); tv_list_alloc_ret(rettv, kListLenUnknown); @@ -2292,7 +2293,16 @@ void f_getmappings(typval_T *argvars, typval_T *rettv, EvalFuncData fptr) for (int buffer_local = 0; buffer_local <= 1; buffer_local++) { for (int hash = 0; hash < 256; hash++) { mapblock_T *mp; - if (buffer_local) { + if (abbr) { + if (hash > 0) { // there is only one abbr list + break; + } + if (buffer_local) { + mp = curbuf->b_first_abbr; + } else { + mp = first_abbr; + } + } else if (buffer_local) { mp = curbuf->b_maphash[hash]; } else { mp = maphash[hash]; diff --git a/test/old/testdir/test_map_functions.vim b/test/old/testdir/test_map_functions.vim new file mode 100644 index 0000000000..4d94722597 --- /dev/null +++ b/test/old/testdir/test_map_functions.vim @@ -0,0 +1,463 @@ +" Tests for maparg(), mapcheck(), mapset(), maplist() +" Also test utf8 map with a 0x80 byte. + +source shared.vim + +func s:SID() + return str2nr(matchstr(expand(''), '\zs\d\+\ze_SID$')) +endfunc + +func Test_maparg() + new + set cpo-=< + set encoding=utf8 + " Test maparg() with a string result + let sid = s:SID() + let lnum = expand('') + map foo isfoo + vnoremap