qgslogger.h

Go to the documentation of this file.

/***************************************************************************
                         qgslogger.h  -  description
                             -------------------
    begin                : April 2006
    copyright            : (C) 2006 by Marco Hugentobler
    email                : marco.hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSLOGGER_H
#define QGSLOGGER_H
 
#include "qgsconfig.h"
 
#include <iostream>
#include <sstream>
 
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QString>
#include <QTime>
 
using namespace Qt::StringLiterals;
 
class QFile;
 
#ifndef SIP_RUN
 
#ifdef QGISDEBUG
 
#define QgsDebugError( str ) QgsLogger::debug( QString( str ), 0, __FILE__, __FUNCTION__, __LINE__ )
 
#define QgsDebugMsgLevel( str, level )                                                 \
  do                                                                                   \
  {                                                                                    \
    if ( ( level ) <= QgsLogger::debugLevel() )                                        \
    {                                                                                  \
      QgsLogger::debug( QString( str ), ( level ), __FILE__, __FUNCTION__, __LINE__ ); \
    }                                                                                  \
  } while ( false )
 
#define QgsDebugErrorLoc( str, file, func, line ) QgsLogger::debug( QString( str ), 0, ( file ), ( func ), ( line ) )
 
#define QgsDebugMsgLevelLoc( str, level, file, func, line )                        \
  do                                                                               \
  {                                                                                \
    if ( ( level ) <= QgsLogger::debugLevel() )                                    \
    {                                                                              \
      QgsLogger::debug( QString( str ), ( level ), ( file ), ( func ), ( line ) ); \
    }                                                                              \
  } while ( false )
 
#define QgsDebugCall QgsScopeLogger _qgsScopeLogger( __FILE__, __FUNCTION__, __LINE__ )
 
#else
 
#define QgsDebugCall \
  do                 \
  {                  \
  } while ( false )
 
#define QgsDebugError( str )                            \
  do                                                    \
  {                                                     \
    if constexpr ( false )                              \
    {                                                   \
      QgsLogger::debug( QString( str ), 0, "", "", 0 ); \
    }                                                   \
  } while ( false )
 
#define QgsDebugMsgLevel( str, level )                          \
  do                                                            \
  {                                                             \
    if constexpr ( false )                                      \
    {                                                           \
      QgsLogger::debug( QString( str ), ( level ), "", "", 0 ); \
    }                                                           \
  } while ( false )
 
#define QgsDebugErrorLoc( str, file, func, line )                          \
  do                                                                       \
  {                                                                        \
    if constexpr ( false )                                                 \
    {                                                                      \
      QgsLogger::debug( QString( str ), 0, ( file ), ( func ), ( line ) ); \
    }                                                                      \
  } while ( false )
 
#define QgsDebugMsgLevelLoc( str, level, file, func, line )                        \
  do                                                                               \
  {                                                                                \
    if constexpr ( false )                                                         \
    {                                                                              \
      QgsLogger::debug( QString( str ), ( level ), ( file ), ( func ), ( line ) ); \
    }                                                                              \
  } while ( false )
#endif
 
#endif
 

 
class CORE_EXPORT QgsLogger
{
  public:
    static void debug( const QString &msg, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );

    static void debug( const QString &var, int val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );

    static void debug( const QString &var, double val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 ) SIP_SKIP SIP_SKIP;

    template<typename T> static void debug( const QString &var, T val, const char *file = nullptr, const char *function = nullptr, int line = -1, int debuglevel = 1 ) SIP_SKIP SIP_SKIP
    {
      std::ostringstream os;
      os << var.toLocal8Bit().data() << " = " << val;
      debug( var, os.str().c_str(), file, function, line, debuglevel );
    }

    static void warning( const QString &msg );

    static void critical( const QString &msg );

    static void fatal( const QString &msg );

    static int debugLevel()
    {
      if ( sDebugLevel == -999 )
        init();
      return sDebugLevel;
    }

    static void logMessageToFile( const QString &message );

    static QString logFile();
 
  private:
    static void init();

    static int sDebugLevel;
    static int sPrefixLength;
};

class CORE_EXPORT QgsScopeLogger // clazy:exclude=rule-of-three
{
  public:
    QgsScopeLogger( const char *file, const char *func, int line )
      : _file( file )
      , _func( func )
      , _line( line )
    {
      QgsLogger::debug( u"Entering."_s, 2, _file, _func, _line );
    }
    ~QgsScopeLogger() { QgsLogger::debug( u"Leaving."_s, 2, _file, _func, _line ); }
 
  private:
    const char *_file = nullptr;
    const char *_func = nullptr;
    int _line;
};
 
#endif