|
sl@0
|
1 |
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
#ifndef __BARSC_H__
|
|
sl@0
|
17 |
#define __BARSC_H__
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#include <f32file.h>
|
|
sl@0
|
20 |
|
|
sl@0
|
21 |
//Forward declarations
|
|
sl@0
|
22 |
class RResourceFileImpl;
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
/** Accesses a resource file and reads the resource data into a buffer.
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
Interpretation of the data is achieved using the TResourceReader class.
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
RResourceFile instance behaviour when some problem occurs - it panics. Or asserts,
|
|
sl@0
|
29 |
if the used method is not "L" method.
|
|
sl@0
|
30 |
|
|
sl@0
|
31 |
Expected behaviour when assignment operator or copy constructor is called:
|
|
sl@0
|
32 |
The class doesn't have assignment operator and copy constructor, so the compiler generated
|
|
sl@0
|
33 |
ones will be used. The heap buffers used by the source class instance will be shared with the
|
|
sl@0
|
34 |
destination class instance.
|
|
sl@0
|
35 |
|
|
sl@0
|
36 |
Expected behaviour when the RResourceFile instance is about to be destroyed:
|
|
sl@0
|
37 |
The class doesn't have destructor so compiler generated one will be used.
|
|
sl@0
|
38 |
Always call Close() to free allocated by the instance resources.
|
|
sl@0
|
39 |
|
|
sl@0
|
40 |
@see TResourceReader
|
|
sl@0
|
41 |
@publishedAll
|
|
sl@0
|
42 |
@released
|
|
sl@0
|
43 |
*/
|
|
sl@0
|
44 |
class RResourceFile
|
|
sl@0
|
45 |
{
|
|
sl@0
|
46 |
public:
|
|
sl@0
|
47 |
IMPORT_C RResourceFile();
|
|
sl@0
|
48 |
IMPORT_C void Close();
|
|
sl@0
|
49 |
IMPORT_C void OpenL(RFs &aFs,const TDesC &aName);
|
|
sl@0
|
50 |
IMPORT_C TUidType UidType() const;
|
|
sl@0
|
51 |
IMPORT_C void ReadL(TDes8 &aDes,TInt aResourceId) const;
|
|
sl@0
|
52 |
IMPORT_C HBufC8 *AllocReadL(TInt aResourceId) const;
|
|
sl@0
|
53 |
IMPORT_C HBufC8 *AllocReadLC(TInt aResourceId) const;
|
|
sl@0
|
54 |
IMPORT_C void ConfirmSignatureL(TInt aSignature);
|
|
sl@0
|
55 |
IMPORT_C void ConfirmSignatureL();
|
|
sl@0
|
56 |
IMPORT_C TInt SignatureL() const; // not available before Release 005
|
|
sl@0
|
57 |
IMPORT_C TBool OwnsResourceId(TInt aResourceId) const;
|
|
sl@0
|
58 |
IMPORT_C TBool OwnsResourceIdL(TInt aResourceId) const;
|
|
sl@0
|
59 |
IMPORT_C void OpenL(RFs& aFs, const TDesC& aName, TUint aFileOffset, TInt aFileSize);
|
|
sl@0
|
60 |
inline TInt Offset() const;
|
|
sl@0
|
61 |
private:
|
|
sl@0
|
62 |
void DoOpenL(RFs& aFs, const TDesC& aName, TUint aFileOffset, TInt aFileSize);
|
|
sl@0
|
63 |
IMPORT_C TInt Offset2() const;
|
|
sl@0
|
64 |
RResourceFileImpl* Impl();
|
|
sl@0
|
65 |
const RResourceFileImpl* Impl() const;
|
|
sl@0
|
66 |
private:
|
|
sl@0
|
67 |
enum
|
|
sl@0
|
68 |
{
|
|
sl@0
|
69 |
KRscFileSize = 24
|
|
sl@0
|
70 |
};
|
|
sl@0
|
71 |
TUint8 iImpl[KRscFileSize];
|
|
sl@0
|
72 |
};
|
|
sl@0
|
73 |
|
|
sl@0
|
74 |
/** Returns the offset value defined for this resource file.
|
|
sl@0
|
75 |
|
|
sl@0
|
76 |
This function must not be called until a call to ConfirmSignatureL() has
|
|
sl@0
|
77 |
completed successfully, otherwise the value returned by this function may
|
|
sl@0
|
78 |
be meaningless.
|
|
sl@0
|
79 |
|
|
sl@0
|
80 |
@return The offset value defined for this resource file.
|
|
sl@0
|
81 |
@see RResourceFile::ConfirmSignatureL() */
|
|
sl@0
|
82 |
inline TInt RResourceFile::Offset() const
|
|
sl@0
|
83 |
{
|
|
sl@0
|
84 |
return Offset2();
|
|
sl@0
|
85 |
}
|
|
sl@0
|
86 |
|
|
sl@0
|
87 |
#endif//__BARSC_H__
|