Implement popupmenu as a floating grid internally to reduce flicker #9530

bfredl · 2019-01-20T12:12:24Z

Extract the "compositor" layer from #6619. This allows us to draw the popupmenu on a separate grid rather than on the default grid, even for TUI use.

Attempt to eliminate flicker in all these cases:

The pum was filtered due to the user added a prefix char.
The pum is moved due to linewrap change ( i e by long inserted item at end of line)
The contents of the pum was changed due to complete() call or something (corresponding to vim/vim@ae65438, tested now)

Also update_screen(NOT_VALID) should never be needed to redraw the text under the pum, rather the cached contents is resent from default_grid.

Note: in principle this will enable two connected UI:s, one using ext_popupmenu and the other using the builtin popupmenu, at the same time. This will need some other refactors though.

Note 2: this should reduce the bookkeeping in edit.c for pum redraws (ideally all commented code can be removed, but needs more testing). This will lower the bar for ex_getln.c also using the pum instead of statusline wildmenu for completions. It will need to compute position differently, but apart from that it would be able to use pum_display and pum_undisplay without thinking about window redraws at all.

fixes #9542.

bfredl · 2019-01-20T12:15:38Z

ping @Shougo what is the typical situation for vim/vim@ae65438, is it multiple complete() calls changing the popupmenu?

justinmk · 2019-01-20T13:31:25Z

src/nvim/compositor.c

@@ -0,0 +1,369 @@
+// This is an open source non-commercial project. Dear PVS-Studio, please check


name it ui_compositor.c , so it is grouped with ui.c and ui_bridge.c ? And the prefix could be uicomp_. This helps discover the project structure.

yeah, lets do that.

justinmk · 2019-01-20T13:35:13Z

src/nvim/ui.c

@@ -338,6 +359,18 @@ void ui_line(ScreenGrid *grid, int row, int startcol, int endcol, int clearcol,
  }
 }

