CamiTKLogger.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2025 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * 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 CAMITKLOGGER_H
#define CAMITKLOGGER_H
 
// -- Core stuff
#include "CamiTKAPI.h"
#include "InterfaceLogger.h"
 
// -- Qt stuff
#include <QDir>
#include <QDateTime>
class QFile;
class QTextStream;
 
namespace camitk {

 
class CAMITK_API CamiTKLogger : public InterfaceLogger {
 
public :
    CamiTKLogger();

    ~CamiTKLogger() override;

    LogLevel getLogLevel() override;

    void setLogLevel(LogLevel level) override;

    void setLogToStandardOutput(bool writeToStdOut) override;

    bool getLogToStandardOutput() override;

    bool setLogToFile(bool writeToFile) override;

    bool setLogFileDirectory(QDir directoryName, bool moveExistingLogFile = true) override;

    bool getLogToFile() override;

    QFileInfo getLogFileInfo() override;

    void setMessageBoxLevel(LogLevel level) override;

    LogLevel getMessageBoxLevel() override;

    void setDebugInformation(bool) override;

    bool getDebugInformation() override;

    void setTimeStampInformation(bool showTimeStamp) override;

    bool getTimeStampInformation() override;

    QString log(const QString msg, const LogLevel level, char const* fileName, char const* methodName, int lineNumber, const QObject* sender = nullptr) override final;
 
 
protected:
    virtual QString buildLogMessage(QString message, LogLevel level, char const* fileName, char const* methodName, int lineNumber, const QObject* sender = nullptr);
 
private:
    QString getCamiTKAPIInformation(const QObject* sender);

    bool openLogFile(bool moveFile = false, QFileInfo fileToMove = QFileInfo());

    void closeLogFile();

    InterfaceLogger::LogLevel level;

    InterfaceLogger::LogLevel messageBoxLevel;

    bool logToStdOut;

    bool logToFile;

    bool displayDebugInformation;

    bool displayTimeStampInformation;

    QDir logFileDirectory;

    QFile* logFile;

    QTextStream* logStream;

    QDateTime logStartTime;
 
};
 
}
 
#endif // CAMITKLOGGER_H