Classes
class	stk::diag::Tracespec
	Class Tracespec dissects file specification strings. It contains a single char const pointer to a function specification string. Accessor functions can dissect the function specification string and return various components of it. More...
class	stk::diag::Traceback
	Class Traceback is a stack of char constant pointers to function specifications which have been encounter by Traceback during exception stack unwind. More...
class	stk::diag::Traceback::Preserve
	Class Traceback::Preserve serves as a sentry for traceback stack preservation during additional extension and unwinding. More...
class	stk::diag::Trace
	Class Trace serves as a sentry for entering routines. Creating a trace object prints the specified member function name to the specfied diag_writer and pushes the diag_writer depth. On destruction, it prints the member function name again and pops the depth. More...
struct	stk::diag::Trace::TraceList
	Typedef TraceList declares the trace list data type. More...
Typedefs
typedef std::vector< const char * >	stk::diag::TracebackStack
typedef const char *	stk::diag::Traceback::Stack [STACK_SIZE]
	Stack type.
typedef const char const	stk::diag::Traceback::const_stack_iterator
	const iterator thru stack
typedef const char **	stk::diag::Traceback::stack_iterator
	iterator thru stack
typedef std::map< const char *, int >	stk::diag::Traceback::Coverage
	Typedef Coverage declares the function usage coverage data type.
typedef Writer &(*	stk::diag::Trace::ExtraFuncPtr )(Writer &)
	Typedef ExtraFuncPtr declares the extra function pointer signature.
Enumerations
enum	stk::diag::Traceback::TracebackState { RUNNING, THROWING }
	Enumeration TracebackState lists the traceback execution states. More...
enum	{ STACK_SIZE = 2048 }
enum	{ stk::diag::Trace::IN_TRACE_LIST = 0x01 }
	Enumeration to describe the trace back flags. More...
Functions
	stk::diag::Tracespec::Tracespec (const char *function_spec)
const char *	stk::diag::Tracespec::getFunctionSpec () const
	Member function getFunctionSpec returns the function's name.
std::string	stk::diag::Tracespec::getFunctionName () const
	Member function getFunctionName returns the function's name.
std::string	stk::diag::Tracespec::getFunctionShortName () const
	Member function getFunctionName returns the function's name.
std::string	stk::diag::Tracespec::getFunctionClass () const
	Member function getFunctionName returns the function's name.
std::string	stk::diag::Tracespec::getFunctionNamespace () const
	Member function getFunctionName returns the function's name.
std::string	stk::diag::Tracespec::getFunctionShortClass () const
	Member function getFunctionName returns the function's name.
	stk::diag::Traceback::Preserve::Preserve ()
	Creates a new Traceback::Preserve sentry. When the sentry is in place, the traceback stack is preserved from extension and clearing.
	stk::diag::Traceback::Preserve::~Preserve ()
	Destroys a Preserve sentry which allows traceback stack.
	stk::diag::Traceback::Traceback (const char *function_spec)
	Creates a new Trace instance, resulting in the printing of the member function name and pushing the depth.
	stk::diag::Traceback::~Traceback ()
	Destroys a Traceback instance, resulting in the pushing of the function specification if unwinding the stack.
static TracebackStack	stk::diag::Traceback::snapshot ()
static void	stk::diag::Traceback::enableTracebackDisplay ()
	Member function enableTracebackDisplay enables the display of the traceback.
static void	stk::diag::Traceback::disableTracebackDisplay ()
	Member function disableTracebackDisplay disables the display of the traceback.
static bool	stk::diag::Traceback::displayTraceback ()
	Member function displayEnabled returns true if display of the tracback stack has been enabled.
static void	stk::diag::Traceback::preserveStack ()
	Member function preserveStack increments the traceback stack preservation counter.
static void	stk::diag::Traceback::releaseStack ()
	Member function releaseStack decrements the traceback stack preservation counter.
static TracebackState	stk::diag::Traceback::getTracebackState ()
	Member function getTracebackState returns the value of the traceback state.
static std::string	stk::diag::Traceback::printTraceback (const TracebackStack &traceback_stack)
	Member function printTraceback writes the traceback stack function specifications to the output stream os.
	stk::diag::Trace::Trace (Writer &dout, const char *function_name, int print_mask=LOG_TRACE, bool do_trace=true)
	Creates a new Trace instance, resulting in the printing of the member function name and pushing the depth.
	stk::diag::Trace::~Trace ()
	Destroys a Trace instance, resulting in the printing of the member function name and popping the diag_writer depth.
static ExtraFuncPtr	stk::diag::Trace::setExtra (ExtraFuncPtr extra)
	Member function setExtra sets the extra function which is called during each trace construction and destrution. (Not implemented)
static void	stk::diag::Trace::addTraceFunction (const std::string &function_prefix)
	Member function addTraceFunction adds a function prefix to the list of function prefixes search to enable tracing.
static void	stk::diag::Trace::clearTraceFunctions ()
	Member function clearTraceFunctions removes all function prefixes from the function signature prefix list.
Writer &	stk::diag::Trace::verbose_print (Writer &dout) const
	Member function dump writes the trace to the specified Writer.
Writer &	stk::diag::operator<< (Writer &dout, const Trace &diag_trace)
	Member function operator<< writes the trace data to the diagnostic writer.
Variables
const char *	stk::diag::Tracespec::m_functionSpec
	The member function specification.

Typedef Documentation

typedef std::map<const char *, int> stk::diag::Traceback::Coverage

Typedef Coverage declares the function usage coverage data type.

NOTE: This does really want to use const char * as the key. I know, things could move, but the definition of a function spec is that it is a string literal only. So, let it go.

Definition at line 128 of file stk_util/stk_util/diag/Trace.hpp.

Enumeration Type Documentation

enum stk::diag::Traceback::TracebackState

Enumeration TracebackState lists the traceback execution states.

RUNNING - No throws are in progress.
THROWING - A throw is in progress.

Definition at line 113 of file stk_util/stk_util/diag/Trace.hpp.

anonymous enum

Enumeration to describe the trace back flags.

Enumerator:

IN_TRACE_LIST

Tracing enabled by this function.

Definition at line 310 of file stk_util/stk_util/diag/Trace.hpp.

Function Documentation

stk::diag::Tracespec::Tracespec ( const char * function_spec ) [inline, explicit]

Creates a new Tracespec instance.

Parameters:

function_spec a char const pointer to the function full specification.

Definition at line 40 of file stk_util/stk_util/diag/Trace.hpp.

const char* stk::diag::Tracespec::getFunctionSpec ( ) const [inline]

Member function getFunctionSpec returns the function's name.

Returns:: a char const pointer to the function's name.

Definition at line 49 of file stk_util/stk_util/diag/Trace.hpp.

std::string stk::diag::Tracespec::getFunctionName ( ) const