More info about script story ID collisions-> "Move engine script story ID under EngineExternal (default is "off")"

Author: mnelenpridumivat

src/xrCore/_stl_extensions.h

@@ -114,6 +114,27 @@ using xr_hash_map = std::unordered_map<K, V, std::hash<K>, _Traits, allocator>;
 template <typename K, typename H = std::hash<K>, class _Traits = std::equal_to<K>, typename allocator = xalloc<K> >
 using xr_hash_set = std::unordered_set<K, H, _Traits, allocator>;
 
+#if __cplusplus > 202002L
+#include <scope>
+using xr_scope_exit = std::scope_exit;
+#else
+template<typename T>
+requires requires(T a) { {a()} -> void; }
+struct xr_scope_exit
+{
+	T Func;
+	bool IsActive = true;
+	xr_scope_exit(T &&t) : Func(t) {}
+	~xr_scope_exit(){ if (IsActive) { Func(); }}
+	void release() { IsActive = false; }
+
+	xr_scope_exit(const xr_scope_exit&) = delete;
+	xr_scope_exit& operator=(const xr_scope_exit&) = delete;
+	xr_scope_exit(xr_scope_exit&&) noexcept = default;
+	xr_scope_exit& operator=(xr_scope_exit&&) noexcept = default;
+};
+#endif
+
 struct pred_str {
 	IC bool operator()(const char* x, const char* y) const				{	return xr_strcmp(x,y)<0;	}
 };

src/xrGame/ScriptsSubsystems/StoryID/StoryIDManager.cpp

@@ -30,7 +30,9 @@ void CScriptStoryIDManager::VerifiedRegisterObject(CSE_Abstract* se_obj)
             R_ASSERT3(false, "There is no 'story_id' field in [story_object] section :object", se_obj->name());
         }
         if (value)
+        {
             self.Register(se_obj->ID, value);
+        }
         return;
     }
     auto story_id = READ_IF_EXISTS(pSettings, r_string, se_obj->name(), "story_id", nullptr);
@@ -92,31 +94,38 @@ void CScriptStoryIDManager::script_register(lua_State* L)
 void CScriptStoryIDManager::Register(ALife::_OBJECT_ID obj_id, shared_str script_story_id)
 {
     xrSRWLockGuard guard(m_containers_lock);
+    VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
+    auto Finally = xr_scope_exit([this]()
+    {
+        VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
+    });
     auto ByIDIt = m_containers_by_id.find(obj_id);
     auto ByScriptStoryIDIt = m_containers_by_script_story_id.find(script_story_id);
     if (ByScriptStoryIDIt != m_containers_by_script_story_id.end() && ByScriptStoryIDIt->second != obj_id)
     {
-        xr_string message = "You are trying to spawn two or more objects with the same story_id:[";
-        message.append(script_story_id.c_str());
-        message.append("] --> [");
-        auto ExistName = ai().alife().objects().object(ByScriptStoryIDIt->second)->name();
-        message.append(ExistName);
-        message.append("] try to add:[");
-        auto NewName = ai().alife().objects().object(obj_id)->name();
-        message.append(NewName);
-        message.append("]");
-        R_ASSERT2(ByScriptStoryIDIt == m_containers_by_script_story_id.end(), message.c_str());
+        auto ObjExist = ai().alife().objects().object(ByScriptStoryIDIt->second);
+        auto ObjNew = ai().alife().objects().object(obj_id);
+        I_ASSERT_M(false,
+            "You are trying to spawn two or more objects with the same story_id [%s]: Old Obj [%d][%s], New obj [%d][%s]",
+            script_story_id.c_str(),
+            ObjExist->ID,
+            ObjExist->name(),
+            std::to_string(ObjNew->ID),
+            ObjNew->name()
+            );
     }
     if (ByIDIt != m_containers_by_id.end()){
         VERIFY(ByScriptStoryIDIt != m_containers_by_script_story_id.end());
         if(ByScriptStoryIDIt->first != script_story_id){
-            xr_string message = "Object [";
-            message.append(script_story_id.c_str());
-            message.append("] is already in story_objects_registry with story_id[");
-            message.append(ByIDIt->second.c_str());
-            R_ASSERT2(ByScriptStoryIDIt != m_containers_by_script_story_id.end(), message.c_str());
+            I_ASSERT_M(false,
+                "Object [%d][%s] is already in story_objects_registry with story_id [%s]",
+                ByIDIt->first,
+                script_story_id.c_str(),
+                ByIDIt->second.c_str()
+                );
         }else
         {
+            VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
             return;
         }
     }
@@ -127,6 +136,11 @@ void CScriptStoryIDManager::Register(ALife::_OBJECT_ID obj_id, shared_str script
 void CScriptStoryIDManager::Unregister(ALife::_OBJECT_ID obj_id)
 {
     xrSRWLockGuard guard(m_containers_lock);
+    VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
+    auto Finally = xr_scope_exit([this]()
+    {
+        VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
+    });
     if (m_containers_by_id.contains(obj_id)){
         auto elem = *m_containers_by_id.find(obj_id);
         m_containers_by_id.erase(elem.first);
@@ -137,6 +151,11 @@ void CScriptStoryIDManager::Unregister(ALife::_OBJECT_ID obj_id)
 void CScriptStoryIDManager::Unregister(LPCSTR script_story_id)
 {
     xrSRWLockGuard guard(m_containers_lock);
+    VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
+    auto Finally = xr_scope_exit([this]()
+    {
+        VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
+    });
     if (m_containers_by_script_story_id.contains(script_story_id)){
         auto elem = *m_containers_by_script_story_id.find(script_story_id);
         m_containers_by_id.erase(elem.second);
@@ -147,13 +166,15 @@ void CScriptStoryIDManager::Unregister(LPCSTR script_story_id)
 ALife::_OBJECT_ID CScriptStoryIDManager::GetID(LPCSTR script_story_id) const
 {
     xrSRWLockGuard guard(m_containers_lock, true);
+    VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
     auto it = m_containers_by_script_story_id.find(script_story_id);
     return it != m_containers_by_script_story_id.end() ? it->second : ALife::_OBJECT_ID(-1);
 }
 
 LPCSTR CScriptStoryIDManager::GetID(ALife::_OBJECT_ID obj_id) const
 {
     xrSRWLockGuard guard(m_containers_lock, true);
+    VERIFY(m_containers_by_id.size() == m_containers_by_script_story_id.size());
     auto it = m_containers_by_id.find(obj_id);
     return it != m_containers_by_id.end() ? it->second.c_str() : nullptr;
 }