summaryrefslogtreecommitdiffstats
path: root/runtime/doc/usr_52.txt
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/doc/usr_52.txt')
-rw-r--r--runtime/doc/usr_52.txt47
1 files changed, 44 insertions, 3 deletions
diff --git a/runtime/doc/usr_52.txt b/runtime/doc/usr_52.txt
index 222b899..d5062e2 100644
--- a/runtime/doc/usr_52.txt
+++ b/runtime/doc/usr_52.txt
@@ -1,4 +1,4 @@
-*usr_52.txt* For Vim version 9.1. Last change: 2022 Jun 04
+*usr_52.txt* For Vim version 9.1. Last change: 2024 Jun 09
VIM USER MANUAL - by Bram Moolenaar
@@ -13,6 +13,7 @@ smaller parts.
|52.3| Autoloading without import/export
|52.4| Other mechanisms to use
|52.5| Using a Vim9 script from legacy script
+|52.6| Vim9 script examples: comment package, highlight-yank plugin
Next chapter: |usr_90.txt| Installing Vim
Previous chapter: |usr_51.txt| Create a plugin
@@ -45,7 +46,7 @@ private function: >
def GetReply(nr: number): string
if nr == 42
return 'yes'
- elseif nr = 22
+ elseif nr == 22
return 'maybe'
else
return 'no'
@@ -155,7 +156,7 @@ AUTOLOAD DIRECTORY
Another form is to use autoload with a script name that is not an absolute or
relative path: >
- import autload "monthlib.vim"
+ import autoload "monthlib.vim"
This will search for the script "monthlib.vim" in the autoload directories of
'runtimepath'. With Unix one of the directories often is "~/.vim/autoload".
@@ -336,6 +337,46 @@ will have to make sure to use a unique name for these global items. Example: >
call g:NicePluginTest()
==============================================================================
+*52.6* Vim9 script examples: comment package, highlight-yank plugin
+
+COMMENT PACKAGE
+
+Vim comes with a comment plugin, written in Vim9 script. |comment-install|
+Have a look at the package located at $VIMRUNTIME/pack/dist/opt/comment/
+
+HIGHLIGHT YANK PLUGIN
+
+Here is an example for highlighting the yanked region. It makes use of the
+|getregionpos()| function, available since Vim 9.1.0446.
+
+Copy the following example into a new file and place it into your plugin directory
+and it will be active next time you start Vim. |add-plugin|: >
+
+ vim9script
+
+ def HighlightedYank(hlgroup = 'IncSearch', duration = 300, in_visual = true)
+ if v:event.operator ==? 'y'
+ if !in_visual && visualmode() != null_string
+ visualmode(1)
+ return
+ endif
+ var [beg, end] = [getpos("'["), getpos("']")]
+ var type = v:event.regtype ?? 'v'
+ var pos = getregionpos(beg, end, {type: type})
+ var end_offset = (type == 'V' || v:event.inclusive) ? 1 : 0
+ var m = matchaddpos(hlgroup, pos->mapnew((_, v) => {
+ var col_beg = v[0][2] + v[0][3]
+ var col_end = v[1][2] + v[1][3] + end_offset
+ return [v[0][1], col_beg, col_end - col_beg]
+ }))
+ var winid = win_getid()
+ timer_start(duration, (_) => m->matchdelete(winid))
+ endif
+ enddef
+
+ autocmd TextYankPost * HighlightedYank()
+<
+==============================================================================
Next chapter: |usr_90.txt| Installing Vim