/**
 * @ingroup  lib_file68
 * @file     sc68/file68_zip.h
 * @author   Benjamin Gerard
 * @date     2003-09-03
 * @brief    Gzip loader header.
 */

/* Copyright (c) 1998-2016 Benjamin Gerard */

#ifndef FILE68_ZIP_H
#define FILE68_ZIP_H

#ifndef FILE68_API
# include "file68_api.h"
#endif

/**
 * @defgroup  lib_file68_zip  gzip file support.
 * @ingroup   lib_file68
 *
 *   Provides functions for loading and saving gzip file.
 *
 * @{
 */

FILE68_API
/**
 * Test gzip file header magic header.
 *
 * @param  buffer  Buffer containing at least 3 bytes from gzip header.
 *
 * @retval  1  buffer may be gzipped.
 * @retval  0  buffer is not gzipped.
 */
int gzip68_is_magic(const void * buffer);

FILE68_API
/**
 * Load an optionnally gzipped file.
 *
 *   The gzip68_load() function allocates memory and loads the
 *   totality of the given file. If the file is a gzipped file, it
 *   will be inflate.
 *
 * @param  fname    Name of file to load.
 * @param  ulen     Pointer to uncompressed or total size of file.
 *
 * @return A pointer to loaded file buffer.
 * @retval 0 on error.
 */
void * gzip68_load(const char * fname, int * ulen);

FILE68_API
/**
 * Unzip from and to memory.
 *
 * @param  dst   destination buffer
 * @param  dsize destination buffer size
 * @param  src   COmpressed buffer
 * @param  csize compressed buffer size
 *
 * @return size of deflated buffer
 * @retval -1 on error.
 */
int gzip68_buffer(void * dst, int dsize, const void * src, int csize);

/**
 * @}
 */

#endif
