Add userAgent property to IEngine

Author: adazem009

include/scratchcpp/iengine.h

@@ -358,6 +358,12 @@ class LIBSCRATCHCPP_EXPORT IEngine
 
         /*! Returns the map of scripts (each top level block has a Script object). */
         virtual const std::unordered_map<std::shared_ptr<Block>, std::shared_ptr<Script>> &scripts() const = 0;
+
+        /*! Returns the user agent of the last person to edit the project. */
+        virtual const std::string &userAgent() const = 0;
+
+        /*! Sets the user agent of the last person to edit the project. */
+        virtual void setUserAgent(const std::string &agent) = 0;
 };
 
 } // namespace libscratchcpp

src/engine/internal/engine.cpp

@@ -1430,6 +1430,16 @@ BlockSectionContainer *Engine::blockSectionContainer(IBlockSection *section) con
     return nullptr;
 }
 
+const std::string &Engine::userAgent() const
+{
+    return m_userAgent;
+}
+
+void Engine::setUserAgent(const std::string &agent)
+{
+    m_userAgent = agent;
+}
+
 void Engine::finalize()
 {
     m_eventLoopMutex.lock();

src/engine/internal/engine.h

@@ -157,6 +157,9 @@ class Engine : public IEngine
         BlockSectionContainer *blockSectionContainer(const std::string &opcode) const;
         BlockSectionContainer *blockSectionContainer(IBlockSection *section) const;
 
+        const std::string &userAgent() const override;
+        void setUserAgent(const std::string &agent) override;
+
         IClock *m_clock = nullptr;
 
     private:
@@ -227,6 +230,7 @@ class Engine : public IEngine
         std::unordered_map<std::shared_ptr<Block>, std::shared_ptr<Script>> m_scripts;
         std::vector<BlockFunc> m_functions;
         std::recursive_mutex m_eventLoopMutex;
+        std::string m_userAgent;
 
         std::unordered_map<Target *, std::vector<Script *>> m_greenFlagHats;
         std::unordered_map<Target *, std::vector<Script *>> m_backdropChangeHats;

test/engine/engine_test.cpp

@@ -1767,6 +1767,15 @@ TEST(EngineTest, StopOtherScriptsInSprite)
     ASSERT_EQ(GET_VAR(stage, "l")->value().toInt(), 110);
 }
 
+TEST(EngineTest, UserAgent)
+{
+    Engine engine;
+    ASSERT_TRUE(engine.userAgent().empty());
+
+    engine.setUserAgent("test");
+    ASSERT_EQ(engine.userAgent(), "test");
+}
+
 TEST(EngineTest, NoCrashAfterStop)
 {
     // Regtest for #186

test/mocks/enginemock.h

@@ -134,6 +134,9 @@ class EngineMock : public IEngine
         MOCK_METHOD(void, setExtensions, (const std::vector<std::string> &), (override));
 
         MOCK_METHOD(const ScriptMap &, scripts, (), (const, override));
+
+        MOCK_METHOD(const std::string &, userAgent, (), (const, override));
+        MOCK_METHOD(void, setUserAgent, (const std::string &), (override));
 };
 
 } // namespace libscratchcpp