1 | <html> |
---|
2 | <head> |
---|
3 | <title>OgreDataStream.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
4 | <link type="text/css" rel="stylesheet" href="style.css"> |
---|
5 | </head> |
---|
6 | |
---|
7 | <body> |
---|
8 | <!-- Generated by Doxygen 1.3.6 --> |
---|
9 | <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
10 | <h1>OgreDataStream.h</h1><a href="OgreDataStream_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span> |
---|
11 | 00002 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
12 | 00003 <span class="comment">This source file is part of OGRE</span> |
---|
13 | 00004 <span class="comment">(Object-oriented Graphics Rendering Engine)</span> |
---|
14 | 00005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span> |
---|
15 | 00006 <span class="comment"></span> |
---|
16 | 00007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span> |
---|
17 | 00008 <span class="comment">Also see acknowledgements in Readme.html</span> |
---|
18 | 00009 <span class="comment"></span> |
---|
19 | 00010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span> |
---|
20 | 00011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span> |
---|
21 | 00012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span> |
---|
22 | 00013 <span class="comment">version.</span> |
---|
23 | 00014 <span class="comment"></span> |
---|
24 | 00015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span> |
---|
25 | 00016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span> |
---|
26 | 00017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span> |
---|
27 | 00018 <span class="comment"></span> |
---|
28 | 00019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span> |
---|
29 | 00020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span> |
---|
30 | 00021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span> |
---|
31 | 00022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span> |
---|
32 | 00023 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
33 | 00024 <span class="comment">*/</span> |
---|
34 | 00025 <span class="preprocessor">#ifndef __DataStream_H__</span> |
---|
35 | 00026 <span class="preprocessor"></span><span class="preprocessor">#define __DataStream_H__</span> |
---|
36 | 00027 <span class="preprocessor"></span> |
---|
37 | 00028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span> |
---|
38 | 00029 <span class="preprocessor">#include "<a class="code" href="OgreString_8h.html">OgreString.h</a>"</span> |
---|
39 | 00030 <span class="preprocessor">#include "<a class="code" href="OgreSharedPtr_8h.html">OgreSharedPtr.h</a>"</span> |
---|
40 | 00031 <span class="preprocessor">#include <istream></span> |
---|
41 | 00032 |
---|
42 | 00033 <span class="keyword">namespace </span>Ogre { |
---|
43 | 00034 |
---|
44 | <a name="l00054"></a><a class="code" href="classOgre_1_1DataStream.html">00054</a> <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> DataStream |
---|
45 | 00055 { |
---|
46 | 00056 <span class="keyword">protected</span>: |
---|
47 | <a name="l00058"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp2">00058</a> <a class="code" href="namespaceOgre.html#a471">String</a> mName; |
---|
48 | <a name="l00060"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp3">00060</a> size_t mSize; |
---|
49 | <a name="l00061"></a><a class="code" href="OgreDataStream_8h.html#a0">00061</a> <span class="preprocessor"> #define OGRE_STREAM_TEMP_SIZE 128</span> |
---|
50 | 00062 <span class="preprocessor"></span> |
---|
51 | <a name="l00063"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp4">00063</a> <span class="keywordtype">char</span> mTmpArea[<a class="code" href="OgreDataStream_8h.html#a0">OGRE_STREAM_TEMP_SIZE</a>]; |
---|
52 | 00064 <span class="keyword">public</span>: |
---|
53 | <a name="l00066"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama0">00066</a> DataStream() : mSize(0) {} |
---|
54 | <a name="l00068"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama1">00068</a> DataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name) : mName(name), mSize(0) {} |
---|
55 | <a name="l00070"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama11">00070</a> <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& getName(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mName; } |
---|
56 | <a name="l00071"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama3">00071</a> <span class="keyword">virtual</span> ~DataStream() {} |
---|
57 | 00072 <span class="comment">// Streaming operators</span> |
---|
58 | 00073 <span class="keyword">template</span><<span class="keyword">typename</span> T> DataStream& operator>>(T& val); |
---|
59 | 00080 <span class="keyword">virtual</span> size_t read(<span class="keywordtype">void</span>* buf, size_t count) = 0; |
---|
60 | 00092 <span class="keyword">virtual</span> size_t readLine(<span class="keywordtype">char</span>* buf, size_t maxCount, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>) = 0; |
---|
61 | 00093 |
---|
62 | 00105 <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a471">String</a> getLine( <span class="keywordtype">bool</span> trimAfter = <span class="keyword">true</span> ); |
---|
63 | 00106 |
---|
64 | 00112 <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a471">String</a> getAsString(<span class="keywordtype">void</span>); |
---|
65 | 00113 |
---|
66 | 00118 <span class="keyword">virtual</span> size_t skipLine(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>) = 0; |
---|
67 | 00119 |
---|
68 | 00122 <span class="keyword">virtual</span> <span class="keywordtype">void</span> skip(<span class="keywordtype">long</span> count) = 0; |
---|
69 | 00123 |
---|
70 | 00126 <span class="keyword">virtual</span> <span class="keywordtype">void</span> seek( size_t pos ) = 0; |
---|
71 | 00127 |
---|
72 | 00129 <span class="keyword">virtual</span> size_t tell(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0; |
---|
73 | 00130 |
---|
74 | 00133 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> eof(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0; |
---|
75 | 00134 |
---|
76 | <a name="l00138"></a><a class="code" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama15">00138</a> size_t size(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mSize; } |
---|
77 | 00139 |
---|
78 | 00141 <span class="keyword">virtual</span> <span class="keywordtype">void</span> close(<span class="keywordtype">void</span>) = 0; |
---|
79 | 00142 |
---|
80 | 00143 |
---|
81 | 00144 }; |
---|
82 | 00145 |
---|
83 | <a name="l00149"></a><a class="code" href="namespaceOgre.html#a146">00149</a> <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr<DataStream></a> <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>; |
---|
84 | 00150 |
---|
85 | <a name="l00152"></a><a class="code" href="namespaceOgre.html#a147">00152</a> <span class="keyword">typedef</span> std::list<DataStreamPtr> <a class="code" href="namespaceOgre.html#a147">DataStreamList</a>; |
---|
86 | <a name="l00154"></a><a class="code" href="namespaceOgre.html#a148">00154</a> <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr<DataStreamList></a> <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamListPtr</a>; |
---|
87 | 00155 |
---|
88 | <a name="l00158"></a><a class="code" href="classOgre_1_1MemoryDataStream.html">00158</a> <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> MemoryDataStream : <span class="keyword">public</span> DataStream |
---|
89 | 00159 { |
---|
90 | 00160 <span class="keyword">protected</span>: |
---|
91 | <a name="l00162"></a><a class="code" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp0">00162</a> <a class="code" href="namespaceOgre.html#a466">uchar</a>* mData; |
---|
92 | <a name="l00164"></a><a class="code" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp1">00164</a> <a class="code" href="namespaceOgre.html#a466">uchar</a>* mPos; |
---|
93 | <a name="l00166"></a><a class="code" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp2">00166</a> <a class="code" href="namespaceOgre.html#a466">uchar</a>* mEnd; |
---|
94 | <a name="l00168"></a><a class="code" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreamp3">00168</a> <span class="keywordtype">bool</span> mFreeOnClose; |
---|
95 | 00169 <span class="keyword">public</span>: |
---|
96 | 00170 |
---|
97 | 00177 MemoryDataStream(<span class="keywordtype">void</span>* pMem, size_t size, <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">false</span>); |
---|
98 | 00178 |
---|
99 | 00186 MemoryDataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name, <span class="keywordtype">void</span>* pMem, size_t size, |
---|
100 | 00187 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">false</span>); |
---|
101 | 00188 |
---|
102 | 00199 MemoryDataStream(DataStream& sourceStream, |
---|
103 | 00200 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
104 | 00201 |
---|
105 | 00212 MemoryDataStream(<a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>& sourceStream, |
---|
106 | 00213 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
107 | 00214 |
---|
108 | 00227 MemoryDataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name, DataStream& sourceStream, |
---|
109 | 00228 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
110 | 00229 |
---|
111 | 00242 MemoryDataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name, <span class="keyword">const</span> <a class="code" href="classOgre_1_1SharedPtr.html">DataStreamPtr</a>& sourceStream, |
---|
112 | 00243 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
113 | 00244 |
---|
114 | 00250 MemoryDataStream(size_t size, <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
115 | 00257 MemoryDataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name, size_t size, |
---|
116 | 00258 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
117 | 00259 |
---|
118 | 00260 ~MemoryDataStream(); |
---|
119 | 00261 |
---|
120 | <a name="l00263"></a><a class="code" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama9">00263</a> <a class="code" href="namespaceOgre.html#a466">uchar</a>* getPtr(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mData; } |
---|
121 | 00264 |
---|
122 | <a name="l00266"></a><a class="code" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama10">00266</a> <a class="code" href="namespaceOgre.html#a466">uchar</a>* getCurrentPtr(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mPos; } |
---|
123 | 00267 |
---|
124 | 00270 size_t read(<span class="keywordtype">void</span>* buf, size_t count); |
---|
125 | 00273 size_t readLine(<span class="keywordtype">char</span>* buf, size_t maxCount, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>); |
---|
126 | 00274 |
---|
127 | 00277 size_t skipLine(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>); |
---|
128 | 00278 |
---|
129 | 00281 <span class="keywordtype">void</span> skip(<span class="keywordtype">long</span> count); |
---|
130 | 00282 |
---|
131 | 00285 <span class="keywordtype">void</span> seek( size_t pos ); |
---|
132 | 00286 |
---|
133 | 00289 size_t tell(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
134 | 00290 |
---|
135 | 00293 <span class="keywordtype">bool</span> eof(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
136 | 00294 |
---|
137 | 00297 <span class="keywordtype">void</span> close(<span class="keywordtype">void</span>); |
---|
138 | 00298 |
---|
139 | <a name="l00300"></a><a class="code" href="classOgre_1_1MemoryDataStream.html#Ogre_1_1MemoryDataStreama19">00300</a> <span class="keywordtype">void</span> setFreeOnClose(<span class="keywordtype">bool</span> free) { mFreeOnClose = free; } |
---|
140 | 00301 }; |
---|
141 | 00302 |
---|
142 | <a name="l00306"></a><a class="code" href="namespaceOgre.html#a149">00306</a> <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1SharedPtr.html">SharedPtr<MemoryDataStream></a> <a class="code" href="classOgre_1_1SharedPtr.html">MemoryDataStreamPtr</a>; |
---|
143 | 00307 |
---|
144 | <a name="l00311"></a><a class="code" href="classOgre_1_1FileStreamDataStream.html">00311</a> <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> FileStreamDataStream : <span class="keyword">public</span> DataStream |
---|
145 | 00312 { |
---|
146 | 00313 <span class="keyword">protected</span>: |
---|
147 | <a name="l00315"></a><a class="code" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreamp0">00315</a> std::ifstream* mpStream; |
---|
148 | <a name="l00316"></a><a class="code" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreamp1">00316</a> <span class="keywordtype">bool</span> mFreeOnClose; |
---|
149 | 00317 <span class="keyword">public</span>: |
---|
150 | 00323 FileStreamDataStream(std::ifstream* s, |
---|
151 | 00324 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
152 | 00331 FileStreamDataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name, |
---|
153 | 00332 std::ifstream* s, |
---|
154 | 00333 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
155 | 00334 |
---|
156 | 00347 FileStreamDataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name, |
---|
157 | 00348 std::ifstream* s, |
---|
158 | 00349 size_t size, |
---|
159 | 00350 <span class="keywordtype">bool</span> freeOnClose = <span class="keyword">true</span>); |
---|
160 | 00351 |
---|
161 | 00352 ~FileStreamDataStream(); |
---|
162 | 00353 |
---|
163 | 00356 size_t read(<span class="keywordtype">void</span>* buf, size_t count); |
---|
164 | 00359 size_t readLine(<span class="keywordtype">char</span>* buf, size_t maxCount, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>); |
---|
165 | 00360 |
---|
166 | 00363 size_t skipLine(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>); |
---|
167 | 00364 |
---|
168 | 00367 <span class="keywordtype">void</span> skip(<span class="keywordtype">long</span> count); |
---|
169 | 00368 |
---|
170 | 00371 <span class="keywordtype">void</span> seek( size_t pos ); |
---|
171 | 00372 |
---|
172 | 00375 size_t tell(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
173 | 00376 |
---|
174 | 00379 <span class="keywordtype">bool</span> eof(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
175 | 00380 |
---|
176 | 00383 <span class="keywordtype">void</span> close(<span class="keywordtype">void</span>); |
---|
177 | 00384 |
---|
178 | 00385 |
---|
179 | 00386 }; |
---|
180 | 00387 |
---|
181 | <a name="l00397"></a><a class="code" href="classOgre_1_1FileHandleDataStream.html">00397</a> <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> FileHandleDataStream : <span class="keyword">public</span> DataStream |
---|
182 | 00398 { |
---|
183 | 00399 <span class="keyword">protected</span>: |
---|
184 | <a name="l00400"></a><a class="code" href="classOgre_1_1FileHandleDataStream.html#Ogre_1_1FileHandleDataStreamp0">00400</a> FILE* mFileHandle; |
---|
185 | 00401 <span class="keyword">public</span>: |
---|
186 | 00403 FileHandleDataStream(FILE* handle); |
---|
187 | 00405 FileHandleDataStream(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& name, FILE* handle); |
---|
188 | 00406 ~FileHandleDataStream(); |
---|
189 | 00407 |
---|
190 | 00410 size_t read(<span class="keywordtype">void</span>* buf, size_t count); |
---|
191 | 00413 size_t readLine(<span class="keywordtype">char</span>* buf, size_t maxCount, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>); |
---|
192 | 00414 |
---|
193 | 00417 size_t skipLine(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>& delim = <span class="stringliteral">"\n"</span>); |
---|
194 | 00418 |
---|
195 | 00421 <span class="keywordtype">void</span> skip(<span class="keywordtype">long</span> count); |
---|
196 | 00422 |
---|
197 | 00425 <span class="keywordtype">void</span> seek( size_t pos ); |
---|
198 | 00426 |
---|
199 | 00429 size_t tell(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
200 | 00430 |
---|
201 | 00433 <span class="keywordtype">bool</span> eof(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
202 | 00434 |
---|
203 | 00437 <span class="keywordtype">void</span> close(<span class="keywordtype">void</span>); |
---|
204 | 00438 |
---|
205 | 00439 }; |
---|
206 | 00440 } |
---|
207 | 00441 <span class="preprocessor">#endif</span> |
---|
208 | 00442 <span class="preprocessor"></span> |
---|
209 | </pre></div><hr> |
---|
210 | <p> |
---|
211 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
212 | <!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/> |
---|
213 | This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/> |
---|
214 | <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> |
---|
215 | <Work rdf:about=""> |
---|
216 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
217 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
218 | </Work> |
---|
219 | <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> --> |
---|
220 | |
---|
221 | Last modified Sun Mar 12 14:37:40 2006 |
---|
222 | </p> |
---|
223 | </body> |
---|
224 | </html> |
---|