A file inside ZIP archive. More...

#include <quazip/quazipfile.h>

Inheritance diagram for QuaZipFile:

Collaboration diagram for QuaZipFile:

Public Member Functions
	QuaZipFile ()
	Constructs a QuaZipFile instance.

	QuaZipFile (QObject *parent)
	Constructs a QuaZipFile instance.

	QuaZipFile (const QString &zipName, QObject *parent=nullptr)
	Constructs a QuaZipFile instance.

	QuaZipFile (const QString &zipName, const QString &fileName, QuaZip::CaseSensitivity cs=QuaZip::csDefault, QObject *parent=nullptr)
	Constructs a QuaZipFile instance.

	QuaZipFile (QuaZip zip, QObject parent=nullptr)
	Constructs a QuaZipFile instance.

	~QuaZipFile () override
	Destroys a QuaZipFile instance.

QString	getZipName () const
	Returns the ZIP archive file name.

QuaZip *	getZip () const
	Returns a pointer to the associated QuaZip object.

QString	getFileName () const
	Returns file name.

QuaZip::CaseSensitivity	getCaseSensitivity () const
	Returns case sensitivity of the file name.

QString	getActualFileName () const
	Returns the actual file name in the archive.

void	setZipName (const QString &zipName)
	Sets the ZIP archive file name.

bool	isRaw () const
	Returns `true` if the file was opened in raw mode.

void	setZip (QuaZip *zip)
	Binds to the existing QuaZip instance.

void	setFileName (const QString &fileName, QuaZip::CaseSensitivity cs=QuaZip::csDefault)
	Sets the file name.

bool	open (OpenMode mode) override
	Opens a file for reading.

bool	open (OpenMode mode, const char *password)
	Opens a file for reading.

bool	open (OpenMode mode, int method, int level, bool raw, const char *password=nullptr)
	Opens a file for reading.

bool	open (OpenMode mode, const QuaZipNewInfo &info, const char *password=nullptr, quint32 crc=0, int method=Z_DEFLATED, int level=Z_DEFAULT_COMPRESSION, bool raw=false, int windowBits=-MAX_WBITS, int memLevel=DEF_MEM_LEVEL, int strategy=Z_DEFAULT_STRATEGY)
	Opens a file for writing.

bool	isSequential () const override
	Returns `true`, but beware!

qint64	pos () const override
	Returns current position in the file.

bool	atEnd () const override
	Returns `true` if the end of file was reached.

qint64	size () const override
	Returns file size.

qint64	csize () const
	Returns compressed file size.

qint64	usize () const
	Returns uncompressed file size.

bool	getFileInfo (QuaZipFileInfo *info)
	Gets information about current file.

bool	getFileInfo (QuaZipFileInfo64 *info)
	Gets information about current file with zip64 support.

void	close () override
	Closes the file.

int	getZipError () const
	Returns the error code returned by the last ZIP/UNZIP API call.

qint64	bytesAvailable () const override
	Returns the number of bytes available for reading.

QByteArray	getLocalExtraField ()
	Returns the local extra field.

QDateTime	getExtModTime ()
	Returns the extended modification timestamp.

QDateTime	getExtAcTime ()
	Returns the extended access timestamp.

QDateTime	getExtCrTime ()
	Returns the extended creation timestamp.

Public Member Functions inherited from QIODevice
virtual const QMetaObject *	metaObject () const const

virtual void *	qt_metacast (const char *)

virtual int	qt_metacall (QMetaObject::Call, int, void **)

	QIODevice (QObject *parent)

QIODevice::OpenMode	openMode () const const

void	setTextModeEnabled (bool enabled)

bool	isTextModeEnabled () const const

bool	isOpen () const const

bool	isReadable () const const

bool	isWritable () const const

virtual bool	isSequential () const const

int	readChannelCount () const const

int	writeChannelCount () const const

int	currentReadChannel () const const

void	setCurrentReadChannel (int channel)

int	currentWriteChannel () const const

void	setCurrentWriteChannel (int channel)

virtual bool	open (QIODevice::OpenMode mode)

virtual void	close ()

virtual qint64	pos () const const

virtual qint64	size () const const

virtual bool	seek (qint64 pos)

virtual bool	atEnd () const const

virtual bool	reset ()

virtual qint64	bytesAvailable () const const

virtual qint64	bytesToWrite () const const

qint64	read (char *data, qint64 maxSize)

