Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/group__Compression.html below:

NCBI C++ ToolKit: Compression

try { \

NCBI_REPORT_EXCEPTION_X(subcode, message, e); \

} catch (...) { \

} \

} \

catch (exception& e) { \

try { \

ERR_POST_X(subcode,

\

<< "[" << message \

<< "] Exception: " << e.what()); \

} catch (...) { \

} \

} \

catch (...) { \

try { \

ERR_POST_X(subcode,

\

<< "[" << message << "] Unknown exception"); \

} catch (...) { \

} \

} \

void Error(CExceptionArgs_Base &args)

Macro to catch and handle exceptions (from streams in the destructor)

Definition at line 87 of file compress.hpp.

Macro to report errors in compression API.

Error codes for ERR_COMPRESS and OMPRESS_HANDLE_EXCEPTIONS are really a subcodes and current maximum value is defined in 'include/util/error_codes.hpp': NCBI_DEFINE_ERRCODE_X(Util_Compress, 210, max); For new values use 'max'+1 and update it there.

Definition at line 84 of file compress.hpp.

Type of user-defined callback for extraction from archive.

It can be used to extract data from a single archive entry on the fly.

Parameters

info A current entry that is processed. buf Pointer to buffer with data. n Size of data in the buffer.

Returns

The callback function should process all incoming data and return 'n' for success. If returning value don't equal the number of bytes in the incoming buffer, that extraction fail.

Definition at line 216 of file archive_.hpp.

Archive entry type (the same as directory entry type).

Definition at line 115 of file archive_.hpp.

Bitwise OR of EFlags.

Definition at line 73 of file bzip2.hpp.

Define a list of entries.

Definition at line 397 of file tar.hpp.

Define a list of files with sizes (directories and specials, such as devices, must be given with sizes of 0; symlinks – with the sizes of the names they are linking to).

Definition at line 402 of file tar.hpp.

Bitwise OR of EFlags.

Definition at line 368 of file tar.hpp.

Bitwise OR of EFlags.

Definition at line 165 of file lzo.hpp.

Type to store stream positions.

Definition at line 633 of file compress.hpp.

Bitwise OR of ETarModeBits.

Definition at line 89 of file tar.hpp.

Bitwise OR of EFlags.

Definition at line 127 of file zlib.hpp.

Action, performed on the archive.

Definition at line 396 of file archive.hpp.

Action types.

Continue scanning to the next data chunk, if any.

Stop scanning.

Definition at line 636 of file compress.hpp.

Definition at line 672 of file tar.hpp.

Decompression mode (see fAllowTransparentRead flag).

Not known yet (decompress/transparent read)

Generic decompression.

Transparent read, the data is uncompressed.

Definition at line 331 of file compress.hpp.

Processing direction.

Reading from archive.

Writing into archive.

Definition at line 192 of file archive_.hpp.

Error types that CArchive API can generate.

Definition at line 64 of file archive_.hpp.

Compression/decompression error.

Compression/decompression file error.

Definition at line 583 of file compress.hpp.

Error types that file operations can generate.

Definition at line 110 of file tar.hpp.

General flags.

Allow to overwrite destinations with entries from the archive.

Only update entries that are older than those already existing.

Backup destinations if they exist (all entries including dirs)

If destination entry exists, it must have the same type as source.

Create extracted files with the original ownership.

Create extracted files with the original permissions.

Preserve date/times for extracted files Note, that some formats, as zip for example, store modification time only, so creation and last access time will be the same as modification time.

And even it can be a little bit off due a rounding errors.

Preserve all file attributes.

Follow symbolic links (instead of storing/extracting them)

Skip unsupported entries rather than making files out of them when extracting (the latter is the default POSIX requirement).

On adding entry of unsupported type to the archive it will be skipping also.

Default flags.

Definition at line 73 of file archive.hpp.

Compression/decompression flags.

Allow transparent reading data from buffer/file/stream regardless is it compressed or not.

But be aware, if data source contains broken data and API cannot detect that it is compressed data, that you can get binary instead of decompressed data. By default this flag is OFF.

Allow to "compress/decompress" empty data.

The output compressed data will have header and footer only.

Definition at line 62 of file bzip2.hpp.

Compression/decompression flags.

Allow transparent reading data from buffer/file/stream regardless is it compressed or not.

But be aware, if data source contains broken data and API cannot detect that it is compressed data, that you can get binary instead of decompressed data. By default this flag is OFF.

Allow to "compress/decompress" empty data.

Buffer compression functions starts to return TRUE instead of FALSE for zero-length input. And, if this flag is used together with fStreamFormat than the output will have header and footer only.

Add/check (accordingly to compression or decompression) the compressed data checksum.

A checksum is a form of redundancy check. We use the safe decompressor, but this can be not enough, because many data errors will not result in a compressed data violation.

Use stream compatible format for data compression.

This flag have an effect for CompressBuffer/DecompressBuffer only. File and stream based compressors always use it by default. Use this flag with DecompressBuffer() to decompress data, compressed using streams, or compress data with CompressBuffer(), that can be decompressed using decompression stream.

Note

This flag is reguired to compress data > 4GB. LZO default single block compression cannot handle such large amount of data on some platforms.

Store file information like file name and file modification date of the compressed file into the file/stream.

Works only with fStreamFormat flag.

Definition at line 131 of file lzo.hpp.

General flags.

Ignore blocks of zeros in archive.

Follow symbolic links (instead of storing/extracting them)

Allow to overwrite destinations with entries from the archive.

Only update entries that are older than those already existing.

Backup destinations if they exist (all entries including dirs)

If destination entry exists, it must have the same type as source.

Create extracted files with the original ownership.

Create extracted files with the original permissions.

Preserve date/times for extracted files.

Preserve all file attributes.

Preserve absolute path instead of stripping the leadind slash('/')

