epoc32/include/zipfile.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_FILE_H_
williamr@2
    18
#define _ZIP_FILE_H_
williamr@2
    19
williamr@2
    20
#include <e32std.h>
williamr@2
    21
#include <s32file.h>
williamr@2
    22
#include <charconv.h>
williamr@2
    23
williamr@4
    24
#include <localtypes.h>
williamr@4
    25
#include <ziparchive.h>
williamr@4
    26
#include <zipfilememberinputstream.h>
williamr@2
    27
#include <zipfilememberiterator.h>
williamr@2
    28
#include <zipfilemember.h>
williamr@2
    29
williamr@2
    30
// Forward Class Declaration(s)
williamr@2
    31
williamr@2
    32
class CFileInputStream;
williamr@2
    33
class CZipFileMemberIterator;
williamr@2
    34
class CZipFileMember;
williamr@2
    35
namespace ContentAccess
williamr@2
    36
	{
williamr@2
    37
	class CData;
williamr@2
    38
	}
williamr@2
    39
williamr@2
    40
// End of Forward Class Declaration(s)
williamr@2
    41
williamr@2
    42
williamr@2
    43
/** 
williamr@2
    44
A CZipFile represents a ZIP archive contained in a single file. 
williamr@2
    45
Multi file zip archives are not supported.
williamr@2
    46
williamr@2
    47
@publishedAll
williamr@2
    48
@released
williamr@2
    49
*/
williamr@2
    50
