Main Page Class Hierarchy Compound List File List Compound Members

csDebuggingGraph Class Reference

This is a static class that helps with debugging. More...

#include <debug.h>

List of all members.

Static Public Methods

void SetupGraph (iObjectRegistry *object_reg)

Initialize the debugging graph. More...

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. More...

void AttachDescription (iObjectRegistry *object_reg, void *object, char *description,...)

Attach a new description to an object in the graph.

void AttachType (iObjectRegistry *object_reg, void *object, char *type)

Attach a type to an object in the graph.

void RemoveObject (iObjectRegistry *object_reg, void *object, char *file, int linenr)

Remove an object from the debug tree.

void AddChild (iObjectRegistry *object_reg, void *parent, void *child)

Add a child to an object.

void AddParent (iObjectRegistry *object_reg, void *child, void *parent)

Add a parent to an object.

void RemoveChild (iObjectRegistry *object_reg, void *parent, void *child)

Unlink a child from its parent.

void RemoveParent (iObjectRegistry *object_reg, void *child, void *parent)

Unlink a parent from its child.

void Clear (iObjectRegistry *object_reg)

Completely clear everything in the debug graph.

void Dump (iObjectRegistry *object_reg)

Dump all the resulting graphs.

void Dump (iObjectRegistry *object_reg, void *object, bool reset_mark=true)

Dump the graph containing the given object. More...

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.

Member Function Documentation

void csDebuggingGraph::AddObject ( iObjectRegistry * object_reg,

void * object,

bool scf,

char * file,

int linenr,

char * description,

... ) [static]

Add a new object to the debug graph and link to its parent.
If 'scf' is true 'object' is an iBase.

void csDebuggingGraph::Dump ( iObjectRegistry * object_reg,

void * object,

bool reset_mark = true ) [static]

Dump the graph containing the given object.
You should usually leave reset_mark alone. That's for internal use.

void csDebuggingGraph::SetupGraph ( iObjectRegistry * object_reg ) [static]

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