patch 8.1.1071: cannot get composing characters from the screen
Problem: Cannot get composing characters from the screen.
Solution: Add screenchars() and screenstring(). (partly by Ozaki Kiichi,
closes #4059)
diff --git a/src/evalfunc.c b/src/evalfunc.c
index 6aff499..06f8155 100644
--- a/src/evalfunc.c
+++ b/src/evalfunc.c
@@ -344,8 +344,10 @@
#endif
static void f_screenattr(typval_T *argvars, typval_T *rettv);
static void f_screenchar(typval_T *argvars, typval_T *rettv);
+static void f_screenchars(typval_T *argvars, typval_T *rettv);
static void f_screencol(typval_T *argvars, typval_T *rettv);
static void f_screenrow(typval_T *argvars, typval_T *rettv);
+static void f_screenstring(typval_T *argvars, typval_T *rettv);
static void f_search(typval_T *argvars, typval_T *rettv);
static void f_searchdecl(typval_T *argvars, typval_T *rettv);
static void f_searchpair(typval_T *argvars, typval_T *rettv);
@@ -839,8 +841,10 @@
#endif
{"screenattr", 2, 2, f_screenattr},
{"screenchar", 2, 2, f_screenchar},
+ {"screenchars", 2, 2, f_screenchars},
{"screencol", 0, 0, f_screencol},
{"screenrow", 0, 0, f_screenrow},
+ {"screenstring", 2, 2, f_screenstring},
{"search", 1, 4, f_search},
{"searchdecl", 1, 3, f_searchdecl},
{"searchpair", 3, 7, f_searchpair},
@@ -10430,8 +10434,7 @@
row = (int)tv_get_number_chk(&argvars[0], NULL) - 1;
col = (int)tv_get_number_chk(&argvars[1], NULL) - 1;
- if (row < 0 || row >= screen_Rows
- || col < 0 || col >= screen_Columns)
+ if (row < 0 || row >= screen_Rows || col < 0 || col >= screen_Columns)
c = -1;
else
{
@@ -10445,6 +10448,39 @@
}
/*
+ * "screenchars()" function
+ */
+ static void
+f_screenchars(typval_T *argvars, typval_T *rettv)
+{
+ int row;
+ int col;
+ int off;
+ int c;
+ int i;
+
+ if (rettv_list_alloc(rettv) == FAIL)
+ return;
+ row = (int)tv_get_number_chk(&argvars[0], NULL) - 1;
+ col = (int)tv_get_number_chk(&argvars[1], NULL) - 1;
+ if (row < 0 || row >= screen_Rows || col < 0 || col >= screen_Columns)
+ return;
+
+ off = LineOffset[row] + col;
+ if (enc_utf8 && ScreenLinesUC[off] != 0)
+ c = ScreenLinesUC[off];
+ else
+ c = ScreenLines[off];
+ list_append_number(rettv->vval.v_list, (varnumber_T)c);
+
+ if (enc_utf8)
+
+ for (i = 0; i < Screen_mco && ScreenLinesC[i][off] != 0; ++i)
+ list_append_number(rettv->vval.v_list,
+ (varnumber_T)ScreenLinesC[i][off]);
+}
+
+/*
* "screencol()" function
*
* First column is 1 to be consistent with virtcol().
@@ -10465,6 +10501,43 @@
}
/*
+ * "screenstring()" function
+ */
+ static void
+f_screenstring(typval_T *argvars, typval_T *rettv)
+{
+ int row;
+ int col;
+ int off;
+ int c;
+ int i;
+ char_u buf[MB_MAXBYTES + 1];
+ int buflen = 0;
+
+ rettv->vval.v_string = NULL;
+ rettv->v_type = VAR_STRING;
+
+ row = (int)tv_get_number_chk(&argvars[0], NULL) - 1;
+ col = (int)tv_get_number_chk(&argvars[1], NULL) - 1;
+ if (row < 0 || row >= screen_Rows || col < 0 || col >= screen_Columns)
+ return;
+
+ off = LineOffset[row] + col;
+ if (enc_utf8 && ScreenLinesUC[off] != 0)
+ c = ScreenLinesUC[off];
+ else
+ c = ScreenLines[off];
+ buflen += mb_char2bytes(c, buf);
+
+ if (enc_utf8)
+ for (i = 0; i < Screen_mco && ScreenLinesC[i][off] != 0; ++i)
+ buflen += mb_char2bytes(ScreenLinesC[i][off], buf + buflen);
+
+ buf[buflen] = NUL;
+ rettv->vval.v_string = vim_strsave(buf);
+}
+
+/*
* "search()" function
*/
static void
diff --git a/src/testdir/test_utf8.vim b/src/testdir/test_utf8.vim
index 8a71f50..98793c3 100644
--- a/src/testdir/test_utf8.vim
+++ b/src/testdir/test_utf8.vim
@@ -1,5 +1,6 @@
" Tests for Unicode manipulations
+source view_util.vim
" Visual block Insert adjusts for multi-byte char
func Test_visual_block_insert()
@@ -60,3 +61,37 @@
call assert_equal(2, virtcol("'["))
call assert_equal(2, virtcol("']"))
endfunc
+
+func Test_screenchar_utf8()
+ new
+
+ " 1-cell, with composing characters
+ call setline(1, ["ABC\u0308"])
+ redraw
+ call assert_equal([0x0041], screenchars(1, 1))
+ call assert_equal([0x0042], screenchars(1, 2))
+ call assert_equal([0x0043, 0x0308], screenchars(1, 3))
+ call assert_equal("A", screenstring(1, 1))
+ call assert_equal("B", screenstring(1, 2))
+ call assert_equal("C\u0308", screenstring(1, 3))
+
+ " 2-cells, with composing characters
+ let text = "\u3042\u3044\u3046\u3099"
+ call setline(1, text)
+ redraw
+ call assert_equal([0x3042], screenchars(1, 1))
+ call assert_equal([0], screenchars(1, 2))
+ call assert_equal([0x3044], screenchars(1, 3))
+ call assert_equal([0], screenchars(1, 4))
+ call assert_equal([0x3046, 0x3099], screenchars(1, 5))
+
+ call assert_equal("\u3042", screenstring(1, 1))
+ call assert_equal("", screenstring(1, 2))
+ call assert_equal("\u3044", screenstring(1, 3))
+ call assert_equal("", screenstring(1, 4))
+ call assert_equal("\u3046\u3099", screenstring(1, 5))
+
+ call assert_equal([text . ' '], ScreenLinesUtf8(1, 8))
+
+ bwipe!
+endfunc
diff --git a/src/testdir/view_util.vim b/src/testdir/view_util.vim
index 29ea073..34b4519 100644
--- a/src/testdir/view_util.vim
+++ b/src/testdir/view_util.vim
@@ -5,6 +5,7 @@
finish
endif
+" Get text on the screen, without composing characters.
" ScreenLines(lnum, width) or
" ScreenLines([start, end], width)
function! ScreenLines(lnum, width) abort
@@ -23,6 +24,25 @@
return lines
endfunction
+" Get text on the screen, including composing characters.
+" ScreenLines(lnum, width) or
+" ScreenLines([start, end], width)
+function! ScreenLinesUtf8(lnum, width) abort
+ redraw!
+ if type(a:lnum) == v:t_list
+ let start = a:lnum[0]
+ let end = a:lnum[1]
+ else
+ let start = a:lnum
+ let end = a:lnum
+ endif
+ let lines = []
+ for l in range(start, end)
+ let lines += [join(map(range(1, a:width), 'screenstring(l, v:val)'), '')]
+ endfor
+ return lines
+endfunction
+
function! ScreenAttrs(lnum, width) abort
redraw!
if type(a:lnum) == v:t_list
diff --git a/src/version.c b/src/version.c
index 94fb6f6..637a3fb 100644
--- a/src/version.c
+++ b/src/version.c
@@ -776,6 +776,8 @@
static int included_patches[] =
{ /* Add new patch number below this line */
/**/
+ 1071,
+/**/
1070,
/**/
1069,