class CZipFile : public CZipArchive
williamr@2
    51
	{
williamr@2
    52
	friend class RZipFileMemberReaderStream;
williamr@2
    53
	friend class CZipFileMemberIterator;
williamr@2
    54
williamr@2
    55
	public:
williamr@2
    56
		/**	ZipFile error enumeration.
williamr@2
    57
		*/
williamr@2
    58
		enum
williamr@2
    59
			{
williamr@2
    60
			/** Cannot read file directory in the archive file*/
williamr@2
    61
			KZipFileError 		= KZipArchiveMinError - 1,
williamr@2
    62
			
williamr@2
    63
			/** File not found error. It is not used in current implemenation*/
williamr@2
    64
			KZipFileNotFound	= KZipFileError - 1,
williamr@2
    65
			
williamr@2
    66
			/** File IO error.Any error occurs during a archive file is readed. 
williamr@2
    67
			For examples, any error about reading number of disk,
williamr@2
    68
			an offset of signature, or the content of file is non-readable.
williamr@2
    69
			*/
williamr@2
    70
			KZipFileIOError 	= KZipFileError - 2
williamr@2
    71
			};
williamr@2
    72
williamr@2
    73
	public:
williamr@2
    74
		IMPORT_C static CZipFile* NewL(RFs& aFs, RFile& aFile);	
williamr@2
    75
		IMPORT_C static CZipFile* NewL(RFs& aFs, const TDesC& aFileName);
williamr@2
    76
		IMPORT_C CZipFile(RFs& aFs, const TDesC& aFileName);
williamr@2
    77
		IMPORT_C TInt OpenL(void);
williamr@2
    78
		IMPORT_C void Close(void);
williamr@2
    79
		IMPORT_C virtual ~CZipFile();
williamr@2
    80
williamr@2
    81
	protected:
williamr@2
    82
		IMPORT_C void ConstructL(const TDesC& aFileName);
williamr@2
    83
		
williamr@2
    84
		IMPORT_C void ConstructL(RFile& aFile);
williamr@2
    85
williamr@2
    86
	public:
williamr@2
    87
		IMPORT_C TInt Size(TInt& aSize) const;
williamr@2
    88
    
williamr@2
    89
		IMPORT_C CZipFileMember* MemberL(const TDesC& aName);
williamr@2
    90
		IMPORT_C CZipFileMember* CaseInsensitiveMemberL(const TDesC& aName);
williamr@2
    91
		IMPORT_C CZipFileMember* CaseSensitiveOrCaseInsensitiveMemberL(const TDesC& aName);
williamr@2
    92
		IMPORT_C TInt GetInputStreamL(const CZipFileMember* aMember, RZipFileMemberReaderStream*& aStream);
williamr@2
    93
williamr@2
    94
  		IMPORT_C CZipFileMemberIterator* GetMembersL(void);
williamr@2
    95
	
williamr@2
    96
    
williamr@2
    97
protected:
williamr@2
    98
williamr@2
    99
	/** 
williamr@2
   100
	Internal representation of a compressed file in a zipfile
williamr@2
   101
	@publishedAll
williamr@2
   102
	@released
williamr@2
   103
	*/
williamr@2
   104
	struct TMemberPointer
williamr@2
   105
		{
williamr@2
   106
		/** the name of a compressed file*/
williamr@2
   107
		TFileName*  iName;
williamr@2
   108
		
williamr@2
   109
		/** Not used in current implementation*/
williamr@2
   110
		TUint32		iCentralHeaderOffset;
williamr@2
   111
		
williamr@2
   112
		/** The local offset of header in a compressed file*/
williamr@2
   113
		TUint32	iLocalHeaderOffset;
williamr@2
   114
		
williamr@2
   115
		/** CRC with 32 bits length in a compressed file*/
williamr@2
   116
		TUint32 iCRC32;
williamr@2
   117
		
williamr@2
   118
		/** The size of compressed file */	
williamr@2
   119
		TUint32	iCompressedSize;
williamr@2
   120
		
williamr@2
   121
		/** The size of file without compressed*/
williamr@2
   122
		TUint32	iUncompressedSize;
williamr@2
   123
		};
williamr@2
   124
		
williamr@2
   125
protected:
williamr@2
   126
	TInt FindCentralDirectoryTrailer(TUint32& offset);
williamr@2
   127
    TInt ReadCentralDirectoryTrailer(TUint32 offset, TCentralDirectoryTrailer&);
williamr@2
   128
    TInt ReadCentralDirectoryHeaderL(TCentralDirectoryHeader&, TMemberPointer&,
williamr@2
   129
    	CCnvCharacterSetConverter* aConverter, TInt aConverterState);
williamr@2
   130
williamr@2
   131
	TInt ReadLocalHeader(TUint32, TLocalHeader&);
williamr@2
   132
	
williamr@2
   133
	const TMemberPointer* FindMemberPointer(const TDesC&, TBool);
williamr@2
   134
	
williamr@2
   135
    TInt LoadMemberPointersL(void);
williamr@2
   136
    
williamr@2
   137
	RZipFileMemberReaderStream*   MakeInputStreamL(TUint32, TUint32, TUint32, TUint32);
williamr@2
   138
    CZipFileMember* MakeMemberL(TInt);
williamr@2
   139
    CZipFileMember* MakeMemberL(const TMemberPointer&, const TLocalHeader&);
williamr@2
   140
    
williamr@2
   141
    // File I/O Support
williamr@2
   142
    void OpenFileL(const TDesC& aFileName);
williamr@2
   143
  
williamr@2
   144
    TInt Read(TByte*, TUint32);
williamr@2
   145
    TInt Read(TUint16&);
williamr@2
   146
    TInt Read(TUint32&);
williamr@2
   147
    
williamr@2
   148
    TInt Seek(TInt);
williamr@2
   149
williamr@2
   150
	// Misc
williamr@2
   151
	void DeleteMemberPointers(void);
williamr@2
   152
williamr@2
   153
private:
williamr@2
   154
    const TDesC&				iFileName;
williamr@2
   155
    TUint32 iFileLength;
williamr@2
   156
	
williamr@2
   157
	/** The central directory of ZIP File Trailer*/
williamr@2
   158
	TCentralDirectoryTrailer iTrailer;
williamr@2
   159
	
williamr@2
   160
	/** The pointer to a a compressed file in a zipfile*/
williamr@2
   161
	TMemberPointer*	iMemberPointers;
williamr@2
   162
	
williamr@2
   163
	RFs& iFs;
williamr@2
   164
	
williamr@2
   165
	/** The pointer to CData object created from a zip file*/
williamr@2
   166
	ContentAccess::CData* iData;
williamr@2
   167
	};
williamr@2
   168
williamr@2
   169
#endif /* !_ZIP_FILE_H_ */