A C++ static library offering a clean and simple interface to the 7-zip shared libraries

⚡️ Introduction

🎯 Supported Features

Notes

🔥 Getting Started (Library Usage)

📂 Extracting Files from an Archive

#include<bit7z/bitfileextractor.hpp>try {// bit7z classes can throw BitException objectsusingnamespacebit7z;    Bit7zLibrary lib{"7za.dll" };    BitFileExtractor extractor{ lib, BitFormat::SevenZip };// Extracting a simple archive    extractor.extract("path/to/archive.7z","out/dir/" );// Extracting a specific file inside an archive    extractor.extractMatching("path/to/archive.7z","file.pdf","out/dir/" );// Extracting the first file of an archive to a buffer    std::vector<byte_t > buffer;    extractor.extract("path/to/archive.7z", buffer );// Extracting an encrypted archive    extractor.setPassword("password" );    extractor.extract("path/to/another/archive.7z","out/dir/" );}catch (const bit7z::BitException& ex ) {/* Do something with ex.what()...*/ }

#include<bit7z/bitarchivereader.hpp>try {// bit7z classes can throw BitException objectsusingnamespacebit7z;    Bit7zLibrary lib{"7z.dll" };// Opening the archive    BitArchiveReader archive{ lib,"path/to/archive.gz", BitFormat::GZip };// Testing the archive    archive.test();// Extracting the archive    archive.extractTo("out/dir/" );}catch (const bit7z::BitException& ex ) {/* Do something with ex.what()...*/ }

💼 Compressing Files into an Archive

#include<bit7z/bitfilecompressor.hpp>try {// bit7z classes can throw BitException objectsusingnamespacebit7z;    Bit7zLibrary lib{"7z.dll" };    BitFileCompressor compressor{ lib, BitFormat::Zip };    std::vector< std::string > files = {"path/to/file1.jpg","path/to/file2.pdf" };// Creating a simple zip archive    compressor.compress( files,"output_archive.zip" );// Creating a zip archive with a custom directory structure    std::map< std::string, std::string > files_map = {        {"path/to/file1.jpg","alias/path/file1.jpg" },        {"path/to/file2.pdf","alias/path/file2.pdf" }    };    compressor.compress( files_map,"output_archive2.zip" );// Compressing a directory    compressor.compressDirectory("dir/path/","dir_archive.zip" );// Creating an encrypted zip archive of two files    compressor.setPassword("password" );    compressor.compressFiles( files,"protected_archive.zip" );// Updating an existing zip archive    compressor.setUpdateMode( UpdateMode::Append );    compressor.compressFiles( files,"existing_archive.zip" );// Compressing a single file into a buffer    std::vector< bit7z::byte_t > buffer;    BitFileCompressor compressor2{ lib, BitFormat::BZip2 };    compressor2.compressFile( files[0], buffer );}catch (const bit7z::BitException& ex ) {/* Do something with ex.what()...*/ }

#include<bit7z/bitarchivewriter.hpp>try {// bit7z classes can throw BitException objectsusingnamespacebit7z;    Bit7zLibrary lib{"7z.dll" };    BitArchiveWriter archive{ lib, BitFormat::SevenZip };// Adding the items to be compressed (no compression is performed here)    archive.addFile("path/to/file.txt" );    archive.addDirectory("path/to/dir/" );// Compressing the added items to the output archive    archive.compressTo("output.7z" );}catch (const bit7z::BitException& ex ) {/* Do something with ex.what()...*/ }

📑 Reading Archive Metadata

#include<bit7z/bitarchivereader.hpp>try {// bit7z classes can throw BitException objectsusingnamespacebit7z;    Bit7zLibrary lib{"7za.dll" };    BitArchiveReader arc{ lib,"archive.7z", BitFormat::SevenZip };// Printing archive metadata    std::cout <<"Archive properties\n";    std::cout <<"  Items count:"   << arc.itemsCount() <<'\n';    std::cout <<"  Folders count:" << arc.foldersCount() <<'\n';    std::cout <<"  Files count:"   << arc.filesCount() <<'\n';    std::cout <<"  Size:"          << arc.size() <<'\n';    std::cout <<"  Packed size:"   << arc.packSize() <<"\n\n";// Printing the metadata of the archived items    std::cout <<"Archived items";for (constauto& item : arc ) {        std::cout <<'\n';        std::cout <<"  Item index:"    << item.index() <<'\n';        std::cout <<"    Name:"        << item.name() <<'\n';        std::cout <<"    Extension:"   << item.extension() <<'\n';        std::cout <<"    Path:"        << item.path() <<'\n';        std::cout <<"    IsDir:"       << item.isDir() <<'\n';        std::cout <<"    Size:"        << item.size() <<'\n';        std::cout <<"    Packed size:" << item.packSize() <<'\n';        std::cout <<"    CRC:" << std::hex << item.crc() << std::dec <<'\n';    }    std::cout.flush();}catch (const bit7z::BitException& ex ) {/* Do something with ex.what()...*/ }

🚀 Upgrading from bit7z v3 to v4

💾 Download

🧰 Requirements

⚙️ Building and Using bit7z

cd<bit7z folder>mkdir build&&cd buildcmake ../ -DCMAKE_BUILD_TYPE=Releasecmake --build. -j --config Release

add_subdirectory(${CMAKE_SOURCE_DIR}/third_party/bit7z )target_link_libraries(${YOUR_TARGET}PRIVATE bit7z )

📑 7-zip Version

Using 7-zip v23.01 on Linux and macOS

🌐 String Encoding

☕️ Donate

📜 License