feat: Replace outcome with Boost's version of outcome to remove dependence on quickcpplib. (#62)

Co-authored-by: kirkrodrigues <[email protected]>

Author: anlowee

CMakeLists.txt

@@ -53,11 +53,9 @@ if(BUILD_TESTING AND YSTDLIB_CPP_BUILD_TESTING)
     set(YSTDLIB_CPP_ENABLE_TESTS ON)
 endif()
 
-find_package(outcome REQUIRED)
-if(outcome_FOUND)
-    message(STATUS "Found outcome.")
-else()
-    message(FATAL_ERROR "Could not find libraries for outcome.")
+find_package(Boost REQUIRED)
+if(Boost_FOUND)
+    message(STATUS "Found Boost ${Boost_VERSION}.")
 endif()
 
 if(YSTDLIB_CPP_ENABLE_TESTS)

src/.clang-format

@@ -6,7 +6,7 @@ IncludeCategories:
   # NOTE: clang-format retains leading white-space on a line in violation of the YAML spec.
   - Regex: "<(ystdlib)"
     Priority: 3
-  - Regex: "<(catch2|outcome)"
+  - Regex: "<(boost|catch2)"
     Priority: 4
   # C system headers
   - Regex: "^<.+\\.h>"

src/ystdlib/error_handling/CMakeLists.txt

