aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/big__file_8h-source.html
blob: b573b5b67ff7037ffd670daa20de5c242aa23bfe (plain)
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
<!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="/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="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=140 BGCOLOR=#dddddd><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=16><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
        <TD><IMG  width=6 height=14  SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
 </TR>
</TABLE> 

<!-- banner Nevrax -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 WIDTH=100%>
 <TR><TD  BGCOLOR="#000000" BACKGROUND="/inc/img/black_banner.jpg"><A HREF=""><IMG  SRC="/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="/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
	<TD WIDTH=140   BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG  SRC="/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="/news/" TITLE="Rubrique news"><img width=13 height=15  hspace=5 border=0 src=/inc/img/picto-news.gif ALT=#></A></td><td><a  class='linkbox' href="/news/" TITLE="News">News</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/mail/" TITLE="Rubrique mail"><img width=15 height=11  hspace=5 border=0 src=/inc/img/picto-mail.gif ALT=#></A></td><td><a  class='linkbox' href="/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/docs/" TITLE="Rubrique docs"><img width=14 height=16  hspace=5 border=0 src=/inc/img/picto-docs.gif ALT=#></A></td><td><a  class='linkbox' href="/docs/" TITLE="Documentation">Documentation</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/cvs/" TITLE="Rubrique cvs"><img width=13 height=17  hspace=5 border=0 src=/inc/img/picto-cvs.gif ALT=#></A></td><td><a  class='linkbox' href="/cvs/" TITLE="CVS Web">CVS</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/bugs/" TITLE="Rubrique bugs"><img width=20 height=16  hspace=5 border=0 src=/inc/img/picto-bugs.gif ALT=#></A></td><td><a  class='linkbox' href="/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="/GPL.php3" TITLE="Rubrique license"><img  width=18 height=12   hspace=5 border=0 src=/inc/img/picto-gpl.gif ALT=#></A></td><td><a  class='linkbox' href="/GPL.php3" TITLE="License">License</a></td></tr>
		</TABLE>
		</TD></TR></TABLE></TD></TR></TABLE>
		<!------ End Box  ------>

	</TD>
	<TD WIDTH=15><IMG  SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
	<TD ALIGN=left valign=top><IMG  SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

<!-- title -->
<TABLE  background="/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td>
<A HREF="/docs/"><img src="/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
</td><td><IMG  SRC="/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
</td></tr></table>
&nbsp;

<!-- 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="/inc/img/reddots.gif"></TD>
	<TD><B>Documentation</B></TD>
	<TD ALIGN=RIGHT>&nbsp;</td>
