Refactor user pointers

hexagonrecursion · Feb 2, 2025 · ba04b1f · ba04b1f
1 parent 9fdb5b1
commit ba04b1f
Show file tree

Hide file tree

Showing 14 changed files with 128 additions and 118 deletions.
diff --git a/CBot/CMakeLists.txt b/CBot/CMakeLists.txt
@@ -167,7 +167,6 @@ target_sources(CBot PRIVATE
     src/CBot/CBotVar/CBotVarString.h
     src/CBot/context/cbot_context.cpp
     src/CBot/context/cbot_context.h
-    src/CBot/context/cbot_user_pointer.h
     src/CBot/context/context_observer.h
     src/CBot/context/context_owner.h
     src/CBot/context/external_call_list_interface.h
@@ -181,6 +180,8 @@ target_sources(CBot PRIVATE
     src/CBot/stdlib/StringFunctions.cpp
     src/CBot/stdlib/stdlib.h
     src/CBot/stdlib/stdlib_public.h
+    src/CBot/user_pointer.cpp
+    src/CBot/user_pointer.h
 )
 
 target_include_directories(CBot PUBLIC src)

diff --git a/CBot/src/CBot/CBotInstr/CBotFieldExpr.cpp b/CBot/src/CBot/CBotInstr/CBotFieldExpr.cpp
@@ -25,8 +25,6 @@
 
 #include "CBot/CBotVar/CBotVarClass.h"
 
-#include "CBot/context/cbot_user_pointer.h"
-
 #include <cassert>
 #include <sstream>
 
@@ -88,13 +86,10 @@ bool CBotFieldExpr::ExecuteVar(CBotVar* &pVar, CBotStack* &pile, CBotToken* prev
             return pj->Return(pile);
         }
 
-        if (const auto& userPtr = pItem->GetUserPointer())
+        if (pItem->GetUserPointer().GetState() == PtrState::Dead)
         {
-            if (userPtr->GetPointerAs<void>() == nullptr)
-            {
-                pile->SetError(CBotErrDeletedPtr, prevToken);
-                return pj->Return(pile);
-            }
+            pile->SetError(CBotErrDeletedPtr, prevToken);
+            return pj->Return(pile);
         }
     }
 

diff --git a/CBot/src/CBot/CBotStack.cpp b/CBot/src/CBot/CBotStack.cpp
@@ -31,7 +31,6 @@
 #include "CBot/CBotProgram.h"
 
 #include "CBot/context/cbot_context.h"
-#include "CBot/context/cbot_user_pointer.h"
 
 #include <cassert>
 #include <cstdint>

diff --git a/CBot/src/CBot/CBotVar/CBotVar.cpp b/CBot/src/CBot/CBotVar/CBotVar.cpp
@@ -41,8 +41,6 @@
 
 #include "CBot/CBotEnums.h"
 
-#include "CBot/context/cbot_user_pointer.h"
-
 #include <cassert>
 #include <cmath>
 #include <cstdio>
@@ -98,14 +96,17 @@ void CBotVar::Update()
 {
 }
 
-void CBotVar::SetUserPointer(std::unique_ptr<CBotUserPointer> user)
+void CBotVar::SetUserPointer(void* user)
+{
+}
+
+void CBotVar::KillUserPointer()
 {
 }
 
-const std::unique_ptr<CBotUserPointer>& CBotVar::GetUserPointer()
+VarUserPointer CBotVar::GetUserPointer()
 {
-    const static std::unique_ptr<CBotUserPointer> emptyPtr{nullptr};
-    return emptyPtr;
+    return {};
 }
 
 void CBotVar::SetUniqNum(long n)

diff --git a/CBot/src/CBot/CBotVar/CBotVar.h b/CBot/src/CBot/CBotVar/CBotVar.h
@@ -23,6 +23,7 @@
 #include "CBot/CBotTypResult.h"
 #include "CBot/CBotEnums.h"
 #include "CBot/CBotUtils.h"
+#include "CBot/user_pointer.h"
 
 #include <cstdint>
 #include <memory>
@@ -35,7 +36,6 @@ class CBotClass;
 class CBotContext;
 class CBotInstr;
 class CBotToken;
-class CBotUserPointer;
 class CBotVar;
 class CBotVarClass;
 
@@ -149,13 +149,17 @@ class CBotVar : public CBotLinkedList<CBotVar>
      * \brief Set a custom pointer associated with this variable
      * \param user custom pointer to set
      */
-    virtual void SetUserPointer(std::unique_ptr<CBotUserPointer> user);
+    virtual void SetUserPointer(void* user);
 
     /**
-     * \brief Returns the custom pointer associated with this variable
-     * \return A pointer set with SetUserPointer()
+     * \brief Set user pointer as dead
      */
-    virtual const std::unique_ptr<CBotUserPointer>& GetUserPointer();
+    virtual void KillUserPointer();
+
+    /**
+     * \brief Return the custom pointer associated with this variable
+     */
+    virtual VarUserPointer GetUserPointer();
 
     //@}
 

diff --git a/CBot/src/CBot/CBotVar/CBotVarClass.cpp b/CBot/src/CBot/CBotVar/CBotVarClass.cpp
@@ -26,7 +26,6 @@
 #include "CBot/CBotInstr/CBotInstr.h"
 
 #include "CBot/context/cbot_context.h"
-#include "CBot/context/cbot_user_pointer.h"
 
 #include <cassert>
 
@@ -195,24 +194,23 @@ CBotClass* CBotVarClass::GetClass()
 
 void CBotVarClass::Update()
 {
-    if (!m_userPtr) return;
-
-    void* user = m_userPtr->GetPointerAs<void>();
-
-    if (user == nullptr) return;
-
+    if (m_userPtr.GetState() != PtrState::Alive) return;
+    void* user = m_userPtr.Get();
     m_pClass->Update(this, user);
 }
 
-void CBotVarClass::SetUserPointer(std::unique_ptr<CBotUserPointer> user)
+void CBotVarClass::SetUserPointer(void* user)
 {
-    if (m_userPtr)
-        assert(false);
-    else
-        m_userPtr = std::move(user);
+    assert(m_userPtr.GetState() == PtrState::UnInit);
+    m_userPtr.Set(user);
+}
+
+void CBotVarClass::KillUserPointer()
+{
+    m_userPtr.Kill();
 }
 
-const std::unique_ptr<CBotUserPointer>& CBotVarClass::GetUserPointer()
+VarUserPointer CBotVarClass::GetUserPointer()
 {
     return m_userPtr;
 }

diff --git a/CBot/src/CBot/CBotVar/CBotVarClass.h b/CBot/src/CBot/CBotVar/CBotVarClass.h
@@ -55,8 +55,9 @@ class CBotVarClass : public CBotVar
     bool Save1State(std::ostream &ostr, CBotContext& context) override;
 
     void Update() override;
-    void SetUserPointer(std::unique_ptr<CBotUserPointer> user) override;
-    const std::unique_ptr<CBotUserPointer>& GetUserPointer() override;
+    void SetUserPointer(void* user) override;
+    void KillUserPointer() override;
+    VarUserPointer GetUserPointer() override;
 
     CBotVarSPtr GetPointer() override;
 
@@ -78,7 +79,7 @@ class CBotVarClass : public CBotVar
     //! Set after constructor is called, allows destructor to be called
     bool m_bConstructor;
 
-    std::unique_ptr<CBotUserPointer> m_userPtr;
+    VarUserPointer m_userPtr;
 
     friend class CBotVar;
     friend class CBotVarPointer;

diff --git a/CBot/src/CBot/CBotVar/CBotVarPointer.cpp b/CBot/src/CBot/CBotVar/CBotVarPointer.cpp
@@ -25,8 +25,6 @@
 #include "CBot/CBotEnums.h"
 #include "CBot/CBotUtils.h"
 
-#include "CBot/context/cbot_user_pointer.h"
-
 #include <cassert>
 
 namespace CBot
@@ -63,15 +61,20 @@ void CBotVarPointer::Update()
     if (m_pVarClass) m_pVarClass->Update();
 }
 
-void CBotVarPointer::SetUserPointer(std::unique_ptr<CBotUserPointer> user)
+void CBotVarPointer::SetUserPointer(void* user)
+{
+    if (m_pVarClass) m_pVarClass->SetUserPointer(user);
+}
+
+void CBotVarPointer::KillUserPointer()
 {
-    if (m_pVarClass) m_pVarClass->SetUserPointer(std::move(user));
+    if (m_pVarClass) m_pVarClass->KillUserPointer();
 }
 
