0fdab36710
Many of our systems currently generate significant amount of debug output on deeper levels. Now, when your engine is using Debug Channels, you might want to show that debug information only, which is currently not possible, as the generic output will be mixed in your output. Alternative solution would be to implement possibility to specify per-channel debug levels.
135 lines
4.4 KiB
C
135 lines
4.4 KiB
C
/* ScummVM - Graphic Adventure Engine
|
|
*
|
|
* ScummVM is the legal property of its developers, whose names
|
|
* are too numerous to list here. Please refer to the COPYRIGHT
|
|
* file distributed with this source distribution.
|
|
*
|
|
* 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.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*
|
|
*/
|
|
|
|
#ifndef COMMON_DEBUG_H
|
|
#define COMMON_DEBUG_H
|
|
|
|
#include "common/scummsys.h"
|
|
|
|
#ifdef DISABLE_TEXT_CONSOLE
|
|
|
|
inline void debug(const char *s, ...) {}
|
|
inline void debug(int level, const char *s, ...) {}
|
|
inline void debugN(const char *s, ...) {}
|
|
inline void debugN(int level, const char *s, ...) {}
|
|
inline void debugC(int level, uint32 engineChannel, const char *s, ...) {}
|
|
inline void debugC(uint32 engineChannel, const char *s, ...) {}
|
|
inline void debugCN(int level, uint32 engineChannel, const char *s, ...) {}
|
|
inline void debugCN(uint32 engineChannel, const char *s, ...) {}
|
|
|
|
|
|
#else
|
|
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout).
|
|
* Automatically appends a newline.
|
|
*/
|
|
void debug(const char *s, ...) GCC_PRINTF(1, 2);
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout), but only if
|
|
* the gDebugLevel equals at least the specified level.
|
|
* As a rule of thumb, the more important the message, the lower the level.
|
|
* Automatically appends a newline.
|
|
*/
|
|
void debug(int level, const char *s, ...) GCC_PRINTF(2, 3);
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout).
|
|
* Does not append a newline.
|
|
*/
|
|
void debugN(const char *s, ...) GCC_PRINTF(1, 2);
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout), but only if
|
|
* the gDebugLevel equals at least the specified level.
|
|
* As a rule of thumb, the more important the message, the lower the level.
|
|
* Does not append a newline.
|
|
*/
|
|
void debugN(int level, const char *s, ...) GCC_PRINTF(2, 3);
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout), but only if
|
|
* the gDebugLevel equals at least the specified level AND
|
|
* if the specified special debug level is active.
|
|
* As a rule of thumb, the more important the message, the lower the level.
|
|
* Automatically appends a newline.
|
|
*
|
|
* @see enableDebugChannel
|
|
*/
|
|
void debugC(int level, uint32 debugChannels, const char *s, ...) GCC_PRINTF(3, 4);
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout), but only if
|
|
* the gDebugLevel equals at least the specified level AND
|
|
* if the specified special debug level is active.
|
|
* As a rule of thumb, the more important the message, the lower the level.
|
|
* Does not append a newline automatically.
|
|
*
|
|
* @see enableDebugChannel
|
|
*/
|
|
void debugCN(int level, uint32 debugChannels, const char *s, ...) GCC_PRINTF(3, 4);
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout), but only if
|
|
* the specified special debug level is active.
|
|
* Automatically appends a newline.
|
|
*
|
|
* @see enableDebugChannel
|
|
*/
|
|
void debugC(uint32 debugChannels, const char *s, ...) GCC_PRINTF(2, 3);
|
|
|
|
/**
|
|
* Print a debug message to the text console (stdout), but only if
|
|
* the specified special debug level is active.
|
|
* Does not append a newline automatically.
|
|
*
|
|
* @see enableDebugChannel
|
|
*/
|
|
void debugCN(uint32 debugChannels, const char *s, ...) GCC_PRINTF(2, 3);
|
|
|
|
#endif
|
|
|
|
/**
|
|
* The debug level. Initially set to -1, indicating that no debug output
|
|
* should be shown. Positive values usually imply an increasing number of
|
|
* debug output shall be generated, the higher the value, the more verbose the
|
|
* information (although the exact semantics are up to the engines).
|
|
*/
|
|
extern int gDebugLevel;
|
|
|
|
/**
|
|
* Specify if we want to show only the debug channels and suppress
|
|
* the non-channeled output.
|
|
*
|
|
* This option is useful when you want to have higher levels of channels
|
|
* visible without the noise from other subsystems or OSystem.
|
|
*/
|
|
extern bool gDebugChannelsOnly;
|
|
|
|
//Global constant for EventRecorder debug channel
|
|
enum GlobalDebugLevels {
|
|
kDebugLevelEventRec = 1 << 30
|
|
};
|
|
|
|
#endif
|