// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// 8 and 16 bit ini file parser

// 

//

/**

 @file

 @internalAll

*/

#include "IniParserImpl.h"

#include "inifile.h"

#include "s32file.h"

namespace BSUL

{

/**

Creates a 8 bit section content iterator

this iterator is used to navigate through the key value pairs

within the section.Useful when the number of keys within the 

section is unknown.

@param aSectionName the name of the section to iterate

@param aIniDocument the document object containing the section

@return A pointer to a newly created CIniSecIter8 object

@leave	KErrNoMemory if not enough memory

		KErrArgument if aIniDocument is NULL

*/

EXPORT_C CIniSecIter8* CIniSecIter8::NewL(const TDesC8& aSectionName,const CIniDocument8* aIniDocument)

{

	CIniSecIter8* self=new (ELeave)CIniSecIter8();

	CleanupStack::PushL(self);

	self->iImpl=CIniSecIter8Impl::NewL(aSectionName,aIniDocument);

	CleanupStack::Pop();

	return self;	

}

/**

Return the next key value pair within the section

@param aKey a pointer to contain the key name

@param aValue a pointer to contain the key value

@return ETrue if there are keyvalue pairs to return

	    EFalse if it is already end of section

@post the iterator points to the next available keyvalue pair

	  the aKeyName points to  the key name

	  the aKeyValue points to the key value

*/	

EXPORT_C TBool CIniSecIter8::Next(TPtrC8& aKey,TPtrC8& aValue)

{

	return iImpl->Next(aKey,aValue);

}

/**

Look ahead in the section to check whether there is 

still any keyvalue pair in the section to be read

@return ETrue if it is already end of section

	    EFalse indicating the next keyvalue pair exists

*/

EXPORT_C TBool CIniSecIter8::End()

{

	return iImpl->End();

}

/**

Reset the iterator to point to the first keypair value within

the section.

@post the iterator now points to first keypair in the section

*/

EXPORT_C void CIniSecIter8::Reset()

{

	iImpl->Reset();

}

/**

Destructor

*/

EXPORT_C CIniSecIter8::~CIniSecIter8()

{

	delete iImpl;

}

//Default constructor

CIniSecIter8::CIniSecIter8()

{

}

//

/** 

Opening 8 bit ini file for reading.If the supplied file name is a valid

ini file, it will instantiate the object and read the content of 

the ini file.If file not found it will simply instantiate the object.

The file is opened for read only and close directly after the construction

of this object is complete.

User will need to explicitly call Externalise(aFileName) to write the content back to ini file.

@param aFs the handle to the file session

@param aFileName the ini file name to read from

@return A pointer to a newly created CIniDocument8 object

*/

EXPORT_C CIniDocument8* CIniDocument8::NewL(RFs& aFs,const TDesC& aFileName)

	{

	CIniDocument8* self=new (ELeave)CIniDocument8();

	CleanupStack::PushL(self);

	self->iImpl=CIniDocument8Impl::NewL(aFs,aFileName);

	CleanupStack::Pop();

	return self;	

	}

/**

Externalise the buffered content to an output file name

This will first write into a temporary file in the same directory and path

as the supplied aFileName.It will then replace the existing file or 

create a new file if does not exist yet.

@param aFileName the output file name to write to

@return KErrNone if no error

		Other System Wide errors

*/

EXPORT_C TInt CIniDocument8::Externalise(const TDesC& aFileName)

{

	TRAPD(r,iImpl->FlushL(aFileName));

	return r;

}

/**

Compare this document against another for differences.

@param aDoc to compare against.

@return True if same

		Otherwise false

*/

EXPORT_C TBool CIniDocument8::CompareDocs(CIniDocument8& aDoc) 

	{

	return (iImpl->CompareDocs( *(aDoc.iImpl) ));

	}	

/** 

Get an array of the section name present in the ini document object

Note that any items inside this array will be cleared and the array will

be populated with the sections' names from this document object.

@param aSectionList an array of descriptor to contain the section name

@return KErrNone if successful, otherwise another of the system-wide error codes

@post aSectionList contains all the section name in the document object

*/

EXPORT_C TInt CIniDocument8::GetSectionList(RArray<TPtrC8>& aSectionList) const

	{

	return iImpl->GetSectionList(aSectionList);

	}

/**

Get the value of a key within a section

@param aSectionName the section where the key resides

@param aKey the key name

@param aValue pointer to the key value

@return

	KErrNotFound if either section or keyname not found

	KErrNone if successful

@post aKeyValue now points to the key value

*/

EXPORT_C TInt CIniDocument8::GetKeyValue(const TDesC8& aSectionName,const TDesC8& aKey,TPtrC8& aValue) const

	{

	TRAPD(ret,iImpl->GetKeyValueL(aSectionName,aKey,aValue));

	return ret;

	}

/**

Add a section to the ini document object

@param aSectionName the name of the section to be added

@return

	KErrNone if successful

	KErrAlreadyExists if the section with that name already exists

	Any other system wide error code

@post a section with that name is created and added to the document object

*/

EXPORT_C TInt CIniDocument8::AddSection(const TDesC8& aSectionName)

	{

	TRAPD(ret,iImpl->AddSectionL(aSectionName));

	return ret;	

	}

/**

Remove an existing section from the ini document object

@param aSectionName the name of the section to be removed

@return KErrNone if successful

	    KErrNotFound if section does not exist

	    Any other system wide error code

@post if exist that section is removed from the document object	

*/	

EXPORT_C TInt CIniDocument8::RemoveSection(const TDesC8& aSectionName)

	{

	TRAPD(ret,iImpl->RemoveSectionL(aSectionName));

	return ret;

	}

/**

Set the value of a key within a section.

This API offers the following flexibility:

-If section does not exist,create a section and key and value

-If section exists but key does not exist, create the key and value

-Else replace the existing key value with the new value

@param aSectionName the name of the section

@param aKey the name of the key

@param aValue the new value for this key

@return

	KErrNone if successful,any other system wide error code

*/

EXPORT_C TInt CIniDocument8::SetKey(const TDesC8& aSectionName,const TDesC8& aKey,const TDesC8& aValue)

	{

	TRAPD(ret,iImpl->SetKeyL(aSectionName,aKey,aValue));	

	return ret;

	}

/**

Remove an existing key within a section

if supplied section or key name does not exist, it does nothing

@param aSectionName the name of the section where the key resides

@param aKey the name of the key to be removed

@post if exist that key is removed from the section

*/

EXPORT_C TInt CIniDocument8::RemoveKey(const TDesC8& aSectionName,const TDesC8& aKey)

	{

	TRAPD(ret,iImpl->RemoveKeyL(aSectionName,aKey));

	return ret;	

	}

/**

Destructor

*/	

EXPORT_C CIniDocument8::~CIniDocument8()

	{

	delete iImpl;

	}

CIniDocument8::CIniDocument8()

{

}

//

/**

Creates a 8 bit light weight parser

@param aFs the handle to the file session

@param aFileName the ini file name to open

@return A pointer to a newly created CIniFile8 object

@leave	KErrNoMemory if not enough memory

		KErrNotFound if the supplied file does not exist

*/

EXPORT_C CIniFile8* CIniFile8::NewL(RFs& aFs,const TDesC& aFileName)

	{

	CIniFile8* self=new (ELeave)CIniFile8;

	CleanupStack::PushL(self);

	self->iImpl=CIniFile8Impl::NewL(aFs,aFileName);

	CleanupStack::Pop();

	return self;

	}

/**

Public destructor

*/	

EXPORT_C CIniFile8::~CIniFile8()

	{

	delete iImpl;	

	}

/**

Get the value of a key within a section

@param aSectionName the section where the key resides

@param aKeyName the key name

@param aValue pointer to the key value

@return

	KErrNotFound if either section or keyname not found

	KErrNone if successful

*/	

EXPORT_C TInt CIniFile8::FindVar(const TDesC8& aSectionName,const TDesC8& aKeyName,TPtrC8& aValue)	const

	{

	return iImpl->FindVar(aSectionName,aKeyName,aValue);

	}

CIniFile8::CIniFile8(){}

//

/**

Creates a 16 bit section content iterator

this iterator is used to navigate through the key value pairs

within the section.Useful when the number of keys within the 

section is unknown.

@param aSectionName the name of the section to iterate

@param aIniDocument the document object containing the section

@return A pointer to a newly created CIniSecIter16 object

@leave	KErrNoMemory if not enough memory

		KErrArgument if aIniDocument is NULL

*/

EXPORT_C CIniSecIter16* CIniSecIter16::NewL(const TDesC16& aSectionName,const CIniDocument16* aIniDocument)

{

	CIniSecIter16* self=new (ELeave)CIniSecIter16();

	CleanupStack::PushL(self);

	self->iImpl=CIniSecIter16Impl::NewL(aSectionName,aIniDocument);

	CleanupStack::Pop();

	return self;	

}

/**

Return the next key value pair within the section

@param aKey a pointer to contain the key name

@param aValue a pointer to contain the key value

@return ETrue if there are keyvalue pairs to return

	    EFalse if it is already end of section

@post the iterator points to the next available keyvalue pair

	  the aKeyName points to  the key name

	  the aKeyValue points to the key value

*/	

EXPORT_C TBool CIniSecIter16::Next(TPtrC16& aKey,TPtrC16& aValue)

{

	return iImpl->Next(aKey,aValue);

}

/**

Look ahead in the section to check whether there is 

still any keyvalue pair in the section to be read

@return ETrue if it is already end of section

	    EFalse indicating the next keyvalue pair exists

*/

EXPORT_C TBool CIniSecIter16::End()

{

	return iImpl->End();

}

/**

Reset the iterator to point to the first keypair value within

the section.

@post the iterator now points to first keypair in the section

*/

EXPORT_C void CIniSecIter16::Reset()

{

	iImpl->Reset();

}

/**

Destructor

*/

EXPORT_C CIniSecIter16::~CIniSecIter16()

{

	delete iImpl;

}

//Default constructor

CIniSecIter16::CIniSecIter16()

{

}

//

/** 

Opening 16 bit ini file for reading.If the supplied file name is a valid

ini file, it will instantiate the object and read the content of 

the ini file.If file not found it will simply instantiate the object.

The file is opened for read only and close directly after the construction

of this object is complete.

User will need to explicitly call Externalise(aFileName) to write the content back to ini file.

@param aFs the handle to the file session

@param aFileName the ini file name to read from

@return A pointer to a newly created CIniDocument16 object

*/

EXPORT_C CIniDocument16* CIniDocument16::NewL(RFs& aFs,const TDesC& aFileName)

	{

	CIniDocument16* self=new (ELeave)CIniDocument16();

	CleanupStack::PushL(self);

	self->iImpl=CIniDocument16Impl::NewL(aFs,aFileName);

	CleanupStack::Pop();

	return self;	

	}

/**

Flush the buffered content to an output file name

This will first write into a temporary file in the same directory and path

as the supplied aFileName.It will then replace the existing file or 

create a new file if does not exist yet.

@param aFileName the output file name to write to

@return KErrNone if no error

		Other System Wide errors

*/

EXPORT_C TInt CIniDocument16::Externalise(const TDesC& aFileName)

{

	TRAPD(r,iImpl->FlushL(aFileName));

	return r;

}

/** 

Get an array of the section name present in the ini document object

Note that any items inside this array will be cleared and the array will

be populated with the sections' names from this document object.

@param aSectionList an array of descriptor to contain the section name

@return KErrNone if successful, otherwise another of the system-wide error codes

@post aSectionList contains all the section name in the document object

*/

EXPORT_C TInt CIniDocument16::GetSectionList(RArray<TPtrC16>& aSectionList) const

