1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/persistentdata/persistentstorage/dbms/inc/D32REC.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,201 @@
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 +//
1.18 +
1.19 +#ifndef __D32REC_H__
1.20 +#define __D32REC_H__
1.21 +#ifndef __E32BASE_H__
1.22 +#include <e32base.h>
1.23 +#endif
1.24 +#ifndef __D32DBMS_H__
1.25 +#include <d32dbms.h>
1.26 +#endif
1.27 +#ifndef __D32DBAS__
1.28 +#include "D32DBAS.H"
1.29 +#endif
1.30 +
1.31 +// classes used in this header
1.32 +class RDbTableRow;
1.33 +class MStreamBuf;
1.34 +
1.35 +// classes defined in this header
1.36 +class TDbRecordId;
1.37 +class CDbRecordBase;
1.38 +class CDbRecordIter;
1.39 +class CDbRecordSpace;
1.40 +class CDbBlobSpace;
1.41 +class CDbRecordIndex;
1.42 +
1.43 +/**
1.44 +@internalComponent
1.45 +*/
1.46 +enum TDbPosition { EDbFirst=RDbRowSet::EFirst,EDbNext=RDbRowSet::ENext,EDbPrevious=RDbRowSet::EPrevious,EDbLast=RDbRowSet::ELast };
1.47 +
1.48 +/**
1.49 +@internalComponent
1.50 +*/
1.51 +const TUint32 KDbNullRecordIdValue=0;
1.52 +class TDbRecordId
1.53 +/**
1.54 +@internalComponent
1.55 +*/
1.56 + {
1.57 +public:
1.58 + TDbRecordId() {}
1.59 + inline TDbRecordId(TUint32 aValue);
1.60 + inline TDbRecordId& operator=(TUint32 aValue);
1.61 +//
1.62 + inline TBool operator==(TDbRecordId anId) const;
1.63 + inline TBool operator!=(TDbRecordId anId) const;
1.64 +//
1.65 + inline TUint32 Value() const;
1.66 +private:
1.67 + TUint32 iValue;
1.68 + };
1.69 +#if defined(__NO_CLASS_CONSTS__)
1.70 +/**
1.71 +@internalComponent
1.72 +*/
1.73 +#define KDbNullRecordId TDbRecordId(KDbNullRecordIdValue)
1.74 +#else
1.75 +/**
1.76 +@internalComponent
1.77 +*/
1.78 +const TDbRecordId KDbNullRecordId=TDbRecordId(KDbNullRecordIdValue);
1.79 +#endif
1.80 +
1.81 +class CDbRecordBase : public CBase
1.82 +/**
1.83 +@internalComponent
1.84 +*/
1.85 + {
1.86 +private:
1.87 + enum {EOpen=0x1,EModified=0x2,EBroken=0x4};
1.88 +protected:
1.89 + CDbRecordBase() {}
1.90 +public:
1.91 + inline TBool OpenL();
1.92 + IMPORT_C void FlushL();
1.93 + inline void Abandon();
1.94 + inline TBool IsBroken() const;
1.95 +//
1.96 + static void DoFlushL(CDbRecordBase* aRec);
1.97 + static void DoDelete(CDbRecordBase* aRec);
1.98 + static void DoAbandon(CDbRecordBase* aRec);
1.99 +protected:
1.100 + IMPORT_C void TouchL();
1.101 + inline void MarkIntact();
1.102 +private:
1.103 + IMPORT_C TBool DoRestoreL();
1.104 + IMPORT_C virtual TBool RestoreL();
1.105 + IMPORT_C virtual void AboutToModifyL();
1.106 + IMPORT_C virtual void SynchL();
1.107 +private:
1.108 + TUint iFlags;
1.109 + };
1.110 +
1.111 +class CDbRecordIter : public CBase
1.112 +/**
1.113 +@internalComponent
1.114 +*/
1.115 + {
1.116 +public:
1.117 + enum TDeleted {EAtRow,ENoRow,ENotSupported};
1.118 +protected:
1.119 + IMPORT_C CDbRecordIter(CDbRecordBase& aHost);
1.120 +public:
1.121 + IMPORT_C ~CDbRecordIter();
1.122 + inline CDbRecordBase& Host() const;
1.123 +// pure virtual
1.124 + virtual TInt Count() const =0;
1.125 + virtual TDbRecordId CurrentL() =0;
1.126 + virtual TBool GotoL(TDbPosition aPosition) =0;
1.127 + virtual TBool GotoL(TDbRecordId aRecordId,RDbTableRow& aBuffer) =0; // re-synchronise
1.128 + virtual TBool SeekL(const TDbLookupKey& aKey,RDbTable::TComparison aComparison) =0;
1.129 + inline TDeleted DeletedL(TDbPosition aPosition,TDbRecordId aRecordId); // goto next id
1.130 + inline TDeleted DeletedL(TDbPosition aPosition,TDbRecordId aRecordId,const RDbTableRow& aRow); // goto next id
1.131 +//
1.132 + virtual TDeleted DoDeletedL(TDbPosition aPosition,TDbRecordId aRecordId,const RDbTableRow* aRow) =0;
1.133 +private:
1.134 + CDbRecordBase& iHost;
1.135 + };
1.136 +
1.137 +class CDbRecordSpace : public CDbRecordBase
1.138 +/**
1.139 +@internalComponent
1.140 +*/
1.141 + {
1.142 +protected:
1.143 + CDbRecordSpace() {}
1.144 +public:
1.145 + virtual TBool ExistsL(TDbRecordId aRecordId) =0;
1.146 + virtual TPtrC8 ReadL(TDbRecordId aRecordId) const =0;
1.147 + TUint8* ReplaceL(TDbRecordId aRecordId,TInt aRecordSize);
1.148 + virtual TUint AutoIncrementL() =0;
1.149 + TUint8* NewL(TInt aRecordSize);
1.150 + virtual TDbRecordId AppendL() =0;
1.151 + void EraseL(TDbRecordId aRecordId);
1.152 + virtual CDbRecordIter* IteratorL() =0;
1.153 +private:
1.154 + virtual TUint8* DoReplaceL(TDbRecordId aRecordId,TInt aRecordSize) =0;
1.155 + virtual TUint8* DoNewL(TInt aRecordSize) =0;
1.156 + virtual void DoEraseL(TDbRecordId aRecordId) =0;
1.157 + };
1.158 +
1.159 +class CDbBlobSpace : public CDbRecordBase
1.160 +/**
1.161 +@internalComponent
1.162 +*/
1.163 + {
1.164 +protected:
1.165 + CDbBlobSpace() {}
1.166 +public:
1.167 + virtual MStreamBuf* ReadL(TDbBlobId aBlobId,TDbColType aType) const =0;
1.168 + IMPORT_C MStreamBuf* ReadLC(TDbBlobId aBlobId,TDbColType aType) const;
1.169 + IMPORT_C MStreamBuf* CreateL(TDbBlobId &aBlobId,TDbColType aType);
1.170 + IMPORT_C TDbBlobId CreateL(TDbColType aType,const TAny* aBuf,TInt aLength);
1.171 + IMPORT_C void DeleteL(TDbBlobId aBlobId);
1.172 + IMPORT_C TInt Delete(TDbBlobId aBlobId);
1.173 + inline TInt InlineLimit() const;
1.174 +protected:
1.175 + inline void SetInlineLimit(TInt anInlineLimit);
1.176 +private:
1.177 + virtual MStreamBuf* DoCreateL(TDbBlobId &aBlobId,TDbColType aType) =0;
1.178 + virtual void DoDeleteL(TDbBlobId aBlobId) =0;
1.179 +private:
1.180 + TInt iInlineLimit;
1.181 + };
1.182 +
1.183 +class CDbRecordIndex : public CDbRecordBase
1.184 +/**
1.185 +@internalComponent
1.186 +*/
1.187 + {
1.188 +public:
1.189 + enum TFind {ENoMatch,EKeyMatch,EEntryMatch};
1.190 + enum TInclusion {EIncludeLower=0x1,EIncludeUpper=0x2,EIncludeBoth=0x3};
1.191 +protected:
1.192 + CDbRecordIndex() {}
1.193 +public:
1.194 + virtual TFind FindL(TDbRecordId aRecordId,const RDbTableRow& aRow) =0;
1.195 + TBool InsertL(TDbRecordId aRecordId,const RDbTableRow& aRow);
1.196 + void DeleteL(TDbRecordId aRecordId,const RDbTableRow& aRow);
1.197 + virtual CDbRecordIter* IteratorL(TUint aInclusion=0,const TDbLookupKey* aLowerBound=0,const TDbLookupKey* aUpperBound=0) =0;
1.198 +private:
1.199 + virtual TBool DoInsertL(TDbRecordId aRecordId,const RDbTableRow& aRow) =0;
1.200 + virtual void DoDeleteL(TDbRecordId aRecordId,const RDbTableRow& aRow) =0;
1.201 + };
1.202 +
1.203 +#include "D32REC.INL"
1.204 +#endif