AssertMessage.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_FRAMEWORK_ASSERTMESSAGE_H
#define SURGSIM_FRAMEWORK_ASSERTMESSAGE_H

#include <memory>

#include "SurgSim/Framework/LogMessageBase.h"


namespace SurgSim
{
namespace Framework
{


class AssertionFailure : public std::runtime_error
{
public:
    explicit AssertionFailure(const std::string& message) : std::runtime_error(message)
    {
    }
};


class AssertMessage : public LogMessageBase
{
public:
    typedef void (*DeathCallback)(const std::string& message);

    explicit AssertMessage(Logger* logger) : LogMessageBase(logger, LOG_LEVEL_CRITICAL)
    {
    }

    explicit AssertMessage(const std::unique_ptr<Logger>& logger) : LogMessageBase(logger.get(), LOG_LEVEL_CRITICAL)
    {
    }

    explicit AssertMessage(const std::shared_ptr<Logger>& logger) : LogMessageBase(logger.get(), LOG_LEVEL_CRITICAL)
    {
    }

    // As per https://docs.microsoft.com/en-us/cpp/cpp/exception-specifications-throw-cpp?view=vs-2019
    // noexcept(false) has implementation from Visual Studio 2017 15.5
#if defined(_MSC_VER) && _MSC_VER < 1912
    ~AssertMessage() throw(...) 
#else
    ~AssertMessage() noexcept(false)
#endif
    {
        flush();
        m_killMeNow(getMessage());
    }

    static void setFailureCallback(DeathCallback callback);

    static DeathCallback getFailureCallback();

    static void setFailureBehaviorToThrow()
    {
        setFailureCallback(throwException);
    }

    static void setFailureBehaviorToDeath()
    {
        setFailureCallback(killApplication);
    }

private:
    static void throwException(const std::string& errorMessage);

    static void killApplication(const std::string& errorMessage);


    static DeathCallback m_killMeNow;
};


};  // namespace Framework
};  // namespace SurgSim

#endif // SURGSIM_FRAMEWORK_ASSERTMESSAGE_H