ue1/doxygen/classCScriptparser.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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>imgsynth: CScriptparser Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>CScriptparser Class Reference</h1><!-- doxytag: class="CScriptparser" -->class for parsing simple scriptfiles  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="cscriptparser_8h-source.html">cscriptparser.h</a>&gt;</code>
<p>

<p>
<a href="classCScriptparser-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<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>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default ctor.  <a href="#634edff14e86240f53ff7451343c6c56"></a><br></td></tr>
<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>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor.  <a href="#09591a8276fd376e04d4017f3c8d17d1"></a><br></td></tr>
<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>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Start parsing the scriptfile.  <a href="#d288fe020a67ade7914d7a3a77e16c42"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<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>

<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>
<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>

<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>
<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>

<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>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<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>

<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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
class for parsing simple scriptfiles 
<p>
<dl class="user" compact><dt><b>Modulname:</b></dt><dd>cscriptparser </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Manuel Mausz, 0728348 </dd></dl>
<dl class="date" compact><dt><b>Date:</b></dt><dd>17.04.2009</dd></dl>
Parses 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>
read- 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>
On 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>
<a class="anchor" name="634edff14e86240f53ff7451343c6c56"></a><!-- doxytag: member="CScriptparser::CScriptparser" ref="634edff14e86240f53ff7451343c6c56" args="(const std::string &amp;scriptfile)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CScriptparser::CScriptparser           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>scriptfile</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default ctor. 
<p>
<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>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>scriptfile</em>&nbsp;</td><td>filename of script to parse </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>bad_alloc</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<a class="anchor" name="09591a8276fd376e04d4017f3c8d17d1"></a><!-- doxytag: member="CScriptparser::~CScriptparser" ref="09591a8276fd376e04d4017f3c8d17d1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CScriptparser::~CScriptparser           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default dtor. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CScriptparser </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d288fe020a67ade7914d7a3a77e16c42"></a><!-- doxytag: member="CScriptparser::parse" ref="d288fe020a67ade7914d7a3a77e16c42" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CScriptparser::parse           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Start parsing the scriptfile. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>parse </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <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>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<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)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CScriptparser::callFunc           </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>func</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::list&lt; std::string &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>funcparams</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Delegates the function and its parameters to the correct method (internal or handler). 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>callFunc </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>func</em>&nbsp;</td><td>function name </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>funcparams</em>&nbsp;</td><td>function parameters as list </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <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>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>

</div>
</div><p>
<a class="anchor" name="2f2aba481c11c38b85bb2e8306961c03"></a><!-- doxytag: member="CScriptparser::read" ref="2f2aba481c11c38b85bb2e8306961c03" args="(std::list&lt; std::string &gt; funcparams)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CScriptparser::read           </td>
          <td>(</td>
          <td class="paramtype">std::list&lt; std::string &gt;&nbsp;</td>
          <td class="paramname"> <em>funcparams</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Handles/wrappes read-command. according to the filetype the read-method of the corresponding handler will be called inside. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>read </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>funcparams</em>&nbsp;</td><td>function parameters as list </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <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>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none</dd></dl>
Scriptfile syntax: read(&lt;FILETYPE&gt;, &lt;FILENAME&gt;) 
</div>
</div><p>
<a class="anchor" name="a8ef12e68ca61acfd463e55a3fe8518c"></a><!-- doxytag: member="CScriptparser::write" ref="a8ef12e68ca61acfd463e55a3fe8518c" args="(std::list&lt; std::string &gt; funcparams)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void CScriptparser::write           </td>
          <td>(</td>
          <td class="paramtype">std::list&lt; std::string &gt;&nbsp;</td>
          <td class="paramname"> <em>funcparams</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Handles/wrappes write-command. according to the filetype the write-method of the corresponding handler will be called inside. 
<p>
<dl class="user" compact><dt><b>Methodname:</b></dt><dd>write </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>funcparams</em>&nbsp;</td><td>function parameters as list </td></tr>
  </table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <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>
  </table>
</dl>
<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none</dd></dl>
Scriptfile syntax: write(&lt;FILETYPE&gt;, &lt;FILENAME&gt;) 
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>imgsynth/<a class="el" href="cscriptparser_8h-source.html">cscriptparser.h</a><li>imgsynth/cscriptparser.cpp</ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 26 12:25:52 2009 for imgsynth by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>