InterfaceLogger.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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
 * GNU Lesser General Public License version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/

#ifndef INTERFACELOGGER_H
#define INTERFACELOGGER_H

// -- Core stuff
#include "CamiTKAPI.h"

class QObject;

#include <QDir>
#include <QFileInfo>

namespace camitk {

class CAMITK_API InterfaceLogger {

public:

#ifdef ERROR
#define CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD ERROR
#undef ERROR
#endif
    enum LogLevel {
        NONE = 0,  
        ERROR = 1,  
        WARNING = 2,  
        INFO = 3,  
        TRACE = 4,  
    };

#ifdef CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD
#define ERROR CAMITK_WINDOWS_SYSTEM_ERROR_SAFEGUARD
#endif

    virtual ~InterfaceLogger() = default;

    virtual LogLevel getLogLevel() = 0;

    virtual void setLogLevel(LogLevel level) = 0;

    virtual void setLogToStandardOutput(bool writeToStdOut) = 0;

    virtual bool getLogToStandardOutput() = 0;

    virtual bool setLogToFile(bool writeToFile) = 0;

    virtual bool setLogFileDirectory(QDir directoryName, bool moveExistingLogFile = true) = 0;

    virtual bool getLogToFile() = 0;

    virtual QFileInfo getLogFileInfo() = 0;

    virtual void setMessageBoxLevel(LogLevel level) = 0;

    virtual LogLevel getMessageBoxLevel() = 0;

    virtual void setDebugInformation(bool) = 0;

    virtual bool getDebugInformation() = 0;

    virtual void setTimeStampInformation(bool showTimeStamp) = 0;

    virtual bool getTimeStampInformation() = 0;

    virtual QString log(const QString msg, const LogLevel level, char const* fileName, char const* methodName, int lineNumber, const QObject* sender = nullptr) = 0;
};

}

#endif // INTERFACELOGGER_H