Add conformance support for std::out_ptr (#408)

* Add conformance support for std::out_ptr

* Run pre-commit

* Ensure tests execute all paths

* Run pre-commit

Author: Twon

conanfile.py

@@ -133,6 +133,15 @@ def useRanges(self):
                       (compiler == "clang" and version >= Version("16")) or (compiler == "apple-clang" and version >= Version("15"))
         return not std_support
 
+    @property
+    def useOutPtr(self):
+        """ Does the current compiler version lack support for std::out_ptr via the STL. """
+        compiler = self.settings.compiler
+        version = Version(self.settings.compiler.version)
+        std_support = (compiler == "msvc" and version >= 193) or (compiler == "gcc" and version >= Version("14")) or \
+                      (compiler == "clang" and version >= Version("19"))
+        return not std_support
+
     def config_options(self):
         if not self.checkMoldIsSupported():
             self.options.rm_safe("link_with_mold")
@@ -183,6 +192,9 @@ def requirements(self):
         if self.useRanges:
             self.requires("range-v3/0.12.0", transitive_headers=True)
 
+        if self.useOutPtr:
+            self.requires("out_ptr/cci.20211119", transitive_headers=True)
+
     def system_requirements(self):
         if self.options.get_safe("with_rs_opengl", False):
             apt = Apt(self)

libraries/core/lib/morpheus/core/conformance/CMakeLists.txt

@@ -7,6 +7,7 @@ target_sources(MorpheusCore
             date.hpp
             format.hpp
             expected.hpp
+            outptr.hpp
             print.hpp
             ranges.hpp
             scan.hpp
@@ -38,6 +39,13 @@ morpheus_conformance_check(
     CLANG_VERSION "19"
 )
 
+morpheus_conformance_check(
+    RESULT OUTPTR_SUPPORTED
+    MSVC_VERSION "19.37"
+    GNU_VERSION "14"
+    CLANG_VERSION "19"
+)
+
 morpheus_conformance_check(
     RESULT RANGES_SUPPORTED
     MSVC_VERSION "19.29"
@@ -58,6 +66,10 @@ if (NOT ${FORMAT_SUPPORTED})
     find_package(fmt REQUIRED)
 endif (NOT ${FORMAT_SUPPORTED})
 
+if (NOT ${OUTPTR_SUPPORTED})
+    find_package(out_ptr REQUIRED)
+endif (NOT ${OUTPTR_SUPPORTED})
+
 if (NOT ${RANGES_SUPPORTED})
     find_package(range-v3 REQUIRED)
 endif (NOT ${RANGES_SUPPORTED})
@@ -80,6 +92,7 @@ target_link_libraries(MorpheusCore
         $<$<NOT:$<BOOL:${DATE_SUPPORTED}>>:date::date>
         $<$<NOT:$<BOOL:${DATE_SUPPORTED}>>:date::date-tz>
         $<$<NOT:$<BOOL:${FORMAT_SUPPORTED}>>:fmt::fmt>
+        $<$<NOT:$<BOOL:${OUTPTR_SUPPORTED}>>:out_ptr::out_ptr>
         $<$<NOT:$<BOOL:${RANGES_SUPPORTED}>>:range-v3::range-v3>
         scn::scn
         $<$<NOT:$<BOOL:${EXPECTED_SUPPORTED}>>:tl::expected>

libraries/core/lib/morpheus/core/conformance/outptr.hpp

@@ -0,0 +1,13 @@
+#pragma once
+
+#include <morpheus/core/conformance/version.hpp>
+
+// clang-format off
+#if (__cpp_lib_out_ptr >= 202106L)
+    #include <memory> // IWYU pragma: export
+    namespace morpheus::conf { namespace ptr = ::std; }
+#else
+    #include <ztd/out_ptr.hpp> // IWYU pragma: export
+    namespace morpheus::conf { namespace ptr = ::ztd::out_ptr; }
+#endif
+// clang-format on

libraries/core/tests/conformance/CMakeLists.txt

@@ -1,6 +1,7 @@
 target_sources(MorpheusCoreTests
     PRIVATE
         date.tests.cpp
+        outptr.tests.cpp
         print.tests.cpp
         scan.tests.cpp
         stacktrace.tests.cpp

libraries/core/tests/conformance/outptr.tests.cpp

@@ -0,0 +1,73 @@
+#include "morpheus/core/conformance/outptr.hpp"
+
+#include <catch2/catch_test_macros.hpp>
+#include <cstdlib>
+#include <memory>
+
+// Dummy C-style API
+extern "C" {
+struct CObject
+{
+    int value;
+};
+
+// Allocate a new object
+void create_object(CObject** obj)
+{
+    *obj = static_cast<CObject*>(std::malloc(sizeof(CObject)));
+    (*obj)->value = 42;
+}
+
+// Modify an existing object, reallocating if necessary
+void update_object(CObject** obj, int new_value)
+{
+    if (!*obj)
+    {
+        *obj = static_cast<CObject*>(std::malloc(sizeof(CObject)));
+    }
+    (*obj)->value = new_value;
+}
+
+// Free an object
+void destroy_object(CObject* obj)
+{
+    std::free(obj);
+}
+}
+
+namespace morpheus
+{
+
+TEST_CASE("std::out_ptr works for initial ownership acquisition", "[morpheus.conformance.outptr]")
+{
+    std::unique_ptr<CObject, decltype(&destroy_object)> ptr(nullptr, &destroy_object);
+
+    // Acquire ownership from a raw C API using out_ptr
+    create_object(conf::ptr::out_ptr(ptr));
+
+    REQUIRE(ptr != nullptr);
+    REQUIRE(ptr->value == 42);
+}
+
+TEST_CASE("std::inout_ptr works for modifying existing allocation", "[morpheus.conformance.inoutptr]")
+{
+    std::unique_ptr<CObject, decltype(&destroy_object)> ptr(nullptr, &destroy_object);
+
+    // First allocate
+    create_object(conf::ptr::out_ptr(ptr));
+    REQUIRE(ptr->value == 42);
+
+    ptr.release();
+    REQUIRE(ptr == nullptr);
+
+    update_object(conf::ptr::out_ptr(ptr), 64);
+    REQUIRE(ptr != nullptr);
+    REQUIRE(ptr->value == 64);
+
+    // Now update the existing object with a new value using inout_ptr
+    update_object(conf::ptr::inout_ptr(ptr), 99);
+    REQUIRE(ptr != nullptr);
+    REQUIRE(ptr->value == 99);
+}
+
+} // namespace morpheus