Add LzmaCustomDecompressLib based on the LZMA SDK 4.65 which was

[mirror_edk2.git] / IntelFrameworkModulePkg / Library / LzmaCustomDecompressLib / Sdk / C / Types.h

/** @file\r
  Types.h\r
\r
  Based on LZMA SDK 4.65:\r
    Types.h -- Basic types\r
    2008-11-23 : Igor Pavlov : Public domain\r
\r
  Copyright (c) 2009, Intel Corporation<BR>\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __7Z_TYPES_H\r
#define __7Z_TYPES_H\r
\r
#ifdef EFIAPI\r
\r
#include "UefiLzma.h"\r
\r
#else\r
\r
#include <stddef.h>\r
\r
#ifdef _WIN32\r
#include <windows.h>\r
#endif\r
\r
#endif\r
\r
#define SZ_OK 0\r
\r
#define SZ_ERROR_DATA 1\r
#define SZ_ERROR_MEM 2\r
#define SZ_ERROR_CRC 3\r
#define SZ_ERROR_UNSUPPORTED 4\r
#define SZ_ERROR_PARAM 5\r
#define SZ_ERROR_INPUT_EOF 6\r
#define SZ_ERROR_OUTPUT_EOF 7\r
#define SZ_ERROR_READ 8\r
#define SZ_ERROR_WRITE 9\r
#define SZ_ERROR_PROGRESS 10\r
#define SZ_ERROR_FAIL 11\r
#define SZ_ERROR_THREAD 12\r
\r
#define SZ_ERROR_ARCHIVE 16\r
#define SZ_ERROR_NO_ARCHIVE 17\r
\r
typedef int SRes;\r
\r
#ifdef _WIN32\r
typedef DWORD WRes;\r
#else\r
typedef int WRes;\r
#endif\r
\r
#ifndef RINOK\r
#define RINOK(x) { int __result__ = (x); if (__result__ != 0) return __result__; }\r
#endif\r
\r
typedef unsigned char Byte;\r
typedef short Int16;\r
typedef unsigned short UInt16;\r
\r
#ifdef _LZMA_UINT32_IS_ULONG\r
typedef long Int32;\r
typedef unsigned long UInt32;\r
#else\r
typedef int Int32;\r
typedef unsigned int UInt32;\r
#endif\r
\r
#ifdef _SZ_NO_INT_64\r
\r
/* define _SZ_NO_INT_64, if your compiler doesn't support 64-bit integers.\r
   NOTES: Some code will work incorrectly in that case! */\r
