rubidium@9631: /* $Id$ */
rubidium@9631: 
rubidium@9631: /** @file dbg_helpers.cpp */
rubidium@9631: #include "../stdafx.h"
rubidium@9723: #include "../openttd.h"
rubidium@9723: #include "../direction_type.h"
rubidium@9631: #include "../rail.h"
rubidium@9631: #include "../rail_map.h"
rubidium@9631: #include "dbg_helpers.h"
rubidium@9631: 
rubidium@9631: /** Trackdir & TrackdirBits short names. */
rubidium@9631: static const char* trackdir_names[] = {
rubidium@9631: 	"NE", "SE", "UE", "LE", "LS", "RS", "rne", "rse",
rubidium@9631: 	"SW", "NW", "UW", "LW", "LN", "RN", "rsw", "rnw",
rubidium@9631: };
rubidium@9631: 
rubidium@9631: /** Return name of given Trackdir. */
rubidium@9631: CStrA ValueStr(Trackdir td)
rubidium@9631: {
rubidium@9631: 	CStrA out;
rubidium@9631: 	out.Format("%d (%s)", td, ItemAtT(td, trackdir_names, "UNK", INVALID_TRACKDIR, "INV"));
rubidium@9631: 	return out.Transfer();
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /** Return composed name of given TrackdirBits. */
rubidium@9631: CStrA ValueStr(TrackdirBits td_bits)
rubidium@9631: {
rubidium@9631: 	CStrA out;
rubidium@9631: 	out.Format("%d (%s)", td_bits, ComposeNameT(td_bits, trackdir_names, "UNK", INVALID_TRACKDIR_BIT, "INV").Data());
rubidium@9631: 	return out.Transfer();
rubidium@9631: }
rubidium@9631: 
rubidium@9631: 
rubidium@9631: /** DiagDirection short names. */
rubidium@9631: static const char* diagdir_names[] = {
rubidium@9631: 	"NE", "SE", "SW", "NW",
rubidium@9631: };
rubidium@9631: 
rubidium@9631: /** Return name of given DiagDirection. */
rubidium@9631: CStrA ValueStr(DiagDirection dd)
rubidium@9631: {
rubidium@9631: 	CStrA out;
rubidium@9631: 	out.Format("%d (%s)", dd, ItemAtT(dd, diagdir_names, "UNK", INVALID_DIAGDIR, "INV"));
rubidium@9631: 	return out.Transfer();
rubidium@9631: }
rubidium@9631: 
rubidium@9631: 
rubidium@9631: /** SignalType short names. */
rubidium@9631: static const char* signal_type_names[] = {
rubidium@9631: 	"NORMAL", "ENTRY", "EXIT", "COMBO",
rubidium@9631: };
rubidium@9631: 
rubidium@9631: /** Return name of given SignalType. */
rubidium@9631: CStrA ValueStr(SignalType t)
rubidium@9631: {
rubidium@9631: 	CStrA out;
rubidium@9631: 	out.Format("%d (%s)", t, ItemAtT(t, signal_type_names, "UNK"));
rubidium@9631: 	return out.Transfer();
rubidium@9631: }
rubidium@9631: 
rubidium@9631: 
rubidium@9631: /** Translate TileIndex into string. */
rubidium@9631: CStrA TileStr(TileIndex tile)
rubidium@9631: {
rubidium@9631: 	CStrA out;
rubidium@9631: 	out.Format("0x%04X (%d, %d)", tile, TileX(tile), TileY(tile));
rubidium@9631: 	return out.Transfer();
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /** Keep track of the last assigned type_id. Used for anti-recursion. */
rubidium@9631: /*static*/ size_t& DumpTarget::LastTypeId()
rubidium@9631: {
rubidium@9631: 	static size_t last_type_id = 0;
rubidium@9631: 	return last_type_id;
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /** Return structured name of the current class/structure. */
rubidium@9631: CStrA DumpTarget::GetCurrentStructName()
rubidium@9631: {
rubidium@9631: 	CStrA out;
rubidium@9631: 	if (!m_cur_struct.empty()) {
rubidium@9631: 		// we are inside some named struct, return its name
rubidium@9631: 		out = m_cur_struct.top();
rubidium@9631: 	}
rubidium@9631: 	return out.Transfer();
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /**
rubidium@9631:  * Find the given instance in our anti-recursion repository.
rubidium@9631:  * Return true and set name when object was found.
rubidium@9631:  */
rubidium@9631: bool DumpTarget::FindKnownName(size_t type_id, const void *ptr, CStrA &name)
rubidium@9631: {
rubidium@9631: 	KNOWN_NAMES::const_iterator it = m_known_names.find(KnownStructKey(type_id, ptr));
rubidium@9631: 	if (it != m_known_names.end()) {
rubidium@9631: 		/* we have found it */
rubidium@9631: 		name = (*it).second;
rubidium@9631: 		return true;
rubidium@9631: 	}
rubidium@9631: 	return false;
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /** Write some leading spaces into the output. */
rubidium@9631: void DumpTarget::WriteIndent()
rubidium@9631: {
rubidium@9631: 	int num_spaces = 2 * m_indent;
rubidium@9631: 	memset(m_out.GrowSizeNC(num_spaces), ' ', num_spaces);
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /** Write a line with indent at the beginning and <LF> at the end. */
rubidium@9631: void DumpTarget::WriteLine(const char *format, ...)
rubidium@9631: {
rubidium@9631: 	WriteIndent();
rubidium@9631: 	va_list args;
rubidium@9631: 	va_start(args, format);
rubidium@9631: 	m_out.AddFormatL(format, args);
rubidium@9631: 	va_end(args);
rubidium@9631: 	m_out.AppendStr("\n");
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /** Write 'name = value' with indent and new-line. */
rubidium@9631: void DumpTarget::WriteValue(const char *name, const char *value_str)
rubidium@9631: {
rubidium@9631: 	WriteIndent();
rubidium@9631: 	m_out.AddFormat("%s = %s\n", name, value_str);
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /** Write name & TileIndex to the output. */
rubidium@9631: void DumpTarget::WriteTile(const char *name, TileIndex tile)
rubidium@9631: {
rubidium@9631: 	WriteIndent();
rubidium@9631: 	m_out.AddFormat("%s = %s\n", name, TileStr(tile).Data());
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /**
rubidium@9631:  * Open new structure (one level deeper than the current one) 'name = {<LF>'.
rubidium@9631:  */
rubidium@9631: void DumpTarget::BeginStruct(size_t type_id, const char *name, const void *ptr)
rubidium@9631: {
rubidium@9631: 	/* make composite name */
rubidium@9631: 	CStrA cur_name = GetCurrentStructName().Transfer();
rubidium@9631: 	if (cur_name.Size() > 0) {
rubidium@9631: 		/* add name delimiter (we use structured names) */
rubidium@9631: 		cur_name.AppendStr(".");
rubidium@9631: 	}
rubidium@9631: 	cur_name.AppendStr(name);
rubidium@9631: 
rubidium@9631: 	/* put the name onto stack (as current struct name) */
rubidium@9631: 	m_cur_struct.push(cur_name);
rubidium@9631: 
rubidium@9631: 	/* put it also to the map of known structures */
rubidium@9631: 	m_known_names.insert(KNOWN_NAMES::value_type(KnownStructKey(type_id, ptr), cur_name));
rubidium@9631: 
rubidium@9631: 	WriteIndent();
rubidium@9631: 	m_out.AddFormat("%s = {\n", name);
rubidium@9631: 	m_indent++;
rubidium@9631: }
rubidium@9631: 
rubidium@9631: /**
rubidium@9631:  * Close structure '}<LF>'.
rubidium@9631:  */
rubidium@9631: void DumpTarget::EndStruct()
rubidium@9631: {
rubidium@9631: 	m_indent--;
rubidium@9631: 	WriteIndent();
rubidium@9631: 	m_out.AddFormat("}\n");
rubidium@9631: 
rubidium@9631: 	/* remove current struct name from the stack */
rubidium@9631: 	m_cur_struct.pop();
rubidium@9631: }
rubidium@9631: