The BitCompressor template class allows compressing files into archives. More...

#include <bit7z/bitcompressor.hpp>

Inheritance diagram for BitCompressor< Input >:

Collaboration diagram for BitCompressor< Input >:

Public Member Functions
	BitCompressor (Bit7zLibrary const &lib, BitInOutFormat const &format)
	Constructs a BitCompressor object.

void	clearPassword () noexcept
	Clear the current password used by the handler.

void	compressFile (Input inFile, const tstring &outFile, const tstring &inputName={}) const
	Compresses a single file.

void	compressFile (Input inFile, ostream &outStream, const tstring &inputName={}) const
	Compresses the input file to the output stream.

void	compressFile (Input inFile, vector< byte_t > &outBuffer, const tstring &inputName={}) const
	Compresses the input file to the output buffer.

auto	compressionFormat () const noexcept -> const BitInOutFormat &

auto	compressionLevel () const noexcept -> BitCompressionLevel

auto	compressionMethod () const noexcept -> BitCompressionMethod

auto	cryptHeaders () const noexcept -> bool

auto	dictionarySize () const noexcept -> uint32_t

auto	fileCallback () const -> FileCallback

auto	format () const noexcept -> const BitInFormat &override

auto	isPasswordDefined () const noexcept -> bool

auto	library () const noexcept -> const Bit7zLibrary &

auto	overwriteMode () const -> OverwriteMode

auto	password () const -> tstring

auto	passwordCallback () const -> PasswordCallback

auto	progressCallback () const -> ProgressCallback

auto	ratioCallback () const -> RatioCallback

auto	retainDirectories () const noexcept -> bool

void	setCompressionLevel (BitCompressionLevel level) noexcept
	Sets the compression level to be used when creating/updating an archive.

void	setCompressionMethod (BitCompressionMethod method)
	Sets the compression method to be used when creating/updating an archive.

void	setDictionarySize (uint32_t dictionarySize)
	Sets the dictionary size to be used when creating/updating an archive.

void	setFileCallback (const FileCallback &callback)
	Sets the function to be called when the current file being processed changes.

