patch 9.1.1856: cannot style popup window (border, shadow, etc)

Problem:  cannot style popup window (border, shadow, etc)
Solution: Extend the 'completepopup' option with additional properties
          (Girish Palya)

This patch extends the 'completepopup' option with additional settings
to allow more configuration of info popup window.

New values:
```
- close           "on" (default) or "off"
- resize          "on" (default) or "off"
- borderchars     specify eight characters (separated by semicolons) to
                  draw the popup border: top, right, bottom, left,
                  topleft, topright, botright, botleft.
- borderhighlight highlight group for the popup border characters
- shadow          pum shadow
```

closes: #18487

Signed-off-by: Girish Palya <[email protected]>
Signed-off-by: Christian Brabandt <[email protected]>

Author: girishji

runtime/doc/insert.txt

@@ -1,4 +1,4 @@
-*insert.txt*    For Vim version 9.1.  Last change: 2025 Oct 12
+*insert.txt*    For Vim version 9.1.  Last change: 2025 Oct 14
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -1287,26 +1287,9 @@ remove existing text in the preview window.  The size of the preview window is
 three lines, but 'previewheight' is used when it has a value of 1 or 2.
 
 						*complete-popup*
-When "popup" is in 'completeopt' a popup window is used to display the "info".
-Then the 'completepopup' option specifies the properties of the popup.  This
-is used when the info popup is created.  The option is a comma-separated list
-of values:
-	height		maximum height of the popup
-	width		maximum width of the popup
-	highlight	highlight group of the popup (default is PmenuSel)
-	align		"item" (default) or "menu"
-	border		"on" (default) or "off"
-Example: >
-	:set completepopup=height:10,width:60,highlight:InfoPopup
-
-When `"align"` is set to `"item"`, the popup is positioned near the selected
-item, and moves as the selection changes.
-When set to `"menu"`, the popup aligns with the top of the menu (if the menu
-appears below the text), or with the bottom (if the menu appears above).
-
-If the 'mouse' is enabled, a close button and resize handle will appear on the
-popup border.
-
+When "popup" is included in 'completeopt', a popup window is used to display
+the completion "info" text.  The appearance and behavior of this popup are
+controlled by the 'completepopup' option when the popup is created.
 After creation, the info popup can be located with |popup_findinfo()| and
 modified using |popup_setoptions()|.
 

runtime/doc/options.txt

@@ -1,4 +1,4 @@
-*options.txt*	For Vim version 9.1.  Last change: 2025 Oct 12
+*options.txt*	For Vim version 9.1.  Last change: 2025 Oct 14
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -2339,12 +2339,50 @@ A jump table for the options with a short description can be found at |Q_op|.
 			global
 			{not available when compiled without the |+textprop|
 			or |+quickfix| feature}
-	When 'completeopt' contains "popup" then this option is used for the
+	When 'completeopt' contains "popup", this option specifies the
 	properties of the info popup when it is created.  If an info popup
 	window already exists it is closed, so that the option value is
 	applied when it is created again.
-	You can also use |popup_findinfo()| and then set properties for an
-	existing info popup with |popup_setoptions()|.  See |complete-popup|.
+
+	The option is a comma-separated list of values:
+		align		"item" (default) or "menu"
+		border		border style:
+				"single"	thin box-drawing characters
+				"double"	double-line
+				"round"		rounded corners
+				"ascii"		ASCII characters (-, |, +)
+				"custom:X;X;X;X;X;X;X;X"
+						eight characters separated by
+						semicolons, in the order: top,
+						right, bottom, left, topleft,
+						topright, botright, botleft
+				"on"		same as "double" when
+						'encoding' is "utf-8" and
+						'ambiwidth' is "single", else
+						"ascii" (default)
+				"off"		no border
+		borderhighlight	highlight group for the popup border characters
+		close		show close button: "on" (default) or "off"
+		height		maximum height of the popup
+		highlight	popup highlight group (default: PmenuSel)
+		resize		show resize handle: "on" (default) or "off"
+		shadow		"off" (default) or "on" using |hl-PmenuShadow|
+		width		maximum width of the popup
+
+	Example: >
+		:set completepopup=height:10,border:single,highlight:InfoPopup
+		:set completepopup=width:60,border:custom:─;│;─;│;┌;┐;┘;└
+<
+	When "align" is set to "item", the popup is positioned near the
+	selected item and moves as the selection changes.
+	When set to "menu", the popup aligns with the top of the menu (if the
+	menu appears below the text) or with the bottom (if it appears above).
+
+	The close button and resize handle are shown on the popup border only
+	when 'mouse' is enabled.
+
+	After creation, the info popup can be located with |popup_findinfo()|
+	and modified using |popup_setoptions()|.  See also: |complete-popup|.
 
 						*'completeslash'* *'csl'*
 'completeslash' 'csl'	string	(default: "")

