Add a generic Instruction struct

Author: adazem009

src/engine/internal/codegen/CMakeLists.txt

@@ -4,6 +4,7 @@ target_sources(scratchcpp
     icodebuilderfactory.h
     codebuilderfactory.cpp
     codebuilderfactory.h
+    instruction.h
 )
 
 add_subdirectory(llvm)

src/engine/internal/codegen/instruction.h

@@ -0,0 +1,110 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <scratchcpp/compiler.h>
+
+namespace libscratchcpp
+{
+
+class BlockPrototype;
+
+template<typename TInstruction, typename TRegister>
+struct Instruction
+{
+        enum class Type
+        {
+            FunctionCall,
+            Add,
+            Sub,
+            Mul,
+            Div,
+            Random,
+            RandomInt,
+            CmpEQ,
+            CmpGT,
+            CmpLT,
+            StrCmpEQCS, // case sensitive
+            StrCmpEQCI, // case insensitive
+            And,
+            Or,
+            Not,
+            Mod,
+            Round,
+            Abs,
+            Floor,
+            Ceil,
+            Sqrt,
+            Sin,
+            Cos,
+            Tan,
+            Asin,
+            Acos,
+            Atan,
+            Ln,
+            Log10,
+            Exp,
+            Exp10,
+            StringConcat,
+            StringChar,
+            StringLength,
+            Select,
+            CreateLocalVariable,
+            WriteLocalVariable,
+            ReadLocalVariable,
+            WriteVariable,
+            ReadVariable,
+            ClearList,
+            RemoveListItem,
+            AppendToList,
+            InsertToList,
+            ListReplace,
+            GetListContents,
+            GetListItem,
+            GetListSize,
+            GetListItemIndex,
+            ListContainsItem,
+            Yield,
+            BeginIf,
+            BeginElse,
+            EndIf,
+            BeginRepeatLoop,
+            LoopIndex,
+            BeginWhileLoop,
+            BeginRepeatUntilLoop,
+            BeginLoopCondition,
+            EndLoop,
+            Stop,
+            ThreadStop,
+            InvalidateTarget,
+            CallProcedure,
+            ProcedureArg,
+            Print
+        };
+
+        Instruction(Type type, bool loopCondition) :
+            type(type),
+            loopCondition(loopCondition)
+        {
+        }
+
+        Type type;
+        std::string functionName;
+        std::vector<std::pair<Compiler::StaticType, TRegister *>> args; // target type, register
+        TRegister *functionReturnReg = nullptr;
+        bool functionTargetArg = false;                                  // whether to add target ptr to function parameters
+        bool functionCtxArg = false;                                     // whether to add execution context ptr to function parameters
+        Variable *targetVariable = nullptr;                              // for variables
+        List *targetList = nullptr;                                      // for lists
+        Compiler::StaticType targetType = Compiler::StaticType::Unknown; // variable or list type (before read/write operation)
+        BlockPrototype *procedurePrototype = nullptr;
+        size_t procedureArgIndex = 0;
+        bool loopCondition = false; // whether the instruction is part of a loop condition
+
+        // Linked list
+        TInstruction *previous = nullptr;
+        TInstruction *next = nullptr;
+        std::shared_ptr<TInstruction> _next; // ensure items are not deleted
+};
+
+} // namespace libscratchcpp

src/engine/internal/codegen/llvm/llvminstruction.h

@@ -4,6 +4,7 @@
 
 #include <scratchcpp/compiler.h>
 
+#include "../instruction.h"
 #include "llvmregister.h"
 
 namespace libscratchcpp
@@ -12,102 +13,12 @@ namespace libscratchcpp
 class LLVMLocalVariableInfo;
 class BlockPrototype;
 
-struct LLVMInstruction
+struct LLVMInstruction : Instruction<LLVMInstruction, LLVMRegister>
 {
-        enum class Type
-        {
-            FunctionCall,
-            Add,
-            Sub,
-            Mul,
-            Div,
-            Random,
-            RandomInt,
-            CmpEQ,
-            CmpGT,
-            CmpLT,
-            StrCmpEQCS, // case sensitive
-            StrCmpEQCI, // case insensitive
-            And,
-            Or,
-            Not,
-            Mod,
-            Round,
-            Abs,
-            Floor,
-            Ceil,
-            Sqrt,
-            Sin,
-            Cos,
-            Tan,
-            Asin,
-            Acos,
-            Atan,
-            Ln,
-            Log10,
-            Exp,
-            Exp10,
-            StringConcat,
-            StringChar,
-            StringLength,
-            Select,
-            CreateLocalVariable,
-            WriteLocalVariable,
-            ReadLocalVariable,
-            WriteVariable,
-            ReadVariable,
-            ClearList,
-            RemoveListItem,
-            AppendToList,
-            InsertToList,
-            ListReplace,
-            GetListContents,
-            GetListItem,
-            GetListSize,
-            GetListItemIndex,
-            ListContainsItem,
-            Yield,
-            BeginIf,
-            BeginElse,
-            EndIf,
-            BeginRepeatLoop,
-            LoopIndex,
-            BeginWhileLoop,
-            BeginRepeatUntilLoop,
-            BeginLoopCondition,
-            EndLoop,
-            Stop,
-            ThreadStop,
-            InvalidateTarget,
-            CallProcedure,
-            ProcedureArg,
-            Print
-        };
+        using Type = Instruction<LLVMInstruction, LLVMRegister>::Type;
+        using Instruction<LLVMInstruction, LLVMRegister>::Instruction; // inherit constructor
 
-        LLVMInstruction(Type type, bool loopCondition) :
-            type(type),
-            loopCondition(loopCondition)
-        {
-        }
-
-        Type type;
-        std::string functionName;
-        std::vector<std::pair<Compiler::StaticType, LLVMRegister *>> args; // target type, register
-        LLVMRegister *functionReturnReg = nullptr;
-        bool functionTargetArg = false;                                  // whether to add target ptr to function parameters
-        bool functionCtxArg = false;                                     // whether to add execution context ptr to function parameters
-        LLVMLocalVariableInfo *localVarInfo = nullptr;                   // for local variables
-        Variable *targetVariable = nullptr;                              // for variables
-        List *targetList = nullptr;                                      // for lists
-        Compiler::StaticType targetType = Compiler::StaticType::Unknown; // variable or list type (before read/write operation)
-        BlockPrototype *procedurePrototype = nullptr;
-        size_t procedureArgIndex = 0;
-        bool loopCondition = false; // whether the instruction is part of a loop condition
-
-        // Linked list
-        LLVMInstruction *previous = nullptr;
-        LLVMInstruction *next = nullptr;
-        std::shared_ptr<LLVMInstruction> _next; // ensure items are not deleted
+        LLVMLocalVariableInfo *localVarInfo = nullptr; // for local variables
 };
 
 } // namespace libscratchcpp