fix(snapshot): cleare temporary data used for reconstruction

reconstructing globals from a snapshot leaves some state behind, when reconstruction again globals from the same snapshot this data need to be cleared first.

refactor: fixes clang compiler warnings

Author: JBenda

.clang-format-ignore

@@ -0,0 +1 @@
+inkcpp_compiler/json.hpp

.pre-commit-config.yaml

@@ -1,9 +1,10 @@
 repos:
   - repo: https://github.com/pre-commit/mirrors-clang-format
-    rev: v18.1.0
+    rev: v18.1.8
     hooks:
     - id: clang-format
       types_or: [c++, c, cuda]
+      exclude: inkcpp_compiler/json.hpp
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0

inkcpp/array.h

@@ -57,9 +57,17 @@ class managed_array : public snapshot_interface
 		}
 	}
 
-	const T& operator[](size_t i) const { return data()[i]; }
+	const T& operator[](size_t i) const
+	{
+		inkAssert(i < _size, "Access array out of bounds, index %u in array of size %u", i, _size);
+		return data()[i];
+	}
 
-	T& operator[](size_t i) { return data()[i]; }
+	T& operator[](size_t i)
+	{
+		inkAssert(i < _size, "Access array out of bounds, index %u in array of size %u", i, _size);
+		return data()[i];
+	}
 
 	const T* data() const
 	{

inkcpp/avl_array.h

@@ -70,7 +70,7 @@ class avl_array
 	ink::runtime::internal::if_t<dynamic, std::int8_t*, std::int8_t[Size]> balance_;
 	ink::runtime::internal::if_t<dynamic, child_type*, child_type[Size]>   child_;
 	size_type                                                              size_; // actual size
-	size_type                                                              _capacity;
+	size_type                                                                     _capacity;
 	size_type                                                              root_; // root node
 	ink::runtime::internal::if_t<dynamic, size_type*, size_type[Fast ? Size : 1]> parent_;
 
@@ -112,6 +112,12 @@ class avl_array
 			return *this;
 		}
 
+		tag_avl_array_iterator(const tag_avl_array_iterator& other)
+		    : instance_{other.instance_}
+		    , idx_{other.idx_}
+		{
+		}
+
 		inline bool operator==(const tag_avl_array_iterator& rhs) const { return idx_ == rhs.idx_; }
 
 		inline bool operator!=(const tag_avl_array_iterator& rhs) const { return ! (*this == rhs); }

inkcpp/choice.cpp