QByteArray	read (qint64 maxSize)

QByteArray	readAll ()

qint64	readLine (char *data, qint64 maxSize)

QByteArray	readLine (qint64 maxSize)

virtual bool	canReadLine () const const

void	startTransaction ()

void	commitTransaction ()

void	rollbackTransaction ()

bool	isTransactionStarted () const const

qint64	write (const char *data, qint64 maxSize)

qint64	write (const char *data)

qint64	write (const QByteArray &byteArray)

qint64	peek (char *data, qint64 maxSize)

QByteArray	peek (qint64 maxSize)

qint64	skip (qint64 maxSize)

virtual bool	waitForReadyRead (int msecs)

virtual bool	waitForBytesWritten (int msecs)

void	ungetChar (char c)

bool	putChar (char c)

bool	getChar (char *c)

QString	errorString () const const

void	readyRead ()

void	channelReadyRead (int channel)

void	bytesWritten (qint64 bytes)

void	channelBytesWritten (int channel, qint64 bytes)

void	aboutToClose ()

void	readChannelFinished ()

Public Member Functions inherited from QObject
virtual const QMetaObject *	metaObject () const const

virtual void *	qt_metacast (const char *)

virtual int	qt_metacall (QMetaObject::Call, int, void **)

	QObject (QObject *parent)

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const const

void	setObjectName (const QString &name)

bool	isWidgetType () const const

bool	isWindowType () const const

bool	signalsBlocked () const const

bool	blockSignals (bool block)

QThread *	thread () const const

void	moveToThread (QThread *targetThread)

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

void	killTimer (int id)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

const QObjectList &	children () const const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectTree ()

void	dumpObjectInfo ()

void	dumpObjectTree () const const

void	dumpObjectInfo () const const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const const

QList< QByteArray >	dynamicPropertyNames () const const

void	destroyed (QObject *obj)

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

bool	inherits (const char *className) const const

void	deleteLater ()

Protected Member Functions
qint64	readData (char *data, qint64 maxSize) override
	Implementation of the QIODevice::readData().

qint64	writeData (const char *data, qint64 maxSize) override
	Implementation of the QIODevice::writeData().

Protected Member Functions inherited from QIODevice
virtual qint64	readData (char *data, qint64 maxSize)=0

virtual qint64	readLineData (char *data, qint64 maxSize)

virtual qint64	writeData (const char *data, qint64 maxSize)=0

void	setOpenMode (QIODevice::OpenMode openMode)

void	setErrorString (const QString &str)

Protected Member Functions inherited from QObject
QObject *	sender () const const

int	senderSignalIndex () const const

int	receivers (const char *signal) const const

bool	isSignalConnected (const QMetaMethod &signal) const const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

Friends
class	QuaZipFilePrivate

Additional Inherited Members
Static Public Member Functions inherited from QIODevice
QString	tr (const char s, const char c, int n)

QString	trUtf8 (const char s, const char c, int n)

Static Public Member Functions inherited from QObject
QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

Public Attributes inherited from QIODevice
typedef	OpenMode

Properties inherited from QObject
	objectName

Detailed Description

A file inside ZIP archive.

This is the most interesting class. Not only it provides C++ interface to the ZIP/UNZIP package, but also integrates it with Qt by subclassing QIODevice. This makes possible to access files inside ZIP archive using QTextStream or QDataStream, for example. Actually, this is the main purpose of the whole QuaZip library.

You can either use existing QuaZip instance to create instance of this class or pass ZIP archive file name to this class, in which case it will create internal QuaZip object. See constructors' descriptions for details. Writing is only possible with the existing instance.

Note that due to the underlying library's limitation it is not possible to use multiple QuaZipFile instances to open several files in the same archive at the same time. If you need to write to multiple files in parallel, then you should write to temporary files first, then pack them all at once when you have finished writing. If you need to read multiple files inside the same archive in parallel, you should extract them all into a temporary directory first.

Sequential or random-access?

At the first thought, QuaZipFile has fixed size, the start and the end and should be therefore considered random-access device. But there is one major obstacle to making it random-access: ZIP/UNZIP API does not support seek() operation and the only way to implement it is through reopening the file and re-reading to the required position, but this is prohibitively slow.

