feat: get/set namespace properties #28728

ref https://github.com/neovim/neovim/pull/28432
ref https://github.com/neovim/neovim/issues/28469

src/nvim/api/deprecated.c

@@ -170,7 +170,7 @@ Integer nvim_buf_set_virtual_text(Buffer buffer, Integer src_id, Integer line, A
   DecorInline decor = { .ext = true, .data.ext.vt = vt, .data.ext.sh_idx = DECOR_ID_INVALID };
 
   extmark_set(buf, ns_id, NULL, (int)line, 0, -1, -1, decor, 0, true,
-              false, false, false, false, NULL);
+              false, false, false, NULL);
   return src_id;
 }
 

src/nvim/api/extmark.c

@@ -18,6 +18,7 @@
 #include "nvim/decoration_provider.h"
 #include "nvim/drawscreen.h"
 #include "nvim/extmark.h"
+#include "nvim/globals.h"
 #include "nvim/grid.h"
 #include "nvim/highlight_group.h"
 #include "nvim/map_defs.h"
@@ -41,6 +42,7 @@ void api_extmark_free_all_mem(void)
     xfree(name.data);
   })
   map_destroy(String, &namespace_ids);
+  set_destroy(uint32_t, &namespace_localscope);
 }
 
 /// Creates a new namespace or gets an existing one. [namespace]()
@@ -179,10 +181,6 @@ static Array extmark_to_array(MTPair extmark, bool id, bool add_dict, bool hl_na
       PUT_C(dict, "invalid", BOOLEAN_OBJ(true));
     }
 
-    if (mt_scoped(start)) {
-      PUT_C(dict, "scoped", BOOLEAN_OBJ(true));
-    }
-
     decor_to_dict_legacy(&dict, mt_decor(start), hl_name, arena);
 
     ADD_C(rv, DICTIONARY_OBJ(dict));
