From 1495d36d63305862da3c4106455667d51b578707 Mon Sep 17 00:00:00 2001 From: Björn Linse Date: Fri, 23 Jul 2021 18:00:42 +0200 Subject: feat(decorations): allow more than one stacked highlight in a virt_text --- src/nvim/api/buffer.c | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) (limited to 'src/nvim/api/buffer.c') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 78e36e5ef0..47216996b4 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -1433,8 +1433,14 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, /// - hl_group : name of the highlight group used to highlight /// this mark. /// - virt_text : virtual text to link to this mark. -/// - virt_text_pos : positioning of virtual text. Possible -/// values: +/// A list of [text, highlight] tuples, each representing a +/// text chunk with specified highlight. `highlight` element +/// can either be a a single highlight group, or an array of +/// multiple highlight groups that will be stacked +/// (highest priority last). A highlight group can be supplied +/// either as a string or as an integer, the latter which +/// can be obtained using |nvim_get_hl_id_by_name|. +/// - virt_text_pos : position of virtual text. Possible values: /// - "eol": right after eol character (default) /// - "overlay": display over the specified column, without /// shifting the underlying text. -- cgit From a4d81a800293f05790025f43033de11c7bd05a7b Mon Sep 17 00:00:00 2001 From: Björn Linse Date: Sun, 25 Jul 2021 14:33:28 +0200 Subject: refactor(decorations): merge the two different code paths for virt_text test(bufhl): CHANGE of tested behaviour (inb4 a proper priority mechanism) test(decoration): change of test; previous behavior was buggy (ghost buffer text) --- src/nvim/api/buffer.c | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) (limited to 'src/nvim/api/buffer.c') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 47216996b4..56c9cfc517 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -1566,7 +1566,8 @@ Integer nvim_buf_set_extmark(Buffer buffer, Integer ns_id, "virt_text is not an Array"); goto error; } - decor.virt_text = parse_virt_text(v->data.array, err); + decor.virt_text = parse_virt_text(v->data.array, err, + &decor.virt_text_width); if (ERROR_SET(err)) { goto error; } @@ -1949,23 +1950,26 @@ Integer nvim_buf_set_virtual_text(Buffer buffer, } uint64_t ns_id = src2ns(&src_id); + int width; - VirtText virt_text = parse_virt_text(chunks, err); + VirtText virt_text = parse_virt_text(chunks, err, &width); if (ERROR_SET(err)) { return 0; } - VirtText *existing = decor_find_virttext(buf, (int)line, ns_id); + Decoration *existing = decor_find_virttext(buf, (int)line, ns_id); if (existing) { - clear_virttext(existing); - *existing = virt_text; + clear_virttext(&existing->virt_text); + existing->virt_text = virt_text; + existing->virt_text_width = width; return src_id; } Decoration *decor = xcalloc(1, sizeof(*decor)); decor->virt_text = virt_text; + decor->virt_text_width = width; extmark_set(buf, ns_id, 0, (int)line, 0, -1, -1, decor, true, false, kExtmarkNoUndo); -- cgit From 25a879dfa2f0795d610833c9552ca48f0cab95fa Mon Sep 17 00:00:00 2001 From: Björn Linse Date: Wed, 28 Jul 2021 22:29:54 +0200 Subject: feat(decorations): deprecate nvim_buf_set_virtual_text Full virt_text functionality is provided by nvim_buf_set_extmark --- src/nvim/api/buffer.c | 77 --------------------------------------------------- 1 file changed, 77 deletions(-) (limited to 'src/nvim/api/buffer.c') diff --git a/src/nvim/api/buffer.c b/src/nvim/api/buffer.c index 56c9cfc517..77cff0cb4f 100644 --- a/src/nvim/api/buffer.c +++ b/src/nvim/api/buffer.c @@ -1899,83 +1899,6 @@ void nvim_buf_clear_namespace(Buffer buffer, (int)line_end-1, MAXCOL); } -/// Set the virtual text (annotation) for a buffer line. -/// -/// By default (and currently the only option) the text will be placed after -/// the buffer text. Virtual text will never cause reflow, rather virtual -/// text will be truncated at the end of the screen line. The virtual text will -/// begin one cell (|lcs-eol| or space) after the ordinary text. -/// -/// Namespaces are used to support batch deletion/updating of virtual text. -/// To create a namespace, use |nvim_create_namespace()|. Virtual text is -/// cleared using |nvim_buf_clear_namespace()|. The same `ns_id` can be used for -/// both virtual text and highlights added by |nvim_buf_add_highlight()|, both -/// can then be cleared with a single call to |nvim_buf_clear_namespace()|. If -/// the virtual text never will be cleared by an API call, pass `ns_id = -1`. -/// -/// As a shorthand, `ns_id = 0` can be used to create a new namespace for the -/// virtual text, the allocated id is then returned. -/// -/// @param buffer Buffer handle, or 0 for current buffer -/// @param ns_id Namespace to use or 0 to create a namespace, -/// or -1 for a ungrouped annotation -/// @param line Line to annotate with virtual text (zero-indexed) -/// @param chunks A list of [text, hl_group] arrays, each representing a -/// text chunk with specified highlight. `hl_group` element -/// can be omitted for no highlight. -/// @param opts Optional parameters. Currently not used. -/// @param[out] err Error details, if any -/// @return The ns_id that was used -Integer nvim_buf_set_virtual_text(Buffer buffer, - Integer src_id, - Integer line, - Array chunks, - Dictionary opts, - Error *err) - FUNC_API_SINCE(5) -{ - buf_T *buf = find_buffer_by_handle(buffer, err); - if (!buf) { - return 0; - } - - if (line < 0 || line >= MAXLNUM) { - api_set_error(err, kErrorTypeValidation, "Line number outside range"); - return 0; - } - - if (opts.size > 0) { - api_set_error(err, kErrorTypeValidation, "opts dict isn't empty"); - return 0; - } - - uint64_t ns_id = src2ns(&src_id); - int width; - - VirtText virt_text = parse_virt_text(chunks, err, &width); - if (ERROR_SET(err)) { - return 0; - } - - - Decoration *existing = decor_find_virttext(buf, (int)line, ns_id); - - if (existing) { - clear_virttext(&existing->virt_text); - existing->virt_text = virt_text; - existing->virt_text_width = width; - return src_id; - } - - Decoration *decor = xcalloc(1, sizeof(*decor)); - decor->virt_text = virt_text; - decor->virt_text_width = width; - - extmark_set(buf, ns_id, 0, (int)line, 0, -1, -1, decor, true, - false, kExtmarkNoUndo); - return src_id; -} - /// call a function with buffer as temporary current buffer /// /// This temporarily switches current buffer to "buffer". -- cgit