kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-29 14:41:06 -07:00
Code Issues Packages Projects Releases Wiki Activity

cursor_shape: use attribute ids instead of syntax ids

Browse Source 
As attribute ids is the convention in the UI protocol
Also remove non-threadsafe calls in tui.c to syntax module.
This commit is contained in:
Björn Linse 2018-07-26 21:27:41 +02:00
parent fab555e59c
commit fa4c260100
7 changed files with 104 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
runtime/doc/ui.txt
View File

@ -89,13 +89,18 @@ Global Events *ui-global*
`cursor_shape`: "block", "horizontal", "vertical"
`cell_percentage`: Cell % occupied by the cursor.
`blinkwait`, `blinkon`, `blinkoff`: See |cursor-blinking|.
`hl_id`: Cursor highlight group.
`hl_lm`: Cursor highlight group if 'langmap' is active.
`attr_id`: Cursor attribute id (defined by `hl_attr_define`)
`attr_id_lm`: Cursor attribute id for when 'langmap' is active.
`short_name`: Mode code name, see 'guicursor'.
`name`: Mode descriptive name.
`mouse_shape`: (To be implemented.)
Some keys are missing in some modes.
The following keys are deprecated:
`hl_id`: Use `attr_id` instead.
`hl_lm`: Use `attr_id_lm` instead.
["option_set", name, value]
UI-related option changed, where `name` is one of:

24
src/nvim/cursor_shape.c
View File

