sl@0: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Written by DavidW, October 1996
sl@0: // Descriptor arrays
sl@0: // 
sl@0: //
sl@0: 
sl@0: #if !defined(__BADESCA_H__)
sl@0: #define __BADESCA_H__
sl@0: 
sl@0: #if !defined(__BAMDESCA_H__)
sl@0: #include <bamdesca.h>
sl@0: #endif
sl@0: 
sl@0: #if !defined(__E32BASE_H__)
sl@0: #include <e32base.h>
sl@0: #endif
sl@0: 
sl@0: 
sl@0: class CDesC8Array : public CArrayFixBase, public MDesC8Array
sl@0: /** An implementation base class for 8 bit descriptor arrays. 
sl@0: 
sl@0: It provides some of the behaviour for 8 bit descriptor arrays. The class is 
sl@0: abstract and cannot be instantiated. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: protected:
sl@0: 	IMPORT_C CDesC8Array(TBufRep aRep,TInt aGranularity);
sl@0: public:
sl@0:     IMPORT_C ~CDesC8Array();
sl@0: 	IMPORT_C void AppendL(const TDesC8& aPtr);
sl@0: 	IMPORT_C void InsertL(TInt aPos,const TDesC8& aPtr);
sl@0: 	IMPORT_C TInt InsertIsqL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
sl@0: 	IMPORT_C TInt InsertIsqAllowDuplicatesL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
sl@0: 	IMPORT_C void Sort(TKeyCmpText aTextComparisonType=ECmpFolded);
sl@0: 	IMPORT_C TInt Find(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
sl@0: 	IMPORT_C TInt FindIsq(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
sl@0: 	IMPORT_C void Delete(TInt aPos);
sl@0: 	IMPORT_C void Delete(TInt aIndex,TInt aCount);
sl@0: 	IMPORT_C void Reset();
sl@0: 	inline TPtrC8 operator[](TInt aIndex) const;
sl@0: // from MDesC8Array
sl@0:     IMPORT_C TInt MdcaCount() const;
sl@0: 	IMPORT_C TPtrC8 MdcaPoint(TInt aIndex) const;
sl@0: 	};
sl@0: 
sl@0: inline TPtrC8 CDesC8Array::operator[](TInt aIndex) const
sl@0: 	{ return(MdcaPoint(aIndex)); }
sl@0: 
sl@0: 
sl@0: class CDesC8ArrayFlat : public CDesC8Array
sl@0: /** An array of 8 bit descriptors implemented using a flat buffer.
sl@0: "bafl.lib" 
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C CDesC8ArrayFlat(TInt aGranularity);
sl@0:     IMPORT_C ~CDesC8ArrayFlat();
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class CDesC8ArraySeg : public CDesC8Array
sl@0: /** An array of 8 bit descriptors implemented using a segmented buffer. 
sl@0: "bafl.lib"
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C CDesC8ArraySeg(TInt aGranularity);
sl@0:     IMPORT_C ~CDesC8ArraySeg();
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class CDesC16Array : public CArrayFixBase, public MDesC16Array
sl@0: /** An implementation base class for 16 bit descriptor arrays. It provides some 
sl@0: of the behaviour for 16 bit descriptor arrays.
sl@0: 
sl@0: The class is abstract and cannot be instantiated. 
sl@0: " bafl.lib "
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: protected:
sl@0: 	IMPORT_C CDesC16Array(TBufRep aRep,TInt aGranularity);
sl@0: public:
sl@0:     IMPORT_C ~CDesC16Array();
sl@0: 	IMPORT_C void AppendL(const TDesC16& aPtr);
sl@0: 	IMPORT_C void InsertL(TInt aPos,const TDesC16& aPtr);
sl@0: 	IMPORT_C TInt InsertIsqL(const TDesC16& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
sl@0: 	IMPORT_C TInt InsertIsqAllowDuplicatesL(const TDesC16& aPtr,TKeyCmpText aTextComparisonType=ECmpFolded);
sl@0: 	IMPORT_C void Sort(TKeyCmpText aTextComparisonType=ECmpFolded);
sl@0: 	IMPORT_C TInt Find(const TDesC16& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
sl@0: 	IMPORT_C TInt FindIsq(const TDesC16& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType=ECmpFolded) const;
sl@0: 	IMPORT_C void Delete(TInt aPos);
sl@0: 	IMPORT_C void Delete(TInt aIndex,TInt aCount);
sl@0: 	IMPORT_C void Reset();
sl@0: 	inline TPtrC16 operator[](TInt aIndex) const;
sl@0: // from MDesC16Array
sl@0:     IMPORT_C TInt MdcaCount() const;
sl@0: 		IMPORT_C TPtrC16 MdcaPoint(TInt aIndex) const;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: inline TPtrC16 CDesC16Array::operator[](TInt aIndex) const
sl@0: /** Returns a non-modifiable descriptor to represent the descriptor
sl@0: element located at the specified index within the array.
sl@0: 
sl@0: @param aIndex The position of the descriptor element within the array. 
sl@0: The position is relative to zero; i.e. zero implies the first descriptor 
sl@0: element in the array. This value must be non-negative and less than the
sl@0: number of descriptors currently within the array otherwise the operator 
sl@0: panics with
sl@0: @code
sl@0: EArrayIndexOutOfRange
sl@0: @endcode
sl@0: @return A 16 bit non-modifiable pointer descriptor. */
sl@0:  { return(MdcaPoint(aIndex)); }
sl@0: 
sl@0: 
sl@0: class CDesC16ArrayFlat : public CDesC16Array
sl@0: /** Array of 16 bit descriptors implemented using a flat buffer. 
sl@0: "bafl.lib  
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C CDesC16ArrayFlat(TInt aGranularity);
sl@0:     IMPORT_C ~CDesC16ArrayFlat();
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class CDesC16ArraySeg : public CDesC16Array
sl@0: /** An array of 16 bit descriptors implemented using a segmented buffer. 
sl@0: "bafl.lib"
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C CDesC16ArraySeg(TInt aGranularity);
sl@0:     IMPORT_C ~CDesC16ArraySeg();
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class CPtrC8Array : public CArrayFixFlat<TPtrC8>, public MDesC8Array
sl@0: /** Array of 8 bit non-modifiable pointer descriptors, TPtrC8, implemented using 
sl@0: a flat buffer.
sl@0: "bafl.lib" 
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C CPtrC8Array(TInt aGranularity);
sl@0: 	IMPORT_C ~CPtrC8Array();
sl@0: //
sl@0: 	IMPORT_C void CopyL(const MDesC8Array& aArray);
sl@0:     inline void operator=(const MDesC8Array& aArray);
sl@0: // Mixin members
sl@0:     IMPORT_C TInt MdcaCount() const;
sl@0:     IMPORT_C TPtrC8 MdcaPoint(TInt aIndex) const;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class CPtrC16Array : public CArrayFixFlat<TPtrC16>, public MDesC16Array
sl@0: /** An array of 16 bit non-modifiable pointer descriptors, TPtrC16, implemented 
sl@0: using a flat buffer. 
sl@0: "bafl.lib"
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C CPtrC16Array(TInt aGranularity);
sl@0: 	IMPORT_C ~CPtrC16Array();
sl@0: //
sl@0: 	IMPORT_C void CopyL(const MDesC16Array& aArray);
sl@0:     inline void operator=(const MDesC16Array& aArray);
sl@0: // Mixin members
sl@0:     IMPORT_C TInt MdcaCount() const;
sl@0:     IMPORT_C TPtrC16 MdcaPoint(TInt aIndex) const;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: inline void CPtrC8Array::operator=(const MDesC8Array& aArray)
sl@0: /** Copies a descriptor array into this array, deleting any pre-existing
sl@0: elements.
sl@0: 
sl@0: The function constructs TPtrC8 elements for each descriptor element
sl@0: in the specified descriptor array. This operator behaves in the 
sl@0: same ways as CPtrC8Array::CopyL().
sl@0: 
sl@0: @param aArrayA reference to any descriptor array which satisfies
sl@0: the protocol defined by this mixin class. */
sl@0: 	{CopyL(aArray);}
sl@0: 
sl@0: 
sl@0: inline void CPtrC16Array::operator=(const MDesC16Array& aArray)
sl@0: /** Copies a descriptor array into this array, deleting any pre-existing
sl@0: elements.
sl@0: 
sl@0: The function constructs TPtrC16 elements for each descriptor element
sl@0: in the specified descriptor array.This operator behaves in the 
sl@0: same ways as CPtrC16Array::CopyL().
sl@0: 
sl@0: @param aArray A reference to any descriptor array which satisfies
sl@0: the protocol defined by this mixin class. */
sl@0: 	{CopyL(aArray);}
sl@0: 
sl@0: // generic text array definitions
sl@0: 
sl@0: #if defined (_UNICODE)
sl@0: /** Build independent implementation base class for descriptor arrays.
sl@0: 
sl@0: @see CDesC8Array
sl@0: @see CDesC16Array 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CDesC16Array     CDesCArray;
sl@0: 
sl@0: /** Build independent array of descriptors implemented using a flat buffer.
sl@0: 
sl@0: @see CDesC8ArrayFlat
sl@0: @see CDesC16ArrayFlat
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CDesC16ArrayFlat CDesCArrayFlat;
sl@0: 
sl@0: /** Build independent array of descriptors implemented using a segmented buffer.
sl@0: 
sl@0: @see CDesC16ArraySeg
sl@0: @see CDesC8ArraySeg 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CDesC16ArraySeg  CDesCArraySeg;
sl@0: 
sl@0: /** Build independent array of non-modifiable pointer descriptors.
sl@0: 
sl@0: A 16 bit build variant is generated for a Unicode build and an 8 bit build 
sl@0: variant generated for a non-Unicode build.
sl@0: 
sl@0: This build independent type should always be used unless an explicit 8 bit 
sl@0: or 16 bit build variant is required.
sl@0: 
sl@0: @see CPtrC16Array
sl@0: @see CPtrC8Array 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CPtrC16Array CPtrCArray;
sl@0: #else
sl@0: /** Build independent implementation base class for descriptor arrays.
sl@0: 
sl@0: @see CDesC8Array
sl@0: @see CDesC16Array 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CDesC8Array      CDesCArray;
sl@0: /** Build independent array of descriptors implemented using a flat buffer.
sl@0: 
sl@0: @see CDesC8ArrayFlat
sl@0: @see CDesC16ArrayFlat
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CDesC8ArrayFlat  CDesCArrayFlat;
sl@0: /** Build independent array of descriptors implemented using a segmented buffer.
sl@0: 
sl@0: @see CDesC16ArraySeg
sl@0: @see CDesC8ArraySeg 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CDesC8ArraySeg   CDesCArraySeg;
sl@0: /** Build independent array of non-modifiable pointer descriptors.
sl@0: 
sl@0: A 16 bit build variant is generated for a Unicode build and an 8 bit build 
sl@0: variant generated for a non-Unicode build.
sl@0: 
sl@0: This build independent type should always be used unless an explicit 8 bit 
sl@0: or 16 bit build variant is required.
sl@0: 
sl@0: @see CPtrC16Array
sl@0: @see CPtrC8Array 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CPtrC8Array CPtrCArray;
sl@0: #endif
sl@0: 
sl@0: 
sl@0: #endif // __BADESCA_H__
sl@0: 
sl@0: 
sl@0: 
sl@0: