← Back to branch summary

~ubuntu-branches/ubuntu/utopic/castle-game-engine/utopic

« back to all changes in this revision

Viewing changes to doc/pasdoc/html/CastleScriptLexer.TCasScriptLexer.html

  • Committer: Package Import Robot
  • Author(s): Abou Al Montacir
  • Date: 2013-04-27 18:06:40 UTC
  • Revision ID: package-import@ubuntu.com-20130427180640-eink4nmwzuivez1c
Tags: upstream-4.0.1
Import upstream version 4.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/pasdoc/html/CastleScriptLexer.TCasScriptLexer.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
 
2
<html>
 
3
<head>
 
4
<title>Castle Game Engine: CastleScriptLexer: Class TCasScriptLexer</title>
 
5
<meta name="generator" content="PasDoc 0.12.1">
 
6
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
 
7
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
 
8
</head>
 
9
<body>
 
10
<table class="container"><tr><td class="navigation">
 
11
<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">
 
12
<a name="TCasScriptLexer"></a><h1 class="cio">Class TCasScriptLexer</h1>
 
13
<table class="sections wide_list">
 
14
<tr>
 
15
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
 
16
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
 
17
<p class="unitlink">
 
18
<a  href="CastleScriptLexer.html">CastleScriptLexer</a></p>
 
19
<h2 class="declaration">Declaration</h2>
 
20
<p class="declaration">
 
21
<code>type TCasScriptLexer = class(TObject)</code></p>
 
22
<h2 class="description">Description</h2>
 
23
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
 
24
<ul class="hierarchy"><li class="ancestor">TObject</li>
 
25
<li class="thisitem">TCasScriptLexer</li></ul><h2 class="overview">Overview</h2>
 
26
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
 
27
<table class="summary wide_list">
 
28
<tr class="list">
 
29
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
30
<td class="itemcode"><code>function <b><a  href="CastleScriptLexer.TCasScriptLexer.html#NextToken">NextToken</a></b>: <a  href="CastleScriptLexer.html#TToken">TToken</a>;</code></td>
 
31
</tr>
 
32
<tr class="list2">
 
33
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
34
<td class="itemcode"><code>constructor <b><a  href="CastleScriptLexer.TCasScriptLexer.html#Create">Create</a></b>(const AText: string);</code></td>
 
35
</tr>
 
36
<tr class="list">
 
37
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
38
<td class="itemcode"><code>function <b><a  href="CastleScriptLexer.TCasScriptLexer.html#TokenDescription">TokenDescription</a></b>: string;</code></td>
 
39
</tr>
 
40
<tr class="list2">
 
41
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
42
<td class="itemcode"><code>procedure <b><a  href="CastleScriptLexer.TCasScriptLexer.html#CheckTokenIs">CheckTokenIs</a></b>(Tok: <a  href="CastleScriptLexer.html#TToken">TToken</a>);</code></td>
 
43
</tr>
 
44
</table>
 
45
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
 
46
<table class="summary wide_list">
 
47
<tr class="list">
 
48
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
49
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#Token">Token</a></b>: <a  href="CastleScriptLexer.html#TToken">TToken</a> read FToken;</code></td>
 
50
</tr>
 
51
<tr class="list2">
 
52
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
53
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#TokenInteger">TokenInteger</a></b>: Int64 read FTokenInteger;</code></td>
 
54
</tr>
 
55
<tr class="list">
 
56
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
57
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#TokenFloat">TokenFloat</a></b>: <a  href="CastleUtils.html#Float">Float</a> read FTokenFloat;</code></td>
 
58
</tr>
 
59
<tr class="list2">
 
60
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
61
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#TokenString">TokenString</a></b>: string read FTokenString;</code></td>
 
62
</tr>
 
63
<tr class="list">
 
64
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
65
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#TokenBoolean">TokenBoolean</a></b>: boolean read FTokenBoolean;</code></td>
 
66
</tr>
 
67
<tr class="list2">
 
68
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
69
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#TokenFunctionClass">TokenFunctionClass</a></b>: <a  href="CastleScript.html#TCasScriptFunctionClass">TCasScriptFunctionClass</a> read FTokenFunctionClass;</code></td>
 
70
</tr>
 
71
<tr class="list">
 
72
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
73
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#TextPos">TextPos</a></b>: Integer read FTextPos;</code></td>
 
74
</tr>
 
75
<tr class="list2">
 
76
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
77
<td class="itemcode"><code>property <b><a  href="CastleScriptLexer.TCasScriptLexer.html#Text">Text</a></b>: string read FText;</code></td>
 
78
</tr>
 
79
</table>
 
80
<h2 class="description">Description</h2>
 
81
<h3 class="detail">Methods</h3>
 
82
<table class="detail wide_list">
 
83
<tr class="list">
 
84
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
85
<td class="itemcode"><a name="NextToken"></a><code>function <b>NextToken</b>: <a  href="CastleScriptLexer.html#TToken">TToken</a>;</code></td>
 
86
</tr>
 
87
<tr><td colspan="2">
 
88
<p>
 
