File: CastleClassUtils.TPeekCharStream.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (238 lines) | stat: -rw-r--r-- 14,376 bytes parent folder | download
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
<!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: CastleClassUtils: Class TPeekCharStream</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">
<a name="TPeekCharStream"></a><h1 class="cio">Class TPeekCharStream</h1>
<table class="sections wide_list">
<tr>
<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>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="CastleClassUtils.html">CastleClassUtils</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TPeekCharStream = class(TStream)</code></p>
<h2 class="description">Description</h2>
<p>
Abstract class to read another stream, always being able to back one character. This is a purely sequential read-only stream. This means that calling <a class="normal" href="CastleClassUtils.TPeekCharStream.html#Write">Write</a>, <a class="normal" href="CastleClassUtils.TPeekCharStream.html#Seek">Seek</a> (changing Position) or setting <code>Size</code> will always cause an exception with appropriate descendant of <a class="normal" href="CastleClassUtils.EStreamNotImplemented.html">EStreamNotImplemented</a>.

<p>Getting <code>Size</code> and <code>Position</code> is allowed. Getting <code>Size</code> is simply implemented by getting SourceStream.Size (so it works if the underlying source stream supports getting Size). Getting <code>Position</code> always works correctly, as it's just the number of characters <i>read</i> from this stream. The fact that we may read ahead in the underlying source stream (for buffering, for peeking) is completely hidden.

<p>We do not assume anything about the underlying source stream, in particular the underlying source stream may also be purely sequential (so we can only read from it, and we cannot predict when it ends).

<p>The main advantage of using this class is that you get <a class="normal" href="CastleClassUtils.TPeekCharStream.html#PeekChar">PeekChar</a> routine: you can always peek ahead one character in the stream, without reading it (i.e. next time you will call Read or ReadBuffer you will still get that char). And it works for all source streams, including the ones where seeking is not allowed (so Seek(-1, soCurrent) would not work).</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TStream</li>
<li class="thisitem">TPeekCharStream</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleClassUtils.TPeekCharStream.html#GetSize">GetSize</a></b>: Int64; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleClassUtils.TPeekCharStream.html#SetSize">SetSize</a></b>(NewSize: Longint); override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleClassUtils.TPeekCharStream.html#Seek">Seek</a></b>(const Offset: Int64; Origin: TSeekOrigin): Int64; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleClassUtils.TPeekCharStream.html#Write">Write</a></b>(const Buffer; Count: Longint): Longint; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleClassUtils.TPeekCharStream.html#PeekChar">PeekChar</a></b>: Integer; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleClassUtils.TPeekCharStream.html#ReadChar">ReadChar</a></b>: Integer; virtual; abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleClassUtils.TPeekCharStream.html#ReadUpto">ReadUpto</a></b>(const EndingChars: <a  href="CastleStringUtils.html#TSetOfChars">TSetOfChars</a>): string; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="CastleClassUtils.TPeekCharStream.html#Create">Create</a></b>(ASourceStream: TStream; AOwnsSourceStream: boolean);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a  href="CastleClassUtils.TPeekCharStream.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleClassUtils.TPeekCharStream.html#SourceStream">SourceStream</a></b>: TStream read FSourceStream;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleClassUtils.TPeekCharStream.html#OwnsSourceStream">OwnsSourceStream</a></b>: boolean
      read FOwnsSourceStream <a  href="CastleClassUtils.TPeekCharStream.html#Write">write</a> FOwnsSourceStream;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetSize"></a><code>function <b>GetSize</b>: Int64; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
.</p>
<h6 class="description_section">Returns</h6>
<p class="return">SourceStream.Size</p></td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SetSize"></a><code>procedure <b>SetSize</b>(NewSize: Longint); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
This stream doesn't support setting size. (All other versions of <code>SetSize</code> also call this.) </p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleClassUtils.EStreamNotImplementedSetSize.html">EStreamNotImplementedSetSize</a></dt>
<dd>Always.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Seek"></a><code>function <b>Seek</b>(const Offset: Int64; Origin: TSeekOrigin): Int64; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
This stream doesn't support seeking. (SetPosition and all other versions of Seek also call this.) </p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleClassUtils.EStreamNotImplementedSeek.html">EStreamNotImplementedSeek</a></dt>
<dd>Always.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Write"></a><code>function <b>Write</b>(const Buffer; Count: Longint): Longint; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
This stream doesn't support writing. (WriteBuffer also calls this.) </p>
<h6 class="description_section">Exceptions raised</h6>
<dl class="exceptions_raised">
<dt><a class="normal" href="CastleClassUtils.EStreamNotImplementedWrite.html">EStreamNotImplementedWrite</a></dt>
<dd>Always.</dd>
</dl>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="PeekChar"></a><code>function <b>PeekChar</b>: Integer; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Peek next character. Returns the next character without making it &quot;already read&quot;, so the next call to Read or ReadBuffer will return this char. Subsequent calls to <code>PeekChar</code> (without any Read/ReadBuffer between) will also return the same character.

<p>Returns -1 if stream ended, otherwise returns Ord or given char.

<p>This may call SourceStream.Read, and any exceptions that may be raised in SourceStream.Read are propagated higher from this method.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ReadChar"></a><code>function <b>ReadChar</b>: Integer; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Read next character. A shortcut for Read(c, 1), but it returns -1 if end of stream is reached. So it's consistent with <a class="normal" href="CastleClassUtils.TPeekCharStream.html#PeekChar">PeekChar</a>. Sometimes it's also more comfortable, and it's a little faster.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ReadUpto"></a><code>function <b>ReadUpto</b>(const EndingChars: <a  href="CastleStringUtils.html#TSetOfChars">TSetOfChars</a>): string; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Read characters, until one of EndingChars (or end of stream) is found. The ending character is not &quot;consumed&quot; from the stream. The Result is guaranteed to not contain any char from EndingChars.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(ASourceStream: TStream; AOwnsSourceStream: boolean);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="SourceStream"></a><code>property <b>SourceStream</b>: TStream read FSourceStream;</code></td>
</tr>
<tr><td colspan="2">
<p>
Underlying stream.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="OwnsSourceStream"></a><code>property <b>OwnsSourceStream</b>: boolean
      read FOwnsSourceStream <a  href="CastleClassUtils.TPeekCharStream.html#Write">write</a> FOwnsSourceStream;</code></td>
</tr>
<tr><td colspan="2">
<p>
Should we free underlying <a class="normal" href="CastleClassUtils.TPeekCharStream.html#SourceStream">SourceStream</a> at destruction.</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&amp;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:09</em>
</span>
</td></tr></table></body></html>