QuentierLogger.h

/*
 * Copyright 2016-2024 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier 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 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <quentier/utility/Linkage.h>
 
#include <QDebug>
#include <QRegularExpression>
#include <QString>
#include <QTextStream>
 
namespace quentier {

enum class LogLevel
{
    Trace,
    Debug,
    Info,
    Warning,
    Error
};
 
QUENTIER_EXPORT QDebug & operator<<(QDebug & dbg, LogLevel logLevel);
 
QUENTIER_EXPORT QTextStream & operator<<(QTextStream & strm, LogLevel logLevel);

void QUENTIER_EXPORT QuentierInitializeLogging();

void QUENTIER_EXPORT QuentierAddLogEntry(
    const QString & sourceFileName, int sourceFileLineNumber,
    const QString & component, const QString & message, LogLevel logLevel);

LogLevel QUENTIER_EXPORT QuentierMinLogLevel();

void QUENTIER_EXPORT QuentierSetMinLogLevel(LogLevel logLevel);

void QUENTIER_EXPORT QuentierAddStdOutLogDestination();

[[nodiscard]] bool QUENTIER_EXPORT QuentierIsLogLevelActive(LogLevel logLevel);

[[nodiscard]] QString QUENTIER_EXPORT QuentierLogFilesDirPath();

void QUENTIER_EXPORT QuentierRestartLogging();

[[nodiscard]] QRegularExpression QUENTIER_EXPORT QuentierLogComponentFilter();

void QUENTIER_EXPORT
    QuentierSetLogComponentFilter(const QRegularExpression & filter);
 
} // namespace quentier
 
#define QNLOG_PRIVATE_BASE(component, message, level)                          \
    if (quentier::QuentierIsLogLevelActive(quentier::LogLevel::level)) {       \
        QString msg;                                                           \
        QDebug dbg(&msg);                                                      \
        dbg.nospace();                                                         \
        dbg.noquote();                                                         \
        dbg << message;                                                        \
        quentier::QuentierAddLogEntry(                                         \
            QStringLiteral(__FILE__), __LINE__, QString::fromUtf8(component),  \
            msg, quentier::LogLevel::level);                                   \
    }                                                                          \
    // QNLOG_PRIVATE_BASE
 
#define QNTRACE(component, message)                                            \
    QNLOG_PRIVATE_BASE(component, message, Trace)                              \
    // QNTRACE
 
#define QNDEBUG(component, message)                                            \
    QNLOG_PRIVATE_BASE(component, message, Debug)                              \
    // QNDEBUG
 
#define QNINFO(component, message)                                             \
    QNLOG_PRIVATE_BASE(component, message, Info)                               \
    // QNINFO
 
#define QNWARNING(component, message)                                          \
    QNLOG_PRIVATE_BASE(component, message, Warning)                            \
    // QNWARNING
 
#define QNERROR(component, message)                                            \
    QNLOG_PRIVATE_BASE(component, message, Error)                              \
    // QNERROR
 
#define QUENTIER_SET_MIN_LOG_LEVEL(level)                                      \
    quentier::QuentierSetMinLogLevel(quentier::LogLevel::level)
  // QUENTIER_SET_MIN_LOG_LEVEL
 
#define QUENTIER_INITIALIZE_LOGGING() quentier::QuentierInitializeLogging()
  // QUENTIER_INITIALIZE_LOGGING
 
// clang-format off
#define QUENTIER_ADD_STDOUT_LOG_DESTINATION()                                  \
    quentier::QuentierAddStdOutLogDestination()                                \
    // QUENTIER_ADD_STDOUT_LOG_DESTINATION
// clang-format on
 
#define QNLOG_FILE_LINENUMBER_DELIMITER ":"