| 1 |
/*************************************************************************** |
| 2 |
* Copyright (C) 2005-2019 by the FIFE team * |
| 3 |
* http://www.fifengine.net * |
| 4 |
* This file is part of FIFE. * |
| 5 |
* * |
| 6 |
* FIFE is free software; you can redistribute it and/or * |
| 7 |
* modify it under the terms of the GNU Lesser General Public * |
| 8 |
* License as published by the Free Software Foundation; either * |
| 9 |
* version 2.1 of the License, or (at your option) any later version. * |
| 10 |
* * |
| 11 |
* This library is distributed in the hope that it will be useful, * |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of * |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * |
| 14 |
* Lesser General Public License for more details. * |
| 15 |
* * |
| 16 |
* You should have received a copy of the GNU Lesser General Public * |
| 17 |
* License along with this library; if not, write to the * |
| 18 |
* Free Software Foundation, Inc., * |
| 19 |
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * |
| 20 |
***************************************************************************/ |
| 21 |
#ifndef FIFE_VFS_ZIP_ZIPTREE_H |
| 22 |
#define FIFE_VFS_ZIP_ZIPTREE_H |
| 23 |
|
| 24 |
// Standard C++ library includes |
| 25 |
#include <string> |
| 26 |
#include <vector> |
| 27 |
#include <ostream> |
| 28 |
|
| 29 |
// 3rd party library includes |
| 30 |
|
| 31 |
// FIFE includes |
| 32 |
// These includes are split up in two parts, separated by one empty line |
| 33 |
// First block: files included from the FIFE root src directory |
| 34 |
// Second block: files included from the same folder |
| 35 |
|
| 36 |
|
| 37 |
namespace FIFE { |
| 38 |
|
| 39 |
class ZipNode; |
| 40 |
|
| 41 |
class ZipTree { |
| 42 |
public: |
| 43 |
/** constructor |
| 44 |
*/ |
| 45 |
ZipTree(); |
| 46 |
|
| 47 |
/** destructor |
| 48 |
*/ |
| 49 |
~ZipTree(); |
| 50 |
|
| 51 |
/** adds a node to the proper place in the tree |
| 52 |
* based on the node path name |
| 53 |
* @param nodePath the node description |
| 54 |
* @return ZipNode of the most derived path added |
| 55 |
(value after the last path separator) |
| 56 |
or NULL if the path could not be added |
| 57 |
*/ |
| 58 |
ZipNode* addNode(const std::string& nodePath); |
| 59 |
|
| 60 |
/** accessor for getting a node by name |
| 61 |
* @param name the name to search for |
| 62 |
* @ param ZipNode pointer, or NULL if not found |
| 63 |
*/ |
| 64 |
ZipNode* getNode(const std::string& name) const; |
| 65 |
|
| 66 |
/** accessor for the root node of the tree |
| 67 |
* mostly used for debugging purposes |
| 68 |
* @return ZipNode pointer to the root node |
| 69 |
*/ |
| 70 |
ZipNode* getRootNode() const; |
| 71 |
private: |
| 72 |
ZipNode* m_rootNode; |
| 73 |
}; |
| 74 |
} |
| 75 |
|
| 76 |
/** debug stream for a zip tree |
| 77 |
* useful for debugging |
| 78 |
* @param os output stream |
| 79 |
* @param zipTree the ZipTree to output |
| 80 |
* @return os output stream to allow for chaining |
| 81 |
*/ |
| 82 |
std::ostream& operator<<(std::ostream& os, const FIFE::ZipTree& zipTree); |
| 83 |
|
| 84 |
|
| 85 |
#endif |