template<std::size_t N, typename T , typename = typename std::enable_if< !std::is_integral< T >::value >::type>
void	setFormatProperty (const wchar_t(&name)[N], const T &value) noexcept
	Sets a property for the output archive format as described by the 7-zip documentation (e.g., https://sevenzip.osdn.jp/chm/cmdline/switches/method.htm).

template<std::size_t N, typename T , typename = typename std::enable_if< std::is_integral< T >::value >::type>
void	setFormatProperty (const wchar_t(&name)[N], T value) noexcept
	Sets a property for the output archive format as described by the 7-zip documentation (e.g., https://sevenzip.osdn.jp/chm/cmdline/switches/method.htm).

void	setOverwriteMode (OverwriteMode mode)
	Sets how the handler should behave when it tries to output to an existing file or buffer.

void	setPassword (const tstring &password) override
	Sets up a password for the output archives.

void	setPassword (const tstring &password, bool cryptHeaders)
	Sets up a password for the output archive.

void	setPasswordCallback (const PasswordCallback &callback)
	Sets the function to be called when a password is needed to complete the ongoing operation.

void	setProgressCallback (const ProgressCallback &callback)
	Sets the function to be called when the processed size of the ongoing operation is updated.

void	setRatioCallback (const RatioCallback &callback)
	Sets the function to be called when the input processed size and current output size of the ongoing operation are known.

void	setRetainDirectories (bool retain) noexcept
	Sets whether the operations' output will preserve the input's directory structure or not.

void	setSolidMode (bool solidMode) noexcept
	Sets whether to use solid compression or not.

void	setStoreSymbolicLinks (bool storeSymlinks) noexcept
	Sets whether the creator will store symbolic links as links in the output archive.

void	setThreadsCount (uint32_t threadsCount) noexcept
	Sets the number of threads to be used when creating/updating an archive.

void	setTotalCallback (const TotalCallback &callback)
	Sets the function to be called when the total size of an operation is available.

void	setUpdateMode (bool canUpdate)
	Sets whether the creator can update existing archives or not.

virtual void	setUpdateMode (UpdateMode mode)
	Sets whether and how the creator can update existing archives or not.

void	setVolumeSize (uint64_t volumeSize) noexcept
	Sets the volumeSize (in bytes) of the output archive volumes.

void	setWordSize (uint32_t wordSize)
	Sets the word size to be used when creating/updating an archive.

auto	solidMode () const noexcept -> bool

auto	storeSymbolicLinks () const noexcept -> bool

auto	threadsCount () const noexcept -> uint32_t

auto	totalCallback () const -> TotalCallback

auto	updateMode () const noexcept -> UpdateMode

auto	volumeSize () const noexcept -> uint64_t

auto	wordSize () const noexcept -> uint32_t

Detailed Description

template<typename Input>
class bit7z::BitCompressor< Input >

The BitCompressor template class allows compressing files into archives.

It let decide various properties of the produced archive file, such as the password protection and the compression level desired.

Constructor & Destructor Documentation

◆ BitCompressor()

template<typename Input >

BitCompressor	(	Bit7zLibrary const &	lib,
		BitInOutFormat const &	format
	)

inline

Constructs a BitCompressor object.

The Bit7zLibrary parameter is needed to have access to the functionalities of the 7z DLLs. On the contrary, the BitInOutFormat is required to know the format of the output archive.

Parameters

lib	the 7z library to use.
format	the output archive format.

Member Function Documentation

◆ clearPassword()

void clearPassword ( )

noexceptinherited

Clear the current password used by the handler.

Calling clearPassword() will disable the encryption/decryption of archives.

Note: This is equivalent to calling setPassword(L"").

◆ compressFile() [1/3]

template<typename Input >

void compressFile	(	Input	inFile,
		const tstring &	outFile,
		const tstring &	inputName = `{}`
	)		const

inline

Compresses a single file.

Parameters

inFile	the file to be compressed.
outFile	the path (relative or absolute) to the output archive file.
inputName	(optional) the name to give to the compressed file inside the output archive.

◆ compressFile() [2/3]

template<typename Input >

void compressFile	(	Input	inFile,
		ostream &	outStream,
		const tstring &	inputName = `{}`
	)		const

inline

Compresses the input file to the output stream.

Parameters

inFile	the file to be compressed.
outStream	the output stream.
inputName	(optional) the name to give to the compressed file inside the output archive.

◆ compressFile() [3/3]

template<typename Input >

void compressFile	(	Input	inFile,
		vector< byte_t > &	outBuffer,
		const tstring &	inputName = `{}`
	)		const

inline

Compresses the input file to the output buffer.

Parameters

inFile	the file to be compressed.
outBuffer	the buffer going to contain the output archive.
inputName	(optional) the name to give to the compressed file inside the output archive.

◆ compressionFormat()

auto compressionFormat ( ) const -> const BitInOutFormat &

noexceptinherited

Returns: the format used for creating/updating an archive.

◆ compressionLevel()

auto compressionLevel ( ) const -> BitCompressionLevel

noexceptinherited

Returns: the compression level used for creating/updating an archive.

◆ compressionMethod()

auto compressionMethod ( ) const -> BitCompressionMethod

noexceptinherited

Returns: the compression method used for creating/updating an archive.

◆ cryptHeaders()

auto cryptHeaders ( ) const -> bool

noexceptinherited

Returns: whether the creator crypts also the headers of archives or not.

◆ dictionarySize()

auto dictionarySize ( ) const -> uint32_t

noexceptinherited

Returns: the dictionary size used for creating/updating an archive.

◆ fileCallback()

auto fileCallback ( ) const -> FileCallback

inherited

Returns: the current file callback.

◆ format()

auto format ( ) const -> const BitInFormat &override

overridevirtualnoexceptinherited

Returns: the format used for creating/updating an archive.

Implements BitAbstractArchiveHandler.

◆ isPasswordDefined()

auto isPasswordDefined ( ) const -> bool

noexceptinherited

Returns: a boolean value indicating whether a password is defined or not.

◆ library()

auto library ( ) const -> const Bit7zLibrary &

noexceptinherited

Returns: the Bit7zLibrary object used by the handler.

◆ overwriteMode()

auto overwriteMode ( ) const -> OverwriteMode

inherited

Returns: the current OverwriteMode.

◆ password()

auto password ( ) const -> tstring

inherited

Returns: the password used to open, extract, or encrypt the archive.

◆ passwordCallback()

auto passwordCallback ( ) const -> PasswordCallback

inherited

Returns: the current password callback.

◆ progressCallback()

auto progressCallback ( ) const -> ProgressCallback

inherited

Returns: the current progress callback.

◆ ratioCallback()

auto ratioCallback ( ) const -> RatioCallback

inherited

Returns: the current ratio callback.

◆ retainDirectories()

auto retainDirectories ( ) const -> bool

noexceptinherited

Returns: a boolean value indicating whether the directory structure must be preserved while extracting or compressing the archive.

◆ setCompressionLevel()

void setCompressionLevel ( BitCompressionLevel level )

noexceptinherited

Sets the compression level to be used when creating/updating an archive.

Parameters

level the compression level desired.

◆ setCompressionMethod()

void setCompressionMethod ( BitCompressionMethod method )

inherited

Sets the compression method to be used when creating/updating an archive.

Parameters

method the compression method desired.

◆ setDictionarySize()

void setDictionarySize ( uint32_t dictionarySize )

inherited

Sets the dictionary size to be used when creating/updating an archive.

Parameters

dictionarySize the dictionary size desired.

◆ setFileCallback()

void setFileCallback ( const FileCallback & callback )

inherited

Sets the function to be called when the current file being processed changes.

Parameters

callback the file callback to be used.

◆ setFormatProperty() [1/2]

template<std::size_t N, typename T , typename = typename std::enable_if< !std::is_integral< T >::value >::type>

void setFormatProperty	(	const wchar_t(&)	name[N],
		const T &	value
	)

inlinenoexceptinherited

Sets a property for the output archive format as described by the 7-zip documentation (e.g., https://sevenzip.osdn.jp/chm/cmdline/switches/method.htm).

For example, passing the string L"tm" with a false value while creating a .7z archive will disable storing the last modified timestamps of the compressed files.

Template Parameters

T	A non-integral type (i.e., a string).

Parameters

name	The string name of the property to be set.
value	The value to be used for the property.

◆ setFormatProperty() [2/2]

template<std::size_t N, typename T , typename = typename std::enable_if< std::is_integral< T >::value >::type>

void setFormatProperty	(	const wchar_t(&)	name[N],
		T	value
	)

inlinenoexceptinherited

Sets a property for the output archive format as described by the 7-zip documentation (e.g., https://sevenzip.osdn.jp/chm/cmdline/switches/method.htm).

Template Parameters

T	An integral type (i.e., a bool or an integer type).

Parameters

name	The string name of the property to be set.
value	The value to be used for the property.

◆ setOverwriteMode()

void setOverwriteMode ( OverwriteMode mode )

inherited

Sets how the handler should behave when it tries to output to an existing file or buffer.

Parameters

mode	the OverwriteMode to be used by the handler.

◆ setPassword() [1/2]

void setPassword ( const tstring & password )

overridevirtualinherited

Sets up a password for the output archives.

When setting a password, the produced archives will be encrypted using the default cryptographic method of the output format. The option "crypt headers" remains unchanged, in contrast with what happens when calling the setPassword(tstring, bool) method.

Note: Calling setPassword when the output format doesn't support archive encryption (e.g., GZip, BZip2, etc...) does not have any effects (in other words, it doesn't throw exceptions, and it has no effects on compression operations).; After a password has been set, it will be used for every subsequent operation. To disable the use of the password, you need to call the clearPassword method (inherited from BitAbstractArchiveHandler), which is equivalent to setPassword(L"").

Parameters

password the password to be used when creating/updating archives.

Reimplemented from BitAbstractArchiveHandler.

◆ setPassword() [2/2]

void setPassword	(	const tstring &	password,
		bool	cryptHeaders
	)

inherited

Sets up a password for the output archive.

When setting a password, the produced archive will be encrypted using the default cryptographic method of the output format. If the format is 7z, and the option "cryptHeaders" is set to true, the headers of the archive will be encrypted, resulting in a password request every time the output file will be opened.

Note: Calling setPassword when the output format doesn't support archive encryption (e.g., GZip, BZip2, etc...) does not have any effects (in other words, it doesn't throw exceptions, and it has no effects on compression operations).; Calling setPassword with "cryptHeaders" set to true does not have effects on formats different from 7z.; After a password has been set, it will be used for every subsequent operation. To disable the use of the password, you need to call the clearPassword method (inherited from BitAbstractArchiveHandler), which is equivalent to setPassword(L"").

Parameters

password	the password to be used when creating/updating archives.
cryptHeaders	if true, the headers of the output archives will be encrypted (valid only when using the 7z format).

◆ setPasswordCallback()

void setPasswordCallback ( const PasswordCallback & callback )

inherited

Sets the function to be called when a password is needed to complete the ongoing operation.

Parameters

callback the password callback to be used.

◆ setProgressCallback()

void setProgressCallback ( const ProgressCallback & callback )

inherited

Sets the function to be called when the processed size of the ongoing operation is updated.

Note: The completion percentage of the current operation can be obtained by calculating static_cast<int>((100.0 * processed_size) / total_size).

Parameters

callback the progress callback to be used.

◆ setRatioCallback()

void setRatioCallback ( const RatioCallback & callback )

inherited

Sets the function to be called when the input processed size and current output size of the ongoing operation are known.

Note: The ratio percentage of a compression operation can be obtained by calculating static_cast<int>((100.0 * output_size) / input_size).

Parameters

callback the ratio callback to be used.

◆ setRetainDirectories()

void setRetainDirectories ( bool retain )

noexceptinherited

Sets whether the operations' output will preserve the input's directory structure or not.

Parameters

retain the setting for preserving or not the input directory structure

◆ setSolidMode()

void setSolidMode ( bool solidMode )

noexceptinherited

Sets whether to use solid compression or not.

Note: Setting the solid compression mode to true has effect only when using the 7z format with multiple input files.

Parameters

solidMode if true, it will be used the "solid compression" method.

◆ setStoreSymbolicLinks()

void setStoreSymbolicLinks ( bool storeSymlinks )

noexceptinherited

Sets whether the creator will store symbolic links as links in the output archive.

Parameters

storeSymlinks if true, symbolic links will be stored as links.

◆ setThreadsCount()

void setThreadsCount ( uint32_t threadsCount )

noexceptinherited

Sets the number of threads to be used when creating/updating an archive.

Parameters

threadsCount the number of threads desired.

◆ setTotalCallback()

void setTotalCallback ( const TotalCallback & callback )

inherited

Sets the function to be called when the total size of an operation is available.

Parameters

callback the total callback to be used.

◆ setUpdateMode() [1/2]

void setUpdateMode ( bool canUpdate )

inherited

Sets whether the creator can update existing archives or not.

Deprecated:: since v4.0; it is provided just for an easier transition from the old v3 API.

Note: If set to false, a subsequent compression operation may throw an exception if it targets an existing archive.

Parameters

canUpdate if true, compressing operations will update existing archives.

◆ setUpdateMode() [2/2]

virtual void setUpdateMode ( UpdateMode mode )

virtualinherited

Sets whether and how the creator can update existing archives or not.

Note: If set to UpdateMode::None, a subsequent compression operation may throw an exception if it targets an existing archive.

Parameters

mode	the desired update mode.

Reimplemented in BitArchiveEditor.

◆ setVolumeSize()

void setVolumeSize ( uint64_t volumeSize )

noexceptinherited

Sets the volumeSize (in bytes) of the output archive volumes.

Note: This setting has effects only when the destination archive is on the filesystem.

Parameters

volumeSize The dimension of a volume.

◆ setWordSize()

void setWordSize ( uint32_t wordSize )

inherited

Sets the word size to be used when creating/updating an archive.

Parameters

wordSize the word size desired.

◆ solidMode()

auto solidMode ( ) const -> bool

noexceptinherited

Returns: whether the archive creator uses solid compression or not.

◆ storeSymbolicLinks()

auto storeSymbolicLinks ( ) const -> bool

noexceptinherited

Returns: whether the archive creator stores symbolic links as links in the output archive.

◆ threadsCount()

auto threadsCount ( ) const -> uint32_t

noexceptinherited

Returns: the number of threads used when creating/updating an archive (a 0 value means that it will use the 7-zip default value).

◆ totalCallback()

auto totalCallback ( ) const -> TotalCallback

inherited

Returns: the current total callback.

◆ updateMode()

auto updateMode ( ) const -> UpdateMode

noexceptinherited

Returns: the update mode used when updating existing archives.

◆ volumeSize()

auto volumeSize ( ) const -> uint64_t

noexceptinherited

Returns: the volume size (in bytes) used when creating multi-volume archives (a 0 value means that all files are going in a single archive).

◆ wordSize()

auto wordSize ( ) const -> uint32_t

noexceptinherited

Returns: the word size used for creating/updating an archive.

The documentation for this class was generated from the following file:

include/bit7z/bitcompressor.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BitCompressor()

Member Function Documentation

◆ clearPassword()

◆ compressFile() [1/3]

◆ compressFile() [2/3]

◆ compressFile() [3/3]

◆ compressionFormat()

◆ compressionLevel()

◆ compressionMethod()

◆ cryptHeaders()

◆ dictionarySize()

◆ fileCallback()

◆ format()

◆ isPasswordDefined()

◆ library()

◆ overwriteMode()

◆ password()

◆ passwordCallback()

◆ progressCallback()

◆ ratioCallback()

◆ retainDirectories()

◆ setCompressionLevel()

◆ setCompressionMethod()

◆ setDictionarySize()

◆ setFileCallback()

◆ setFormatProperty() [1/2]

◆ setFormatProperty() [2/2]

◆ setOverwriteMode()

◆ setPassword() [1/2]

◆ setPassword() [2/2]

◆ setPasswordCallback()

◆ setProgressCallback()

◆ setRatioCallback()

◆ setRetainDirectories()

◆ setSolidMode()

◆ setStoreSymbolicLinks()

◆ setThreadsCount()

◆ setTotalCallback()

◆ setUpdateMode() [1/2]

◆ setUpdateMode() [2/2]

◆ setVolumeSize()

◆ setWordSize()

◆ solidMode()

◆ storeSymbolicLinks()

◆ threadsCount()

◆ totalCallback()

◆ updateMode()

◆ volumeSize()

◆ wordSize()