// 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:

// Tests for Object provider mechanism.\n

// An interface that allows an object to be part of a network of object providers.

// The object provider mechanism can be used to find and access objects of a 

// given type, where the type is defined by a TTypeUid object. Object providers 

// may be arranged in a hierarchy, i.e. an object provider may have a parent-child 

// relationship with another object provider.

// An object provider must provide an implementation for the MopSupplyObject() 

// function and can choose to provide an implementation for the MopNext() function. 

// Typically, it will also have functionality to define who its parent is.

// 

//

/**

 @file

 @internalComponent - Internal Symbian test code

 @test

*/

#include <e32std.h>

#include <coeaui.h>

#include <coemop.h>

#include "TCone3Step.h"

#include "statecon.h"

//				Object Tree

/**

					A

				   / \

				 /	  \

			   /		\

			 /			  \

			B				E

		  /   \			  /   \

		C		D		F		G

*/

/**   Destructor for Class CSquareObj.\n */

CSquareObj::~CSquareObj()

	{}

/**   Sets the parent object provider's class name.\n  */

void CSquareObj::SetParentClassName(TDesC& aName)

	{

	iName.Set( aName );

	}

TPtrC CSquareObj::GetParentClassName() const

	{

	return iName;

	}

//! A CBase Derived Class.\n

/**   The class is used to test the object provider mechanism.\n */

class CTriangleObj : public CBase

	{

public:

	DECLARE_TYPE_ID(0x10004C75)

    ~CTriangleObj();

	void SetParentClassName(TDesC& aName);

	TPtrC GetParentClassName()  const;

private:

	TPtrC	iName;

   };

/**   Destructor for class CTriangleObj.\n */

CTriangleObj::~CTriangleObj()

    {}

/**   Sets the Parent class name of CTriangleObj class to aName.\n */

void CTriangleObj::SetParentClassName(TDesC& aName)

	{

	iName.Set( aName );

	}

/**   Returns the Parent class name of CTriangleObj class.\n */

TPtrC CTriangleObj::GetParentClassName() const

	{

	return iName;

	}

/**   Destructor for class COctagonObj.\n */

COctagonObj::~COctagonObj()

    {}

/**   Sets the Parent class name of COctagonObj class to aName.\n */

void COctagonObj::SetParentClassName(TDesC& aName)

	{

	iName.Set( aName );

	}

/**   Returns the Parent class name of COctagonObj class.\n */		

TPtrC COctagonObj::GetParentClassName() const

	{

	return iName;

	}

//! A Class derived from CBase and MObjectProvider.\n

/**

  CObjectNode is an object provider implementing the MObjectProvider interface.\n

  MObjectProvider interface that allows an object to be part of a network of object providers.\n

  This class contains objects of classes CTriangleObj,CSquareObj and COctagonObj.\n

*/

class CObjectNode : public CBase, public MObjectProvider

	{

public:

	CObjectNode();

	CObjectNode(CTriangleObj* aTriangleObj, CSquareObj* aSquareObj, COctagonObj* aOctagonObj);

    ~CObjectNode();

	void SetMopParent(MObjectProvider* aParent);

	CTriangleObj* GetTriangleObject();	

	CTriangleObj* GetTriangleObjNoChaining();

	CSquareObj* GetSquareObject();

	CSquareObj* GetSquareObjNoChaining();

	COctagonObj* GetOctagonObject();

	COctagonObj* GetOctagonObjNoChaining();

protected: // from MObjectProvider

	TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

	MObjectProvider* MopNext();

private:

	inline TTypeUid::Ptr SupplyMopObject(const TTypeUid aId);

public:

	//! Array to store objects linked through object provider mechanism.\n

	RPointerArray<CObjectNode> iArray;

private:

	//! Parent object provider.\n

	MObjectProvider* iMopParent;

	//! Pointer to the CTriangleObj returned searched by object provider mechanism.\n

	CTriangleObj* iTriangleObj;

	//! Pointer to the CSquareObj returned searched by object provider mechanism.\n	

	CSquareObj* iSquareObj;

	//! Pointer to the COctagonObj returned searched by object provider mechanism.\n	

	COctagonObj* iOctagonObj;

    };

