Mercurial > fife-parpg
diff engine/core/vfs/directoryprovider.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/directoryprovider.h Sun Jun 29 18:44:17 2008 +0000 @@ -0,0 +1,68 @@ +/*************************************************************************** + * 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_DIRECTORYPROVIDER_H +#define FIFE_VFS_DIRECTORYPROVIDER_H + +// Standard C++ library includes +#include <string> + +// 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 "vfssourceprovider.h" + +namespace FIFE { + + class VFSSource; + + /** Provider for OS directories. + */ + class DirectoryProvider : public VFSSourceProvider { + public: + DirectoryProvider() : VFSSourceProvider("OS Directory") { } + + /** Check if a given directory is readable for this VFSSource. + * Directory sources must be denoted by a trailing '/', otherwise VFS will consider + * the source to be a file, and unreadable asa a directory. + * + * @param file the filename to check + * @return true if readable, false otherwise + */ + virtual bool isReadable(const std::string& path) const; + + /** Create a new instance of a VFSSource initialized with the given directory + * + * @param file the directory to open + * @return the new VFSSource + */ + virtual VFSSource* createSource(const std::string& path) const; + + private: + std::string m_name; + + }; +} + +#endif