zipnode.h

Go to the documentation of this file.

/***************************************************************************
*   Copyright (C) 2005-2019 by the FIFE team                              *
*   http://www.fifengine.net                                              *
*   This file is part of FIFE.                                            *
*                                                                         *
*   FIFE is free software; you can redistribute it and/or                 *
*   modify it under the terms of the GNU Lesser General Public            *
*   License as published by the Free Software Foundation; either          *
*   version 2.1 of the License, or (at your option) any later version.    *
*                                                                         *
*   This library 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     *
*   Lesser General Public License for more details.                       *
*                                                                         *
*   You should have received a copy of the GNU Lesser General Public      *
*   License along with this library; if not, write to the                 *
*   Free Software Foundation, Inc.,                                       *
*   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
***************************************************************************/
#ifndef FIFE_VFS_ZIP_ZIPNODE_H
#define FIFE_VFS_ZIP_ZIPNODE_H

// Standard C++ library includes
#include <string>
#include <vector>
#include <ostream>

// 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 "util/base/fife_stdint.h"

namespace FIFE {

    struct ZipContentType {
        enum Enum
        {
            File = 0,       // specifies files as content type
            Directory,      // specifies directories as content type
            All             // specifies everything as content type (no filter)
        };
    };

    struct ZipEntryData {
        ZipEntryData();

        uint16_t comp;
        uint32_t crc32;
        uint32_t size_comp;
        uint32_t size_real;
        uint32_t offset;
    };

    // convenience typedef
    class ZipNode;
    typedef std::vector<ZipNode*> ZipNodeContainer;

    class ZipNode {
    public:
        ZipNode(const std::string& name, ZipNode* parent=0);

        ~ZipNode();

        std::string getName() const;

        std::string getFullName() const;

        ZipContentType::Enum getContentType() const;

        ZipNode* getParent() const;

        std::vector<ZipNode*> getChildren(ZipContentType::Enum contentType=ZipContentType::All) const;

        ZipNode* getChild(const std::string& name,
                          ZipContentType::Enum contentType=ZipContentType::All) const;

        ZipNode* addChild(const std::string& child);

        void removeChild(ZipNode* child);

        void removeChild(const std::string& name);

        bool isLeaf() const;

        bool isBranch() const;

        void setZipEntryData(const ZipEntryData& entryData);

        const ZipEntryData& getZipEntryData() const;

    private:
        std::string m_name;
        ZipContentType::Enum m_contentType;
        ZipEntryData m_entryData;

        ZipNode* m_parent;
        ZipNodeContainer m_fileChildren;
        ZipNodeContainer m_directoryChildren;
    };
}

std::ostream& operator<<(std::ostream& os, const FIFE::ZipNode& node);

#endif