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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleScript</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<h1 class="unit">Unit CastleScript</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Uses">Uses</a></td><td><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#PasDoc-Types">Types</a></td><td>Constants</td><td><a class="section" href="#PasDoc-Variables">Variables</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Base <code>CastleScript</code> structures: values, functions, expressions.
<p>It is designed to be extendable, so you can add new <a class="normal" href="CastleScript.TCasScriptValue.html">TCasScriptValue</a> descendants and new <a class="normal" href="CastleScript.TCasScriptFunction.html">TCasScriptFunction</a> descendants, and register their handlers in <a class="normal" href="CastleScript.html#FunctionHandlers">FunctionHandlers</a> instance (<a class="normal" href="CastleScript.TCasScriptFunctionHandlers.html">TCasScriptFunctionHandlers</a>).
<p>Using structures here you can also build <code>CastleScript</code> expressions by Pascal code (that is, you don't have to parse them). For example this is an expression that calculates <code>sin(3) + 10 + 1</code>:
<p></p>
<pre class="longcode">
Expr := TCasScriptAdd.Create([
TCasScriptSin.Create([TCasScriptFloat.Create(false, <span class="pascal_numeric">3</span>)]),
TCasScriptFloat.Create(false, <span class="pascal_numeric">10</span>),
TCasScriptFloat.Create(false, <span class="pascal_numeric">1</span>)
]);
</pre>
<p>
<p>You can then call <code>Expr.Execute</code> to calculate such expression.
<p>To make a variable in the expression, just create and remember a <a class="normal" href="CastleScript.TCasScriptFloat.html">TCasScriptFloat</a> instance first, and then change it's value freely between <code>Expr.Execute</code> calls. For example
<p></p>
<pre class="longcode">
MyVariable := TCasScriptFloat.Create(false, <span class="pascal_numeric">3</span>);
Expr := TCasScriptAdd.Create([
TCasScriptSin.Create([MyVariable]),
TCasScriptFloat.Create(false, <span class="pascal_numeric">10</span>),
TCasScriptFloat.Create(false, <span class="pascal_numeric">1</span>)
]);
Writeln((Expr.Execute <span class="pascal_keyword">as</span> TKamStringFloat)<span class="pascal_float">.</span>Value); <span class="pascal_comment">// calculate "sin(3) + 10 + 1"</span>
MyVariable.Value := <span class="pascal_numeric">4</span>;
Writeln((Expr.Execute <span class="pascal_keyword">as</span> TKamStringFloat)<span class="pascal_float">.</span>Value); <span class="pascal_comment">// calculate "sin(4) + 10 + 1"</span>
MyVariable.Value := <span class="pascal_numeric">5</span>;
Writeln((Expr.Execute <span class="pascal_keyword">as</span> TKamStringFloat)<span class="pascal_float">.</span>Value); <span class="pascal_comment">// calculate "sin(5) + 10 + 1"</span>
</pre>
<p>
<p>Note that generally each <a class="normal" href="CastleScript.TCasScriptExpression.html">TCasScriptExpression</a> owns it's children expressions, so they will be automatically freed when parent is freed. Also, the values returned by Execute are owned by expression. So you can simply free whole thing by <code>Expr.Free</code>.
<p>If you're want to parse <code>CastleScript</code> expression from a text file, see <a class="normal" href="CastleScriptParser.html">CastleScriptParser</a>.</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li>Math</li><li>Contnrs</li><li><a href="CastleUtils.html">CastleUtils</a></li><li><a href="CastleClassUtils.html">CastleClassUtils</a></li><li>Classes</li><li>FGL</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.ECasScriptError.html"><code>ECasScriptError</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.ECasScriptAssignError.html"><code>ECasScriptAssignError</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.ECasScriptAnyMathError.html"><code>ECasScriptAnyMathError</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptEnvironment.html"><code>TCasScriptEnvironment</code></a></td>
<td class="itemdesc">Various information that may be useful for implementing some function handlers, but that should be supplied from outside of <a class="normal" href="CastleScript.html">CastleScript</a>.</td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptExpression.html"><code>TCasScriptExpression</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptExpressionList.html"><code>TCasScriptExpressionList</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptValue.html"><code>TCasScriptValue</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptValueList.html"><code>TCasScriptValueList</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptParameterValue.html"><code>TCasScriptParameterValue</code></a></td>
<td class="itemdesc">This is a very special <a class="normal" href="CastleScript.html">CastleScript</a> value, used to represent user-defined function parameter.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptInteger.html"><code>TCasScriptInteger</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptFloat.html"><code>TCasScriptFloat</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptBoolean.html"><code>TCasScriptBoolean</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptString.html"><code>TCasScriptString</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">record <a class="bold" href="CastleScript.TCasScriptSearchArgumentClassesCache.html"><code>TCasScriptSearchArgumentClassesCache</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptFunction.html"><code>TCasScriptFunction</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptSequence.html"><code>TCasScriptSequence</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptAssignment.html"><code>TCasScriptAssignment</code></a></td>
<td class="itemdesc"><a class="normal" href="CastleScript.html">CastleScript</a> assignment operator.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptIf.html"><code>TCasScriptIf</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptWhen.html"><code>TCasScriptWhen</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptWhile.html"><code>TCasScriptWhile</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptFor.html"><code>TCasScriptFor</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptRegisteredHandler.html"><code>TCasScriptRegisteredHandler</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptFunctionHandlers.html"><code>TCasScriptFunctionHandlers</code></a></td>
<td class="itemdesc">This specifies for each type combination (array of <a class="normal" href="CastleScript.TCasScriptValue.html">TCasScriptValue</a> classes) and for each function (<a class="normal" href="CastleScript.TCasScriptFunction.html">TCasScriptFunction</a> class) how they should be handled.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.ECasScriptFunctionArgumentsError.html"><code>ECasScriptFunctionArgumentsError</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.ECasScriptFunctionNoHandler.html"><code>ECasScriptFunctionNoHandler</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptUserFunction.html"><code>TCasScriptUserFunction</code></a></td>
<td class="itemdesc"><a class="normal" href="CastleScript.html">CastleScript</a> user function definition.</td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptUserFunctionList.html"><code>TCasScriptUserFunctionList</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleScript.ECasScriptMissingFunction.html"><code>ECasScriptMissingFunction</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleScript.TCasScriptProgram.html"><code>TCasScriptProgram</code></a></td>
<td class="itemdesc"> </td>
</tr>
</table>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleScript.html#CreateValueIfNeeded">CreateValueIfNeeded</a></b>(var Value: <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>; var ParentOfValue: boolean; NeededClass: <a href="CastleScript.html#TCasScriptValueClass">TCasScriptValueClass</a>);</code></td>
</tr>
</table>
<a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScript.html#EKamAssignValueError">EKamAssignValueError</a></b> = <a href="CastleScript.ECasScriptAssignError.html">ECasScriptAssignError</a> deprecated;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScript.html#TCasScriptMessage">TCasScriptMessage</a></b> = procedure (const S: string) of object;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScript.html#TCasScriptValueClass">TCasScriptValueClass</a></b> = class of <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScript.html#TCasScriptValueClassArray">TCasScriptValueClassArray</a></b> = array of <a href="CastleScript.html#TCasScriptValueClass">TCasScriptValueClass</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScript.html#TCasScriptFunctionClass">TCasScriptFunctionClass</a></b> = class of <a href="CastleScript.TCasScriptFunction.html">TCasScriptFunction</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScript.html#TCasScriptFunctionHandler">TCasScriptFunctionHandler</a></b> = procedure ( AFunction: <a href="CastleScript.TCasScriptFunction.html">TCasScriptFunction</a>; const Arguments: array of <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>; var AResult: <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>; var ParentOfResult: boolean) of object;</code></td>
</tr>
</table>
<a name="PasDoc-Variables"></a><h3 class="summary">Variables</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleScript.html#FunctionHandlers">FunctionHandlers</a></b>: <a href="CastleScript.TCasScriptFunctionHandlers.html">TCasScriptFunctionHandlers</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleScript.html#OnScriptMessage">OnScriptMessage</a></b>: <a href="CastleScript.html#TCasScriptMessage">TCasScriptMessage</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CreateValueIfNeeded"></a><code>procedure <b>CreateValueIfNeeded</b>(var Value: <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>; var ParentOfValue: boolean; NeededClass: <a href="CastleScript.html#TCasScriptValueClass">TCasScriptValueClass</a>);</code></td>
</tr>
<tr><td colspan="1">
<p>
Make sure Value is assigned and of NeededClass. If Value is not assigned, or is not exactly of NeededClass, it will be freed and new will be created.</p>
</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="EKamAssignValueError"></a><code><b>EKamAssignValueError</b> = <a href="CastleScript.ECasScriptAssignError.html">ECasScriptAssignError</a> deprecated;</code></td>
</tr>
<tr><td colspan="1">
<p class="hint_directive">Warning: this symbol is deprecated.</p><p>
Deprecated name for <a class="normal" href="CastleScript.ECasScriptAssignError.html">ECasScriptAssignError</a>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCasScriptMessage"></a><code><b>TCasScriptMessage</b> = procedure (const S: string) of object;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCasScriptValueClass"></a><code><b>TCasScriptValueClass</b> = class of <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCasScriptValueClassArray"></a><code><b>TCasScriptValueClassArray</b> = array of <a href="CastleScript.html#TCasScriptValueClass">TCasScriptValueClass</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCasScriptFunctionClass"></a><code><b>TCasScriptFunctionClass</b> = class of <a href="CastleScript.TCasScriptFunction.html">TCasScriptFunction</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCasScriptFunctionHandler"></a><code><b>TCasScriptFunctionHandler</b> = procedure ( AFunction: <a href="CastleScript.TCasScriptFunction.html">TCasScriptFunction</a>; const Arguments: array of <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>; var AResult: <a href="CastleScript.TCasScriptValue.html">TCasScriptValue</a>; var ParentOfResult: boolean) of object;</code></td>
</tr>
<tr><td colspan="1">
<p>
Calculate result on given function arguments Arguments. Place result in AResult.
<p>The current function is also passed here, although usually you don't need it (you already get a list of calculated Arguments, and you should register different procedures for different <a class="normal" href="CastleScript.TCasScriptFunction.html">TCasScriptFunction</a> classes, so you know what operation on arguments should be done). For functions when GreedyArgumentsCalculation >= 0, it may be useful to directly access AFunction.Args.
<p>If needed, previous value of AResult should be freed and new created. If current AResult is <> nil and it's of appropriate class, you may also reuse it and only change it's fields (this is helpful, to avoid many creations/destroying of class instances while calculating an expression many times). <a class="normal" href="CastleScript.html#CreateValueIfNeeded">CreateValueIfNeeded</a> may be helpful for implementing this.</p>
</td></tr>
</table>
<h3 class="detail">Variables</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="FunctionHandlers"></a><code><b>FunctionHandlers</b>: <a href="CastleScript.TCasScriptFunctionHandlers.html">TCasScriptFunctionHandlers</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OnScriptMessage"></a><code><b>OnScriptMessage</b>: <a href="CastleScript.html#TCasScriptMessage">TCasScriptMessage</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Global method to output messages done by <a class="normal" href="CastleScript.html">CastleScript</a> <code>writeln()</code> function. If not assigned, we will use <a class="normal" href="CastleWarnings.html#OnWarning">OnWarning</a>.</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:11</em>
</span>
</td></tr></table></body></html>
|
