1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/src/BaSPI.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,133 @@
1.4 +// Copyright (c) 2004-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 +#include <baspi.h>
1.20 +#include "BaArchiveImpl.h"
1.21 +
1.22 +/** Constructs a default resource archive reader object. */
1.23 +EXPORT_C RResourceArchive::RResourceArchive()
1.24 + {
1.25 + }
1.26 +
1.27 +/** Closes the resource archive(SPI) reader.
1.28 +This function is called after finishing reading all resources.
1.29 +*/
1.30 +EXPORT_C void RResourceArchive::Close()
1.31 + {
1.32 + delete iArchiveImpl;
1.33 + iArchiveImpl=NULL;
1.34 + }
1.35 +
1.36 +/** Open the resource archive reader
1.37 +@param aFs Handle to a file server session
1.38 +@param aName File to open as a resource archive file
1.39 +@leave The function leaves if the named file cannot be found or the header
1.40 +record at the beggining of the file cannot be read
1.41 +@panic If the file is corrupted - the method will panic in debug mode.
1.42 +*/
1.43 +EXPORT_C void RResourceArchive::OpenL(RFs& aFs,const TDesC& aName)
1.44 + {
1.45 + iArchiveImpl=CResourceArchiveImpl::NewL(aFs,aName);
1.46 + }
1.47 +
1.48 +/** Open the resource archive reader, this is usually used in composite
1.49 +rom drive situation where multiple independent rom images are mapped to
1.50 +a single rom drive and each rom image may consist 0..n spi files. Spi files
1.51 +in each rom image are labelled with the rom image id(example ecom-<id>-0.spi)
1.52 +with the id itself indicating the order of mounting/reading of the spi files.
1.53 +RResourceArchive will always mount/read the spi files in ascending order of
1.54 +the rom image id i.e. ecom-2-0.spi is mounted after ecom-1-0.spi and etc.
1.55 +
1.56 +As a result of this mounting order,it is possible to replace a resource
1.57 +inside an spi with the resource with same name from a later mounted spi.
1.58 +It is also possible to specify in an spi file the hiding of resource in
1.59 +another spi file.(See example below)
1.60 +
1.61 +In the presence of localised spi files(ecom-<id>-0.sNN where NN is language code)
1.62 +the spi files will be resolved internally based on existing language downgrade
1.63 +path.(See example below)
1.64 +
1.65 +@param aFs Handle to a file server session
1.66 +@param aSpiPath full path of the folder that contains the spi file
1.67 +@param aSpiName the default spi name without any image id and extension
1.68 +
1.69 +@code
1.70 +Example of use case:
1.71 +z:\private\10009d8f\ecom-0-0.spi (ROM IMAGE 0)
1.72 +z:\private\10009d8f\ecom-0-1.s02 (ROM IMAGE 0)
1.73 +z:\private\10009d8f\ecom-1-0.spi (ROM IMAGE 1)
1.74 +In this situation the function call to RResourceArchive should be:
1.75 +RResourceArchive::OpenL(RFs,_L("z:\\private\\10009d8f\\"),_L("ecom"));
1.76 +
1.77 +Example of multiple spi files and the visibility of the resource files
1.78 +under two different language downgrade path(DGP):
1.79 +-------------------------------------------------------------------------------
1.80 + | | | |Resource Visibility
1.81 +Ecom-1-0.spi| Ecom-1-0.s02 | Ecom-2-0.spi | Ecom-2-0.s02 |DGP(1) | DGP(2-1)
1.82 +-------------------------------------------------------------------------------
1.83 +A.RSC | A.R02 | B.RSC | Hide D.R02 |A.RSC(1) | A.R02(1)
1.84 +B.RSC | D.R02 | | C.R02 |B.RSC(2) | B.RSC(2)
1.85 +C.RSC | | | |C.RSC(1) | C.R02(2)
1.86 +-------------------------------------------------------------------------------
1.87 +@endcode
1.88 +
1.89 +@leave KErrNotFound if there is no single file matching aSpiName in the path
1.90 + KErrCorrupt if the spi file is corrupted
1.91 +@panic EBafPanicBadResourceFileFormat if the spi files that match the pattern
1.92 + do not share a common spi type.
1.93 +*/
1.94 +EXPORT_C void RResourceArchive::OpenL(RFs& aFs,const TDesC& aSpiPath,const TDesC& aSpiName)
1.95 + {
1.96 + iArchiveImpl=CResourceArchiveImpl::NewL(aFs,aSpiPath,aSpiName);
1.97 + }
1.98 +
1.99 +/** Creates an instance of CResourceFile which corresponds to the next
1.100 +rsc file in the resource archive file(SPI)
1.101 +@param aRscFileName the rsc file name buffer passed in by client
1.102 +@return CResourceFile pointer of the next resource file in the SPI
1.103 +@return NULL if there is no more resource file to read from the SPI
1.104 +@leave KErrNoMemory if there is not enough memory for the object
1.105 +@panic If the file is corrupted - the method will panic in debug mode
1.106 +*/
1.107 +EXPORT_C CResourceFile* RResourceArchive::NextL(HBufC*& aRscFileName)
1.108 + {
1.109 + return (iArchiveImpl->NextL(aRscFileName));
1.110 + }
1.111 +
1.112 +/** Reset the CResourceArchiveIter to start reading the first rsc file
1.113 +from the resourc archive(SPI) file
1.114 +*/
1.115 +EXPORT_C void RResourceArchive::Reset()
1.116 + {
1.117 + iArchiveImpl->Reset();
1.118 + }
1.119 +
1.120 +/** Return the type of the resource archive(SPI) file being opened
1.121 +@return the TUid type of the resource archive(SPI) file
1.122 +*/
1.123 +EXPORT_C TUid RResourceArchive::Type()
1.124 + {
1.125 + return iArchiveImpl->Type();
1.126 + }
1.127 +
1.128 +/** Look ahead in the resource archive to check whether there is
1.129 +still any resource in the archive to be read
1.130 +@pre RResourceArchive::OpenL must be called beforehand
1.131 +@return boolean indicating whether the next resource exists
1.132 +*/
1.133 +EXPORT_C TBool RResourceArchive::End()
1.134 + {
1.135 + return (!(iArchiveImpl->NextResourceExist()));
1.136 + }