VirtualMachine: Add warp instruction

Author: adazem009

src/engine/virtualmachine.cpp

@@ -83,7 +83,8 @@ const unsigned int VirtualMachine::instruction_arg_count[] = {
     1, // OP_CALL_PROCEDURE
     0, // OP_ADD_ARG
     1, // OP_READ_ARG
-    0  // OP_BREAK_ATOMIC
+    0, // OP_BREAK_ATOMIC
+    0  // OP_WARP
 };
 ;
 
@@ -222,13 +223,15 @@ unsigned int *VirtualMachine::run(unsigned int *pos)
         &&do_call_procedure,
         &&do_add_arg,
         &&do_read_arg,
-        &&do_break_atomic
+        &&do_break_atomic,
+        &&do_warp
     };
     unsigned int *loopStart;
     unsigned int *loopEnd;
     size_t loopCount;
     m_atEnd = false;
     m_atomic = true;
+    m_warp = false;
     DISPATCH();
 
 do_halt:
@@ -324,13 +327,13 @@ do_loop_end : {
             pos = l.start;
         else
             m_loops.pop_back();
-        if (!m_atomic) {
+        if (!m_atomic && !m_warp) {
             m_engine->breakFrame();
             return pos;
         }
         DISPATCH();
     } else {
-        if (!m_atomic) {
+        if (!m_atomic && !m_warp) {
             m_engine->breakFrame();
             return pos - 1;
         }
@@ -683,15 +686,18 @@ do_exec : {
         m_procedureArgTree.clear();
         m_procedureArgs = nullptr;
         m_nextProcedureArgs = nullptr;
-        if (!m_atomic)
+        if (!m_atomic && !m_warp)
             m_engine->breakFrame();
         if (m_goBack) {
             m_goBack = false;
             pos -= instruction_arg_count[OP_EXEC] + 1;
             m_freeExecRegs = ret;
         } else
             FREE_REGS(ret);
-        return pos;
+        if (m_warp)
+            DISPATCH();
+        else
+            return pos;
     }
     FREE_REGS(ret);
     DISPATCH();
@@ -723,4 +729,8 @@ do_exec : {
 do_break_atomic:
     m_atomic = false;
     DISPATCH();
+
+do_warp:
+    m_warp = true;
+    DISPATCH();
 }

src/engine/virtualmachine.h

@@ -73,7 +73,8 @@ enum Opcode
     OP_CALL_PROCEDURE, /*! Calls the procedure (custom block) with the index in the argument. */
     OP_ADD_ARG,        /*!< Adds a procedure (custom block) argument with the value from the last register. */
     OP_READ_ARG,       /*!< Reads the procedure (custom block) argument with the index in the argument and stores the value in the last register. */
-    OP_BREAK_ATOMIC    /*!< Breaks current frame at the end of the loop. */
+    OP_BREAK_ATOMIC,   /*!< Breaks current frame at the end of the loop. */
+    OP_WARP            /*! Runs the script without screen refresh. */
 };
 
 }
@@ -116,9 +117,12 @@ class LIBSCRATCHCPP_EXPORT VirtualMachine
          * \param[in] savePos Changes the return value of savePos().
          * \param[in] breakAtomic Whether to break the frame after stopping the script.
          * \param[in] goBack Whether to go back so that the current instruction can run again in the future.
+         * \note Nothing will happen if the script is set to run without screen refresh.
          */
         void stop(bool savePos = true, bool breakAtomic = false, bool goBack = false)
         {
+            if (m_warp)
+                return;
             m_stop = true;
             m_savePos = savePos;
             m_atomic = !breakAtomic;
@@ -153,6 +157,7 @@ class LIBSCRATCHCPP_EXPORT VirtualMachine
         std::vector<Value> *m_procedureArgs = nullptr;
         std::vector<Value> *m_nextProcedureArgs = nullptr;
         bool m_atomic;
+        bool m_warp;
         bool m_stop = false;
         bool m_savePos = true;
         bool m_goBack = false;