/**   Default Constructor for CObjectNode class.\n */

CObjectNode::CObjectNode()

	{}

/**

  Three argument constructor for CObjectNode class.\n

  Initializes iTriangleObj,iSquareObj and iOctagonObj member objects.\n

*/

CObjectNode::CObjectNode(CTriangleObj* aTriangleObj, CSquareObj* aSquareObj, COctagonObj* aOctagonObj)

: iTriangleObj(aTriangleObj), iSquareObj(aSquareObj), iOctagonObj(aOctagonObj)

	{}

/**

  Destructor for CObjectNode class.\n

  Deletes the member objects of CTriangleObj,CSquareObj and COctagonObj classes.\n

*/

CObjectNode::~CObjectNode()

    {

	delete iTriangleObj;

	delete iSquareObj;

	delete iOctagonObj;

	iArray.ResetAndDestroy();

	iArray.Close();

    }

/**

  Support for the object provider mechanism is in the construction of 

  top-level controls in an application or view.\n

  Top level controls must have the view or app UI set as their object provider.\n

  The view or app UI does this by calling the control's SetMopParent() function.\n

*/

void CObjectNode::SetMopParent(MObjectProvider* aParent)

	{

	iMopParent = aParent;

	}

/**

  Gets the parent object provider.\n

  This is called by the private function MopGetById() when a call to MopGetObject()

  returns NULL.\n

*/

MObjectProvider* CObjectNode::MopNext()

	{

	return iMopParent;

	}

/**

  Gets an object whose type is encapsulated by the specified TTypeUid object.\n

  Calls the inline function SupplyMopObject .\n

*/

TTypeUid::Ptr CObjectNode::MopSupplyObject(TTypeUid aId)

	{

	return SupplyMopObject(aId);

	}

/**

  This function is called by the MopSupplyObject when there is a request

  to get an object whose type is encapsulated by the specified TTypeUid object.\n

  The type uid is compared with the Uids of the three component objects namely

  aTriangleObj,aSquareObj and aOctagonObj.\n

  If the Uid matches,pointer to the matched object is returned.\n

*/

inline TTypeUid::Ptr CObjectNode::SupplyMopObject(const TTypeUid aId)

	{

	if (iTriangleObj)

		{

		if(aId.iUid == CTriangleObj::ETypeId)

			{

			return aId.MakePtr(iTriangleObj);

			}

		}

	if (iSquareObj)

		{

		if(aId.iUid == CSquareObj::ETypeId)

			{

			return aId.MakePtr(iSquareObj);

			}

		}

	if (iOctagonObj)

		{

		if(aId.iUid == COctagonObj::ETypeId)

			{

			return aId.MakePtr(iOctagonObj);

			}

		}

	return TTypeUid::Null();

	}

/**

  The function tests the ability to get the triangle object pointer 

  using the Object provider mechanism.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

CTriangleObj* CObjectNode::GetTriangleObject()

	{

	CTriangleObj* triangle = MopGetObject(triangle);

	return triangle;

	}

/**

  The function tests the ability to get the square object pointer 

  using the Object provider mechanism.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

CSquareObj* CObjectNode::GetSquareObject()

	{

	CSquareObj* square = MopGetObject(square);

	return square;

	}

/**

  The function tests the ability to get the octagon object pointer 

  using the Object provider mechanism.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

COctagonObj* CObjectNode::GetOctagonObject()

	{

	COctagonObj* octagon = MopGetObject(octagon);

	return octagon;

	}

/**

  The function tests the ability to get the triangle object pointer 

  using the Object provider mechanism without chaining.\n

  The object will be supplied directly by this object provider, or NULL 

  will be returned, this function does not recurse through the object chain.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

CTriangleObj* CObjectNode::GetTriangleObjNoChaining()

	{

	CTriangleObj* triangle = MopGetObjectNoChaining(triangle);

	return triangle;

	}

/**

  The function tests the ability to get the square object pointer 

  using the Object provider mechanism without chaining.\n

  The object will be supplied directly by this object provider, or NULL 

  will be returned, this function does not recurse through the object chain.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

CSquareObj* CObjectNode::GetSquareObjNoChaining()

	{

	CSquareObj* square = MopGetObjectNoChaining(square);

	return square;

	}

/**

  The function tests the ability to get the octagon object pointer 

  using the Object provider mechanism without chaining.\n

  The object will be supplied directly by this object provider, or NULL 

  will be returned, this function does not recurse through the object chain.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

COctagonObj* CObjectNode::GetOctagonObjNoChaining()

	{

	COctagonObj* octagon = MopGetObjectNoChaining(octagon);

	return octagon;

	}

//! A class derived from CBase and MObjectProvider interface.\n

/**

  The CObjectNodeConst tests the object provider mechanism by providing 

  a constant interface. All the Get functions are constant to ensure that no changes

  are made to the objects.\n

*/

