qgsmessagelog.h

Go to the documentation of this file.

/***************************************************************************
    qgsmessagelog.h  -  interface for logging messages
    ----------------------
    begin                : October 2011
    copyright            : (C) 2011 by Juergen E. Fischer
    email                : jef at norbit dot de
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSMESSAGELOG_H
#define QGSMESSAGELOG_H
 
#include "qgis.h"
#include "qgis_core.h"
 
#include <QObject>
#include <QString>

class CORE_EXPORT QgsMessageLog : public QObject
{
    Q_OBJECT
 
  public:
 
    QgsMessageLog() = default;
 
    // TODO: Update this code to use std::source_location from C++20 when transitioning to a fully C++20-compliant codebase.
    //       Currently, we rely on __builtin_XXX functions (e.g., __builtin_FILE(), __builtin_LINE()),
    //       which have been successfully tested across multiple systems (Windows, macOS, Linux, FreeBSD)
    //       and compilers (LLVM, GCC, MSVC).
    // Note: We tested with LLVM on FreeBSD and macOS, and std::experimental::source_location is not available.
    //       It works fine with GNU. It also seems unavailable with MSVC.
    //       For now, we stick with __builtin_XXX because it is "portable" and functional across all tested environments.
    //       We'll switch to std::source_location once the transition to C++20 is complete.

    static void logMessage( const QString &message, const QString &tag = QString(), Qgis::MessageLevel level = Qgis::MessageLevel::Warning, bool notifyUser = true,
                            const char *file = __builtin_FILE(), const char *function = __builtin_FUNCTION(), int line = __builtin_LINE(), Qgis::StringFormat format = Qgis::StringFormat::PlainText );
 
  signals:

    Q_DECL_DEPRECATED void messageReceived( const QString &message, const QString &tag, Qgis::MessageLevel level ) SIP_DEPRECATED;

    void messageReceivedWithFormat( const QString &message, const QString &tag, Qgis::MessageLevel level, Qgis::StringFormat );
 
    //TODO QGIS 5.0 - remove received argument

    void messageReceived( bool received );
 
  private:
 
    void emitMessage( const QString &message, const QString &tag, Qgis::MessageLevel level, bool notifyUser = true, Qgis::StringFormat format = Qgis::StringFormat::PlainText );
 
    int mAdviseBlockCount = 0;
 
    friend class QgsMessageLogNotifyBlocker;
 
};

class CORE_EXPORT QgsMessageLogNotifyBlocker
{
  public:

    QgsMessageLogNotifyBlocker();
 
    QgsMessageLogNotifyBlocker( const QgsMessageLogNotifyBlocker &other ) = delete;
    QgsMessageLogNotifyBlocker &operator=( const QgsMessageLogNotifyBlocker &other ) = delete;
 
    ~QgsMessageLogNotifyBlocker();
 
  private:
 
#ifdef SIP_RUN
    QgsMessageLogNotifyBlocker( const QgsMessageLogNotifyBlocker &other );
#endif
};

class CORE_EXPORT QgsMessageLogConsole : public QObject
{
    Q_OBJECT
 
  public:

    QgsMessageLogConsole();
 
  protected:

    QString formatLogMessage( const QString &message, const QString &tag, Qgis::MessageLevel level = Qgis::MessageLevel::Info ) const;
 
  public slots:

    virtual void logMessage( const QString &message, const QString &tag, Qgis::MessageLevel level );

    virtual void logMessage( const QString &message, const QString &tag, Qgis::MessageLevel level, Qgis::StringFormat format );
};
 
#endif