feat(defaults): map CTRL-L to search highlights, update diffs #15385

gpanders · web-flow · commit 0aa8128aaa9e · 2021-08-16T08:31:14.000-07:00
diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt
@@ -14,6 +14,10 @@ Various commands					*various*
 							*CTRL-L*
 CTRL-L			Clears and redraws the screen.  The redraw may happen
 			later, after processing typeahead.
+							*CTRL-L-default*
+			By default, also clears search highlighting
+			|:nohlsearch| and updates diffs |:diffupdate|.
+			|default-mappings|
 
 							*:mod* *:mode*
 :mod[e]			Clears and redraws the screen.
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
@@ -74,7 +74,9 @@ the differences.
 
 
 Default Mappings:					*default-mappings*
-  nnoremap Y y$
+
+nnoremap Y y$
+nnoremap <C-L> <Cmd>nohlsearch<Bar>diffupdate<CR><C-L>
 
 ==============================================================================
 3. New Features						       *nvim-features*
diff --git a/src/nvim/ex_getln.c b/src/nvim/ex_getln.c
@@ -6259,8 +6259,8 @@ static int open_cmdwin(void)
   const int histtype = hist_char2type(cmdwin_type);
   if (histtype == HIST_CMD || histtype == HIST_DEBUG) {
     if (p_wc == TAB) {
-      add_map((char_u *)"<buffer> <Tab> <C-X><C-V>", INSERT);
-      add_map((char_u *)"<buffer> <Tab> a<C-X><C-V>", NORMAL);
+      add_map((char_u *)"<buffer> <Tab> <C-X><C-V>", INSERT, false);
+      add_map((char_u *)"<buffer> <Tab> a<C-X><C-V>", NORMAL, false);
     }
     set_option_value("ft", 0L, "vim", OPT_LOCAL);
   }
diff --git a/src/nvim/getchar.c b/src/nvim/getchar.c
@@ -4357,18 +4357,23 @@ check_map (
 }
 
 
-/*
- * Add a mapping "map" for mode "mode".
- * Need to put string in allocated memory, because do_map() will modify it.
- */
-void add_map(char_u *map, int mode)
+/// 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(0, s, mode, FALSE);
+  (void)do_map(nore ? 2 : 0, s, mode, false);
   xfree(s);
   p_cpo = cpo_save;
 }
diff --git a/src/nvim/normal.c b/src/nvim/normal.c
@@ -399,7 +399,8 @@ void init_normal_cmds(void)
 
 void init_default_mappings(void)
 {
-  add_map((char_u *)"Y y$", NORMAL);
+  add_map((char_u *)"Y y$", NORMAL, true);
+  add_map((char_u *)"<C-L> <Cmd>nohlsearch<Bar>diffupdate<CR><C-L>", NORMAL, true);
 }
 
 /*
diff --git a/src/nvim/testdir/setup.vim b/src/nvim/testdir/setup.vim
@@ -21,7 +21,10 @@ set undodir^=.
 set wildoptions=
 set startofline
 set sessionoptions+=options
+
+" Unmap Nvim default mappings.
 unmap Y
+unmap <C-L>
 
 " Prevent Nvim log from writing to stderr.
 let $NVIM_LOG_FILE = exists($NVIM_LOG_FILE) ? $NVIM_LOG_FILE : 'Xnvim.log'
diff --git a/test/functional/helpers.lua b/test/functional/helpers.lua
@@ -42,7 +42,10 @@ module.nvim_set = (
 module.nvim_argv = {
   module.nvim_prog, '-u', 'NONE', '-i', 'NONE',
   '--cmd', module.nvim_set,
-  '--cmd', 'unmap Y', '--embed'}
+  '--cmd', 'unmap Y',
+  '--cmd', 'unmap <C-L>',
+  '--embed'}
+
 -- Directory containing nvim.
 module.nvim_dir = module.nvim_prog:gsub("[/\\][^/\\]+$", "")
 if module.nvim_dir == module.nvim_prog then

Original file line number	Diff line number	Diff line change
`@@ -6259,8 +6259,8 @@ static int open_cmdwin(void)`
`6259`	`6259`	`const int histtype = hist_char2type(cmdwin_type);`
`6260`	`6260`	`if (histtype == HIST_CMD \|\| histtype == HIST_DEBUG) {`
`6261`	`6261`	`if (p_wc == TAB) {`
`6262`		`- add_map((char_u *)"<buffer> <Tab> <C-X><C-V>", INSERT);`
`6263`		`- add_map((char_u *)"<buffer> <Tab> a<C-X><C-V>", NORMAL);`
	`6262`	`+ add_map((char_u *)"<buffer> <Tab> <C-X><C-V>", INSERT, false);`
	`6263`	`+ add_map((char_u *)"<buffer> <Tab> a<C-X><C-V>", NORMAL, false);`
`6264`	`6264`	`}`
`6265`	`6265`	`set_option_value("ft", 0L, "vim", OPT_LOCAL);`
`6266`	`6266`	`}`
Original file line number	Diff line number	Diff line change
`@@ -399,7 +399,8 @@ void init_normal_cmds(void)`
`399`	`399`
`400`	`400`	`void init_default_mappings(void)`
`401`	`401`	`{`
`402`		`- add_map((char_u *)"Y y$", NORMAL);`
	`402`	`+ add_map((char_u *)"Y y$", NORMAL, true);`
	`403`	`+ add_map((char_u *)"<C-L> <Cmd>nohlsearch<Bar>diffupdate<CR><C-L>", NORMAL, true);`
`403`	`404`	`}`
`404`	`405`
`405`	`406`	`/*`