bitabstractarchivehandler.hpp

/*
 * bit7z - A C++ static library to interface with the 7-zip shared libraries.
 * Copyright (c) 2014-2023 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 <cstdint>
#include <functional>
 
#include "bit7zlibrary.hpp"
#include "bitdefines.hpp"
 
namespace bit7z {
 
class BitInFormat;
 
using TotalCallback = std::function< void( uint64_t ) >;
 
using ProgressCallback = std::function< bool( uint64_t ) >;
 
using RatioCallback = std::function< void( uint64_t, uint64_t ) >;
 
using FileCallback = std::function< void( tstring ) >;
 
using PasswordCallback = std::function< tstring() >;
 
enum struct OverwriteMode {
    None = 0, 
    Overwrite, 
    Skip, 
//TODO:    RenameOutput,
//TODO:    RenameExisting
};
 
enum struct FilterPolicy {
    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 -> const BitInFormat& = 0;
 
        BIT7Z_NODISCARD auto password() const -> tstring;
 
        BIT7Z_NODISCARD auto retainDirectories() const noexcept -> bool;
 
        BIT7Z_NODISCARD auto isPasswordDefined() const noexcept -> bool;
 
        BIT7Z_NODISCARD auto totalCallback() const -> TotalCallback;
 
        BIT7Z_NODISCARD auto progressCallback() const -> ProgressCallback;
 
        BIT7Z_NODISCARD auto ratioCallback() const -> RatioCallback;
 
        BIT7Z_NODISCARD auto fileCallback() const -> FileCallback;
 
        BIT7Z_NODISCARD auto passwordCallback() const -> PasswordCallback;
 
        BIT7Z_NODISCARD auto overwriteMode() const -> 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