Logger.h

Go to the documentation of this file.

// Copyright Contributors to the OpenVDB Project
// SPDX-License-Identifier: MPL-2.0


#ifndef OPENVDB_AX_COMPILER_LOGGER_HAS_BEEN_INCLUDED
#define OPENVDB_AX_COMPILER_LOGGER_HAS_BEEN_INCLUDED

#include "../ast/AST.h"

#include <openvdb/version.h>

#include <functional>
#include <string>
#include <unordered_map>

class TestLogger;

namespace openvdb {
OPENVDB_USE_VERSION_NAMESPACE
namespace OPENVDB_VERSION_NAME {

namespace ax {

class Logger
{
public:
    using Ptr = std::shared_ptr<Logger>;

    using CodeLocation = std::pair<size_t, size_t>;
    using OutputFunction = std::function<void(const std::string&)>;

    Logger(const OutputFunction& errors =
        [](const std::string& msg){
            std::cerr << msg << std::endl;
        },
        const OutputFunction& warnings = [](const std::string&){});
    ~Logger();

    bool error(const std::string& message, const CodeLocation& lineCol);

    bool error(const std::string& message, const ax::ast::Node* node);

    bool warning(const std::string& message, const CodeLocation& lineCol);

    bool warning(const std::string& message, const ax::ast::Node* node);


    inline size_t errors() const { return mNumErrors; }
    inline size_t warnings() const { return mNumWarnings; }

    inline bool hasError() const { return this->errors() > 0; }
    inline bool hasWarning() const { return this->warnings() > 0; }
    inline bool atErrorLimit() const  {
        return this->getMaxErrors() > 0 && this->errors() >= this->getMaxErrors();
    }

    void clear();

    void setWarningsAsErrors(const bool warnAsError = false);
    bool getWarningsAsErrors() const;

    void setMaxErrors(const size_t maxErrors = 0);
    size_t getMaxErrors() const;


    void setNumberedOutput(const bool numbered = true);
    void setErrorPrefix(const char* prefix = "error: ");
    void setWarningPrefix(const char* prefix = "warning: ");
    void setPrintLines(const bool print = true);

    bool getNumberedOutput() const;
    const char* getErrorPrefix() const;
    const char* getWarningPrefix() const;
    bool getPrintLines() const;

    void setSourceCode(const char* code);


    void setSourceTree(openvdb::ax::ast::Tree::ConstPtr tree);

    void addNodeLocation(const ax::ast::Node* node, const CodeLocation& location);

    // forward declaration
    struct Settings;
    struct SourceCode;

private:

    friend class ::TestLogger;

    std::function<void(const std::string&)> mErrorOutput;
    std::function<void(const std::string&)> mWarningOutput;

    size_t mNumErrors;
    size_t mNumWarnings;

    std::unique_ptr<Settings> mSettings;

    // components needed for verbose error info i.e. line/column numbers and
    // lines from source code
    std::unique_ptr<SourceCode> mCode;
    ax::ast::Tree::ConstPtr mTreePtr;
    std::unordered_map<const ax::ast::Node*, CodeLocation> mNodeToLineColMap;
};

} // namespace ax
} // namespace OPENVDB_VERSION_NAME
} // namespace openvdb

#endif // OPENVDB_AX_COMPILER_LOGGER_HAS_BEEN_INCLUDED