1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/src/BANAMEDPLUGINS.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,401 @@
1.4 +// Copyright (c) 2000-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 <e32std.h>
1.20 +#include <e32base.h>
1.21 +#include <f32file.h>
1.22 +#include <charconv.h>
1.23 +#include <bamdesca.h>
1.24 +#include <bautils.h>
1.25 +#include <barsc.h>
1.26 +#include <barsread.h>
1.27 +#include <baflpan.h>
1.28 +#include <banamedplugins.h>
1.29 +
1.30 +// CBaNamedPlugins
1.31 +
1.32 +EXPORT_C CBaNamedPlugins* CBaNamedPlugins::NewL(const CParameters& aParameters)
1.33 +/** Allocates and constructs a new list of plug-in names. The list is populated
1.34 +using the CParameters object passed into the function. The CParameters object
1.35 +can be destroyed once the CBaNamedPlugins object has been created.
1.36 +
1.37 +@param aParameters The parameters for the list of plug-in names.
1.38 +@return The new list of plug-in names. */
1.39 + {
1.40 + CBaNamedPlugins* const namedPlugIns=NewLC(aParameters);
1.41 + CleanupStack::Pop(namedPlugIns);
1.42 + return namedPlugIns;
1.43 + }
1.44 +
1.45 +EXPORT_C CBaNamedPlugins* CBaNamedPlugins::NewLC(const CParameters& aParameters)
1.46 +/** Allocates and constructs a new list of plug-in names. The list is populated
1.47 +using the CParameters object passed into the function. The list is left on
1.48 +the cleanup stack. The CParameters object can be destroyed once the
1.49 +CBaNamedPlugins object has been created.
1.50 +
1.51 +@param aParameters The parameters for the list of plug-in names.
1.52 +@return The new list of plug-in names. */
1.53 + {
1.54 + CBaNamedPlugins* const namedPlugIns=new(ELeave) CBaNamedPlugins(Max(aParameters.iArrayOfResourceFiles->Count(), 1));
1.55 + CleanupStack::PushL(namedPlugIns);
1.56 + namedPlugIns->ConstructL(aParameters);
1.57 + return namedPlugIns;
1.58 + }
1.59 +
1.60 +EXPORT_C CBaNamedPlugins::~CBaNamedPlugins()
1.61 +/** Destructor. Deletes all resources owned by the object prior to its
1.62 +destruction. */
1.63 + {
1.64 + for (TInt i=iArrayOfNamedPlugIns.Count()-1; i>=0; --i)
1.65 + {
1.66 + delete iArrayOfNamedPlugIns[i].iName;
1.67 + delete iArrayOfNamedPlugIns[i].iIdentifier;
1.68 + }
1.69 + iArrayOfNamedPlugIns.Close();
1.70 + }
1.71 +
1.72 +EXPORT_C TInt CBaNamedPlugins::IndexOfUid(TUid aUid) const
1.73 +/** Gets the index into the sorted list (i.e. the index into the MDesCArray) of
1.74 +the plug-in associated with the UID specified.
1.75 +
1.76 +@param aUid A plug-in UID to search for. Its value must not be KNullUid or
1.77 +a panic occurs.
1.78 +@return The index into the list of the plug-in with the UID specified, or
1.79 +KErrNotFound if no plug-in has the specified UID. */
1.80 + {
1.81 + __ASSERT_ALWAYS(aUid.iUid!=KNullUid.iUid, Panic(EBafPanicNullUid));
1.82 + for (TInt i=iArrayOfNamedPlugIns.Count()-1; i>=0; --i)
1.83 + {
1.84 + if (iArrayOfNamedPlugIns[i].iUid.iUid==aUid.iUid)
1.85 + {
1.86 + return i;
1.87 + }
1.88 + }
1.89 + return KErrNotFound;
1.90 + }
1.91 +
1.92 +EXPORT_C TInt CBaNamedPlugins::IndexOfIdentifier(const TDesC& aIdentifier, TEquivalentIdentifiers aEquivalentIdentifiers) const
1.93 +/** Gets the index into the sorted list (i.e. the index into the MDesCArray) of
1.94 +the plug-in associated with the identifier specified.
1.95 +
1.96 +@param aIdentifier The plug-in identifier to search for.
1.97 +@param aEquivalentIdentifiers A function which tests whether two plug-in
1.98 +identifiers are the same, returning true or false.
1.99 +@return The index into the list of the plug-in with the identifier specified,
1.100 +or KErrNotFound if no plug-in has the specified identifier. */
1.101 + {
1.102 + for (TInt i=iArrayOfNamedPlugIns.Count()-1; i>=0; --i)
1.103 + {
1.104 + const TDesC* const identifier=iArrayOfNamedPlugIns[i].iIdentifier;
1.105 + if ((identifier!=NULL) && (*aEquivalentIdentifiers)(*identifier, aIdentifier))
1.106 + {
1.107 + return i;
1.108 + }
1.109 + }
1.110 + return KErrNotFound;
1.111 + }
1.112 +
1.113 +EXPORT_C TUid CBaNamedPlugins::UidAtIndex(TInt aIndex) const
1.114 +/** Gets the UID of the plug-in at the specified index into the MDesCArray.
1.115 +
1.116 +@param aIndex The index into the MDesCArray. Must be within the bounds of
1.117 +the array, or a panic occurs.
1.118 +@return The UID of the plug-in at the specified index. */
1.119 + {
1.120 + return iArrayOfNamedPlugIns[aIndex].iUid;
1.121 + }
1.122 +
1.123 +EXPORT_C const TDesC* CBaNamedPlugins::IdentifierAtIndex(TInt aIndex) const
1.124 +/** Gets the identifier of the plug-in at the specified index into the MDesCArray.
1.125 +
1.126 +@param aIndex The index into the MDesCArray. Must be within the bounds of
1.127 +the array, or a panic occurs.
1.128 +@return The identifier of the plug-in at the specified index. */
1.129 + {
1.130 + return iArrayOfNamedPlugIns[aIndex].iIdentifier;
1.131 + }
1.132 +
1.133 +EXPORT_C TInt CBaNamedPlugins::MdcaCount() const
1.134 +/** Gets the number of plug-ins in the list.
1.135 +
1.136 +@return The number of plug-ins in the list. */
1.137 + {
1.138 + return iArrayOfNamedPlugIns.Count();
1.139 + }
1.140 +
1.141 +EXPORT_C TPtrC CBaNamedPlugins::MdcaPoint(TInt aIndex) const
1.142 +/** Returns a TPtrC for the name of the plug-in at the given index.
1.143 +
1.144 +@param aIndex The index into the list. Must be within the bounds of the array,
1.145 +or a panic occurs.
1.146 +@return The name of the plug-in at the given index. */
1.147 + {
1.148 + return *iArrayOfNamedPlugIns[aIndex].iName;
1.149 + }
1.150 +
1.151 +CBaNamedPlugins::CBaNamedPlugins(TInt aGranularity)
1.152 + :iArrayOfNamedPlugIns(aGranularity)
1.153 + {
1.154 + }
1.155 +
1.156 +void CBaNamedPlugins::ConstructL(const CParameters& aParameters)
1.157 + {
1.158 + TFileName* const fileName=new(ELeave) TFileName;
1.159 + CleanupStack::PushL(fileName);
1.160 + RResourceFile resourceFile;
1.161 + CleanupClosePushL(resourceFile);
1.162 + const TCompareNames compareNames=(aParameters.iCompareNames!=NULL)? aParameters.iCompareNames: DefaultAlgorithmToCompareNames;
1.163 + for (TInt i=aParameters.iArrayOfResourceFiles->Count()-1; i>=0; --i)
1.164 + {
1.165 + const TResourceFile& resourceFileData=(*aParameters.iArrayOfResourceFiles)[i];
1.166 + *fileName=*resourceFileData.iFullFileName;
1.167 + BaflUtils::NearestLanguageFile(aParameters.iFileServerSession, *fileName);
1.168 + TNamedPlugIn namedPlugIn;
1.169 + namedPlugIn.iIdentifier=(resourceFileData.iIdentifier==NULL)? NULL: resourceFileData.iIdentifier->AllocLC();
1.170 + namedPlugIn.iUid=resourceFileData.iUid;
1.171 + namedPlugIn.iCompareNames=compareNames;
1.172 + if (!BaflUtils::FileExists(aParameters.iFileServerSession, *fileName))
1.173 + {
1.174 + if (aParameters.iFallBackName==NULL)
1.175 + {
1.176 + namedPlugIn.iName=TParsePtrC(*resourceFileData.iFullFileName).Name().AllocLC();
1.177 + }
1.178 + else
1.179 + {
1.180 + namedPlugIn.iName=aParameters.iFallBackName->FallBackNameL(*resourceFileData.iFullFileName);
1.181 + CleanupStack::PushL(namedPlugIn.iName);
1.182 + }
1.183 + User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
1.184 + CleanupStack::Pop(namedPlugIn.iName);
1.185 + }
1.186 + else
1.187 + {
1.188 + resourceFile.Close();
1.189 + resourceFile.OpenL(aParameters.iFileServerSession, *fileName);
1.190 + HBufC8* const resource=resourceFile.AllocReadLC(resourceFile.Offset()+2); // read the first resource after the RSS_SIGNATURE resource
1.191 + switch (resourceFileData.iFormat)
1.192 + {
1.193 + case TResourceFile::EFormatTbuf:
1.194 + {
1.195 + const TPtrC name(REINTERPRET_CAST(const TText*, resource->Ptr()), resource->Length()/sizeof(TText));
1.196 + if (name.Length()>0)
1.197 + {
1.198 + namedPlugIn.iName=name.AllocLC();
1.199 + User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
1.200 + CleanupStack::Pop(namedPlugIn.iName);
1.201 + }
1.202 + }
1.203 + break;
1.204 + case TResourceFile::EFormatArrayOfUidNamePairs:
1.205 + {
1.206 + TResourceReader resourceReader;
1.207 + resourceReader.SetBuffer(resource);
1.208 + for (TInt j=resourceReader.ReadUint16()-1; j>=0; --j)
1.209 + {
1.210 + namedPlugIn.iUid=TUid::Uid(resourceReader.ReadUint32());
1.211 + const TPtrC name(resourceReader.ReadTPtrC());
1.212 + if (name.Length()>0)
1.213 + {
1.214 + namedPlugIn.iName=name.AllocLC();
1.215 + User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
1.216 + CleanupStack::Pop(namedPlugIn.iName);
1.217 + }
1.218 + }
1.219 + }
1.220 + break;
1.221 + default:
1.222 + Panic(EBafPanicBadResourceFileFormat);
1.223 + break;
1.224 + }
1.225 + CleanupStack::PopAndDestroy(resource);
1.226 + }
1.227 + if (namedPlugIn.iIdentifier!=NULL)
1.228 + {
1.229 + CleanupStack::Pop(namedPlugIn.iIdentifier);
1.230 + }
1.231 + }
1.232 + CleanupStack::PopAndDestroy(2, fileName);
1.233 + iArrayOfNamedPlugIns.Sort(TLinearOrder<TNamedPlugIn>(CompareNamedPlugIns));
1.234 + if (aParameters.iTextForNone!=NULL)
1.235 + {
1.236 + TNamedPlugIn namedPlugIn;
1.237 + namedPlugIn.iName=aParameters.iTextForNone->AllocLC();
1.238 + namedPlugIn.iIdentifier=NULL;
1.239 + namedPlugIn.iUid=KNullUid;
1.240 + namedPlugIn.iCompareNames=NULL;
1.241 + switch (aParameters.iArrayPositionOfTextForNone)
1.242 + {
1.243 + case EArrayPositionFirst:
1.244 + User::LeaveIfError(iArrayOfNamedPlugIns.Insert(namedPlugIn, 0));
1.245 + break;
1.246 + case EArrayPositionLast:
1.247 + User::LeaveIfError(iArrayOfNamedPlugIns.Append(namedPlugIn));
1.248 + break;
1.249 + default:
1.250 + Panic(EBafPanicBadArrayPosition);
1.251 + break;
1.252 + }
1.253 + CleanupStack::Pop(namedPlugIn.iName);
1.254 + }
1.255 + }
1.256 +
1.257 +TInt CBaNamedPlugins::CompareNamedPlugIns(const TNamedPlugIn& aNamedPlugIn1, const TNamedPlugIn& aNamedPlugIn2)
1.258 + {
1.259 + __ASSERT_DEBUG((aNamedPlugIn1.iCompareNames!=NULL) && (aNamedPlugIn1.iCompareNames==aNamedPlugIn2.iCompareNames), Panic(EBafPanicBadCompareNames));
1.260 + return (*aNamedPlugIn1.iCompareNames)(*aNamedPlugIn1.iName, *aNamedPlugIn2.iName);
1.261 + }
1.262 +
1.263 +TInt CBaNamedPlugins::DefaultAlgorithmToCompareNames(const TDesC& aName1, const TDesC& aName2)
1.264 + {
1.265 + return aName1.CompareC(aName2);
1.266 + }
1.267 +
1.268 +// CBaNamedPlugins::MFallBackName
1.269 +/**
1.270 +@internalAll
1.271 +*/
1.272 +EXPORT_C void CBaNamedPlugins::MFallBackName::MFallBackName_Reserved_1()
1.273 + {
1.274 + }
1.275 +/**
1.276 +@internalAll
1.277 +*/
1.278 +EXPORT_C void CBaNamedPlugins::MFallBackName::MFallBackName_Reserved_2()
1.279 + {
1.280 + }
1.281 +
1.282 +// CBaNamedPlugins::CParameters
1.283 +
1.284 +EXPORT_C CBaNamedPlugins::CParameters* CBaNamedPlugins::CParameters::NewL(RFs& aFileServerSession, const TArray<TResourceFile>& aArrayOfResourceFiles)
1.285 +/** Allocates and constructs a new parameters object.
1.286 +
1.287 +@param aFileServerSession A connected session with the file server. This is
1.288 +required to search the file sytem for the localised resource files, and to
1.289 +open them for reading.
1.290 +@param aArrayOfResourceFiles Array of TResourceFile objects. Each object
1.291 +contains information about a single plug-in, if its iFormat attribute is set
1.292 +to EFormatTbuf or potentially multiple plug-ins if its iFormat attribute is
1.293 +set to EFormatArrayOfUidNamePairs. This information includes the filename of
1.294 +its resource file. The CParameters object takes a copy of this array.
1.295 +@return The new parameters object. */
1.296 + {
1.297 + CParameters* const parameters=NewLC(aFileServerSession, aArrayOfResourceFiles);
1.298 + CleanupStack::Pop(parameters);
1.299 + return parameters;
1.300 + }
1.301 +
1.302 +EXPORT_C CBaNamedPlugins::CParameters* CBaNamedPlugins::CParameters::NewLC(RFs& aFileServerSession, const TArray<TResourceFile>& aArrayOfResourceFiles)
1.303 +/** Allocates and constructs a new parameters object. The object is left on the
1.304 +cleanup stack.
1.305 +
1.306 +@param aFileServerSession A connected session with the file server. This is
1.307 +required to search the file sytem for the localised resource files and to
1.308 +open them for reading.
1.309 +@param aArrayOfResourceFiles Array of TResourceFile objects. Each object
1.310 +contains information about a single plug-in, if its iFormat attribute is set
1.311 +to EFormatTbuf or potentially multiple plug-ins if its iFormat attribute is
1.312 +set to EFormatArrayOfUidNamePairs. This information includes the filename of
1.313 +its resource file. The CParameters object takes a copy of this array.
1.314 +@return The new parameters object. */
1.315 + {
1.316 + CParameters* const parameters=new(ELeave) CParameters(aFileServerSession);
1.317 + CleanupStack::PushL(parameters);
1.318 + parameters->ConstructL(aArrayOfResourceFiles);
1.319 + return parameters;
1.320 + }
1.321 +
1.322 +
1.323 +EXPORT_C CBaNamedPlugins::CParameters::~CParameters()
1.324 +/** Destructor. Deletes all resources owned by the object. */
1.325 + {
1.326 + delete iArrayOfResourceFiles;
1.327 + delete iTextForNone;
1.328 + }
1.329 +
1.330 +EXPORT_C void CBaNamedPlugins::CParameters::SetFallBackName(const MFallBackName& aFallBackName)
1.331 +/** Sets a function that generates a fallback name for plug-ins for which no
1.332 +resource file could be found. If SetFallBackName() is not called, then by
1.333 +default the fallback name used for plug-ins is simply the filename of the
1.334 +resource file without the drive, directory path or extension.
1.335 +
1.336 +@param aFallBackName An instance of an MFallBackName-derived class. This should
1.337 +implement a function which creates a name for plug-ins for which there is
1.338 +no resource available (the "fallback" name). */
1.339 + {
1.340 + iFallBackName=&aFallBackName;
1.341 + }
1.342 +
1.343 +EXPORT_C void CBaNamedPlugins::CParameters::SetCompareNames(TCompareNames aCompareNames)
1.344 +/** Sets a function that compares two plug-in names for sorting. The plug-in
1.345 +names list is sorted after it has been fully populated, using this algorithm.
1.346 +If SetCompareNames() is not called, collation takes place by default using
1.347 +TDesC::CompareC().
1.348 +
1.349 +@param aCompareNames A function that compares two plug-in names for sorting. */
1.350 + {
1.351 + iCompareNames=aCompareNames;
1.352 + }
1.353 +
1.354 +EXPORT_C void CBaNamedPlugins::CParameters::SetTextForNoneL(const TDesC& aTextForNone, TArrayPosition aArrayPositionOfTextForNone)
1.355 +/** Sets a text string, representing the choice of no plug-in and the array
1.356 +position at which to insert it. This function increases the length of the
1.357 +plug-in names list by one because it creates and adds an item to the array
1.358 +which is empty except for the text string specified.
1.359 +
1.360 +@param aTextForNone The string whose meaning is "none", i.e. no plug-in. It
1.361 +is assumed that this descriptor has already been localised.
1.362 +@param aArrayPositionOfTextForNone Whether the string should be inserted at
1.363 +the start or appended to the end of the array. */
1.364 + {
1.365 + HBufC* const textForNone=aTextForNone.AllocL();
1.366 + delete iTextForNone;
1.367 + iTextForNone=textForNone;
1.368 + iArrayPositionOfTextForNone=aArrayPositionOfTextForNone;
1.369 + }
1.370 +
1.371 +
1.372 +EXPORT_C void CBaNamedPlugins::CParameters::SetTextForNone(HBufC* aTextForNone, TArrayPosition aArrayPositionOfTextForNone)
1.373 +/** Sets a text string, representing the choice of no plug-in and the array
1.374 +position at which to insert it. This function increases the length of the
1.375 +plug-in names list by one because it creates and adds an item to the array
1.376 +which is empty except for the text string specified. The function cannot
1.377 +leave because nothing is allocated ownership of aTextForNone is passed to
1.378 +the CParameters object.
1.379 +
1.380 +@param aTextForNone The string whose meaning is "none", i.e. no plug-in. It
1.381 +is assumed that this descriptor has already been localised.
1.382 +@param aArrayPositionOfTextForNone Whether the string should be inserted at
1.383 +the start or appended to the end of the array. */
1.384 + {
1.385 + delete iTextForNone;
1.386 + iTextForNone=aTextForNone;
1.387 + iArrayPositionOfTextForNone=aArrayPositionOfTextForNone;
1.388 + }
1.389 +
1.390 +CBaNamedPlugins::CParameters::CParameters(RFs& aFileServerSession)
1.391 + :iFileServerSession(aFileServerSession),
1.392 + iArrayOfResourceFiles(NULL),
1.393 + iFallBackName(NULL),
1.394 + iCompareNames(NULL),
1.395 + iTextForNone(NULL),
1.396 + iArrayPositionOfTextForNone(STATIC_CAST(TArrayPosition, -1))
1.397 + {
1.398 + }
1.399 +
1.400 +void CBaNamedPlugins::CParameters::ConstructL(const TArray<TResourceFile>& aArrayOfResourceFiles)
1.401 + {
1.402 + iArrayOfResourceFiles=new(ELeave) TArray<TResourceFile>(aArrayOfResourceFiles);
1.403 + }
1.404 +