Therefore, QuaZipFile is considered to be a sequential device. This has advantage of availability of the ungetChar() operation (QIODevice does not implement it properly for non-sequential devices unless they support seek()). Disadvantage is a somewhat strange behaviour of the size() and pos() functions. This should be kept in mind while using this class.

Constructor & Destructor Documentation

◆ QuaZipFile() [1/5]

QuaZipFile::QuaZipFile ( )

Constructs a QuaZipFile instance.

You should use setZipName() and setFileName() or setZip() before trying to call open() on the constructed object.

◆ QuaZipFile() [2/5]

QuaZipFile::QuaZipFile ( QObject * parent )

Constructs a QuaZipFile instance.

parent argument specifies this object's parent object.

You should use setZipName() and setFileName() or setZip() before trying to call open() on the constructed object.

◆ QuaZipFile() [3/5]

QuaZipFile::QuaZipFile	(	const QString &	zipName,
		QObject *	parent = `nullptr`
	)

Constructs a QuaZipFile instance.

parent argument specifies this object's parent object and zipName specifies ZIP archive file name.

You should use setFileName() before trying to call open() on the constructed object.

QuaZipFile constructed by this constructor can be used for read only access. Use QuaZipFile(QuaZip*,QObject*) for writing.

◆ QuaZipFile() [4/5]

QuaZipFile::QuaZipFile	(	const QString &	zipName,
		const QString &	fileName,
		QuaZip::CaseSensitivity	cs = `QuaZip::csDefault`,
		QObject *	parent = `nullptr`
	)

Constructs a QuaZipFile instance.

parent argument specifies this object's parent object, zipName specifies ZIP archive file name and fileName and cs specify a name of the file to open inside archive.

QuaZipFile constructed by this constructor can be used for read only access. Use QuaZipFile(QuaZip*,QObject*) for writing.

See also: QuaZip::setCurrentFile()

◆ QuaZipFile() [5/5]

QuaZipFile::QuaZipFile	(	QuaZip *	zip,
		QObject *	parent = `nullptr`
	)

Constructs a QuaZipFile instance.

parent argument specifies this object's parent object.

zip is the pointer to the existing QuaZip object. This QuaZipFile object then can be used to read current file in the zip or to write to the file inside it.

Warning: Using this constructor for reading current file can be tricky. Let's take the following example:
QuaZip zip("archive.zip");

zip.open(QuaZip::mdUnzip);

zip.setCurrentFile("file-in-archive");

QuaZipFile file(&zip);

file.open(QIODevice::ReadOnly);

// ok, now we can read from the file

file.read(somewhere, some);

zip.setCurrentFile("another-file-in-archive"); // oops...

QuaZipFile anotherFile(&zip);

anotherFile.open(QIODevice::ReadOnly);

anotherFile.read(somewhere, some); // this is still ok...

file.read(somewhere, some); // and this is NOT

QuaZipFile
A file inside ZIP archive.
Definition: quazipfile.h:74

QuaZip
ZIP archive.
Definition: quazip.h:84

QuaZip::mdUnzip
@ mdUnzip
ZIP file is open for reading files inside it.
Definition: quazip.h:96

So, what exactly happens here? When we change current file in the zip archive, file that references it becomes invalid (actually, as far as I understand ZIP/UNZIP sources, it becomes closed, but QuaZipFile has no means to detect it).

Summary: do not close zip object or change its current file as long as QuaZipFile is open. Even better - use another constructors which create internal QuaZip instances, one per object, and therefore do not cause unnecessary trouble. This constructor may be useful, though, if you already have a QuaZip instance and do not want to access several files at once. Good example:

QuaZip zip("archive.zip");
zip.open(QuaZip::mdUnzip);
// first, we need some information about archive itself
QByteArray comment=zip.getComment();
// and now we are going to access files inside it
QuaZipFile file(&zip);
for(bool more=zip.goToFirstFile(); more; more=zip.goToNextFile()) {
  file.open(QIODevice::ReadOnly);
  // do something cool with file here
  file.close(); // do not forget to close!
}
zip.close();

◆ ~QuaZipFile()

QuaZipFile::~QuaZipFile ( )

override

Destroys a QuaZipFile instance.

Closes file if open, destructs internal QuaZip object (if it exists and is internal, of course).

References close(), and QIODevice::isOpen().

Member Function Documentation

◆ readData()

qint64 QuaZipFile::readData	(	char *	data,
		qint64	maxSize
	)

overrideprotectedvirtual

Implementation of the QIODevice::readData().