runtime/doc/version9.txt

@@ -41717,6 +41717,7 @@ Options: ~
   to ">" by default, indicating text that extends beyond the window width.
 - 'guioptions': New value |'go-C'| to style the title/caption bar on Windows 11
   (see also the below platform specific change).
+- 'completepopup': Add more values to style popup windows.
 
 Ex commands: ~
 - allow to specify a priority when defining a new sign |:sign-define|

src/optiondefs.h

@@ -711,7 +711,7 @@ static struct vimoption options[] =
 			    SCTX_INIT},
     {"completepopup", "cpp", P_STRING|P_VI_DEF|P_COMMA|P_NODUP|P_COLON,
 #if defined(FEAT_PROP_POPUP) && defined(FEAT_QUICKFIX)
-			    (char_u *)&p_cpp, PV_NONE, did_set_completepopup, expand_set_popupoption,
+			    (char_u *)&p_cpp, PV_NONE, did_set_completepopup, expand_set_completepopup,
 			    {(char_u *)"", (char_u *)0L}
 #else
 			    (char_u *)NULL, PV_NONE, NULL, NULL,
@@ -1991,7 +1991,7 @@ static struct vimoption options[] =
 			    {(char_u *)12L, (char_u *)0L} SCTX_INIT},
     {"previewpopup", "pvp", P_STRING|P_VI_DEF|P_COMMA|P_NODUP|P_COLON,
 #ifdef FEAT_PROP_POPUP
-			    (char_u *)&p_pvp, PV_NONE, did_set_previewpopup, expand_set_popupoption,
+			    (char_u *)&p_pvp, PV_NONE, did_set_previewpopup, expand_set_previewpopup,
 			    {(char_u *)"", (char_u *)0L}
 #else
 			    (char_u *)NULL, PV_NONE, NULL, NULL,

src/optionstr.c

@@ -70,9 +70,14 @@ static char *(p_fdo_values[]) = {"all", "block", "hor", "mark", "percent",
 static char *(p_kpc_protocol_values[]) = {"none", "mok2", "kitty", NULL};
 #ifdef FEAT_PROP_POPUP
 // Note: Keep this in sync with parse_popup_option()
-static char *(p_popup_option_values[]) = { "align:", "border:", "height:",
-    "highlight:", "shadow:", "width:", NULL};
-static char *(p_popup_option_border_values[]) = {"on", "off", NULL};
+static char *(p_popup_cpp_option_values[]) = {"align:", "border:",
+    "borderhighlight:", "close:", "height:", "highlight:", "resize:",
+    "shadow:", "width:", NULL};
+static char *(p_popup_pvp_option_values[]) = {"height:", "highlight:",
+    "width:", NULL};
+static char *(p_popup_option_on_off_values[]) = {"on", "off", NULL};
+static char *(p_popup_cpp_border_values[]) = {"single", "double", "round",
+    "ascii", "on", "off", "custom:", NULL};
 static char *(p_popup_option_align_values[]) = {"item", "menu", NULL};
 #endif
 #if defined(FEAT_SPELL)
@@ -3408,22 +3413,44 @@ did_set_previewpopup(optset_T *args UNUSED)
     return NULL;
 }
 
-    int
-expand_set_popupoption(optexpand_T *args, int *numMatches, char_u ***matches)
+    static int
+expand_set_popupoption(optexpand_T *args, int *numMatches, char_u ***matches,
+	int previewpopup)
 {
     expand_T *xp = args->oe_xp;
 
     if (xp->xp_pattern > args->oe_set_arg && *(xp->xp_pattern-1) == ':')
     {
 	// Within "highlight:"/"border:"/"align:", we have a subgroup of possible options.
 	int border_len = (int)STRLEN("border:");
-	if (xp->xp_pattern - args->oe_set_arg >= border_len &&
-		STRNCMP(xp->xp_pattern - border_len, "border:", border_len) == 0)
+	int close_len = (int)STRLEN("close:");
+	int resize_len = (int)STRLEN("resize:");
+	int shadow_len = (int)STRLEN("shadow:");
+	int is_border = xp->xp_pattern - args->oe_set_arg >= border_len &&
+		STRNCMP(xp->xp_pattern - border_len, "border:", border_len) == 0;
+	int is_close = xp->xp_pattern - args->oe_set_arg >= close_len &&
+		STRNCMP(xp->xp_pattern - close_len, "close:", close) == 0;
+	int is_resize = xp->xp_pattern - args->oe_set_arg >= resize_len &&
+		STRNCMP(xp->xp_pattern - resize_len, "resize:", resize_len) == 0;
+	int is_shadow = xp->xp_pattern - args->oe_set_arg >= shadow_len &&
+		STRNCMP(xp->xp_pattern - shadow_len, "shadow:", shadow_len) == 0;
+	if (is_close || is_resize || is_shadow)
+	{
+	    return expand_set_opt_string(
+		    args,
+		    p_popup_option_on_off_values,
+		    ARRAY_LENGTH(p_popup_option_on_off_values) - 1,
+		    numMatches,
+		    matches);
+	}
+	if (is_border)
 	{
 	    return expand_set_opt_string(
 		    args,
-		    p_popup_option_border_values,
-		    ARRAY_LENGTH(p_popup_option_border_values) - 1,
+		    previewpopup ? p_popup_option_on_off_values
+			: p_popup_cpp_border_values,
+		    (previewpopup ? ARRAY_LENGTH(p_popup_option_on_off_values)
+			: ARRAY_LENGTH(p_popup_cpp_border_values)) - 1,
 		    numMatches,
 		    matches);
 	}
@@ -3439,8 +3466,15 @@ expand_set_popupoption(optexpand_T *args, int *numMatches, char_u ***matches)
 		    matches);
 	}
 	int highlight_len = (int)STRLEN("highlight:");
-	if (xp->xp_pattern - args->oe_set_arg >= highlight_len &&
-		STRNCMP(xp->xp_pattern - highlight_len, "highlight:", highlight_len) == 0)
+	int borderhighlight_len = (int)STRLEN("borderhighlight:");
+	int is_highlight = xp->xp_pattern - args->oe_set_arg >= highlight_len
+	    && STRNCMP(xp->xp_pattern - highlight_len, "highlight:",
+		    highlight_len) == 0;
+	int is_borderhighlight
+	    = xp->xp_pattern - args->oe_set_arg >= borderhighlight_len
+	    && STRNCMP(xp->xp_pattern - borderhighlight_len, "highlight:",
+		    borderhighlight_len) == 0;
+	if (is_highlight || is_borderhighlight)
 	{
 	    // Return the list of all highlight names
 	    return expand_set_opt_generic(
@@ -3454,11 +3488,25 @@ expand_set_popupoption(optexpand_T *args, int *numMatches, char_u ***matches)
 
     return expand_set_opt_string(
 	    args,
-	    p_popup_option_values,
-	    ARRAY_LENGTH(p_popup_option_values) - 1,
+	    previewpopup ? p_popup_pvp_option_values
+		: p_popup_cpp_option_values,
+	    previewpopup ? ARRAY_LENGTH(p_popup_pvp_option_values) - 1
+		: ARRAY_LENGTH(p_popup_cpp_option_values) - 1,
 	    numMatches,
 	    matches);
 }
+
+    int
+expand_set_previewpopup(optexpand_T *args, int *numMatches, char_u ***matches)
+{
+    return expand_set_popupoption(args, numMatches, matches, TRUE);
+}
+
+    int
+expand_set_completepopup(optexpand_T *args, int *numMatches, char_u ***matches)
+{
+    return expand_set_popupoption(args, numMatches, matches, FALSE);
+}
 #endif
 
 #if defined(FEAT_POSTSCRIPT)