Exception.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* The Base of this class has been adopted from the Delta3D engine
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Class Inspired by the Delta3D Engine
* http://delta3dengine.org/
*
* @author Matthew W. Campbell
* @author Maxim Serebrennik
*/
#pragma once

#include <trUtil/Export.h>

#include <trUtil/Logging/Log.h>

#include <string>

namespace trUtil
{
    class TR_UTIL_EXPORT Exception
    {
    public:

        Exception(const std::string& message, const std::string& filename, unsigned int linenum);

        virtual ~Exception();

        const std::string& What() const;

        const std::string& File() const;

        unsigned int Line() const;

        std::string ToString() const;

        void Print() const;

        void LogException(trUtil::Logging::LogLevel level = trUtil::Logging::LogLevel::LOG_ERROR) const;

        void LogException(trUtil::Logging::LogLevel level, const std::string& loggerName) const;

        void LogException(trUtil::Logging::LogLevel level, trUtil::Logging::Log& logger) const;

    private:
        std::string mMessage, mFileName;
        unsigned int mLineNum;
    };

    TR_UTIL_EXPORT std::ostream& operator << (std::ostream& o, const Exception& ex);
}