csDebuggingGraph Class Reference
This is a static class that helps with debugging. More...
#include <csutil/debug.h>
Static Public Member Functions | |
static void | AddChild (iObjectRegistry *object_reg, void *parent, void *child) |
Add a child to an object. | |
static void | AddObject (iObjectRegistry *object_reg, void *object, bool scf, char *file, int linenr, char *description,...) |
Add a new object to the debug graph and link to its parent. | |
static void | AddParent (iObjectRegistry *object_reg, void *child, void *parent) |
Add a parent to an object. | |
static void | AttachDescription (iObjectRegistry *object_reg, void *object, char *description,...) |
Attach a new description to an object in the graph. | |
static void | AttachType (iObjectRegistry *object_reg, void *object, char *type) |
Attach a type to an object in the graph. | |
static void | Clear (iObjectRegistry *object_reg) |
Completely clear everything in the debug graph. | |
static void | Dump (iObjectRegistry *object_reg, void *object, bool reset_mark=true) |
Dump the graph containing the given object. | |
static void | Dump (iObjectRegistry *object_reg) |
Dump all the resulting graphs. | |
static void | RemoveChild (iObjectRegistry *object_reg, void *parent, void *child) |
Unlink a child from its parent. | |
static void | RemoveObject (iObjectRegistry *object_reg, void *object, char *file, int linenr) |
Remove an object from the debug tree. | |
static void | RemoveParent (iObjectRegistry *object_reg, void *child, void *parent) |
Unlink a parent from its child. | |
static void | SetupGraph (iObjectRegistry *object_reg) |
Initialize the debugging graph. |
Detailed Description
This is a static class that helps with debugging.It will register an object in the object registry that keeps track of allocations in a graph. Later on you can add/remove allocations from that graph.
Definition at line 84 of file debug.h.
Member Function Documentation
|
Add a child to an object.
|
|
Add a new object to the debug graph and link to its parent. If 'scf' is true 'object' is an iBase. |
|
Add a parent to an object.
|
|
Attach a new description to an object in the graph.
|
|
Attach a type to an object in the graph.
|
|
Completely clear everything in the debug graph.
|
|
Dump the graph containing the given object. You should usually leave reset_mark alone. That's for internal use. |
|
Dump all the resulting graphs.
|
|
Unlink a child from its parent.
|
|
Remove an object from the debug tree.
|
|
Unlink a parent from its child.
|
|
Initialize the debugging graph. Special note! In debug mode (CS_DEBUG) this function will put the pointer to the object registry in iSCF::object_reg. That way we can use this debugging functionality in places where the object registry is not available. |
The documentation for this class was generated from the following file:
- csutil/debug.h
Generated for Crystal Space by doxygen 1.4.4