From abd380e28d48dd155b1e29cd2453f13b28bf7e08 Mon Sep 17 00:00:00 2001
From: Steven Ward <planet36@users.noreply.github.com>
Date: Mon, 5 Jun 2023 22:05:51 -0500
Subject: fix(defaults): visual mode star (*,#) is fragile

Problem:
Visual mode "*", "#" mappings don't work on text with "/", "\", "?", and
newlines.

Solution:
Get the visual selection and escape it as a search pattern.
Add functions vim.get_visual_selection and _search_for_visual_selection.

Fix #21676
---
 runtime/doc/lua.txt      | 19 +++++++++++++++++++
 runtime/doc/vim_diff.txt |  5 +++--
 2 files changed, 22 insertions(+), 2 deletions(-)

(limited to 'runtime/doc')

diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index 77a89a123d..9d3a3dec71 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -1410,6 +1410,25 @@ deprecate({name}, {alternative}, {version}, {plugin}, {backtrace})
     Return: ~
         Deprecated message, or nil if no message was shown.
 
+                                                  *vim.get_visual_selection()*
+get_visual_selection({list}, {append_empty})
+    Gets the content of the visual selection.
+
+    The result is either a string or, if {list} is `true`, a list of strings.
+    If not in any |visual-mode|, `nil` is returned.
+
+    Parameters: ~
+      • {list}          boolean|nil Return a list of strings instead of a
+                        string. See |getreg()|. Defaults to `false`.
+      • {append_empty}  boolean|nil Append an empty string to the result when
+                        in |linewise-visual| mode and {list} is `true`. This
+                        will preserve the trailing newline of the selection
+                        when the result is concatenated with `"\n"`. Defaults
+                        to `false`.
+
+    Return: ~
+        string|table
+
 inspect({object}, {options})                                   *vim.inspect()*
     Gets a human-readable representation of the given object.
 
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index 686905537d..4abecfc321 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -119,10 +119,11 @@ of these in your config by simply removing the mapping, e.g. ":unmap Y".
 	nnoremap <C-L> <Cmd>nohlsearch<Bar>diffupdate<Bar>normal! <C-L><CR>
 	inoremap <C-U> <C-G>u<C-U>
 	inoremap <C-W> <C-G>u<C-W>
-	xnoremap * y/\V<C-R>"<CR>
-	xnoremap # y?\V<C-R>"<CR>
 	nnoremap & :&&<CR>
 <
+Default mappings composed of Lua code are not listed above. Use ":map" to see
+the |map-listing|.
+
 DEFAULT AUTOCOMMANDS
 							*default-autocmds*
 Default autocommands exist in the following groups. Use ":autocmd! {group}" to
-- 
cgit