BitAbstractArchiveHandler Class Reference

Abstract class representing a generic archive handler. More...

#include <bit7z/bitabstractarchivehandler.hpp>

Inheritance diagram for BitAbstractArchiveHandler:

Public Member Functions
void	clearPassword () noexcept
	Clear the current password used by the handler.
auto	fileCallback () const -> FileCallback
virtual auto	format () const -> const BitInFormat &=0
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.
auto	totalCallback () const -> TotalCallback

Detailed Description

Abstract class representing a generic archive handler.

Member Function Documentation

clearPassword()

void clearPassword ( )

noexcept

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"").

fileCallback()

auto fileCallback

(

)

const -> FileCallback

Returns

the current file callback.

format()

virtual auto format ( ) const -> const BitInFormat &

pure virtual

Returns

the format used by the handler for extracting or compressing.

Implemented in BitAbstractArchiveCreator, and BitAbstractArchiveOpener.

isPasswordDefined()

auto isPasswordDefined ( ) const -> bool

noexcept

Returns

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

library()

auto library ( ) const -> const Bit7zLibrary &

noexcept

Returns

the Bit7zLibrary object used by the handler.

overwriteMode()

auto overwriteMode

(

)

const -> OverwriteMode

Returns

the current OverwriteMode.

password()

auto password

(

)

const -> tstring

Returns

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

passwordCallback()

auto passwordCallback

(

)

const -> PasswordCallback

Returns

the current password callback.

progressCallback()

auto progressCallback

(

)

const -> ProgressCallback

Returns

the current progress callback.

ratioCallback()

auto ratioCallback

(

)

const -> RatioCallback

Returns

the current ratio callback.

retainDirectories()

auto retainDirectories ( ) const -> bool

noexcept

Returns

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

setFileCallback()

void setFileCallback

(

const FileCallback &

callback

)

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

)

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 )

virtual

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

)

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

)

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

)

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 )

noexcept

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

)

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

Parameters

callback

the total callback to be used.

totalCallback()

auto totalCallback

(

)

const -> TotalCallback

Returns

the current total callback.

---

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

• include/bit7z/bitabstractarchivehandler.hpp