Mercurial > vim
changeset 29024:9f25e0ed831d v8.2.5034
patch 8.2.5034: there is no way to get the byte index from a virtual column
Commit: https://github.com/vim/vim/commit/5a6ec10cc80ab02eeff644ab19b82312630ea855
Author: Bram Moolenaar <Bram@vim.org>
Date: Fri May 27 21:58:00 2022 +0100
patch 8.2.5034: there is no way to get the byte index from a virtual column
Problem: There is no way to get the byte index from a virtual column.
Solution: Add virtcol2col(). (Yegappan Lakshmanan, closes https://github.com/vim/vim/issues/10477,
closes #10098)
| author | Bram Moolenaar <Bram@vim.org> |
|---|---|
| date | Fri, 27 May 2022 23:00:03 +0200 |
| parents | b7960e26a397 |
| children | 81a69e9445c8 |
| files | runtime/doc/builtin.txt runtime/doc/usr_41.txt src/evalfunc.c src/move.c src/proto/move.pro src/testdir/test_cursor_func.vim src/version.c |
| diffstat | 7 files changed, 89 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -691,6 +691,8 @@ uniq({list} [, {func} [, {dict}]]) values({dict}) List values in {dict} virtcol({expr} [, {list}]) Number or List screen column of cursor or mark +virtcol2col({winid}, {lnum}, {col}) + Number byte index of a character on screen visualmode([expr]) String last visual mode used wildmenumode() Number whether 'wildmenu' mode is active win_execute({id}, {command} [, {silent}]) @@ -6211,11 +6213,17 @@ nr2char({expr} [, {utf8}]) *nr2char() or({expr}, {expr}) *or()* Bitwise OR on the two arguments. The arguments are converted to a number. A List, Dict or Float argument causes an error. + Also see `and()` and `xor()`. Example: > :let bits = or(bits, 0x80) < Can also be used as a |method|: > :let bits = bits->or(0x80) +< Rationale: The reason this is a function and not using the "|" + character like many languages, is that Vi has always used "|" + to separate commands. In many places it would not be clear if + "|" is an operator or a command separator. + pathshorten({path} [, {len}]) *pathshorten()* Shorten directory names in the path {path} and return the @@ -9788,6 +9796,25 @@ virtcol({expr} [, {list}]) *virtcol() < Can also be used as a |method|: > GetPos()->virtcol() +virtcol2col({winid}, {lnum}, {col}) *virtcol2col()* + The result is a Number, which is the byte index of the + character in window {winid} at buffer line {lnum} and virtual + column {col}. + + If {col} is greater than the last virtual column in line + {lnum}, then the byte index of the character at the last + virtual column is returned. + + The {winid} argument can be the window number or the + |window-ID|. If this is zero, then the current window is used. + + Returns -1 if the window {winid} doesn't exist or the buffer + line {lnum} or virtual column {col} is invalid. + + See also |screenpos()|, |virtcol()| and |col()|. + + Can also be used as a |method|: > + GetWinid()->virtcol2col(lnum, col) visualmode([{expr}]) *visualmode()* The result is a String, which describes the last Visual mode @@ -10220,6 +10247,7 @@ writefile({object}, {fname} [, {flags}]) xor({expr}, {expr}) *xor()* Bitwise XOR on the two arguments. The arguments are converted to a number. A List, Dict or Float argument causes an error. + Also see `and()` and `or()`. Example: > :let bits = xor(bits, 0x80) <
--- a/runtime/doc/usr_41.txt +++ b/runtime/doc/usr_41.txt @@ -835,6 +835,7 @@ Cursor and mark position: *cursor-funct screencol() get screen column of the cursor screenrow() get screen row of the cursor screenpos() screen row and col of a text character + virtcol2col() byte index of a text character on screen getcurpos() get position of the cursor getpos() get position of cursor, mark, etc. setpos() set position of cursor, mark, etc.
--- a/src/evalfunc.c +++ b/src/evalfunc.c @@ -2682,6 +2682,8 @@ static funcentry_T global_functions[] = ret_list_any, f_values}, {"virtcol", 1, 2, FEARG_1, arg2_string_or_list_bool, ret_virtcol, f_virtcol}, + {"virtcol2col", 3, 3, FEARG_1, arg3_number, + ret_number, f_virtcol2col}, {"visualmode", 0, 1, 0, arg1_bool, ret_string, f_visualmode}, {"wildmenumode", 0, 0, 0, NULL,
--- a/src/move.c +++ b/src/move.c @@ -1322,6 +1322,39 @@ f_screenpos(typval_T *argvars UNUSED, ty dict_add_number(dict, "curscol", ccol); dict_add_number(dict, "endcol", ecol); } + +/* + * "virtcol2col({winid}, {lnum}, {col})" function + */ + void +f_virtcol2col(typval_T *argvars UNUSED, typval_T *rettv) +{ + win_T *wp; + linenr_T lnum; + int screencol; + int error = FALSE; + + rettv->vval.v_number = -1; + + if (check_for_number_arg(argvars, 0) == FAIL + || check_for_number_arg(argvars, 1) == FAIL + || check_for_number_arg(argvars, 2) == FAIL) + return; + + wp = find_win_by_nr_or_id(&argvars[0]); + if (wp == NULL) + return; + + lnum = tv_get_number_chk(&argvars[1], &error); + if (error || lnum < 0 || lnum > wp->w_buffer->b_ml.ml_line_count) + return; + + screencol = tv_get_number_chk(&argvars[2], &error); + if (error || screencol < 0) + return; + + rettv->vval.v_number = vcol2col(wp, lnum, screencol); +} #endif /*
--- a/src/proto/move.pro +++ b/src/proto/move.pro @@ -30,6 +30,7 @@ int curwin_col_off2(void); void curs_columns(int may_scroll); void textpos2screenpos(win_T *wp, pos_T *pos, int *rowp, int *scolp, int *ccolp, int *ecolp); void f_screenpos(typval_T *argvars, typval_T *rettv); +void f_virtcol2col(typval_T *argvars, typval_T *rettv); void scrolldown(long line_count, int byfold); void scrollup(long line_count, int byfold); void check_topfill(win_T *wp, int down);
--- a/src/testdir/test_cursor_func.vim +++ b/src/testdir/test_cursor_func.vim @@ -419,4 +419,26 @@ func Test_setcursorcharpos() %bw! endfunc +" Test for virtcol2col() +func Test_virtcol2col() + new + call setline(1, ["a\tb\tc"]) + call assert_equal(1, virtcol2col(0, 1, 1)) + call assert_equal(2, virtcol2col(0, 1, 2)) + call assert_equal(2, virtcol2col(0, 1, 8)) + call assert_equal(3, virtcol2col(0, 1, 9)) + call assert_equal(4, virtcol2col(0, 1, 10)) + call assert_equal(4, virtcol2col(0, 1, 16)) + call assert_equal(5, virtcol2col(0, 1, 17)) + call assert_equal(-1, virtcol2col(10, 1, 1)) + call assert_equal(-1, virtcol2col(0, 10, 1)) + call assert_equal(-1, virtcol2col(0, -1, 1)) + call assert_equal(-1, virtcol2col(0, 1, -1)) + call assert_equal(5, virtcol2col(0, 1, 20)) + call assert_fails('echo virtcol2col("0", 1, 20)', 'E1210:') + call assert_fails('echo virtcol2col(0, "1", 20)', 'E1210:') + call assert_fails('echo virtcol2col(0, 1, "1")', 'E1210:') + bw! +endfunc + " vim: shiftwidth=2 sts=2 expandtab