o3de/Code/Tools/CryCommonTools/ZipDir/ZipDirList.h

/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

#ifndef CRYINCLUDE_CRYCOMMONTOOLS_ZIPDIR_ZIPDIRLIST_H
#define CRYINCLUDE_CRYCOMMONTOOLS_ZIPDIR_ZIPDIRLIST_H
#pragma once

#include <smartptr.h>

namespace ZipDir
{
    // this is the array of file entries that's convenient to use to construct CDR
    struct FileRecord
    {
        string strPath; // relative path to the file inside zip
        FileEntry* pFileEntry; // the file entry itself

        void ConstructFileRecord()
        {
            new (&strPath)string();
        }
    };

    struct FileDataRecord
        : public FileRecord
    {
        FileDataRecord() { m_nRefCount = 0; }
        void AddRef() { ++m_nRefCount; }
        void Release()
        {
            if (--m_nRefCount <= 0)
            {
                Delete();
            }
        }

        void Delete()
        {
            free (this);
        }

        static FileDataRecord* New(const FileRecord& rThat)
        {
            FileDataRecord* pThis = (FileDataRecord*)malloc(sizeof(FileDataRecord) + rThat.pFileEntry->desc.lSizeCompressed);

            if (pThis)
            {
                pThis->m_nRefCount = 0;
                pThis->ConstructFileRecord();
                *static_cast<FileRecord*>(pThis) = rThat;
            }
            return pThis;
        }

        void* GetData() {return this + 1; }

        volatile signed int m_nRefCount; // the reference count
    };

    TYPEDEF_AUTOPTR(FileDataRecord);
    typedef FileDataRecord_AutoPtr FileDataRecordPtr;

    struct FileRecordFileOffsetOrder
    {
        bool operator () (const FileRecord& left, const FileRecord& right)
        {
            return left.pFileEntry->nFileHeaderOffset < right.pFileEntry->nFileHeaderOffset;
        }
    };

    // this is used for construction of CDR
    class FileRecordList
        : public std::vector<FileRecord>
    {
    public:
        FileRecordList(class FileEntryTree* pTree);

        struct ZipStats
        {
            // the size of the CDR in the file
            size_t nSizeCDR;
            // the size of the file data part (local file descriptors and file datas)
            // if it's compacted
            size_t nSizeCompactData;
        };

        // sorts the files by the physical offset in the zip file
        void SortByFileOffset ();

        // returns the size of CDR in the zip file
        ZipStats GetStats() const;

        // puts the CDR into the given block of mem
        size_t MakeZipCDR(ZipFile::ulong lCDROffset, void* p, bool encryptedFlag) const;

        void Backup(std::vector<FileEntry>& arrFiles) const;
        void Restore(const std::vector<FileEntry>& arrFiles);

    protected:
        // recursively adds the files from this directory and subdirectories
        // the strRoot contains the trailing slash
        void AddAllFiles(class FileEntryTree* pTree, string strRoot = string());
    };


    struct FileEntryFileOffsetOrder
    {
        bool operator () (FileEntry* pLeft, FileEntry* pRight) const
        {
            return pLeft->nFileHeaderOffset < pRight->nFileHeaderOffset;
        }
    };

    // this is used for refreshing EOFOffsets
    class FileEntryList
        : public std::set<FileEntry*, FileEntryFileOffsetOrder>
    {
    public:
        FileEntryList (class FileEntryTree* pTree, unsigned lCDROffset);
        // updates each file entry's info about the next file entry
        void RefreshEOFOffsets();
    protected:
        void Add (class FileEntryTree* pTree);
        unsigned m_lCDROffset;
    };
}

#endif // CRYINCLUDE_CRYCOMMONTOOLS_ZIPDIR_ZIPDIRLIST_H