1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/* 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 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 __kfilterdev_h
#define __kfilterdev_h
#include <qiodevice.h>
#include <qstring.h>
#include <kdelibs_export.h>
class QFile;
class KFilterBase;
/**
* A class for reading and writing compressed data onto a device
* (e.g. file, but other usages are possible, like a buffer or a socket).
*
* To simply read/write compressed files, see deviceForFile.
*
* @author David Faure <faure@kde.org>
*/
class KIO_EXPORT KFilterDev : public QIODevice
{
public:
/**
* Constructs a KFilterDev for a given filter (e.g. gzip, bzip2 etc.).
* @param filter the KFilterBase to use
* @param autoDeleteFilterBase when true this object will become the
* owner of @p filter.
*/
KFilterDev( KFilterBase * filter, bool autoDeleteFilterBase = false );
/**
* Destructs the KFilterDev.
* Calls close() if the filter device is still open.
*/
virtual ~KFilterDev();
/**
* Open for reading or writing.
* If the KFilterBase's device is not opened, it will be opened.
*/
virtual bool open( int mode );
/**
* Close after reading or writing.
* If the KFilterBase's device was opened by open(), it will be closed.
*/
virtual void close();
virtual void flush();
/**
* For writing gzip compressed files only:
* set the name of the original file, to be used in the gzip header.
* @param fileName the name of the original file
*/
void setOrigFileName( const QCString & fileName );
/**
* Call this let this device skip the gzip headers when reading/writing.
* This way KFilterDev (with gzip filter) can be used as a direct wrapper
* around zlib - this is used by KZip.
* @since 3.1
*/
void setSkipHeaders();
// Not implemented
virtual QIODevice::Offset size() const;
virtual QIODevice::Offset at() const;
/**
* That one can be quite slow, when going back. Use with care.
*/
virtual bool at( QIODevice::Offset );
virtual bool atEnd() const;
virtual Q_LONG readBlock( char *data, Q_ULONG maxlen );
virtual Q_LONG writeBlock( const char *data, Q_ULONG len );
//int readLine( char *data, uint maxlen );
virtual int getch();
virtual int putch( int );
virtual int ungetch( int );
#ifdef KDE_NO_COMPAT
private:
#endif
/**
* Call this to create the appropriate filter device for @p base
* working on @p file . The returned QIODevice has to be deleted
* after using.
* @deprecated. Use deviceForFile instead.
* To be removed in KDE 3.0
*/
static QIODevice* createFilterDevice(KFilterBase* base, QFile* file) KDE_DEPRECATED;
public:
/**
* Creates an i/o device that is able to read from @p fileName,
* whether it's compressed or not. Available compression filters
* (gzip/bzip2 etc.) will automatically be used.
*
* The compression filter to be used is determined from the @p fileName
* if @p mimetype is empty. Pass "application/x-gzip" or "application/x-bzip2"
* to force the corresponding decompression filter, if available.
*
* Warning: application/x-bzip2 may not be available.
* In that case a QFile opened on the compressed data will be returned !
* Use KFilterBase::findFilterByMimeType and code similar to what
* deviceForFile is doing, to better control what's happening.
*
* The returned QIODevice has to be deleted after using.
*
* @param fileName the name of the file to filter
* @param mimetype the mime type of the file to filter, or QString::null if unknown
* @param forceFilter if true, the function will either find a compression filter, or return 0.
* If false, it will always return a QIODevice. If no
* filter is available it will return a simple QFile.
* This can be useful if the file is usable without a filter.
* @return if a filter has been found, the QIODevice for the filter. If the
* filter does not exist, the return value depends on @p forceFilter.
* The returned QIODevice has to be deleted after using.
*/
static QIODevice * deviceForFile( const QString & fileName, const QString & mimetype = QString::null,
bool forceFilter = false );
/**
* Creates an i/o device that is able to read from the QIODevice @p inDevice,
* whether the data is compressed or not. Available compression filters
* (gzip/bzip2 etc.) will automatically be used.
*
* The compression filter to be used is determined @p mimetype .
* Pass "application/x-gzip" or "application/x-bzip2"
* to use the corresponding decompression filter.
*
* Warning: application/x-bzip2 may not be available.
* In that case 0 will be returned !
*
* The returned QIODevice has to be deleted after using.
* @param inDevice input device, becomes owned by this device! Automatically deleted!
* @param mimetype the mime type for the filter
* @return a QIODevice that filters the original stream. Must be deleted after
* using
*/
static QIODevice * device( QIODevice* inDevice, const QString & mimetype);
// BIC: merge with device() method below, using default value for autoDeleteInDevice
/**
* Creates an i/o device that is able to read from the QIODevice @p inDevice,
* whether the data is compressed or not. Available compression filters
* (gzip/bzip2 etc.) will automatically be used.
*
* The compression filter to be used is determined @p mimetype .
* Pass "application/x-gzip" or "application/x-bzip2"
* to use the corresponding decompression filter.
*
* Warning: application/x-bzip2 may not be available.
* In that case 0 will be returned !
*
* The returned QIODevice has to be deleted after using.
* @param inDevice input device. Won't be deleted if @p autoDeleteInDevice = false
* @param mimetype the mime type for the filter
* @param autoDeleteInDevice if true, @p inDevice will be deleted automatically
* @return a QIODevice that filters the original stream. Must be deleted after
* using
* @since 3.1
*/
static QIODevice * device( QIODevice* inDevice, const QString & mimetype, bool autoDeleteInDevice );
private:
KFilterBase *filter;
class KFilterDevPrivate;
KFilterDevPrivate * d;
};
#endif
|
