exception.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_EXCEPTION_HPP_
#define INCLUDE_FIFECHAN_EXCEPTION_HPP_
 
// Standard library includes
#include <source_location>
#include <stdexcept>
#include <string>
#include <utility>
 
namespace fcn
{
    class /*FIFEGUI_API*/ Exception : public std::runtime_error
    {
        public:
            explicit Exception(std::string message, std::source_location location = std::source_location::current()) :
                std::runtime_error(message),  // Pass by reference, do not move.
                mMessage(std::move(message)), // Move only once into mMessage.
                mFunction(location.function_name()),
                mFilename(location.file_name()),
                mLine(location.line())
            {
            }

            char const * what() const noexcept override
            {
                return mMessage.c_str();
            }

            std::string const & getFunction() const
            {
                return mFunction;
            };

            std::string const & getMessage() const
            {
                return mMessage;
            };

            std::string const & getFilename() const
            {
                return mFilename;
            };

            unsigned int getLine() const
            {
                return mLine;
            };
 
        private:
            std::string mMessage = "Message?";

            std::string mFunction = "Function?";

            std::string mFilename = "Filename?";

            unsigned int mLine = 0;
    };

    inline void throwException(
        std::string const & message, std::source_location location = std::source_location::current())
    {
        throw Exception(message, location);
    }
 
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_EXCEPTION_HPP_