feat(api): combined highlights in nvim_eval_statusline()

Problem:  Combined highlighting was not applied to nvim_eval_statusline(),
          and 'statuscolumn' sign segment/numhl highlights.
Solution: Add an additional `groups` element to the return value of
          `nvim_eval_statusline()->highlights`. This is an array of stacked
          highlight groups (highest priority last). Also resolve combined
          highlights for the 'statuscolumn' sign segment/numhl highlights.
          Expose/synchronize some drawline.c logic that is now mimicked in
          three different places.

Author: luukvbaal

runtime/doc/api.txt

@@ -672,7 +672,10 @@ nvim_eval_statusline({str}, {opts})                   *nvim_eval_statusline()*
           true. Each element of the array is a |Dict| with these keys:
           • start: (number) Byte index (0-based) of first character that uses
             the highlight.
-          • group: (string) Name of highlight group.
+          • group: (string) Name of highlight group. May be removed in the
+            future, use `groups` instead.
+          • groups: (array) Names of stacked highlight groups (highest
+            priority last).
 
 nvim_exec_lua({code}, {args})                                *nvim_exec_lua()*
     Execute Lua code. Parameters (if any) are available as `...` inside the

runtime/doc/news.txt

@@ -421,8 +421,10 @@ These existing features changed their behavior.
   using the upgraded implementation.
 
 • Custom highlights in 'rulerformat', 'statuscolumn', 'statusline', 'tabline',
-  'winbar' and the number column (through |:sign-define| `numhl`) now combine
-  with their respective highlight groups, as opposed to |hl-Normal|.
+  'winbar', and the sign/number column are stacked with their respective
+  highlight groups, as opposed to |hl-Normal|.
+  This is also reflected in the `highlights` from |nvim_eval_statusline()|,
+  with a new `groups` field containing an array of stacked highlight groups.
 
 • |vim.on_key()| callbacks won't be invoked recursively when a callback itself
   consumes input.

runtime/lua/vim/_meta/api.lua

@@ -28,6 +28,7 @@
 #include "nvim/context.h"
 #include "nvim/cursor.h"
 #include "nvim/decoration.h"
+#include "nvim/drawline.h"
 #include "nvim/drawscreen.h"
 #include "nvim/errors.h"
 #include "nvim/eval.h"
@@ -1983,7 +1984,9 @@ Array nvim_get_mark(String name, Dict(empty) *opts, Arena *arena, Error *err)
 ///                     the "highlights" key in {opts} is true. Each element of the array is a
 ///                     |Dict| with these keys:
 ///           - start: (number) Byte index (0-based) of first character that uses the highlight.
-///           - group: (string) Name of highlight group.
+///           - group: (string) Name of highlight group. May be removed in the future, use
+///           `groups` instead.
+///           - groups: (array) Names of stacked highlight groups (highest priority last).
 Dict nvim_eval_statusline(String str, Dict(eval_statusline) *opts, Arena *arena, Error *err)
   FUNC_API_SINCE(8) FUNC_API_FAST
 {
@@ -2035,6 +2038,7 @@ Dict nvim_eval_statusline(String str, Dict(eval_statusline) *opts, Arena *arena,
   });
 
   int stc_hl_id = 0;
+  int scl_hl_id = 0;
   statuscol_T statuscol = { 0 };
   SignTextAttrs sattrs[SIGN_SHOW_MAX] = { 0 };
 