@@ -16,7 +16,10 @@ namespace ink
 namespace runtime
 {
 
-	size_t choice::num_tags() const { return static_cast<size_t>(std::distance(_tags_start, _tags_end)); }
+	size_t choice::num_tags() const
+	{
+		return static_cast<size_t>(std::distance(_tags_start, _tags_end));
+	}
 
 	const char* choice::get_tag(size_t index) const
 	{

inkcpp/collections/restorable.cpp

@@ -16,10 +16,10 @@ unsigned char*
 	ptr = snapshot_interface::snap_write(ptr, jump, write);
 	ptr = snapshot_interface::snap_write(ptr, save, write);
 	max = pos;
-	if (jump != ~0 && jump > max) {
+	if (jump != ~0U && jump > max) {
 		max = jump;
 	}
-	if (save != ~0 && save > max) {
+	if (save != ~0U && save > max) {
 		max = save;
 	}
 	return ptr;
@@ -32,10 +32,10 @@ const unsigned char*
 	ptr = snapshot_interface::snap_read(ptr, jump);
 	ptr = snapshot_interface::snap_read(ptr, save);
 	max = pos;
-	if (jump != ~0 && jump > max) {
+	if (jump != ~0U && jump > max) {
 		max = jump;
 	}
-	if (save != ~0 && save > max) {
+	if (save != ~0U && save > max) {
 		max = save;
 	}
 	return ptr;

inkcpp/collections/restorable.h

@@ -6,7 +6,7 @@
  */
 #pragma once
 
-#include "../snapshot_impl.h"
+#include "../snapshot_interface.h"
 
 #include <system.h>
 #include <traits.h>
@@ -102,15 +102,15 @@ class restorable : public snapshot_interface
 	}
 
 	// Checks if we have a save state
-	bool is_saved() const { return _save != ~0; }
+	bool is_saved() const { return _save != ~0U; }
 
 	// Creates a save point which can later be restored to or forgotten
 	void save()
 	{
 		inkAssert(
-		    _save == ~0, "Collection is already saved. You should never call save twice. Ignoring."
+		    _save == ~0U, "Collection is already saved. You should never call save twice. Ignoring."
 		);
-		if (_save != ~0) {
+		if (_save != ~0U) {
 			return;
 		}
 
@@ -121,8 +121,8 @@ class restorable : public snapshot_interface
 	// Restore to the last save point
 	void restore()
 	{
-		inkAssert(_save != ~0, "Collection can't be restored because it's not saved. Ignoring.");
-		if (_save == ~0) {
+		inkAssert(_save != ~0U, "Collection can't be restored because it's not saved. Ignoring.");
+		if (_save == ~0U) {
 			return;
 		}
 
@@ -137,8 +137,8 @@ class restorable : public snapshot_interface
 	template<typename NullifyMethod>
 	void forget(NullifyMethod nullify)
 	{
-		inkAssert(_save != ~0, "Can't forget save point because there is none. Ignoring.");
-		if (_save == ~0) {
+		inkAssert(_save != ~0U, "Can't forget save point because there is none. Ignoring.");
+		if (_save == ~0U) {
 			return;
 		}
 
@@ -170,7 +170,7 @@ class restorable : public snapshot_interface
 	ElementType& push(const ElementType& elem)
 	{
 		// Don't destroy saved data. Jump over it
-		if (_pos < _save && _save != ~0) {
+		if (_pos < _save && _save != ~0U) {
 			_jump = _pos;
 			_pos  = _save;
 		}
@@ -279,7 +279,7 @@ class restorable : public snapshot_interface
 	void for_each_all(CallbackMethod callback) const
 	{
 		// no matter if we're saved or not, we iterate everything
-		int len = (_save == ~0 || _pos > _save) ? _pos : _save;
+		int len = (_save == ~0U || _pos > _save) ? _pos : _save;
 
 		// Iterate
 		for (int i = 0; i < len; i++)
@@ -358,10 +358,7 @@ class restorable : public snapshot_interface
 
 protected:
 	// Called when we run out of space in buffer.
-	virtual void overflow(ElementType*&, size_t&)
-	{
-		inkFail("Restorable run out of memory!");
-	}
+	virtual void overflow(ElementType*&, size_t&) { inkFail("Restorable run out of memory!"); }
 
 private:
 	template<typename Predicate>

inkcpp/container_operations.cpp

@@ -13,40 +13,35 @@
 
 #include <iostream>
 
-namespace ink::runtime::internal {
+namespace ink::runtime::internal
+{
 
-	void operation<Command::READ_COUNT_VAR, value_type::divert, void>::operator()(
-			basic_eval_stack& stack, value* vals)
-	{
-		container_t id;
-		bool success = _story.get_container_id(
-			_story.instructions() + vals[0].get<value_type::divert>(),
-			id);
-		inkAssert(success, "failed to find container to read visit count!");
-		stack.push(value{}.set<value_type::int32>(
-				static_cast<int32_t>(_visit_counts.visits( id )
-			)));
-	}
-
-	void operation<Command::TURNS, value_type::divert, void>::operator()(
-		basic_eval_stack& stack, value* vals)
-	{
-		container_t id;
-		bool success = _story.get_container_id(
-			_story.instructions() + vals[0].get<value_type::divert>(),
-			id);
-		inkAssert(success, "failed to find container to read turn count!");
-		stack.push(value{}.set<value_type::int32>(
-						static_cast<int32_t>(_visit_counts.turns(id)
-					)));
-	}
+void operation<Command::READ_COUNT_VAR, value_type::divert, void>::operator()(
+    basic_eval_stack& stack, value* vals
+)
+{
+	container_t id;
+	bool        success
+	    = _story.get_container_id(_story.instructions() + vals[0].get<value_type::divert>(), id);
+	inkAssert(success, "failed to find container to read visit count!");
+	stack.push(value{}.set<value_type::int32>(static_cast<int32_t>(_visit_counts.visits(id))));
+}
 
-	void operation<Command::CHOICE_COUNT, value_type::none, void>::operator()
-		(basic_eval_stack& stack, value*)
-	{
-		stack.push(value{}.set<value_type::int32>(static_cast<int32_t>(
-						_runner.num_choices()
-					)));
-	}
+void operation<Command::TURNS, value_type::divert, void>::operator()(
+    basic_eval_stack& stack, value* vals
+)
+{
+	container_t id;
+	bool        success
+	    = _story.get_container_id(_story.instructions() + vals[0].get<value_type::divert>(), id);
+	inkAssert(success, "failed to find container to read turn count!");
+	stack.push(value{}.set<value_type::int32>(static_cast<int32_t>(_visit_counts.turns(id))));
+}
 
+void operation<
+    Command::CHOICE_COUNT, value_type::none, void>::operator()(basic_eval_stack& stack, value*)
+{
+	stack.push(value{}.set<value_type::int32>(static_cast<int32_t>(_runner.num_choices())));
 }
+
+} // namespace ink::runtime::internal