base/ResourceCache

Go to the documentation of this file.

/****************************************************************************
  Copyright (C)1996 David Jung <opensim@pobox.com>

  This program/file is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
  
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details. (http://www.gnu.org)
  
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  
  $Id: ResourceCache 1029 2004-02-11 20:45:54Z jungd $
  $Revision: 1.3 $
  $Date: 2004-02-11 15:45:54 -0500 (Wed, 11 Feb 2004) $
  $Author: jungd $
 
****************************************************************************/

#ifndef _BASE_RESOURCECACHE_
#define _BASE_RESOURCECACHE_

#include <base/base>
#include <base/ReferencedObject>
#include <base/PathName>
#include <base/VFileSystem>


namespace base {


class ResourceCache : public ReferencedObject
{
public:
  explicit ResourceCache(ref<VFileSystem> fs, const PathName& resourceDirectory, const PathName& cacheDirectory);
  virtual ~ResourceCache();

  virtual PathName resourceDirectory() const { return _resourceDirectory; }
  virtual PathName cacheDirectory() const { return _cacheDirectory; }

  virtual ref<VFile>      getFile(const PathName& name)  throw (path_not_found, io_error) = 0; ///< obtain a file (relative paths are w.r.t. the current directory)
  /// obtain a file (looks in the resource tree, current directory & the optional path provided)
  virtual ref<VFile>      findFile(const PathName& name, const PathName& additionalPath=PathName()) throw (path_not_found, io_error) = 0;
  virtual bool            isCached(const PathName& name) throw (path_not_found, io_error) = 0; ///< is there a resource cache directory associated with this file
  virtual ref<VDirectory> getCache(const PathName& name) throw (path_not_found, io_error) = 0; ///< obtain resource cache directory associated with a file (possibly empty)

protected:
  PathName _resourceDirectory;
  PathName _cacheDirectory;
  ref<VFileSystem> filesystem;

  ResourceCache(const ResourceCache& c);

private:

};


} // base

#endif

---