QGIS API Documentation  3.13.0-Master (b73bd58cfb)
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
38 #define QgsDebugMsg(str)
39 #define QgsDebugMsgLevel(str, level)
40 #endif
41 
59 class CORE_EXPORT QgsLogger
60 {
61  public:
62 
70  static void debug( const QString &msg, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );
71 
73  static void debug( const QString &var, int val, int debuglevel = 1, const char *file = nullptr, const char *function = nullptr, int line = -1 );
74 
79  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;
80 
85  template <typename T> static void debug( const QString &var, T val, const char *file = nullptr, const char *function = nullptr,
86  int line = -1, int debuglevel = 1 ) SIP_SKIP SIP_SKIP
87  {
88  std::ostringstream os;
89  os << var.toLocal8Bit().data() << " = " << val;
90  debug( var, os.str().c_str(), file, function, line, debuglevel );
91  }
92 
94  static void warning( const QString &msg );
95 
97  static void critical( const QString &msg );
98 
100  static void fatal( const QString &msg );
101 
105  static int debugLevel()
106  {
107  if ( sDebugLevel == -999 )
108  init();
109  return sDebugLevel;
110  }
111 
113  static void logMessageToFile( const QString &message );
114 
118  static QString logFile();
119 
120  private:
121  static void init();
122 
124  static int sDebugLevel;
125  static int sPrefixLength;
126 };
127 
131 class CORE_EXPORT QgsScopeLogger // clazy:exclude=rule-of-three
132 {
133  public:
134  QgsScopeLogger( const char *file, const char *func, int line )
135  : _file( file )
136  , _func( func )
137  , _line( line )
138  {
139  QgsLogger::debug( QStringLiteral( "Entering." ), 2, _file, _func, _line );
140  }
142  {
143  QgsLogger::debug( QStringLiteral( "Leaving." ), 2, _file, _func, _line );
144  }
145  private:
146  const char *_file = nullptr;
147  const char *_func = nullptr;
148  int _line;
149 };
150 
151 #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:134
#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:105
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:85