-const std::unique_ptr<CBotUserPointer>& CBotVarPointer::GetUserPointer()
+VarUserPointer CBotVarPointer::GetUserPointer()
 {
     if (m_pVarClass) return m_pVarClass->GetUserPointer();
-    return CBotVar::GetUserPointer();
+    return {};
 }
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -208,45 +211,15 @@ bool CBotVarPointer::Eq(CBotVar* left, CBotVar* right)
     auto r = right->GetPointer();
 
     if ( l == r ) return true;
-    if ( l == nullptr )
-    {
-        if (const auto& rUser = r->GetUserPointer())
-        {
-            if (rUser->GetPointerAs<void>() == nullptr) return true;
-        }
-    }
-    if ( r == nullptr )
-    {
-        if (const auto& lUser = l->GetUserPointer())
-        {
-            if (lUser->GetPointerAs<void>() == nullptr) return true;
-        }
-    }
+    if ( l == nullptr && r->GetUserPointer().GetState() == PtrState::Dead) return true;
+    if ( r == nullptr && l->GetUserPointer().GetState() == PtrState::Dead) return true;
     return false;
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 bool CBotVarPointer::Ne(CBotVar* left, CBotVar* right)
 {
-    auto l = left->GetPointer();
-    auto r = right->GetPointer();
-
-    if ( l == r ) return false;
-    if ( l == nullptr )
-    {
-        if (const auto& rUser = r->GetUserPointer())
-        {
-            if (rUser->GetPointerAs<void>() == nullptr) return false;
-        }
-    }
-    if ( r == nullptr )
-    {
-        if (const auto& lUser = l->GetUserPointer())
-        {
-            if (lUser->GetPointerAs<void>() == nullptr) return false;
-        }
-    }
-    return true;
+    return !Eq(left, right);
 }
 
 } // namespace CBot
diff --git a/CBot/src/CBot/CBotVar/CBotVarPointer.h b/CBot/src/CBot/CBotVar/CBotVarPointer.h
@@ -58,8 +58,9 @@ class CBotVarPointer : public CBotVar
     bool Save1State(std::ostream &ostr, CBotContext& context) override;
 
     void Update() override;
-    void SetUserPointer(std::unique_ptr<CBotUserPointer> user) override;
-    const std::unique_ptr<CBotUserPointer>& GetUserPointer() override;
+    void SetUserPointer(void* user) override;
+    void KillUserPointer() override;
+    VarUserPointer GetUserPointer() override;
 
     bool Eq(CBotVar* left, CBotVar* right) override;
     bool Ne(CBotVar* left, CBotVar* right) override;

diff --git a/CBot/src/CBot/stdlib/stdlib_public.h b/CBot/src/CBot/stdlib/stdlib_public.h
@@ -21,8 +21,6 @@
 
 #include "CBot/stdlib/Compilation.h"
 
-#include "CBot/context/cbot_user_pointer.h"
-
 #include <filesystem>
 #include <memory>
 #include <unordered_map>

diff --git a/CBot/src/CBot/user_pointer.cpp b/CBot/src/CBot/user_pointer.cpp
@@ -0,0 +1,49 @@
+/*
+ * This file is part of the Colobot: Gold Edition source code
+ * Copyright (C) 2025, Daniel Roux, EPSITEC SA & TerranovaTeam
+ * http://epsitec.ch; http://colobot.info; http://github.com/colobot
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ * See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see http://gnu.org/licenses
+ */
+
+#include <cassert>
+#include "CBot/user_pointer.h"
+
+namespace CBot
+{
+
+PtrState VarUserPointer::GetState() const
+{
+    return m_state;
+}
+
+void* VarUserPointer::Get() const
+{
+    return m_p;
+}
+
+void VarUserPointer::Set(void* p)
+{
+    assert(p != nullptr);
+    m_p = p;
+    m_state = PtrState::Alive;
+}
+
+void VarUserPointer::Kill()
+{
+    m_p = nullptr;
+    m_state = PtrState::Dead;
+}
+
+} // namespace CBot