• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.20 API Reference
  • KDE Home
  • Contact Us
 

KDECore

  • kdecore
  • compression
kgzipfilter.h
Go to the documentation of this file.
1 /* This file is part of the KDE libraries
2  Copyright (C) 2000, 2009 David Faure <faure@kde.org>
3 
4  This library is free software; you can redistribute it and/or
5  modify it under the terms of the GNU Library General Public
6  License as published by the Free Software Foundation; either
7  version 2 of the License, or (at your option) any later version.
8 
9  This library is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  Library General Public License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to
16  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  Boston, MA 02110-1301, USA.
18 */
19 
20 #ifndef __kgzipfilter__h
21 #define __kgzipfilter__h
22 
23 #include "kfilterbase.h"
24 
32 class KARCHIVE_EXPORT KGzipFilter : public KFilterBase
33 {
34 public:
35  KGzipFilter();
36  virtual ~KGzipFilter();
37 
38 
39  virtual void init(int mode);
40 
41  // The top of zlib.h explains it: there are three cases.
42  // - Raw deflate, no header (e.g. inside a ZIP file)
43  // - Thin zlib header (1) (which is normally what HTTP calls "deflate" (2))
44  // - Gzip header, implemented here by readHeader
45  //
46  // (1) as written out by compress()/compress2()
47  // (2) see http://www.zlib.net/zlib_faq.html#faq39
48  enum Flag {
49  RawDeflate = 0, // raw deflate data
50  ZlibHeader = 1, // zlib headers (HTTP deflate)
51  GZipHeader = 2
52  };
53  void init(int mode, Flag flag); // for direct users of KGzipFilter
54  virtual int mode() const;
55  virtual void terminate();
56  virtual void reset();
57  virtual bool readHeader(); // this is about the GZIP header
58  virtual bool writeHeader( const QByteArray & fileName );
59  void writeFooter();
60  virtual void setOutBuffer( char * data, uint maxlen );
61  virtual void setInBuffer( const char * data, uint size );
62  virtual int inBufferAvailable() const;
63  virtual int outBufferAvailable() const;
64  virtual Result uncompress();
65  virtual Result compress( bool finish );
66 
67 private:
68  Result uncompress_noop();
69  class Private;
70  Private* const d;
71 };
72 
73 #endif
KFilterBase::init
virtual void init(int mode)=0
KFilterBase::setInBuffer
virtual void setInBuffer(const char *data, uint size)=0
KFilterBase::mode
virtual int mode() const =0
KFilterBase::reset
virtual void reset()
Definition: kfilterbase.cpp:153
KFilterBase::readHeader
virtual bool readHeader()=0
KGzipFilter
Internal class used by KFilterDev.
Definition: kgzipfilter.h:32
kfilterbase.h
KFilterBase::compress
virtual Result compress(bool finish)=0
KGzipFilter::Flag
Flag
Definition: kgzipfilter.h:48
KFilterBase::setOutBuffer
virtual void setOutBuffer(char *data, uint maxlen)=0
KFilterBase::outBufferAvailable
virtual int outBufferAvailable() const =0
KFilterBase
This is the base class for compression filters such as gzip and bzip2.
Definition: kfilterbase.h:36
KFilterBase::inBufferAvailable
virtual int inBufferAvailable() const =0
KFilterBase::terminate
virtual void terminate()
Definition: kfilterbase.cpp:149
KARCHIVE_EXPORT
#define KARCHIVE_EXPORT
Definition: karchive_export.h:46
KFilterBase::Result
Result
Definition: kfilterbase.h:82
KFilterBase::uncompress
virtual Result uncompress()=0
KFilterBase::writeHeader
virtual bool writeHeader(const QByteArray &filename)=0
This file is part of the KDE documentation.
Documentation copyright © 1996-2016 The KDE developers.
Generated on Sun May 8 2016 19:34:17 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

Skip menu "KDECore"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.20 API Reference

Skip menu "kdelibs-4.14.20 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal