include/DebugReport.h File Reference


Detailed Description

Project Debugging Utility Library - Error Reporting Header.

Author:
Richard Marks <ccpsceo@gmail.com>, Redslash
The Project Debugging Utility Library is comprised of a few classes that make error reporting an easy task. There are several levels of reporting severity.
Including

Definition in file DebugReport.h.

#include <cstdarg>

Include dependency graph for DebugReport.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  DEBUG

Classes

class  DEBUG::DebugReportInfo
 A helper class that gives the functionality of a printf-style error reporting function. More...
class  DEBUG::DebugReport
 Handles the actual report logging functionality of the debug system. More...
class  DEBUG::DebugAllegroGUI
 a simple class providing static methods that wrap around allegro's alert() function More...

Defines

#define __PRETTY_FUNCTION__   "This feature is unavailable on this compiler."
#define LogFatal   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintFatal
 reports a fatal error and kills the running process
#define LogError   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintError
 reports an error and continues running
#define LogWarning   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintWarning
 reports a warning and continues running
#define LogMessage   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintMessage
 reports a message and continues running
#define LogSimpleMessage   DEBUG::DebugReportInfo("simple", "", 1984).PrintSimpleMessage
 reports a message with no extra information attached and continues running

Enumerations

enum  DEBUG::ReportSeverityLevel {
  DEBUG::DebugReport_Fatal, DEBUG::DebugReport_Error, DEBUG::DebugReport_Warning, DEBUG::DebugReport_Message,
  DEBUG::DebugReport_SimpleMessage
}
 Possible levels of severity for error reporting. More...

Variables

const unsigned int DEBUG::DBGREP_MAX_REPORT_LENGTH = 0x1000
 the maximum report length is limited to 4096 characters


Define Documentation

#define __PRETTY_FUNCTION__   "This feature is unavailable on this compiler."

Definition at line 34 of file DebugReport.h.

#define LogError   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintError

#define LogFatal   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintFatal

#define LogMessage   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintMessage

reports a message and continues running

Definition at line 228 of file DebugReport.h.

Referenced by ENGINE::InputDeviceSingleton::BeginJoystickCalibration(), and UTILITY::PARSING::TextFileParser::Execute().

#define LogSimpleMessage   DEBUG::DebugReportInfo("simple", "", 1984).PrintSimpleMessage

reports a message with no extra information attached and continues running

Definition at line 229 of file DebugReport.h.

#define LogWarning   DEBUG::DebugReportInfo(__PRETTY_FUNCTION__, __FILE__, __LINE__).PrintWarning

reports a warning and continues running

Definition at line 227 of file DebugReport.h.

Referenced by UTILITY::FILESYSTEM::FileExists::Execute(), and ENGINE::InputDeviceSingleton::InitializeJoystick().


Generated on Tue Mar 3 20:11:33 2009 for ged101minimal by  doxygen 1.5.5