</tr></table>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:/cgi-bin/nel-search.cgi" href="/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
<hr><h1>big_file.h</h1><a href="big__file_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 
00007 <font class="comment">/* Copyright, 2000, 2002 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_BIG_FILE_H</font>
00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_BIG_FILE_H</font>
00028 <font class="preprocessor"></font>
00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font>
00030 <font class="preprocessor">#include "<a class="code" href="tds_8h.html">nel/misc/tds.h</a>"</font>
00031 
00032 
00033 <font class="keyword">namespace </font>NLMISC {
00034 
00042 <font class="keyword">const</font> uint32 <a class="code" href="namespaceNLMISC.html#a0">BF_ALWAYS_OPENED</a>           =       0x00000001;
00043 <font class="keyword">const</font> uint32 <a class="code" href="namespaceNLMISC.html#a1">BF_CACHE_FILE_ON_OPEN</a>      =       0x00000002;
00044 
00045 <font class="comment">// ***************************************************************************</font>
<a name="l00046"></a><a class="code" href="classNLMISC_1_1CBigFile.html">00046</a> <font class="keyword">class </font>CBigFile
00047 {
00048 
00049 <font class="keyword">public</font>:
00050 
00051         <font class="comment">// Retrieve the global instance</font>
00052         <font class="keyword">static</font> <a class="code" href="classNLMISC_1_1CBigFile.html#c0">CBigFile</a> &amp;<a class="code" href="classNLMISC_1_1CBigFile.html#d0">getInstance</a> ();
00053 
00054         <font class="comment">// Add a big file to the manager</font>
00055         <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CBigFile.html#a0">add</a> (<font class="keyword">const</font> std::string &amp;sBigFileName, uint32 nOptions);
00056 
00057         <font class="comment">// Remove a big file from the manager</font>
00058         <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBigFile.html#a1">remove</a> (<font class="keyword">const</font> std::string &amp;sBigFileName);
00059 
00060         <font class="comment">// true if a bigFile is added</font>
00061         <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CBigFile.html#a2">isBigFileAdded</a>(<font class="keyword">const</font> std::string &amp;sBigFileName);
00062 
00063         <font class="comment">// List all files in a bigfile</font>
00064         <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBigFile.html#a3">list</a> (<font class="keyword">const</font> std::string &amp;sBigFileName, std::vector&lt;std::string&gt; &amp;vAllFiles);
00065 
00066         <font class="comment">// Remove all big files added</font>
00067         <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CBigFile.html#a4">removeAll</a> ();
00068 
00069         <font class="comment">// Used by CIFile to get information about the files within the big file</font>
00070         FILE* <a class="code" href="classNLMISC_1_1CBigFile.html#a5">getFile</a> (<font class="keyword">const</font> std::string &amp;sFileName, uint32 &amp;rFileSize, uint32 &amp;rBigFileOffset, 
00071                                         <font class="keywordtype">bool</font> &amp;rCacheFileOnOpen, <font class="keywordtype">bool</font> &amp;rAlwaysOpened);
00072 
00073 <font class="comment">// ***************</font>
00074 <font class="keyword">private</font>:
00075         <font class="keyword">class   </font><a class="code" href="classNLMISC_1_1CBigFile.html#l0">CThreadFileArray</a>;
<a name="l00076"></a><a class="code" href="classNLMISC_1_1CBigFile.html#l0">00076</a>         <font class="keyword">friend</font> <font class="keyword">class    </font><a class="code" href="classNLMISC_1_1CBigFile.html#l0">CThreadFileArray</a>;
00077 
00078         <font class="comment">// A ptr to a file.</font>
<a name="l00079"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1CHandleFile.html">00079</a>         <font class="keyword">struct  </font>CHandleFile
00080         {
<a name="l00081"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1CHandleFile.html#m0">00081</a>                 FILE            *<a class="code" href="structNLMISC_1_1CBigFile_1_1CHandleFile.html#m0">File</a>;
<a name="l00082"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1CHandleFile.html#a0">00082</a>                 <a class="code" href="structNLMISC_1_1CBigFile_1_1CHandleFile.html#a0">CHandleFile</a>()
00083                 {
00084                         <a class="code" href="structNLMISC_1_1CBigFile_1_1CHandleFile.html#m0">File</a>= NULL;
00085                 }
00086         };
00087 
00088         <font class="comment">// A class which return a FILE * handle per Thread.</font>
<a name="l00089"></a><a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html">00089</a>         <font class="keyword">class   </font><a class="code" href="classNLMISC_1_1CBigFile.html#l0">CThreadFileArray</a>
00090         {
00091         <font class="keyword">public</font>:
00092                 <a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html#a0">CThreadFileArray</a>();
00093 
00094                 <font class="comment">// Allocate a FileId for a BNP.</font>
00095                 uint32                  <a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html#a1">allocate</a>();
00096                 <font class="comment">// Given a BNP File Id, return its FILE* handle for the current thread.</font>
00097                 CHandleFile             &amp;<a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html#a2">get</a>(uint32 <a class="code" href="driver__opengl__extension__def_8h.html#a358">index</a>);
00098 
00099         <font class="keyword">private</font>:
00100                 <font class="comment">// Do it this way because a few limited TDS is possible (64 on NT4)</font>
<a name="l00101"></a><a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html#o0">00101</a>                 CTDS            <a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html#o0">_TDS</a>;
00102                 <font class="comment">// The array is grow only!!</font>
<a name="l00103"></a><a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html#o1">00103</a>                 uint32          <a class="code" href="classNLMISC_1_1CBigFile_1_1CThreadFileArray.html#o1">_CurrentId</a>;
00104         };
00105 
00106         <font class="comment">// A BNPFile header</font>
<a name="l00107"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNPFile.html">00107</a>         <font class="keyword">struct </font>BNPFile
00108         {
<a name="l00109"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNPFile.html#m0">00109</a>                 uint32          <a class="code" href="structNLMISC_1_1CBigFile_1_1BNPFile.html#m0">Size</a>;
<a name="l00110"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNPFile.html#m1">00110</a>                 uint32          <a class="code" href="structNLMISC_1_1CBigFile_1_1BNPFile.html#m1">Pos</a>;
00111         };
00112 
00113         <font class="comment">// A BNP structure</font>
<a name="l00114"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html">00114</a>         <font class="keyword">struct </font>BNP
00115         {
00116                 <font class="comment">// FileName of the BNP. important to open it in getFile() (for other threads or if not always opened).</font>
<a name="l00117"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m0">00117</a>                 std::string                                             <a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m0">BigFileName</a>;
00118                 <font class="comment">// map of files in the BNP.</font>
<a name="l00119"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m1">00119</a>                 std::map&lt;std::string, BNPFile&gt;  <a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m1">Files</a>;
00120                 <font class="comment">// Since many seek may be done on a FILE*, each thread should have its own FILE opened.</font>
<a name="l00121"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m2">00121</a>                 uint32                                                  <a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m2">ThreadFileId</a>;
<a name="l00122"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m3">00122</a>                 <font class="keywordtype">bool</font>                                                    <a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m3">CacheFileOnOpen</a>;
<a name="l00123"></a><a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m4">00123</a>                 <font class="keywordtype">bool</font>                                                    <a class="code" href="structNLMISC_1_1CBigFile_1_1BNP.html#m4">AlwaysOpened</a>;
00124         };
00125 <font class="keyword">private</font>:
00126 
00127         <a class="code" href="classNLMISC_1_1CBigFile.html#c0">CBigFile</a>(); <font class="comment">// Singleton mode -&gt; access it with the getInstance function</font>
00128 
00129         <font class="keyword">static</font> <a class="code" href="classNLMISC_1_1CBigFile.html#c0">CBigFile</a>                         *<a class="code" href="classNLMISC_1_1CBigFile.html#r0">_Singleton</a>;
00130 
00131         <font class="comment">// This is an array of CHandleFile, unique to each thread</font>
<a name="l00132"></a><a class="code" href="classNLMISC_1_1CBigFile.html#o0">00132</a>         <a class="code" href="classNLMISC_1_1CBigFile.html#l0">CThreadFileArray</a>                        <a class="code" href="classNLMISC_1_1CBigFile.html#o0">_ThreadFileArray</a>;
00133 
<a name="l00134"></a><a class="code" href="classNLMISC_1_1CBigFile.html#o1">00134</a>         std::map&lt;std::string, BNP&gt; <a class="code" href="classNLMISC_1_1CBigFile.html#o1">_BNPs</a>;
00135 };
00136 
00137 } <font class="comment">// NLMISC</font>
00138 
00139 
00140 <font class="preprocessor">#endif // NL_BIG_FILE_H</font>
00141 <font class="preprocessor"></font>
00142 <font class="comment">/* End of big_file.h */</font>
</pre></div>

<!-- footer -->
<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
</TD>
<TD WIDTH=15><IMG  SRC=/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>