Mercurial > hg > openttd

annotate src/misc/dbg_helpers.cpp @ 10123:57aa34285d05 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r14307) -Fix: when deleting a station, remove news items regarding it
author smatz <smatz@openttd.org>
date Sat, 13 Sep 2008 10:19:51 +0000
parents f5b8e5291165
children 592ae9307430
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7122
c5da52de6e18 (svn r10395) -Fix [YAPF]: missing include + some signed/unsigned comparison warnings
KUDr <KUDr@openttd.org>
parents: 7118
diff changeset
1 /* $Id$ */
7118
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
2
9111
d48433370037 (svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
rubidium <rubidium@openttd.org>
parents: 8123
diff changeset
3 /** @file dbg_helpers.cpp Helpers for outputting debug information. */
d48433370037 (svn r12971) -Documentation: add @file in files that missed them and add something more than whitespace as description of files that don't have a description.
rubidium <rubidium@openttd.org>
parents: 8123
diff changeset
4
7118
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
5 #include "../stdafx.h"
8123
c26c28875749 (svn r11684) -Codechange: split gfx.h in a type and functional header.
rubidium <rubidium@openttd.org>
parents: 8100
diff changeset
6 #include "../openttd.h"
8100
6d739a5490a9 (svn r11661) -Codechange: some header reworks in order to try to reduce the compile time of OpenTTD by reduce the amount of circular-ish dependencies.
rubidium <rubidium@openttd.org>
parents: 7122
diff changeset
7 #include "../direction_type.h"
9154
046d0b6e0218 (svn r13016) -Codechange: unify the detection if rail catenary should be drawn
smatz <smatz@openttd.org>
parents: 9111
diff changeset
8 #include "../strings_type.h"
7118
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
9 #include "../rail.h"
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
10 #include "../rail_map.h"
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
11 #include "dbg_helpers.h"
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
12
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
13 /** Trackdir & TrackdirBits short names. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
14 static const char* trackdir_names[] = {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
15 "NE", "SE", "UE", "LE", "LS", "RS", "rne", "rse",
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
16 "SW", "NW", "UW", "LW", "LN", "RN", "rsw", "rnw",
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
17 };
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
18
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
19 /** Return name of given Trackdir. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
20 CStrA ValueStr(Trackdir td)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
21 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
22 CStrA out;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
23 out.Format("%d (%s)", td, ItemAtT(td, trackdir_names, "UNK", INVALID_TRACKDIR, "INV"));
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
24 return out.Transfer();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
25 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
26
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
27 /** Return composed name of given TrackdirBits. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
28 CStrA ValueStr(TrackdirBits td_bits)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
29 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
30 CStrA out;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
31 out.Format("%d (%s)", td_bits, ComposeNameT(td_bits, trackdir_names, "UNK", INVALID_TRACKDIR_BIT, "INV").Data());
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
32 return out.Transfer();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
33 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
34
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
35
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
36 /** DiagDirection short names. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
37 static const char* diagdir_names[] = {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
38 "NE", "SE", "SW", "NW",
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
39 };
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
40
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
41 /** Return name of given DiagDirection. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
42 CStrA ValueStr(DiagDirection dd)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
43 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
44 CStrA out;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
45 out.Format("%d (%s)", dd, ItemAtT(dd, diagdir_names, "UNK", INVALID_DIAGDIR, "INV"));
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
46 return out.Transfer();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
47 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
48
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
49
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
50 /** SignalType short names. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
51 static const char* signal_type_names[] = {
9790
f5b8e5291165 (svn r13932) -Add [YAPP]: PBS signals added to the map array. The signals are drawn using the old Patch-like PBS sprites. (michi_cc)
rubidium <rubidium@openttd.org>
parents: 9154
diff changeset
52 "NORMAL", "ENTRY", "EXIT", "COMBO", "PBS", "NOENTRY",
7118
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
53 };
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
54
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
55 /** Return name of given SignalType. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
56 CStrA ValueStr(SignalType t)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
57 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
58 CStrA out;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
59 out.Format("%d (%s)", t, ItemAtT(t, signal_type_names, "UNK"));
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
60 return out.Transfer();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
61 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
62
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
63
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
64 /** Translate TileIndex into string. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
65 CStrA TileStr(TileIndex tile)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
66 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
67 CStrA out;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
68 out.Format("0x%04X (%d, %d)", tile, TileX(tile), TileY(tile));
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
69 return out.Transfer();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
70 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
71
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
72 /** Keep track of the last assigned type_id. Used for anti-recursion. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
73 /*static*/ size_t& DumpTarget::LastTypeId()
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
74 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
75 static size_t last_type_id = 0;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
76 return last_type_id;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
77 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
78
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
79 /** Return structured name of the current class/structure. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
80 CStrA DumpTarget::GetCurrentStructName()
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
81 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
82 CStrA out;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
83 if (!m_cur_struct.empty()) {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
84 // we are inside some named struct, return its name
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
85 out = m_cur_struct.top();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
86 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
87 return out.Transfer();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
88 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
89
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
90 /**
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
91 * Find the given instance in our anti-recursion repository.
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
92 * Return true and set name when object was found.
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
93 */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
94 bool DumpTarget::FindKnownName(size_t type_id, const void *ptr, CStrA &name)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
95 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
96 KNOWN_NAMES::const_iterator it = m_known_names.find(KnownStructKey(type_id, ptr));
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
97 if (it != m_known_names.end()) {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
98 /* we have found it */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
99 name = (*it).second;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
100 return true;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
101 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
102 return false;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
103 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
104
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
105 /** Write some leading spaces into the output. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
106 void DumpTarget::WriteIndent()
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
107 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
108 int num_spaces = 2 * m_indent;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
109 memset(m_out.GrowSizeNC(num_spaces), ' ', num_spaces);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
110 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
111
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
112 /** Write a line with indent at the beginning and <LF> at the end. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
113 void DumpTarget::WriteLine(const char *format, ...)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
114 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
115 WriteIndent();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
116 va_list args;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
117 va_start(args, format);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
118 m_out.AddFormatL(format, args);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
119 va_end(args);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
120 m_out.AppendStr("\n");
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
121 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
122
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
123 /** Write 'name = value' with indent and new-line. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
124 void DumpTarget::WriteValue(const char *name, const char *value_str)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
125 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
126 WriteIndent();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
127 m_out.AddFormat("%s = %s\n", name, value_str);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
128 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
129
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
130 /** Write name & TileIndex to the output. */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
131 void DumpTarget::WriteTile(const char *name, TileIndex tile)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
132 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
133 WriteIndent();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
134 m_out.AddFormat("%s = %s\n", name, TileStr(tile).Data());
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
135 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
136
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
137 /**
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
138 * Open new structure (one level deeper than the current one) 'name = {<LF>'.
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
139 */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
140 void DumpTarget::BeginStruct(size_t type_id, const char *name, const void *ptr)
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
141 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
142 /* make composite name */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
143 CStrA cur_name = GetCurrentStructName().Transfer();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
144 if (cur_name.Size() > 0) {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
145 /* add name delimiter (we use structured names) */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
146 cur_name.AppendStr(".");
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
147 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
148 cur_name.AppendStr(name);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
149
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
150 /* put the name onto stack (as current struct name) */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
151 m_cur_struct.push(cur_name);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
152
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
153 /* put it also to the map of known structures */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
154 m_known_names.insert(KNOWN_NAMES::value_type(KnownStructKey(type_id, ptr), cur_name));
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
155
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
156 WriteIndent();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
157 m_out.AddFormat("%s = {\n", name);
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
158 m_indent++;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
159 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
160
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
161 /**
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
162 * Close structure '}<LF>'.
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
163 */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
164 void DumpTarget::EndStruct()
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
165 {
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
166 m_indent--;
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
167 WriteIndent();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
168 m_out.AddFormat("}\n");
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
169
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
170 /* remove current struct name from the stack */
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
171 m_cur_struct.pop();
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
172 }
4220402d0dab (svn r10391) -Add: debug support - structured dump of variables/classes/structures (with anti-recursion repository) into string
KUDr <KUDr@openttd.org>
parents:
diff changeset
173