Merge pull request #274 from scratchcpp/find_stage_by_reserved_name

Use a reserved name for the stage in IEngine::findTarget()

Author: adazem009

include/scratchcpp/iengine.h

@@ -237,7 +237,11 @@ class LIBSCRATCHCPP_EXPORT IEngine
         /*! Returns the target at index. */
         virtual Target *targetAt(int index) const = 0;
 
-        /*! Returns the index of the target with the given name. */
+        /*!
+         * Returns the index of the target with the given name.
+         * \note Using "Stage" will return the index of the sprite with this name, or nullptr if it doesn't exist.
+         *       Use the "_stage_" reserved name to get the stage, or use the stage() method.
+         */
         virtual int findTarget(const std::string &targetName) const = 0;
 
         /*! Returns the Stage. */

src/engine/internal/engine.cpp

@@ -729,7 +729,7 @@ int Engine::findTarget(const std::string &targetName) const
 {
     int i = 0;
     for (auto target : m_targets) {
-        if (target->name() == targetName)
+        if ((target->isStage() && targetName == "_stage_") || (!target->isStage() && target->name() == targetName))
             return i;
         i++;
     }

test/compiler/compiler_test.cpp

@@ -179,8 +179,7 @@ TEST_F(CompilerTest, ResolveIds)
     ASSERT_EQ(engine->broadcasts().size(), 1);
 
     // Stage
-    ASSERT_NE(engine->findTarget("Stage"), -1);
-    Stage *stage = dynamic_cast<Stage *>(engine->targetAt(engine->findTarget("Stage")));
+    Stage *stage = engine->stage();
     ASSERT_TRUE(stage);
     ASSERT_EQ(stage->blocks().size(), 2);
     auto block = stage->greenFlagBlocks().at(0);

test/engine/engine_test.cpp

@@ -440,7 +440,7 @@ TEST(EngineTest, Targets)
     t2->setName("Sprite2");
     t2->addBlock(block1);
     t2->addBlock(block2);
-    auto t3 = std::make_shared<Target>();
+    auto t3 = std::make_shared<Stage>();
     t3->setName("Stage");
     engine.setTargets({ t1, t2, t3 });
 
@@ -454,7 +454,18 @@ TEST(EngineTest, Targets)
     ASSERT_EQ(engine.findTarget("invalid"), -1);
     ASSERT_EQ(engine.findTarget("Sprite1"), 0);
     ASSERT_EQ(engine.findTarget("Sprite2"), 1);
+    ASSERT_EQ(engine.findTarget("Stage"), -1);
+    ASSERT_EQ(engine.findTarget("_stage_"), 2);
+
+    auto t4 = std::make_shared<Target>();
+    t4->setName("Stage");
+    engine.setTargets({ t1, t2, t4 });
     ASSERT_EQ(engine.findTarget("Stage"), 2);
+    ASSERT_EQ(engine.findTarget("_stage_"), -1);
+
+    engine.setTargets({ t1, t2, t3, t4 });
+    ASSERT_EQ(engine.findTarget("Stage"), 3);
+    ASSERT_EQ(engine.findTarget("_stage_"), 2);
 
     ASSERT_EQ(t1->engine(), &engine);
     ASSERT_EQ(t2->engine(), &engine);
@@ -545,7 +556,7 @@ TEST(EngineTest, Clones)
 
     auto engine = p.engine();
 
-    Target *stage = engine->targetAt(engine->findTarget("Stage"));
+    Stage *stage = engine->stage();
     ASSERT_TRUE(stage);
 
     ASSERT_VAR(stage, "clone1");
@@ -592,7 +603,7 @@ TEST(EngineTest, Clones)
 
     auto engine = p.engine();
 
-    Target *stage = engine->targetAt(engine->findTarget("Stage"));
+    Stage *stage = engine->stage();
     ASSERT_TRUE(stage);
 
     ASSERT_VAR(stage, "test1");

test/load_project/load_project_test.cpp

@@ -73,8 +73,7 @@ TEST(LoadProjectTest, LoadTestProject)
         ASSERT_EQ(engine->broadcasts().size(), 1);
 
         // Stage
-        ASSERT_NE(engine->findTarget("Stage"), -1);
-        Stage *stage = dynamic_cast<Stage *>(engine->targetAt(engine->findTarget("Stage")));
+        Stage *stage = engine->stage();
         ASSERT_EQ(stage->variables().size(), 2);
         ASSERT_EQ(stage->lists().size(), 1);