Merge pull request #27076 from glepnir/extmark_hlgroup

refactor(api): use hl id directly in nvim_buf_set_extmark

runtime/lua/vim/_meta/api_keysets.lua

@@ -246,7 +246,7 @@ error('Cannot require a meta file')
 --- @field end_line? integer
 --- @field end_row? integer
 --- @field end_col? integer
---- @field hl_group? any
+--- @field hl_group? number|string
 --- @field virt_text? any[]
 --- @field virt_text_pos? string
 --- @field virt_text_win_col? integer
@@ -264,10 +264,10 @@ error('Cannot require a meta file')
 --- @field virt_lines_leftcol? boolean
 --- @field strict? boolean
 --- @field sign_text? string
---- @field sign_hl_group? any
---- @field number_hl_group? any
---- @field line_hl_group? any
---- @field cursorline_hl_group? any
+--- @field sign_hl_group? number|string
+--- @field number_hl_group? number|string
+--- @field line_hl_group? number|string
+--- @field cursorline_hl_group? number|string
 --- @field conceal? string
 --- @field spell? boolean
 --- @field ui_watched? boolean

scripts/gen_eval_files.lua

@@ -88,6 +88,7 @@ local API_TYPES = {
   LuaRef = 'function',
   Dictionary = 'table<string,any>',
   Float = 'number',
+  HLGroupID = 'number|string',
   void = '',
 }
 

src/nvim/api/extmark.c

@@ -14,6 +14,7 @@
 #include "nvim/buffer_defs.h"
 #include "nvim/charset.h"
 #include "nvim/decoration.h"
+#include "nvim/decoration_defs.h"
 #include "nvim/decoration_provider.h"
 #include "nvim/drawscreen.h"
 #include "nvim/extmark.h"
@@ -546,36 +547,15 @@ Integer nvim_buf_set_extmark(Buffer buffer, Integer ns_id, Integer line, Integer
     col2 = (int)val;
   }
 
-  // uncrustify:off
+  hl.hl_id = (int)opts->hl_group;
+  has_hl = hl.hl_id > 0;
+  sign.hl_id = (int)opts->sign_hl_group;
+  sign.cursorline_hl_id = (int)opts->cursorline_hl_group;
+  sign.number_hl_id = (int)opts->number_hl_group;
+  sign.line_hl_id = (int)opts->line_hl_group;
 
-  // TODO(bfredl): keyset type alias for hl_group? (nil|int|string)
-  struct {
-    const char *name;
-    Object *opt;
-    int *dest;
-  } hls[] = {
-    { "hl_group"           , &opts->hl_group           , &hl.hl_id            },
-    { "sign_hl_group"      , &opts->sign_hl_group      , &sign.hl_id       },
-    { "number_hl_group"    , &opts->number_hl_group    , &sign.number_hl_id     },
-    { "line_hl_group"      , &opts->line_hl_group      , &sign.line_hl_id       },
-    { "cursorline_hl_group", &opts->cursorline_hl_group, &sign.cursorline_hl_id },
-    { NULL, NULL, NULL },
-  };
-
-  // uncrustify:on
-
-  for (int j = 0; hls[j].name && hls[j].dest; j++) {
-    if (hls[j].opt->type != kObjectTypeNil) {
-      if (j > 0) {
+  if (sign.hl_id || sign.cursorline_hl_id || sign.number_hl_id || sign.line_hl_id) {
     sign.flags |= kSHIsSign;
-      } else {
-        has_hl = true;
-      }
-      *hls[j].dest = object_to_hl_id(*hls[j].opt, hls[j].name, err);
-      if (ERROR_SET(err)) {
-        goto error;
-      }
-    }
   }
 
   if (HAS_KEY(opts, set_extmark, conceal)) {

src/nvim/api/keysets_defs.h

@@ -28,7 +28,7 @@ typedef struct {
   Integer end_line;
   Integer end_row;
   Integer end_col;
-  Object hl_group;
+  HLGroupID hl_group;
   Array virt_text;
   String virt_text_pos;
   Integer virt_text_win_col;
@@ -46,10 +46,10 @@ typedef struct {
   Boolean virt_lines_leftcol;
   Boolean strict;
   String sign_text;
-  Object sign_hl_group;
-  Object number_hl_group;
-  Object line_hl_group;
-  Object cursorline_hl_group;
+  HLGroupID sign_hl_group;
+  HLGroupID number_hl_group;
+  HLGroupID line_hl_group;
+  HLGroupID cursorline_hl_group;
   String conceal;
   Boolean spell;
   Boolean ui_watched;

src/nvim/api/private/defs.h

@@ -124,6 +124,7 @@ struct key_value_pair {
 };
 
 typedef uint64_t OptionalKeys;
+typedef Integer HLGroupID;
 
 // this is the prefix of all keysets with optional keys
 typedef struct {
@@ -135,6 +136,7 @@ typedef struct {
   size_t ptr_off;
   ObjectType type;  // kObjectTypeNil == untyped
   int opt_index;
+  bool is_hlgroup;
 } KeySetLink;
 
 typedef KeySetLink *(*FieldHashfn)(const char *str, size_t len);

src/nvim/api/private/helpers.c

@@ -936,13 +936,26 @@ bool api_dict_to_keydict(void *retval, FieldHashfn hashy, Dictionary dict, Error
 
     char *mem = ((char *)retval + field->ptr_off);
     Object *value = &dict.items[i].value;
+
     if (field->type == kObjectTypeNil) {
       *(Object *)mem = *value;
     } else if (field->type == kObjectTypeInteger) {
+      if (field->is_hlgroup) {
+        int hl_id = 0;
+        if (value->type != kObjectTypeNil) {
+          hl_id = object_to_hl_id(*value, k.data, err);
+          if (ERROR_SET(err)) {
+            return false;
+          }
+        }
+        *(Integer *)mem = hl_id;
+      } else {
         VALIDATE_T(field->str, kObjectTypeInteger, value->type, {
           return false;
         });
+
         *(Integer *)mem = value->data.integer;
+      }
     } else if (field->type == kObjectTypeFloat) {
       Float *val = (Float *)mem;
       if (value->type == kObjectTypeInteger) {

src/nvim/generators/gen_api_dispatch.lua

@@ -91,10 +91,12 @@ local function add_keyset(val)
       has_optional = true
     end
   end
-  table.insert(
-    keysets,
-    { name = val.keyset_name, keys = keys, types = types, has_optional = has_optional }
-  )
+  table.insert(keysets, {
+    name = val.keyset_name,
+    keys = keys,
+    types = types,
+    has_optional = has_optional,
+  })
 end
 
 -- read each input file, parse and append to the api metadata
@@ -280,7 +282,9 @@ for _, k in ipairs(keysets) do
   keysets_defs:write('extern KeySetLink ' .. k.name .. '_table[];\n')
 
   local function typename(type)
-    if type ~= nil then
+    if type == 'HLGroupID' then
+      return 'kObjectTypeInteger'
+    elseif type ~= nil then
       return 'kObjectType' .. type
     else
       return 'kObjectTypeNil'
@@ -305,10 +309,12 @@ for _, k in ipairs(keysets) do
         .. typename(k.types[key])
         .. ', '
         .. ind
+        .. ', '
+        .. (k.types[key] == 'HLGroupID' and 'true' or 'false')
         .. '},\n'
     )
   end
-  output:write('  {NULL, 0, kObjectTypeNil, -1},\n')
+  output:write('  {NULL, 0, kObjectTypeNil, -1, false},\n')
   output:write('};\n\n')
 
   output:write(hashfun)

src/nvim/lua/converter.c

@@ -17,6 +17,7 @@
 #include "nvim/eval/typval_encode.h"
 #include "nvim/eval/userfunc.h"
 #include "nvim/gettext_defs.h"
+#include "nvim/highlight_group.h"
 #include "nvim/lua/converter.h"
 #include "nvim/lua/executor.h"
 #include "nvim/macros_defs.h"
@@ -1324,7 +1325,14 @@ void nlua_pop_keydict(lua_State *L, void *retval, FieldHashfn hashy, char **err_
     if (field->type == kObjectTypeNil) {
       *(Object *)mem = nlua_pop_Object(L, true, err);
     } else if (field->type == kObjectTypeInteger) {
+      if (field->is_hlgroup && lua_type(L, -1) == LUA_TSTRING) {
+        size_t name_len;
+        const char *name = lua_tolstring(L, -1, &name_len);
+        lua_pop(L, 1);
+        *(Integer *)mem = name_len > 0 ? syn_check_group(name, name_len) : 0;
+      } else {
         *(Integer *)mem = nlua_pop_Integer(L, err);
+      }
     } else if (field->type == kObjectTypeBoolean) {
       *(Boolean *)mem = nlua_pop_Boolean_strict(L, err);
     } else if (field->type == kObjectTypeString) {