Features / detailed description

Optional features

Installation

Swift Package Manager

.package(url:"https://github.com/OlehKulykov/PLzmaSDK.git",.exact("1.5.0"))

CocoaPods Podfile (Swift)

use_frameworks!platform:ios,'11.0'target'<REPLACE_WITH_YOUR_TARGET>'dopod'PLzmaSDK','1.5.0'end

CocoaPods Podfile (Objective-C)

use_frameworks!platform:ios,'9.0'target'<REPLACE_WITH_YOUR_TARGET>'dopod'PLzmaSDK-ObjC','1.5.0'end

npm via 'package.json'

{"engines": {"node":">=13.0.0","npm":">=6.0.0"  },"dependencies": {"plzmasdk":"1.5.0"  }}

Android NDK

cd<PATH_TO_ANDROID_NDK>./ndk-build NDK_PROJECT_PATH=<PATH_TO_PLZMASDK>/PLzmaSDK/android

CMake Unix

cd PLzmaSDKmkdir buildcd buildcmake -DCMAKE_BUILD_TYPE=Release ..make -j4

CMake Windows (MSVC)

cd PLzmaSDKmd buildcd buildcmake -DCMAKE_BUILD_TYPE=Release ..cmake --build. --config Release --parallel 4

CMake Windows (MinGW)

...cmake -G"MinGW Makefiles" -DCMAKE_MAKE_PROGRAM=mingw32-make -DCMAKE_CXX_COMPILER=g++ -DCMAKE_C_COMPILER=gcc -DCMAKE_BUILD_TYPE=Release ..cmake --build. --config Release --parallel 4

Examples

Extract or test

Open, list and select archive items for extracting or testing.

Swift

