zipFile.h

//
// Copyright 2018 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_USD_USD_ZIP_FILE_H
#define PXR_USD_USD_ZIP_FILE_H

#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"

#include <memory>
#include <string>
#include <utility>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

class ArAsset;

class UsdZipFile
{
private:
    class _Impl;

public:
    USD_API
    static UsdZipFile Open(const std::string& filePath);

    USD_API
    static UsdZipFile Open(const std::shared_ptr<ArAsset>& asset);

    USD_API
    UsdZipFile();

    USD_API
    ~UsdZipFile();

    USD_API
    explicit operator bool() const { return static_cast<bool>(_impl); }

    class FileInfo
    {
    public:
        size_t dataOffset = 0;

        size_t size = 0;

        size_t uncompressedSize = 0;

        uint16_t compressionMethod = 0;

        bool encrypted = false;
    };

    class Iterator 
    {
        // Proxy type for operator->(), needed since this iterator's value
        // is generated on the fly.
        class _ArrowProxy
        {
        public:
            explicit _ArrowProxy(const std::string& s) : _s(s) { }
            const std::string* operator->() const { return &_s; }
        private:
            std::string _s;
        };

    public:
        USD_API
        Iterator();

        USD_API
        ~Iterator();

        USD_API
        Iterator(const Iterator& rhs);

        USD_API
        Iterator(Iterator&& rhs);

        USD_API
        Iterator& operator=(const Iterator& rhs);

        USD_API
        Iterator& operator=(Iterator&& rhs);

        using difference_type = std::ptrdiff_t;
        using value_type = std::string;
        using pointer = _ArrowProxy;
        using reference = std::string;
        using iterator_category = std::forward_iterator_tag;

        USD_API
        Iterator& operator++();
        USD_API
        Iterator operator++(int);

        USD_API
        bool operator==(const Iterator& rhs) const;
        USD_API
        bool operator!=(const Iterator& rhs) const;

        USD_API
        reference operator*() const;

        USD_API
        pointer operator->() const;

        USD_API
        const char* GetFile() const;

        USD_API
        FileInfo GetFileInfo() const;

    private:
        friend class UsdZipFile;
        Iterator(const _Impl* impl, size_t offset = 0);

        class _IteratorData;
        std::unique_ptr<_IteratorData> _data;
    };

    USD_API
    Iterator begin() const;

    Iterator cbegin() const { return begin(); }

    USD_API
    Iterator end() const;

    Iterator cend() const { return end(); }

    USD_API
    Iterator Find(const std::string& path) const;

    USD_API
    void DumpContents() const;

private:
    UsdZipFile(std::shared_ptr<_Impl>&& impl);

    std::shared_ptr<_Impl> _impl;
};

class UsdZipFileWriter
{
public:
    USD_API
    static UsdZipFileWriter CreateNew(const std::string& filePath);

    USD_API
    UsdZipFileWriter();

    USD_API
    ~UsdZipFileWriter();

    UsdZipFileWriter(const UsdZipFileWriter&) = delete;
    UsdZipFileWriter& operator=(const UsdZipFileWriter&) = delete;

    USD_API
    UsdZipFileWriter(UsdZipFileWriter&& rhs);
    USD_API
    UsdZipFileWriter& operator=(UsdZipFileWriter&& rhs);

    USD_API
    explicit operator bool() const { return static_cast<bool>(_impl); }

    USD_API
    std::string AddFile(const std::string& filePath,
                        const std::string& filePathInArchive = std::string());

    USD_API
    bool Save();

    USD_API
    void Discard();

private:
    class _Impl;
    UsdZipFileWriter(std::unique_ptr<_Impl>&& impl);

    std::unique_ptr<_Impl> _impl;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_USD_ZIP_FILE_H