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: #include <badesca.h>
sl@0: 
sl@0: 
sl@0: // Class to provide an interface for Sort function - two variants
sl@0: // for 8 and 16-bit descriptors.  (should this be templated? -PNJ)
sl@0: 
sl@0: 
sl@0: NONSHARABLE_CLASS(TKeyDesC8Array) : public TKeyArrayFix
sl@0: 	{
sl@0: public:
sl@0: 	TKeyDesC8Array(TKeyCmpText aType);
sl@0: private: // from TKey
sl@0: 	TInt Compare(TInt aLeft,TInt aRight) const;
sl@0: 	};
sl@0: 
sl@0: TKeyDesC8Array::TKeyDesC8Array(TKeyCmpText aType)
sl@0: 	: TKeyArrayFix(0,aType,0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: TInt TKeyDesC8Array::Compare(TInt aLeft,TInt aRight) const
sl@0: 	{
sl@0: 	TDesC8* left=(*(TDesC8**)At(aLeft));
sl@0: 	TDesC8* right=(*(TDesC8**)At(aRight));
sl@0: 	switch (iCmpType)
sl@0: 		{
sl@0: 	case ECmpFolded:
sl@0: 		return(left->CompareF(*right));
sl@0: 	case ECmpCollated:
sl@0: 		return(left->CompareC(*right));
sl@0: 	default:
sl@0: 		break;
sl@0: 		}
sl@0: 	return(left->Compare(*right));
sl@0: 	}
sl@0: 
sl@0: 
sl@0: NONSHARABLE_CLASS(TKeyDesC16Array) : public TKeyArrayFix
sl@0: 	{
sl@0: public:
sl@0: 	TKeyDesC16Array(TKeyCmpText aType);
sl@0: private: // from TKey
sl@0: 	TInt Compare(TInt aLeft,TInt aRight) const;
sl@0: 	};
sl@0: 
sl@0: TKeyDesC16Array::TKeyDesC16Array(TKeyCmpText aType)
sl@0: 	: TKeyArrayFix(0,aType,0)
sl@0: 	{
sl@0: 	}
sl@0: 
sl@0: TInt TKeyDesC16Array::Compare(TInt aLeft,TInt aRight) const
sl@0: 	{
sl@0: 	TDesC16* left=(*(TDesC16**)At(aLeft));
sl@0: 	TDesC16* right=(*(TDesC16**)At(aRight));
sl@0: 	switch (iCmpType)
sl@0: 		{
sl@0: 	case ECmpFolded:
sl@0: 		return(left->CompareF(*right));
sl@0: 	case ECmpCollated:
sl@0: 		return(left->CompareC(*right));
sl@0: 	default:
sl@0: 		break;
sl@0: 		}
sl@0: 	return(left->Compare(*right));
sl@0: 	}
sl@0: 
sl@0: 
sl@0: 
sl@0: // CDesCxArray implementation...
sl@0: 
sl@0: 
sl@0: EXPORT_C CDesC8Array::CDesC8Array(TBufRep aRep,TInt aGranularity)
sl@0:     : CArrayFixBase(aRep,sizeof(HBufC8*),aGranularity)
sl@0:     {
sl@0:     }
sl@0: 
sl@0: EXPORT_C CDesC8Array::~CDesC8Array()
sl@0: /** Frees all resources owned by the object, prior to its destruction. In particular, 
sl@0: it deletes all descriptors from the array and frees the memory allocated to 
sl@0: the array buffer. */
sl@0:     {
sl@0: 	Reset();
sl@0:     }
sl@0: 
sl@0: EXPORT_C void CDesC8Array::Reset()
sl@0: /** Deletes all descriptors from the array and frees the memory allocated to the 
sl@0: array buffer.
sl@0: 
sl@0: @see CDesC8Array::Delete() */
sl@0: 	{
sl@0: 	Delete(0,Count());
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC8Array::Delete(TInt aIndex)
sl@0: 	{
sl@0: 	Delete(aIndex,1);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Deletes one or more logically contiguous descriptor elements from the
sl@0:  * array.
sl@0:  *
sl@0:  * The deletion starts at the specified position.Deleting descriptor
sl@0:  * elements from the array frees the memory occupied by the associated
sl@0:  * heap descriptors and removes their pointers from the array buffer but
sl@0:  * does not cause the array buffer to be automatically compressed. Call
sl@0:  * the Compress() function to return excess space in the array buffer to
sl@0:  * the heap.
sl@0:  *
sl@0:  * @param     " TInt aPos "
sl@0:  *            The starting position in the array from which
sl@0:  *            descriptor elements are to be deleted. The position is
sl@0:  *            relative to zero, i.e. zero implies the first
sl@0:  *            descriptor element. This value must not be negative
sl@0:  *            and must not be greater than the number of descriptor
sl@0:  *            elements currently in the array, otherwise the
sl@0:  *            functions raise an E32USER-CBase 21 panic.
sl@0:  * @param     " TInt aCount "
sl@0:  *            If specified, the number of contiguous descriptor
sl@0:  *            elements to be deleted from the array. This value must
sl@0:  *            not be negative otherwise the function raises an
sl@0:  *            E32USER-CBase 22 panic. This value plus the value of
sl@0:  *            the starting position must not be greater than the
sl@0:  *            number of descriptor elements in the array, otherwise
sl@0:  *            the function raises an E32USER-CBase 29 panic. This
sl@0:  *            value must not be negative otherwise the function
sl@0:  *            raises an E32USER-CBase 22 panic. This value plus the
sl@0:  *            value of the starting position must not be greater
sl@0:  *            than the number of descriptor elements in the array,
sl@0:  *            otherwise the function raises an E32USER-CBase 29
sl@0:  *            panic. If not specified, one element is assumed.
sl@0:  */
sl@0: EXPORT_C void CDesC8Array::Delete(TInt aIndex,TInt aCount)
sl@0: 	{
sl@0: 	TInt count=aCount;
sl@0: 	for (TInt ii=aIndex; count--; ii++)
sl@0: 		User::Free(*(HBufC8**)At(ii));
sl@0: 	CArrayFixBase::Delete(aIndex,aCount);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC8Array::MdcaCount() const
sl@0: /** Returns the number of descriptor elements in the array. The function implements 
sl@0: the interface MDesC8Array::MdcaCount().
sl@0: 
sl@0: @return The number of descriptor elements. */
sl@0:     {
sl@0:     return Count();
sl@0:     }
sl@0: 
sl@0: EXPORT_C TPtrC8 CDesC8Array::MdcaPoint(TInt anIndex) const
sl@0: /** Indexes into a descriptor array. The function implements the interface 
sl@0: MDesC8Array::MdcaPoint().
sl@0: 	
sl@0: @param aIndex The position of the descriptor element within the array. The 
sl@0: position is relative to zero; i.e. zero implies the first descriptor element 
sl@0: in the array. This value must be non-negative and less than the number of 
sl@0: descriptors currently within the array otherwise the operator panics with 
sl@0: EArrayIndexOutOfRange. 
sl@0: @return A non-modifiable pointer descriptor representing the descriptor element 
sl@0: located at position aIndex within the array. */
sl@0: 	{
sl@0: 	HBufC8* temp=(*(HBufC8**)At(anIndex));
sl@0: 	return (TPtrC8)(*temp);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC8Array::AppendL(const TDesC8& aPtr)
sl@0: /** Appends a descriptor onto the end of any existing descriptor elements in the 
sl@0: array.
sl@0: 
sl@0: @param aPtr A reference to the descriptor to be appended to the array. 
sl@0: @leave KErrNoMemory There is insufficient memory available. If the function 
sl@0: leaves, the array is left in the state it was in before the call. */
sl@0: 	{
sl@0: 	InsertL(Count(),aPtr);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC8Array::InsertL(TInt aPos,const TDesC8& aPtr)
sl@0: /** Inserts a descriptor into the array at the specified position. 
sl@0: 
sl@0: If the specified position is the same as the current number of descriptor 
sl@0: elements in the array, this has the effect of appending the element.
sl@0: 
sl@0: @param aPos The position within the array where the descriptor element is 
sl@0: to be inserted. The position is relative to zero, i.e. zero implies the first 
sl@0: descriptor element. This value must not be negative and must not be greater 
sl@0: than the number of descriptor elements currently in the array, otherwise the 
sl@0: function rasises an E32USER-CBase 21 panic. 
sl@0: @param aPtr The descriptor to be inserted into the array. 
sl@0: @leave KErrNoMemory There is insufficient memory available. If the function 
sl@0: leaves, the array is left in the state it was in before the call. */
sl@0: 	{
sl@0: 	HBufC8* bufPtr=aPtr.AllocLC();
sl@0:    	CArrayFixBase::InsertL(aPos,&bufPtr);
sl@0: 	CleanupStack::Pop();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC8Array::InsertIsqL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType)
sl@0: /** Inserts a descriptor into the array at a position which maintains the 
sl@0: sequence of the descriptors.
sl@0: 
sl@0: The sequence is determined by comparing descriptors using one of the TDesC 
sl@0: comparison functions. The enumeration aTextComparisonType governs how the 
sl@0: descriptors are to be compared.
sl@0: 
sl@0: The array should already be in sequence, otherwise the position of the new 
sl@0: descriptor element is unpredictable. Descriptor elements which are the same 
sl@0: are not permitted.
sl@0: 
sl@0: @param aPtr A reference to the descriptor to be inserted into the array. 
sl@0: @param aTextComparisonType An enumeration which determines the type of 
sl@0: comparison to be made between descriptors for the purpose of choosing the 
sl@0: insertion position.  If no parameter is explicitly passed, ECmpFolded is used 
sl@0: by default.
sl@0: @leave KErrAlreadyExists A descriptor with the same data (i.e. the same length 
sl@0: and the same content) already exists within the array.
sl@0: @leave KErrNoMemory There is insufficient memory available. If the function 
sl@0: leaves, the array is left in the state it was in before the call.
sl@0: @return The position within the array of the inserted descriptor. */
sl@0: 	{
sl@0: 	HBufC8* bufPtr=aPtr.AllocLC();
sl@0: 	TKeyDesC8Array key(aTextComparisonType);
sl@0:    	TInt found=CArrayFixBase::InsertIsqL(&bufPtr,key);
sl@0: 	CleanupStack::Pop();
sl@0: 	return(found);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC8Array::InsertIsqAllowDuplicatesL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType)
sl@0: /** Inserts a descriptor into the array at a position which maintains the 
sl@0: sequence of the descriptors - allows duplicates.
sl@0: 
sl@0: The sequence is determined by comparing descriptors using one of the TDesC 
sl@0: comparison functions. The enumeration aTextComparisonType governs how the 
sl@0: descriptors are to be compared.
sl@0: 
sl@0: The array should already be in sequence, otherwise the position of the new 
sl@0: descriptor element is unpredictable. Descriptor elements which are the same 
sl@0: are permitted; if the descriptor aPtr is a duplicate of an existing descriptor 
sl@0: within the array, then the new descriptor element is positioned after the 
sl@0: existing descriptor element.
sl@0: 
sl@0: @param aPtr A reference to the descriptor to be inserted into the array. 
sl@0: @param aTextComparisonType An enumeration which determines the type of comparison 
sl@0: to be made between descriptors for the purpose of choosing the insertion position. 
sl@0: If no parameter is explicitly passed, ECmpFolded is used by default.
sl@0: @leave KErrNoMemory There is insufficient memory available. If the function 
sl@0: leaves, the array is left in the state it was in before the call. 
sl@0: @return The position within the array of the inserted descriptor. */
sl@0: 	{
sl@0: 	HBufC8* bufPtr=aPtr.AllocLC();
sl@0: 	TKeyDesC8Array key(aTextComparisonType);
sl@0:    	TInt found=CArrayFixBase::InsertIsqAllowDuplicatesL(&bufPtr,key);
sl@0: 	CleanupStack::Pop();
sl@0: 	return(found);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC8Array::Sort(TKeyCmpText aTextComparisonType)
sl@0: /** Sorts the descriptor elements into sequence.
sl@0: 
sl@0: The sequence is determined by comparing descriptors using one of the member 
sl@0: functions of the descriptor base class TDesC.
sl@0: 
sl@0: @param aTextComparisonType An enumeration which defines the type of comparison 
sl@0: to be made between descriptors. By default the comparison type is ECmpFolded. */
sl@0: 	{
sl@0: 	TKeyDesC8Array key(aTextComparisonType);
sl@0: 	CArrayFixBase::Sort(key);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC8Array::Find(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType) const
sl@0: /** Finds the position of a descriptor element within the array which matches the 
sl@0: specified descriptor using a sequential search.
sl@0: 
sl@0: The array is searched sequentially for a matching descriptor element, starting 
sl@0: with the first descriptor element in the array. Descriptors are compared using 
sl@0: one of the TDesC comparison functions. The enumeration aTextComparisonType 
sl@0: governs how the descriptors are to be compared.
sl@0: 
sl@0: Where an array has duplicate descriptor elements, the function only supplies 
sl@0: the position of the first descriptor element.
sl@0: 
sl@0: @param aPtr A reference to a descriptor to be used for comparison. 
sl@0: @param aPos If the descriptor element is found, this reference is set to the 
sl@0: position of that descriptor element within the array. The position is relative 
sl@0: to zero, (i.e. the first descriptor element in the array is at position 0). 
sl@0: If the descriptor element is not found and the array is not empty, then the 
sl@0: value of the reference is set to the number of descriptor elements in the 
sl@0: array. If the descriptor element is not found and the array is empty, then 
sl@0: the reference is set to zero. 
sl@0: @param aTextComparisonType An enumeration which determines the type of comparison 
sl@0: to be made between descriptors. If no parameter is explicitly passed, ECmpFolded 
sl@0: is used by default. 
sl@0: @return Zero, if a matching descriptor element is found. Non-zero, if no matching 
sl@0: descriptor element can be found. */
sl@0: 	{
sl@0: 	TKeyDesC8Array key(aTextComparisonType);
sl@0: 	const TDesC8* tmp=(&aPtr);
sl@0: 	return(CArrayFixBase::Find(&tmp,key,aPos));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC8Array::FindIsq(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType) const
sl@0: /** Finds the position of a descriptor element within the array which matches 
sl@0: the specified descriptor using a binary search technique. The array must 
sl@0: be in sequence, otherwise the outcome is unpredictable.
sl@0: 
sl@0: Descriptors are compared using one of the TDesC comparison functions. The 
sl@0: enumeration aTextComparisonType governs how the descriptors are to be compared.
sl@0: 
sl@0: Where an array has duplicate descriptor elements, the function cannot guarantee 
sl@0: which matching descriptor element it will return; except that it will find 
sl@0: one of them.
sl@0: 
sl@0: @param aPtr A reference to a descriptor to be used for comparison. 
sl@0: @param aPos If the descriptor element is found, the reference is set to the 
sl@0: position of that descriptor element within the array. The position is relative 
sl@0: to zero, (i.e. the first descriptor element in the array is at position 0). 
sl@0: If the descriptor element is not found and the array is not empty, then the 
sl@0: reference is set to the position of the first descriptor element in the array 
sl@0: whose content is greater than the content of aPtr. If the descriptor element 
sl@0: is not found and the array is empty, then the reference is set to zero.
sl@0: @param aTextComparisonType An enumeration which determines the type of comparison 
sl@0: to be made between descriptors. If no parameter is explicitly passed, ECmpFolded 
sl@0: is used by default. 
sl@0: @return Zero, if a matching descriptor element is found. Non-zero, if no matching 
sl@0: descriptor element can be found. */
sl@0: 	{
sl@0: 	TKeyDesC8Array key(aTextComparisonType);
sl@0: 	const TDesC8* tmp=(&aPtr);
sl@0: 	return(CArrayFixBase::FindIsq(&tmp,key,aPos));
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Constructs a flat descriptor array with the specified granularity.
sl@0:  *
sl@0:  * No memory is allocated to the array buffer by this constructor.
sl@0:  *
sl@0:  * @param     "TInt aGranularity"
sl@0:  *            The granularity of the array. This value must be
sl@0:  *            positive otherwise the constructor raises an
sl@0:  *            E32USER-CBase 18 panic.
sl@0:  */
sl@0: EXPORT_C CDesC8ArrayFlat::CDesC8ArrayFlat(TInt aGranularity)
sl@0:     : CDesC8Array((TBufRep)CBufFlat::NewL,aGranularity)
sl@0:     {
sl@0: 	__DECLARE_NAME(_S("CDesC8ArrayFlat"));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CDesC8ArrayFlat::~CDesC8ArrayFlat()
sl@0: /** Frees all resources owned by the object, prior to its destruction. */
sl@0:     {}
sl@0: 
sl@0: EXPORT_C CDesC8ArraySeg::CDesC8ArraySeg(TInt aGranularity)
sl@0:     : CDesC8Array((TBufRep)CBufSeg::NewL,aGranularity)
sl@0: /** Constructs a segmented descriptor array with the specified granularity.
sl@0: 
sl@0: No memory is allocated to the array buffer by this constructor.
sl@0: 
sl@0: @param aGranularity The granularity of the array. This value must be positive 
sl@0: otherwise the constructor raises an E32USER-CBase 18 panic. */
sl@0:     {
sl@0: 	__DECLARE_NAME(_S("CDesC8ArraySeg"));
sl@0:     }
sl@0: 
sl@0: EXPORT_C CDesC8ArraySeg::~CDesC8ArraySeg()
sl@0: /** Frees all resources owned by the object, prior to its destruction. */
sl@0:     {}
sl@0: 
sl@0: 
sl@0: // 16-bit equivalents to the above.
sl@0: 
sl@0: 
sl@0: EXPORT_C CDesC16Array::CDesC16Array(TBufRep aRep,TInt aGranularity)
sl@0:     : CArrayFixBase(aRep,sizeof(HBufC16*),aGranularity)
sl@0:     {
sl@0:     }
sl@0: 
sl@0: EXPORT_C CDesC16Array::~CDesC16Array()
sl@0: /** Frees all resources owned by the object, prior to its destruction. In particular, 
sl@0: it deletes all descriptors from the array and frees the memory allocated to 
sl@0: the array buffer. */
sl@0:     {
sl@0: 	Reset();
sl@0:     }
sl@0: 
sl@0: EXPORT_C void CDesC16Array::Reset()
sl@0: /** Deletes all descriptors from the array and frees the memory allocated to the 
sl@0: array buffer.
sl@0: 
sl@0: @see CDesC16Array::Delete() */
sl@0: 	{
sl@0: 	Delete(0,Count());
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC16Array::Delete(TInt aIndex)
sl@0: 	{
sl@0: 	Delete(aIndex,1);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Deletes one or more logically contiguous descriptor elements from the
sl@0:  * array.
sl@0:  *
sl@0:  * The deletion starts at the specified position.Deleting descriptor
sl@0:  * elements from the array frees the memory occupied by the associated
sl@0:  * heap descriptors and removes their pointers from the array buffer but
sl@0:  * does not cause the array buffer to be automatically compressed. Call
sl@0:  * the Compress() function to return excess space in the array buffer to
sl@0:  * the heap.
sl@0:  *
sl@0:  * @param     " TInt aPos "
sl@0:  *            The starting position in the array from which
sl@0:  *            descriptor elements are to be deleted. The position is
sl@0:  *            relative to zero, i.e. zero implies the first
sl@0:  *            descriptor element. This value must not be negative
sl@0:  *            and must not be greater than the number of descriptor
sl@0:  *            elements currently in the array, otherwise the
sl@0:  *            functions raise an E32USER-CBase 21 panic.
sl@0:  * @param     " TInt aCount "
sl@0:  *            If specified, the number of contiguous descriptor
sl@0:  *            elements to be deleted from the array. This value must
sl@0:  *            not be negative otherwise the function raises an
sl@0:  *            E32USER-CBase 22 panic. This value must not be
sl@0:  *            negative otherwise the function raises an
sl@0:  *            E32USER-CBase 22 panic. This value must not be
sl@0:  *            negative otherwise the function raises an
sl@0:  *            E32USER-CBase 22 panic. This value plus the value of
sl@0:  *            the starting position must not be greater than the
sl@0:  *            number of descriptor elements in the array, otherwise
sl@0:  *            the function raises an E32USER-CBase 29 panic. If not
sl@0:  *            specified, one element is assumed.
sl@0:  */
sl@0: EXPORT_C void CDesC16Array::Delete(TInt aIndex,TInt aCount)
sl@0: 	{
sl@0: 	TInt count=aCount;
sl@0: 	for (TInt ii=aIndex; count--; ii++)
sl@0: 		User::Free(*(HBufC16**)At(ii));
sl@0: 	CArrayFixBase::Delete(aIndex,aCount);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC16Array::MdcaCount() const
sl@0: /** Returns the number of descriptor elements in the array. The function implements 
sl@0: the function interface MDesC16Array::MdcaCount().
sl@0: 
sl@0: @return The number of descriptor elements. */
sl@0:     {
sl@0:     return Count();
sl@0:     }
sl@0: 
sl@0: EXPORT_C TPtrC16 CDesC16Array::MdcaPoint(TInt anIndex) const
sl@0: /** Indexes into a descriptor array. The function implements the interface MDesC16Array::MdcaPoint().
sl@0: 	
sl@0: 	@param aIndex The position of the descriptor element within the array. The 
sl@0: 	position is relative to zero; i.e. zero implies the first descriptor element 
sl@0: 	in the array. This value must be non-negative and less than the number of 
sl@0: 	descriptors currently within the array otherwise the operator panics with 
sl@0: 	EArrayIndexOutOfRange. 
sl@0: 	@return A non-modifiable pointer descriptor representing the descriptor element 
sl@0: 	located at position aIndex within the array. */	
sl@0: 	{
sl@0: 	HBufC16* temp=(*(HBufC16**)At(anIndex));
sl@0: 	return (TPtrC16)(*temp);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC16Array::AppendL(const TDesC16& aPtr)
sl@0: /** Appends a descriptor onto the end of any existing descriptor elements in the 
sl@0: array.
sl@0: 
sl@0: @param aPtr A reference to the descriptor to be appended to the array. */
sl@0: 	{
sl@0: 	InsertL(Count(),aPtr);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC16Array::InsertL(TInt aPos,const TDesC16& aPtr)
sl@0: /** Inserts a descriptor into the array at the specified position. 
sl@0: 
sl@0: If the specified position is the same as the current number of descriptor 
sl@0: elements in the array, this has the effect of appending the element.
sl@0: 
sl@0: @param aPos The position within the array where the descriptor element is 
sl@0: to be inserted. The position is relative to zero, i.e. zero implies the first 
sl@0: descriptor element. This value must not be negative and must not be greater 
sl@0: than the number of descriptor elements currently in the array, otherwise the 
sl@0: function raises an E32USER-CBase 21 panic. 
sl@0: @param aPtr The descriptor to be inserted into the array. */
sl@0: 	{
sl@0: 	HBufC16* bufPtr=aPtr.AllocLC();
sl@0:    	CArrayFixBase::InsertL(aPos,&bufPtr);
sl@0: 	CleanupStack::Pop();
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC16Array::InsertIsqL(const TDesC16& aPtr,TKeyCmpText aTextComparisonType)
sl@0: /** Inserts a descriptor into the array at a position which maintains the sequence 
sl@0: of the descriptors.
sl@0: 
sl@0: The sequence is determined by comparing descriptors using one of the TDesC 
sl@0: comparison functions. The enumeration aTextComparisonType governs how the 
sl@0: descriptors are to be compared.
sl@0: 
sl@0: The array should already be in sequence, otherwise the position of the new 
sl@0: descriptor element is unpredictable. Descriptor elements which are the same 
sl@0: are not permitted.
sl@0: 
sl@0: @param aPtr A reference to the descriptor to be inserted into the array. 
sl@0: @param aTextComparisonType An enumeration which determines the type of comparison 
sl@0: to be made between descriptors for the purpose of choosing the insertion position. 
sl@0: If no parameter is explicitly passed, ECmpFolded is used by default.
sl@0: @return The position within the array of the inserted descriptor. */
sl@0: 	{
sl@0: 	HBufC16* bufPtr=aPtr.AllocLC();
sl@0: 	TKeyDesC16Array key(aTextComparisonType);
sl@0:    	TInt found=CArrayFixBase::InsertIsqL(&bufPtr,key);
sl@0: 	CleanupStack::Pop();
sl@0: 	return(found);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC16Array::InsertIsqAllowDuplicatesL(const TDesC16& aPtr,TKeyCmpText aTextComparisonType)
sl@0: /** Inserts a descriptor into the array at a position which maintains the sequence 
sl@0: of the descriptors; allows duplicates.
sl@0: 
sl@0: The sequence is determined by comparing descriptors using one of the TDesC 
sl@0: comparison functions. The enumeration aTextComparisonType governs how the 
sl@0: descriptors are to be compared.
sl@0: 
sl@0: The array should already be in sequence, otherwise the position of the new 
sl@0: descriptor element is unpredictable. Descriptor elements which are the same 
sl@0: are permitted; if the descriptor aPtr is a duplicate of an existing descriptor 
sl@0: within the array, then the new descriptor element is positioned after the 
sl@0: existing descriptor element.
sl@0: 
sl@0: @param aPtr A reference to the descriptor to be inserted into the array. 
sl@0: @param aTextComparisonType An enumeration which determines the type of comparison 
sl@0: to be made between descriptors for the purpose of choosing the insertion position. 
sl@0: If no parameter is explicitly passed, ECmpFolded is used by default.
sl@0: @return The position within the array of the inserted descriptor. */
sl@0: 	{
sl@0: 	HBufC16* bufPtr=aPtr.AllocLC();
sl@0: 	TKeyDesC16Array key(aTextComparisonType);
sl@0:    	TInt found=CArrayFixBase::InsertIsqAllowDuplicatesL(&bufPtr,key);
sl@0: 	CleanupStack::Pop();
sl@0: 	return(found);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CDesC16Array::Sort(TKeyCmpText aTextComparisonType)
sl@0: /** Sorts the descriptor elements into sequence.
sl@0: 
sl@0: The sequence is determined by comparing descriptors using one of the member 
sl@0: functions of the descriptor base class TDesC.
sl@0: 
sl@0: @param aTextComparisonType An enumeration which defines the type of comparison 
sl@0: to be made between descriptors. By default the comparison type is ECmpFolded. */
sl@0: 	{
sl@0: 	TKeyDesC16Array key(aTextComparisonType);
sl@0: 	CArrayFixBase::Sort(key);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC16Array::Find(const TDesC16& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType) const
sl@0: /** Finds the position of a descriptor element within the array which matches the 
sl@0: specified descriptor, using a sequential search.
sl@0: 
sl@0: The array is searched sequentially for a matching descriptor element, starting 
sl@0: with the first descriptor element in the array. Descriptors are compared using 
sl@0: one of the TDesC comparison functions. The enumeration aTextComparisonType 
sl@0: governs how the descriptors are to be compared.
sl@0: 
sl@0: Where an array has duplicate descriptor elements, the function only supplies 
sl@0: the position of the first descriptor element.
sl@0: 
sl@0: @param aPtr A reference to a descriptor to be used for comparison. 
sl@0: @param aPos If the descriptor element is found, this reference is set to the 
sl@0: position of that descriptor element within the array. The position is relative 
sl@0: to zero, (i.e. the first descriptor element in the array is at position 0). 
sl@0: If the descriptor element is not found and the array is not empty, then the 
sl@0: value of the reference is set to the number of descriptor elements in the 
sl@0: array. If the descriptor element is not found and the array is empty, then 
sl@0: the reference is set to zero. 
sl@0: @param aTextComparisonType An enumeration which determines the type of comparison 
sl@0: to be made between descriptors. If no parameter is explicitly passed,ECmpFolded 
sl@0: is used by default. 
sl@0: @return Zero, if a matching descriptor element is found. Non-zero, if no matching 
sl@0: descriptor element can be found. */
sl@0: 	{
sl@0: 	TKeyDesC16Array key(aTextComparisonType);
sl@0: 	const TDesC16* tmp=(&aPtr);
sl@0: 	return(CArrayFixBase::Find(&tmp,key,aPos));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt CDesC16Array::FindIsq(const TDesC16& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType) const
sl@0: /** Finds the position of a descriptor element within the array which matches the 
sl@0: specified descriptor, using a binary search technique. The array must 
sl@0: be in sequence, otherwise the outcome is unpredictable.
sl@0: 
sl@0: Descriptors are compared using one of the TDesC comparison functions. The 
sl@0: enumeration aTextComparisonType governs how the descriptors are to be compared.
sl@0: 
sl@0: Where an array has duplicate descriptor elements, the function cannot guarantee 
sl@0: which matching descriptor element it will return; except that it will find 
sl@0: one of them.
sl@0: 
sl@0: @param aPtr A reference to a descriptor to be used for comparison. 
sl@0: @param aPos If the descriptor element is found, the reference is set to the 
sl@0: position of that descriptor element within the array. The position is relative 
sl@0: to zero, (i.e. the first descriptor element in the array is at position 0). 
sl@0: If the descriptor element is not found and the array is not empty, then the 
sl@0: reference is set to the position of the first descriptor element in the array 
sl@0: whose content is greater than the content of aPtr. If the descriptor element 
sl@0: is not found and the array is empty, then the reference is set to zero.
sl@0: @param aTextComparisonType An enumeration which determines the type of comparison 
sl@0: to be made between descriptors. If no parameter is explicitly passed, ECmpFolded 
sl@0: is used by default. 
sl@0: @return Zero, if a matching descriptor element is found. Non-zero, if no matching 
sl@0: descriptor element can be found. */
sl@0: 	{
sl@0: 	TKeyDesC16Array key(aTextComparisonType);
sl@0: 	const TDesC16* tmp=(&aPtr);
sl@0: 	return(CArrayFixBase::FindIsq(&tmp,key,aPos));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:  *
sl@0:  * Constructs a flat descriptor array with the specified granularity.
sl@0:  *
sl@0:  * No memory is allocated to the array buffer by this constructor.
sl@0:  *
sl@0:  * @param     "TInt aGranularity"
sl@0:  *            The granularity of the array. This value must be
sl@0:  *            positive otherwise the constructor raises an
sl@0:  *            E32USER-CBase 18 panic.
sl@0:  */
sl@0: EXPORT_C CDesC16ArrayFlat::CDesC16ArrayFlat(TInt aGranularity)
sl@0:     : CDesC16Array((TBufRep)CBufFlat::NewL,aGranularity)
sl@0:     {
sl@0: 	__DECLARE_NAME(_S("CDesC16ArrayFlat"));
sl@0:     }
sl@0: 
sl@0: EXPORT_C CDesC16ArrayFlat::~CDesC16ArrayFlat()
sl@0: /** Frees all resources owned by the object, prior to its destruction. */
sl@0:     {}
sl@0: 
sl@0: EXPORT_C CDesC16ArraySeg::CDesC16ArraySeg(TInt aGranularity)
sl@0:     : CDesC16Array((TBufRep)CBufSeg::NewL,aGranularity)
sl@0: /** Construct a segmented descriptor array with the specified granularity.
sl@0: 
sl@0: No memory is allocated to the array buffer by this C++ constructor.
sl@0: 
sl@0: @param aGranularity The granularity of the array. This value must be positive 
sl@0: otherwise the constructor raises an E32USER-CBase 18 panic. */
sl@0:     {
sl@0: 	__DECLARE_NAME(_S("CDesC16ArraySeg"));
sl@0:     }
sl@0: 
sl@0: EXPORT_C CDesC16ArraySeg::~CDesC16ArraySeg()
sl@0: /** Frees all resources owned by the object, prior to its destruction. */
sl@0:     {}
sl@0: 
sl@0: //
sl@0: //	class CPtrC8Array
sl@0: //
sl@0: 
sl@0: EXPORT_C CPtrC8Array::CPtrC8Array(TInt aGranularity)
sl@0: 	: CArrayFixFlat<TPtrC8>(aGranularity)
sl@0: /** Constructs an array of 8 bit non-modifiable descriptors with the specified 
sl@0: granularity. The length of all elements in the array buffer is the length 
sl@0: of a TPtrC8 object.
sl@0: 
sl@0: No memory is allocated to the array buffer by this constructor.
sl@0: 
sl@0: @param aGranularity The granularity of the array. This value must be positive 
sl@0: otherwise the constructor raises an E32USER-CBase 18 panic. */
sl@0: 	{
sl@0: 	__DECLARE_NAME(_S("CPtrC8Array"));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CPtrC8Array::~CPtrC8Array()
sl@0: /** Frees all resources owned by the object, prior to its destruction. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TInt CPtrC8Array::MdcaCount() const
sl@0: /** Returns the number of elements in the array. The function implements the pure 
sl@0: virtual function MDesC8Array::MdcaCount().
sl@0: 
sl@0: @return The number of elements. */
sl@0: 	{
sl@0: 	return(Count());
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TPtrC8 CPtrC8Array::MdcaPoint(TInt aIndex) const
sl@0: /** Indexes into the descriptor array. The function implements the pure virtual 
sl@0: function MDesC8Array::MdcaPoint().
sl@0: 
sl@0: @param aIndex The position of the descriptor element within the array. The 
sl@0: position is relative to zero; i.e. zero implies the first descriptor element 
sl@0: in the array. This value must be non-negative and must be less than the number 
sl@0: of elements currently in the array otherwise the operator raises a E32USER-CBase 
sl@0: 21 panic.
sl@0: @return A non-modifiable pointer descriptor for the data represented by the 
sl@0: element at position aIndex within the array. */
sl@0: 	{
sl@0: 	return(At(aIndex));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPtrC8Array::CopyL(const MDesC8Array& aArray)
sl@0: /** Copies a descriptor array into this array, deleting any pre-existing elements.
sl@0: 
sl@0: The function constructs TPtrC8 elements for each descriptor element in the 
sl@0: specified descriptor array.
sl@0: 
sl@0: @param aArray A reference to any descriptor array which satisfies the protocol 
sl@0: defined by this mixin class. */
sl@0: 	{
sl@0: 	Reset();
sl@0: 	TInt count=aArray.MdcaCount();
sl@0: 	for (TInt i=0;i<count;++i)
sl@0: 		AppendL(aArray.MdcaPoint(i));
sl@0: 	}
sl@0: 
sl@0: //
sl@0: //	class CPtrC16Array
sl@0: //
sl@0: 
sl@0: EXPORT_C CPtrC16Array::CPtrC16Array(TInt aGranularity)
sl@0: 	: CArrayFixFlat<TPtrC16>(aGranularity)
sl@0: /** Constructs an array of 16 bit non-modifiable descriptors with the specified 
sl@0: granularity. The length of all elements in the array buffer is the length 
sl@0: of a TPtrC16 object.
sl@0: 
sl@0: No memory is allocated to the array buffer by constructor.
sl@0: 
sl@0: @param aGranularity The granularity of the array. This value must be positive 
sl@0: otherwise the constructor raises an E32USER-CBase 18 panic. */
sl@0: 	{
sl@0: 	__DECLARE_NAME(_S("CPtrC16Array"));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C CPtrC16Array::~CPtrC16Array()
sl@0: /** Frees all resources owned by the object, prior to its destruction. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TInt CPtrC16Array::MdcaCount() const
sl@0: /** Returns the number of elements in the array. The function implements the pure 
sl@0: virtual function MDesC16Array::MdcaCount().
sl@0: 
sl@0: @return The number of elements. */
sl@0: 	{
sl@0: 	return(Count());
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TPtrC16 CPtrC16Array::MdcaPoint(TInt aIndex) const
sl@0: /** Indexes into the descriptor array. The function implements the pure virtual 
sl@0: function MDesC16Array::MdcaPoint().
sl@0: 
sl@0: @param aIndex The position of the descriptor element within the array. The 
sl@0: position is relative to zero; i.e. zero implies the first descriptor element 
sl@0: in the array. This value must be non-negative and must be less than the number 
sl@0: of elements currently in the array otherwise the operator raises a E32USER-CBase 
sl@0: 21 panic.
sl@0: @return A non-modifiable pointer descriptor for the data represented by the 
sl@0: element at position aIndex within the array. */
sl@0: 	{
sl@0: 	return(At(aIndex));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void CPtrC16Array::CopyL(const MDesC16Array& aArray)
sl@0: /** Copies a descriptor array into this array, deleting any pre-existing elements.
sl@0: 
sl@0: The function constructs TPtrC16 elements for each descriptor element in the 
sl@0: specified descriptor array.
sl@0: 
sl@0: @param aArray A reference to any descriptor array which satisfies the protocol 
sl@0: defined by this mixin class. */
sl@0: 	{
sl@0: 	Reset();
sl@0: 	TInt count=aArray.MdcaCount();
sl@0: 	for (TInt i=0;i<count;++i)
sl@0: 		AppendL(aArray.MdcaPoint(i));
sl@0: 	}