summaryrefslogtreecommitdiffstats
path: root/ue1/doxygen/classCScriptparser.html
diff options
context:
space:
mode:
Diffstat (limited to 'ue1/doxygen/classCScriptparser.html')
-rw-r--r--ue1/doxygen/classCScriptparser.html297
1 files changed, 297 insertions, 0 deletions
diff --git a/ue1/doxygen/classCScriptparser.html b/ue1/doxygen/classCScriptparser.html
new file mode 100644
index 0000000..735cfa5
--- /dev/null
+++ b/ue1/doxygen/classCScriptparser.html
@@ -0,0 +1,297 @@
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>imgsynth: CScriptparser 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>CScriptparser Class Reference</h1><!-- doxytag: class="CScriptparser" -->class for parsing simple scriptfiles
24<a href="#_details">More...</a>
25<p>
26<code>#include &lt;<a class="el" href="cscriptparser_8h-source.html">cscriptparser.h</a>&gt;</code>
27<p>
28
29<p>
30<a href="classCScriptparser-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
31<tr><td></td></tr>
32<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
33<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCScriptparser.html#634edff14e86240f53ff7451343c6c56">CScriptparser</a> (const std::string &amp;scriptfile)</td></tr>
34
35<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor. <a href="#634edff14e86240f53ff7451343c6c56"></a><br></td></tr>
36<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCScriptparser.html#09591a8276fd376e04d4017f3c8d17d1">~CScriptparser</a> ()</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor. <a href="#09591a8276fd376e04d4017f3c8d17d1"></a><br></td></tr>
39<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCScriptparser.html#d288fe020a67ade7914d7a3a77e16c42">parse</a> ()</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start parsing the scriptfile. <a href="#d288fe020a67ade7914d7a3a77e16c42"></a><br></td></tr>
42<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
43<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCScriptparser.html#9318b7e1379de95a7c920f7d0b79eb7b">callFunc</a> (const std::string &amp;func, const std::list&lt; std::string &gt; &amp;funcparams)</td></tr>
44
45<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delegates the function and its parameters to the correct method (internal or handler). <a href="#9318b7e1379de95a7c920f7d0b79eb7b"></a><br></td></tr>
46<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCScriptparser.html#2f2aba481c11c38b85bb2e8306961c03">read</a> (std::list&lt; std::string &gt; funcparams)</td></tr>
47
48<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handles/wrappes read-command. according to the filetype the read-method of the corresponding handler will be called inside. <a href="#2f2aba481c11c38b85bb2e8306961c03"></a><br></td></tr>
49<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCScriptparser.html#a8ef12e68ca61acfd463e55a3fe8518c">write</a> (std::list&lt; std::string &gt; funcparams)</td></tr>
50
51<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handles/wrappes write-command. according to the filetype the write-method of the corresponding handler will be called inside. <a href="#a8ef12e68ca61acfd463e55a3fe8518c"></a><br></td></tr>
52<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
53<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCScriptparser_1_1ParserError.html">ParserError</a></td></tr>
54
55<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Exception thrown by <a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a>. <a href="classCScriptparser_1_1ParserError.html#_details">More...</a><br></td></tr>
56</table>
57<hr><a name="_details"></a><h2>Detailed Description</h2>
58class for parsing simple scriptfiles
59<p>
60<dl class="user" compact><dt><b>Modulname:</b></dt><dd>cscriptparser </dd></dl>
61<dl class="author" compact><dt><b>Author:</b></dt><dd>Manuel Mausz, 0728348 </dd></dl>
62<dl class="date" compact><dt><b>Date:</b></dt><dd>17.04.2009</dd></dl>
63Parses a simple line based scriptfile with some limitations: first function (starting a block) must be a read-command, last must be a write-command (ending this block).<p>
64read- and write-commands have hard coded parameters, number#1 being a filetype. Classes handling certain filetypes must be of type <a class="el" href="classCFile.html" title="Abstract class for handling files. Needed for generic use in CScriptparser.">CFile</a>. Custom functions will be passed to <a class="el" href="classCFile.html#3991c5f43fab6365cc82ba80afccd791" title="Pure virtual method (interface). Should delegate the function and its parameters...">CFile::callFunc()</a>.<p>
65On error <a class="el" href="classCScriptparser_1_1ParserError.html" title="Exception thrown by CScriptparser.">ParserError</a> will be thrown. <hr><h2>Constructor &amp; Destructor Documentation</h2>
66<a class="anchor" name="634edff14e86240f53ff7451343c6c56"></a><!-- doxytag: member="CScriptparser::CScriptparser" ref="634edff14e86240f53ff7451343c6c56" args="(const std::string &amp;scriptfile)" -->
67<div class="memitem">
68<div class="memproto">
69 <table class="memname">
70 <tr>
71 <td class="memname">CScriptparser::CScriptparser </td>
72 <td>(</td>
73 <td class="paramtype">const std::string &amp;&nbsp;</td>
74 <td class="paramname"> <em>scriptfile</em> </td>
75 <td>&nbsp;)&nbsp;</td>
76 <td width="100%"></td>
77 </tr>
78 </table>
79</div>
80<div class="memdoc">
81
82<p>
83Default ctor.
84<p>
85<dl class="user" compact><dt><b>Methodname:</b></dt><dd><a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a> </dd></dl>
86<dl compact><dt><b>Parameters:</b></dt><dd>
87 <table border="0" cellspacing="2" cellpadding="0">
88 <tr><td valign="top"></td><td valign="top"><em>scriptfile</em>&nbsp;</td><td>filename of script to parse </td></tr>
89 </table>
90</dl>
91<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
92<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
93<dl compact><dt><b>Exceptions:</b></dt><dd>
94 <table border="0" cellspacing="2" cellpadding="0">
95 <tr><td valign="top"></td><td valign="top"><em>bad_alloc</em>&nbsp;</td><td></td></tr>
96 </table>
97</dl>
98<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
99
100</div>
101</div><p>
102<a class="anchor" name="09591a8276fd376e04d4017f3c8d17d1"></a><!-- doxytag: member="CScriptparser::~CScriptparser" ref="09591a8276fd376e04d4017f3c8d17d1" args="()" -->
103<div class="memitem">
104<div class="memproto">
105 <table class="memname">
106 <tr>
107 <td class="memname">CScriptparser::~CScriptparser </td>
108 <td>(</td>
109 <td class="paramname"> </td>
110 <td>&nbsp;)&nbsp;</td>
111 <td width="100%"></td>
112 </tr>
113 </table>
114</div>
115<div class="memdoc">
116
117<p>
118Default dtor.
119<p>
120<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CScriptparser </dd></dl>
121<dl compact><dt><b>Parameters:</b></dt><dd>
122 <table border="0" cellspacing="2" cellpadding="0">
123 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
124 </table>
125</dl>
126<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
127<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
128<dl compact><dt><b>Exceptions:</b></dt><dd>
129 <table border="0" cellspacing="2" cellpadding="0">
130 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
131 </table>
132</dl>
133<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
134
135</div>
136</div><p>
137<hr><h2>Member Function Documentation</h2>
138<a class="anchor" name="d288fe020a67ade7914d7a3a77e16c42"></a><!-- doxytag: member="CScriptparser::parse" ref="d288fe020a67ade7914d7a3a77e16c42" args="()" -->
139<div class="memitem">
140<div class="memproto">
141 <table class="memname">
142 <tr>
143 <td class="memname">void CScriptparser::parse </td>
144 <td>(</td>
145 <td class="paramname"> </td>
146 <td>&nbsp;)&nbsp;</td>
147 <td width="100%"></td>
148 </tr>
149 </table>
150</div>
151<div class="memdoc">
152
153<p>
154Start parsing the scriptfile.
155<p>
156<dl class="user" compact><dt><b>Methodname:</b></dt><dd>parse </dd></dl>
157<dl compact><dt><b>Parameters:</b></dt><dd>
158 <table border="0" cellspacing="2" cellpadding="0">
159 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
160 </table>
161</dl>
162<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
163<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
164<dl compact><dt><b>Exceptions:</b></dt><dd>
165 <table border="0" cellspacing="2" cellpadding="0">
166 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCScriptparser_1_1ParserError.html" title="Exception thrown by CScriptparser.">ParserError</a></em>&nbsp;</td><td></td></tr>
167 </table>
168</dl>
169<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
170
171</div>
172</div><p>
173<a class="anchor" name="9318b7e1379de95a7c920f7d0b79eb7b"></a><!-- doxytag: member="CScriptparser::callFunc" ref="9318b7e1379de95a7c920f7d0b79eb7b" args="(const std::string &amp;func, const std::list&lt; std::string &gt; &amp;funcparams)" -->
174<div class="memitem">
175<div class="memproto">
176 <table class="memname">
177 <tr>
178 <td class="memname">void CScriptparser::callFunc </td>
179 <td>(</td>
180 <td class="paramtype">const std::string &amp;&nbsp;</td>
181 <td class="paramname"> <em>func</em>, </td>
182 </tr>
183 <tr>
184 <td class="paramkey"></td>
185 <td></td>
186 <td class="paramtype">const std::list&lt; std::string &gt; &amp;&nbsp;</td>
187 <td class="paramname"> <em>funcparams</em></td><td>&nbsp;</td>
188 </tr>
189 <tr>
190 <td></td>
191 <td>)</td>
192 <td></td><td></td><td width="100%"><code> [protected]</code></td>
193 </tr>
194 </table>
195</div>
196<div class="memdoc">
197
198<p>
199Delegates the function and its parameters to the correct method (internal or handler).
200<p>
201<dl class="user" compact><dt><b>Methodname:</b></dt><dd>callFunc </dd></dl>
202<dl compact><dt><b>Parameters:</b></dt><dd>
203 <table border="0" cellspacing="2" cellpadding="0">
204 <tr><td valign="top"></td><td valign="top"><em>func</em>&nbsp;</td><td>function name </td></tr>
205 <tr><td valign="top"></td><td valign="top"><em>funcparams</em>&nbsp;</td><td>function parameters as list </td></tr>
206 </table>
207</dl>
208<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
209<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
210<dl compact><dt><b>Exceptions:</b></dt><dd>
211 <table border="0" cellspacing="2" cellpadding="0">
212 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCScriptparser_1_1ParserError.html" title="Exception thrown by CScriptparser.">ParserError</a></em>&nbsp;</td><td></td></tr>
213 </table>
214</dl>
215<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
216
217</div>
218</div><p>
219<a class="anchor" name="2f2aba481c11c38b85bb2e8306961c03"></a><!-- doxytag: member="CScriptparser::read" ref="2f2aba481c11c38b85bb2e8306961c03" args="(std::list&lt; std::string &gt; funcparams)" -->
220<div class="memitem">
221<div class="memproto">
222 <table class="memname">
223 <tr>
224 <td class="memname">void CScriptparser::read </td>
225 <td>(</td>
226 <td class="paramtype">std::list&lt; std::string &gt;&nbsp;</td>
227 <td class="paramname"> <em>funcparams</em> </td>
228 <td>&nbsp;)&nbsp;</td>
229 <td width="100%"><code> [protected]</code></td>
230 </tr>
231 </table>
232</div>
233<div class="memdoc">
234
235<p>
236Handles/wrappes read-command. according to the filetype the read-method of the corresponding handler will be called inside.
237<p>
238<dl class="user" compact><dt><b>Methodname:</b></dt><dd>read </dd></dl>
239<dl compact><dt><b>Parameters:</b></dt><dd>
240 <table border="0" cellspacing="2" cellpadding="0">
241 <tr><td valign="top"></td><td valign="top"><em>funcparams</em>&nbsp;</td><td>function parameters as list </td></tr>
242 </table>
243</dl>
244<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
245<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
246<dl compact><dt><b>Exceptions:</b></dt><dd>
247 <table border="0" cellspacing="2" cellpadding="0">
248 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCScriptparser_1_1ParserError.html" title="Exception thrown by CScriptparser.">ParserError</a></em>&nbsp;</td><td></td></tr>
249 </table>
250</dl>
251<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none</dd></dl>
252Scriptfile syntax: read(&lt;FILETYPE&gt;, &lt;FILENAME&gt;)
253</div>
254</div><p>
255<a class="anchor" name="a8ef12e68ca61acfd463e55a3fe8518c"></a><!-- doxytag: member="CScriptparser::write" ref="a8ef12e68ca61acfd463e55a3fe8518c" args="(std::list&lt; std::string &gt; funcparams)" -->
256<div class="memitem">
257<div class="memproto">
258 <table class="memname">
259 <tr>
260 <td class="memname">void CScriptparser::write </td>
261 <td>(</td>
262 <td class="paramtype">std::list&lt; std::string &gt;&nbsp;</td>
263 <td class="paramname"> <em>funcparams</em> </td>
264 <td>&nbsp;)&nbsp;</td>
265 <td width="100%"><code> [protected]</code></td>
266 </tr>
267 </table>
268</div>
269<div class="memdoc">
270
271<p>
272Handles/wrappes write-command. according to the filetype the write-method of the corresponding handler will be called inside.
273<p>
274<dl class="user" compact><dt><b>Methodname:</b></dt><dd>write </dd></dl>
275<dl compact><dt><b>Parameters:</b></dt><dd>
276 <table border="0" cellspacing="2" cellpadding="0">
277 <tr><td valign="top"></td><td valign="top"><em>funcparams</em>&nbsp;</td><td>function parameters as list </td></tr>
278 </table>
279</dl>
280<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
281<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
282<dl compact><dt><b>Exceptions:</b></dt><dd>
283 <table border="0" cellspacing="2" cellpadding="0">
284 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCScriptparser_1_1ParserError.html" title="Exception thrown by CScriptparser.">ParserError</a></em>&nbsp;</td><td></td></tr>
285 </table>
286</dl>
287<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none</dd></dl>
288Scriptfile syntax: write(&lt;FILETYPE&gt;, &lt;FILENAME&gt;)
289</div>
290</div><p>
291<hr>The documentation for this class was generated from the following files:<ul>
292<li>imgsynth/<a class="el" href="cscriptparser_8h-source.html">cscriptparser.h</a><li>imgsynth/cscriptparser.cpp</ul>
293<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 26 12:25:52 2009 for imgsynth by&nbsp;
294<a href="http://www.doxygen.org/index.html">
295<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
296</body>
297</html>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-11 20:43:20 +0000