epoc32/include/ziparchive.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@4
    16
williamr@2
    17
#ifndef _ZIP_ARCHIVE_H_
williamr@2
    18
#define _ZIP_ARCHIVE_H_
williamr@2
    19
williamr@4
    20
#include <localtypes.h>
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
This class represents a zip archive
williamr@2
    24
williamr@2
    25
@publishedAll
williamr@2
    26
@released
williamr@2
    27
*/
williamr@2
    28
class CZipArchive: public CBase
williamr@2
    29
	{
williamr@2
    30
public:
williamr@2
    31
williamr@2
    32
    enum 
williamr@2
    33
		{	
williamr@2
    34
		KZipArchiveError 					= -256,
williamr@2
    35
	    KCentralDirectoryTrailerNotFound	= KZipArchiveError - 1,
williamr@2
    36
	    KCentralDirectoryTrailerInvalid		= KZipArchiveError - 3,
williamr@2
    37
	    KCompressionMethodNotSupported		= KZipArchiveError - 4,
williamr@2
    38
	    KLocalHeaderSignatureInvalid		= KZipArchiveError - 5,
williamr@2
    39
	    KMultiDiskArchivesNotSupported		= KZipArchiveError - 6,
williamr@2
    40
		KMemberNotFound						= KZipArchiveError - 7,
williamr@2
    41
williamr@2
    42
		KZipArchiveMinError					= KZipArchiveError - 8
williamr@2
    43
williamr@2
    44
		};
williamr@2
    45
    
williamr@2
    46
    enum TCompressionMethod 
williamr@2
    47
		{
williamr@2
    48
		
williamr@2
    49
		EStored 		= 0,
williamr@2
    50
		EShrunk 		= 1,
williamr@2
    51
		EReducedCFOne	= 2,
williamr@2
    52
		EReducedCFTwo	= 3,
williamr@2
    53
		EReducedCFThree	= 4,
williamr@2
    54
		EReducedCFFour	= 5,
williamr@2
    55
		EImploded		= 6,
williamr@2
    56
		EReservedOne	= 7,
williamr@2
    57
		EDeflated		= 8,
williamr@2
    58
		EReservedTwo	= 9,
williamr@2
    59
		EPKWAREImploded	= 10
williamr@2
    60
		
williamr@2
    61
		};
williamr@2
    62
williamr@2
    63
protected:
williamr@2
    64
williamr@2
    65
    enum // Constants 
williamr@2
    66
		{
williamr@2
    67
    
williamr@2
    68
        KCentralDirectorySignature  		= 0x06054b50,
williamr@2
    69
    	KCentralDirectoryHeaderSignature	= 0x02014b50,
williamr@2
    70
    	KLocalHeaderSignature   			= 0x04034b50
williamr@2
    71
		};
williamr@2
    72
	
williamr@2
    73
	enum // Lengths 
williamr@2
    74
		{
williamr@2
    75
	
williamr@2
    76
		KCentralDirectoryTrailerFixedLength = 22,
williamr@2
    77
		KLocalHeaderFixedLength             = 30,
williamr@2
    78
		KCentralDirectoryHeaderFixedLength	= 46,
williamr@2
    79
		KSignatureLength                    =  4,
williamr@2
    80
		KMaxTrailerSearchLength             = 65536
williamr@2
    81
		};
williamr@2
    82
	
williamr@2
    83
	enum // Offsets 
williamr@2
    84
		{
williamr@2
    85
	
williamr@2
    86
		KCentralFileHeaderFileNameLengthOffset   = 28,
williamr@2
    87
		KCentralFileHeaderExtraFieldLengthOffset = 30,
williamr@2
    88
		KCentralFileHeaderFileNameOffset         = 46
williamr@2
    89
		};
williamr@2
    90
	
williamr@2
    91
	/**
williamr@2
    92
	Represents the archive's central directory trailer - the central directory contains information
williamr@2
    93
	about files in the arhive
williamr@2
    94
williamr@2
    95
	@publishedAll
williamr@2
    96
	@released
williamr@2
    97
	*/
williamr@2
    98
    struct TCentralDirectoryTrailer 
williamr@2
    99
		{
williamr@2
   100
        TUint32 iSignature;
williamr@2
   101
		TUint16 iDiskNumber;
williamr@2
   102
		TUint16 iStartDiskNumber;
williamr@2
   103
		TUint16 iLocalEntryCount;
williamr@2
   104
		TUint16 iTotalEntryCount;
williamr@2
   105
		TUint32 iSize;
williamr@2
   106
		TUint32 iOffset;
williamr@2
   107
		TUint16 iCommentLength;
williamr@2
   108
		// comment -- variable length
williamr@2
   109
		};
williamr@2
   110
williamr@2
   111
	/**
williamr@2
   112
	Represents the archive's central directory header - the central directory contains information
williamr@2
   113
	about files in the arhive
williamr@2
   114
williamr@2
   115
	@publishedAll
williamr@2
   116
	@released
williamr@2
   117
	*/
williamr@2
   118
	struct TCentralDirectoryHeader 
williamr@2
   119
		{
williamr@2
   120
		TUint32 iSignature;
williamr@2
   121
		TUint16 iMadeBy;
williamr@2
   122
		TUint16 iRequired;
williamr@2
   123
		TUint16 iFlags;
williamr@2
   124
		TUint16 iCompressionMethod;
williamr@2
   125
		TUint16 iLastModifiedFileTime;
williamr@2
   126
		TUint16 iLastModifiedFileDate;
williamr@2
   127
		TUint32 iCRC32;
williamr@2
   128
		TUint32 iCompressedSize;
williamr@2
   129
		TUint32 iUncompressedSize;
williamr@2
   130
		TUint16 iFileNameLength;
williamr@2
   131
		TUint16 iExtraFieldLength;
williamr@2
   132
		TUint16 iFileCommentLength;
williamr@2
   133
		TUint16 iDiskNumberStart;
williamr@2
   134
		TUint16 iInternalFileAttributes;
williamr@2
   135
		TUint32 iExternalFileAttributes;
williamr@2
   136
		TUint32 iLocalHeaderOffset;
williamr@2
   137
		// file name    -- variable length 
williamr@2
   138
		// extra field  -- variable length
williamr@2
   139
		// file comment -- variable length
williamr@2
   140
		};
williamr@2
   141
williamr@2
   142
	/**
williamr@2
   143
	Represents the archive's local header
williamr@2
   144
williamr@2
   145
	@publishedAll
williamr@2
   146
	@released
williamr@2
   147
	*/
williamr@2
   148
	struct TLocalHeader 
williamr@2
   149
		{
williamr@2
   150
		TUint32 iSignature;
williamr@2
   151
		TUint16 iVersionNeeded;
williamr@2
   152
		TUint16 iFlags;
williamr@2
   153
		TUint16 iCompressionMethod;
williamr@2
   154
		TUint16 iLastModifiedFileTime;
williamr@2
   155
		TUint16 iLastModifiedFileDate;
williamr@2
   156
		TUint32 iCRC32;
williamr@2
   157
		TUint32 iCompressedSize;
williamr@2
   158
		TUint32 iUncompressedSize;
williamr@2
   159
		TUint16 iFileNameLength;
williamr@2
   160
		TUint16 iExtraFieldLength;
williamr@2
   161
		// file name    -- variable length 
williamr@2
   162
		// extra field  -- variable length
williamr@2
   163
		};
williamr@2
   164
	};
williamr@2
   165
williamr@2
   166
#endif /* !_ZIP_ARCHIVE_H_ */
williamr@4
   167