class trace The trace class allows you to easily produce tracing diagnostics. More... Full name dbg::trace Definition #include <dbg.h> List of all Methods

Annotated List Files Globals Hierarchy Index

Public Methods

•  trace (func_name_t name)
•  trace (dbg_source src, func_name_t name)
•  trace (const source_pos &here)
•  trace (dbg_source src, const source_pos &here)
•  ~trace ()
•  trace (const char *fn_name)
•  trace (dbg_source, const char *fn_name)
•  trace (void *here)
•  trace (dbg_source, void *here)
•  ~trace ()

Detailed Description

The trace class allows you to easily produce tracing diagnostics.

When the ctor is called, it prints "->" and the name of the function, increasing the indent level. When the object is deleted it prints "<-" followed again by the name of the function.

You can use the name of the current function gathered via the DBG_HERE macro, or some other tracing string you supply.

Diagnostics are produced at the tracing level.

For example, if you write the following code:

     void foo()
     {
         dbg::trace t1(DBG_HERE);
         // do some stuff
         {
             dbg::trace t2("sub block");
             // do some stuff
             dbg::out(tracing) << dbg::prefix() << "Hello!\n";
         }
         dbg::out(tracing) << dbg::prefix() << "Hello again!\n";
         // more stuff
     }

You will get the following tracing information:

     *** ->foo (0 in foo.cpp)
     ***   ->sub block
     ***     Hello!
     ***   <-sub block
     ***   Hello again!
     *** <-foo (0 in foo.cpp)

Don't forget to create named dbg::trace objects. If you create anonymous objects (i.e. you just wrote "dbg::trace(DBG_HERE);") then the destructor will be called immediately, rather than at the end of the block scope, causing invalid trace output.

Tracing does not cause assertions to trigger, therefore you will never generate an abort or exception using this object.

If you disable the tracing diagnostic level before the trace object's destructor is called you will still get the closing trace output. This is important, otherwise the indentation level of the library would get out of sync. In this case, the closing diagnostic output will have a "note" attached to indicate what has happened.

Similarly, if tracing diagnostics are off when the trace object is created, yet subsequently enabled before the destructor there will be no closing tracing output.

Provide the function name, or some other tracing string.

This will not tie the trace object to a particular dbg_source.

Parameters:

name	Tracing block name

Parameters:

src	String describing the diagnostic source
name	Tracing block name

This will not tie the trace object to a particular dbg_source.

Parameters:

here	Supply DBG_HERE

Parameters:

src	String describing the diagnostic source
here	Supply DBG_HERE