You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@corinthia.apache.org by ja...@apache.org on 2015/03/23 17:19:49 UTC
[61/83] [abbrv] incubator-corinthia git commit: removed zlib
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/1a48f7c3/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.c
----------------------------------------------------------------------
diff --git a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.c b/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.c
deleted file mode 100644
index 922f878..0000000
--- a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.c
+++ /dev/null
@@ -1,1059 +0,0 @@
-/*
- * gzlog.c
- * Copyright (C) 2004, 2008, 2012 Mark Adler, all rights reserved
- * For conditions of distribution and use, see copyright notice in gzlog.h
- * version 2.2, 14 Aug 2012
- */
-
-/*
- gzlog provides a mechanism for frequently appending short strings to a gzip
- file that is efficient both in execution time and compression ratio. The
- strategy is to write the short strings in an uncompressed form to the end of
- the gzip file, only compressing when the amount of uncompressed data has
- reached a given threshold.
-
- gzlog also provides protection against interruptions in the process due to
- system crashes. The status of the operation is recorded in an extra field
- in the gzip file, and is only updated once the gzip file is brought to a
- valid state. The last data to be appended or compressed is saved in an
- auxiliary file, so that if the operation is interrupted, it can be completed
- the next time an append operation is attempted.
-
- gzlog maintains another auxiliary file with the last 32K of data from the
- compressed portion, which is preloaded for the compression of the subsequent
- data. This minimizes the impact to the compression ratio of appending.
- */
-
-/*
- Operations Concept:
-
- Files (log name "foo"):
- foo.gz -- gzip file with the complete log
- foo.add -- last message to append or last data to compress
- foo.dict -- dictionary of the last 32K of data for next compression
- foo.temp -- temporary dictionary file for compression after this one
- foo.lock -- lock file for reading and writing the other files
- foo.repairs -- log file for log file recovery operations (not compressed)
-
- gzip file structure:
- - fixed-length (no file name) header with extra field (see below)
- - compressed data ending initially with empty stored block
- - uncompressed data filling out originally empty stored block and
- subsequent stored blocks as needed (16K max each)
- - gzip trailer
- - no junk at end (no other gzip streams)
-
- When appending data, the information in the first three items above plus the
- foo.add file are sufficient to recover an interrupted append operation. The
- extra field has the necessary information to restore the start of the last
- stored block and determine where to append the data in the foo.add file, as
- well as the crc and length of the gzip data before the append operation.
-
- The foo.add file is created before the gzip file is marked for append, and
- deleted after the gzip file is marked as complete. So if the append
- operation is interrupted, the data to add will still be there. If due to
- some external force, the foo.add file gets deleted between when the append
- operation was interrupted and when recovery is attempted, the gzip file will
- still be restored, but without the appended data.
-
- When compressing data, the information in the first two items above plus the
- foo.add file are sufficient to recover an interrupted compress operation.
- The extra field has the necessary information to find the end of the
- compressed data, and contains both the crc and length of just the compressed
- data and of the complete set of data including the contents of the foo.add
- file.
-
- Again, the foo.add file is maintained during the compress operation in case
- of an interruption. If in the unlikely event the foo.add file with the data
- to be compressed is missing due to some external force, a gzip file with
- just the previous compressed data will be reconstructed. In this case, all
- of the data that was to be compressed is lost (approximately one megabyte).
- This will not occur if all that happened was an interruption of the compress
- operation.
-
- The third state that is marked is the replacement of the old dictionary with
- the new dictionary after a compress operation. Once compression is
- complete, the gzip file is marked as being in the replace state. This
- completes the gzip file, so an interrupt after being so marked does not
- result in recompression. Then the dictionary file is replaced, and the gzip
- file is marked as completed. This state prevents the possibility of
- restarting compression with the wrong dictionary file.
-
- All three operations are wrapped by a lock/unlock procedure. In order to
- gain exclusive access to the log files, first a foo.lock file must be
- exclusively created. When all operations are complete, the lock is
- released by deleting the foo.lock file. If when attempting to create the
- lock file, it already exists and the modify time of the lock file is more
- than five minutes old (set by the PATIENCE define below), then the old
- lock file is considered stale and deleted, and the exclusive creation of
- the lock file is retried. To assure that there are no false assessments
- of the staleness of the lock file, the operations periodically touch the
- lock file to update the modified date.
-
- Following is the definition of the extra field with all of the information
- required to enable the above append and compress operations and their
- recovery if interrupted. Multi-byte values are stored little endian
- (consistent with the gzip format). File pointers are eight bytes long.
- The crc's and lengths for the gzip trailer are four bytes long. (Note that
- the length at the end of a gzip file is used for error checking only, and
- for large files is actually the length modulo 2^32.) The stored block
- length is two bytes long. The gzip extra field two-byte identification is
- "ap" for append. It is assumed that writing the extra field to the file is
- an "atomic" operation. That is, either all of the extra field is written
- to the file, or none of it is, if the operation is interrupted right at the
- point of updating the extra field. This is a reasonable assumption, since
- the extra field is within the first 52 bytes of the file, which is smaller
- than any expected block size for a mass storage device (usually 512 bytes or
- larger).
-
- Extra field (35 bytes):
- - Pointer to first stored block length -- this points to the two-byte length
- of the first stored block, which is followed by the two-byte, one's
- complement of that length. The stored block length is preceded by the
- three-bit header of the stored block, which is the actual start of the
- stored block in the deflate format. See the bit offset field below.
- - Pointer to the last stored block length. This is the same as above, but
- for the last stored block of the uncompressed data in the gzip file.
- Initially this is the same as the first stored block length pointer.
- When the stored block gets to 16K (see the MAX_STORE define), then a new
- stored block as added, at which point the last stored block length pointer
- is different from the first stored block length pointer. When they are
- different, the first bit of the last stored block header is eight bits, or
- one byte back from the block length.
- - Compressed data crc and length. This is the crc and length of the data
- that is in the compressed portion of the deflate stream. These are used
- only in the event that the foo.add file containing the data to compress is
- lost after a compress operation is interrupted.
- - Total data crc and length. This is the crc and length of all of the data
- stored in the gzip file, compressed and uncompressed. It is used to
- reconstruct the gzip trailer when compressing, as well as when recovering
- interrupted operations.
- - Final stored block length. This is used to quickly find where to append,
- and allows the restoration of the original final stored block state when
- an append operation is interrupted.
- - First stored block start as the number of bits back from the final stored
- block first length byte. This value is in the range of 3..10, and is
- stored as the low three bits of the final byte of the extra field after
- subtracting three (0..7). This allows the last-block bit of the stored
- block header to be updated when a new stored block is added, for the case
- when the first stored block and the last stored block are the same. (When
- they are different, the numbers of bits back is known to be eight.) This
- also allows for new compressed data to be appended to the old compressed
- data in the compress operation, overwriting the previous first stored
- block, or for the compressed data to be terminated and a valid gzip file
- reconstructed on the off chance that a compression operation was
- interrupted and the data to compress in the foo.add file was deleted.
- - The operation in process. This is the next two bits in the last byte (the
- bits under the mask 0x18). The are interpreted as 0: nothing in process,
- 1: append in process, 2: compress in process, 3: replace in process.
- - The top three bits of the last byte in the extra field are reserved and
- are currently set to zero.
-
- Main procedure:
- - Exclusively create the foo.lock file using the O_CREAT and O_EXCL modes of
- the system open() call. If the modify time of an existing lock file is
- more than PATIENCE seconds old, then the lock file is deleted and the
- exclusive create is retried.
- - Load the extra field from the foo.gz file, and see if an operation was in
- progress but not completed. If so, apply the recovery procedure below.
- - Perform the append procedure with the provided data.
- - If the uncompressed data in the foo.gz file is 1MB or more, apply the
- compress procedure.
- - Delete the foo.lock file.
-
- Append procedure:
- - Put what to append in the foo.add file so that the operation can be
- restarted if this procedure is interrupted.
- - Mark the foo.gz extra field with the append operation in progress.
- + Restore the original last-block bit and stored block length of the last
- stored block from the information in the extra field, in case a previous
- append operation was interrupted.
- - Append the provided data to the last stored block, creating new stored
- blocks as needed and updating the stored blocks last-block bits and
- lengths.
- - Update the crc and length with the new data, and write the gzip trailer.
- - Write over the extra field (with a single write operation) with the new
- pointers, lengths, and crc's, and mark the gzip file as not in process.
- Though there is still a foo.add file, it will be ignored since nothing
- is in process. If a foo.add file is leftover from a previously
- completed operation, it is truncated when writing new data to it.
- - Delete the foo.add file.
-
- Compress and replace procedures:
- - Read all of the uncompressed data in the stored blocks in foo.gz and write
- it to foo.add. Also write foo.temp with the last 32K of that data to
- provide a dictionary for the next invocation of this procedure.
- - Rewrite the extra field marking foo.gz with a compression in process.
- * If there is no data provided to compress (due to a missing foo.add file
- when recovering), reconstruct and truncate the foo.gz file to contain
- only the previous compressed data and proceed to the step after the next
- one. Otherwise ...
- - Compress the data with the dictionary in foo.dict, and write to the
- foo.gz file starting at the bit immediately following the last previously
- compressed block. If there is no foo.dict, proceed anyway with the
- compression at slightly reduced efficiency. (For the foo.dict file to be
- missing requires some external failure beyond simply the interruption of
- a compress operation.) During this process, the foo.lock file is
- periodically touched to assure that that file is not considered stale by
- another process before we're done. The deflation is terminated with a
- non-last empty static block (10 bits long), that is then located and
- written over by a last-bit-set empty stored block.
- - Append the crc and length of the data in the gzip file (previously
- calculated during the append operations).
- - Write over the extra field with the updated stored block offsets, bits
- back, crc's, and lengths, and mark foo.gz as in process for a replacement
- of the dictionary.
- @ Delete the foo.add file.
- - Replace foo.dict with foo.temp.
- - Write over the extra field, marking foo.gz as complete.
-
- Recovery procedure:
- - If not a replace recovery, read in the foo.add file, and provide that data
- to the appropriate recovery below. If there is no foo.add file, provide
- a zero data length to the recovery. In that case, the append recovery
- restores the foo.gz to the previous compressed + uncompressed data state.
- For the the compress recovery, a missing foo.add file results in foo.gz
- being restored to the previous compressed-only data state.
- - Append recovery:
- - Pick up append at + step above
- - Compress recovery:
- - Pick up compress at * step above
- - Replace recovery:
- - Pick up compress at @ step above
- - Log the repair with a date stamp in foo.repairs
- */
-
-#include <sys/types.h>
-#include <stdio.h> /* rename, fopen, fprintf, fclose */
-#include <stdlib.h> /* malloc, free */
-#include <string.h> /* strlen, strrchr, strcpy, strncpy, strcmp */
-#include <fcntl.h> /* open */
-#include <unistd.h> /* lseek, read, write, close, unlink, sleep, */
- /* ftruncate, fsync */
-#include <errno.h> /* errno */
-#include <time.h> /* time, ctime */
-#include <sys/stat.h> /* stat */
-#include <sys/time.h> /* utimes */
-#include "zlib.h" /* crc32 */
-
-#include "gzlog.h" /* header for external access */
-
-#define local static
-typedef unsigned int uint;
-typedef unsigned long ulong;
-
-/* Macro for debugging to deterministically force recovery operations */
-#ifdef DEBUG
- #include <setjmp.h> /* longjmp */
- jmp_buf gzlog_jump; /* where to go back to */
- int gzlog_bail = 0; /* which point to bail at (1..8) */
- int gzlog_count = -1; /* number of times through to wait */
-# define BAIL(n) do { if (n == gzlog_bail && gzlog_count-- == 0) \
- longjmp(gzlog_jump, gzlog_bail); } while (0)
-#else
-# define BAIL(n)
-#endif
-
-/* how old the lock file can be in seconds before considering it stale */
-#define PATIENCE 300
-
-/* maximum stored block size in Kbytes -- must be in 1..63 */
-#define MAX_STORE 16
-
-/* number of stored Kbytes to trigger compression (must be >= 32 to allow
- dictionary construction, and <= 204 * MAX_STORE, in order for >> 10 to
- discard the stored block headers contribution of five bytes each) */
-#define TRIGGER 1024
-
-/* size of a deflate dictionary (this cannot be changed) */
-#define DICT 32768U
-
-/* values for the operation (2 bits) */
-#define NO_OP 0
-#define APPEND_OP 1
-#define COMPRESS_OP 2
-#define REPLACE_OP 3
-
-/* macros to extract little-endian integers from an unsigned byte buffer */
-#define PULL2(p) ((p)[0]+((uint)((p)[1])<<8))
-#define PULL4(p) (PULL2(p)+((ulong)PULL2(p+2)<<16))
-#define PULL8(p) (PULL4(p)+((off_t)PULL4(p+4)<<32))
-
-/* macros to store integers into a byte buffer in little-endian order */
-#define PUT2(p,a) do {(p)[0]=a;(p)[1]=(a)>>8;} while(0)
-#define PUT4(p,a) do {PUT2(p,a);PUT2(p+2,a>>16);} while(0)
-#define PUT8(p,a) do {PUT4(p,a);PUT4(p+4,a>>32);} while(0)
-
-/* internal structure for log information */
-#define LOGID "\106\035\172" /* should be three non-zero characters */
-struct log {
- char id[4]; /* contains LOGID to detect inadvertent overwrites */
- int fd; /* file descriptor for .gz file, opened read/write */
- char *path; /* allocated path, e.g. "/var/log/foo" or "foo" */
- char *end; /* end of path, for appending suffices such as ".gz" */
- off_t first; /* offset of first stored block first length byte */
- int back; /* location of first block id in bits back from first */
- uint stored; /* bytes currently in last stored block */
- off_t last; /* offset of last stored block first length byte */
- ulong ccrc; /* crc of compressed data */
- ulong clen; /* length (modulo 2^32) of compressed data */
- ulong tcrc; /* crc of total data */
- ulong tlen; /* length (modulo 2^32) of total data */
- time_t lock; /* last modify time of our lock file */
-};
-
-/* gzip header for gzlog */
-local unsigned char log_gzhead[] = {
- 0x1f, 0x8b, /* magic gzip id */
- 8, /* compression method is deflate */
- 4, /* there is an extra field (no file name) */
- 0, 0, 0, 0, /* no modification time provided */
- 0, 0xff, /* no extra flags, no OS specified */
- 39, 0, 'a', 'p', 35, 0 /* extra field with "ap" subfield */
- /* 35 is EXTRA, 39 is EXTRA + 4 */
-};
-
-#define HEAD sizeof(log_gzhead) /* should be 16 */
-
-/* initial gzip extra field content (52 == HEAD + EXTRA + 1) */
-local unsigned char log_gzext[] = {
- 52, 0, 0, 0, 0, 0, 0, 0, /* offset of first stored block length */
- 52, 0, 0, 0, 0, 0, 0, 0, /* offset of last stored block length */
- 0, 0, 0, 0, 0, 0, 0, 0, /* compressed data crc and length */
- 0, 0, 0, 0, 0, 0, 0, 0, /* total data crc and length */
- 0, 0, /* final stored block data length */
- 5 /* op is NO_OP, last bit 8 bits back */
-};
-
-#define EXTRA sizeof(log_gzext) /* should be 35 */
-
-/* initial gzip data and trailer */
-local unsigned char log_gzbody[] = {
- 1, 0, 0, 0xff, 0xff, /* empty stored block (last) */
- 0, 0, 0, 0, /* crc */
- 0, 0, 0, 0 /* uncompressed length */
-};
-
-#define BODY sizeof(log_gzbody)
-
-/* Exclusively create foo.lock in order to negotiate exclusive access to the
- foo.* files. If the modify time of an existing lock file is greater than
- PATIENCE seconds in the past, then consider the lock file to have been
- abandoned, delete it, and try the exclusive create again. Save the lock
- file modify time for verification of ownership. Return 0 on success, or -1
- on failure, usually due to an access restriction or invalid path. Note that
- if stat() or unlink() fails, it may be due to another process noticing the
- abandoned lock file a smidge sooner and deleting it, so those are not
- flagged as an error. */
-local int log_lock(struct log *log)
-{
- int fd;
- struct stat st;
-
- strcpy(log->end, ".lock");
- while ((fd = open(log->path, O_CREAT | O_EXCL, 0644)) < 0) {
- if (errno != EEXIST)
- return -1;
- if (stat(log->path, &st) == 0 && time(NULL) - st.st_mtime > PATIENCE) {
- unlink(log->path);
- continue;
- }
- sleep(2); /* relinquish the CPU for two seconds while waiting */
- }
- close(fd);
- if (stat(log->path, &st) == 0)
- log->lock = st.st_mtime;
- return 0;
-}
-
-/* Update the modify time of the lock file to now, in order to prevent another
- task from thinking that the lock is stale. Save the lock file modify time
- for verification of ownership. */
-local void log_touch(struct log *log)
-{
- struct stat st;
-
- strcpy(log->end, ".lock");
- utimes(log->path, NULL);
- if (stat(log->path, &st) == 0)
- log->lock = st.st_mtime;
-}
-
-/* Check the log file modify time against what is expected. Return true if
- this is not our lock. If it is our lock, touch it to keep it. */
-local int log_check(struct log *log)
-{
- struct stat st;
-
- strcpy(log->end, ".lock");
- if (stat(log->path, &st) || st.st_mtime != log->lock)
- return 1;
- log_touch(log);
- return 0;
-}
-
-/* Unlock a previously acquired lock, but only if it's ours. */
-local void log_unlock(struct log *log)
-{
- if (log_check(log))
- return;
- strcpy(log->end, ".lock");
- unlink(log->path);
- log->lock = 0;
-}
-
-/* Check the gzip header and read in the extra field, filling in the values in
- the log structure. Return op on success or -1 if the gzip header was not as
- expected. op is the current operation in progress last written to the extra
- field. This assumes that the gzip file has already been opened, with the
- file descriptor log->fd. */
-local int log_head(struct log *log)
-{
- int op;
- unsigned char buf[HEAD + EXTRA];
-
- if (lseek(log->fd, 0, SEEK_SET) < 0 ||
- read(log->fd, buf, HEAD + EXTRA) != HEAD + EXTRA ||
- memcmp(buf, log_gzhead, HEAD)) {
- return -1;
- }
- log->first = PULL8(buf + HEAD);
- log->last = PULL8(buf + HEAD + 8);
- log->ccrc = PULL4(buf + HEAD + 16);
- log->clen = PULL4(buf + HEAD + 20);
- log->tcrc = PULL4(buf + HEAD + 24);
- log->tlen = PULL4(buf + HEAD + 28);
- log->stored = PULL2(buf + HEAD + 32);
- log->back = 3 + (buf[HEAD + 34] & 7);
- op = (buf[HEAD + 34] >> 3) & 3;
- return op;
-}
-
-/* Write over the extra field contents, marking the operation as op. Use fsync
- to assure that the device is written to, and in the requested order. This
- operation, and only this operation, is assumed to be atomic in order to
- assure that the log is recoverable in the event of an interruption at any
- point in the process. Return -1 if the write to foo.gz failed. */
-local int log_mark(struct log *log, int op)
-{
- int ret;
- unsigned char ext[EXTRA];
-
- PUT8(ext, log->first);
- PUT8(ext + 8, log->last);
- PUT4(ext + 16, log->ccrc);
- PUT4(ext + 20, log->clen);
- PUT4(ext + 24, log->tcrc);
- PUT4(ext + 28, log->tlen);
- PUT2(ext + 32, log->stored);
- ext[34] = log->back - 3 + (op << 3);
- fsync(log->fd);
- ret = lseek(log->fd, HEAD, SEEK_SET) < 0 ||
- write(log->fd, ext, EXTRA) != EXTRA ? -1 : 0;
- fsync(log->fd);
- return ret;
-}
-
-/* Rewrite the last block header bits and subsequent zero bits to get to a byte
- boundary, setting the last block bit if last is true, and then write the
- remainder of the stored block header (length and one's complement). Leave
- the file pointer after the end of the last stored block data. Return -1 if
- there is a read or write failure on the foo.gz file */
-local int log_last(struct log *log, int last)
-{
- int back, len, mask;
- unsigned char buf[6];
-
- /* determine the locations of the bytes and bits to modify */
- back = log->last == log->first ? log->back : 8;
- len = back > 8 ? 2 : 1; /* bytes back from log->last */
- mask = 0x80 >> ((back - 1) & 7); /* mask for block last-bit */
-
- /* get the byte to modify (one or two back) into buf[0] -- don't need to
- read the byte if the last-bit is eight bits back, since in that case
- the entire byte will be modified */
- buf[0] = 0;
- if (back != 8 && (lseek(log->fd, log->last - len, SEEK_SET) < 0 ||
- read(log->fd, buf, 1) != 1))
- return -1;
-
- /* change the last-bit of the last stored block as requested -- note
- that all bits above the last-bit are set to zero, per the type bits
- of a stored block being 00 and per the convention that the bits to
- bring the stream to a byte boundary are also zeros */
- buf[1] = 0;
- buf[2 - len] = (*buf & (mask - 1)) + (last ? mask : 0);
-
- /* write the modified stored block header and lengths, move the file
- pointer to after the last stored block data */
- PUT2(buf + 2, log->stored);
- PUT2(buf + 4, log->stored ^ 0xffff);
- return lseek(log->fd, log->last - len, SEEK_SET) < 0 ||
- write(log->fd, buf + 2 - len, len + 4) != len + 4 ||
- lseek(log->fd, log->stored, SEEK_CUR) < 0 ? -1 : 0;
-}
-
-/* Append len bytes from data to the locked and open log file. len may be zero
- if recovering and no .add file was found. In that case, the previous state
- of the foo.gz file is restored. The data is appended uncompressed in
- deflate stored blocks. Return -1 if there was an error reading or writing
- the foo.gz file. */
-local int log_append(struct log *log, unsigned char *data, size_t len)
-{
- uint put;
- off_t end;
- unsigned char buf[8];
-
- /* set the last block last-bit and length, in case recovering an
- interrupted append, then position the file pointer to append to the
- block */
- if (log_last(log, 1))
- return -1;
-
- /* append, adding stored blocks and updating the offset of the last stored
- block as needed, and update the total crc and length */
- while (len) {
- /* append as much as we can to the last block */
- put = (MAX_STORE << 10) - log->stored;
- if (put > len)
- put = (uint)len;
- if (put) {
- if (write(log->fd, data, put) != put)
- return -1;
- BAIL(1);
- log->tcrc = crc32(log->tcrc, data, put);
- log->tlen += put;
- log->stored += put;
- data += put;
- len -= put;
- }
-
- /* if we need to, add a new empty stored block */
- if (len) {
- /* mark current block as not last */
- if (log_last(log, 0))
- return -1;
-
- /* point to new, empty stored block */
- log->last += 4 + log->stored + 1;
- log->stored = 0;
- }
-
- /* mark last block as last, update its length */
- if (log_last(log, 1))
- return -1;
- BAIL(2);
- }
-
- /* write the new crc and length trailer, and truncate just in case (could
- be recovering from partial append with a missing foo.add file) */
- PUT4(buf, log->tcrc);
- PUT4(buf + 4, log->tlen);
- if (write(log->fd, buf, 8) != 8 ||
- (end = lseek(log->fd, 0, SEEK_CUR)) < 0 || ftruncate(log->fd, end))
- return -1;
-
- /* write the extra field, marking the log file as done, delete .add file */
- if (log_mark(log, NO_OP))
- return -1;
- strcpy(log->end, ".add");
- unlink(log->path); /* ignore error, since may not exist */
- return 0;
-}
-
-/* Replace the foo.dict file with the foo.temp file. Also delete the foo.add
- file, since the compress operation may have been interrupted before that was
- done. Returns 1 if memory could not be allocated, or -1 if reading or
- writing foo.gz fails, or if the rename fails for some reason other than
- foo.temp not existing. foo.temp not existing is a permitted error, since
- the replace operation may have been interrupted after the rename is done,
- but before foo.gz is marked as complete. */
-local int log_replace(struct log *log)
-{
- int ret;
- char *dest;
-
- /* delete foo.add file */
- strcpy(log->end, ".add");
- unlink(log->path); /* ignore error, since may not exist */
- BAIL(3);
-
- /* rename foo.name to foo.dict, replacing foo.dict if it exists */
- strcpy(log->end, ".dict");
- dest = malloc(strlen(log->path) + 1);
- if (dest == NULL)
- return -2;
- strcpy(dest, log->path);
- strcpy(log->end, ".temp");
- ret = rename(log->path, dest);
- free(dest);
- if (ret && errno != ENOENT)
- return -1;
- BAIL(4);
-
- /* mark the foo.gz file as done */
- return log_mark(log, NO_OP);
-}
-
-/* Compress the len bytes at data and append the compressed data to the
- foo.gz deflate data immediately after the previous compressed data. This
- overwrites the previous uncompressed data, which was stored in foo.add
- and is the data provided in data[0..len-1]. If this operation is
- interrupted, it picks up at the start of this routine, with the foo.add
- file read in again. If there is no data to compress (len == 0), then we
- simply terminate the foo.gz file after the previously compressed data,
- appending a final empty stored block and the gzip trailer. Return -1 if
- reading or writing the log.gz file failed, or -2 if there was a memory
- allocation failure. */
-local int log_compress(struct log *log, unsigned char *data, size_t len)
-{
- int fd;
- uint got, max;
- ssize_t dict;
- off_t end;
- z_stream strm;
- unsigned char buf[DICT];
-
- /* compress and append compressed data */
- if (len) {
- /* set up for deflate, allocating memory */
- strm.zalloc = Z_NULL;
- strm.zfree = Z_NULL;
- strm.opaque = Z_NULL;
- if (deflateInit2(&strm, Z_DEFAULT_COMPRESSION, Z_DEFLATED, -15, 8,
- Z_DEFAULT_STRATEGY) != Z_OK)
- return -2;
-
- /* read in dictionary (last 32K of data that was compressed) */
- strcpy(log->end, ".dict");
- fd = open(log->path, O_RDONLY, 0);
- if (fd >= 0) {
- dict = read(fd, buf, DICT);
- close(fd);
- if (dict < 0) {
- deflateEnd(&strm);
- return -1;
- }
- if (dict)
- deflateSetDictionary(&strm, buf, (uint)dict);
- }
- log_touch(log);
-
- /* prime deflate with last bits of previous block, position write
- pointer to write those bits and overwrite what follows */
- if (lseek(log->fd, log->first - (log->back > 8 ? 2 : 1),
- SEEK_SET) < 0 ||
- read(log->fd, buf, 1) != 1 || lseek(log->fd, -1, SEEK_CUR) < 0) {
- deflateEnd(&strm);
- return -1;
- }
- deflatePrime(&strm, (8 - log->back) & 7, *buf);
-
- /* compress, finishing with a partial non-last empty static block */
- strm.next_in = data;
- max = (((uint)0 - 1) >> 1) + 1; /* in case int smaller than size_t */
- do {
- strm.avail_in = len > max ? max : (uint)len;
- len -= strm.avail_in;
- do {
- strm.avail_out = DICT;
- strm.next_out = buf;
- deflate(&strm, len ? Z_NO_FLUSH : Z_PARTIAL_FLUSH);
- got = DICT - strm.avail_out;
- if (got && write(log->fd, buf, got) != got) {
- deflateEnd(&strm);
- return -1;
- }
- log_touch(log);
- } while (strm.avail_out == 0);
- } while (len);
- deflateEnd(&strm);
- BAIL(5);
-
- /* find start of empty static block -- scanning backwards the first one
- bit is the second bit of the block, if the last byte is zero, then
- we know the byte before that has a one in the top bit, since an
- empty static block is ten bits long */
- if ((log->first = lseek(log->fd, -1, SEEK_CUR)) < 0 ||
- read(log->fd, buf, 1) != 1)
- return -1;
- log->first++;
- if (*buf) {
- log->back = 1;
- while ((*buf & ((uint)1 << (8 - log->back++))) == 0)
- ; /* guaranteed to terminate, since *buf != 0 */
- }
- else
- log->back = 10;
-
- /* update compressed crc and length */
- log->ccrc = log->tcrc;
- log->clen = log->tlen;
- }
- else {
- /* no data to compress -- fix up existing gzip stream */
- log->tcrc = log->ccrc;
- log->tlen = log->clen;
- }
-
- /* complete and truncate gzip stream */
- log->last = log->first;
- log->stored = 0;
- PUT4(buf, log->tcrc);
- PUT4(buf + 4, log->tlen);
- if (log_last(log, 1) || write(log->fd, buf, 8) != 8 ||
- (end = lseek(log->fd, 0, SEEK_CUR)) < 0 || ftruncate(log->fd, end))
- return -1;
- BAIL(6);
-
- /* mark as being in the replace operation */
- if (log_mark(log, REPLACE_OP))
- return -1;
-
- /* execute the replace operation and mark the file as done */
- return log_replace(log);
-}
-
-/* log a repair record to the .repairs file */
-local void log_log(struct log *log, int op, char *record)
-{
- time_t now;
- FILE *rec;
-
- now = time(NULL);
- strcpy(log->end, ".repairs");
- rec = fopen(log->path, "a");
- if (rec == NULL)
- return;
- fprintf(rec, "%.24s %s recovery: %s\n", ctime(&now), op == APPEND_OP ?
- "append" : (op == COMPRESS_OP ? "compress" : "replace"), record);
- fclose(rec);
- return;
-}
-
-/* Recover the interrupted operation op. First read foo.add for recovering an
- append or compress operation. Return -1 if there was an error reading or
- writing foo.gz or reading an existing foo.add, or -2 if there was a memory
- allocation failure. */
-local int log_recover(struct log *log, int op)
-{
- int fd, ret = 0;
- unsigned char *data = NULL;
- size_t len = 0;
- struct stat st;
-
- /* log recovery */
- log_log(log, op, "start");
-
- /* load foo.add file if expected and present */
- if (op == APPEND_OP || op == COMPRESS_OP) {
- strcpy(log->end, ".add");
- if (stat(log->path, &st) == 0 && st.st_size) {
- len = (size_t)(st.st_size);
- if ((off_t)len != st.st_size ||
- (data = malloc(st.st_size)) == NULL) {
- log_log(log, op, "allocation failure");
- return -2;
- }
- if ((fd = open(log->path, O_RDONLY, 0)) < 0) {
- log_log(log, op, ".add file read failure");
- return -1;
- }
- ret = (size_t)read(fd, data, len) != len;
- close(fd);
- if (ret) {
- log_log(log, op, ".add file read failure");
- return -1;
- }
- log_log(log, op, "loaded .add file");
- }
- else
- log_log(log, op, "missing .add file!");
- }
-
- /* recover the interrupted operation */
- switch (op) {
- case APPEND_OP:
- ret = log_append(log, data, len);
- break;
- case COMPRESS_OP:
- ret = log_compress(log, data, len);
- break;
- case REPLACE_OP:
- ret = log_replace(log);
- }
-
- /* log status */
- log_log(log, op, ret ? "failure" : "complete");
-
- /* clean up */
- if (data != NULL)
- free(data);
- return ret;
-}
-
-/* Close the foo.gz file (if open) and release the lock. */
-local void log_close(struct log *log)
-{
- if (log->fd >= 0)
- close(log->fd);
- log->fd = -1;
- log_unlock(log);
-}
-
-/* Open foo.gz, verify the header, and load the extra field contents, after
- first creating the foo.lock file to gain exclusive access to the foo.*
- files. If foo.gz does not exist or is empty, then write the initial header,
- extra, and body content of an empty foo.gz log file. If there is an error
- creating the lock file due to access restrictions, or an error reading or
- writing the foo.gz file, or if the foo.gz file is not a proper log file for
- this object (e.g. not a gzip file or does not contain the expected extra
- field), then return true. If there is an error, the lock is released.
- Otherwise, the lock is left in place. */
-local int log_open(struct log *log)
-{
- int op;
-
- /* release open file resource if left over -- can occur if lock lost
- between gzlog_open() and gzlog_write() */
- if (log->fd >= 0)
- close(log->fd);
- log->fd = -1;
-
- /* negotiate exclusive access */
- if (log_lock(log) < 0)
- return -1;
-
- /* open the log file, foo.gz */
- strcpy(log->end, ".gz");
- log->fd = open(log->path, O_RDWR | O_CREAT, 0644);
- if (log->fd < 0) {
- log_close(log);
- return -1;
- }
-
- /* if new, initialize foo.gz with an empty log, delete old dictionary */
- if (lseek(log->fd, 0, SEEK_END) == 0) {
- if (write(log->fd, log_gzhead, HEAD) != HEAD ||
- write(log->fd, log_gzext, EXTRA) != EXTRA ||
- write(log->fd, log_gzbody, BODY) != BODY) {
- log_close(log);
- return -1;
- }
- strcpy(log->end, ".dict");
- unlink(log->path);
- }
-
- /* verify log file and load extra field information */
- if ((op = log_head(log)) < 0) {
- log_close(log);
- return -1;
- }
-
- /* check for interrupted process and if so, recover */
- if (op != NO_OP && log_recover(log, op)) {
- log_close(log);
- return -1;
- }
-
- /* touch the lock file to prevent another process from grabbing it */
- log_touch(log);
- return 0;
-}
-
-/* See gzlog.h for the description of the external methods below */
-gzlog *gzlog_open(char *path)
-{
- size_t n;
- struct log *log;
-
- /* check arguments */
- if (path == NULL || *path == 0)
- return NULL;
-
- /* allocate and initialize log structure */
- log = malloc(sizeof(struct log));
- if (log == NULL)
- return NULL;
- strcpy(log->id, LOGID);
- log->fd = -1;
-
- /* save path and end of path for name construction */
- n = strlen(path);
- log->path = malloc(n + 9); /* allow for ".repairs" */
- if (log->path == NULL) {
- free(log);
- return NULL;
- }
- strcpy(log->path, path);
- log->end = log->path + n;
-
- /* gain exclusive access and verify log file -- may perform a
- recovery operation if needed */
- if (log_open(log)) {
- free(log->path);
- free(log);
- return NULL;
- }
-
- /* return pointer to log structure */
- return log;
-}
-
-/* gzlog_compress() return values:
- 0: all good
- -1: file i/o error (usually access issue)
- -2: memory allocation failure
- -3: invalid log pointer argument */
-int gzlog_compress(gzlog *logd)
-{
- int fd, ret;
- uint block;
- size_t len, next;
- unsigned char *data, buf[5];
- struct log *log = logd;
-
- /* check arguments */
- if (log == NULL || strcmp(log->id, LOGID))
- return -3;
-
- /* see if we lost the lock -- if so get it again and reload the extra
- field information (it probably changed), recover last operation if
- necessary */
- if (log_check(log) && log_open(log))
- return -1;
-
- /* create space for uncompressed data */
- len = ((size_t)(log->last - log->first) & ~(((size_t)1 << 10) - 1)) +
- log->stored;
- if ((data = malloc(len)) == NULL)
- return -2;
-
- /* do statement here is just a cheap trick for error handling */
- do {
- /* read in the uncompressed data */
- if (lseek(log->fd, log->first - 1, SEEK_SET) < 0)
- break;
- next = 0;
- while (next < len) {
- if (read(log->fd, buf, 5) != 5)
- break;
- block = PULL2(buf + 1);
- if (next + block > len ||
- read(log->fd, (char *)data + next, block) != block)
- break;
- next += block;
- }
- if (lseek(log->fd, 0, SEEK_CUR) != log->last + 4 + log->stored)
- break;
- log_touch(log);
-
- /* write the uncompressed data to the .add file */
- strcpy(log->end, ".add");
- fd = open(log->path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
- if (fd < 0)
- break;
- ret = (size_t)write(fd, data, len) != len;
- if (ret | close(fd))
- break;
- log_touch(log);
-
- /* write the dictionary for the next compress to the .temp file */
- strcpy(log->end, ".temp");
- fd = open(log->path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
- if (fd < 0)
- break;
- next = DICT > len ? len : DICT;
- ret = (size_t)write(fd, (char *)data + len - next, next) != next;
- if (ret | close(fd))
- break;
- log_touch(log);
-
- /* roll back to compressed data, mark the compress in progress */
- log->last = log->first;
- log->stored = 0;
- if (log_mark(log, COMPRESS_OP))
- break;
- BAIL(7);
-
- /* compress and append the data (clears mark) */
- ret = log_compress(log, data, len);
- free(data);
- return ret;
- } while (0);
-
- /* broke out of do above on i/o error */
- free(data);
- return -1;
-}
-
-/* gzlog_write() return values:
- 0: all good
- -1: file i/o error (usually access issue)
- -2: memory allocation failure
- -3: invalid log pointer argument */
-int gzlog_write(gzlog *logd, void *data, size_t len)
-{
- int fd, ret;
- struct log *log = logd;
-
- /* check arguments */
- if (log == NULL || strcmp(log->id, LOGID))
- return -3;
- if (data == NULL || len <= 0)
- return 0;
-
- /* see if we lost the lock -- if so get it again and reload the extra
- field information (it probably changed), recover last operation if
- necessary */
- if (log_check(log) && log_open(log))
- return -1;
-
- /* create and write .add file */
- strcpy(log->end, ".add");
- fd = open(log->path, O_WRONLY | O_CREAT | O_TRUNC, 0644);
- if (fd < 0)
- return -1;
- ret = (size_t)write(fd, data, len) != len;
- if (ret | close(fd))
- return -1;
- log_touch(log);
-
- /* mark log file with append in progress */
- if (log_mark(log, APPEND_OP))
- return -1;
- BAIL(8);
-
- /* append data (clears mark) */
- if (log_append(log, data, len))
- return -1;
-
- /* check to see if it's time to compress -- if not, then done */
- if (((log->last - log->first) >> 10) + (log->stored >> 10) < TRIGGER)
- return 0;
-
- /* time to compress */
- return gzlog_compress(log);
-}
-
-/* gzlog_close() return values:
- 0: ok
- -3: invalid log pointer argument */
-int gzlog_close(gzlog *logd)
-{
- struct log *log = logd;
-
- /* check arguments */
- if (log == NULL || strcmp(log->id, LOGID))
- return -3;
-
- /* close the log file and release the lock */
- log_close(log);
-
- /* free structure and return */
- if (log->path != NULL)
- free(log->path);
- strcpy(log->id, "bad");
- free(log);
- return 0;
-}
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/1a48f7c3/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.h
----------------------------------------------------------------------
diff --git a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.h b/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.h
deleted file mode 100644
index 86f0cec..0000000
--- a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/gzlog.h
+++ /dev/null
@@ -1,91 +0,0 @@
-/* gzlog.h
- Copyright (C) 2004, 2008, 2012 Mark Adler, all rights reserved
- version 2.2, 14 Aug 2012
-
- This software is provided 'as-is', without any express or implied
- warranty. In no event will the author be held liable for any damages
- arising from the use of this software.
-
- Permission is granted to anyone to use this software for any purpose,
- including commercial applications, and to alter it and redistribute it
- freely, subject to the following restrictions:
-
- 1. The origin of this software must not be misrepresented; you must not
- claim that you wrote the original software. If you use this software
- in a product, an acknowledgment in the product documentation would be
- appreciated but is not required.
- 2. Altered source versions must be plainly marked as such, and must not be
- misrepresented as being the original software.
- 3. This notice may not be removed or altered from any source distribution.
-
- Mark Adler madler@alumni.caltech.edu
- */
-
-/* Version History:
- 1.0 26 Nov 2004 First version
- 2.0 25 Apr 2008 Complete redesign for recovery of interrupted operations
- Interface changed slightly in that now path is a prefix
- Compression now occurs as needed during gzlog_write()
- gzlog_write() now always leaves the log file as valid gzip
- 2.1 8 Jul 2012 Fix argument checks in gzlog_compress() and gzlog_write()
- 2.2 14 Aug 2012 Clean up signed comparisons
- */
-
-/*
- The gzlog object allows writing short messages to a gzipped log file,
- opening the log file locked for small bursts, and then closing it. The log
- object works by appending stored (uncompressed) data to the gzip file until
- 1 MB has been accumulated. At that time, the stored data is compressed, and
- replaces the uncompressed data in the file. The log file is truncated to
- its new size at that time. After each write operation, the log file is a
- valid gzip file that can decompressed to recover what was written.
-
- The gzlog operations can be interupted at any point due to an application or
- system crash, and the log file will be recovered the next time the log is
- opened with gzlog_open().
- */
-
-#ifndef GZLOG_H
-#define GZLOG_H
-
-/* gzlog object type */
-typedef void gzlog;
-
-/* Open a gzlog object, creating the log file if it does not exist. Return
- NULL on error. Note that gzlog_open() could take a while to complete if it
- has to wait to verify that a lock is stale (possibly for five minutes), or
- if there is significant contention with other instantiations of this object
- when locking the resource. path is the prefix of the file names created by
- this object. If path is "foo", then the log file will be "foo.gz", and
- other auxiliary files will be created and destroyed during the process:
- "foo.dict" for a compression dictionary, "foo.temp" for a temporary (next)
- dictionary, "foo.add" for data being added or compressed, "foo.lock" for the
- lock file, and "foo.repairs" to log recovery operations performed due to
- interrupted gzlog operations. A gzlog_open() followed by a gzlog_close()
- will recover a previously interrupted operation, if any. */
-gzlog *gzlog_open(char *path);
-
-/* Write to a gzlog object. Return zero on success, -1 if there is a file i/o
- error on any of the gzlog files (this should not happen if gzlog_open()
- succeeded, unless the device has run out of space or leftover auxiliary
- files have permissions or ownership that prevent their use), -2 if there is
- a memory allocation failure, or -3 if the log argument is invalid (e.g. if
- it was not created by gzlog_open()). This function will write data to the
- file uncompressed, until 1 MB has been accumulated, at which time that data
- will be compressed. The log file will be a valid gzip file upon successful
- return. */
-int gzlog_write(gzlog *log, void *data, size_t len);
-
-/* Force compression of any uncompressed data in the log. This should be used
- sparingly, if at all. The main application would be when a log file will
- not be appended to again. If this is used to compress frequently while
- appending, it will both significantly increase the execution time and
- reduce the compression ratio. The return codes are the same as for
- gzlog_write(). */
-int gzlog_compress(gzlog *log);
-
-/* Close a gzlog object. Return zero on success, -3 if the log argument is
- invalid. The log object is freed, and so cannot be referenced again. */
-int gzlog_close(gzlog *log);
-
-#endif
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/1a48f7c3/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zlib_how.html
----------------------------------------------------------------------
diff --git a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zlib_how.html b/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zlib_how.html
deleted file mode 100644
index 444ff1c..0000000
--- a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zlib_how.html
+++ /dev/null
@@ -1,545 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
- "http://www.w3.org/TR/REC-html40/loose.dtd">
-<html>
-<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
-<title>zlib Usage Example</title>
-<!-- Copyright (c) 2004, 2005 Mark Adler. -->
-</head>
-<body bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#00A000">
-<h2 align="center"> zlib Usage Example </h2>
-We often get questions about how the <tt>deflate()</tt> and <tt>inflate()</tt> functions should be used.
-Users wonder when they should provide more input, when they should use more output,
-what to do with a <tt>Z_BUF_ERROR</tt>, how to make sure the process terminates properly, and
-so on. So for those who have read <tt>zlib.h</tt> (a few times), and
-would like further edification, below is an annotated example in C of simple routines to compress and decompress
-from an input file to an output file using <tt>deflate()</tt> and <tt>inflate()</tt> respectively. The
-annotations are interspersed between lines of the code. So please read between the lines.
-We hope this helps explain some of the intricacies of <em>zlib</em>.
-<p>
-Without further adieu, here is the program <a href="zpipe.c"><tt>zpipe.c</tt></a>:
-<pre><b>
-/* zpipe.c: example of proper use of zlib's inflate() and deflate()
- Not copyrighted -- provided to the public domain
- Version 1.4 11 December 2005 Mark Adler */
-
-/* Version history:
- 1.0 30 Oct 2004 First version
- 1.1 8 Nov 2004 Add void casting for unused return values
- Use switch statement for inflate() return values
- 1.2 9 Nov 2004 Add assertions to document zlib guarantees
- 1.3 6 Apr 2005 Remove incorrect assertion in inf()
- 1.4 11 Dec 2005 Add hack to avoid MSDOS end-of-line conversions
- Avoid some compiler warnings for input and output buffers
- */
-</b></pre><!-- -->
-We now include the header files for the required definitions. From
-<tt>stdio.h</tt> we use <tt>fopen()</tt>, <tt>fread()</tt>, <tt>fwrite()</tt>,
-<tt>feof()</tt>, <tt>ferror()</tt>, and <tt>fclose()</tt> for file i/o, and
-<tt>fputs()</tt> for error messages. From <tt>string.h</tt> we use
-<tt>strcmp()</tt> for command line argument processing.
-From <tt>assert.h</tt> we use the <tt>assert()</tt> macro.
-From <tt>zlib.h</tt>
-we use the basic compression functions <tt>deflateInit()</tt>,
-<tt>deflate()</tt>, and <tt>deflateEnd()</tt>, and the basic decompression
-functions <tt>inflateInit()</tt>, <tt>inflate()</tt>, and
-<tt>inflateEnd()</tt>.
-<pre><b>
-#include <stdio.h>
-#include <string.h>
-#include <assert.h>
-#include "zlib.h"
-</b></pre><!-- -->
-This is an ugly hack required to avoid corruption of the input and output data on
-Windows/MS-DOS systems. Without this, those systems would assume that the input and output
-files are text, and try to convert the end-of-line characters from one standard to
-another. That would corrupt binary data, and in particular would render the compressed data unusable.
-This sets the input and output to binary which suppresses the end-of-line conversions.
-<tt>SET_BINARY_MODE()</tt> will be used later on <tt>stdin</tt> and <tt>stdout</tt>, at the beginning of <tt>main()</tt>.
-<pre><b>
-#if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(__CYGWIN__)
-# include <fcntl.h>
-# include <io.h>
-# define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
-#else
-# define SET_BINARY_MODE(file)
-#endif
-</b></pre><!-- -->
-<tt>CHUNK</tt> is simply the buffer size for feeding data to and pulling data
-from the <em>zlib</em> routines. Larger buffer sizes would be more efficient,
-especially for <tt>inflate()</tt>. If the memory is available, buffers sizes
-on the order of 128K or 256K bytes should be used.
-<pre><b>
-#define CHUNK 16384
-</b></pre><!-- -->
-The <tt>def()</tt> routine compresses data from an input file to an output file. The output data
-will be in the <em>zlib</em> format, which is different from the <em>gzip</em> or <em>zip</em>
-formats. The <em>zlib</em> format has a very small header of only two bytes to identify it as
-a <em>zlib</em> stream and to provide decoding information, and a four-byte trailer with a fast
-check value to verify the integrity of the uncompressed data after decoding.
-<pre><b>
-/* Compress from file source to file dest until EOF on source.
- def() returns Z_OK on success, Z_MEM_ERROR if memory could not be
- allocated for processing, Z_STREAM_ERROR if an invalid compression
- level is supplied, Z_VERSION_ERROR if the version of zlib.h and the
- version of the library linked do not match, or Z_ERRNO if there is
- an error reading or writing the files. */
-int def(FILE *source, FILE *dest, int level)
-{
-</b></pre>
-Here are the local variables for <tt>def()</tt>. <tt>ret</tt> will be used for <em>zlib</em>
-return codes. <tt>flush</tt> will keep track of the current flushing state for <tt>deflate()</tt>,
-which is either no flushing, or flush to completion after the end of the input file is reached.
-<tt>have</tt> is the amount of data returned from <tt>deflate()</tt>. The <tt>strm</tt> structure
-is used to pass information to and from the <em>zlib</em> routines, and to maintain the
-<tt>deflate()</tt> state. <tt>in</tt> and <tt>out</tt> are the input and output buffers for
-<tt>deflate()</tt>.
-<pre><b>
- int ret, flush;
- unsigned have;
- z_stream strm;
- unsigned char in[CHUNK];
- unsigned char out[CHUNK];
-</b></pre><!-- -->
-The first thing we do is to initialize the <em>zlib</em> state for compression using
-<tt>deflateInit()</tt>. This must be done before the first use of <tt>deflate()</tt>.
-The <tt>zalloc</tt>, <tt>zfree</tt>, and <tt>opaque</tt> fields in the <tt>strm</tt>
-structure must be initialized before calling <tt>deflateInit()</tt>. Here they are
-set to the <em>zlib</em> constant <tt>Z_NULL</tt> to request that <em>zlib</em> use
-the default memory allocation routines. An application may also choose to provide
-custom memory allocation routines here. <tt>deflateInit()</tt> will allocate on the
-order of 256K bytes for the internal state.
-(See <a href="zlib_tech.html"><em>zlib Technical Details</em></a>.)
-<p>
-<tt>deflateInit()</tt> is called with a pointer to the structure to be initialized and
-the compression level, which is an integer in the range of -1 to 9. Lower compression
-levels result in faster execution, but less compression. Higher levels result in
-greater compression, but slower execution. The <em>zlib</em> constant Z_DEFAULT_COMPRESSION,
-equal to -1,
-provides a good compromise between compression and speed and is equivalent to level 6.
-Level 0 actually does no compression at all, and in fact expands the data slightly to produce
-the <em>zlib</em> format (it is not a byte-for-byte copy of the input).
-More advanced applications of <em>zlib</em>
-may use <tt>deflateInit2()</tt> here instead. Such an application may want to reduce how
-much memory will be used, at some price in compression. Or it may need to request a
-<em>gzip</em> header and trailer instead of a <em>zlib</em> header and trailer, or raw
-encoding with no header or trailer at all.
-<p>
-We must check the return value of <tt>deflateInit()</tt> against the <em>zlib</em> constant
-<tt>Z_OK</tt> to make sure that it was able to
-allocate memory for the internal state, and that the provided arguments were valid.
-<tt>deflateInit()</tt> will also check that the version of <em>zlib</em> that the <tt>zlib.h</tt>
-file came from matches the version of <em>zlib</em> actually linked with the program. This
-is especially important for environments in which <em>zlib</em> is a shared library.
-<p>
-Note that an application can initialize multiple, independent <em>zlib</em> streams, which can
-operate in parallel. The state information maintained in the structure allows the <em>zlib</em>
-routines to be reentrant.
-<pre><b>
- /* allocate deflate state */
- strm.zalloc = Z_NULL;
- strm.zfree = Z_NULL;
- strm.opaque = Z_NULL;
- ret = deflateInit(&strm, level);
- if (ret != Z_OK)
- return ret;
-</b></pre><!-- -->
-With the pleasantries out of the way, now we can get down to business. The outer <tt>do</tt>-loop
-reads all of the input file and exits at the bottom of the loop once end-of-file is reached.
-This loop contains the only call of <tt>deflate()</tt>. So we must make sure that all of the
-input data has been processed and that all of the output data has been generated and consumed
-before we fall out of the loop at the bottom.
-<pre><b>
- /* compress until end of file */
- do {
-</b></pre>
-We start off by reading data from the input file. The number of bytes read is put directly
-into <tt>avail_in</tt>, and a pointer to those bytes is put into <tt>next_in</tt>. We also
-check to see if end-of-file on the input has been reached. If we are at the end of file, then <tt>flush</tt> is set to the
-<em>zlib</em> constant <tt>Z_FINISH</tt>, which is later passed to <tt>deflate()</tt> to
-indicate that this is the last chunk of input data to compress. We need to use <tt>feof()</tt>
-to check for end-of-file as opposed to seeing if fewer than <tt>CHUNK</tt> bytes have been read. The
-reason is that if the input file length is an exact multiple of <tt>CHUNK</tt>, we will miss
-the fact that we got to the end-of-file, and not know to tell <tt>deflate()</tt> to finish
-up the compressed stream. If we are not yet at the end of the input, then the <em>zlib</em>
-constant <tt>Z_NO_FLUSH</tt> will be passed to <tt>deflate</tt> to indicate that we are still
-in the middle of the uncompressed data.
-<p>
-If there is an error in reading from the input file, the process is aborted with
-<tt>deflateEnd()</tt> being called to free the allocated <em>zlib</em> state before returning
-the error. We wouldn't want a memory leak, now would we? <tt>deflateEnd()</tt> can be called
-at any time after the state has been initialized. Once that's done, <tt>deflateInit()</tt> (or
-<tt>deflateInit2()</tt>) would have to be called to start a new compression process. There is
-no point here in checking the <tt>deflateEnd()</tt> return code. The deallocation can't fail.
-<pre><b>
- strm.avail_in = fread(in, 1, CHUNK, source);
- if (ferror(source)) {
- (void)deflateEnd(&strm);
- return Z_ERRNO;
- }
- flush = feof(source) ? Z_FINISH : Z_NO_FLUSH;
- strm.next_in = in;
-</b></pre><!-- -->
-The inner <tt>do</tt>-loop passes our chunk of input data to <tt>deflate()</tt>, and then
-keeps calling <tt>deflate()</tt> until it is done producing output. Once there is no more
-new output, <tt>deflate()</tt> is guaranteed to have consumed all of the input, i.e.,
-<tt>avail_in</tt> will be zero.
-<pre><b>
- /* run deflate() on input until output buffer not full, finish
- compression if all of source has been read in */
- do {
-</b></pre>
-Output space is provided to <tt>deflate()</tt> by setting <tt>avail_out</tt> to the number
-of available output bytes and <tt>next_out</tt> to a pointer to that space.
-<pre><b>
- strm.avail_out = CHUNK;
- strm.next_out = out;
-</b></pre>
-Now we call the compression engine itself, <tt>deflate()</tt>. It takes as many of the
-<tt>avail_in</tt> bytes at <tt>next_in</tt> as it can process, and writes as many as
-<tt>avail_out</tt> bytes to <tt>next_out</tt>. Those counters and pointers are then
-updated past the input data consumed and the output data written. It is the amount of
-output space available that may limit how much input is consumed.
-Hence the inner loop to make sure that
-all of the input is consumed by providing more output space each time. Since <tt>avail_in</tt>
-and <tt>next_in</tt> are updated by <tt>deflate()</tt>, we don't have to mess with those
-between <tt>deflate()</tt> calls until it's all used up.
-<p>
-The parameters to <tt>deflate()</tt> are a pointer to the <tt>strm</tt> structure containing
-the input and output information and the internal compression engine state, and a parameter
-indicating whether and how to flush data to the output. Normally <tt>deflate</tt> will consume
-several K bytes of input data before producing any output (except for the header), in order
-to accumulate statistics on the data for optimum compression. It will then put out a burst of
-compressed data, and proceed to consume more input before the next burst. Eventually,
-<tt>deflate()</tt>
-must be told to terminate the stream, complete the compression with provided input data, and
-write out the trailer check value. <tt>deflate()</tt> will continue to compress normally as long
-as the flush parameter is <tt>Z_NO_FLUSH</tt>. Once the <tt>Z_FINISH</tt> parameter is provided,
-<tt>deflate()</tt> will begin to complete the compressed output stream. However depending on how
-much output space is provided, <tt>deflate()</tt> may have to be called several times until it
-has provided the complete compressed stream, even after it has consumed all of the input. The flush
-parameter must continue to be <tt>Z_FINISH</tt> for those subsequent calls.
-<p>
-There are other values of the flush parameter that are used in more advanced applications. You can
-force <tt>deflate()</tt> to produce a burst of output that encodes all of the input data provided
-so far, even if it wouldn't have otherwise, for example to control data latency on a link with
-compressed data. You can also ask that <tt>deflate()</tt> do that as well as erase any history up to
-that point so that what follows can be decompressed independently, for example for random access
-applications. Both requests will degrade compression by an amount depending on how often such
-requests are made.
-<p>
-<tt>deflate()</tt> has a return value that can indicate errors, yet we do not check it here. Why
-not? Well, it turns out that <tt>deflate()</tt> can do no wrong here. Let's go through
-<tt>deflate()</tt>'s return values and dispense with them one by one. The possible values are
-<tt>Z_OK</tt>, <tt>Z_STREAM_END</tt>, <tt>Z_STREAM_ERROR</tt>, or <tt>Z_BUF_ERROR</tt>. <tt>Z_OK</tt>
-is, well, ok. <tt>Z_STREAM_END</tt> is also ok and will be returned for the last call of
-<tt>deflate()</tt>. This is already guaranteed by calling <tt>deflate()</tt> with <tt>Z_FINISH</tt>
-until it has no more output. <tt>Z_STREAM_ERROR</tt> is only possible if the stream is not
-initialized properly, but we did initialize it properly. There is no harm in checking for
-<tt>Z_STREAM_ERROR</tt> here, for example to check for the possibility that some
-other part of the application inadvertently clobbered the memory containing the <em>zlib</em> state.
-<tt>Z_BUF_ERROR</tt> will be explained further below, but
-suffice it to say that this is simply an indication that <tt>deflate()</tt> could not consume
-more input or produce more output. <tt>deflate()</tt> can be called again with more output space
-or more available input, which it will be in this code.
-<pre><b>
- ret = deflate(&strm, flush); /* no bad return value */
- assert(ret != Z_STREAM_ERROR); /* state not clobbered */
-</b></pre>
-Now we compute how much output <tt>deflate()</tt> provided on the last call, which is the
-difference between how much space was provided before the call, and how much output space
-is still available after the call. Then that data, if any, is written to the output file.
-We can then reuse the output buffer for the next call of <tt>deflate()</tt>. Again if there
-is a file i/o error, we call <tt>deflateEnd()</tt> before returning to avoid a memory leak.
-<pre><b>
- have = CHUNK - strm.avail_out;
- if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
- (void)deflateEnd(&strm);
- return Z_ERRNO;
- }
-</b></pre>
-The inner <tt>do</tt>-loop is repeated until the last <tt>deflate()</tt> call fails to fill the
-provided output buffer. Then we know that <tt>deflate()</tt> has done as much as it can with
-the provided input, and that all of that input has been consumed. We can then fall out of this
-loop and reuse the input buffer.
-<p>
-The way we tell that <tt>deflate()</tt> has no more output is by seeing that it did not fill
-the output buffer, leaving <tt>avail_out</tt> greater than zero. However suppose that
-<tt>deflate()</tt> has no more output, but just so happened to exactly fill the output buffer!
-<tt>avail_out</tt> is zero, and we can't tell that <tt>deflate()</tt> has done all it can.
-As far as we know, <tt>deflate()</tt>
-has more output for us. So we call it again. But now <tt>deflate()</tt> produces no output
-at all, and <tt>avail_out</tt> remains unchanged as <tt>CHUNK</tt>. That <tt>deflate()</tt> call
-wasn't able to do anything, either consume input or produce output, and so it returns
-<tt>Z_BUF_ERROR</tt>. (See, I told you I'd cover this later.) However this is not a problem at
-all. Now we finally have the desired indication that <tt>deflate()</tt> is really done,
-and so we drop out of the inner loop to provide more input to <tt>deflate()</tt>.
-<p>
-With <tt>flush</tt> set to <tt>Z_FINISH</tt>, this final set of <tt>deflate()</tt> calls will
-complete the output stream. Once that is done, subsequent calls of <tt>deflate()</tt> would return
-<tt>Z_STREAM_ERROR</tt> if the flush parameter is not <tt>Z_FINISH</tt>, and do no more processing
-until the state is reinitialized.
-<p>
-Some applications of <em>zlib</em> have two loops that call <tt>deflate()</tt>
-instead of the single inner loop we have here. The first loop would call
-without flushing and feed all of the data to <tt>deflate()</tt>. The second loop would call
-<tt>deflate()</tt> with no more
-data and the <tt>Z_FINISH</tt> parameter to complete the process. As you can see from this
-example, that can be avoided by simply keeping track of the current flush state.
-<pre><b>
- } while (strm.avail_out == 0);
- assert(strm.avail_in == 0); /* all input will be used */
-</b></pre><!-- -->
-Now we check to see if we have already processed all of the input file. That information was
-saved in the <tt>flush</tt> variable, so we see if that was set to <tt>Z_FINISH</tt>. If so,
-then we're done and we fall out of the outer loop. We're guaranteed to get <tt>Z_STREAM_END</tt>
-from the last <tt>deflate()</tt> call, since we ran it until the last chunk of input was
-consumed and all of the output was generated.
-<pre><b>
- /* done when last data in file processed */
- } while (flush != Z_FINISH);
- assert(ret == Z_STREAM_END); /* stream will be complete */
-</b></pre><!-- -->
-The process is complete, but we still need to deallocate the state to avoid a memory leak
-(or rather more like a memory hemorrhage if you didn't do this). Then
-finally we can return with a happy return value.
-<pre><b>
- /* clean up and return */
- (void)deflateEnd(&strm);
- return Z_OK;
-}
-</b></pre><!-- -->
-Now we do the same thing for decompression in the <tt>inf()</tt> routine. <tt>inf()</tt>
-decompresses what is hopefully a valid <em>zlib</em> stream from the input file and writes the
-uncompressed data to the output file. Much of the discussion above for <tt>def()</tt>
-applies to <tt>inf()</tt> as well, so the discussion here will focus on the differences between
-the two.
-<pre><b>
-/* Decompress from file source to file dest until stream ends or EOF.
- inf() returns Z_OK on success, Z_MEM_ERROR if memory could not be
- allocated for processing, Z_DATA_ERROR if the deflate data is
- invalid or incomplete, Z_VERSION_ERROR if the version of zlib.h and
- the version of the library linked do not match, or Z_ERRNO if there
- is an error reading or writing the files. */
-int inf(FILE *source, FILE *dest)
-{
-</b></pre>
-The local variables have the same functionality as they do for <tt>def()</tt>. The
-only difference is that there is no <tt>flush</tt> variable, since <tt>inflate()</tt>
-can tell from the <em>zlib</em> stream itself when the stream is complete.
-<pre><b>
- int ret;
- unsigned have;
- z_stream strm;
- unsigned char in[CHUNK];
- unsigned char out[CHUNK];
-</b></pre><!-- -->
-The initialization of the state is the same, except that there is no compression level,
-of course, and two more elements of the structure are initialized. <tt>avail_in</tt>
-and <tt>next_in</tt> must be initialized before calling <tt>inflateInit()</tt>. This
-is because the application has the option to provide the start of the zlib stream in
-order for <tt>inflateInit()</tt> to have access to information about the compression
-method to aid in memory allocation. In the current implementation of <em>zlib</em>
-(up through versions 1.2.x), the method-dependent memory allocations are deferred to the first call of
-<tt>inflate()</tt> anyway. However those fields must be initialized since later versions
-of <em>zlib</em> that provide more compression methods may take advantage of this interface.
-In any case, no decompression is performed by <tt>inflateInit()</tt>, so the
-<tt>avail_out</tt> and <tt>next_out</tt> fields do not need to be initialized before calling.
-<p>
-Here <tt>avail_in</tt> is set to zero and <tt>next_in</tt> is set to <tt>Z_NULL</tt> to
-indicate that no input data is being provided.
-<pre><b>
- /* allocate inflate state */
- strm.zalloc = Z_NULL;
- strm.zfree = Z_NULL;
- strm.opaque = Z_NULL;
- strm.avail_in = 0;
- strm.next_in = Z_NULL;
- ret = inflateInit(&strm);
- if (ret != Z_OK)
- return ret;
-</b></pre><!-- -->
-The outer <tt>do</tt>-loop decompresses input until <tt>inflate()</tt> indicates
-that it has reached the end of the compressed data and has produced all of the uncompressed
-output. This is in contrast to <tt>def()</tt> which processes all of the input file.
-If end-of-file is reached before the compressed data self-terminates, then the compressed
-data is incomplete and an error is returned.
-<pre><b>
- /* decompress until deflate stream ends or end of file */
- do {
-</b></pre>
-We read input data and set the <tt>strm</tt> structure accordingly. If we've reached the
-end of the input file, then we leave the outer loop and report an error, since the
-compressed data is incomplete. Note that we may read more data than is eventually consumed
-by <tt>inflate()</tt>, if the input file continues past the <em>zlib</em> stream.
-For applications where <em>zlib</em> streams are embedded in other data, this routine would
-need to be modified to return the unused data, or at least indicate how much of the input
-data was not used, so the application would know where to pick up after the <em>zlib</em> stream.
-<pre><b>
- strm.avail_in = fread(in, 1, CHUNK, source);
- if (ferror(source)) {
- (void)inflateEnd(&strm);
- return Z_ERRNO;
- }
- if (strm.avail_in == 0)
- break;
- strm.next_in = in;
-</b></pre><!-- -->
-The inner <tt>do</tt>-loop has the same function it did in <tt>def()</tt>, which is to
-keep calling <tt>inflate()</tt> until has generated all of the output it can with the
-provided input.
-<pre><b>
- /* run inflate() on input until output buffer not full */
- do {
-</b></pre>
-Just like in <tt>def()</tt>, the same output space is provided for each call of <tt>inflate()</tt>.
-<pre><b>
- strm.avail_out = CHUNK;
- strm.next_out = out;
-</b></pre>
-Now we run the decompression engine itself. There is no need to adjust the flush parameter, since
-the <em>zlib</em> format is self-terminating. The main difference here is that there are
-return values that we need to pay attention to. <tt>Z_DATA_ERROR</tt>
-indicates that <tt>inflate()</tt> detected an error in the <em>zlib</em> compressed data format,
-which means that either the data is not a <em>zlib</em> stream to begin with, or that the data was
-corrupted somewhere along the way since it was compressed. The other error to be processed is
-<tt>Z_MEM_ERROR</tt>, which can occur since memory allocation is deferred until <tt>inflate()</tt>
-needs it, unlike <tt>deflate()</tt>, whose memory is allocated at the start by <tt>deflateInit()</tt>.
-<p>
-Advanced applications may use
-<tt>deflateSetDictionary()</tt> to prime <tt>deflate()</tt> with a set of likely data to improve the
-first 32K or so of compression. This is noted in the <em>zlib</em> header, so <tt>inflate()</tt>
-requests that that dictionary be provided before it can start to decompress. Without the dictionary,
-correct decompression is not possible. For this routine, we have no idea what the dictionary is,
-so the <tt>Z_NEED_DICT</tt> indication is converted to a <tt>Z_DATA_ERROR</tt>.
-<p>
-<tt>inflate()</tt> can also return <tt>Z_STREAM_ERROR</tt>, which should not be possible here,
-but could be checked for as noted above for <tt>def()</tt>. <tt>Z_BUF_ERROR</tt> does not need to be
-checked for here, for the same reasons noted for <tt>def()</tt>. <tt>Z_STREAM_END</tt> will be
-checked for later.
-<pre><b>
- ret = inflate(&strm, Z_NO_FLUSH);
- assert(ret != Z_STREAM_ERROR); /* state not clobbered */
- switch (ret) {
- case Z_NEED_DICT:
- ret = Z_DATA_ERROR; /* and fall through */
- case Z_DATA_ERROR:
- case Z_MEM_ERROR:
- (void)inflateEnd(&strm);
- return ret;
- }
-</b></pre>
-The output of <tt>inflate()</tt> is handled identically to that of <tt>deflate()</tt>.
-<pre><b>
- have = CHUNK - strm.avail_out;
- if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
- (void)inflateEnd(&strm);
- return Z_ERRNO;
- }
-</b></pre>
-The inner <tt>do</tt>-loop ends when <tt>inflate()</tt> has no more output as indicated
-by not filling the output buffer, just as for <tt>deflate()</tt>. In this case, we cannot
-assert that <tt>strm.avail_in</tt> will be zero, since the deflate stream may end before the file
-does.
-<pre><b>
- } while (strm.avail_out == 0);
-</b></pre><!-- -->
-The outer <tt>do</tt>-loop ends when <tt>inflate()</tt> reports that it has reached the
-end of the input <em>zlib</em> stream, has completed the decompression and integrity
-check, and has provided all of the output. This is indicated by the <tt>inflate()</tt>
-return value <tt>Z_STREAM_END</tt>. The inner loop is guaranteed to leave <tt>ret</tt>
-equal to <tt>Z_STREAM_END</tt> if the last chunk of the input file read contained the end
-of the <em>zlib</em> stream. So if the return value is not <tt>Z_STREAM_END</tt>, the
-loop continues to read more input.
-<pre><b>
- /* done when inflate() says it's done */
- } while (ret != Z_STREAM_END);
-</b></pre><!-- -->
-At this point, decompression successfully completed, or we broke out of the loop due to no
-more data being available from the input file. If the last <tt>inflate()</tt> return value
-is not <tt>Z_STREAM_END</tt>, then the <em>zlib</em> stream was incomplete and a data error
-is returned. Otherwise, we return with a happy return value. Of course, <tt>inflateEnd()</tt>
-is called first to avoid a memory leak.
-<pre><b>
- /* clean up and return */
- (void)inflateEnd(&strm);
- return ret == Z_STREAM_END ? Z_OK : Z_DATA_ERROR;
-}
-</b></pre><!-- -->
-That ends the routines that directly use <em>zlib</em>. The following routines make this
-a command-line program by running data through the above routines from <tt>stdin</tt> to
-<tt>stdout</tt>, and handling any errors reported by <tt>def()</tt> or <tt>inf()</tt>.
-<p>
-<tt>zerr()</tt> is used to interpret the possible error codes from <tt>def()</tt>
-and <tt>inf()</tt>, as detailed in their comments above, and print out an error message.
-Note that these are only a subset of the possible return values from <tt>deflate()</tt>
-and <tt>inflate()</tt>.
-<pre><b>
-/* report a zlib or i/o error */
-void zerr(int ret)
-{
- fputs("zpipe: ", stderr);
- switch (ret) {
- case Z_ERRNO:
- if (ferror(stdin))
- fputs("error reading stdin\n", stderr);
- if (ferror(stdout))
- fputs("error writing stdout\n", stderr);
- break;
- case Z_STREAM_ERROR:
- fputs("invalid compression level\n", stderr);
- break;
- case Z_DATA_ERROR:
- fputs("invalid or incomplete deflate data\n", stderr);
- break;
- case Z_MEM_ERROR:
- fputs("out of memory\n", stderr);
- break;
- case Z_VERSION_ERROR:
- fputs("zlib version mismatch!\n", stderr);
- }
-}
-</b></pre><!-- -->
-Here is the <tt>main()</tt> routine used to test <tt>def()</tt> and <tt>inf()</tt>. The
-<tt>zpipe</tt> command is simply a compression pipe from <tt>stdin</tt> to <tt>stdout</tt>, if
-no arguments are given, or it is a decompression pipe if <tt>zpipe -d</tt> is used. If any other
-arguments are provided, no compression or decompression is performed. Instead a usage
-message is displayed. Examples are <tt>zpipe < foo.txt > foo.txt.z</tt> to compress, and
-<tt>zpipe -d < foo.txt.z > foo.txt</tt> to decompress.
-<pre><b>
-/* compress or decompress from stdin to stdout */
-int main(int argc, char **argv)
-{
- int ret;
-
- /* avoid end-of-line conversions */
- SET_BINARY_MODE(stdin);
- SET_BINARY_MODE(stdout);
-
- /* do compression if no arguments */
- if (argc == 1) {
- ret = def(stdin, stdout, Z_DEFAULT_COMPRESSION);
- if (ret != Z_OK)
- zerr(ret);
- return ret;
- }
-
- /* do decompression if -d specified */
- else if (argc == 2 && strcmp(argv[1], "-d") == 0) {
- ret = inf(stdin, stdout);
- if (ret != Z_OK)
- zerr(ret);
- return ret;
- }
-
- /* otherwise, report usage */
- else {
- fputs("zpipe usage: zpipe [-d] < source > dest\n", stderr);
- return 1;
- }
-}
-</b></pre>
-<hr>
-<i>Copyright (c) 2004, 2005 by Mark Adler<br>Last modified 11 December 2005</i>
-</body>
-</html>
http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/1a48f7c3/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zpipe.c
----------------------------------------------------------------------
diff --git a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zpipe.c b/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zpipe.c
deleted file mode 100644
index 83535d1..0000000
--- a/DocFormats/platform/3rdparty/zlib-1.2.8/examples/zpipe.c
+++ /dev/null
@@ -1,205 +0,0 @@
-/* zpipe.c: example of proper use of zlib's inflate() and deflate()
- Not copyrighted -- provided to the public domain
- Version 1.4 11 December 2005 Mark Adler */
-
-/* Version history:
- 1.0 30 Oct 2004 First version
- 1.1 8 Nov 2004 Add void casting for unused return values
- Use switch statement for inflate() return values
- 1.2 9 Nov 2004 Add assertions to document zlib guarantees
- 1.3 6 Apr 2005 Remove incorrect assertion in inf()
- 1.4 11 Dec 2005 Add hack to avoid MSDOS end-of-line conversions
- Avoid some compiler warnings for input and output buffers
- */
-
-#include <stdio.h>
-#include <string.h>
-#include <assert.h>
-#include "zlib.h"
-
-#if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(__CYGWIN__)
-# include <fcntl.h>
-# include <io.h>
-# define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
-#else
-# define SET_BINARY_MODE(file)
-#endif
-
-#define CHUNK 16384
-
-/* Compress from file source to file dest until EOF on source.
- def() returns Z_OK on success, Z_MEM_ERROR if memory could not be
- allocated for processing, Z_STREAM_ERROR if an invalid compression
- level is supplied, Z_VERSION_ERROR if the version of zlib.h and the
- version of the library linked do not match, or Z_ERRNO if there is
- an error reading or writing the files. */
-int def(FILE *source, FILE *dest, int level)
-{
- int ret, flush;
- unsigned have;
- z_stream strm;
- unsigned char in[CHUNK];
- unsigned char out[CHUNK];
-
- /* allocate deflate state */
- strm.zalloc = Z_NULL;
- strm.zfree = Z_NULL;
- strm.opaque = Z_NULL;
- ret = deflateInit(&strm, level);
- if (ret != Z_OK)
- return ret;
-
- /* compress until end of file */
- do {
- strm.avail_in = fread(in, 1, CHUNK, source);
- if (ferror(source)) {
- (void)deflateEnd(&strm);
- return Z_ERRNO;
- }
- flush = feof(source) ? Z_FINISH : Z_NO_FLUSH;
- strm.next_in = in;
-
- /* run deflate() on input until output buffer not full, finish
- compression if all of source has been read in */
- do {
- strm.avail_out = CHUNK;
- strm.next_out = out;
- ret = deflate(&strm, flush); /* no bad return value */
- assert(ret != Z_STREAM_ERROR); /* state not clobbered */
- have = CHUNK - strm.avail_out;
- if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
- (void)deflateEnd(&strm);
- return Z_ERRNO;
- }
- } while (strm.avail_out == 0);
- assert(strm.avail_in == 0); /* all input will be used */
-
- /* done when last data in file processed */
- } while (flush != Z_FINISH);
- assert(ret == Z_STREAM_END); /* stream will be complete */
-
- /* clean up and return */
- (void)deflateEnd(&strm);
- return Z_OK;
-}
-
-/* Decompress from file source to file dest until stream ends or EOF.
- inf() returns Z_OK on success, Z_MEM_ERROR if memory could not be
- allocated for processing, Z_DATA_ERROR if the deflate data is
- invalid or incomplete, Z_VERSION_ERROR if the version of zlib.h and
- the version of the library linked do not match, or Z_ERRNO if there
- is an error reading or writing the files. */
-int inf(FILE *source, FILE *dest)
-{
- int ret;
- unsigned have;
- z_stream strm;
- unsigned char in[CHUNK];
- unsigned char out[CHUNK];
-
- /* allocate inflate state */
- strm.zalloc = Z_NULL;
- strm.zfree = Z_NULL;
- strm.opaque = Z_NULL;
- strm.avail_in = 0;
- strm.next_in = Z_NULL;
- ret = inflateInit(&strm);
- if (ret != Z_OK)
- return ret;
-
- /* decompress until deflate stream ends or end of file */
- do {
- strm.avail_in = fread(in, 1, CHUNK, source);
- if (ferror(source)) {
- (void)inflateEnd(&strm);
- return Z_ERRNO;
- }
- if (strm.avail_in == 0)
- break;
- strm.next_in = in;
-
- /* run inflate() on input until output buffer not full */
- do {
- strm.avail_out = CHUNK;
- strm.next_out = out;
- ret = inflate(&strm, Z_NO_FLUSH);
- assert(ret != Z_STREAM_ERROR); /* state not clobbered */
- switch (ret) {
- case Z_NEED_DICT:
- ret = Z_DATA_ERROR; /* and fall through */
- case Z_DATA_ERROR:
- case Z_MEM_ERROR:
- (void)inflateEnd(&strm);
- return ret;
- }
- have = CHUNK - strm.avail_out;
- if (fwrite(out, 1, have, dest) != have || ferror(dest)) {
- (void)inflateEnd(&strm);
- return Z_ERRNO;
- }
- } while (strm.avail_out == 0);
-
- /* done when inflate() says it's done */
- } while (ret != Z_STREAM_END);
-
- /* clean up and return */
- (void)inflateEnd(&strm);
- return ret == Z_STREAM_END ? Z_OK : Z_DATA_ERROR;
-}
-
-/* report a zlib or i/o error */
-void zerr(int ret)
-{
- fputs("zpipe: ", stderr);
- switch (ret) {
- case Z_ERRNO:
- if (ferror(stdin))
- fputs("error reading stdin\n", stderr);
- if (ferror(stdout))
- fputs("error writing stdout\n", stderr);
- break;
- case Z_STREAM_ERROR:
- fputs("invalid compression level\n", stderr);
- break;
- case Z_DATA_ERROR:
- fputs("invalid or incomplete deflate data\n", stderr);
- break;
- case Z_MEM_ERROR:
- fputs("out of memory\n", stderr);
- break;
- case Z_VERSION_ERROR:
- fputs("zlib version mismatch!\n", stderr);
- }
-}
-
-/* compress or decompress from stdin to stdout */
-int main(int argc, char **argv)
-{
- int ret;
-
- /* avoid end-of-line conversions */
- SET_BINARY_MODE(stdin);
- SET_BINARY_MODE(stdout);
-
- /* do compression if no arguments */
- if (argc == 1) {
- ret = def(stdin, stdout, Z_DEFAULT_COMPRESSION);
- if (ret != Z_OK)
- zerr(ret);
- return ret;
- }
-
- /* do decompression if -d specified */
- else if (argc == 2 && strcmp(argv[1], "-d") == 0) {
- ret = inf(stdin, stdout);
- if (ret != Z_OK)
- zerr(ret);
- return ret;
- }
-
- /* otherwise, report usage */
- else {
- fputs("zpipe usage: zpipe [-d] < source > dest\n", stderr);
- return 1;
- }
-}