Implements QIODevice.

References QuaZip::getUnzFile().

◆ writeData()

qint64 QuaZipFile::writeData	(	const char *	data,
		qint64	maxSize
	)

overrideprotectedvirtual

Implementation of the QIODevice::writeData().

Implements QIODevice.

References QuaZip::getZipFile().

◆ getZipName()

QString QuaZipFile::getZipName ( ) const

Returns the ZIP archive file name.

If this object was created by passing QuaZip pointer to the constructor, this function will return that QuaZip's file name (or null string if that object does not have file name yet).

Otherwise, returns associated ZIP archive file name or null string if there are no name set yet.

See also: setZipName() getFileName()

References QuaZip::getZipName().

◆ getZip()

QuaZip * QuaZipFile::getZip ( ) const

Returns a pointer to the associated QuaZip object.

Returns NULL if there is no associated QuaZip or it is internal (so you will not mess with it).

◆ getFileName()

QString QuaZipFile::getFileName ( ) const

Returns file name.

This function returns file name you passed to this object either by using QuaZipFile(const QString&,const QString&,QuaZip::CaseSensitivity,QObject*) or by calling setFileName(). Real name of the file may differ in case if you used case-insensitivity.

Returns null string if there is no file name set yet. This is the case when this QuaZipFile operates on the existing QuaZip object (constructor QuaZipFile(QuaZip*,QObject*) or setZip() was used).

See also: getActualFileName

◆ getCaseSensitivity()

QuaZip::CaseSensitivity QuaZipFile::getCaseSensitivity ( ) const

Returns case sensitivity of the file name.

This function returns case sensitivity argument you passed to this object either by using QuaZipFile(const QString&,const QString&,QuaZip::CaseSensitivity,QObject*) or by calling setFileName().

Returns unpredictable value if getFileName() returns null string (this is the case when you did not used setFileName() or constructor above).

See also: getFileName

◆ getActualFileName()

QString QuaZipFile::getActualFileName ( ) const

Returns the actual file name in the archive.

This is not a ZIP archive file name, but a name of file inside archive. It is not necessary the same name that you have passed to the QuaZipFile(const QString&,const QString&,QuaZip::CaseSensitivity,QObject*), setFileName() or QuaZip::setCurrentFile() - this is the real file name inside archive, so it may differ in case if the file name search was case-insensitive.

Equivalent to calling getCurrentFileName() on the associated QuaZip object. Returns null string if there is no associated QuaZip object or if it does not have a current file yet. And this is the case if you called setFileName() but did not open the file yet. So this is perfectly fine:

QuaZipFile file("somezip.zip");
file.setFileName("somefile");
QString name=file.getName(); // name=="somefile"
QString actual=file.getActualFileName(); // actual is null string
file.open(QIODevice::ReadOnly);
QString actual=file.getActualFileName(); // actual can be "SoMeFiLe" on Windows

See also: getZipName(), getFileName(), QuaZip::CaseSensitivity

References QuaZip::getCurrentFileName(), QuaZip::getZipError(), QString::isNull(), and QIODevice::openMode().

◆ setZipName()

void QuaZipFile::setZipName ( const QString & zipName )

Sets the ZIP archive file name.

Automatically creates internal QuaZip object and destroys previously created internal QuaZip object, if any.

Will do nothing if this file is already open. You must close() it first.

References QIODevice::isOpen().

◆ isRaw()

bool QuaZipFile::isRaw ( ) const

Returns true if the file was opened in raw mode.

If the file is not open, the returned value is undefined.

See also: open(OpenMode,int*,int*,bool,const char*)

Referenced by close().

◆ setZip()

void QuaZipFile::setZip ( QuaZip * zip )

Binds to the existing QuaZip instance.

This function destroys internal QuaZip object, if any, and makes this QuaZipFile to use current file in the zip object for any further operations. See QuaZipFile(QuaZip*,QObject*) for the possible pitfalls.

Will do nothing if the file is currently open. You must close() it first.

References QIODevice::isOpen().

◆ setFileName()

void QuaZipFile::setFileName	(	const QString &	fileName,
		QuaZip::CaseSensitivity	cs = `QuaZip::csDefault`
	)

Sets the file name.

Will do nothing if at least one of the following conditions is met:

ZIP name has not been set yet (getZipName() returns null string).
This QuaZipFile is associated with external QuaZip. In this case you should call that QuaZip's setCurrentFile() function instead!
File is already open so setting the name is meaningless.

