FileSearchZip.h

Go to the documentation of this file.

/*********************************************************\
 *  File: FileSearchZip.h                                *
 *
 *  Copyright (C) 2002-2011 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight 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 PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLCORE_FILESEARCH_ZIP_H__
#define __PLCORE_FILESEARCH_ZIP_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLCore/File/ZipHandle.h"
#include "PLCore/File/FileSearchImpl.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLCore {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    ZIP implementation of 'FileSearchImpl'
*/
class FileSearchZip : public FileSearchImpl {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class FileSearch;
    friend class FileZip;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] sZipFile
        *    Path to the ZIP-file
        *  @param[in] sPathInZip
        *    Path inside the ZIP-file
        *  @param[in] pAccess
        *    Additional file access information (can be a null pointer)
        *
        *  @note
        *    - sPathInZip *must* end with '/'!
        */
        FileSearchZip(const String &sZipFile, const String &sPathInZip, const FileAccess *pAccess);

        /**
        *  @brief
        *    Destructor
        */
        virtual ~FileSearchZip();


    //[-------------------------------------------------------]
    //[ Private virtual FileSearchImpl functions              ]
    //[-------------------------------------------------------]
    private:
        virtual bool HasNextFile() override;
        virtual String GetNextFile() override;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Find next file in the selected directory
        */
        bool FindNextFile();
        bool CheckFile(const String &sFilename);


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        String    m_sZipFile;   /**< File name of ZIP-file */
        String    m_sPathInZip; /**< Path inside the ZIP-file */
        ZipHandle m_cZipFile;   /**< ZIP file handle */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLCore


#endif // __PLCORE_FILESEARCH_ZIP_H__