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: // DBMS server proxy cursor
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include "SD_STD.H"
sl@0: 
sl@0: const TDbBlobId KUnknownBlobId=~0u;
sl@0: 
sl@0: // Class HDbsColumns
sl@0: 
sl@0: class HDbsColumns
sl@0: 	{
sl@0: public:
sl@0: 	static HDbsColumns* NewL(TInt aCount);
sl@0: 	inline void Set(const TUint8* aPtr);
sl@0: 	inline TPtr8 Ptr();
sl@0: 	inline TInt Count() const;
sl@0: 	inline TDbColType Type(TDbColNo aCol) const;
sl@0: 	void Check(TDbColNo aCol) const;
sl@0: private:
sl@0: 	inline HDbsColumns(TInt aCount);
sl@0: private:
sl@0: 	TInt iCount;
sl@0: 	TUint8 iType[1];
sl@0: 	};
sl@0: 
sl@0: inline HDbsColumns::HDbsColumns(TInt aCount)
sl@0: 	:iCount(aCount)
sl@0: 	{}
sl@0: inline void HDbsColumns::Set(const TUint8* aPtr)
sl@0: 	{Mem::Copy(iType,aPtr,iCount);}
sl@0: inline TPtr8 HDbsColumns::Ptr()
sl@0: 	{return TPtr8(iType,iCount);}
sl@0: inline TInt HDbsColumns::Count() const
sl@0: 	{return iCount;}
sl@0: inline TDbColType HDbsColumns::Type(TDbColNo aCol) const
sl@0: 	{__DEBUG(Check(aCol));return TDbColType(iType[aCol-1]);}
sl@0: 
sl@0: HDbsColumns* HDbsColumns::NewL(TInt aCount)
sl@0: 	{
sl@0: 	return new(User::AllocL(_FOFF(HDbsColumns,iType[aCount]))) HDbsColumns(aCount);
sl@0: 	}
sl@0: 
sl@0: void HDbsColumns::Check(TDbColNo aColNo) const
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(aColNo>0&&aColNo<=iCount,Panic(EDbsInvalidColumn));
sl@0: 	}
sl@0: 
sl@0: // Class CDbsCursor
sl@0: 
sl@0: CDbsCursor::CDbsCursor()
sl@0: 	:iState(EAtBeginning)
sl@0: 	{}
sl@0: 
sl@0: CDbsCursor* CDbsCursor::NewL(const RDbsObject& aDbs,TDbsFunction aFunction,TIpcArgs& aArgs)
sl@0: 	{
sl@0: 	CDbsCursor* self=new(ELeave) CDbsCursor;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	self->ConstructL(aDbs,aFunction,aArgs);
sl@0: 	CleanupStack::Pop();
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::ConstructL(const RDbsObject& aDbs,TDbsFunction aFunction,TIpcArgs& aArgs)
sl@0: //
sl@0: // construct a cursor from the supplied parameters
sl@0: // Retrieve the column types, in one pass if possible
sl@0: //
sl@0: 	{
sl@0: 	TPckgBuf<TDbsColumns> cols;
sl@0: 	aArgs.Set(3,&cols);
sl@0: 	iObject.OpenL(aDbs,aFunction,aArgs);
sl@0: 	iColumns=HDbsColumns::NewL(cols().iCount);
sl@0: 	if (cols().iCount<=cols().EMax)
sl@0: 		iColumns->Set(cols().iData);	// we have the column types
sl@0: 	else
sl@0: 		{	// too many for the fixed buffer, make a second call to get the columns
sl@0: 		TPtr8 ptr=iColumns->Ptr();
sl@0: 		aArgs.Set(3,&ptr);
sl@0: 		iObject.SendReceiveL(EDbsCursorColumnTypes,aArgs);
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: CDbsCursor::~CDbsCursor()
sl@0: 	{
sl@0: 	iObject.Close();
sl@0: 	delete iColumns;
sl@0: 	iRow.Close();
sl@0: 	}
sl@0: 
sl@0: TDbColType CDbsCursor::Type(TDbColNo aCol) const
sl@0: 	{
sl@0: 	iColumns->Check(aCol);
sl@0: 	return iColumns->Type(aCol);
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::Reset()
sl@0: 	{
sl@0: 	iState=EAtBeginning;
sl@0: 	iObject.SendReceive(EDbsCursorReset);
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::EvaluateL()
sl@0: 	{
sl@0: 	iState=EUnknown;
sl@0: 	return iObject.SendReceiveL(EDbsCursorEvaluate);
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::Evaluate(TRequestStatus& aStatus)
sl@0: 	{
sl@0: 	iState=EUnknown;
sl@0: 	iObject.SendReceive(EDbsCursorEvaluate,aStatus);
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::Unevaluated()
sl@0: 	{
sl@0: 	return iObject.SendReceive(EDbsCursorUnevaluated);
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::SetIndexL(const TDesC* anIndex)
sl@0: 	{
sl@0: 	iObject.SendReceiveL(EDbsCursorSetIndex,TIpcArgs(anIndex));
sl@0: 	iState=EAtBeginning;
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::SeekL(const TDbLookupKey& aKey,RDbTable::TComparison aComparison)
sl@0: 	{
sl@0: 	TPtrC8 key(TDbsParam::PrepareLC(aKey));
sl@0: 	iState=EUnknown;
sl@0: 	TBool found=iObject.SendReceiveL(EDbsCursorSeek,TIpcArgs(&key,key.Length(),aComparison));
sl@0: 	CleanupStack::PopAndDestroy();	// key
sl@0: 	if (found)
sl@0: 		iState=EAtRow;
sl@0: 	return found;
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::AtBeginning()
sl@0: 	{
sl@0: 	if (iState==EUnknown && iObject.SendReceive(EDbsCursorAtBeginning)>0)
sl@0: 		iState=EAtBeginning;
sl@0: 	return iState==EAtBeginning;
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::AtEnd()
sl@0: 	{
sl@0: 	if (iState==EUnknown && iObject.SendReceive(EDbsCursorAtEnd)>0)
sl@0: 		iState=EAtEnd;
sl@0: 	return iState==EAtEnd;
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::AtRow()
sl@0: 	{
sl@0: 	if (iState==EUnknown && iObject.SendReceive(EDbsCursorAtRow)>0)
sl@0: 		iState=EAtRow;
sl@0: 	return iState>=EAtRow;
sl@0: 	}
sl@0: 
sl@0: TInt CDbsCursor::CountL(RDbRowSet::TAccuracy aAccuracy)
sl@0: //
sl@0: // valid response is >=0 + undefined (==-1)
sl@0: // server returns +1 for non-error conditions
sl@0: //
sl@0: 	{
sl@0: 	return iObject.SendReceiveL(EDbsCursorCount,TIpcArgs(aAccuracy))-1;
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::GotoL(RDbRowSet::TPosition aPosition)
sl@0: 	{
sl@0: 	TBool atrow=RetrieveL(EDbsCursorGotoPos,aPosition);
sl@0: 	if (atrow)
sl@0: 		iState=ERetrieve;
sl@0: 	else
sl@0: 		{
sl@0: 		switch (aPosition)
sl@0: 			{
sl@0: 		default:
sl@0: 			__ASSERT(0);
sl@0: 		case RDbRowSet::EEnd:
sl@0: 		case RDbRowSet::EFirst:
sl@0: 		case RDbRowSet::ENext:
sl@0: 			iState=EAtEnd;
sl@0: 			break;
sl@0: 		case RDbRowSet::EBeginning:
sl@0: 		case RDbRowSet::ELast:
sl@0: 		case RDbRowSet::EPrevious:
sl@0: 			iState=EAtBeginning;
sl@0: 			break;
sl@0: 			}
sl@0: 		}
sl@0: 	return atrow;
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::Bookmark(TDbBookmark::TMark& aMark)
sl@0: 	{
sl@0: 	TPckg<TDbBookmark::TMark> pckg(aMark);
sl@0: 	iObject.SendReceive(EDbsCursorBookmark,TIpcArgs(TIpcArgs::ENothing,TIpcArgs::ENothing,TIpcArgs::ENothing,&pckg));
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::GotoL(const TDbBookmark::TMark& aMark)
sl@0: 	{
sl@0: 	TPckgC<TDbBookmark::TMark> pckg(aMark);
sl@0: 	iState=EUnknown;
sl@0: 	iObject.SendReceiveL(EDbsCursorGotoBookmark,TIpcArgs(&pckg));
sl@0: 	}
sl@0: 
sl@0: LOCAL_C void CancelCursor(TAny* aPtr)
sl@0: 	{
sl@0: 	STATIC_CAST(CDbCursor*,aPtr)->Cancel();
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::RetrieveL(TDbsFunction aFunction,TInt aArg0)
sl@0: //
sl@0: // Read the row buffer
sl@0: //
sl@0: 	{
sl@0: 	iState=EUnknown;
sl@0: 	TInt size;
sl@0: 	for (;;)
sl@0: 		{
sl@0: 		TInt max=iRow.MaxSize();
sl@0: 		TPtr8 row((TUint8*)iRow.First(),max);
sl@0: 		size=iObject.SendReceiveL(aFunction,TIpcArgs(aArg0,TIpcArgs::ENothing,max,&row))-1;
sl@0: 		if (size<0)
sl@0: 			return EFalse;		// no row to retrieve
sl@0: 		if (size<=max)
sl@0: 			break;
sl@0: 		// didn't fit! Grow the buffer
sl@0: 		if (aFunction!=EDbsCursorRetrieveRow)
sl@0: 			{
sl@0: 			CleanupStack::PushL(TCleanupItem(CancelCursor,this));	// in case this goes wrong!
sl@0: 			aFunction=EDbsCursorRetrieveRow;
sl@0: 			}
sl@0: 		iRow.GrowL(size);
sl@0: 		}
sl@0: 	iRow.SetSize(size);
sl@0: 	if (aFunction==EDbsCursorRetrieveRow)
sl@0: 		CleanupStack::Pop();
sl@0: 	return ETrue;
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::GetL()
sl@0: 	{
sl@0: 	if (iState!=ERetrieve)
sl@0: 		RetrieveL(EDbsCursorGet);
sl@0: 	iState=ERead;
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::InsertL(TInsert aClearRow)
sl@0: 	{
sl@0: 	RetrieveL(EDbsCursorInsert,aClearRow);
sl@0: 	iState=EWrite;
sl@0: 	iChangedBlob=EFalse;
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::UpdateL()
sl@0: 	{
sl@0: 	RetrieveL(EDbsCursorUpdate);
sl@0: 	iState=EWrite;
sl@0: 	iChangedBlob=EFalse;
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::Cancel()
sl@0: 	{
sl@0: 	if (iState==EUnknown || iState==EWrite)
sl@0: 		iObject.SendReceive(EDbsCursorCancel);
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::PutL()
sl@0: 	{
sl@0: 	TInt size=iRow.Size();
sl@0: 	TPtrC8 row((const TUint8*)iRow.First(),size);
sl@0: 	iObject.SendReceiveL(EDbsCursorPut,TIpcArgs(&row,size,iChangedBlob));// if iChangedBlob false, server can optimize put
sl@0: 	iState=ERead;		// we can still look at the row we put
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::DeleteL()
sl@0: 	{
sl@0: 	iState=EUnknown;
sl@0: 	iObject.SendReceiveL(EDbsCursorDelete);
sl@0: 	}
sl@0: 
sl@0: TInt CDbsCursor::ColumnCount()
sl@0: 	{
sl@0: 	return iColumns->Count();
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::ColumnsL(CDbColSet& aColSet)
sl@0: //
sl@0: // optimise the retreival of all columns
sl@0: //
sl@0: 	{
sl@0: 	TIpcArgs m;
sl@0: 	RReadStream in(HDbsBuf::NewLC(iObject,EDbsCursorColumns,m));
sl@0: 	in>>aColSet;
sl@0: 	CleanupStack::PopAndDestroy();	// buffer
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::ColumnDef(TDbCol& aCol,TDbColNo aColNo)
sl@0: 	{
sl@0: 	TPckg<TDbCol> pckg(aCol);
sl@0: 	iColumns->Check(aColNo);
sl@0: 	iObject.SendReceive(EDbsCursorColumnDef,TIpcArgs(aColNo,TIpcArgs::ENothing,TIpcArgs::ENothing,&pckg));
sl@0: 	}
sl@0: 
sl@0: TDbColType CDbsCursor::ColumnType(TDbColNo aCol)
sl@0: 	{
sl@0: 	return Type(aCol);
sl@0: 	}
sl@0: 
sl@0: RDbRow* CDbsCursor::RowBuffer()
sl@0: //
sl@0: // Invoked by the server-- should not be called
sl@0: //
sl@0: 	{
sl@0: 	__ASSERT(0);
sl@0: 	return 0;
sl@0: 	}
sl@0: 
sl@0: TDbColumnC CDbsCursor::ColumnC(TDbColNo aCol)
sl@0: //
sl@0: // check row is valid for extraction
sl@0: //
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(iState>=ERead,Panic(EDbsNoRowData));
sl@0: 	return TDbColumnC(iRow,aCol);
sl@0: 	}
sl@0: 
sl@0: TDbColumn CDbsCursor::Column(TDbColNo aCol)
sl@0: //
sl@0: // check row is valid for writing
sl@0: //
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(iState==EWrite,Panic(EDbsNotInUpdate));
sl@0: 	return TDbColumn(iRow,aCol);
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::ReplaceBlobL(TDbColumn& aCol)
sl@0: //
sl@0: // We no longer know what the shape of a blob is, mark it as "unknown"
sl@0: //
sl@0: 	{
sl@0: 	iChangedBlob=ETrue;
sl@0: 	aCol.SetBlobL(KUnknownBlobId);
sl@0: 	}
sl@0: 
sl@0: void CDbsCursor::SetNullL(TDbColNo aCol)
sl@0: //
sl@0: // Make the column Null
sl@0: //
sl@0: 	{
sl@0: 	TDbColumn col=Column(aCol);
sl@0: 	if (!TDbCol::IsLong(Type(aCol)))
sl@0: 		col.SetNull();
sl@0: 	else if (!TDbColumnC(col).IsNull())
sl@0: 		{
sl@0: 		ReplaceBlobL(col);
sl@0: 		iObject.SendReceiveL(EDbsCursorSetNull,TIpcArgs(aCol));
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: TInt CDbsCursor::ColumnSize(TDbColNo aCol)
sl@0: 	{
sl@0: 	TDbColumnC col(ColumnC(aCol));
sl@0: 	if (!TDbCol::IsLong(Type(aCol)))
sl@0: 		return col.Size();
sl@0: 	TInt size=col.Blob().Size();
sl@0: 	if (size>=0)
sl@0: 		return size;
sl@0: 	// unknown size, so ask the server
sl@0: 	return iObject.SendReceive(EDbsCursorColumnSize,TIpcArgs(aCol));
sl@0: 	}
sl@0: 
sl@0: MStreamBuf* CDbsCursor::ColumnSourceL(TDbColNo aCol)
sl@0: 	{
sl@0: 	TDbColumnC col(ColumnC(aCol));
sl@0: 	if (!TDbCol::IsLong(iColumns->Type(aCol)))
sl@0: 		return HDbsReadBuf::NewL(col.PtrC8());
sl@0: 	// blobs
sl@0: 	const TDbBlob& blob=col.Blob();
sl@0: 	if (blob.IsInline())
sl@0: 		return HDbsReadBuf::NewL(blob.PtrC8());
sl@0: 	// get it from the server
sl@0: 	TIpcArgs args(aCol);
sl@0: 	return HDbsBuf::NewL(iObject,EDbsCursorColumnSource,args);
sl@0: 	}
sl@0: 
sl@0: MStreamBuf* CDbsCursor::ColumnSinkL(TDbColNo aCol)
sl@0: 	{
sl@0: 	TDbColumn col(Column(aCol));
sl@0: 	ReplaceBlobL(col);
sl@0: 	TIpcArgs args(aCol);
sl@0: 	return HDbsBuf::NewL(iObject,EDbsCursorColumnSink,args);
sl@0: 	}
sl@0: 
sl@0: CDbRowConstraint* CDbsCursor::OpenConstraintL(const TDbQuery& aQuery)
sl@0: 	{
sl@0: 	const TDesC& des = aQuery.Query();
sl@0: 	CDbsConstraint* c=new(ELeave) CDbsConstraint();
sl@0: 	CleanupStack::PushL(c);
sl@0: 	c->iObject.OpenL(iObject,EDbsCursorOpenConstraint,TIpcArgs(&des,aQuery.Comparison()));
sl@0: 	CleanupStack::Pop();
sl@0: 	return c;
sl@0: 	}
sl@0: 
sl@0: TBool CDbsCursor::MatchL(CDbRowConstraint& aConstraint)
sl@0: 	{
sl@0: 	TInt handle = STATIC_CAST(CDbsConstraint&,aConstraint).iObject.Handle();
sl@0: 	return iObject.SendReceiveL(EDbsCursorMatch,TIpcArgs(handle));
sl@0: 	}
sl@0: 
sl@0: TInt CDbsCursor::FindL(RDbRowSet::TDirection aDirection,const TDbQuery& aCriteria)
sl@0: //
sl@0: // Server returns result-KErrNotFound, to ensure non-leaving on not found
sl@0: //
sl@0: 	{
sl@0: 	const TDesC& des = aCriteria.Query();
sl@0: 	iState=EUnknown;
sl@0: 	TInt f=iObject.SendReceiveL(EDbsCursorFind,TIpcArgs(&des,aCriteria.Comparison(),aDirection))+KErrNotFound;
sl@0: 	if (f>=0)
sl@0: 		iState=EAtRow;
sl@0: 	return f;
sl@0: 	}
sl@0: 
sl@0: // Class CDbsConstraint
sl@0: 
sl@0: CDbsConstraint::~CDbsConstraint()
sl@0: 	{
sl@0: 	iObject.Close();
sl@0: 	}