89
<code>NextToken</code> moves to next token (updating fields <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#Token">Token</a>, and eventually <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#TokenFloat">TokenFloat</a>, <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#TokenString">TokenString</a> and <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#TokenFunctionClass">TokenFunctionClass</a>) and returns the value of field <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#Token">Token</a>.
 
90
 
 
91
<p>When <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#Token">Token</a> is tokEnd, then <code>NextToken</code> doesn't do anything, i.e. <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#Token">Token</a> will remain tokEnd forever.
 
92
 
 
93
<p></p>
 
94
<h6 class="description_section">Exceptions raised</h6>
 
95
<dl class="exceptions_raised">
 
96
<dt><a class="normal" href="CastleScriptLexer.ECasScriptLexerError.html">ECasScriptLexerError</a></dt>
 
97
<dd></dd>
 
98
</dl>
 
99
</td></tr>
 
100
</table>
 
101
<table class="detail wide_list">
 
102
<tr class="list">
 
103
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
104
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(const AText: string);</code></td>
 
105
</tr>
 
106
<tr><td colspan="2">
 
107
&nbsp;</td></tr>
 
108
</table>
 
109
<table class="detail wide_list">
 
110
<tr class="list">
 
111
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
112
<td class="itemcode"><a name="TokenDescription"></a><code>function <b>TokenDescription</b>: string;</code></td>
 
113
</tr>
 
114
<tr><td colspan="2">
 
115
<p>
 
116
Current token textual description. Useful mainly for debugging lexer.</p>
 
117
</td></tr>
 
118
</table>
 
119
<table class="detail wide_list">
 
120
<tr class="list">
 
121
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
122
<td class="itemcode"><a name="CheckTokenIs"></a><code>procedure <b>CheckTokenIs</b>(Tok: <a  href="CastleScriptLexer.html#TToken">TToken</a>);</code></td>
 
123
</tr>
 
124
<tr><td colspan="2">
 
125
<p>
 
126
Check is current token Tok, eventually rise parser error. This is an utility for parser.
 
127
 
 
128
<p></p>
 
129
<h6 class="description_section">Exceptions raised</h6>
 
130
<dl class="exceptions_raised">
 
131
<dt><a class="normal" href="CastleScriptLexer.ECasScriptParserError.html">ECasScriptParserError</a></dt>
 
132
<dd>if current Token doesn't match required Tok.</dd>
 
133
</dl>
 
134
</td></tr>
 
135
</table>
 
136
<h3 class="detail">Properties</h3>
 
137
<table class="detail wide_list">
 
138
<tr class="list">
 
139
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
140
<td class="itemcode"><a name="Token"></a><code>property <b>Token</b>: <a  href="CastleScriptLexer.html#TToken">TToken</a> read FToken;</code></td>
 
141
</tr>
 
142
<tr><td colspan="2">
 
143
&nbsp;</td></tr>
 
144
</table>
 
145
<table class="detail wide_list">
 
146
<tr class="list">
 
147
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
148
<td class="itemcode"><a name="TokenInteger"></a><code>property <b>TokenInteger</b>: Int64 read FTokenInteger;</code></td>
 
149
</tr>
 
150
<tr><td colspan="2">
 
151
&nbsp;</td></tr>
 
152
</table>
 
153
<table class="detail wide_list">
 
154
<tr class="list">
 
155
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
156
<td class="itemcode"><a name="TokenFloat"></a><code>property <b>TokenFloat</b>: <a  href="CastleUtils.html#Float">Float</a> read FTokenFloat;</code></td>
 
157
</tr>
 
158
<tr><td colspan="2">
 
159
&nbsp;</td></tr>
 
160
</table>
 
161
<table class="detail wide_list">
 
162
<tr class="list">
 
163
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
164
<td class="itemcode"><a name="TokenString"></a><code>property <b>TokenString</b>: string read FTokenString;</code></td>
 
165
</tr>
 
166
<tr><td colspan="2">
 
167
&nbsp;</td></tr>
 
168
</table>
 
169
<table class="detail wide_list">
 
170
<tr class="list">
 
171
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
172
<td class="itemcode"><a name="TokenBoolean"></a><code>property <b>TokenBoolean</b>: boolean read FTokenBoolean;</code></td>
 
173
</tr>
 
174
<tr><td colspan="2">
 
175
&nbsp;</td></tr>
 
176
</table>
 
177
<table class="detail wide_list">
 
178
<tr class="list">
 
179
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
180
<td class="itemcode"><a name="TokenFunctionClass"></a><code>property <b>TokenFunctionClass</b>: <a  href="CastleScript.html#TCasScriptFunctionClass">TCasScriptFunctionClass</a> read FTokenFunctionClass;</code></td>
 
181
</tr>
 
182
<tr><td colspan="2">
 
183
&nbsp;</td></tr>
 
184
</table>
 
185
<table class="detail wide_list">
 
186
<tr class="list">
 
187
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
188
<td class="itemcode"><a name="TextPos"></a><code>property <b>TextPos</b>: Integer read FTextPos;</code></td>
 
189
</tr>
 
190
<tr><td colspan="2">
 
191
<p>
 
192
Position of lexer in the <a class="normal" href="CastleScriptLexer.TCasScriptLexer.html#Text">Text</a> string.</p>
 
193
</td></tr>
 
194
</table>
 
195
<table class="detail wide_list">
 
196
<tr class="list">
 
197
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
198
<td class="itemcode"><a name="Text"></a><code>property <b>Text</b>: string read FText;</code></td>
 
199
</tr>
 
200
<tr><td colspan="2">
 
201
<p>
 
202
Text that this lexer reads.</p>
 
203
</td></tr>
 
204
</table>
 
205
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.12.1</a> on 2013-02-04 20:26:52</em>
 
206
</span>
 
207
</td></tr></table></body></html>