CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

reporter.h File Reference

Reporter interface. More...

#include "csutil/ansicolor.h"
#include "csutil/scf.h"
#include "csutil/sysfunc.h"
#include "csutil/util.h"
#include "iutil/objreg.h"

Go to the source code of this file.

Classes

class  csReporterHelper
 Helper class for csReport(). More...
struct  iReporter
 This is the interface for the error/message reporter plugin. More...
struct  iReporterIterator
 An iterator to iterate over all messages in the reporter. More...
struct  iReporterListener
 Implement this interface if you're interested in hearing about new messages on the reporter. More...

iReporter severity levels

#define CS_REPORTER_SEVERITY_BUG   0
 BUG severity level.
#define CS_REPORTER_SEVERITY_DEBUG   4
 DEBUG severity level.
#define CS_REPORTER_SEVERITY_ERROR   1
 ERROR severity level.
#define CS_REPORTER_SEVERITY_NOTIFY   3
 NOTIFY severity level.
#define CS_REPORTER_SEVERITY_WARNING   2
 WARNING severity level.

Defines

#define csReport   csReporterHelper::Report
 Helper macro to use a reporter easily.
#define csReportV   csReporterHelper::ReportV
 Helper macro to use a reporter easily.


Detailed Description

Reporter interface.

Definition in file reporter.h.


Define Documentation

#define CS_REPORTER_SEVERITY_BUG   0
 

BUG severity level.

This is the worst thing that can happen. It means that some code detected a bug in Crystal Space.

Definition at line 43 of file reporter.h.

Referenced by iReporter::ReportBug(), and csReporterHelper::ReportV().

#define CS_REPORTER_SEVERITY_DEBUG   4
 

DEBUG severity level.

This is for debugging and it will usually generate an entry in some log.

Definition at line 69 of file reporter.h.

Referenced by iReporter::ReportDebug(), and csReporterHelper::ReportV().

#define CS_REPORTER_SEVERITY_ERROR   1
 

ERROR severity level.

There was an error of some kind. Usually this is an error while reading data.

Definition at line 50 of file reporter.h.

Referenced by csDebugImageWriter::DebugImageWrite(), iReporter::ReportError(), csApplicationFramework::ReportError(), and csReporterHelper::ReportV().

#define CS_REPORTER_SEVERITY_NOTIFY   3
 

NOTIFY severity level.

Just a notification message.

Definition at line 62 of file reporter.h.

Referenced by csApplicationFramework::ReportInfo(), iReporter::ReportNotify(), and csReporterHelper::ReportV().

#define CS_REPORTER_SEVERITY_WARNING   2
 

WARNING severity level.

There was some condition which is non fatal but is suspicious.

Definition at line 56 of file reporter.h.

Referenced by csReporterHelper::ReportV(), iReporter::ReportWarning(), and csApplicationFramework::ReportWarning().

#define csReport   csReporterHelper::Report
 

Helper macro to use a reporter easily.

Definition at line 389 of file reporter.h.

#define csReportV   csReporterHelper::ReportV
 

Helper macro to use a reporter easily.

Definition at line 393 of file reporter.h.

Referenced by csApplicationFramework::ReportError(), csApplicationFramework::ReportInfo(), and csApplicationFramework::ReportWarning().


Generated for Crystal Space by doxygen 1.4.4