os/persistentdata/persistentstorage/store/INC/S32CONT.H
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#if !defined(__S32CONT_H__)
sl@0
    17
#define __S32CONT_H__
sl@0
    18
#if !defined(__S32BTREE_H__)
sl@0
    19
#include <s32btree.h>
sl@0
    20
#endif
sl@0
    21
sl@0
    22
/**
sl@0
    23
 * @publishedAll 
sl@0
    24
 * @released
sl@0
    25
 */
sl@0
    26
class TPagedSetToken : public TBtreeToken
sl@0
    27
	{
sl@0
    28
public:
sl@0
    29
	TPagedSetToken() {}
sl@0
    30
	inline TPagedSetToken(TEmpty);
sl@0
    31
//
sl@0
    32
	inline TInt Count() const;
sl@0
    33
//
sl@0
    34
	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
sl@0
    35
	IMPORT_C void InternalizeL(RReadStream& aStream);
sl@0
    36
protected:
sl@0
    37
	IMPORT_C void Clear();
sl@0
    38
private:
sl@0
    39
	inline TPagedSetToken(const TBtreeToken& aTree,TInt aCount);
sl@0
    40
private:
sl@0
    41
	TInt iCount;
sl@0
    42
private:
sl@0
    43
	friend class TPagedSetBase;
sl@0
    44
	};
sl@0
    45
#define KEmptyPagedSetToken TPagedSetToken(TPagedSetToken::EEmpty)
sl@0
    46
sl@0
    47
/**
sl@0
    48
 * @publishedAll 
sl@0
    49
 * @released
sl@0
    50
 */
sl@0
    51
class TPagedSetBase
sl@0
    52
	{
sl@0
    53
public:
sl@0
    54
	IMPORT_C void Connect(MPagePool* aPool);
sl@0
    55
	IMPORT_C void Set(const TPagedSetToken& aToken);
sl@0
    56
	IMPORT_C TPagedSetToken Token() const;
sl@0
    57
//
sl@0
    58
	inline TBool IsDirty() const;
sl@0
    59
	inline void MarkCurrent();
sl@0
    60
	inline void MarkDirty();
sl@0
    61
//
sl@0
    62
	inline TBool IsBroken() const;
sl@0
    63
	inline TBool IsIntact() const;
sl@0
    64
	inline void MarkBroken();
sl@0
    65
	IMPORT_C TInt RepairL();
sl@0
    66
//
sl@0
    67
	inline TInt Count() const;
sl@0
    68
	inline TBool IsEmpty() const;
sl@0
    69
	IMPORT_C void ClearL();
sl@0
    70
//
sl@0
    71
	IMPORT_C TBool ContainsL(const TAny* aPtr) const;
sl@0
    72
	IMPORT_C void InsertL(const TAny* aPtr);
sl@0
    73
	IMPORT_C void DeleteL(const TAny* aPtr);
sl@0
    74
protected:
sl@0
    75
	IMPORT_C TPagedSetBase(TInt anEntrySize);
sl@0
    76
	IMPORT_C TPagedSetBase(const TPagedSetToken& aToken,TInt anEntrySize);
sl@0
    77
	IMPORT_C void InsertAllowDuplicatesL(const TAny* aPtr);
sl@0
    78
private:
sl@0
    79
	TBtreeFix<TAny,TAny> iTree;
sl@0
    80
	TBtreeKey iKey;
sl@0
    81
	TInt iCount;
sl@0
    82
private:
sl@0
    83
	friend class TPagedSetIterBase;
sl@0
    84
	friend class TPagedSetBiIterBase;
sl@0
    85
	};
sl@0
    86
sl@0
    87
/**
sl@0
    88
 * @publishedAll 
sl@0
    89
 * @released
sl@0
    90
 */
sl@0
    91
class TPagedMultisetBase : public TPagedSetBase
sl@0
    92
	{
sl@0
    93
public:
sl@0
    94
	inline void InsertL(const TAny* aPtr);
sl@0
    95
protected:
sl@0
    96
	inline TPagedMultisetBase(TInt anEntrySize);
sl@0
    97
	inline TPagedMultisetBase(const TPagedSetToken& aToken,TInt anEntrySize);
sl@0
    98
	};
