sl@0: // Copyright (c) 2000-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 <e32std.h>
sl@0: #include <e32base.h>
sl@0: #include <f32file.h>
sl@0: #include <charconv.h>
sl@0: #include <bamdesca.h>
sl@0: #include <bautils.h>
sl@0: #include <barsc.h>
sl@0: #include <barsread.h>
sl@0: #include <baflpan.h>
sl@0: #include <banamedplugins.h>
sl@0: 
sl@0: // CBaNamedPlugins
sl@0: 
sl@0: EXPORT_C CBaNamedPlugins* CBaNamedPlugins::NewL(const CParameters& aParameters)
sl@0: /** Allocates and constructs a new list of plug-in names. The list is populated 
sl@0: using the CParameters object passed into the function. The CParameters object 
sl@0: can be destroyed once the CBaNamedPlugins object has been created.
sl@0: 
sl@0: @param aParameters The parameters for the list of plug-in names. 
sl@0: @return The new list of plug-in names. */
sl@0: 	{
sl@0: 	CBaNamedPlugins* const namedPlugIns=NewLC(aParameters);
sl@0: 	CleanupStack::Pop(namedPlugIns);
sl@0: 	return namedPlugIns;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CBaNamedPlugins* CBaNamedPlugins::NewLC(const CParameters& aParameters)
sl@0: /** Allocates and constructs a new list of plug-in names. The list is populated 
sl@0: using the CParameters object passed into the function. The list is left on 
sl@0: the cleanup stack. The CParameters object can be destroyed once the 
sl@0: CBaNamedPlugins object has been created.
sl@0: 
sl@0: @param aParameters The parameters for the list of plug-in names.
sl@0: @return The new list of plug-in names. */
sl@0: 	{
sl@0: 	CBaNamedPlugins* const namedPlugIns=new(ELeave) CBaNamedPlugins(Max(aParameters.iArrayOfResourceFiles->Count(), 1));
sl@0: 	CleanupStack::PushL(namedPlugIns);
sl@0: 	namedPlugIns->ConstructL(aParameters);
sl@0: 	return namedPlugIns;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CBaNamedPlugins::~CBaNamedPlugins()
sl@0: /** Destructor. Deletes all resources owned by the object prior to its 
sl@0: destruction. */
sl@0: 	{
sl@0: 	for (TInt i=iArrayOfNamedPlugIns.Count()-1; i>=0; --i)
sl@0: 		{
sl@0: 		delete iArrayOfNamedPlugIns[i].iName;
sl@0: 		delete iArrayOfNamedPlugIns[i].iIdentifier;
sl@0: 		}
sl@0: 	iArrayOfNamedPlugIns.Close();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CBaNamedPlugins::IndexOfUid(TUid aUid) const
sl@0: /** Gets the index into the sorted list (i.e. the index into the MDesCArray) of 
sl@0: the plug-in associated with the UID specified.
sl@0: 
sl@0: @param aUid A plug-in UID to search for. Its value must not be KNullUid or 
sl@0: a panic occurs.
sl@0: @return The index into the list of the plug-in with the UID specified, or 
sl@0: KErrNotFound if no plug-in has the specified UID. */
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(aUid.iUid!=KNullUid.iUid, Panic(EBafPanicNullUid));
sl@0: 	for (TInt i=iArrayOfNamedPlugIns.Count()-1; i>=0; --i)
sl@0: 		{
sl@0: 		if (iArrayOfNamedPlugIns[i].iUid.iUid==aUid.iUid)
sl@0: 			{
sl@0: 			return i;
sl@0: 			}
sl@0: 		}
sl@0: 	return KErrNotFound;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CBaNamedPlugins::IndexOfIdentifier(const TDesC& aIdentifier, TEquivalentIdentifiers aEquivalentIdentifiers) const
sl@0: /** Gets the index into the sorted list (i.e. the index into the MDesCArray) of 
sl@0: the plug-in associated with the identifier specified.
sl@0: 
sl@0: @param aIdentifier The plug-in identifier to search for.
sl@0: @param aEquivalentIdentifiers A function which tests whether two plug-in 
sl@0: identifiers are the same, returning true or false.
sl@0: @return The index into the list of the plug-in with the identifier specified, 
sl@0: or KErrNotFound if no plug-in has the specified identifier. */
sl@0: 	{
sl@0: 	for (TInt i=iArrayOfNamedPlugIns.Count()-1; i>=0; --i)
sl@0: 		{
sl@0: 		const TDesC* const identifier=iArrayOfNamedPlugIns[i].iIdentifier;
sl@0: 		if ((identifier!=NULL) && (*aEquivalentIdentifiers)(*identifier, aIdentifier))
sl@0: 			{
sl@0: 			return i;
sl@0: 			}
sl@0: 		}
sl@0: 	return KErrNotFound;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TUid CBaNamedPlugins::UidAtIndex(TInt aIndex) const
sl@0: /** Gets the UID of the plug-in at the specified index into the MDesCArray.
sl@0: 
sl@0: @param aIndex The index into the MDesCArray. Must be within the bounds of 
sl@0: the array, or a panic occurs.
sl@0: @return The UID of the plug-in at the specified index. */
sl@0: 	{
sl@0: 	return iArrayOfNamedPlugIns[aIndex].iUid;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C const TDesC* CBaNamedPlugins::IdentifierAtIndex(TInt aIndex) const
sl@0: /** Gets the identifier of the plug-in at the specified index into the MDesCArray.
sl@0: 
sl@0: @param aIndex The index into the MDesCArray. Must be within the bounds of 
sl@0: the array, or a panic occurs.
sl@0: @return The identifier of the plug-in at the specified index. */
sl@0: 	{
sl@0: 	return iArrayOfNamedPlugIns[aIndex].iIdentifier;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CBaNamedPlugins::MdcaCount() const
sl@0: /** Gets the number of plug-ins in the list.
sl@0: 
sl@0: @return The number of plug-ins in the list. */
sl@0: 	{
sl@0: 	return iArrayOfNamedPlugIns.Count();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TPtrC CBaNamedPlugins::MdcaPoint(TInt aIndex) const
sl@0: /** Returns a TPtrC for the name of the plug-in at the given index.
sl@0: 
sl@0: @param aIndex The index into the list. Must be within the bounds of the array, 
sl@0: or a panic occurs.
sl@0: @return The name of the plug-in at the given index. */
sl@0: 	{
sl@0: 	return *iArrayOfNamedPlugIns[aIndex].iName;
sl@0: 	}
sl@0: 
sl@0: CBaNamedPlugins::CBaNamedPlugins(TInt aGranularity)
sl@0: 	:iArrayOfNamedPlugIns(aGranularity)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: void CBaNamedPlugins::ConstructL(const CParameters& aParameters)
sl@0: 	{
sl@0: 	TFileName* const fileName=new(ELeave) TFileName;
sl@0: 	CleanupStack::PushL(fileName);
sl@0: 	RResourceFile resourceFile;
sl@0: 	CleanupClosePushL(resourceFile);
sl@0: 	const TCompareNames compareNames=(aParameters.iCompareNames!=NULL)? aParameters.iCompareNames: DefaultAlgorithmToCompareNames;
sl@0: 	for (TInt i=aParameters.iArrayOfResourceFiles->Count()-1; i>=0; --i)
sl@0: 		{
sl@0: 		const TResourceFile& resourceFileData=(*aParameters.iArrayOfResourceFiles)[i];
sl@0: 		*fileName=*resourceFileData.iFullFileName;
sl@0: 		BaflUtils::NearestLanguageFile(aParameters.iFileServerSession, *fileName);
sl@0: 		TNamedPlugIn namedPlugIn;
sl@0: 		namedPlugIn.iIdentifier=(resourceFileData.iIdentifier==NULL)? NULL: resourceFileData.iIdentifier->AllocLC();
sl@0: 		namedPlugIn.iUid=resourceFileData.iUid;
sl@0: 		namedPlugIn.iCompareNames=compareNames;
sl@0: 		if (!BaflUtils::FileExists(aParameters.iFileServerSession, *fileName))
sl@0: 			{
sl@0: 			if (aParameters.iFallBackName==NULL)
sl@0: 				{
sl@0: 				namedPlugIn.iName=TParsePtrC(*resourceFileData.iFullFileName).Name().AllocLC();
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				namedPlugIn.iName=aParameters.iFallBackName->FallBackNameL(*resourceFileData.iFullFileName);
sl@0: 				CleanupStack::PushL(namedPlugIn.iName);
sl@0: 				}
sl@0: 			User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
sl@0: 			CleanupStack::Pop(namedPlugIn.iName);
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			resourceFile.Close();
sl@0: 			resourceFile.OpenL(aParameters.iFileServerSession, *fileName);
sl@0: 			HBufC8* const resource=resourceFile.AllocReadLC(resourceFile.Offset()+2); // read the first resource after the RSS_SIGNATURE resource
sl@0: 			switch (resourceFileData.iFormat)
sl@0: 				{
sl@0: 			case TResourceFile::EFormatTbuf:
sl@0: 				{
sl@0: 				const TPtrC name(REINTERPRET_CAST(const TText*, resource->Ptr()), resource->Length()/sizeof(TText));
sl@0: 				if (name.Length()>0)
sl@0: 					{
sl@0: 					namedPlugIn.iName=name.AllocLC();
sl@0: 					User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
sl@0: 					CleanupStack::Pop(namedPlugIn.iName);
sl@0: 					}
sl@0: 				}
sl@0: 				break;
sl@0: 			case TResourceFile::EFormatArrayOfUidNamePairs:
sl@0: 				{
sl@0: 				TResourceReader resourceReader;
sl@0: 				resourceReader.SetBuffer(resource);
sl@0: 				for (TInt j=resourceReader.ReadUint16()-1; j>=0; --j)
sl@0: 					{
sl@0: 					namedPlugIn.iUid=TUid::Uid(resourceReader.ReadUint32());
sl@0: 					const TPtrC name(resourceReader.ReadTPtrC());
sl@0: 					if (name.Length()>0)
sl@0: 						{
sl@0: 						namedPlugIn.iName=name.AllocLC();
sl@0: 						User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
sl@0: 						CleanupStack::Pop(namedPlugIn.iName);
sl@0: 						}
sl@0: 					}
sl@0: 				}
sl@0: 				break;
sl@0: 			default:
sl@0: 				Panic(EBafPanicBadResourceFileFormat);
sl@0: 				break;
sl@0: 				}
sl@0: 			CleanupStack::PopAndDestroy(resource);
sl@0: 			}
sl@0: 		if (namedPlugIn.iIdentifier!=NULL)
sl@0: 			{
sl@0: 			CleanupStack::Pop(namedPlugIn.iIdentifier);
sl@0: 			}
sl@0: 		}
sl@0: 	CleanupStack::PopAndDestroy(2, fileName);
sl@0: 	iArrayOfNamedPlugIns.Sort(TLinearOrder<TNamedPlugIn>(CompareNamedPlugIns));
sl@0: 	if (aParameters.iTextForNone!=NULL)
sl@0: 		{
sl@0: 		TNamedPlugIn namedPlugIn;
sl@0: 		namedPlugIn.iName=aParameters.iTextForNone->AllocLC();
sl@0: 		namedPlugIn.iIdentifier=NULL;
sl@0: 		namedPlugIn.iUid=KNullUid;
sl@0: 		namedPlugIn.iCompareNames=NULL;
sl@0: 		switch (aParameters.iArrayPositionOfTextForNone)
sl@0: 			{
sl@0: 		case EArrayPositionFirst:
sl@0: 			User::LeaveIfError(iArrayOfNamedPlugIns.Insert(namedPlugIn, 0));
sl@0: 			break;
sl@0: 		case EArrayPositionLast:
sl@0: 			User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
sl@0: 			break;
sl@0: 		default:
sl@0: 			Panic(EBafPanicBadArrayPosition);
sl@0: 			break;
sl@0: 			}
sl@0: 		CleanupStack::Pop(namedPlugIn.iName);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: TInt CBaNamedPlugins::CompareNamedPlugIns(const TNamedPlugIn& aNamedPlugIn1, const TNamedPlugIn& aNamedPlugIn2)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG((aNamedPlugIn1.iCompareNames!=NULL) && (aNamedPlugIn1.iCompareNames==aNamedPlugIn2.iCompareNames), Panic(EBafPanicBadCompareNames));
sl@0: 	return (*aNamedPlugIn1.iCompareNames)(*aNamedPlugIn1.iName, *aNamedPlugIn2.iName);
sl@0: 	}
sl@0: 
sl@0: TInt CBaNamedPlugins::DefaultAlgorithmToCompareNames(const TDesC& aName1, const TDesC& aName2)
sl@0: 	{
sl@0: 	return aName1.CompareC(aName2);
sl@0: 	}
sl@0: 
sl@0: // CBaNamedPlugins::MFallBackName
sl@0: /**
sl@0: @internalAll
sl@0: */
sl@0: EXPORT_C void CBaNamedPlugins::MFallBackName::MFallBackName_Reserved_1()
sl@0: 	{
sl@0: 	}
sl@0: /**
sl@0: @internalAll
sl@0: */
sl@0: EXPORT_C void CBaNamedPlugins::MFallBackName::MFallBackName_Reserved_2()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: // CBaNamedPlugins::CParameters
sl@0: 
sl@0: EXPORT_C CBaNamedPlugins::CParameters* CBaNamedPlugins::CParameters::NewL(RFs& aFileServerSession, const TArray<TResourceFile>& aArrayOfResourceFiles)
sl@0: /** Allocates and constructs a new parameters object. 
sl@0: 	
sl@0: @param aFileServerSession A connected session with the file server. This is 
sl@0: required to search the file sytem for the localised resource files, and to 
sl@0: open them for reading.
sl@0: @param aArrayOfResourceFiles Array of TResourceFile objects. Each object 
sl@0: contains information about a single plug-in, if its iFormat attribute is set 
sl@0: to EFormatTbuf or potentially multiple plug-ins if its iFormat attribute is 
sl@0: set to EFormatArrayOfUidNamePairs. This information includes the filename of 
sl@0: its resource file. The CParameters object takes a copy of this array.
sl@0: @return The new parameters object. */
sl@0: 	{
sl@0: 	CParameters* const parameters=NewLC(aFileServerSession, aArrayOfResourceFiles);
sl@0: 	CleanupStack::Pop(parameters);
sl@0: 	return parameters;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CBaNamedPlugins::CParameters* CBaNamedPlugins::CParameters::NewLC(RFs& aFileServerSession, const TArray<TResourceFile>& aArrayOfResourceFiles)
sl@0: /** Allocates and constructs a new parameters object. The object is left on the 
sl@0: cleanup stack. 
sl@0: 
sl@0: @param aFileServerSession A connected session with the file server. This is 
sl@0: required to search the file sytem for the localised resource files and to 
sl@0: open them for reading.
sl@0: @param aArrayOfResourceFiles Array of TResourceFile objects. Each object 
sl@0: contains information about a single plug-in, if its iFormat attribute is set 
sl@0: to EFormatTbuf or potentially multiple plug-ins if its iFormat attribute is 
sl@0: set to EFormatArrayOfUidNamePairs. This information includes the filename of 
sl@0: its resource file. The CParameters object takes a copy of this array.
sl@0: @return The new parameters object. */
sl@0: 	{
sl@0: 	CParameters* const parameters=new(ELeave) CParameters(aFileServerSession);
sl@0: 	CleanupStack::PushL(parameters);
sl@0: 	parameters->ConstructL(aArrayOfResourceFiles);
sl@0: 	return parameters;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C CBaNamedPlugins::CParameters::~CParameters()
sl@0: /** Destructor. Deletes all resources owned by the object. */
sl@0: 	{
sl@0: 	delete iArrayOfResourceFiles;
sl@0: 	delete iTextForNone;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CBaNamedPlugins::CParameters::SetFallBackName(const MFallBackName& aFallBackName)
sl@0: /** Sets a function that generates a fallback name for plug-ins for which no 
sl@0: resource file could be found. If SetFallBackName() is not called, then by 
sl@0: default the fallback name used for plug-ins is simply the filename of the 
sl@0: resource file without the drive, directory path or extension. 
sl@0: 
sl@0: @param aFallBackName An instance of an MFallBackName-derived class. This should 
sl@0: implement a function which creates a name for plug-ins for which there is 
sl@0: no resource available (the "fallback" name). */
sl@0: 	{
sl@0: 	iFallBackName=&aFallBackName;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CBaNamedPlugins::CParameters::SetCompareNames(TCompareNames aCompareNames)
sl@0: /** Sets a function that compares two plug-in names for sorting. The plug-in 
sl@0: names list is sorted after it has been fully populated, using this algorithm. 
sl@0: If SetCompareNames() is not called, collation takes place by default using 
sl@0: TDesC::CompareC().
sl@0: 	
sl@0: @param aCompareNames A function that compares two plug-in names for sorting. */
sl@0: 	{
sl@0: 	iCompareNames=aCompareNames;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CBaNamedPlugins::CParameters::SetTextForNoneL(const TDesC& aTextForNone, TArrayPosition aArrayPositionOfTextForNone)
sl@0: /** Sets a text string, representing the choice of no plug-in and the array 
sl@0: position at which to insert it. This function increases the length of the 
sl@0: plug-in names list by one because it creates and adds an item to the array 
sl@0: which is empty except for the text string specified.
sl@0: 
sl@0: @param aTextForNone The string whose meaning is "none", i.e. no plug-in. It 
sl@0: is assumed that this descriptor has already been localised.
sl@0: @param aArrayPositionOfTextForNone Whether the string should be inserted at 
sl@0: the start or appended to the end of the array. */
sl@0: 	{
sl@0: 	HBufC* const textForNone=aTextForNone.AllocL();
sl@0: 	delete iTextForNone;
sl@0: 	iTextForNone=textForNone;
sl@0: 	iArrayPositionOfTextForNone=aArrayPositionOfTextForNone;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: EXPORT_C void CBaNamedPlugins::CParameters::SetTextForNone(HBufC* aTextForNone, TArrayPosition aArrayPositionOfTextForNone)
sl@0: /** Sets a text string, representing the choice of no plug-in and the array 
sl@0: position at which to insert it. This function increases the length of the 
sl@0: plug-in names list by one because it creates and adds an item to the array 
sl@0: which is empty except for the text string specified. The function cannot 
sl@0: leave because nothing is allocated ownership of aTextForNone is passed to 
sl@0: the CParameters object. 
sl@0: 
sl@0: @param aTextForNone The string whose meaning is "none", i.e. no plug-in. It 
sl@0: is assumed that this descriptor has already been localised.
sl@0: @param aArrayPositionOfTextForNone Whether the string should be inserted at 
sl@0: the start or appended to the end of the array. */
sl@0: 	{
sl@0: 	delete iTextForNone;
sl@0: 	iTextForNone=aTextForNone;
sl@0: 	iArrayPositionOfTextForNone=aArrayPositionOfTextForNone;
sl@0: 	}
sl@0: 
sl@0: CBaNamedPlugins::CParameters::CParameters(RFs& aFileServerSession)
sl@0: 	:iFileServerSession(aFileServerSession),
sl@0: 	 iArrayOfResourceFiles(NULL),
sl@0: 	 iFallBackName(NULL),
sl@0: 	 iCompareNames(NULL),
sl@0: 	 iTextForNone(NULL),
sl@0: 	 iArrayPositionOfTextForNone(STATIC_CAST(TArrayPosition, -1))
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: void CBaNamedPlugins::CParameters::ConstructL(const TArray<TResourceFile>& aArrayOfResourceFiles)
sl@0: 	{
sl@0: 	iArrayOfResourceFiles=new(ELeave) TArray<TResourceFile>(aArrayOfResourceFiles);
sl@0: 	}
sl@0: