7zTypes.h

Go to the documentation of this file.

/* 7zTypes.h -- Basic types
2013-11-12 : Igor Pavlov : Public domain */

#ifndef __7Z_TYPES_H
#define __7Z_TYPES_H

#include <stdint.h>
#include <stddef.h>

#ifndef EXTERN_C_BEGIN
#ifdef __cplusplus
#define EXTERN_C_BEGIN extern "C" {
#define EXTERN_C_END }
#else
#define EXTERN_C_BEGIN
#define EXTERN_C_END
#endif
#endif

EXTERN_C_BEGIN

#ifndef _7ZIP_ST
#define _7ZIP_ST
#endif

#define SZ_OK 0

#define SZ_ERROR_DATA 1
#define SZ_ERROR_MEM 2
#define SZ_ERROR_CRC 3
#define SZ_ERROR_UNSUPPORTED 4
#define SZ_ERROR_PARAM 5
#define SZ_ERROR_INPUT_EOF 6
#define SZ_ERROR_OUTPUT_EOF 7
#define SZ_ERROR_READ 8
#define SZ_ERROR_WRITE 9
#define SZ_ERROR_PROGRESS 10
#define SZ_ERROR_FAIL 11
#define SZ_ERROR_THREAD 12

#define SZ_ERROR_ARCHIVE 16
#define SZ_ERROR_NO_ARCHIVE 17

typedef int SRes;

#ifdef _WIN32
typedef unsigned WRes;
#else
typedef int WRes;
#endif

#ifndef RINOK
#define RINOK(x) { int __result__ = (x); if (__result__ != 0) return __result__; }
#endif

#ifdef _MSC_VER
#define MY_FAST_CALL __fastcall
#else
#define MY_FAST_CALL
#endif

/* The following interfaces use first parameter as pointer to structure */

typedef struct
{
 unsigned char (*Read)(void *p); /* reads one byte, returns 0 in case of EOF or error */
} IByteIn;

typedef struct
{
 void (*Write)(void *p, unsigned char b);
} IByteOut;

typedef struct
{
 SRes (*Read)(void *p, void *buf, size_t *size);
 /* if (input(*size) != 0 && output(*size) == 0) means end_of_stream.
 (output(*size) < input(*size)) is allowed */
} ISeqInStream;

/* it can return SZ_ERROR_INPUT_EOF */
SRes SeqInStream_Read(ISeqInStream *stream, void *buf, size_t size);
SRes SeqInStream_Read2(ISeqInStream *stream, void *buf, size_t size, SRes errorType);
SRes SeqInStream_ReadByte(ISeqInStream *stream, unsigned char *buf);

typedef struct
{
 size_t (*Write)(void *p, const void *buf, size_t size);
 /* Returns: result - the number of actually written bytes.
 (result < size) means error */
} ISeqOutStream;

typedef enum
{
 SZ_SEEK_SET = 0,
 SZ_SEEK_CUR = 1,
 SZ_SEEK_END = 2
} ESzSeek;

typedef struct
{
 SRes (*Read)(void *p, void *buf, size_t *size); /* same as ISeqInStream::Read */
 SRes (*Seek)(void *p, int64_t *pos, ESzSeek origin);
} ISeekInStream;

typedef struct
{
 SRes (*Look)(void *p, const void **buf, size_t *size);
 /* if (input(*size) != 0 && output(*size) == 0) means end_of_stream.
 (output(*size) > input(*size)) is not allowed
 (output(*size) < input(*size)) is allowed */
 SRes (*Skip)(void *p, size_t offset);
 /* offset must be <= output(*size) of Look */

 SRes (*Read)(void *p, void *buf, size_t *size);
 /* reads directly (without buffer). It's same as ISeqInStream::Read */
 SRes (*Seek)(void *p, int64_t *pos, ESzSeek origin);
} ILookInStream;

SRes LookInStream_LookRead(ILookInStream *stream, void *buf, size_t *size);
SRes LookInStream_SeekTo(ILookInStream *stream, uint64_t offset);

/* reads via ILookInStream::Read */
SRes LookInStream_Read2(ILookInStream *stream, void *buf, size_t size, SRes errorType);
SRes LookInStream_Read(ILookInStream *stream, void *buf, size_t size);

#define LookToRead_BUF_SIZE (1 << 14)

typedef struct
{
 ILookInStream s;
 ISeekInStream *realStream;
 size_t pos;
 size_t size;
 unsigned char buf[LookToRead_BUF_SIZE];
} CLookToRead;

void LookToRead_CreateVTable(CLookToRead *p, int lookahead);
void LookToRead_Init(CLookToRead *p);

typedef struct
{
 ISeqInStream s;
 ILookInStream *realStream;
} CSecToLook;

void SecToLook_CreateVTable(CSecToLook *p);

typedef struct
{
 ISeqInStream s;
 ILookInStream *realStream;
} CSecToRead;

void SecToRead_CreateVTable(CSecToRead *p);

typedef struct
{
 SRes (*Progress)(void *p, uint64_t inSize, uint64_t outSize);
} ICompressProgress;

typedef struct
{
 void *(*Alloc)(void *p, size_t size);
 void (*Free)(void *p, void *address); /* address can be 0 */
} ISzAlloc;

#define IAlloc_Alloc(p, size) (p)->Alloc((p), size)
#define IAlloc_Free(p, a) (p)->Free((p), a)

EXTERN_C_END

#endif