1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/compressionlibs/ziplib/inc/ezgzip.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,253 @@
1.4 +// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#ifndef __GZIP_H__
1.20 +#define __GZIP_H__
1.21 +
1.22 +#include <ezdecompressor.h>
1.23 +#include <ezcompressor.h>
1.24 +#include <ezfilebuffer.h>
1.25 +
1.26 +/**
1.27 +The TEZGZipHeader class encapsulates a zip file header, which is written to the start of the zip
1.28 +file to store various settings of the archive
1.29 +
1.30 +@publishedAll
1.31 +@released
1.32 +*/
1.33 +class TEZGZipHeader
1.34 + {
1.35 +
1.36 +public:
1.37 + IMPORT_C TEZGZipHeader();
1.38 + IMPORT_C ~TEZGZipHeader();
1.39 +
1.40 +public:
1.41 + TUint8 iId1;
1.42 + TUint8 iId2;
1.43 + TUint8 iCompressionMethod;
1.44 + TUint8 iFlags;
1.45 + TInt32 iTime;
1.46 + TUint8 iExtraFlags;
1.47 + TUint8 iOs;
1.48 + TInt16 iXlen;
1.49 + HBufC8* iExtra;
1.50 + HBufC8* iFname;
1.51 + HBufC8* iComment;
1.52 + TInt16 iCrc;
1.53 + };
1.54 +
1.55 +/**
1.56 +The TEZGZipTrailer class encapsulates a zip file trailer, which uses a CRC (cyclic redundancy check) to
1.57 +confirm the validity of the unpacked archive
1.58 +
1.59 +@publishedAll
1.60 +@released
1.61 +*/
1.62 +class TEZGZipTrailer
1.63 + {
1.64 +public:
1.65 + IMPORT_C TEZGZipTrailer();
1.66 + IMPORT_C TEZGZipTrailer(TInt32 aCrc, TInt32 aSize);
1.67 +public:
1.68 + TInt32 iCrc32;
1.69 + TInt32 iSize;
1.70 + };
1.71 +
1.72 +/**
1.73 +The EZGZipFile class handles writing / reading of headers and trailers to / from zip files
1.74 +
1.75 +@publishedAll
1.76 +@released
1.77 +*/
1.78 +class EZGZipFile
1.79 + {
1.80 +public:
1.81 +
1.82 + /** Zip file error codes */
1.83 + enum { ENotGZipFile = KEZlibErrNotGZipFile,
1.84 + EInvalidCompressionMethod = KEZlibErrInvalidCompression,
1.85 + EBadGZipHeader= KEZlibErrBadGZipHeader,
1.86 + EBadGZipTrailer = KEZlibErrBadGZipTrailer,
1.87 + EBadGZipCrc = KEZlibErrBadGZipCrc };
1.88 + /** Flags to determine which part of the header / trailer is being written */
1.89 + enum { EFText = 0, EFHcrc = 1, EFExtra = 2, EFName = 3, EFComment = 4};
1.90 +
1.91 +public:
1.92 + IMPORT_C static void ReadHeaderL(RFile &aFile, TEZGZipHeader &aHeader);
1.93 + IMPORT_C static void WriteHeaderL(RFile &aFile, TEZGZipHeader &aHeader);
1.94 + IMPORT_C static void ReadTrailerL(RFile &aFile, TEZGZipTrailer &aTrailer);
1.95 + IMPORT_C static void WriteTrailerL(RFile &aFile, TEZGZipTrailer &aTrailer);
1.96 + IMPORT_C static void LocateAndReadTrailerL(RFs &aRfs, const TDesC &aFname, TEZGZipTrailer &aTrailer);
1.97 + IMPORT_C static TBool IsGzipFile(RFs &aRfs, const TDesC &aFname);
1.98 + IMPORT_C static TBool IsGzipFileL(RFs &aRfs, const TDesC &aFname);
1.99 +
1.100 +private:
1.101 + static void ReadStringIntoDescriptorL(RFile &aFile, HBufC8 **aDes);
1.102 +
1.103 +public:
1.104 + /** First of the header ID pair */
1.105 + static const TUint8 ID1;
1.106 + /** Second of the header ID pair */
1.107 + static const TUint8 ID2;
1.108 + };
1.109 +
1.110 +/**
1.111 +The CEZFileToGzipBM manages the input and output buffers for compression
1.112 +
1.113 +@publishedAll
1.114 +@released
1.115 +*/
1.116 +NONSHARABLE_CLASS(CEZFileToGzipBM) : public CEZFileBufferManager
1.117 + {
1.118 +public:
1.119 +
1.120 + static CEZFileToGzipBM* NewLC(RFile &aInput, RFile &aOutput, TInt aBufferSize);
1.121 + static CEZFileToGzipBM* NewL(RFile &aInput, RFile &aOutput, TInt aBufferSize);
1.122 +
1.123 + /**
1.124 + Initialise the stream with input and output buffers and starts reading
1.125 +
1.126 + @param aZStream the stream to initialise
1.127 + */
1.128 + virtual void InitializeL(CEZZStream &aZStream);
1.129 +
1.130 + /**
1.131 + Set the stream's input buffer and starts reading
1.132 +
1.133 + @param aZStream the steam whose input buffer to set
1.134 + */
1.135 + virtual void NeedInputL(CEZZStream &aZStream);
1.136 +
1.137 + /**
1.138 + Return the CRC - used for checking validity of the archive
1.139 +
1.140 + @return the CRC value
1.141 + */
1.142 + TInt32 Crc() const { return iCrc; } ;
1.143 +
1.144 +private:
1.145 + CEZFileToGzipBM(RFile &aInput, RFile &aOutput);
1.146 +private:
1.147 + TInt32 iCrc;
1.148 + };
1.149 +
1.150 +/**
1.151 +The CEZGzipToFileBM class manages the input and output buffers for de-compression
1.152 +
1.153 +@publishedAll
1.154 +@released
1.155 +*/
1.156 +NONSHARABLE_CLASS(CEZGzipToFileBM) : public CEZFileBufferManager
1.157 + {
1.158 +public:
1.159 +
1.160 + static CEZGzipToFileBM* NewLC(RFile &aInput, RFile &aOutput, TInt aBufferSize);
1.161 + static CEZGzipToFileBM* NewL(RFile &aInput, RFile &aOutput, TInt aBufferSize);
1.162 +
1.163 + /**
1.164 + Finish writing to the stream
1.165 +
1.166 + @param aZStream the stream to complete writing to
1.167 + */
1.168 + virtual void FinalizeL(CEZZStream &aZStream);
1.169 +
1.170 + /**
1.171 + Set the stream's output buffer and start writing
1.172 +
1.173 + @param aZStream the steam whose output buffer to set
1.174 + */
1.175 + virtual void NeedOutputL(CEZZStream &aZStream);
1.176 +
1.177 + /**
1.178 + Return the CRC - used for checking validity of the archive
1.179 +
1.180 + @return the CRC value
1.181 + */
1.182 + TInt32 Crc() const { return iCrc; } ;
1.183 +
1.184 +private:
1.185 + CEZGzipToFileBM(RFile &aInput, RFile &aOutput);
1.186 +private:
1.187 + TInt32 iCrc;
1.188 + };
1.189 +
1.190 +
1.191 +/**
1.192 +A CEZGZipToFile object allows de-compression of a compressed file.
1.193 +The name of the compressed file is passed into the constructor along with a target file
1.194 +to contain the uncompressed data. The file is uncompressed by calling the InflateL() function.
1.195 +
1.196 +@publishedAll
1.197 +@released
1.198 +*/
1.199 +class CEZGZipToFile : public CBase
1.200 + {
1.201 +public:
1.202 + ~CEZGZipToFile();
1.203 +
1.204 + IMPORT_C static CEZGZipToFile* NewLC(RFs &aRfs, const TDesC &aGzFileName, RFile &aOutput, TInt aBufferSize = 0x8000);
1.205 + IMPORT_C static CEZGZipToFile* NewL(RFs &aRfs, const TDesC &aGzFileName, RFile &aOutput, TInt aBufferSize = 0x8000);
1.206 +
1.207 + IMPORT_C void ResetL(RFs &aRfs, const TDesC &aGzFileName, RFile &aOutput, TInt aBufferSize = 0x8000);
1.208 +
1.209 + IMPORT_C TBool InflateL();
1.210 +
1.211 +private:
1.212 + CEZGZipToFile();
1.213 + void ConstructL(RFs &aRfs, const TDesC &aGzFileName, RFile &aOutput, TInt aBufferSize);
1.214 + void InitialiseBufManL(RFs &aRfs, const TDesC &aGzFileName, RFile &aOutput, TInt aBufferSize);
1.215 +private:
1.216 + CEZDecompressor *iDecompressor;
1.217 + CEZGzipToFileBM *iBufferManager;
1.218 + TEZGZipTrailer iTrailer;
1.219 + RFile iGZipFile;
1.220 + TEZGZipHeader iHeader;
1.221 + };
1.222 +
1.223 +/**
1.224 +A CEZFileToGZip object allows compression of an uncompressed file to a zip file.
1.225 +The uncompressed source file is passed into the constructor along with the name of the target
1.226 +zip file. The file is compressed by calling the DeflateL() function.
1.227 +
1.228 +@publishedAll
1.229 +@released
1.230 +*/
1.231 +class CEZFileToGZip : public CBase
1.232 + {
1.233 +public:
1.234 + ~CEZFileToGZip();
1.235 +
1.236 + IMPORT_C static CEZFileToGZip* NewLC(RFs &aRfs, const TDesC &aGzFileName, RFile &aInput, TInt aBufferSize = 0x8000);
1.237 + IMPORT_C static CEZFileToGZip* NewL(RFs &aRfs, const TDesC &aGzFileName, RFile &aInput, TInt aBufferSize = 0x8000);
1.238 +
1.239 + IMPORT_C void ResetL(RFs &aRfs, const TDesC &aGzFileName, RFile &aInput, TInt aBufferSize = 0x8000);
1.240 +
1.241 + IMPORT_C TBool DeflateL();
1.242 +
1.243 +private:
1.244 + CEZFileToGZip();
1.245 + void ConstructL(RFs &aRfs, const TDesC &aGzFileName, RFile &aInput, TInt aBufferSize);
1.246 + void InitialiseBufManL(RFs &aRfs, const TDesC &aGzFileName, RFile &aInput, TInt aBufferSize);
1.247 +private:
1.248 + CEZCompressor *iCompressor;
1.249 + CEZFileToGzipBM *iBufferManager;
1.250 + TInt iUncompressedDataSize;
1.251 + RFile iGZipFile;
1.252 + TEZGZipHeader iHeader;
1.253 + };
1.254 +
1.255 +
1.256 +#endif