![]() |
Murl Engine API
Version 2018.3
|
Assert, Trace and Error functions and macros. More...
Macros | |
#define | MURL_ASSERT(x) |
Assert a condition. More... | |
#define | MURL_VERIFY(x) |
Verify a condition. More... | |
#define | MURL_ERROR(...) |
Write an error message with the current function name plus line number and a variable number of arguments. More... | |
#define | MURL_TRACE_TIME_BEGIN(key) |
Begin a time measurement for trace output. More... | |
#define | MURL_TRACE_TIME_END(key, level, message) |
End a time measurement and write a trace message with the current function name plus line number. More... | |
#define | MURL_ERROR_TIME_BEGIN(key) |
Begin a time measurement for error output. More... | |
#define | MURL_ERROR_TIME_END(key, message) |
End a time measurement and write an error message with the current function name plus line number. More... | |
#define | MURL_TRACE(level, ...) |
Write a trace message with the current function name plus line number and a variable number of arguments. More... | |
#define | MURL_TRACE_CODE(x) |
Implement a code line for trace usage. More... | |
Functions | |
void | Murl::Debug::Error (const Char *message) |
Write an error message string. More... | |
template<class Type1 > | |
void | Murl::Debug::Error (const Char *format, const Type1 v1) |
Write an error with format string and 1 argument. More... | |
template<class Type1 , class Type2 > | |
void | Murl::Debug::Error (const Char *format, const Type1 v1, const Type2 v2) |
Write an error with format string and 2 arguments. More... | |
template<class Type1 , class Type2 , class Type3 > | |
void | Murl::Debug::Error (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3) |
Write an error with format string and 3 arguments. More... | |
template<class Type1 , class Type2 , class Type3 , class Type4 > | |
void | Murl::Debug::Error (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3, const Type4 v4) |
Write an error with format string and 4 arguments. More... | |
template<class Type1 , class Type2 , class Type3 , class Type4 , class Type5 > | |
void | Murl::Debug::Error (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3, const Type4 v4, const Type5 v5) |
Write an error with format string and 5 arguments. More... | |
template<class Type1 , class Type2 , class Type3 , class Type4 , class Type5 , class Type6 > | |
void | Murl::Debug::Error (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3, const Type4 v4, const Type5 v5, const Type6 v6) |
Write an error with format string and 6 arguments. More... | |
void | Murl::Debug::Trace (const Char *message) |
Write a trace message string. More... | |
template<class Type1 > | |
void | Murl::Debug::Trace (const Char *format, const Type1 v1) |
Write a trace with format string and 1 argument. More... | |
template<class Type1 , class Type2 > | |
void | Murl::Debug::Trace (const Char *format, const Type1 v1, const Type2 v2) |
Write a trace with format string and 2 arguments. More... | |
template<class Type1 , class Type2 , class Type3 > | |
void | Murl::Debug::Trace (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3) |
Write a trace with format string and 3 arguments. More... | |
template<class Type1 , class Type2 , class Type3 , class Type4 > | |
void | Murl::Debug::Trace (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3, const Type4 v4) |
Write a trace with format string and 4 arguments. More... | |
template<class Type1 , class Type2 , class Type3 , class Type4 , class Type5 > | |
void | Murl::Debug::Trace (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3, const Type4 v4, const Type5 v5) |
Write a trace with format string and 5 arguments. More... | |
template<class Type1 , class Type2 , class Type3 , class Type4 , class Type5 , class Type6 > | |
void | Murl::Debug::Trace (const Char *format, const Type1 v1, const Type2 v2, const Type3 v3, const Type4 v4, const Type5 v5, const Type6 v6) |
Write a trace with format string and 6 arguments. More... | |
Assert, Trace and Error functions and macros.
#define MURL_ASSERT | ( | x | ) |
Assert a condition.
The condition is evaluated in debug build only. If the condition fails Murl::Debug::Assert::Abort() is called.
(!) In release build the condition is not compiled.
#define MURL_VERIFY | ( | x | ) |
Verify a condition.
The condition is evaluated always and the result is returned. This allows skipping code blocks if the check fails in release build.
If the condition fails in debug build, Murl::Debug::Assert::Abort() is called.
#define MURL_ERROR | ( | ... | ) |
Write an error message with the current function name plus line number and a variable number of arguments.
The details of the function name can be configured by the Murl::IAppConfiguration::SetDebugOutputFunctionVerbosity() method.
The error is written with the Murl::Debug::Logger::PrintErrorVA() method.
... | The message format string and a variable number of arguments. |
#define MURL_TRACE_TIME_BEGIN | ( | key | ) |
Begin a time measurement for trace output.
The trace macros are empty in release build.
key | A unique key to differentiate multiple measurement statements within the current scope. |
#define MURL_TRACE_TIME_END | ( | key, | |
level, | |||
message | |||
) |
End a time measurement and write a trace message with the current function name plus line number.
The trace level can be configured by the Murl::IAppConfiguration::SetDebugTraceLevel() method.
The details of the function name can be configured by the Murl::IAppConfiguration::SetDebugOutputFunctionVerbosity() method.
The trace is written with the Murl::Debug::Logger::PrintDebugVA() method in debug build only, the trace macros are empty in release build.
key | The unique key used in MURL_TRACE_TIME_BEGIN(). |
level | The trace level. |
message | The message string in front of the time. |
#define MURL_ERROR_TIME_BEGIN | ( | key | ) |
Begin a time measurement for error output.
key | A unique key to differentiate multiple measurement statements within the current scope. |
#define MURL_ERROR_TIME_END | ( | key, | |
message | |||
) |
End a time measurement and write an error message with the current function name plus line number.
The details of the function name can be configured by the Murl::IAppConfiguration::SetDebugOutputFunctionVerbosity() method.
The error is written with the Murl::Debug::Logger::PrintErrorVA() method.
key | The unique key used in MURL_ERROR_TIME_BEGIN(). |
message | The message string in front of the time. |
#define MURL_TRACE | ( | level, | |
... | |||
) |
Write a trace message with the current function name plus line number and a variable number of arguments.
The trace level can be configured by the Murl::IAppConfiguration::SetDebugTraceLevel() method.
The details of the function name can be configured by the Murl::IAppConfiguration::SetDebugOutputFunctionVerbosity() method.
The trace is written with the Murl::Debug::Logger::PrintDebugVA() method in debug build only, the trace macros are empty in release build.
level | The trace level |
... | The message format string and a variable number of arguments. |
#define MURL_TRACE_CODE | ( | x | ) |
Implement a code line for trace usage.
The code is implemented in debug build only, the trace macros are empty in release build.
x | The code line to implement. |
|
inline |
Write an error message string.
The error is written with the Logger::PrintError() method.
message | The message string to write. |
|
inline |
Write an error with format string and 1 argument.
The error is written with the Logger::PrintError() method.
format | The format string to write. |
v1 | The argument for the fromat string. |
|
inline |
Write an error with format string and 2 arguments.
The error is written with the Logger::PrintError() method.
format | The format string to write. |
v1,v2 | The arguments for the fromat string. |
|
inline |
Write an error with format string and 3 arguments.
The error is written with the Logger::PrintError() method.
format | The format string to write. |
v1,v2,v3 | The arguments for the fromat string. |
|
inline |
Write an error with format string and 4 arguments.
The error is written with the Logger::PrintError() method.
format | The format string to write. |
v1,v2,v3,v4 | The arguments for the fromat string. |
|
inline |
Write an error with format string and 5 arguments.
The error is written with the Logger::PrintError() method.
format | The format string to write. |
v1,v2,v3,v4,v5 | The arguments for the fromat string. |
|
inline |
Write an error with format string and 6 arguments.
The error is written with the Logger::PrintError() method.
format | The format string to write. |
v1,v2,v3,v4,v5,v6 | The arguments for the fromat string. |
|
inline |
Write a trace message string.
The trace is written with the Logger::PrintDebug() method in debug build only, the trace functions are empty in release build.
message | The message string to write. |
|
inline |
Write a trace with format string and 1 argument.
The trace is written with the Logger::PrintDebug() method in debug build only, the trace functions are empty in release build.
format | The format string to write. |
v1 | The argument for the fromat string. |
|
inline |
Write a trace with format string and 2 arguments.
The trace is written with the Logger::PrintDebug() method in debug build only, the trace functions are empty in release build.
format | The format string to write. |
v1,v2 | The arguments for the fromat string. |
|
inline |
Write a trace with format string and 3 arguments.
The trace is written with the Logger::PrintDebug() method in debug build only, the trace functions are empty in release build.
format | The format string to write. |
v1,v2,v3 | The arguments for the fromat string. |
|
inline |
Write a trace with format string and 4 arguments.
The trace is written with the Logger::PrintDebug() method in debug build only, the trace functions are empty in release build.
format | The format string to write. |
v1,v2,v3,v4 | The arguments for the fromat string. |
|
inline |
Write a trace with format string and 5 arguments.
The trace is written with the Logger::PrintDebug() method in debug build only, the trace functions are empty in release build.
format | The format string to write. |
v1,v2,v3,v4,v5 | The arguments for the fromat string. |
|
inline |
Write a trace with format string and 6 arguments.
The trace is written with the Logger::PrintDebug() method in debug build only, the trace functions are empty in release build.
format | The format string to write. |
v1,v2,v3,v4,v5,v6 | The arguments for the fromat string. |