summaryrefslogtreecommitdiffstats
path: root/ue3/doxygen/classCProgram.html
diff options
context:
space:
mode:
authormanuel <manuel@nc8430.lan>2009-05-14 18:21:15 +0200
committermanuel <manuel@nc8430.lan>2009-05-14 18:21:15 +0200
commit3563c6dfd0f5f102cb748ecc6ad318601990515e (patch)
tree269af83394e84e2a7142dde87fb15dce413aa5c9 /ue3/doxygen/classCProgram.html
parentad6ca84f6e93f983de926ae71f31f42325986f61 (diff)
downloadooprog-3563c6dfd0f5f102cb748ecc6ad318601990515e.tar.gz
ooprog-3563c6dfd0f5f102cb748ecc6ad318601990515e.tar.bz2
ooprog-3563c6dfd0f5f102cb748ecc6ad318601990515e.zip
adding doxygen docs
Diffstat (limited to 'ue3/doxygen/classCProgram.html')
-rw-r--r--ue3/doxygen/classCProgram.html234
1 files changed, 234 insertions, 0 deletions
diff --git a/ue3/doxygen/classCProgram.html b/ue3/doxygen/classCProgram.html
new file mode 100644
index 0000000..a756aaa
--- /dev/null
+++ b/ue3/doxygen/classCProgram.html
@@ -0,0 +1,234 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mycpu: CProgram Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.3 -->
8<div class="tabs">
9 <ul>
10 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
14 </ul>
15</div>
16<div class="tabs">
17 <ul>
18 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
19 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
21 </ul>
22</div>
23<h1>CProgram Class Reference</h1><!-- doxytag: class="CProgram" --><code>#include &lt;<a class="el" href="cprogram_8h-source.html">cprogram.h</a>&gt;</code>
24<p>
25
26<p>
27<a href="classCProgram-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
28<tr><td></td></tr>
29<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
30<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgram.html#74d3ca01d5e8b892f37684254ae546ed">CProgram</a> ()</td></tr>
31
32<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor. <a href="#74d3ca01d5e8b892f37684254ae546ed"></a><br></td></tr>
33<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgram.html#7dfeb30706e7af06114fdf18262d7926">~CProgram</a> ()</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor. <a href="#7dfeb30706e7af06114fdf18262d7926"></a><br></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::map<br>
37&lt; std::string,<br>
38 unsigned &gt; &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgram.html#8d5dc184872d4616d327c87ffa665804">getLabels</a> () const </td></tr>
39
40<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">get reference to labels map <a href="#8d5dc184872d4616d327c87ffa665804"></a><br></td></tr>
41<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgram.html#4c29c5c7932174242c50fd9d1c5bc1ec">findLabel</a> (const std::string &amp;label) const </td></tr>
42
43<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">search for label <a href="#4c29c5c7932174242c50fd9d1c5bc1ec"></a><br></td></tr>
44<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCProgram.html#e75e8a7709afcebc7f1537db247f9671">compile</a> (std::istream &amp;in)</td></tr>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">create instructions from parsing stream <a href="#e75e8a7709afcebc7f1537db247f9671"></a><br></td></tr>
47</table>
48<hr><a name="_details"></a><h2>Detailed Description</h2>
49<a class="el" href="classCProgram.html">CProgram</a> extends std::vector and adds a method for parsing programfile. This adds instances of <a class="el" href="classCInstruction.html">CInstruction</a> to <a class="el" href="classCProgram.html">CProgram</a> itself. <hr><h2>Constructor &amp; Destructor Documentation</h2>
50<a class="anchor" name="74d3ca01d5e8b892f37684254ae546ed"></a><!-- doxytag: member="CProgram::CProgram" ref="74d3ca01d5e8b892f37684254ae546ed" args="()" -->
51<div class="memitem">
52<div class="memproto">
53 <table class="memname">
54 <tr>
55 <td class="memname">CProgram::CProgram </td>
56 <td>(</td>
57 <td class="paramname"> </td>
58 <td>&nbsp;)&nbsp;</td>
59 <td width="100%"></td>
60 </tr>
61 </table>
62</div>
63<div class="memdoc">
64
65<p>
66Default ctor.
67<p>
68<dl class="user" compact><dt><b>Methodname:</b></dt><dd><a class="el" href="classCProgram.html">CProgram</a> </dd></dl>
69<dl compact><dt><b>Parameters:</b></dt><dd>
70 <table border="0" cellspacing="2" cellpadding="0">
71 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
72 </table>
73</dl>
74<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
75<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
76<dl compact><dt><b>Exceptions:</b></dt><dd>
77 <table border="0" cellspacing="2" cellpadding="0">
78 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
79 </table>
80</dl>
81<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
82
83</div>
84</div><p>
85<a class="anchor" name="7dfeb30706e7af06114fdf18262d7926"></a><!-- doxytag: member="CProgram::~CProgram" ref="7dfeb30706e7af06114fdf18262d7926" args="()" -->
86<div class="memitem">
87<div class="memproto">
88 <table class="memname">
89 <tr>
90 <td class="memname">CProgram::~CProgram </td>
91 <td>(</td>
92 <td class="paramname"> </td>
93 <td>&nbsp;)&nbsp;</td>
94 <td width="100%"></td>
95 </tr>
96 </table>
97</div>
98<div class="memdoc">
99
100<p>
101Default dtor.
102<p>
103<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CProgram </dd></dl>
104<dl compact><dt><b>Parameters:</b></dt><dd>
105 <table border="0" cellspacing="2" cellpadding="0">
106 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
107 </table>
108</dl>
109<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
110<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
111<dl compact><dt><b>Exceptions:</b></dt><dd>
112 <table border="0" cellspacing="2" cellpadding="0">
113 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
114 </table>
115</dl>
116<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
117
118</div>
119</div><p>
120<hr><h2>Member Function Documentation</h2>
121<a class="anchor" name="8d5dc184872d4616d327c87ffa665804"></a><!-- doxytag: member="CProgram::getLabels" ref="8d5dc184872d4616d327c87ffa665804" args="() const " -->
122<div class="memitem">
123<div class="memproto">
124 <table class="memname">
125 <tr>
126 <td class="memname">const std::map&lt;std::string, unsigned&gt;&amp; CProgram::getLabels </td>
127 <td>(</td>
128 <td class="paramname"> </td>
129 <td>&nbsp;)&nbsp;</td>
130 <td width="100%"> const<code> [inline]</code></td>
131 </tr>
132 </table>
133</div>
134<div class="memdoc">
135
136<p>
137get reference to labels map
138<p>
139<dl class="user" compact><dt><b>Methodname:</b></dt><dd>getLabels </dd></dl>
140<dl compact><dt><b>Parameters:</b></dt><dd>
141 <table border="0" cellspacing="2" cellpadding="0">
142 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
143 </table>
144</dl>
145<dl class="return" compact><dt><b>Returns:</b></dt><dd>reference to labels map </dd></dl>
146<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
147<dl compact><dt><b>Exceptions:</b></dt><dd>
148 <table border="0" cellspacing="2" cellpadding="0">
149 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
150 </table>
151</dl>
152<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
153
154</div>
155</div><p>
156<a class="anchor" name="4c29c5c7932174242c50fd9d1c5bc1ec"></a><!-- doxytag: member="CProgram::findLabel" ref="4c29c5c7932174242c50fd9d1c5bc1ec" args="(const std::string &amp;label) const " -->
157<div class="memitem">
158<div class="memproto">
159 <table class="memname">
160 <tr>
161 <td class="memname">unsigned CProgram::findLabel </td>
162 <td>(</td>
163 <td class="paramtype">const std::string &amp;&nbsp;</td>
164 <td class="paramname"> <em>label</em> </td>
165 <td>&nbsp;)&nbsp;</td>
166 <td width="100%"> const</td>
167 </tr>
168 </table>
169</div>
170<div class="memdoc">
171
172<p>
173search for label
174<p>
175<dl class="user" compact><dt><b>Methodname:</b></dt><dd>findLabel </dd></dl>
176<dl compact><dt><b>Parameters:</b></dt><dd>
177 <table border="0" cellspacing="2" cellpadding="0">
178 <tr><td valign="top"></td><td valign="top"><em>label</em>&nbsp;</td><td>name of label to search for </td></tr>
179 </table>
180</dl>
181<dl class="return" compact><dt><b>Returns:</b></dt><dd>index of found label in program </dd></dl>
182<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
183<dl compact><dt><b>Exceptions:</b></dt><dd>
184 <table border="0" cellspacing="2" cellpadding="0">
185 <tr><td valign="top"></td><td valign="top"><em>std::runtime_error</em>&nbsp;</td><td></td></tr>
186 </table>
187</dl>
188<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
189
190</div>
191</div><p>
192<a class="anchor" name="e75e8a7709afcebc7f1537db247f9671"></a><!-- doxytag: member="CProgram::compile" ref="e75e8a7709afcebc7f1537db247f9671" args="(std::istream &amp;in)" -->
193<div class="memitem">
194<div class="memproto">
195 <table class="memname">
196 <tr>
197 <td class="memname">void CProgram::compile </td>
198 <td>(</td>
199 <td class="paramtype">std::istream &amp;&nbsp;</td>
200 <td class="paramname"> <em>in</em> </td>
201 <td>&nbsp;)&nbsp;</td>
202 <td width="100%"></td>
203 </tr>
204 </table>
205</div>
206<div class="memdoc">
207
208<p>
209create instructions from parsing stream
210<p>
211<dl class="user" compact><dt><b>Methodname:</b></dt><dd>compile </dd></dl>
212<dl compact><dt><b>Parameters:</b></dt><dd>
213 <table border="0" cellspacing="2" cellpadding="0">
214 <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>inputstream to read from </td></tr>
215 </table>
216</dl>
217<dl class="return" compact><dt><b>Returns:</b></dt><dd>void </dd></dl>
218<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
219<dl compact><dt><b>Exceptions:</b></dt><dd>
220 <table border="0" cellspacing="2" cellpadding="0">
221 <tr><td valign="top"></td><td valign="top"><em>std::runtime_error</em>&nbsp;</td><td></td></tr>
222 </table>
223</dl>
224<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
225
226</div>
227</div><p>
228<hr>The documentation for this class was generated from the following files:<ul>
229<li>mycpu/<a class="el" href="cprogram_8h-source.html">cprogram.h</a><li>mycpu/cprogram.cpp</ul>
230<hr size="1"><address style="text-align: right;"><small>Generated on Thu May 14 18:19:17 2009 for mycpu by&nbsp;
231<a href="http://www.doxygen.org/index.html">
232<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
233</body>
234</html>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-12 02:17:40 +0000