Exception.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/Detail/Arp.Base.Core.hpp"
#include "Arp/Base/Core/ExceptionTypeId.hpp"
#include <memory>
 
namespace Arp { namespace Base { namespace Core
{
 
class ARP_BASE_CORE_EXPORT Exception
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Ptr = std::unique_ptr<Exception>;
    using TypeCode = std::underlying_type<Arp::Base::Core::ExceptionTypeId>::type;
 
public: // canonical construction/destruction/assignment
    Exception(const Exception& arg);
    Exception(Exception&& arg)noexcept;
    Exception& operator=(const Exception& arg);
    Exception& operator=(Exception&& arg)noexcept;
    virtual ~Exception(void);
 
public: // construction
    Exception(void);
    template<typename... Args>
    Exception(const char* message, Args&& ... args);
    explicit Exception(const String& message);
    explicit Exception(String&& message);
    Exception(const String& message, const Exception& innerException);
    Exception(String&& message, const Exception& innerException);
 
protected: //construction
    Exception(ExceptionTypeId typeId, String&& message);
    Exception(ExceptionTypeId typeId, const String& message);
    Exception(ExceptionTypeId typeId, String&& message, const Exception& innerException);
    Exception(ExceptionTypeId typeId, const String& message, const Exception& innerException);
 
public: // setter operations
    const String&       GetMessage(void)const;
    ExceptionTypeId     GetTypeId(void)const;
    TypeCode            GetTypeCode(void)const;
    bool                HasInnerException(void)const;
    const Exception&    GetInnerException(void)const;
 
public: // operations
    String  ToString(void)const;
 
public: // operations to override
    virtual Exception::Ptr  Clone(void)const;
    virtual String          Format(bool withInnerException)const;
 
public: // global (friend) operators
    friend ARP_EXPORT std::ostream& operator<<(std::ostream& os, const Exception& arg);
 
protected: // deprecated operations
    ARP_DEPRECATED("Use the protected constructor 'Exception(ExceptionTypeId, String&&, const Exception&)' instead.")
    Exception(String&& message, const Exception::Ptr& innerExceptionPtr);
 
    ARP_DEPRECATED("Override 'Exception::Format(bool withInnerException)const' instead.")
    String  Format(int indentLevel, bool withInnerException)const;
 
    ARP_DEPRECATED("Remove the override of this operation, it's not required any more.")
    virtual uint32  GetTypeCodeInternal(void)const;
 
public: // internal operations
    Impl&       GetImpl(void);
    const Impl& GetImpl(void)const;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
// Declarations of global functions of class Exception
ARP_EXPORT std::ostream& operator<<(std::ostream& os, const Exception& arg);
 
// inline operations of class Exception
 
template<typename... Args>
inline Exception::Exception(const char* message, Args&& ... args)
    : Exception(ExceptionTypeId::Exception, String::Format(message, std::forward<Args>(args)...))
{
}
 
}}} // end of namespace Arp::Base::Core
 
namespace Arp {
using Arp::Base::Core::Exception;
}
template<> struct fmt::formatter<Arp::Base::Core::Exception> : public fmt::ostream_formatter {};