module Message Reporting and Error Handling

Classes

Functions

Enums

Typedefs

Variables

Defines

bool GEO_CALL Geo::DisplayPageInBrowser

public: bool GEO_CALL DisplayPageInBrowser
(
    const char * htmlText
)

Display a text string, which should containing html, in the default browser.

Only implemented on windows platforms currently.

bool Geo::GeoAttachLogger

public: bool GeoAttachLogger
(
    GeoLogHandler logHandler,
    eGeoLogMsgTypeMask typeMask
)

Attach a log handler which will be passed messages of the requested types.

It returns true if it was successfully registered for all message types, otherwise a warning message is raised, and it returns false.

void Geo::GeoAttachSystemLoggers

public: void GeoAttachSystemLoggers
(
    eGeoLogContext context,
    bool nonInteractive
)

Attach a default set of system log handlers, appropriate to the content in which it is called.

Note, this has the side effect of enabling all the system loggers, even if they were previously disabled.

void Geo::GeoDetachAllLoggers

public: void GeoDetachAllLoggers
(
    eGeoLogMsgTypeMask typeMask
)

Detach all log handlers for the specified message types.

bool Geo::GeoDetachLogger

public: bool GeoDetachLogger
(
    GeoLogHandler logHandler,
    eGeoLogMsgTypeMask typeMask
)

Detach a previously attached log handler, it if was previously attached.

Returns true it if was detached, and false otherwise.

bool Geo::GeoIsLoggerAttached

public: bool GeoIsLoggerAttached
(
    eGeoLogMsgTypeMask typeMask
)

Return true if at least one logger is attached for all of the specified message types.

bool Geo::GeoLogHandler_Debugger

public: bool GeoLogHandler_Debugger
(
    eGeoLogMsgType msgType,
    u32 code,
    const char * msgText
)

A log message handler for writing messages to the debugger output channel.

bool Geo::GeoLogHandler_Popup

public: bool GeoLogHandler_Popup
(
    eGeoLogMsgType msgType,
    u32 code,
    const char * msgText
)

A log message handler for displaying messages in a popup box.

bool Geo::GeoLogHandler_Stdout

public: bool GeoLogHandler_Stdout
(
    eGeoLogMsgType msgType,
    u32 code,
    const char * msgText
)

A log message handler for writing messages to stdout.

void Geo::GeoLogHandler_Stdout_SetOrigin

public: void GeoLogHandler_Stdout_SetOrigin
(
    const char * filename
)