	{

	return iImpl->GetSectionList(aSectionList);

	}

/**

Get the value of a key within a section

@param aSectionName the section where the key resides

@param aKey the key name

@param aValue pointer to the key value

@return

	KErrNotFound if either section or keyname not found

	KErrNone if successful

@post aKeyValue now points to the key value

*/

EXPORT_C TInt CIniDocument16::GetKeyValue(const TDesC16& aSectionName,const TDesC16& aKey,TPtrC16& aValue) const

	{

	TRAPD(ret,iImpl->GetKeyValueL(aSectionName,aKey,aValue));

	return ret;

	}

/**

Add a section to the ini document object

@param aSectionName the name of the section to be added

@return

	KErrNone if successful

	KErrAlreadyExists if the section with that name already exists

	Any other system wide error code

@post a section with that name is created and added to the document object

*/

EXPORT_C TInt CIniDocument16::AddSection(const TDesC16& aSectionName)

	{

	TRAPD(ret,iImpl->AddSectionL(aSectionName));

	return ret;	

	}

/**

Remove an existing section from the ini document object

@param aSectionName the name of the section to be removed

@return KErrNone if successful

	    KErrNotFound if section does not exist

	    Any other system wide error code

@post if exist that section is removed from the document object	

*/	

EXPORT_C TInt CIniDocument16::RemoveSection(const TDesC16& aSectionName)

	{

	TRAPD(ret,iImpl->RemoveSectionL(aSectionName));

	return ret;

	}

/**

Set the value of a key within a section.

This API offers the following flexibility:

-If section does not exist,create a section and key and value

-If section exists but key does not exist, create the key and value

-Else replace the existing key value with the new value

@param aSectionName the name of the section

@param aKey the name of the key

@param aValue the new value for this key

@return

	KErrNone if successful,any other system wide error code

*/

EXPORT_C TInt CIniDocument16::SetKey(const TDesC16& aSectionName,const TDesC16& aKey,const TDesC16& aValue)

	{

	TRAPD(ret,iImpl->SetKeyL(aSectionName,aKey,aValue));	

	return ret;

	}

/**

Remove an existing key within a section

if supplied section or key name does not exist, it does nothing

@param aSectionName the name of the section where the key resides

@param aKey the name of the key to be removed

@post if exist that key is removed from the section

*/

EXPORT_C TInt CIniDocument16::RemoveKey(const TDesC16& aSectionName,const TDesC16& aKey)

	{

	TRAPD(ret,iImpl->RemoveKeyL(aSectionName,aKey));

	return ret;	

	}

/**

Compare two document objects. If names, keys or values differ, a false is returned,

else a true is returned.

@param aDoc name of the document to compare against this object.

*/

EXPORT_C TBool CIniDocument16::CompareDocs(CIniDocument16& aDoc)	

	{

	return (iImpl->CompareDocs( *(aDoc.iImpl) ));

	}	

/**

Destructor

*/	

EXPORT_C CIniDocument16::~CIniDocument16()

	{

	delete iImpl;

	}

CIniDocument16::CIniDocument16(){}

//

/**

Creates a 16 bit light weight parser

@param aFs the handle to the file session

@param aFileName the ini file name to open

@return A pointer to a newly created CIniFile16 object

@leave	KErrNoMemory if not enough memory

		KErrNotFound if the supplied file does not exist

*/

EXPORT_C CIniFile16* CIniFile16::NewL(RFs& aFs,const TDesC& aFileName)

	{

	return CIniFile16::NewL(aFs,aFileName,EFalse);

	}

/**

Creates a 16 bit light weight parser

@param aFs the handle to the file session

@param aFileName the ini file name to open

@param aConvert8To16 upconvert 8 bit files otherwise leave with KErrCorrupt

@return A pointer to a newly created CIniFile16 object

@leave	KErrNoMemory if not enough memory

		KErrNotFound if the supplied file does not exist

*/

EXPORT_C CIniFile16* CIniFile16::NewL(RFs& aFs,const TDesC& aFileName,TBool aConvert8To16)

	{

	CIniFile16* self=new (ELeave)CIniFile16;

	CleanupStack::PushL(self);