TfError Error-posting Facility

See The TfError Error Posting System for a detailed description. More...

Classes

class  TfDiagnosticBase
 Represents the base class of an object representing a diagnostic message. More...
 
class  TfErrorMark
 Class used to record the end of the error-list. More...
 

Macros

#define TF_HAS_ERRORS(marker, expr)
 Convenience macro to check if errors occurred. More...
 
#define TF_BAD_SIZE_T   SIZE_MAX
 This value may be used by functions that return a size_t to indicate that a special or error condition has occurred. More...
 

Functions

TF_API void TfReportActiveErrorMarks ()
 Report current TfErrorMark instances and the stack traces that created them to stdout for debugging purposes. More...
 

Detailed Description

See The TfError Error Posting System for a detailed description.

Macro Definition Documentation

◆ TF_BAD_SIZE_T

#define TF_BAD_SIZE_T   SIZE_MAX

This value may be used by functions that return a size_t to indicate that a special or error condition has occurred.

Definition at line 55 of file tf.h.

◆ TF_HAS_ERRORS

#define TF_HAS_ERRORS (   marker,
  expr 
)

Convenience macro to check if errors occurred.

This macro is equivalent to

(marker.SetMark(), (expr), !marker.IsClean())

which enables it to be used as an expression:

if (TF_HAS_ERRORS(m, expr))
// cope!

Definition at line 203 of file errorMark.h.

Function Documentation

◆ TfReportActiveErrorMarks()

TF_API void TfReportActiveErrorMarks ( )

Report current TfErrorMark instances and the stack traces that created them to stdout for debugging purposes.

To call this function, set _enableTfErrorMarkStackTraces in errorMark.cpp and enable the TF_ERROR_MARK_TRACKING TfDebug code.