QuaGzipFile Class Reference

GZIP file. More...

#include <src/ckb/quazip/quagzipfile.h>

Inheritance diagram for QuaGzipFile:

Collaboration diagram for QuaGzipFile:

Public Member Functions
	QuaGzipFile ()
	Empty constructor. More...
	QuaGzipFile (QObject *parent)
	Empty constructor with a parent. More...
	QuaGzipFile (const QString &fileName, QObject *parent=NULL)
	Constructor. More...
virtual	~QuaGzipFile ()
	Destructor. More...
void	setFileName (const QString &fileName)
	Sets the name of the GZIP file to be opened. More...
QString	getFileName () const
	Returns the name of the GZIP file. More...
virtual bool	isSequential () const
	Returns true. More...
virtual bool	open (QIODevice::OpenMode mode)
	Opens the file. More...
virtual bool	open (int fd, QIODevice::OpenMode mode)
	Opens the file. More...
virtual bool	flush ()
	Flushes data to file. More...
virtual void	close ()
	Closes the file. More...

Protected Member Functions
virtual qint64	readData (char *data, qint64 maxSize)
	Implementation of QIODevice::readData(). More...
virtual qint64	writeData (const char *data, qint64 maxSize)
	Implementation of QIODevice::writeData(). More...

Private Member Functions
	QuaGzipFile (const QuaGzipFile &that)
QuaGzipFile &	operator= (const QuaGzipFile &that)

Private Attributes
QuaGzipFilePrivate *	d

Detailed Description

This class is a wrapper around GZIP file access functions in zlib. Unlike QuaZip classes, it doesn't allow reading from a GZIP file opened as QIODevice, for example, if your GZIP file is in QBuffer. It only provides QIODevice access to a GZIP file contents, but the GZIP file itself must be identified by its name on disk or by descriptor id.

Definition at line 39 of file quagzipfile.h.

Constructor & Destructor Documentation

QuaGzipFile::QuaGzipFile

(

)

Must call setFileName() before trying to open.

Definition at line 87 of file quagzipfile.cpp.

                        :
d(new QuaGzipFilePrivate())
{
}

QuaGzipFile::QuaGzipFile

(

QObject *

parent

)

Must call setFileName() before trying to open.

Parameters

parent

The parent object, as per QObject logic.

Definition at line 92 of file quagzipfile.cpp.

                                       :
QIODevice(parent),
d(new QuaGzipFilePrivate())
{
}

QuaGzipFile::QuaGzipFile	(	const QString &	fileName,
		QObject *	parent = NULL
	)

Parameters

fileName	The name of the GZIP file.
parent	The parent object, as per QObject logic.

Definition at line 98 of file quagzipfile.cpp.

                                                                :
  QIODevice(parent),
d(new QuaGzipFilePrivate(fileName))
{
}

QuaGzipFile::~QuaGzipFile ( )

virtual

Definition at line 104 of file quagzipfile.cpp.

References close(), and d.

{
  if (isOpen()) {
    close();
  }
  delete d;
}

Here is the call graph for this function:

QuaGzipFile::QuaGzipFile ( const QuaGzipFile &  that )

private

Member Function Documentation

void QuaGzipFile::close ( )

virtual

Definition at line 152 of file quagzipfile.cpp.

References d.

Referenced by ~QuaGzipFile().

{
  QIODevice::close();
  gzclose(d->gzd);
}

Here is the caller graph for this function:

bool QuaGzipFile::flush ( )

virtual

The data is written using Z_SYNC_FLUSH mode. Doesn't make any sense when reading.

Definition at line 147 of file quagzipfile.cpp.

References d.

{
    return gzflush(d->gzd, Z_SYNC_FLUSH) == Z_OK;
}

QString QuaGzipFile::getFileName

(

)

const

Definition at line 117 of file quagzipfile.cpp.

References d.

{
    return d->fileName;
}

bool QuaGzipFile::isSequential ( ) const

virtual

Strictly speaking, zlib supports seeking for GZIP files, but it is poorly implemented, because there is no way to implement it properly. For reading, seeking backwards is very slow, and for writing, it is downright impossible. Therefore, QuaGzipFile does not support seeking at all.

Definition at line 122 of file quagzipfile.cpp.

{
  return true;
}

bool QuaGzipFile::open ( QIODevice::OpenMode  mode )

virtual

Parameters

mode	Can be either QIODevice::Write or QIODevice::Read. ReadWrite and Append aren't supported.

Definition at line 127 of file quagzipfile.cpp.

References d.

{
    QString error;
    if (!d->open(d->fileName, mode, error)) {
        setErrorString(error);
        return false;
    }
    return QIODevice::open(mode);
}

bool QuaGzipFile::open ( int  fd, QIODevice::OpenMode  mode  )

virtual

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

Parameters

fd	The file descriptor to read/write the GZIP file from/to.
mode	Can be either QIODevice::Write or QIODevice::Read. ReadWrite and Append aren't supported.

Definition at line 137 of file quagzipfile.cpp.

References d.

{
    QString error;
    if (!d->open(fd, mode, error)) {
        setErrorString(error);
        return false;
    }
    return QIODevice::open(mode);
}

QuaGzipFile& QuaGzipFile::operator= ( const QuaGzipFile &  that )

private

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

protectedvirtual

Definition at line 158 of file quagzipfile.cpp.

References d.

{
    return gzread(d->gzd, (voidp)data, (unsigned)maxSize);
}

void QuaGzipFile::setFileName

(

const QString &

fileName

)

Definition at line 112 of file quagzipfile.cpp.

References d.

{
    d->fileName = fileName;
}

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

protectedvirtual

Definition at line 163 of file quagzipfile.cpp.

References d.

{
    if (maxSize == 0)
        return 0;
    int written = gzwrite(d->gzd, (voidp)data, (unsigned)maxSize);
    if (written == 0)
        return -1;
    else
        return written;
}

Field Documentation

QuaGzipFilePrivate* QuaGzipFile::d

private

Definition at line 105 of file quagzipfile.h.

Referenced by close(), flush(), getFileName(), open(), readData(), setFileName(), writeData(), and ~QuaGzipFile().

---

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

• src/ckb/quazip/quagzipfile.h
• src/ckb/quazip/quagzipfile.cpp