// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// Written by DavidW, October 1996

// Descriptor arrays

// 

//

#include <badesca.h>

// Class to provide an interface for Sort function - two variants

// for 8 and 16-bit descriptors.  (should this be templated? -PNJ)

NONSHARABLE_CLASS(TKeyDesC8Array) : public TKeyArrayFix

	{

public:

	TKeyDesC8Array(TKeyCmpText aType);

private: // from TKey

	TInt Compare(TInt aLeft,TInt aRight) const;

	};

TKeyDesC8Array::TKeyDesC8Array(TKeyCmpText aType)

	: TKeyArrayFix(0,aType,0)

	{

	}

TInt TKeyDesC8Array::Compare(TInt aLeft,TInt aRight) const

	{

	TDesC8* left=(*(TDesC8**)At(aLeft));

	TDesC8* right=(*(TDesC8**)At(aRight));

	switch (iCmpType)

		{

	case ECmpFolded:

		return(left->CompareF(*right));

	case ECmpCollated:

		return(left->CompareC(*right));

	default:

		break;

		}

	return(left->Compare(*right));

	}

NONSHARABLE_CLASS(TKeyDesC16Array) : public TKeyArrayFix

	{

public:

	TKeyDesC16Array(TKeyCmpText aType);

private: // from TKey

	TInt Compare(TInt aLeft,TInt aRight) const;

	};

TKeyDesC16Array::TKeyDesC16Array(TKeyCmpText aType)

	: TKeyArrayFix(0,aType,0)

	{

	}

TInt TKeyDesC16Array::Compare(TInt aLeft,TInt aRight) const

	{

	TDesC16* left=(*(TDesC16**)At(aLeft));

	TDesC16* right=(*(TDesC16**)At(aRight));

	switch (iCmpType)

		{

	case ECmpFolded:

		return(left->CompareF(*right));

	case ECmpCollated:

		return(left->CompareC(*right));

	default:

		break;

		}

	return(left->Compare(*right));

	}

// CDesCxArray implementation...

EXPORT_C CDesC8Array::CDesC8Array(TBufRep aRep,TInt aGranularity)

    : CArrayFixBase(aRep,sizeof(HBufC8*),aGranularity)

    {

    }

EXPORT_C CDesC8Array::~CDesC8Array()

/** Frees all resources owned by the object, prior to its destruction. In particular, 

it deletes all descriptors from the array and frees the memory allocated to 

the array buffer. */

    {

	Reset();

    }

EXPORT_C void CDesC8Array::Reset()

/** Deletes all descriptors from the array and frees the memory allocated to the 

array buffer.

@see CDesC8Array::Delete() */

	{

	Delete(0,Count());

	}

EXPORT_C void CDesC8Array::Delete(TInt aIndex)

	{

	Delete(aIndex,1);

	}

/**

 *

 * Deletes one or more logically contiguous descriptor elements from the

 * array.

 *

 * The deletion starts at the specified position.Deleting descriptor

 * elements from the array frees the memory occupied by the associated

 * heap descriptors and removes their pointers from the array buffer but

 * does not cause the array buffer to be automatically compressed. Call

 * the Compress() function to return excess space in the array buffer to

 * the heap.

 *

 * @param     " TInt aPos "

 *            The starting position in the array from which

 *            descriptor elements are to be deleted. The position is

 *            relative to zero, i.e. zero implies the first

 *            descriptor element. This value must not be negative

 *            and must not be greater than the number of descriptor

 *            elements currently in the array, otherwise the

 *            functions raise an E32USER-CBase 21 panic.

 * @param     " TInt aCount "

 *            If specified, the number of contiguous descriptor

 *            elements to be deleted from the array. This value must

 *            not be negative otherwise the function raises an

 *            E32USER-CBase 22 panic. This value plus the value of

 *            the starting position must not be greater than the

 *            number of descriptor elements in the array, otherwise

 *            the function raises an E32USER-CBase 29 panic. This

 *            value must not be negative otherwise the function

 *            raises an E32USER-CBase 22 panic. This value plus the

 *            value of the starting position must not be greater

 *            than the number of descriptor elements in the array,

 *            otherwise the function raises an E32USER-CBase 29

 *            panic. If not specified, one element is assumed.

 */

EXPORT_C void CDesC8Array::Delete(TInt aIndex,TInt aCount)

	{

	TInt count=aCount;

	for (TInt ii=aIndex; count--; ii++)

		User::Free(*(HBufC8**)At(ii));

	CArrayFixBase::Delete(aIndex,aCount);

	}

EXPORT_C TInt CDesC8Array::MdcaCount() const

/** Returns the number of descriptor elements in the array. The function implements 

the interface MDesC8Array::MdcaCount().

@return The number of descriptor elements. */

    {

    return Count();

    }

EXPORT_C TPtrC8 CDesC8Array::MdcaPoint(TInt anIndex) const

/** Indexes into a descriptor array. The function implements the interface 

MDesC8Array::MdcaPoint().

@param aIndex The position of the descriptor element within the array. The 

position is relative to zero; i.e. zero implies the first descriptor element 

in the array. This value must be non-negative and less than the number of 

descriptors currently within the array otherwise the operator panics with 

EArrayIndexOutOfRange. 

@return A non-modifiable pointer descriptor representing the descriptor element 

located at position aIndex within the array. */

	{

	HBufC8* temp=(*(HBufC8**)At(anIndex));

	return (TPtrC8)(*temp);

	}

EXPORT_C void CDesC8Array::AppendL(const TDesC8& aPtr)

/** Appends a descriptor onto the end of any existing descriptor elements in the 

array.

@param aPtr A reference to the descriptor to be appended to the array. 

@leave KErrNoMemory There is insufficient memory available. If the function 

leaves, the array is left in the state it was in before the call. */

	{

	InsertL(Count(),aPtr);

	}

EXPORT_C void CDesC8Array::InsertL(TInt aPos,const TDesC8& aPtr)

/** Inserts a descriptor into the array at the specified position. 

If the specified position is the same as the current number of descriptor 

elements in the array, this has the effect of appending the element.

@param aPos The position within the array where the descriptor element is 

to be inserted. The position is relative to zero, i.e. zero implies the first 

descriptor element. This value must not be negative and must not be greater 

than the number of descriptor elements currently in the array, otherwise the 

function rasises an E32USER-CBase 21 panic. 

@param aPtr The descriptor to be inserted into the array. 

@leave KErrNoMemory There is insufficient memory available. If the function 

leaves, the array is left in the state it was in before the call. */

	{

	HBufC8* bufPtr=aPtr.AllocLC();

   	CArrayFixBase::InsertL(aPos,&bufPtr);

	CleanupStack::Pop();

	}

EXPORT_C TInt CDesC8Array::InsertIsqL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType)

/** Inserts a descriptor into the array at a position which maintains the 

sequence of the descriptors.

The sequence is determined by comparing descriptors using one of the TDesC 

comparison functions. The enumeration aTextComparisonType governs how the 

descriptors are to be compared.

The array should already be in sequence, otherwise the position of the new 

descriptor element is unpredictable. Descriptor elements which are the same 

are not permitted.

@param aPtr A reference to the descriptor to be inserted into the array. 

@param aTextComparisonType An enumeration which determines the type of 

comparison to be made between descriptors for the purpose of choosing the 

insertion position.  If no parameter is explicitly passed, ECmpFolded is used 

by default.

@leave KErrAlreadyExists A descriptor with the same data (i.e. the same length 

and the same content) already exists within the array.

@leave KErrNoMemory There is insufficient memory available. If the function 

leaves, the array is left in the state it was in before the call.

@return The position within the array of the inserted descriptor. */

	{

	HBufC8* bufPtr=aPtr.AllocLC();

	TKeyDesC8Array key(aTextComparisonType);

   	TInt found=CArrayFixBase::InsertIsqL(&bufPtr,key);

	CleanupStack::Pop();

	return(found);

	}

