Debug

Description

Various debugging helpers.

Classes

class  BitmapWriter
 Utility class for generating BMP images. More...
 
class  Debug
 Utility class providing various debug functionality. More...
 
class  LogEntry
 A single log entry, containing a message and a channel the message was recorded on. More...
 
class  Log
 Used for logging messages. More...
 

Macros

#define LOGDBG(x)   bs::gDebug().logDebug((x) + String("\n\t\t in ") + __PRETTY_FUNCTION__ + " [" + __FILE__ + ":" + toString(__LINE__) + "]\n");
 Shortcut for logging a message in the debug channel. More...
 
#define LOGWRN(x)   bs::gDebug().logWarning((x) + String("\n\t\t in ") + __PRETTY_FUNCTION__ + " [" + __FILE__ + ":" + toString(__LINE__) + "]\n");
 Shortcut for logging a message in the warning channel. More...
 
#define LOGERR(x)   bs::gDebug().logError((x) + String("\n\t\t in ") + __PRETTY_FUNCTION__ + " [" + __FILE__ + ":" + toString(__LINE__) + "]\n");
 Shortcut for logging a message in the error channel. More...
 
#define LOGDBG_VERBOSE(x)
 Shortcut for logging a verbose message in the debug channel. More...
 
#define LOGWRN_VERBOSE(x)
 Shortcut for logging a verbose message in the warning channel. More...
 

Enumerations

enum  DebugChannel {
  Debug, Warning, Error, CompilerWarning,
  CompilerError
}
 Available types of channels that debug messages can be logged to. More...
 

Functions

BS_UTILITY_EXPORT Debug & gDebug ()
 A simpler way of accessing the Debug module. More...
 

Macro Definition Documentation

#define LOGDBG (   x)    bs::gDebug().logDebug((x) + String("\n\t\t in ") + __PRETTY_FUNCTION__ + " [" + __FILE__ + ":" + toString(__LINE__) + "]\n");

Shortcut for logging a message in the debug channel.

#define LOGDBG_VERBOSE (   x)

Shortcut for logging a verbose message in the debug channel.

Verbose messages can be ignored unlike other log messages.

#define LOGERR (   x)    bs::gDebug().logError((x) + String("\n\t\t in ") + __PRETTY_FUNCTION__ + " [" + __FILE__ + ":" + toString(__LINE__) + "]\n");

Shortcut for logging a message in the error channel.

#define LOGWRN (   x)    bs::gDebug().logWarning((x) + String("\n\t\t in ") + __PRETTY_FUNCTION__ + " [" + __FILE__ + ":" + toString(__LINE__) + "]\n");

Shortcut for logging a message in the warning channel.

#define LOGWRN_VERBOSE (   x)

Shortcut for logging a verbose message in the warning channel.

Verbose messages can be ignored unlike other log messages.

Enumeration Type Documentation

enum DebugChannel
strong

Available types of channels that debug messages can be logged to.

Function Documentation

BS_UTILITY_EXPORT Debug& bs::gDebug ( )

A simpler way of accessing the Debug module.