Replaced tinkerforge_exception with std::system_error and tinkerforge_error_category.

Author: crowbar27

power_overwhelming/include/visus/pwrowg/tinkerforge_display.h

@@ -65,7 +65,7 @@ class POWER_OVERWHELMING_API tinkerforge_display final {
     /// is <c>nullptr</c>.</exceptions>
     /// <exception cref="std::bad_alloc">If the required resources could not
     /// be allocated.</exceptions>
-    /// <exception cref="tinkerforge_exception">If the connection to the
+    /// <exception cref="std::system_error">If the connection to the
     /// master brick could not be established.</exception>
     tinkerforge_display(_In_z_ const char *uid,
         _In_opt_z_ const char *host,

power_overwhelming/src/tinkerforge_configuration.cpp

@@ -13,7 +13,6 @@
 
 #include "string_functions.h"
 #include "tinkerforge_bricklet.h"
-#include "tinkerforge_exception.h"
 #include "tinkerforge_scope.h"
 
 

power_overwhelming/src/tinkerforge_display.cpp

@@ -12,7 +12,7 @@
 
 #include "tinkerforge_bricklet.h"
 #include "tinkerforge_display_impl.h"
-#include "tinkerforge_exception.h"
+#include "tinkerforge_error_category.h"
 
 
 /*
@@ -66,9 +66,7 @@ void PWROWG_NAMESPACE::tinkerforge_display::clear(void) {
     }
 
     auto status = ::lcd_128x64_clear_display(&this->_impl->bricklet);
-    if (status < 0) {
-        throw PWROWG_DETAIL_NAMESPACE::tinkerforge_exception(status);
-    }
+    detail::throw_if_tinkerforge_failed(status);
 }
 
 
@@ -91,9 +89,7 @@ void PWROWG_NAMESPACE::tinkerforge_display::print(
 
     auto status = ::lcd_128x64_draw_text(&this->_impl->bricklet, x, y, font,
         colour, text);
-    if (status < 0) {
-        throw PWROWG_DETAIL_NAMESPACE::tinkerforge_exception(status);
-    }
+    detail::throw_if_tinkerforge_failed(status);
 }
 
 

…erwhelming/src/tinkerforge_exception.cpp …lming/src/tinkerforge_error_category.cpppower_overwhelming/src/tinkerforge_exception.cpp renamed to power_overwhelming/src/tinkerforge_error_category.cpp power_overwhelming/src/tinkerforge_exception.cpp renamed to power_overwhelming/src/tinkerforge_error_category.cpp

@@ -1,21 +1,32 @@
-// <copyright file="tinkerforge_exception.cpp" company="Visualisierungsinstitut der Universität Stuttgart">
-// Copyright © 2021 - 2025 Visualisierungsinstitut der Universität Stuttgart.
+// <copyright file="tinkerforge_error_category.cpp" company="Visualisierungsinstitut der Universität Stuttgart">
+// Copyright © 2025 Visualisierungsinstitut der Universität Stuttgart.
 // Licensed under the MIT licence. See LICENCE file for details.
 // </copyright>
 // <author>Christoph Müller</author>
 
-#include "tinkerforge_exception.h"
+#include "tinkerforge_error_category.h"
+
+#include <string>
 
 #include <ip_connection.h>
 
 
-/// <summary>
-/// Get a human-readable error description for the given Tinkerforge error code.
-/// </summary>
-/// <param name="code"></param>
-/// <returns></returns>
-static std::string tinkerforge_to_string(const int code) {
-    switch (code) {
+/*
+ * PWROWG_DETAIL_NAMESPACE::tinkerforge_error_category::default_error_condition
+ */
+std::error_condition
+PWROWG_DETAIL_NAMESPACE::tinkerforge_error_category::default_error_condition(
+        int status) const noexcept {
+    return std::error_condition(status, tinkerforge_category());
+}
+
+
+/*
+ * PWROWG_DETAIL_NAMESPACE::message
+ */
+std::string PWROWG_DETAIL_NAMESPACE::tinkerforge_error_category::message(
+        int status) const {
+    switch (status) {
         case E_OK:
             return "The operation completed successfully.";
 
@@ -71,13 +82,32 @@ static std::string tinkerforge_to_string(const int code) {
             return "The response has an unexpected length.";
 
         default:
-            return std::to_string(code);
+            return std::to_string(status);
     }
 }
 
+
+/*
+ * PWROWG_DETAIL_NAMESPACE::tinkerforge_category
+ */
+const std::error_category& PWROWG_DETAIL_NAMESPACE::tinkerforge_category(
+        void) noexcept {
+    static const tinkerforge_error_category retval;
+    return retval;
+}
+
+
 /*
- * PWROWG_DETAIL_NAMESPACE::tinkerforge_exception::tinkerforge_exception
+ * PWROWG_DETAIL_NAMESPACE::throw_if_tinkerforge_failed
  */
-PWROWG_DETAIL_NAMESPACE::tinkerforge_exception::tinkerforge_exception(
-        const value_type code)
-    : std::runtime_error(tinkerforge_to_string(code).c_str()), _code(code) { }
+void PWROWG_DETAIL_NAMESPACE::throw_if_tinkerforge_failed(
+        _In_ const int status,
+        _In_opt_z_ const char *message) {
+    if (status < 0) {
+        if (message == nullptr) {
+            throw std::system_error(status, tinkerforge_category());
+        } else {
+            throw std::system_error(status, tinkerforge_category(), message);
+        }
+    }
+}

power_overwhelming/src/tinkerforge_error_category.h

@@ -0,0 +1,75 @@
+// <copyright file="tinkerforge_error_category.h" company="Visualisierungsinstitut der Universität Stuttgart">
+// Copyright © 2025 Visualisierungsinstitut der Universität Stuttgart.
+// Licensed under the MIT licence. See LICENCE file for details.
+// </copyright>
+// <author>Christoph Müller</author>
+
+#if !defined(_PWROWG_TINKERFORGE_ERROR_CATEGORY_H)
+#define _PWROWG_TINKERFORGE_ERROR_CATEGORY_H
+#pragma once
+
+#include <system_error>
+
+#include "visus/pwrowg/api.h"
+
+
+PWROWG_DETAIL_NAMESPACE_BEGIN
+
+/// <summary>
+/// An error category for Tinkerforge errors.
+/// </summary>
+class PWROWG_TEST_API tinkerforge_error_category final
+        : public std::error_category {
+
+public:
+
+    using std::error_category::error_category;
+
+    /// <summary>
+    /// Converts the error code into a portable description.
+    /// </summary>
+    /// <param name="status">The error code to be converted.</param>
+    /// <returns>The portable description of the Tinkerforge error.</returns>
+    std::error_condition default_error_condition(
+        _In_ int status) const noexcept override;
+
+    /// <summary>
+    /// Convert the given error code into a string.
+    /// </summary>
+    /// <param name="status">The error code to get the message for.</param>
+    /// <returns>The error message associated with the error code.
+    /// </returns>
+    std::string message(_In_ int status) const override;
+
+    /// <summary>
+    /// Answer the name of the error category.
+    /// </summary>
+    /// <returns>The name of the category.</returns>
+    inline const char *name(void) const noexcept override {
+        return "Tinkerforge";
+    }
+};
+
+
+/// <summary>
+/// Answer the one and only <see cref="tinkerforge_error_category" />.
+/// </summary>
+/// <returns>The only instance of <see cref="tinkerforge_error_category" />.
+/// </returns>
+PWROWG_TEST_API const std::error_category& tinkerforge_category(void) noexcept;
+
+/// <summary>
+/// Check whether <paramref name="status" /> indicates failure, and if so,
+/// throw an exception.
+/// </summary>
+/// <param name="status">The status code to be checked.</param>
+/// <param name="message">An optional error message to be included in the
+/// exception.</param>
+/// <exception cref="std::system_error">If <paramref name="status" /> indicates
+/// failure.</exception>
+PWROWG_TEST_API void throw_if_tinkerforge_failed(_In_ const int status,
+    _In_opt_z_ const char *message = nullptr);
+
+PWROWG_DETAIL_NAMESPACE_END
+
+#endif /* !defined(_PWROWG_TINKERFORGE_ERROR_CATEGORY_H) */

power_overwhelming/src/tinkerforge_exception.h

@@ -14,7 +14,7 @@
 #include <WinSock2.h>
 #endif /* defined(_WIN32) */
 
-#include "tinkerforge_exception.h"
+#include "tinkerforge_error_category.h"
 
 
 /*
@@ -54,7 +54,7 @@ PWROWG_DETAIL_NAMESPACE::tinkerforge_scope::data::data(
         if (status < 0) {
             // Must deallocate if throwing after ipcon_create!
             ::ipcon_destroy(&this->connection);
-            throw tinkerforge_exception(status);
+            throw std::system_error(status, tinkerforge_category());
         }
     }
 
@@ -68,7 +68,7 @@ PWROWG_DETAIL_NAMESPACE::tinkerforge_scope::data::data(
         if (status < 0) {
             // Same as above: manually cleanup resources.
             ::ipcon_destroy(&this->connection);
-            throw tinkerforge_exception(status);
+            throw std::system_error(status, tinkerforge_category());
         }
     }
 }

power_overwhelming/src/tinkerforge_scope.cpp

@@ -51,7 +51,7 @@ class PWROWG_TEST_API tinkerforge_scope final {
     /// </param>
     /// <param name="port">The port on which the Brick daemon is listening.
     /// </param>
-    /// <exception cref="tinkerforge_exception">In case the connection could
+    /// <exception cref="std::system_error">In case the connection could
     /// not be established.</exception>
     tinkerforge_scope(const std::string& host, const std::uint16_t port);