sl@0: // Copyright (c) 1997-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 __BARSREAD_H__
sl@0: #define __BARSREAD_H__
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include <badesca.h>
sl@0: 
sl@0: class TResourceReaderImpl;
sl@0: 
sl@0: /** 
sl@0: Interprets resource data read from a resource file.
sl@0: 
sl@0: To use an instance of this class, pass the buffer containing the resource 
sl@0: data to it by calling SetBuffer().
sl@0: 
sl@0: The buffer containing the resource data is created by RResourceFile::AllocReadLC() or 
sl@0: RResourceFile::AllocReadL() which reads the specified resource into it.
sl@0: 
sl@0: The current position within the buffer is always maintained and any request 
sl@0: for data is always supplied from the current position. The current position 
sl@0: is always updated .
sl@0: 
sl@0: @see TResourceReader::SetBuffer()
sl@0: @see RResourceFile::AllocReadL()
sl@0: @see RResourceFile::AllocReadLC() 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TResourceReader
sl@0:     {
sl@0: public:
sl@0:     IMPORT_C void SetBuffer(const TDesC8* aBuffer);
sl@0:     IMPORT_C const TAny* Ptr();
sl@0: 
sl@0:     // Read counted strings into allocated buffer
sl@0:     inline HBufC*   ReadHBufCL();
sl@0:     IMPORT_C HBufC8*  ReadHBufC8L();
sl@0:     IMPORT_C HBufC16* ReadHBufC16L();
sl@0: 
sl@0:     // Build pointer from a counted string
sl@0:     inline TPtrC   ReadTPtrC();
sl@0:     IMPORT_C TPtrC8  ReadTPtrC8();
sl@0: 	IMPORT_C TPtrC16 ReadTPtrC16();
sl@0: 
sl@0:     // Build pointer from a counted string in an array of counted strings,
sl@0:     // also setting the buffer to be used.
sl@0:     inline TPtrC ReadTPtrC(TInt aIndex,const TDesC8* aBuffer);
sl@0:     IMPORT_C TPtrC8 ReadTPtrC8(TInt aIndex,const TDesC8* aBuffer);
sl@0:     IMPORT_C TPtrC16 ReadTPtrC16(TInt aIndex,const TDesC8* aBuffer);
sl@0: 
sl@0:     // Build an array of strings from a resource array
sl@0:     inline CDesCArrayFlat*   ReadDesCArrayL();
sl@0:     IMPORT_C CDesC8ArrayFlat*  ReadDesC8ArrayL();
sl@0:     IMPORT_C CDesC16ArrayFlat* ReadDesC16ArrayL();
sl@0: 
sl@0:     IMPORT_C TInt ReadInt8();
sl@0:     IMPORT_C TUint ReadUint8();
sl@0:     IMPORT_C TInt ReadInt16();
sl@0:     IMPORT_C TUint ReadUint16();
sl@0:     IMPORT_C TInt ReadInt32();
sl@0:     IMPORT_C TUint ReadUint32();
sl@0:     IMPORT_C TReal64 ReadReal64() __SOFTFP;
sl@0: 
sl@0:     IMPORT_C void Read(TAny* aPtr,TInt aLength);
sl@0:     IMPORT_C void Rewind(TInt aLength);
sl@0:     IMPORT_C void Advance(TInt aLength);
sl@0: 
sl@0: private:
sl@0: 	void CreateImpl();
sl@0: 	TResourceReaderImpl* Impl();
sl@0: 	const TResourceReaderImpl* Impl() const;
sl@0: 
sl@0: 	TPtrC8 ReadTPtrC8L();
sl@0: 	TPtrC16 ReadTPtrC16L();
sl@0: 	TPtrC8 ReadTPtrC8L(TInt aIndex,const TDesC8* aBuffer);
sl@0: 	TPtrC16 ReadTPtrC16L(TInt aIndex,const TDesC8* aBuffer);
sl@0: 	TInt ReadInt8L();
sl@0: 	TUint ReadUint8L();
sl@0: 	TInt ReadInt16L();
sl@0: 	TUint ReadUint16L();
sl@0: 	TInt ReadInt32L();
sl@0: 	TUint ReadUint32L();
sl@0: 	TReal64 ReadReal64L() __SOFTFP;
sl@0: 
sl@0: private:
sl@0: 	enum
sl@0: 		{
sl@0: 		KRsReaderSize = 12
sl@0: 		};
sl@0: 	TUint8 iImpl[KRsReaderSize];
sl@0:     };
sl@0: 
sl@0: #if defined(_UNICODE)
sl@0: 
sl@0: /** 
sl@0: Interprets the data at the current buffer position as leading byte count data 
sl@0: and constructs a build independent heap descriptor containing a copy of this 
sl@0: data.
sl@0: 
sl@0: The data is interpreted as:
sl@0: 
sl@0: a byte value defining the number of text characters or the length of binary 
sl@0: data
sl@0: 
sl@0: followed by:
sl@0: 
sl@0: the text characters or binary data. This resource data is interpreted as either 
sl@0: 8-bit or 16-bit, depending on the build.
sl@0: 
sl@0: If the value of the leading byte is zero, the function assumes that no data 
sl@0: follows the leading byte and returns a NULL pointer.
sl@0: 
sl@0: The current position within the resource buffer is updated. If the resulting 
sl@0: position lies beyond the end of the resource buffer, then the function raises 
sl@0: a BAFL 4 panic.
sl@0: 
sl@0: Use this build independent variant when the resource contains text. If the 
sl@0: resource contains binary data, use the explicit 8-bit variant ReadHBufC8L().
sl@0: 
sl@0: @return A pointer to the heap descriptor containing a copy of the data following 
sl@0: the leading byte count at the current position within the resource buffer. 
sl@0: The pointer can be NULL. 
sl@0: */
sl@0: inline HBufC* TResourceReader::ReadHBufCL()
sl@0:     {
sl@0: 	return ReadHBufC16L();
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Interprets the data at the current buffer position as leading byte count data 
sl@0: and constructs a non modifiable pointer descriptor to represent this data.
sl@0: 
sl@0: The data is interpreted as:
sl@0: 
sl@0: a byte value defining the number of text characters or the length of binary 
sl@0: data
sl@0: 
sl@0: followed by:
sl@0: 
sl@0: the text characters or binary data. This resource data is interpreted as either 
sl@0: 8-bit or 16-bit, depending on the build.
sl@0: 
sl@0: If the value of the leading byte is zero, calling Length() on the returned 
sl@0: TPtrC returns zero.
sl@0: 
sl@0: The current position within the resource buffer is updated. If the resulting 
sl@0: position lies beyond the end of the resource buffer, then the function raises 
sl@0: a BAFL 4 panic.
sl@0: 
sl@0: Use this build independent variant when the resource contains text. If the 
sl@0: resource contains binary data, use the explicit 8-bit variant ReadTPtrC8().
sl@0: 
sl@0: @return A non modifiable pointer descriptor representing the data following 
sl@0: the leading byte count at the current position within the resource buffer. 
sl@0: */
sl@0: inline TPtrC TResourceReader::ReadTPtrC()
sl@0:     {
sl@0: 	return ReadTPtrC16();
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Interprets the data within the specified resource buffer as an array of leading 
sl@0: byte count data and constructs a non modifiable pointer descriptor to represent 
sl@0: an element within this array.
sl@0: 
sl@0: The function sets the buffer containing the resource data and sets the current 
sl@0: position to the start of this buffer. Any buffer set by a previous call to 
sl@0: SetBuffer() etc, is lost.
sl@0: 
sl@0: The buffer is expected to contain an array of data elements preceded by a 
sl@0: TInt16 value defining the number of elements within that array.
sl@0: 
sl@0: Each element of the array is interpreted as:
sl@0: 
sl@0: a byte value defining the number of text characters or the length of binary 
sl@0: data
sl@0: 
sl@0: followed by:
sl@0: 
sl@0: the text characters or binary data. This resource data is interpreted as either 
sl@0: 8-bit or 16-bit, depending on the build.
sl@0: 
sl@0: If the value of the leading byte is zero, calling Length() on the returned 
sl@0: TPtrC returns zero.
sl@0: 
sl@0: The current position within the resource buffer is updated. If the resulting 
sl@0: position lies beyond the end of the resource buffer, then the function raises 
sl@0: a BAFL 4 panic.
sl@0: 
sl@0: Use this build independent variant when the elements contain text. If the 
sl@0: elements contain binary data, use the explicit 8-bit variant ReadTPtrC8(TInt,const TDesC8*).
sl@0: 
sl@0: @param aIndex The position of the element within the array. This value is 
sl@0: relative to zero.
sl@0: @param aBuffer The buffer containing the resource data.
sl@0: @return A non modifiable pointer descriptor representing the data following 
sl@0: the leading byte count of the element at the specified position within the 
sl@0: array. 
sl@0: */
sl@0: inline TPtrC TResourceReader::ReadTPtrC(TInt aIndex,const TDesC8* aBuffer)
sl@0:     {
sl@0: 	return ReadTPtrC16(aIndex, aBuffer);
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Interprets the data at the current buffer position as an array of leading byte 
sl@0: count data and constructs a build independent flat array of descriptors.
sl@0: 
sl@0: Each descriptor in the descriptor array corresponds to an element of the resource 
sl@0: array.
sl@0: 
sl@0: At the current buffer position, the buffer is expected to contain an array 
sl@0: of data elements preceded by a TInt16 value defining the number of elements 
sl@0: within that array.
sl@0: 
sl@0: Each element of the array is interpreted as:
sl@0: 
sl@0: a byte value defining the number of text characters or the length of binary 
sl@0: data
sl@0: 
sl@0: followed by:
sl@0: 
sl@0: the text characters or binary data. This resource data is interpreted as either 
sl@0: 8-bit or 16-bit, depending on the build.
sl@0: 
sl@0: The current position within the resource buffer is updated. If the resulting 
sl@0: position lies beyond the end of the resource buffer, then the function raises 
sl@0: a BAFL 4 panic.
sl@0: 
sl@0: Use this build independent variant when the elements contain text. If the 
sl@0: elements contain binary data, use the explicit 8-bit variant ReadDesC8ArrayL().
sl@0: 
sl@0: @return A pointer to a build independent flat descriptor array. 
sl@0: */
sl@0: inline CDesCArrayFlat* TResourceReader::ReadDesCArrayL()
sl@0:     {
sl@0: 	return ReadDesC16ArrayL();
sl@0: 	}
sl@0: 
sl@0: #else // defined(_UNICODE)
sl@0: 
sl@0: inline HBufC* TResourceReader::ReadHBufCL()
sl@0:     {
sl@0: 	return ReadHBufC8L();
sl@0: 	}
sl@0: 
sl@0: inline TPtrC TResourceReader::ReadTPtrC()
sl@0:     {
sl@0: 	return ReadTPtrC8();
sl@0: 	}
sl@0: 
sl@0: inline TPtrC TResourceReader::ReadTPtrC(TInt aIndex,const TDesC8* aBuffer)
sl@0:     {
sl@0: 	return ReadTPtrC8(aIndex, aBuffer);
sl@0: 	}
sl@0: 
sl@0: inline CDesCArrayFlat* TResourceReader::ReadDesCArrayL()
sl@0:     {
sl@0: 	return ReadDesC8ArrayL();
sl@0: 	}
sl@0: 
sl@0: #endif// defined(_UNICODE)
sl@0: 
sl@0: 
sl@0: 
sl@0: #endif//__BARSREAD_H__