QGIS API Documentation  3.17.0-Master (8af46bc54f)
qgslogger.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgslogger.h - description
3  -------------------
4  begin : April 2006
5  copyright : (C) 2006 by Marco Hugentobler
6  email : marco.hugentobler at karto dot baug dot ethz dot ch
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSLOGGER_H
19 #define QGSLOGGER_H
20 
21 #include <iostream>
22 #include "qgis_sip.h"
23 #include <sstream>
24 #include <QString>
25 #include <QTime>
26 
27 #include "qgis_core.h"
28 #include "qgsconfig.h"
29 
30 class QFile;
31 
32 #ifdef QGISDEBUG
33 #define QgsDebugMsg(str) QgsLogger::debug(QString(str), 1, __FILE__, __FUNCTION__, __LINE__)
34 #define QgsDebugMsgLevel(str, level) if ( level <= QgsLogger::debugLevel() ) { QgsLogger::debug(QString(str), (level), __FILE__, __FUNCTION__, __LINE__); }(void)(0)
35 #define QgsDebugCall QgsScopeLogger _qgsScopeLogger(__FILE__, __FUNCTION__, __LINE__)
36 #else
37 #define QgsDebugCall do {} while(false)
38 #define QgsDebugMsg(str) do {} while(false)
39 #define QgsDebugMsgLevel(str, level) do {} while(false)
40 #endif
41 
59 class CORE_EXPORT QgsLogger
60 {
61  public:
62 
71  static void debug( const QString &msg, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );
72 
74  static void debug( const QString &var, int val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );
75 
80  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;
81 
86  template <typename T> static void debug( const QString &var, T val, const char *file = nullptr, const char *function = nullptr,
87  int line = -1, int debuglevel = 1 ) SIP_SKIP SIP_SKIP
88  {
89  std::ostringstream os;
90  os << var.toLocal8Bit().data() << " = " << val;
91  debug( var, os.str().c_str(), file, function, line, debuglevel );
92  }
93 
95  static void warning( const QString &msg );
96 
98  static void critical( const QString &msg );
99 
101  static void fatal( const QString &msg );
102 
107  static int debugLevel()
108  {
109  if ( sDebugLevel == -999 )
110  init();
111  return sDebugLevel;
112  }
113 
115  static void logMessageToFile( const QString &message );
116 
121  static QString logFile();
122 
123  private:
124  static void init();
125 
127  static int sDebugLevel;
128  static int sPrefixLength;
129 };
130 
134 class CORE_EXPORT QgsScopeLogger // clazy:exclude=rule-of-three
135 {
136  public:
137  QgsScopeLogger( const char *file, const char *func, int line )
138  : _file( file )
139  , _func( func )
140  , _line( line )
141  {
142  QgsLogger::debug( QStringLiteral( "Entering." ), 2, _file, _func, _line );
143  }
145  {
146  QgsLogger::debug( QStringLiteral( "Leaving." ), 2, _file, _func, _line );
147  }
148  private:
149  const char *_file = nullptr;
150  const char *_func = nullptr;
151  int _line;
152 };
153 
154 #endif
QgsLogger is a class to print debug/warning/error messages to the console.
Definition: qgslogger.h:59
QgsScopeLogger(const char *file, const char *func, int line)
Definition: qgslogger.h:137
#define SIP_SKIP
Definition: qgis_sip.h:126
static void debug(const QString &msg, int debuglevel=1, const char *file=nullptr, const char *function=nullptr, int line=-1)
Goes to qDebug.
Definition: qgslogger.cpp:58
static int debugLevel()
Reads the environment variable QGIS_DEBUG and converts it to int.
Definition: qgslogger.h:107
static void debug(const QString &var, T val, const char *file=nullptr, const char *function=nullptr, int line=-1, int debuglevel=1)
Prints out a variable/value pair for types with overloaded operator<<.
Definition: qgslogger.h:86