Merge pull request #149 from dstein64/on_key_for_mouse3

Use vim.on_key for mouse functionality instead of mappings

Author: dstein64

autoload/scrollview.vim

@@ -322,6 +322,10 @@ let g:scrollview_ins_mode_buf_lines = 0
 " escaping.
 let g:scrollview_echo_string = v:null
 
+" Keep track of the initial mouse settings. These are only used for nvim<0.11.
+let g:scrollview_init_mouse_primary = g:scrollview_mouse_primary
+let g:scrollview_init_mouse_secondary = g:scrollview_mouse_secondary
+
 " *************************************************
 " * Versioning
 " *************************************************
@@ -432,6 +436,23 @@ endif
 " * Mappings
 " *************************************************
 
+function! scrollview#HandleMouseFromMapping(button, is_primary) abort
+  let l:button_repr = nvim_replace_termcodes(
+        \ printf('<%smouse>', a:button), v:true, v:true, v:true)
+  let l:packed = luaeval(
+        \ '{require("scrollview").should_handle_mouse(_A)}', l:button_repr)
+  let l:should_handle = l:packed[0]
+  if l:should_handle
+    let l:data = l:packed[1]
+    call luaeval(
+          \ 'require("scrollview").handle_mouse('
+          \ .. '_A.button, _A.is_primary, _A.props, _A.mousepos)', l:data)
+  else
+    " Process the click as it would ordinarily be processed.
+    call feedkeys(l:button_repr, 'ni')
+  endif
+endfunction
+
 function! s:SetUpMouseMappings(button, primary) abort
   if a:button isnot# v:null
     " Create a mouse mapping only if mappings don't already exist and "!" is
@@ -447,25 +468,28 @@ function! s:SetUpMouseMappings(button, primary) abort
       let l:button =
             \ strcharpart(l:button, 0, strchars(l:button, 1) - 1)
     endif
-    " scrollview mouse handling is not supported in select-mode. #140
-    for l:mapmode in ['n', 'x', 'i']
+    for l:mapmode in ['n', 'v', 'i']
       execute printf(
             \   'silent! %snoremap %s <silent> <%smouse>'
-            \   .. ' <cmd>lua require("scrollview").handle_mouse("%s", %s)<cr>',
+            \   .. ' <cmd>call scrollview#HandleMouseFromMapping("%s", %s)<cr>',
             \   l:mapmode,
             \   l:force ? '' : '<unique>',
             \   l:button,
             \   l:button,
-            \   a:primary ? 'true' : 'false',
+            \   a:primary,
             \ )
     endfor
   endif
 endfunction
 
-call s:SetUpMouseMappings(g:scrollview_mouse_primary, v:true)
-" :popup doesn't work for nvim<0.8.
-if has('nvim-0.8')
-  call s:SetUpMouseMappings(g:scrollview_mouse_secondary, v:false)
+" With Neovim 0.11, mouse functionality is handled with vim.on_key, not
+" mappings.
+if !has('nvim-0.11')
+  call s:SetUpMouseMappings(g:scrollview_mouse_primary, v:true)
+  " :popup doesn't work for nvim<0.8.
+  if has('nvim-0.8')
+    call s:SetUpMouseMappings(g:scrollview_mouse_secondary, v:false)
+  endif
 endif
 
 " Additional <plug> mappings are defined for convenience of creating

doc/scrollview.txt

@@ -20,7 +20,7 @@ signs. The plugin is customizable (see |scrollview-configuration|).
 1. Requirements                            *scrollview-requirements*
 
 * `nvim>=0.6`
-* Scrollbar mouse dragging requires mouse support (see |'mouse'|)
+* Scrollbar mouse functionality requires mouse support (see |'mouse'|)
 * Signs require `nvim>=0.9`
 
 ============================================================================
@@ -301,19 +301,19 @@ scrollview_mouse_primary                   *scrollview_mouse_primary*
                        Possible values include `'left'`, `'middle'`, `'right'`,
                        `'x1'`, and `'x2'`. These can be prepended with `'c-'` or
                        `'m-'` for the control-key and alt-key variants (e.g.,
-                       `'c-left'` for control-left). An existing mapping will
-                       not be clobbered, unless `'!'` is added at the end (e.g.,
-                       `'left!'`). Set to `v:null` to disable the functionality.
-                       Defaults to `'left'`. Considered only when the plugin is
-                       loaded.
+                       `'c-left'` for control-left). Set to `v:null` to disable
+                       the functionality. Defaults to `'left'`. For `nvim<0.11`,
+                       an existing mapping will not be clobbered, unless `'!'`
+                       is added at the end (e.g., `'left!'`). For `nvim<0.11`,
+                       the option is considered only when the plugin is loaded.
 
 scrollview_mouse_secondary                 *scrollview_mouse_secondary*
                        |String| specifying the button for secondary mouse
                        operations (clicking signs for additional information).
                        See |scrollview_mouse_primary| for the possible values,
-                       including how `'c-'`, `'m-'`, `'!'`, and `v:null` can be
-                       utilized. Defaults to `'right'`. Considered only when the
-                       plugin is loaded.
+                       including how `'c-'`, `'m-'`, and `v:null` can be utilized,
+                       as well as the behavior specific to `nvim<0.11`. Defaults
+                       to `'right'`.
 
                                            *scrollview_on_startup*
 scrollview_on_startup  |Boolean| specifying whether scrollbars are enabled on