Add a separate class for building LLVM instructions

Author: adazem009

src/engine/internal/llvm/CMakeLists.txt

@@ -28,3 +28,5 @@ target_sources(scratchcpp
     llvmexecutioncontext.cpp
     llvmexecutioncontext.h
 )
+
+add_subdirectory(instructions)

src/engine/internal/llvm/instructions/CMakeLists.txt

@@ -0,0 +1,8 @@
+target_sources(scratchcpp
+  PRIVATE
+    instructionbuilder.cpp
+    instructionbuilder.h
+    instructiongroup.cpp
+    instructiongroup.h
+    processresult.h
+)

src/engine/internal/llvm/instructions/instructionbuilder.cpp

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "instructionbuilder.h"
+
+using namespace libscratchcpp;
+using namespace libscratchcpp::llvmins;
+
+InstructionBuilder::InstructionBuilder(LLVMBuildUtils &utils)
+{
+    // Create groups
+}
+
+LLVMInstruction *InstructionBuilder::process(LLVMInstruction *ins)
+{
+    // Process all groups
+    for (const auto &group : m_groups) {
+        ProcessResult result = group->process(ins);
+
+        if (result.match)
+            return result.next;
+    }
+
+    assert(false); // instruction not found
+    return ins;
+}

src/engine/internal/llvm/instructions/instructionbuilder.h

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "instructiongroup.h"
+
+namespace libscratchcpp::llvmins
+{
+
+class InstructionBuilder
+{
+    public:
+        InstructionBuilder(LLVMBuildUtils &utils);
+
+        LLVMInstruction *process(LLVMInstruction *ins);
+
+    private:
+        std::vector<std::unique_ptr<InstructionGroup>> m_groups;
+};
+
+} // namespace libscratchcpp::llvmins

src/engine/internal/llvm/instructions/instructiongroup.cpp

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "instructiongroup.h"
+#include "../llvmbuildutils.h"
+
+using namespace libscratchcpp::llvmins;
+
+InstructionGroup::InstructionGroup(LLVMBuildUtils &utils) :
+    m_utils(utils),
+    m_builder(utils.builder())
+{
+}

src/engine/internal/llvm/instructions/instructiongroup.h

@@ -0,0 +1,30 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <llvm/IR/IRBuilder.h>
+
+#include "processresult.h"
+
+namespace libscratchcpp
+{
+
+class LLVMBuildUtils;
+
+namespace llvmins
+{
+
+class InstructionGroup
+{
+    public:
+        InstructionGroup(LLVMBuildUtils &utils);
+
+        virtual ProcessResult process(LLVMInstruction *ins) = 0;
+
+    protected:
+        LLVMBuildUtils &m_utils;
+        llvm::IRBuilder<> &m_builder;
+};
+
+} // namespace llvmins
+} // namespace libscratchcpp

src/engine/internal/llvm/instructions/processresult.h

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+namespace libscratchcpp
+{
+
+class LLVMInstruction;
+
+namespace llvmins
+{
+
+// Result of group processing
+struct ProcessResult
+{
+        ProcessResult(bool match, LLVMInstruction *next) :
+            match(match),
+            next(next)
+        {
+        }
+
+        bool match = false;              // whether the desired instruction was found
+        LLVMInstruction *next = nullptr; // next instruction (state)
+};
+
+} // namespace llvmins
+} // namespace libscratchcpp