Add an option for controlling sign/scrollbar overlap

Author: dstein64

autoload/scrollview.vim

@@ -108,6 +108,8 @@ let g:scrollview_signs_on_startup =
       \ get(g:, 'scrollview_signs_on_startup', s:default_signs)
 " Specifies the sign overflow direction ('left' or 'right').
 let g:scrollview_signs_overflow = get(g:, 'scrollview_signs_overflow', 'left')
+let g:scrollview_signs_scrollbar_overlap =
+      \ get(g:, 'scrollview_signs_scrollbar_overlap', 'off')
 " Whether signs in folds should be shown or hidden.
 let g:scrollview_signs_show_in_folds =
       \ get(g:, 'scrollview_signs_show_in_folds', v:false)

doc/scrollview.txt

@@ -401,6 +401,15 @@ scrollview_signs_overflow                  *scrollview_signs_overflow*
                        Possible values are `'left'` or `'right'`. Defaults to
                        `'left'`.
 
+scrollview_signs_scrollbar_overlap         *scrollview_signs_scrollbar_overlap*
+                       |String| specifying whether/how signs overlap the
+                       scrollbar. Possible values are `'off'`, `'over'`, and `'under'`.
+                       Defaults to `'off'`.
+                       * `off` Signs are positioned to never overlap the
+                         scrollbar.
+                       * `over` A sign can be placed over the scrollbar.
+                       * `under` A sign can be placed under the scrollbar.
+
 scrollview_signs_show_in_folds             *scrollview_signs_show_in_folds*
                        |Boolean| specifying whether signs on lines within hidden
                        folds should be shown. Sign groups can override this

doc/tags

@@ -128,6 +128,7 @@ scrollview_signs_hidden_for_insert	scrollview.txt	/*scrollview_signs_hidden_for_
 scrollview_signs_max_per_row	scrollview.txt	/*scrollview_signs_max_per_row*
 scrollview_signs_on_startup	scrollview.txt	/*scrollview_signs_on_startup*
 scrollview_signs_overflow	scrollview.txt	/*scrollview_signs_overflow*
+scrollview_signs_scrollbar_overlap	scrollview.txt	/*scrollview_signs_scrollbar_overlap*
 scrollview_signs_show_in_folds	scrollview.txt	/*scrollview_signs_show_in_folds*
 scrollview_signs_version	scrollview.txt	/*scrollview_signs_version*
 scrollview_spell_priority	scrollview.txt	/*scrollview_spell_priority*

lua/scrollview.lua

@@ -1868,16 +1868,17 @@ local show_signs = function(winid, sign_winids, bar_winid)
     -- A set of columns, to prevent creating multiple signs in the same
     -- location.
     local total_width = 0  -- running sum of sign widths
+    local bar_row = bar_props ~= nil
+      and row >= bar_props.row
+      and row <= bar_props.row + bar_props.height - 1
     -- Treat the bar as if it were a sign, and position subsequent signs
     -- accordingly. This only applies if a scrollbar is shown (e.g., not when
     -- it is hidden from hide_on_intersect or not shown because of an invalid
     -- column).
-    if bar_props ~= nil
-        and row >= bar_props.row
-        and row <= bar_props.row + bar_props.height - 1 then
+    if vim.g.scrollview_signs_scrollbar_overlap == 'off' and bar_row then
       total_width = total_width + 1
     end
-    for _, properties in ipairs(props_list) do
+    for properties_idx, properties in ipairs(props_list) do
       local symbol = properties.symbol
       local sign_width = fn.strdisplaywidth(symbol)
       local col = base_col
@@ -1971,6 +1972,13 @@ local show_signs = function(winid, sign_winids, bar_winid)
         if is_float then
           zindex = zindex + config.zindex
         end
+        if bar_row and properties_idx == 1 then
+          if vim.g.scrollview_signs_scrollbar_overlap == 'over' then
+            zindex = zindex + 1
+          elseif vim.g.scrollview_signs_scrollbar_overlap == 'under' then
+            zindex = zindex - 1
+          end
+        end
         local sign_config = {
           win = winid,
           relative = 'win',
@@ -1981,7 +1989,7 @@ local show_signs = function(winid, sign_winids, bar_winid)
           width = sign_width,
           row = row - 1,
           col = col - 1,
-          zindex = zindex,
+          zindex = math.max(1, zindex),
         }
         -- Create a new window if none are available for re-use. Also, create a
         -- new window if the base window is a floating window, to avoid Neovim
@@ -2046,6 +2054,22 @@ local show_signs = function(winid, sign_winids, bar_winid)
                 target = 'FloatBorder'
               end
             end
+            -- Properly highlight a sign over a scrollbar.
+            if bar_props ~= nil
+                and bar_row
+                and vim.g.scrollview_signs_scrollbar_overlap == 'over'
+                and properties_idx == 1 then
+              target = 'ScrollView'
+              if vim.g.scrollview_hover
+                  and mousemove_received
+                  and to_bool(fn.exists('&mousemoveevent'))
+                  and vim.o.mousemoveevent then
+                if is_mouse_over_scrollview_win(bar_props.scrollview_winid)
+                    or is_mouse_over_scrollview_win(sign_winid) then
+                  target = 'ScrollViewHover'
+                end
+              end
+            end
             target = get_mapped_highlight(winid, target)
             local winhighlight = string.format(
               'Normal:%s,EndOfBuffer:%s,NormalFloat:%s', target, target, target)