Mercurial > hg > CbC > CbC_gcc
annotate zlib/contrib/blast/blast.h @ 51:ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
author | kent <kent@cr.ie.u-ryukyu.ac.jp> |
---|---|
date | Sun, 07 Feb 2010 18:27:48 +0900 |
parents | |
children | 04ced10e8804 |
rev | line source |
---|---|
51
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
1 /* blast.h -- interface for blast.c |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
2 Copyright (C) 2003 Mark Adler |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
3 version 1.1, 16 Feb 2003 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
4 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
5 This software is provided 'as-is', without any express or implied |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
6 warranty. In no event will the author be held liable for any damages |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
7 arising from the use of this software. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
8 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
9 Permission is granted to anyone to use this software for any purpose, |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
10 including commercial applications, and to alter it and redistribute it |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
11 freely, subject to the following restrictions: |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
12 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
13 1. The origin of this software must not be misrepresented; you must not |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
14 claim that you wrote the original software. If you use this software |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
15 in a product, an acknowledgment in the product documentation would be |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
16 appreciated but is not required. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
17 2. Altered source versions must be plainly marked as such, and must not be |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
18 misrepresented as being the original software. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
19 3. This notice may not be removed or altered from any source distribution. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
20 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
21 Mark Adler madler@alumni.caltech.edu |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
22 */ |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
23 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
24 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
25 /* |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
26 * blast() decompresses the PKWare Data Compression Library (DCL) compressed |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
27 * format. It provides the same functionality as the explode() function in |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
28 * that library. (Note: PKWare overused the "implode" verb, and the format |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
29 * used by their library implode() function is completely different and |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
30 * incompatible with the implode compression method supported by PKZIP.) |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
31 */ |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
32 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
33 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
34 typedef unsigned (*blast_in)(void *how, unsigned char **buf); |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
35 typedef int (*blast_out)(void *how, unsigned char *buf, unsigned len); |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
36 /* Definitions for input/output functions passed to blast(). See below for |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
37 * what the provided functions need to do. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
38 */ |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
39 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
40 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
41 int blast(blast_in infun, void *inhow, blast_out outfun, void *outhow); |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
42 /* Decompress input to output using the provided infun() and outfun() calls. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
43 * On success, the return value of blast() is zero. If there is an error in |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
44 * the source data, i.e. it is not in the proper format, then a negative value |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
45 * is returned. If there is not enough input available or there is not enough |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
46 * output space, then a positive error is returned. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
47 * |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
48 * The input function is invoked: len = infun(how, &buf), where buf is set by |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
49 * infun() to point to the input buffer, and infun() returns the number of |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
50 * available bytes there. If infun() returns zero, then blast() returns with |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
51 * an input error. (blast() only asks for input if it needs it.) inhow is for |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
52 * use by the application to pass an input descriptor to infun(), if desired. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
53 * |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
54 * The output function is invoked: err = outfun(how, buf, len), where the bytes |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
55 * to be written are buf[0..len-1]. If err is not zero, then blast() returns |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
56 * with an output error. outfun() is always called with len <= 4096. outhow |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
57 * is for use by the application to pass an output descriptor to outfun(), if |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
58 * desired. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
59 * |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
60 * The return codes are: |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
61 * |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
62 * 2: ran out of input before completing decompression |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
63 * 1: output error before completing decompression |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
64 * 0: successful decompression |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
65 * -1: literal flag not zero or one |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
66 * -2: dictionary size not in 4..6 |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
67 * -3: distance is too far back |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
68 * |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
69 * At the bottom of blast.c is an example program that uses blast() that can be |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
70 * compiled to produce a command-line decompression filter by defining TEST. |
ae3a4bfb450b
add some files of version 4.4.3 that have been forgotten.
kent <kent@cr.ie.u-ryukyu.ac.jp>
parents:
diff
changeset
|
71 */ |