sl@0: // Copyright (c) 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: // Parse the ini file
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0: @file
sl@0: @test
sl@0: @internalComponent
sl@0: */
sl@0: 
sl@0: #include "PARSEINIDATA.H"
sl@0: #include <f32file.h>
sl@0: #include <e32std.h>
sl@0: 
sl@0: // Default directory to look for INI file
sl@0: _LIT(KIniFileDir,"Z:\\System\\Data\\");
sl@0: 
sl@0: // Constant Value changed for DEF047130 fix
sl@0: const TInt KTokenSize = 256;
sl@0: 
sl@0: enum TIniPanic
sl@0: 	{
sl@0: 	ESectionNameTooBig,
sl@0: 	EKeyNameTooBig,
sl@0: 	};
sl@0: 
sl@0: //
sl@0: void Panic(TIniPanic aPanic)
sl@0: 	{
sl@0: 	_LIT(CIniData,"CIniData");
sl@0: 	User::Panic(CIniData,aPanic);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructor
sl@0: */
sl@0: CIniData::CIniData() : iPtr(NULL,0)
sl@0: 	{
sl@0: 	__DECLARE_NAME(_S("CIniData"));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Destructor.
sl@0: Frees the resources located in second-phase constructor
sl@0: */
sl@0: CIniData::~CIniData()
sl@0: 	{
sl@0: 	delete (TText*)iPtr.Ptr();
sl@0: 	delete iToken;
sl@0: 	delete iName;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  Creates, and returns a pointer to CIniData object, leave on failure
sl@0:  @param aName the name of the file which contains the ini data
sl@0:  @param aDelimeter	Delimiter used in wsini.ini file between variable and value
sl@0:  @return A pointer to the CiniData object
sl@0: */
sl@0: CIniData* CIniData::NewL(const TDesC& aName, char aDelimiter)
sl@0: 	{
sl@0: 	CIniData* p = new(ELeave) CIniData;
sl@0: 	CleanupStack::PushL(p);
sl@0: 	p->ConstructL(aName, aDelimiter);
sl@0: 	CleanupStack::Pop();
sl@0: 	return p;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  Second-phase constructor.
sl@0:  The function attempts to allocate a buffer and Read file's contents into iPtr
sl@0:  @param aName the name of the file which contains the ini data
sl@0:  @param aDelimeter	Delimiter used in wsini.ini file between variable and value
sl@0:  @leave One of the system-wide error codes
sl@0: */
sl@0: void CIniData::ConstructL(const TDesC& aName, char aDelimiter)
sl@0: 	{
sl@0: 	//Set delimiter
sl@0: 	iDelimiter = aDelimiter;
sl@0: 	
sl@0:  	// Allocate space for token
sl@0: 	iToken=HBufC::NewL(KTokenSize+2);	// 2 extra chars for [tokenName]
sl@0: 
sl@0: 	// Connect to file server
sl@0: 	TAutoClose<RFs> fs;
sl@0: 	User::LeaveIfError(fs.iObj.Connect());
sl@0: 	fs.PushL();
sl@0: 
sl@0: 	// Find file, given name
sl@0: 	TFindFile ff(fs.iObj);
sl@0: 	User::LeaveIfError(ff.FindByDir(aName, KIniFileDir));
sl@0: 	iName = ff.File().AllocL();
sl@0: 
sl@0: 	// Open file
sl@0: 	TAutoClose<RFile> file;
sl@0: 	TInt size;
sl@0: 	User::LeaveIfError(file.iObj.Open(fs.iObj,*iName,EFileStreamText|EFileShareReadersOrWriters));
sl@0: 	file.PushL();
sl@0: 
sl@0: 	// Get file size and read in
sl@0: 	User::LeaveIfError(file.iObj.Size(size));
sl@0: 	TText* data = (TText*)User::AllocL(size);
sl@0: 	iPtr.Set(data, size/sizeof(TText), size/sizeof(TText));
sl@0: 	TPtr8 dest((TUint8*)data, 0, size);
sl@0: 	User::LeaveIfError(file.iObj.Read(dest));
sl@0: 	TUint8* ptr = (TUint8*)data;
sl@0: 
sl@0: 	//
sl@0: 	// This is orderred as FEFF assuming the processor is Little Endian
sl@0: 	// The data in the file is FFFE.		PRR 28/9/98
sl@0: 	//
sl@0: 	if(size>=(TInt)sizeof(TText) && iPtr[0]==0xFEFF)
sl@0: 	{
sl@0: 		// UNICODE Text file so lose the FFFE
sl@0: 		Mem::Copy(ptr, ptr+sizeof(TText), size-sizeof(TText));
sl@0: 		iPtr.Set(data, size/sizeof(TText)-1, size/sizeof(TText)-1);
sl@0: 	}
sl@0: 	else if(size)
sl@0: 	{
sl@0: 		// NON-UNICODE so convert to UNICODE
sl@0: 		TText* newdata = (TText*)User::AllocL(size*sizeof(TText));
sl@0: 		iPtr.Set(newdata, size, size);
sl@0: 		TInt i;
sl@0: 		for(i = 0 ; i<size ; ++i)
sl@0: 			iPtr[i] = ptr[i];
sl@0: 		delete data;
sl@0: 	}
sl@0: 
sl@0: 	file.Pop();
sl@0: 	fs.Pop();
sl@0: }
sl@0: 
sl@0: /**
sl@0: Find a text value from given aKeyName regardless the section in the ini data file
sl@0: @param aKeyName Key being searched for
sl@0: @param aResult On return, contains the text result 
sl@0: @return ETrue if found, otherwise EFalse
sl@0: */
sl@0: TBool CIniData::FindVar(const TDesC& aKeyName, TPtrC& aResult)
sl@0: 	{
sl@0: 	// Call with no section, so starts at beginning
sl@0: 	if (FindVar((TDesC&)KNullDesC , aKeyName, aResult))
sl@0: 		return(ETrue);
sl@0: 	else
sl@0: 		return(EFalse);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Find a text value from given aKeyName and aSecName in the ini data file
sl@0: @param aSectName Section containing key
sl@0: @param aKeyName Key being searched for in aSectName
sl@0: @param aResult On return, contains the text result 
sl@0: @return ETrue if found, otherwise EFalse
sl@0: */
sl@0: TBool CIniData::FindVar(const TDesC& aSectName,const TDesC& aKeyName,TPtrC& aResult)
sl@0: 	{
sl@0: 
sl@0: 	__ASSERT_DEBUG(aSectName.Length()<=KTokenSize,Panic(ESectionNameTooBig));
sl@0: 	__ASSERT_DEBUG(aKeyName.Length()<=KTokenSize,Panic(EKeyNameTooBig));
sl@0: 
sl@0: 	TInt posStartOfSection(0);
sl@0: 	TInt posEndOfSection(iPtr.Length()); // Default to the entire length of the ini data
sl@0: 	TPtrC SearchBuf;
sl@0: 
sl@0: 	// If we have a section, set pos to section start
sl@0: 	TInt posI(0);	// Position in internal data Buffer
sl@0: 	if( aSectName.Length() > 0 )
sl@0: 		{
sl@0: 		TBool FoundSection(false);
sl@0: 		while ( ! FoundSection )
sl@0: 			{
sl@0: 			// Move search buffer to next area of interest
sl@0: 			SearchBuf.Set(iPtr.Mid(posI));
sl@0: 
sl@0: 			// Make up token "[SECTIONNAME]", to search for
sl@0: 			TPtr sectionToken = iToken->Des();
sl@0: 			_LIT(sectionTokenFmtString,"[%S]");
sl@0: 			sectionToken.Format(sectionTokenFmtString,&aSectName);
sl@0: 
sl@0: 			// Search for next occurrence of aSectName
sl@0: 			TInt posSB = SearchBuf.Find(sectionToken);
sl@0: 
sl@0: 			if (posSB == KErrNotFound)
sl@0: 				return(EFalse);
sl@0: 
sl@0: 			// Check this is at beginning of line (ie. non-commented)
sl@0: 			// ie. Check preceding char was LF
sl@0: 			if(posSB>0)
sl@0: 				{
sl@0: 				// Create a Buffer, starting one char before found subBuf
sl@0: 				TPtrC CharBefore(SearchBuf.Right(SearchBuf.Length()-posSB+1));
sl@0: 				// Check first char is end of prev
sl@0: 				if(CharBefore[0] == '\n')
sl@0: 					{
sl@0: 					FoundSection = ETrue;		// found
sl@0: 					posI = posI + posSB;
sl@0: 					}
sl@0: 				else
sl@0: 					{
sl@0: 					posI = posI + posSB + 1;	// try again
sl@0: 					}
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				FoundSection = ETrue;
sl@0: 				}
sl@0: 
sl@0: 			}	// while ( ! FoundSection ) 
sl@0: 
sl@0: 		// Set start of section, after section name, (incl '[' and ']')
sl@0: 		posStartOfSection = posI + aSectName.Length() + 2;
sl@0: 
sl@0: 		// Set end of section, by finding begin of next section or end
sl@0: 		SearchBuf.Set(iPtr.Mid(posI));
sl@0: 		_LIT(nextSectionBuf,"\n[");
sl@0: 		TInt posSB = SearchBuf.Find(nextSectionBuf);
sl@0: 		if(posSB != KErrNotFound)
sl@0: 			{
sl@0: 			posEndOfSection = posI + posSB;
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			posEndOfSection = iPtr.Length();
sl@0: 			}
sl@0: 
sl@0: 		}	// if( aSectName.Length() > 0 )
sl@0: 
sl@0: 	// Look for key in ini file data Buffer
sl@0: 	posI = posStartOfSection;
sl@0: 	TBool FoundKey(false);
sl@0: 	while ( ! FoundKey )
sl@0: 		{
sl@0: 		// Search for next occurrence of aKeyName
sl@0: 		SearchBuf.Set(iPtr.Mid(posI,posEndOfSection-posI));
sl@0: 		TInt posSB = SearchBuf.Find(aKeyName);
sl@0: 
sl@0: 		// If not found, return
sl@0: 		if (posSB == KErrNotFound)
sl@0: 			return(EFalse);
sl@0: 
sl@0: 		// Check this is at beginning of line (ie. non-commented)
sl@0: 		// ie. Check preceding char was CR or LF
sl@0: 		if(posSB>0)
sl@0: 			{
sl@0: 			// Create a Buffer, starting one char before found subBuf
sl@0: 			TPtrC CharBefore(SearchBuf.Right(SearchBuf.Length()-posSB+1));
sl@0: 			// Check if the first char is end of prev and also check 
sl@0: 			// if the token found is not a substring of another string  
sl@0: 			TBool beginningOK = ((CharBefore[0] == '\n') || (CharBefore[0] == ' ') || (CharBefore[0] == '\t'));
sl@0: 			TBool endingOK = ((CharBefore[aKeyName.Length()+1] == iDelimiter) || (CharBefore[aKeyName.Length()+1] == ' ') || (CharBefore[aKeyName.Length()+1] == '\t'));
sl@0: 			if (beginningOK && endingOK)
sl@0: 				{
sl@0: 				FoundKey = ETrue;
sl@0: 				posI = posI + posSB;
sl@0: 				}
sl@0: 			else
sl@0: 				{
sl@0: 				posI = posI + posSB + 1;
sl@0: 				}
sl@0: 			}
sl@0: 		else
sl@0: 			{
sl@0: 			FoundKey = ETrue;
sl@0: 			}
sl@0: 		}	// while ( ! FoundKey )
sl@0: 
sl@0: 	// Set pos, to just after iDelimiter sign
sl@0: 	SearchBuf.Set(iPtr.Mid(posI));
sl@0: 	TInt posSB = SearchBuf.Locate(iDelimiter);
sl@0: 	if(posSB==KErrNotFound)		// Illegal format, should flag this...
sl@0: 		return(EFalse);
sl@0: 
sl@0: 	// Identify start and end of data (EOL or EOF)
sl@0: 	posI = posI + posSB + 1;	// 1 char after iDelimiter
sl@0: 	TInt posValStart = posI;
sl@0: 	TInt posValEnd;
sl@0: 	SearchBuf.Set(iPtr.Mid(posI));
sl@0: 	posSB = SearchBuf.Locate('\r');
sl@0: 	if(posSB != KErrNotFound)
sl@0: 		{
sl@0: 		posValEnd = posI + posSB;
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		posValEnd = iPtr.Length();
sl@0: 		}
sl@0: 
sl@0: 	// Check we are still in the section requested
sl@0: 	if( aSectName.Length() > 0 )
sl@0: 		{
sl@0: 		if( posValEnd > posEndOfSection )
sl@0: 			{
sl@0: 			return(EFalse);
sl@0: 			}
sl@0: 		}
sl@0: 	// Parse Buffer from posn of key
sl@0: 	// Start one space after '='
sl@0: 	TLex lex(iPtr.Mid(posValStart, posValEnd-posValStart));
sl@0: 	lex.SkipSpaceAndMark();		// Should be at the start of the data
sl@0: 	aResult.Set(lex.MarkedToken().Ptr(),posValEnd-posValStart - lex.Offset() );
sl@0: 	return(ETrue);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Find an integer value from given aKeyName regardless the section in the ini data file
sl@0: @param aKeyName Key being searched for
sl@0: @param aResult On return, contains the TInt result 
sl@0: @return ETrue if found, otherwise EFalse
sl@0: */
sl@0: TBool CIniData::FindVar(const TDesC& aKeyName, TInt& aResult)
sl@0: 	{
sl@0: 	TPtrC ptr(NULL,0);
sl@0: 	if (FindVar(aKeyName,ptr))
sl@0: 		{
sl@0: 		TLex lex(ptr);
sl@0: 		if (lex.Val(aResult) == KErrNone)
sl@0: 			return(ETrue);
sl@0: 		}
sl@0: 	return(EFalse);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Find an integer value from given aKeyName and aSecName in the ini data file
sl@0: @param aSectName Section containing key
sl@0: @param aKeyName Key being searched for  in aSectName
sl@0: @param aResult On return, contains TInt result 
sl@0: @return ETrue if found, otherwise EFalse
sl@0: */
sl@0: TBool CIniData::FindVar(const TDesC& aSection,const TDesC& aKeyName,TInt& aResult)
sl@0: 	{
sl@0: 	TPtrC ptr(NULL,0);
sl@0: 	if (FindVar(aSection,aKeyName,ptr))
sl@0: 		{
sl@0: 		TLex lex(ptr);
sl@0: 		if (lex.Val(aResult) == KErrNone)
sl@0: 			return(ETrue);
sl@0: 		}
sl@0: 	return(EFalse);
sl@0: }