@@ -2043,23 +2047,18 @@ Dict nvim_eval_statusline(String str, Dict(eval_statusline) *opts, Arena *arena,
     int cul_id = 0;
     int num_id = 0;
     linenr_T lnum = statuscol_lnum;
+    foldinfo_T cursorline_fi = { 0 };
     decor_redraw_signs(wp, wp->w_buffer, lnum - 1, sattrs, &line_id, &cul_id, &num_id);
 
     statuscol.sattrs = sattrs;
     statuscol.foldinfo = fold_info(wp, lnum);
-    wp->w_cursorline = win_cursorline_standout(wp) ? wp->w_cursor.lnum : 0;
+    win_update_cursorline(wp, &cursorline_fi);
+    statuscol.sign_cul_id = use_cursor_line_highlight(wp, lnum) ? cul_id : 0;
+    scl_hl_id = use_cursor_line_highlight(wp, lnum) ? HLF_CLS : HLF_SC;
 
-    if (wp->w_p_cul) {
-      if (statuscol.foldinfo.fi_level != 0 && statuscol.foldinfo.fi_lines > 0) {
-        wp->w_cursorline = statuscol.foldinfo.fi_lnum;
-      }
-      statuscol.use_cul = lnum == wp->w_cursorline && (wp->w_p_culopt_flags & kOptCuloptFlagNumber);
-    }
-
-    statuscol.sign_cul_id = statuscol.use_cul ? cul_id : 0;
     if (num_id) {
       stc_hl_id = num_id;
-    } else if (statuscol.use_cul) {
+    } else if (use_cursor_line_highlight(wp, lnum)) {
       stc_hl_id = HLF_CLN;
     } else if (wp->w_p_rnu) {
       stc_hl_id = (lnum < wp->w_cursor.lnum ? HLF_LNA : HLF_LNB);
@@ -2112,22 +2111,19 @@ Dict nvim_eval_statusline(String str, Dict(eval_statusline) *opts, Arena *arena,
 
     // If first character doesn't have a defined highlight,
     // add the default highlight at the beginning of the highlight list
+    const char *dfltname = get_default_stl_hl(opts->use_tabline ? NULL : wp,
+                                              opts->use_winbar, stc_hl_id);
     if (hltab->start == NULL || (hltab->start - buf) != 0) {
-      Dict hl_info = arena_dict(arena, 2);
-      const char *grpname = get_default_stl_hl(opts->use_tabline ? NULL : wp,
-                                               opts->use_winbar, stc_hl_id);
-
+      Dict hl_info = arena_dict(arena, 3);
       PUT_C(hl_info, "start", INTEGER_OBJ(0));
-      PUT_C(hl_info, "group", CSTR_AS_OBJ(grpname));
-
+      PUT_C(hl_info, "group", CSTR_AS_OBJ(dfltname));
+      Array groups = arena_array(arena, 1);
+      ADD_C(groups, CSTR_AS_OBJ(dfltname));
+      PUT_C(hl_info, "groups", ARRAY_OBJ(groups));
       ADD_C(hl_values, DICT_OBJ(hl_info));
     }
 
     for (stl_hlrec_t *sp = hltab; sp->start != NULL; sp++) {
-      Dict hl_info = arena_dict(arena, 2);
-
-      PUT_C(hl_info, "start", INTEGER_OBJ(sp->start - buf));
-
       const char *grpname;
       if (sp->userhl == 0) {
         grpname = get_default_stl_hl(opts->use_tabline ? NULL : wp, opts->use_winbar, stc_hl_id);
@@ -2137,7 +2133,18 @@ Dict nvim_eval_statusline(String str, Dict(eval_statusline) *opts, Arena *arena,
         snprintf(user_group, sizeof(user_group), "User%d", sp->userhl);
         grpname = arena_memdupz(arena, user_group, strlen(user_group));
       }
+
+      const char *combine = sp->item == STL_SIGNCOL ? syn_id2name(scl_hl_id)
+                                                    : sp->item == STL_FOLDCOL ? grpname : dfltname;
+      Dict hl_info = arena_dict(arena, 3);
+      PUT_C(hl_info, "start", INTEGER_OBJ(sp->start - buf));
       PUT_C(hl_info, "group", CSTR_AS_OBJ(grpname));
+      Array groups = arena_array(arena, 1 + (combine != grpname));
+      if (combine != grpname) {
+        ADD_C(groups, CSTR_AS_OBJ(combine));
+      }
+      ADD_C(groups, CSTR_AS_OBJ(grpname));
+      PUT_C(hl_info, "groups", ARRAY_OBJ(groups));
       ADD_C(hl_values, DICT_OBJ(hl_info));
     }
     PUT_C(result, "highlights", ARRAY_OBJ(hl_values));

src/nvim/api/vim.c

@@ -856,9 +856,9 @@ static const uint32_t sign_filter[4] = {[kMTMetaSignText] = kMTFilterSelect,
 /// Return the sign attributes on the currently refreshed row.
 ///
 /// @param[out] sattrs Output array for sign text and texthl id
-/// @param[out] line_attr Highest priority linehl id
-/// @param[out] cul_attr Highest priority culhl id
-/// @param[out] num_attr Highest priority numhl id
+/// @param[out] line_id Highest priority linehl id
+/// @param[out] cul_id Highest priority culhl id
+/// @param[out] num_id Highest priority numhl id
 void decor_redraw_signs(win_T *wp, buf_T *buf, int row, SignTextAttrs sattrs[], int *line_id,
                         int *cul_id, int *num_id)
 {

src/nvim/decoration.c

@@ -81,6 +81,8 @@ typedef struct {
   int cul_attr;              ///< set when 'cursorline' active
   int line_attr;             ///< attribute for the whole line
   int line_attr_lowprio;     ///< low-priority attribute for the line
+  int sign_num_attr;         ///< line number attribute (sign numhl)
+  int sign_cul_attr;         ///< cursorline sign attribute (sign culhl)
 
   int fromcol;               ///< start of inverting
   int tocol;                 ///< end of inverting
@@ -397,7 +399,7 @@ static void draw_col_fill(winlinevars_T *wlv, schar_T fillchar, int width, int a
 }
 
 /// Return true if CursorLineSign highlight is to be used.
-static bool use_cursor_line_highlight(win_T *wp, linenr_T lnum)
+bool use_cursor_line_highlight(win_T *wp, linenr_T lnum)
 {
   return wp->w_p_cul
          && lnum == wp->w_cursorline
@@ -460,16 +462,15 @@ void fill_foldcolumn(win_T *wp, foldinfo_T foldinfo, linenr_T lnum, int attr, in
 /// If "nrcol" is true, the sign is going to be displayed in the number column.
 /// Otherwise the sign is going to be displayed in the sign column. If there is no
 /// sign, draw blank cells instead.
-static void draw_sign(bool nrcol, win_T *wp, winlinevars_T *wlv, int sign_idx, int sign_cul_attr)
+static void draw_sign(bool nrcol, win_T *wp, winlinevars_T *wlv, int sign_idx)
 {
   SignTextAttrs sattr = wlv->sattrs[sign_idx];
   int scl_attr = win_hl_attr(wp, use_cursor_line_highlight(wp, wlv->lnum) ? HLF_CLS : HLF_SC);
 
   if (sattr.text[0] && wlv->row == wlv->startrow + wlv->filler_lines && wlv->filler_todo <= 0) {
-    int attr = (use_cursor_line_highlight(wp, wlv->lnum) && sign_cul_attr)
-               ? sign_cul_attr : sattr.hl_id ? syn_id2attr(sattr.hl_id) : 0;
-    attr = hl_combine_attr(scl_attr, attr);
     int fill = nrcol ? number_width(wp) + 1 : SIGN_WIDTH;
+    int attr = wlv->sign_cul_attr ? wlv->sign_cul_attr : sattr.hl_id ? syn_id2attr(sattr.hl_id) : 0;
+    attr = hl_combine_attr(scl_attr, attr);
     draw_col_fill(wlv, schar_from_ascii(' '), fill, attr);
     int sign_pos = wlv->off - SIGN_WIDTH - (int)nrcol;
     assert(sign_pos >= 0);
@@ -544,7 +545,7 @@ static int get_line_number_attr(win_T *wp, winlinevars_T *wlv)
 
 /// Display the absolute or relative line number.  After the first row fill with
 /// blanks when the 'n' flag isn't in 'cpo'.
-static void draw_lnum_col(win_T *wp, winlinevars_T *wlv, int sign_num_attr, int sign_cul_attr)
+static void draw_lnum_col(win_T *wp, winlinevars_T *wlv)
 {
   bool has_cpo_n = vim_strchr(p_cpo, CPO_NUMCOL) != NULL;
 
@@ -557,12 +558,12 @@ static void draw_lnum_col(win_T *wp, winlinevars_T *wlv, int sign_num_attr, int
     // then display the sign instead of the line number.
     if (wp->w_minscwidth == SCL_NUM && wlv->sattrs[0].text[0]
         && wlv->row == wlv->startrow + wlv->filler_lines && wlv->filler_todo <= 0) {
-      draw_sign(true, wp, wlv, 0, sign_cul_attr);
+      draw_sign(true, wp, wlv, 0);
     } else {
       // Draw the line number (empty space after wrapping).
       int width = number_width(wp) + 1;
       int attr = hl_combine_attr(get_line_number_attr(wp, wlv),
-                                 wlv->filler_todo <= 0 ? sign_num_attr : 0);
+                                 wlv->filler_todo <= 0 ? wlv->sign_num_attr : 0);
       if (wlv->row == wlv->startrow + wlv->filler_lines
           && (wp->w_skipcol == 0 || wlv->row > 0 || (wp->w_p_nu && wp->w_p_rnu))) {
         char buf[32];
@@ -631,22 +632,25 @@ static void draw_statuscol(win_T *wp, winlinevars_T *wlv, linenr_T lnum, int vir
 
   char *p = buf;
   char transbuf[MAXPATHL];
-  int attr = stcp->num_attr;
   size_t len = strlen(buf);
+  int scl_attr = win_hl_attr(wp, use_cursor_line_highlight(wp, wlv->lnum) ? HLF_CLS : HLF_SC);
+  int num_attr = hl_combine_attr(get_line_number_attr(wp, wlv),
+                                 wlv->filler_todo <= 0 ? wlv->sign_num_attr : 0);
+  int cur_attr = num_attr;
 
   // Draw each segment with the specified highlighting.
   for (stl_hlrec_t *sp = stcp->hlrec; sp->start != NULL; sp++) {
     ptrdiff_t textlen = sp->start - p;
     // Make all characters printable.
     size_t translen = transstr_buf(p, textlen, transbuf, MAXPATHL, true);
-    draw_col_buf(wp, wlv, transbuf, translen, attr, false);
+    draw_col_buf(wp, wlv, transbuf, translen, cur_attr, false);
+    int attr = sp->item == STL_SIGNCOL ? scl_attr : sp->item == STL_FOLDCOL ? 0 : num_attr;
+    cur_attr = hl_combine_attr(attr, sp->userhl < 0 ? syn_id2attr(-sp->userhl) : 0);
     p = sp->start;
-    int hl = sp->userhl;
-    attr = hl < 0 ? hl_combine_attr(stcp->num_attr, syn_id2attr(-hl)) : stcp->num_attr;
   }
   size_t translen = transstr_buf(p, buf + len - p, transbuf, MAXPATHL, true);
-  draw_col_buf(wp, wlv, transbuf, translen, attr, false);
-  draw_col_fill(wlv, schar_from_ascii(' '), stcp->width - width, stcp->num_attr);
+  draw_col_buf(wp, wlv, transbuf, translen, num_attr, false);
+  draw_col_fill(wlv, schar_from_ascii(' '), stcp->width - width, num_attr);
 }
 
 static void handle_breakindent(win_T *wp, winlinevars_T *wlv)
@@ -1201,11 +1205,10 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s
     area_highlighting = true;
   }
 
-  int line_attr = 0;
-  int sign_cul_attr = 0;
-  int sign_num_attr = 0;
+  int sign_line_attr = 0;
   // TODO(bfredl, vigoux): line_attr should not take priority over decoration!
-  decor_redraw_signs(wp, buf, wlv.lnum - 1, wlv.sattrs, &line_attr, &sign_cul_attr, &sign_num_attr);
+  decor_redraw_signs(wp, buf, wlv.lnum - 1, wlv.sattrs,
+                     &sign_line_attr, &wlv.sign_cul_attr, &wlv.sign_num_attr);
 
   statuscol_T statuscol = { 0 };
   if (*wp->w_p_stc != NUL) {
@@ -1214,19 +1217,15 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s
     statuscol.sattrs = wlv.sattrs;
     statuscol.foldinfo = foldinfo;
     statuscol.width = win_col_off(wp) - (wp == cmdwin_win);
-    statuscol.use_cul = use_cursor_line_highlight(wp, lnum);
-    statuscol.sign_cul_id = statuscol.use_cul ? sign_cul_attr : 0;
-    statuscol.num_attr = sign_num_attr > 0 ? syn_id2attr(sign_num_attr) : 0;
-  } else {
-    if (sign_cul_attr > 0) {
-      sign_cul_attr = syn_id2attr(sign_cul_attr);
-    }
-    if (sign_num_attr > 0) {
-      sign_num_attr = syn_id2attr(sign_num_attr);
-    }
+    statuscol.sign_cul_id = use_cursor_line_highlight(wp, lnum) ? wlv.sign_cul_attr : 0;
+  } else if (wlv.sign_cul_attr > 0) {
+    wlv.sign_cul_attr = use_cursor_line_highlight(wp, lnum) ? syn_id2attr(wlv.sign_cul_attr) : 0;
   }
-  if (line_attr > 0) {
-    wlv.line_attr = syn_id2attr(line_attr);
+  if (wlv.sign_num_attr > 0) {
+    wlv.sign_num_attr = syn_id2attr(wlv.sign_num_attr);
+  }
+  if (sign_line_attr > 0) {
+    wlv.line_attr = syn_id2attr(sign_line_attr);
   }
 
   // Highlight the current line in the quickfix window.
@@ -1549,9 +1548,6 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s
         // skip columns
       } else if (statuscol.draw) {
         // Draw 'statuscolumn' if it is set.
-        if (sign_num_attr == 0) {
-          statuscol.num_attr = get_line_number_attr(wp, &wlv);
-        }
         const int v = (int)(ptr - line);
         draw_statuscol(wp, &wlv, lnum, wlv.row - startrow - wlv.filler_lines, col_rows, &statuscol);
         if (wp->w_redr_statuscol) {
@@ -1568,10 +1564,10 @@ int win_line(win_T *wp, linenr_T lnum, int startrow, int endrow, int col_rows, s
 
         // wp->w_scwidth is zero if signcol=number is used
         for (int sign_idx = 0; sign_idx < wp->w_scwidth; sign_idx++) {
-          draw_sign(false, wp, &wlv, sign_idx, sign_cul_attr);
+          draw_sign(false, wp, &wlv, sign_idx);
         }
 
-        draw_lnum_col(wp, &wlv, sign_num_attr, sign_cul_attr);
+        draw_lnum_col(wp, &wlv);
       }
 
       win_col_offset = wlv.off;

src/nvim/drawline.c

@@ -2029,14 +2029,7 @@ static void win_update(win_T *wp)
   }
 
   foldinfo_T cursorline_fi = { 0 };
-  wp->w_cursorline = win_cursorline_standout(wp) ? wp->w_cursor.lnum : 0;
-  if (wp->w_p_cul) {
-    // Make sure that the cursorline on a closed fold is redrawn
-    cursorline_fi = fold_info(wp, wp->w_cursor.lnum);
-    if (cursorline_fi.fi_level != 0 && cursorline_fi.fi_lines > 0) {
-      wp->w_cursorline = cursorline_fi.fi_lnum;
-    }
-  }
+  win_update_cursorline(wp, &cursorline_fi);
 
   win_check_ns_hl(wp);
 
@@ -2862,3 +2855,18 @@ bool win_cursorline_standout(const win_T *wp)
 {
   return wp->w_p_cul || (wp->w_p_cole > 0 && !conceal_cursor_line(wp));
 }
+
+/// Update w_cursorline, taking care to set it to the to the start of a closed fold.
+///
+/// @param[out] foldinfo foldinfo for the cursor line
+void win_update_cursorline(win_T *wp, foldinfo_T *foldinfo)
+{
+  wp->w_cursorline = win_cursorline_standout(wp) ? wp->w_cursor.lnum : 0;
+  if (wp->w_p_cul) {
+    // Make sure that the cursorline on a closed fold is redrawn
+    *foldinfo = fold_info(wp, wp->w_cursor.lnum);
+    if (foldinfo->fi_level != 0 && foldinfo->fi_lines > 0) {
+      wp->w_cursorline = foldinfo->fi_lnum;
+    }
+  }
+}