To support the MS error message format (see http://tinyurl.com/6hm53bz) allow user to set an Origin, otherwise just leave empty.

void Geo::GeoLogMsgType

public: void GeoLogMsgType
(
    eGeoLogMsgType type,
    u32 code,
    char * buffer
)

It is convenient to have a textual label for a given channel easily available.

The given buffer must be at least as long as GEO_LOG_MSG_TYPE_MAX_LENGTH.

bool Geo::GeoPrintf

public: bool GeoPrintf
(
    eGeoLogMsgType msgType,
    u32 code,
    const char * fmtStr,
    ...
)

Messages are passed through the logger using a "printf()" like function.

This function will always return true, unless any of the registered handlers return false. This is useful, for instance in the assert handler, where returning false indicates that the debugger should be entered.

bool Geo::GeoPrintf

public: bool GeoPrintf
(
    eGeoLogMsgType msgType,
    const char * fmtStr,
    ...
)

Messages are passed through the logger using a "printf()" like function.

This function will always return true, unless any of the registered handlers return false. This is useful, for instance in the assert handler, where returning false indicates that the debugger should be entered.

void GEO_CALL Geo::GeoStageBegin

public: void GEO_CALL GeoStageBegin
(
    const char * name
)

Begin a statistics block.

void GEO_CALL Geo::GeoStageEnd

public: void GEO_CALL GeoStageEnd()

End a statistics block.

void GEO_CALL Geo::GeoStatistic

public: void GEO_CALL GeoStatistic
(
    const char * name,
    Geo::s64 value
)

Log a single statistic, as a name/value pair.

void GEO_CALL Geo::GeoStatistic

public: void GEO_CALL GeoStatistic
(
    const char * name,
    Geo::s32 value
)

Log a single statistic, as a name/value pair.

void GEO_CALL Geo::GeoStatistic

public: void GEO_CALL GeoStatistic
(
    const char * name,
    Geo::u32 value
)

Log a single statistic, as a name/value pair.

void GEO_CALL Geo::GeoStatistic

public: void GEO_CALL GeoStatistic
(
    const char * name,
    double value
)

Log a single statistic, as a name/value pair.

void GEO_CALL Geo::GeoStatistic

public: void GEO_CALL GeoStatistic
(
    const char * name,
    float value
)

Log a single statistic, as a name/value pair.

void GEO_CALL Geo::GeoStatistic

public: void GEO_CALL GeoStatistic
(
    const char * name,
    const char * value
)

Log a single statistic, as a name/value pair.

void GEO_CALL Geo::GeoStatistic

public: void GEO_CALL GeoStatistic
(
    const char * name,
    Geo::u64 value
)

Log a single statistic, as a name/value pair.

void GEO_CALL Geo::GeoStatisticsBegin

public: void GEO_CALL GeoStatisticsBegin
(
    const char * taskName,
    const char * output,
    const char * version
)

Begin a StatusXml file.

void GEO_CALL Geo::GeoStatisticsEnd

public: void GEO_CALL GeoStatisticsEnd()

End the StatusXml file (note that you may wish to set the filename to NULL after this)

bool GEO_CALL Geo::GeoStatusLogHandler_XmlFile

public: bool GEO_CALL GeoStatusLogHandler_XmlFile
(
    eGeoLogMsgType msgType,
    u32 code,
    const char * msgText
)

The event handler for the StatusXml file.

void GEO_CALL Geo::GeoStatusLogHandler_XmlFile_SetName

public: void GEO_CALL GeoStatusLogHandler_XmlFile_SetName
(
    const char * filename,
    bool logInputOutput
)

Set the name of the StatusXml file writer. If not called, no file is created.

bool GEO_CALL Geo::GetTempFilename

public: bool GEO_CALL GetTempFilename
(
    GeoFileString & resultFilename
)

Get an absolute path to a temporary file you can open for reading/writing.

May fail due to permissions (unlikely), and only implemented under windows. Returns false on all other platforms

GeoError Geo::MakeGeoError

public: GeoError MakeGeoError
(
    const char * message,
    TPayload * pPayload
)

Creates a GeoError struct by filling in the given error code, textual message and payload data.

The severity of the error is automatically set using the severity defined in the payload class.

bool GEO_CALL Geo::MsgBox

public: bool GEO_CALL MsgBox
(
    Geo::eGeoLogMsgType msgType,
    const char * errorString
)

Generate a popup window, indicating either an error or a warning otherwise.

bool GEO_CALL Geo::MsgBox

public: bool GEO_CALL MsgBox
(
    Geo::eGeoLogMsgType msgType,
    u32 code,
    const char * errorString
)

Generate a popup window, indicating either an error or a warning otherwise.

void Geo::PrintError

public: void PrintError
(
    const GeoError & error
)

Sends a GeoError object to the listeners attached to the GeoPrintf handlers.

This is the simplest response you can have to a GeoError being raised.

bool GEO_CALL Geo::PutTextOnWindowsClipBoard

public: bool GEO_CALL PutTextOnWindowsClipBoard
(
    const char * text
)

Puts text into the windows clipboard.

void Geo::StopAndEnterDebugger

public: void StopAndEnterDebugger()

Drop into the debugger.

eGeoErrorSeverity

public: enum eGeoErrorSeverity
{
    ES_WARNING = 0,
    ES_FATAL = 1
}

The severity of an error.

enumerators

eGeoLogContext

public: enum eGeoLogContext
{
    LOG_CONTEXT_GFX,
    LOG_CONTEXT_TEXT
}

enum eGeoLogContext

When attaching a default set of system messages, we set up different things depending upon whether we are in graphic or command line mode.

enumerators

eGeoLogMsgType

public: enum eGeoLogMsgType
{
    LOG_INFO = 1,
    LOG_DEBUG = 2,
    LOG_STATUS = 4,
    LOG_WARN = 8,
    LOG_FATAL = 16,
    LOG_ASSERT = 32
}

enum eGeoLogMsgType

The message logger knows about different kinds of log message.

Messages are expected to be formatted for output, and in particular should contain trailing line feed characters ("\n") where necessary. It is up to a particular logger handler to translate these into the correct convention for it's use, for example replacing "\n" with "\r\n" when writing to Windows files.

Note: If you add new message remember to preinitialise the LastLogHandler[] array as this will be missed by the compiler! Note: These should be arranged in the order of the frequency at which each message type is expected to be generated, with more frequent first.

enumerators

eGeoLogSystemState

public: enum eGeoLogSystemState
{
    LOG_DISABLED,
    LOG_ENABLED
}

enum eGeoLogSystemState

The system loggers can operate in a number of different states. This enables their behaviour to be controlled, without having to uninstall them.

enumerators