QZipWriter Class Reference

the QZipWriter class provides a way to create a new zip archive. More...

#include <qzipwriter_p.h>

Public Types
enum	CompressionPolicy { AlwaysCompress, NeverCompress, AutoCompress }
enum	Status {   NoError, FileWriteError, FileOpenError, FilePermissionsError,   FileError }
	The following status values are possible: More...

Public Functions
void	addDirectory (const QString &dirName)
	Create a new directory in the archive with the specified dirName and the permissions;. More...
void	addFile (const QString &fileName, const QByteArray &data)
	Add a file to the archive with data as the file contents. More...
void	addFile (const QString &fileName, QIODevice *device)
	Add a file to the archive with device as the source of the contents. More...
void	addSymLink (const QString &fileName, const QString &destination)
	Create a new symbolic link in the archive with the specified dirName and the permissions; A symbolic link contains the destination (relative) path and name. More...
void	close ()
	Closes the zip file. More...
CompressionPolicy	compressionPolicy () const
	Returns the currently set compression policy. More...
QFile::Permissions	creationPermissions () const
	Returns the currently set creation permissions. More...
QIODevice *	device () const
	Returns device used for writing zip archive. More...
bool	exists () const
	Returns true if the file exists; otherwise returns false. More...
bool	isWritable () const
	Returns true if the user can write to the archive; otherwise returns false. More...
	QZipWriter (const QString &fileName, QIODevice::OpenMode mode=(QIODevice::WriteOnly|QIODevice::Truncate))
	Create a new zip archive that operates on the archive filename. More...
	QZipWriter (QIODevice *device)
	Create a new zip archive that operates on the archive found in device. More...
void	setCompressionPolicy (CompressionPolicy policy)
	Sets the policy for compressing newly added files to the new policy. More...
void	setCreationPermissions (QFile::Permissions permissions)
	Sets the permissions that will be used for newly added files. More...
Status	status () const
	Returns a status code indicating the first error that was met by QZipWriter, or QZipWriter::NoError if no error occurred. More...
	~QZipWriter ()

Properties
QZipWriterPrivate *	d

Detailed Description

the QZipWriter class provides a way to create a new zip archive.

Warning

This function is not part of the public interface.

Since

4.5

QZipWriter can be used to create a zip archive containing any number of files and directories. The files in the archive will be compressed in a way that is compatible with common zip reader applications.

Definition at line 64 of file qzipwriter_p.h.

Enumerations

CompressionPolicy

enum QZipWriter::CompressionPolicy

• AlwaysCompress A file that is added is compressed.
• NeverCompress A file that is added will be stored without changes.
• AutoCompress A file that is added will be compressed only if that will give a smaller file.

Enumerator
AlwaysCompress
NeverCompress
AutoCompress

Definition at line 87 of file qzipwriter_p.h.

                           {
        AlwaysCompress,
        NeverCompress,
        AutoCompress
    };

Status

enum QZipWriter::Status

The following status values are possible:

• NoError No error occurred.

• FileWriteError An error occurred when writing to the device.
• FileOpenError The file could not be opened.
• FilePermissionsError The file could not be accessed.
• FileError Another file error occurred.

Enumerator
NoError
FileWriteError
FileOpenError
FilePermissionsError
FileError

Definition at line 77 of file qzipwriter_p.h.

                {
        NoError,
        FileWriteError,
        FileOpenError,
        FilePermissionsError,
        FileError
    };

Constructors and Destructors

QZipWriter() [1/2]

QZipWriter::QZipWriter	(	const QString &	fileName,
		QIODevice::OpenMode	mode = (QIODevice::WriteOnly | QIODevice::Truncate)
	)

Create a new zip archive that operates on the archive filename.

The file will be opened with the mode.

See also

isValid()

Definition at line 1049 of file qzip.cpp.

{
    QScopedPointer<QFile> f(new QFile(fileName));
    f->open(mode);
    QZipWriter::Status status;
    if (f->error() == QFile::NoError)
        status = QZipWriter::NoError;
    else {
        if (f->error() == QFile::WriteError)
            status = QZipWriter::FileWriteError;
        else if (f->error() == QFile::OpenError)
            status = QZipWriter::FileOpenError;
        else if (f->error() == QFile::PermissionsError)
            status = QZipWriter::FilePermissionsError;
        else
            status = QZipWriter::FileError;
    }

    d = new QZipWriterPrivate(f.data(), /*ownDevice=*/true);
    f.take();
    d->status = status;
}

QZipWriter() [2/2]

QZipWriter::QZipWriter ( QIODevice *  device )

explicit

Create a new zip archive that operates on the archive found in device.

You have to open the device previous to calling the constructor and only a device that is readable will be scanned for zip filecontent.

Definition at line 1077 of file qzip.cpp.

    : d(new QZipWriterPrivate(device, /*ownDevice=*/false))
{
    Q_ASSERT(device);
}

~QZipWriter()

QZipWriter::~QZipWriter

(

)

Definition at line 1083 of file qzip.cpp.

{
    close();
    delete d;
}

Functions

addDirectory()

void QZipWriter::addDirectory

(

const QString &

dirName

)

Create a new directory in the archive with the specified dirName and the permissions;.

Definition at line 1240 of file qzip.cpp.

{
    QString name(QDir::fromNativeSeparators(dirName));
    // separator is mandatory
    if (!name.endsWith(QLatin1Char('/')))
        name.append(QLatin1Char('/'));
    d->addEntry(QZipWriterPrivate::Directory, name, QByteArray());
}

addFile() [1/2]

void QZipWriter::addFile	(	const QString &	fileName,
		const QByteArray &	data
	)

Add a file to the archive with data as the file contents.

The file will be stored in the archive using the fileName which includes the full path in the archive.

The new file will get the file permissions based on the current creationPermissions and it will be compressed using the zip compression based on the current compression policy.

See also

setCreationPermissions()

setCompressionPolicy()

Definition at line 1207 of file qzip.cpp.

{
    d->addEntry(QZipWriterPrivate::File, QDir::fromNativeSeparators(fileName), data);
}

addFile() [2/2]

void QZipWriter::addFile	(	const QString &	fileName,
		QIODevice *	device
	)

Add a file to the archive with device as the source of the contents.

The contents returned from QIODevice::readAll() will be used as the filedata. The file will be stored in the archive using the fileName which includes the full path in the archive.

Definition at line 1219 of file qzip.cpp.

{
    Q_ASSERT(device);
    QIODevice::OpenMode mode = device->openMode();
    bool opened = false;
    if ((mode & QIODevice::ReadOnly) == 0) {
        opened = true;
        if (! device->open(QIODevice::ReadOnly)) {
            d->status = FileOpenError;
            return;
        }
    }
    d->addEntry(QZipWriterPrivate::File, QDir::fromNativeSeparators(fileName), device->readAll());
    if (opened)
        device->close();
}

addSymLink()

void QZipWriter::addSymLink	(	const QString &	fileName,
		const QString &	destination
	)

Create a new symbolic link in the archive with the specified dirName and the permissions; A symbolic link contains the destination (relative) path and name.

Definition at line 1254 of file qzip.cpp.

{
    d->addEntry(QZipWriterPrivate::Symlink, QDir::fromNativeSeparators(fileName), QFile::encodeName(destination));
}

close()

void QZipWriter::close

(

)

Closes the zip file.

Definition at line 1262 of file qzip.cpp.

Referenced by ~QZipWriter().

{
    if (!(d->device->openMode() & QIODevice::WriteOnly)) {
        d->device->close();
        return;
    }

    //qDebug("QZip::close writing directory, %d entries", d->fileHeaders.size());
    d->device->seek(d->start_of_directory);
    // write new directory
    for (int i = 0; i < d->fileHeaders.size(); ++i) {
        const FileHeader &header = d->fileHeaders.at(i);
        d->device->write((const char *)&header.h, sizeof(CentralFileHeader));
        d->device->write(header.file_name);
        d->device->write(header.extra_field);
        d->device->write(header.file_comment);
    }
    int dir_size = d->device->pos() - d->start_of_directory;
    // write end of directory
    EndOfDirectory eod;
    memset(&eod, 0, sizeof(EndOfDirectory));
    writeUInt(eod.signature, 0x06054b50);
    //uchar this_disk[2];
    //uchar start_of_directory_disk[2];
    writeUShort(eod.num_dir_entries_this_disk, d->fileHeaders.size());
    writeUShort(eod.num_dir_entries, d->fileHeaders.size());
    writeUInt(eod.directory_size, dir_size);
    writeUInt(eod.dir_start_offset, d->start_of_directory);
    writeUShort(eod.comment_length, d->comment.length());

    d->device->write((const char *)&eod, sizeof(EndOfDirectory));
    d->device->write(d->comment);
    d->device->close();
}

compressionPolicy()

QZipWriter::CompressionPolicy QZipWriter::compressionPolicy

(

)

const

Returns the currently set compression policy.

See also

setCompressionPolicy()

addFile()

Definition at line 1166 of file qzip.cpp.

{
    return d->compressionPolicy;
}

creationPermissions()

QFile::Permissions QZipWriter::creationPermissions

(

)

const

Returns the currently set creation permissions.

See also

setCreationPermissions()

addFile()

Definition at line 1190 of file qzip.cpp.

{
    return d->permissions;
}

device()

QIODevice * QZipWriter::device

(

)

const

Returns device used for writing zip archive.

Definition at line 1092 of file qzip.cpp.

{
    return d->device;
}

exists()

bool QZipWriter::exists

(

)

const

Returns true if the file exists; otherwise returns false.

Definition at line 1108 of file qzip.cpp.

{
    QFile *f = qobject_cast<QFile*> (d->device);
    if (f == 0)
        return true;
    return f->exists();
}

isWritable()

bool QZipWriter::isWritable

(

)

const

Returns true if the user can write to the archive; otherwise returns false.

Definition at line 1100 of file qzip.cpp.

{
    return d->device->isWritable();
}

setCompressionPolicy()

void QZipWriter::setCompressionPolicy

(

CompressionPolicy

policy

)

Sets the policy for compressing newly added files to the new policy.

Note

the default policy is AlwaysCompress

See also

compressionPolicy()

addFile()

Definition at line 1156 of file qzip.cpp.

{
    d->compressionPolicy = policy;
}

setCreationPermissions()

void QZipWriter::setCreationPermissions

(

QFile::Permissions

permissions

)

Sets the permissions that will be used for newly added files.

Note

the default permissions are QFile::ReadOwner | QFile::WriteOwner.

See also

creationPermissions()

addFile()

Definition at line 1179 of file qzip.cpp.

{
    d->permissions = permissions;
}

status()

QZipWriter::Status QZipWriter::status

(

)

const

Returns a status code indicating the first error that was met by QZipWriter, or QZipWriter::NoError if no error occurred.

Definition at line 1135 of file qzip.cpp.

{
    return d->status;
}

Properties

d

QZipWriterPrivate* QZipWriter::d

private

Definition at line 109 of file qzipwriter_p.h.

Referenced by addDirectory(), addFile(), addSymLink(), close(), compressionPolicy(), creationPermissions(), device(), exists(), isWritable(), setCompressionPolicy(), setCreationPermissions(), status(), and ~QZipWriter().

---

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

• /src/gui/text/qzipwriter_p.h
• /src/gui/text/qzip.cpp