Add Promise class

Author: adazem009

CMakeLists.txt

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

include/scratchcpp/dev/promise.h

@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+#include "../global.h"
+#include "../spimpl.h"
+
+namespace libscratchcpp
+{
+
+class PromisePrivate;
+
+/*! \brief The Promise class represents the eventual completion of an asynchronous operation. */
+class LIBSCRATCHCPP_EXPORT Promise
+{
+    public:
+        Promise();
+        Promise(const Promise &) = delete;
+
+        bool isResolved() const;
+        void resolve();
+
+    private:
+        spimpl::unique_impl_ptr<PromisePrivate> impl;
+};
+
+} // namespace libscratchcpp

src/dev/engine/CMakeLists.txt

@@ -12,6 +12,9 @@ target_sources(scratchcpp
     executioncontext.cpp
     executioncontext_p.cpp
     executioncontext_p.h
+    promise.cpp
+    promise_p.cpp
+    promise_p.h
     internal/icodebuilder.h
     internal/icodebuilderfactory.h
     internal/codebuilderfactory.cpp

src/dev/engine/promise.cpp

@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include <scratchcpp/dev/promise.h>
+
+#include "promise_p.h"
+
+using namespace libscratchcpp;
+
+/*! Constructs Promise. */
+Promise::Promise() :
+    impl(spimpl::make_unique_impl<PromisePrivate>())
+{
+}
+
+/*! Returns true if the promise is resolved. */
+bool Promise::isResolved() const
+{
+    return impl->isResolved;
+}
+
+/*! Marks the promise as resolved. */
+void Promise::resolve()
+{
+    impl->isResolved = true;
+}

src/dev/engine/promise_p.cpp

@@ -0,0 +1,5 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#include "promise_p.h"
+
+using namespace libscratchcpp;

src/dev/engine/promise_p.h

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: Apache-2.0
+
+#pragma once
+
+namespace libscratchcpp
+{
+
+struct PromisePrivate
+{
+        bool isResolved = false;
+};
+
+} // namespace libscratchcpp

test/dev/CMakeLists.txt

@@ -2,3 +2,4 @@ add_subdirectory(blocks)
 add_subdirectory(executioncontext)
 add_subdirectory(llvm)
 add_subdirectory(compiler)
+add_subdirectory(promise)

test/dev/promise/CMakeLists.txt

@@ -0,0 +1,12 @@
+add_executable(
+  promise_test
+  promise_test.cpp
+)
+
+target_link_libraries(
+  promise_test
+  GTest::gtest_main
+  scratchcpp
+)
+
+gtest_discover_tests(promise_test)

test/dev/promise/promise_test.cpp

@@ -0,0 +1,14 @@
+#include <scratchcpp/dev/promise.h>
+
+#include "../../common.h"
+
+using namespace libscratchcpp;
+
+TEST(PromiseTest, Resolve)
+{
+    Promise promise;
+    ASSERT_FALSE(promise.isResolved());
+
+    promise.resolve();
+    ASSERT_TRUE(promise.isResolved());
+}