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 __BARSC_H__
sl@0: #define __BARSC_H__
sl@0: 
sl@0: #include <f32file.h>
sl@0: 
sl@0: //Forward declarations
sl@0: class RResourceFileImpl;
sl@0: 
sl@0: /** Accesses a resource file and reads the resource data into a buffer. 
sl@0: 
sl@0: Interpretation of the data is achieved using the TResourceReader class.
sl@0: 
sl@0: RResourceFile instance behaviour when some problem occurs - it panics. Or asserts,
sl@0: if the used method is not "L" method.
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: Expected behaviour when the RResourceFile instance is about to be destroyed:
sl@0: The class doesn't have destructor so compiler generated one will be used.
sl@0: Always call Close() to free allocated by the instance resources.
sl@0: 
sl@0: @see TResourceReader 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class RResourceFile
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C RResourceFile();
sl@0: 	IMPORT_C void Close();
sl@0: 	IMPORT_C void OpenL(RFs &aFs,const TDesC &aName);
sl@0: 	IMPORT_C TUidType UidType() const;
sl@0: 	IMPORT_C void ReadL(TDes8 &aDes,TInt aResourceId) const;
sl@0: 	IMPORT_C HBufC8 *AllocReadL(TInt aResourceId) const;
sl@0: 	IMPORT_C HBufC8 *AllocReadLC(TInt aResourceId) const;
sl@0: 	IMPORT_C void ConfirmSignatureL(TInt aSignature);
sl@0: 	IMPORT_C void ConfirmSignatureL();
sl@0: 	IMPORT_C TInt SignatureL() const; // not available before Release 005
sl@0: 	IMPORT_C TBool OwnsResourceId(TInt aResourceId) const;
sl@0: 	IMPORT_C TBool OwnsResourceIdL(TInt aResourceId) const;
sl@0: 	IMPORT_C void OpenL(RFs& aFs, const TDesC& aName, TUint aFileOffset, TInt aFileSize);
sl@0: 	inline TInt Offset() const;
sl@0: private:
sl@0: 	void DoOpenL(RFs& aFs, const TDesC& aName, TUint aFileOffset, TInt aFileSize);
sl@0: 	IMPORT_C TInt Offset2() const;
sl@0: 	RResourceFileImpl* Impl();
sl@0: 	const RResourceFileImpl* Impl() const;
sl@0: private:
sl@0: 	enum
sl@0: 		{
sl@0: 		KRscFileSize = 24
sl@0: 		};
sl@0: 	TUint8 iImpl[KRscFileSize];
sl@0: 	};
sl@0: 
sl@0: /** Returns the offset value defined for this resource file. 
sl@0:    	
sl@0: This function must not be called until a call to ConfirmSignatureL() has 
sl@0: completed successfully, otherwise the value returned by this function may 
sl@0: be meaningless.
sl@0: 
sl@0: @return The offset value defined for this resource file.
sl@0: @see RResourceFile::ConfirmSignatureL() */
sl@0: inline TInt RResourceFile::Offset() const 
sl@0: 	{ 
sl@0: 	return Offset2(); 
sl@0: 	}
sl@0: 
sl@0: #endif//__BARSC_H__