debug_stl.cpp File Reference

#include "precompiled.h"
#include "lib/debug_stl.h"
#include "lib/regex.h"
#include <cassert>
#include <deque>
#include <list>
#include <map>
#include <set>
#include <vector>

Include dependency graph for debug_stl.cpp:

Classes
struct	ContainerBase< Container >
struct	Any_deque
struct	Any_list
struct	Any_vector
struct	Any_queue
struct	Any_stack

Macros
#define	REPLACE(what, with)
#define	STRIP(what)
#define	STRIP_NESTED(what)
#define	CONTAINER(name, type_name_pattern)
#define	STD_CONTAINER(name)   CONTAINER(name, L"std::" WIDEN(#name) L"<*>")
#define	STRINGIZE2(id)   # id
#define	STRINGIZE(id)   STRINGIZE2(id)

Functions
	STATUS_ADD_DEFINITIONS (debugStlStatusDefinitions)
wchar_t *	debug_stl_simplify_name (wchar_t *name)
	reduce complicated STL symbol names to human-readable form. More...
template<class T >
const u8 *	stl_iterator (void *it_mem, size_t el_size)
template<class T >
static bool	IsContainerValid (const T &t, size_t el_count)
template<class T >
bool	get_container_info (const T &t, size_t size, size_t el_size, size_t &el_count, DebugStlIterator &el_iterator, void *it_mem)
Status	debug_stl_get_container_info (const wchar_t *type_name, const u8 *p, size_t size, size_t el_size, size_t *el_count, DebugStlIterator *el_iterator, void *it_mem)
	prepare to enumerate the elements of arbitrarily typed STL containers. More...

Variables
static const StatusDefinition	debugStlStatusDefinitions []

Macro Definition Documentation

CONTAINER

#define CONTAINER	(		name,
			type_name_pattern
	)

Value:

    else if(match_wildcard(type_name, type_name_pattern))\
    {\
        handled = true;\
        IsValid = get_container_info<Any_##name>(*(Any_##name*)p, size, el_size, *el_count, *el_iterator, it_mem);\
    }

REPLACE

#define REPLACE	(		what,
			with
	)

Value:

    else if(!wcsncmp(src, (what), ARRAY_SIZE(what)-1))\
    {\
        src += ARRAY_SIZE(what)-1-1; /* see preincrement rationale*/\
        wcscpy_s(dst, ARRAY_SIZE(with), (with));\
        dst += ARRAY_SIZE(with)-1;\
    }

STD_CONTAINER

#define STD_CONTAINER

(

name

)

CONTAINER(name, L"std::" WIDEN(#name) L"<*>")

STRINGIZE

#define STRINGIZE

(

id

)

STRINGIZE2(id)

STRINGIZE2

#define STRINGIZE2

(

id

)

# id

STRIP

#define STRIP

(

what

)

Value:

    else if(!wcsncmp(src, (what), ARRAY_SIZE(what)-1))\
    {\
        src += ARRAY_SIZE(what)-1-1;/* see preincrement rationale*/\
    }

STRIP_NESTED

#define STRIP_NESTED

(

what

)

Value:

    else if(!wcsncmp(src, (what), ARRAY_SIZE(what)-1))\
    {\
        /* remove preceding comma (if present) */\
        if(src != name && src[-1] == ',')\
            dst--;\
        src += ARRAY_SIZE(what)-1;\
        /* strip everything until trailing > is matched */\
        ENSURE(nesting == 0);\
        nesting = 1;\
    }

Function Documentation

debug_stl_get_container_info()

Status debug_stl_get_container_info	(	const wchar_t *	type_name,
		const u8 *	p,
		size_t	size,
		size_t	el_size,
		size_t *	el_count,
		DebugStlIterator *	el_iterator,
		void *	it_mem
	)

prepare to enumerate the elements of arbitrarily typed STL containers.

works by retrieving element count&size via debug information and hiding the container's iterator implementation behind a common interface. a basic sanity check is performed to see if the container memory is valid and appears to be initialized.

Parameters

type_name	exact type of STL container (see example above)
p	raw memory holding the container
size	sizeof(container)
el_size	sizeof(value_type)
el_count	out; number of valid elements in container
el_iterator	out; callback function that acts as an iterator
it_mem	out; buffer holding the iterator state. must be at least DEBUG_STL_MAX_ITERATOR_SIZE bytes.

Returns

Status (ERR::STL_*)

debug_stl_simplify_name()

wchar_t * debug_stl_simplify_name

(

wchar_t *

name

)

reduce complicated STL symbol names to human-readable form.

algorithm: remove/replace undesired substrings in one pass (fast). example: "std::basic_string\<char, char_traits\<char\>, std::allocator\<char\> \>" => "string".

Parameters

name	Buffer holding input symbol name; modified in-place. There is no length limit; must be large enough to hold typical STL strings. DEBUG_SYMBOL_CHARS chars is a good measure.

Returns

name for convenience.

get_container_info()

template<class T >

bool get_container_info	(	const T &	t,
		size_t	size,
		size_t	el_size,
		size_t &	el_count,
		DebugStlIterator &	el_iterator,
		void *	it_mem
	)

IsContainerValid()

template<class T >

static bool IsContainerValid ( const T &  t, size_t  el_count  )

static

STATUS_ADD_DEFINITIONS()

STATUS_ADD_DEFINITIONS

(

debugStlStatusDefinitions

)

stl_iterator()

template<class T >

const u8 * stl_iterator	(	void *	it_mem,
		size_t	el_size
	)

Variable Documentation

debugStlStatusDefinitions

const StatusDefinition debugStlStatusDefinitions[]

static

Initial value:

= {
    { ERR::STL_CNT_UNKNOWN, L"Unknown STL container type_name" },
    { ERR::STL_CNT_UNSUPPORTED, L"Unsupported STL container" },
    { ERR::STL_CNT_INVALID, L"Container type is known but contents are invalid" }
}