abstract_logger.h

/*****************************************************************************
 * VCLib                                                                     *
 * Visual Computing Library                                                  *
 *                                                                           *
 * Copyright(C) 2021-2025                                                    *
 * Visual Computing Lab                                                      *
 * ISTI - Italian National Research Council                                  *
 *                                                                           *
 * All rights reserved.                                                      *
 *                                                                           *
 * This program is free software; you can redistribute it and/or modify      *
 * it under the terms of the Mozilla Public License Version 2.0 as published *
 * by the Mozilla Foundation; either version 2 of the License, or            *
 * (at your option) any later version.                                       *
 *                                                                           *
 * This program 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              *
 * Mozilla Public License Version 2.0                                        *
 * (https://www.mozilla.org/en-US/MPL/2.0/) for more details.                *
 ****************************************************************************/
 
#ifndef VCL_BASE_LOGGER_ABSTRACT_LOGGER_H
#define VCL_BASE_LOGGER_ABSTRACT_LOGGER_H
 
#include <vclib/base/base.h>
#include <vclib/base/pointers.h>
 
#include <string>
 
namespace vcl {
 
class AbstractLogger
{
public:
    // note: these constants have the _LOG suffix to avoid conflicts with some
    // macros defined in windows.h headers
    enum LogLevel {
        ERROR_LOG = 0,
        WARNING_LOG,
        MESSAGE_LOG,
        PROGRESS_LOG,
        DEBUG_LOG
    };
 
    AbstractLogger() = default;
 
    virtual void enableIndentation() = 0;
 
    virtual void disableIndentation() = 0;
 
    virtual void enablePrintPercentage() = 0;
 
    virtual void disablePrintPercentage() = 0;
 
    virtual void setPrintLevel(LogLevel level) = 0;
 
    virtual void enablePrintMessageDuringProgress() = 0;
 
    virtual void disablePrintMessageDuringProgress() = 0;
 
    virtual void enablePrintTimer() = 0;
 
    virtual void disablePrintTimer() = 0;
 
    virtual void reset() = 0;
 
    virtual void setMaxLineWidth(uint width) = 0;
 
    virtual void startTimer() = 0;
 
    virtual void stopTimer() = 0;
 
    virtual double time() const = 0;
 
    virtual void startNewTask(
        double             fromPerc,
        double             toPerc,
        const std::string& action) = 0;
 
    virtual void endTask(const std::string& action) = 0;
 
    virtual double percentage() const = 0;
 
    virtual void setPercentage(uint newPerc) = 0;
 
    virtual void log(const std::string& msg) const = 0;
 
    virtual void log(const std::string& msg, LogLevel lvl) const = 0;
 
    virtual void log(uint perc, const std::string& msg) = 0;
 
    virtual void log(uint perc, const std::string& msg, LogLevel lvl) = 0;
 
    virtual void startProgress(
        const std::string& msg,
        uint               progressSize,
        uint               percPrintProgress = 10,
        uint               startPerc         = 0,
        uint               endPerc           = 100) = 0;
 
    virtual void endProgress() = 0;
 
    virtual void progress(uint n) = 0;
};
 
/* Concepts */
 
template<typename T>
concept LoggerConcept = std::derived_from<RemoveRef<T>, AbstractLogger>;
 
} // namespace vcl
 
#endif // VCL_BASE_LOGGER_ABSTRACT_LOGGER_H