xref: /plan9/sys/src/cmd/bzip2/lib/bzlib_stdio.h (revision 59cc4ca53493a3c6d2349fe2b7f7c40f7dce7294)
1 /*
2  * THIS FILE IS NOT IDENTICAL TO THE ORIGINAL
3  * FROM THE BZIP2 DISTRIBUTION.
4  *
5  * It has been modified, mainly to break the library
6  * into smaller pieces.
7  *
8  * Russ Cox
9  * rsc@plan9.bell-labs.com
10  * July 2000
11  */
12 
13 /*-------------------------------------------------------------*/
14 /*--- Library top-level functions.                          ---*/
15 /*---                                               bzlib.c ---*/
16 /*-------------------------------------------------------------*/
17 
18 /*--
19   This file is a part of bzip2 and/or libbzip2, a program and
20   library for lossless, block-sorting data compression.
21 
22   Copyright (C) 1996-2000 Julian R Seward.  All rights reserved.
23 
24   Redistribution and use in source and binary forms, with or without
25   modification, are permitted provided that the following conditions
26   are met:
27 
28   1. Redistributions of source code must retain the above copyright
29      notice, this list of conditions and the following disclaimer.
30 
31   2. The origin of this software must not be misrepresented; you must
32      not claim that you wrote the original software.  If you use this
33      software in a product, an acknowledgment in the product
34      documentation would be appreciated but is not required.
35 
36   3. Altered source versions must be plainly marked as such, and must
37      not be misrepresented as being the original software.
38 
39   4. The name of the author may not be used to endorse or promote
40      products derived from this software without specific prior written
41      permission.
42 
43   THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
44   OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
45   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46   ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
47   DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48   DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
49   GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
50   INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
51   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
52   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
53   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 
55   Julian Seward, Cambridge, UK.
56   jseward@acm.org
57   bzip2/libbzip2 version 1.0 of 21 March 2000
58 
59   This program is based on (at least) the work of:
60      Mike Burrows
61      David Wheeler
62      Peter Fenwick
63      Alistair Moffat
64      Radford Neal
65      Ian H. Witten
66      Robert Sedgewick
67      Jon L. Bentley
68 
69   For more information on these sources, see the manual.
70 --*/
71 
72 /*--
73    CHANGES
74    ~~~~~~~
75    0.9.0 -- original version.
76 
77    0.9.0a/b -- no changes in this file.
78 
79    0.9.0c
80       * made zero-length BZ_FLUSH work correctly in bzCompress().
81       * fixed bzWrite/bzRead to ignore zero-length requests.
82       * fixed bzread to correctly handle read requests after EOF.
83       * wrong parameter order in call to bzDecompressInit in
84         bzBuffToBuffDecompress.  Fixed.
85 --*/
86 
87 #include <stdio.h>
88 
89 #define BZ_MAX_UNUSED 5000
90 
91 typedef void BZFILE;
92 
93 BZ_EXTERN BZFILE * BZ_API(BZ2_bzopen) (
94       const char *path,
95       const char *mode
96    );
97 
98 BZ_EXTERN BZFILE * BZ_API(BZ2_bzdopen) (
99       int        fd,
100       const char *mode
101    );
102 
103 BZ_EXTERN int BZ_API(BZ2_bzread) (
104       BZFILE* b,
105       void* buf,
106       int len
107    );
108 
109 BZ_EXTERN int BZ_API(BZ2_bzwrite) (
110       BZFILE* b,
111       void*   buf,
112       int     len
113    );
114 
115 BZ_EXTERN int BZ_API(BZ2_bzflush) (
116       BZFILE* b
117    );
118 
119 BZ_EXTERN void BZ_API(BZ2_bzclose) (
120       BZFILE* b
121    );
122 
123 BZ_EXTERN const char * BZ_API(BZ2_bzerror) (
124       BZFILE *b,
125       int    *errnum
126    );
127 
128 
129 /*-- High(er) level library functions --*/
130 BZ_EXTERN BZFILE* BZ_API(BZ2_bzReadOpen) (
131       int*  bzerror,
132       FILE* f,
133       int   verbosity,
134       int   small,
135       void* unused,
136       int   nUnused
137    );
138 
139 BZ_EXTERN void BZ_API(BZ2_bzReadClose) (
140       int*    bzerror,
141       BZFILE* b
142    );
143 
144 BZ_EXTERN void BZ_API(BZ2_bzReadGetUnused) (
145       int*    bzerror,
146       BZFILE* b,
147       void**  unused,
148       int*    nUnused
149    );
150 
151 BZ_EXTERN int BZ_API(BZ2_bzRead) (
152       int*    bzerror,
153       BZFILE* b,
154       void*   buf,
155       int     len
156    );
157 
158 BZ_EXTERN BZFILE* BZ_API(BZ2_bzWriteOpen) (
159       int*  bzerror,
160       FILE* f,
161       int   blockSize100k,
162       int   verbosity,
163       int   workFactor
164    );
165 
166 BZ_EXTERN void BZ_API(BZ2_bzWrite) (
167       int*    bzerror,
168       BZFILE* b,
169       void*   buf,
170       int     len
171    );
172 
173 BZ_EXTERN void BZ_API(BZ2_bzWriteClose) (
174       int*          bzerror,
175       BZFILE*       b,
176       int           abandon,
177       unsigned int* nbytes_in,
178       unsigned int* nbytes_out
179    );
180 
181 BZ_EXTERN void BZ_API(BZ2_bzWriteClose64) (
182       int*          bzerror,
183       BZFILE*       b,
184       int           abandon,
185       unsigned int* nbytes_in_lo32,
186       unsigned int* nbytes_in_hi32,
187       unsigned int* nbytes_out_lo32,
188       unsigned int* nbytes_out_hi32
189    );
190 
191