Add clone limit

Author: adazem009

include/scratchcpp/iengine.h

@@ -140,6 +140,12 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Sets the stage height. */
         virtual void setStageHeight(unsigned int height) = 0;
 
+        /*! Returns the maximum number of clones (or -1 if the limit is disabled). */
+        virtual int cloneLimit() const = 0;
+
+        /*! Sets the maximum number of clones (use -1 or any negative number to disable the limit). */
+        virtual void setCloneLimit(int limit) = 0;
+
         /*! Returns true if there are any running script of the broadcast with the given index. */
         virtual bool broadcastRunning(unsigned int index, VirtualMachine *sourceScript) = 0;
 

src/engine/internal/engine.cpp

@@ -311,7 +311,7 @@ void Engine::stopTarget(Target *target, VirtualMachine *exceptScript)
 
 void Engine::initClone(Sprite *clone)
 {
-    if (!clone)
+    if (!clone || ((m_cloneLimit >= 0) && (m_clones.size() >= m_cloneLimit)))
         return;
 
     Sprite *source = clone->cloneParent();
@@ -481,6 +481,16 @@ void Engine::setStageHeight(unsigned int height)
     m_stageHeight = height;
 }
 
+int Engine::cloneLimit() const
+{
+    return m_cloneLimit;
+}
+
+void Engine::setCloneLimit(int limit)
+{
+    m_cloneLimit = limit < 0 ? -1 : limit;
+}
+
 bool Engine::broadcastRunning(unsigned int index, VirtualMachine *sourceScript)
 {
     if (index < 0 || index >= m_broadcasts.size())

src/engine/internal/engine.h

@@ -63,6 +63,9 @@ class Engine : public IEngine
         unsigned int stageHeight() const override;
         void setStageHeight(unsigned int height) override;
 
+        int cloneLimit() const override;
+        void setCloneLimit(int limit) override;
+
         bool broadcastRunning(unsigned int index, VirtualMachine *sourceScript) override;
         bool broadcastByPtrRunning(Broadcast *broadcast, VirtualMachine *sourceScript) override;
 
@@ -146,6 +149,7 @@ class Engine : public IEngine
         bool m_mousePressed = false;
         unsigned int m_stageWidth = 480;
         unsigned int m_stageHeight = 360;
+        int m_cloneLimit = 300;
         std::vector<Sprite *> m_clones;
 
         bool m_running = false;

test/clone_limit.sb3

@@ -547,6 +547,58 @@ TEST(EngineTest, Clones)
     }
 }
 
+TEST(EngineTest, CloneLimit)
+{
+    Project p("clone_limit.sb3");
+    ASSERT_TRUE(p.load());
+    auto engine = p.engine();
+    ASSERT_EQ(engine->cloneLimit(), 300);
+
+    // TODO: Set "infinite" FPS and remove this (#254)
+    engine->setFps(100000);
+
+    Stage *stage = engine->stage();
+    ASSERT_TRUE(stage);
+
+    p.run();
+    ASSERT_VAR(stage, "count");
+    ASSERT_EQ(GET_VAR(stage, "count")->value().toInt(), 300);
+    ASSERT_VAR(stage, "delete_passed");
+    ASSERT_TRUE(GET_VAR(stage, "delete_passed")->value().toBool());
+
+    engine->setCloneLimit(475);
+    ASSERT_EQ(engine->cloneLimit(), 475);
+    p.run();
+    ASSERT_VAR(stage, "count");
+    ASSERT_EQ(GET_VAR(stage, "count")->value().toInt(), 475);
+    ASSERT_VAR(stage, "delete_passed");
+    ASSERT_TRUE(GET_VAR(stage, "delete_passed")->value().toBool());
+
+    engine->setCloneLimit(0);
+    ASSERT_EQ(engine->cloneLimit(), 0);
+    p.run();
+    ASSERT_VAR(stage, "count");
+    ASSERT_EQ(GET_VAR(stage, "count")->value().toInt(), 0);
+    ASSERT_VAR(stage, "delete_passed");
+    ASSERT_TRUE(GET_VAR(stage, "delete_passed")->value().toBool());
+
+    engine->setCloneLimit(-1);
+    ASSERT_EQ(engine->cloneLimit(), -1);
+    p.run();
+    ASSERT_VAR(stage, "count");
+    ASSERT_GT(GET_VAR(stage, "count")->value().toInt(), 500);
+    ASSERT_VAR(stage, "delete_passed");
+    ASSERT_TRUE(GET_VAR(stage, "delete_passed")->value().toBool());
+
+    engine->setCloneLimit(-5);
+    ASSERT_EQ(engine->cloneLimit(), -1);
+    p.run();
+    ASSERT_VAR(stage, "count");
+    ASSERT_GT(GET_VAR(stage, "count")->value().toInt(), 500);
+    ASSERT_VAR(stage, "delete_passed");
+    ASSERT_TRUE(GET_VAR(stage, "delete_passed")->value().toBool());
+}
+
 // TODO: Uncomment this after fixing #256 and #257
 /*TEST(EngineTest, BackdropBroadcasts)
 {

test/engine/engine_test.cpp

@@ -50,6 +50,9 @@ class EngineMock : public IEngine
         MOCK_METHOD(unsigned int, stageHeight, (), (const, override));
         MOCK_METHOD(void, setStageHeight, (unsigned int), (override));
 
+        MOCK_METHOD(int, cloneLimit, (), (const, override));
+        MOCK_METHOD(void, setCloneLimit, (int), (override));
+
         MOCK_METHOD(bool, broadcastRunning, (unsigned int, VirtualMachine *), (override));
         MOCK_METHOD(bool, broadcastByPtrRunning, (Broadcast *, VirtualMachine *), (override));