The BitExtractor template class allows extracting the content of archives from supported input types. More...

#include <bit7z/bitextractor.hpp>

Inheritance diagram for BitExtractor< Input >:

Collaboration diagram for BitExtractor< Input >:

Public Member Functions
	BitExtractor (const Bit7zLibrary &lib, const BitInFormat &format=BitFormat::Auto)
	Constructs a BitExtractor object.

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

void	extract (Input inArchive, const tstring &outDir={}) const
	Extracts the given archive to the chosen directory.

void	extract (Input inArchive, std::map< tstring, vector< byte_t > > &outMap) const
	Extracts the content of the given archive into a map of memory buffers, where the keys are the paths of the files (inside the archive), and the values are their decompressed contents.

void	extract (Input inArchive, std::ostream &outStream, uint32_t index=0) const
	Extracts a file from the given archive to the output stream.

void	extract (Input inArchive, vector< byte_t > &outBuffer, uint32_t index=0) const
	Extracts a file from the given archive to the output buffer.

auto	extractionFormat () const noexcept -> const BitInFormat &

void	extractItems (Input inArchive, const std::vector< uint32_t > &indices, const tstring &outDir={}) const
	Extracts the specified items from the given archive to the chosen directory.

void	extractMatching (Input inArchive, const tstring &itemFilter, const tstring &outDir={}, FilterPolicy policy=FilterPolicy::Include) const
	Extracts the files in the archive that match the given wildcard pattern to the chosen directory.

void	extractMatching (Input inArchive, const tstring &itemFilter, vector< byte_t > &outBuffer, FilterPolicy policy=FilterPolicy::Include) const
	Extracts to the output buffer the first file in the archive matching the given wildcard pattern.

void	extractMatchingRegex (Input inArchive, const tstring &regex, const tstring &outDir={}, FilterPolicy policy=FilterPolicy::Include) const
	Extracts the files in the archive that match the given regex pattern to the chosen directory.

void	extractMatchingRegex (Input inArchive, const tstring &regex, vector< byte_t > &outBuffer, FilterPolicy policy=FilterPolicy::Include) const
	Extracts the first file in the archive that matches the given regex pattern to the output buffer.

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	setFileCallback (const FileCallback &callback)
	Sets the function to be called when the current file being processed changes.

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

virtual void	setPassword (const tstring &password)
	Sets up a password to be used by the archive handler.

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	setTotalCallback (const TotalCallback &callback)
	Sets the function to be called when the total size of an operation is available.

void	test (Input inArchive) const
	Tests the given archive without extracting its content.

auto	totalCallback () const -> TotalCallback

Detailed Description

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

The BitExtractor template class allows extracting the content of archives from supported input types.

Template Parameters

Input the type of input archives that the generated extractor class supports.

Constructor & Destructor Documentation

◆ BitExtractor()

template<typename Input >

BitExtractor	(	const Bit7zLibrary &	lib,
		const BitInFormat &	format = `BitFormat::Auto`
	)

inlineexplicit

Constructs a BitExtractor object.

The Bit7zLibrary parameter is needed to have access to the functionalities of the 7z DLLs. On the contrary, the BitInFormat is required to know the format of the in_file archives.

Note: When bit7z is compiled using the BIT7Z_AUTO_FORMAT macro define, the format argument has the default value BitFormat::Auto (automatic format detection of the in_file archive). Otherwise, when BIT7Z_AUTO_FORMAT is not defined (i.e., no auto format detection available), the format argument must be specified.

Parameters

lib	the 7z library to use.
format	the in_file 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"").

◆ extract() [1/4]

template<typename Input >

void extract	(	Input	inArchive,
		const tstring &	outDir = `{}`
	)		const

inline

Extracts the given archive to the chosen directory.

Parameters

inArchive	the input archive to be extracted.
outDir	the output directory where extracted files will be put.

◆ extract() [2/4]

template<typename Input >

void extract	(	Input	inArchive,
		std::map< tstring, vector< byte_t > > &	outMap
	)		const

inline

Extracts the content of the given archive into a map of memory buffers, where the keys are the paths of the files (inside the archive), and the values are their decompressed contents.

Parameters

inArchive	the input archive to be extracted.
outMap	the output map.

◆ extract() [3/4]

template<typename Input >

void extract	(	Input	inArchive,
		std::ostream &	outStream,
		uint32_t	index = `0`
	)		const

inline

Extracts a file from the given archive to the output stream.

Parameters

inArchive	the input archive to extract from.
outStream	the (binary) stream where the content of the extracted file will be put.
index	the index of the file to be extracted from the archive.

◆ extract() [4/4]

template<typename Input >

void extract	(	Input	inArchive,
		vector< byte_t > &	outBuffer,
		uint32_t	index = `0`
	)		const

inline

Extracts a file from the given archive to the output buffer.

Parameters

inArchive	the input archive to extract from.
outBuffer	the output buffer where the content of the extracted file will be put.
index	the index of the file to be extracted from the archive.

◆ extractionFormat()

