kfilterbase.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2000 David Faure <faure@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   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 __kfilterbase__h
#define __kfilterbase__h

#include <karchive_export.h>

#include <QtCore/QObject>
#include <QtCore/QString>

class QIODevice;

class KARCHIVE_EXPORT KFilterBase
{
public:
    KFilterBase();
    virtual ~KFilterBase();

    void setDevice( QIODevice * dev, bool autodelete = false );
    // Note that this isn't in the constructor, because of KLibFactory::create,
    // but it should be called before using the filterbase !

    QIODevice * device();
    virtual void init( int mode ) = 0;   // KDE5 TODO: return a bool
    virtual int mode() const = 0;
    virtual void terminate();
    virtual void reset();
    virtual bool readHeader() = 0;
    virtual bool writeHeader( const QByteArray & filename ) = 0;
    virtual void setOutBuffer( char * data, uint maxlen ) = 0;
    virtual void setInBuffer( const char * data, uint size ) = 0;
    virtual bool inBufferEmpty() const;
    virtual int  inBufferAvailable() const = 0;
    virtual bool outBufferFull() const;
    virtual int  outBufferAvailable() const = 0;

    enum Result { Ok, End, Error };
    virtual Result uncompress() = 0;
    virtual Result compress( bool finish ) = 0;

    enum FilterFlags {
        NoHeaders = 0,
        WithHeaders = 1
    };
    void setFilterFlags(FilterFlags flags);
    FilterFlags filterFlags() const;

    static KFilterBase * findFilterByFileName( const QString & fileName );

    static KFilterBase * findFilterByMimeType( const QString & mimeType );

protected: // TODO KDE5: move to d pointer
    QIODevice * m_dev;
    bool m_bAutoDel;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    Q_DISABLE_COPY( KFilterBase )
    class Private;
    Private * const d;
};

#endif