\r
typedef long Int64;\r
typedef unsigned long UInt64;\r
\r
#else\r
\r
#if defined(_MSC_VER) || defined(__BORLANDC__)\r
typedef __int64 Int64;\r
typedef unsigned __int64 UInt64;\r
#else\r
typedef long long int Int64;\r
typedef unsigned long long int UInt64;\r
#endif\r
\r
#endif\r
\r
#ifdef _LZMA_NO_SYSTEM_SIZE_T\r
typedef UInt32 SizeT;\r
#else\r
typedef size_t SizeT;\r
#endif\r
\r
typedef int Bool;\r
#define True 1\r
#define False 0\r
\r
\r
#ifdef _MSC_VER\r
\r
#if _MSC_VER >= 1300\r
#define MY_NO_INLINE __declspec(noinline)\r
#else\r
#define MY_NO_INLINE\r
#endif\r
\r
#define MY_CDECL __cdecl\r
#define MY_STD_CALL __stdcall\r
#define MY_FAST_CALL MY_NO_INLINE __fastcall\r
\r
#else\r
\r
#define MY_CDECL\r
#define MY_STD_CALL\r
#define MY_FAST_CALL\r
\r
#endif\r
\r
\r
/* The following interfaces use first parameter as pointer to structure */\r
\r
typedef struct\r
{\r
  SRes (*Read)(void *p, void *buf, size_t *size);\r
    /* if (input(*size) != 0 && output(*size) == 0) means end_of_stream.\r
       (output(*size) < input(*size)) is allowed */\r
} ISeqInStream;\r
\r
/* it can return SZ_ERROR_INPUT_EOF */\r
SRes SeqInStream_Read(ISeqInStream *stream, void *buf, size_t size);\r
SRes SeqInStream_Read2(ISeqInStream *stream, void *buf, size_t size, SRes errorType);\r
SRes SeqInStream_ReadByte(ISeqInStream *stream, Byte *buf);\r
\r
typedef struct\r
{\r
  size_t (*Write)(void *p, const void *buf, size_t size);\r
    /* Returns: result - the number of actually written bytes.\r
       (result < size) means error */\r
} ISeqOutStream;\r
\r
typedef enum\r
{\r
  SZ_SEEK_SET = 0,\r
  SZ_SEEK_CUR = 1,\r
  SZ_SEEK_END = 2\r
} ESzSeek;\r
\r
typedef struct\r
{\r
  SRes (*Read)(void *p, void *buf, size_t *size);  /* same as ISeqInStream::Read */\r
  SRes (*Seek)(void *p, Int64 *pos, ESzSeek origin);\r
} ISeekInStream;\r
\r
typedef struct\r
{\r
  SRes (*Look)(void *p, void **buf, size_t *size);\r
    /* if (input(*size) != 0 && output(*size) == 0) means end_of_stream.\r
       (output(*size) > input(*size)) is not allowed\r
       (output(*size) < input(*size)) is allowed */\r
  SRes (*Skip)(void *p, size_t offset);\r
    /* offset must be <= output(*size) of Look */\r
\r
  SRes (*Read)(void *p, void *buf, size_t *size);\r
    /* reads directly (without buffer). It's same as ISeqInStream::Read */\r
  SRes (*Seek)(void *p, Int64 *pos, ESzSeek origin);\r
} ILookInStream;\r
\r
SRes LookInStream_LookRead(ILookInStream *stream, void *buf, size_t *size);\r
SRes LookInStream_SeekTo(ILookInStream *stream, UInt64 offset);\r
\r
/* reads via ILookInStream::Read */\r
SRes LookInStream_Read2(ILookInStream *stream, void *buf, size_t size, SRes errorType);\r
SRes LookInStream_Read(ILookInStream *stream, void *buf, size_t size);\r
\r
#define LookToRead_BUF_SIZE (1 << 14)\r
\r
typedef struct\r
{\r
  ILookInStream s;\r
  ISeekInStream *realStream;\r
  size_t pos;\r
  size_t size;\r
  Byte buf[LookToRead_BUF_SIZE];\r
} CLookToRead;\r
\r
void LookToRead_CreateVTable(CLookToRead *p, int lookahead);\r
void LookToRead_Init(CLookToRead *p);\r
\r
typedef struct\r
{\r
  ISeqInStream s;\r
  ILookInStream *realStream;\r
} CSecToLook;\r
\r
void SecToLook_CreateVTable(CSecToLook *p);\r
\r
typedef struct\r
{\r
  ISeqInStream s;\r
  ILookInStream *realStream;\r
} CSecToRead;\r
\r
void SecToRead_CreateVTable(CSecToRead *p);\r
\r
typedef struct\r
{\r
  SRes (*Progress)(void *p, UInt64 inSize, UInt64 outSize);\r
    /* Returns: result. (result != SZ_OK) means break.\r
       Value (UInt64)(Int64)-1 for size means unknown value. */\r
} ICompressProgress;\r
\r
typedef struct\r
{\r
  void *(*Alloc)(void *p, size_t size);\r
  void (*Free)(void *p, void *address); /* address can be 0 */\r
} ISzAlloc;\r
\r
#define IAlloc_Alloc(p, size) (p)->Alloc((p), size)\r
#define IAlloc_Free(p, a) (p)->Free((p), a)\r
\r
#endif\r