/*

* Copyright (c) 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: This module contains implementation of 

* CTestModuleList class and CTestModuleInfo class member functions.

*

*/

// INCLUDE FILES

#include "TestModuleInfo.h"

#include <e32svr.h>

#include "Logging.h"

// EXTERNAL DATA STRUCTURES

// None

// EXTERNAL FUNCTION PROTOTYPES

// None

// CONSTANTS

// None

// MACROS

// None

// LOCAL CONSTANTS AND MACROS

// None

// MODULE DATA STRUCTURES

// None

// LOCAL FUNCTION PROTOTYPES

// None

// FORWARD DECLARATIONS

// None

// ==================== LOCAL FUNCTIONS =======================================

// None

#define LOGGER iLogger

// ================= MEMBER FUNCTIONS =========================================

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: CTestModuleInfo

    Description: Default constructor

    C++ default constructor can NOT contain any code, that

    might leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestModuleInfo::CTestModuleInfo()

    {

	iLogger = NULL;

    iModuleName = NULL;

    iIniFileName = NULL;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: ConstructL

    Description: Symbian OS second phase constructor

    Symbian OS default constructor can leave.

    Parameters: aModuleName: module name

                aLogger: pointer to stif logger

    Return Values: None

    Errors/Exceptions:

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestModuleInfo::ConstructL(TDesC& aModuleName, CStifLogger* aLogger)

    {

	iLogger = aLogger;

	if(iModuleName)

	    {

        delete iModuleName;

		iModuleName = NULL;

        }

    iModuleName = aModuleName.AllocL();

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: NewL

    Description: Two-phased constructor.

    Parameters: aModuleName: module name

                aLogger: pointer to stif logger

    Return Values: CTestModuleInfo* : pointer to created object

    Errors/Exceptions: Leaves if memory allocation for object fails

                       Leaves if ConstructL leaves

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestModuleInfo* CTestModuleInfo::NewL(TDesC& aModuleName, CStifLogger* aLogger)

    {

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

    CleanupStack::PushL(self);

    self->ConstructL(aModuleName, aLogger);

    CleanupStack::Pop(self);

    return self;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: ~CTestModuleInfo

    Description: Destructor.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestModuleInfo::~CTestModuleInfo()

    {

    delete iModuleName;

    delete iIniFileName;

    iCfgFiles.ResetAndDestroy();

    iCfgFiles.Close();

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: SetIniFile

    Description: Set ini file

    Parameters: aIniFileName: initialization file name

    Return Values: KErrNone if everything went ok

                   KErrAlreadyExists if ini file was already set

                   Symbian error code otherwise

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CTestModuleInfo::SetIniFile(TDesC& aIniFileName)

    {

	if(iIniFileName)

	    {

        return KErrAlreadyExists;

        }

    TRAPD(err, iIniFileName = aIniFileName.AllocL());

    if(err != KErrNone)

        {

        if(iLogger)

            {

            __TRACE(KError, (_L("Could not create descriptor (CTestModuleInfo::SetIniFile) for string '%S'. Error %d."), &aIniFileName, err));

            }

        else

            {

            RDebug::Print(_L("Could not create descriptor (CTestModuleInfo::SetIniFile) for string '%S'. Error %d."), &aIniFileName, err);

            }

        return err;

        }

    return KErrNone;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: AddCfgFile

    Description: Add config file if it is not yet added to the array

    Parameters: aCfgFileName: file name

    Return Values: KErrNone if everything went ok

                   KErrAlreadyExists if config file is already present

                   Symbian error code otherwise

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CTestModuleInfo::AddCfgFile(TDesC& aCfgFileName)

    {

    //Check if given file name does not exist already

    TInt cnt = iCfgFiles.Count();

    TInt i;

    TFileName cfgFileName;

    //Check if given module is already on the list

    for(i = 0; i < cnt; i++)

        {

        iCfgFiles[i]->GetCfgFileName(cfgFileName);

        if(cfgFileName == aCfgFileName)

            {

            return KErrAlreadyExists;

			}

        }

    //Add to array

    TInt err = KErrNone;

    CTestCaseFileInfo* tmp = NULL;

    TRAP(err, tmp = CTestCaseFileInfo::NewL(aCfgFileName, iLogger));

    if(err != KErrNone)

        {

        if(iLogger)

            {

            __TRACE(KError, (_L("Could not create CTestCaseFileInfo object (CTestModuleInfo::AddCfgFile). Error %d."), err));

            }

        else

            {

            RDebug::Print(_L("Could not create CTestCaseFileInfo object (CTestModuleInfo::AddCfgFile). Error %d."), err);

            }

		return err;

        }

    if(!tmp)

        {

        if(iLogger)

            {

            __TRACE(KError, (_L("Could not create CTestCaseFileInfo object (CTestModuleInfo::AddCfgFile)")));

            }

        else

            {

            RDebug::Print(_L("Could not create CTestCaseFileInfo object (CTestModuleInfo::AddCfgFile)"));

            }

		return KErrGeneral;

        }

    err = iCfgFiles.Append(tmp);

    if(err != KErrNone)

        {

        if(iLogger)

            {

            __TRACE(KError, (_L("Could not append CTestCaseFileInfo object to array (CTestModuleInfo::AddCfgFile). Error %d."), err));

            }

        else

            {

            RDebug::Print(_L("Could not append CTestCaseFileInfo object to array (CTestModuleInfo::AddCfgFile). Error %d."), err);

            }

        delete tmp;

        return err;

        }

    return KErrNone;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: CountCfgFiles

    Description: Return number of config files

    Parameters: None

    Return Values: number of config files

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CTestModuleInfo::CountCfgFiles(void)

    {

    return iCfgFiles.Count();

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: GetModuleName

    Description: Get module name

    Parameters: None

    Return Values:

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CTestModuleInfo::GetModuleName(TDes& aModuleName)

    {

    aModuleName.Zero();

    if(iModuleName)

        {

        aModuleName.Copy(*iModuleName);

        }

    return KErrNone;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: GetIniFileName

    Description: Get module ini file name

    Parameters: None

    Return Values:

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CTestModuleInfo::GetIniFileName(TDes& aIniFileName)

    {

    aIniFileName.Zero();

    if(iIniFileName)

        {

        aIniFileName.Copy(*iIniFileName);

        }

    return KErrNone;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: GetCfgFileName

    Description: Get config file name

    Parameters: aIndex: index of config file

    Return Values: TDesC&: config file name

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

EXPORT_C TInt CTestModuleInfo::GetCfgFileName(TInt aIndex, TDes& aCfgFileName)

    {

    aCfgFileName.Zero();

    TInt cnt = iCfgFiles.Count();

    //Check index

    if(aIndex >= cnt || aIndex < 0)

        {

        if(iLogger)

            {

            __TRACE(KError, (_L("Given index reaches out of array (CTestModuleInfo::GetCfgFileName). Given index: %d. Max allowed index: %d"), aIndex, cnt - 1));

            }

        else

            {

            RDebug::Print(_L("Given index reaches out of array (CTestModuleInfo::GetCfgFileName). Given index: %d. Max allowed index: %d"), aIndex, cnt - 1);

            }

        return KErrArgument;

        }

    TInt ret = iCfgFiles[aIndex]->GetCfgFileName(aCfgFileName);

    return ret;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleInfo

    Method: GetUncheckedCfgFile

    Description: Get first unchecked test case file

    Parameters: None

    Return Values: Pointer to CTestCaseFileInfo object if found

                   Null otherwise

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestCaseFileInfo* CTestModuleInfo::GetUncheckedCfgFile(void)

    {

    TInt cnt = iCfgFiles.Count();

    TInt i;

    for(i = 0; i < cnt; i++)

        {

        if(!iCfgFiles[i]->IsChecked())

            {

            return iCfgFiles[i];

            }

        }

    return NULL;

    }

// ================= MEMBER FUNCTIONS =========================================

/*

-------------------------------------------------------------------------------

    Class: CTestModuleList

    Method: CTestModuleList

    Description: Default constructor

    C++ default constructor can NOT contain any code, that

    might leave.

    Parameters: None

    Return Values: None

    Errors/Exceptions: None

    Status: Approved

-------------------------------------------------------------------------------

*/

CTestModuleList::CTestModuleList()

    {

	iLogger = NULL;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleList

    Method: ConstructL

    Description: Symbian OS second phase constructor

    Symbian OS default constructor can leave.

    Parameters: aLogger: pointer to stif logger

    Return Values: None

    Errors/Exceptions:

    Status: Approved

-------------------------------------------------------------------------------

*/

void CTestModuleList::ConstructL(CStifLogger* aLogger)

    {

	iLogger = aLogger;

    }

/*

-------------------------------------------------------------------------------

    Class: CTestModuleList

    Method: NewL

    Description: Two-phased constructor.