ReportHandler.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/Function.hpp"
#include "CeresEngine/Foundation/String.hpp"
#include "CeresEngine/Foundation/Container/Set.hpp"
#include "CeresEngine/Foundation/Container/Stack.hpp"
#include "CeresEngine/Foundation/Container/Vector.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/Log.hpp"
#include "CeresEngine/Material/ShaderCompiler/Report.hpp"
 
#include "CeresEngine/Material/ShaderCompiler/AST/SourceArea.hpp"
 
#include <functional>
 
namespace CeresEngine::ShaderCompiler {
 
    class SourceCode;
 
    // Interface for a common report callback procedure (either for error or warning messages).
    using OnReportProc = Function<void(const String& msg, const AST* ast) const>;
 
    // Report handler class for simpler error and warning handling.
    class ReportHandler {
    public:
        ReportHandler(Log* log);
 
        void warning(bool breakWithException, const String& msg, SourceCode* sourceCode = nullptr, const SourceArea& area = SourceArea::ignore);
 
        void submitReport(bool breakWithException, const ReportTypes type, const String& typeName, const String& msg, SourceCode* sourceCode = nullptr,
            const SourceArea& area = SourceArea::ignore, const Vector<SourceArea>& secondaryAreas = {});
 
        // Returns true if any errors have been submitted.
        [[nodiscard]] inline bool hasErrors() const { return mHasErrors; }
 
        // Pushes the specified context description string onto the stack. The top most description will be added to the next report message.
        void pushContextDesc(const String& contextDesc);
        void popContextDesc();
 
        static void hintForNextReport(const String& hint);
 
    private:
        Report makeReport(const ReportTypes type, const String& msg, SourceCode* sourceCode, const SourceArea& area, const Vector<SourceArea>& secondaryAreas);
 
        Log* mLog = nullptr;
        bool mHasErrors = false;
 
        Stack<String> mContextDescStack;
 
        // TODO: sometimes the same error/warning message appears multiple times, these sets are a workaround for this issue
        Set<SourcePosition> mErrorPositions;
        Set<SourcePosition> mWarningPositions;
    };
 
} // namespace CeresEngine::ShaderCompiler