Skip to content

Commit

Permalink
completion: move in right direction when filling completion_info()
Browse files Browse the repository at this point in the history
When moving through the insert completion menu and switching directions,
we need to make sure we start at the correct position in the list and
move correctly forward/backwards through it, so that we do not skip
entries and the selected item points to the correct entry in the list
of completion entries generated by the completion_info() function.

The general case is this:

1) CTRL-X CTRL-N, we will traverse the list starting from
   compl_first_match and then go forwards (using the cp->next pointer)
   through the list (skipping the very first entry, which has the
   CP_ORIGINAL_TEXT flag set (since that is the empty/non-selected entry

2) CTRL-X CTRL-P, we will traverse the list starting from
   compl_first_match (which now points to the last entry). The previous
   entry will have the CP_ORIGINAL_TEXT flag set, so we need to start
   traversing the list from the second prev pointer.

There are in fact 2 special cases after starting the completion menu
with CTRL-X:

3)  CTRL-N and then going backwards by pressing CTRL-P again.
    compl_first_match will point to the same entry as in step 1 above,
    but since compl_dir_foward() has been switched by pressing CTRL-P
    to backwards we need to pretend to be in still in case 1 and still
    traverse the list in forward direction using the cp_next pointer

4)  CTRL-P and then going forwards by pressing CTRL-N again.
    compl_first_match will point to the same entry as in step 2 above,
    but since compl_dir_foward() has been switched by pressing CTRL-N
    to forwards we need to pretend to be in still in case 2 and still
    traverse the list in backward direction using the cp_prev pointer

related: vim#13402
related: vim#12971
  • Loading branch information
chrisbra committed Oct 22, 2023
1 parent 47416d1 commit 1f2882d
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 3 deletions.
31 changes: 28 additions & 3 deletions src/insexpand.c
Original file line number Diff line number Diff line change
Expand Up @@ -3044,14 +3044,39 @@ ins_compl_update_sequence_numbers(void)
info_add_completion_info(list_T *li)
{
compl_T *match;
int forward = compl_dir_forward();

if (compl_first_match == NULL)
return OK;

match = compl_first_match;
// There are four cases to consider here:
// 1) when just going forward through the menu,
// compl_first_match should point to the initial entry with
// number zero and CP_ORIGINAL_TEXT flag set
// 2) when just going backwards,
// compl-first_match should point to the last entry before
// the entry with the CP_ORIGINAL_TEXT flag set
// 3) when first going forwards and then backwards, e.g.
// pressing C-N, C-P, compl_first_match points to the
// last entry before the entry with the CP_ORIGINAL_TEXT
// flag set and next-entry moves opposite through the list
// compared to case 2, so pretend the direction is forward again
// 4) when first going backwards and then forwards, e.g.
// pressing C-P, C-N, compl_first_match points to the
// first entry with the CP_ORIGINAL_TEXT
// flag set and next-entry moves in opposite direction through the list
// compared to case 1, so pretend the direction is backwards again

if (forward && !match_at_original_text(match))
forward = FALSE;
else if (!forward && match_at_original_text(match))
forward = TRUE;

// Skip the element with the CP_ORIGINAL_TEXT flag at the beginning, in case of
// forward completion, or at the end, in case of backward completion.
match = compl_dir_forward()
? compl_first_match->cp_next : compl_first_match->cp_prev->cp_prev;
match = forward ? match->cp_next : match->cp_prev->cp_prev;

while (match != NULL && !match_at_original_text(match))
{
dict_T *di = dict_alloc();
Expand All @@ -3071,7 +3096,7 @@ info_add_completion_info(list_T *li)
else
dict_add_tv(di, "user_data", &match->cp_user_data);

match = compl_dir_forward() ? match->cp_next : match->cp_prev;
match = forward ? match->cp_next : match->cp_prev;
}

return OK;
Expand Down
7 changes: 7 additions & 0 deletions src/testdir/test_ins_complete.vim
Original file line number Diff line number Diff line change
Expand Up @@ -2279,6 +2279,13 @@ func Test_complete_info_index()
call feedkeys("Go\<C-X>\<C-P>\<C-P>\<F5>\<Esc>_dd", 'tx')
call assert_equal("eee", g:compl_info['items'][g:compl_info['selected']]['word'])

" switch direction
call feedkeys("Go\<C-X>\<C-N>\<C-P>\<C-P>\<F5>\<Esc>_dd", 'tx')
call assert_equal("fff", g:compl_info['items'][g:compl_info['selected']]['word'])

call feedkeys("Go\<C-X>\<C-P>\<C-N>\<C-N>\<F5>\<Esc>_dd", 'tx')
call assert_equal("aaa", g:compl_info['items'][g:compl_info['selected']]['word'])

" Add 'noselect', check that 'selected' is -1 when nothing is selected.
set completeopt+=noselect
" Search forward.
Expand Down

0 comments on commit 1f2882d

Please sign in to comment.