1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/sdbms/SD_CURS.CPP Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,442 @@
1.4 +// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// DBMS server proxy cursor
1.18 +//
1.19 +//
1.20 +
1.21 +#include "SD_STD.H"
1.22 +
1.23 +const TDbBlobId KUnknownBlobId=~0u;
1.24 +
1.25 +// Class HDbsColumns
1.26 +
1.27 +class HDbsColumns
1.28 + {
1.29 +public:
1.30 + static HDbsColumns* NewL(TInt aCount);
1.31 + inline void Set(const TUint8* aPtr);
1.32 + inline TPtr8 Ptr();
1.33 + inline TInt Count() const;
1.34 + inline TDbColType Type(TDbColNo aCol) const;
1.35 + void Check(TDbColNo aCol) const;
1.36 +private:
1.37 + inline HDbsColumns(TInt aCount);
1.38 +private:
1.39 + TInt iCount;
1.40 + TUint8 iType[1];
1.41 + };
1.42 +
1.43 +inline HDbsColumns::HDbsColumns(TInt aCount)
1.44 + :iCount(aCount)
1.45 + {}
1.46 +inline void HDbsColumns::Set(const TUint8* aPtr)
1.47 + {Mem::Copy(iType,aPtr,iCount);}
1.48 +inline TPtr8 HDbsColumns::Ptr()
1.49 + {return TPtr8(iType,iCount);}
1.50 +inline TInt HDbsColumns::Count() const
1.51 + {return iCount;}
1.52 +inline TDbColType HDbsColumns::Type(TDbColNo aCol) const
1.53 + {__DEBUG(Check(aCol));return TDbColType(iType[aCol-1]);}
1.54 +
1.55 +HDbsColumns* HDbsColumns::NewL(TInt aCount)
1.56 + {
1.57 + return new(User::AllocL(_FOFF(HDbsColumns,iType[aCount]))) HDbsColumns(aCount);
1.58 + }
1.59 +
1.60 +void HDbsColumns::Check(TDbColNo aColNo) const
1.61 + {
1.62 + __ASSERT_ALWAYS(aColNo>0&&aColNo<=iCount,Panic(EDbsInvalidColumn));
1.63 + }
1.64 +
1.65 +// Class CDbsCursor
1.66 +
1.67 +CDbsCursor::CDbsCursor()
1.68 + :iState(EAtBeginning)
1.69 + {}
1.70 +
1.71 +CDbsCursor* CDbsCursor::NewL(const RDbsObject& aDbs,TDbsFunction aFunction,TIpcArgs& aArgs)
1.72 + {
1.73 + CDbsCursor* self=new(ELeave) CDbsCursor;
1.74 + CleanupStack::PushL(self);
1.75 + self->ConstructL(aDbs,aFunction,aArgs);
1.76 + CleanupStack::Pop();
1.77 + return self;
1.78 + }
1.79 +
1.80 +void CDbsCursor::ConstructL(const RDbsObject& aDbs,TDbsFunction aFunction,TIpcArgs& aArgs)
1.81 +//
1.82 +// construct a cursor from the supplied parameters
1.83 +// Retrieve the column types, in one pass if possible
1.84 +//
1.85 + {
1.86 + TPckgBuf<TDbsColumns> cols;
1.87 + aArgs.Set(3,&cols);
1.88 + iObject.OpenL(aDbs,aFunction,aArgs);
1.89 + iColumns=HDbsColumns::NewL(cols().iCount);
1.90 + if (cols().iCount<=cols().EMax)
1.91 + iColumns->Set(cols().iData); // we have the column types
1.92 + else
1.93 + { // too many for the fixed buffer, make a second call to get the columns
1.94 + TPtr8 ptr=iColumns->Ptr();
1.95 + aArgs.Set(3,&ptr);
1.96 + iObject.SendReceiveL(EDbsCursorColumnTypes,aArgs);
1.97 + }
1.98 + }
1.99 +
1.100 +CDbsCursor::~CDbsCursor()
1.101 + {
1.102 + iObject.Close();
1.103 + delete iColumns;
1.104 + iRow.Close();
1.105 + }
1.106 +
1.107 +TDbColType CDbsCursor::Type(TDbColNo aCol) const
1.108 + {
1.109 + iColumns->Check(aCol);
1.110 + return iColumns->Type(aCol);
1.111 + }
1.112 +
1.113 +void CDbsCursor::Reset()
1.114 + {
1.115 + iState=EAtBeginning;
1.116 + iObject.SendReceive(EDbsCursorReset);
1.117 + }
1.118 +
1.119 +TBool CDbsCursor::EvaluateL()
1.120 + {
1.121 + iState=EUnknown;
1.122 + return iObject.SendReceiveL(EDbsCursorEvaluate);
1.123 + }
1.124 +
1.125 +void CDbsCursor::Evaluate(TRequestStatus& aStatus)
1.126 + {
1.127 + iState=EUnknown;
1.128 + iObject.SendReceive(EDbsCursorEvaluate,aStatus);
1.129 + }
1.130 +
1.131 +TBool CDbsCursor::Unevaluated()
1.132 + {
1.133 + return iObject.SendReceive(EDbsCursorUnevaluated);
1.134 + }
1.135 +
1.136 +void CDbsCursor::SetIndexL(const TDesC* anIndex)
1.137 + {
1.138 + iObject.SendReceiveL(EDbsCursorSetIndex,TIpcArgs(anIndex));
1.139 + iState=EAtBeginning;
1.140 + }
1.141 +
1.142 +TBool CDbsCursor::SeekL(const TDbLookupKey& aKey,RDbTable::TComparison aComparison)
1.143 + {
1.144 + TPtrC8 key(TDbsParam::PrepareLC(aKey));
1.145 + iState=EUnknown;
1.146 + TBool found=iObject.SendReceiveL(EDbsCursorSeek,TIpcArgs(&key,key.Length(),aComparison));
1.147 + CleanupStack::PopAndDestroy(); // key
1.148 + if (found)
1.149 + iState=EAtRow;
1.150 + return found;
1.151 + }
1.152 +
1.153 +TBool CDbsCursor::AtBeginning()
1.154 + {
1.155 + if (iState==EUnknown && iObject.SendReceive(EDbsCursorAtBeginning)>0)
1.156 + iState=EAtBeginning;
1.157 + return iState==EAtBeginning;
1.158 + }
1.159 +
1.160 +TBool CDbsCursor::AtEnd()
1.161 + {
1.162 + if (iState==EUnknown && iObject.SendReceive(EDbsCursorAtEnd)>0)
1.163 + iState=EAtEnd;
1.164 + return iState==EAtEnd;
1.165 + }
1.166 +
1.167 +TBool CDbsCursor::AtRow()
1.168 + {
1.169 + if (iState==EUnknown && iObject.SendReceive(EDbsCursorAtRow)>0)
1.170 + iState=EAtRow;
1.171 + return iState>=EAtRow;
1.172 + }
1.173 +
1.174 +TInt CDbsCursor::CountL(RDbRowSet::TAccuracy aAccuracy)
1.175 +//
1.176 +// valid response is >=0 + undefined (==-1)
1.177 +// server returns +1 for non-error conditions
1.178 +//
1.179 + {
1.180 + return iObject.SendReceiveL(EDbsCursorCount,TIpcArgs(aAccuracy))-1;
1.181 + }
1.182 +
1.183 +TBool CDbsCursor::GotoL(RDbRowSet::TPosition aPosition)
1.184 + {
1.185 + TBool atrow=RetrieveL(EDbsCursorGotoPos,aPosition);
1.186 + if (atrow)
1.187 + iState=ERetrieve;
1.188 + else
1.189 + {
1.190 + switch (aPosition)
1.191 + {
1.192 + default:
1.193 + __ASSERT(0);
1.194 + case RDbRowSet::EEnd:
1.195 + case RDbRowSet::EFirst:
1.196 + case RDbRowSet::ENext:
1.197 + iState=EAtEnd;
1.198 + break;
1.199 + case RDbRowSet::EBeginning:
1.200 + case RDbRowSet::ELast:
1.201 + case RDbRowSet::EPrevious:
1.202 + iState=EAtBeginning;
1.203 + break;
1.204 + }
1.205 + }
1.206 + return atrow;
1.207 + }
1.208 +
1.209 +void CDbsCursor::Bookmark(TDbBookmark::TMark& aMark)
1.210 + {
1.211 + TPckg<TDbBookmark::TMark> pckg(aMark);
1.212 + iObject.SendReceive(EDbsCursorBookmark,TIpcArgs(TIpcArgs::ENothing,TIpcArgs::ENothing,TIpcArgs::ENothing,&pckg));
1.213 + }
1.214 +
1.215 +void CDbsCursor::GotoL(const TDbBookmark::TMark& aMark)
1.216 + {
1.217 + TPckgC<TDbBookmark::TMark> pckg(aMark);
1.218 + iState=EUnknown;
1.219 + iObject.SendReceiveL(EDbsCursorGotoBookmark,TIpcArgs(&pckg));
1.220 + }
1.221 +
1.222 +LOCAL_C void CancelCursor(TAny* aPtr)
1.223 + {
1.224 + STATIC_CAST(CDbCursor*,aPtr)->Cancel();
1.225 + }
1.226 +
1.227 +TBool CDbsCursor::RetrieveL(TDbsFunction aFunction,TInt aArg0)
1.228 +//
1.229 +// Read the row buffer
1.230 +//
1.231 + {
1.232 + iState=EUnknown;
1.233 + TInt size;
1.234 + for (;;)
1.235 + {
1.236 + TInt max=iRow.MaxSize();
1.237 + TPtr8 row((TUint8*)iRow.First(),max);
1.238 + size=iObject.SendReceiveL(aFunction,TIpcArgs(aArg0,TIpcArgs::ENothing,max,&row))-1;
1.239 + if (size<0)
1.240 + return EFalse; // no row to retrieve
1.241 + if (size<=max)
1.242 + break;
1.243 + // didn't fit! Grow the buffer
1.244 + if (aFunction!=EDbsCursorRetrieveRow)
1.245 + {
1.246 + CleanupStack::PushL(TCleanupItem(CancelCursor,this)); // in case this goes wrong!
1.247 + aFunction=EDbsCursorRetrieveRow;
1.248 + }
1.249 + iRow.GrowL(size);
1.250 + }
1.251 + iRow.SetSize(size);
1.252 + if (aFunction==EDbsCursorRetrieveRow)
1.253 + CleanupStack::Pop();
1.254 + return ETrue;
1.255 + }
1.256 +
1.257 +void CDbsCursor::GetL()
1.258 + {
1.259 + if (iState!=ERetrieve)
1.260 + RetrieveL(EDbsCursorGet);
1.261 + iState=ERead;
1.262 + }
1.263 +
1.264 +void CDbsCursor::InsertL(TInsert aClearRow)
1.265 + {
1.266 + RetrieveL(EDbsCursorInsert,aClearRow);
1.267 + iState=EWrite;
1.268 + iChangedBlob=EFalse;
1.269 + }
1.270 +
1.271 +void CDbsCursor::UpdateL()
1.272 + {
1.273 + RetrieveL(EDbsCursorUpdate);
1.274 + iState=EWrite;
1.275 + iChangedBlob=EFalse;
1.276 + }
1.277 +
1.278 +void CDbsCursor::Cancel()
1.279 + {
1.280 + if (iState==EUnknown || iState==EWrite)
1.281 + iObject.SendReceive(EDbsCursorCancel);
1.282 + }
1.283 +
1.284 +void CDbsCursor::PutL()
1.285 + {
1.286 + TInt size=iRow.Size();
1.287 + TPtrC8 row((const TUint8*)iRow.First(),size);
1.288 + iObject.SendReceiveL(EDbsCursorPut,TIpcArgs(&row,size,iChangedBlob));// if iChangedBlob false, server can optimize put
1.289 + iState=ERead; // we can still look at the row we put
1.290 + }
1.291 +
1.292 +void CDbsCursor::DeleteL()
1.293 + {
1.294 + iState=EUnknown;
1.295 + iObject.SendReceiveL(EDbsCursorDelete);
1.296 + }
1.297 +
1.298 +TInt CDbsCursor::ColumnCount()
1.299 + {
1.300 + return iColumns->Count();
1.301 + }
1.302 +
1.303 +void CDbsCursor::ColumnsL(CDbColSet& aColSet)
1.304 +//
1.305 +// optimise the retreival of all columns
1.306 +//
1.307 + {
1.308 + TIpcArgs m;
1.309 + RReadStream in(HDbsBuf::NewLC(iObject,EDbsCursorColumns,m));
1.310 + in>>aColSet;
1.311 + CleanupStack::PopAndDestroy(); // buffer
1.312 + }
1.313 +
1.314 +void CDbsCursor::ColumnDef(TDbCol& aCol,TDbColNo aColNo)
1.315 + {
1.316 + TPckg<TDbCol> pckg(aCol);
1.317 + iColumns->Check(aColNo);
1.318 + iObject.SendReceive(EDbsCursorColumnDef,TIpcArgs(aColNo,TIpcArgs::ENothing,TIpcArgs::ENothing,&pckg));
1.319 + }
1.320 +
1.321 +TDbColType CDbsCursor::ColumnType(TDbColNo aCol)
1.322 + {
1.323 + return Type(aCol);
1.324 + }
1.325 +
1.326 +RDbRow* CDbsCursor::RowBuffer()
1.327 +//
1.328 +// Invoked by the server-- should not be called
1.329 +//
1.330 + {
1.331 + __ASSERT(0);
1.332 + return 0;
1.333 + }
1.334 +
1.335 +TDbColumnC CDbsCursor::ColumnC(TDbColNo aCol)
1.336 +//
1.337 +// check row is valid for extraction
1.338 +//
1.339 + {
1.340 + __ASSERT_ALWAYS(iState>=ERead,Panic(EDbsNoRowData));
1.341 + return TDbColumnC(iRow,aCol);
1.342 + }
1.343 +
1.344 +TDbColumn CDbsCursor::Column(TDbColNo aCol)
1.345 +//
1.346 +// check row is valid for writing
1.347 +//
1.348 + {
1.349 + __ASSERT_ALWAYS(iState==EWrite,Panic(EDbsNotInUpdate));
1.350 + return TDbColumn(iRow,aCol);
1.351 + }
1.352 +
1.353 +void CDbsCursor::ReplaceBlobL(TDbColumn& aCol)
1.354 +//
1.355 +// We no longer know what the shape of a blob is, mark it as "unknown"
1.356 +//
1.357 + {
1.358 + iChangedBlob=ETrue;
1.359 + aCol.SetBlobL(KUnknownBlobId);
1.360 + }
1.361 +
1.362 +void CDbsCursor::SetNullL(TDbColNo aCol)
1.363 +//
1.364 +// Make the column Null
1.365 +//
1.366 + {
1.367 + TDbColumn col=Column(aCol);
1.368 + if (!TDbCol::IsLong(Type(aCol)))
1.369 + col.SetNull();
1.370 + else if (!TDbColumnC(col).IsNull())
1.371 + {
1.372 + ReplaceBlobL(col);
1.373 + iObject.SendReceiveL(EDbsCursorSetNull,TIpcArgs(aCol));
1.374 + }
1.375 + }
1.376 +
1.377 +TInt CDbsCursor::ColumnSize(TDbColNo aCol)
1.378 + {
1.379 + TDbColumnC col(ColumnC(aCol));
1.380 + if (!TDbCol::IsLong(Type(aCol)))
1.381 + return col.Size();
1.382 + TInt size=col.Blob().Size();
1.383 + if (size>=0)
1.384 + return size;
1.385 + // unknown size, so ask the server
1.386 + return iObject.SendReceive(EDbsCursorColumnSize,TIpcArgs(aCol));
1.387 + }
1.388 +
1.389 +MStreamBuf* CDbsCursor::ColumnSourceL(TDbColNo aCol)
1.390 + {
1.391 + TDbColumnC col(ColumnC(aCol));
1.392 + if (!TDbCol::IsLong(iColumns->Type(aCol)))
1.393 + return HDbsReadBuf::NewL(col.PtrC8());
1.394 + // blobs
1.395 + const TDbBlob& blob=col.Blob();
1.396 + if (blob.IsInline())
1.397 + return HDbsReadBuf::NewL(blob.PtrC8());
1.398 + // get it from the server
1.399 + TIpcArgs args(aCol);
1.400 + return HDbsBuf::NewL(iObject,EDbsCursorColumnSource,args);
1.401 + }
1.402 +
1.403 +MStreamBuf* CDbsCursor::ColumnSinkL(TDbColNo aCol)
1.404 + {
1.405 + TDbColumn col(Column(aCol));
1.406 + ReplaceBlobL(col);
1.407 + TIpcArgs args(aCol);
1.408 + return HDbsBuf::NewL(iObject,EDbsCursorColumnSink,args);
1.409 + }
1.410 +
1.411 +CDbRowConstraint* CDbsCursor::OpenConstraintL(const TDbQuery& aQuery)
1.412 + {
1.413 + const TDesC& des = aQuery.Query();
1.414 + CDbsConstraint* c=new(ELeave) CDbsConstraint();
1.415 + CleanupStack::PushL(c);
1.416 + c->iObject.OpenL(iObject,EDbsCursorOpenConstraint,TIpcArgs(&des,aQuery.Comparison()));
1.417 + CleanupStack::Pop();
1.418 + return c;
1.419 + }
1.420 +
1.421 +TBool CDbsCursor::MatchL(CDbRowConstraint& aConstraint)
1.422 + {
1.423 + TInt handle = STATIC_CAST(CDbsConstraint&,aConstraint).iObject.Handle();
1.424 + return iObject.SendReceiveL(EDbsCursorMatch,TIpcArgs(handle));
1.425 + }
1.426 +
1.427 +TInt CDbsCursor::FindL(RDbRowSet::TDirection aDirection,const TDbQuery& aCriteria)
1.428 +//
1.429 +// Server returns result-KErrNotFound, to ensure non-leaving on not found
1.430 +//
1.431 + {
1.432 + const TDesC& des = aCriteria.Query();
1.433 + iState=EUnknown;
1.434 + TInt f=iObject.SendReceiveL(EDbsCursorFind,TIpcArgs(&des,aCriteria.Comparison(),aDirection))+KErrNotFound;
1.435 + if (f>=0)
1.436 + iState=EAtRow;
1.437 + return f;
1.438 + }
1.439 +
1.440 +// Class CDbsConstraint
1.441 +
1.442 +CDbsConstraint::~CDbsConstraint()
1.443 + {
1.444 + iObject.Close();
1.445 + }