1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/BADESCA.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,326 @@
1.4 +// Copyright (c) 1997-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 +// Written by DavidW, October 1996
1.18 +// Descriptor arrays
1.19 +//
1.20 +//
1.21 +
1.22 +#if !defined(__BADESCA_H__)
1.23 +#define __BADESCA_H__
1.24 +
1.25 +#if !defined(__BAMDESCA_H__)
1.26 +#include <bamdesca.h>
1.27 +#endif
1.28 +
1.29 +#if !defined(__E32BASE_H__)
1.30 +#include <e32base.h>
1.31 +#endif
1.32 +
1.33 +
1.34 +class CDesC8Array : public CArrayFixBase, public MDesC8Array
1.35 +/** An implementation base class for 8 bit descriptor arrays.
1.36 +
1.37 +It provides some of the behaviour for 8 bit descriptor arrays. The class is
1.38 +abstract and cannot be instantiated.
1.39 +@publishedAll
1.40 +@released
1.41 +*/
1.42 + {
1.43 +protected:
1.44 + IMPORT_C CDesC8Array(TBufRep aRep,TInt aGranularity);
1.45 +public:
1.46 + IMPORT_C ~CDesC8Array();
1.47 + IMPORT_C void AppendL(const TDesC8& aPtr);
1.48 + IMPORT_C void InsertL(TInt aPos,const TDesC8& aPtr);
1.49 + IMPORT_C TInt InsertIsqL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
1.50 + IMPORT_C TInt InsertIsqAllowDuplicatesL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
1.51 + IMPORT_C void Sort(TKeyCmpText aTextComparisonType=ECmpFolded);
1.52 + IMPORT_C TInt Find(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
1.53 + IMPORT_C TInt FindIsq(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
1.54 + IMPORT_C void Delete(TInt aPos);
1.55 + IMPORT_C void Delete(TInt aIndex,TInt aCount);
1.56 + IMPORT_C void Reset();
1.57 + inline TPtrC8 operator[](TInt aIndex) const;
1.58 +// from MDesC8Array
1.59 + IMPORT_C TInt MdcaCount() const;
1.60 + IMPORT_C TPtrC8 MdcaPoint(TInt aIndex) const;
1.61 + };
1.62 +
1.63 +inline TPtrC8 CDesC8Array::operator[](TInt aIndex) const
1.64 + { return(MdcaPoint(aIndex)); }
1.65 +
1.66 +
1.67 +class CDesC8ArrayFlat : public CDesC8Array
1.68 +/** An array of 8 bit descriptors implemented using a flat buffer.
1.69 +"bafl.lib"
1.70 +@since 5.0
1.71 +@publishedAll
1.72 +@released
1.73 +*/
1.74 + {
1.75 +public:
1.76 + IMPORT_C CDesC8ArrayFlat(TInt aGranularity);
1.77 + IMPORT_C ~CDesC8ArrayFlat();
1.78 + };
1.79 +
1.80 +
1.81 +class CDesC8ArraySeg : public CDesC8Array
1.82 +/** An array of 8 bit descriptors implemented using a segmented buffer.
1.83 +"bafl.lib"
1.84 +@since 5.0
1.85 +@publishedAll
1.86 +@released
1.87 +*/
1.88 + {
1.89 +public:
1.90 + IMPORT_C CDesC8ArraySeg(TInt aGranularity);
1.91 + IMPORT_C ~CDesC8ArraySeg();
1.92 + };
1.93 +
1.94 +
1.95 +class CDesC16Array : public CArrayFixBase, public MDesC16Array
1.96 +/** An implementation base class for 16 bit descriptor arrays. It provides some
1.97 +of the behaviour for 16 bit descriptor arrays.
1.98 +
1.99 +The class is abstract and cannot be instantiated.
1.100 +" bafl.lib "
1.101 +@since 5.0
1.102 +@publishedAll
1.103 +@released
1.104 +*/
1.105 + {
1.106 +protected:
1.107 + IMPORT_C CDesC16Array(TBufRep aRep,TInt aGranularity);
1.108 +public:
1.109 + IMPORT_C ~CDesC16Array();
1.110 + IMPORT_C void AppendL(const TDesC16& aPtr);
1.111 + IMPORT_C void InsertL(TInt aPos,const TDesC16& aPtr);
1.112 + IMPORT_C TInt InsertIsqL(const TDesC16& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
1.113 + IMPORT_C TInt InsertIsqAllowDuplicatesL(const TDesC16& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
1.114 + IMPORT_C void Sort(TKeyCmpText aTextComparisonType=ECmpFolded);
1.115 + IMPORT_C TInt Find(const TDesC16& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
1.116 + IMPORT_C TInt FindIsq(const TDesC16& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
1.117 + IMPORT_C void Delete(TInt aPos);
1.118 + IMPORT_C void Delete(TInt aIndex,TInt aCount);
1.119 + IMPORT_C void Reset();
1.120 + inline TPtrC16 operator[](TInt aIndex) const;
1.121 +// from MDesC16Array
1.122 + IMPORT_C TInt MdcaCount() const;
1.123 + IMPORT_C TPtrC16 MdcaPoint(TInt aIndex) const;
1.124 + };
1.125 +
1.126 +
1.127 +
1.128 +inline TPtrC16 CDesC16Array::operator[](TInt aIndex) const
1.129 +/** Returns a non-modifiable descriptor to represent the descriptor
1.130 +element located at the specified index within the array.
1.131 +
1.132 +@param aIndex The position of the descriptor element within the array.
1.133 +The position is relative to zero; i.e. zero implies the first descriptor
1.134 +element in the array. This value must be non-negative and less than the
1.135 +number of descriptors currently within the array otherwise the operator
1.136 +panics with
1.137 +@code
1.138 +EArrayIndexOutOfRange
1.139 +@endcode
1.140 +@return A 16 bit non-modifiable pointer descriptor. */
1.141 + { return(MdcaPoint(aIndex)); }
1.142 +
1.143 +
1.144 +class CDesC16ArrayFlat : public CDesC16Array
1.145 +/** Array of 16 bit descriptors implemented using a flat buffer.
1.146 +"bafl.lib
1.147 +@since 5.0
1.148 +@publishedAll
1.149 +@released
1.150 +*/
1.151 + {
1.152 +public:
1.153 + IMPORT_C CDesC16ArrayFlat(TInt aGranularity);
1.154 + IMPORT_C ~CDesC16ArrayFlat();
1.155 + };
1.156 +
1.157 +
1.158 +class CDesC16ArraySeg : public CDesC16Array
1.159 +/** An array of 16 bit descriptors implemented using a segmented buffer.
1.160 +"bafl.lib"
1.161 +@since 5.0
1.162 +@publishedAll
1.163 +@released
1.164 +*/
1.165 + {
1.166 +public:
1.167 + IMPORT_C CDesC16ArraySeg(TInt aGranularity);
1.168 + IMPORT_C ~CDesC16ArraySeg();
1.169 + };
1.170 +
1.171 +
1.172 +class CPtrC8Array : public CArrayFixFlat<TPtrC8>, public MDesC8Array
1.173 +/** Array of 8 bit non-modifiable pointer descriptors, TPtrC8, implemented using
1.174 +a flat buffer.
1.175 +"bafl.lib"
1.176 +@since 5.0
1.177 +@publishedAll
1.178 +@released
1.179 +*/
1.180 + {
1.181 +public:
1.182 + IMPORT_C CPtrC8Array(TInt aGranularity);
1.183 + IMPORT_C ~CPtrC8Array();
1.184 +//
1.185 + IMPORT_C void CopyL(const MDesC8Array& aArray);
1.186 + inline void operator=(const MDesC8Array& aArray);
1.187 +// Mixin members
1.188 + IMPORT_C TInt MdcaCount() const;
1.189 + IMPORT_C TPtrC8 MdcaPoint(TInt aIndex) const;
1.190 + };
1.191 +
1.192 +
1.193 +class CPtrC16Array : public CArrayFixFlat<TPtrC16>, public MDesC16Array
1.194 +/** An array of 16 bit non-modifiable pointer descriptors, TPtrC16, implemented
1.195 +using a flat buffer.
1.196 +"bafl.lib"
1.197 +@since 5.0
1.198 +@publishedAll
1.199 +@released
1.200 +*/
1.201 + {
1.202 +public:
1.203 + IMPORT_C CPtrC16Array(TInt aGranularity);
1.204 + IMPORT_C ~CPtrC16Array();
1.205 +//
1.206 + IMPORT_C void CopyL(const MDesC16Array& aArray);
1.207 + inline void operator=(const MDesC16Array& aArray);
1.208 +// Mixin members
1.209 + IMPORT_C TInt MdcaCount() const;
1.210 + IMPORT_C TPtrC16 MdcaPoint(TInt aIndex) const;
1.211 + };
1.212 +
1.213 +
1.214 +inline void CPtrC8Array::operator=(const MDesC8Array& aArray)
1.215 +/** Copies a descriptor array into this array, deleting any pre-existing
1.216 +elements.
1.217 +
1.218 +The function constructs TPtrC8 elements for each descriptor element
1.219 +in the specified descriptor array. This operator behaves in the
1.220 +same ways as CPtrC8Array::CopyL().
1.221 +
1.222 +@param aArrayA reference to any descriptor array which satisfies
1.223 +the protocol defined by this mixin class. */
1.224 + {CopyL(aArray);}
1.225 +
1.226 +
1.227 +inline void CPtrC16Array::operator=(const MDesC16Array& aArray)
1.228 +/** Copies a descriptor array into this array, deleting any pre-existing
1.229 +elements.
1.230 +
1.231 +The function constructs TPtrC16 elements for each descriptor element
1.232 +in the specified descriptor array.This operator behaves in the
1.233 +same ways as CPtrC16Array::CopyL().
1.234 +
1.235 +@param aArray A reference to any descriptor array which satisfies
1.236 +the protocol defined by this mixin class. */
1.237 + {CopyL(aArray);}
1.238 +
1.239 +// generic text array definitions
1.240 +
1.241 +#if defined (_UNICODE)
1.242 +/** Build independent implementation base class for descriptor arrays.
1.243 +
1.244 +@see CDesC8Array
1.245 +@see CDesC16Array
1.246 +@publishedAll
1.247 +@released
1.248 +*/
1.249 +typedef CDesC16Array CDesCArray;
1.250 +
1.251 +/** Build independent array of descriptors implemented using a flat buffer.
1.252 +
1.253 +@see CDesC8ArrayFlat
1.254 +@see CDesC16ArrayFlat
1.255 +@publishedAll
1.256 +@released
1.257 +*/
1.258 +typedef CDesC16ArrayFlat CDesCArrayFlat;
1.259 +
1.260 +/** Build independent array of descriptors implemented using a segmented buffer.
1.261 +
1.262 +@see CDesC16ArraySeg
1.263 +@see CDesC8ArraySeg
1.264 +@publishedAll
1.265 +@released
1.266 +*/
1.267 +typedef CDesC16ArraySeg CDesCArraySeg;
1.268 +
1.269 +/** Build independent array of non-modifiable pointer descriptors.
1.270 +
1.271 +A 16 bit build variant is generated for a Unicode build and an 8 bit build
1.272 +variant generated for a non-Unicode build.
1.273 +
1.274 +This build independent type should always be used unless an explicit 8 bit
1.275 +or 16 bit build variant is required.
1.276 +
1.277 +@see CPtrC16Array
1.278 +@see CPtrC8Array
1.279 +@publishedAll
1.280 +@released
1.281 +*/
1.282 +typedef CPtrC16Array CPtrCArray;
1.283 +#else
1.284 +/** Build independent implementation base class for descriptor arrays.
1.285 +
1.286 +@see CDesC8Array
1.287 +@see CDesC16Array
1.288 +@publishedAll
1.289 +@released
1.290 +*/
1.291 +typedef CDesC8Array CDesCArray;
1.292 +/** Build independent array of descriptors implemented using a flat buffer.
1.293 +
1.294 +@see CDesC8ArrayFlat
1.295 +@see CDesC16ArrayFlat
1.296 +@publishedAll
1.297 +@released
1.298 +*/
1.299 +typedef CDesC8ArrayFlat CDesCArrayFlat;
1.300 +/** Build independent array of descriptors implemented using a segmented buffer.
1.301 +
1.302 +@see CDesC16ArraySeg
1.303 +@see CDesC8ArraySeg
1.304 +@publishedAll
1.305 +@released
1.306 +*/
1.307 +typedef CDesC8ArraySeg CDesCArraySeg;
1.308 +/** Build independent array of non-modifiable pointer descriptors.
1.309 +
1.310 +A 16 bit build variant is generated for a Unicode build and an 8 bit build
1.311 +variant generated for a non-Unicode build.
1.312 +
1.313 +This build independent type should always be used unless an explicit 8 bit
1.314 +or 16 bit build variant is required.
1.315 +
1.316 +@see CPtrC16Array
1.317 +@see CPtrC8Array
1.318 +@publishedAll
1.319 +@released
1.320 +*/
1.321 +typedef CPtrC8Array CPtrCArray;
1.322 +#endif
1.323 +
1.324 +
1.325 +#endif // __BADESCA_H__
1.326 +
1.327 +
1.328 +
1.329 +