Source: ktar.h

# Source: ktar.h |
Annotated List
Files
Globals
Hierarchy
Index

    /* This file is part of the KDE libraries
       Copyright (C) 2000 David Faure

       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., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
    */
    #ifndef __ktar_h
    #define __ktar_h

    #include
    #include

    #include
    #include
    #include
    #include

    #include

    /**
     * @short A class for reading/writing (optionnally compressed) tar archives.
     * @author Torben Weis , David Faure
     */
    class KTar : public KArchive
    {
    public:
        /**
         * Creates an instance that operates on the given filename.
         * using the compression filter associated to given mimetype.
         *
         * @param filename is a local path (e.g. "/home/weis/myfile.tgz")
         * @param mimetype "application/x-gzip" or "application/x-bzip2"
         * Do not use application/x-tgz or so. Only the compression layer !
         * If the mimetype is ommitted, it will be determined from the filename.
         */
        KTar( const QString& filename, const QString & mimetype = QString::null );

        /**
         * Creates an instance that operates on the given device.
         * The device can be compressed (KFilterDev) or not (QFile, etc.).
         * WARNING: don't assume that giving a QFile here will decompress the file,
         * in case it's compressed!
         */
        KTar( QIODevice * dev );

        /**
         * If the tar ball is still opened, then it will be
         * closed automatically by the destructor.
         */
        virtual ~KTar();

        /**
         * The name of the tar file, as passed to the constructor
         * Null if you used the QIODevice constructor.
         */
        QString fileName() { return m_filename; }

        /**
         * Special function for setting the "original file name" in the gzip header,
         * when writing a tar.gz file. It appears when using in the "file" command,
         * for instance. Should only be called if the underlying device is a KFilterDev!
         */
        void setOrigFileName( const QCString & fileName );

        virtual bool writeDir( const QString& name, const QString& user, const QString& group );
        virtual bool prepareWriting( const QString& name, const QString& user, const QString& group, uint size );
        virtual bool doneWriting( uint size );

    protected:
        /**
         * Opens the archive for reading.
         * Parses the directory listing of the archive
         * and creates the KArchiveDirectory/KArchiveFile entries.
         *
         */
        virtual bool openArchive( int mode );
        virtual bool closeArchive();

    private:
        /**
         * @internal
         */
        void prepareDevice( const QString & filename, const QString & mimetype, bool forced = false );

        /**
         * @internal
         * Fills @p buffer for writing a file as required by the tar format
         * Has to be called LAST, since it does the checksum
         * (normally, only the name has to be filled in before)
         * @param mode is expected to be 6 chars long, [uname and gname 31].
         */
        void fillBuffer( char * buffer, const char * mode, int size, char typeflag, const char * uname, const char * gname );

        QString m_filename;
    protected:
        virtual void virtual_hook( int id, void* data );
    private:
        class KTarPrivate;
        KTarPrivate * d;
    };

    /**
     * Old, deprecated naming
     */
    #define KTarGz KTar
    #define KTarEntry KArchiveEntry
    #define KTarFile KArchiveFile
    #define KTarDirectory KArchiveDirectory

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:57 2003, using kdoc 2.0a54.