do{    // 1. Create a source input stream for reading archive file content.    //  1.1. Create a source input stream with the path to an archive file.letarchivePath=tryPath("path/to/archive.7z")letarchivePathInStream=tryInStream(path: archivePath)    //  1.2. Create a source input stream with the file content.letarchiveData=Data(...)letarchiveDataInStream=tryInStream(dataNoCopy: archiveData) // also available Data(dataCopy: Data)    // 2. Create decoder with source input stream, type of archive and optional delegate.letdecoder=tryDecoder(stream: archiveDataInStream /* archivePathInStream */, fileType:.sevenZ, delegate:self)        //  2.1. Optionaly provide the password to open/list/test/extract encrypted archive items.try decoder.setPassword("1234")letopened=try decoder.open()        // 3. Select archive items for extracting or testing.    //  3.1. Select all archive items.letallArchiveItems=try decoder.items()        //  3.2. Get the number of items, iterate items by index, filter and select items.letnumberOfArchiveItems=try decoder.count()letselectedItemsDuringIteration=tryItemArray(capacity: numberOfArchiveItems)letselectedItemsToStreams=tryItemOutStreamArray()foritemIndexin0..<numberOfArchiveItems{letitem=try decoder.item(at: itemIndex)try selectedItemsDuringIteration.add(item: item)try selectedItemsToStreams.add(item: item, stream:OutStream()) // to memory stream}        // 4. Extract or test selected archive items. The extract process might be:    //  4.1. Extract all items to a directory. In this case, you can skip the step #3.letextracted=try decoder.extract(to:Path("path/outdir"))        //  4.2. Extract selected items to a directory.letextracted=try decoder.extract(items: selectedItemsDuringIteration, to:Path("path/outdir"))        //  4.3. Extract each item to a custom out-stream.     //       The out-stream might be a file or memory. I.e. extract 'item #1' to a file stream, extract 'item #2' to a memory stream(then take extacted memory) and so on.letextracted=try decoder.extract(itemsToStreams: selectedItemsToStreams)}catchlet exception asException{print("Exception:\(exception)")}

JavaScript

constplzma=require('plzmasdk');try{// 1. Create a source input stream for reading archive file content.//  1.1. Create a source input stream with the path to an archive file.constarchivePath=plzma.Path(__dirname).append('path/to/archive.7z');constarchivePathInStream=newplzma.InStream(archivePath/* 'path/to/archive.7z' */);//  1.2. Create a source input stream with the file content.constarchiveData=newArrayBuffer(...);constarchiveDataInStream=newplzma.InStream(archiveData);// 2. Create decoder with source input stream, type of archive and optional delegate.constdecoder=newplzma.Decoder(archivePathInStream,plzma.FileType.sevenZ);decoder.setProgressDelegate((path,progress)=>console.log(`Delegating progress, path:${path}, progress:${progress}`));//  2.1. Optionaly provide the password to open/list/test/extract encrypted archive items.decoder.setPassword('1234');constopened=awaitdecoder.openAsync();// also available sync. version 'decoder.open()'// 3. Select archive items for extracting or testing.//  3.1. Select all archive items.constallArchiveItems=decoder.items;//  3.2. Get the number of items, iterate items by index, filter and select items.constselectedItemsDuringIteration=[];constselectedItemsToStreams=newMap();for(letitemIndex=0,numberOfArchiveItems=decoder.count;itemIndex<numberOfArchiveItems;itemIndex++){constitem=decoder.itemAt(itemIndex);selectedItemsDuringIteration.push(item);selectedItemsToStreams.set(item,plzma.OutStream());// to memory stream}// 4. Extract or test selected archive items. The extract process might be://  4.1. Extract all items to a directory. In this case, you can skip the step #3.constextracted=awaitdecoder.extractAsync('path/outdir');// also available sync. version 'decoder.extract()'//  4.2. Extract selected items to a directory.constextracted=awaitdecoder.extractAsync(selectedItemsDuringIteration,'path/outdir');// also available sync. version 'decoder.extract()'//  4.3. Extract each item to a custom out-stream.//       The out-stream might be a file or memory. I.e. extract 'item #1' to a file stream, extract 'item #2' to a memory stream(then take extacted memory) and so on.constextracted=awaitdecoder.extractAsync(selectedItemsToStreams);// also available sync. version 'decoder.extract()'}catch(error){console.log(`Exception:${error}`);}

C++

try {// 1. Create a source input stream for reading archive file content.//  1.1. Create a source input stream with the path to an archive file.    PatharchivePath("path/to/archive.7z");// Path(L"C:\\\\path\\to\\archive.7z");auto archivePathInStream =makeSharedInStream(archivePath/* std::move(archivePath)*/);//  1.2. Create a source input stream with the file content.auto archiveDataInStream =makeSharedInStream(<FILE DATA>, <FILE SIZE>);// 2. Create decoder with source input stream, type of archive and provide optional delegate.auto decoder =makeSharedDecoder(archiveDataInStream, plzma_file_type_7z);    decoder->setProgressDelegate(this);//  2.1. Optionaly provide the password to open/list/test/extract encrypted archive items.    decoder->setPassword("1234");// decoder->setPassword(L"1234");bool opened = decoder->open();// 3. Select archive items for extracting or testing.//  3.1. Select all archive items.auto allArchiveItems = decoder->items();//  3.2. Get the number of items, iterate items by index, filter and select items.size_t numberOfArchiveItems = decoder->count();auto selectedItemsDuringIteration = makeShared<ItemArray>(numberOfArchiveItems);auto selectedItemsToStreams = makeShared<ItemOutStreamArray>();for (size_t itemIndex =0; itemIndex < numberOfArchiveItems; itemIndex++) {auto item = decoder->itemAt(itemIndex);        selectedItemsDuringIteration->push(item/* std::move(item)*/);        selectedItemsToStreams->push(Pair<SharedPtr<Item>, SharedPtr<OutStream> >(item,makeSharedOutStream()));// to memory stream    }// 4. Extract or test selected archive items. The extract process might be://  4.1. Extract all items to a directory. In this case, you can skip the step #3.bool extracted = decoder->extract(Path("path/outdir"));//  4.2. Extract selected items to a directory.bool extracted = decoder->extract(selectedItemsDuringIteration,Path("path/outdir"));//  4.3. Extract each item to a custom out-stream.//       The out-stream might be a file or memory. I.e. extract 'item #1' to a file stream, extract 'item #2' to a memory stream(then take extacted memory) and so on.bool extracted = decoder->extract(selectedItemsToStreams);}catch (const Exception &exception) {    std::cout <<"Exception:" <<exception.what() << std::endl;}

C

// 1. Create a source input stream for reading archive file content.//  1.1. Create a source input stream with the path to an archive file.plzma_patharchivePath=plzma_path_create_with_utf8_string("path/to/archive.7z");// plzma_path_create_with_wide_string(L"C:\\\\path\\to\\archive.7z");plzma_in_streamarchivePathInStream=plzma_in_stream_create_with_path(&archivePath);// plzma_in_stream_create_with_pathm(...);plzma_path_release(&archivePath);plzma_in_stream_release(&archivePathInStream);// when no longer needed//  1.2. Create a source input stream with the file content in memory.plzma_in_streamarchiveDataInStream=plzma_in_stream_create_with_memory_copy(<FILEDATA>,<FILESIZE>);// plzma_in_stream_create_with_memory(...);// 2. Create decoder with source input stream, type of archive, context for optional delegate and provide optional delegate callback.plzma_decoderdecoder=plzma_decoder_create(&archiveDataInStream,plzma_file_type_7z,plzma_context{nullptr,nullptr });// C2059 = { .context = nullptr, .deinitializer = nullptr }plzma_in_stream_release(&archiveDataInStream);// when no longer neededplzma_decoder_set_progress_delegate_utf8_callback(&decoder,<UTF8CCALLBACK>);// plzma_decoder_set_progress_delegate_wide_callback(...);//  2.1. Optionaly provide the password to open/list/test/extract encrypted archive items.plzma_decoder_set_password_utf8_string(&decoder,"1234");// plzma_decoder_set_password_wide_string(&decoder, L"1234");boolopened=plzma_decoder_open(&decoder);// 3. Select archive items for extracting or testing.//  3.1. Select all archive items.plzma_item_arrayallArchiveItems=plzma_decoder_items(&decoder);//  3.2. Get the number of items, iterate items by index, filter and select items.size_tnumberOfArchiveItems=plzma_decoder_count(&decoder);plzma_item_arrayselectedItemsDuringIteration=plzma_item_array_create(numberOfArchiveItems);plzma_item_out_stream_arrayselectedItemsToStreams=plzma_item_out_stream_array_create(numberOfArchiveItems);for (size_titemIndex=0;itemIndex<numberOfArchiveItems;itemIndex++) {plzma_itemitem=plzma_decoder_item_at(&decoder,itemIndex);plzma_item_array_add(&selectedItemsDuringIteration,&item);plzma_out_streamoutItemStream=plzma_out_stream_create_memory_stream();// to memory streamplzma_item_out_stream_array_add(&selectedItemsToStreams,&item,&outItemStream);plzma_out_stream_release(&outItemStream);plzma_item_release(&item);}// 4. Extract or test selected archive items. The extract process might be://  4.1. Extract all items to a directory. In this case, you can skip the step #3.plzma_pathextractPath=plzma_path_create_with_utf8_string("path/outdir");boolextracted=plzma_decoder_extract_all_items_to_path(&decoder,&extractPath, true);plzma_path_release(&extractPath);//  4.2. Extract selected items to a directory.plzma_pathextractPath=plzma_path_create_with_utf8_string("path/outdir");boolextracted=plzma_decoder_extract_items_to_path(&decoder,&selectedItemsDuringIteration,&extractPath, true);plzma_path_release(&extractPath);//  4.3. Extract each item to a custom out-stream.//       The out-stream might be a file or memory. I.e. extract 'item #1' to a file stream, extract 'item #2' to a memory stream(then take extacted memory) and so on.boolextracted=plzma_decoder_extract_item_out_stream_array(&decoder,&selectedItemsToStreams);plzma_item_array_release(&selectedItemsDuringIteration);// when no longer neededplzma_item_array_release(&allArchiveItems);// when no longer neededplzma_item_out_stream_array_release(&selectedItemsToStreams);// when no longer neededplzma_decoder_release(&decoder);// when no longer needed

Compress

Create output, setup encoder/archive, add content, open & compress.

Swift

do{    // 1. Create output stream for writing archive's file content.    //  1.1. Using file path.letarchivePath=Path("path/out.7z");letarchivePathOutStream=tryOutStream(path: archivePath)        // 2. Create encoder with output stream, type of the archive, compression method and optional progress delegate.letencoder=tryEncoder(stream: archivePathOutStream, fileType:.sevenZ, method:.LZMA2, delegate:self)        //  2.1. Optionaly provide the password in case of header and/or content encryption.try encoder.setPassword("1234")        //  2.2. Setup archive properties.try encoder.setShouldEncryptHeader(true)  // use this option with password.try encoder.setShouldEncryptContent(true) // use this option with password.try encoder.setCompressionLevel(9)        // 3. Add content for archiving.    //  3.1. Single file path with optional path inside the archive.try encoder.add(path:Path("dir/my_file1.txt")) // store as "dir/my_file1.txt", as is.try encoder.add(path:Path("dir/my_file2.txt"), mode:.default, archivePath:Path("renamed_file2.txt")) // store as "renamed_file2.txt"        //  3.2. Single directory path with optional directory iteration option and optional path inside the archive.try encoder.add(path:Path("dir/dir1")) // store as "dir1/..."try encoder.add(path:Path("dir/dir2"), mode:.followSymlinks, archivePath:Path("renamed_dir2")) // store as "renamed_dir2/..."        //  3.3. Any input stream with required path inside the archive.letitemStream=tryInStream(dataCopy:<Data>) // InStream(dataNoCopy: <Data>)try encoder.add(stream: itemStream, archivePath:Path("my_file3.txt")) // store as "my_file3.txt"        // 4. Open.letopened=try encoder.open()        // 4. Compress.letcompressed=try encoder.compress()}catchlet exception asException{print("Exception:\(exception)")}

JavaScript

constplzma=require('plzmasdk');try{// 1. Create output stream for writing archive's file content.//  1.1. Using file path.constarchivePathOutStream=newplzma.OutStream('path/out.7z');// 2. Create encoder with output stream, type of the archive, compression method and optional progress delegate.constencoder=plzma.Encoder(archivePathOutStream,plzma.FileType.sevenZ,plzma.Method.LZMA2);encoder.setProgressDelegate((path,progress)=>console.log(`Delegating progress, path:${path}, progress:${progress}`));//  2.1. Optionaly provide the password in case of header and/or content encryption.encoder.setPassword('1234');//  2.2. Setup archive properties.encoder.shouldEncryptHeader=true;// use this option with password.encoder.shouldEncryptContent=true;// use this option with password.encoder.compressionLevel=9;// 3. Add content for archiving.//  3.1. Single file path with optional path inside the archive.encoder.add('dir/my_file1.txt');// store as "dir/my_file1.txt", as is.encoder.add('dir/my_file2.txt',0,'renamed_file2.txt');// store as "renamed_file2.txt"//  3.2. Single directory path with optional directory iteration option and optional path inside the archive.encoder.add('dir/dir1');// store as "dir1/..."encoder.add('dir/dir2',plzma.OpenDirMode.followSymlinks,'renamed_dir2');// store as "renamed_dir2/..."//  3.3. Any input stream with required path inside the archive.constitemStream=plzma.InStream(newArrayBuffer(...));encoder.add(itemStream,'my_file3.txt');// store as "my_file3.txt"// 4. Open.constopened=awaitencoder.openAsync();// also available sync. version 'encoder.open()'// 4. Compress.constcompressed=awaitencoder.compressAsync();// also available sync. version 'encoder.compress()'}catch(error){console.log(`Exception:${error}`);}

C++

try {// 1. Create output stream for writing archive's file content.//  1.1. Using file path.constauto archivePathOutStream =makeSharedOutStream(Path("path/out.7z"));// 2. Create encoder with output stream, type of the archive, compression method and optional progress delegate.auto encoder =makeSharedEncoder(archivePathOutStream, plzma_file_type_7z, plzma_method_LZMA2);    encoder->setProgressDelegate(_progressDelegate);//  2.1. Optionaly provide the password in case of header and/or content encryption.    encoder->setPassword("1234");//  2.2. Setup archive properties.    encoder->setShouldEncryptHeader(true);// use this option with password.    encoder->setShouldEncryptContent(true);// use this option with password.    encoder->setCompressionLevel(9);// 3. Add content for archiving.//  3.1. Single file path with optional path inside the archive.    encoder->add(Path("dir/my_file1.txt"));// store as "dir/my_file1.txt", as is.    encoder->add(Path("dir/my_file2.txt"),0,Path("renamed_file2.txt"));// store as "renamed_file2.txt"//  3.2. Single directory path with optional directory iteration option and optional path inside the archive.    encoder->add(Path("dir/dir1"));// store as "dir1/..."    encoder->add(Path("dir/dir2"), plzma_open_dir_mode_follow_symlinks,Path("renamed_dir2"));// store as "renamed_dir2/..."//  3.3. Any input stream with required path inside the archive.auto itemStream =makeSharedInStream(<DATA>, <DATA_SIZE>);    encoder->add(itemStream,Path("my_file3.txt"));// store as "my_file3.txt"// 4. Open.bool opened = encoder->open();// 4. Compress.bool compressed = encoder->compress();}catch (const Exception &exception) {    std::cout <<"Exception:" <<exception.what() << std::endl;}

C

// 1. Create output stream for writing archive's file content.//  1.1. Using file path.plzma_patharchivePath=plzma_path_create_with_utf8_string("path/out.7z");plzma_out_streamarchivePathOutStream=plzma_out_stream_create_with_path(&archivePath);// 2. Create encoder with output stream, type of the archive, compression method and optional progress delegate.plzma_contextcontext;plzma_encoderencoder=plzma_encoder_create(&archivePathOutStream,plzma_file_type_7z,plzma_method_LZMA2,context);plzma_encoder_set_progress_delegate_utf8_callback(&encoder,<C_CALLBACK_FUNCTION>);//  2.1. Optionaly provide the password in case of header and/or content encryption.plzma_encoder_set_password_utf8_string(&encoder,"1234");//  2.2. Setup archive properties.plzma_encoder_set_should_encrypt_header(&encoder, true);// use this option with password.plzma_encoder_set_should_encrypt_content(&encoder, true);// use this option with password.plzma_encoder_set_compression_level(&encoder,9);// 3. Add content for archiving.//  3.1. Single file path with optional path inside the archive.plzma_pathitemPath=plzma_path_create_with_utf8_string("dir/my_file1.txt");plzma_encoder_add_path(&encoder,&itemPath,0,NULL);// store as "dir/my_file1.txt", as is.plzma_path_release(&itemPath);itemPath=plzma_path_create_with_utf8_string("dir/my_file2.txt");plzma_pathitemArchivePath=plzma_path_create_with_utf8_string("renamed_file2.txt");plzma_encoder_add_path(&encoder,&itemPath,0,&itemArchivePath);// store as "renamed_file2.txt"plzma_path_release(&itemPath);plzma_path_release(&itemArchivePath);//  3.2. Single directory path with optional directory iteration option and optional path inside the archive.itemPath=plzma_path_create_with_utf8_string("dir/dir1");plzma_encoder_add_path(&encoder,&itemPath,0,NULL);// store as "dir1/..."plzma_path_release(&itemPath);itemPath=plzma_path_create_with_utf8_string("dir/dir2");itemArchivePath=plzma_path_create_with_utf8_string("renamed_dir2");plzma_encoder_add_path(&encoder,&itemPath,plzma_open_dir_mode_follow_symlinks,&itemArchivePath);// store as "renamed_dir2/..."plzma_path_release(&itemPath);plzma_path_release(&itemArchivePath);//  3.3. Any input stream with required path inside the archive.itemArchivePath=plzma_path_create_with_utf8_string("my_file3.txt");plzma_in_streamitemStream=plzma_in_stream_create_with_memory(<DATA>,<DATA_SIZE>);plzma_encoder_add_stream(&encoder,&itemStream,&itemArchivePath);// store as "my_file3.txt"plzma_in_stream_release(&itemStream);plzma_path_release(&itemArchivePath);// 4. Open.boolopened=plzma_encoder_open(&encoder);// 4. Compress.boolcompressed=plzma_encoder_compress(&encoder);plzma_out_stream_release(&archivePathOutStream);// when no longer neededplzma_path_release(&archivePath);// when no longer neededplzma_encoder_release(&encoder);// when no longer needed

License