sl@0
    99
sl@0
   100
/**
sl@0
   101
 * @publishedAll 
sl@0
   102
 * @released
sl@0
   103
 */
sl@0
   104
template <class T>
sl@0
   105
class TPagedSet : public TPagedSetBase
sl@0
   106
	{
sl@0
   107
public:
sl@0
   108
	inline TPagedSet();
sl@0
   109
	inline TPagedSet(const TPagedSetToken& aToken);
sl@0
   110
//
sl@0
   111
	inline TBool ContainsL(const T& anObject) const;
sl@0
   112
	inline void InsertL(const T& anObject);
sl@0
   113
	inline void DeleteL(const T& anObject);
sl@0
   114
	};
sl@0
   115
sl@0
   116
/**
sl@0
   117
 * @publishedAll 
sl@0
   118
 * @released
sl@0
   119
 */
sl@0
   120
TEMPLATE_SPECIALIZATION class TPagedSet<TAny> : public TPagedSetBase
sl@0
   121
	{
sl@0
   122
public:
sl@0
   123
	inline TPagedSet(TInt anEntrySize);
sl@0
   124
	inline TPagedSet(const TPagedSetToken& aToken,TInt anEntrySize);
sl@0
   125
	};
sl@0
   126
sl@0
   127
/**
sl@0
   128
 * @publishedAll 
sl@0
   129
 * @released
sl@0
   130
 */
sl@0
   131
template <class T>
sl@0
   132
class TPagedMultiset : public TPagedMultisetBase
sl@0
   133
	{
sl@0
   134
public:
sl@0
   135
	inline TPagedMultiset();
sl@0
   136
	inline TPagedMultiset(const TPagedSetToken& aToken);
sl@0
   137
//
sl@0
   138
	inline TBool ContainsL(const T& anObject) const;
sl@0
   139
	inline void InsertL(const T& anObject);
sl@0
   140
	inline void DeleteL(const T& anObject);
sl@0
   141
	};
sl@0
   142
sl@0
   143
/**
sl@0
   144
 * @publishedAll 
sl@0
   145
 * @released
sl@0
   146
 */
sl@0
   147
TEMPLATE_SPECIALIZATION class TPagedMultiset<TAny> : public TPagedMultisetBase
sl@0
   148
	{
sl@0
   149
public:
sl@0
   150
	inline TPagedMultiset(TInt anEntrySize);
sl@0
   151
	inline TPagedMultiset(const TPagedSetToken& aToken,TInt anEntrySize);
sl@0
   152
	};
sl@0
   153
sl@0
   154
/**
sl@0
   155
 * @publishedAll 
sl@0
   156
 * @released
sl@0
   157
 */
sl@0
   158
class TPagedSetIterBase
sl@0
   159
	{
sl@0
   160
public:
sl@0
   161
	IMPORT_C TBool ResetL();
sl@0
   162
	IMPORT_C TBool NextL();
sl@0
   163
	IMPORT_C void ExtractAtL(TAny* aPtr) const;
sl@0
   164
protected:
sl@0
   165
	inline TPagedSetIterBase(const TPagedSetBase& aSet);
sl@0
   166
private:
sl@0
   167
	const TBtreeFixBase* iTree;
sl@0
   168
	TBtreeMark iMark;
sl@0
   169
	};
sl@0
   170
sl@0
   171
/**
sl@0
   172
 * @publishedAll 
sl@0
   173
 * @released
sl@0
   174
 */
sl@0
   175
template <class T>
sl@0
   176
class TPagedSetIter : public TPagedSetIterBase
sl@0
   177
	{
sl@0
   178
public:
sl@0
   179
	inline TPagedSetIter(const TPagedSet<T>& aSet);
sl@0
   180
	inline TPagedSetIter(const TPagedMultiset<T>& aSet);
sl@0
   181
	inline T AtL() const;
sl@0
   182
	inline void ExtractAtL(T& anObject) const;
sl@0
   183
	};
sl@0
   184
sl@0
   185
/**
sl@0
   186
 * @publishedAll 
sl@0
   187
 * @released
sl@0
   188
 */
sl@0
   189
