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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
|
<!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: CastleParameters</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 CastleParameters</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><a class="section" href="#PasDoc-Constants">Constants</a></td><td><a class="section" href="#PasDoc-Variables">Variables</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Processing command-line parameters and options (<a class="normal" href="CastleParameters.TParameters.html">TParameters</a>, single instance Parameters).</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li>SysUtils</li><li><a href="CastleVectors.html">CastleVectors</a></li><li><a href="CastleUtils.html">CastleUtils</a></li><li><a href="CastleStringUtils.html">CastleStringUtils</a></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="CastleParameters.EInvalidParams.html"><code>EInvalidParams</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleParameters.EInvalidShortOption.html"><code>EInvalidShortOption</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleParameters.EInvalidLongOption.html"><code>EInvalidLongOption</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleParameters.EWrongOptionArgument.html"><code>EWrongOptionArgument</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">Class <a class="bold" href="CastleParameters.EExcessiveOptionArgument.html"><code>EExcessiveOptionArgument</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleParameters.EMissingOptionArgument.html"><code>EMissingOptionArgument</code></a></td>
<td class="itemdesc"> </td>
</tr>
<tr class="list">
<td class="itemname">record <a class="bold" href="CastleParameters.TOption.html"><code>TOption</code></a></td>
<td class="itemdesc">Command-line option specification, for <a class="normal" href="CastleParameters.TParameters.html#Parse">TParameters.Parse</a>.</td>
</tr>
<tr class="list2">
<td class="itemname">Class <a class="bold" href="CastleParameters.TParameters.html"><code>TParameters</code></a></td>
<td class="itemdesc">Storing and processing command-line parameters and options.</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>function <b><a href="CastleParameters.html#SeparateArgsToVector3Single">SeparateArgsToVector3Single</a></b>(const v: <a href="CastleParameters.html#TSeparateArgs">TSeparateArgs</a>): <a href="CastleVectors.html#TVector3Single">TVector3Single</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="CastleParameters.html#TOptionArgument">TOptionArgument</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#TOptionArguments">TOptionArguments</a></b> = set of <a href="CastleParameters.html#TOptionArgument">TOptionArgument</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#TOptionSeparateArgument">TOptionSeparateArgument</a></b> = <a href="CastleParameters.html#oaRequiredSeparateFirst">oaRequiredSeparateFirst</a> .. <a href="CastleParameters.html#oaRequiredSeparateLast">oaRequiredSeparateLast</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#TSeparateArgs">TSeparateArgs</a></b> = array[1..<a href="CastleParameters.html#RequiredSeparateLastCount">RequiredSeparateLastCount</a>]of string;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#TOptionProc">TOptionProc</a></b> = procedure (OptionNum: Integer; HasArgument: boolean; const Argument: string; const SeparateArgs: <a href="CastleParameters.html#TSeparateArgs">TSeparateArgs</a>; Data: Pointer);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#POption">POption</a></b> = ˆ<a href="CastleParameters.TOption.html">TOption</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#TOption_Array">TOption_Array</a></b> = array [0..MaxInt div SizeOf(<a href="CastleParameters.TOption.html">TOption</a>) - 1] of <a href="CastleParameters.TOption.html">TOption</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#POption_Array">POption_Array</a></b> = ˆ<a href="CastleParameters.html#TOption_Array">TOption_Array</a>;</code></td>
</tr>
</table>
<a name="PasDoc-Constants"></a><h3 class="summary">Constants</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#oaRequiredSeparateFirst">oaRequiredSeparateFirst</a></b> = oaRequired2Separate;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#oaRequiredSeparateLast">oaRequiredSeparateLast</a></b> = oaRequired9Separate;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#RequiredSeparateFirstCount">RequiredSeparateFirstCount</a></b> = 2;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#RequiredSeparateLastCount">RequiredSeparateLastCount</a></b> = <a href="CastleParameters.html#RequiredSeparateFirstCount">RequiredSeparateFirstCount</a>
+ Ord(<a href="CastleParameters.html#oaRequiredSeparateLast">oaRequiredSeparateLast</a>) - Ord(<a href="CastleParameters.html#oaRequiredSeparateFirst">oaRequiredSeparateFirst</a>);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#OptionArgumentsRequiredSeparate">OptionArgumentsRequiredSeparate</a></b>: <a href="CastleParameters.html#TOptionArguments">TOptionArguments</a> =
[<a href="CastleParameters.html#oaRequiredSeparateFirst">oaRequiredSeparateFirst</a> .. <a href="CastleParameters.html#oaRequiredSeparateLast">oaRequiredSeparateLast</a>];</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#EmptySeparateArgs">EmptySeparateArgs</a></b>: <a href="CastleParameters.html#TSeparateArgs">TSeparateArgs</a> = ('','','', '','','', '','','');</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#OnlyHelpOptions">OnlyHelpOptions</a></b>: array[0..0]of <a href="CastleParameters.TOption.html">TOption</a> = (
(Short: 'h'; Long: 'help'; Argument: oaNone)
);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleParameters.html#HelpOptionHelp">HelpOptionHelp</a></b> =
' -h / --help Print this help message and exit.';</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleParameters.html#VersionOptionHelp">VersionOptionHelp</a></b> =
' -v / --version Print the version number and exit.';</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="CastleParameters.html#Parameters">Parameters</a></b>: <a href="CastleParameters.TParameters.html">TParameters</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="SeparateArgsToVector3Single"></a><code>function <b>SeparateArgsToVector3Single</b>(const v: <a href="CastleParameters.html#TSeparateArgs">TSeparateArgs</a>): <a href="CastleVectors.html#TVector3Single">TVector3Single</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TOptionArgument"></a><code><b>TOptionArgument</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<h6 class="description_section">Values</h6>
<ul>
<li>
oaNone: No arguments allowed.</li>
<li>
oaOptional: An optional argument. It must be given as --option=argument or (short form) -o=argument.
<p>If you use a short form and you combine many short option names into one parameter, then only the last option may have an argument. For example <code>-abc=blah</code> is equivalent to <code>-a -b -c=blah</code>.</li>
<li>
oaRequired: A required argument. It must be given as for oaOptional, but this time the equal sign is not needed (we know anyway that following parameter must be an argument). So the following versions are possible:
<p></p>
<pre class="preformatted">
--option=argument # long form, as one parameter
--option argument # long form, as two parameters
-o=argument # short form, as one parameter
-o argument # short form, as two parameters
</pre>
<p></li>
<li>
oaRequired2Separate: We require a specified (more than one) argument. All of the arguments must be specified as separate parameters, like
<p></p>
<pre class="preformatted">
--option Argument1 Argument2
-o Argument1 Argument2
</pre>
<p></li>
<li>
oaRequired3Separate: </li>
<li>
oaRequired4Separate: </li>
<li>
oaRequired5Separate: </li>
<li>
oaRequired6Separate: </li>
<li>
oaRequired7Separate: </li>
<li>
oaRequired8Separate: </li>
<li>
oaRequired9Separate: </li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TOptionArguments"></a><code><b>TOptionArguments</b> = set of <a href="CastleParameters.html#TOptionArgument">TOptionArgument</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TOptionSeparateArgument"></a><code><b>TOptionSeparateArgument</b> = <a href="CastleParameters.html#oaRequiredSeparateFirst">oaRequiredSeparateFirst</a> .. <a href="CastleParameters.html#oaRequiredSeparateLast">oaRequiredSeparateLast</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TSeparateArgs"></a><code><b>TSeparateArgs</b> = array[1..<a href="CastleParameters.html#RequiredSeparateLastCount">RequiredSeparateLastCount</a>]of string;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TOptionProc"></a><code><b>TOptionProc</b> = procedure (OptionNum: Integer; HasArgument: boolean; const Argument: string; const SeparateArgs: <a href="CastleParameters.html#TSeparateArgs">TSeparateArgs</a>; Data: Pointer);</code></td>
</tr>
<tr><td colspan="1">
<p>
Callback used by <a class="normal" href="CastleParameters.TParameters.html#Parse">TParameters.Parse</a> to notify about new option.
<p>
<p>
<p>
<p>
<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>OptionNum</dt>
<dd>The option number in the Options table (zero-based).</dd>
<dt>HasArgument</dt>
<dd>Says if you have a single argument in the Argument parameter. Always <code>False</code> when your option has oaNone or oaRequiredXSeparate. Always <code>True</code> when your option has oaRequired. For oaOptional, this is how you know if the optional argument was used.</dd>
<dt>Argument</dt>
<dd>A single argument for oaRequired or oaOptional, only if HasArgument. Otherwise empty string.</dd>
<dt>SeparateArgs</dt>
<dd>For options using oaRequiredXSeparate, your arguments are here. You get exactly as many argument as your oaRequiredXSeparate requested, the rest of SeparateArgs is empty strings.</dd>
<dt>Data</dt>
<dd>This is the OptionProcData value you passed to <a class="normal" href="CastleParameters.TParameters.html#Parse">TParameters.Parse</a>, use this to pass some pointer to your callback.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="POption"></a><code><b>POption</b> = ˆ<a href="CastleParameters.TOption.html">TOption</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TOption_Array"></a><code><b>TOption_Array</b> = array [0..MaxInt div SizeOf(<a href="CastleParameters.TOption.html">TOption</a>) - 1] of <a href="CastleParameters.TOption.html">TOption</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="POption_Array"></a><code><b>POption_Array</b> = ˆ<a href="CastleParameters.html#TOption_Array">TOption_Array</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Constants</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="oaRequiredSeparateFirst"></a><code><b>oaRequiredSeparateFirst</b> = oaRequired2Separate;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="oaRequiredSeparateLast"></a><code><b>oaRequiredSeparateLast</b> = oaRequired9Separate;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="RequiredSeparateFirstCount"></a><code><b>RequiredSeparateFirstCount</b> = 2;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="RequiredSeparateLastCount"></a><code><b>RequiredSeparateLastCount</b> = <a href="CastleParameters.html#RequiredSeparateFirstCount">RequiredSeparateFirstCount</a>
+ Ord(<a href="CastleParameters.html#oaRequiredSeparateLast">oaRequiredSeparateLast</a>) - Ord(<a href="CastleParameters.html#oaRequiredSeparateFirst">oaRequiredSeparateFirst</a>);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OptionArgumentsRequiredSeparate"></a><code><b>OptionArgumentsRequiredSeparate</b>: <a href="CastleParameters.html#TOptionArguments">TOptionArguments</a> =
[<a href="CastleParameters.html#oaRequiredSeparateFirst">oaRequiredSeparateFirst</a> .. <a href="CastleParameters.html#oaRequiredSeparateLast">oaRequiredSeparateLast</a>];</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="EmptySeparateArgs"></a><code><b>EmptySeparateArgs</b>: <a href="CastleParameters.html#TSeparateArgs">TSeparateArgs</a> = ('','','', '','','', '','','');</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="OnlyHelpOptions"></a><code><b>OnlyHelpOptions</b>: array[0..0]of <a href="CastleParameters.TOption.html">TOption</a> = (
(Short: 'h'; Long: 'help'; Argument: oaNone)
);</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="HelpOptionHelp"></a><code><b>HelpOptionHelp</b> =
' -h / --help Print this help message and exit.';</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="VersionOptionHelp"></a><code><b>VersionOptionHelp</b> =
' -v / --version Print the version number and exit.';</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Variables</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="Parameters"></a><code><b>Parameters</b>: <a href="CastleParameters.TParameters.html">TParameters</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Command-line parameters. Initialized from standard ParamStr(0) ... ParamStr(ParamCount). Can be later modified, which is good — you can remove handled parameters. You also have all the methods of <a class="normal" href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a> class (e.g. you can assign to another <a class="normal" href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a> instance).</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:10</em>
</span>
</td></tr></table></body></html>
|
