/usr/include/qgis/qgslogger.h is in libqgis-dev 2.4.0-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | /***************************************************************************
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 <iostream>
#include <sstream>
#include <QString>
class QFile;
#ifdef QGISDEBUG
#define QgsDebugMsg(str) QgsLogger::debug(QString(str), 1, __FILE__, __FUNCTION__, __LINE__)
#define QgsDebugMsgLevel(str, level) \
{ \
if ( QgsLogger::debugLevel() >= (level) && (level) > 0 ) \
QgsLogger::debug(QString(str), (level), __FILE__, __FUNCTION__, __LINE__); \
}
#define QgsDebugCall QgsScopeLogger _qgsScopeLogger(__FILE__, __FUNCTION__, __LINE__)
#else
#define QgsDebugCall
#define QgsDebugMsg(str)
#define QgsDebugMsgLevel(str, level)
#endif
/** \ingroup core
* QgsLogger is a class to print debug/warning/error messages to the console.
* The advantage of this class over iostream & co. is that the
* output can be controlled with environment variables:
* QGIS_DEBUG is an int describing what debug messages are written to the console.
* If the debug level of a message is <= QGIS_DEBUG, the message is written to the
* console. It the variable QGIS_DEBUG is not defined, it defaults to 1 for debug
* mode and to 0 for release mode
* QGIS_DEBUG_FILE may contain a file name. Only the messages from this file are
* printed (provided they have the right debuglevel). If QGIS_DEBUG_FILE is not
* set, messages from all files are printed
*
* QGIS_LOG_FILE may contain a file name. If set, all messages will be appended
* to this file rather than to stdout.
*/
class CORE_EXPORT QgsLogger
{
public:
/**Goes to qDebug.
@param msg the message to be printed
@param debuglevel
@param file file name where the message comes from
@param function function where the message comes from
@param line place in file where the message comes from*/
static void debug( const QString& msg, int debuglevel = 1, const char* file = NULL, const char* function = NULL, int line = -1 );
/**Similar to the previous method, but prints a variable int-value pair*/
static void debug( const QString& var, int val, int debuglevel = 1, const char* file = NULL, const char* function = NULL, int line = -1 );
/**Similar to the previous method, but prints a variable double-value pair*/
// @note not available in python bindings
static void debug( const QString& var, double val, int debuglevel = 1, const char* file = NULL, const char* function = NULL, int line = -1 );
/**Prints out a variable/value pair for types with overloaded operator<<*/
// @note not available in python bindings
template <typename T> static void debug( const QString& var, T val, const char* file = 0, const char* function = 0,
int line = -1, int debuglevel = 1 )
{
Q_UNUSED( debuglevel );
const char* dfile = debugFile();
if ( dfile ) //exit if QGIS_DEBUG_FILE is set and the message comes from the wrong file
{
if ( !file || strcmp( dfile, file ) != 0 )
{
return;
}
}
std::ostringstream os;
os << var.toLocal8Bit().data() << " = " << val;
if ( line == -1 )
{
qDebug( "%s: (%s) %s", file + sPrefixLength, function, os.str().c_str() );
}
else
{
#if defined(_MSC_VER)
qDebug( "%s(%d): (%s) %s", file + sPrefixLength, line, function, os.str().c_str() );
#else
qDebug( "%s: %d: (%s) %s", file + sPrefixLength, line, function, os.str().c_str() );
#endif
}
}
/**Goes to qWarning*/
static void warning( const QString& msg );
/**Goes to qCritical*/
static void critical( const QString& msg );
/**Goes to qFatal*/
static void fatal( const QString& msg );
/**Reads the environment variable QGIS_DEBUG and converts it to int. If QGIS_DEBUG is not set,
the function returns 1 if QGISDEBUG is defined and 0 if not*/
static int debugLevel();
/** Logs the message passed in to the logfile defined in QGIS_LOG_FILE if any. **/
static void logMessageToFile( QString theMessage );
/**Reads the environment variable QGIS_LOG_FILE. Returns NULL if the variable is not set,
* otherwise returns a file name for writing log messages to.*/
static const QString logFile();
private:
/**Reads the environment variable QGIS_DEBUG_FILE. Returns NULL if the variable is not set.
* If set, only messages from this source file will be sent to logs. */
static const char* debugFile();
/** current debug level */
static int sDebugLevel;
static int sPrefixLength;
};
class QgsScopeLogger
{
public:
QgsScopeLogger( const char* file, const char* func, int line )
: _file( file ), _func( func ), _line( line )
{
QgsLogger::debug( "Entering.", 1, _file, _func, _line );
}
~QgsScopeLogger()
{
QgsLogger::debug( "Leaving.", 1, _file, _func, _line );
}
private:
const char *_file;
const char *_func;
int _line;
};
#endif
|