From 02bc40c19401ea9f7529cbc81bd18bd01c39bb3c Mon Sep 17 00:00:00 2001 From: zeertzjq Date: Thu, 19 Dec 2024 07:59:03 +0800 Subject: [PATCH] vim-patch:9.1.0945: ComplMatchIns highlight doesn't end after inserted text (#31628) Problem: ComplMatchIns highlight doesn't end after inserted text. Solution: Handle ComplMatchIns highlight more like search highlight. Fix off-by-one error. Handle deleting text properly. (zeertzjq) closes: vim/vim#16244 https://github.com/vim/vim/commit/f25d8f9312a24da2727671560a865888812ab8d9 --- runtime/colors/vim.lua | 2 +- src/nvim/drawline.c | 26 +++--- src/nvim/highlight_group.c | 2 +- src/nvim/insexpand.c | 5 +- test/functional/ui/mode_spec.lua | 2 +- test/functional/ui/popupmenu_spec.lua | 110 ++++++++++++++++++++++++++ test/old/testdir/test_indent.vim | 2 +- test/old/testdir/test_popup.vim | 58 +++++++++++++- 8 files changed, 188 insertions(+), 19 deletions(-) diff --git a/runtime/colors/vim.lua b/runtime/colors/vim.lua index dd3e83c653..dd59e5075d 100644 --- a/runtime/colors/vim.lua +++ b/runtime/colors/vim.lua @@ -60,7 +60,7 @@ hi('PmenuMatch', { link = 'Pmenu' }) hi('PmenuMatchSel', { link = 'PmenuSel' }) hi('PmenuExtra', { link = 'Pmenu' }) hi('PmenuExtraSel', { link = 'PmenuSel' }) -hi('ComplMatchIns', { link = 'Normal' }) +hi('ComplMatchIns', {}) hi('Substitute', { link = 'Search' }) hi('Whitespace', { link = 'NonText' }) hi('MsgSeparator', { link = 'StatusLine' }) diff --git a/src/nvim/drawline.c b/src/nvim/drawline.c index a1d03486ff..35a41f840d 100644 --- a/src/nvim/drawline.c +++ b/src/nvim/drawline.c @@ -955,7 +955,7 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s bool area_highlighting = false; // Visual or incsearch highlighting in this line int vi_attr = 0; // attributes for Visual and incsearch highlighting int area_attr = 0; // attributes desired by highlighting - int search_attr = 0; // attributes desired by 'hlsearch' + int search_attr = 0; // attributes desired by 'hlsearch' or ComplMatchIns int vcol_save_attr = 0; // saved attr for 'cursorcolumn' int decor_attr = 0; // attributes desired by syntax and extmarks bool has_syntax = false; // this buffer has syntax highl. @@ -969,7 +969,7 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s int spell_attr = 0; // attributes desired by spelling int word_end = 0; // last byte with same spell_attr int cur_checked_col = 0; // checked column for current line - bool extra_check = 0; // has syntax or linebreak + bool extra_check = false; // has extra highlighting int multi_attr = 0; // attributes desired by multibyte int mb_l = 1; // multi-byte byte length int mb_c = 0; // decoded multi-byte character @@ -1495,6 +1495,10 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s ptr = line + v; // "line" may have been updated } + if ((State & MODE_INSERT) && in_curline && ins_compl_active()) { + area_highlighting = true; + } + win_line_start(wp, &wlv); bool draw_cols = true; int leftcols_width = 0; @@ -1740,6 +1744,14 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s if (*ptr == NUL) { has_match_conc = 0; } + + // Check if ComplMatchIns highlight is needed. + if ((State & MODE_INSERT) && in_curline && ins_compl_active()) { + int ins_match_attr = ins_compl_col_range_attr((int)(ptr - line)); + if (ins_match_attr > 0) { + search_attr = hl_combine_attr(search_attr, ins_match_attr); + } + } } if (wlv.diff_hlf != (hlf_T)0) { @@ -1787,16 +1799,6 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s wlv.char_attr = hl_combine_attr(char_attr_base, char_attr_pri); } - // Apply ComplMatchIns highlight if needed. - if (wlv.filler_todo <= 0 - && (State & MODE_INSERT) && in_curline && ins_compl_active()) { - int ins_match_attr = ins_compl_col_range_attr((int)(ptr - line)); - if (ins_match_attr > 0) { - char_attr_pri = hl_combine_attr(char_attr_pri, ins_match_attr); - wlv.char_attr = hl_combine_attr(char_attr_base, char_attr_pri); - } - } - if (draw_folded && has_foldtext && wlv.n_extra == 0 && wlv.col == win_col_offset) { const int v = (int)(ptr - line); linenr_T lnume = lnum + foldinfo.fi_lines - 1; diff --git a/src/nvim/highlight_group.c b/src/nvim/highlight_group.c index 636124a698..2ae15254ea 100644 --- a/src/nvim/highlight_group.c +++ b/src/nvim/highlight_group.c @@ -173,7 +173,7 @@ static const char *highlight_init_both[] = { "default link PmenuKind Pmenu", "default link PmenuKindSel PmenuSel", "default link PmenuSbar Pmenu", - "default link ComplMatchIns Normal", + "default link ComplMatchIns NONE", "default link Substitute Search", "default link StatusLineTerm StatusLine", "default link StatusLineTermNC StatusLineNC", diff --git a/src/nvim/insexpand.c b/src/nvim/insexpand.c index 5036ec5e45..872ed2b4c3 100644 --- a/src/nvim/insexpand.c +++ b/src/nvim/insexpand.c @@ -958,7 +958,7 @@ static void ins_compl_insert_bytes(char *p, int len) } assert(len >= 0); ins_bytes_len(p, (size_t)len); - compl_ins_end_col = curwin->w_cursor.col - 1; + compl_ins_end_col = curwin->w_cursor.col; } /// Checks if the column is within the currently inserted completion text @@ -2147,6 +2147,8 @@ static bool ins_compl_stop(const int c, const int prev_mode, bool retval) && pum_visible()) { word = xstrdup(compl_shown_match->cp_str); retval = true; + // May need to remove ComplMatchIns highlight. + redrawWinline(curwin, curwin->w_cursor.lnum); } // CTRL-E means completion is Ended, go back to the typed text. @@ -3648,6 +3650,7 @@ void ins_compl_delete(bool new_leader) return; } backspace_until_column(col); + compl_ins_end_col = curwin->w_cursor.col; } // TODO(vim): is this sufficient for redrawing? Redrawing everything diff --git a/test/functional/ui/mode_spec.lua b/test/functional/ui/mode_spec.lua index 69b38f3ff3..01f4dda227 100644 --- a/test/functional/ui/mode_spec.lua +++ b/test/functional/ui/mode_spec.lua @@ -94,7 +94,7 @@ describe('ui mode_change event', function() } end) - -- oldtest: Test_indent_norm_with_gq() + -- oldtest: Test_mouse_shape_indent_norm_with_gq() it('is restored to Normal mode after "gq" indents using :normal #12309', function() screen:try_resize(60, 6) n.exec([[ diff --git a/test/functional/ui/popupmenu_spec.lua b/test/functional/ui/popupmenu_spec.lua index a64fc99f26..75421c6998 100644 --- a/test/functional/ui/popupmenu_spec.lua +++ b/test/functional/ui/popupmenu_spec.lua @@ -1162,6 +1162,8 @@ describe('builtin popupmenu', function() [6] = { foreground = Screen.colors.White, background = Screen.colors.Red }, [7] = { background = Screen.colors.Yellow }, -- Search [8] = { foreground = Screen.colors.Red }, + [9] = { foreground = Screen.colors.Yellow, background = Screen.colors.Green }, + [10] = { foreground = Screen.colors.White, background = Screen.colors.Green }, ks = { foreground = Screen.colors.Red, background = Screen.colors.Grey }, kn = { foreground = Screen.colors.Red, background = Screen.colors.Plum1 }, xs = { foreground = Screen.colors.Black, background = Screen.colors.Grey }, @@ -5625,6 +5627,114 @@ describe('builtin popupmenu', function() {2:-- INSERT --} | ]]) feed('') + + -- text after the inserted text shouldn't be highlighted + feed('0ea ') + screen:expect([[ + αβγ {8:foo}^ foo | + {1:~ }{s: foo }{1: }| + {1:~ }{n: bar }{1: }| + {1:~ }{n: 你好 }{1: }| + {1:~ }|*15 + {2:-- }{5:match 1 of 3} | + ]]) + feed('') + screen:expect([[ + αβγ ^ foo | + {1:~ }{n: foo }{1: }| + {1:~ }{n: bar }{1: }| + {1:~ }{n: 你好 }{1: }| + {1:~ }|*15 + {2:-- }{8:Back at original} | + ]]) + feed('') + screen:expect([[ + αβγ {8:你好}^ foo | + {1:~ }{n: foo }{1: }| + {1:~ }{n: bar }{1: }| + {1:~ }{s: 你好 }{1: }| + {1:~ }|*15 + {2:-- }{5:match 3 of 3} | + ]]) + feed('') + screen:expect([[ + αβγ 你好^ foo | + {1:~ }|*18 + {2:-- INSERT --} | + ]]) + feed('') + end) + + -- oldtest: Test_pum_matchins_highlight_combine() + it('with ComplMatchIns, Normal and CursorLine highlights', function() + exec([[ + func Omni_test(findstart, base) + if a:findstart + return col(".") + endif + return [#{word: "foo"}, #{word: "bar"}, #{word: "你好"}] + endfunc + set omnifunc=Omni_test + hi Normal guibg=blue + hi CursorLine guibg=green guifg=white + set cursorline + call setline(1, 'aaa bbb') + ]]) + + -- when ComplMatchIns is not set, CursorLine applies normally + feed('0ea ') + screen:expect([[ + {10:aaa foo^ bbb }| + {1:~ }{s: foo }{1: }| + {1:~ }{n: bar }{1: }| + {1:~ }{n: 你好 }{1: }| + {1:~ }|*15 + {2:-- }{5:match 1 of 3} | + ]]) + feed('') + screen:expect([[ + {10:aaa ^ bbb }| + {1:~ }|*18 + {2:-- INSERT --} | + ]]) + feed('') + + -- when ComplMatchIns is set, it is applied over CursorLine + command('hi ComplMatchIns guifg=Yellow') + feed('0ea ') + screen:expect([[ + {10:aaa }{9:foo}{10:^ bbb }| + {1:~ }{s: foo }{1: }| + {1:~ }{n: bar }{1: }| + {1:~ }{n: 你好 }{1: }| + {1:~ }|*15 + {2:-- }{5:match 1 of 3} | + ]]) + feed('') + screen:expect([[ + {10:aaa ^ bbb }| + {1:~ }{n: foo }{1: }| + {1:~ }{n: bar }{1: }| + {1:~ }{n: 你好 }{1: }| + {1:~ }|*15 + {2:-- }{8:Back at original} | + ]]) + feed('') + screen:expect([[ + {10:aaa }{9:你好}{10:^ bbb }| + {1:~ }{n: foo }{1: }| + {1:~ }{n: bar }{1: }| + {1:~ }{s: 你好 }{1: }| + {1:~ }|*15 + {2:-- }{5:match 3 of 3} | + ]]) + feed('') + screen:expect([[ + {10:aaa ^ bbb }| + {1:~ }|*18 + {2:-- INSERT --} | + ]]) + feed('') end) end end diff --git a/test/old/testdir/test_indent.vim b/test/old/testdir/test_indent.vim index 36670a0472..630beed810 100644 --- a/test/old/testdir/test_indent.vim +++ b/test/old/testdir/test_indent.vim @@ -308,7 +308,7 @@ endfunc " Test that mouse shape is restored to Normal mode after using "gq" when " 'indentexpr' executes :normal. -func Test_indent_norm_with_gq() +func Test_mouse_shape_indent_norm_with_gq() CheckFeature mouseshape CheckCanRunGui diff --git a/test/old/testdir/test_popup.vim b/test/old/testdir/test_popup.vim index 28104bdff5..f16a897b07 100644 --- a/test/old/testdir/test_popup.vim +++ b/test/old/testdir/test_popup.vim @@ -1747,13 +1747,67 @@ func Test_pum_matchins_highlight() call TermWait(buf) call term_sendkeys(buf, "Sαβγ \\\") call VerifyScreenDump(buf, 'Test_pum_matchins_04', {}) - call term_sendkeys(buf, "\\") + call term_sendkeys(buf, "\") " restore after cancel completion call TermWait(buf) call term_sendkeys(buf, "Sαβγ \\\") call VerifyScreenDump(buf, 'Test_pum_matchins_05', {}) - call term_sendkeys(buf, "\\") + call term_sendkeys(buf, "\") + + " text after the inserted text shouldn't be highlighted + call TermWait(buf) + call term_sendkeys(buf, "0ea \\") + call VerifyScreenDump(buf, 'Test_pum_matchins_07', {}) + call term_sendkeys(buf, "\") + call VerifyScreenDump(buf, 'Test_pum_matchins_08', {}) + call term_sendkeys(buf, "\") + call VerifyScreenDump(buf, 'Test_pum_matchins_09', {}) + call term_sendkeys(buf, "\") + call VerifyScreenDump(buf, 'Test_pum_matchins_10', {}) + call term_sendkeys(buf, "\") + + call StopVimInTerminal(buf) +endfunc + +func Test_pum_matchins_highlight_combine() + CheckScreendump + let lines =<< trim END + func Omni_test(findstart, base) + if a:findstart + return col(".") + endif + return [#{word: "foo"}, #{word: "bar"}, #{word: "你好"}] + endfunc + set omnifunc=Omni_test + hi Normal ctermbg=blue + hi CursorLine cterm=underline ctermbg=green + set cursorline + call setline(1, 'aaa bbb') + END + call writefile(lines, 'Xscript', 'D') + let buf = RunVimInTerminal('-S Xscript', {}) + + " when ComplMatchIns is not set, CursorLine applies normally + call term_sendkeys(buf, "0ea \\") + call VerifyScreenDump(buf, 'Test_pum_matchins_combine_01', {}) + call term_sendkeys(buf, "\") + call VerifyScreenDump(buf, 'Test_pum_matchins_combine_02', {}) + call term_sendkeys(buf, "\\") + + " when ComplMatchIns is set, it is applied over CursorLine + call TermWait(buf) + call term_sendkeys(buf, ":hi ComplMatchIns ctermbg=red ctermfg=yellow\") + call TermWait(buf) + call term_sendkeys(buf, "0ea \\") + call VerifyScreenDump(buf, 'Test_pum_matchins_combine_03', {}) + call term_sendkeys(buf, "\") + call VerifyScreenDump(buf, 'Test_pum_matchins_combine_04', {}) + call term_sendkeys(buf, "\") + call VerifyScreenDump(buf, 'Test_pum_matchins_combine_05', {}) + call term_sendkeys(buf, "\") + call VerifyScreenDump(buf, 'Test_pum_matchins_combine_06', {}) + call term_sendkeys(buf, "\") call StopVimInTerminal(buf) endfunc