auto extractionFormat ( ) const -> const BitInFormat &

noexceptinherited

Returns: the archive format used by the archive opener.

◆ extractItems()

template<typename Input >

void extractItems	(	Input	inArchive,
		const std::vector< uint32_t > &	indices,
		const tstring &	outDir = `{}`
	)		const

inline

Extracts the specified items from the given archive to the chosen directory.

Parameters

inArchive	the input archive to extract from.
indices	the indices of the files in the archive that should be extracted.
outDir	the output directory where the extracted files will be placed.

◆ extractMatching() [1/2]

template<typename Input >

void extractMatching	(	Input	inArchive,
		const tstring &	itemFilter,
		const tstring &	outDir = `{}`,
		FilterPolicy	policy = `FilterPolicy::Include`
	)		const

inline

Extracts the files in the archive that match the given wildcard pattern to the chosen directory.

Parameters

inArchive	the input archive to extract from.
itemFilter	the wildcard pattern used for matching the paths of files inside the archive.
outDir	the output directory where extracted files will be put.
policy	the filtering policy to be applied to the matched items.

◆ extractMatching() [2/2]

template<typename Input >

void extractMatching	(	Input	inArchive,
		const tstring &	itemFilter,
		vector< byte_t > &	outBuffer,
		FilterPolicy	policy = `FilterPolicy::Include`
	)		const

inline

Extracts to the output buffer the first file in the archive matching the given wildcard pattern.

Parameters

inArchive	the input archive to extract from.
itemFilter	the wildcard pattern used for matching the paths of files inside the archive.
outBuffer	the output buffer where to extract the file.
policy	the filtering policy to be applied to the matched items.

◆ extractMatchingRegex() [1/2]

template<typename Input >

void extractMatchingRegex	(	Input	inArchive,
		const tstring &	regex,
		const tstring &	outDir = `{}`,
		FilterPolicy	policy = `FilterPolicy::Include`
	)		const

inline

Extracts the files in the archive that match the given regex pattern to the chosen directory.

Note: Available only when compiling bit7z using the BIT7Z_REGEX_MATCHING preprocessor define.

Parameters

inArchive	the input archive to extract from.
regex	the regex used for matching the paths of files inside the archive.
outDir	the output directory where extracted files will be put.
policy	the filtering policy to be applied to the matched items.

◆ extractMatchingRegex() [2/2]

template<typename Input >

void extractMatchingRegex	(	Input	inArchive,
		const tstring &	regex,
		vector< byte_t > &	outBuffer,
		FilterPolicy	policy = `FilterPolicy::Include`
	)		const

inline

Extracts the first file in the archive that matches the given regex pattern to the output buffer.

Note: Available only when compiling bit7z using the BIT7Z_REGEX_MATCHING preprocessor define.

Parameters

inArchive	the input archive to extract from.
regex	the regex used for matching the paths of files inside the archive.
outBuffer	the output buffer where the extracted file will be put.
policy	the filtering policy to be applied to the matched items.

◆ fileCallback()

auto fileCallback ( ) const -> FileCallback

inherited

Returns: the current file callback.

◆ format()

auto format ( ) const -> const BitInFormat &override

overridevirtualnoexceptinherited

Returns: the archive format used by the archive opener.

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.

◆ 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.

◆ 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()

virtual void setPassword ( const tstring & password )

virtualinherited

Sets up a password to be used by the archive handler.

The password will be used to encrypt/decrypt archives by using the default cryptographic method of the archive format.

Note: Calling setPassword when the input archive is not encrypted does not have any effect on the extraction process.; 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, which is equivalent to calling setPassword(L"").

Parameters

password the password to be used.

Reimplemented in BitAbstractArchiveCreator.

◆ 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

◆ 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.

◆ test()

template<typename Input >

void test ( Input inArchive ) const

inline

Tests the given archive without extracting its content.

If the archive is not valid, a BitException is thrown!

Parameters

inArchive the input archive to be tested.

◆ totalCallback()

auto totalCallback ( ) const -> TotalCallback

inherited

Returns: the current total callback.

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

include/bit7z/bitextractor.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ BitExtractor()

Member Function Documentation

◆ clearPassword()

◆ extract() [1/4]

◆ extract() [2/4]

◆ extract() [3/4]

◆ extract() [4/4]

◆ extractionFormat()

◆ extractItems()

◆ extractMatching() [1/2]

◆ extractMatching() [2/2]

◆ extractMatchingRegex() [1/2]

◆ extractMatchingRegex() [2/2]

◆ fileCallback()

◆ format()

◆ isPasswordDefined()

◆ library()

◆ overwriteMode()

◆ password()

◆ passwordCallback()

◆ progressCallback()

◆ ratioCallback()

◆ retainDirectories()

◆ setFileCallback()

◆ setOverwriteMode()

◆ setPassword()

◆ setPasswordCallback()

◆ setProgressCallback()

◆ setRatioCallback()

◆ setRetainDirectories()

◆ setTotalCallback()

◆ test()

◆ totalCallback()