xref: /netbsd-src/common/dist/zlib/examples/zpipe.c (revision c34236556bea94afcaca1782d7d228301edc3ea0)
1aaf4ece6Schristos /* zpipe.c: example of proper use of zlib's inflate() and deflate()
2aaf4ece6Schristos    Not copyrighted -- provided to the public domain
3*c3423655Schristos    Version 1.4  11 December 2005  Mark Adler */
4aaf4ece6Schristos 
5aaf4ece6Schristos /* Version history:
6aaf4ece6Schristos    1.0  30 Oct 2004  First version
7aaf4ece6Schristos    1.1   8 Nov 2004  Add void casting for unused return values
8aaf4ece6Schristos                      Use switch statement for inflate() return values
9aaf4ece6Schristos    1.2   9 Nov 2004  Add assertions to document zlib guarantees
10aaf4ece6Schristos    1.3   6 Apr 2005  Remove incorrect assertion in inf()
11*c3423655Schristos    1.4  11 Dec 2005  Add hack to avoid MSDOS end-of-line conversions
12*c3423655Schristos                      Avoid some compiler warnings for input and output buffers
13aaf4ece6Schristos  */
14aaf4ece6Schristos 
15aaf4ece6Schristos #include <stdio.h>
16aaf4ece6Schristos #include <string.h>
17aaf4ece6Schristos #include <assert.h>
18aaf4ece6Schristos #include "zlib.h"
19aaf4ece6Schristos 
20*c3423655Schristos #if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(__CYGWIN__)
21*c3423655Schristos #  include <fcntl.h>
22*c3423655Schristos #  include <io.h>
23*c3423655Schristos #  define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
24*c3423655Schristos #else
25*c3423655Schristos #  define SET_BINARY_MODE(file)
26*c3423655Schristos #endif
27*c3423655Schristos 
28aaf4ece6Schristos #define CHUNK 16384
29aaf4ece6Schristos 
30aaf4ece6Schristos /* Compress from file source to file dest until EOF on source.
31aaf4ece6Schristos    def() returns Z_OK on success, Z_MEM_ERROR if memory could not be
32aaf4ece6Schristos    allocated for processing, Z_STREAM_ERROR if an invalid compression
33aaf4ece6Schristos    level is supplied, Z_VERSION_ERROR if the version of zlib.h and the
34aaf4ece6Schristos    version of the library linked do not match, or Z_ERRNO if there is
35aaf4ece6Schristos    an error reading or writing the files. */
def(FILE * source,FILE * dest,int level)36aaf4ece6Schristos int def(FILE *source, FILE *dest, int level)
37aaf4ece6Schristos {
38aaf4ece6Schristos     int ret, flush;
39aaf4ece6Schristos     unsigned have;
40aaf4ece6Schristos     z_stream strm;
41*c3423655Schristos     unsigned char in[CHUNK];
42*c3423655Schristos     unsigned char out[CHUNK];
43aaf4ece6Schristos 
44aaf4ece6Schristos     /* allocate deflate state */
45aaf4ece6Schristos     strm.zalloc = Z_NULL;
46aaf4ece6Schristos     strm.zfree = Z_NULL;
47aaf4ece6Schristos     strm.opaque = Z_NULL;
48aaf4ece6Schristos     ret = deflateInit(&strm, level);
49aaf4ece6Schristos     if (ret != Z_OK)
50aaf4ece6Schristos         return ret;
51aaf4ece6Schristos 
52aaf4ece6Schristos     /* compress until end of file */
53aaf4ece6Schristos     do {
54aaf4ece6Schristos         strm.avail_in = fread(in, 1, CHUNK, source);
55aaf4ece6Schristos         if (ferror(source)) {
56aaf4ece6Schristos             (void)deflateEnd(&strm);
57aaf4ece6Schristos             return Z_ERRNO;
58aaf4ece6Schristos         }
59aaf4ece6Schristos         flush = feof(source) ? Z_FINISH : Z_NO_FLUSH;
60aaf4ece6Schristos         strm.next_in = in;
61aaf4ece6Schristos 
62aaf4ece6Schristos         /* run deflate() on input until output buffer not full, finish
63aaf4ece6Schristos            compression if all of source has been read in */
64aaf4ece6Schristos         do {
65aaf4ece6Schristos             strm.avail_out = CHUNK;
66aaf4ece6Schristos             strm.next_out = out;
67aaf4ece6Schristos             ret = deflate(&strm, flush);    /* no bad return value */
68aaf4ece6Schristos             assert(ret != Z_STREAM_ERROR);  /* state not clobbered */
69aaf4ece6Schristos             have = CHUNK - strm.avail_out;
70aaf4ece6Schristos             if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
71aaf4ece6Schristos                 (void)deflateEnd(&strm);
72aaf4ece6Schristos                 return Z_ERRNO;
73aaf4ece6Schristos             }
74aaf4ece6Schristos         } while (strm.avail_out == 0);
75aaf4ece6Schristos         assert(strm.avail_in == 0);     /* all input will be used */
76aaf4ece6Schristos 
77aaf4ece6Schristos         /* done when last data in file processed */
78aaf4ece6Schristos     } while (flush != Z_FINISH);
79aaf4ece6Schristos     assert(ret == Z_STREAM_END);        /* stream will be complete */
80aaf4ece6Schristos 
81aaf4ece6Schristos     /* clean up and return */
82aaf4ece6Schristos     (void)deflateEnd(&strm);
83aaf4ece6Schristos     return Z_OK;
84aaf4ece6Schristos }
85aaf4ece6Schristos 
86aaf4ece6Schristos /* Decompress from file source to file dest until stream ends or EOF.
87aaf4ece6Schristos    inf() returns Z_OK on success, Z_MEM_ERROR if memory could not be
88aaf4ece6Schristos    allocated for processing, Z_DATA_ERROR if the deflate data is
89aaf4ece6Schristos    invalid or incomplete, Z_VERSION_ERROR if the version of zlib.h and
90aaf4ece6Schristos    the version of the library linked do not match, or Z_ERRNO if there
91aaf4ece6Schristos    is an error reading or writing the files. */
inf(FILE * source,FILE * dest)92aaf4ece6Schristos int inf(FILE *source, FILE *dest)
93aaf4ece6Schristos {
94aaf4ece6Schristos     int ret;
95aaf4ece6Schristos     unsigned have;
96aaf4ece6Schristos     z_stream strm;
97*c3423655Schristos     unsigned char in[CHUNK];
98*c3423655Schristos     unsigned char out[CHUNK];
99aaf4ece6Schristos 
100aaf4ece6Schristos     /* allocate inflate state */
101aaf4ece6Schristos     strm.zalloc = Z_NULL;
102aaf4ece6Schristos     strm.zfree = Z_NULL;
103aaf4ece6Schristos     strm.opaque = Z_NULL;
104aaf4ece6Schristos     strm.avail_in = 0;
105aaf4ece6Schristos     strm.next_in = Z_NULL;
106aaf4ece6Schristos     ret = inflateInit(&strm);
107aaf4ece6Schristos     if (ret != Z_OK)
108aaf4ece6Schristos         return ret;
109aaf4ece6Schristos 
110aaf4ece6Schristos     /* decompress until deflate stream ends or end of file */
111aaf4ece6Schristos     do {
112aaf4ece6Schristos         strm.avail_in = fread(in, 1, CHUNK, source);
113aaf4ece6Schristos         if (ferror(source)) {
114aaf4ece6Schristos             (void)inflateEnd(&strm);
115aaf4ece6Schristos             return Z_ERRNO;
116aaf4ece6Schristos         }
117aaf4ece6Schristos         if (strm.avail_in == 0)
118aaf4ece6Schristos             break;
119aaf4ece6Schristos         strm.next_in = in;
120aaf4ece6Schristos 
121aaf4ece6Schristos         /* run inflate() on input until output buffer not full */
122aaf4ece6Schristos         do {
123aaf4ece6Schristos             strm.avail_out = CHUNK;
124aaf4ece6Schristos             strm.next_out = out;
125aaf4ece6Schristos             ret = inflate(&strm, Z_NO_FLUSH);
126aaf4ece6Schristos             assert(ret != Z_STREAM_ERROR);  /* state not clobbered */
127aaf4ece6Schristos             switch (ret) {
128aaf4ece6Schristos             case Z_NEED_DICT:
129aaf4ece6Schristos                 ret = Z_DATA_ERROR;     /* and fall through */
130aaf4ece6Schristos             case Z_DATA_ERROR:
131aaf4ece6Schristos             case Z_MEM_ERROR:
132aaf4ece6Schristos                 (void)inflateEnd(&strm);
133aaf4ece6Schristos                 return ret;
134aaf4ece6Schristos             }
135aaf4ece6Schristos             have = CHUNK - strm.avail_out;
136aaf4ece6Schristos             if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
137aaf4ece6Schristos                 (void)inflateEnd(&strm);
138aaf4ece6Schristos                 return Z_ERRNO;
139aaf4ece6Schristos             }
140aaf4ece6Schristos         } while (strm.avail_out == 0);
141aaf4ece6Schristos 
142aaf4ece6Schristos         /* done when inflate() says it's done */
143aaf4ece6Schristos     } while (ret != Z_STREAM_END);
144aaf4ece6Schristos 
145aaf4ece6Schristos     /* clean up and return */
146aaf4ece6Schristos     (void)inflateEnd(&strm);
147aaf4ece6Schristos     return ret == Z_STREAM_END ? Z_OK : Z_DATA_ERROR;
148aaf4ece6Schristos }
149aaf4ece6Schristos 
150aaf4ece6Schristos /* report a zlib or i/o error */
zerr(int ret)151aaf4ece6Schristos void zerr(int ret)
152aaf4ece6Schristos {
153aaf4ece6Schristos     fputs("zpipe: ", stderr);
154aaf4ece6Schristos     switch (ret) {
155aaf4ece6Schristos     case Z_ERRNO:
156aaf4ece6Schristos         if (ferror(stdin))
157aaf4ece6Schristos             fputs("error reading stdin\n", stderr);
158aaf4ece6Schristos         if (ferror(stdout))
159aaf4ece6Schristos             fputs("error writing stdout\n", stderr);
160aaf4ece6Schristos         break;
161aaf4ece6Schristos     case Z_STREAM_ERROR:
162aaf4ece6Schristos         fputs("invalid compression level\n", stderr);
163aaf4ece6Schristos         break;
164aaf4ece6Schristos     case Z_DATA_ERROR:
165aaf4ece6Schristos         fputs("invalid or incomplete deflate data\n", stderr);
166aaf4ece6Schristos         break;
167aaf4ece6Schristos     case Z_MEM_ERROR:
168aaf4ece6Schristos         fputs("out of memory\n", stderr);
169aaf4ece6Schristos         break;
170aaf4ece6Schristos     case Z_VERSION_ERROR:
171aaf4ece6Schristos         fputs("zlib version mismatch!\n", stderr);
172aaf4ece6Schristos     }
173aaf4ece6Schristos }
174aaf4ece6Schristos 
175aaf4ece6Schristos /* compress or decompress from stdin to stdout */
main(int argc,char ** argv)176aaf4ece6Schristos int main(int argc, char **argv)
177aaf4ece6Schristos {
178aaf4ece6Schristos     int ret;
179aaf4ece6Schristos 
180*c3423655Schristos     /* avoid end-of-line conversions */
181*c3423655Schristos     SET_BINARY_MODE(stdin);
182*c3423655Schristos     SET_BINARY_MODE(stdout);
183*c3423655Schristos 
184aaf4ece6Schristos     /* do compression if no arguments */
185aaf4ece6Schristos     if (argc == 1) {
186aaf4ece6Schristos         ret = def(stdin, stdout, Z_DEFAULT_COMPRESSION);
187aaf4ece6Schristos         if (ret != Z_OK)
188aaf4ece6Schristos             zerr(ret);
189aaf4ece6Schristos         return ret;
190aaf4ece6Schristos     }
191aaf4ece6Schristos 
192aaf4ece6Schristos     /* do decompression if -d specified */
193aaf4ece6Schristos     else if (argc == 2 && strcmp(argv[1], "-d") == 0) {
194aaf4ece6Schristos         ret = inf(stdin, stdout);
195aaf4ece6Schristos         if (ret != Z_OK)
196aaf4ece6Schristos             zerr(ret);
197aaf4ece6Schristos         return ret;
198aaf4ece6Schristos     }
199aaf4ece6Schristos 
200aaf4ece6Schristos     /* otherwise, report usage */
201aaf4ece6Schristos     else {
202aaf4ece6Schristos         fputs("zpipe usage: zpipe [-d] < source > dest\n", stderr);
203aaf4ece6Schristos         return 1;
204aaf4ece6Schristos     }
205aaf4ece6Schristos }
206