1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/bsul/src/IniTemplate.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,1253 @@
1.4 +// Copyright (c) 2005-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 +// @internalComponent
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef __INITEMPLATE_H__
1.22 +#define __INITEMPLATE_H__
1.23 +
1.24 +#include <e32base.h>
1.25 +#include <e32std.h>
1.26 +#include <f32file.h>
1.27 +#include <s32file.h>
1.28 +#include <e32des16.h>
1.29 +
1.30 +namespace BSUL
1.31 +{
1.32 +//Line Type enumeration //
1.33 +enum TLineType
1.34 + {
1.35 + EComment,
1.36 + ESection,
1.37 + EKeyValue
1.38 + };
1.39 +
1.40 +//utils template class//
1.41 +static void GetBufferL(RFs& aFs,const TDesC& aFileName,HBufC8*& aBufferPtr)
1.42 + {
1.43 + //open the file for reading
1.44 + RFile file;
1.45 + User::LeaveIfError(file.Open(aFs,aFileName,EFileShareReadersOnly));
1.46 +
1.47 + //only process the file if it exists
1.48 + TInt filesize;
1.49 + CleanupClosePushL(file);
1.50 + User::LeaveIfError(file.Size(filesize));
1.51 + aBufferPtr=HBufC8::NewLC(filesize + 2); //In case '\r\n' needs to be appended
1.52 + TPtr8 asWritableBuffer(aBufferPtr->Des());
1.53 + User::LeaveIfError(file.Read(0,asWritableBuffer,filesize));
1.54 +
1.55 + //check if '\n' is present
1.56 + if( filesize > 0 && asWritableBuffer[filesize - 1] != '\n' )
1.57 + {
1.58 + asWritableBuffer.Append(_L8("\r\n"));
1.59 + }
1.60 + //pop the buffer
1.61 + CleanupStack::Pop();
1.62 + //close the file
1.63 + CleanupStack::PopAndDestroy();
1.64 + }
1.65 +
1.66 +template <class TLexX>
1.67 +TBool IsEosAfterSpace(TLexX& aLex)
1.68 + {
1.69 + aLex.SkipSpace();
1.70 + return (aLex.Eos());
1.71 + }
1.72 +
1.73 +template<class TPtrCX>
1.74 +void RemoveComment(TPtrCX& aLine)
1.75 + {
1.76 + //Trim anything on the rhs of any inline comment ';' or '#'
1.77 + //in this case we need to locate which is the first occuring from left
1.78 + TInt semiColon=aLine.Locate(';');
1.79 + TInt hash=aLine.Locate('#');
1.80 + if (semiColon!=KErrNotFound || hash!=KErrNotFound)
1.81 + {
1.82 + if (semiColon!=KErrNotFound && hash!=KErrNotFound)
1.83 + {
1.84 + aLine.Set(aLine.Left(semiColon<hash?semiColon:hash));
1.85 + }
1.86 + else
1.87 + {
1.88 + aLine.Set(aLine.Left(semiColon!=KErrNotFound?semiColon:hash));
1.89 + }
1.90 + }
1.91 + }
1.92 +
1.93 +template <class TPtrCX,class TLexX>
1.94 +void RemoveWSBeforeAndAfter(const TPtrCX& aString,TPtrCX& aOutput)
1.95 + {
1.96 + TLexX parser(aString);
1.97 + parser.SkipSpaceAndMark();
1.98 + TInt offset=parser.Offset();
1.99 + while(!parser.Eos())
1.100 + {
1.101 + //now skip for whitespace and check end of string
1.102 + //if this is eos we are done unget to mark and break
1.103 + parser.SkipCharacters();
1.104 + parser.Mark();
1.105 + if (IsEosAfterSpace(parser))
1.106 + {
1.107 + parser.UnGetToMark();
1.108 + break;
1.109 + }
1.110 + }
1.111 + TInt endOffset=parser.MarkedOffset();
1.112 + aOutput.Set(aString.Mid(offset,endOffset-offset));
1.113 + }
1.114 +
1.115 +template<class TPtrCX,class TLexX>
1.116 +TInt CountTokens(TPtrCX aLine)
1.117 + {
1.118 + TLexX myLexer(aLine);
1.119 + TInt tokenCount=0;
1.120 + while (!myLexer.Eos())
1.121 + {
1.122 + TPtrCX next = myLexer.NextToken();
1.123 + if (next.Size())
1.124 + {
1.125 + tokenCount++;
1.126 + }
1.127 + }
1.128 + return tokenCount;
1.129 + }
1.130 +
1.131 +static void CorruptIfL(TBool aIsCorrupt)
1.132 + {
1.133 + if (aIsCorrupt)
1.134 + {
1.135 + User::Leave(KErrCorrupt);
1.136 + }
1.137 + }
1.138 +
1.139 +template<class HBufCX, class TPtrCX>
1.140 +TPtrCX ExtractLineFromBuffer(const TPtrCX& aFileBuffer, TInt aStartOffset)
1.141 + {
1.142 + TChar delim('\n');
1.143 + TPtrCX partialLine = aFileBuffer.Mid(aStartOffset, aFileBuffer.Length()- aStartOffset);
1.144 + TInt delimOffset= partialLine.Locate(delim);
1.145 + if (delimOffset==KErrNotFound)
1.146 + {
1.147 + return partialLine;
1.148 + }
1.149 + return partialLine.Left(delimOffset+1);
1.150 + }
1.151 +
1.152 +//ini line template class //
1.153 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.154 +NONSHARABLE_CLASS(CIniLine) : public CBase
1.155 +{
1.156 +public:
1.157 + static CIniLine* NewL(const TDesCX& aLine);
1.158 + static CIniLine* NewLC(const TDesCX& aLine);
1.159 + static CIniLine* NewLC(HBufCX* aLine, TLineType aTypeOfLine);
1.160 + static CIniLine* NewFromSectionNameLC(const TDesCX& aSectionName);
1.161 + static CIniLine* NewFromKeyValueLineLC(const TDesCX& aKeyName, const TDesCX& aKeyValue);
1.162 +
1.163 + ~CIniLine();
1.164 + TLineType LineType() const;
1.165 + void InsertBefore(CIniLine* aLine);
1.166 + const HBufCX& LineBuffer() const;
1.167 + TBool operator==(const CIniLine&) const;
1.168 +public:
1.169 + TDblQueLink iLink;
1.170 +private:
1.171 + TLineType DetermineTypeOfLine(const TDesCX& aLine);
1.172 + void ConstructL(const TDesCX& aLine);
1.173 + CIniLine(HBufCX* aLine, TLineType aLineType);
1.174 + CIniLine();
1.175 +private:
1.176 + HBufCX* iLine;
1.177 + TLineType iLineType;
1.178 +};
1.179 +
1.180 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.181 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>* CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::NewL(const TDesCX& aLine)
1.182 + {
1.183 + CIniLine* self=CIniLine::NewLC(aLine);
1.184 + CleanupStack::Pop(self);
1.185 + return self;
1.186 + }
1.187 +
1.188 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.189 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>* CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::NewLC(const TDesCX& aLine)
1.190 + {
1.191 + CIniLine* self=new (ELeave) CIniLine();
1.192 + CleanupStack::PushL(self);
1.193 + self->ConstructL(aLine);
1.194 + return self;
1.195 + }
1.196 +
1.197 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.198 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>* CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::NewLC(HBufCX* aLine, TLineType aTypeOfLine)
1.199 + {
1.200 + CIniLine* self=new (ELeave) CIniLine(aLine, aTypeOfLine);
1.201 + CleanupStack::PushL(self);
1.202 + return self;
1.203 + }
1.204 +
1.205 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.206 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::CIniLine(HBufCX* aLine, TLineType aTypeOfLine):iLine(aLine), iLineType(aTypeOfLine)
1.207 + {}
1.208 +
1.209 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.210 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::CIniLine()
1.211 + {}
1.212 +
1.213 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.214 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::~CIniLine()
1.215 + {
1.216 + iLink.Deque();
1.217 + delete iLine;
1.218 + }
1.219 +
1.220 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.221 +void CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::ConstructL(const TDesCX& aLine)
1.222 + {
1.223 + HBufCX* myHBuf = aLine.AllocL();
1.224 + this->iLine = myHBuf;
1.225 + this->iLineType = this->DetermineTypeOfLine(aLine);
1.226 + }
1.227 +
1.228 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.229 +TLineType CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::DetermineTypeOfLine(const TDesCX& aLine)
1.230 + {
1.231 + // First recognized character wins. Otherwise return a comment.
1.232 + for (TInt i=0; i< aLine.Length();i++)
1.233 + {
1.234 + TText myChar = aLine[i];
1.235 + switch (myChar)
1.236 + {
1.237 + case TText('#'):
1.238 + case ';':
1.239 + return EComment;
1.240 +
1.241 + case TText('['):
1.242 + return ESection;
1.243 +
1.244 + case TText('='):
1.245 + return EKeyValue;
1.246 +
1.247 + default:
1.248 + break;
1.249 + }
1.250 + }
1.251 + return EComment;
1.252 + }
1.253 +
1.254 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.255 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>* CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::NewFromSectionNameLC(const TDesCX& aSectionName)
1.256 + {
1.257 + //Fabricate a section name.
1.258 + HBufCX* myBuffer=HBufCX::NewLC(aSectionName.Size()+ 6); //6= "2 cr's and \r" + "[]".
1.259 + TPtrX myBuf (myBuffer->Des());
1.260 + myBuf.Append(_L("\r\n["));
1.261 + myBuf.Append(aSectionName);
1.262 + myBuf.Append(_L("]\r\n"));
1.263 + CIniLine* myLine = CIniLine::NewLC(myBuffer, ESection);
1.264 + CleanupStack::Pop(2);
1.265 + CleanupStack::PushL(myLine);
1.266 + return myLine;
1.267 + }
1.268 +
1.269 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.270 +CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>* CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::NewFromKeyValueLineLC(const TDesCX& aKeyName, const TDesCX& aKeyValue)
1.271 + {
1.272 + //Fabricate a key = value line.
1.273 + HBufCX* myBuffer=HBufCX::NewLC(aKeyName.Size()+ aKeyValue.Size() + 3); //3= "1 cr + \r" + "=".
1.274 + TPtrX myBuf (myBuffer->Des());
1.275 + myBuf.Set(myBuffer->Des());
1.276 + myBuf.Append(aKeyName);
1.277 + myBuf.Append('=');
1.278 + myBuf.Append(aKeyValue);
1.279 + myBuf.Append(_L("\r\n"));
1.280 + CIniLine* myLine = CIniLine::NewLC(myBuffer, EKeyValue);
1.281 + CleanupStack::Pop(2);
1.282 + CleanupStack::PushL(myLine);
1.283 + return myLine;
1.284 + }
1.285 +
1.286 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.287 +TLineType CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::LineType() const
1.288 + {
1.289 + return iLineType;
1.290 + }
1.291 +
1.292 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.293 +void CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::InsertBefore(CIniLine* aLine)
1.294 + {
1.295 + aLine->iLink.AddBefore(&(this->iLink));
1.296 + }
1.297 +
1.298 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.299 +const HBufCX& CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::LineBuffer() const
1.300 + {
1.301 + return *iLine;
1.302 + }
1.303 +
1.304 +template<class TDesCX,class HBufCX,class TPtrCX, class TPtrX>
1.305 +TBool CIniLine<TDesCX,HBufCX,TPtrCX,TPtrX>::operator==(const CIniLine& aLine)const
1.306 + {
1.307 + if (LineType() != aLine.LineType())
1.308 + return EFalse;
1.309 +
1.310 + if ((LineBuffer()).Compare(aLine.LineBuffer()) != 0)
1.311 + return EFalse;
1.312 + return ETrue;
1.313 + }
1.314 +
1.315 +//ini key template class//
1.316 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX, class TPtrX,class TLexX>
1.317 +NONSHARABLE_CLASS(CIniKey): public CBase
1.318 +{
1.319 +public:
1.320 + static CIniKey* NewL(const TDesCX& aKeyName,const TDesCX& aKeyValue);
1.321 + static CIniKey* NewLC(const TDesCX& aKeyName,const TDesCX& aKeyValue);
1.322 + static CIniKey* NewLC(CIniLineX* aLine);
1.323 + static TInt CompareKey(const CIniKey& aFirstKey,const CIniKey& aSecondKey);
1.324 +
1.325 + void SetKeyValue(const TDesCX& aKeyValue);
1.326 + TPtrCX KeyName() const;
1.327 + TPtrCX KeyValue() const;
1.328 + CIniLineX* LineSrc() const;
1.329 + ~CIniKey();
1.330 +private:
1.331 + CIniKey(const TDesCX& aKeyName, const TDesCX& aKeyValue, CIniLineX* aLine);
1.332 + CIniKey(const TDesCX& aKeyName, const TDesCX& aKeyValue);
1.333 + static CIniKey* ParseKeyLineL(CIniLineX* aLine);
1.334 +private:
1.335 + TPtrCX iKeyName;
1.336 + TPtrCX iKeyValue;
1.337 + CIniLineX* iLineSrc;
1.338 +};
1.339 +
1.340 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.341 +CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>* CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::NewL(const TDesCX& aKeyName,const TDesCX& aKeyValue)
1.342 + {
1.343 + CIniKey* self=new (ELeave) CIniKey(aKeyName, aKeyValue);
1.344 + return self;
1.345 + }
1.346 +
1.347 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.348 +CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>* CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::NewLC(const TDesCX& aKeyName,const TDesCX& aKeyValue)
1.349 + {
1.350 + CIniKey* self=CIniKey::NewL(aKeyName,aKeyValue);
1.351 + CleanupStack::PushL(self);
1.352 + return self;
1.353 + }
1.354 +
1.355 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.356 +CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>* CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::NewLC(CIniLineX* aLine)
1.357 + {
1.358 + CIniKey* self=ParseKeyLineL(aLine);
1.359 + CleanupStack::PushL(self);
1.360 + self->iLineSrc=aLine;
1.361 + return self;
1.362 + }
1.363 +
1.364 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.365 +CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::CIniKey(const TDesCX& aKeyName, const TDesCX& aKeyValue, CIniLineX* aLine):iKeyName(aKeyName),iKeyValue(aKeyValue),iLineSrc(aLine)
1.366 + { }
1.367 +
1.368 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.369 +CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::CIniKey(const TDesCX& aKeyName, const TDesCX& aKeyValue):iKeyName(aKeyName),iKeyValue(aKeyValue),iLineSrc(NULL)
1.370 + { }
1.371 +
1.372 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.373 +CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::~CIniKey()
1.374 + {}
1.375 +
1.376 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.377 +TPtrCX CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::KeyName() const
1.378 + {
1.379 + return iKeyName;
1.380 + }
1.381 +
1.382 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.383 +TPtrCX CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::KeyValue() const
1.384 + {
1.385 + return iKeyValue;
1.386 + }
1.387 +
1.388 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.389 +CIniLineX* CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::LineSrc() const
1.390 + {
1.391 + return iLineSrc;
1.392 + }
1.393 +
1.394 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.395 +void CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::SetKeyValue(const TDesCX& aKeyValue)
1.396 + {
1.397 + iKeyValue.Set(aKeyValue);
1.398 + }
1.399 +
1.400 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.401 +TInt CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::CompareKey(const CIniKey& aFirstKey,const CIniKey& aSecondKey)
1.402 + {
1.403 + return (aFirstKey.KeyName()).Compare(aSecondKey.KeyName());
1.404 + }
1.405 +
1.406 +template<class TDesCX,class HBufCX,class TPtrCX, class CIniLineX,class TPtrX,class TLexX>
1.407 +CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>* CIniKey<TDesCX,HBufCX,TPtrCX,CIniLineX,TPtrX,TLexX>::ParseKeyLineL(CIniLineX* aIniLine)
1.408 + {
1.409 + const HBufCX& myLine = aIniLine->LineBuffer();
1.410 + //Get the first occurence of '=' sign
1.411 + TInt equalOffset=myLine.Locate('=');
1.412 + CorruptIfL(equalOffset==KErrNotFound);
1.413 +
1.414 + TInt tokenCount = CountTokens<TPtrCX, TLexX>(myLine.Left(equalOffset));
1.415 + CorruptIfL(tokenCount != 1);
1.416 +
1.417 + //construct a TLex for checking the lhs of equal sign
1.418 + TLexX parser;
1.419 + parser.Assign(myLine.Left(equalOffset));
1.420 + parser.SkipSpaceAndMark();
1.421 + parser.SkipCharacters();
1.422 + TPtrCX keyname=parser.MarkedToken();
1.423 + TBool check = (keyname.Length()==0);
1.424 + CorruptIfL(check);
1.425 +
1.426 + //strip off any white space before and after the value
1.427 + TInt edgeOfValue=equalOffset;
1.428 + while(++edgeOfValue < myLine.Length())
1.429 + {
1.430 + TChar t = (myLine)[edgeOfValue];
1.431 + if (!t.IsSpace())
1.432 + {
1.433 + break;
1.434 + }
1.435 + }
1.436 + TPtrCX keyvalue;
1.437 + if (edgeOfValue < myLine.Length())
1.438 + {
1.439 + keyvalue.Set(myLine.Mid(edgeOfValue, (myLine.Length()-edgeOfValue-1)));
1.440 + }
1.441 +
1.442 + TInt hashOffset=keyvalue.Locate('#');
1.443 + if (hashOffset>0)
1.444 + {
1.445 + keyvalue.Set(keyvalue.Left(hashOffset));
1.446 + }
1.447 + TInt commentOffset=keyvalue.Locate(';');
1.448 + if (commentOffset > 0)
1.449 + {
1.450 + keyvalue.Set(keyvalue.Left(commentOffset));
1.451 + }
1.452 +
1.453 + TInt index = keyvalue.Length()-1;
1.454 + if (index > 0)
1.455 + {
1.456 + while (index > 0)
1.457 + {
1.458 + TChar t = keyvalue[index];
1.459 + if (t.IsSpace())
1.460 + {
1.461 + index--;
1.462 + }
1.463 + else
1.464 + {
1.465 + break;
1.466 + }
1.467 + }
1.468 + if (index < (keyvalue.Length()-1))
1.469 + {
1.470 + keyvalue.Set(keyvalue.Left(index+1));
1.471 + }
1.472 + }
1.473 +
1.474 + CIniKey* myKey = new (ELeave) CIniKey(keyname,keyvalue, aIniLine);
1.475 + return myKey;
1.476 + }
1.477 +
1.478 +//section template class//
1.479 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX,class CIniLineX,class TPtrX, class TLexX>
1.480 +NONSHARABLE_CLASS(CIniSection): public CBase
1.481 +{
1.482 +public:
1.483 + static CIniSection* NewL(const TDesCX& aSectionName);
1.484 + static CIniSection* NewLC(const TDesCX& aSectionName);
1.485 + static CIniSection* NewL(const TDesCX& aSectionName, CIniLineX* aLineSrc);
1.486 + static CIniSection* NewLC(CIniLineX* aLineSrc);
1.487 + static TInt CompareSection(const CIniSection& aFirstSection,const CIniSection& aSecondSection);
1.488 + ~CIniSection();
1.489 +
1.490 + void InsertKeyL(const TDesCX& aKeyName,const TDesCX& aKeyValue);
1.491 + void InsertKeyL(const CIniKeyX* aKey);
1.492 + void RemoveKeyL(const TDesCX& aKeyName);
1.493 +
1.494 + TPtrCX KeyValueL(const TDesCX& aKeyName) const;
1.495 + TInt KeyCount() const;
1.496 + CIniKeyX* FindKeyL(const TDesCX& aKeyName) const;
1.497 + TPtrCX SectionName() const;
1.498 +
1.499 + CIniLineX* SrcLine();
1.500 + void SetSrcLine(CIniLineX* aLineSrc);
1.501 +
1.502 + //to be used to access individual item
1.503 + const CIniKeyX* Key(TInt aIndex) const {return iKeyArray[aIndex];}
1.504 + void ReserveSpaceInKeyArrayL(){iKeyArray.ReserveL(1);}
1.505 +private:
1.506 + CIniSection(TPtrCX aSectionName);
1.507 + CIniSection(TPtrCX aSectionName, CIniLineX* aLine);
1.508 + static TPtrCX ParseSectionLineL(const HBufCX& aLine);
1.509 +
1.510 +private:
1.511 + TPtrCX iSectionName;
1.512 + RPointerArray<CIniKeyX> iKeyArray;
1.513 + CIniLineX* iLineSrc; //If no document object exists, then this object is not used.
1.514 +};
1.515 +
1.516 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.517 +CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>* CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::NewL(const TDesCX& aSectionName)
1.518 + {
1.519 + CIniSection* self=new (ELeave) CIniSection(aSectionName);
1.520 + return self;
1.521 + }
1.522 +
1.523 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.524 +CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>* CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::NewL(const TDesCX& aSectionName,CIniLineX* aLineSrc)
1.525 + {
1.526 + CIniSection* self=new (ELeave) CIniSection(aSectionName, aLineSrc);
1.527 + return self;
1.528 + }
1.529 +
1.530 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.531 +CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>* CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::NewLC(const TDesCX& aSectionName)
1.532 + {
1.533 + CIniSection* self=new (ELeave) CIniSection(aSectionName);
1.534 + CleanupStack::PushL(self);
1.535 + return self;
1.536 + }
1.537 +
1.538 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.539 +CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>* CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::NewLC(CIniLineX* aLineSrc)
1.540 + {
1.541 + const HBufCX& buffer = aLineSrc->LineBuffer();
1.542 + TPtrCX sectionName = ParseSectionLineL(buffer);
1.543 + CIniSection* self=new (ELeave) CIniSection(sectionName, aLineSrc);
1.544 + CleanupStack::PushL(self);
1.545 + return self;
1.546 + }
1.547 +
1.548 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.549 +CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::CIniSection(TPtrCX aSectionName, CIniLineX* aLine):iSectionName(aSectionName), iLineSrc(aLine)
1.550 + {
1.551 + iKeyArray.Reset();
1.552 + }
1.553 +
1.554 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.555 +CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::CIniSection(TPtrCX aSectionName):iSectionName(aSectionName)
1.556 + {
1.557 + iKeyArray.Reset();
1.558 + }
1.559 +
1.560 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.561 +CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::~CIniSection()
1.562 + {
1.563 + iKeyArray.ResetAndDestroy();
1.564 + }
1.565 +
1.566 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX, class TLexX>
1.567 +void CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::SetSrcLine(CIniLineX* aLineSrc)
1.568 + {
1.569 + if (iLineSrc)
1.570 + {
1.571 + delete iLineSrc;
1.572 + }
1.573 + iLineSrc = aLineSrc;
1.574 + }
1.575 +
1.576 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.577 +TInt CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::KeyCount() const
1.578 + {
1.579 + return iKeyArray.Count();
1.580 + }
1.581 +
1.582 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.583 +TPtrCX CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::SectionName() const
1.584 + {
1.585 + return iSectionName;
1.586 + }
1.587 +
1.588 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.589 +CIniLineX* CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::SrcLine()
1.590 + {
1.591 + return iLineSrc;
1.592 + }
1.593 +
1.594 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.595 +TInt CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::CompareSection(const CIniSection& aFirstSection,const CIniSection& aSecondSection)
1.596 + {
1.597 + return aFirstSection.SectionName().Compare(aSecondSection.SectionName());
1.598 + }
1.599 +
1.600 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX, class TLexX>
1.601 +void CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::InsertKeyL(const TDesCX& aKeyName,const TDesCX& aKeyValue)
1.602 + {
1.603 + CIniKeyX* newKey=CIniKeyX::NewLC(aKeyName,aKeyValue);
1.604 + InsertKeyL(newKey);
1.605 + CleanupStack::Pop(newKey);
1.606 + }
1.607 +
1.608 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX, class TLexX>
1.609 +void CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::InsertKeyL(const CIniKeyX* aKey)
1.610 + {
1.611 + iKeyArray.InsertInOrderL(aKey,TLinearOrder<CIniKeyX>(CIniKeyX::CompareKey));
1.612 + }
1.613 +
1.614 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.615 +void CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::RemoveKeyL(const TDesCX& aKeyName)
1.616 + {
1.617 + CIniKeyX* key=FindKeyL(aKeyName);
1.618 + CIniLineX* myLine = key->LineSrc();
1.619 + TInt index=iKeyArray.FindInOrderL(key,TLinearOrder<CIniKeyX>(CIniKeyX::CompareKey));
1.620 + iKeyArray.Remove(index);
1.621 + delete key;
1.622 + delete myLine;
1.623 + }
1.624 +
1.625 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX, class TLexX>
1.626 +CIniKeyX* CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::FindKeyL(const TDesCX& aKeyName) const
1.627 + {
1.628 + CIniKeyX* key=CIniKeyX::NewLC(aKeyName, aKeyName);
1.629 + TInt index=iKeyArray.FindInOrderL(key,TLinearOrder<CIniKeyX>(CIniKeyX::CompareKey));
1.630 + CleanupStack::PopAndDestroy(key);
1.631 + return iKeyArray[index];
1.632 + }
1.633 +
1.634 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.635 +TPtrCX CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::KeyValueL(const TDesCX& aKeyName) const
1.636 + {
1.637 + CIniKeyX* key=FindKeyL(aKeyName);
1.638 + return key->KeyValue();
1.639 + }
1.640 +
1.641 +template<class TDesCX,class HBufCX,class TPtrCX,class CIniKeyX, class CIniLineX, class TPtrX,class TLexX>
1.642 +TPtrCX CIniSection<TDesCX,HBufCX,TPtrCX,CIniKeyX,CIniLineX,TPtrX,TLexX>::ParseSectionLineL(const HBufCX& aLine)
1.643 + {
1.644 + //find the last terminating bracket ']'
1.645 + //anything in between is considered the section name
1.646 + TInt endBracket=aLine.Locate(']');
1.647 + //Check if the terminating bracket exits. Leave with an error code if not found.
1.648 + CorruptIfL(endBracket == KErrNotFound);
1.649 +
1.650 + TInt startBracket=aLine.Locate('[');
1.651 + CorruptIfL(startBracket == KErrNotFound);
1.652 +
1.653 + TPtrCX sectionName=aLine.Mid(startBracket+1, (endBracket-startBracket)-1);
1.654 +
1.655 + //corrupt if empty section e.g []
1.656 + TBool check = (sectionName.Length()==0);
1.657 + CorruptIfL(check);
1.658 +
1.659 + TLexX lex(sectionName);
1.660 +
1.661 + //Check for any white space within section name
1.662 + //check any white spaces directly after the '['
1.663 + lex.SkipSpace();
1.664 + check = (lex.Offset()>lex.MarkedOffset());
1.665 + CorruptIfL(check);
1.666 + lex.SkipCharacters();
1.667 +
1.668 + //At this stage we can extract the section name
1.669 + sectionName.Set(lex.MarkedToken());
1.670 + return (sectionName);
1.671 + }
1.672 +
1.673 +//iterator template class//
1.674 +template<class TDesCX,class TPtrCX,class CIniSectionX,class CIniDocumentX,class CIniKeyX>
1.675 +NONSHARABLE_CLASS(CIniSecIterImplX): public CBase
1.676 +{
1.677 +public:
1.678 + CIniSecIterImplX():iCurrentIndex(0),iSection(NULL){}
1.679 + TBool Next(TPtrCX& aKeyName,TPtrCX& aKeyValue);
1.680 + void Reset(){iCurrentIndex=0;}
1.681 + TBool End(){return iCurrentIndex>=iSection->KeyCount();}
1.682 +public:
1.683 + TInt iCurrentIndex;
1.684 + CIniSectionX* iSection;
1.685 +};
1.686 +
1.687 +template<class TDesCX,class TPtrCX,class CIniSectionX,class CIniDocumentX,class CIniKeyX>
1.688 +TBool CIniSecIterImplX<TDesCX,TPtrCX,CIniSectionX,CIniDocumentX,CIniKeyX>::Next(TPtrCX& aKeyName,TPtrCX& aKeyValue)
1.689 + {
1.690 + if (iSection)
1.691 + {
1.692 + if (iCurrentIndex<iSection->KeyCount())
1.693 + {
1.694 + const CIniKeyX* key=iSection->Key(iCurrentIndex);
1.695 + aKeyName.Set(key->KeyName());
1.696 + aKeyValue.Set(key->KeyValue());
1.697 + iCurrentIndex++;
1.698 + return ETrue;
1.699 + }
1.700 + }
1.701 + return EFalse;
1.702 + }
1.703 +
1.704 +
1.705 +//inidocument template class//
1.706 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.707 +NONSHARABLE_CLASS(CIniDocumentTmplX) : public CBase
1.708 +{
1.709 +public:
1.710 + CIniDocumentTmplX(RFs& aFs,TBool aNarrow);
1.711 + ~CIniDocumentTmplX();
1.712 + void FlushL(const TDesC& aFileName);
1.713 +
1.714 + TInt GetSectionList(RArray<TPtrCX>& aSectionList) const;
1.715 + void GetKeyValueL(const TDesCX& aSectionName,const TDesCX& aKeyName,TPtrCX& aKeyValue) const;
1.716 + CIniSectionX* SectionL(const TDesCX& aSectionName) const;
1.717 +
1.718 + CIniSectionX* AddSectionL(const TDesCX& aSectionName, CIniLineX* aLine);
1.719 + CIniSectionX* AddSectionL(const TDesCX& aSectionName);
1.720 + void AddSectionL(const CIniSectionX* aSection);
1.721 +
1.722 + void RemoveSectionL(const TDesCX& aSectionName);
1.723 + void SetKeyL(const TDesCX& aSectionName,const TDesCX& aKeyName,const TDesCX& aKeyValue);
1.724 + void RemoveKeyL(const TDesCX& aSectionName,const TDesCX& aKeyName);
1.725 + void RemoveLineL(CIniLineX* aLine);
1.726 + void InsertKeyValueIntoQueueL(CIniLineX* aKeyValue, CIniSectionX& aSection);
1.727 + void AppendIntoQueue(CIniLineX* aSection);
1.728 + TBool CompareDocs(CIniDocumentTmplX& aDoc);
1.729 +
1.730 +private:
1.731 + CIniSectionX* FindSectionL(const TDesCX& aSectionName) const;
1.732 + void ConstructL(const TDesC& aFileName);
1.733 +
1.734 +private:
1.735 + TBool iNarrow;
1.736 + RFs& iFs;
1.737 + TDblQue<CIniLineX> iDocument;
1.738 + RPointerArray<CIniSectionX> iSectionArray;
1.739 +};
1.740 +
1.741 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX, class CIniLineX,class CIniKeyX>
1.742 +CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::CIniDocumentTmplX(RFs& aFs,TBool aNarrow):iNarrow(aNarrow),iFs(aFs)
1.743 + {
1.744 + iSectionArray.Reset();
1.745 + iDocument.SetOffset(_FOFF(CIniLineX, iLink));
1.746 + iDocument.Reset();
1.747 + }
1.748 +
1.749 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.750 +TBool CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::CompareDocs(CIniDocumentTmplX& aDoc)
1.751 + {
1.752 + CIniLineX* lineFromA; // This object is a. The passed in one is b.
1.753 + CIniLineX* lineFromB;
1.754 + TDblQueIter<CIniLineX> itera(this->iDocument);
1.755 + TDblQueIter<CIniLineX> iterb(aDoc.iDocument);
1.756 +
1.757 + TBool NotDoneYet= ETrue;
1.758 + while (NotDoneYet)
1.759 + {
1.760 + lineFromA = itera++;
1.761 + lineFromB = iterb++;
1.762 + if ((lineFromA == NULL) || (lineFromB == NULL))
1.763 + break;
1.764 +
1.765 + if (!(*lineFromA == *lineFromB))
1.766 + {
1.767 + return EFalse;
1.768 + }
1.769 + }
1.770 +
1.771 + if ( (lineFromA) || (lineFromB))
1.772 + return EFalse;
1.773 +
1.774 + if ((this->iSectionArray.Count()) != (aDoc.iSectionArray.Count()))
1.775 + {
1.776 + return EFalse;
1.777 + }
1.778 +
1.779 + for (TInt i=0; i<this->iSectionArray.Count(); i++)
1.780 + {
1.781 + TPtrCX secNameA = this->iSectionArray[i]->SectionName();
1.782 + TPtrCX secNameB = aDoc.iSectionArray[i]->SectionName();
1.783 + if ((secNameA.Compare(secNameB))!= 0)
1.784 + return EFalse;
1.785 +
1.786 + if ((this->iSectionArray[i]->KeyCount()) != (aDoc.iSectionArray[i]->KeyCount()))
1.787 + return EFalse;
1.788 +
1.789 + lineFromA = this->iSectionArray[i]->SrcLine();
1.790 + lineFromB = aDoc.iSectionArray[i]->SrcLine();
1.791 +
1.792 + if (!(*lineFromA == *lineFromB))
1.793 + {
1.794 + return EFalse;
1.795 + }
1.796 +
1.797 + for (TInt k=0; k<this->iSectionArray[i]->KeyCount(); k++)
1.798 + {
1.799 + const CIniKeyX* keyA = this->iSectionArray[i]->Key(k);
1.800 + const CIniKeyX* keyB = aDoc.iSectionArray[i]->Key(k);
1.801 + if (keyA->KeyName().Compare(keyB->KeyName()) != 0)
1.802 + return EFalse;
1.803 + if (keyA->KeyValue().Compare(keyB->KeyValue()) != 0)
1.804 + return EFalse;
1.805 +
1.806 + lineFromA = keyA->LineSrc();
1.807 + lineFromB = keyB->LineSrc();
1.808 +
1.809 + if (!(*lineFromA == *lineFromB))
1.810 + {
1.811 + return EFalse;
1.812 + }
1.813 + }
1.814 + }
1.815 +
1.816 + return ETrue;
1.817 + }
1.818 +
1.819 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX, class CIniLineX,class CIniKeyX>
1.820 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::AppendIntoQueue(CIniLineX* aLine)
1.821 + {
1.822 + if (iDocument.IsEmpty())
1.823 + {
1.824 + iDocument.AddFirst(*aLine);
1.825 + }
1.826 + else
1.827 + {
1.828 + iDocument.AddLast(*aLine); //always at the end of the list.
1.829 + }
1.830 + }
1.831 +
1.832 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX, class CIniLineX,class CIniKeyX>
1.833 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::InsertKeyValueIntoQueueL(CIniLineX* aKeyValue,CIniSectionX& aSection)
1.834 + {
1.835 + // Find the end of the section (if exists).
1.836 + CIniLineX* lastEntry;
1.837 + CIniLineX* line;
1.838 + TDblQueIter<CIniLineX> iter(iDocument);
1.839 +
1.840 + lastEntry = aSection.SrcLine(); //by default insert into queue after this line entry.
1.841 + iter.Set(*lastEntry); // search after this point for a keyvalue line.
1.842 + iter++; //point to next line
1.843 + while ((line = iter++) != NULL)
1.844 + {
1.845 + lastEntry=line;
1.846 + TLineType typeOfLine = line->LineType();
1.847 + if (typeOfLine == ESection)
1.848 + {
1.849 + break;
1.850 + }
1.851 + }
1.852 +
1.853 + if ( line == NULL )
1.854 + {
1.855 + AppendIntoQueue(aKeyValue);
1.856 + }
1.857 + else
1.858 + {
1.859 + if (iDocument.IsLast(lastEntry))
1.860 + {
1.861 + AppendIntoQueue(aKeyValue);
1.862 + }
1.863 + else
1.864 + {
1.865 + lastEntry->InsertBefore(aKeyValue);
1.866 + }
1.867 + }
1.868 + }
1.869 +
1.870 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX, class CIniLineX,class CIniKeyX>
1.871 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::FlushL(const TDesC& aFileName)
1.872 + {
1.873 + //we need to get the path for the target file
1.874 + TParse originFile;
1.875 + User::LeaveIfError(originFile.Set(aFileName,NULL,NULL));
1.876 +
1.877 + //Need to ensure path exists
1.878 + TInt error=iFs.MkDirAll(originFile.DriveAndPath());
1.879 + if (error!=KErrAlreadyExists)
1.880 + {
1.881 + User::LeaveIfError(error);
1.882 + }
1.883 +
1.884 + //Constructing the temp file name with the same directory and path
1.885 + TFileName tempFile;
1.886 + RFile file;
1.887 + User::LeaveIfError(file.Temp(iFs,originFile.DriveAndPath(),tempFile,EFileWrite));
1.888 + CleanupClosePushL(file);
1.889 +
1.890 + TPtrC8 bufPtr;
1.891 + if (!iNarrow)
1.892 + {
1.893 + TChar myChar(0xFEFF);
1.894 + const unsigned char* myChar8=reinterpret_cast<const unsigned char*>(&myChar);
1.895 + bufPtr.Set(myChar8, 2);
1.896 + User::LeaveIfError(file.Write(bufPtr));
1.897 + }
1.898 +
1.899 + TDblQueIter<CIniLineX> iter(iDocument);
1.900 + CIniLineX* line;
1.901 + while ((line = iter++) != NULL)
1.902 + {
1.903 + const HBufCX& tempBuffer=line->LineBuffer();
1.904 + const TUint8* rawptr8=reinterpret_cast<const TUint8*>(tempBuffer.Ptr());
1.905 + if (iNarrow)
1.906 + {
1.907 + bufPtr.Set(rawptr8,tempBuffer.Length());
1.908 + }
1.909 + else
1.910 + {
1.911 + bufPtr.Set(rawptr8,tempBuffer.Length()*2);
1.912 + }
1.913 + User::LeaveIfError(file.Write(bufPtr));
1.914 + }
1.915 + User::LeaveIfError(file.Flush());
1.916 + CleanupStack::PopAndDestroy();
1.917 +
1.918 + //Finally try replacing or creating a new file
1.919 + //depending on whether file exist or not
1.920 + TEntry entry;
1.921 + if (iFs.Entry(aFileName,entry)==KErrNone)
1.922 + {
1.923 + User::LeaveIfError(iFs.Replace(tempFile,aFileName));
1.924 + }
1.925 + else
1.926 + {
1.927 + User::LeaveIfError(iFs.Rename(tempFile,aFileName));
1.928 + }
1.929 + }
1.930 +
1.931 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX, class CIniLineX,class CIniKeyX>
1.932 +TInt CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::GetSectionList(RArray<TPtrCX>& aSectionList) const
1.933 + {
1.934 + //Reset the list first
1.935 + aSectionList.Reset();
1.936 + for (TInt i=0;i<iSectionArray.Count();i++)
1.937 + {
1.938 + TPtrCX nameptr=iSectionArray[i]->SectionName();
1.939 + TInt ret=aSectionList.Append(nameptr);
1.940 + //If error half way fo the copying, reset the list first
1.941 + if (ret!=KErrNone)
1.942 + {
1.943 + aSectionList.Reset();
1.944 + return ret;
1.945 + }
1.946 + }
1.947 + return KErrNone;
1.948 + }
1.949 +
1.950 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX, class CIniLineX,class CIniKeyX>
1.951 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::GetKeyValueL(const TDesCX& aSectionName,const TDesCX& aKeyName,TPtrCX& aKeyValue) const
1.952 + {
1.953 + //Find if section exists
1.954 + CIniSectionX* section = SectionL(aSectionName);
1.955 + aKeyValue.Set(section->KeyValueL(aKeyName));
1.956 + }
1.957 +
1.958 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.959 +CIniSectionX* CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::SectionL(const TDesCX& aSectionName) const
1.960 + {
1.961 + CIniSectionX* section = FindSectionL(aSectionName);
1.962 + return section;
1.963 + }
1.964 +
1.965 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.966 +CIniSectionX* CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::AddSectionL(const TDesCX& aSectionName)
1.967 + {
1.968 + //Find if section exists
1.969 + CIniSectionX* section = NULL;
1.970 + TRAPD(ret, section = FindSectionL(aSectionName));
1.971 + if ((ret == KErrNone) && (section != NULL))
1.972 + User::Leave(KErrAlreadyExists);
1.973 +
1.974 + //Fabricate objects upfront and on the cleanup stack to ensure their deletion if OOM conditions occur.
1.975 + CIniLineX* myLine = CIniLineX::NewFromSectionNameLC(aSectionName);
1.976 + AppendIntoQueue(myLine);
1.977 +
1.978 + // reserve 1 slot for the new section name to provoke the out of memory condition
1.979 + // before actually inserting the object to avoid having to go back and remove it if it fails.
1.980 + this->iSectionArray.ReserveL(1);
1.981 +
1.982 + // If we have not left, we are sure adding a section should not leave due to OOM.
1.983 + CIniSectionX* newSection=AddSectionL(aSectionName, myLine);
1.984 + CleanupStack::Pop(myLine);
1.985 + return newSection;
1.986 + }
1.987 +
1.988 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.989 +CIniSectionX* CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::AddSectionL(const TDesCX& aSectionName, CIniLineX* aLine)
1.990 + {
1.991 + CIniSectionX* newSection=CIniSectionX::NewLC(aSectionName);
1.992 + AddSectionL(newSection);
1.993 + newSection->SetSrcLine(aLine);
1.994 + CleanupStack::Pop(newSection);
1.995 + return newSection;
1.996 + }
1.997 +
1.998 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.999 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::AddSectionL(const CIniSectionX* aSection)
1.1000 + {
1.1001 + iSectionArray.InsertInOrderL(aSection,TLinearOrder<CIniSectionX>(CIniSectionX::CompareSection));
1.1002 + }
1.1003 +
1.1004 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.1005 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::RemoveSectionL(const TDesCX& aSectionName)
1.1006 + {
1.1007 + CIniSectionX* section = FindSectionL(aSectionName);
1.1008 + CIniLineX* line = section->SrcLine();
1.1009 + ASSERT(line); //This should never happen ie. the Key object must have a line associated with it.
1.1010 +
1.1011 + // remove the lines after to the start of the next section
1.1012 + TDblQueIter<CIniLineX> iter(iDocument);
1.1013 + iter.Set(*line); // search after this point for a keyvalue line.
1.1014 + TBool atStartofSection = ETrue;
1.1015 + while ((line = iter++) != NULL)
1.1016 + {
1.1017 + TLineType typeOfLine = line->LineType();
1.1018 + if ((typeOfLine == ESection))
1.1019 + {
1.1020 + if (!atStartofSection)
1.1021 + {
1.1022 + break;
1.1023 + }
1.1024 + else
1.1025 + {
1.1026 + delete line;
1.1027 + atStartofSection = EFalse;
1.1028 + }
1.1029 + }
1.1030 + else
1.1031 + {
1.1032 + delete line; //includes comment lines which are only in the document object. Otherwise you could just ~section.
1.1033 + }
1.1034 + }
1.1035 +
1.1036 + TInt index=this->iSectionArray.FindInOrderL(section,TLinearOrder<CIniSectionX>(CIniSectionX::CompareSection));
1.1037 + iSectionArray.Remove(index);
1.1038 + delete section;
1.1039 + }
1.1040 +
1.1041 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.1042 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::SetKeyL(const TDesCX& aSectionName,const TDesCX& aKeyName,const TDesCX& aKeyValue)
1.1043 + {
1.1044 + //Find if section exists
1.1045 + CIniSectionX* section = NULL;
1.1046 + TRAPD(ret, section = FindSectionL(aSectionName));
1.1047 + if (ret == KErrNone)
1.1048 + {
1.1049 + TRAPD(ret2, RemoveKeyL(aSectionName, aKeyName));
1.1050 + if ((ret2 != KErrNone) && (ret2 != KErrNotFound))
1.1051 + {
1.1052 + User::Leave(ret2);
1.1053 + }
1.1054 +
1.1055 + CIniLineX* myLine2 = CIniLineX::NewFromKeyValueLineLC(aKeyName, aKeyValue);
1.1056 + CIniKeyX* myKey = CIniKeyX::NewLC(myLine2);
1.1057 + InsertKeyValueIntoQueueL(myLine2, *section);
1.1058 +
1.1059 + // reserve 1 slot in the key array to provoke the out of memory condition
1.1060 + // before inserting the key to avoid having to go back and remove the key if OOM occurs.
1.1061 + section->ReserveSpaceInKeyArrayL();
1.1062 + section->InsertKeyL(myKey);
1.1063 +
1.1064 + CleanupStack::Pop(2);
1.1065 + return;
1.1066 + }
1.1067 + if (ret!=KErrNotFound)
1.1068 + {
1.1069 + User::Leave(ret);
1.1070 + }
1.1071 +
1.1072 + //Fabricate objects upfront and on the cleanup stack to ensure their deletion if OOM conditions occur.
1.1073 + CIniLineX* myLine = CIniLineX::NewFromSectionNameLC(aSectionName);
1.1074 + AppendIntoQueue(myLine);
1.1075 + CIniLineX* myLine3 = CIniLineX::NewFromKeyValueLineLC(aKeyName, aKeyValue);
1.1076 + AppendIntoQueue(myLine3);
1.1077 + CIniKeyX* myKey = CIniKeyX::NewLC(myLine3);
1.1078 +
1.1079 + // reserve 1 slot for the new section name to provoke the out of memory condition
1.1080 + // before actually inserting the object to avoid having to go back and remove it if it fails.
1.1081 + this->iSectionArray.ReserveL(1);
1.1082 +
1.1083 + // If we have not left, we are sure adding a section should not leave due to OOM.
1.1084 + CIniSectionX* newSection=AddSectionL(aSectionName, myLine);
1.1085 +
1.1086 + // reserve 1 slot in the key array of the newly created empty section to provoke the out of memory condition
1.1087 + // before inserting the key to avoid having to go back and remove the key if OOM occurs.
1.1088 + TRAPD(err, newSection->ReserveSpaceInKeyArrayL());
1.1089 + if (err == KErrNoMemory)
1.1090 + {
1.1091 + // In this case, we have an empty newSection object to be removed.
1.1092 + TInt index=this->iSectionArray.FindInOrder(newSection,TLinearOrder<CIniSectionX>(CIniSectionX::CompareSection));
1.1093 + iSectionArray.Remove(index);
1.1094 + delete newSection;
1.1095 + CleanupStack::PopAndDestroy(3);
1.1096 + User::Leave(KErrNoMemory);
1.1097 + }
1.1098 + else
1.1099 + {
1.1100 + if (err!= KErrNone)
1.1101 + User::Leave(err);
1.1102 + }
1.1103 +
1.1104 + // we are now sure the next inserts will not fail due to OOM.
1.1105 + newSection->InsertKeyL(myKey);
1.1106 + CleanupStack::Pop(3);
1.1107 + }
1.1108 +
1.1109 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.1110 +void CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::RemoveKeyL(const TDesCX& aSectionName,const TDesCX& aKeyName)
1.1111 + {
1.1112 + //Find if section exists
1.1113 + CIniSectionX* section = FindSectionL(aSectionName);
1.1114 + section->RemoveKeyL(aKeyName);
1.1115 + }
1.1116 +
1.1117 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.1118 +CIniSectionX* CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::FindSectionL(const TDesCX& aSectionName) const
1.1119 + {
1.1120 + CIniSectionX* newSection=CIniSectionX::NewLC(aSectionName);
1.1121 + TInt index=iSectionArray.FindInOrderL(newSection,TLinearOrder<CIniSectionX>(CIniSectionX::CompareSection));
1.1122 + CleanupStack::PopAndDestroy(newSection);
1.1123 + return iSectionArray[index];
1.1124 + }
1.1125 +
1.1126 +template<class TDesCX,class TPtrCX,class CIniSectionX,class TLexX,class TPtrX,class HBufCX,class CIniLineX,class CIniKeyX>
1.1127 +CIniDocumentTmplX<TDesCX,TPtrCX,CIniSectionX,TLexX,TPtrX,HBufCX,CIniLineX,CIniKeyX>::~CIniDocumentTmplX()
1.1128 + {
1.1129 + CIniLineX* line;
1.1130 + TDblQueIter<CIniLineX> iter(iDocument);
1.1131 +
1.1132 + while ((line = iter++) != NULL)
1.1133 + {
1.1134 + delete line;
1.1135 + }
1.1136 + iSectionArray.ResetAndDestroy();
1.1137 + }
1.1138 +
1.1139 +//light weight template class//
1.1140 +template<class TDesCX,class TPtrCX,class HBufCX,class TLexX,class TPtrX,class TBufX,class CIniLineX>
1.1141 +NONSHARABLE_CLASS(CIniFileImplX): public CBase
1.1142 +{
1.1143 +public:
1.1144 + CIniFileImplX():iBuffer(NULL) {}
1.1145 + TInt FindVar(const TDesCX& aSection,const TDesCX& aKey,TPtrCX& aValue);
1.1146 + void ProcessBufferL(const TDesCX& aPtr);
1.1147 + ~CIniFileImplX()
1.1148 + {
1.1149 + delete iBuffer;
1.1150 + }
1.1151 +private:
1.1152 + HBufCX* iBuffer;
1.1153 +};
1.1154 +
1.1155 +template<class TDesCX,class TPtrCX,class HBufCX,class TLexX,class TPtrX,class TBufX,class CIniLineX>
1.1156 +void CIniFileImplX<TDesCX,TPtrCX,HBufCX,TLexX,TPtrX,TBufX,CIniLineX>::ProcessBufferL(const TDesCX& aPtr)
1.1157 + {
1.1158 + iBuffer = HBufCX::NewL(aPtr.Length() + sizeof('\n')); //1 for cr.
1.1159 + TPtrX bufferPtr(iBuffer->Des());
1.1160 + TLexX lineParser(aPtr);
1.1161 + while (!lineParser.Eos())
1.1162 + {
1.1163 + //Get line by line which is terminated by \n
1.1164 + lineParser.SkipSpaceAndMark();
1.1165 + while (!lineParser.Eos() && lineParser.Peek()!='\n')
1.1166 + {
1.1167 + lineParser.Inc();
1.1168 + }
1.1169 + TPtrCX line=lineParser.MarkedToken();
1.1170 + //Now append the LHS of the comment to the buffer
1.1171 + RemoveComment(line);
1.1172 +
1.1173 + //trim any white space before section,key- value and comments
1.1174 + TLexX removeWs(line);
1.1175 + removeWs.SkipSpace();
1.1176 + if (!removeWs.Eos())
1.1177 + {
1.1178 + bufferPtr.Append(line);
1.1179 + //this added own delimiter is useful for syntax checking
1.1180 + bufferPtr.Append('\n');
1.1181 + }
1.1182 + }
1.1183 + }
1.1184 +
1.1185 +template<class TDesCX,class TPtrCX,class HBufCX,class TLexX,class TPtrX,class TBufX,class CIniLineX>
1.1186 +TInt CIniFileImplX<TDesCX,TPtrCX,HBufCX,TLexX,TPtrX,TBufX,CIniLineX>::FindVar(const TDesCX& aSection,const TDesCX& aKey,TPtrCX& aValue)
1.1187 + {
1.1188 + //first find the start of the section [aSectionName]
1.1189 + //5 here is []\n and the wildcard *\n[sectionname]*
1.1190 + HBufCX* section=HBufCX::New(aSection.Length()+5);
1.1191 + if (!section)
1.1192 + return KErrNoMemory;
1.1193 + TPtrX sectionPtr(section->Des());
1.1194 + sectionPtr.Append(_L("*\n["));
1.1195 + sectionPtr.Append(aSection);
1.1196 + sectionPtr.Append(_L("]*"));
1.1197 +
1.1198 + // Find a match purely on the section and not on the value, i.e. checking for a match on
1.1199 + // [SECTION] does not find a match on key=[SECTION].
1.1200 +
1.1201 + TBool firstSection=ETrue;
1.1202 + // Matching on first section is different as it should be the first
1.1203 + // entry, i.e. no *\n before [aSection]* .
1.1204 + TInt sectionStart=iBuffer->Match(sectionPtr.Mid(2));
1.1205 + if (sectionStart==KErrNotFound)
1.1206 + {
1.1207 + firstSection=EFalse;
1.1208 + // Then try to match on any section after the first, i.e. *\n[aSection]* .
1.1209 + sectionStart=iBuffer->Match(sectionPtr);
1.1210 + }
1.1211 + delete section;
1.1212 + if (sectionStart!=KErrNotFound)
1.1213 + {
1.1214 + // There will be always \n added after section, key or value.
1.1215 + TPtrCX searchBoundary(iBuffer->Mid(sectionStart+aSection.Length()+(firstSection?2:3)));
1.1216 + searchBoundary.Set(searchBoundary.Mid(searchBoundary.Locate('\n')));
1.1217 + //now need to locate the start of next section or end of file
1.1218 + TBufX matchPattern;
1.1219 + matchPattern.Append(_L("*\n[*]*"));
1.1220 + TInt endSearchPos=searchBoundary.Match(matchPattern);
1.1221 + if (endSearchPos!=KErrNotFound)
1.1222 + {
1.1223 + //if can find next section block reduce the search boundary
1.1224 + searchBoundary.Set(searchBoundary.Left(++endSearchPos));
1.1225 + }
1.1226 + //now time to find the first exact match key i.e "key" does not match "subkey"
1.1227 + TInt equalOffset;
1.1228 + //search through the boundary for matching key
1.1229 + while ((equalOffset=searchBoundary.Locate('='))!=KErrNotFound)
1.1230 + {
1.1231 + //skip over the \n char
1.1232 + searchBoundary.Set(searchBoundary.Mid(1));
1.1233 + TLexX keyCheck(searchBoundary.Left(--equalOffset));
1.1234 + keyCheck.SkipSpaceAndMark();
1.1235 + keyCheck.SkipCharacters();
1.1236 + TPtrCX key(keyCheck.MarkedToken());
1.1237 + keyCheck.SkipSpace();
1.1238 + if (keyCheck.Eos() && key.Compare(aKey)==0)
1.1239 + {
1.1240 + TInt location = searchBoundary.Locate('\n');
1.1241 + __ASSERT_DEBUG(location >= 0, User::Invariant());
1.1242 + //trim any white space before and after the value
1.1243 + TPtrCX rhs(searchBoundary.Mid(equalOffset+1,location-equalOffset-1));
1.1244 + RemoveWSBeforeAndAfter<TPtrCX,TLexX>(rhs,aValue);
1.1245 + return KErrNone;
1.1246 + }
1.1247 + //update the next search boundary
1.1248 + searchBoundary.Set(searchBoundary.Mid(searchBoundary.Locate('\n')));
1.1249 + }
1.1250 + }
1.1251 + //cannot find here
1.1252 + return KErrNotFound;
1.1253 + }
1.1254 +
1.1255 +}//namespace BSUL
1.1256 +#endif//__BAINIPARSERIMPL_H__