sl@0: // Copyright (c) 2003-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 "UD_STD.H"
sl@0: 
sl@0: const TInt KPakArrayGranularity=0x80;
sl@0: 
sl@0: // class TDbCol
sl@0: EXPORT_C TDbCol::TDbCol(const TDesC &aName,TDbColType aType)
sl@0: 	: iType(aType), iAttributes(0), iName(aName)
sl@0: 	{
sl@0: 	iMaxLength=(aType==EDbColText8 || aType==EDbColText16)
sl@0: 		? KDbDefaultTextColLength : KDbUndefinedLength;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbCol::TDbCol(const TDesC &aName,TDbColType aType,TInt aMaxLength)
sl@0: 	: iType(aType), iMaxLength(aMaxLength), iAttributes(0), iName(aName)
sl@0: /** Constructs a TDbCol with the given name, optional type and optional maximum 
sl@0: length.
sl@0: 
sl@0: Note: The iAttributes member is initialised to 0.
sl@0: 
sl@0: @param aName The column name.
sl@0: @param aType The column type.
sl@0: @param aMaxLength If present, this specifies a limit on how many characters 
sl@0: may be stored in a Text column, or how many bytes can be stored in a Binary 
sl@0: column. By default this is set to KDbDefaultTextColLength for Text (but not 
sl@0: LongText) columns and KDbUndefinedLength for other columns. */
sl@0: 	{}
sl@0: 
sl@0: // class CDbColSet
sl@0: EXPORT_C CDbColSet::CDbColSet()
sl@0: : iColumns(KPakArrayGranularity)
sl@0: /** Constructs an empty column set. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C CDbColSet* CDbColSet::NewL()
sl@0: /** Constructs a new empty column set and returns a pointer to it.
sl@0: 
sl@0: @return A pointer to the column set object. */
sl@0: 	{
sl@0: 	return new(ELeave) CDbColSet;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CDbColSet* CDbColSet::NewLC()
sl@0: /** Constructs a new empty column set and returns a pointer to it — placing 
sl@0: the pointer onto the cleanup stack. This allows the column set object and 
sl@0: allocated resources to be cleaned up if a subsequent leave occurs.
sl@0: 
sl@0: @return A pointer to the column set object. */
sl@0: 	{
sl@0: 	CDbColSet* cs=NewL();
sl@0: 	CleanupStack::PushL(cs);
sl@0: 	return cs;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CDbColSet::~CDbColSet()
sl@0: /** Frees resources owned by the object. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C const TDbCol* CDbColSet::Col(const TDesC &aColName) const
sl@0: /** Returns a named column definition in the set. If such a column does not 
sl@0: exist in the set NULL is returned.
sl@0: 
sl@0: @param aColName The name of the column to find.
sl@0: @return A pointer to the column definition found, or NULL. */
sl@0: 	{
sl@0: 	TDbColNo col=ColNo(aColName);
sl@0: 	if (col==KDbNullColNo)
sl@0: 		return NULL;
sl@0: 	else
sl@0: 		return &(*this)[col];
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbColNo CDbColSet::ColNo(const TDesC &aColName) const
sl@0: /** Returns the ordinal for a particular column name in this column set. If 
sl@0: such a column does not exist in the set the special ordinal KDbNullColNo is 
sl@0: returned.
sl@0: 
sl@0: This function is particularly important when accessing data through a rowset. 
sl@0: If the set of columns to be returned by a rowset is not explicitly specified, 
sl@0: no assumptions should be made about the ordering of the columns returned. 
sl@0: In such a case, in order to access the column data a column ordinal is required, 
sl@0: and this can be obtained by using this function on the column set returned 
sl@0: by RDbRowSet::ColSetL().
sl@0: 
sl@0: @param aColName The name of the column to find.
sl@0: @return The ordinal number of the column. */
sl@0: 	{
sl@0: 	TInt pos;
sl@0: 	TKeyArrayPak key(_FOFF(TDbCol,iName),ECmpFolded);
sl@0: 	if (iColumns.Find(TDbCol(aColName),key,pos))
sl@0: 		return KDbNullColNo;
sl@0: 	else
sl@0: 		return pos+1;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CDbColSet& CDbColSet::AddL(const TDbCol& aCol)
sl@0: /** Adds a column to the column set.
sl@0: 
sl@0: @param aCol The column to add to the set.
sl@0: @return A reference to this object. */
sl@0: 	{
sl@0: 	iColumns.AppendL(aCol,REINTERPRET_CAST(const TUint8*,aCol.iName.Ptr())+aCol.iName.Size()-REINTERPRET_CAST(const TUint8*,&aCol));
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDbColSet::Remove(const TDesC &aColName)
sl@0: /** Removes the named column from the set.
sl@0: 
sl@0: @param aColName The name of the column to remove from the set. */
sl@0: 	{
sl@0: 	TDbColNo col=ColNo(aColName);
sl@0: 	__ASSERT_ALWAYS(col!=KDbNullColNo,Panic(EDbInvalidColumn));
sl@0: 	iColumns.Delete(col-1);
sl@0: 	}
sl@0: 
sl@0: // Class TDbColSetIter
sl@0: EXPORT_C TDbColSetIter::TDbColSetIter(const CDbColSet& aColSet)
sl@0: 	: iIndex(-1),iArray(&aColSet.iColumns)
sl@0: /** Constructs a column set iterator over a column set. The iterator now 
sl@0: references the first column in the set.
sl@0: 
sl@0: @param aColSet The column set to iterate over. */
sl@0: 	{
sl@0: 	++(*this);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbColSetIter& TDbColSetIter::operator++()
sl@0: /** Moves the iterator to the next column in the set -- post increment operator.
sl@0: 
sl@0: Note that this is implemented in terms of the pre-increment operator, and 
sl@0: is less efficient.
sl@0: 
sl@0: @param Unused: required for the C++ compiler to resolve the ambiguity with 
sl@0: the pre-increment operator.
sl@0: @return A copy of this iterator, referring to the column definition before 
sl@0: the increment operation is performed. */
sl@0: 	{
sl@0: 	__ASSERT(iIndex<iArray->Count());
sl@0: 	iColumn=++iIndex<iArray->Count() ? &(*iArray)[iIndex] : 0;
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: // class TDbKeyCol
sl@0: EXPORT_C TDbKeyCol::TDbKeyCol(const TDesC& aName,TOrder anOrder)
sl@0: 	: iOrder(anOrder),iLength(KDbUndefinedLength),iName(aName)
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TDbKeyCol::TDbKeyCol(const TDesC& aName,TInt aLength,TOrder anOrder)
sl@0: 	: iOrder(anOrder),iLength(aLength),iName(aName)
sl@0: /** Constructs an object with the given name, ordering and optional truncation 
sl@0: length.
sl@0: 
sl@0: @param aName The column name.
sl@0: @param aLength If present, this specifies a limit on how many characters of 
sl@0: a Text or LongText column are used for the key. This should only be used for 
sl@0: the last key column in an index. It is required for keys on LongText columns.
sl@0: @param anOrder The ordering for the key column. By default this is ascending 
sl@0: order. */
sl@0: 	{}
sl@0: 
sl@0: // class CDbKey
sl@0: 
sl@0: EXPORT_C CDbKey::CDbKey()
sl@0: 	: iKeys(KPakArrayGranularity)
sl@0: /** Constructs an empty key. It is initialised to non-unique, non-primary and 
sl@0: normal text comparison. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C CDbKey *CDbKey::NewL()
sl@0: /** Constructs and returns a pointer to a new empty key.
sl@0: 
sl@0: @return A pointer to the key object. */
sl@0: 	{
sl@0: 	return new(ELeave) CDbKey;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CDbKey *CDbKey::NewLC()
sl@0: /** Constructs and returns a new empty key and return a pointer to it, leaving 
sl@0: a pointer to the key object on the cleanup stack. This allows the key object 
sl@0: and allocated resources to be cleaned up if a subsequent leave occurs. 
sl@0: 
sl@0: @return A pointer to the key object. */
sl@0: 	{
sl@0: 	CDbKey* key=NewL();
sl@0: 	CleanupStack::PushL(key);
sl@0: 	return key;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CDbKey::~CDbKey()
sl@0: /** Frees resources owned by the object. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C CDbKey& CDbKey::AddL(const TDbKeyCol& aKey)
sl@0: /** Adds a key column to the end of the key.
sl@0: 	
sl@0: @param aKeyCol The key column to add to the key.
sl@0: @return A reference to this object. */
sl@0: 	{
sl@0: 	iKeys.AppendL(aKey,REINTERPRET_CAST(const TUint8*,aKey.iName.Ptr())+aKey.iName.Size()-REINTERPRET_CAST(const TUint8*,&aKey));
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDbKey::Remove(const TDesC& aColName)
sl@0: /** Removes the named column from the key.
sl@0: 
sl@0: @param aColName The name of the column to remove from the key. */
sl@0: 	{
sl@0: 	TInt pos;
sl@0: 	TKeyArrayPak key(_FOFF(TDbKeyCol,iName),ECmpFolded);
sl@0: 	__ASSERT_ALWAYS(!iKeys.Find(TDbKeyCol(aColName),key,pos),Panic(EDbInvalidColumn));
sl@0: 	iKeys.Delete(pos);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDbKey::Clear()
sl@0: /** Resets the key to its initial empty state. */
sl@0: 	{
sl@0: 	iKeys.Reset();
sl@0: 	iAttributes=0;
sl@0: 	iComparison=EDbCompareNormal;
sl@0: 	}
sl@0: 
sl@0: // Class TDbLookupKey
sl@0: 
sl@0: TDbLookupKey::SColumn& TDbLookupKey::NextKey()
sl@0: 	{
sl@0: 	return iKey[iCount++];
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(TInt aKey)
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColInt32;
sl@0: 	key.iInt32=aKey;
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(TUint aKey)
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColUint32;
sl@0: 	key.iUint32=aKey;
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(TInt64 aKey)
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColInt64;
sl@0: 	key.iInt64()=aKey;
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(TReal32 aKey) __SOFTFP
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColReal32;
sl@0: 	key.iReal32=aKey;
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(TReal64 aKey) __SOFTFP
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColReal64;
sl@0: 	key.iReal64=aKey;
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(TTime aKey)
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColDateTime;
sl@0: 	key.iTime()=aKey;
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(const TDesC8& aKey)
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColText8;
sl@0: 	key.iDes8.iPtr=aKey.Ptr();
sl@0: 	key.iDes8.iLength=aKey.Length();
sl@0: 	}
sl@0: 
sl@0: void TDbLookupKey::Add(const TDesC16& aKey)
sl@0: 	{
sl@0: 	SColumn& key=NextKey();
sl@0: 	key.iType=EDbColText16;
sl@0: 	key.iDes16.iPtr=aKey.Ptr();
sl@0: 	key.iDes16.iLength=aKey.Length();
sl@0: 	}
sl@0: 
sl@0: // Class TDbSeekKey
sl@0: 
sl@0: TDbLookupKey& TDbSeekKey::Check()
sl@0: 	{
sl@0: 	__ASSERT_ALWAYS(iKey.Count()<iMaxKeys,Panic(EDbTooManyKeys));
sl@0: 	return iKey;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(TInt aKey)
sl@0: /** Appends a key value for an TInt8, TInt16 or TInt32 column.
sl@0: 
sl@0: @param aKey The key value to lookup.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(TUint aKey)
sl@0: /** Appends a key value for a Bit, TUint8, TUint16 or TUint32 column.
sl@0: 
sl@0: @param aKey The key value to lookup.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(TInt64 aKey)
sl@0: /** Appends a key value for an TInt64 column.
sl@0: 
sl@0: @param aKey The key value to lookup.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(TReal32 aKey) __SOFTFP
sl@0: /** Appends a key value for a TReal32 column.
sl@0: 
sl@0: @param aKey The key value to lookup.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(TReal64 aKey) __SOFTFP
sl@0: /** Appends a key value for a TReal64 column.
sl@0: 
sl@0: @param aKey The key value to lookup.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(TTime aKey)
sl@0: /** Appends a key value for a DateTime column.
sl@0: 
sl@0: @param aKey The key value to lookup. TTime may be either local time or universal time. 
sl@0: DBMS doesn't interpret the value of TTime, it is left up to the user to decide which should be used.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(const TDesC8& aKey)
sl@0: /** Appends a key value for a non-Unicode text column.
sl@0: 
sl@0: Note that the seek key does not copy the text data contained by the descriptor. 
sl@0: This needs to be retained until the seek key is no longer required.
sl@0: 
sl@0: @param aKey The key value to lookup.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TDbSeekKey& TDbSeekKey::Add(const TDesC16& aKey)
sl@0: /** Appends a key value for a Unicode text column.
sl@0: 
sl@0: Note that the seek key does not copy the text data contained by the descriptor. 
sl@0: This needs to be retained until the seek key is no longer required.
sl@0: 
sl@0: @param aKey The key value to lookup.
sl@0: @return A reference to this database key value object. */
sl@0: 	{
sl@0: 	Check().Add(aKey);
sl@0: 	return *this;
sl@0: 	}
sl@0: 
sl@0: // Class CDbNames
sl@0: 
sl@0: inline CDbNames::CDbNames()
sl@0: 	: iList(KPakArrayGranularity)
sl@0: 	{}
sl@0: 
sl@0: CDbNames* CDbNames::NewLC()
sl@0: 	{
sl@0: 	CDbNames* self=new(ELeave) CDbNames;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: CDbNames::~CDbNames()
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C void CDbNames::AddL(const TDesC& aName)
sl@0: 	{
sl@0: 	TDbNameC name(aName);
sl@0: 	iList.AppendL(name,(const TUint8*)name.Ptr()+name.Size()-(const TUint8*)&name);
sl@0: 	}
sl@0: 
sl@0: ////////////////////////////////////////////////////////////////////////////////////////////////
sl@0: // Class CDbStrings
sl@0: 
sl@0: /**
sl@0: Granularity of CDbStrings array.
sl@0: @internalComponent
sl@0: */
sl@0: const TInt KPakArrayGranularity2 = KDbMaxStrLen * 2;
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: inline CDbStrings::CDbStrings() :
sl@0: 	iList(KPakArrayGranularity2)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Standard phase-one creation method for CDbStrings objects.
sl@0: @return A pointer to the created CDbStrings object.
sl@0: @leave KErrNoMemory - Out of memory.
sl@0: */
sl@0: CDbStrings* CDbStrings::NewLC()
sl@0: 	{
sl@0: 	CDbStrings* self = new(ELeave) CDbStrings;
sl@0: 	CleanupStack::PushL(self);
sl@0: 	return self;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: @internalComponent
sl@0: */
sl@0: CDbStrings::~CDbStrings()
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Adds a string to the array.
sl@0: @param aStr String to be added to the array.
sl@0: @leave KErrNoMemory - Out of memory.
sl@0: @internalComponent
sl@0: */
sl@0: void CDbStrings::AddL(const TDesC& aStr)
sl@0: 	{
sl@0: 	TDbStringC str(aStr);
sl@0: 	iList.AppendL(str, (const TUint8*)str.Ptr() + str.Size() - (const TUint8*)&str);
sl@0: 	}