File: qgslogger.sip.in

package info (click to toggle)
qgis 3.40.11%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,183,800 kB
  • sloc: cpp: 1,595,841; python: 372,637; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,257; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 154
file content (113 lines) | stat: -rw-r--r-- 3,523 bytes parent folder | download | duplicates (12)
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
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgslogger.h                                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/








class QgsLogger
{
%Docstring(signature="appended")
:py:class:`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.
%End

%TypeHeaderCode
#include "qgslogger.h"
%End
  public:

    static void debug( const QString &msg, int debuglevel = 1, const char *file = 0, const char *function = 0, int line = -1 );
%Docstring
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
%End

    static void debug( const QString &var, int val, int debuglevel = 1, const char *file = 0, const char *function = 0, int line = -1 );
%Docstring
Similar to the previous method, but prints a variable int-value pair
%End



    static void warning( const QString &msg );
%Docstring
Goes to qWarning.
%End

    static void critical( const QString &msg );
%Docstring
Goes to qCritical.
%End

    static void fatal( const QString &msg );
%Docstring
Goes to qFatal.
%End

    static int debugLevel();
%Docstring
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.
%End

    static void logMessageToFile( const QString &message );
%Docstring
Logs the message passed in to the logfile defined in QGIS_LOG_FILE if
any.
%End

    static QString logFile();
%Docstring
Reads the environment variable QGIS_LOG_FILE. Returns an empty string if
the variable is not set, otherwise returns a file name for writing log
messages to.
%End

};

class QgsScopeLogger
{

%TypeHeaderCode
#include "qgslogger.h"
%End
  public:
    QgsScopeLogger( const char *file, const char *func, int line );
    ~QgsScopeLogger();
};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/qgslogger.h                                                 *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/