diff options
Diffstat (limited to 'docs/doxygen/nel/file_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/file_8h-source.html | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/docs/doxygen/nel/file_8h-source.html b/docs/doxygen/nel/file_8h-source.html new file mode 100644 index 00000000..968ae527 --- /dev/null +++ b/docs/doxygen/nel/file_8h-source.html @@ -0,0 +1,232 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<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">Compound 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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>file.h</h1><a href="file_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2000 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 +00026 <font class="preprocessor">#ifndef NL_FILE_H</font> +00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_FILE_H</font> +00028 <font class="preprocessor"></font> +00029 <font class="preprocessor">#include "<a class="code" href="stream_8h.html">nel/misc/stream.h</a>"</font> +00030 +00031 +00032 +00033 <font class="keyword">namespace </font>NLMISC +00034 { +00035 +00036 <font class="comment">// ======================================================================================================</font> +<a name="l00043"></a><a class="code" href="structNLMISC_1_1EFile.html">00043</a> <font class="comment"></font><font class="keyword">struct </font>EFile : <font class="keyword">public</font> EStream +00044 { +00045 <font class="keyword">public</font>: +<a name="l00046"></a><a class="code" href="structNLMISC_1_1EFile.html#a0">00046</a> <a class="code" href="structNLMISC_1_1EFile.html#a0">EFile</a> () : <a class="code" href="structNLMISC_1_1EStream.html#a0">EStream</a>( "Unknown <a class="code" href="cf__lexical_8cpp.html#a95">file</a> error" ) {} +<a name="l00047"></a><a class="code" href="structNLMISC_1_1EFile.html#a1">00047</a> <a class="code" href="structNLMISC_1_1EFile.html#a0">EFile</a> (<font class="keyword">const</font> std::string& filename) : <a class="code" href="structNLMISC_1_1EStream.html#a0">EStream</a>( "Unknown <a class="code" href="cf__lexical_8cpp.html#a95">file</a> error <a class="code" href="driver__opengl__extension__def_8h.html#a404">in</a> '"+filename+"'" ) {} +00048 }; +00049 +<a name="l00050"></a><a class="code" href="structNLMISC_1_1EFileNotOpened.html">00050</a> <font class="keyword">struct </font>EFileNotOpened : <font class="keyword">public</font> EFile +00051 { +<a name="l00052"></a><a class="code" href="structNLMISC_1_1EFileNotOpened.html#a0">00052</a> <a class="code" href="structNLMISC_1_1EFileNotOpened.html#a0">EFileNotOpened</a>( <font class="keyword">const</font> std::string& filename ) : <a class="code" href="structNLMISC_1_1EFile.html#a0">EFile</a>( "File '"+filename+"' not opened" ) {} +00053 }; +00054 +<a name="l00055"></a><a class="code" href="structNLMISC_1_1EReadError.html">00055</a> <font class="keyword">struct </font>EReadError : <font class="keyword">public</font> EFile +00056 { +<a name="l00057"></a><a class="code" href="structNLMISC_1_1EReadError.html#a0">00057</a> <a class="code" href="structNLMISC_1_1EReadError.html#a0">EReadError</a>( <font class="keyword">const</font> std::string& filename ) : <a class="code" href="structNLMISC_1_1EFile.html#a0">EFile</a>( "Read error <a class="code" href="driver__opengl__extension__def_8h.html#a404">in</a> <a class="code" href="cf__lexical_8cpp.html#a95">file</a> '" +filename+"' (End of <a class="code" href="cf__lexical_8cpp.html#a95">file</a>?)" ) {} +00058 }; +00059 +<a name="l00060"></a><a class="code" href="structNLMISC_1_1EWriteError.html">00060</a> <font class="keyword">struct </font>EWriteError : <font class="keyword">public</font> EFile +00061 { +<a name="l00062"></a><a class="code" href="structNLMISC_1_1EWriteError.html#a0">00062</a> <a class="code" href="structNLMISC_1_1EWriteError.html#a0">EWriteError</a>( <font class="keyword">const</font> std::string& filename ) : <a class="code" href="structNLMISC_1_1EFile.html#a0">EFile</a>( "Write Error <a class="code" href="driver__opengl__extension__def_8h.html#a404">in</a> <a class="code" href="cf__lexical_8cpp.html#a95">file</a> '" +filename+"'" ) {} +00063 }; +00064 +00065 +00066 <font class="comment">// ======================================================================================================</font> +<a name="l00073"></a><a class="code" href="classNLMISC_1_1CIFile.html">00073</a> <font class="comment"></font><font class="keyword">class </font>CIFile : <font class="keyword">public</font> IStream +00074 { +00075 <font class="keyword">public</font>: <font class="comment">// Basic Usage.</font> +00077 <font class="comment"> CIFile();</font> +00078 <a class="code" href="classNLMISC_1_1CIFile.html#a0">CIFile</a>(<font class="keyword">const</font> std::string &path, <font class="keywordtype">bool</font> text=<font class="keyword">false</font>); +00079 <a class="code" href="classNLMISC_1_1CIFile.html#a2">~CIFile</a>(); +00080 +00082 <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CIFile.html#a3">open</a> (<font class="keyword">const</font> std::string &path, <font class="keywordtype">bool</font> text=<font class="keyword">false</font>); +00083 +00085 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CIFile.html#a4">setCacheFileOnOpen</a> (<font class="keywordtype">bool</font> newState); +00086 +00090 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CIFile.html#a5">allowBNPCacheFileOnOpen</a>(<font class="keywordtype">bool</font> newState); +00091 +00093 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CIFile.html#a6">setAsyncLoading</a> (<font class="keywordtype">bool</font> newState); +00094 +00095 <font class="keyword">public</font>: <font class="comment">// Advanced Usage.</font> +00097 <font class="comment"> void close();</font> +00099 <font class="comment"> void flush();</font> +00101 <font class="comment"> bool seek (sint32 offset, IStream::TSeekOrigin origin) throw(EStream);</font> +00103 <font class="comment"> sint32 getPos () throw(EStream);</font> +00104 +00105 <font class="comment">// Imp the Name of the stream as the name of the file.</font> +00106 <font class="keyword">virtual</font> std::string <a class="code" href="classNLMISC_1_1CIFile.html#a11">getStreamName</a>() <font class="keyword">const</font>; +00107 +00108 <font class="comment">// same function that in ifstream</font> +00109 <font class="comment">// return a string separated by \n or eof, used to parsing text file</font> +00110 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CIFile.html#a12">getline</a> (<font class="keywordtype">char</font> *buffer, uint32 bufferSize); +00111 +00112 <font class="comment">// return the size of the file</font> +<a name="l00113"></a><a class="code" href="classNLMISC_1_1CIFile.html#a13">00113</a> uint32 <a class="code" href="classNLMISC_1_1CIFile.html#a13">getFileSize</a> () { <font class="keywordflow">return</font> <a class="code" href="classNLMISC_1_1CIFile.html#o7">_FileSize</a>; } +00114 +00115 <font class="comment">// return true if there s nothing more to read (same as ifstream)</font> +00116 <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CIFile.html#a14">eof</a> (); +00117 +00118 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CIFile.html#a15">serialBuffer</a>(uint8 *buf, uint len)<font class="keywordflow">throw</font>(EReadError); +00119 +00120 <font class="keyword">protected</font>: +00121 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CIFile.html#b0">serialBit</a>(<font class="keywordtype">bool</font> &bit) <font class="keywordflow">throw</font>(EReadError); +00122 +00123 <font class="keyword">private</font>: +<a name="l00124"></a><a class="code" href="classNLMISC_1_1CIFile.html#o0">00124</a> FILE *<a class="code" href="classNLMISC_1_1CIFile.html#o0">_F</a>; +<a name="l00125"></a><a class="code" href="classNLMISC_1_1CIFile.html#o1">00125</a> std::string <a class="code" href="classNLMISC_1_1CIFile.html#o1">_FileName</a>; +00126 +00127 <font class="comment">// Async</font> +00128 <font class="keyword">static</font> uint32 <a class="code" href="classNLMISC_1_1CIFile.html#r0">_NbBytesSerialized</a>; +00129 <font class="keyword">static</font> uint32 <a class="code" href="classNLMISC_1_1CIFile.html#r1">_NbBytesLoaded</a>; +<a name="l00130"></a><a class="code" href="classNLMISC_1_1CIFile.html#o2">00130</a> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CIFile.html#o2">_IsAsyncLoading</a>; +00131 +00132 <font class="comment">// Cache </font> +<a name="l00133"></a><a class="code" href="classNLMISC_1_1CIFile.html#o3">00133</a> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CIFile.html#o3">_CacheFileOnOpen</a>; +<a name="l00134"></a><a class="code" href="classNLMISC_1_1CIFile.html#o4">00134</a> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CIFile.html#o4">_AllowBNPCacheFileOnOpen</a>; +<a name="l00135"></a><a class="code" href="classNLMISC_1_1CIFile.html#o5">00135</a> uint8 *<a class="code" href="classNLMISC_1_1CIFile.html#o5">_Cache</a>; +<a name="l00136"></a><a class="code" href="classNLMISC_1_1CIFile.html#o6">00136</a> sint32 <a class="code" href="classNLMISC_1_1CIFile.html#o6">_ReadPos</a>; +<a name="l00137"></a><a class="code" href="classNLMISC_1_1CIFile.html#o7">00137</a> uint32 <a class="code" href="classNLMISC_1_1CIFile.html#o7">_FileSize</a>; +00138 +00139 <font class="comment">// Big file</font> +<a name="l00140"></a><a class="code" href="classNLMISC_1_1CIFile.html#o8">00140</a> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CIFile.html#o8">_AlwaysOpened</a>; +<a name="l00141"></a><a class="code" href="classNLMISC_1_1CIFile.html#o9">00141</a> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CIFile.html#o9">_IsInBigFile</a>; +<a name="l00142"></a><a class="code" href="classNLMISC_1_1CIFile.html#o10">00142</a> uint32 <a class="code" href="classNLMISC_1_1CIFile.html#o10">_BigFileOffset</a>; +00143 +00144 <font class="comment">// Load async if needed in the cache.</font> +00145 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CIFile.html#c0">loadIntoCache</a>(); +00146 }; +00147 +00148 +00149 <font class="comment">// ======================================================================================================</font> +<a name="l00156"></a><a class="code" href="classNLMISC_1_1COFile.html">00156</a> <font class="comment"></font><font class="keyword">class </font>COFile : <font class="keyword">public</font> IStream +00157 { +00158 <font class="keyword">public</font>: <font class="comment">// Basic Usage.</font> +00160 <font class="comment"> COFile();</font> +00161 <a class="code" href="classNLMISC_1_1COFile.html#a0">COFile</a>(<font class="keyword">const</font> std::string &path, <font class="keywordtype">bool</font> append=<font class="keyword">false</font>, <font class="keywordtype">bool</font> text=<font class="keyword">false</font>); +00162 <a class="code" href="classNLMISC_1_1COFile.html#a2">~COFile</a>(); +00163 +00165 <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1COFile.html#a3">open</a>(<font class="keyword">const</font> std::string &path, <font class="keywordtype">bool</font> append=<font class="keyword">false</font>, <font class="keywordtype">bool</font> text=<font class="keyword">false</font>); +00166 +00167 +00168 <font class="keyword">public</font>: <font class="comment">// Advanced Usage.</font> +00170 <font class="comment"> void close();</font> +00172 <font class="comment"> void flush();</font> +00174 <font class="comment"> bool seek (sint32 offset, IStream::TSeekOrigin origin) throw(EStream);</font> +00176 <font class="comment"> sint32 getPos () throw(EStream);</font> +00177 +00178 <font class="comment">// Imp the Name of the stream as the name of the file.</font> +00179 <font class="keyword">virtual</font> std::string <a class="code" href="classNLMISC_1_1COFile.html#a8">getStreamName</a>() <font class="keyword">const</font>; +00180 +00181 <font class="comment">// very useful to serialize string in text mode (without the size)</font> +00182 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1COFile.html#a9">serialBuffer</a>(uint8 *buf, uint len) <font class="keywordflow">throw</font>(EWriteError); +00183 +00184 <font class="keyword">protected</font>: +00185 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1COFile.html#b0">serialBit</a>(<font class="keywordtype">bool</font> &bit) <font class="keywordflow">throw</font>(EWriteError); +00186 +00187 <font class="keyword">private</font>: +<a name="l00188"></a><a class="code" href="classNLMISC_1_1COFile.html#o0">00188</a> FILE *<a class="code" href="classNLMISC_1_1COFile.html#o0">_F</a>; +<a name="l00189"></a><a class="code" href="classNLMISC_1_1COFile.html#o1">00189</a> std::string <a class="code" href="classNLMISC_1_1COFile.html#o1">_FileName</a>; +00190 }; +00191 +00192 +00193 } +00194 +00195 +00196 <font class="preprocessor">#endif // NL_FILE_H</font> +00197 <font class="preprocessor"></font> +00198 <font class="comment">/* End of file.h */</font> +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |