epoc32/include/mw/senpointermap.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2005 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: Pointermap class declaration        
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
#ifndef POINTERMAP_H
williamr@2
    19
#define POINTERMAP_H
williamr@2
    20
williamr@2
    21
// INCLUDES
williamr@2
    22
#include <e32std.h>
williamr@2
    23
williamr@2
    24
// CLASS DECLARATION
williamr@2
    25
template <typename K, typename V>
williamr@2
    26
class RSenPointerMap
williamr@2
    27
    {
williamr@2
    28
    public: // Constructors and destructor
williamr@2
    29
        
williamr@2
    30
    RSenPointerMap(TBool aTakeOwnershipKey, TBool aTakeOwnershipValue)
williamr@2
    31
        :
williamr@2
    32
        iTakeOwnershipKey(aTakeOwnershipKey),
williamr@2
    33
        iTakeOwnershipValue(aTakeOwnershipValue)
williamr@2
    34
        {}
williamr@2
    35
williamr@2
    36
    ~RSenPointerMap()
williamr@2
    37
        {
williamr@2
    38
        Reset();
williamr@2
    39
        }
williamr@2
    40
williamr@2
    41
        // New functions
williamr@2
    42
        
williamr@2
    43
    TInt Append(const K* aKey, const V* aValue)
williamr@2
    44
        {
williamr@2
    45
        TInt err = iKeys.Append(aKey);
williamr@2
    46
        if (err == KErrNone)
williamr@2
    47
            {
williamr@2
    48
            err = iValues.Append(aValue);
williamr@2
    49
            if (err != KErrNone)
williamr@2
    50
                {
williamr@2
    51
                // last element of iKeys should be removed
williamr@2
    52
                TInt lastElementIndex = iKeys.Count() - 1;
williamr@2
    53
                iKeys.Remove(lastElementIndex);
williamr@2
    54
                }
williamr@2
    55
            }
williamr@2
    56
        return err;
williamr@2
    57
        }
williamr@2
    58
williamr@2
    59
    TInt Find(const K& aKey) const
williamr@2
    60
        {
williamr@2
    61
        TInt index = KErrNotFound;
williamr@2
    62
        for (int i = 0; i < iKeys.Count(); i++)
williamr@2
    63
            {
williamr@2
    64
            if (*iKeys[i] == aKey)
williamr@2
    65
                {
williamr@2
    66
                index = i;
williamr@2
    67
                break;
williamr@2
    68
                }
williamr@2
    69
            }
williamr@2
    70
        return index;
williamr@2
    71
        }
williamr@2
    72
williamr@2
    73
    // @return the index of removed key-value pair, or
williamr@2
    74
    // KErrNotFound, if such key was not found
williamr@2
    75
    TInt RemoveByKey(const K& aKey)
williamr@2
    76
        {
williamr@2
    77
        TInt index = Find(aKey);
williamr@2
    78
        if (index != KErrNotFound)
williamr@2
    79
            {
williamr@2
    80
            if(iTakeOwnershipKey)
williamr@2
    81
                {
williamr@2
    82
                K* key = KeyAt(index);
williamr@2
    83
                delete key;
williamr@2
    84
                }
williamr@2
    85
            if(iTakeOwnershipValue)
williamr@2
    86
                {
williamr@2
    87
                V* value = iValues[index];
williamr@2
    88
                delete value;
williamr@2
    89
                }
williamr@2
    90
            iKeys.Remove(index);
williamr@2
    91
            iValues.Remove(index);
williamr@2
    92
            }
williamr@2
    93
        return index;
williamr@2
    94
        }
williamr@2
    95
williamr@2
    96
    // @return the index of removed key-value pair, or
williamr@2
    97
    // KErrNotFound, if such key was not found
williamr@2
    98
    TInt Remove(const V& aValue)
williamr@2
    99
        {
williamr@2
   100
        TInt index = FindValue(aValue);
williamr@2
   101
        if (index != KErrNotFound)
williamr@2
   102
            {
williamr@2
   103
            if (iTakeOwnershipValue)
williamr@2
   104
                {
williamr@2
   105
                V* value = iValues[index];
williamr@2
   106
                delete value;
williamr@2
   107
                }
williamr@2
   108
            if (iTakeOwnershipKey)
williamr@2
   109
                {
williamr@2
   110
                K* key = iKeys[index];
williamr@2
   111
                delete key;
williamr@2
   112
                }
williamr@2
   113
            iValues.Remove(index);
williamr@2
   114
            iKeys.Remove(index);
williamr@2
   115
            }
williamr@2
   116
        return index; 
williamr@2
   117
        }
williamr@2
   118
williamr@2
   119
    TInt FindValue(const V& aValue) const
williamr@2
   120
        {
williamr@2
   121
        TInt index = KErrNotFound;
williamr@2
   122
        for (int i = 0; i < iValues.Count(); i++)
williamr@2
   123
            {
williamr@2
   124
            if ((iValues[i]) && (*iValues[i] == aValue))
williamr@2
   125
                {
williamr@2
   126
                index = i;
williamr@2
   127
                break;
williamr@2
   128
                }
williamr@2
   129
            }
williamr@2
   130
        return index;
williamr@2
   131
        }
williamr@2
   132
williamr@2
   133
williamr@2
   134
    // Note: deletes the current value of this key
williamr@2
   135
    TInt UpdateValue(const K* aKey, const V* aValue)
williamr@2
   136
        {
williamr@2
   137
        TInt index=Find(*aKey);
williamr@2
   138
        if (index==KErrNotFound)
williamr@2
   139
            {
williamr@2
   140
            return Append(aKey, aValue);
williamr@2
   141
            }
williamr@2
   142
williamr@2
   143
        V* bValue=iValues[index];
williamr@2
   144
        if (iTakeOwnershipValue)
williamr@2
   145
            {
williamr@2
   146
            // Since OWNED value is going to be replaced with aValue,
williamr@2
   147
            // destroy old value instance first:
williamr@2
   148
            delete bValue;  
williamr@2
   149
            }
williamr@2
   150
williamr@2
   151
        iValues[index]=(V*)aValue;
williamr@2
   152
        return KErrNone;
williamr@2
   153
        }
williamr@2
   154
williamr@2
   155
williamr@2
   156
    K* KeyAt(TInt aIndex)
williamr@2
   157
        {
williamr@2
   158
        return iKeys[aIndex];
williamr@2
   159
        }
williamr@2
   160
williamr@2
   161
    const V* ValueAt(TInt aIndex) const
williamr@2
   162
        {
williamr@2
   163
        return iValues[aIndex];
williamr@2
   164
        }
williamr@2
   165
williamr@2
   166
    TInt Count() const
williamr@2
   167
        {
williamr@2
   168
        return iKeys.Count();
williamr@2
   169
        }
williamr@2
   170
williamr@2
   171
    void Reset()
williamr@2
   172
        {
williamr@2
   173
        if ( iTakeOwnershipKey )
williamr@2
   174
            {
williamr@2
   175
            iKeys.ResetAndDestroy();
williamr@2
   176
            }
williamr@2
   177
        else
williamr@2
   178
            {
williamr@2
   179
            iKeys.Reset();
williamr@2
   180
            }
williamr@2
   181
williamr@2
   182
        if ( iTakeOwnershipValue )
williamr@2
   183
            {
williamr@2
   184
            iValues.ResetAndDestroy();
williamr@2
   185
            }
williamr@2
   186
        else
williamr@2
   187
            {
williamr@2
   188
            iValues.Reset();
williamr@2
   189
            }
williamr@2
   190
        }
williamr@2
   191
        
williamr@2
   192
    TInt Insert(const K* aKey, const V* aValue)
williamr@2
   193
        {
williamr@2
   194
        TInt count=iKeys.Count();
williamr@2
   195
        TInt err=KErrNone;
williamr@2
   196
		TBool inserted=EFalse;
williamr@2
   197
williamr@2
   198
        for(TInt i=0; i<count; i++)
williamr@2
   199
        	{
williamr@2
   200
        	 if(*iKeys[i] >= *aKey)
williamr@2
   201
        	 {
williamr@2
   202
	        err = iKeys.Insert(aKey, i);
williamr@2
   203
	        if (err == KErrNone)
williamr@2
   204
	            {
williamr@2
   205
	            err = iValues.Insert(aValue, i);
williamr@2
   206
	            if (err != KErrNone)
williamr@2
   207
	                {
williamr@2
   208
	                // inserted element of iKeys should be removed
williamr@2
   209
	                iKeys.Remove(i);
williamr@2
   210
	                }
williamr@2
   211
				    else
williamr@2
   212
					{
williamr@2
   213
					inserted=ETrue;
williamr@2
   214
					}
williamr@2
   215
            	}
williamr@2
   216
			break;  	 	
williamr@2
   217
        	 }
williamr@2
   218
			}
williamr@2
   219
williamr@2
   220
        if(!inserted)
williamr@2
   221
        	{
williamr@2
   222
	        err = iKeys.Append(aKey);
williamr@2
   223
	        if (err == KErrNone)
williamr@2
   224
	            {
williamr@2
   225
	            err = iValues.Append(aValue);
williamr@2
   226
	            if (err != KErrNone)
williamr@2
   227
	                {
williamr@2
   228
	                // last element of iKeys should be removed
williamr@2
   229
	                TInt lastElementIndex = iKeys.Count() - 1;
williamr@2
   230
	                iKeys.Remove(lastElementIndex);
williamr@2
   231
	                }
williamr@2
   232
            	}
williamr@2
   233
        	}
williamr@2
   234
	return err;
williamr@2
   235
        }
williamr@2
   236
        
williamr@2
   237
    private: // Data
williamr@2
   238
    TBool iTakeOwnershipKey;
williamr@2
   239
    TBool iTakeOwnershipValue;
williamr@2
   240
    RPointerArray<K> iKeys;
williamr@2
   241
    RPointerArray<V> iValues;
williamr@2
   242
    };
williamr@2
   243
williamr@2
   244
#endif // POINTERMAP_H
williamr@2
   245
williamr@2
   246
// End of File
williamr@2
   247