api: set_text: fix some byte count issues

add byte count tests

update documentation
This commit is contained in:
Björn Linse 2020-12-30 11:31:17 +01:00
parent f7d01a65d5
commit 39d098f9f9
2 changed files with 88 additions and 32 deletions

View File

@ -495,40 +495,38 @@ end:
try_end(err); try_end(err);
} }
/// Sets (replaces) a range in the buffer, retaining any extmarks /// Sets (replaces) a range in the buffer
/// that may lie in that range.
/// ///
/// Indexing is zero-based; end_row is inclusive, while end_col is /// This is recommended over nvim_buf_set_lines when only modifying parts of a
/// exclusive. /// line, as extmarks will be preserved on non-modified parts of the touched
/// lines.
///
/// Indexing is zero-based and end-exclusive.
/// ///
/// To insert text at a given index, set `start` and `end` ranges to the same /// To insert text at a given index, set `start` and `end` ranges to the same
/// index. To delete a range, set `replacement` to an array containing /// index. To delete a range, set `replacement` to an array containing
/// an empty string, or simply an empty array. /// an empty string, or simply an empty array.
/// ///
/// Prefer nvim_buf_set_lines when adding or deleting entire lines. /// Prefer nvim_buf_set_lines when adding or deleting entire lines only.
/// ///
/// @param channel_id /// @param channel_id
/// @param buffer Buffer handle, or 0 for current buffer /// @param buffer Buffer handle, or 0 for current buffer
/// @param start_row First line index /// @param start_row First line index
/// @param start_column Last column /// @param start_column Last column
/// @param end_row Last line index (inclusive) /// @param end_row Last line index
/// @param end_column Last column (exclusive) /// @param end_column Last column
/// @param replacement Array of lines to use as replacement /// @param replacement Array of lines to use as replacement
/// @param[out] err Error details, if any /// @param[out] err Error details, if any
void nvim_buf_set_text(uint64_t channel_id, void nvim_buf_set_text(uint64_t channel_id, Buffer buffer,
Buffer buffer, Integer start_row, Integer start_col,
Integer start_row, Integer end_row, Integer end_col,
Integer start_col, ArrayOf(String) replacement, Error *err)
Integer end_row,
Integer end_col,
ArrayOf(String) replacement,
Error *err)
FUNC_API_SINCE(7) FUNC_API_SINCE(7)
{ {
FIXED_TEMP_ARRAY(scratch, 1);
if (replacement.size == 0) { if (replacement.size == 0) {
String s = { .data = "", .size = 0 }; scratch.items[0] = STRING_OBJ(STATIC_CSTR_AS_STRING(""));
ADD(replacement, STRING_OBJ(s)); replacement = scratch;
replacement.size = 1;
} }
buf_T *buf = find_buffer_by_handle(buffer, err); buf_T *buf = find_buffer_by_handle(buffer, err);
@ -586,18 +584,13 @@ void nvim_buf_set_text(uint64_t channel_id,
} else { } else {
const char *bufline; const char *bufline;
old_byte += (bcount_t)strlen(str_at_start) - start_col; old_byte += (bcount_t)strlen(str_at_start) - start_col;
for (int64_t i = 0; i < end_row - start_row; i++) { for (int64_t i = 1; i < end_row - start_row; i++) {
int64_t lnum = start_row + i; int64_t lnum = start_row + i;
if (lnum >= MAXLNUM) {
api_set_error(err, kErrorTypeValidation, "Index value is too high");
goto end;
}
bufline = (char *)ml_get_buf(buf, lnum, false); bufline = (char *)ml_get_buf(buf, lnum, false);
old_byte += (bcount_t)(strlen(bufline)); old_byte += (bcount_t)(strlen(bufline))+1;
} }
old_byte += (bcount_t)end_col; old_byte += (bcount_t)end_col+1;
} }
String first_item = replacement.items[0].data.string; String first_item = replacement.items[0].data.string;
@ -631,11 +624,11 @@ void nvim_buf_set_text(uint64_t channel_id,
// NL-used-for-NUL. // NL-used-for-NUL.
lines[i] = xmemdupz(l.data, l.size); lines[i] = xmemdupz(l.data, l.size);
memchrsub(lines[i], NUL, NL, l.size); memchrsub(lines[i], NUL, NL, l.size);
new_byte += (bcount_t)(l.size); new_byte += (bcount_t)(l.size)+1;
} }
if (replacement.size > 1) { if (replacement.size > 1) {
lines[replacement.size-1] = last; lines[replacement.size-1] = last;
new_byte += (bcount_t)(last_item.size); new_byte += (bcount_t)(last_item.size)+1;
} }
try_start(); try_start();
@ -715,8 +708,6 @@ void nvim_buf_set_text(uint64_t channel_id,
// Adjust marks. Invalidate any which lie in the // Adjust marks. Invalidate any which lie in the
// changed range, and move any in the remainder of the buffer. // changed range, and move any in the remainder of the buffer.
// Only adjust marks if we managed to switch to a window that holds
// the buffer, otherwise line numbers will be invalid.
mark_adjust((linenr_T)start_row, mark_adjust((linenr_T)start_row,
(linenr_T)end_row, (linenr_T)end_row,
MAXLNUM, MAXLNUM,
@ -724,7 +715,7 @@ void nvim_buf_set_text(uint64_t channel_id,
kExtmarkNOOP); kExtmarkNOOP);
colnr_T col_extent = (colnr_T)(end_col colnr_T col_extent = (colnr_T)(end_col
- ((end_col > start_col) ? start_col : 0)); - ((end_row == start_row) ? start_col : 0));
extmark_splice(buf, (int)start_row-1, (colnr_T)start_col, extmark_splice(buf, (int)start_row-1, (colnr_T)start_col,
(int)(end_row-start_row), col_extent, old_byte, (int)(end_row-start_row), col_extent, old_byte,
(int)new_len-1, (colnr_T)last_item.size, new_byte, (int)new_len-1, (colnr_T)last_item.size, new_byte,

View File

@ -288,7 +288,8 @@ describe('lua: nvim_buf_attach on_bytes', function()
-- TODO: while we are brewing the real strong coffe, -- TODO: while we are brewing the real strong coffe,
-- verify should check buf_get_offset after every check_events -- verify should check buf_get_offset after every check_events
if verify then if verify then
meths.buf_get_offset(0, meths.buf_line_count(0)) local len = meths.buf_get_offset(0, meths.buf_line_count(0))
eq(len == -1 and 1 or len, string.len(shadowbytes))
end end
exec_lua("return test_register(...)", 0, "test1", false, false, true) exec_lua("return test_register(...)", 0, "test1", false, false, true)
meths.buf_get_changedtick(0) meths.buf_get_changedtick(0)
@ -510,6 +511,70 @@ describe('lua: nvim_buf_attach on_bytes', function()
{ "test1", "bytes", 1, 3, 0, 1, 1, 0, 3, 3, 0, 1, 1 }; { "test1", "bytes", 1, 3, 0, 1, 1, 0, 3, 3, 0, 1, 1 };
} }
end) end)
it('nvim_buf_set_text insert', function()
local check_events = setup_eventcheck(verify, {"bastext"})
meths.buf_set_text(0, 0, 3, 0, 3, {"fiol","kontra"})
check_events {
{ "test1", "bytes", 1, 3, 0, 3, 3, 0, 0, 0, 1, 6, 11 };
}
meths.buf_set_text(0, 1, 6, 1, 6, {"punkt","syntgitarr","övnings"})
check_events {
{ "test1", "bytes", 1, 4, 1, 6, 14, 0, 0, 0, 2, 8, 25 };
}
eq({ "basfiol", "kontrapunkt", "syntgitarr", "övningstext" },
meths.buf_get_lines(0, 0, -1, true))
end)
it('nvim_buf_set_text replace', function()
local check_events = setup_eventcheck(verify, origlines)
meths.buf_set_text(0, 2, 3, 2, 8, {"very text"})
check_events {
{ "test1", "bytes", 1, 3, 2, 3, 35, 0, 5, 5, 0, 9, 9 };
}
meths.buf_set_text(0, 3, 5, 3, 7, {" splitty","line "})
check_events {
{ "test1", "bytes", 1, 4, 3, 5, 57, 0, 2, 2, 1, 5, 14 };
}
meths.buf_set_text(0, 0, 8, 1, 2, {"JOINY"})
check_events {
{ "test1", "bytes", 1, 5, 0, 8, 8, 1, 2, 10, 0, 5, 5 };
}
meths.buf_set_text(0, 4, 0, 6, 0, {"was 5,6",""})
check_events {
{ "test1", "bytes", 1, 6, 4, 0, 75, 2, 0, 32, 1, 0, 8 };
}
eq({ "originalJOINYiginal line 2", "orivery text line 3", "origi splitty",
"line l line 4", "was 5,6", " indented line" },
meths.buf_get_lines(0, 0, -1, true))
end)
it('nvim_buf_set_text delete', function()
local check_events = setup_eventcheck(verify, origlines)
-- really {""} but accepts {} as a shorthand
meths.buf_set_text(0, 0, 0, 1, 0, {})
check_events {
{ "test1", "bytes", 1, 3, 0, 0, 0, 1, 0, 16, 0, 0, 0 };
}
-- TODO(bfredl): this works but is not as convenient as set_lines
meths.buf_set_text(0, 4, 15, 5, 17, {""})
check_events {
{ "test1", "bytes", 1, 4, 4, 15, 79, 1, 17, 18, 0, 0, 0 };
}
eq({ "original line 2", "original line 3", "original line 4",
"original line 5", "original line 6" },
meths.buf_get_lines(0, 0, -1, true))
end)
end end
describe('(with verify) handles', function() describe('(with verify) handles', function()