1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/sql/SRC/Common/SqlBufIterator.inl Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,234 @@
1.4 +// Copyright (c) 2006-2010 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 +// ///////////////////// TSqlBufRIterator class /////////////////////////////////////////
1.18 +//
1.19 +//
1.20 +
1.21 +/**
1.22 +
1.23 + Initializes the iterator.
1.24 + After the initialization the iterator points to the first flat buffer field - 1.
1.25 +
1.26 + @param aBuf A reference to the buffer which will be iterated.
1.27 +*/
1.28 +inline void TSqlBufRIterator::Set(const RSqlBufFlat& aBuf)
1.29 + {
1.30 + iBegin = aBuf.Header();
1.31 + iCurrent = iBegin - 1;
1.32 + iEnd = iBegin + aBuf.Count();
1.33 + }
1.34 +
1.35 +/**
1.36 +Moves to the next flat buffer field
1.37 +
1.38 +@return False if there are no more fields to be iterated.
1.39 +*/
1.40 +inline TBool TSqlBufRIterator::Next()
1.41 + {
1.42 + return ++iCurrent < iEnd;
1.43 + }
1.44 +
1.45 +/**
1.46 +Moves to the specified field in the flat buffer.
1.47 +
1.48 +@param aIndex Field index
1.49 +*/
1.50 +inline void TSqlBufRIterator::MoveTo(TInt aIndex)
1.51 + {
1.52 + __ASSERT_DEBUG((iBegin + (TUint)aIndex) < iEnd, __SQLPANIC(ESqlPanicBadArgument));
1.53 + iCurrent = iBegin + aIndex;
1.54 + }
1.55 +
1.56 +/**
1.57 +@return True if the current flat buffer field is "Present"
1.58 +*/
1.59 +inline TBool TSqlBufRIterator::IsPresent() const
1.60 + {
1.61 + __ASSERT_DEBUG(iCurrent >= iBegin && iCurrent < iEnd, __SQLPANIC(ESqlPanicInternalError));
1.62 + return iCurrent->iPos > 0;
1.63 + }
1.64 +
1.65 +/**
1.66 +@return Current flat buffer field type. One of TSqlColumnType enum item values or ESqlText8.
1.67 +*/
1.68 +inline TInt TSqlBufRIterator::Type() const
1.69 + {
1.70 + __ASSERT_DEBUG(iCurrent >= iBegin && iCurrent < iEnd, __SQLPANIC(ESqlPanicInternalError));
1.71 + return iCurrent->Type();
1.72 + }
1.73 +
1.74 +/**
1.75 +@return Current flat buffer field size
1.76 +*/
1.77 +inline TInt TSqlBufRIterator::Size() const
1.78 + {
1.79 + __ASSERT_DEBUG(iCurrent >= iBegin && iCurrent < iEnd, __SQLPANIC(ESqlPanicInternalError));
1.80 + return Type() == ESqlText ? iCurrent->Size() / sizeof(TUint16) : iCurrent->Size();
1.81 + }
1.82 +
1.83 +
1.84 +///////////////////////////////////////////////////////////////////////////////////////////////////////////
1.85 +//////////////////////// TSqlBufWIterator class //////////////////////////////////
1.86 +///////////////////////////////////////////////////////////////////////////////////////////////////////////
1.87 +
1.88 +/**
1.89 +Initializes the iterator.
1.90 +After the initialization the iterator points to the first flat buffer field - 1.
1.91 +
1.92 +@param aBuf A reference to the buffer which will be iterated.
1.93 +*/
1.94 +inline void TSqlBufWIterator::Set(RSqlBufFlat& aBuf)
1.95 + {
1.96 + iBuf = &aBuf;
1.97 + iIndex = -1;
1.98 + }
1.99 +
1.100 +/**
1.101 +Moves to the next flat buffer field
1.102 +
1.103 +@return False if there are no more fields to be iterated.
1.104 +*/
1.105 +inline TBool TSqlBufWIterator::Next()
1.106 + {
1.107 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.108 + return ++iIndex < iBuf->Count();
1.109 + }
1.110 +
1.111 +/**
1.112 +Moves to the specified field in the flat buffer.
1.113 +
1.114 +@param aIndex Field index
1.115 +*/
1.116 +inline void TSqlBufWIterator::MoveTo(TInt aIndex)
1.117 + {
1.118 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.119 + __ASSERT_DEBUG((TUint)aIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.120 + iIndex = aIndex;
1.121 + }
1.122 +
1.123 +/**
1.124 +Sets the current flat buffer field to NULL.
1.125 +*/
1.126 +inline void TSqlBufWIterator::SetNull()
1.127 + {
1.128 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.129 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.130 + (void)iBuf->SetField(iIndex, ESqlNull, NULL, 0);
1.131 + }
1.132 +
1.133 +/**
1.134 +Sets the current flat buffer field as "Not present".
1.135 +
1.136 +@param aType Field type. One of TSqlColumnType enum item values or ESqlText8.
1.137 +@param aLength Field length in bytes
1.138 +*/
1.139 +inline void TSqlBufWIterator::SetAsNotPresent(TInt aType, TInt aLength)
1.140 + {
1.141 + __ASSERT_DEBUG(::IsSequenceSqlType(aType), __SQLPANIC(ESqlPanicBadArgument));
1.142 + __ASSERT_DEBUG(aLength >= 0, __SQLPANIC(ESqlPanicBadArgument));
1.143 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.144 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.145 + iBuf->SetField(iIndex, aType, NULL, aType == ESqlText ? aLength * sizeof(TUint16) : aLength);
1.146 + }
1.147 +
1.148 +/**
1.149 +Initializes current flat buffer field with an integer value.
1.150 +
1.151 +@param aValue An integer value to be set as a field content
1.152 +
1.153 +@return KErrNone, The operation has completed successfully;
1.154 + KErrNoMemory, Out of memory condition has occured.
1.155 +*/
1.156 +inline TInt TSqlBufWIterator::SetInt(TInt aValue)
1.157 + {
1.158 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.159 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.160 + return iBuf->SetField(iIndex, ESqlInt, &aValue, sizeof(TInt));
1.161 + }
1.162 +
1.163 +/**
1.164 +Initializes current flat buffer field with an 64 bit integer value.
1.165 +
1.166 +@param aValue A 64 bit integer value to be set as a field content
1.167 +
1.168 +@return KErrNone, The operation has completed successfully;
1.169 + KErrNoMemory, Out of memory condition has occured.
1.170 +*/
1.171 +inline TInt TSqlBufWIterator::SetInt64(TInt64 aValue)
1.172 + {
1.173 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.174 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.175 + return iBuf->SetField(iIndex, ESqlInt64, &aValue, sizeof(TInt64));
1.176 + }
1.177 +
1.178 +/**
1.179 +Initializes current flat buffer field with a real value.
1.180 +
1.181 +@param aValue A real value to be set as a field content
1.182 +
1.183 +@return KErrNone, The operation has completed successfully;
1.184 + KErrNoMemory, Out of memory condition has occured.
1.185 +*/
1.186 +inline TInt TSqlBufWIterator::SetReal(TReal aValue)
1.187 + {
1.188 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.189 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.190 + return iBuf->SetField(iIndex, ESqlReal, &aValue, sizeof(TReal));
1.191 + }
1.192 +
1.193 +/**
1.194 +Initializes current flat buffer field with a block of binary data.
1.195 +
1.196 +@param aValue An 8 bit descriptor pointing to the block of data to be set as a field content.
1.197 +
1.198 +@return KErrNone, The operation has completed successfully;
1.199 + KErrNoMemory, Out of memory condition has occured.
1.200 +*/
1.201 +inline TInt TSqlBufWIterator::SetBinary(const TDesC8& aValue)
1.202 + {
1.203 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.204 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.205 + return iBuf->SetField(iIndex, ESqlBinary, aValue.Ptr(), aValue.Length());
1.206 + }
1.207 +
1.208 +/**
1.209 +Initializes current flat buffer field with a block of 16 bit text.
1.210 +
1.211 +@param aValue A 16 bit descriptor pointing to the block of text to be set as a field content.
1.212 +
1.213 +@return KErrNone, The operation has completed successfully;
1.214 + KErrNoMemory, Out of memory condition has occured.
1.215 +*/
1.216 +inline TInt TSqlBufWIterator::SetText(const TDesC16& aValue)
1.217 + {
1.218 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.219 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.220 + return iBuf->SetField(iIndex, ESqlText, aValue.Ptr(), aValue.Length() * sizeof(TUint16));
1.221 + }
1.222 +
1.223 +
1.224 +/**
1.225 +Initializes current flat buffer field with a zeroblob of the specified size.
1.226 +
1.227 +@param aSize The size, in bytes, of the zeroblob to be set as the field content.
1.228 +
1.229 +@return KErrNone, The operation has completed successfully;
1.230 + KErrNoMemory, Out of memory condition has occured.
1.231 +*/
1.232 +inline TInt TSqlBufWIterator::SetZeroBlob(TInt aSize)
1.233 + {
1.234 + __ASSERT_DEBUG(iBuf != NULL, __SQLPANIC(ESqlPanicInternalError));
1.235 + __ASSERT_DEBUG((TUint)iIndex < iBuf->Count(), __SQLPANIC(ESqlPanicInternalError));
1.236 + return iBuf->SetField(iIndex, ESqlZeroBlob, &aSize, sizeof(TInt));
1.237 + }