sl@0: // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: //
sl@0: 
sl@0: #ifndef __BARSCIMPL_H__
sl@0: #define __BARSCIMPL_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <f32file.h>
sl@0: 
sl@0: //Forward declarations
sl@0: struct SDictionaryCompressionData;
sl@0: class RDictionaryCompressionBitStream;
sl@0: class TBaAssert;
sl@0: 
sl@0: /** Accesses a resource file and reads the resource data into a buffer.
sl@0: 
sl@0: It is the implementation class for RResourceFile and CResourceFile classes.
sl@0: 
sl@0: Because of BC reasons, the size of RResourceFileImpl must be the same as 
sl@0: the size of RResourceFile class.
sl@0: 
sl@0: It is expected that all resources deallocation must be done in Close() method.
sl@0: (BC reasons - RResourceFile reserves enough space for the RResourceFileImpl
sl@0: instance and uses placement new operator to create it. But RResourceFile doesn't have a 
sl@0: destructor, so there is no predictable way how the RResourceFileImpl 
sl@0: destructor might be called, even if the class has user defined destructor).
sl@0: 
sl@0: Expected behaviour when assignment operator or copy constructor is called:
sl@0: The class doesn't have assignment operator and copy constructor, so the compiler generated
sl@0: ones will be used. The heap buffers used by the source class instance will be shared with the 
sl@0: destination class instance.
sl@0: 
sl@0: Methods panic/leave behaviour: "L" methods panics/leave behaviour depends on iAssertObj
sl@0: member (iExtra data member actually). If iAssertObj internal state is TBaAssert::EPanic - 
sl@0: "L" methods will panic, otherwise they will leave if something goes wrong.
sl@0: 
sl@0: @internalComponent 
sl@0: @see RResourceFile 
sl@0: @see CResourceFile */
sl@0: class RResourceFileImpl
sl@0: 	{
sl@0: public:
sl@0: 	RResourceFileImpl();
sl@0: 	~RResourceFileImpl();
sl@0: 	void OpenL(
sl@0: 		RFs& aFs, 
sl@0: 		const TDesC& aName, 
sl@0: 		const TBaAssert& aAssert,
sl@0: 		TUint aFileOffset = 0, 
sl@0: 		TInt aFileSize = 0);
sl@0: 	void OpenL(const TDesC8& aRscArchive,const TBaAssert& aAssert);
sl@0: 	void Close();
sl@0: 	TUidType UidType() const;
sl@0: 	void ReadL(TDes8 &aDes, TInt aResourceId) const;
sl@0: 	HBufC8 *AllocReadLC(TInt aResourceId) const;
sl@0: 	void ConfirmSignatureL(TInt aSignature);
sl@0: 	void ConfirmSignatureL();
sl@0: 	TInt SignatureL() const;
sl@0: 	TBool OwnsResourceIdL(TInt aResourceId) const;
sl@0: 	TInt Offset() const;
sl@0: private:
sl@0: 	struct SSigRecord
sl@0: 		{
sl@0: 		TInt signature;
sl@0: 		TInt offset;
sl@0: 		};
sl@0: 	enum
sl@0: 		{
sl@0: 		EFlagIsRomFile																=0x80000000,
sl@0: 		EFlagPotentiallyContainsCompressedUnicode									=0x40000000,
sl@0: 		EFlagDictionaryCompressed													=0x20000000,
sl@0: 		EFlagThirdUidIsOffset														=0x10000000,
sl@0: 		EFlagGenerate_RSS_SIGNATURE_ForFirstUserResource							=0x08000000,
sl@0: 		EFlagFirstResourceIsGeneratedBitArrayOfResourcesContainingCompressedUnicode	=0x04000000,
sl@0:  		EFlagCalypsoFileFormat														=0x02000000,
sl@0:  		EFlagIsBufferRscFile														=0x01000000,
sl@0: 		EAllFlags																	=0xff000000
sl@0: 		};
sl@0: 	enum
sl@0: 		{
sl@0: 		EOffsetBits	=0xfffff000,
sl@0: 		EIdBits		=0x00000fff
sl@0: 		};
sl@0: 	class TExtra;
sl@0: private:
sl@0: 	void ReadL(TInt aPos,TDes8& aDes,TInt aLength) const;
sl@0: 	SSigRecord FirstRecordL() const;
sl@0: 
sl@0: 	void AppendDecompressedUnicodeL(TDes8& aBuffer,const TDesC8& aCompressedUnicode) const;
sl@0: 	HBufC8* DecompressUnicodeL(
sl@0: 		const TDesC8& aDictionaryDecompressedResourceData,
sl@0: 		TInt aSizeOfLargestResourceWhenCompletelyUncompressed) const;
sl@0: 	HBufC8* DictionaryDecompressedResourceDataLC(
sl@0: 		TInt aResourceIndex,
sl@0: 		TUint aFlags,
sl@0: 		const SDictionaryCompressionData& aDictionaryCompressionData,
sl@0: 		const TDesC16& aIndex) const;
sl@0: 	void AppendDictionaryCompressionBitStreamL(
sl@0: 		RArray<RDictionaryCompressionBitStream>& aStackOfDictionaryCompressionBitStreams,
sl@0: 		TUint aFlags,
sl@0: 		const SDictionaryCompressionData& aDictionaryCompressionData,
sl@0: 		TInt aStartOfBitData,
sl@0: 		TInt aStartOfIndex,
sl@0: 		TInt aIndexEntry) const;
sl@0: 	TInt LittleEndianTwoByteIntegerL(const TDesC8& aBuffer,TInt aIndexOfFirstByte) const;
sl@0: 	void ReadL(TUint aFlags,TInt aPos,TDes8& aDes,TInt aLength) const;
sl@0: 	void ReadHeaderAndResourceIndexL();
sl@0: 
sl@0: private:
sl@0: 	TAny* iFile; // either an RFile*, or a const TUint8* pointing into ROM
sl@0: 	TInt iSizeOfLargestResourceWhenCompletelyUncompressed;
sl@0: 	//basically an array of (unsigned) 16-bit file-positions - 
sl@0: 	//this is only used for non-dictionary-compressed resource files
sl@0: 	HBufC16* iIndex; 
sl@0: 	//the position of this member in the class is exposed because RResourceFile::Offset() is 
sl@0: 	//an inline function accessing "iOffset". RResourceFileImpl is an implementation class for
sl@0: 	//RResourceFile class. The "iOffset" offset from the beginning of the class must be exactly
sl@0: 	//12 bytes.
sl@0: 	TInt iOffset; 
sl@0: 	TExtra* iExtra;
sl@0: 	TUint iFlagsAndNumberOfResources;
sl@0: 	};
sl@0: 
sl@0: #endif//__BARSCIMPL_H__