<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csutil/vfscache.h Source File (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<h1>csutil/vfscache.h</h1><a href="vfscache_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2002 by Jorrit Tyberghein</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span>
<a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"> </span>
<a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"> </span>
<a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span>
<a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span>
<a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_UTIL_VFSCACHE_H__</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_UTIL_VFSCACHE_H__</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "csextern.h"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="cache_8h.html" title="Cache manager interface.">iutil/cache.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="csstring_8h.html" title="String utility class.">csutil/csstring.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="scf__implementation_8h.html" title="Crystal Space Shared Class Facility (SCF) - implementation creation support.">csutil/scf_implementation.h</a>"</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">struct </span><a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>;
<a name="l00031"></a>00031 <span class="keyword">struct </span><a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>;
<a name="l00032"></a>00032
<a name="l00036"></a><a class="code" href="classcsVfsCacheManager.html">00036</a> <span class="keyword">class </span>CS_CRYSTALSPACE_EXPORT <a class="code" href="classcsVfsCacheManager.html" title="This is a general cache that can cache data on VFS.">csVfsCacheManager</a> :
<a name="l00037"></a>00037 <span class="keyword">public</span> <a class="code" href="classscfImplementation1.html">scfImplementation1</a><csVfsCacheManager, iCacheManager>
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039 <span class="keyword">private</span>:
<a name="l00040"></a>00040 <a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>* object_reg;
<a name="l00041"></a>00041 <span class="keywordtype">char</span>* vfsdir;
<a name="l00042"></a>00042 <a class="code" href="classcsRef.html" title="A smart pointer.">csRef<iVFS></a> vfs;
<a name="l00043"></a>00043 <span class="keywordtype">char</span>* current_type;
<a name="l00044"></a>00044 <span class="keywordtype">char</span>* current_scope;
<a name="l00045"></a>00045 <span class="keywordtype">bool</span> readonly;
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <a class="code" href="structiVFS.html" title="The Virtual Filesystem Class is intended to be the only way for Crystal Space engine...">iVFS</a>* GetVFS ();
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keywordtype">void</span> CacheName (<a class="code" href="classcsStringFast.html" title="Subclass of csStringBase that contains an internal buffer which is faster than the...">csStringFast<512></a>& buf, <span class="keyword">const</span> <span class="keywordtype">char</span>* type, <span class="keyword">const</span> <span class="keywordtype">char</span>* scope,
<a name="l00050"></a>00050 <a class="code" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e" title="unsigned 32-bit integer (0..4 294 967 295)">uint32</a> <span class="keywordtype">id</span>);
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00057"></a>00057 <a class="code" href="classcsVfsCacheManager.html" title="This is a general cache that can cache data on VFS.">csVfsCacheManager</a> (<a class="code" href="structiObjectRegistry.html" title="This interface serves as a registry of other objects.">iObjectRegistry</a>* object_reg, <span class="keyword">const</span> <span class="keywordtype">char</span>* vfsdir);
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keyword">virtual</span> ~<a class="code" href="classcsVfsCacheManager.html" title="This is a general cache that can cache data on VFS.">csVfsCacheManager</a> ();
<a name="l00060"></a>00060
<a name="l00061"></a>00061
<a name="l00062"></a><a class="code" href="classcsVfsCacheManager.html#37027ad3efed70589a378920b6c808ef">00062</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetReadOnly (<span class="keywordtype">bool</span> ro) { readonly = ro; }
<a name="l00063"></a><a class="code" href="classcsVfsCacheManager.html#4024c7cfb5a6b10275538943f1d45c28">00063</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> IsReadOnly ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> readonly; }
<a name="l00064"></a>00064
<a name="l00068"></a>00068 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetCurrentType (<span class="keyword">const</span> <span class="keywordtype">char</span>* type);
<a name="l00072"></a><a class="code" href="classcsVfsCacheManager.html#beaf915c611af5992efb6c65d11a6f8d">00072</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetCurrentType ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current_type; }
<a name="l00076"></a>00076 <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetCurrentScope (<span class="keyword">const</span> <span class="keywordtype">char</span>* scope);
<a name="l00080"></a><a class="code" href="classcsVfsCacheManager.html#d2aee76ef0d1e381fc473bf810991648">00080</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* GetCurrentScope ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> current_scope; }
<a name="l00084"></a>00084 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> CacheData (<span class="keyword">const</span> <span class="keywordtype">void</span>* data, <span class="keywordtype">size_t</span> size,
<a name="l00085"></a>00085 <span class="keyword">const</span> <span class="keywordtype">char</span>* type, <span class="keyword">const</span> <span class="keywordtype">char</span>* scope, <a class="code" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e" title="unsigned 32-bit integer (0..4 294 967 295)">uint32</a> <span class="keywordtype">id</span>);
<a name="l00090"></a>00090 <span class="keyword">virtual</span> <a class="code" href="classcsPtr.html" title="A pointer encapsulator.">csPtr<iDataBuffer></a> ReadCache (<span class="keyword">const</span> <span class="keywordtype">char</span>* type, <span class="keyword">const</span> <span class="keywordtype">char</span>* scope,
<a name="l00091"></a>00091 <a class="code" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e" title="unsigned 32-bit integer (0..4 294 967 295)">uint32</a> <span class="keywordtype">id</span>);
<a name="l00095"></a>00095 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ClearCache (<span class="keyword">const</span> <span class="keywordtype">char</span>* type = 0, <span class="keyword">const</span> <span class="keywordtype">char</span>* scope = 0,
<a name="l00096"></a>00096 <span class="keyword">const</span> <a class="code" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e" title="unsigned 32-bit integer (0..4 294 967 295)">uint32</a>* <span class="keywordtype">id</span> = 0);
<a name="l00097"></a>00097
<a name="l00101"></a>00101 <span class="keyword">virtual</span> <span class="keywordtype">void</span> Flush ();
<a name="l00102"></a>00102 };
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="preprocessor">#endif // __CS_UTIL_VFSCACHE_H__</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span>
</pre></div><hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
4043
