COMMON: implement plugin_refresh_id for variable lifecycle handling

Author: Chris Warren-Smith

src/common/plugins.c

@@ -42,6 +42,7 @@ typedef int (*sblib_count_fn) (void);
 typedef int (*sblib_init_fn) (const char *);
 typedef int (*sblib_has_window_ui_fn) (void);
 typedef int (*sblib_free_fn) (int, int);
+typedef int (*sblib_refresh_id_fn) (int, int);
 typedef void (*sblib_close_fn) (void);
 
 typedef struct {
@@ -51,6 +52,7 @@ typedef struct {
   sblib_exec_fn _sblib_proc_exec;
   sblib_exec_fn _sblib_func_exec;
   sblib_free_fn _sblib_free;
+  sblib_refresh_id_fn _sblib_refresh_id;
   ext_func_node_t *_func_list;
   ext_proc_node_t *_proc_list;
   uint32_t _id;
@@ -327,6 +329,7 @@ static void slib_import_routines(slib_t *lib, int comp) {
   lib->_sblib_func_exec = slib_getoptptr(lib, "sblib_func_exec");
   lib->_sblib_proc_exec = slib_getoptptr(lib, "sblib_proc_exec");
   lib->_sblib_free = slib_getoptptr(lib, "sblib_free");
+  lib->_sblib_refresh_id = slib_getoptptr(lib, "sblib_refresh_id");
   sblib_count_fn fcount = slib_getoptptr(lib, "sblib_proc_count");
   sblib_getname_fn fgetname = slib_getoptptr(lib, "sblib_proc_getname");
 
@@ -565,6 +568,17 @@ void plugin_free(int lib_id, int cls_id, int id) {
   }
 }
 
+int plugin_refresh_id(int lib_id, int cls_id, int id) {
+  int result = id;
+  if (lib_id != -1 && cls_id != -1 && id != -1) {
+    slib_t *lib = get_lib(lib_id);
+    if (lib && lib->_sblib_refresh_id) {
+      result = lib->_sblib_refresh_id(cls_id, id);
+    }
+  }
+  return result;
+}
+
 void plugin_close() {
   for (int i = 0; i < MAX_SLIBS; i++) {
     if (plugins[i]) {
@@ -594,6 +608,7 @@ void *plugin_get_func(const char *name) { return 0; }
 int plugin_procexec(int lib_id, int index) { return -1; }
 int plugin_funcexec(int lib_id, int index, var_t *ret) { return -1; }
 void plugin_free(int lib_id, int cls_id, int id) {}
+int plugin_refresh_id(int lib_id, int cls_id, int id) {return id;}
 void plugin_close() {}
 #endif
 

src/common/plugins.h

@@ -71,6 +71,11 @@ int plugin_funcexec(int lib_id, int index, var_t *ret);
 //
 void plugin_free(int lib_id, int cls_id, int id);
 
+//
+// in v_move and plugin_free later called on source, dest remains registered
+//
+int plugin_refresh_id(int lib_id, int cls_id, int id);
+
 //
 // closes the plugin system
 //

src/common/var.c

@@ -9,6 +9,7 @@
 
 #include "common/sys.h"
 #include "common/sberr.h"
+#include "common/plugins.h"
 
 #define INT_STR_LEN 64
 
@@ -571,9 +572,9 @@ void v_move(var_t *dest, const var_t *src) {
     dest->v.m.map = src->v.m.map;
     dest->v.m.count = src->v.m.count;
     dest->v.m.size = src->v.m.size;
-    dest->v.m.id = src->v.m.id;
     dest->v.m.lib_id = src->v.m.lib_id;
     dest->v.m.cls_id = src->v.m.cls_id;
+    dest->v.m.id = plugin_refresh_id(src->v.m.lib_id, src->v.m.cls_id, src->v.m.id);
     break;
   case V_REF:
     dest->v.ref = src->v.ref;

src/common/var_map.c

@@ -317,9 +317,9 @@ void map_set(var_p_t dest, const var_p_t src) {
     hashmap_create(dest, src->v.m.count);
     hashmap_foreach(src, map_set_cb, &cb);
     dest->v.m.count = src->v.m.count;
-    dest->v.m.id = src->v.m.id;
-    dest->v.m.lib_id = -1;
-    dest->v.m.cls_id = -1;
+    dest->v.m.lib_id = src->v.m.lib_id;
+    dest->v.m.cls_id = src->v.m.cls_id;
+    dest->v.m.id = plugin_refresh_id(src->v.m.lib_id, src->v.m.cls_id, src->v.m.id);
   }
 }
 

src/include/module.h

@@ -120,13 +120,23 @@ int sblib_func_exec(int index, int param_count, slib_par_t *params, var_t *retva
 /**
  * @ingroup modlib
  *
- * executes a function
+ * free resources associated with the variable
  *
  * @param cls_id the variable class identifier
  * @param id the variable instance identifier
  */
 int sblib_free(int cls_id, int id);
 
+/**
+ * @ingroup modlib
+ *
+ * registers a fresh id to replace the given id
+ *
+ * @param cls_id the variable class identifier
+ * @param id the variable instance identifier
+ */
+int sblib_refresh_id(int cls_id, int id);
+
 /**
  * @ingroup modlib
  *