1
// Protocol Buffers - Google's data interchange format
2
// Copyright 2008 Google Inc. All rights reserved.
3
// http://code.google.com/p/protobuf/
5
// Redistribution and use in source and binary forms, with or without
6
// modification, are permitted provided that the following conditions are
9
// * Redistributions of source code must retain the above copyright
10
// notice, this list of conditions and the following disclaimer.
11
// * Redistributions in binary form must reproduce the above
12
// copyright notice, this list of conditions and the following disclaimer
13
// in the documentation and/or other materials provided with the
15
// * Neither the name of Google Inc. nor the names of its
16
// contributors may be used to endorse or promote products derived from
17
// this software without specific prior written permission.
19
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
// Author: brianolson@google.com (Brian Olson)
33
// This file contains the definition for classes GzipInputStream and
36
// GzipInputStream decompresses data from an underlying
37
// ZeroCopyInputStream and provides the decompressed data as a
38
// ZeroCopyInputStream.
40
// GzipOutputStream is an ZeroCopyOutputStream that compresses data to
41
// an underlying ZeroCopyOutputStream.
43
#ifndef GOOGLE_PROTOBUF_IO_GZIP_STREAM_H__
44
#define GOOGLE_PROTOBUF_IO_GZIP_STREAM_H__
48
#include <google/protobuf/io/zero_copy_stream.h>
54
// A ZeroCopyInputStream that reads compressed data through zlib
55
class LIBPROTOBUF_EXPORT GzipInputStream : public ZeroCopyInputStream {
57
// Format key for constructor
59
// zlib will autodetect gzip header or deflate stream
62
// GZIP streams have some extra header data for file attributes.
65
// Simpler zlib stream format.
69
// buffer_size and format may be -1 for default of 64kB and GZIP format
70
explicit GzipInputStream(
71
ZeroCopyInputStream* sub_stream,
73
int buffer_size = -1);
74
virtual ~GzipInputStream();
76
// Return last error message or NULL if no error.
77
inline const char* ZlibErrorMessage() const {
80
inline int ZlibErrorCode() const {
84
// implements ZeroCopyInputStream ----------------------------------
85
bool Next(const void** data, int* size);
86
void BackUp(int count);
88
int64 ByteCount() const;
93
ZeroCopyInputStream* sub_stream_;
99
void* output_position_;
100
size_t output_buffer_length_;
102
int Inflate(int flush);
103
void DoNextOutput(const void** data, int* size);
105
GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(GzipInputStream);
109
class LIBPROTOBUF_EXPORT GzipOutputStream : public ZeroCopyOutputStream {
111
// Format key for constructor
113
// GZIP streams have some extra header data for file attributes.
116
// Simpler zlib stream format.
124
// What size buffer to use internally. Defaults to 64kB.
127
// A number between 0 and 9, where 0 is no compression and 9 is best
128
// compression. Defaults to Z_DEFAULT_COMPRESSION (see zlib.h).
129
int compression_level;
131
// Defaults to Z_DEFAULT_STRATEGY. Can also be set to Z_FILTERED,
132
// Z_HUFFMAN_ONLY, or Z_RLE. See the documentation for deflateInit2 in
133
// zlib.h for definitions of these constants.
134
int compression_strategy;
136
Options(); // Initializes with default values.
139
// Create a GzipOutputStream with default options.
140
explicit GzipOutputStream(ZeroCopyOutputStream* sub_stream);
142
// Create a GzipOutputStream with the given options.
144
ZeroCopyOutputStream* sub_stream,
145
const Options& options);
147
// DEPRECATED: Use one of the above constructors instead.
149
ZeroCopyOutputStream* sub_stream,
151
int buffer_size = -1) GOOGLE_ATTRIBUTE_DEPRECATED;
153
virtual ~GzipOutputStream();
155
// Return last error message or NULL if no error.
156
inline const char* ZlibErrorMessage() const {
157
return zcontext_.msg;
159
inline int ZlibErrorCode() const {
163
// Flushes data written so far to zipped data in the underlying stream.
164
// It is the caller's responsibility to flush the underlying stream if
166
// Compression may be less efficient stopping and starting around flushes.
167
// Returns true if no error.
170
// Writes out all data and closes the gzip stream.
171
// It is the caller's responsibility to close the underlying stream if
173
// Returns true if no error.
176
// implements ZeroCopyOutputStream ---------------------------------
177
bool Next(void** data, int* size);
178
void BackUp(int count);
179
int64 ByteCount() const;
182
ZeroCopyOutputStream* sub_stream_;
183
// Result from calling Next() on sub_stream_
190
size_t input_buffer_length_;
192
// Shared constructor code.
193
void Init(ZeroCopyOutputStream* sub_stream, const Options& options);
195
// Do some compression.
196
// Takes zlib flush mode.
197
// Returns zlib error code.
198
int Deflate(int flush);
200
GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(GzipOutputStream);
204
} // namespace protobuf
206
} // namespace google
207
#endif // GOOGLE_PROTOBUF_IO_GZIP_STREAM_H__