Pass unsafe constants to CompilerContext

Author: adazem009

include/scratchcpp/compiler.h

@@ -164,7 +164,7 @@ class LIBSCRATCHCPP_EXPORT Compiler
 
         const std::unordered_set<std::string> &unsupportedBlocks() const;
 
-        static std::shared_ptr<CompilerContext> createContext(IEngine *engine, Target *target);
+        static std::shared_ptr<CompilerContext> createContext(IEngine *engine, Target *target, const std::unordered_set<std::string> &unsafeConstants);
 
     private:
         spimpl::unique_impl_ptr<CompilerPrivate> impl;

src/engine/compiler.cpp

@@ -751,8 +751,8 @@ const std::unordered_set<std::string> &Compiler::unsupportedBlocks() const
 }
 
 /*! Creates a compiler context for the given target. */
-std::shared_ptr<CompilerContext> Compiler::createContext(IEngine *engine, Target *target)
+std::shared_ptr<CompilerContext> Compiler::createContext(IEngine *engine, Target *target, const std::unordered_set<std::string> &unsafeConstants)
 {
     CompilerPrivate::initBuilderFactory();
-    return CompilerPrivate::builderFactory()->createCtx(engine, target);
+    return CompilerPrivate::builderFactory()->createCtx(engine, target, unsafeConstants);
 }

src/engine/compiler_p.cpp

@@ -18,7 +18,7 @@ CompilerPrivate::CompilerPrivate(CompilerContext *ctx) :
 }
 
 CompilerPrivate::CompilerPrivate(IEngine *engine, Target *target) :
-    ctxPtr(Compiler::createContext(engine, target)),
+    ctxPtr(Compiler::createContext(engine, target, {})), // NOTE: This constructor is only used in tests, so we can leave unsafe constants empty
     ctx(ctxPtr.get())
 {
     initBuilderFactory();

src/engine/internal/engine.cpp

@@ -85,6 +85,7 @@ void Engine::clear()
     m_broadcastMap.clear();
     m_broadcastSenders.clear();
     m_sortedDrawables.clear();
+    m_unsafeConstants.clear();
     m_threads.clear();
     m_threadsToStop.clear();
     m_scripts.clear();
@@ -245,10 +246,41 @@ void Engine::compile()
     // Resolve entities by ID
     resolveIds();
 
+    // Find unsafe constants (string numerals) in costume and sound names
+    m_unsafeConstants.clear();
+
+    for (auto target : m_targets) {
+        IEngine *engine = target->engine();
+
+        if (engine) {
+            auto checkConstant = [this](const std::string &str) {
+                Value stringValue(str);
+                Value numberValue(stringValue.toDouble());
+
+                if (stringValue.isValidNumber() && str == numberValue.toString())
+                    m_unsafeConstants.insert(str);
+            };
+
+            const auto &targets = engine->targets();
+            bool found = false;
+
+            for (const auto &target : targets) {
+                const auto &costumes = target->costumes();
+                const auto &sounds = target->sounds();
+
+                for (const auto &costume : costumes)
+                    checkConstant(costume->name());
+
+                for (const auto &sound : sounds)
+                    checkConstant(sound->name());
+            }
+        }
+    }
+
     // Compile scripts
     for (auto target : m_targets) {
         std::cout << "Compiling scripts in target " << target->name() << "..." << std::endl;
-        auto ctx = Compiler::createContext(this, target.get());
+        auto ctx = Compiler::createContext(this, target.get(), m_unsafeConstants);
         m_compilerContexts[target.get()] = ctx;
         Compiler compiler(ctx.get());
         const auto &blocks = target->blocks();
@@ -1789,7 +1821,7 @@ void Engine::compileMonitor(std::shared_ptr<Monitor> monitor)
     auto ext = blockExtension(block->opcode());
 
     if (ext) {
-        auto ctx = Compiler::createContext(this, target);
+        auto ctx = Compiler::createContext(this, target, m_unsafeConstants);
         Compiler compiler(ctx.get());
         MonitorNameFunc nameFunc = resolveMonitorNameFunc(ext, block->opcode());
 

src/engine/internal/engine.h

@@ -241,7 +241,8 @@ class LIBSCRATCHCPP_TEST_EXPORT Engine : public IEngine
         std::unordered_map<Broadcast *, Thread *> m_broadcastSenders; // used for resolving broadcast promises
         std::vector<std::shared_ptr<Monitor>> m_monitors;
         std::vector<std::string> m_extensions;
-        std::vector<Drawable *> m_sortedDrawables; // sorted by layer (reverse order of execution)
+        std::vector<Drawable *> m_sortedDrawables;         // sorted by layer (reverse order of execution)
+        std::unordered_set<std::string> m_unsafeConstants; // string numerals which shouldn't be optimized
         std::vector<std::shared_ptr<Thread>> m_threads;
         std::vector<std::shared_ptr<Thread>> m_threadsToStop;
         std::shared_ptr<Thread> m_activeThread;