add on_clear parameter on storage.clear method

Andre-LA · Jan 12, 2023 · f704e36 · f704e36
1 parent 361b5ea
commit f704e36
Show file tree

Hide file tree

Showing 29 changed files with 31 additions and 19 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/.gitignore b/.gitignore
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
diff --git a/docs/component.md b/docs/component.md
diff --git a/docs/concepts.md b/docs/concepts.md
diff --git a/docs/derived_entity.md b/docs/derived_entity.md
diff --git a/docs/entity.md b/docs/entity.md
diff --git a/docs/gen_idx.md b/docs/gen_idx.md
@@ -12,7 +12,7 @@ Generational Index module
 ```lua
 local GenIdx = @record{
   index: usize,      -- 0-based, since this is an index for arrays
-  generation: usize, -- 1-based: 1 is the "first" valid generation, 0 is invalid
+  generation: uint16, -- 1-based: 1 is the "first" valid generation, 0 is invalid
 }
 ```
 

diff --git a/docs/storage.md b/docs/storage.md
@@ -1,11 +1,11 @@
 ### Summary
 * [storage](#storage)
-* [storage:clear](#storageclear)
 * [storage:push](#storagepush)
 * [storage:remove](#storageremove)
 * [storage:mget](#storagemget)
 * [storage:__mnext](#storage__mnext)
 * [storage:__mpairs](#storage__mpairs)
+* [storage:clear](#storageclear)
 * [storage](#storage)
 
 ## storage
@@ -33,14 +33,6 @@ local storage = @record{
 
 the storage type
 
-### storage:clear
-
-```lua
-function storage:clear()
-```
-
-resets storage to a zeroed state
-
 ### storage:push
 
 ```lua
@@ -57,14 +49,17 @@ the generational index of the used slot and a reference to the inserted entry.
 ### storage:remove
 
 ```lua
-function storage:remove(idx: GenIdx): boolean
+function storage:remove(idx: GenIdx, destroyer: facultative(function(*T))): boolean
 ```
 
 Removes an entry associated with the generational index.
 
 If the entry is found, then the slot it's zeroed and the function returns `true`. Othewise
 it does nothing and returns `false`.
 
+You can optionally pass a `destroyer` function, which will be called passing a pointer to
+the entry, this is useful if you need to free resources on this entry.
+
 ### storage:mget
 
 ```lua
@@ -95,6 +90,14 @@ function storage:__mpairs(): (auto, *storage, isize)
 Iterator for `mpairs`, this allows using `for in` using the `mpairs` iterator on
 the storage, it iterates only on the entries and skips unused slots.
 
+### storage:clear
+
+```lua
+function storage:clear(on_clear: facultative(function(*T)))
+```
+
+resets storage to a zeroed state
+
 ### storage
 
 ```lua

diff --git a/docs/system.md b/docs/system.md
diff --git a/docs/utils.md b/docs/utils.md
diff --git a/examples/basic.nelua b/examples/basic.nelua
diff --git a/examples/bench.nelua b/examples/bench.nelua
diff --git a/examples/derived.nelua b/examples/derived.nelua
diff --git a/examples/derived_entity_tree.nelua b/examples/derived_entity_tree.nelua
diff --git a/examples/entity_tree.nelua b/examples/entity_tree.nelua
diff --git a/examples/entity_with_destroy.nelua b/examples/entity_with_destroy.nelua
diff --git a/examples/override.nelua b/examples/override.nelua
diff --git a/gen-docs.lua b/gen-docs.lua
diff --git a/nldoc.lua b/nldoc.lua
diff --git a/rotor/component.nelua b/rotor/component.nelua
diff --git a/rotor/concepts.nelua b/rotor/concepts.nelua
diff --git a/rotor/derived_entity.nelua b/rotor/derived_entity.nelua
diff --git a/rotor/entity.nelua b/rotor/entity.nelua
diff --git a/rotor/gen_idx.nelua b/rotor/gen_idx.nelua
@@ -7,7 +7,7 @@
 -- each index unique between re-uses.
 local GenIdx = @record{
   index: usize,      -- 0-based, since this is an index for arrays
-  generation: usize, -- 1-based: 1 is the "first" valid generation, 0 is invalid
+  generation: uint16, -- 1-based: 1 is the "first" valid generation, 0 is invalid
 }
 
 -- The `is_genidx` trait

diff --git a/rotor/storage.nelua b/rotor/storage.nelua
@@ -56,13 +56,6 @@ local GenIdx = require 'rotor.gen_idx'
     return found, next_idx
   end
 
-  -- resets storage to a zeroed state
-  function storage:clear()
-    self.unavailables = {}
-    self.generations = {}
-    self.next_idx = 0
-  end
-
   --[[
   Push a new entry on the storage on the next free slot, if no free slots are available,
   then a warning will be printed and this function will return `false`, a zeroed generational
@@ -148,6 +141,22 @@ local GenIdx = require 'rotor.gen_idx'
   function storage:__mpairs(): (auto, *storage, isize)
     return storage.__mnext, self, -1
   end
+
+  -- resets storage to a zeroed state
+  function storage:clear(on_clear: facultative(function(*T)))
+    ## if not on_clear.type.is_niltype then
+      check(on_clear, "Passed an nilptr 'on_clear' function!")
+
+      for _, entry in mpairs(self) do
+        on_clear(entry)
+      end
+    ## end
+
+    self.entries = {}
+    self.unavailables = {}
+    self.generations = {}
+    self.next_idx = 0
+  end
 
   ## return storage
 ## end)

diff --git a/rotor/system.nelua b/rotor/system.nelua
diff --git a/rotor/utils.nelua b/rotor/utils.nelua