LocalException.h

Go to the documentation of this file.

#pragma once
 
#include <ArmarXCore/core/util/StringHelpers.h>
 
#include <exception>
#include <sstream>
#include <string>
 
namespace armarx
{
    /**
     * \class LocalException
     * \ingroup Exceptions
     * \brief Standard exception type for ArmarX, that should not be transmitted via Ice.
     *
     *
     * Offers a backtrace to where the exception was thrown.<br/>
     * All local exceptions must inherit from this class.
     */
    class LocalException: public std::exception
    {
    public:
        /**
         * @brief LocalException Constructor
         */
        LocalException();
        /**
         * @brief LocalException Copy Constructor
         */
        LocalException(const LocalException& e) noexcept;
        /**
         * @brief LocalException Constructor taking a \p reason string as parameter
         */
        LocalException(const std::string& reason) :
            reason(reason), backtrace(""), output_buffer("")
        {
            backtrace = std::runtime_error(generateBacktrace());
            setReason(reason);
        }
 
        /**
         * @brief LocalException Destructor
         */
        ~LocalException() noexcept override = default;
 
        /**
         * @return string containing the reason of the exception
         */
        const char* what() const noexcept override;
        /**
         * @return the exception name
         */
        virtual std::string name() const
        {
            return "armarx::LocalException";
        }
 
        /**
         * @param reason string containing an explanation about the reason why the exception occured
         */
        void setReason(const std::string& reason);
 
 
        /**
         * @return string containing the reason without backtrace
         */
        std::string getReason() const;
 
        /**
         * @return string containing the backtrace
         */
        static std::string generateBacktrace();
 
        template<typename T>
        LocalException& operator <<(const T& message)
        {
            std::stringstream ss;
            ss << reason.what() << message;
            reason = std::runtime_error(ss.str());
            return *this;
        }
 
        template<typename T>
        LocalException& operator <<(const std::vector<T>& message)
        {
            // the operator <<(ostream, vector) is defined in two headers
            // the implementations behave differently.
            // here we explicitly select the operator we want
            std::operator <<(std::stringstream(reason.what()), message);
            return *this;
        }
 
    private:
        /**
         * Generates an explanatory string by concatenating all LocalException
         * information and stores it in armarx::LocalException::resultingMessage.
         */
        std::string generateOutputString() const;
        /**
         * @brief reason is a std::runtime_error object holding an explanation of why the exception
         * was thrown
         */
        std::runtime_error reason;
        /**
         * @brief backtrace is a std::runtime_error object containing the backtrace from where
         * the exception was thrown
         */
 
        std::runtime_error backtrace;
 
        /**
         * @brief output_buffer is a std::runtime_error object that is filled and kept when calling what() for combining
         * the reason and the backtrace
         */
        mutable std::runtime_error output_buffer;
    };
    static_assert(std::is_nothrow_copy_constructible<LocalException>::value,
                  "LocalException must be nothrow copy constructible");
 
    /**
     * \ingroup Exceptions
     * Print the output of common armarx exceptions.
     *
     * Handles exception types like armarx::LocalException, armarx::UserException,
     * IceUtil::Exception and std::exception.
     *
     * If available, the backtrace is printed out.
     *
     * example:
     * \code
     * try{
     *   //...your code
     * }
     * catch(...)
     * {
     *   handleExceptions();
     *   // your special exception handling
     * }
     * \endcode
     */
    extern "C" void handleExceptions();
 
    /**
     * \ingroup Exceptions
     * Generates a string from an exception with additional information for some exceptions, like Ice::NoObjectFactoryException.
 
     * example:
     * \code
     * try{
     *   //...your code
     * }
     * catch(...)
     * {
     *   ARMARX_ERROR_S << GetHandledExceptionString();
     *   // your special exception handling
     * }
     */
    std::string GetHandledExceptionString();
}