Avoid leaking map_itr_t in is_subscribed(). Updated map and stack doc.

FedeDP · Aug 20, 2019 · a7a0dd5 · a7a0dd5
1 parent 3b70803
commit a7a0dd5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/Lib/pubsub.c b/Lib/pubsub.c
@@ -35,6 +35,7 @@ static bool is_subscribed(mod_t *mod, const char *topic) {
         /* Execute regular expression */
         int ret = regexec(reg, topic, 0, NULL, 0);
         if (!ret) {
+            memhook._free(itr);
             return true;
         }
     }

diff --git a/docs/src/map.rst b/docs/src/map.rst
@@ -53,7 +53,7 @@ Where not specified, these functions return a map_ret_code.
 
 .. c:function:: map_itr_new(m)
 
-  Create a new map iterator object.
+  Create a new map iterator object. Note that it can be freed with free().
 
   :param m: pointer to map_t
   :type m: :c:type:`const map_t *`
@@ -62,7 +62,7 @@ Where not specified, these functions return a map_ret_code.
 
 .. c:function:: map_itr_next(itr)
 
-  Get next iterator.
+  Get next iterator. If next iterator is past last element, iterator will be automatically freed for you.
 
   :param itr: pointer to map_itr_t
   :type itr: :c:type:`map_itr_t *`

diff --git a/docs/src/stack.rst b/docs/src/stack.rst
@@ -49,7 +49,7 @@ Where not specified, these functions return a stack_ret_code.
 
 .. c:function:: stack_itr_new(s)
 
-  Create a new stack_itr_t object.
+  Create a new stack_itr_t object. Note that it can be freed with free().
 
   :param s: pointer to stack_t
   :type s: :c:type:`const stack_t *`
@@ -58,7 +58,7 @@ Where not specified, these functions return a stack_ret_code.
 
 .. c:function:: stack_itr_next(itr)
 
-  Get next iterator.
+  Get next iterator. If next iterator is past last element, iterator will be automatically freed for you.
 
   :param itr: pointer to stack_itr_t
   :type itr: :c:type:`stack_itr_t *`