Updated documentation
[libs.git] / docs / html / _input_stream_8h-source.html
blob9c5f137c3da7d3adee91c41a94b62df63c5d9cee
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>LibSylph: Sylph/IO/InputStream.h Source File</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.5.8 -->
7 <div class="navigation" id="top">
8 <div class="tabs">
9 <ul>
10 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12 <li><a href="classes.html"><span>Classes</span></a></li>
13 <li class="current"><a href="files.html"><span>Files</span></a></li>
14 <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 </ul>
16 </div>
17 <div class="tabs">
18 <ul>
19 <li><a href="files.html"><span>File&nbsp;List</span></a></li>
20 </ul>
21 </div>
22 <h1>Sylph/IO/InputStream.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
23 <a name="l00002"></a>00002 <span class="comment"> * LibSylph Class Library</span>
24 <a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2009 Frank "SeySayux" Erens &lt;seysayux@gmail.com&gt;</span>
25 <a name="l00004"></a>00004 <span class="comment"> *</span>
26 <a name="l00005"></a>00005 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
27 <a name="l00006"></a>00006 <span class="comment"> * modify it under the terms of the LibSylph Pulbic License as published</span>
28 <a name="l00007"></a>00007 <span class="comment"> * by the LibSylph Developers; either version 1.0 of the License, or</span>
29 <a name="l00008"></a>00008 <span class="comment"> * (at your option) any later version.</span>
30 <a name="l00009"></a>00009 <span class="comment"> *</span>
31 <a name="l00010"></a>00010 <span class="comment"> * This library is distributed in the hope that it will be useful,</span>
32 <a name="l00011"></a>00011 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
33 <a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the LibSylph</span>
34 <a name="l00013"></a>00013 <span class="comment"> * Public License for more details.</span>
35 <a name="l00014"></a>00014 <span class="comment"> *</span>
36 <a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the LibSylph Public License</span>
37 <a name="l00016"></a>00016 <span class="comment"> * along with this Library, if not, contact the LibSylph Developers.</span>
38 <a name="l00017"></a>00017 <span class="comment"> * </span>
39 <a name="l00018"></a>00018 <span class="comment"> * Created on 27 april 2009, 17:39</span>
40 <a name="l00019"></a>00019 <span class="comment"> */</span>
41 <a name="l00020"></a>00020
42 <a name="l00021"></a>00021 <span class="preprocessor">#ifndef INPUTSTREAM_H_</span>
43 <a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define INPUTSTREAM_H_</span>
44 <a name="l00023"></a>00023 <span class="preprocessor"></span>
45 <a name="l00024"></a>00024
46 <a name="l00025"></a>00025 <span class="preprocessor">#include "../Core/Object.h"</span>
47 <a name="l00026"></a>00026 <span class="preprocessor">#include "../Core/Primitives.h"</span>
48 <a name="l00027"></a>00027 <span class="preprocessor">#include "../Core/Array.h"</span>
49 <a name="l00028"></a>00028 <span class="preprocessor">#include "../Core/String.h"</span>
50 <a name="l00029"></a>00029
51 <a name="l00030"></a>00030 SYLPH_BEGIN_NAMESPACE
52 <a name="l00031"></a>00031 SYLPH_PUBLIC
53 <a name="l00032"></a>00032
54 <a name="l00033"></a>00033 <span class="keyword">class </span>InputStream : <span class="keyword">public</span> <span class="keyword">virtual</span> Object {
55 <a name="l00034"></a>00034 <span class="keyword">public</span>:
56 <a name="l00035"></a>00035 InputStream() : closed(false) {}
57 <a name="l00036"></a>00036 <span class="keyword">virtual</span> ~InputStream() {}
58 <a name="l00037"></a>00037
59 <a name="l00038"></a>00038 <span class="keyword">virtual</span> fsize_t available() <span class="keyword">const</span> = 0;
60 <a name="l00039"></a>00039 <span class="keyword">virtual</span> <span class="keywordtype">void</span> close() { closed = <span class="keyword">true</span>; }
61 <a name="l00040"></a>00040 <span class="keyword">virtual</span> <span class="keywordtype">void</span> read(byte&amp; b) {
62 <a name="l00041"></a>00041 operator&gt;&gt;(b);
63 <a name="l00042"></a>00042 }
64 <a name="l00043"></a>00043 <span class="keyword">virtual</span> fssize_t read(Array&lt;byte&gt;&amp; b, off_t offset = 0, <span class="keywordtype">size_t</span> len = 0) {
65 <a name="l00044"></a>00044 <span class="keywordflow">if</span>(!len) len = b.length;
66 <a name="l00045"></a>00045 <span class="keywordflow">if</span>(offset + len &gt; b.length) sthrow(ArrayException, <span class="stringliteral">"Index out of bounds"</span>);
67 <a name="l00046"></a>00046 <span class="keywordflow">if</span>(eof()) <span class="keywordflow">return</span> -1;
68 <a name="l00047"></a>00047 fssize_t actuallyRead = 0;
69 <a name="l00048"></a>00048 <span class="keywordflow">for</span>(idx_t i = offset; i &lt; len; i++) {
70 <a name="l00049"></a>00049 <span class="keywordflow">if</span>(eof()) <span class="keywordflow">break</span>;
71 <a name="l00050"></a>00050 operator&gt;&gt;(b[i]);
72 <a name="l00051"></a>00051 actuallyRead++;
73 <a name="l00052"></a>00052 }
74 <a name="l00053"></a>00053 <span class="keywordflow">return</span> actuallyRead;
75 <a name="l00054"></a>00054 }
76 <a name="l00055"></a>00055 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> eof() <span class="keyword">const</span> = 0;
77 <a name="l00056"></a>00056 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> markSupported()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
78 <a name="l00057"></a>00057 <span class="keyword">virtual</span> <span class="keywordtype">void</span> mark(fsize_t) = 0;
79 <a name="l00058"></a>00058 <span class="keyword">virtual</span> fsize_t skip(fsize_t) = 0;
80 <a name="l00059"></a>00059 <span class="keyword">virtual</span> <span class="keywordtype">void</span> reset() = 0;
81 <a name="l00060"></a>00060
82 <a name="l00061"></a>00061 <span class="keyword">virtual</span> InputStream&amp; operator&gt;&gt;(byte&amp;) = 0;
83 <a name="l00062"></a>00062 <span class="keyword">virtual</span> InputStream&amp; operator&gt;&gt;(Array&lt;byte&gt;&amp; b) {
84 <a name="l00063"></a>00063 read(b);
85 <a name="l00064"></a>00064 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
86 <a name="l00065"></a>00065 }
87 <a name="l00066"></a>00066 <span class="keywordtype">bool</span> toBool()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> eof() &amp;&amp; !closed; }
88 <a name="l00067"></a>00067 <span class="keyword">protected</span>:
89 <a name="l00068"></a>00068 <span class="keywordtype">bool</span> closed;
90 <a name="l00069"></a>00069 };
91 <a name="l00070"></a>00070 SYLPH_END_NAMESPACE
92 <a name="l00071"></a>00071
93 <a name="l00072"></a>00072 <span class="preprocessor">#endif </span><span class="comment">/* INPUTSTREAM_H_ */</span>
94 </pre></div></div>
95 <hr size="1" class="unhidden"><address style="text-align: right;"><small>
96 Documentation for LibSylph by Doxygen
97 </body>
98 </html>