+void ui_composed_call_raw_line(Integer draw_grid, Integer row,


isn't "composite" the more common phrasing rather than "composed"?

Maybe, but "composed" is a passive/past tense as in "the UI is (being) composed" or "after the line was composed"

justinmk · 2019-01-20T13:35:42Z

src/nvim/ui.c

@@ -85,21 +86,25 @@ static char uilog_last_event[1024] = { 0 };
 //
 // See http://stackoverflow.com/a/11172679 for how it works.
 #ifdef _MSC_VER
-# define UI_CALL(funname, ...) \
+# define UI_CALL_CND(CND, funname, ...) \


what does CND mean?

condition, maybe _IF is better?

FWIW we use cond in a few places.

# define UI_CALL_IF(cond, ...

Shougo · 2019-01-20T13:48:44Z

is it multiple complete() calls changing the popupmenu?

Yes. I will test the branch later.

bfredl · 2019-01-20T20:34:25Z

And another thing: using compositior for pum also make possible things like this:

Probably not practially useful for anything (except I guess providing useful context once in a blue moon), but maybe it can help make up for the lack of :smile.

Shougo · 2019-01-20T23:22:23Z

@bfredl I have tested below script with the branch.

" save this as complete_flicker.vim
" vim -u complete_flicker.vim -c "startinsert"

let s:months = ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']

let s:last_tick = []

function! s:current_tick()
    return [b:changedtick, getcurpos()]
endfunction

function! s:check_changes(...)
    let l:current_tick = s:current_tick()
    if s:last_tick != l:current_tick
        let s:last_tick = l:current_tick
        call s:on_changed()
    endif
endfunction

function! s:start_check_changes_timer()
    let s:last_tick = []
    let s:check_change_timer = timer_start(30, function('s:check_changes'), {'repeat': -1})
endfunction

function! s:stop_check_changes_timer()
    if exists('s:check_change_timer')
        call timer_stop(s:check_change_timer)
        unlet s:check_change_timer
    endif
endfunction

function! s:on_changed()
    if mode() != 'i'
        return
    endif
    setlocal completeopt-=longest
    setlocal completeopt+=menuone
    setlocal completeopt-=menu
    setlocal completeopt+=noselect
    call complete(1, s:months)
endfunction

autocmd TextChangedI * call s:check_changes()
autocmd InsertEnter * call s:start_check_changes_timer()
autocmd InsertLeave * call s:stop_check_changes_timer()

In the branch, narrowing flicker is gone, but press backspace is more flicker than master of neovim.
Can you fix the backspace flicker?

bfredl · 2019-01-21T07:21:39Z

Thanks, I will investigate.

bfredl · 2019-01-21T13:25:22Z

Actually, it seems to randomly happen for both typing and backspace (but not all of either).

bfredl · 2019-01-21T13:31:01Z

@Shougo I think at least some of the flicker here is fundamental, not related to this patch. Because if you press a key that changes the pum, and then 0-30ms later a timer will change the pum back again, there will be flicker for up to 30ms. Adding this line fixes it:

   autocmd TextChangedP * call s:check_changes()

Does nvim behave subtly different than vim for the behavior of autocmds, perhaps?

bfredl · 2019-01-21T13:47:47Z

But I changed timer to manually invoked <cmd> command and there is still some flicker, so all was not timer related.

bfredl · 2019-01-21T19:16:10Z

Hmm state management in edit.c is a bit more complicated than I thought. At several points where the pum is undisplayed, the code doesn't know if the pum is going to be displayed immediately again. (The code might say pum_undisplay(); ins_show_completion_again() but the later sometimes ends up not showing the pum again). I will try a different approach:

at every point pum_undisplay or pum_display is called, just store the internal state
do the actual pum draw or clearing in ins_redraw.

bfredl · 2019-01-21T19:50:03Z

Did the defer for only undisplay for now, probably enough.

@Shougo please try it again.

Shougo · 2019-01-22T00:04:56Z

I have tested the latest version.
I have confirmed the flicker problem is fixed.
Thank you.

bfredl · 2019-01-22T11:35:11Z

Issue: invoke the popupmenu with lots of items so it covers the entire the height of the screen. Now do :<c-r>=<c-f>. The cmdline window is now unusable due to covered by the pum. But the same issue exists on vim master, I will report it upstream.

bfredl · 2019-01-22T11:45:57Z

vim issue: vim/vim#3838

Shougo · 2019-01-23T01:05:30Z

The problem is fixed in Vim.

Shougo · 2019-02-02T07:18:52Z

I have tested the branch, and it is faster completion than master.

Initially we will use this for the popupmenu, floating windows will follow soon NB: writedelay + compositor is weird, we need more flexible redraw introspection.

This makes it possible for the compositor to compare the old pum with the new position, and only clear what is necessary.

… completion

Many of these are handled by the compositor. Check that it causes no glitches.

bfredl · 2019-02-02T15:41:50Z

Made some simplifications to the dispatching logic. A single UI_CALL macro now does all the work without a bunch of helper macros for __VA_ARGS__ shenanigans. Also internal-only events use ui_call_evname wrappers, just like internal+external and external-only events.

purpleP · 2019-02-03T15:13:45Z

Seems like you have a bug. After filtering spaces between items and metadata disappear.

Nice to see this pull request. I thought it would never be fixed!

bfredl · 2019-02-03T16:13:24Z

@purpleP yes, the metadata seems to be shifted to the left one cell. Thanks for noticing, I will fix it.

popupmenu: fix alignment of kind and extra after #9530

bfredl force-pushed the pum_float branch 3 times, most recently from 42217df to a9a74d7 Compare January 20, 2019 12:44

marvim added the WIP label Jan 20, 2019

justinmk reviewed Jan 20, 2019

View reviewed changes

bfredl mentioned this pull request Jan 20, 2019

vim-patch:8.1.0768: updating completions may cause the popup menu to … #9528

Closed

bfredl mentioned this pull request Jan 20, 2019

UI extension work (tracking issue) #9421

Open

23 tasks

bfredl mentioned this pull request Jan 24, 2019

E41: Out of memory when rightleft is set and a certain plugin is used #9542

Closed

bfredl force-pushed the pum_float branch 6 times, most recently from 98c2366 to 171e446 Compare January 27, 2019 13:33

bfredl added build building and installing Neovim using the provided scripts display redraw, layout, presentation ui and removed build building and installing Neovim using the provided scripts labels Jan 30, 2019

bfredl force-pushed the pum_float branch 2 times, most recently from b650143 to 6426cd1 Compare January 31, 2019 18:31

bfredl mentioned this pull request Feb 1, 2019

UI: implement 'pumblend' option for semi-transparent popupmenu #9571

Merged

bfredl force-pushed the pum_float branch 5 times, most recently from 8f0a227 to 1a03769 Compare February 2, 2019 15:30

bfredl added 6 commits February 2, 2019 16:31

UI: add "compositor" layer to merge grids for TUI use in a correct way

31cbd34

Initially we will use this for the popupmenu, floating windows will follow soon NB: writedelay + compositor is weird, we need more flexible redraw introspection.

Reduce pum redraws from edit.c by delaying undisplay of pum

2c01e79

This makes it possible for the compositor to compare the old pum with the new position, and only clear what is necessary.

vim-patch:8.1.0792: bad display if opening cmdline window from Insert…

2405cf8

… completion

ui/compositor: add redraws needed due to intersected doublewidth chars.

69bdc4f

tests/ui: add test for popupmenu redrawing in various situations

bfe2435

Many of these are handled by the compositor. Check that it causes no glitches.

multigrid: reset win scrolling after swap message

0f96a21

bfredl force-pushed the pum_float branch from 1a03769 to 0f96a21 Compare February 2, 2019 15:32

bfredl merged commit 79a0ea2 into neovim:master Feb 2, 2019

alok mentioned this pull request Feb 3, 2019

Is this Neovim PR relevant for ncm2? ncm2/ncm2#137

Closed

bfredl added a commit to bfredl/neovim that referenced this pull request Feb 3, 2019

popupmenu: fix alignment of kind and extra after neovim#9530

ae61afe

bfredl added a commit to bfredl/neovim that referenced this pull request Feb 3, 2019

popupmenu: fix alignment of kind and extra after neovim#9530

81ac8e9

bfredl mentioned this pull request Feb 3, 2019

popupmenu: fix alignment of kind and extra after #9530 #9579

Merged

bfredl added a commit that referenced this pull request Feb 3, 2019

Merge pull request #9579 from bfredl/pum_fix

da88278

popupmenu: fix alignment of kind and extra after #9530

bfredl mentioned this pull request Feb 19, 2019

[release-0.3] screen: don't crash when drawing popupmenu with 'rightleft' option #9629

Merged

		@@ -0,0 +1,369 @@
		// This is an open source non-commercial project. Dear PVS-Studio, please check

Uh oh!

Implement popupmenu as a floating grid internally to reduce flicker #9530

Implement popupmenu as a floating grid internally to reduce flicker #9530

Uh oh!

Conversation

bfredl commented Jan 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bfredl commented Jan 20, 2019

Uh oh!

justinmk Jan 20, 2019

Choose a reason for hiding this comment

Uh oh!

bfredl Jan 20, 2019

Choose a reason for hiding this comment

Uh oh!

justinmk Jan 20, 2019

Choose a reason for hiding this comment

Uh oh!

bfredl Jan 20, 2019

Choose a reason for hiding this comment

Uh oh!

justinmk Jan 20, 2019

Choose a reason for hiding this comment

Uh oh!

bfredl Jan 20, 2019

Choose a reason for hiding this comment

Uh oh!

justinmk Jan 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Shougo commented Jan 20, 2019

Uh oh!

bfredl commented Jan 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Shougo commented Jan 20, 2019

Uh oh!

bfredl commented Jan 21, 2019

Uh oh!

bfredl commented Jan 21, 2019

Uh oh!

bfredl commented Jan 21, 2019

Uh oh!

bfredl commented Jan 21, 2019

Uh oh!

bfredl commented Jan 21, 2019

Uh oh!

bfredl commented Jan 21, 2019

Uh oh!

Shougo commented Jan 22, 2019

Uh oh!

bfredl commented Jan 22, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bfredl commented Jan 22, 2019

Uh oh!

Shougo commented Jan 23, 2019

Uh oh!

Shougo commented Feb 2, 2019

Uh oh!

bfredl commented Feb 2, 2019

Uh oh!

purpleP commented Feb 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bfredl commented Feb 3, 2019

Uh oh!

Uh oh!

bfredl commented Jan 20, 2019 •

edited

Loading

justinmk Jan 20, 2019 •

edited

Loading

bfredl commented Jan 20, 2019 •

edited

Loading

bfredl commented Jan 22, 2019 •

edited

Loading

purpleP commented Feb 3, 2019 •

edited

Loading