@@ -7,7 +7,7 @@ cpp_library(
         Result.hpp
         utils.hpp
     PUBLIC_LINK_LIBRARIES
-        outcome::hl
+        Boost::headers
     TESTS_SOURCES
         test/constants.hpp
         test/test_ErrorCode.cpp

src/ystdlib/error_handling/Result.hpp

@@ -3,10 +3,10 @@
 
 #include <system_error>
 
-#include <outcome/config.hpp>
-#include <outcome/std_result.hpp>
-#include <outcome/success_failure.hpp>
-#include <outcome/try.hpp>
+#include <boost/outcome/config.hpp>
+#include <boost/outcome/std_result.hpp>
+#include <boost/outcome/success_failure.hpp>
+#include <boost/outcome/try.hpp>
 
 namespace ystdlib::error_handling {
 /**
@@ -20,14 +20,14 @@ namespace ystdlib::error_handling {
  * @tparam ErrorType The type used to represent errors.
  */
 template <typename ReturnType, typename ErrorType = std::error_code>
-using Result = OUTCOME_V2_NAMESPACE::std_result<ReturnType, ErrorType>;
+using Result = BOOST_OUTCOME_V2_NAMESPACE::std_result<ReturnType, ErrorType>;
 
 /**
  * @return A value indicating successful completion of a function that returns a void result (i.e.,
  * `Result<void, E>`).
  */
-[[nodiscard]] inline auto success() -> OUTCOME_V2_NAMESPACE::success_type<void> {
-    return OUTCOME_V2_NAMESPACE::success();
+[[nodiscard]] inline auto success() -> BOOST_OUTCOME_V2_NAMESPACE::success_type<void> {
+    return BOOST_OUTCOME_V2_NAMESPACE::success();
 }
 
 /**
@@ -43,9 +43,9 @@ using Result = OUTCOME_V2_NAMESPACE::std_result<ReturnType, ErrorType>;
  * NOTE: This macro is only supported on GCC and Clang due to reliance on compiler-specific
  * extensions.
  */
-#ifdef OUTCOME_TRYX
+#ifdef BOOST_OUTCOME_TRYX
     // NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
-    #define YSTDLIB_ERROR_HANDLING_TRYX(expr) OUTCOME_TRYX(expr)
+    #define YSTDLIB_ERROR_HANDLING_TRYX(expr) BOOST_OUTCOME_TRYX(expr)
 #endif
 
 /**
@@ -60,7 +60,7 @@ using Result = OUTCOME_V2_NAMESPACE::std_result<ReturnType, ErrorType>;
  * - Otherwise, execution continues normally.
  */
 // NOLINTNEXTLINE(cppcoreguidelines-macro-usage)
-#define YSTDLIB_ERROR_HANDLING_TRYV(expr) OUTCOME_TRYV(expr)
+#define YSTDLIB_ERROR_HANDLING_TRYV(expr) BOOST_OUTCOME_TRYV(expr)
 }  // namespace ystdlib::error_handling
 
 #endif  // YSTDLIB_ERROR_HANDLING_RESULT_HPP

taskfiles/deps.yaml

@@ -3,10 +3,6 @@ version: "3"
 vars:
   G_CATCH2_LIB_NAME: "Catch2"
   G_CATCH2_WORK_DIR: "{{.G_DEPS_DIR}}/{{.G_CATCH2_LIB_NAME}}"
-  G_OUTCOME_LIB_NAME: "outcome"
-  G_OUTCOME_WORK_DIR: "{{.G_DEPS_DIR}}/{{.G_OUTCOME_LIB_NAME}}"
-  G_QUICKCPPLIB_LIB_NAME: "quickcpplib"
-  G_QUICKCPPLIB_WORK_DIR: "{{.G_DEPS_DIR}}/{{.G_QUICKCPPLIB_LIB_NAME}}"
 
 tasks:
   install-all:
@@ -24,8 +20,8 @@ tasks:
   install-all-parallel:
     internal: true
     deps:
+      - "install-boost"
       - "install-Catch2"
-      - "install-outcome"
 
   install-Catch2:
     internal: true
@@ -39,36 +35,15 @@ tasks:
           TAR_URL: "https://github.com/catchorg/Catch2/archive/refs/tags/v3.8.0.tar.gz"
           WORK_DIR: "{{.G_CATCH2_WORK_DIR}}"
 
-  install-outcome:
+  install-boost:
     internal: true
     run: "once"
-    deps:
-      - "install-quickcpplib"
     cmds:
-      - task: ":utils:cmake:install-remote-tar"
-        vars:
-          CMAKE_GEN_ARGS:
-            - "-C {{.G_DEPS_CMAKE_SETTINGS_DIR}}/{{.G_QUICKCPPLIB_LIB_NAME}}.cmake"
-            - "-DBUILD_TESTING=OFF"
-            - "-DCMAKE_BUILD_TYPE=Release"
-            - "-DCMAKE_POLICY_DEFAULT_CMP0074=NEW"
-          CMAKE_PACKAGE_NAME: "{{.G_OUTCOME_LIB_NAME}}"
-          CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
-          TAR_SHA256: "0382248cbb00806ce4b5f3ce6939797dc3b597c85fd3531614959e31ef488b39"
-          TAR_URL: "https://github.com/ned14/outcome/archive/refs/tags/v2.2.11.tar.gz"
-          WORK_DIR: "{{.G_OUTCOME_WORK_DIR}}"
-
-  install-quickcpplib:
-    internal: true
-    run: "once"
-    cmds:
-      - task: ":utils:cmake:install-remote-tar"
+      - task: ":utils:boost:download-and-install"
         vars:
-          CMAKE_GEN_ARGS:
-            - "-DBUILD_TESTING=OFF"
-            - "-DCMAKE_BUILD_TYPE=Release"
-          CMAKE_PACKAGE_NAME: "{{.G_QUICKCPPLIB_LIB_NAME}}"
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
-          TAR_SHA256: "5d4c9b2d6fa177d3fb14f3fe3086867e43b44f4a7a944eb10ee4616b2b0f3c05"
-          TAR_URL: "https://github.com/ned14/quickcpplib/archive/f3e452e.tar.gz"
-          WORK_DIR: "{{.G_QUICKCPPLIB_WORK_DIR}}"
+          FILE_SHA256: "d6c69e4459eb5d6ec208250291221e7ff4a2affde9af6e49c9303b89c687461f"
+          URL: "https://github.com/boostorg/boost/releases/download/boost-1.87.0\
+            /boost-1.87.0-b2-nodocs.tar.gz"
+          TARGETS: ["headers"]
+          WORK_DIR: "{{.G_DEPS_DIR}}/boost"