CommonExceptionBase.hpp

 
//
//  Copyright Phoenix Contact GmbH & Co. KG
//
#pragma once
#include "Arp/Base/Core/Arp.hpp"
#include "Arp/Base/Core/PimplPtr.hxx"
#include "Arp/Base/Core/Exception.hpp"
#include "Arp/Base/Core/ExceptionTypeId.hpp"
#include "Arp/Base/Commons/Runtime/Stacktrace.hpp"
#include "Arp/Base/Commons/Runtime/StackCounter.hpp"
#include "Arp/Base/Commons/Arp.Base.Commons.hpp"
 
namespace Arp::Base::Commons::Exceptions
{
 
class ARP_BASE_COMMONS_EXPORT CommonExceptionBase : public Arp::Base::Core::Exception
{
public: // Impl forward declaration
    class Impl;
 
public: // usings
    using Stacktrace    = Arp::Base::Commons::Runtime::Stacktrace;
    using StackCounter  = Arp::Base::Commons::Runtime::StackCounter;
 
protected: // construction
    CommonExceptionBase(void) = delete;
    CommonExceptionBase(ExceptionTypeId typeId, String&& message, StackCounter stackCounter);
    CommonExceptionBase(ExceptionTypeId typeId, const String& message, StackCounter stackCounter);
    CommonExceptionBase(ExceptionTypeId typeId, String&& message, const Exception& innerException, StackCounter stackCounter);
    CommonExceptionBase(ExceptionTypeId typeId, const String& message, const Exception& innerException, StackCounter stackCounter);
 
    // canonical construction/destruction/assignment
    CommonExceptionBase(const CommonExceptionBase& arg);
    CommonExceptionBase(CommonExceptionBase&& arg)noexcept;
    CommonExceptionBase& operator=(const CommonExceptionBase& arg);
    CommonExceptionBase& operator=(CommonExceptionBase&& arg)noexcept;
    ~CommonExceptionBase(void) override ;
 
public: // setter/getter operations
    const Stacktrace&           GetStacktrace(void)const;
    const Stacktrace::Items&    GetStacktraceItems(void)const;
 
protected: // overriden operations
    String  Format(bool withInnerException)const override ;
 
private: // Impl usings
    using Pimpl = PimplPtr<Impl, true>;
 
private: // Impl fields
    Pimpl   pimpl;
};
 
} // end of namespace Arp::Base::Commons::Exceptions