See also: QuaZip::setCurrentFile

References QIODevice::isOpen(), QString::mid(), and QString::startsWith().

◆ open() [1/4]

bool QuaZipFile::open ( OpenMode mode )

override

Opens a file for reading.

Returns true on success, false otherwise. Call getZipError() to get error code.

Note: Since ZIP/UNZIP API provides buffered reading only, QuaZipFile does not support unbuffered reading. So do not pass QIODevice::Unbuffered flag in mode, or open will fail.

References open().

Referenced by JlCompress::compressFile(), JlCompress::compressSubDir(), JlCompress::extractFile(), and open().

◆ open() [2/4]

bool QuaZipFile::open	(	OpenMode	mode,
		const char *	password
	)

inline

Opens a file for reading.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Argument password specifies a password to decrypt the file. If it is NULL then this function behaves just like open(OpenMode).

References QIODevice::open().

◆ open() [3/4]

bool QuaZipFile::open	(	OpenMode	mode,
		int *	method,
		int *	level,
		bool	raw,
		const char *	password = `nullptr`
	)

Opens a file for reading.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Argument password specifies a password to decrypt the file.

An integers pointed by method and level will receive codes of the compression method and level used. See unzip.h.

If raw is true then no decompression is performed.

method should not be NULL. level can be NULL if you don't want to know the compression level.

References QuaZip::close(), QuaZip::getMode(), QuaZip::getUnzFile(), QuaZip::getZipError(), QuaZip::hasCurrentFile(), QIODevice::isOpen(), QuaZip::mdUnzip, QuaZip::open(), QuaZip::setCurrentFile(), and QIODevice::setOpenMode().

◆ open() [4/4]

bool QuaZipFile::open	(	OpenMode	mode,
		const QuaZipNewInfo &	info,
		const char *	password = `nullptr`,
		quint32	crc = `0`,
		int	method = `Z_DEFLATED`,
		int	level = `Z_DEFAULT_COMPRESSION`,
		bool	raw = `false`,
		int	windowBits = `-MAX_WBITS`,
		int	memLevel = `DEF_MEM_LEVEL`,
		int	strategy = `Z_DEFAULT_STRATEGY`
	)

Opens a file for writing.

info argument specifies information about file. It should at least specify a correct file name. Also, it is a good idea to specify correct timestamp (by default, current time will be used). See QuaZipNewInfo.

The password argument specifies the password for crypting. Pass NULL if you don't need any crypting. The crc argument was supposed to be used for crypting too, but then it turned out that it's false information, so you need to set it to 0 unless you want to use the raw mode (see below).

Arguments method and level specify compression method and level. The only compression methods supported are Z_DEFLATED and Z_BZIP2ED. But you may also specify 0 for no compression. If all of the files in the archive use both method 0 and either level 0 is explicitly specified or data descriptor writing is disabled with QuaZip::setDataDescriptorWritingEnabled(), then the resulting archive is supposed to be compatible with the 1.0 ZIP format version, should you need that. Except for this, level has no other effects with method 0.

If the method is Z_BZIP2ED, then the level must be specified explicitly (1 to 9), as the bzip2 backend doesn't support Z_DEFAULT_COMPRESSION.

If raw is true, no compression is performed. In this case, crc and uncompressedSize field of the info are required.

Arguments windowBits, memLevel, strategy provide zlib algorithms tuning. See deflateInit2() in zlib.

References QuaZipNewInfo::comment, QByteArray::constData(), QDateTime::date(), QuaZipNewInfo::dateTime, QDate::day(), QuaZipNewInfo::externalAttr, QuaZipNewInfo::extraGlobal, QuaZipNewInfo::extraLocal, QTextCodec::fromUnicode(), QuaZip::getCommentCodec(), QuaZip::getFileNameCodec(), QuaZip::getMode(), QuaZip::getOsCode(), QuaZip::getZipFile(), QTime::hour(), QuaZipNewInfo::internalAttr, QuaZip::isDataDescriptorWritingEnabled(), QIODevice::isOpen(), QuaZip::isUtf8Enabled(), QuaZip::isZip64Enabled(), QByteArray::length(), QuaZip::mdAdd, QuaZip::mdAppend, QuaZip::mdCreate, QTime::minute(), QDate::month(), QuaZipNewInfo::name, QTime::second(), QIODevice::setOpenMode(), QDateTime::time(), QString::toUtf8(), QuaZipNewInfo::uncompressedSize, and QDate::year().

