patch 9.1.1812: completion: flicker with slow LSPs

Problem:  completion: flicker with slow LSPs
Solution: Disable flushing the changed text (Girish Palya).

In insert-mode completion, the leader text is temporarily deleted while
searching for completion candidates. If the LSP server responds slowly,
the client may call `:sleep` to wait, which triggers `out_flush()`. This
causes the deleted text to briefly disappear before being redrawn when
results arrive, producing a visible flicker.

There are two possible fixes:

1. Suppress flushing while a user function (e.g. LSP client) is waiting.
2. Reinsert the deleted text before invoking the user function.

This Commit implements (1), which is the simpler solution, though somewhat
heavy-handed. If you think this may introduce unwanted side effects, I
can rework it to use (2).

closes: #18439

Signed-off-by: Girish Palya <girishji@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>

diff --git a/src/globals.h b/src/globals.h
index 5e2f7b0f46bd48cbbadfd2e7a3d5b67192f3d76f..b105ce5154f1c004ba7498d809f994828c1134e2 100644 (file)
--- a/src/globals.h
+++ b/src/globals.h
@@ -1133,6 +1133,9 @@ EXTERN int        secure INIT(= FALSE);
                                // allowed, e.g. when sourcing .exrc or .vimrc
                                // in current directory
 
+EXTERN int     no_flush INIT(= 0);
+                               // non-zero to prevent flushing output buffer
+
 EXTERN int     textlock INIT(= 0);
                                // non-zero when changing text and jumping to
                                // another window or editing another buffer is

diff --git a/src/insexpand.c b/src/insexpand.c
index 286fc0b472ba3a70f18de5e09f5e58cdd7f13489..17d0965ffec181ad653f88393a9edf6aa4fcf0ce 100644 (file)
--- a/src/insexpand.c
+++ b/src/insexpand.c
@@ -3601,8 +3601,18 @@ expand_by_function(int type, char_u *base, callback_T *cb)
     // Insert mode in another buffer.
     ++textlock;
 
+    // Suppress flushing of the output buffer. Without this, text removed
+    // temporarily by ins_compl_delete() is flushed to the terminal and shown
+    // as deleted, only to be redrawn later. This causes visible flicker (typed
+    // chars disappear and reappear) when a user func (e.g. an LSP server)
+    // responds slowly. Such funcs may call sleep(), which indirectly triggers
+    // out_flush(). We want deleted text to remain visible.
+    ++no_flush;
+
     retval = call_callback(cb, 0, &rettv, 2, args);
 
+    --no_flush;
+
     // Call a function, which returns a list or dict.
     if (retval == OK)
     {
@@ -6093,7 +6103,6 @@ find_next_completion_match(
     int                compl_fuzzy_match = (cur_cot_flags & COT_FUZZY) != 0;
     string_T   *leader;
 
-
     while (--todo >= 0)
     {
        if (compl_shows_dir_forward() && compl_shown_match->cp_next != NULL)
@@ -6203,7 +6212,7 @@ find_next_completion_match(
  *
  * Note that this function may be called recursively once only.  First with
  * "allow_get_expansion" TRUE, which calls ins_compl_get_exp(), which in turn
- * calls this function with "allow_get_expansion" FALSE.
+ * calls this with "allow_get_expansion" FALSE (via ins_compl_check_keys()).
  */
     static int
 ins_compl_next(

diff --git a/src/term.c b/src/term.c
index e2308583732ac610d4b15cee546eded989e9f0a1..0fa5652b3ca7ace66822f35fd8efb629cd51cefa 100644 (file)
--- a/src/term.c
+++ b/src/term.c
@@ -2772,7 +2772,7 @@ out_flush(void)
 {
     int            len;
 
-    if (out_pos == 0)
+    if (no_flush > 0 || out_pos == 0)
        return;
 
     // set out_pos to 0 before ui_write, to avoid recursiveness

diff --git a/src/testdir/test_ins_complete.vim b/src/testdir/test_ins_complete.vim
index e7346b8b581ac469287ded76cde18df7d70b1fce..5f5fb8d971aba6d0694f4ea1d35bf0eda8c48684 100644 (file)
--- a/src/testdir/test_ins_complete.vim
+++ b/src/testdir/test_ins_complete.vim
@@ -420,7 +420,7 @@ func Test_CompleteDoneDict()
   au CompleteDone * :call <SID>CompleteDone_CheckCompletedItemDict(0)
 
   set complete=.,F<SID>CompleteDone_CompleteFuncDict
-  execute "normal a\<C-N>\<C-Y>"
+  execute "normal dda\<C-N>\<C-Y>"
   set complete&
 
   call assert_equal(['one', 'two'], v:completed_item[ 'user_data' ])
@@ -473,7 +473,7 @@ func Test_CompleteDoneDictNoUserData()
   let s:called_completedone = 0
 
   set complete=.,F<SID>CompleteDone_CompleteFuncDictNoUserData
-  execute "normal a\<C-N>\<C-Y>"
+  execute "normal dda\<C-N>\<C-Y>"
   set complete&
 
   call assert_equal('', v:completed_item[ 'user_data' ])

diff --git a/src/version.c b/src/version.c
index 5c74bc0e1361ddab8bcf1fa0df428885ae969396..d989f097a53966b48805f1826364954d45cc8a41 100644 (file)
--- a/src/version.c
+++ b/src/version.c
@@ -729,6 +729,8 @@ static char *(features[]) =
 
 static int included_patches[] =
 {   /* Add new patch number below this line */
+/**/
+    1812,
 /**/
     1811,
 /**/