sl@0: // Copyright (c) 2004-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: #include <baspi.h>
sl@0: #include "BaArchiveImpl.h"
sl@0: 
sl@0: /** Constructs a default resource archive reader object. */
sl@0: EXPORT_C RResourceArchive::RResourceArchive()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /** Closes the resource archive(SPI) reader.
sl@0: This function is called after finishing reading all resources.
sl@0: */
sl@0: EXPORT_C void RResourceArchive::Close()
sl@0: 	{
sl@0: 	delete iArchiveImpl;
sl@0: 	iArchiveImpl=NULL;
sl@0: 	}
sl@0: 
sl@0: /** Open the resource archive reader
sl@0: @param aFs Handle to a file server session
sl@0: @param aName File to open as a resource archive file
sl@0: @leave The function leaves if the named file cannot be found or the header
sl@0: record at the beggining of the file cannot be read
sl@0: @panic If the file is corrupted - the method will panic in debug mode. 
sl@0: */
sl@0: EXPORT_C void RResourceArchive::OpenL(RFs& aFs,const TDesC& aName)
sl@0: 	{
sl@0: 	iArchiveImpl=CResourceArchiveImpl::NewL(aFs,aName);
sl@0: 	}
sl@0: 
sl@0: /** Open the resource archive reader, this is usually used in composite
sl@0: rom drive situation where multiple independent rom images are mapped to 
sl@0: a single rom drive and each rom image may consist 0..n spi files. Spi files
sl@0: in each rom image are labelled with the rom image id(example ecom-<id>-0.spi)
sl@0: with the id itself indicating the order of mounting/reading of the spi files.
sl@0: RResourceArchive will always mount/read the spi files in ascending order of 
sl@0: the rom image id i.e. ecom-2-0.spi is mounted after ecom-1-0.spi and etc.
sl@0: 
sl@0: As a result of this mounting order,it is possible to replace a resource
sl@0: inside an spi with the resource with same name from a later mounted spi.
sl@0: It is also possible to specify in an spi file the hiding of resource in
sl@0: another spi file.(See example below)
sl@0: 
sl@0: In the presence of localised spi files(ecom-<id>-0.sNN where NN is language code)
sl@0: the spi files will be resolved internally based on existing language downgrade
sl@0: path.(See example below)
sl@0: 
sl@0: @param aFs Handle to a file server session
sl@0: @param aSpiPath full path of the folder that contains the spi file
sl@0: @param aSpiName the default spi name without any image id and extension
sl@0: 
sl@0: @code
sl@0: Example of use case:
sl@0: z:\private\10009d8f\ecom-0-0.spi	(ROM IMAGE 0)
sl@0: z:\private\10009d8f\ecom-0-1.s02	(ROM IMAGE 0)
sl@0: z:\private\10009d8f\ecom-1-0.spi	(ROM IMAGE 1)
sl@0: In this situation the function call to RResourceArchive should be:
sl@0: RResourceArchive::OpenL(RFs,_L("z:\\private\\10009d8f\\"),_L("ecom"));
sl@0: 
sl@0: Example of multiple spi files and the visibility of the resource files
sl@0: under two different language downgrade path(DGP):
sl@0: -------------------------------------------------------------------------------
sl@0:             |              |              |              |Resource  Visibility  
sl@0: Ecom-1-0.spi| Ecom-1-0.s02 | Ecom-2-0.spi | Ecom-2-0.s02 |DGP(1)   | DGP(2-1)
sl@0: -------------------------------------------------------------------------------
sl@0: A.RSC		|	A.R02	   |   B.RSC	  |  Hide D.R02  |A.RSC(1) | A.R02(1)
sl@0: B.RSC	    |	D.R02	   |			  |  C.R02       |B.RSC(2) | B.RSC(2)
sl@0: C.RSC       |              |              |              |C.RSC(1) | C.R02(2)
sl@0: -------------------------------------------------------------------------------
sl@0: @endcode
sl@0: 
sl@0: @leave KErrNotFound if there is no single file matching aSpiName in the path
sl@0:        KErrCorrupt if the spi file is corrupted
sl@0: @panic EBafPanicBadResourceFileFormat if the spi files that match the pattern
sl@0:        do not share a common spi type.
sl@0: */	
sl@0: EXPORT_C void RResourceArchive::OpenL(RFs& aFs,const TDesC& aSpiPath,const TDesC& aSpiName)
sl@0: 	{
sl@0: 	iArchiveImpl=CResourceArchiveImpl::NewL(aFs,aSpiPath,aSpiName);	
sl@0: 	}
sl@0: 
sl@0: /** Creates an instance of CResourceFile which corresponds to the next
sl@0: rsc file in the resource archive file(SPI)
sl@0: @param aRscFileName the rsc file name buffer passed in by client
sl@0: @return CResourceFile pointer of the next resource file in the SPI
sl@0: @return NULL if there is no more resource file to read from the SPI
sl@0: @leave KErrNoMemory if there is not enough memory for the object
sl@0: @panic If the file is corrupted - the method will panic in debug mode
sl@0: */
sl@0: EXPORT_C CResourceFile* RResourceArchive::NextL(HBufC*& aRscFileName)
sl@0: 	{
sl@0: 	return (iArchiveImpl->NextL(aRscFileName));
sl@0: 	}
sl@0: 	
sl@0: /** Reset the CResourceArchiveIter to start reading the first rsc file
sl@0: from the resourc archive(SPI) file 
sl@0: */
sl@0: EXPORT_C void RResourceArchive::Reset()
sl@0: 	{
sl@0: 	iArchiveImpl->Reset();
sl@0: 	}
sl@0: 
sl@0: /** Return the type of the resource archive(SPI) file being opened
sl@0: @return the TUid type of the resource archive(SPI) file
sl@0: */
sl@0: EXPORT_C TUid RResourceArchive::Type()
sl@0: 	{
sl@0: 	return iArchiveImpl->Type();
sl@0: 	}
sl@0: 	
sl@0: /** Look ahead in the resource archive to check whether there is 
sl@0: still any resource in the archive to be read
sl@0: @pre RResourceArchive::OpenL must be called beforehand
sl@0: @return boolean indicating whether the next resource exists
sl@0: */
sl@0: EXPORT_C TBool RResourceArchive::End()
sl@0: 	{
sl@0: 	return (!(iArchiveImpl->NextResourceExist()));
sl@0: 	}