1

/* $Id$ */

     2

     3

/** @file dbg_helpers.cpp */

     4

#include "../stdafx.h"

     5

#include "../openttd.h"

     6

#include "../direction_type.h"

     7

#include "../rail.h"

     8

#include "../rail_map.h"

     9

#include "dbg_helpers.h"

    10

    11

/** Trackdir & TrackdirBits short names. */

    12

static const char* trackdir_names[] = {

    13

	"NE", "SE", "UE", "LE", "LS", "RS", "rne", "rse",

    14

	"SW", "NW", "UW", "LW", "LN", "RN", "rsw", "rnw",

    15

};

    16

    17

/** Return name of given Trackdir. */

    18

CStrA ValueStr(Trackdir td)

    19

{

    20

	CStrA out;

    21

	out.Format("%d (%s)", td, ItemAtT(td, trackdir_names, "UNK", INVALID_TRACKDIR, "INV"));

    22

	return out.Transfer();

    23

}

    24

    25

/** Return composed name of given TrackdirBits. */

    26

CStrA ValueStr(TrackdirBits td_bits)

    27

{

    28

	CStrA out;

    29

	out.Format("%d (%s)", td_bits, ComposeNameT(td_bits, trackdir_names, "UNK", INVALID_TRACKDIR_BIT, "INV").Data());

    30

	return out.Transfer();

    31

}

    32

    33

    34

/** DiagDirection short names. */

    35

static const char* diagdir_names[] = {

    36

	"NE", "SE", "SW", "NW",

    37

};

    38

    39

/** Return name of given DiagDirection. */

    40

CStrA ValueStr(DiagDirection dd)

    41

{

    42

	CStrA out;

    43

	out.Format("%d (%s)", dd, ItemAtT(dd, diagdir_names, "UNK", INVALID_DIAGDIR, "INV"));

    44

	return out.Transfer();

    45

}

    46

    47

    48

/** SignalType short names. */

    49

static const char* signal_type_names[] = {

    50

	"NORMAL", "ENTRY", "EXIT", "COMBO",

    51

};

    52

    53

/** Return name of given SignalType. */

    54

CStrA ValueStr(SignalType t)

    55

{

    56

	CStrA out;

    57

	out.Format("%d (%s)", t, ItemAtT(t, signal_type_names, "UNK"));

    58

	return out.Transfer();

    59

}

    60

    61

    62

/** Translate TileIndex into string. */

    63

CStrA TileStr(TileIndex tile)

    64

{

    65

	CStrA out;

    66

	out.Format("0x%04X (%d, %d)", tile, TileX(tile), TileY(tile));

    67

	return out.Transfer();

    68

}

    69

    70

/** Keep track of the last assigned type_id. Used for anti-recursion. */

    71

/*static*/ size_t& DumpTarget::LastTypeId()

    72

{

    73

	static size_t last_type_id = 0;

    74

	return last_type_id;

    75

}

    76

    77

/** Return structured name of the current class/structure. */

    78

CStrA DumpTarget::GetCurrentStructName()

    79

{

    80

	CStrA out;

    81

	if (!m_cur_struct.empty()) {

    82

		// we are inside some named struct, return its name

    83

		out = m_cur_struct.top();

    84

	}

    85

	return out.Transfer();

    86

}

    87

    88

/**

    89

 * Find the given instance in our anti-recursion repository.

    90

 * Return true and set name when object was found.

    91

 */

    92

bool DumpTarget::FindKnownName(size_t type_id, const void *ptr, CStrA &name)

    93

{

    94

	KNOWN_NAMES::const_iterator it = m_known_names.find(KnownStructKey(type_id, ptr));

    95

	if (it != m_known_names.end()) {

    96

		/* we have found it */

    97

		name = (*it).second;

    98

		return true;

    99

	}

   100

	return false;

   101

}

   102

   103

/** Write some leading spaces into the output. */

   104

void DumpTarget::WriteIndent()

   105

{

   106

	int num_spaces = 2 * m_indent;

   107

	memset(m_out.GrowSizeNC(num_spaces), ' ', num_spaces);

   108

}

   109

   110

/** Write a line with indent at the beginning and <LF> at the end. */

   111

void DumpTarget::WriteLine(const char *format, ...)

   112

{

   113

	WriteIndent();

   114

	va_list args;

   115

	va_start(args, format);

   116

	m_out.AddFormatL(format, args);

   117

	va_end(args);

   118

	m_out.AppendStr("\n");

   119

}

   120

   121

/** Write 'name = value' with indent and new-line. */

   122

void DumpTarget::WriteValue(const char *name, const char *value_str)

   123

{

   124

	WriteIndent();

   125

	m_out.AddFormat("%s = %s\n", name, value_str);

   126

}

   127

   128

/** Write name & TileIndex to the output. */

   129

void DumpTarget::WriteTile(const char *name, TileIndex tile)

   130

{

   131

	WriteIndent();

   132

	m_out.AddFormat("%s = %s\n", name, TileStr(tile).Data());

   133

}

   134

   135

/**

   136

 * Open new structure (one level deeper than the current one) 'name = {<LF>'.

   137

 */

   138

void DumpTarget::BeginStruct(size_t type_id, const char *name, const void *ptr)

   139

{

   140

	/* make composite name */

   141

	CStrA cur_name = GetCurrentStructName().Transfer();

   142

	if (cur_name.Size() > 0) {

   143

		/* add name delimiter (we use structured names) */

   144

		cur_name.AppendStr(".");

   145

	}

   146

	cur_name.AppendStr(name);

   147

   148

	/* put the name onto stack (as current struct name) */

   149

	m_cur_struct.push(cur_name);

   150

   151

	/* put it also to the map of known structures */

   152

	m_known_names.insert(KNOWN_NAMES::value_type(KnownStructKey(type_id, ptr), cur_name));

   153

   154

	WriteIndent();

   155

	m_out.AddFormat("%s = {\n", name);

   156

	m_indent++;

   157

}

   158

   159

/**

   160

 * Close structure '}<LF>'.

   161

 */

   162

void DumpTarget::EndStruct()

   163

{

   164

	m_indent--;

   165

	WriteIndent();

   166

	m_out.AddFormat("}\n");

   167

   168

	/* remove current struct name from the stack */

   169

	m_cur_struct.pop();

   170

}

   171