1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/graphics/windowing/windowserver/nga/SERVER/INIFILE.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,550 @@
1.4 +// Copyright (c) 1996-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 "server.h"
1.21 +#include "inifile.h"
1.22 +
1.23 +// uncomment so that if the wsini.ini file is not found on drive Wserv loaded from or drive Z: (if different)
1.24 +// it will be searched for on drive C: (if different from Wserv's drive)
1.25 +//#define LOAD_INI_FILE_FROM_DRIVE_Z_OR_C
1.26 +
1.27 +
1.28 +GLREF_D CDebugLogBase *wsDebugLog;
1.29 +
1.30 +_LIT(KDefaultSectionName,"DEFAULT");
1.31 +_LIT(KCommentMarker,"//");
1.32 +_LIT(KScreenSectionName,"SCREEN");
1.33 +const TUint16 KNewSection('[');
1.34 +const TUint16 KSpaceChar(' ');
1.35 +const TUint16 KNewSection2(']');
1.36 +const TInt KDefaultSectionNumber(0);
1.37 +const TInt KDefaultScreenId(-1);
1.38 +
1.39 +
1.40 +CIniFile::CIniFile()
1.41 + {}
1.42 +
1.43 +CIniFile::~CIniFile()
1.44 + {
1.45 + FreeData();
1.46 + }
1.47 +
1.48 +CIniSection * CIniFile::FindSection(TInt aScreen)
1.49 + {
1.50 + for (TInt sect = 0; sect < iSectionArray.Count(); ++sect)
1.51 + {
1.52 + if (iSectionArray[sect]->Screen() == aScreen)
1.53 + {
1.54 + return iSectionArray[sect];
1.55 + }
1.56 + }
1.57 + return NULL;
1.58 + }
1.59 +
1.60 +CIniSection * CIniFile::FindSection(const TDesC& aName)
1.61 + {
1.62 + for (TInt sect = 0; sect < iSectionArray.Count(); ++sect)
1.63 + {
1.64 + if (iSectionArray[sect]->Screen() == KDefaultScreenId && !iSectionArray[sect]->Name().CompareF(aName))
1.65 + {
1.66 + return iSectionArray[sect];
1.67 + }
1.68 + }
1.69 + return NULL;
1.70 + }
1.71 +
1.72 +/* Processes a .ini file entry section name.
1.73 +
1.74 + @return the corresponding index.
1.75 + @param aLine Input line of text from the .ini file, stripped of comments & excess whitespace.
1.76 + @leave KErrNoMemory
1.77 + */
1.78 +CIniSection * CIniFile::AddOrFindIniSectionL(TPtr& aSectionName)
1.79 + {
1.80 + aSectionName.Trim();
1.81 +
1.82 + // DEFAULT section
1.83 + if (aSectionName.CompareF(KDefaultSectionName) == 0)
1.84 + {
1.85 + return iSectionArray[KDefaultSectionNumber];
1.86 + }
1.87 +
1.88 + // SCREENx section
1.89 + if (0 == aSectionName.FindF(KScreenSectionName))
1.90 + {
1.91 + TLex lex(aSectionName.Mid(KScreenSectionName().Length()));
1.92 + TInt screenNum;
1.93 + lex.SkipSpace();
1.94 + if (lex.Val(screenNum) == KErrNone)
1.95 + {
1.96 + return AddOrFindScreenSectionL(screenNum);
1.97 + }
1.98 + }
1.99 +
1.100 + // other section
1.101 + return AddOrFindNamedSectionL(aSectionName);
1.102 + }
1.103 +
1.104 +CIniSection * CIniFile::CreateSectionL(TInt aScreen)
1.105 + {
1.106 + CIniSection* newSection = new (ELeave) CIniSection(aScreen);
1.107 + CleanupStack::PushL( newSection ) ;
1.108 + newSection->ConstructL() ;
1.109 + User::LeaveIfError(iSectionArray.Append(newSection));
1.110 + CleanupStack::Pop( newSection ) ;
1.111 + if (aScreen + 1 > iScreenCount)
1.112 + iScreenCount = aScreen + 1;
1.113 + return newSection;
1.114 + }
1.115 +
1.116 +CIniSection * CIniFile::CreateSectionL(const TDesC& aName)
1.117 + {
1.118 + CIniSection* newSection = new (ELeave) CIniSection(KDefaultScreenId);
1.119 + CleanupStack::PushL( newSection ) ;
1.120 + newSection->ConstructL(aName) ;
1.121 + User::LeaveIfError(iSectionArray.Append(newSection));
1.122 + CleanupStack::Pop( newSection ) ;
1.123 + return newSection;
1.124 + }
1.125 +
1.126 +
1.127 +void CIniFile::doConstructL(RFile &aFile)
1.128 + {
1.129 + TFileText textFile;
1.130 + textFile.Set(aFile);
1.131 + const TInt KMaxIniLine=256;
1.132 + TBuf<KMaxIniLine> readLine;
1.133 + TBool first=ETrue;
1.134 +
1.135 + // always have a [DEFAULT] section
1.136 + CIniSection * currentSection = CreateSectionL(KDefaultSectionName);
1.137 +
1.138 + FOREVER
1.139 + {
1.140 + TInt err=textFile.Read(readLine);
1.141 + if (err==KErrEof)
1.142 + break;
1.143 + User::LeaveIfError(err);
1.144 +
1.145 + if (readLine.Length()>0)
1.146 + {
1.147 + if (first && (readLine[0]==0xFFFE || readLine[0]==0xFEFF))
1.148 + readLine.Delete(0,1);
1.149 +
1.150 + // Comment marker "//" indicates the rest of the line should be discarded
1.151 + TInt commentStart = readLine.Find(KCommentMarker);
1.152 + if (commentStart != KErrNotFound)
1.153 + {
1.154 + readLine.Delete(commentStart, readLine.Length());
1.155 + }
1.156 +
1.157 + // compact unnecessary whitespace
1.158 + readLine.TrimAll();
1.159 +
1.160 + // anything left in buffer?
1.161 + if (readLine.Length() > 0)
1.162 + {
1.163 + // section name requires "[" and "]"
1.164 + if (readLine[0] == KNewSection && readLine.LocateReverse(KNewSection2) == readLine.Length() - 1)
1.165 + {
1.166 + TPtr nameText = readLine.MidTPtr(1, readLine.Length() - 2); // strip [ and ]
1.167 + currentSection = AddOrFindIniSectionL(nameText);
1.168 + }
1.169 + else
1.170 + {
1.171 + if (currentSection)
1.172 + {
1.173 + currentSection->AddVariableL(readLine);
1.174 + }
1.175 + }
1.176 + }
1.177 + first=EFalse;
1.178 + }
1.179 + }
1.180 +
1.181 + if (iScreenCount == 0)
1.182 + {
1.183 + iScreenCount = 1;
1.184 + }
1.185 + }
1.186 +
1.187 +CIniFile* CIniFile::NewL()
1.188 + {
1.189 + CIniFile* self = new(ELeave) CIniFile();
1.190 + CleanupStack::PushL(self);
1.191 + self->ConstructL();
1.192 + CleanupStack::Pop(self);
1.193 + return self;
1.194 + }
1.195 +
1.196 +void CIniFile::FreeData()
1.197 + {
1.198 + iSectionArray.ResetAndDestroy() ;
1.199 + iScreenCount = 0;
1.200 + }
1.201 +
1.202 +void errFreeData(TAny *aIniFile)
1.203 + {
1.204 + ((CIniFile *)aIniFile)->FreeData();
1.205 + }
1.206 +
1.207 +HBufC* IniFileSearchPathLC()
1.208 + {
1.209 + _LIT(KPath,"\\SYSTEM\\DATA\\");
1.210 + _LIT(KPathSep,";");
1.211 + const TInt KLengthPerPath = 2 + KPath().Length();
1.212 + // work out which drive Wserv loaded from
1.213 + RProcess self;
1.214 + TFileName myPath = self.FileName();
1.215 + TParsePtrC myDrive(myPath);
1.216 + TDriveUnit myDriveUnit(myDrive.Drive());
1.217 + // need extra buffer space for search paths for drives Z: or C: ?
1.218 +#if defined(LOAD_INI_FILE_FROM_DRIVE_Z_OR_C)
1.219 + TInt numPaths = 2;
1.220 + if (myDriveUnit != EDriveZ && myDriveUnit != EDriveC)
1.221 + {
1.222 + numPaths += 1;
1.223 + }
1.224 +#else
1.225 + TInt numPaths = 1;
1.226 + if (myDriveUnit != EDriveZ)
1.227 + {
1.228 + numPaths += 1;
1.229 + }
1.230 +#endif
1.231 + HBufC* searchPath = HBufC::NewLC(numPaths * KLengthPerPath + (numPaths - 1) * KPathSep().Length());
1.232 + TPtr pPath(searchPath->Des());
1.233 + pPath.Append(myDrive.Drive());
1.234 + pPath.Append(KPath);
1.235 + if (myDriveUnit != EDriveZ)
1.236 + {
1.237 + pPath.Append(KPathSep);
1.238 + pPath.Append(TDriveUnit(EDriveZ).Name());
1.239 + pPath.Append(KPath);
1.240 + }
1.241 +#if defined(LOAD_INI_FILE_FROM_DRIVE_Z_OR_C)
1.242 + if (myDriveUnit != EDriveC)
1.243 + {
1.244 + pPath.Append(KPathSep);
1.245 + pPath.Append(TDriveUnit(EDriveC).Name());
1.246 + pPath.Append(KPath);
1.247 + }
1.248 +#endif
1.249 + return searchPath;
1.250 + }
1.251 +
1.252 +void CIniFile::ConstructL()
1.253 + {
1.254 + TAutoClose<RFs> fs;
1.255 + User::LeaveIfError(fs.iObj.Connect());
1.256 + fs.iObj.SetNotifyUser(EFalse);
1.257 + fs.PushL();
1.258 + HBufC* searchPath = IniFileSearchPathLC();
1.259 + _LIT(KFileName,"WSINI.INI");
1.260 + TFindFile findinifile(fs.iObj);
1.261 + TInt err=findinifile.FindByPath(KFileName,searchPath);
1.262 + User::LeaveIfError(err);
1.263 + CleanupStack::PopAndDestroy(searchPath);
1.264 + TAutoClose<RFile> file;
1.265 + User::LeaveIfError(file.iObj.Open(fs.iObj,findinifile.File(),EFileStreamText|EFileRead));
1.266 + file.PushL();
1.267 + CleanupStack::PushL(TCleanupItem(errFreeData,this));
1.268 + doConstructL(file.iObj);
1.269 + CleanupStack::Pop(); // TCleanupItem
1.270 + file.Pop();
1.271 + fs.Pop();
1.272 + }
1.273 +
1.274 +/* If the Section for the screen exists find the data, otherwise create a new data structure.
1.275 +
1.276 + @param aScreen Screen number
1.277 + @return index to section
1.278 + @leave KErrNoMemory
1.279 + */
1.280 +CIniSection * CIniFile::AddOrFindScreenSectionL(TInt aScreen)
1.281 + {
1.282 + CIniSection * section = FindSection(aScreen);
1.283 + if (!section)
1.284 + section = CreateSectionL(aScreen);
1.285 + return section;
1.286 + }
1.287 +
1.288 +/* If the Section exists find the data, otherwise create a new data structure.
1.289 +
1.290 + @param aName section name
1.291 + @return index to section
1.292 + @leave KErrNoMemory
1.293 + */
1.294 +CIniSection * CIniFile::AddOrFindNamedSectionL(const TDesC& aName)
1.295 + {
1.296 + CIniSection * section = FindSection(aName);
1.297 + if (!section)
1.298 + section = CreateSectionL(aName);
1.299 + return section;
1.300 + }
1.301 +
1.302 +TBool CIniFile::FindVar(const TDesC &aVarName, TPtrC &aResult)
1.303 + {
1.304 + return iSectionArray[KDefaultSectionNumber]->FindVar(aVarName, aResult);
1.305 + }
1.306 +
1.307 +
1.308 +TBool CIniFile::FindVar(const TDesC &aVarName, TInt &aResult)
1.309 + {
1.310 + return iSectionArray[KDefaultSectionNumber]->FindVar(aVarName, aResult);
1.311 + }
1.312 +
1.313 +TBool CIniFile::FindVar(const TDesC &aVarName)
1.314 +//
1.315 +// Used to simply detect the presence of the specified variable name
1.316 +//
1.317 + {
1.318 + TPtrC ptr(NULL,0);
1.319 + return FindVar(aVarName, ptr);
1.320 + }
1.321 +
1.322 +// FindVar in [SCREENx] sections
1.323 +TBool CIniFile::FindVar( TInt aScreen, const TDesC &aVarName)
1.324 + {
1.325 + TPtrC ptr(NULL,0);
1.326 + return FindVar(aScreen, aVarName, ptr);
1.327 + }
1.328 +
1.329 +TBool CIniFile::FindVar( TInt aScreen, const TDesC& aVarName, TPtrC &aResult )
1.330 + {
1.331 + CIniSection * section = FindSection(aScreen);
1.332 + TBool found = EFalse;
1.333 + if (section)
1.334 + found = section->FindVar(aVarName, aResult);
1.335 + if (!found)
1.336 + found = FindVar(aVarName, aResult);
1.337 + return found;
1.338 + }
1.339 +
1.340 +TBool CIniFile::FindVar(TInt aScreen, const TDesC &aVarName, TInt &aResult)
1.341 + {
1.342 + CIniSection * section = FindSection(aScreen);
1.343 + TBool found = EFalse;
1.344 + if (section)
1.345 + found = section->FindVar(aVarName, aResult);
1.346 + if (!found)
1.347 + found = FindVar(aVarName, aResult);
1.348 + return found;
1.349 + }
1.350 +
1.351 +// FindVar in named sections
1.352 +TBool CIniFile::FindVar(const TDesC& aSectionName, const TDesC &aVarName)
1.353 + {
1.354 + TPtrC ptr(NULL,0);
1.355 + return FindVar(aSectionName, aVarName, ptr);
1.356 + }
1.357 +
1.358 +TBool CIniFile::FindVar(const TDesC& aSectionName, const TDesC& aVarName, TPtrC &aResult )
1.359 + {
1.360 + CIniSection * section = FindSection(aSectionName);
1.361 + TBool found = EFalse;
1.362 + if (section)
1.363 + found = section->FindVar(aVarName, aResult);
1.364 + if (!found)
1.365 + found = FindVar(aVarName, aResult);
1.366 + return found;
1.367 + }
1.368 +
1.369 +TBool CIniFile::FindVar(const TDesC& aSectionName, const TDesC &aVarName, TInt &aResult)
1.370 + {
1.371 + CIniSection * section = FindSection(aSectionName);
1.372 + TBool found = EFalse;
1.373 + if (section)
1.374 + found = section->FindVar(aVarName, aResult);
1.375 + if (!found)
1.376 + found = FindVar(aVarName, aResult);
1.377 + return found;
1.378 + }
1.379 +
1.380 +TInt CIniFile::NumberOfScreens() const
1.381 + {
1.382 + return iScreenCount;
1.383 + }
1.384 +
1.385 +
1.386 +// CIniSection.
1.387 +// ini file structure is now in sections like this
1.388 +//
1.389 +// [DEFAULT]
1.390 +// varname value
1.391 +// varname2 value2
1.392 +// [SCREEN0]
1.393 +// screenvar value
1.394 +// etc
1.395 +//
1.396 +// CIniSection represents a section - i.e. section name and content pairs.
1.397 +// Content pairs are as ini file was previously (so use same code)
1.398 +// [default] section name is optional to support backwards compatibility
1.399 +// if no sutable value is found in a [screenN] section the [default] section will be searched.
1.400 +
1.401 +
1.402 +CIniSection::CIniSection(TInt aScreen) : iScreen(aScreen)
1.403 + {}
1.404 +
1.405 +void CIniSection::ConstructL()
1.406 + {
1.407 + iPtrArray = new (ELeave) CArrayPtrFlat<TDesC>(8) ;
1.408 + }
1.409 +
1.410 +void CIniSection::ConstructL(const TDesC& aName)
1.411 + {
1.412 + iName.CreateL(aName);
1.413 + ConstructL();
1.414 + }
1.415 +
1.416 +CIniSection::~CIniSection()
1.417 + {
1.418 + iName.Close();
1.419 + iPtrArray->ResetAndDestroy() ;
1.420 + delete iPtrArray ;
1.421 + }
1.422 +
1.423 +inline TInt CIniSection::Screen() const
1.424 + { return iScreen; }
1.425 +
1.426 +inline const TDesC& CIniSection::Name() const
1.427 + { return iName; }
1.428 +
1.429 +TBool CIniSection::FindVar( const TDesC& aVarName, TPtrC &aResult )
1.430 + {
1.431 + if (iPtrArray)
1.432 + {
1.433 + TInt index(KErrNotFound);
1.434 +
1.435 + if (FindVarName(aVarName, index))
1.436 + {
1.437 + TLex lex((*iPtrArray)[index]->Mid(aVarName.Length()));
1.438 + lex.SkipSpace();
1.439 + aResult.Set(lex.Remainder());
1.440 +
1.441 + if (wsDebugLog)
1.442 + {
1.443 + wsDebugLog->IniFileSettingRead(iScreen, aVarName, ETrue, aResult);
1.444 + }
1.445 + return(ETrue);
1.446 + }
1.447 + }
1.448 +
1.449 + if (wsDebugLog)
1.450 + {
1.451 + wsDebugLog->IniFileSettingRead(iScreen, aVarName, EFalse, KNullDesC);
1.452 + }
1.453 + return(EFalse);
1.454 + }
1.455 +
1.456 +/*
1.457 + create a TPtrC with just the first word (variable name) in the given string
1.458 + */
1.459 +TPtrC CIniSection::VarName(const TDesC& aVarString)
1.460 + {
1.461 + TInt varLength = aVarString.Locate(KSpaceChar);
1.462 + if (varLength == KErrNotFound)
1.463 + {
1.464 + varLength = aVarString.Length();
1.465 + }
1.466 + return aVarString.Left(varLength);
1.467 + }
1.468 +
1.469 +
1.470 +TBool CIniSection::FindVar(const TDesC &aVarName, TInt &aResult)
1.471 + {
1.472 + TPtrC ptr(NULL,0);
1.473 + // do text Find
1.474 + if (FindVar(aVarName, ptr))
1.475 + {
1.476 + TLex lex(ptr);
1.477 + _LIT(HexFormatCheck,"0x");
1.478 + TPtrC hexPtr(HexFormatCheck);
1.479 + if(ptr.Left(2) != hexPtr)
1.480 + {
1.481 + if (lex.Val(aResult) == KErrNone)
1.482 + {
1.483 + return ETrue;
1.484 + }
1.485 + }
1.486 + else
1.487 + {
1.488 + lex.SkipAndMark(2); //To skip 0x in hex code
1.489 + if (lex.Val((TUint32&)aResult, EHex) == KErrNone)
1.490 + {
1.491 + return ETrue;
1.492 + }
1.493 + }
1.494 + }
1.495 +
1.496 + return EFalse;
1.497 + }
1.498 +
1.499 +
1.500 +/*
1.501 + Find variable name in sorted array, using binary search
1.502 + @param aVarName variable name to search for, must have any space and variable value stripped.
1.503 + @param aIndex output index of matching or preceeding item
1.504 + @return
1.505 + */
1.506 +TBool CIniSection::FindVarName(const TDesC& aVarName, TInt& aIndex)
1.507 + {
1.508 + // Binary Search
1.509 + // left is lowest index to include, right is highest index + 1;
1.510 + TInt left = 0;
1.511 + TInt right = iPtrArray->Count();
1.512 +
1.513 + while (right > left)
1.514 + {
1.515 + TInt middle = (left + right)>>1;
1.516 + // compare to start of variable string
1.517 + TPtrC cmpString = VarName(*(*iPtrArray)[middle]);
1.518 + TInt cmp = aVarName.CompareF(cmpString);
1.519 +
1.520 + if (cmp == 0)
1.521 + {
1.522 + aIndex = middle;
1.523 + return ETrue;
1.524 + }
1.525 + else if (cmp > 0)
1.526 + {
1.527 + left = middle + 1;
1.528 + }
1.529 + else
1.530 + {
1.531 + right = middle;
1.532 + }
1.533 + }
1.534 +
1.535 + aIndex = right;
1.536 + return EFalse;
1.537 + }
1.538 +
1.539 +void CIniSection::AddVariableL(const TDesC& aNewVariable)
1.540 + {
1.541 + // use variable name only for search
1.542 + TPtrC varName = VarName(aNewVariable);
1.543 + TInt index(0);
1.544 +
1.545 + // ignore duplicate definitions
1.546 + if (0 == FindVarName(varName, index))
1.547 + { // insert in sorted array
1.548 + HBufC* hbuf = aNewVariable.AllocLC() ;
1.549 + iPtrArray->InsertL(index, hbuf);
1.550 + CleanupStack::Pop(hbuf);
1.551 + }
1.552 + }
1.553 +