@@ -489,8 +487,6 @@ Array nvim_buf_get_extmarks(Buffer buffer, Integer ns_id, Object start, Object e
 ///                   used together with virt_text.
 ///               - url: A URL to associate with this extmark. In the TUI, the OSC 8 control
 ///                   sequence is used to generate a clickable hyperlink to this URL.
-///               - scoped: boolean (EXPERIMENTAL) enables "scoping" for the extmark. See
-///                 |nvim__win_add_ns()|
 ///
 /// @param[out]  err   Error details, if any
 /// @return Id of the created/updated extmark
@@ -749,11 +745,6 @@ Integer nvim_buf_set_extmark(Buffer buffer, Integer ns_id, Integer line, Integer
   }
 
   if (opts->ephemeral && decor_state.win && decor_state.win->w_buffer == buf) {
-    if (opts->scoped) {
-      api_set_error(err, kErrorTypeException, "not yet implemented");
-      goto error;
-    }
-
     int r = (int)line;
     int c = (int)col;
     if (line2 == -1) {
@@ -834,7 +825,7 @@ Integer nvim_buf_set_extmark(Buffer buffer, Integer ns_id, Integer line, Integer
     extmark_set(buf, (uint32_t)ns_id, &id, (int)line, (colnr_T)col, line2, col2,
                 decor, decor_flags, right_gravity, opts->end_right_gravity,
                 !GET_BOOL_OR_TRUE(opts, set_extmark, undo_restore),
-                opts->invalidate, opts->scoped, err);
+                opts->invalidate, err);
     if (ERROR_SET(err)) {
       decor_free(decor);
       return 0;
@@ -960,7 +951,7 @@ Integer nvim_buf_add_highlight(Buffer buffer, Integer ns_id, String hl_group, In
   decor.data.hl.hl_id = hl_id;
 
   extmark_set(buf, ns, NULL, (int)line, (colnr_T)col_start, end_line, (colnr_T)col_end,
-              decor, MT_FLAG_DECOR_HL, true, false, false, false, false, NULL);
+              decor, MT_FLAG_DECOR_HL, true, false, false, false, NULL);
   return ns_id;
 }
 
@@ -1217,77 +1208,119 @@ String nvim__buf_debug_extmarks(Buffer buffer, Boolean keys, Boolean dot, Error
 
 /// EXPERIMENTAL: this API will change in the future.
 ///
-/// Scopes a namespace to the a window, so extmarks in the namespace will be active only in the
-/// given window.
+/// Set some properties for namespace
 ///
-/// @param window Window handle, or 0 for current window
 /// @param ns_id Namespace
-/// @return true if the namespace was added, else false
-Boolean nvim__win_add_ns(Window window, Integer ns_id, Error *err)
+/// @param opts Optional parameters to set:
+///           - wins: a list of windows to be scoped in
+///
+void nvim__ns_set(Integer ns_id, Dict(ns_opts) *opts, Error *err)
 {
-  win_T *win = find_window_by_handle(window, err);
-  if (!win) {
-    return false;
+  VALIDATE_INT(ns_initialized((uint32_t)ns_id), "ns_id", ns_id, {
+    return;
+  });
+
+  bool set_scoped = true;
+
+  if (HAS_KEY(opts, ns_opts, wins)) {
+    if (opts->wins.size == 0) {
+      set_scoped = false;
+    }
+
+    Set(ptr_t) windows = SET_INIT;
+    for (size_t i = 0; i < opts->wins.size; i++) {
+      Integer win = opts->wins.items[i].data.integer;
+
+      win_T *wp = find_window_by_handle((Window)win, err);
+      if (!wp) {
+        return;
+      }
+
+      set_put(ptr_t, &windows, wp);
+    }
+
+    FOR_ALL_TAB_WINDOWS(tp, wp) {
+      if (set_has(ptr_t, &windows, wp) && !set_has(uint32_t, &wp->w_ns_set, (uint32_t)ns_id)) {
+        set_put(uint32_t, &wp->w_ns_set, (uint32_t)ns_id);
+
+        if (map_has(uint32_t, wp->w_buffer->b_extmark_ns, (uint32_t)ns_id)) {
+          changed_window_setting(wp);
+        }
+      }
+
+      if (set_has(uint32_t, &wp->w_ns_set, (uint32_t)ns_id) && !set_has(ptr_t, &windows, wp)) {
+        set_del(uint32_t, &wp->w_ns_set, (uint32_t)ns_id);
+
+        if (map_has(uint32_t, wp->w_buffer->b_extmark_ns, (uint32_t)ns_id)) {
+          changed_window_setting(wp);
+        }
+      }
+    }
+
+    set_destroy(ptr_t, &windows);
   }
 
+  if (set_scoped && !set_has(uint32_t, &namespace_localscope, (uint32_t)ns_id)) {
+    set_put(uint32_t, &namespace_localscope, (uint32_t)ns_id);
+
+    // When a namespace becomes scoped, any window which contains
+    // elements associated with namespace needs to be redrawn
+    FOR_ALL_TAB_WINDOWS(tp, wp) {
+      if (map_has(uint32_t, wp->w_buffer->b_extmark_ns, (uint32_t)ns_id)) {
+        changed_window_setting(wp);
+      }
+    }
+  } else if (!set_scoped && set_has(uint32_t, &namespace_localscope, (uint32_t)ns_id)) {
+    set_del(uint32_t, &namespace_localscope, (uint32_t)ns_id);
+
+    // When a namespace becomes unscoped, any window which does not
+    // contain elements associated with namespace needs to be redrawn
+    FOR_ALL_TAB_WINDOWS(tp, wp) {
+      if (map_has(uint32_t, wp->w_buffer->b_extmark_ns, (uint32_t)ns_id)) {
+        changed_window_setting(wp);
+      }
+    }
+  }
+}
+
+/// EXPERIMENTAL: this API will change in the future.
+///
+/// Get the properties for namespace
+///
+/// @param ns_id Namespace
+/// @return  Map defining the namespace properties, see |nvim__ns_set()|
+Dict(ns_opts) nvim__ns_get(Integer ns_id, Arena *arena, Error *err)
+{
+  Dict(ns_opts) opts = KEYDICT_INIT;
+
+  Array windows = ARRAY_DICT_INIT;
+
+  PUT_KEY(opts, ns_opts, wins, windows);
+
   VALIDATE_INT(ns_initialized((uint32_t)ns_id), "ns_id", ns_id, {
-    return false;
+    return opts;
   });
 
-  set_put(uint32_t, &win->w_ns_set, (uint32_t)ns_id);
-
-  if (map_has(uint32_t, win->w_buffer->b_extmark_ns, (uint32_t)ns_id)) {
-    changed_window_setting(win);
+  if (!set_has(uint32_t, &namespace_localscope, (uint32_t)ns_id)) {
+    return opts;
   }
 
-  return true;
-}
-
-/// EXPERIMENTAL: this API will change in the future.
-///
-/// Gets the namespace scopes for a given window.
-///
-/// @param window Window handle, or 0 for current window
-/// @return a list of namespaces ids
-ArrayOf(Integer) nvim__win_get_ns(Window window, Arena *arena, Error *err)
-{
-  win_T *win = find_window_by_handle(window, err);
-  if (!win) {
-    return (Array)ARRAY_DICT_INIT;
-  }
-
-  Array rv = arena_array(arena, set_size(&win->w_ns_set));
-  uint32_t i;
-  set_foreach(&win->w_ns_set, i, {
-    ADD_C(rv, INTEGER_OBJ((Integer)(i)));
-  });
-
-  return rv;
-}
-
-/// EXPERIMENTAL: this API will change in the future.
-///
-/// Unscopes a namespace (un-binds it from the given scope).
-///
-/// @param window Window handle, or 0 for current window
-/// @param ns_id the namespace to remove
-/// @return true if the namespace was removed, else false
-Boolean nvim__win_del_ns(Window window, Integer ns_id, Error *err)
-{
-  win_T *win = find_window_by_handle(window, err);
-  if (!win) {
-    return false;
-  }
-
-  if (!set_has(uint32_t, &win->w_ns_set, (uint32_t)ns_id)) {
-    return false;
-  }
-
-  set_del(uint32_t, &win->w_ns_set, (uint32_t)ns_id);
-
-  if (map_has(uint32_t, win->w_buffer->b_extmark_ns, (uint32_t)ns_id)) {
-    changed_window_setting(win);
-  }
-
-  return true;
+  size_t count = 0;
+  FOR_ALL_TAB_WINDOWS(tp, wp) {
+    if (set_has(uint32_t, &wp->w_ns_set, (uint32_t)ns_id)) {
+      count++;
+    }
+  }
+
+  windows = arena_array(arena, count);
+
+  FOR_ALL_TAB_WINDOWS(tp, wp) {
+    if (set_has(uint32_t, &wp->w_ns_set, (uint32_t)ns_id)) {
+      ADD(windows, INTEGER_OBJ(wp->handle));
+    }
+  }
+
+  PUT_KEY(opts, ns_opts, wins, windows);
+
+  return opts;
 }

src/nvim/api/extmark.h

@@ -4,14 +4,29 @@
 
 #include "nvim/api/keysets_defs.h"  // IWYU pragma: keep
 #include "nvim/api/private/defs.h"  // IWYU pragma: keep
+#include "nvim/buffer_defs.h"
 #include "nvim/decoration_defs.h"  // IWYU pragma: keep
 #include "nvim/macros_defs.h"
 #include "nvim/map_defs.h"
 #include "nvim/types_defs.h"
 
 EXTERN Map(String, int) namespace_ids INIT( = MAP_INIT);
+/// Non-global namespaces. A locally-scoped namespace may be "orphaned" if all
+/// window(s) it was scoped to, are destroyed. Such orphans are tracked here to
+/// avoid being mistaken as "global scope".
+EXTERN Set(uint32_t) namespace_localscope INIT( = SET_INIT);
 EXTERN handle_T next_namespace_id INIT( = 1);
 
+/// Returns true if the namespace is global or scoped in the given window.
+static inline bool ns_in_win(uint32_t ns_id, win_T *wp)
+{
+  if (!set_has(uint32_t, &namespace_localscope, ns_id)) {
+    return true;
+  }
+
+  return set_has(uint32_t, &wp->w_ns_set, ns_id);
+}
+
 #ifdef INCLUDE_GENERATED_DECLARATIONS
 # include "api/extmark.h.generated.h"
 #endif

src/nvim/api/keysets_defs.h

@@ -387,3 +387,8 @@ typedef struct {
   Window win;
   Buffer buf;
 } Dict(redraw);
+
+typedef struct {
+  OptionalKeys is_set__ns_opts_;
+  Array wins;
+} Dict(ns_opts);