Merge pull request #143 from scratchcpp/running_api

Add project running API

Author: adazem009

libscratchcpp

@@ -11,6 +11,7 @@ ProjectScene {
 	readonly property string fileName: loader.fileName
     property int stageWidth: 480
     property int stageHeight: 360
+    readonly property bool running: loader.running
     property alias fps: loader.fps
     property alias turboMode: loader.turboMode
 	property alias cloneLimit: loader.cloneLimit

src/ProjectPlayer.qml

@@ -128,6 +128,11 @@ bool ProjectLoader::loadStatus() const
     return m_loadStatus;
 }
 
+bool ProjectLoader::running() const
+{
+    return m_running;
+}
+
 IEngine *ProjectLoader::engine() const
 {
     if (m_loadThread.isRunning())
@@ -216,9 +221,15 @@ void ProjectLoader::timerEvent(QTimerEvent *event)
     if (m_loadThread.isRunning())
         return;
 
-    if (m_engine)
+    if (m_engine) {
         m_engine->step();
 
+        if (m_running != m_engine->isRunning()) {
+            m_running = !m_running;
+            emit runningChanged();
+        }
+    }
+
     event->accept();
 }
 

src/projectloader.cpp

@@ -24,6 +24,7 @@ class ProjectLoader : public QObject
         QML_ELEMENT
         Q_PROPERTY(QString fileName READ fileName WRITE setFileName NOTIFY fileNameChanged)
         Q_PROPERTY(bool loadStatus READ loadStatus NOTIFY loadStatusChanged)
+        Q_PROPERTY(bool running READ running NOTIFY runningChanged)
         Q_PROPERTY(libscratchcpp::IEngine *engine READ engine NOTIFY engineChanged)
         Q_PROPERTY(StageModel *stage READ stage NOTIFY stageChanged)
         Q_PROPERTY(QQmlListProperty<SpriteModel> sprites READ sprites NOTIFY spritesChanged)
@@ -48,6 +49,8 @@ class ProjectLoader : public QObject
 
         bool loadStatus() const;
 
+        bool running() const;
+
         libscratchcpp::IEngine *engine() const;
         void setEngine(libscratchcpp::IEngine *engine);
 
@@ -96,6 +99,7 @@ class ProjectLoader : public QObject
         void fileNameChanged();
         void loadStatusChanged();
         void loadingFinished();
+        void runningChanged();
         void engineChanged();
         void stageChanged();
         void spritesChanged();
@@ -135,6 +139,7 @@ class ProjectLoader : public QObject
         QString m_fileName;
         QFuture<void> m_loadThread;
         libscratchcpp::Project m_project;
+        bool m_running = false;
         libscratchcpp::IEngine *m_engine = nullptr;
         QMutex m_engineMutex;
         bool m_loadStatus = false;

src/projectloader.h

@@ -19,9 +19,9 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, start, (), (override));
         MOCK_METHOD(void, stop, (), (override));
         MOCK_METHOD(VirtualMachine *, startScript, (std::shared_ptr<Block>, Target *), (override));
-        MOCK_METHOD(void, broadcast, (int), (override));
-        MOCK_METHOD(void, broadcastByPtr, (Broadcast *), (override));
-        MOCK_METHOD(void, startBackdropScripts, (Broadcast *), (override));
+        MOCK_METHOD(void, broadcast, (int, VirtualMachine *), (override));
+        MOCK_METHOD(void, broadcastByPtr, (Broadcast *, VirtualMachine *), (override));
+        MOCK_METHOD(void, startBackdropScripts, (Broadcast *, VirtualMachine *), (override));
         MOCK_METHOD(void, stopScript, (VirtualMachine *), (override));
         MOCK_METHOD(void, stopTarget, (Target *, VirtualMachine *), (override));
         MOCK_METHOD(void, initClone, (std::shared_ptr<Sprite>), (override));
@@ -82,9 +82,6 @@ class EngineMock : public IEngine
         MOCK_METHOD(bool, spriteFencingEnabled, (), (const, override));
         MOCK_METHOD(void, setSpriteFencingEnabled, (bool), (override));
 
-        MOCK_METHOD(bool, broadcastRunning, (unsigned int), (override));
-        MOCK_METHOD(bool, broadcastByPtrRunning, (Broadcast *), (override));
-
         MOCK_METHOD(void, requestRedraw, (), (override));
 
         MOCK_METHOD(ITimer *, timer, (), (const, override));

test/mocks/enginemock.h

@@ -163,12 +163,35 @@ TEST_F(ProjectLoaderTest, StartStop)
 TEST_F(ProjectLoaderTest, TimerEvent)
 {
     ProjectLoader loader;
+    ASSERT_FALSE(loader.running());
     EngineMock engine;
     loader.setEngine(&engine);
     QTimerEvent event(0);
 
+    QSignalSpy runningSpy(&loader, &ProjectLoader::runningChanged);
     EXPECT_CALL(engine, step());
+    EXPECT_CALL(engine, isRunning()).WillOnce(Return(false));
     QCoreApplication::sendEvent(&loader, &event);
+    ASSERT_FALSE(loader.running());
+    ASSERT_TRUE(runningSpy.empty());
+
+    EXPECT_CALL(engine, step());
+    EXPECT_CALL(engine, isRunning()).WillOnce(Return(true));
+    QCoreApplication::sendEvent(&loader, &event);
+    ASSERT_TRUE(loader.running());
+    ASSERT_EQ(runningSpy.size(), 1);
+
+    EXPECT_CALL(engine, step());
+    EXPECT_CALL(engine, isRunning()).WillOnce(Return(true));
+    QCoreApplication::sendEvent(&loader, &event);
+    ASSERT_TRUE(loader.running());
+    ASSERT_EQ(runningSpy.size(), 1);
+
+    EXPECT_CALL(engine, step());
+    EXPECT_CALL(engine, isRunning()).WillOnce(Return(false));
+    QCoreApplication::sendEvent(&loader, &event);
+    ASSERT_FALSE(loader.running());
+    ASSERT_EQ(runningSpy.size(), 2);
 }
 
 TEST_F(ProjectLoaderTest, QuestionAsked)