◆ isSequential()

bool QuaZipFile::isSequential ( ) const

overridevirtual

Returns true, but beware!

Reimplemented from QIODevice.

◆ pos()

qint64 QuaZipFile::pos ( ) const

overridevirtual

Returns current position in the file.

Implementation of the QIODevice::pos(). When reading, this function is a wrapper to the ZIP/UNZIP unztell(), therefore it is unable to keep track of the ungetChar() calls (which is non-virtual and therefore is dangerous to reimplement). So if you are using ungetChar() feature of the QIODevice, this function reports incorrect value until you get back characters which you ungot.

When writing, pos() returns number of bytes already written (uncompressed unless you use raw mode).

Note: Although QuaZipFile is a sequential device and therefore pos() should always return zero, it does not, because it would be misguiding. Keep this in mind.

This function returns -1 if the file or archive is not open.

Error code returned by getZipError() is not affected by this function call.

Reimplemented from QIODevice.

References QIODevice::bytesAvailable(), QuaZip::getUnzFile(), QIODevice::isOpen(), and QIODevice::openMode().

Referenced by bytesAvailable().

◆ atEnd()

bool QuaZipFile::atEnd ( ) const

overridevirtual

Returns true if the end of file was reached.

This function returns false in the case of error. This means that you called this function on either not open file, or a file in the not open archive or even on a QuaZipFile instance that does not even have QuaZip instance associated. Do not do that because there is no means to determine whether false is returned because of error or because end of file was reached. Well, on the other side you may interpret false return value as "there is no file open to check for end of file and there is no end of file therefore".

When writing, this function always returns true (because you are always writing to the end of file).

Error code returned by getZipError() is not affected by this function call.

Reimplemented from QIODevice.

References QIODevice::bytesAvailable(), QuaZip::getUnzFile(), QIODevice::isOpen(), and QIODevice::openMode().

◆ size()

qint64 QuaZipFile::size ( ) const

overridevirtual

Returns file size.

This function returns csize() if the file is open for reading in raw mode, usize() if it is open for reading in normal mode and pos() if it is open for writing.

Returns -1 on error, call getZipError() to get error code.

Note: This function returns file size despite that QuaZipFile is considered to be sequential device, for which size() should return bytesAvailable() instead. But its name would be very misguiding otherwise, so just keep in mind this inconsistence.

Reimplemented from QIODevice.

References csize(), QIODevice::isOpen(), QIODevice::openMode(), and usize().

Referenced by bytesAvailable(), and getLocalExtraField().

◆ csize()

qint64 QuaZipFile::csize ( ) const

Returns compressed file size.

Equivalent to calling getFileInfo() and then getting compressedSize field, but more convenient and faster.

File must be open for reading before calling this function.

Returns -1 on error, call getZipError() to get error code.

References QuaZip::getMode(), QuaZip::getUnzFile(), and QuaZip::mdUnzip.

Referenced by size().

◆ usize()

qint64 QuaZipFile::usize ( ) const

Returns uncompressed file size.

Equivalent to calling getFileInfo() and then getting uncompressedSize field, but more convenient and faster. See getFileInfo() for a warning.

File must be open for reading before calling this function.

Returns -1 on error, call getZipError() to get error code.

References QuaZip::getMode(), QuaZip::getUnzFile(), and QuaZip::mdUnzip.

Referenced by size().

◆ getFileInfo() [1/2]

bool QuaZipFile::getFileInfo ( QuaZipFileInfo * info )

Gets information about current file.

This function does the same thing as calling QuaZip::getCurrentFileInfo() on the associated QuaZip object, but you can not call getCurrentFileInfo() if the associated QuaZip is internal (because you do not have access to it), while you still can call this function in that case.

File must be open for reading before calling this function.

Returns: false in the case of an error.

This function doesn't support zip64, but will still work fine on zip64 archives if file sizes are below 4 GB, otherwise the values will be set as if converted using QuaZipFileInfo64::toQuaZipFileInfo().

See also: getFileInfo(QuaZipFileInfo64*)

References getFileInfo(), and QuaZipFileInfo64::toQuaZipFileInfo().

Referenced by getFileInfo().

◆ getFileInfo() [2/2]

