bitnestedarchivereader.hpp

/*
 * bit7z - A C++ static library to interface with the 7-zip shared libraries.
 * Copyright (c) Riccardo Ostani - All Rights Reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */
 
#ifndef BITNESTEDARCHIVEREADER_HPP
#define BITNESTEDARCHIVEREADER_HPP
 
#include "bitabstractarchiveopener.hpp"
#include "bitarchiveiteminfo.hpp"
#include "bitinputarchive.hpp"
 
namespace bit7z {

class BitNestedArchiveReader final : public BitAbstractArchiveOpener {
    public:
        BitNestedArchiveReader(
            const Bit7zLibrary& lib,
            const BitInputArchive& parentArchive,
            std::uint32_t index,
            const BitInFormat& format,
            const tstring& password = {}
        );

        BitNestedArchiveReader(
            const Bit7zLibrary& lib,
            const BitInputArchive& parentArchive,
            const BitInFormat& format,
            const tstring& password = {}
        );

        BIT7Z_NODISCARD
        auto maxMemoryUsage() const noexcept -> std::uint64_t;

        BIT7Z_NODISCARD
        auto detectedFormat() const noexcept -> const BitInFormat&;

        BIT7Z_NODISCARD
        auto archiveProperty( BitProperty property ) const -> BitPropVariant;

        BIT7Z_NODISCARD
        auto itemProperty( std::uint32_t index, BitProperty property ) const -> BitPropVariant;

        BIT7Z_NODISCARD
        auto itemsCount() const -> std::uint32_t;

        BIT7Z_NODISCARD
        auto items() const -> std::vector< BitArchiveItemInfo >;

        void extractTo( const tstring& outDir ) const;

        void extractTo( std::map< tstring, buffer_t >& outMap ) const;

        void test() const;

        BIT7Z_NODISCARD
        auto openCount() const -> std::size_t;

        void setMaxMemoryUsage( std::uint64_t value ) noexcept;
 
    private:
        BitInputArchive mNestedArchive;
        const BitInputArchive& mParentArchive;
        std::uint32_t mIndexInParent;
        std::uint64_t mMaxMemoryUsage;
 
        mutable std::uint32_t mCachedItemsCount;
        mutable std::uint32_t mLastReadItem; // TODO: Use std::optional< std::uint32_t > once we move to C++17
        mutable std::size_t mOpenCount;
 
        void openSequentially() const;
 
        BIT7Z_NODISCARD
        auto needReopen( std::uint32_t index = 0 ) const -> bool;
 
        BIT7Z_NODISCARD
        auto calculateItemsCount() const -> std::uint32_t;
};
 
} // namespace bit7z
 
#endif //BITNESTEDARCHIVEREADER_HPP