Macros to help with debugging.
|
#define | VuoLog_status(format, ...) |
| Stores status information so it can be included in crash reports. More...
|
|
#define | VL() |
| Prints the name of the file and function to the system log and to stderr (and implicitly flushes the output buffer). More...
|
|
#define | VLog(format, ...) |
| Prints the name of the file and function, and printf() -style format/arguments, to the system log and to stderr (and implicitly flushes the output buffer). More...
|
|
#define | VUserLog(format, ...) |
| Same as VLog, but for messages intended for end users. More...
|
|
#define | VDebugLog(format, ...) |
| Same as VLog, but for debug messages intended for end users. More...
|
|
#define | VLogHeap(heapPointer) |
| Prints the name of the current file and function, and the address and description of the specified heapPointer , to the system log and to stderr (and implicitly flushes the output buffer). More...
|
|
#define | VUOLOG_PROFILE_BEGIN(object) |
| Starts a profiler time sample. More...
|
|
#define | VUOLOG_PROFILE_END(object) |
| Ends a profiler time sample. More...
|
|
|
double | VuoLogGetTime (void) |
| Returns the number of seconds (including fractional seconds) since an arbitrary start time. More...
|
|
double | VuoLogGetElapsedTime (void) |
| Returns the number of seconds (including fractional seconds) since this module was loaded. More...
|
|
bool | VuoIsDebugEnabled (void) |
| Returns true if debug mode is enabled. More...
|
|
void | VuoLog_backtrace (void) |
| Prints the stack backtrace to stderr. More...
|
|
bool | VuoLog_isDebuggerAttached (void) |
| Returns true if the current process is being debugged (either launched by LLDB/Instruments, or the LLDB/Instruments attached after the process launched). More...
|
|
void | VuoLog_statusF (const char *file, const unsigned int linenumber, const char *function, const char *format,...) |
| Helper for VuoLog_status. More...
|
|
void | VuoLog (const char *file, const unsigned int linenumber, const char *function, const char *format,...) |
| Outputs a message to the system log and to stderr . More...
|
|
void | VuoLog_recordTime (const char *name, double time) |
| Adds time to the specified profile name . More...
|
|
◆ VDebugLog
#define VDebugLog |
( |
|
format, |
|
|
|
... |
|
) |
| |
Same as VLog, but for debug messages intended for end users.
Definition at line 116 of file VuoLog.h.
◆ VL
Prints the name of the file and function to the system log and to stderr
(and implicitly flushes the output buffer).
- Example:
-
Definition at line 86 of file VuoLog.h.
◆ VLog
#define VLog |
( |
|
format, |
|
|
|
... |
|
) |
| |
Prints the name of the file and function, and printf()
-style format/arguments, to the system log and to stderr
(and implicitly flushes the output buffer).
Use this for debugging only; don't commit files with VLog
calls. To log messages intended for end users, see VUserLog.
- Example:
-
Definition at line 102 of file VuoLog.h.
◆ VLogHeap
#define VLogHeap |
( |
|
heapPointer | ) |
|
Prints the name of the current file and function, and the address and description of the specified heapPointer
, to the system log and to stderr
(and implicitly flushes the output buffer).
- Example:
-
Definition at line 130 of file VuoLog.h.
◆ VUOLOG_PROFILE_BEGIN
#define VUOLOG_PROFILE_BEGIN |
( |
|
object | ) |
|
Starts a profiler time sample.
In this macro's parameter, pass a text identifier for the time sample (such as the variable name of a libdispatch queue or semaphore).
- Example:
-
Definition at line 154 of file VuoLog.h.
◆ VUOLOG_PROFILE_END
#define VUOLOG_PROFILE_END |
( |
|
object | ) |
|
Ends a profiler time sample.
Definition at line 159 of file VuoLog.h.
◆ VuoLog_status
#define VuoLog_status |
( |
|
format, |
|
|
|
... |
|
) |
| |
Stores status information so it can be included in crash reports.
Only the most recent status is stored. Use NULL
to clear the status.
Similar to VUserLog()/VDebugLog(), but useful for highly verbose status messages where only the most recent is relevant.
Definition at line 52 of file VuoLog.h.
◆ VUserLog
#define VUserLog |
( |
|
format, |
|
|
|
... |
|
) |
| |
Same as VLog, but for messages intended for end users.
Definition at line 109 of file VuoLog.h.
◆ VuoIsDebugEnabled()
bool VuoIsDebugEnabled |
( |
void |
| ) |
|
Returns true if debug mode is enabled.
Users can enable debug mode by executing defaults write org.vuo.Editor debug -boolean true
, and can disable it by executing defaults delete org.vuo.Editor debug
.
Nodes should use this to control verbose logging.
Definition at line 513 of file VuoLog.cc.
◆ VuoLog()
void VuoLog |
( |
const char * |
file, |
|
|
const unsigned int |
linenumber, |
|
|
const char * |
function, |
|
|
const char * |
format, |
|
|
|
... |
|
) |
| |
Outputs a message to the system log and to stderr
.
Also stores the most recent several messages in the OS X CrashReporter data structure, to be included with crash reports.
Definition at line 297 of file VuoLog.cc.
◆ VuoLog_backtrace()
void VuoLog_backtrace |
( |
void |
| ) |
|
Prints the stack backtrace to stderr.
Definition at line 526 of file VuoLog.cc.
◆ VuoLog_isDebuggerAttached()
bool VuoLog_isDebuggerAttached |
( |
void |
| ) |
|
◆ VuoLog_recordTime()
void VuoLog_recordTime |
( |
const char * |
name, |
|
|
double |
time |
|
) |
| |
Adds time to the specified profile name
.
Definition at line 139 of file VuoLog.cc.
◆ VuoLog_statusF()
void VuoLog_statusF |
( |
const char * |
file, |
|
|
const unsigned int |
linenumber, |
|
|
const char * |
function, |
|
|
const char * |
format, |
|
|
|
... |
|
) |
| |
Helper for VuoLog_status.
Definition at line 205 of file VuoLog.cc.
◆ VuoLogGetElapsedTime()
double VuoLogGetElapsedTime |
( |
void |
| ) |
|
Returns the number of seconds (including fractional seconds) since this module was loaded.
Definition at line 180 of file VuoLog.cc.
◆ VuoLogGetTime()
double VuoLogGetTime |
( |
void |
| ) |
|
Returns the number of seconds (including fractional seconds) since an arbitrary start time.
Definition at line 78 of file VuoLog.cc.