Merge pull request #577 from scratchcpp/thread_class

Add Thread class

Author: adazem009

CMakeLists.txt

@@ -32,6 +32,7 @@ target_sources(scratchcpp
     include/scratchcpp/iengine.h
     include/scratchcpp/iextension.h
     include/scratchcpp/iblocksection.h
+    include/scratchcpp/thread.h
     include/scratchcpp/asset.h
     include/scratchcpp/costume.h
     include/scratchcpp/sound.h

include/scratchcpp/iengine.h

@@ -23,6 +23,7 @@ class Stage;
 class Variable;
 class List;
 class Script;
+class Thread;
 class ITimer;
 class KeyEvent;
 class Monitor;
@@ -58,26 +59,26 @@ class LIBSCRATCHCPP_EXPORT IEngine
         virtual void stop() = 0;
 
         /*! Starts a script with the given top level block as the given Target (a sprite or the stage). */
-        virtual VirtualMachine *startScript(std::shared_ptr<Block> topLevelBlock, Target *) = 0;
+        virtual Thread *startScript(std::shared_ptr<Block> topLevelBlock, Target *) = 0;
 
         /*! Starts the scripts of the broadcast with the given index. */
-        virtual void broadcast(int index, VirtualMachine *sender) = 0;
+        virtual void broadcast(int index, Thread *sender) = 0;
 
         /*! Starts the scripts of the given broadcast. */
-        virtual void broadcastByPtr(Broadcast *broadcast, VirtualMachine *sender) = 0;
+        virtual void broadcastByPtr(Broadcast *broadcast, Thread *sender) = 0;
 
         /*! Starts the "when backdrop switches to" scripts for the given backdrop broadcast. */
-        virtual void startBackdropScripts(Broadcast *broadcast, VirtualMachine *sender) = 0;
+        virtual void startBackdropScripts(Broadcast *broadcast, Thread *sender) = 0;
 
         /*! Stops the given script. */
-        virtual void stopScript(VirtualMachine *vm) = 0;
+        virtual void stopScript(Thread *vm) = 0;
 
         /*!
          * Stops all scripts in the given target.
          * \param[in] target The Target to stop.
          * \param[in] exceptScript Sets this parameter to stop all scripts except the given script.
          */
-        virtual void stopTarget(Target *target, VirtualMachine *exceptScript) = 0;
+        virtual void stopTarget(Target *target, Thread *exceptScript) = 0;
 
         /*! Calls the "when I start as a clone" blocks of the given sprite. */
         virtual void initClone(std::shared_ptr<Sprite> clone) = 0;
@@ -121,7 +122,7 @@ class LIBSCRATCHCPP_EXPORT IEngine
         virtual sigslot::signal<> &aboutToRender() = 0;
 
         /*! Emits when a script is about to stop. */
-        virtual sigslot::signal<VirtualMachine *> &threadAboutToStop() = 0;
+        virtual sigslot::signal<Thread *> &threadAboutToStop() = 0;
 
         /*! Emits when the project is stopped by calling stop(). */
         virtual sigslot::signal<> &stopped() = 0;

include/scratchcpp/script.h

@@ -15,7 +15,7 @@ class Target;
 class Block;
 class IEngine;
 class Value;
-class VirtualMachine;
+class Thread;
 class Variable;
 class List;
 class ScriptPrivate;
@@ -42,8 +42,8 @@ class LIBSCRATCHCPP_EXPORT Script
         void setVariables(const std::vector<Variable *> &variables);
         void setLists(const std::vector<List *> &lists);
 
-        std::shared_ptr<VirtualMachine> start();
-        std::shared_ptr<VirtualMachine> start(Target *target);
+        std::shared_ptr<Thread> start();
+        std::shared_ptr<Thread> start(Target *target);
 
     private:
         BlockFunc *getFunctions() const;

include/scratchcpp/thread.h

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "global.h"
+#include "spimpl.h"
+
+namespace libscratchcpp
+{
+
+class VirtualMachine;
+class Target;
+class IEngine;
+class Script;
+class ThreadPrivate;
+
+/*! \brief The Thread class represents a running Scratch script. */
+class LIBSCRATCHCPP_EXPORT Thread
+{
+    public:
+        Thread(Target *target, IEngine *engine, Script *script);
+        Thread(const Thread &) = delete;
+
+        VirtualMachine *vm() const;
+        Target *target() const;
+        IEngine *engine() const;
+        Script *script() const;
+
+        void run();
+        void kill();
+        void reset();
+
+        bool isFinished() const;
+
+        void promise();
+        void resolvePromise();
+
+    private:
+        spimpl::unique_impl_ptr<ThreadPrivate> impl;
+};
+
+} // namespace libscratchcpp

include/scratchcpp/virtualmachine.h

@@ -88,14 +88,15 @@ enum Opcode
 class Target;
 class IEngine;
 class Script;
+class Thread;
 class List;
 
 /*! \brief The VirtualMachine class is a virtual machine for compiled Scratch scripts. */
 class LIBSCRATCHCPP_EXPORT VirtualMachine
 {
     public:
         VirtualMachine();
-        VirtualMachine(Target *target, IEngine *engine, Script *script);
+        VirtualMachine(Target *target, IEngine *engine, Script *script, Thread *thread = nullptr);
         VirtualMachine(const VirtualMachine &) = delete;
 
         void setProcedures(unsigned int **procedures);
@@ -121,6 +122,7 @@ class LIBSCRATCHCPP_EXPORT VirtualMachine
         Target *target() const;
         IEngine *engine() const;
         Script *script() const;
+        Thread *thread() const;
 
         const Value *getInput(unsigned int index, unsigned int argCount) const;
 

src/blocks/controlblocks.cpp

@@ -204,7 +204,7 @@ unsigned int ControlBlocks::stopAll(VirtualMachine *vm)
 
 unsigned int ControlBlocks::stopOtherScriptsInSprite(VirtualMachine *vm)
 {
-    vm->engine()->stopTarget(vm->target(), vm);
+    vm->engine()->stopTarget(vm->target(), vm->thread());
     return 0;
 }
 

src/blocks/eventblocks.cpp

@@ -181,7 +181,7 @@ unsigned int EventBlocks::broadcast(VirtualMachine *vm)
     std::vector<int> broadcasts = vm->engine()->findBroadcasts(vm->getInput(0, 1)->toString());
 
     for (int index : broadcasts)
-        vm->engine()->broadcast(index, vm);
+        vm->engine()->broadcast(index, vm->thread());
 
     return 1;
 }
@@ -191,7 +191,7 @@ unsigned int EventBlocks::broadcastAndWait(VirtualMachine *vm)
     std::vector<int> broadcasts = vm->engine()->findBroadcasts(vm->getInput(0, 1)->toString());
 
     for (int index : broadcasts)
-        vm->engine()->broadcast(index, vm);
+        vm->engine()->broadcast(index, vm->thread());
 
     vm->promise();
 

src/blocks/looksblocks.cpp

@@ -2,6 +2,7 @@
 
 #include <scratchcpp/iengine.h>
 #include <scratchcpp/compiler.h>
+#include <scratchcpp/thread.h>
 #include <scratchcpp/sprite.h>
 #include <scratchcpp/stage.h>
 #include <scratchcpp/input.h>
@@ -99,9 +100,9 @@ void LooksBlocks::registerBlocks(IEngine *engine)
 
 void LooksBlocks::onInit(IEngine *engine)
 {
-    engine->threadAboutToStop().connect([](VirtualMachine *vm) {
-        m_timeMap.erase(vm);
-        erase_if(m_waitingBubbles, [vm](const std::pair<Target *, VirtualMachine *> &pair) { return pair.second == vm; });
+    engine->threadAboutToStop().connect([](Thread *thread) {
+        m_timeMap.erase(thread->vm());
+        erase_if(m_waitingBubbles, [thread](const std::pair<Target *, VirtualMachine *> &pair) { return pair.second == thread->vm(); });
     });
 
     engine->stopped().connect([engine]() {
@@ -892,7 +893,7 @@ void LooksBlocks::startBackdropScripts(VirtualMachine *vm, bool wait)
 {
     if (Stage *stage = vm->engine()->stage()) {
         if (stage->costumes().size() > 0)
-            vm->engine()->startBackdropScripts(stage->currentCostume()->broadcast(), vm);
+            vm->engine()->startBackdropScripts(stage->currentCostume()->broadcast(), vm->thread());
     }
 }
 

src/blocks/motionblocks.cpp

@@ -2,6 +2,7 @@
 
 #include <scratchcpp/iengine.h>
 #include <scratchcpp/compiler.h>
+#include <scratchcpp/thread.h>
 #include <scratchcpp/sprite.h>
 #include <scratchcpp/input.h>
 #include <scratchcpp/field.h>
@@ -73,9 +74,9 @@ void MotionBlocks::registerBlocks(IEngine *engine)
 
 void MotionBlocks::onInit(IEngine *engine)
 {
-    engine->threadAboutToStop().connect([](VirtualMachine *vm) {
-        m_timeMap.erase(vm);
-        m_glideMap.erase(vm);
+    engine->threadAboutToStop().connect([](Thread *thread) {
+        m_timeMap.erase(thread->vm());
+        m_glideMap.erase(thread->vm());
     });
 }
 

src/blocks/sensingblocks.cpp

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 #include <scratchcpp/virtualmachine.h>
+#include <scratchcpp/thread.h>
 #include <scratchcpp/compiler.h>
 #include <scratchcpp/iengine.h>
 #include <scratchcpp/itimer.h>
@@ -99,16 +100,17 @@ void SensingBlocks::registerBlocks(IEngine *engine)
 
 void SensingBlocks::onInit(IEngine *engine)
 {
-    engine->threadAboutToStop().connect([engine](VirtualMachine *thread) {
+    engine->threadAboutToStop().connect([engine](Thread *thread) {
         if (!m_questionList.empty()) {
             // Abort the question of this thread if it's currently being displayed
-            if (m_questionList.front()->vm == thread) {
+            if (m_questionList.front()->vm == thread->vm()) {
                 thread->target()->setBubbleText("");
                 engine->questionAborted()();
             }
 
-            m_questionList
-                .erase(std::remove_if(m_questionList.begin(), m_questionList.end(), [thread](const std::unique_ptr<Question> &question) { return question->vm == thread; }), m_questionList.end());
+            m_questionList.erase(
+                std::remove_if(m_questionList.begin(), m_questionList.end(), [thread](const std::unique_ptr<Question> &question) { return question->vm == thread->vm(); }),
+                m_questionList.end());
         }
     });
 }