sl@0: // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // GZIO.H
sl@0: // 
sl@0: //
sl@0: 
sl@0: // This header guard define is used subsequently in zutil.h to allow standard libarary functions
sl@0: // (in stdlib.h and string.h) to be included for libz.dll and excluded for libzcore.dll. 
sl@0: #ifndef LIBZGZIO_H
sl@0: #define LIBZGZIO_H
sl@0: 
sl@0: #if (defined(__TOOLS2__) || defined(__TOOLS__))
sl@0: 	#include "zconf.h"
sl@0: #else
sl@0: 	#include <zconf.h> 
sl@0: #endif
sl@0: 
sl@0: #include <stdarg.h>
sl@0:  
sl@0: 
sl@0: #ifdef SYMBIAN_EZLIB_DEVICE
sl@0: 	#include <e32def.h>
sl@0: #endif
sl@0: 
sl@0: #ifdef __cplusplus
sl@0: 	extern "C" {
sl@0: #endif
sl@0: 
sl@0: typedef voidp gzFile;
sl@0: 
sl@0: /* 
sl@0:  * Flushes all pending output if necessary, closes the compressed file
sl@0:  * and deallocates all the (de)compression state.
sl@0:  */
sl@0: int gzclose_r (gzFile file);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Clears the error and end-of-file flags for file.This is analogous to the
sl@0:  * clearerr() function in stdio.
sl@0:  */
sl@0: void gzclearerr_r (gzFile file);
sl@0: 
sl@0:  
sl@0: /* 
sl@0:  * gzdopen() associates a gzFile with the file descriptor fd.  File
sl@0:  * descriptors are obtained from calls like open, dup, creat, pipe or
sl@0:  * fileno (in the file has been previously opened with fopen).
sl@0:  * The mode parameter is as in gzopen.
sl@0:  */
sl@0: gzFile gzdopen_r (int fd, const char *mode);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Returns 1 if file is being read directly without decompression, otherwise
sl@0:  * zero.
sl@0:  */
sl@0: int gzdirect_r (gzFile file);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Returns 1 when EOF has previously been detected reading the given
sl@0:  * input stream, otherwise zero.
sl@0:  */ 
sl@0: int gzeof_r (gzFile file);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Returns the error message for the last error which occurred on the
sl@0:  * given compressed file. errnum is set to zlib error number. If an
sl@0:  * error occurred in the file system and not in the compression library,
sl@0:  * errnum is set to Z_ERRNO and the application may consult errno
sl@0:  * to get the exact error code.
sl@0:  */
sl@0: const char* gzerror_r (gzFile file, int *errnum);
sl@0: 
sl@0: 
sl@0: /* 
sl@0:  * Flushes all pending output into the compressed file.gzflush should 
sl@0:  * be called only when strictly necessary because it can degrade compression.
sl@0:  */
sl@0: int gzflush_r (gzFile file, int flush);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Reads one byte from the compressed file. gzgetc returns this byte
sl@0:  * or -1 in case of end of file or error.
sl@0:  */
sl@0: int gzgetc_r (gzFile file);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Reads bytes from the compressed file until len-1 characters are read, or
sl@0:  * a newline character is read and transferred to buf, or an end-of-file
sl@0:  * condition is encountered.  The string is then terminated with a null
sl@0:  * character.
sl@0:  */
sl@0: char* gzgets_r (gzFile file, char *buf, int len);
sl@0: 
sl@0: /*
sl@0:  * Opens a gzip (.gz) file for reading or writing. The mode parameter
sl@0:  * is as in fopen ("rb" or "wb") but can also include a compression level
sl@0:  * ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for
sl@0:  * Huffman only compression as in "wb1h", or 'R' for run-length encoding
sl@0:  * as in "wb1R".
sl@0:  */ 
sl@0: gzFile gzopen_r (const char *path, const char *mode);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Converts, formats, and writes the args to the compressed file under
sl@0:  * control of the format string, as in fprintf. gzprintf returns the number of
sl@0:  * uncompressed bytes actually written (0 in case of error).
sl@0:  */
sl@0: int gzprintf_r (gzFile file, const char *format, va_list va);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Writes c, converted to an unsigned char, into the compressed file.
sl@0:  * gzputc returns the value that was written, or -1 in case of error.
sl@0:  */
sl@0: int gzputc_r (gzFile file, int c);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Writes the given null-terminated string to the compressed file, excluding
sl@0:  * the terminating null character. gzputs returns the number of characters 
sl@0:  * written, or -1 in case of error.
sl@0:  */
sl@0: int gzputs_r (gzFile file, const char *s);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Reads the given number of uncompressed bytes from the compressed file.
sl@0:  * gzread returns the number of uncompressed bytes actually read (0 for
sl@0:  * end of file, -1 for error).
sl@0:  */
sl@0: int gzread_r (gzFile file, voidp buf, unsigned len);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Rewinds the given file. This function is supported only for reading.
sl@0:  * gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET)
sl@0:  */
sl@0:  
sl@0: int gzrewind_r (gzFile file);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Sets the starting position for the next gzread or gzwrite on the
sl@0:  * given compressed file. If the file is opened for writing, only 
sl@0:  * forward seeks are supported.
sl@0:  */ 
sl@0: z_off_t gzseek_r (gzFile file, z_off_t offset, int whence);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Dynamically update the compression level or strategy. See the description
sl@0:  * of deflateInit2 for the meaning of these parameters.
sl@0:  */                                    
sl@0: int gzsetparams_r (gzFile file, int level, int strategy);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Returns the starting position for the next gzread or gzwrite on the
sl@0:  * given compressed file. This position represents a number of bytes in the
sl@0:  * uncompressed data stream.
sl@0:  */ 
sl@0: z_off_t gztell_r (gzFile file);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Push one character back onto the stream to be read again later.
sl@0:  * Only one character of push-back is allowed. 
sl@0:  */ 
sl@0: int gzungetc_r (int c, gzFile file);
sl@0: 
sl@0: 
sl@0: /*
sl@0:  * Writes the given number of uncompressed bytes into the compressed file.
sl@0:  * gzwrite returns the number of uncompressed bytes actually written
sl@0:  * (0 in case of error).
sl@0:  */ 
sl@0: int gzwrite_r (gzFile file, voidpc buf, unsigned len);
sl@0: 
sl@0:                                    
sl@0: #ifdef __cplusplus
sl@0: 	}
sl@0: #endif
sl@0: 
sl@0: #endif /* LIBZGZIO_H */
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: