diagnostic.h File Reference

Low-level utilities for informing users of various internal and external diagnostic conditions. More...

Include dependency graph for diagnostic.h:

Go to the source code of this file.

Macros
#define	TF_ERROR(...)
	Issue an internal programming error, but continue execution.
#define	TF_CODING_ERROR(fmt, args)
	Issue an internal programming error, but continue execution.
#define	TF_RUNTIME_ERROR(fmt, args)
	Issue a generic runtime error, but continue execution.
#define	TF_FATAL_ERROR(fmt, args)
	Issue a fatal error and end the program.
#define	TF_WARN(...)
	Issue a warning, but continue execution.
#define	TF_STATUS(...)
	Issue a status message, but continue execution.
#define	TF_AXIOM(cond)
	Aborts if the condition cond is not met.
#define	TF_DEV_AXIOM(cond)
	The same as TF_AXIOM, but compiled only in dev builds.
#define	TF_VERIFY(cond, format, ...)
	Checks a condition and reports an error if it evaluates false.
#define	TF_FUNC_NAME()
	Get the name of the current function as a std::string.

Functions
void	TfSetProgramNameForErrors (std::string const &programName)
	Sets program name for reporting errors.
std::string	TfGetProgramNameForErrors ()
	Returns currently set program info.
TF_API void	TfInstallTerminateAndCrashHandlers ()
	(Re)install Tf's crash handler.

Detailed Description

Low-level utilities for informing users of various internal and external diagnostic conditions.

lib/tf supports a range of error-reporting routines.

For a more detailed explanation of when each of the facilities described in this file is appropriate, (and more importantly, when they're not!) see Guide To Diagnostic Facilities.

Definition in file diagnostic.h.