EXPORT_C TInt CDesC8Array::InsertIsqAllowDuplicatesL(const TDesC8& aPtr,TKeyCmpText aTextComparisonType)

/** Inserts a descriptor into the array at a position which maintains the 

sequence of the descriptors - allows duplicates.

The sequence is determined by comparing descriptors using one of the TDesC 

comparison functions. The enumeration aTextComparisonType governs how the 

descriptors are to be compared.

The array should already be in sequence, otherwise the position of the new 

descriptor element is unpredictable. Descriptor elements which are the same 

are permitted; if the descriptor aPtr is a duplicate of an existing descriptor 

within the array, then the new descriptor element is positioned after the 

existing descriptor element.

@param aPtr A reference to the descriptor to be inserted into the array. 

@param aTextComparisonType An enumeration which determines the type of comparison 

to be made between descriptors for the purpose of choosing the insertion position. 

If no parameter is explicitly passed, ECmpFolded is used by default.

@leave KErrNoMemory There is insufficient memory available. If the function 

leaves, the array is left in the state it was in before the call. 

@return The position within the array of the inserted descriptor. */

	{

	HBufC8* bufPtr=aPtr.AllocLC();

	TKeyDesC8Array key(aTextComparisonType);

   	TInt found=CArrayFixBase::InsertIsqAllowDuplicatesL(&bufPtr,key);

	CleanupStack::Pop();

	return(found);

	}

EXPORT_C void CDesC8Array::Sort(TKeyCmpText aTextComparisonType)

/** Sorts the descriptor elements into sequence.

The sequence is determined by comparing descriptors using one of the member 

functions of the descriptor base class TDesC.

@param aTextComparisonType An enumeration which defines the type of comparison 

to be made between descriptors. By default the comparison type is ECmpFolded. */

	{

	TKeyDesC8Array key(aTextComparisonType);

	CArrayFixBase::Sort(key);

	}

EXPORT_C TInt CDesC8Array::Find(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType) const

/** Finds the position of a descriptor element within the array which matches the 

specified descriptor using a sequential search.

The array is searched sequentially for a matching descriptor element, starting 

with the first descriptor element in the array. Descriptors are compared using 

one of the TDesC comparison functions. The enumeration aTextComparisonType 

governs how the descriptors are to be compared.

Where an array has duplicate descriptor elements, the function only supplies 

the position of the first descriptor element.

@param aPtr A reference to a descriptor to be used for comparison. 

@param aPos If the descriptor element is found, this reference is set to the 

position of that descriptor element within the array. The position is relative 

to zero, (i.e. the first descriptor element in the array is at position 0). 

If the descriptor element is not found and the array is not empty, then the 

value of the reference is set to the number of descriptor elements in the 

array. If the descriptor element is not found and the array is empty, then 

the reference is set to zero. 

@param aTextComparisonType An enumeration which determines the type of comparison 

to be made between descriptors. If no parameter is explicitly passed, ECmpFolded 

is used by default. 

@return Zero, if a matching descriptor element is found. Non-zero, if no matching 

descriptor element can be found. */

	{

	TKeyDesC8Array key(aTextComparisonType);

	const TDesC8* tmp=(&aPtr);

	return(CArrayFixBase::Find(&tmp,key,aPos));

	}

EXPORT_C TInt CDesC8Array::FindIsq(const TDesC8& aPtr,TInt& aPos,TKeyCmpText aTextComparisonType) const

