patch 9.2.0289: 'linebreak' may lead to wrong Visual block highlighting

Problem:  'linebreak' may lead to wrong Visual block highlighting when
          end char occupies multiple cells (after 7.4.467).
Solution: Exclude 'linebreak' from the ending column instead of setting
          'virtualedit' temporarily (zeertzjq).

fixes:  #19898
closes: #19900

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

Author: zeertzjq

src/change.c

@@ -1263,7 +1263,7 @@ ins_char_bytes(char_u *buf, int charlen)
 	    // characters (zero if it's a TAB).  Count the number of bytes to
 	    // be deleted to make room for the new character, counting screen
 	    // cells.  May result in adding spaces to fill a gap.
-	    getvcol(curwin, &curwin->w_cursor, NULL, &vcol, NULL);
+	    getvcol(curwin, &curwin->w_cursor, NULL, &vcol, NULL, 0);
 	    new_vcol = vcol + chartabsize(buf, vcol);
 	    while (oldp[col + oldlen] != NUL && vcol < new_vcol)
 	    {

src/charset.c

@@ -905,7 +905,7 @@ win_linetabsize_cts(chartabsize_T *cts, colnr_T len)
     for ( ; *cts->cts_ptr != NUL && (len == MAXCOL || cts->cts_ptr < cts->cts_line + len);
 						      MB_PTR_ADV(cts->cts_ptr))
     {
-	vcol += win_lbr_chartabsize(cts, NULL);
+	vcol += win_lbr_chartabsize(cts, NULL, NULL);
 	if (vcol > MAXCOL)
 	{
 	    cts->cts_vcol = MAXCOL;
@@ -919,7 +919,7 @@ win_linetabsize_cts(chartabsize_T *cts, colnr_T len)
     if (len == MAXCOL && cts->cts_has_prop_with_text && *cts->cts_ptr == NUL)
     {
 	int head = 0;
-	(void)win_lbr_chartabsize(cts, &head);
+	(void)win_lbr_chartabsize(cts, &head, NULL);
 	vcol += cts->cts_cur_text_width + head;
 	// when properties are above or below the empty line must also be
 	// counted
@@ -1186,7 +1186,7 @@ lbr_chartabsize(chartabsize_T *cts)
 	RET_WIN_BUF_CHARTABSIZE(curwin, curbuf, cts->cts_ptr, cts->cts_vcol)
 #if defined(FEAT_LINEBREAK) || defined(FEAT_PROP_POPUP)
     }
-    return win_lbr_chartabsize(cts, NULL);
+    return win_lbr_chartabsize(cts, NULL, NULL);
 #endif
 }
 
@@ -1209,19 +1209,24 @@ lbr_chartabsize_adv(chartabsize_T *cts)
  * inserts text.
  * This function is used very often, keep it fast!!!!
  *
- * If "headp" not NULL, set "*headp" to the size of 'showbreak'/'breakindent'
+ * If "headp" isn't NULL, set "*headp" to the size of 'showbreak'/'breakindent'
  * included in the return value.
  * When "cts->cts_max_head_vcol" is positive, only count in "*headp" the size
  * of 'showbreak'/'breakindent' before "cts->cts_max_head_vcol".
  * When "cts->cts_max_head_vcol" is negative, only count in "*headp" the size
  * of 'showbreak'/'breakindent' before where cursor should be placed.
  *
- * Warning: "*headp" may not be set if it's 0, init to 0 before calling.
+ * If "tailp" isn't NULL, set "*tailp" to the size of 'linebreak' included in
+ * the return value.
+ *
+ * Warning: "*headp" and "*tailp" may not be set if the value is 0, init to 0
+ * before calling.
  */
     int
 win_lbr_chartabsize(
 	chartabsize_T	*cts,
-	int		*headp UNUSED)
+	int		*headp UNUSED,
+	int		*tailp UNUSED)
 {
     win_T	*wp = cts->cts_win;
 #if defined(FEAT_PROP_POPUP) || defined(FEAT_LINEBREAK)
@@ -1470,6 +1475,7 @@ win_lbr_chartabsize(
     if (headp != NULL)
 	*headp = head;
 
+    int size_before_lbr = size;
     int need_lbr = FALSE;
     /*
      * If 'linebreak' set check at a blank before a non-blank if the line
@@ -1522,6 +1528,9 @@ win_lbr_chartabsize(
 	}
     }
 
+    if (tailp != NULL)
+	*tailp = size - size_before_lbr;
+
 #  ifdef FEAT_PROP_POPUP
     size += cts->cts_first_char;
 #  endif
@@ -1598,6 +1607,10 @@ in_win_border(win_T *wp, colnr_T vcol)
  * cursor: where the cursor is on this character (first char, except for TAB)
  *    end: on the last position of this character (TAB, ctrl)
  *
+ * When 'linebreak' follows this character, "end" is set to the position before
+ * 'linebreak' if "flags" contains GETVCOL_END_EXCL_LBR, otherwise it's set to
+ * the end of 'linebreak'.
+ *
  * This is used very often, keep it fast!
  */
     void
@@ -1606,13 +1619,15 @@ getvcol(
     pos_T	*pos,
     colnr_T	*start,
     colnr_T	*cursor,
-    colnr_T	*end)
+    colnr_T	*end,
+    int		flags)
 {
     colnr_T	vcol;
     char_u	*ptr;		// points to current char
     char_u	*line;		// start of the line
     int		incr;
     int		head;
+    int		tail;
 #ifdef FEAT_VARTABS
     int		*vts = wp->w_buffer->b_p_vts_array;
 #endif
@@ -1693,6 +1708,8 @@ getvcol(
 	    vcol += incr;
 	    ptr = next_ptr;
 	}
+
+	tail = 0;
     }
     else
     {
@@ -1701,7 +1718,8 @@ getvcol(
 	    // A tab gets expanded, depending on the current column.
 	    // Other things also take up space.
 	    head = 0;
-	    incr = win_lbr_chartabsize(&cts, &head);
+	    tail = 0;
+	    incr = win_lbr_chartabsize(&cts, &head, &tail);
 	    // make sure we don't go past the end of the line
 	    if (*cts.cts_ptr == NUL)
 	    {
@@ -1736,7 +1754,7 @@ getvcol(
     if (start != NULL)
 	*start = vcol + head;
     if (end != NULL)
-	*end = vcol + incr - 1;
+	*end = vcol + incr - (flags & GETVCOL_END_EXCL_LBR ? tail : 0) - 1;
     if (cursor != NULL)
     {
 	if (*ptr == TAB
@@ -1746,6 +1764,7 @@ getvcol(
 		&& !(VIsual_active
 				&& (*p_sel == 'e' || LTOREQ_POS(*pos, VIsual)))
 		)
+	    // TODO: subtracting "tail" may lead to better cursor position
 	    *cursor = vcol + incr - 1;	    // cursor at end
 	else
 	{
@@ -1775,9 +1794,9 @@ getvcol_nolist(pos_T *posp)
 
     curwin->w_p_list = FALSE;
     if (posp->coladd)
-	getvvcol(curwin, posp, NULL, &vcol, NULL);
+	getvvcol(curwin, posp, NULL, &vcol, NULL, 0);
     else
-	getvcol(curwin, posp, NULL, &vcol, NULL);
+	getvcol(curwin, posp, NULL, &vcol, NULL, 0);
     curwin->w_p_list = list_save;
     return vcol;
 }
@@ -1791,7 +1810,8 @@ getvvcol(
     pos_T	*pos,
     colnr_T	*start,
     colnr_T	*cursor,
-    colnr_T	*end)
+    colnr_T	*end,
+    int		flags)
 {
     colnr_T	col;
     colnr_T	coladd;
@@ -1801,7 +1821,7 @@ getvvcol(
     if (virtual_active())
     {
 	// For virtual mode, only want one value
-	getvcol(wp, pos, &col, NULL, NULL);
+	getvcol(wp, pos, &col, NULL, NULL, flags);
 
 	coladd = pos->coladd;
 	endadd = 0;
@@ -1829,7 +1849,7 @@ getvvcol(
 	    *end = col + endadd;
     }
     else
-	getvcol(wp, pos, start, cursor, end);
+	getvcol(wp, pos, start, cursor, end, flags);
 }
 
 /*
@@ -1842,19 +1862,20 @@ getvcols(
     pos_T	*pos1,
     pos_T	*pos2,
     colnr_T	*left,
-    colnr_T	*right)
+    colnr_T	*right,
+    int		flags)
 {
     colnr_T	from1, from2, to1, to2;
 
     if (LT_POSP(pos1, pos2))
     {
-	getvvcol(wp, pos1, &from1, NULL, &to1);
-	getvvcol(wp, pos2, &from2, NULL, &to2);
+	getvvcol(wp, pos1, &from1, NULL, &to1, flags);
+	getvvcol(wp, pos2, &from2, NULL, &to2, flags);
     }
     else
     {
-	getvvcol(wp, pos2, &from1, NULL, &to1);
-	getvvcol(wp, pos1, &from2, NULL, &to2);
+	getvvcol(wp, pos2, &from1, NULL, &to1, flags);
+	getvvcol(wp, pos1, &from2, NULL, &to2, flags);
     }
     if (from2 < from1)
 	*left = from2;

src/cindent.c

@@ -978,7 +978,7 @@ get_indent_nolabel (linenr_T lnum)	// XXX
 
     fp.col = (colnr_T)(p - l);
     fp.lnum = lnum;
-    getvcol(curwin, &fp, &col, NULL, NULL);
+    getvcol(curwin, &fp, &col, NULL, NULL, 0);
     return (int)col;
 }
 
@@ -1062,7 +1062,7 @@ cin_first_id_amount(void)
     p = skipwhite(p + len);
     fp.lnum = curwin->w_cursor.lnum;
     fp.col = (colnr_T)(p - line);
-    getvcol(curwin, &fp, &col, NULL, NULL);
+    getvcol(curwin, &fp, &col, NULL, NULL, 0);
     return (int)col;
 }
 
@@ -1110,7 +1110,7 @@ cin_get_equal_amount(linenr_T lnum)
 
     fp.lnum = lnum;
     fp.col = (colnr_T)(s - line);
-    getvcol(curwin, &fp, &col, NULL, NULL);
+    getvcol(curwin, &fp, &col, NULL, NULL, 0);
     return (int)col;
 }
 
@@ -1705,7 +1705,7 @@ get_baseclass_amount(int col)
     else
     {
 	curwin->w_cursor.col = col;
-	getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL);
+	getvcol(curwin, &curwin->w_cursor, &vcol, NULL, NULL, 0);
 	amount = (int)vcol;
     }
     if (amount < curbuf->b_ind_cpp_baseclass)
@@ -2265,7 +2265,7 @@ get_c_indent(void)
 	if (trypos  != NULL)
 	{
 	    // find how indented the line beginning the comment is
-	    getvcol(curwin, trypos, &col, NULL, NULL);
+	    getvcol(curwin, trypos, &col, NULL, NULL, 0);
 	    amount = col;
 	    goto theend;
 	}
@@ -2287,7 +2287,7 @@ get_c_indent(void)
 	int	done = FALSE;
 
 	// find how indented the line beginning the comment is
-	getvcol(curwin, comment_pos, &col, NULL, NULL);
+	getvcol(curwin, comment_pos, &col, NULL, NULL, 0);
 	amount = col;
 	*lead_start = NUL;
 	*lead_middle = NUL;
@@ -2413,7 +2413,7 @@ get_c_indent(void)
 		    if (*look != NUL)		    // if something after it
 			comment_pos->col = (colnr_T)(skipwhite(look) - start);
 		}
-		getvcol(curwin, comment_pos, &col, NULL, NULL);
+		getvcol(curwin, comment_pos, &col, NULL, NULL, 0);
 		amount = col;
 		if (curbuf->b_ind_in_comment2 || *look == NUL)
 		    amount += curbuf->b_ind_in_comment;
@@ -2615,7 +2615,7 @@ get_c_indent(void)
 		// if we did the above "if".
 		if (our_paren_pos.col > 0)
 		{
-		    getvcol(curwin, &our_paren_pos, &col, NULL, NULL);
+		    getvcol(curwin, &our_paren_pos, &col, NULL, NULL, 0);
 		    if (cur_amount > (int)col)
 			cur_amount = col;
 		}
@@ -2704,7 +2704,7 @@ get_c_indent(void)
 	look = skipwhite(start);
 	if (*look == '{')
 	{
-	    getvcol(curwin, trypos, &col, NULL, NULL);
+	    getvcol(curwin, trypos, &col, NULL, NULL, 0);
 	    amount = col;
 	    if (*start == '{')
 		start_brace = BRACE_IN_COL0;

src/drawline.c

@@ -1418,7 +1418,8 @@ win_line(
 			wlv.fromcol = 0;
 		    else
 		    {
-			getvvcol(wp, top, (colnr_T *)&wlv.fromcol, NULL, NULL);
+			getvvcol(wp, top, (colnr_T *)&wlv.fromcol,
+								NULL, NULL, 0);
 			if (gchar_pos(top) == NUL)
 			    wlv.tocol = wlv.fromcol + 1;
 		    }
@@ -1437,11 +1438,11 @@ win_line(
 			pos = *bot;
 			if (*p_sel == 'e')
 			    getvvcol(wp, &pos, (colnr_T *)&wlv.tocol,
-								   NULL, NULL);
+								NULL, NULL, 0);
 			else
 			{
 			    getvvcol(wp, &pos, NULL, NULL,
-							(colnr_T *)&wlv.tocol);
+						     (colnr_T *)&wlv.tocol, 0);
 			    ++wlv.tocol;
 			}
 		    }
@@ -1480,14 +1481,14 @@ win_line(
 	{
 	    if (lnum == curwin->w_cursor.lnum)
 		getvcol(curwin, &(curwin->w_cursor),
-					  (colnr_T *)&wlv.fromcol, NULL, NULL);
+				       (colnr_T *)&wlv.fromcol, NULL, NULL, 0);
 	    else
 		wlv.fromcol = 0;
 	    if (lnum == curwin->w_cursor.lnum + search_match_lines)
 	    {
 		pos.lnum = lnum;
 		pos.col = search_match_endcol;
-		getvcol(curwin, &pos, (colnr_T *)&wlv.tocol, NULL, NULL);
+		getvcol(curwin, &pos, (colnr_T *)&wlv.tocol, NULL, NULL, 0);
 	    }
 	    else
 		wlv.tocol = MAXCOL;
@@ -1761,7 +1762,7 @@ win_line(
     {
 	chartabsize_T cts;
 	init_chartabsize_arg(&cts, wp, lnum, 0, line, line);
-	(void)win_lbr_chartabsize(&cts, NULL);
+	(void)win_lbr_chartabsize(&cts, NULL, NULL);
 	vcol_first_char = cts.cts_first_char;
 	clear_chartabsize_arg(&cts);
     }
@@ -1785,7 +1786,7 @@ win_line(
 	while (cts.cts_vcol < v)
 	{
 	    head = 0;
-	    charsize = win_lbr_chartabsize(&cts, &head);
+	    charsize = win_lbr_chartabsize(&cts, &head, NULL);
 	    cts.cts_vcol += charsize;
 	    prev_ptr = cts.cts_ptr;
 	    if (*prev_ptr == NUL)
@@ -3120,7 +3121,8 @@ win_line(
 		    // do not want virtual text counted here
 		    cts.cts_has_prop_with_text = FALSE;
 # endif
-		    wlv.n_extra = win_lbr_chartabsize(&cts, NULL) - 1;
+		    // TODO: consider using "tailp" here
+		    wlv.n_extra = win_lbr_chartabsize(&cts, NULL, NULL) - 1;
 		    clear_chartabsize_arg(&cts);
 
 		    if (on_last_col && c != TAB)
@@ -3780,7 +3782,7 @@ win_line(
 	    colnr_T tcol;
 
 	    if (preedit_end_col == MAXCOL)
-		getvcol(curwin, &(wp->w_cursor), &tcol, NULL, NULL);
+		getvcol(curwin, &(wp->w_cursor), &tcol, NULL, NULL, 0);
 	    else
 		tcol = preedit_end_col;
 	    if ((long)preedit_start_col <= wlv.vcol && wlv.vcol < (long)tcol)