zstd/programs/fileio.h

97 lines
3.2 KiB
C
Raw Normal View History

2016-08-30 17:04:33 +00:00
/**
* Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
2015-01-31 09:52:59 +00:00
2016-09-15 15:02:06 +00:00
#ifndef FILEIO_H_23981798732
#define FILEIO_H_23981798732
2015-01-31 09:52:59 +00:00
#define ZSTD_STATIC_LINKING_ONLY /* ZSTD_compressionParameters */
#include "zstd.h" /* ZSTD_* */
2015-01-31 09:52:59 +00:00
#if defined (__cplusplus)
extern "C" {
#endif
2015-10-22 14:31:46 +00:00
/* *************************************
2015-01-31 09:52:59 +00:00
* Special i/o constants
**************************************/
2016-12-02 23:18:57 +00:00
#define stdinmark "/*stdin*\\"
2016-11-04 10:37:27 +00:00
#define stdoutmark "/*stdout*\\"
2015-01-31 09:52:59 +00:00
#ifdef _WIN32
# define nulmark "nul"
#else
# define nulmark "/dev/null"
#endif
#define LZMA_EXTENSION ".lzma"
#define XZ_EXTENSION ".xz"
#define GZ_EXTENSION ".gz"
#define ZSTD_EXTENSION ".zst"
#define LZ4_EXTENSION ".lz4"
2015-01-31 09:52:59 +00:00
2017-02-08 14:17:55 +00:00
/*-*************************************
* Types
***************************************/
typedef enum { FIO_zstdCompression, FIO_gzipCompression, FIO_xzCompression, FIO_lzmaCompression, FIO_lz4Compression } FIO_compressionType_t;
2017-02-08 14:17:55 +00:00
2016-03-10 20:02:25 +00:00
/*-*************************************
2015-01-31 09:52:59 +00:00
* Parameters
2015-10-22 14:31:46 +00:00
***************************************/
2017-02-14 08:23:32 +00:00
void FIO_setCompressionType(FIO_compressionType_t compressionType);
2015-01-31 09:52:59 +00:00
void FIO_overwriteMode(void);
void FIO_setNotificationLevel(unsigned level);
void FIO_setSparseWrite(unsigned sparse); /**< 0: no sparse; 1: disable on stdout; 2: always enabled */
void FIO_setDictIDFlag(unsigned dictIDFlag);
void FIO_setChecksumFlag(unsigned checksumFlag);
void FIO_setRemoveSrcFile(unsigned flag);
void FIO_setMemLimit(unsigned memLimit);
void FIO_setNbThreads(unsigned nbThreads);
void FIO_setBlockSize(unsigned blockSize);
void FIO_setOverlapLog(unsigned overlapLog);
2015-01-31 09:52:59 +00:00
2016-03-10 20:02:25 +00:00
/*-*************************************
* Single File functions
2015-10-22 14:31:46 +00:00
***************************************/
2016-02-12 02:50:05 +00:00
/** FIO_compressFilename() :
@return : 0 == ok; 1 == pb with src file. */
int FIO_compressFilename (const char* outfilename, const char* infilename, const char* dictFileName,
int compressionLevel, ZSTD_compressionParameters* comprParams);
2015-01-31 09:52:59 +00:00
2016-02-12 02:50:05 +00:00
/** FIO_decompressFilename() :
@return : 0 == ok; 1 == pb with src file. */
int FIO_decompressFilename (const char* outfilename, const char* infilename, const char* dictFileName);
2015-01-31 09:52:59 +00:00
2017-06-06 16:21:42 +00:00
int FIO_listFile(const char* infilename, int displayLevel);
2015-01-31 09:52:59 +00:00
2016-03-10 20:02:25 +00:00
/*-*************************************
* Multiple File functions
***************************************/
2016-02-12 02:50:05 +00:00
/** FIO_compressMultipleFilenames() :
@return : nb of missing files */
2015-12-17 19:30:14 +00:00
int FIO_compressMultipleFilenames(const char** srcNamesTable, unsigned nbFiles,
const char* suffix,
const char* dictFileName, int compressionLevel,
ZSTD_compressionParameters* comprParams);
2016-02-12 02:50:05 +00:00
/** FIO_decompressMultipleFilenames() :
@return : nb of missing or skipped files */
2015-12-17 19:30:14 +00:00
int FIO_decompressMultipleFilenames(const char** srcNamesTable, unsigned nbFiles,
const char* suffix,
const char* dictFileName);
2015-01-31 09:52:59 +00:00
#if defined (__cplusplus)
}
2015-10-22 14:31:46 +00:00
#endif
2016-09-15 15:02:06 +00:00
#endif /* FILEIO_H_23981798732 */