kzip.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2002 Holger Schroeder <holger-kde@holgis.net>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef KZIP_H
#define KZIP_H

#include <karchive.h>

class KZipFileEntry;
class KDECORE_EXPORT KZip : public KArchive
{
public:
    KZip( const QString& filename );

    KZip( QIODevice * dev );

    virtual ~KZip();

    enum ExtraField { NoExtraField = 0,      
                      ModificationTime = 1,  
                      DefaultExtraField = 1
    };

    void setExtraField( ExtraField ef );

    ExtraField extraField() const;

    enum Compression { NoCompression = 0,     
               DeflateCompression = 1 
    };


    void setCompression( Compression c );

    Compression compression() const;

    virtual bool writeData( const char* data, qint64 size );

protected:
    virtual bool doWriteSymLink(const QString &name, const QString &target,
                                const QString &user, const QString &group,
                                mode_t perm, time_t atime, time_t mtime, time_t ctime);
    virtual bool doPrepareWriting( const QString& name, const QString& user,
                                 const QString& group, qint64 size, mode_t perm,
                                 time_t atime, time_t mtime, time_t ctime );

    virtual bool doFinishWriting( qint64 size );

    virtual bool openArchive( QIODevice::OpenMode mode );

    virtual bool closeArchive();

    virtual bool doWriteDir( const QString& name, const QString& user,
                             const QString& group, mode_t perm, time_t atime,
                             time_t mtime, time_t ctime );

protected:
    virtual void virtual_hook( int id, void* data );

private:
    class KZipPrivate;
    KZipPrivate * const d;
};


class KDECORE_EXPORT KZipFileEntry : public KArchiveFile
{
public:
    KZipFileEntry( KZip* zip, const QString& name, int access, int date,
                   const QString& user, const QString& group, const QString& symlink,
                   const QString& path, qint64 start, qint64 uncompressedSize,
                   int encoding, qint64 compressedSize);

    ~KZipFileEntry();

    int encoding() const;
    qint64 compressedSize() const;

    void setCompressedSize(qint64 compressedSize);

    void setHeaderStart(qint64 headerstart);
    qint64 headerStart() const;

    unsigned long crc32() const;
    void setCRC32(unsigned long crc32);

    const QString &path() const;

    virtual QByteArray data() const;

    virtual QIODevice* createDevice() const;

private:
    class KZipFileEntryPrivate;
    KZipFileEntryPrivate * const d;
};

#endif