sl@0: // Copyright (c) 1998-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: //
sl@0: 
sl@0: #include <s32file.h>
sl@0: #include <e32test.h>
sl@0: 
sl@0: const TInt KTestCleanupStack=0x20;
sl@0: 
sl@0: // This is a path specification and should not be used as is
sl@0: _LIT(KFileLocationSpec, "Z:\\STOR-TST\\T_SHAPE.DAT");
sl@0: 
sl@0: class CShape;
sl@0: enum TShape {ENotAShape,ESquare,ECircle};
sl@0: typedef CShape* (*TShapeCtor)();
sl@0: class CShape : public CBase
sl@0: 	{
sl@0: public:
sl@0: 	static TShapeCtor Ctor(TShape type);
sl@0: //
sl@0: 	virtual void ExternalizeL(RWriteStream& aStream) const=0;
sl@0: 	virtual void InternalizeL(RReadStream& aStream)=0;
sl@0: //
sl@0: 	TStreamId StoreL(CStreamStore& aStore) const;
sl@0: 	void RestoreL(const CStreamStore& aStore,TStreamId anId);
sl@0: //
sl@0: 	virtual TPtrC Name() const=0;
sl@0: 	virtual TSize Extent() const=0;
sl@0: 	virtual TPoint Centre() const=0;
sl@0: 	};
sl@0: class CSquare : public CShape
sl@0: 	{
sl@0: public:
sl@0: 	static CShape* New();
sl@0: 	CSquare() {}
sl@0: 	CSquare(const TPoint& aCentre,TInt aSide);
sl@0: 	void ExternalizeL(RWriteStream& aStream) const;
sl@0: 	void InternalizeL(RReadStream& aStream);
sl@0: 	TPtrC Name() const;
sl@0: 	TSize Extent() const;
sl@0: 	TPoint Centre() const;
sl@0: private:
sl@0: 	TRect iRect;
sl@0: 	};
sl@0: class CCircle : public CShape
sl@0: 	{
sl@0: public:
sl@0: 	static CShape* New();
sl@0: 	CCircle() {}
sl@0: 	CCircle(const TPoint& aCentre,TInt aRadius);
sl@0: 	void ExternalizeL(RWriteStream& aStream) const;
sl@0: 	void InternalizeL(RReadStream& aStream);
sl@0: 	TPtrC Name() const;
sl@0: 	TSize Extent() const;
sl@0: 	TPoint Centre() const;
sl@0: private:
sl@0: 	TPoint iCentre;
sl@0: 	TInt iRadius;
sl@0: 	};
sl@0: 
sl@0: class TShapeHolder
sl@0: 	{
sl@0: public:
sl@0: 	TShapeHolder();
sl@0: 	TShapeHolder(TShape aType,CShape* aShape);
sl@0: //
sl@0: 	void ExternalizeL(RWriteStream& aStream) const;
sl@0: 	void InternalizeL(RReadStream& aStream);
sl@0: 	void StoreComponentsL(CStreamStore& aStore,CStoreMap& aMap) const;
sl@0: 	void RestoreComponentsL(const CStreamStore& aStore);
sl@0: //
sl@0: 	void ExternalizeSerialL(RWriteStream& aStream) const;
sl@0: 	void InternalizeSerialL(RReadStream& aStream);
sl@0: //
sl@0: 	TStreamId StoreL(CStreamStore& aStore) const;
sl@0: 	void RestoreL(const CStreamStore& aStore,TStreamId anId);
sl@0: //
sl@0: 	CShape* Shape() const;
sl@0: private:
sl@0: 	TShape iType;
sl@0: 	TSwizzle<CShape> iShape;
sl@0: 	};
sl@0: 
sl@0: LOCAL_D RTest test(_L("t_storshape"));
sl@0: LOCAL_D CTrapCleanup* TheTrapCleanup;
sl@0: LOCAL_D RFs TheFs;
sl@0: //LOCAL_D CBufStore* TheStore;
sl@0: LOCAL_D CFileStore* TheStore;
sl@0: LOCAL_D RStoreWriteStream TheSink;
sl@0: LOCAL_D RStoreReadStream TheSource;
sl@0: //LOCAL_D RFileWriteStream TheSink;
sl@0: //LOCAL_D RFileReadStream TheSource;
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID          PDS-STORE-CT-4025
sl@0: @SYMTestCaseDesc	    Basic test for CStoreMap Forget() and Unbind() API
sl@0: @SYMTestPriority 	    High
sl@0: @SYMTestActions  	    Unbind stream from Map, forget sgtream from map
sl@0: @SYMTestExpectedResults map stream ID should be NUll
sl@0: @SYMDEF                 DEF135804
sl@0: */
sl@0: LOCAL_C void testExtraStoreMapAPIsL()
sl@0: 	{
sl@0: 	test.Next(_L("@SYMTestCaseID PDS-STORE-CT-4025"));
sl@0: 	CShape* shape=new(ELeave) CCircle(TPoint(70,80),40);
sl@0: 	CleanupStack::PushL(shape);
sl@0: 	CStoreMap* map=CStoreMap::NewLC(*TheStore);
sl@0: 	TStreamId id = shape->StoreL(*TheStore);
sl@0: 	
sl@0: 	map->BindL(shape,id);
sl@0: 	test(id == map->At(shape));
sl@0: 	//Unbind the twizzle(shape) and test to make sure it is unbinded
sl@0: 	map->Unbind(shape);
sl@0: 	test(KNullStreamId == map->At(shape));
sl@0: 	
sl@0: 	map->BindL(shape,id);
sl@0: 	test(shape == map->Label(id));
sl@0: 	//Forget the stream id and test to make sure it is forgotten
sl@0: 	map->Forget(id);
sl@0: 	test(shape != map->Label(id));
sl@0: 	CleanupStack::PopAndDestroy(2,shape);
sl@0: 	}
sl@0: /**
sl@0: @SYMTestCaseID          SYSLIB-STORE-CT-1200
sl@0: @SYMTestCaseDesc	    Shape streaming test
sl@0: @SYMTestPriority 	    High
sl@0: @SYMTestActions  	    Attempt for streaming of different shapes
sl@0: @SYMTestExpectedResults Test must not fail
sl@0: @SYMREQ                 REQ0000
sl@0: */
sl@0: LOCAL_C void testShapesL()
sl@0:     {
sl@0: 	test.Start(_L(" @SYMTestCaseID:SYSLIB-STORE-CT-1200 Shape streaming "));
sl@0: 
sl@0: 	TParsePtrC parse(KFileLocationSpec);
sl@0: //
sl@0: //	TheStore=CDirectFileStore::ReplaceLC(TheFs,KTestFile,EFileRead|EFileWrite);
sl@0: 	TheStore=CPermanentFileStore::ReplaceLC(TheFs,parse.NameAndExt(),EFileRead|EFileWrite);
sl@0: 	TheStore->SetTypeL(TheStore->Layout());
sl@0: //
sl@0: 	RStoreWriteStream snk;
sl@0: 	TStreamId id=snk.CreateL(*TheStore);
sl@0: 	TShapeHolder hldr(ESquare,new(ELeave) CSquare(TPoint(20,30),40));
sl@0: 	hldr.ExternalizeSerialL(snk);
sl@0: 	delete hldr.Shape();
sl@0: 	hldr=TShapeHolder(ECircle,new(ELeave) CCircle(TPoint(70,80),40));
sl@0: 	hldr.ExternalizeSerialL(snk);
sl@0: 	delete hldr.Shape();
sl@0: 	snk.Close();
sl@0: 	RStoreReadStream src;
sl@0: 	src.OpenL(*TheStore,id);
sl@0: 	hldr.InternalizeSerialL(src);
sl@0: 	delete hldr.Shape();
sl@0: 	hldr.InternalizeSerialL(src);
sl@0: 	delete hldr.Shape();
sl@0: 	src.Close();
sl@0: //
sl@0: 	hldr=TShapeHolder(ESquare,new(ELeave) CSquare(TPoint(20,30),40));
sl@0: 	id=hldr.StoreL(*TheStore);
sl@0: 	delete hldr.Shape();
sl@0: 	hldr.RestoreL(*TheStore,id);
sl@0: 	delete hldr.Shape();
sl@0: //
sl@0: 	CShape* shape=new(ELeave) CCircle(TPoint(70,80),40);
sl@0: 	CStoreMap* map=CStoreMap::NewL(*TheStore);
sl@0: 	TStreamId id2 = shape->StoreL(*TheStore);
sl@0: 
sl@0: 	testExtraStoreMapAPIsL();
sl@0: 	
sl@0: 	map->BindL(shape,id2);
sl@0: 	snk=RStoreWriteStream(*map);
sl@0: 	id=snk.CreateL(*TheStore);
sl@0: 	snk<<shape;
sl@0: 	snk.Close();
sl@0: 	delete shape;
sl@0: 	src.OpenL(*TheStore,id);
sl@0: 	src>>id;
sl@0: 	src.Close();
sl@0: 	shape=new(ELeave) CCircle;
sl@0: 	shape->RestoreL(*TheStore,id);
sl@0: 	delete map;
sl@0: 	TRAPD(r,shape->RestoreL(*TheStore,id));
sl@0: 	test(r==KErrNotFound);
sl@0: 	delete shape;
sl@0: //
sl@0: 	CleanupStack::PopAndDestroy();
sl@0:     }
sl@0: 
sl@0: //
sl@0: // Prepare the test directory.
sl@0: //
sl@0: LOCAL_C void setupTestDirectory()
sl@0:     {
sl@0: 	TInt r=TheFs.Connect();
sl@0: 	test(r==KErrNone);
sl@0: //
sl@0: 	TDriveUnit drive(static_cast<TUint>(RFs::GetSystemDrive()));	
sl@0: 	TParse parse;
sl@0: 	parse.Set(drive.Name(), &KFileLocationSpec, NULL);
sl@0: 	
sl@0: 	r=TheFs.MkDir(parse.DriveAndPath());
sl@0: 	test(r==KErrNone||r==KErrAlreadyExists);
sl@0: 	r=TheFs.SetSessionPath(parse.DriveAndPath());
sl@0: 	test(r==KErrNone);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Initialise the cleanup stack.
sl@0: //
sl@0: LOCAL_C void setupCleanup()
sl@0:     {
sl@0: 	TheTrapCleanup=CTrapCleanup::New();
sl@0: 	test(TheTrapCleanup!=NULL);
sl@0: 	TRAPD(r,\
sl@0: 		{\
sl@0: 		for (TInt i=KTestCleanupStack;i>0;i--)\
sl@0: 			CleanupStack::PushL((TAny*)1);\
sl@0: 		test(r==KErrNone);\
sl@0: 		CleanupStack::Pop(KTestCleanupStack);\
sl@0: 		});
sl@0: 	test(r==KErrNone);
sl@0: 	}
sl@0: 
sl@0: LOCAL_C void DeleteDataFile(const TDesC& aFullName)
sl@0: 	{
sl@0: 	RFs fsSession;
sl@0: 	TInt err = fsSession.Connect();
sl@0: 	if(err == KErrNone)
sl@0: 		{
sl@0: 		TEntry entry;
sl@0: 		if(fsSession.Entry(aFullName, entry) == KErrNone)
sl@0: 			{
sl@0: 			RDebug::Print(_L("Deleting \"%S\" file.\n"), &aFullName);
sl@0: 			err = fsSession.SetAtt(aFullName, 0, KEntryAttReadOnly);
sl@0: 			if(err != KErrNone)
sl@0: 				{
sl@0: 				RDebug::Print(_L("Error %d changing \"%S\" file attributes.\n"), err, &aFullName);
sl@0: 				}
sl@0: 			err = fsSession.Delete(aFullName);
sl@0: 			if(err != KErrNone)
sl@0: 				{
sl@0: 				RDebug::Print(_L("Error %d deleting \"%S\" file.\n"), err, &aFullName);
sl@0: 				}
sl@0: 			}
sl@0: 		fsSession.Close();
sl@0: 		}
sl@0: 	else
sl@0: 		{
sl@0: 		RDebug::Print(_L("Error %d connecting file session. File: %S.\n"), err, &aFullName);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // Test the streaming framework.
sl@0: //
sl@0: GLDEF_C TInt E32Main()
sl@0:     {
sl@0: 	test.Title();
sl@0: 	setupTestDirectory();
sl@0: 	setupCleanup();
sl@0: 	__UHEAP_MARK;
sl@0: //
sl@0: 	TRAPD(r,testShapesL());
sl@0: 	test(r==KErrNone);
sl@0: 
sl@0: 	//deletion of data files must be before call to .End() - DEF047652
sl@0: 	TDriveUnit drive(static_cast<TUint>(RFs::GetSystemDrive()));	
sl@0: 	TParse parse;
sl@0: 	parse.Set(drive.Name(), &KFileLocationSpec, NULL);
sl@0: 	::DeleteDataFile(parse.FullName());
sl@0: 
sl@0: 	test.End();
sl@0: //
sl@0: 	__UHEAP_MARKEND;
sl@0: 
sl@0: 	delete TheTrapCleanup;
sl@0: 	TheFs.Close();
sl@0: 	test.Close();
sl@0: 	return 0;
sl@0:     }
sl@0: 
sl@0: TShapeCtor CShape::Ctor(TShape type)
sl@0: 	{
sl@0: 	switch (type)
sl@0: 		{
sl@0: 	case ESquare:
sl@0: 		return &CSquare::New;
sl@0: 	case ECircle:
sl@0: 		return &CCircle::New;
sl@0: 	default:
sl@0: 		return NULL;
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: TStreamId CShape::StoreL(CStreamStore& aStore) const
sl@0: 	{
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId id=stream.CreateLC(aStore);
sl@0: 	ExternalizeL(stream);
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: void CShape::RestoreL(const CStreamStore& aStore,TStreamId anId)
sl@0: 	{
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore,anId);
sl@0: 	InternalizeL(stream);
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: CShape* CSquare::New()
sl@0: 	{
sl@0: 	return new CSquare;
sl@0: 	}
sl@0: 
sl@0: CSquare::CSquare(const TPoint& aCentre,TInt aSide)
sl@0: 	{
sl@0: 	TInt offset=aSide/2;
sl@0: 	iRect.iTl.iX=aCentre.iX-offset;
sl@0: 	iRect.iTl.iY=aCentre.iY-offset;
sl@0: 	iRect.iBr.iX=iRect.iTl.iX+aSide;
sl@0: 	iRect.iBr.iY=iRect.iTl.iY+aSide;
sl@0: 	}
sl@0: 
sl@0: void CSquare::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream.WriteUint32L(iRect.iTl.iX);
sl@0: 	aStream.WriteUint32L(iRect.iTl.iY);
sl@0: 	aStream.WriteUint32L(iRect.iBr.iX);
sl@0: 	aStream.WriteUint32L(iRect.iBr.iY);
sl@0: 	}
sl@0: 
sl@0: void CSquare::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	iRect.iTl.iX=aStream.ReadUint32L();
sl@0: 	iRect.iTl.iY=aStream.ReadUint32L();
sl@0: 	iRect.iBr.iX=aStream.ReadUint32L();
sl@0: 	iRect.iBr.iY=aStream.ReadUint32L();
sl@0: 	}
sl@0: 
sl@0: TPtrC CSquare::Name() const
sl@0: 	{
sl@0: 	return _L("Square");
sl@0: 	}
sl@0: 
sl@0: TSize CSquare::Extent() const
sl@0: 	{
sl@0: 	return (iRect.iBr-iRect.iTl).AsSize();
sl@0: 	}
sl@0: 
sl@0: TPoint CSquare::Centre() const
sl@0: 	{
sl@0: 	return TPoint((iRect.iBr.iX-iRect.iTl.iX)/2,(iRect.iBr.iY-iRect.iTl.iY)/2);
sl@0: 	}
sl@0: 
sl@0: CShape* CCircle::New()
sl@0: 	{
sl@0: 	return new CCircle;
sl@0: 	}
sl@0: 
sl@0: CCircle::CCircle(const TPoint& aCentre,TInt aRadius)
sl@0: 	: iCentre(aCentre),iRadius(aRadius)
sl@0: 	{}
sl@0: 
sl@0: void CCircle::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream.WriteUint32L(iCentre.iX);
sl@0: 	aStream.WriteUint32L(iCentre.iY);
sl@0: 	aStream.WriteUint32L(iRadius);
sl@0: 	}
sl@0: 
sl@0: void CCircle::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	iCentre.iX=aStream.ReadUint32L();
sl@0: 	iCentre.iY=aStream.ReadUint32L();
sl@0: 	iRadius=aStream.ReadUint32L();
sl@0: 	}
sl@0: 
sl@0: TPtrC CCircle::Name() const
sl@0: 	{
sl@0: 	return _L("Circle");
sl@0: 	}
sl@0: 
sl@0: TSize CCircle::Extent() const
sl@0: 	{
sl@0: 	TInt diameter=iRadius*2;
sl@0: 	return TSize(diameter,diameter);
sl@0: 	}
sl@0: 
sl@0: TPoint CCircle::Centre() const
sl@0: 	{
sl@0: 	return iCentre;
sl@0: 	}
sl@0: 
sl@0: TShapeHolder::TShapeHolder()
sl@0: 	: iType(ENotAShape),iShape(NULL)
sl@0: 	{}
sl@0: 
sl@0: TShapeHolder::TShapeHolder(TShape aType,CShape* aShape)
sl@0: 	: iType(aType),iShape(aShape)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG((iType==ENotAShape)==(aShape==NULL),User::Panic(_L("gargl"),0));
sl@0: 	}
sl@0: 
sl@0: void TShapeHolder::ExternalizeL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream.WriteUint8L(iType);
sl@0: 	aStream<<iShape;
sl@0: 	}
sl@0: 
sl@0: void TShapeHolder::InternalizeL(RReadStream& aStream)
sl@0: 	{
sl@0: 	TShape type=TShape(aStream.ReadUint8L());
sl@0: 	if ((type==ENotAShape)!=(CShape::Ctor(type)==NULL))
sl@0: 		User::Leave(KErrCorrupt); // representation violation!!!
sl@0: //
sl@0: 	aStream>>iShape;
sl@0: 	iType=type;
sl@0: 	}
sl@0: 
sl@0: void TShapeHolder::StoreComponentsL(CStreamStore& aStore,CStoreMap& aMap) const
sl@0: 	{
sl@0: 	if (iShape!=NULL)
sl@0: 		{
sl@0: 		TStreamId id=iShape->StoreL(aStore);
sl@0: 		aMap.BindL(iShape,id);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: void TShapeHolder::RestoreComponentsL(const CStreamStore& aStore)
sl@0: 	{
sl@0: 	TShapeCtor ctor=CShape::Ctor(iType);
sl@0: 	CShape* shape=NULL;
sl@0: 	if (ctor!=NULL)
sl@0: 		{
sl@0: 		User::LeaveIfNull(shape=(*ctor)());
sl@0: 		CleanupStack::PushL(shape);
sl@0: 		shape->RestoreL(aStore,iShape.AsId());
sl@0: 		CleanupStack::Pop();
sl@0: 		}
sl@0: 	iShape=shape;
sl@0: 	}
sl@0: 
sl@0: void TShapeHolder::ExternalizeSerialL(RWriteStream& aStream) const
sl@0: 	{
sl@0: 	aStream.WriteUint8L(iType);
sl@0: 	if (iShape!=NULL)
sl@0: 		aStream<<*iShape;
sl@0: 	}
sl@0: 
sl@0: void TShapeHolder::InternalizeSerialL(RReadStream& aStream)
sl@0: 	{
sl@0: 	TShape type=TShape(aStream.ReadUint8L());
sl@0: 	TShapeCtor ctor=CShape::Ctor(type);
sl@0: 	if ((type==ENotAShape)!=(ctor==NULL))
sl@0: 		User::Leave(1832); // representation violation!!!
sl@0: //
sl@0: 	CShape* shape=NULL;
sl@0: 	if (ctor!=NULL)
sl@0: 		{
sl@0: 		User::LeaveIfNull(shape=(*ctor)());
sl@0: 		CleanupStack::PushL(shape);
sl@0: 		aStream>>*shape;
sl@0: 		CleanupStack::Pop();
sl@0: 		}
sl@0: 	iType=type;
sl@0: 	iShape=shape;
sl@0: 	}
sl@0: 
sl@0: TStreamId TShapeHolder::StoreL(CStreamStore& aStore) const
sl@0: 	{
sl@0: 	CStoreMap* map=CStoreMap::NewLC(aStore);
sl@0: 	StoreComponentsL(aStore,*map);
sl@0: //
sl@0: 	RStoreWriteStream stream(*map);
sl@0: 	TStreamId id=stream.CreateLC(aStore);
sl@0: 	ExternalizeL(stream);
sl@0: 	stream.CommitL();
sl@0: //
sl@0: 	map->Reset();
sl@0: 	CleanupStack::PopAndDestroy(2);
sl@0: 	return id;
sl@0: 	}
sl@0: 
sl@0: void TShapeHolder::RestoreL(const CStreamStore& aStore,TStreamId anId)
sl@0: 	{
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore,anId);
sl@0: 	InternalizeL(stream);
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: //
sl@0: 	RestoreComponentsL(aStore);
sl@0: 	}
sl@0: 
sl@0: CShape* TShapeHolder::Shape() const
sl@0: 	{
sl@0: 	return iShape;
sl@0: 	}
sl@0: