Skip to content

Commit eb2310d

Browse files
brammoolbrammool
committed
patch 8.1.1559: popup window title property not implemented yet
Problem: Popup window title property not implemented yet. Solution: Implement the title property.
1 parent a730e55 commit eb2310d

9 files changed

Lines changed: 98 additions & 26 deletions

File tree

‎runtime/doc/popup.txt‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ TODO:
112112
popup_setoptions({id}, {options})
113113
hidden option
114114
tabpage option with number
115-
title option
116115
flip option
117116
transparent text property
118117

@@ -452,8 +451,8 @@ The second argument of |popup_create()| is a dictionary with options:
452451
title Text to be displayed above the first item in the
453452
popup, on top of any border. If there is no top
454453
border one line of padding is added to put the title
455-
on.
456-
{not implemented yet}
454+
on. You might want to add one or more spaces at the
455+
start and end as padding.
457456
wrap TRUE to make the lines wrap (default TRUE).
458457
drag TRUE to allow the popup to be dragged with the mouse
459458
by grabbing at at the border. Has no effect if the

‎src/popupwin.c‎

Lines changed: 47 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -294,6 +294,13 @@ apply_options(win_T *wp, buf_T *buf UNUSED, dict_T *dict)
294294
set_string_option_direct_in_win(wp, (char_u *)"wincolor", -1,
295295
str, OPT_FREE|OPT_LOCAL, 0);
296296

297+
str = dict_get_string(dict, (char_u *)"title", FALSE);
298+
if (str != NULL)
299+
{
300+
vim_free(wp->w_popup_title);
301+
wp->w_popup_title = vim_strsave(str);
302+
}
303+
297304
wp->w_firstline = dict_get_number(dict, (char_u *)"firstline");
298305
if (wp->w_firstline < 1)
299306
wp->w_firstline = 1;
@@ -531,6 +538,19 @@ popup_width(win_T *wp)
531538
+ wp->w_popup_padding[1] + wp->w_popup_border[1];
532539
}
533540

541+
/*
542+
* Get the padding plus border at the top, adjusted to 1 if there is a title.
543+
*/
544+
static int
545+
popup_top_extra(win_T *wp)
546+
{
547+
int extra = wp->w_popup_border[0] + wp->w_popup_padding[0];
548+
549+
if (extra == 0 && wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
550+
return 1;
551+
return extra;
552+
}
553+
534554
/*
535555
* Adjust the position and size of the popup to fit on the screen.
536556
*/
@@ -543,7 +563,7 @@ popup_adjust_position(win_T *wp)
543563
int center_vert = FALSE;
544564
int center_hor = FALSE;
545565
int allow_adjust_left = !wp->w_popup_fixed;
546-
int top_extra = wp->w_popup_border[0] + wp->w_popup_padding[0];
566+
int top_extra = popup_top_extra(wp);
547567
int right_extra = wp->w_popup_border[1] + wp->w_popup_padding[1];
548568
int bot_extra = wp->w_popup_border[2] + wp->w_popup_padding[2];
549569
int left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
@@ -553,6 +573,7 @@ popup_adjust_position(win_T *wp)
553573
int org_wincol = wp->w_wincol;
554574
int org_width = wp->w_width;
555575
int org_height = wp->w_height;
576+
int minwidth;
556577

557578
wp->w_winrow = 0;
558579
wp->w_wincol = 0;
@@ -646,8 +667,17 @@ popup_adjust_position(win_T *wp)
646667
break;
647668
}
648669

649-
if (wp->w_minwidth > 0 && wp->w_width < wp->w_minwidth)
650-
wp->w_width = wp->w_minwidth;
670+
minwidth = wp->w_minwidth;
671+
if (wp->w_popup_title != NULL && *wp->w_popup_title != NUL)
672+
{
673+
int title_len = vim_strsize(wp->w_popup_title) + 2 - extra_width;
674+
675+
if (minwidth < title_len)
676+
minwidth = title_len;
677+
}
678+
679+
if (minwidth > 0 && wp->w_width < minwidth)
680+
wp->w_width = minwidth;
651681
if (wp->w_width > maxwidth)
652682
wp->w_width = maxwidth;
653683
if (center_hor)
@@ -1384,7 +1414,7 @@ f_popup_getpos(typval_T *argvars, typval_T *rettv)
13841414
{
13851415
if (wp == NULL)
13861416
return; // invalid {id}
1387-
top_extra = wp->w_popup_border[0] + wp->w_popup_padding[0];
1417+
top_extra = popup_top_extra(wp);
13881418
left_extra = wp->w_popup_border[3] + wp->w_popup_padding[3];
13891419

13901420
dict = rettv->vval.v_dict;
@@ -1750,6 +1780,7 @@ update_popups(void (*win_update)(win_T *wp))
17501780
int left_off;
17511781
int total_width;
17521782
int total_height;
1783+
int top_padding;
17531784
int popup_attr;
17541785
int border_attr[4];
17551786
int border_char[8];
@@ -1770,7 +1801,7 @@ update_popups(void (*win_update)(win_T *wp))
17701801

17711802
// adjust w_winrow and w_wincol for border and padding, since
17721803
// win_update() doesn't handle them.
1773-
top_off = wp->w_popup_padding[0] + wp->w_popup_border[0];
1804+
top_off = popup_top_extra(wp);
17741805
left_off = wp->w_popup_padding[3] + wp->w_popup_border[3];
17751806
wp->w_winrow += top_off;
17761807
wp->w_wincol += left_off;
@@ -1783,7 +1814,7 @@ update_popups(void (*win_update)(win_T *wp))
17831814

17841815
total_width = wp->w_popup_border[3] + wp->w_popup_padding[3]
17851816
+ wp->w_width + wp->w_popup_padding[1] + wp->w_popup_border[1];
1786-
total_height = wp->w_popup_border[0] + wp->w_popup_padding[0]
1817+
total_height = popup_top_extra(wp)
17871818
+ wp->w_height + wp->w_popup_padding[2] + wp->w_popup_border[2];
17881819
popup_attr = get_wcr_attr(wp);
17891820

@@ -1816,6 +1847,7 @@ update_popups(void (*win_update)(win_T *wp))
18161847
border_attr[i] = syn_name2attr(wp->w_border_highlight[i]);
18171848
}
18181849

1850+
top_padding = wp->w_popup_padding[0];
18191851
if (wp->w_popup_border[0] > 0)
18201852
{
18211853
// top border
@@ -1832,17 +1864,24 @@ update_popups(void (*win_update)(win_T *wp))
18321864
wp->w_wincol + total_width - 1, border_attr[1]);
18331865
}
18341866
}
1867+
else if (wp->w_popup_padding[0] == 0 && popup_top_extra(wp) > 0)
1868+
top_padding = 1;
18351869

1836-
if (wp->w_popup_padding[0] > 0)
1870+
if (top_padding > 0)
18371871
{
18381872
// top padding
18391873
row = wp->w_winrow + wp->w_popup_border[0];
1840-
screen_fill(row, row + wp->w_popup_padding[0],
1874+
screen_fill(row, row + top_padding,
18411875
wp->w_wincol + wp->w_popup_border[3],
18421876
wp->w_wincol + total_width - wp->w_popup_border[1],
18431877
' ', ' ', popup_attr);
18441878
}
18451879

1880+
// Title goes on top of border or padding.
1881+
if (wp->w_popup_title != NULL)
1882+
screen_puts(wp->w_popup_title, wp->w_winrow, wp->w_wincol + 1,
1883+
wp->w_popup_border[0] > 0 ? border_attr[0] : popup_attr);
1884+
18461885
for (row = wp->w_winrow + wp->w_popup_border[0];
18471886
row < wp->w_winrow + total_height - wp->w_popup_border[2];
18481887
++row)

‎src/structs.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2891,6 +2891,7 @@ struct window_S
28912891
pos_save_T w_save_cursor; /* backup of cursor pos and topline */
28922892
#ifdef FEAT_TEXT_PROP
28932893
int w_popup_flags; // POPF_ values
2894+
char_u *w_popup_title;
28942895
poppos_T w_popup_pos;
28952896
int w_popup_fixed; // do not shift popup to fit on screen
28962897
int w_zindex;

‎src/testdir/dumps/Test_popupwin_menu_01.dump‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
>1+0&#ffffff0| @73
2-
|2| @30|╔+0#0000001#ffd7ff255|═@8|╗| +0#0000000#ffffff0@31
3-
|3| @30|║+0#0000001#ffd7ff255| @8|║| +0#0000000#ffffff0@31
4-
|4| @30|║+0#0000001#ffd7ff255| |o+0#0000000#5fd7ff255|n|e| +0#0000001#ffd7ff255@4|║| +0#0000000#ffffff0@31
5-
|5| @30|║+0#0000001#ffd7ff255| |t|w|o| @4|║| +0#0000000#ffffff0@31
6-
|6| @30|║+0#0000001#ffd7ff255| |a|n|o|t|h|e|r| |║| +0#0000000#ffffff0@31
7-
|7| @30|║+0#0000001#ffd7ff255| @8|║| +0#0000000#ffffff0@31
8-
|8| @30|╚+0#0000001#ffd7ff255|═@8|╝| +0#0000000#ffffff0@31
2+
|2| @20|╔+0#0000001#ffd7ff255| |m|a|k|e| |a| |c|h|o|i|c|e| |f|r|o|m| |t|h|e| |l|i|s|t| |╗| +0#0000000#ffffff0@21
3+
|3| @20|║+0#0000001#ffd7ff255| @28|║| +0#0000000#ffffff0@21
4+
|4| @20|║+0#0000001#ffd7ff255| |o+0#0000000#5fd7ff255|n|e| +0#0000001#ffd7ff255@24|║| +0#0000000#ffffff0@21
5+
|5| @20|║+0#0000001#ffd7ff255| |t|w|o| @24|║| +0#0000000#ffffff0@21
6+
|6| @20|║+0#0000001#ffd7ff255| |a|n|o|t|h|e|r| @20|║| +0#0000000#ffffff0@21
7+
|7| @20|║+0#0000001#ffd7ff255| @28|║| +0#0000000#ffffff0@21
8+
|8| @20|╚+0#0000001#ffd7ff255|═@28|╝| +0#0000000#ffffff0@21
99
|9| @73
1010
@57|1|,|1| @10|T|o|p|

‎src/testdir/dumps/Test_popupwin_menu_02.dump‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
>1+0&#ffffff0| @73
2-
|2| @30|╔+0#0000001#ffd7ff255|═@8|╗| +0#0000000#ffffff0@31
3-
|3| @30|║+0#0000001#ffd7ff255| @8|║| +0#0000000#ffffff0@31
4-
|4| @30|║+0#0000001#ffd7ff255| |o|n|e| @4|║| +0#0000000#ffffff0@31
5-
|5| @30|║+0#0000001#ffd7ff255| |t|w|o| @4|║| +0#0000000#ffffff0@31
6-
|6| @30|║+0#0000001#ffd7ff255| |a+0#0000000#5fd7ff255|n|o|t|h|e|r| +0#0000001#ffd7ff255|║| +0#0000000#ffffff0@31
7-
|7| @30|║+0#0000001#ffd7ff255| @8|║| +0#0000000#ffffff0@31
8-
|8| @30|╚+0#0000001#ffd7ff255|═@8|╝| +0#0000000#ffffff0@31
2+
|2| @20|╔+0#0000001#ffd7ff255| |m|a|k|e| |a| |c|h|o|i|c|e| |f|r|o|m| |t|h|e| |l|i|s|t| |╗| +0#0000000#ffffff0@21
3+
|3| @20|║+0#0000001#ffd7ff255| @28|║| +0#0000000#ffffff0@21
4+
|4| @20|║+0#0000001#ffd7ff255| |o|n|e| @24|║| +0#0000000#ffffff0@21
5+
|5| @20|║+0#0000001#ffd7ff255| |t|w|o| @24|║| +0#0000000#ffffff0@21
6+
|6| @20|║+0#0000001#ffd7ff255| |a+0#0000000#5fd7ff255|n|o|t|h|e|r| +0#0000001#ffd7ff255@20|║| +0#0000000#ffffff0@21
7+
|7| @20|║+0#0000001#ffd7ff255| @28|║| +0#0000000#ffffff0@21
8+
|8| @20|╚+0#0000001#ffd7ff255|═@28|╝| +0#0000000#ffffff0@21
99
|9| @73
1010
@57|1|,|1| @10|T|o|p|

‎src/testdir/dumps/Test_popupwin_title.dump‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
>1+0&#ffffff0| @73
2+
|2| @73
3+
|3| @73
4+
|4| @28| +0#0000001#ffd7ff255|T|i|t|l|e| |S|t|r|i|n|g| | +0#0000000#ffffff0@30
5+
|5| @28|o+0#0000001#ffd7ff255|n|e| @10| +0#0000000#ffffff0@30
6+
|6| @28|t+0#0000001#ffd7ff255|w|o| @10| +0#0000000#ffffff0@30
7+
|7| @28|a+0#0000001#ffd7ff255|n|o|t|h|e|r| @6| +0#0000000#ffffff0@30
8+
|8| @73
9+
|9| @73
10+
@57|1|,|1| @10|T|o|p|

‎src/testdir/test_popupwin.vim‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -940,7 +940,7 @@ func Test_popup_menu_screenshot()
940940
let lines =<< trim END
941941
call setline(1, range(1, 20))
942942
hi PopupSelected ctermbg=lightblue
943-
call popup_menu(['one', 'two', 'another'], {'callback': 'MenuDone'})
943+
call popup_menu(['one', 'two', 'another'], {'callback': 'MenuDone', 'title': ' make a choice from the list '})
944944
func MenuDone(id, res)
945945
echomsg "selected " .. a:res
946946
endfunc
@@ -960,6 +960,26 @@ func Test_popup_menu_screenshot()
960960
call delete('XtestPopupMenu')
961961
endfunc
962962

963+
func Test_popup_title()
964+
if !CanRunVimInTerminal()
965+
throw 'Skipped: cannot make screendumps'
966+
endif
967+
968+
" Create a popup without title or border, a line of padding will be added to
969+
" put the title on.
970+
let lines =<< trim END
971+
call setline(1, range(1, 20))
972+
call popup_create(['one', 'two', 'another'], {'title': 'Title String'})
973+
END
974+
call writefile(lines, 'XtestPopupTitle')
975+
let buf = RunVimInTerminal('-S XtestPopupTitle', {'rows': 10})
976+
call VerifyScreenDump(buf, 'Test_popupwin_title', {})
977+
978+
" clean up
979+
call StopVimInTerminal(buf)
980+
call delete('XtestPopupTitle')
981+
endfunc
982+
963983
func Test_popup_close_callback()
964984
func PopupDone(id, result)
965985
let g:result = a:result

‎src/version.c‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -777,6 +777,8 @@ static char *(features[]) =
777777

778778
static int included_patches[] =
779779
{ /* Add new patch number below this line */
780+
/**/
781+
1559,
780782
/**/
781783
1558,
782784
/**/

‎src/window.c‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4857,6 +4857,7 @@ win_free(
48574857
free_callback(&wp->w_filter_cb);
48584858
for (i = 0; i < 4; ++i)
48594859
VIM_CLEAR(wp->w_border_highlight[i]);
4860+
vim_free(wp->w_popup_title);
48604861
#endif
48614862

48624863
#ifdef FEAT_SYN_HL

0 commit comments

Comments
 (0)