mirror of
https://github.com/neovim/neovim.git
synced 2025-10-09 03:16:31 +00:00
eb4676c67f
fix(extmarks): disallow removing extmarks in on_lines callbacks decor_redraw_start (which runs before decor_providers_invoke_lines) gets references for the extmarks on a specific line. If these extmarks are deleted in on_lines callbacks then this results in a heap-use-after-free error. Fixes #22801
126 lines
2.9 KiB
C
126 lines
2.9 KiB
C
#ifndef NVIM_DECORATION_H
|
|
#define NVIM_DECORATION_H
|
|
|
|
#include <stdbool.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#include "klib/kvec.h"
|
|
#include "nvim/buffer_defs.h"
|
|
#include "nvim/extmark_defs.h"
|
|
#include "nvim/macros.h"
|
|
#include "nvim/marktree.h"
|
|
#include "nvim/pos.h"
|
|
#include "nvim/types.h"
|
|
|
|
// actual Decoration data is in extmark_defs.h
|
|
|
|
typedef uint16_t DecorPriority;
|
|
#define DECOR_PRIORITY_BASE 0x1000
|
|
|
|
typedef enum {
|
|
kVTEndOfLine,
|
|
kVTOverlay,
|
|
kVTWinCol,
|
|
kVTRightAlign,
|
|
} VirtTextPos;
|
|
|
|
EXTERN const char *const virt_text_pos_str[] INIT(= { "eol", "overlay", "win_col", "right_align" });
|
|
|
|
typedef enum {
|
|
kHlModeUnknown,
|
|
kHlModeReplace,
|
|
kHlModeCombine,
|
|
kHlModeBlend,
|
|
} HlMode;
|
|
|
|
EXTERN const char *const hl_mode_str[] INIT(= { "", "replace", "combine", "blend" });
|
|
|
|
#define VIRTTEXT_EMPTY ((VirtText)KV_INITIAL_VALUE)
|
|
|
|
typedef kvec_t(struct virt_line { VirtText line; bool left_col; }) VirtLines;
|
|
|
|
struct Decoration {
|
|
VirtText virt_text;
|
|
VirtLines virt_lines;
|
|
|
|
int hl_id; // highlight group
|
|
VirtTextPos virt_text_pos;
|
|
HlMode hl_mode;
|
|
|
|
// TODO(bfredl): at some point turn this into FLAGS
|
|
bool virt_text_hide;
|
|
bool hl_eol;
|
|
bool virt_lines_above;
|
|
bool conceal;
|
|
TriState spell;
|
|
// TODO(bfredl): style, etc
|
|
DecorPriority priority;
|
|
int col; // fixed col value, like win_col
|
|
int virt_text_width; // width of virt_text
|
|
char *sign_text;
|
|
int sign_hl_id;
|
|
int number_hl_id;
|
|
int line_hl_id;
|
|
int cursorline_hl_id;
|
|
// TODO(bfredl): in principle this should be a schar_T, but we
|
|
// probably want some kind of glyph cache for that..
|
|
int conceal_char;
|
|
bool ui_watched; // watched for win_extmark
|
|
};
|
|
#define DECORATION_INIT { KV_INITIAL_VALUE, KV_INITIAL_VALUE, 0, kVTEndOfLine, \
|
|
kHlModeUnknown, false, false, false, false, kNone, \
|
|
DECOR_PRIORITY_BASE, 0, 0, NULL, 0, 0, 0, 0, 0, false }
|
|
|
|
typedef struct {
|
|
int start_row;
|
|
int start_col;
|
|
int end_row;
|
|
int end_col;
|
|
Decoration decor;
|
|
int attr_id; // cached lookup of decor.hl_id
|
|
bool virt_text_owned;
|
|
int win_col;
|
|
uint64_t ns_id;
|
|
uint64_t mark_id;
|
|
} DecorRange;
|
|
|
|
typedef struct {
|
|
MarkTreeIter itr[1];
|
|
kvec_t(DecorRange) active;
|
|
win_T *win;
|
|
int top_row;
|
|
int row;
|
|
int col_until;
|
|
int current;
|
|
int eol_col;
|
|
|
|
bool conceal;
|
|
int conceal_char;
|
|
int conceal_attr;
|
|
|
|
TriState spell;
|
|
|
|
// This is used to prevent removing/updating extmarks inside
|
|
// on_lines callbacks which is not allowed since it can lead to
|
|
// heap-use-after-free errors.
|
|
bool running_on_lines;
|
|
} DecorState;
|
|
|
|
EXTERN DecorState decor_state INIT(= { 0 });
|
|
|
|
static inline bool decor_has_sign(Decoration *decor)
|
|
{
|
|
return decor->sign_text
|
|
|| decor->sign_hl_id
|
|
|| decor->number_hl_id
|
|
|| decor->line_hl_id
|
|
|| decor->cursorline_hl_id;
|
|
}
|
|
|
|
#ifdef INCLUDE_GENERATED_DECLARATIONS
|
|
# include "decoration.h.generated.h"
|
|
#endif
|
|
|
|
#endif // NVIM_DECORATION_H
|