other/Kermit/doc/API_doc/html/classSymbolTable.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>SymbolTable class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.9.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </center>
<hr><h1>SymbolTable  Class Reference</h1>A container class for "on-demand" symbol address fetching. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="SymbolTable_8hpp-source.html">SymbolTable.hpp</a>&gt;</code>
<p>
<a href="classSymbolTable-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="SymbolTable::SymbolTable"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a0">SymbolTable</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Construct a SymbolTable object and load configuration from default files.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a1">SymbolTable</a> (string res, string sys)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Construct a SymbolTable object and load configuration from defined files.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="SymbolTable::SymbolTable"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a2">SymbolTable</a> (<a class="el" href="classrwKernel.html">rwKernel</a> *)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Construct a SymbolTable object and use the referenced <a class="el" href="classrwKernel.html">rwKernel</a> object in all member attributes and methods.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="SymbolTable::~SymbolTable"></a>
&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a3">~SymbolTable</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Foo.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a4">setSaveFile</a> (string)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Define the file written to on saveCache ().</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>unsigned int&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a5">getSymbol</a> (string)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>get the address of a known symbol.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a6">findSymbol</a> (string)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Find a symbol.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a7" doxytag="SymbolTable::addSymbolToCache"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a7">addSymbolToCache</a> (string, unsigned int)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>add a symbol, address pair to the cache.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a8" doxytag="SymbolTable::clearCache"></a>
void&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a8">clearCache</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>flush the address cache.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a9" doxytag="SymbolTable::saveCache"></a>
bool&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a9">saveCache</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>save the cache to a file (human readable, System.map style).</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="m0" doxytag="SymbolTable::symList"></a>
zzSymList&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#m0">symList</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>List of name, address pairs.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A container class for "on-demand" symbol address fetching.
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a1" doxytag="SymbolTable::SymbolTable"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> 
SymbolTable::SymbolTable 
          </td>
          <td class="md">(&nbsp</td>
          <td class="md">string          </td>
          <td class="mdname"> <em>res</em>,           </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md">        <tr>
          <td></td>
          <td></td>
          <td class="md">string          </td>
          <td class="mdname"> <em>sys</em>          </td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp</td>
          <td class="md" colspan="2">          </td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Construct a SymbolTable object and load configuration from defined files.
<p>
<dl compact><dt>
Parameters: <dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>res
</em>&nbsp;</td><td>
file name of restore file. </td></tr>
<tr><td valign=top><em>sys
</em>&nbsp;</td><td>
System.map file to load. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a6" doxytag="SymbolTable::findSymbol"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> 
bool SymbolTable::findSymbol 
          </td>
          <td class="md">(&nbsp</td>
          <td class="md">string          </td>
          <td class="mdname">          </td>
          <td class="md">)&nbsp;</td>
          <td class="md">          </td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Find a symbol.
<p>
This will try all available methods to find a symbol and cache the address, name pair (zero if search was not successfull). <dl compact><dt>
<b>Returns: </b><dd>
true on success. </dl>    </td>
  </tr>
</table>
<a name="a5" doxytag="SymbolTable::getSymbol"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> 
unsigned int SymbolTable::getSymbol 
          </td>
          <td class="md">(&nbsp</td>
          <td class="md">string          </td>
          <td class="mdname">          </td>
          <td class="md">)&nbsp;</td>
          <td class="md">          </td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
get the address of a known symbol.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
If the symbol is unknow zero is returned. (hey, would you call 0x00000000?). Else, the address of the symbol. </dl>    </td>
  </tr>
</table>
<a name="a4" doxytag="SymbolTable::setSaveFile"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> 
void SymbolTable::setSaveFile 
          </td>
          <td class="md">(&nbsp</td>
          <td class="md">string          </td>
          <td class="mdname">          </td>
          <td class="md">)&nbsp;</td>
          <td class="md">          </td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Define the file written to on saveCache ().
<p>
<dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classSymbolTable.html#a9">saveCache</a>() </dl>    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SymbolTable_8hpp-source.html">SymbolTable.hpp</a></ul>
<hr><address><small>Generated at Tue Aug 14 18:04:51 2001 for Kermit by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2001</small></address>
</body>
</html>