sl@0: // Copyright (c) 1997-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: // Started by DWW, October 1996
sl@0: // Tests cliboard
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <e32test.h>
sl@0: #include <baclipb.h>
sl@0: #include <bautils.h>
sl@0: #include <f32file.h>
sl@0: #include <s32strm.h>
sl@0: #include <s32stor.h>
sl@0: #include <s32file.h>
sl@0: 
sl@0: LOCAL_D RTest test(_L("T_CLIPB"));
sl@0: 
sl@0: const TUid KClipboardFileUid={268435515};
sl@0: const TUid KUidNameClipboardType={77001};
sl@0: const TUid KUidAddressClipboardType={77002};
sl@0: const TUid KUidNumberClipboardType={77003};
sl@0: const TUid KUidTestType={77004};
sl@0: 
sl@0: const TPtrC KClipboardFileCDrive=_L("C:\\System\\Data\\ClpBoard.cbd");
sl@0: const TPtrC KClipboardFileDDrive=_L("D:\\System\\Data\\ClpBoard.cbd");
sl@0: const TPtrC KClipboardFileEDrive=_L("E:\\System\\Data\\ClpBoard.cbd");
sl@0: /**
sl@0:  * NOTE :- On order to run this test in WINS, there must exist a mapping for the drives
sl@0:  * used above. So in Epoc32\Data add the following lines to epoc.ini...
sl@0:  *
sl@0:  * _epoc_drive_d \epoc32\wins\d
sl@0:  * _epoc_drive_e \epoc32\wins\e
sl@0:  *
sl@0:  * only needed for drive D & E as there is a mapping for drive C.
sl@0:  * Plus make sure that the the above directories (\epoc32\wins\d & e) exist.
sl@0:  */
sl@0: 
sl@0: class TClBase
sl@0: 	{
sl@0: public:
sl@0: 	virtual void CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const=0;
sl@0: 	virtual TBool PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary)=0;
sl@0: 	void CopyL();
sl@0: 	TBool PasteL();
sl@0: 	TBool PasteWithoutClipboardL();
sl@0: private:
sl@0: 	void DoCopyL(RFs& aFsSession);
sl@0: 	TBool DoPasteL(RFs& aFsSession);
sl@0: 	};
sl@0: 
sl@0: void TClBase::CopyL()
sl@0: 	{
sl@0: 	RFs fsSession;
sl@0: 	User::LeaveIfError(fsSession.Connect());
sl@0: 	TRAPD(err,DoCopyL(fsSession));
sl@0: 	fsSession.Close();
sl@0: 	User::LeaveIfError(err);
sl@0: 	}
sl@0: 
sl@0: void TClBase::DoCopyL(RFs& aFsSession)
sl@0: 	{
sl@0: 	CClipboard* cb=CClipboard::NewForWritingLC(aFsSession);
sl@0: 	CopyToClipboardL(cb->Store(),cb->StreamDictionary());
sl@0: 	cb->CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	}
sl@0: 
sl@0: TBool TClBase::PasteL()
sl@0: 	{
sl@0: 	RFs fsSession;
sl@0: 	User::LeaveIfError(fsSession.Connect());
sl@0: 	TBool res=EFalse;
sl@0: 	TRAPD(err,res=DoPasteL(fsSession));
sl@0: 	fsSession.Close();
sl@0: 	User::LeaveIfError(err);
sl@0: 	return(res);
sl@0: 	}
sl@0: 
sl@0: TBool TClBase::DoPasteL(RFs& aFsSession)
sl@0: 	{
sl@0: 	CClipboard* cb=CClipboard::NewForReadingLC(aFsSession);
sl@0: 	TBool res=PasteFromClipboardL(cb->Store(),cb->StreamDictionary());
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return(res);
sl@0: 	}
sl@0: 
sl@0: class TClName : public TClBase
sl@0: 	{
sl@0: public:
sl@0: 	void CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const;
sl@0: 	TBool PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary);
sl@0: public:
sl@0: 	TBuf<4> iName;
sl@0: 	};
sl@0: 
sl@0: class TClNameWithAddress : public TClName
sl@0: 	{
sl@0: 	void CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const;
sl@0: 	TBool PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary);
sl@0: public:
sl@0: 	TBuf<10> iAddress;
sl@0: 	};
sl@0: 
sl@0: class TClNameWithNumber : public TClName
sl@0: 	{
sl@0: 	void CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const;
sl@0: 	TBool PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary);
sl@0: public:
sl@0: 	TInt32 iNumber;
sl@0: 	};
sl@0: 
sl@0: class TClInteger : public TClBase
sl@0: 	{
sl@0: public:
sl@0: 	void CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const;
sl@0: 	TBool PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary);
sl@0: public:
sl@0: 	TInt32 iInteger;
sl@0: 	};
sl@0: 
sl@0: void TClName::CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const
sl@0: 	{
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId streamId=stream.CreateLC(aStore);
sl@0: 	stream<<iName;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	aDictionary.AssignL(KUidNameClipboardType,streamId);
sl@0: 	}
sl@0: 
sl@0: TBool TClName::PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary)
sl@0: 	{
sl@0: 	TStreamId streamId=aDictionary.At(KUidNameClipboardType);
sl@0: 	if (streamId==KNullStreamId)
sl@0: 		return(EFalse);
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore,streamId);
sl@0: 	stream>>iName;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return(ETrue);
sl@0: 	}
sl@0: 
sl@0: void TClNameWithAddress::CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const
sl@0: 	{
sl@0: 	TClName::CopyToClipboardL(aStore,aDictionary);
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId streamId=stream.CreateLC(aStore);
sl@0: 	stream<<iAddress;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	aDictionary.AssignL(KUidAddressClipboardType,streamId);
sl@0: 	}
sl@0: 
sl@0: TBool TClNameWithAddress::PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary)
sl@0: 	{
sl@0: 	TBool namePasted=TClName::PasteFromClipboardL(aStore,aDictionary);
sl@0: 	TStreamId streamId=aDictionary.At(KUidAddressClipboardType);
sl@0: 	if (streamId==KNullStreamId)
sl@0: 		return(namePasted);
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore,streamId);
sl@0: 	stream>>iAddress;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return(ETrue);
sl@0: 	}
sl@0: 
sl@0: void TClNameWithNumber::CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const
sl@0: 	{
sl@0: 	TClName::CopyToClipboardL(aStore,aDictionary);
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId streamId=stream.CreateLC(aStore);
sl@0: 	stream<<iNumber;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	aDictionary.AssignL(KUidNumberClipboardType,streamId);
sl@0: 	}
sl@0: 
sl@0: TBool TClNameWithNumber::PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary)
sl@0: 	{
sl@0: 	TBool namePasted=TClName::PasteFromClipboardL(aStore,aDictionary);
sl@0: 	TStreamId streamId=aDictionary.At(KUidNumberClipboardType);
sl@0: 	if (streamId==KNullStreamId)
sl@0: 		return(namePasted);
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore,streamId);
sl@0: 	stream>>iNumber;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return(ETrue);
sl@0: 	}
sl@0: 
sl@0: void TClInteger::CopyToClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary) const
sl@0: 	{
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId streamId=stream.CreateLC(aStore);
sl@0: 	stream<<iInteger;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	aDictionary.AssignL(KUidNumberClipboardType,streamId);
sl@0: 	}
sl@0: 
sl@0: TBool TClInteger::PasteFromClipboardL(CStreamStore& aStore,CStreamDictionary& aDictionary)
sl@0: 	{
sl@0: 	TStreamId streamId=aDictionary.At(KUidNumberClipboardType);
sl@0: 	if (streamId==KNullStreamId)
sl@0: 		return(EFalse);
sl@0: 	RStoreReadStream stream;
sl@0: 	stream.OpenLC(aStore,streamId);
sl@0: 	stream>>iInteger;
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	return(ETrue);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID          SYSLIB-BAFL-CT-0404
sl@0: @SYMTestCaseDesc        Tests the  CClipboard::Store(),StreamDictionary functions
sl@0: @SYMTestPriority        High
sl@0: @SYMTestActions         Tests the clipboard's file store with various cases(no file,file in use,corrupt file,non-store file)
sl@0: @SYMTestExpectedResults Tests must not fail
sl@0: @SYMREQ                 REQ0000
sl@0: */
sl@0: void TestErrorHandling(const TDesC& aTestPath)
sl@0: 	{
sl@0: 
sl@0: 	test.Next(_L(" @SYMTestCaseID:SYSLIB-BAFL-CT-0404 "));
sl@0: 	TPtrC KClipboardFile(aTestPath);
sl@0: 	RFs fs;
sl@0: 	test (fs.Connect()==KErrNone);
sl@0: //
sl@0: 	test.Next(_L("No clipboard file"));
sl@0: 	fs.Delete(KClipboardFile);
sl@0: 	test (CClipboard::Clear(fs)==KErrNone);
sl@0: 	CClipboard* cb=NULL;
sl@0: 	TRAPD(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 	test (err==KErrNone);
sl@0: 	test (&cb->Store()==NULL);
sl@0: 	test (&cb->StreamDictionary()!=NULL);
sl@0: 	test (cb->StreamDictionary().IsNull());
sl@0: 	delete cb;
sl@0: //
sl@0: 	test.Next(_L("In use"));
sl@0: 	RFile file;
sl@0: 	test (file.Create(fs,KClipboardFile,EFileRead|EFileWrite)==KErrNone);
sl@0: 	TRAP(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 	test (err==KErrNone);
sl@0: 	test (&cb->Store()==NULL);
sl@0: 	test (&cb->StreamDictionary()!=NULL);
sl@0: 	test (cb->StreamDictionary().IsNull());
sl@0: 	delete cb;
sl@0: //
sl@0: 	test.Next(_L("Clear while in use"));
sl@0: 	test (CClipboard::Clear(fs)==KErrInUse);
sl@0: //
sl@0: 	test.Next(_L("Bogus clipboard file"));
sl@0: 	file.Close();
sl@0: 	TRAP(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 	test (err==KErrNone);
sl@0: 	test (&cb->Store()==NULL);
sl@0: 	test (&cb->StreamDictionary()!=NULL);
sl@0: 	test (cb->StreamDictionary().IsNull());
sl@0: 	delete cb;
sl@0: //
sl@0: 	test.Next(_L("Non-store file"));
sl@0: 	test (file.Replace(fs,KClipboardFile,EFileRead|EFileWrite)==KErrNone);
sl@0: 	test (file.Write(_L8("some data which does not make this a file store"))==KErrNone);
sl@0: 	file.Close();
sl@0: 	TRAP(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 	test (err==KErrNone);
sl@0: 	test (&cb->Store()==NULL);
sl@0: 	test (&cb->StreamDictionary()!=NULL);
sl@0: 	test (cb->StreamDictionary().IsNull());
sl@0: 	delete cb;
sl@0: //
sl@0: 	test.Next(_L("Wrong type file"));
sl@0: 	CFileStore* store=CDirectFileStore::ReplaceLC(fs,KClipboardFile,EFileRead|EFileWrite);
sl@0: 	store->SetTypeL(TUidType(KDirectFileStoreLayoutUid,KUidTestType));
sl@0: 	store->CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	TRAP(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 	test (err==KErrNone);
sl@0: 	test (&cb->Store()==NULL);
sl@0: 	test (&cb->StreamDictionary()!=NULL);
sl@0: 	test (cb->StreamDictionary().IsNull());
sl@0: 	delete cb;
sl@0: //
sl@0: 	test.Next(_L("Corrupted clipboard"));
sl@0: 	store=CDirectFileStore::ReplaceLC(fs,KClipboardFile,EFileRead|EFileWrite);
sl@0: 	store->SetTypeL(TUidType(KDirectFileStoreLayoutUid,KClipboardFileUid));
sl@0: 	store->CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	TRAP(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 	test (err==KErrNone);
sl@0: 	test (&cb->Store()==NULL);
sl@0: 	test (&cb->StreamDictionary()!=NULL);
sl@0: 	test (cb->StreamDictionary().IsNull());
sl@0: 	delete cb;
sl@0: //
sl@0: 	test.Next(_L("Clear clipboard"));
sl@0: 	test (CClipboard::Clear(fs)==KErrNone);
sl@0: 	TRAP(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 	test (err==KErrNone);
sl@0: 	test (&cb->Store()==NULL);
sl@0: 	test (&cb->StreamDictionary()!=NULL);
sl@0: 	test (cb->StreamDictionary().IsNull());
sl@0: 	delete cb;
sl@0: //
sl@0: #if defined(_DEBUG)
sl@0: 	test.Next(_L("Out of memory failure"));
sl@0: //
sl@0: 	cb=CClipboard::NewForWritingLC(fs);
sl@0: 	RStoreWriteStream stream;
sl@0: 	TStreamId testId=stream.CreateLC(cb->Store());
sl@0: 	stream.WriteInt32L(0);
sl@0: 	stream.CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: 	cb->StreamDictionary().AssignL(KUidTestType,testId);
sl@0: 	cb->CommitL();
sl@0: 	CleanupStack::PopAndDestroy();
sl@0: //
sl@0: 	__UHEAP_MARK;
sl@0: 	for (TInt ii=0;;++ii)
sl@0: 		{
sl@0: 		__UHEAP_FAILNEXT(ii);
sl@0: 		TRAP(err,cb=CClipboard::NewForReadingL(fs));
sl@0: 		if (err==KErrNone)
sl@0: 			break;
sl@0: 		test(err==KErrNoMemory);
sl@0: 		__UHEAP_CHECK(0);
sl@0: 		}
sl@0: 	__UHEAP_RESET;
sl@0: 	test (&cb->Store()!=NULL);
sl@0: 	test (cb->StreamDictionary().At(KUidTestType)==testId);
sl@0: 	delete cb;
sl@0: 	__UHEAP_MARKEND;
sl@0: //
sl@0: #endif
sl@0: //
sl@0: 	test.Next(_L("Fail to commit clipboard"));
sl@0: 	TRAP(err,cb=CClipboard::NewForWritingLC(fs);CleanupStack::Pop());
sl@0: 	test (err==KErrNone);
sl@0: 	delete cb;
sl@0: 	test (!BaflUtils::FileExists(fs,KClipboardFile));
sl@0: //
sl@0: 	fs.Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @SYMTestCaseID          SYSLIB-BAFL-CT-0405
sl@0: @SYMTestCaseDesc        Tests the CClipboard::NewForWritingLC,NewForReadingL
sl@0: @SYMTestPriority        High
sl@0: @SYMTestActions         Tests for copy and paste operations on TClName,TClNameWithAddress,TClInteger,TClNameWithNumber
sl@0: @SYMTestExpectedResults Tests must not fail
sl@0: @SYMREQ                 REQ0000
sl@0: */
sl@0: void DoTestsOnDrive(const TDesC& aDrivePath)
sl@0:     {
sl@0: 	test.Start(_L(" @SYMTestCaseID:SYSLIB-BAFL-CT-0405 Test single paste "));
sl@0: 	TClName n1,n2;
sl@0: 	n1.iName=_L("Fred");
sl@0: 	n2.iName=_L("Dino");
sl@0: 	n1.CopyL();
sl@0: 	TClNameWithAddress na1,na2;
sl@0: 	test(na1.PasteL());
sl@0: 	n2.CopyL();
sl@0: 	test(na2.PasteL());
sl@0: 	test(na1.iName==_L("Fred"));
sl@0: 	test(na2.iName==_L("Dino"));
sl@0: 	na1.iAddress=_L("Bedrock");
sl@0: 	test.Next(_L("Test double paste"));
sl@0: 	na1.CopyL();
sl@0: 	test(na2.PasteL());
sl@0: 	test(na2.iAddress==_L("Bedrock"));
sl@0: 	test(na2.iName==_L("Fred"));
sl@0: 	test.Next(_L("Test paste failure if type not present"));
sl@0: 	TClInteger i1,i2;
sl@0: 	test(!i1.PasteL());
sl@0: 	test.Next(_L("Test selecting the right data type"));
sl@0: 	TClNameWithNumber nn1,nn2;
sl@0: 	nn1.iNumber=36363;
sl@0: 	test(nn1.PasteL());
sl@0: 	test(nn1.iNumber==36363);
sl@0: 	test(nn1.iName==_L("Fred"));
sl@0: 	nn1.iName=_L("Wilm");
sl@0: 	nn1.CopyL();
sl@0: 	test(i2.PasteL());
sl@0: 	test(i2.iInteger==36363);
sl@0: 	test(n1.PasteL());
sl@0: 	test(n1.iName==_L("Wilm"));
sl@0: 	test(nn2.PasteL());
sl@0: 	test(nn2.iName==_L("Wilm"));
sl@0: 	test(nn2.iNumber==36363);
sl@0: //
sl@0: 	TestErrorHandling(aDrivePath);
sl@0: 	test.End();
sl@0:     }
sl@0: 
sl@0: void DoTests()
sl@0: 	{
sl@0: 	// Tests for the HAL attribute ClipboardDrive set in the device.
sl@0: 	// C Drive
sl@0: 	DoTestsOnDrive(KClipboardFileCDrive);
sl@0: 	}
sl@0: 
sl@0: GLDEF_C TInt E32Main()
sl@0: 	{
sl@0:     __UHEAP_MARK;
sl@0:     CTrapCleanup *cleanup=CTrapCleanup::New();
sl@0: 	test.Title();
sl@0: 	test.Start(_L("Testing CClipboard "));
sl@0:     TRAPD(err,DoTests());
sl@0:     test(err==KErrNone);
sl@0: 	test.End();
sl@0:     test.Close();
sl@0:     delete cleanup;
sl@0:     __UHEAP_MARKEND;
sl@0: 	return(0);
sl@0:     }