@ -64,6 +64,9 @@ Array mode_style_array(void)
PUT(dic, "blinkoff", INTEGER_OBJ(cur->blinkoff));
PUT(dic, "hl_id", INTEGER_OBJ(cur->id));
PUT(dic, "id_lm", INTEGER_OBJ(cur->id_lm));
PUT(dic, "attr_id", INTEGER_OBJ(cur->id ? syn_id2attr(cur->id) : 0));
PUT(dic, "attr_id_lm", INTEGER_OBJ(cur->id_lm ? syn_id2attr(cur->id_lm)
: 0));
}
PUT(dic, "name", STRING_OBJ(cstr_to_string(cur->full_name)));
PUT(dic, "short_name", STRING_OBJ(cstr_to_string(cur->name)));
@ -258,15 +261,30 @@ char_u *parse_shape_opt(int what)
/// @return -1 in case of failure, else the matching SHAPE_ID* integer
int cursor_mode_str2int(const char *mode)
{
for (int current_mode = 0; current_mode < SHAPE_IDX_COUNT; current_mode++) {
if (strcmp(shape_table[current_mode].full_name, mode) == 0) {
return current_mode;
for (int mode_idx = 0; mode_idx < SHAPE_IDX_COUNT; mode_idx++) {
if (strcmp(shape_table[mode_idx].full_name, mode) == 0) {
return mode_idx;
}
}
WLOG("Unknown mode %s", mode);
return -1;
}
/// Check if a syntax id is used as a cursor style.
bool cursor_mode_uses_syn_id(int syn_id)
{
if (*p_guicursor == NUL) {
return false;
}
for (int mode_idx = 0; mode_idx < SHAPE_IDX_COUNT; mode_idx++) {
if (shape_table[mode_idx].id == syn_id
|| shape_table[mode_idx].id_lm == syn_id) {
return true;
}
}
return false;
}
/// Return the index into shape_table[] for the current mode.
int cursor_get_mode_idx(void)

7
src/nvim/syntax.c
View File

@ -16,6 +16,7 @@
#include "nvim/ascii.h"
#include "nvim/syntax.h"
#include "nvim/charset.h"
#include "nvim/cursor_shape.h"
#include "nvim/eval.h"
#include "nvim/ex_cmds2.h"
#include "nvim/ex_docmd.h"
@ -7228,7 +7229,6 @@ static void set_hl_attr(int idx)
HlAttrs at_en = HLATTRS_INIT;
struct hl_group *sgp = HL_TABLE() + idx;
at_en.cterm_ae_attr = sgp->sg_cterm;
at_en.cterm_fg_color = sgp->sg_cterm_fg;
at_en.cterm_bg_color = sgp->sg_cterm_bg;
@ -7241,6 +7241,11 @@ static void set_hl_attr(int idx)
at_en.rgb_sp_color = sgp->sg_rgb_sp_name ? sgp->sg_rgb_sp : -1;
sgp->sg_attr = hl_get_syn_attr(idx+1, at_en);
// a cursor style uses this syn_id, make sure its atribute is updated.
if (cursor_mode_uses_syn_id(idx+1)) {
ui_mode_info_set();
}
}
/// Lookup a highlight group name and return its ID.

14
src/nvim/tui/tui.c
View File

@ -874,7 +874,7 @@ static cursorentry_T decode_cursor_entry(Dictionary args)
r.blinkon = (int)value.data.integer;
} else if (strequal(key, "blinkoff")) {
r.blinkoff = (int)value.data.integer;
} else if (strequal(key, "hl_id")) {
} else if (strequal(key, "attr_id")) {
r.id = (int)value.data.integer;
}
}
@ -942,14 +942,10 @@ static void tui_set_mode(UI *ui, ModeShape mode)
TUIData *data = ui->data;
cursorentry_T c = data->cursor_shapes[mode];
if (c.id != 0 && ui->rgb) {
// TODO(bfredl): NOT threadsafe, include attr in cursor_shape already.
int attr = syn_id2attr(c.id);
if (attr > 0 && attr < (int)kv_size(data->attrs)) {
int color = kv_A(data->attrs, attr).rgb_bg_color;
UNIBI_SET_NUM_VAR(data->params[0], color);
unibi_out_ext(ui, data->unibi_ext.set_cursor_color);
}
if (c.id != 0 && c.id < (int)kv_size(data->attrs) && ui->rgb) {
int color = kv_A(data->attrs, c.id).rgb_bg_color;
UNIBI_SET_NUM_VAR(data->params[0], color);
unibi_out_ext(ui, data->unibi_ext.set_cursor_color);
}
int shape;

13
src/nvim/ui.c
View File

@ -55,6 +55,7 @@ static int row = 0, col = 0;
static bool pending_cursor_update = false;
static int busy = 0;
static int mode_idx = SHAPE_IDX_N;
static bool pending_mode_info_update = false;
static bool pending_mode_update = false;
#if MIN_LOG_LEVEL > DEBUG_LOG_LEVEL
@ -368,10 +369,7 @@ void ui_add_linewrap(int row)
void ui_mode_info_set(void)
{
Array style = mode_style_array();
bool enabled = (*p_guicursor != NUL);
ui_call_mode_info_set(enabled, style);
api_free_array(style);
pending_mode_info_update = true;
}
int ui_current_row(void)
@ -391,6 +389,13 @@ void ui_flush(void)
ui_call_grid_cursor_goto(1, row, col);
pending_cursor_update = false;
}
if (pending_mode_info_update) {
Array style = mode_style_array();
bool enabled = (*p_guicursor != NUL);
ui_call_mode_info_set(enabled, style);
api_free_array(style);
pending_mode_info_update = false;
}
if (pending_mode_update) {
char *full_name = shape_table[mode_idx].full_name;
ui_call_mode_change(cstr_as_string(full_name), mode_idx);

46
test/functional/ui/cursor_spec.lua
View File

@ -28,6 +28,8 @@ describe('ui/cursor', function()
name = 'normal',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'n' },
[2] = {
@ -39,6 +41,8 @@ describe('ui/cursor', function()
name = 'visual',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'v' },
[3] = {
@ -50,6 +54,8 @@ describe('ui/cursor', function()
name = 'insert',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'i' },
[4] = {
@ -61,6 +67,8 @@ describe('ui/cursor', function()
name = 'replace',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'r' },
[5] = {
@ -72,6 +80,8 @@ describe('ui/cursor', function()
name = 'cmdline_normal',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'c' },
[6] = {
@ -83,6 +93,8 @@ describe('ui/cursor', function()
name = 'cmdline_insert',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'ci' },
[7] = {
@ -94,6 +106,8 @@ describe('ui/cursor', function()
name = 'cmdline_replace',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'cr' },
[8] = {
@ -105,6 +119,8 @@ describe('ui/cursor', function()
name = 'operator',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 'o' },
[9] = {
@ -116,6 +132,8 @@ describe('ui/cursor', function()
name = 'visual_select',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
mouse_shape = 0,
short_name = 've' },
[10] = {
@ -155,6 +173,8 @@ describe('ui/cursor', function()
name = 'showmatch',
hl_id = 0,
id_lm = 0,
attr = {},
attr_lm = {},
short_name = 'sm' },
}
@ -179,6 +199,7 @@ describe('ui/cursor', function()
end)
-- Change the cursor style.
helpers.command('hi Cursor guibg=DarkGray')
helpers.command('set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr-o:hor20'
..',a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor'
..',sm:block-blinkwait175-blinkoff150-blinkon175')
@ -194,7 +215,10 @@ describe('ui/cursor', function()
if m.blinkoff then m.blinkoff = 400 end
if m.blinkwait then m.blinkwait = 700 end
end
if m.hl_id then m.hl_id = 49 end
if m.hl_id then
m.hl_id = 49
m.attr = {background = Screen.colors.DarkGray}
end
if m.id_lm then m.id_lm = 50 end
end
@ -205,6 +229,26 @@ describe('ui/cursor', function()
eq('normal', screen.mode)
end)
-- Change hl groups only, should update the styles
helpers.command('hi Cursor guibg=Red')
helpers.command('hi lCursor guibg=Green')
-- Update the expected values.
for _, m in ipairs(expected_mode_info) do
if m.hl_id then
m.attr = {background = Screen.colors.Red}
end
if m.id_lm then
m.attr_lm = {background = Screen.colors.Green}
end
end
-- Assert the new expectation.
screen:expect(function()
eq(expected_mode_info, screen._mode_info)
eq(true, screen._cursor_style_enabled)
eq('normal', screen.mode)
end)
-- Another cursor style.
meths.set_option('guicursor', 'n-v-c:ver35-blinkwait171-blinkoff172-blinkon173'
..',ve:hor35,o:ver50,i-ci:block,r-cr:hor90,sm:ver42')

11
test/functional/ui/screen.lua
View File

@ -386,6 +386,17 @@ end
function Screen:_handle_mode_info_set(cursor_style_enabled, mode_info)
self._cursor_style_enabled = cursor_style_enabled
for _, item in pairs(mode_info) do
-- attr IDs are not stable, but their value should be
if item.attr_id ~= nil then
item.attr = self._attr_table[item.attr_id][1]
item.attr_id = nil
end
if item.attr_id_lm ~= nil then
item.attr_lm = self._attr_table[item.attr_id_lm][1]
item.attr_id_lm = nil
end
end
self._mode_info = mode_info
end