File indexing completed on 2024-04-21 03:52:32

 /* This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2000 David Faure <faure@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef __kfilterbase__h
 #define __kfilterbase__h
 
 #include <karchive_export.h>
 
 #include <QObject>
 #include <QString>
 class KFilterBasePrivate;
 
 class QIODevice;
 
 /**
  * @class KFilterBase kfilterbase.h KFilterBase
  *
  * This is the base class for compression filters
  * such as gzip and bzip2. It's pretty much internal.
  * Don't use directly, use KCompressionDevice instead.
  * @internal
  */
 class KARCHIVE_EXPORT KFilterBase
 {
 public:
     KFilterBase();
     virtual ~KFilterBase();
 
     /**
      * Sets the device on which the filter will work
      * @param dev the device on which the filter will work
      * @param autodelete if true, @p dev is deleted when the filter is deleted
      */
     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 !
 
     /**
      * Returns the device on which the filter will work.
      * @returns the device on which the filter will work
      */
     QIODevice *device();
     /** \internal */
     virtual bool init(int mode) = 0;
     /** \internal */
     virtual int mode() const = 0;
     /** \internal */
     virtual bool terminate();
     /** \internal */
     virtual void reset();
     /** \internal */
     virtual bool readHeader() = 0;
     /** \internal */
     virtual bool writeHeader(const QByteArray &filename) = 0;
     /** \internal */
     virtual void setOutBuffer(char *data, uint maxlen) = 0;
     /** \internal */
     virtual void setInBuffer(const char *data, uint size) = 0;
     /** \internal */
     virtual bool inBufferEmpty() const;
     /** \internal */
     virtual int inBufferAvailable() const = 0;
     /** \internal */
     virtual bool outBufferFull() const;
     /** \internal */
     virtual int outBufferAvailable() const = 0;
 
     /** \internal */
     enum Result {
         Ok,
         End,
         Error,
     };
     /** \internal */
     virtual Result uncompress() = 0;
     /** \internal */
     virtual Result compress(bool finish) = 0;
 
     /**
      * \internal
      * \since 4.3
      */
     enum FilterFlags {
         NoHeaders = 0,
         WithHeaders = 1,
         ZlibHeaders = 2, // only use for gzip compression
     };
     /**
      * \internal
      * \since 4.3
      */
     void setFilterFlags(FilterFlags flags);
     FilterFlags filterFlags() const;
 
 protected:
     /** Virtual hook, used to add new "virtual" functions while maintaining
         binary compatibility. Unused in this class.
     */
     virtual void virtual_hook(int id, void *data);
 
 private:
     Q_DISABLE_COPY(KFilterBase)
     KFilterBasePrivate *const d;
 };
 
 #endif