/** Finds the position of a descriptor element within the array which matches 

the specified descriptor using a binary search technique. The array must 

be in sequence, otherwise the outcome is unpredictable.

Descriptors are compared using one of the TDesC comparison functions. The 

enumeration aTextComparisonType governs how the descriptors are to be compared.

Where an array has duplicate descriptor elements, the function cannot guarantee 

which matching descriptor element it will return; except that it will find 

one of them.

@param aPtr A reference to a descriptor to be used for comparison. 

@param aPos If the descriptor element is found, the reference is set to the 

position of that descriptor element within the array. The position is relative 

to zero, (i.e. the first descriptor element in the array is at position 0). 

If the descriptor element is not found and the array is not empty, then the 

reference is set to the position of the first descriptor element in the array 

whose content is greater than the content of aPtr. If the descriptor element 

is not found and the array is empty, then the reference is set to zero.

@param aTextComparisonType An enumeration which determines the type of comparison 

to be made between descriptors. If no parameter is explicitly passed, ECmpFolded 

is used by default. 

@return Zero, if a matching descriptor element is found. Non-zero, if no matching 

descriptor element can be found. */

	{

	TKeyDesC8Array key(aTextComparisonType);

	const TDesC8* tmp=(&aPtr);

	return(CArrayFixBase::FindIsq(&tmp,key,aPos));

	}

/**

 *

 * Constructs a flat descriptor array with the specified granularity.

 *

 * No memory is allocated to the array buffer by this constructor.

 *

 * @param     "TInt aGranularity"

 *            The granularity of the array. This value must be

 *            positive otherwise the constructor raises an

 *            E32USER-CBase 18 panic.

 */

EXPORT_C CDesC8ArrayFlat::CDesC8ArrayFlat(TInt aGranularity)

    : CDesC8Array((TBufRep)CBufFlat::NewL,aGranularity)

    {

	__DECLARE_NAME(_S("CDesC8ArrayFlat"));

	}

EXPORT_C CDesC8ArrayFlat::~CDesC8ArrayFlat()

/** Frees all resources owned by the object, prior to its destruction. */

    {}

EXPORT_C CDesC8ArraySeg::CDesC8ArraySeg(TInt aGranularity)

    : CDesC8Array((TBufRep)CBufSeg::NewL,aGranularity)

/** Constructs a segmented descriptor array with the specified granularity.

No memory is allocated to the array buffer by this constructor.

@param aGranularity The granularity of the array. This value must be positive 

otherwise the constructor raises an E32USER-CBase 18 panic. */

    {

	__DECLARE_NAME(_S("CDesC8ArraySeg"));

    }

EXPORT_C CDesC8ArraySeg::~CDesC8ArraySeg()

/** Frees all resources owned by the object, prior to its destruction. */

    {}

// 16-bit equivalents to the above.

EXPORT_C CDesC16Array::CDesC16Array(TBufRep aRep,TInt aGranularity)

    : CArrayFixBase(aRep,sizeof(HBufC16*),aGranularity)

    {

    }

EXPORT_C CDesC16Array::~CDesC16Array()

/** Frees all resources owned by the object, prior to its destruction. In particular, 

it deletes all descriptors from the array and frees the memory allocated to 

the array buffer. */

    {

	Reset();

    }

EXPORT_C void CDesC16Array::Reset()

/** Deletes all descriptors from the array and frees the memory allocated to the 

array buffer.

@see CDesC16Array::Delete() */

	{

	Delete(0,Count());

	}

EXPORT_C void CDesC16Array::Delete(TInt aIndex)

	{

	Delete(aIndex,1);

	}