Do not extract PAX GNU/1.0 sparse files (treat 'em as unsupported)

Skip unsupported entries rather than make files out of them when extracting (the latter is the default behavior required by POSIX)

Ignore unreadable files/dirs (still warn them, but don't stop)

Always use OldGNU headers for long names (default:only when needed)

Ignore case difference in names.

Conflict overwrite allowed for entries.

Stream tar data through.

Do not trim tar file size after append/update.

Suppress NCBI signatures in entry headers.

Default flags.

Definition at line 304 of file tar.hpp.

Compression/decompression flags.

Allow transparent reading data from buffer/file/stream regardless is it compressed or not.

But be aware, if data source contains broken data and API cannot detect that it is compressed data, that you can get binary instead of decompressed data. By default this flag is OFF. Note: zlib v1.1.4 and earlier have a bug in decoding. In some cases decompressor can produce output data on invalid compressed data. So, it is not recommended to use this flag with old zlib versions.

Allow to "compress/decompress" empty data.

Buffer compression functions starts to return TRUE instead of FALSE for zero-length input. And, if this flag is used together with fWriteGZipFormat than the output will have gzip header and footer only.

Check (and skip) gzip file header on decompression stage.

Use gzip (.gz) file format to write into compression stream (the archive also can store file name and file modification date in this format).

Note: gzip file header and footer will be omitted by default if no input data is provided, and you will have empty output, that may not be acceptable to tools like gunzip and etc – in this case use fAllowEmptyData.

Allow concatenated gzip files.

Multiple compressed files can be concatenated into one file. In this case, decompressor will try to extract all members at once. But note, that better compression can be usually obtained if all members are decompressed and then recompressed in a single step.

Set of flags for gzip file support. See each flag description above.

This flag can be used only with DecompressFile[IntoDir]().

It allow to restore the original file name and/or time stamp stored in the file header, if present.

See also

DecompressFile, DecompressFileIntoDir

Definition at line 87 of file zlib.hpp.

Compression/decompression flags.

Allow transparent reading data from buffer/file/stream regardless is it compressed or not.

But be aware, if data source contains broken data and API cannot detect that it is compressed data, that you can get binary instead of decompressed data. By default this flag is OFF. Note: zlib v1.1.4 and earlier have a bug in decoding. In some cases decompressor can produce output data on invalid compressed data. So, it is not recommended to use this flag with old zlib versions.

Allow to "compress/decompress" empty data.

Buffer compression functions starts to return TRUE instead of FALSE for zero-length input. And, if this flag is used together with fWriteGZipFormat than the output will have gzip header and footer only.

Check (and skip) gzip file header on decompression stage.

Use gzip (.gz) file format to write into compression stream (the archive also can store file name and file modification date in this format).

Note: gzip file header and footer will be omitted by default if no input data is provided, and you will have empty output, that may not be acceptable to tools like gunzip and etc – in this case use fAllowEmptyData.

Allow concatenated gzip files.

Multiple compressed files can be concatenated into one file. In this case, decompressor will try to extract all members at once. But note, that better compression can be usually obtained if all members are decompressed and then recompressed in a single step.

Set of flags for gzip file support. See each flag description above.

This flag can be used only with DecompressFile[IntoDir]().

It allow to restore the original file name and/or time stamp stored in the file header, if present.

See also

DecompressFile, DecompressFileIntoDir

Definition at line 81 of file zlib_cloudflare.hpp.

Definition at line 121 of file reader_zlib.hpp.

Compression level.

It is in range [0..9]. Increase of level might mean better compression and usualy greater time of compression. Usualy 1 gives best speed, 9 gives best compression, 0 gives no compression at all (if supported). eDefault value requests a compromise between speed and compression (according to developers of the corresponding compression algorithm).

Note

Each compression library/algorithm have its own set of compression levels, than not usually fit into [0..9] range. But for convenience of use and easier switching we prowide conversion between levels, whehe "lowest" is a always a minimem allowed compression level, and "best" is a maximum. All other approximately fits in between.

Definition at line 142 of file compress.hpp.

Archive location.

File-based archive.

File stream based archive (FILE*)

Memory-based archive.

Definition at line 197 of file archive_.hpp.

Definition at line 319 of file archive.hpp.

exact for list or extract

pattern for all but test

Definition at line 379 of file tar.hpp.

File open mode.

Reading from compressed file.

Writing compressed data to file.

Definition at line 371 of file compress.hpp.

Archive open mode.

Definition at line 388 of file archive.hpp.

Archive open mode and action.

Definition at line 666 of file tar.hpp.

Which of the objects (passed in the constructor) should be deleted on this object's destruction.

Definition at line 111 of file reader_zlib.hpp.

Position type.

Definition at line 179 of file tar.hpp.

Type of the result of all basic functions.

Everything is fine, no errors occurred.

Special case of eStatus_Success.

Logical end of (compressed) stream is detected, no errors occurred. All subsequent inquiries about data processing should be ignored.

Error has occurred. The error code can be acquired by GetErrorCode().

Output buffer overflow - not enough output space.

Buffer must be emptied and the last action repeated.

Special value. Just need to repeat last action.

Special value. Status is undefined.

Definition at line 467 of file compress.hpp.

I/O completion code.

Definition at line 683 of file tar.hpp.

Definition at line 371 of file archive.hpp.

Supported features.

Check if current compression method have a real support for eLevel_NoCompression, so it can store data without compression.

If this method of compression is not supported, the lowest supported level will be used instead, automatically.

See also

GetLevel, ELevel

Check if current compression have support for dictionaries.

Without support SetDictionary() always return FALSE.

See also

SetDictionary

Check if current compression have implementation for the EstimateCompressionBufferSize() method.

Without support it always return 0.

See also

EstimateCompressionBufferSize, CompressBuffer

Definition at line 191 of file compress.hpp.

TTarMode –.

Permission bits as defined in tar

set UID on execution

set GID on execution

reserved (sticky bit)

read by owner

write by owner

execute/search by owner

read by group

write by group

execute/search by group

read by other

write by other

execute/search by other

Definition at line 73 of file tar.hpp.

Definition at line 56 of file reader_zlib.hpp.

Archive entry type.

Regular file.

Directory.

Symbolic link.

Pipe (FIFO)

Character device.

Block device.

Unknown type.

Hard link.

Volume header.

PAX extended header.

GNU/STAR sparse file.

GNU long name.

GNU long link.

Definition at line 162 of file tar.hpp.

Add single entry to newly created archive from file system.

Parameters

info Entry information to add. It should have name and type of adding entry at least. If added entry is a directory, just add an information about it to archive. CArchive process all directories recursively. src_path Path to file system object to add. level Compression level used to compress file .

See also

CreateFile, CreateMemory, AddEntryFromMemory

Implements IArchive.

Definition at line 499 of file archive_zip.cpp.

References _ASSERT, CDirEntry::eDir, CDirEntry::eFile, ICompression::eLevel_Default, info, MZ_DEFAULT_LEVEL, mz_zip_writer_add_file(), mz_zip_writer_add_mem_ex(), NULL, ZIP_HANDLE, and ZIP_THROW.

Add single entry to newly created archive from file system.

Parameters

info Entry information to add. It should have name and type of adding entry at least. If added entry is a directory, just add an information about it to archive. CArchive process all directories recursively. src_path Path to file system object to add. level Compression level used to compress file .

See also

CreateFile, CreateMemory, AddEntryFromMemory

Implemented in CArchiveZip.

Add entry to newly created archive from memory buffer.

Parameters

info Entry information to add. It should have name and type of adding entry at least. buf Memory buffer with data to add. size Size of data in memory buffer. level Compression level for added data.

See also

CreateFile, CreateMemory, AddEntryFromFileSystem

Implemented in CArchiveZip.

Append an entry at the end of the archive that already exists.

Appended entry can be either a file, a directory, a symbolic link, a device special file (block or character), or a FIFO special file, subject to any exclusions as set by SetMask() with eExcludeMask. The name is taken with respect to the base directory, if any set.

Adding a directory results in all its files and subdirectories (subject out what has been added.

Note that the final name of an entry may not contain embedded '..'. Leading slash in the absolute paths will be retained. The names of all appended entries will be converted to Unix format (that is, to have only forward slashes in the paths, and drive letter, if any on MS-Windows, stripped). All entries will be added at the logical end (not always EOF) of the archive, when appending to a non-empty one.

Warning

Adding to a stream archive does not seek to the logical end of the archive but begins at the current position right away.

Returns

A list of entries appended.

See also

Create, Update, SetBaseDir, SetMask

Definition at line 820 of file tar.hpp.

References CTar::eAppend, CTar::x_Append(), and CTar::x_Open().

Append an entry to the archive.

Appended entry can be either a file, directory, symbolic link or etc. Each archive format have its own list of supported entry types. The name is taken with respect to the base directory, if any set. Adding a directory results in all its files and subdirectories to get added (examine the return value to find out what has been added). The names of all appended entries will be converted to Unix format (only forward slashes in the paths, and drive letter, if any on MS-Windows, stripped).

Parameters

path Path to appended entry. level Compression level (if selected format support it, or default). comment Optional comment for the appended entry (if selected format support it). For directories the comment will be added to upper directory only.

Returns

A list of entries appended.

Note

On the current moment you can use this method to add files to newly created archive only, modifying existed archive is not allowed.

See also

Create, AppendFileFromMemory, SetBaseDir, HaveSupport, Update

Definition at line 451 of file archive.cpp.

References ARCHIVE_CHECK, CArchive::eAppend, CArchive::x_Append(), and CArchive::x_Open().

Append a single file entry to the created archive using data from memory buffer.

These function assign the current local time to added entry.

Parameters

name_in_archive Name of the file entry in the archive. You can use any symbols, that allowed for file names. Also, you can use relative path here, if you want to create some structure in the archive and put the data to a file in the subdirectory. buf Buffer with data to add. buf_size Size of data in the buffer. level Compression level (if selected format support it, or default). comment Optional comment for the appended entry (if selected format support it).

Returns

An information about added entry.

Note

On the current moment you can use this method to add files to newly created archive only, modification existing archive is not allowed.

See also

Create, Append

Definition at line 461 of file archive.cpp.

References ARCHIVE, ARCHIVE_CHECK, ARCHIVE_THROW, buf, CArchive::eAppend, CArchive::eFeature_AbsolutePath, CDirEntry::eFile, entries, CArchive::eZip, CArchive::HaveSupport(), kEmptyStr, CArchiveEntryInfo::m_Comment, CArchive::m_Current, CArchive::m_Format, CArchiveEntryInfo::m_Name, CArchiveEntryInfo::m_Type, NCBI_THROW, s_ToArchiveName(), and CArchive::x_Open().

Constructor for stream-based archive.

Parameters

format Archive format. fd File/socket descriptor to write archive to. Socket descriptor should be already connected and file descriptor should be opened for writing before creating an archive.

See also

Append, AppendFileFromMemory, Close

Definition at line 1261 of file archive.cpp.

References _T_XCSTRING, ARCHIVE_THROW, CArchiveCompressionFileStream::Create(), IArchive::eFileStream, CArchiveCompressionFileStream::m_fd, CArchiveCompressionFileStream::m_FileStream, CArchive::m_Location, NcbiSys_dup, and NcbiSys_fdopen.

Constructor for memory-based archive.

Parameters

format Archive format. buf Pointer to an archive located in memory. Used only to open already existed archive for reading. Never used if you would like to create new archive, see Create(). buf_size Size of the archive.

See also

Create, Extract, List, Test, Append

Definition at line 1150 of file archive.cpp.

References IArchive::eMemory, CArchive::fDefault, CArchiveMemory::m_Buf, CArchiveMemory::m_BufSize, CArchive::m_Flags, CArchiveMemory::m_InitialAllocationSize, CArchive::m_Location, and ncbi::grid::netcache::search::fields::size.

Private copy constructor to prohibit copy.

Private copy constructor to prohibit copy.

Constructor.

Automatically calls Open() with given file name, mode and compression level.

Note

This constructor don't allow to use any advanced compression parameters or a dictionary. If you need to set any of them, please use simplified conventional constructor, set advanced parameters and use Open().

Current implementation uses default bzip2 methods to work with compression files, so in/out buffer sizes are not used, and added for API uniformity only.

Conventional constructor.

Constructor.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 531 of file bzip2.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 542 of file bzip2.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 579 of file bzip2.hpp.

Use dictionary data from a memory buffer.

CCompressionDictionary can take an ownership of allocated memory, so it can be automatically deallocated when not needed anymore.

Definition at line 282 of file compress.cpp.

Definition at line 203 of file compress.cpp.

Definition at line 46 of file reader_zlib.cpp.

Definition at line 82 of file reader_zlib.hpp.

Return false to skip the current entry when processing.

Note that the callback can encounter multiple entries of the same file in case the archive has been updated (so only the last occurrence is the actual copy of the file when extracted).

Definition at line 426 of file archive.hpp.

Referenced by CArchive::x_AppendEntry(), and CArchive::x_ReadAndProcess().

Return false to skip the current entry when reading; the return code gets ignored when writing.

Note that the callback can encounter multiple entries of the same file in case the archive has been updated (so only the last occurrence is the actual copy of the file when extracted).

Reimplemented in CTarCheckpointed.

Definition at line 660 of file tar.hpp.

Referenced by CTar::x_ReadAndProcess(), and CTar::x_WriteEntryInfo().

Close compressed file.

Flushes all pending output if necessary, closes the compressed file.

Returns

TRUE on success, FALSE on error.

See also

Open, Read, Write

Implements CCompressionFile.

Close compressed file.

Flushes all pending output if necessary, closes the compressed file.

Returns

TRUE on success, FALSE on error.

See also

Open, Read, Write

Implements CCompressionFile.

Definition at line 1049 of file lzo.cpp.

References CCompressionFile::eMode_Read, CCompressionStream::eRead, CCompressionStream::eWrite, CCompressionIOStream::Finalize(), CLZOCompressionFile::GetStreamError(), CLZOCompressionFile::m_File, CLZOCompressionFile::m_Mode, and CLZOCompressionFile::m_Stream.

Referenced by CLZOCompression::CompressFile(), CLZOCompression::DecompressFile(), CLZOCompressionFile::Open(), and CLZOCompressionFile::~CLZOCompressionFile().

Close the archive making sure all pending output is flushed.

Normally, direct call of this method need _not_ intersperse successive archive manipulations by other methods, as they open and close the archive automagically as needed. Rather, this call is to make sure the archive is complete earlier than it otherwise usually be done automatically in the destructor of the CTar object.

See also

~CTar

Definition at line 814 of file tar.hpp.

References CTar::x_Close(), and CTar::x_Flush().

Referenced by CDownloadJob::x_DownloadAndExtract().

Close compressed file.

Flushes all pending output if necessary, closes the compressed file.

Returns

TRUE on success, FALSE on error.

See also

Open, Read, Write

Implements CCompressionFile.

Close compressed file.

Flushes all pending output if necessary, closes the compressed file.

Returns

TRUE on success, FALSE on error.

See also

Open, Read, Write

Implements CCompressionFile.

Close the archive.

For file-based archives it flushes all pending output. All added entries will appears in the archive only after this call. This method will be automatically called from destructor if you forgot to call it directly. But note, that if the archive is created in memory, it will be lost. You should call FinalizeMemory() to get data before closing archive.

See also

FinalizeMemory, OpenFile, OpenMemory

Implements IArchive.

Definition at line 238 of file archive_zip.cpp.

References _ASSERT, IArchive::eFile, IArchive::eFileStream, IArchive::eRead, IArchive::eWrite, IArchive::m_Location, IArchive::m_Mode, mz_zip_reader_end(), mz_zip_writer_end(), mz_zip_writer_finalize_archive(), ZIP_CHECK, ZIP_DELETE, ZIP_HANDLE, and ZIP_THROW.

Referenced by CArchiveZip::~CArchiveZip().

Close the archive.

For file-based archives it flushes all pending output. All added entries will appears in the archive only after this call. This method will be automatically called from destructor if you forgot to call it directly. But note, that if the archive is created in memory, it will be lost. You should call FinalizeMemory() to get it.

See also

FinalizeMemory, OpenFile, OpenMemory

Implemented in CArchiveZip.

Private copy constructor to prohibit copy.

Private copy constructor to prohibit copy.

Private copy constructor to prohibit copy.

Conventional constructor.

Definition at line 887 of file lzo.cpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 787 of file lzo.hpp.

Full constructor.

Definition at line 775 of file lzo.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 798 of file lzo.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 838 of file lzo.hpp.

Full constructor.

Definition at line 827 of file lzo.hpp.

Compress block of data.

Returns

Return compressor error code.

Definition at line 354 of file lzo.cpp.

References F_ISSET, CLZOCompression::fChecksum, AutoArray< X, Del >::get(), CLZOCompression::GetLZOErrorDescription(), CLZOCompression::m_Param, CLZOCompression::m_WorkMem, n, NULL, CCompression::SetError(), and CCompressionUtil::StoreUI4().

Referenced by CLZOCompression::CompressBlockStream(), and CLZOCompression::CompressBuffer().

Compress data in the buffer.

Altogether, the total size of the destination buffer must be little more then size of the source buffer.

Parameters

src_buf [in] Source buffer. src_len [in] Size of data in source buffer. dst_buf [in] Destination buffer. dst_size [in] Size of destination buffer. dst_len [out] Size of compressed data in destination buffer.

Returns

Return TRUE if operation was succesfully or FALSE otherwise. On success, 'dst_buf' contains compressed data of dst_len size.

See also

DecompressBuffer

Implements ICompression.

Referenced by CT_CompressBuffer().

Compress data in the buffer.

Parameters

src_buf [in] Source buffer. src_len [in] Size of data in source buffer. dst_buf [in] Destination buffer. dst_size [in] Size of destination buffer. The size of the destination buffer must be a little more then size of the source buffer. dst_len [out] Size of compressed data in destination buffer.

Returns

Return TRUE if operation was successfully or FALSE otherwise. On success, 'dst_buf' contains compressed data of dst_len size.

Note

Use fStreamFormat flag to compress data > 4GB. LZO default single block compression cannot handle such large amount of data on some platforms.

See also

EstimateCompressionBufferSize, DecompressBuffer

Implements ICompression.

Definition at line 490 of file lzo.cpp.

References _VERIFY, CLZOCompression::CompressBlock(), CLZOCompression::CompressBlockStream(), ERR_COMPRESS, CLZOCompression::EstimateCompressionBufferSize(), F_ISSET, CLZOCompression::fAllowEmptyData, CLZOCompression::FormatErrorMessage(), CLZOCompression::fStreamFormat, CCompression::GetErrorCode(), CCompression::GetFlags(), CLZOCompression::GetLevel(), CLZOCompression::GetLZOErrorDescription(), CLZOCompression::InitCompression(), kMax_UInt, CLZOCompression::m_BlockSize, min(), n, NULL, s_WriteLZOHeader(), CCompression::SetError(), and CCompressionUtil::StoreUI4().

Referenced by CChangePhyloTreeCommand::CChangePhyloTreeCommand(), and CT_CompressBuffer().

Compress data in the buffer.

Parameters

src_buf Source buffer. src_len Size of data in source buffer. dst_buf Destination buffer. dst_size Size of destination buffer. In some cases, small source data or bad compressed data for example, it should be a little more then size of the source buffer. dst_len Size of compressed data in destination buffer.

Returns

Return TRUE if operation was successfully or FALSE otherwise. On success, 'dst_buf' contains compressed data of 'dst_len' size.

See also

EstimateCompressionBufferSize, DecompressBuffer

Implements ICompression.

Referenced by CId2Compressor::CompressChunk(), CT_CompressBuffer(), and CPdfObject::x_PrintTo().

Compress data in the buffer.

Parameters

src_buf Source buffer. src_len Size of data in source buffer. dst_buf Destination buffer. dst_size Size of destination buffer. In some cases, small source data or bad compressed data for example, it should be a little more then size of the source buffer. dst_len Size of compressed data in destination buffer.

Returns

Return TRUE if operation was successfully or FALSE otherwise. On success, 'dst_buf' contains compressed data of 'dst_len' size.

See also

EstimateCompressionBufferSize, DecompressBuffer

Implements ICompression.

Compress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a compressor. compression_in_bufsize Size of the internal buffer holding input data to be compressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. compression_out_bufsize Size of the internal buffer to receive data from a compressor.

Returns

Return TRUE on success, FALSE on error.

Note

This method don't store any file meta information like name, date/time, owner or attributes.

See also

DecompressFile, GetRecommendedBufferSizes, CBZip2CompressionFile

Implements ICompression.

Compress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a compressor. compression_in_bufsize Size of the internal buffer holding input data to be compressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. compression_out_bufsize Size of the internal buffer to receive data from a compressor.

Returns

Return TRUE on success, FALSE on error.

Note

This method don't store any file meta information like name, date/time, owner or attributes.

See also

DecompressFile, GetRecommendedBufferSizes, CLZOCompressionFile

Implements ICompression.

Definition at line 730 of file lzo.cpp.

References CLZOCompressionFile::Close(), CCompressionFile::eMode_Write, CLZOCompression::GetBlockSize(), CCompression::GetErrorCode(), CCompression::GetErrorDescription(), CCompression::GetFlags(), CLZOCompression::GetLevel(), CLZOCompressionFile::Open(), CLZOCompression::SetBlockSize(), CCompression::SetError(), CCompression::SetFlags(), and CCompression::x_CompressFile().

Compress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a compressor. compression_in_bufsize Size of the internal buffer holding input data to be compressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. compression_out_bufsize Size of the internal buffer to receive data from a compressor.

Returns

Return TRUE on success, FALSE on error.

Note

This method, as well as some gzip utilities, always keeps the original file name and timestamp in the compressed file. On this moment DecompressFile() method do not use original file name at all, but be aware... If you assign different base name to destination compressed file, that behavior of decompression utilities on different platforms may differ. For example, WinZip on MS Windows always restore original file name and timestamp stored in the file. UNIX gunzip have -N option for this, but by default do not use it, and just creates a decompressed file with the name of the compressed file without .gz extension.

See also

DecompressFile, DecompressFileIntoDir, GetRecommendedBufferSizes, CZipCompressionFile

Implements ICompression.

Compress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a compressor. compression_in_bufsize Size of the internal buffer holding input data to be compressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. compression_out_bufsize Size of the internal buffer to receive data from a compressor.

Returns

Return TRUE on success, FALSE on error.

Note

This method, as well as some gzip utilities, always keeps the original file name and timestamp in the compressed file. On this moment DecompressFile() method do not use original file name at all, but be aware... If you assign different base name to destination compressed file, that behavior of decompression utilities on different platforms may differ. For example, WinZip on MS Windows always restore original file name and timestamp stored in the file. UNIX gunzip have -N option for this, but by default do not use it, and just creates a decompressed file with the name of the compressed file without .gz extension.

See also

DecompressFile, DecompressFileIntoDir, GetRecommendedBufferSizes, CZipCloudflareCompressionFile

Implements ICompression.

Create a new empty archive in memory.

Parameters

initial_allocation_size Estimated size of the archive, if known. Bigger size allow to avoid extra memory reallocations.

See also

Append, Finalize

Definition at line 1170 of file archive.cpp.

References ARCHIVE_CHECK, CArchive::eCreate, CArchiveMemory::m_Buf, CArchiveMemory::m_InitialAllocationSize, CArchiveMemory::m_OwnBuf, NULL, AutoArray< X, Del >::reset(), and CArchive::x_Open().

Create new archive file.

Parameters

filename File name of the archive to create.

Note

File can be overwritten if exists.

See also

CreateMemory, AddEntryFromFile, AddEntryFromMemory

Implements IArchive.

Definition at line 130 of file archive_zip.cpp.

References IArchive::eFile, IArchive::eWrite, IArchive::m_Location, IArchive::m_Mode, mz_zip_writer_init_file(), ZIP_DELETE, ZIP_HANDLE, ZIP_NEW, and ZIP_THROW.

Create new archive file on top of a FILE stream.

Parameters

filestream File stream that can be used for archive operations.

Note

File stream should be opened with necessary flags to allow read/write, depending on performing archive operations.

The file stream will not be closed after closing archive with Close() .

See also

CreateFile, CreateMemory, AddEntryFromFile, AddEntryFromMemory

Implements IArchive.

Definition at line 144 of file archive_zip.cpp.

References IArchive::eFileStream, IArchive::eWrite, IArchive::m_Location, IArchive::m_Mode, mz_zip_writer_init_cfile(), ZIP_DELETE, ZIP_HANDLE, ZIP_NEW, and ZIP_THROW.

Create new archive file on top of a FILE stream.

Parameters

filestream File stream that can be used for archive operations.

Note

File stream should be opened with necessary flags to allow read/write, depending on performing archive operations.

The file stream will not be closed after closing archive with Close() .

See also

CreateFile, CreateMemory, AddEntryFromFile, AddEntryFromMemory

Implemented in CArchiveZip.

Create new archive located in memory.

Parameters

initial_allocation_size Estimated size of the archive, if known. Bigger size allow to avoid extra memory reallocations.

See also

FinalizeMemory, AddEntryFromFile, AddEntryFromMemory

Implements IArchive.

Definition at line 158 of file archive_zip.cpp.

References IArchive::eMemory, IArchive::eWrite, IArchive::m_Location, IArchive::m_Mode, mz_zip_writer_init_heap(), ZIP_DELETE, ZIP_HANDLE, ZIP_NEW, and ZIP_THROW.

Create new archive located in memory.

Parameters

initial_allocation_size Estimated size of the archive, if known. Bigger size allow to avoid extra memory reallocations.

See also

FinalizeMemory, AddEntryFromFile, AddEntryFromMemory

Implemented in CArchiveZip.

Stream version does not at all use stream positioning and so is safe on non-positionable streams, like pipes/sockets (or magnetic tapes :-I).

Definition at line 1327 of file tar.cpp.

References CTar::x_Init().

Private copy constructor to prohibit copy.

Constructor.

Note

For setting up advanced compression parameters see Set*() methods.

Private copy constructor to prohibit copy.

Constructor.

Automatically calls Open() with given file name, mode and compression level.

Note

This constructor don't allow to use any advanced compression parameters or a dictionary. If you need to set any of them, please use simplified conventional constructor, set advanced parameters and use Open().

Conventional constructor.

Constructor.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 772 of file zlib_cloudflare.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 783 of file zlib_cloudflare.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 825 of file zlib_cloudflare.hpp.

Private copy constructor to prohibit copy.

Constructor.

Note

For setting up advanced compression parameters see Set*() methods.

Private copy constructor to prohibit copy.

Constructor.

Automatically calls Open() with given file name, mode and compression level.

Note

This constructor don't allow to use any advanced compression parameters or a dictionary. If you need to set any of them, please use simplified conventional constructor, set advanced parameters and use Open().

Conventional constructor.

Constructor.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 778 of file zlib.hpp.

Full constructor.

Definition at line 766 of file zlib.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 789 of file zlib.hpp.

Conventional constructor.

Uses default buffer sizes for I/O, that can be not ideal for some scenarios.

Definition at line 831 of file zlib.hpp.

Full constructor.

Definition at line 820 of file zlib.hpp.

Decompress data in the buffer.

Parameters

src_buf Source buffer. src_len Size of data in source buffer. dst_buf Destination buffer. dst_size Size of destination buffer. It must be large enough to hold all of the uncompressed data for the operation to complete. dst_len Size of decompressed data in destination buffer.

Returns

Return TRUE if operation was successfully or FALSE otherwise. On success, 'dst_buf' contains decompressed data of dst_len size.

See also

CompressBuffer

Implements ICompression.

Referenced by CT_DecompressBuffer().

Decompress data in the buffer.

Parameters

src_buf Source buffer. src_len Size of data in source buffer. dst_buf Destination buffer. dst_size Size of destination buffer. It must be large enough to hold all of the uncompressed data for the operation to complete. dst_len Size of decompressed data in destination buffer.

Returns

Return TRUE if operation was successfully or FALSE otherwise. On success, 'dst_buf' contains decompressed data of dst_len size.

Note

Use fStreamFormat flag to decompress data, compressed using streams, or CompressBuffer() with this flag.

See also

CompressBuffer

Implements ICompression.

Definition at line 586 of file lzo.cpp.

References CLZOCompression::DecompressBlock(), CLZOCompression::DecompressBlockStream(), ERR_COMPRESS, F_ISSET, CLZOCompression::fAllowEmptyData, CLZOCompression::fAllowTransparentRead, CLZOCompression::FormatErrorMessage(), CLZOCompression::fStreamFormat, CCompression::GetFlags(), kMax_UInt, min(), n, NULL, s_CheckLZOHeader(), and CCompression::SetError().

Referenced by CT_DecompressBuffer(), CChangePhyloTreeCommand::Execute(), and CChangePhyloTreeCommand::Unexecute().

Decompress data in the buffer.

Note

The decompressor stops and returns TRUE, if it find logical end in the compressed data, even not all compressed data was processed. Only for case of decompressing concatenated gzip files in memory it try to decompress data behind of logical end of recurrent gzip chunk, to check on next portion of data. See fCheckFileHeader, fAllowConcatenatedGZip and fGZip flags description.

Parameters

src_buf Source buffer. src_len Size of data in source buffer. dst_buf Destination buffer. It must be large enough to hold all of the uncompressed data for the operation to complete. dst_size Size of destination buffer. dst_len Size of decompressed data in destination buffer.

Returns

Return TRUE if operation was successfully or FALSE otherwise. On success, 'dst_buf' contains decompressed data of dst_len size.

See also

CompressBuffer, EFlags

Implements ICompression.

Referenced by CT_DecompressBuffer(), and CResultZBtSrcX::ReadLength().

Decompress data in the buffer.

Note

The decompressor stops and returns TRUE, if it find logical end in the compressed data, even not all compressed data was processed. Only for case of decompressing concatenated gzip files in memory it try to decompress data behind of logical end of recurrent gzip chunk, to check on next portion of data. See fCheckFileHeader, fAllowConcatenatedGZip and fGZip flags description.

Parameters

src_buf Source buffer. src_len Size of data in source buffer. dst_buf Destination buffer. It must be large enough to hold all of the uncompressed data for the operation to complete. dst_size Size of destination buffer. dst_len Size of decompressed data in destination buffer.

Returns

Return TRUE if operation was successfully or FALSE otherwise. On success, 'dst_buf' contains decompressed data of dst_len size.

See also

CompressBuffer, EFlags

Implements ICompression.

Decompress block of data in the cache buffer.

Definition at line 1614 of file lzo.cpp.

References CLZOCompression::DecompressBlock(), ERR_COMPRESS, CLZOCompression::FormatErrorMessage(), CLZODecompressor::m_BlockLen, CLZODecompressor::m_HeaderFlags, CLZOBuffer::m_InBuf, CLZOBuffer::m_InLen, CLZOBuffer::m_OutBegPtr, CLZOBuffer::m_OutBuf, CLZOBuffer::m_OutEndPtr, CLZOBuffer::m_OutSize, and memmove.

Referenced by CLZODecompressor::Finish(), and CLZODecompressor::Process().

Decompress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a decompressor. decompression_in_bufsize Size of the internal buffer holding input data to be decompressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. decompression_out_bufsize Size of the internal buffer to receive data from a decompressor.

Returns

Return TRUE on success, FALSE on error.

See also

CompressFile, GetRecommendedBufferSizes, CBZip2CompressionFile

Implements ICompression.

Decompress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a decompressor. decompression_in_bufsize Size of the internal buffer holding input data to be decompressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. decompression_out_bufsize Size of the internal buffer to receive data from a decompressor.

Returns

Return TRUE on success, FALSE on error.

See also

CompressFile, GetRecommendedBufferSizes, CLZOCompressionFile

Implements ICompression.

Definition at line 762 of file lzo.cpp.

References CLZOCompressionFile::Close(), CCompressionFile::eMode_Read, CLZOCompression::GetBlockSize(), CCompression::GetErrorCode(), CCompression::GetErrorDescription(), CCompression::GetFlags(), CLZOCompression::GetLevel(), CLZOCompressionFile::Open(), CLZOCompression::SetBlockSize(), CCompression::SetError(), CCompression::SetFlags(), and CCompression::x_DecompressFile().

Decompress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a decompressor. decompression_in_bufsize Size of the internal buffer holding input data to be decompressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. decompression_out_bufsize Size of the internal buffer to receive data from a decompressor.

Returns

Return TRUE on success, FALSE on error.

See also

CompressFile, DecompressFileIntoDir, GetRecommendedBufferSizes, CZipCompressionFile

Note

CompressFile() method, as well as some gzip utilities, always keeps the original file name and timestamp in the compressed file. If fRestoreFileAttr flag is set, that timestamp, stored in the file header will be restored. The original file name cannot be restored here, see DecompressFileIntoDir().

Implements ICompression.

Decompress file.

Parameters

src_file File name of source file. dst_file File name of result file. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a decompressor. decompression_in_bufsize Size of the internal buffer holding input data to be decompressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. decompression_out_bufsize Size of the internal buffer to receive data from a decompressor.

Returns

Return TRUE on success, FALSE on error.

See also

CompressFile, DecompressFileIntoDir, GetRecommendedBufferSizes, CZipCloudflareCompressionFile

Note

CompressFile() method, as well as some gzip utilities, always keeps the original file name and timestamp in the compressed file. If fRestoreFileAttr flag is set, that timestamp, stored in the file header will be restored. The original file name cannot be restored here, see DecompressFileIntoDir().

Implements ICompression.

Decompress file into specified directory.

Parameters

src_file File name of source file. dst_dir Destination directory. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a decompressor. decompression_in_bufsize Size of the internal buffer holding input data to be decompressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. decompression_out_bufsize Size of the internal buffer to receive data from a decompressor.

Returns

Return TRUE on success, FALSE on error.

See also

CompressFile, DecompressFile, GetRecommendedBufferSizes, CZipCompressionFile

Note

CompressFile() method, as well as some gzip utilities, always keeps the original file name and timestamp in the compressed file. If fRestoreFileAttr flag is set, that original file name and timestamp, stored in the file header will be restored. If not, that destination file will be named as archive name without extension.

Decompress file into specified directory.

Parameters

src_file File name of source file. dst_dir Destination directory. file_io_bufsize Size of the buffer used to read from a source file. Writing happens immediately on receiving some data from a decompressor. decompression_in_bufsize Size of the internal buffer holding input data to be decompressed. It can be different from 'file_io_bufsize' depending on a using compression method, OS and file system. decompression_out_bufsize Size of the internal buffer to receive data from a decompressor.

Returns

Return TRUE on success, FALSE on error.

See also

CompressFile, DecompressFile, GetRecommendedBufferSizes, CZipCloudflareCompressionFile

Note

CompressFile() method, as well as some gzip utilities, always keeps the original file name and timestamp in the compressed file. If fRestoreFileAttr flag is set, that original file name and timestamp, stored in the file header will be restored. If not, that destination file will be named as archive name without extension.

Free all dynamically allocated data structures.

This function discards any unprocessed input and does not flush any pending output.

Parameters

abandon If this parameter is not zero that skip all error checks, always return eStatus_Success. Use it if Process/Flush/Finish where not called to perform any compression/decompression after Init().

Implements CCompressionProcessor.

Free all dynamically allocated data structures.

This function discards any unprocessed input and does not flush any pending output.

Parameters

abandon If this parameter is not zero that skip all error checks, always return eStatus_Success. Use it if Process/Flush/Finish where not called to perform any compression/decompression after Init().

Implements CCompressionProcessor.

Free all dynamically allocated data structures.

This function discards any unprocessed input and does not flush any pending output.

Parameters

abandon If this parameter is not zero that skip all error checks, always return eStatus_Success. Use it if Process/Flush/Finish where not called to perform any compression/decompression after Init().

Implements CCompressionProcessor.

Free all dynamically allocated data structures.

This function discards any unprocessed input and does not flush any pending output.

Parameters

abandon If this parameter is not zero that skip all error checks, always return eStatus_Success. Use it if Process/Flush/Finish where not called to perform any compression/decompression after Init().

Implements CCompressionProcessor.

Free all dynamically allocated data structures.

This function discards any unprocessed input and does not flush any pending output.

Parameters

abandon If this parameter is not zero that skip all error checks, always return eStatus_Success. Use it if Process/Flush/Finish where not called to perform any compression/decompression after Init().

Implements CCompressionProcessor.

Free all dynamically allocated data structures.

This function discards any unprocessed input and does not flush any pending output.

Parameters

abandon If this parameter is not zero that skip all error checks, always return eStatus_Success. Use it if Process/Flush/Finish where not called to perform any compression/decompression after Init().

Implements CCompressionProcessor.

Return archive size as if all specified input entries were put in it.

Note that the return value is not the exact but the upper bound of what the archive size can be expected. This call does not recurse into any subdirectories but relies solely upon the information as passed via the parameter.

The returned size includes all necessary alignments and padding.

Returns

An upper estimate of archive size given that all specified files were stored in it (the actual size may turn out to be smaller).

Definition at line 4611 of file tar.cpp.

References ALIGN_SIZE, BLOCK_SIZE, f, ITERATE, STarHeader::name, padding, result, s_BaseDir(), s_ToArchiveName(), s_ToFilesystemPath(), and SIZE_OF.

Estimate buffer size for data compression.

The function shall estimate the size of buffer required to compress specified number of bytes of data using the CompressBuffer() function. This function may return a conservative value that may be larger than 'src_len'.

Parameters

src_len Size of data in source buffer.

Returns

Estimated buffer size. 0 if unable to determine.

Note

This method ignores used dictionary.

See also

CompressBuffer

Implements ICompression.

Estimate buffer size for data compression.

The function shall estimate the size of buffer required to compress specified number of bytes of data using the CompressBuffer() function. This function may return a conservative value that may be larger than 'src_len'.

Parameters

src_len Size of data in source buffer.

Returns

Estimated buffer size. 0 if unable to determine.

Note

This method ignores used dictionary.

See also

CompressBuffer

Implements ICompression.

Create and return an IReader, which can extract contents of one named file (which can be requested by a name mask in the "name" parameter).

The tar archive is deemed to be in the specified stream "is", properly positioned (either at the beginning of the archive, or at any CTarEntryInfo::GetPosition(ePos_Header)'s result possibly off-set with some fixed archive base position, e.g. if there is any preamble). The extraction is done at the first matching entry only, then stops.

Note

fStreamPipeThrough will be ignored if passed in flags. See test suite (in test/test_tar.cpp) for a usage example.

Returns

IReader interface to read the file contents with; 0 on error.

See also

CTarEntryInfo::GetPosition, Extract, SetMask, SetFlags, GetNextEntryInfo, GetNextEntryData, IReader, CRStream

Definition at line 4759 of file tar.cpp.

References _ASSERT, CTar::CTar(), CTar::CTarReader, CTarEntryInfo::eFile, CTar::eInternal, eTakeOwnership, CTarEntryInfo::eUnknown, flags, CTar::fSkipUnsupported, CTar::fStreamPipeThrough, and mask.

Extract the entire archive.

Extract all archive entries, whose names match the preset mask. Entries will be extracted into either current directory or a directory otherwise specified by SetBaseDir().

Returns

A list of entries that have been actually extracted.

See also

SetMask, SetBaseDir

Definition at line 342 of file archive.cpp.

References ARCHIVE_CHECK, CDirEntry::eDir, CArchive::eExtract, entries, F_ISSET, CArchive::fPreserveAll, ITERATE, CArchive::x_Open(), CArchive::x_ReadAndProcess(), and CArchive::x_RestoreAttrs().

Extract the entire archive (into either current directory or a directory otherwise specified by SetBaseDir()).

If the same-named files exist, they will be replaced (subject to fOverwrite) or backed up (fBackup), unless fUpdate is set, which would cause the replacement / backup only if the files are older than the archive entries. Note that if the fOverwrite bit is stripped, then no matching files will be updated / backed up / overwritten, but skipped.

Extract all archive entries, whose names match the pre-set mask.

Note

Unlike Append(), extracting a matching directory does *not* automatically extract all files within: for them to be extracted, they still must match the mask. So if there is a directory "dir/" stored in the archive, the extract mask can be "dir/*" for the entire subtree to be extracted. Note that "dir/" will only extract the directory itself, and "dir" won't cause that directory to be extracted at all (mismatch due to the trailing slash '/' missing).

Returns

A list of entries that have been actually extracted.

See also

SetMask, SetBaseDir, SetFlags

Definition at line 1632 of file tar.cpp.

References CTarEntryInfo::eDir, CTar::eExtract, entries, CTar::fPreserveAll, ITERATE, CTar::m_Flags, CTar::x_Open(), CTar::x_ReadAndProcess(), and CTar::x_RestoreAttrs().

Referenced by CDownloadJob::x_DownloadAndExtract().

Definition at line 532 of file archive.cpp.

References ARCHIVE, ARCHIVE_THROW1, CDirEntry::eBlockSpecial, CDirEntry::eCharSpecial, CDirEntry::eDir, CDirEntry::eFile, CDirEntry::eLink, CDirEntry::ePipe, CDirEntry::GetPath(), CArchiveEntryInfo::GetType(), and CArchive::m_Current.

Referenced by CArchive::x_ExtractEntry().

Extracts an archive file using user-defined callback to process extracted data.

Do nothing for entries of other types.

Parameters

info Entry to extract. callback User callback for processing extracted data on the fly.

See also

ExtractEntryToFileSystem, ExtractEntryToMemory, CArchiveEntryInfo::GetSize

Implements IArchive.

Definition at line 443 of file archive_zip.cpp.

References _ASSERT, data, CDirEntry::eDir, IArchive::eRead, info, IArchive::m_Mode, mz_zip_reader_extract_to_callback(), s_ZipExtractCallback(), NStr::SizetToString(), ZIP_CHECK, ZIP_HANDLE, and ZIP_THROW.

Extracts an archive entry to file system.

Parameters

info Entry to extract. dst_path Destination path for extracted entry.

Note

This method do not set last accessed and modified times. See CArchive.

See also

ExtractEntryToMemory, ExtractEntryToCallback, CArchiveEntryInfo::GetSize

Implements IArchive.

Definition at line 370 of file archive_zip.cpp.

References _ASSERT, CDirEntry::eDir, IArchive::eRead, info, IArchive::m_Mode, MZ_FCLOSE, MZ_FILE, MZ_FOPEN, mz_zip_file_write_callback(), mz_zip_reader_extract_to_callback(), NStr::SizetToString(), ZIP_CHECK, ZIP_HANDLE, and ZIP_THROW.

Extracts an archive file to a memory buffer.

Do nothing for entries of other types.

Parameters

info Entry to extract. buf Memory buffer for extracted data. size Size of memory buffer. Note, that the buffer size should be big enough to fit whole extracted file.

See also

ExtractEntryToFileSystem, ExtractEntryToCallback, CArchiveEntryInfo::GetSize

Implements IArchive.

Definition at line 402 of file archive_zip.cpp.

References _ASSERT, buf, CDirEntry::eDir, IArchive::eRead, info, IArchive::m_Mode, mz_zip_reader_extract_to_mem(), ncbi::grid::netcache::search::fields::size, NStr::SizetToString(), ZIP_CHECK, ZIP_HANDLE, and ZIP_THROW.

Extract single file entry using user-defined callback.

Parameters

info [in] Entry to extract. callback [in] User callback for processing extracted data on the fly.

See also

ExtractFileToMemory, EctractFileToHeap, CArchiveEntryInfo::GetSize, List

Definition at line 434 of file archive.cpp.

References ARCHIVE, ARCHIVE_THROW_INFO, CArchive::eExtract, CDirEntry::eFile, CDirEntry::eUnknown, F_ISSET, CArchive::fSkipUnsupported, info, kEmptyStr, and CArchive::x_Open().

Extract single file entry to a dynamically allocated memory buffer.

Parameters

info [in] Entry to extract. buf_ptr [out] Pointer to an allocated memory buffer. buf_size_ptr [out] Size of allocated memory buffer, it is equal to the size of extracted data.

Note

Do not forget to deallocate memory buffer after usage. Use free() or AutoPtr<char, CDeleter<char>>.

See also

ExtractFileToMemory, EctractFileToCallback, CArchiveEntryInfo::GetSize, List

Definition at line 385 of file archive.cpp.

References ARCHIVE_CHECK, ARCHIVE_THROW, ARCHIVE_THROW_INFO, CDirEntry::eFile, CDirEntry::eUnknown, CArchive::ExtractFileToMemory(), F_ISSET, free(), CArchive::fSkipUnsupported, get_limits(), info, NStr::Int8ToString(), kEmptyStr, malloc(), NCBI_THROW, and NULL.

Extract single file entry to a memory buffer.

Parameters

info [in] Entry to extract. buf [in] Memory buffer for extracted data. buf_size [in] Size of memory buffer. out_size [out] Size of extracted data in the buffer.

Note

The buffer size should be big enough to fit whole extracted file.

See also

ExtractFileToHeap, EctractFileToCallback, CArchiveEntryInfo::GetSize, List

Definition at line 359 of file archive.cpp.

References ARCHIVE, ARCHIVE_CHECK, ARCHIVE_THROW_INFO, buf, CArchive::eExtract, CDirEntry::eFile, CDirEntry::eUnknown, F_ISSET, CArchive::fSkipUnsupported, info, kEmptyStr, NCBI_THROW, and CArchive::x_Open().

Referenced by CArchive::ExtractFileToHeap().

Finalize the archive created in memory.

Return pointer to a buffer with created archive and its size. After this call you cannot write to archive anymore, but you can read from it. Returning pointer to buffer and its size also will be saved internally and used for opening archive for reading (see constructor).

Parameters

buf_ptr Pointer to an archive located in memory. buf_size_ptr Size of the newly created archive.

Note

Do not forget to deallocate memory buffer after usage. Use free() or AutoPtr<char, CDeleter<char>>.

See also

Create, Close

Definition at line 1194 of file archive.cpp.

References ARCHIVE, ARCHIVE_CHECK, CArchiveMemory::m_Buf, CArchiveMemory::m_BufSize, and NCBI_THROW.

Finalize the archive created in memory.

Return pointer to buffer with created archive and its size. The only valid operation after this call is Close().

Parameters

buf Pointer to an archive located in memory. size Size of the newly created archive.

Note

Do not forget to deallocate memory buffer after usage.

See also

CreateMemory, Close

Implements IArchive.

Definition at line 214 of file archive_zip.cpp.

References _ASSERT, buf, IArchive::eMemory, IArchive::eWrite, free(), IArchive::m_Location, IArchive::m_Mode, mz_zip_writer_finalize_heap_archive(), NULL, ncbi::grid::netcache::search::fields::size, ZIP_CHECK, ZIP_HANDLE, and ZIP_THROW.

Finalize the archive created in memory.

Return pointer to buffer with created archive and its size. The only valid operation after this call is Close().

Parameters

buf Pointer to an archive located in memory. size Size of the newly created archive.

Note

Do not forget to deallocate memory buffer after usage.

See also

CreateMemory, Close

Implemented in CArchiveZip.

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Definition at line 1236 of file lzo.cpp.

References _VERIFY, CLZOCompressor::CompressCache(), ERR_COMPRESS, CCompressionProcessor::eStatus_EndOfData, CCompressionProcessor::eStatus_Error, CCompressionProcessor::eStatus_Overflow, CCompressionProcessor::eStatus_Success, F_ISSET, CLZOCompression::fAllowEmptyData, CLZOCompressor::Flush(), CLZOCompression::FormatErrorMessage(), CCompression::GetFlags(), CCompressionProcessor::GetProcessedSize(), CLZOCompression::m_BlockSize, CLZOCompressor::m_FileInfo, CLZOBuffer::m_InLen, CLZOCompressor::m_NeedWriteHeader, CLZOBuffer::m_OutBegPtr, CLZOBuffer::m_OutEndPtr, CLZOBuffer::m_OutSize, s_WriteLZOHeader(), CCompression::SetError(), and CCompressionUtil::StoreUI4().

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Definition at line 1546 of file lzo.cpp.

References CLZODecompressor::DecompressCache(), CCompression::eMode_Unknown, ERR_COMPRESS, CCompressionProcessor::eStatus_EndOfData, CCompressionProcessor::eStatus_Error, CCompressionProcessor::eStatus_Overflow, CCompressionProcessor::eStatus_Success, F_ISSET, CLZOCompression::fAllowEmptyData, CLZODecompressor::Flush(), CLZOCompression::FormatErrorMessage(), kMinHeaderSize, CLZODecompressor::m_BlockLen, CLZODecompressor::m_Cache, CCompression::m_DecompressMode, CLZODecompressor::m_HeaderLen, CLZOBuffer::m_InLen, CLZOBuffer::m_OutBegPtr, CLZOBuffer::m_OutEndPtr, CLZODecompressor::Process(), and CCompression::SetError().

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implements CCompressionProcessor.

Finish the compression/decompression process.

Process pending input, flush pending output. This function slightly like to Flush(), but it must be called only at the end of compression process just before End().

Implemented in CZipCloudflareDecompressor, CZipCloudflareCompressor, CZipDecompressor, CZipCompressor, CTransparentProcessor, CLZODecompressor, CLZOCompressor, CBZip2Decompressor, and CBZip2Compressor.

Flush compressed/decompressed data from the output buffer.

Flushing may degrade compression for some compression algorithms and so it should be used only when necessary.

Implements CCompressionProcessor.

Flush compressed/decompressed data from the output buffer.

Flushing may degrade compression for some compression algorithms and so it should be used only when necessary.

Implements CCompressionProcessor.

Flush compressed/decompressed data from the output buffer.

Flushing may degrade compression for some compression algorithms and so it should be used only when necessary.

Implements CCompressionProcessor.

Definition at line 1519 of file lzo.cpp.

References CCompression::eMode_Unknown, CCompressionProcessor::eStatus_Overflow, CCompressionProcessor::eStatus_Success, CCompressionProcessor::IncreaseOutputSize(), CCompression::m_DecompressMode, CLZOBuffer::m_OutBegPtr, CLZOBuffer::m_OutBuf, CLZOBuffer::m_OutEndPtr, min(), and n.

Referenced by CLZODecompressor::Finish(), and CLZODecompressor::Process().

Flush compressed/decompressed data from the output buffer.

Flushing may degrade compression for some compression algorithms and so it should be used only when necessary.

Implements CCompressionProcessor.

Flush compressed/decompressed data from the output buffer.

Flushing may degrade compression for some compression algorithms and so it should be used only when necessary.

Implements CCompressionProcessor.

Flush compressed/decompressed data from the output buffer.

Flushing may degrade compression for some compression algorithms and so it should be used only when necessary.

Implements CCompressionProcessor.

Flush compressed/decompressed data from the output buffer.

Flushing may degrade compression for some compression algorithms and so it should be used only when necessary.

Implements CCompressionProcessor.

Format string with last error description.

Format string with last error description.

If pos == 0, that use internal m_Stream's position to report.

Format string with last error description.

If pos == 0, that use internal m_Stream's position to report.

Get list of positions of separate gzip files in the concatenated gzip file.

Return results via user defined handler. Throw CCoreException/CCompressionException on error.

Parameters

is Opened input stream to scan (should be opened in binary mode). handler Call handler's IChunkHandler::OnChunk() method and pass position of each new gzip file inside a stream and size of uncompressed data on that moment.

Note

This method don't support concatenated .gz files compressed with a dictionary.

Get list of positions of separate gzip files in the concatenated gzip file.

Return results via user defined handler. Throw CCoreException/CCompressionException on error.

Parameters

is Opened input stream to scan (should be opened in binary mode). handler Call handler's IChunkHandler::OnChunk() method and pass position of each new gzip file inside a stream and size of uncompressed data on that moment.

Note

This method don't support concatenated .gz files compressed with a dictionary.

Referenced by CLDS2_UrlHandler_GZipFile::SaveChunks().

Get base directory to use for files while extracting from/adding to the archive, and in the latter case used only for relative paths.

See also

SetBaseDir

Definition at line 299 of file archive.hpp.

References CArchive::m_BaseDir.

Get base directory to use for files while extracting from/adding to the archive, and in the latter case used only for relative paths.

See also

SetBaseDir

Definition at line 873 of file tar.hpp.

References CTar::m_BaseDir.

LZO can compress/decompress data limited by its 'lzo_uint' type.

Definition at line 858 of file lzo.cpp.

References max().

This is an artifical limit.

You can use block size as low as 1, but overhead will be too big for practical reasons.

Definition at line 855 of file lzo.cpp.

Get error description for specified error code.

Get detailed information about an archive entry by index.

Parameters

index Zero-based index of entry in the archive. info Pointer to entry information structure that will be filled with information about entry with specified index.

Note

Note that the archive can contain multiple versions of the same entry (in case if an update was done on it), all of which but the last one are to be ignored.

See also

CArchiveEntryInfo

Implements IArchive.

Definition at line 279 of file archive_zip.cpp.

References _ASSERT, CDirEntry::eDir, CDirEntry::eFile, IArchive::eRead, CDirEntry::eUnknown, CDirEntry::GetType(), info, kMax_UInt, mz_zip_archive_file_stat::m_comment, mz_zip_archive_file_stat::m_comment_size, mz_zip_archive_file_stat::m_comp_size, mz_zip_archive_file_stat::m_external_attr, mz_zip_archive_file_stat::m_filename, IArchive::m_Mode, mz_zip_archive_file_stat::m_time, mz_zip_archive_file_stat::m_uncomp_size, mz_zip_archive_file_stat::m_version_made_by, mz_zip_reader_file_stat(), mz_zip_reader_is_file_a_directory(), NCBI_THROW, NStr::SizetToString(), ZIP_CHECK, ZIP_HANDLE, and ZIP_THROW.

Get detailed information about an archive entry by index.

Parameters

index Zero-based index of entry in the archive. info Pointer to entry information structure that will be filled with information about entry with specified index.

Note

Note that the archive can contain multiple versions of the same entry (in case if an update was done on it), all of which but the last one are to be ignored.

See also

CArchiveEntryInfo

Implemented in CArchiveZip.

Translate from an error code value to its string representation.

Reimplemented from CCoreException.

Definition at line 81 of file archive_.hpp.

References CArchiveException::eAppend, CArchiveException::eBackup, CArchiveException::eBadName, CArchiveException::eClose, CArchiveException::eCreate, CArchiveException::eExtract, CArchiveException::eList, CArchiveException::eMemory, CArchiveException::eOpen, CArchiveException::eRestoreAttrs, CArchiveException::eUnsupported, CArchiveException::eUnsupportedEntryType, CArchiveException::eWrite, CCoreException::GetErrCode(), and CException::GetErrCodeString().

Translate from an error code value to its string representation.

Reimplemented from CCoreException.

Definition at line 127 of file tar.hpp.

References CTarException::eBackup, CTarException::eBadName, CTarException::eChecksum, CTarException::eCreate, CTarException::eMemory, CTarException::eNameTooLong, CTarException::eOpen, CTarException::eRead, CTarException::eRestoreAttrs, CTarException::eUnsupportedEntryType, CTarException::eUnsupportedSource, CTarException::eUnsupportedTarFormat, CTarException::eWrite, CCoreException::GetErrCode(), and CException::GetErrCodeString().

Implemented in CCompression.

Get/set flags.

Implements ICompression.

Definition at line 105 of file compress.cpp.

References CCompression::m_Flags.

Referenced by CBZip2Compressor::AllowEmptyData(), CBZip2Decompressor::AllowEmptyData(), CLZOCompressor::AllowEmptyData(), CLZODecompressor::AllowEmptyData(), CZipCompressor::AllowEmptyData(), CZipDecompressor::AllowEmptyData(), CZipCloudflareCompressor::AllowEmptyData(), CZipCloudflareDecompressor::AllowEmptyData(), CLZOCompression::CompressBuffer(), CLZOCompression::CompressFile(), CResultZBtSrcX::CResultZBtSrcX(), CT_CompressBuffer(), CT_DecompressBuffer(), CLZOCompression::DecompressBuffer(), CLZOCompression::DecompressFile(), CLZOCompression::EstimateCompressionBufferSize(), CLZOCompressor::Finish(), CLZOCompressionFile::Open(), and CLZOCompressor::Process().

Implemented in CCompression.

Get compression level.

Note

bzip2 doesn't support zero level compression, so eLevel_NoCompression will be translated to eLevel_Lowest.

Reimplemented from CCompression.

Create and return an IReader, which can extract the current archive entry that has been previously returned via GetNextEntryInfo.

The returned pointer is non-zero only if the current entry is a file (even of size 0). The ownership of the pointer is passed to the caller (so it has to be explicitly deleted when no longer needed). The IReader may be used to read all or part of data out of the entry without affecting GetNextEntryInfo()'s ability to find any following entry in the archive. See test suite (in test/test_tar.cpp) for a usage example.

Returns

Pointer to IReader, or 0 if the current entry is not a file.

See also

GetNextEntryData, IReader, CRStream

Definition at line 4790 of file tar.cpp.

References CTar::CTarReader, CTarEntryInfo::eFile, CTarEntryInfo::eUnknown, CTar::fSkipUnsupported, CTarEntryInfo::GetType(), CTar::m_Current, and CTar::m_Flags.

Iterate over the archive forward and return first (or next) entry.

When using this method (possibly along with GetNextEntryData()), the archive stream (if any) must not be accessed outside the CTar API, because otherwise inconsistency in data may result. An application may call GetNextEntryData() to stream some or all of the data out of this entry, or it may call GetNextEntryInfo() again to skip to the next archive entry, etc. Note that the archive can contain multiple versions of the same entry (in case if an update was done on it), all of which but the last one are to be ignored. This call traverses through all those entry versions, and sequentially exposes them to the application level. See test suite (in test/test_tar.cpp) for a usage example.

Returns

Pointer to next entry info in the archive or 0 if EOF encountered.

See also

CTarEntryInfo, GetNextEntryData

Definition at line 1650 of file tar.cpp.

References _ASSERT, ALIGN_SIZE, BLOCK_OF, CTar::eInternal, CTarEntryInfo::ePos_Data, CTar::eRO, CTarEntryInfo::GetPosition(), CTarEntryInfo::GetSize(), CTar::m_Bad, CTar::m_Current, CTar::m_OpenMode, CTar::m_StreamPos, CTar::x_Open(), CTar::x_ReadAndProcess(), and CTar::x_Skip().

Returns the total number of entries in the archive.

Implemented in CArchiveZip.

Get recommended buffer sizes for stream/file I/O.

These buffer sizes are softly recommended. They are not required, (de)compression streams accepts any reasonable buffer size, for both input and output. Respecting the recommended size just makes it a bit easier for (de)compressor, reducing the amount of memory shuffling and buffering, resulting in minor performance savings. If compression library doesn't have preferences about I/O buffer sizes, kCompressionDefaultBufSize will be used.

Parameters

round_up If specified, round up a returned value by specified amount. Useful for better memory management. For example you can round up to virtual memory page size.

Returns

Structure with recommended buffer sizes.

Note

Applicable for streaming/file operations.

See also

kCompressionDefaultBufSize, CSystemInfo::GetVirtualMemoryPageSize()

Get recommended buffer sizes for stream/file I/O.

These buffer sizes are softly recommended. They are not required, (de)compression streams accepts any reasonable buffer size, for both input and output. Respecting the recommended size just makes it a bit easier for (de)compressor, reducing the amount of memory shuffling and buffering, resulting in minor performance savings. If compression library doesn't have preferences about I/O buffer sizes, kCompressionDefaultBufSize will be used.

Parameters

round_up_by If specified, round up a returned value by specified amount. Useful for better memory management. For example you can round up to virtual memory page size.

Returns

Structure with recommended buffer sizes.

Note

Applicable for streaming/file operations.

See also

kCompressionDefaultBufSize, CSystemInfo::GetVirtualMemoryPageSize()

Definition at line 719 of file lzo.cpp.

References CCompression::SRecommendedBufferSizes::compression_in, CCompression::SRecommendedBufferSizes::compression_out, CCompression::SRecommendedBufferSizes::decompression_in, CCompression::SRecommendedBufferSizes::decompression_out, kCompressionDefaultBufSize, and CCompression::SRecommendedBufferSizes::RoundUp().

Get recommended buffer sizes for stream/file I/O.

These buffer sizes are softly recommended. They are not required, (de)compression streams accepts any reasonable buffer size, for both input and output. Respecting the recommended size just makes it a bit easier for (de)compressor, reducing the amount of memory shuffling and buffering, resulting in minor performance savings. If compression library doesn't have preferences about I/O buffer sizes, kCompressionDefaultBufSize will be used.

Parameters

round_up_by If specified, round up a returned value by specified amount. Useful for better memory management. For example you can round up to virtual memory page size.

Returns

Structure with recommended buffer sizes.

Note

Applicable for streaming/file operations.

See also

kCompressionDefaultBufSize, CSystemInfo::GetVirtualMemoryPageSize()

Get recommended buffer sizes for stream/file I/O.

These buffer sizes are softly recommended. They are not required, (de)compression streams accepts any reasonable buffer size, for both input and output. Respecting the recommended size just makes it a bit easier for (de)compressor, reducing the amount of memory shuffling and buffering, resulting in minor performance savings. If compression library doesn't have preferences about I/O buffer sizes, kCompressionDefaultBufSize will be used.

Parameters

round_up_by If specified, round up a returned value by specified amount. Useful for better memory management. For example you can round up to virtual memory page size.

Returns

Structure with recommended buffer sizes.

Note

Applicable for streaming/file operations.

See also

kCompressionDefaultBufSize, CSystemInfo::GetVirtualMemoryPageSize()

Get error code/description of last stream operation (m_Stream).

It can be received using GetErrorCode()/GetErrorDescription() methods.

Get error code/description of last stream operation (m_Stream).

It can be received using GetErrorCode()/GetErrorDescription() methods.

Return name and version of the compression library.

Implements CCompression.

Return name and version of the compression library.

Implements CCompression.

Definition at line 154 of file lzo.cpp.

Return name and version of the compression library.

Implements CCompression.

Return name and version of the compression library.

Implements CCompression.

Implemented in CArchiveZip.

Implemented in CArchiveZip.

Initialize the internal stream state for compression/decompression.

It does not perform any compression, this will be done by Process().

Implements CCompressionProcessor.

Initialize the internal stream state for compression/decompression.

It does not perform any compression, this will be done by Process().

Implements CCompressionProcessor.

Initialize the internal stream state for compression/decompression.

It does not perform any compression, this will be done by Process().

Implements CCompressionProcessor.

Definition at line 1133 of file lzo.cpp.

References CCompression::eMode_Unknown, CCompressionProcessor::eStatus_Success, CLZOCompression::EstimateCompressionBufferSize(), CLZOCompression::GetLevel(), CLZOCompression::InitCompression(), CLZOCompression::m_BlockSize, CCompression::m_DecompressMode, CLZOCompressor::m_NeedWriteHeader, CCompressionProcessor::Reset(), CLZOBuffer::ResetBuffer(), CCompressionProcessor::SetBusy(), and CCompression::SetError().