csutil/vfshiercache.h Source File (Crystal Space 2.0 Public API Reference)

| ## Public API Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

csutil/vfshiercache.h
Go to the documentation of this file.

    00001 /*
    00002     Copyright (C) 2008 by Frank Richter
    00003
    00004     This library is free software; you can redistribute it and/or
    00005     modify it under the terms of the GNU Library General Public
    00006     License as published by the Free Software Foundation; either
    00007     version 2 of the License, or (at your option) any later version.
    00008
    00009     This library is distributed in the hope that it will be useful,
    00010     but WITHOUT ANY WARRANTY; without even the implied warranty of
    00011     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    00012     Library General Public License for more details.
    00013
    00014     You should have received a copy of the GNU Library General Public
    00015     License along with this library; if not, write to the Free
    00016     Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
    00017 */
    00018
    00019 #ifndef __CS_UTIL_VFSHIERCACHE_H__
    00020 #define __CS_UTIL_VFSHIERCACHE_H__
    00021
    00025 #include "csextern.h"
    00026 #include "iutil/cache.h"
    00027 #include "iutil/hiercache.h"
    00028 #include "csutil/csstring.h"
    00029 #include "csutil/scf_implementation.h"
    00030
    00031 struct iObjectRegistry;
    00032 struct iVFS;
    00033
    00034 namespace CS
    00035 {
    00036   namespace Utility
    00037   {
    00041     class CS_CRYSTALSPACE_EXPORT VfsHierarchicalCache :
    00042       public scfImplementation1<VfsHierarchicalCache, iHierarchicalCache>
    00043     {
    00044     private:
    00045       csRef<VfsHierarchicalCache> parent;
    00046       csString vfsdir;
    00047       csRef<iVFS> vfs;
    00048       bool readonly;
    00049
    00050       VfsHierarchicalCache (VfsHierarchicalCache* parentCache, const char* vfsdir);
    00051
    00053       void EnsureDirectories (const char* path);
    00055       void EnsureFile (const char* path);
    00057       bool RecursiveDelete (const char* path);
    00058     public:
    00063       VfsHierarchicalCache (iObjectRegistry* object_reg, const char* vfsdir);
    00064
    00065       virtual ~VfsHierarchicalCache ();
    00066
    00067       void SetReadOnly (bool ro) { readonly = ro; }
    00068       bool IsReadOnly () const { return readonly; }
    00069
    00072       virtual bool CacheData (const void* data, size_t size,
    00073         const char* path);
    00074       virtual csPtr<iDataBuffer> ReadCache (const char* path);
    00075       virtual bool ClearCache (const char* path);
    00076       virtual void Flush ();
    00077       virtual csPtr<iHierarchicalCache> GetRootedCache (const char* base);
    00078       virtual csPtr<iStringArray> GetSubItems (const char* path);
    00079       virtual iHierarchicalCache* GetTopCache();
    00080       virtual bool IsCacheWriteable() const { return !readonly; }
    00082     };
    00083   } // namespace Utility
    00084 } // namespace CS
    00085
    00086 #endif // __CS_UTIL_VFSHIERCACHE_H__
    00087