/**

 *

 * Deletes one or more logically contiguous descriptor elements from the

 * array.

 *

 * The deletion starts at the specified position.Deleting descriptor

 * elements from the array frees the memory occupied by the associated

 * heap descriptors and removes their pointers from the array buffer but

 * does not cause the array buffer to be automatically compressed. Call

 * the Compress() function to return excess space in the array buffer to

 * the heap.

 *

 * @param     " TInt aPos "

 *            The starting position in the array from which

 *            descriptor elements are to be deleted. The position is

 *            relative to zero, i.e. zero implies the first

 *            descriptor element. This value must not be negative

 *            and must not be greater than the number of descriptor

 *            elements currently in the array, otherwise the

 *            functions raise an E32USER-CBase 21 panic.

 * @param     " TInt aCount "

 *            If specified, the number of contiguous descriptor

 *            elements to be deleted from the array. This value must

 *            not be negative otherwise the function raises an

 *            E32USER-CBase 22 panic. This value must not be

 *            negative otherwise the function raises an

 *            E32USER-CBase 22 panic. This value must not be

 *            negative otherwise the function raises an

 *            E32USER-CBase 22 panic. This value plus the value of

 *            the starting position must not be greater than the

 *            number of descriptor elements in the array, otherwise

 *            the function raises an E32USER-CBase 29 panic. If not

 *            specified, one element is assumed.

 */

EXPORT_C void CDesC16Array::Delete(TInt aIndex,TInt aCount)

	{

	TInt count=aCount;

	for (TInt ii=aIndex; count--; ii++)

		User::Free(*(HBufC16**)At(ii));

	CArrayFixBase::Delete(aIndex,aCount);

	}

EXPORT_C TInt CDesC16Array::MdcaCount() const

/** Returns the number of descriptor elements in the array. The function implements 

the function interface MDesC16Array::MdcaCount().

@return The number of descriptor elements. */

    {

    return Count();

    }

EXPORT_C TPtrC16 CDesC16Array::MdcaPoint(TInt anIndex) const

/** Indexes into a descriptor array. The function implements the interface MDesC16Array::MdcaPoint().

	@param aIndex The position of the descriptor element within the array. The 

	position is relative to zero; i.e. zero implies the first descriptor element 

	in the array. This value must be non-negative and less than the number of 

	descriptors currently within the array otherwise the operator panics with 

	EArrayIndexOutOfRange. 

	@return A non-modifiable pointer descriptor representing the descriptor element 

	located at position aIndex within the array. */	

	{

	HBufC16* temp=(*(HBufC16**)At(anIndex));

	return (TPtrC16)(*temp);

	}

EXPORT_C void CDesC16Array::AppendL(const TDesC16& aPtr)

/** Appends a descriptor onto the end of any existing descriptor elements in the 

array.

@param aPtr A reference to the descriptor to be appended to the array. */

	{

	InsertL(Count(),aPtr);

	}

EXPORT_C void CDesC16Array::InsertL(TInt aPos,const TDesC16& aPtr)

/** Inserts a descriptor into the array at the specified position. 

If the specified position is the same as the current number of descriptor 

elements in the array, this has the effect of appending the element.

@param aPos The position within the array where the descriptor element is 

to be inserted. The position is relative to zero, i.e. zero implies the first 

descriptor element. This value must not be negative and must not be greater 

than the number of descriptor elements currently in the array, otherwise the 

function raises an E32USER-CBase 21 panic. 

@param aPtr The descriptor to be inserted into the array. */

	{

	HBufC16* bufPtr=aPtr.AllocLC();

   	CArrayFixBase::InsertL(aPos,&bufPtr);

	CleanupStack::Pop();

	}

EXPORT_C TInt CDesC16Array::InsertIsqL(const TDesC16& aPtr,TKeyCmpText aTextComparisonType)

/** Inserts a descriptor into the array at a position which maintains the sequence 

of the descriptors.

The sequence is determined by comparing descriptors using one of the TDesC 

comparison functions. The enumeration aTextComparisonType governs how the 

descriptors are to be compared.

The array should already be in sequence, otherwise the position of the new 

descriptor element is unpredictable. Descriptor elements which are the same 

are not permitted.

@param aPtr A reference to the descriptor to be inserted into the array. 

@param aTextComparisonType An enumeration which determines the type of comparison 

to be made between descriptors for the purpose of choosing the insertion position. 

If no parameter is explicitly passed, ECmpFolded is used by default.

@return The position within the array of the inserted descriptor. */