Add a generic InstructionList class

Author: adazem009

src/engine/internal/codegen/CMakeLists.txt

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

src/engine/internal/codegen/instructionlist.h

@@ -0,0 +1,78 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include <memory>
+#include <functional>
+
+#include "test_export.h"
+
+namespace libscratchcpp
+{
+
+template<typename TInstruction>
+class LIBSCRATCHCPP_TEST_EXPORT InstructionList
+{
+    public:
+        InstructionList() = default;
+        InstructionList(const InstructionList &) = delete;
+
+        inline TInstruction *first() const { return m_first.get(); }
+
+        inline TInstruction *last() const { return m_last.get(); }
+
+        inline bool empty() const { return !first(); }
+
+        inline bool containsInstruction(TInstruction *ins) const
+        {
+            TInstruction *ptr = m_first.get();
+
+            while (ptr) {
+                if (ptr == ins)
+                    return true;
+
+                ptr = ptr->next;
+            }
+
+            return false;
+        }
+
+        inline bool containsInstruction(std::function<bool(const TInstruction *)> func) const
+        {
+            TInstruction *ptr = m_first.get();
+
+            while (ptr) {
+                if (func(ptr))
+                    return true;
+
+                ptr = ptr->next;
+            }
+
+            return false;
+        }
+
+        inline void addInstruction(std::shared_ptr<TInstruction> ins)
+        {
+            if (!(m_first && m_last)) {
+                assert(!m_first && !m_last);
+
+                m_first = ins;
+                m_last = ins;
+
+                ins->previous = nullptr;
+                ins->next = nullptr;
+                ins->_next = nullptr;
+            } else {
+                m_last->next = ins.get();
+                m_last->_next = ins;
+                ins->previous = m_last.get();
+                m_last = ins;
+            }
+        }
+
+    private:
+        std::shared_ptr<TInstruction> m_first;
+        std::shared_ptr<TInstruction> m_last;
+};
+
+} // namespace libscratchcpp

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

@@ -9,7 +9,6 @@ target_sources(scratchcpp
     llvmregister.h
     llvmconstantregister.h
     llvminstruction.h
-    llvminstructionlist.cpp
     llvminstructionlist.h
     llvmifstatement.h
     llvmloop.h

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

@@ -6,12 +6,12 @@
 #include <unordered_map>
 
 #include "test_export.h"
+#include "llvminstructionlist.h"
 
 namespace libscratchcpp
 {
 
 class LLVMBuildUtils;
-class LLVMInstructionList;
 class LLVMInstruction;
 
 class LIBSCRATCHCPP_TEST_EXPORT LLVMCodeAnalyzer

src/engine/internal/codegen/llvm/llvminstructionlist.cpp

@@ -2,35 +2,13 @@
 
 #pragma once
 
-#include <memory>
-#include <functional>
-
-#include "test_export.h"
+#include "../instructionlist.h"
 
 namespace libscratchcpp
 {
 
 struct LLVMInstruction;
 
-class LIBSCRATCHCPP_TEST_EXPORT LLVMInstructionList
-{
-    public:
-        LLVMInstructionList() = default;
-        LLVMInstructionList(const LLVMInstructionList &) = delete;
-
-        LLVMInstruction *first() const;
-        LLVMInstruction *last() const;
-
-        bool empty() const { return !first(); }
-
-        bool containsInstruction(LLVMInstruction *ins) const;
-        bool containsInstruction(std::function<bool(const LLVMInstruction *)> func) const;
-
-        void addInstruction(std::shared_ptr<LLVMInstruction> ins);
-
-    private:
-        std::shared_ptr<LLVMInstruction> m_first;
-        std::shared_ptr<LLVMInstruction> m_last;
-};
+using LLVMInstructionList = InstructionList<LLVMInstruction>;
 
 } // namespace libscratchcpp

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

@@ -19,6 +19,7 @@ add_executable(
   codebuilder_test.cpp
   codegentestutils.cpp
   codegentestutils.h
+  instructionlist_test.cpp
   operators/equal_comparison_test.cpp
   operators/greater_than_test.cpp
   operators/less_than_test.cpp