1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/BARSC.H	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,87 @@
     1.4 +// Copyright (c) 1997-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 __BARSC_H__
    1.20 +#define __BARSC_H__
    1.21 +
    1.22 +#include <f32file.h>
    1.23 +
    1.24 +//Forward declarations
    1.25 +class RResourceFileImpl;
    1.26 +
    1.27 +/** Accesses a resource file and reads the resource data into a buffer. 
    1.28 +
    1.29 +Interpretation of the data is achieved using the TResourceReader class.
    1.30 +
    1.31 +RResourceFile instance behaviour when some problem occurs - it panics. Or asserts,
    1.32 +if the used method is not "L" method.
    1.33 +
    1.34 +Expected behaviour when assignment operator or copy constructor is called:
    1.35 +The class doesn't have assignment operator and copy constructor, so the compiler generated
    1.36 +ones will be used. The heap buffers used by the source class instance will be shared with the 
    1.37 +destination class instance.
    1.38 +
    1.39 +Expected behaviour when the RResourceFile instance is about to be destroyed:
    1.40 +The class doesn't have destructor so compiler generated one will be used.
    1.41 +Always call Close() to free allocated by the instance resources.
    1.42 +
    1.43 +@see TResourceReader 
    1.44 +@publishedAll
    1.45 +@released
    1.46 +*/
    1.47 +class RResourceFile
    1.48 +	{
    1.49 +public:
    1.50 +	IMPORT_C RResourceFile();
    1.51 +	IMPORT_C void Close();
    1.52 +	IMPORT_C void OpenL(RFs &aFs,const TDesC &aName);
    1.53 +	IMPORT_C TUidType UidType() const;
    1.54 +	IMPORT_C void ReadL(TDes8 &aDes,TInt aResourceId) const;
    1.55 +	IMPORT_C HBufC8 *AllocReadL(TInt aResourceId) const;
    1.56 +	IMPORT_C HBufC8 *AllocReadLC(TInt aResourceId) const;
    1.57 +	IMPORT_C void ConfirmSignatureL(TInt aSignature);
    1.58 +	IMPORT_C void ConfirmSignatureL();
    1.59 +	IMPORT_C TInt SignatureL() const; // not available before Release 005
    1.60 +	IMPORT_C TBool OwnsResourceId(TInt aResourceId) const;
    1.61 +	IMPORT_C TBool OwnsResourceIdL(TInt aResourceId) const;
    1.62 +	IMPORT_C void OpenL(RFs& aFs, const TDesC& aName, TUint aFileOffset, TInt aFileSize);
    1.63 +	inline TInt Offset() const;
    1.64 +private:
    1.65 +	void DoOpenL(RFs& aFs, const TDesC& aName, TUint aFileOffset, TInt aFileSize);
    1.66 +	IMPORT_C TInt Offset2() const;
    1.67 +	RResourceFileImpl* Impl();
    1.68 +	const RResourceFileImpl* Impl() const;
    1.69 +private:
    1.70 +	enum
    1.71 +		{
    1.72 +		KRscFileSize = 24
    1.73 +		};
    1.74 +	TUint8 iImpl[KRscFileSize];
    1.75 +	};
    1.76 +
    1.77 +/** Returns the offset value defined for this resource file. 
    1.78 +   	
    1.79 +This function must not be called until a call to ConfirmSignatureL() has 
    1.80 +completed successfully, otherwise the value returned by this function may 
    1.81 +be meaningless.
    1.82 +
    1.83 +@return The offset value defined for this resource file.
    1.84 +@see RResourceFile::ConfirmSignatureL() */
    1.85 +inline TInt RResourceFile::Offset() const 
    1.86 +	{ 
    1.87 +	return Offset2(); 
    1.88 +	}
    1.89 +
    1.90 +#endif//__BARSC_H__