From 001c9917ace09f7b1c80d96eb067e1d37e86c546 Mon Sep 17 00:00:00 2001
From: Lexi Winter <lexi@le-fay.org>
Date: Fri, 27 Jun 2025 12:08:58 +0100
Subject: improve error handling

---
 nihil.ucl/real.ccm | 85 +++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 74 insertions(+), 11 deletions(-)

(limited to 'nihil.ucl/real.ccm')

diff --git a/nihil.ucl/real.ccm b/nihil.ucl/real.ccm
index 4e2748b..c491553 100644
--- a/nihil.ucl/real.ccm
+++ b/nihil.ucl/real.ccm
@@ -5,6 +5,9 @@
 module;
 
 #include <compare>
+#include <expected>
+#include <format>
+#include <utility>
 
 #include <ucl.h>
 
@@ -20,30 +23,90 @@ export struct real final : object {
 
 	inline static constexpr object_type ucl_type = object_type::real;
 
-	// Create a new real from a UCL object.
-	real(ref_t, ::ucl_object_t const *uobj);
-	real(noref_t, ::ucl_object_t *uobj);
-
-	// Create a default-initialised real.
+	/*
+	 * Create a real holding the value 0.  Throws std::system_error
+	 * on failure.
+	 */
 	real();
 
-	// Create a new real from a value.
+	/*
+	 * Create a real holding a specific value.  Throws std::system_error
+	 * on failure.
+	 */
 	explicit real(contained_type value);
 
+	/*
+	 * Create a new real from a UCL object.  Throws type_mismatch
+	 * on failure.
+	 */
+	real(ref_t, ::ucl_object_t const *uobj);
+	real(noref_t, ::ucl_object_t *uobj);
+
 	// Return the value of this real.
-	auto value(this real const &self) -> contained_type;
+	[[nodiscard]] auto value(this real const &self) -> contained_type;
 };
 
+/*
+ * Real constructors.  These return an error instead of throwing.
+ */
+
+export [[nodiscard]] auto
+make_real(real::contained_type = 0) -> std::expected<real, error>;
+
 /*
  * Comparison operators.
  */
 
-export auto operator== (real const &a, real const &b) -> bool;
-export auto operator== (real const &a, real::contained_type b) -> bool;
+export [[nodiscard]] auto operator== (real const &a, real const &b) -> bool;
+
+export [[nodiscard]] auto operator== (real const &a,
+				      real::contained_type b) -> bool;
 
-export auto operator<=> (real const &a, real const &b)
+export [[nodiscard]] auto operator<=> (real const &a, real const &b)
 	-> std::partial_ordering;
-export auto operator<=> (real const &a, real::contained_type b)
+
+export [[nodiscard]] auto operator<=> (real const &a, real::contained_type b)
 	-> std::partial_ordering;
 
+/*
+ * Literal operator.
+ */
+inline namespace literals {
+export constexpr auto operator""_ucl (long double d) -> real
+{
+	if (d > static_cast<long double>(std::numeric_limits<double>::max()) ||
+	    d < static_cast<long double>(std::numeric_limits<double>::min()))
+		throw std::out_of_range("literal out of range");
+
+	return real(d);
+}
+} // namespace nihil::ucl::literals
+
 } // namespace nihil::ucl
+
+namespace nihil { inline namespace literals {
+	export using namespace ::nihil::ucl::literals;
+}} // namespace nihil::literals
+
+/*
+ * std::formatter for a real.  This provides the same format operations
+ * as std::formatter<double>;
+ */
+export template<>
+struct std::formatter<nihil::ucl::real, char>
+{
+	std::formatter<double> base_formatter;
+
+	template<class ParseContext>
+	constexpr ParseContext::iterator parse(ParseContext& ctx)
+	{
+		return base_formatter.parse(ctx);
+	}
+
+	template<class FmtContext>
+	FmtContext::iterator format(nihil::ucl::real const &o,
+				    FmtContext& ctx) const
+	{
+		return base_formatter.format(o.value(), ctx);
+	}
+};
-- 
cgit v1.2.3