ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

common/debug.h File Reference

#include "common/scummsys.h"
Include dependency graph for common/debug.h:

Go to the source code of this file.

Enumerations

enum  GlobalDebugLevels { kDebugLevelEventRec = 1 << 30 }

Functions

void debug (const char *s,...) GCC_PRINTF(1
 Print a debug message to the text console (stdout).
void void debug (int level, const char *s,...) GCC_PRINTF(2
 Print a debug message to the text console (stdout), but only if the gDebugLevel equals at least the specified level.
void void void debugN (const char *s,...) GCC_PRINTF(1
 Print a debug message to the text console (stdout).
void void void void debugN (int level, const char *s,...) GCC_PRINTF(2
 Print a debug message to the text console (stdout), but only if the gDebugLevel equals at least the specified level.
void void void void void debugC (int level, uint32 debugChannels, const char *s,...) GCC_PRINTF(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.
void void void void void void debugCN (int level, uint32 debugChannels, const char *s,...) GCC_PRINTF(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.
void void void void void void void debugC (uint32 debugChannels, const char *s,...) GCC_PRINTF(2
 Print a debug message to the text console (stdout), but only if the specified special debug level is active.
void void void void void void
void void 
debugCN (uint32 debugChannels, const char *s,...) GCC_PRINTF(2
 Print a debug message to the text console (stdout), but only if the specified special debug level is active.
void void void void void void
void void bool 
debugLevelSet (int level)
 Returns true if the debug level is set to the specified level.
bool debugChannelSet (int level, uint32 debugChannels)
 Returns true if the debug level and channel are active.

Variables

int gDebugLevel
 The debug level.
bool gDebugChannelsOnly
 Specify if we want to show only the debug channels and suppress the non-channeled output.

Enumeration Type Documentation

Enumerator:
kDebugLevelEventRec 

Definition at line 143 of file common/debug.h.


Function Documentation

void debug ( const char *  s,
  ... 
)

Print a debug message to the text console (stdout).

Automatically appends a newline.

void void debug ( int  level,
const char *  s,
  ... 
)

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 void void void void debugC ( int  level,
uint32  debugChannels,
const char *  s,
  ... 
)

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 also:
enableDebugChannel
void void void void void void void debugC ( uint32  debugChannels,
const char *  s,
  ... 
)

Print a debug message to the text console (stdout), but only if the specified special debug level is active.

Automatically appends a newline.

See also:
enableDebugChannel
bool debugChannelSet ( int  level,
uint32  debugChannels 
)

Returns true if the debug level and channel are active.

Parameters:
level debug level to check against. If set to -1, only channel check is active
See also:
enableDebugChannel

Definition at line 127 of file common/debug.cpp.

void void void void void void void void debugCN ( uint32  debugChannels,
const char *  s,
  ... 
)

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 also:
enableDebugChannel
void void void void void void debugCN ( int  level,
uint32  debugChannels,
const char *  s,
  ... 
)

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 also:
enableDebugChannel
void void void void void void void void bool debugLevelSet ( int  level  ) 

Returns true if the debug level is set to the specified level.

Definition at line 123 of file common/debug.cpp.

void void void debugN ( const char *  s,
  ... 
)

Print a debug message to the text console (stdout).

Does not append a newline.

void void void void debugN ( int  level,
const char *  s,
  ... 
)

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.


Variable Documentation

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.

Definition at line 33 of file common/debug.cpp.

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).

Definition at line 32 of file common/debug.cpp.



Generated on Sat Mar 16 2019 05:02:27 for ResidualVM by doxygen 1.7.1
curved edge   curved edge