summaryrefslogtreecommitdiff
path: root/other/Kermit/doc/API_doc/html/classSymbolTable.html
diff options
context:
space:
mode:
authorRoot THC2026-02-24 12:42:47 +0000
committerRoot THC2026-02-24 12:42:47 +0000
commitc9cbeced5b3f2bdd7407e29c0811e65954132540 (patch)
treeaefc355416b561111819de159ccbd86c3004cf88 /other/Kermit/doc/API_doc/html/classSymbolTable.html
parent073fe4bf9fca6bf40cef2886d75df832ef4b6fca (diff)
initial
Diffstat (limited to 'other/Kermit/doc/API_doc/html/classSymbolTable.html')
-rw-r--r--other/Kermit/doc/API_doc/html/classSymbolTable.html220
1 files changed, 220 insertions, 0 deletions
diff --git a/other/Kermit/doc/API_doc/html/classSymbolTable.html b/other/Kermit/doc/API_doc/html/classSymbolTable.html
new file mode 100644
index 0000000..3acabae
--- /dev/null
+++ b/other/Kermit/doc/API_doc/html/classSymbolTable.html
@@ -0,0 +1,220 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>SymbolTable class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5</head><body bgcolor="#ffffff">
6<!-- Generated by Doxygen 1.2.9.1 -->
7<center>
8<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>
9<hr><h1>SymbolTable Class Reference</h1>A container class for "on-demand" symbol address fetching.
10<a href="#_details">More...</a>
11<p>
12<code>#include &lt;<a class="el" href="SymbolTable_8hpp-source.html">SymbolTable.hpp</a>&gt;</code>
13<p>
14<a href="classSymbolTable-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
15<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
16<tr><td nowrap align=right valign=top><a name="a0" doxytag="SymbolTable::SymbolTable"></a>
17&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a0">SymbolTable</a> ()</td></tr>
18<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>
19<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>
20<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>
21<tr><td nowrap align=right valign=top><a name="a2" doxytag="SymbolTable::SymbolTable"></a>
22&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a2">SymbolTable</a> (<a class="el" href="classrwKernel.html">rwKernel</a> *)</td></tr>
23<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>
24<tr><td nowrap align=right valign=top><a name="a3" doxytag="SymbolTable::~SymbolTable"></a>
25&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a3">~SymbolTable</a> ()</td></tr>
26<tr><td>&nbsp;</td><td><font size=-1><em>Foo.</em></font><br><br></td></tr>
27<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>
28<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>
29<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>
30<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>
31<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>
32<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>
33<tr><td nowrap align=right valign=top><a name="a7" doxytag="SymbolTable::addSymbolToCache"></a>
34void&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a7">addSymbolToCache</a> (string, unsigned int)</td></tr>
35<tr><td>&nbsp;</td><td><font size=-1><em>add a symbol, address pair to the cache.</em></font><br><br></td></tr>
36<tr><td nowrap align=right valign=top><a name="a8" doxytag="SymbolTable::clearCache"></a>
37void&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a8">clearCache</a> ()</td></tr>
38<tr><td>&nbsp;</td><td><font size=-1><em>flush the address cache.</em></font><br><br></td></tr>
39<tr><td nowrap align=right valign=top><a name="a9" doxytag="SymbolTable::saveCache"></a>
40bool&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#a9">saveCache</a> ()</td></tr>
41<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>
42<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
43<tr><td nowrap align=right valign=top><a name="m0" doxytag="SymbolTable::symList"></a>
44zzSymList&nbsp;</td><td valign=bottom><a class="el" href="classSymbolTable.html#m0">symList</a></td></tr>
45<tr><td>&nbsp;</td><td><font size=-1><em>List of name, address pairs.</em></font><br><br></td></tr>
46</table>
47<hr><a name="_details"></a><h2>Detailed Description</h2>
48A container class for "on-demand" symbol address fetching.
49<p>
50<hr><h2>Constructor &amp; Destructor Documentation</h2>
51<a name="a1" doxytag="SymbolTable::SymbolTable"></a><p>
52<table width="100%" cellpadding="2" cellspacing="0" border="0">
53 <tr>
54 <td class="md">
55 <table cellpadding="0" cellspacing="0" border="0">
56 <tr>
57 <td class="md" nowrap valign="top">
58SymbolTable::SymbolTable
59 </td>
60 <td class="md">(&nbsp</td>
61 <td class="md">string </td>
62 <td class="mdname"> <em>res</em>, </td>
63 </tr>
64 <tr>
65 <td></td>
66 <td></td>
67 <td class="md"> <tr>
68 <td></td>
69 <td></td>
70 <td class="md">string </td>
71 <td class="mdname"> <em>sys</em> </td>
72 </tr>
73 <tr>
74 <td></td>
75 <td class="md">)&nbsp</td>
76 <td class="md" colspan="2"> </td>
77 </tr>
78
79 </table>
80 </td>
81 </tr>
82</table>
83<table cellspacing=5 cellpadding=0 border=0>
84 <tr>
85 <td>
86 &nbsp;
87 </td>
88 <td>
89
90<p>
91Construct a SymbolTable object and load configuration from defined files.
92<p>
93<dl compact><dt>
94Parameters: <dd>
95<table border=0 cellspacing=2 cellpadding=0>
96<tr><td valign=top><em>res
97</em>&nbsp;</td><td>
98file name of restore file. </td></tr>
99<tr><td valign=top><em>sys
100</em>&nbsp;</td><td>
101System.map file to load. </td></tr>
102</table>
103</dl> </td>
104 </tr>
105</table>
106<hr><h2>Member Function Documentation</h2>
107<a name="a6" doxytag="SymbolTable::findSymbol"></a><p>
108<table width="100%" cellpadding="2" cellspacing="0" border="0">
109 <tr>
110 <td class="md">
111 <table cellpadding="0" cellspacing="0" border="0">
112 <tr>
113 <td class="md" nowrap valign="top">
114bool SymbolTable::findSymbol
115 </td>
116 <td class="md">(&nbsp</td>
117 <td class="md">string </td>
118 <td class="mdname"> </td>
119 <td class="md">)&nbsp;</td>
120 <td class="md"> </td>
121 </tr>
122
123 </table>
124 </td>
125 </tr>
126</table>
127<table cellspacing=5 cellpadding=0 border=0>
128 <tr>
129 <td>
130 &nbsp;
131 </td>
132 <td>
133
134<p>
135Find a symbol.
136<p>
137This will try all available methods to find a symbol and cache the address, name pair (zero if search was not successfull). <dl compact><dt>
138<b>Returns: </b><dd>
139true on success. </dl> </td>
140 </tr>
141</table>
142<a name="a5" doxytag="SymbolTable::getSymbol"></a><p>
143<table width="100%" cellpadding="2" cellspacing="0" border="0">
144 <tr>
145 <td class="md">
146 <table cellpadding="0" cellspacing="0" border="0">
147 <tr>
148 <td class="md" nowrap valign="top">
149unsigned int SymbolTable::getSymbol
150 </td>
151 <td class="md">(&nbsp</td>
152 <td class="md">string </td>
153 <td class="mdname"> </td>
154 <td class="md">)&nbsp;</td>
155 <td class="md"> </td>
156 </tr>
157
158 </table>
159 </td>
160 </tr>
161</table>
162<table cellspacing=5 cellpadding=0 border=0>
163 <tr>
164 <td>
165 &nbsp;
166 </td>
167 <td>
168
169<p>
170get the address of a known symbol.
171<p>
172<dl compact><dt>
173<b>Returns: </b><dd>
174If the symbol is unknow zero is returned. (hey, would you call 0x00000000?). Else, the address of the symbol. </dl> </td>
175 </tr>
176</table>
177<a name="a4" doxytag="SymbolTable::setSaveFile"></a><p>
178<table width="100%" cellpadding="2" cellspacing="0" border="0">
179 <tr>
180 <td class="md">
181 <table cellpadding="0" cellspacing="0" border="0">
182 <tr>
183 <td class="md" nowrap valign="top">
184void SymbolTable::setSaveFile
185 </td>
186 <td class="md">(&nbsp</td>
187 <td class="md">string </td>
188 <td class="mdname"> </td>
189 <td class="md">)&nbsp;</td>
190 <td class="md"> </td>
191 </tr>
192
193 </table>
194 </td>
195 </tr>
196</table>
197<table cellspacing=5 cellpadding=0 border=0>
198 <tr>
199 <td>
200 &nbsp;
201 </td>
202 <td>
203
204<p>
205Define the file written to on saveCache ().
206<p>
207<dl compact><dt>
208<b>See also: </b><dd>
209<a class="el" href="classSymbolTable.html#a9">saveCache</a>() </dl> </td>
210 </tr>
211</table>
212<hr>The documentation for this class was generated from the following file:<ul>
213<li><a class="el" href="SymbolTable_8hpp-source.html">SymbolTable.hpp</a></ul>
214<hr><address><small>Generated at Tue Aug 14 18:04:51 2001 for Kermit by
215<a href="http://www.doxygen.org/index.html">
216<img src="doxygen.gif" alt="doxygen" align="middle" border=0
217width=110 height=53></a>1.2.9.1 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
218 &copy;&nbsp;1997-2001</small></address>
219</body>
220</html>