TEMPLATE_SPECIALIZATION class TPagedSetIter<TAny> : public TPagedSetIterBase
sl@0
   190
	{
sl@0
   191
public:
sl@0
   192
	inline TPagedSetIter(const TPagedSetBase& aSet);
sl@0
   193
	};
sl@0
   194
sl@0
   195
/**
sl@0
   196
 * @publishedAll 
sl@0
   197
 * @released
sl@0
   198
 */
sl@0
   199
class TPagedSetBiIterBase
sl@0
   200
	{
sl@0
   201
public:
sl@0
   202
	IMPORT_C TBool FirstL();
sl@0
   203
	IMPORT_C TBool LastL();
sl@0
   204
	IMPORT_C TBool NextL();
sl@0
   205
	IMPORT_C TBool PreviousL();
sl@0
   206
	IMPORT_C void ExtractAtL(TAny* aPtr) const;
sl@0
   207
protected:
sl@0
   208
	inline TPagedSetBiIterBase(const TPagedSetBase& aSet);
sl@0
   209
private:
sl@0
   210
	const TBtreeFixBase* iTree;
sl@0
   211
	TBtreePos iPos;
sl@0
   212
	};
sl@0
   213
sl@0
   214
/**
sl@0
   215
 * @publishedAll 
sl@0
   216
 * @released
sl@0
   217
 */
sl@0
   218
template <class T>
sl@0
   219
class TPagedSetBiIter : public TPagedSetBiIterBase
sl@0
   220
	{
sl@0
   221
public:
sl@0
   222
	inline TPagedSetBiIter(const TPagedSet<T>& aSet);
sl@0
   223
	inline TPagedSetBiIter(const TPagedMultiset<T>& aSet);
sl@0
   224
	inline T AtL() const;
sl@0
   225
	inline void ExtractAtL(T& anObject) const;
sl@0
   226
	};
sl@0
   227
sl@0
   228
/**
sl@0
   229
 * @publishedAll 
sl@0
   230
 * @released
sl@0
   231
 */
sl@0
   232
TEMPLATE_SPECIALIZATION class TPagedSetBiIter<TAny> : public TPagedSetBiIterBase
sl@0
   233
	{
sl@0
   234
public:
sl@0
   235
	inline TPagedSetBiIter(const TPagedSetBase& aSet);
sl@0
   236
	};
sl@0
   237
sl@0
   238
/**
sl@0
   239
 * @publishedAll 
sl@0
   240
 * @released
sl@0
   241
 */
sl@0
   242
class TPagedSetRIterBase
sl@0
   243
	{
sl@0
   244
public:
sl@0
   245
	inline TBool ResetL();
sl@0
   246
	inline TBool NextL();
sl@0
   247
	inline void ExtractAtL(TAny* aPtr) const;
sl@0
   248
protected:
sl@0
   249
	inline TPagedSetRIterBase(const TPagedSetBase& aSet);
sl@0
   250
private:
sl@0
   251
	TPagedSetBiIter<TAny> iIter;
sl@0
   252
	};
sl@0
   253
sl@0
   254
/**
sl@0
   255
 * @publishedAll 
sl@0
   256
 * @released
sl@0
   257
 */
sl@0
   258
template <class T>
sl@0
   259
class TPagedSetRIter : public TPagedSetRIterBase
sl@0
   260
	{
sl@0
   261
public:
sl@0
   262
	inline TPagedSetRIter(const TPagedSet<T>& aSet);
sl@0
   263
	inline TPagedSetRIter(const TPagedMultiset<T>& aSet);
sl@0
   264
	inline T AtL() const;
sl@0
   265
	inline void ExtractAtL(T& anObject) const;
sl@0
   266
	};
sl@0
   267
sl@0
   268
/**
sl@0
   269
 * @publishedAll 
sl@0
   270
 * @released
sl@0
   271
 */
sl@0
   272
TEMPLATE_SPECIALIZATION class TPagedSetRIter<TAny> : public TPagedSetRIterBase
sl@0
   273
	{
sl@0
   274
public:
sl@0
   275
	inline TPagedSetRIter(const TPagedSetBase& aSet);
sl@0
   276
	};
sl@0
   277
sl@0
   278
#include <s32cont.inl>
sl@0
   279
#endif