bool QuaZipFile::getFileInfo ( QuaZipFileInfo64 * info )

Gets information about current file with zip64 support.

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

See also: getFileInfo(QuaZipFileInfo*)

References QuaZip::getCurrentFileInfo(), QuaZip::getMode(), QuaZip::getZipError(), and QuaZip::mdUnzip.

◆ close()

void QuaZipFile::close ( )

overridevirtual

Closes the file.

Call getZipError() to determine if the close was successful.

Reimplemented from QIODevice.

References QuaZip::close(), QuaZip::getUnzFile(), QuaZip::getZipError(), QuaZip::getZipFile(), QuaZip::isOpen(), QIODevice::isOpen(), isRaw(), QIODevice::openMode(), and QIODevice::setOpenMode().

Referenced by JlCompress::compressFile(), JlCompress::compressSubDir(), JlCompress::extractFile(), and ~QuaZipFile().

◆ bytesAvailable()

qint64 QuaZipFile::bytesAvailable ( ) const

overridevirtual

Returns the number of bytes available for reading.

Reimplemented from QIODevice.

References pos(), and size().

◆ getLocalExtraField()

QByteArray QuaZipFile::getLocalExtraField ( )

Returns the local extra field.

There are two (optional) local extra fields associated with a file. One is located in the central header and is available along with the rest of the file information in QuaZipFileInfo64::extra. Another is located before the file itself, and is returned by this function. The file must be open first.

Returns: the local extra field, or an empty array if there is none (or file is not open)

References QByteArray::data(), QuaZip::getUnzFile(), QByteArray::size(), and size().

Referenced by getExtAcTime(), getExtCrTime(), and getExtModTime().

◆ getExtModTime()

QDateTime QuaZipFile::getExtModTime ( )

Returns the extended modification timestamp.

The getExt*Time() functions only work if there is an extended timestamp extra field (ID 0x5455) present. Otherwise, they all return invalid null timestamps.

Modification time, but not other times, can also be accessed through QuaZipFileInfo64 without the need to open the file first.

See also: dateTime; QuaZipFileInfo64::getExtModTime(); getExtAcTime(); getExtCrTime()

Returns: The extended modification time, UTC

References QuaZipFileInfo64::getExtTime(), and getLocalExtraField().

◆ getExtAcTime()

QDateTime QuaZipFile::getExtAcTime ( )

Returns the extended access timestamp.

The getExt*Time() functions only work if there is an extended timestamp extra field (ID 0x5455) present. Otherwise, they all return invalid null timestamps.

See also: dateTime; QuaZipFileInfo64::getExtModTime(); getExtModTime(); getExtCrTime()

Returns: The extended access time, UTC

References QuaZipFileInfo64::getExtTime(), and getLocalExtraField().

◆ getExtCrTime()

QDateTime QuaZipFile::getExtCrTime ( )

Returns the extended creation timestamp.

The getExt*Time() functions only work if there is an extended timestamp extra field (ID 0x5455) present. Otherwise, they all return invalid null timestamps.

See also: dateTime; QuaZipFileInfo64::getExtModTime(); getExtModTime(); getExtAcTime()

Returns: The extended creation time, UTC

References QuaZipFileInfo64::getExtTime(), and getLocalExtraField().

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

quazip/quazipfile.h
quazip/quazipfile.cpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Sequential or random-access?

Constructor & Destructor Documentation

◆ QuaZipFile() [1/5]

◆ QuaZipFile() [2/5]

◆ QuaZipFile() [3/5]

◆ QuaZipFile() [4/5]

◆ QuaZipFile() [5/5]

◆ ~QuaZipFile()

Member Function Documentation

◆ readData()

◆ writeData()

◆ getZipName()

◆ getZip()

◆ getFileName()

◆ getCaseSensitivity()

◆ getActualFileName()

◆ setZipName()

◆ isRaw()

◆ setZip()

◆ setFileName()

◆ open() [1/4]

◆ open() [2/4]

◆ open() [3/4]

◆ open() [4/4]

◆ isSequential()

◆ pos()

◆ atEnd()

◆ size()

◆ csize()

◆ usize()

◆ getFileInfo() [1/2]

◆ getFileInfo() [2/2]

◆ close()

◆ bytesAvailable()

◆ getLocalExtraField()

◆ getExtModTime()

◆ getExtAcTime()

◆ getExtCrTime()