1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/BaRscImpl.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,136 @@
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 __BARSCIMPL_H__
1.20 +#define __BARSCIMPL_H__
1.21 +
1.22 +#include <e32std.h>
1.23 +#include <f32file.h>
1.24 +
1.25 +//Forward declarations
1.26 +struct SDictionaryCompressionData;
1.27 +class RDictionaryCompressionBitStream;
1.28 +class TBaAssert;
1.29 +
1.30 +/** Accesses a resource file and reads the resource data into a buffer.
1.31 +
1.32 +It is the implementation class for RResourceFile and CResourceFile classes.
1.33 +
1.34 +Because of BC reasons, the size of RResourceFileImpl must be the same as
1.35 +the size of RResourceFile class.
1.36 +
1.37 +It is expected that all resources deallocation must be done in Close() method.
1.38 +(BC reasons - RResourceFile reserves enough space for the RResourceFileImpl
1.39 +instance and uses placement new operator to create it. But RResourceFile doesn't have a
1.40 +destructor, so there is no predictable way how the RResourceFileImpl
1.41 +destructor might be called, even if the class has user defined destructor).
1.42 +
1.43 +Expected behaviour when assignment operator or copy constructor is called:
1.44 +The class doesn't have assignment operator and copy constructor, so the compiler generated
1.45 +ones will be used. The heap buffers used by the source class instance will be shared with the
1.46 +destination class instance.
1.47 +
1.48 +Methods panic/leave behaviour: "L" methods panics/leave behaviour depends on iAssertObj
1.49 +member (iExtra data member actually). If iAssertObj internal state is TBaAssert::EPanic -
1.50 +"L" methods will panic, otherwise they will leave if something goes wrong.
1.51 +
1.52 +@internalComponent
1.53 +@see RResourceFile
1.54 +@see CResourceFile */
1.55 +class RResourceFileImpl
1.56 + {
1.57 +public:
1.58 + RResourceFileImpl();
1.59 + ~RResourceFileImpl();
1.60 + void OpenL(
1.61 + RFs& aFs,
1.62 + const TDesC& aName,
1.63 + const TBaAssert& aAssert,
1.64 + TUint aFileOffset = 0,
1.65 + TInt aFileSize = 0);
1.66 + void OpenL(const TDesC8& aRscArchive,const TBaAssert& aAssert);
1.67 + void Close();
1.68 + TUidType UidType() const;
1.69 + void ReadL(TDes8 &aDes, TInt aResourceId) const;
1.70 + HBufC8 *AllocReadLC(TInt aResourceId) const;
1.71 + void ConfirmSignatureL(TInt aSignature);
1.72 + void ConfirmSignatureL();
1.73 + TInt SignatureL() const;
1.74 + TBool OwnsResourceIdL(TInt aResourceId) const;
1.75 + TInt Offset() const;
1.76 +private:
1.77 + struct SSigRecord
1.78 + {
1.79 + TInt signature;
1.80 + TInt offset;
1.81 + };
1.82 + enum
1.83 + {
1.84 + EFlagIsRomFile =0x80000000,
1.85 + EFlagPotentiallyContainsCompressedUnicode =0x40000000,
1.86 + EFlagDictionaryCompressed =0x20000000,
1.87 + EFlagThirdUidIsOffset =0x10000000,
1.88 + EFlagGenerate_RSS_SIGNATURE_ForFirstUserResource =0x08000000,
1.89 + EFlagFirstResourceIsGeneratedBitArrayOfResourcesContainingCompressedUnicode =0x04000000,
1.90 + EFlagCalypsoFileFormat =0x02000000,
1.91 + EFlagIsBufferRscFile =0x01000000,
1.92 + EAllFlags =0xff000000
1.93 + };
1.94 + enum
1.95 + {
1.96 + EOffsetBits =0xfffff000,
1.97 + EIdBits =0x00000fff
1.98 + };
1.99 + class TExtra;
1.100 +private:
1.101 + void ReadL(TInt aPos,TDes8& aDes,TInt aLength) const;
1.102 + SSigRecord FirstRecordL() const;
1.103 +
1.104 + void AppendDecompressedUnicodeL(TDes8& aBuffer,const TDesC8& aCompressedUnicode) const;
1.105 + HBufC8* DecompressUnicodeL(
1.106 + const TDesC8& aDictionaryDecompressedResourceData,
1.107 + TInt aSizeOfLargestResourceWhenCompletelyUncompressed) const;
1.108 + HBufC8* DictionaryDecompressedResourceDataLC(
1.109 + TInt aResourceIndex,
1.110 + TUint aFlags,
1.111 + const SDictionaryCompressionData& aDictionaryCompressionData,
1.112 + const TDesC16& aIndex) const;
1.113 + void AppendDictionaryCompressionBitStreamL(
1.114 + RArray<RDictionaryCompressionBitStream>& aStackOfDictionaryCompressionBitStreams,
1.115 + TUint aFlags,
1.116 + const SDictionaryCompressionData& aDictionaryCompressionData,
1.117 + TInt aStartOfBitData,
1.118 + TInt aStartOfIndex,
1.119 + TInt aIndexEntry) const;
1.120 + TInt LittleEndianTwoByteIntegerL(const TDesC8& aBuffer,TInt aIndexOfFirstByte) const;
1.121 + void ReadL(TUint aFlags,TInt aPos,TDes8& aDes,TInt aLength) const;
1.122 + void ReadHeaderAndResourceIndexL();
1.123 +
1.124 +private:
1.125 + TAny* iFile; // either an RFile*, or a const TUint8* pointing into ROM
1.126 + TInt iSizeOfLargestResourceWhenCompletelyUncompressed;
1.127 + //basically an array of (unsigned) 16-bit file-positions -
1.128 + //this is only used for non-dictionary-compressed resource files
1.129 + HBufC16* iIndex;
1.130 + //the position of this member in the class is exposed because RResourceFile::Offset() is
1.131 + //an inline function accessing "iOffset". RResourceFileImpl is an implementation class for
1.132 + //RResourceFile class. The "iOffset" offset from the beginning of the class must be exactly
1.133 + //12 bytes.
1.134 + TInt iOffset;
1.135 + TExtra* iExtra;
1.136 + TUint iFlagsAndNumberOfResources;
1.137 + };
1.138 +
1.139 +#endif//__BARSCIMPL_H__