Mercurial > fife-parpg
diff engine/core/vfs/vfsdirectory.h @ 0:4a0efb7baf70
* Datasets becomes the new trunk and retires after that :-)
author | mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222 |
---|---|
date | Sun, 29 Jun 2008 18:44:17 +0000 |
parents | |
children | 90005975cdbb |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/engine/core/vfs/vfsdirectory.h Sun Jun 29 18:44:17 2008 +0000 @@ -0,0 +1,88 @@ +/*************************************************************************** + * Copyright (C) 2005-2008 by the FIFE team * + * http://www.fifengine.de * + * This file is part of FIFE. * + * * + * FIFE 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. * + * * + * 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., * + * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * + ***************************************************************************/ + +#ifndef FIFE_VFS_VFSHOSTSYSTEM_H +#define FIFE_VFS_VFSHOSTSYSTEM_H + +// Standard C++ library includes + +// 3rd party library includes + +// FIFE includes +// These includes are split up in two parts, separated by one empty line +// First block: files included from the FIFE root src directory +// Second block: files included from the same folder +#include "vfssource.h" + +namespace FIFE { + + /** The most basic VFSSource for "normal" filesystems. + * For example, '/' or './tests/data'. + * + * Uses boost_filesystem to achieve Plattform independancy. + * This also means you have to use slashes as directory + * separators. + */ + class VFSDirectory : public VFSSource { + public: + /** Constructor + * Creates the given file system's VFS Source, Uses boost_filesystem to + * achieve Plattform independancy. + */ + VFSDirectory(VFS* vfs, const std::string& root = "./"); + /** Destructor + */ + virtual ~VFSDirectory(); + + /** Tests whether a file can be opened. + * @param filename The file to test. + * @return True, if the file filename can be opened. + */ + virtual bool fileExists(const std::string& filename) const; + /** Opens a file. + * @param filename The file to open. + */ + virtual RawData* open(const std::string& filename) const; + + /** List files in a directory + * @param path The directory to list the files in + * @return A string list of filenames + * Will return an empty list on \b any error + */ + std::set<std::string> listFiles(const std::string& path) const; + + /** List directories in a directory + * @param path The directory to list the directories in + * @return A string list of directories + * Will return an empty list on \b any error + */ + std::set<std::string> listDirectories(const std::string& path) const; + + private: + std::string m_root; + + std::set<std::string> list(const std::string& path, bool directorys) const; + + }; + +} + +#endif