LLVMCodeBuilder: Add createStop() method

Author: adazem009

src/dev/engine/internal/icodebuilder.h

@@ -81,6 +81,8 @@ class ICodeBuilder
         virtual void endLoop() = 0;
 
         virtual void yield() = 0;
+
+        virtual void createStop() = 0;
 };
 
 } // namespace libscratchcpp

src/dev/engine/internal/llvm/llvmcodebuilder.cpp

@@ -68,6 +68,7 @@ std::shared_ptr<ExecutableCode> LLVMCodeBuilder::finalize()
     llvm::Value *targetLists = func->getArg(3);
 
     llvm::BasicBlock *entry = llvm::BasicBlock::Create(m_ctx, "entry", func);
+    llvm::BasicBlock *endBranch = llvm::BasicBlock::Create(m_ctx, "end", func);
     m_builder.SetInsertPoint(entry);
 
     // Init coroutine
@@ -898,9 +899,19 @@ std::shared_ptr<ExecutableCode> LLVMCodeBuilder::finalize()
                 popScopeLevel();
                 break;
             }
+
+            case LLVMInstruction::Type::Stop: {
+                m_builder.CreateBr(endBranch);
+                llvm::BasicBlock *nextBranch = llvm::BasicBlock::Create(m_ctx, "", func);
+                m_builder.SetInsertPoint(nextBranch);
+                break;
+            }
         }
     }
 
+    m_builder.CreateBr(endBranch);
+
+    m_builder.SetInsertPoint(endBranch);
     freeHeap();
     syncVariables(targetVariables);
 
@@ -1283,6 +1294,11 @@ void LLVMCodeBuilder::yield()
     m_instructions.push_back({ LLVMInstruction::Type::Yield });
 }
 
+void LLVMCodeBuilder::createStop()
+{
+    m_instructions.push_back({ LLVMInstruction::Type::Stop });
+}
+
 void LLVMCodeBuilder::initTypes()
 {
     m_valueDataType = LLVMTypes::createValueDataType(&m_builder);

src/dev/engine/internal/llvm/llvmcodebuilder.h

@@ -89,6 +89,8 @@ class LLVMCodeBuilder : public ICodeBuilder
 
         void yield() override;
 
+        void createStop() override;
+
     private:
         enum class Comparison
         {

src/dev/engine/internal/llvm/llvminstruction.h

@@ -61,7 +61,8 @@ struct LLVMInstruction
             BeginWhileLoop,
             BeginRepeatUntilLoop,
             BeginLoopCondition,
-            EndLoop
+            EndLoop,
+            Stop
         };
 
         LLVMInstruction(Type type) :

test/dev/llvm/llvmcodebuilder_test.cpp

@@ -3568,3 +3568,72 @@ TEST_F(LLVMCodeBuilderTest, LoopLists)
     code->run(ctx.get());
     ASSERT_EQ(testing::internal::GetCapturedStdout(), expected);
 }
+
+TEST_F(LLVMCodeBuilderTest, StopNoWarp)
+{
+    Sprite sprite;
+    createBuilder(&sprite, false);
+
+    m_builder->beginLoopCondition();
+    CompilerValue *v = m_builder->addConstValue(true);
+    m_builder->beginWhileLoop(v);
+    m_builder->createStop();
+    m_builder->endLoop();
+
+    m_builder->addTargetFunctionCall("test_function_no_args", Compiler::StaticType::Void, {}, {});
+
+    std::string expected = "";
+
+    auto code = m_builder->finalize();
+    Script script(&sprite, nullptr, nullptr);
+    script.setCode(code);
+    Thread thread(&sprite, nullptr, &script);
+    auto ctx = code->createExecutionContext(&thread);
+    testing::internal::CaptureStdout();
+    code->run(ctx.get());
+    ASSERT_EQ(testing::internal::GetCapturedStdout(), expected);
+}
+
+TEST_F(LLVMCodeBuilderTest, StopWarp)
+{
+    Sprite sprite;
+    createBuilder(&sprite, true);
+
+    CompilerValue *v = m_builder->addConstValue(true);
+    m_builder->beginIfStatement(v);
+    m_builder->createStop();
+    m_builder->endIf();
+
+    m_builder->addTargetFunctionCall("test_function_no_args", Compiler::StaticType::Void, {}, {});
+
+    std::string expected = "";
+
+    auto code = m_builder->finalize();
+    Script script(&sprite, nullptr, nullptr);
+    script.setCode(code);
+    Thread thread(&sprite, nullptr, &script);
+    auto ctx = code->createExecutionContext(&thread);
+    testing::internal::CaptureStdout();
+    code->run(ctx.get());
+    ASSERT_EQ(testing::internal::GetCapturedStdout(), expected);
+}
+
+TEST_F(LLVMCodeBuilderTest, StopAndReturn)
+{
+    Sprite sprite;
+    createBuilder(&sprite, true);
+
+    m_builder->addTargetFunctionCall("test_function_no_args", Compiler::StaticType::Void, {}, {});
+    m_builder->createStop();
+
+    std::string expected = "no_args\n";
+
+    auto code = m_builder->finalize();
+    Script script(&sprite, nullptr, nullptr);
+    script.setCode(code);
+    Thread thread(&sprite, nullptr, &script);
+    auto ctx = code->createExecutionContext(&thread);
+    testing::internal::CaptureStdout();
+    code->run(ctx.get());
+    ASSERT_EQ(testing::internal::GetCapturedStdout(), expected);
+}

test/mocks/codebuildermock.h

@@ -71,4 +71,6 @@ class CodeBuilderMock : public ICodeBuilder
         MOCK_METHOD(void, endLoop, (), (override));
 
         MOCK_METHOD(void, yield, (), (override));
+
+        MOCK_METHOD(void, createStop, (), (override));
 };