bitformat.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 BITFORMAT_HPP
#define BITFORMAT_HPP
 
#include "bitcompressionmethod.hpp"
#include "bitdefines.hpp"
#include "bittypes.hpp"
 
#include <cstdint>
 
namespace bit7z {

enum struct FormatFeatures : std::uint8_t {
    MultipleFiles    = 1u << 0u, 
    SolidArchive     = 1u << 1u, 
    CompressionLevel = 1u << 2u, 
    Encryption       = 1u << 3u, 
    HeaderEncryption = 1u << 4u, 
    MultipleMethods  = 1u << 5u  
};

constexpr auto operator|( FormatFeatures lhs, FormatFeatures rhs ) noexcept -> FormatFeatures {
    return static_cast< FormatFeatures >( to_underlying( lhs ) | to_underlying( rhs ) );
}

using FormatFeaturesType = underlying_type_t< FormatFeatures >;

constexpr auto operator&( FormatFeatures lhs, FormatFeatures rhs ) noexcept -> FormatFeaturesType {
    return to_underlying( lhs ) & to_underlying( rhs );
}

class BitInFormat {
    public:
        //non-copyable
        BitInFormat( const BitInFormat& other ) = delete;
 
        auto operator=( const BitInFormat& other ) -> BitInFormat& = delete;
 
        //non-movable
        BitInFormat( BitInFormat&& other ) = delete;
 
        auto operator=( BitInFormat&& other ) -> BitInFormat& = delete;
 
        ~BitInFormat() = default;

        constexpr explicit BitInFormat( unsigned char value ) noexcept : mValue( value ) {}

        BIT7Z_NODISCARD auto value() const noexcept -> unsigned char;

        auto operator==( BitInFormat const& other ) const noexcept -> bool;

        auto operator!=( BitInFormat const& other ) const noexcept -> bool;
 
    private:
        unsigned char mValue;
};

class BitInOutFormat final : public BitInFormat {
    public:
        constexpr BitInOutFormat(
            unsigned char value,
            const tchar* ext,
            BitCompressionMethod defaultMethod,
            FormatFeatures features
        ) noexcept : BitInFormat( value ), mExtension( ext ), mDefaultMethod( defaultMethod ), mFeatures( features ) {}
 
        //non-copyable
        BitInOutFormat( const BitInOutFormat& other ) = delete;
 
        auto operator=( const BitInOutFormat& other ) -> BitInOutFormat& = delete;
 
        //non-movable
        BitInOutFormat( BitInOutFormat&& other ) = delete;
 
        auto operator=( BitInOutFormat&& other ) -> BitInOutFormat& = delete;
 
        ~BitInOutFormat() = default;

        BIT7Z_NODISCARD
        auto extension() const noexcept -> const tchar*;

        BIT7Z_NODISCARD
        auto features() const noexcept -> FormatFeatures;

        BIT7Z_NODISCARD
        auto hasFeature( FormatFeatures feature ) const noexcept -> bool;

        BIT7Z_NODISCARD
        auto defaultMethod() const noexcept -> BitCompressionMethod;
 
    private:
        const tchar* mExtension;
        BitCompressionMethod mDefaultMethod;
        FormatFeatures mFeatures;
};

namespace BitFormat {
#ifdef BIT7Z_AUTO_FORMAT
extern const BitInFormat Auto;
#endif
extern const BitInFormat Rar;       
extern const BitInFormat Arj;       
//NOLINTNEXTLINE(*-identifier-length)
extern const BitInFormat Z;         
extern const BitInFormat Lzh;       
extern const BitInFormat Cab;       
extern const BitInFormat Nsis;      
extern const BitInFormat Lzma;      
extern const BitInFormat Lzma86;    
extern const BitInFormat Ppmd;      
extern const BitInFormat Zstd;      
extern const BitInFormat LVM;       
extern const BitInFormat AVB;       
extern const BitInFormat LP;        
extern const BitInFormat Sparse;    
extern const BitInFormat APFS;      
extern const BitInFormat Vhdx;      
extern const BitInFormat COFF;      
extern const BitInFormat Ext;       
extern const BitInFormat VMDK;      
extern const BitInFormat VDI;       
extern const BitInFormat QCow;      
extern const BitInFormat GPT;       
extern const BitInFormat Rar5;      
extern const BitInFormat IHex;      
extern const BitInFormat Hxs;       
//NOLINTNEXTLINE(*-identifier-length)
extern const BitInFormat TE;        
extern const BitInFormat UEFIc;     
extern const BitInFormat UEFIs;     
extern const BitInFormat SquashFS;  
extern const BitInFormat CramFS;    
extern const BitInFormat APM;       
extern const BitInFormat Mslz;      
extern const BitInFormat Flv;       
extern const BitInFormat Swf;       
extern const BitInFormat Swfc;      
extern const BitInFormat Ntfs;      
extern const BitInFormat Fat;       
extern const BitInFormat Mbr;       
extern const BitInFormat Vhd;       
//NOLINTNEXTLINE(*-identifier-length)
extern const BitInFormat Pe;        
extern const BitInFormat Elf;       
extern const BitInFormat Macho;     
extern const BitInFormat Udf;       
extern const BitInFormat Xar;       
extern const BitInFormat Mub;       
extern const BitInFormat Hfs;       
extern const BitInFormat Dmg;       
extern const BitInFormat Compound;  
extern const BitInFormat Iso;       
extern const BitInFormat Chm;       
extern const BitInFormat Split;     
extern const BitInFormat Rpm;       
extern const BitInFormat Deb;       
extern const BitInFormat Cpio;      
 
extern const BitInOutFormat Zip;        
extern const BitInOutFormat BZip2;      
extern const BitInOutFormat SevenZip;   
//NOLINTNEXTLINE(*-identifier-length)
extern const BitInOutFormat Xz;         
extern const BitInOutFormat Wim;        
extern const BitInOutFormat Tar;        
extern const BitInOutFormat GZip;       
}  // namespace BitFormat
 
#ifdef BIT7Z_AUTO_FORMAT
#define BIT7Z_DEFAULT_FORMAT = BitFormat::Auto
#else
#define BIT7Z_DEFAULT_FORMAT
#endif
 
} // namespace bit7z
 
#endif // BITFORMAT_HPP