Report.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
#include <stdexcept>
 
namespace CeresEngine::ShaderCompiler {
 
    enum class ReportTypes {
        Info,
 
        Warning,
 
        Error
    };
 
    class Report : public std::exception {
    public:
        Report(const Report&) = default;
        Report& operator=(const Report&) = default;
 
        inline Report(const ReportTypes type, const String& message, const String& context = "") : mType{type}, mContext{context}, mMessage{message} {}
 
        inline Report(const ReportTypes type, const String& message, const String& line, const String& marker, const String& context = "")
                : mType{type}, mContext{context}, mMessage{message}, mLine{line}, mMarker{marker} {
            while(!mLine.empty() && (mLine.back() == '\n' || mLine.back() == '\r')) {
                mLine.pop_back();
            }
        }
 
        [[nodiscard]] inline const char* what() const noexcept override { return mMessage.c_str(); }
 
        inline void takeHints(Vector<String>&& hints) { mHints = std::move(hints); }
 
        [[nodiscard]] inline ReportTypes getType() const { return mType; }
 
        [[nodiscard]] inline const String& getContext() const { return mContext; }
 
        [[nodiscard]] inline const String& getMessage() const { return mMessage; }
 
        [[nodiscard]] inline const String& getLine() const { return mLine; }
 
        [[nodiscard]] inline const String& getMarker() const { return mMarker; }
 
        [[nodiscard]] inline const Vector<String>& getHints() const { return mHints; }
 
        [[nodiscard]] inline bool hasLine() const { return (!mLine.empty()); }
 
    private:
        ReportTypes mType = ReportTypes::Info;
        String mContext;
        String mMessage;
        String mLine;
        String mMarker;
        Vector<String> mHints;
    };
 
} // namespace CeresEngine::ShaderCompiler