Use shared_ptr in IEngine::deinitClone()

Author: adazem009

include/scratchcpp/iengine.h

@@ -76,7 +76,7 @@ class LIBSCRATCHCPP_EXPORT IEngine
         virtual void initClone(std::shared_ptr<Sprite> clone) = 0;
 
         /*! Automatically called from clones that are being deleted. */
-        virtual void deinitClone(Sprite *clone) = 0;
+        virtual void deinitClone(std::shared_ptr<Sprite> clone) = 0;
 
         /*!
          * Calls and runs "when green flag clicked" blocks.

include/scratchcpp/sprite.h

@@ -13,7 +13,9 @@ class IGraphicsEffect;
 class SpritePrivate;
 
 /*! \brief The Sprite class represents a Scratch sprite. */
-class LIBSCRATCHCPP_EXPORT Sprite : public Target
+class LIBSCRATCHCPP_EXPORT Sprite
+    : public Target
+    , public std::enable_shared_from_this<Sprite>
 {
     public:
         enum class RotationStyle

src/engine/internal/engine.cpp

@@ -315,10 +315,10 @@ void Engine::initClone(std::shared_ptr<Sprite> clone)
     m_executableTargets.push_back(clone.get()); // execution order needs to be updated after this
 }
 
-void Engine::deinitClone(Sprite *clone)
+void Engine::deinitClone(std::shared_ptr<Sprite> clone)
 {
-    m_clones.erase(std::remove(m_clones.begin(), m_clones.end(), clone), m_clones.end());
-    m_executableTargets.erase(std::remove(m_executableTargets.begin(), m_executableTargets.end(), clone), m_executableTargets.end());
+    m_clones.erase(std::remove(m_clones.begin(), m_clones.end(), clone.get()), m_clones.end());
+    m_executableTargets.erase(std::remove(m_executableTargets.begin(), m_executableTargets.end(), clone.get()), m_executableTargets.end());
 }
 
 void Engine::run()

src/engine/internal/engine.h

@@ -37,7 +37,7 @@ class Engine : public IEngine
         void stopScript(VirtualMachine *vm) override;
         void stopTarget(Target *target, VirtualMachine *exceptScript) override;
         void initClone(std::shared_ptr<Sprite> clone) override;
-        void deinitClone(libscratchcpp::Sprite *clone) override;
+        void deinitClone(std::shared_ptr<Sprite> clone) override;
 
         void run() override;
         void runEventLoop() override;

src/scratch/sprite.cpp

@@ -99,7 +99,7 @@ void Sprite::deleteClone()
         IEngine *eng = engine();
 
         if (eng)
-            eng->deinitClone(this);
+            eng->deinitClone(shared_from_this());
 
         assert(impl->cloneSprite);
         impl->cloneDeleted = true;

test/blocks/control_blocks_test.cpp

@@ -949,10 +949,10 @@ TEST_F(ControlBlocksTest, CreateCloneOfImpl)
     ASSERT_EQ(vm.registerCount(), 0);
     ASSERT_EQ(sprite.clones().size(), 4);
 
-    EXPECT_CALL(m_engineMock, deinitClone(clone1.get()));
+    EXPECT_CALL(m_engineMock, deinitClone(clone1));
     clone1->deleteClone();
 
-    EXPECT_CALL(m_engineMock, deinitClone(clone3.get()));
+    EXPECT_CALL(m_engineMock, deinitClone(clone3));
     clone3->deleteClone();
 }
 
@@ -1007,7 +1007,7 @@ TEST_F(ControlBlocksTest, DeleteThisCloneImpl)
     vm.setFunctions(functions);
 
     EXPECT_CALL(m_engineMock, stopTarget(clone.get(), nullptr)).Times(1);
-    EXPECT_CALL(m_engineMock, deinitClone(clone.get()));
+    EXPECT_CALL(m_engineMock, deinitClone(clone));
 
     vm.setBytecode(bytecode);
     vm.run();

test/mocks/enginemock.h

@@ -22,7 +22,7 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, stopScript, (VirtualMachine *), (override));
         MOCK_METHOD(void, stopTarget, (Target *, VirtualMachine *), (override));
         MOCK_METHOD(void, initClone, (std::shared_ptr<Sprite>), (override));
-        MOCK_METHOD(void, deinitClone, (Sprite *), (override));
+        MOCK_METHOD(void, deinitClone, (std::shared_ptr<Sprite>), (override));
 
         MOCK_METHOD(void, run, (), (override));
         MOCK_METHOD(void, runEventLoop, (), (override));

test/scratch_classes/sprite_test.cpp

@@ -199,28 +199,28 @@ TEST(SpriteTest, Clone)
     ASSERT_EQ(clone2->costumes(), sprite.costumes());
 
     // Delete
-    EXPECT_CALL(engine, deinitClone(clone1.get()));
+    EXPECT_CALL(engine, deinitClone(clone1));
     clone1->deleteClone();
 
     ASSERT_EQ(clones.size(), 3);
     ASSERT_EQ(clones[0], clone2);
     ASSERT_EQ(clones[1], clone3);
     ASSERT_EQ(clones[2], clone4);
 
-    EXPECT_CALL(engine, deinitClone(clone3.get()));
+    EXPECT_CALL(engine, deinitClone(clone3));
     clone3->deleteClone();
 
     ASSERT_EQ(clones.size(), 2);
     ASSERT_EQ(clones[0], clone2);
     ASSERT_EQ(clones[1], clone4);
 
-    EXPECT_CALL(engine, deinitClone(clone2.get()));
+    EXPECT_CALL(engine, deinitClone(clone2));
     clone2->deleteClone();
 
     ASSERT_EQ(clones.size(), 1);
     ASSERT_EQ(clones[0], clone4);
 
-    EXPECT_CALL(engine, deinitClone(clone4.get()));
+    EXPECT_CALL(engine, deinitClone(clone4));
     clone4->deleteClone();
     ASSERT_TRUE(clones.empty());
 }

test/script/script_test.cpp

@@ -141,6 +141,6 @@ TEST_F(ScriptTest, Start)
     ASSERT_EQ(vm->lists()[0], lists[0]);
     ASSERT_EQ(vm->lists()[1], clone->listAt(clone->findListById("d")).get());
 
-    EXPECT_CALL(m_engine, deinitClone(clone.get()));
+    EXPECT_CALL(m_engine, deinitClone(clone));
     clone->deleteClone();
 }