class CObjectNodeConst : public CBase, public MObjectProvider

	{

public:

	CObjectNodeConst();

	CObjectNodeConst(const CTriangleObj* aTriangleObj, const CSquareObj* aSquareObj, const COctagonObj* aOctagonObj);

    ~CObjectNodeConst();

	void SetMopParent(MObjectProvider* aParent);

	const CTriangleObj* GetTriangleObject();

	const CTriangleObj* GetTriangleObjNoChaining();

	const CSquareObj* GetSquareObject();

	const CSquareObj* GetSquareObjNoChaining();

	const COctagonObj* GetOctagonObject();

	const COctagonObj* GetOctagonObjNoChaining();

protected: // from MObjectProvider

	TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

	MObjectProvider* MopNext();

private:

	inline const TTypeUid::Ptr SupplyMopObject(TTypeUid aId);

public:

		//! Array to store objects linked through object provider mechanism.\n

	RPointerArray<CObjectNodeConst> iArray;

private:

	//! Parent object provider.\n

	MObjectProvider* iMopParent;

	//! Pointer to the CTriangleObj returned searched by object provider mechanism.\n

	const CTriangleObj* iTriangleObj;

	//! Pointer to the CSquareObj returned searched by object provider mechanism.\n

	const CSquareObj* iSquareObj;

	//! Pointer to the COctagonObj returned searched by object provider mechanism.\n

	const COctagonObj* iOctagonObj;

    };

/**   Default constructor for CObjectNodeConst class.\n */

CObjectNodeConst::CObjectNodeConst()

	{}

/**

  Three argument constructor for CObjectNodeConst class.\n

  Initializes iTriangleObj,iSquareObj and iOctagonObj member objects.\n

*/

CObjectNodeConst::CObjectNodeConst(const CTriangleObj* aTriangleObj, 

						 const CSquareObj* aSquareObj, 

						 const COctagonObj* aOctagonObj)

: iTriangleObj(aTriangleObj), iSquareObj(aSquareObj), iOctagonObj(aOctagonObj)

	{}

/**

  Destructor for CObjectNodeConst class.\n

  Deletes the iTriangleObj,iSquareObj and iOctagonObj objects.\n

*/

CObjectNodeConst::~CObjectNodeConst()

    {

	delete iTriangleObj;

	delete iSquareObj;

	delete iOctagonObj;

	iArray.ResetAndDestroy();

	iArray.Close();

    }

/**

  Sets the context - that is, the enclosing parent object - for this object.\n

*/

void CObjectNodeConst::SetMopParent(MObjectProvider* aParent)

	{

	iMopParent = aParent;

	}

/**

  Retrieves the parent object provider.\n

  This function may be overridden to continue the chain of object providers 

  which are to be asked to supply an object.\n

  This is called by the private function MopGetById() when a call to MopGetObject()

  returns NULL.\n

*/

MObjectProvider* CObjectNodeConst::MopNext()

	{

	return iMopParent;

	}

/**

  Gets an object whose type is encapsulated by the specified TTypeUid object.\n

  Calls the inline function SupplyMopObject .\n

*/

TTypeUid::Ptr CObjectNodeConst::MopSupplyObject(TTypeUid aId)

	{

	return SupplyMopObject(aId);

	}

/**

  This function is called by the MopSupplyObject when there is a request

  to get an object whose type is encapsulated by the specified TTypeUid object.\n

  The type uid is compared with the Uids of the three component objects namely

  aTriangleObj,aSquareObj and aOctagonObj.\n

  If the Uid matches,pointer to the matched object is returned.\n

*/

inline const TTypeUid::Ptr CObjectNodeConst::SupplyMopObject(TTypeUid aId)

	{

	if (iTriangleObj)

		{

		if(aId.iUid == CTriangleObj::ETypeId)

			{

			return aId.MakePtr(const_cast<CTriangleObj*>(iTriangleObj));

			}

		}

	if (iSquareObj)

		{

		if(aId.iUid == CSquareObj::ETypeId)

			{

			return aId.MakePtr(const_cast<CSquareObj*>(iSquareObj));

			}

		}

	if (iOctagonObj)

		{

		if(aId.iUid == COctagonObj::ETypeId)

			{

			return aId.MakePtr(const_cast<COctagonObj*>(iOctagonObj));

			}

		}

	return TTypeUid::Null();

	}

/**

  The function tests the ability to get the triangle object pointer 

  using the Object provider mechanism.\n

  The function calls MopGetObject passing a pointer reference.\n

*/	

const CTriangleObj* CObjectNodeConst::GetTriangleObject()

	{

	const CTriangleObj* triangle = MopGetObject(triangle);

	return triangle;

	}

/**

  The function tests the ability to get the square object pointer 

  using the Object provider mechanism.\n

  The function calls MopGetObject passing a pointer reference.\n

*/	

const CSquareObj* CObjectNodeConst::GetSquareObject()

	{

	const CSquareObj* square = MopGetObject(square);

	return square;

	}

/**

  The function tests the ability to get the octagon object pointer 

  using the Object provider mechanism.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

const COctagonObj* CObjectNodeConst::GetOctagonObject()

	{

	const COctagonObj* octagon = MopGetObject(octagon);

	return octagon;

	}

/**

  The function tests the ability to get the triangle object pointer 

  using the Object provider mechanism without chaining for constant functions.\n

  The object will be supplied directly by this object provider, or NULL 

  will be returned, this function does not recurse through the object chain.\n

  The function calls MopGetObject passing a pointer reference.\n

*/	

const CTriangleObj* CObjectNodeConst::GetTriangleObjNoChaining()

	{

	const CTriangleObj* triangle = MopGetObjectNoChaining(triangle);

	return triangle;

	}

/**

  The function tests the ability to get the square object pointer 

  using the Object provider mechanism without chaining for constant functions.\n

  The object will be supplied directly by this object provider, or NULL 

  will be returned, this function does not recurse through the object chain.\n

  The function calls MopGetObject passing a pointer reference.\n

*/	

const CSquareObj* CObjectNodeConst::GetSquareObjNoChaining()

	{

	const CSquareObj* square = MopGetObjectNoChaining(square);

	return square;

	}

/**

  The function tests the ability to get the octagon object pointer 

  using the Object provider mechanism without chaining for constant functions.\n

  The object will be supplied directly by this object provider, or NULL 

  will be returned, this function does not recurse through the object chain.\n

  The function calls MopGetObject passing a pointer reference.\n

*/

const COctagonObj* CObjectNodeConst::GetOctagonObjNoChaining()

	{

	const COctagonObj* octagon = MopGetObjectNoChaining(octagon);

	return octagon;

	}

/**   Single Argument Constructor for CCone3TestAppUi class.\n */

CCone3TestAppUi::CCone3TestAppUi(CTmsTestStep* aStep) :

	CTestCoeAppUi(aStep)

	{}

/**   Destructor for CCone3TestAppUi class.\n */