Add CompilerLocalVariable class

Author: adazem009

CMakeLists.txt

@@ -76,6 +76,7 @@ if (LIBSCRATCHCPP_USE_LLVM)
         include/scratchcpp/dev/compiler.h
         include/scratchcpp/dev/compilervalue.h
         include/scratchcpp/dev/compilerconstant.h
+        include/scratchcpp/dev/compilerlocalvariable.h
         include/scratchcpp/dev/executablecode.h
         include/scratchcpp/dev/executioncontext.h
         include/scratchcpp/dev/promise.h

include/scratchcpp/dev/compilerlocalvariable.h

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "compiler.h"
+
+namespace libscratchcpp
+{
+
+class CompilerLocalVariablePrivate;
+
+/*! \brief The CompilerLocalVariable class represents a statically typed local variable in compiled code. */
+class LIBSCRATCHCPP_EXPORT CompilerLocalVariable
+{
+    public:
+        CompilerLocalVariable(CompilerValue *ptr);
+        CompilerLocalVariable(const CompilerLocalVariable &) = delete;
+
+        CompilerValue *ptr() const;
+        Compiler::StaticType type() const;
+
+    private:
+        spimpl::unique_impl_ptr<CompilerLocalVariablePrivate> impl;
+};
+
+} // namespace libscratchcpp

src/dev/engine/CMakeLists.txt

@@ -9,6 +9,9 @@ target_sources(scratchcpp
     compilerconstant.cpp
     compilerconstant_p.cpp
     compilerconstant_p.h
+    compilerlocalvariable.cpp
+    compilerlocalvariable_p.cpp
+    compilerlocalvariable_p.h
     executioncontext.cpp
     executioncontext_p.cpp
     executioncontext_p.h

src/dev/engine/compilerlocalvariable.cpp

@@ -0,0 +1,23 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <scratchcpp/dev/compilerlocalvariable.h>
+#include <scratchcpp/dev/compilervalue.h>
+
+#include "compilerlocalvariable_p.h"
+
+using namespace libscratchcpp;
+
+CompilerLocalVariable::CompilerLocalVariable(CompilerValue *ptr) :
+    impl(spimpl::make_unique_impl<CompilerLocalVariablePrivate>(ptr))
+{
+}
+
+CompilerValue *CompilerLocalVariable::ptr() const
+{
+    return impl->ptr;
+}
+
+Compiler::StaticType CompilerLocalVariable::type() const
+{
+    return impl->ptr->type();
+}

src/dev/engine/compilerlocalvariable_p.cpp

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <cassert>
+
+#include "compilerlocalvariable_p.h"
+
+using namespace libscratchcpp;
+
+CompilerLocalVariablePrivate::CompilerLocalVariablePrivate(CompilerValue *ptr) :
+    ptr(ptr)
+{
+    assert(ptr);
+}

src/dev/engine/compilerlocalvariable_p.h

@@ -0,0 +1,18 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+namespace libscratchcpp
+{
+
+class CompilerValue;
+
+struct CompilerLocalVariablePrivate
+{
+        CompilerLocalVariablePrivate(CompilerValue *ptr);
+        CompilerLocalVariablePrivate(CompilerLocalVariablePrivate &) = delete;
+
+        CompilerValue *ptr = nullptr;
+};
+
+} // namespace libscratchcpp

test/dev/compiler/CMakeLists.txt

@@ -3,6 +3,7 @@ add_executable(
   compiler_test.cpp
   compilervalue_test.cpp
   compilerconstant_test.cpp
+  compilerlocalvariable_test.cpp
 )
 
 target_link_libraries(

test/dev/compiler/compilerlocalvariable_test.cpp

@@ -0,0 +1,33 @@
+#include <scratchcpp/dev/compilerlocalvariable.h>
+#include <scratchcpp/dev/compilervalue.h>
+#include <gtest/gtest.h>
+
+using namespace libscratchcpp;
+
+TEST(CompilerLocalVariableTest, Constructors)
+{
+    CompilerValue ptr(Compiler::StaticType::Number);
+    CompilerLocalVariable var(&ptr);
+    ASSERT_EQ(var.ptr(), &ptr);
+}
+
+TEST(CompilerLocalVariableTest, Type)
+{
+    {
+        CompilerValue ptr(Compiler::StaticType::Number);
+        CompilerLocalVariable var(&ptr);
+        ASSERT_EQ(var.type(), ptr.type());
+    }
+
+    {
+        CompilerValue ptr(Compiler::StaticType::Bool);
+        CompilerLocalVariable var(&ptr);
+        ASSERT_EQ(var.type(), ptr.type());
+    }
+
+    {
+        CompilerValue ptr(Compiler::StaticType::String);
+        CompilerLocalVariable var(&ptr);
+        ASSERT_EQ(var.type(), ptr.type());
+    }
+}