bitabstractarchivehandler.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 BITABSTRACTARCHIVEHANDLER_HPP
#define BITABSTRACTARCHIVEHANDLER_HPP
 
#include "bit7zlibrary.hpp"
#include "bitdefines.hpp"
#include "bittypes.hpp"
 
#include <cstdint>
#include <functional>
 
namespace bit7z {
 
class BitInFormat;
class BitArchiveItem;

using TotalCallback = std::function< void( std::uint64_t ) >;

using ProgressCallback = std::function< bool( std::uint64_t ) >;

using RatioCallback = std::function< void( std::uint64_t, std::uint64_t ) >;

using FileCallback = std::function< void( const tstring& ) >;

using PasswordCallback = std::function< tstring() >;

using RawDataCallback = std::function< bool( const byte_t*, std::size_t ) >;

using RenameCallback = std::function< tstring( const BitArchiveItem& ) >;

using LegacyRenameCallback = std::function< tstring( std::uint32_t, const tstring& ) >;

using BufferCallback = std::function< buffer_t&( std::uint32_t, const tstring& ) >;

enum struct FilterResult : std::uint8_t {
    ProcessItem,    
    SkipItem,       
    AbortOperation, 
    BIT7Z_DEPRECATED_ENUMERATOR( Process, ProcessItem, "Use FilterResult::ProcessItem" ),
    BIT7Z_DEPRECATED_ENUMERATOR( Skip, SkipItem, "Use FilterResult::SkipItem" ),
    BIT7Z_DEPRECATED_ENUMERATOR( Abort, AbortOperation, "Use FilterResult::AbortOperation" ),
};

using FilterCallback = std::function< FilterResult( const BitArchiveItem& ) >;

enum struct OverwriteMode : std::uint8_t {
    None = 0,  
    Overwrite, 
    Skip,      
    //TODO:    RenameOutput,
    //TODO:    RenameExisting
};

enum struct FilterPolicy : std::uint8_t {
    Include, 
    Exclude  
};

class BitAbstractArchiveHandler {
    public:
        BitAbstractArchiveHandler( const BitAbstractArchiveHandler& ) = delete;
 
        BitAbstractArchiveHandler( BitAbstractArchiveHandler&& ) = delete;
 
        auto operator=( const BitAbstractArchiveHandler& ) -> BitAbstractArchiveHandler& = delete;
 
        auto operator=( BitAbstractArchiveHandler&& ) -> BitAbstractArchiveHandler& = delete;
 
        virtual ~BitAbstractArchiveHandler() = default;

        BIT7Z_NODISCARD auto library() const noexcept -> const Bit7zLibrary&;

        BIT7Z_NODISCARD virtual auto format() const noexcept -> const BitInFormat& = 0;

        BIT7Z_NODISCARD auto password() const -> const tstring&;

        BIT7Z_NODISCARD auto retainDirectories() const noexcept -> bool;

        BIT7Z_NODISCARD auto isPasswordDefined() const noexcept -> bool;

        BIT7Z_NODISCARD auto totalCallback() const -> const TotalCallback&;

        BIT7Z_NODISCARD auto progressCallback() const -> const ProgressCallback&;

        BIT7Z_NODISCARD auto ratioCallback() const -> const RatioCallback&;

        BIT7Z_NODISCARD auto fileCallback() const -> const FileCallback&;

        BIT7Z_NODISCARD auto passwordCallback() const -> const PasswordCallback&;

        BIT7Z_NODISCARD auto overwriteMode() const noexcept -> OverwriteMode;

        virtual void setPassword( const tstring& password );

        void clearPassword() noexcept;

        void setRetainDirectories( bool retain ) noexcept;

        void setTotalCallback( const TotalCallback& callback );

        void setProgressCallback( const ProgressCallback& callback );

        void setRatioCallback( const RatioCallback& callback );

        void setFileCallback( const FileCallback& callback );

        void setPasswordCallback( const PasswordCallback& callback );

        void setOverwriteMode( OverwriteMode mode );
 
    protected:
        explicit BitAbstractArchiveHandler(
            const Bit7zLibrary& lib,
            tstring password = {},
            OverwriteMode overwriteMode = OverwriteMode::None
        );
 
    private:
        const Bit7zLibrary& mLibrary;
        tstring mPassword;
        bool mRetainDirectories;
        OverwriteMode mOverwriteMode;
 
        //CALLBACKS
        TotalCallback mTotalCallback;
        ProgressCallback mProgressCallback;
        RatioCallback mRatioCallback;
        FileCallback mFileCallback;
        PasswordCallback mPasswordCallback;
};
 
} // namespace bit7z
 
#endif // BITABSTRACTARCHIVEHANDLER_HPP