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