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

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "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:

// e32\euser\cbase\ub_buf.cpp

// 

//

#include "ub_std.h"

class TBufSegLink : public TDblQueLink

	{

public:

	inline TBufSegLink() : iLen(0) {}

	inline TBufSegLink *Next() const {return((TBufSegLink *)iNext);}

	inline TBufSegLink *Prev() const {return((TBufSegLink *)iPrev);}

public:

	TInt iLen;

	};

EXPORT_C CBufBase::CBufBase(TInt anExpandSize)

//

// Constructor

//

/**

@internalComponent

*/

	{

	__ASSERT_ALWAYS(anExpandSize>=0,Panic(EBufExpandSizeNegative));

//	iSize=0;

	iExpandSize=anExpandSize;

	}

EXPORT_C CBufBase::~CBufBase()

/**

Destructor

*/

	{

	}

EXPORT_C void CBufBase::Reset()

/**

Deletes all data in the buffer.

Its behaviour is the same as calling Delete(0,Size()). 

The buffer is compressed before the function returns.

*/

	{

	if (iSize)

		Delete(0,iSize);

	Compress();

	}

EXPORT_C void CBufBase::Read(TInt aPos,TDes8 &aDes) const

//

// Read up to aDes.MaxLength() bytes.

//

/**

Reads data from the buffer into a descriptor.

Data, starting at the specified buffer position is written to the descriptor, 

filling the descriptor.

@param aPos Buffer position from which data is read: must be in range zero 

            to Size(). 

@param aDes On return, contains the data read from the buffer; its MaxLength() 

            specifies the amount of data to be read.

*/

	{

	Read(aPos,aDes,aDes.MaxLength());

	}

EXPORT_C void CBufBase::Read(TInt aPos,TDes8 &aDes,TInt aLength) const

/**

Reads the specified number of bytes of data from the buffer into a descriptor.

@param aPos    Buffer position from which data is read: must be in range zero 

               to (Size() minus the length of the data to be read). 

@param aDes    On return, contains data read from the buffer.

@param aLength The length of the data to be read.

*/

	{

	aDes.SetLength(aLength);

	Read(aPos,(TAny *)aDes.Ptr(),aLength);

	}

EXPORT_C void CBufBase::Read(TInt aPos,TAny *aPtr,TInt aLength) const

/**

Reads the specified number of bytes of data from the buffer into a specified 

address.

@param aPos    Buffer position from which data is read: must be in range zero 

               to (Size() minus the length of the data to be read). 

@param aPtr    The address into which the data should be read.

@param aLength The length of the data to be read.

*/

	{

	if (aLength==0)

		return;

	__ASSERT_ALWAYS(aLength>0,Panic(EBufReadLengthNegative));

	__ASSERT_ALWAYS((aPos+aLength)<=iSize,Panic(EBufReadBeyondEnd));

	TUint8 *pT=(TUint8 *)aPtr;

	while (aLength)

		{

		TPtr8 p=((CBufBase *)this)->Ptr(aPos);

		TInt s=Min(p.Length(),aLength);

		pT=Mem::Copy(pT,p.Ptr(),s);

		aLength-=s;

		aPos+=s;

		}

	}

EXPORT_C void CBufBase::Write(TInt aPos,const TDesC8 &aDes)

//

// Write aDes.Length() characters to the buffer. Does not cause any expansion.

//

/**

Writes data from a descriptor to the buffer.

The data in the descriptor overwrites the data in the buffer from the insertion 

point onwards.

No new space is allocated; this function cannot fail (provided the parameters 

are specified within the bounds of the buffer and descriptor).

No shuffling occurs; new data is written to the memory locations occupied 

by the data it overwrites.

@param aPos Buffer position at which data will begin to be written; must be 

            in range zero to (Size() minus the length of the data

            to be written). 

@param aDes Contains the data to be written. The length of data to be written

            is the descriptor length.

*/

	{

	Write(aPos,aDes.Ptr(),aDes.Length());

	}

EXPORT_C void CBufBase::Write(TInt aPos,const TDesC8 &aDes,TInt aLength)

//

// Write aDes.Length() characters to the buffer. Does not cause any expansion.

//

/**

Writes the specified number of bytes of data from a descriptor to the buffer.

The data in the descriptor overwrites the data in the buffer from the insertion 

point onwards.

No new space is allocated; this function cannot fail (provided the parameters 

are specified within the bounds of the buffer and descriptor).

No shuffling occurs; new data is written to the memory locations occupied 

by the data it overwrites.

@param aPos    Buffer position at which data will begin to be written; must be 

               in range zero to (Size() minus the length of the data to

               be written). 

@param aDes    Contains the data to be written.

@param aLength The length of the data to be written.

*/

	{

	Write(aPos,aDes.Ptr(),aLength);

	}

EXPORT_C void CBufBase::Write(TInt aPos,const TAny *aPtr,TInt aLength)

/**

Writes the specified number of bytes of data from the specified address to the 

buffer.

The data in the buffer is overwritten from the insertion point onwards.

No new space is allocated; this function cannot fail (provided the parameters 

are specified within the bounds of the buffer and descriptor).

No shuffling occurs: new data is written to the memory locations occupied 

by the data it overwrites.

@param aPos    Buffer position at which data will begin to be written; must be 

               in range zero to (Size() minus the length of the data to

               be written). 

@param aPtr    The address of the data to be written.

@param aLength The length of the data to be written.

@panic E32USER-CBase 7, if aLength is not positive

@panic E32USER-CBase 5, if aPos + aLength is greater than the number of

                        data bytes in the buffer, i.e. if the target appears

                        to be outside the buffer.

*/

	{

	if (aLength==0)

		return;

	__ASSERT_ALWAYS(aLength>0,Panic(EBufWriteLengthNegative));

	__ASSERT_ALWAYS((aPos+aLength)<=iSize,Panic(EBufWriteBeyondEnd));

	const TUint8 *pS=(const TUint8 *)aPtr;

	while (aLength)

		{

		TPtr8 p=Ptr(aPos);

		TInt s=Min(p.Length(),aLength);

		Mem::Copy((TAny *)p.Ptr(),pS,s);

		pS+=s;

		aLength-=s;

		aPos+=s;

		}

	}

EXPORT_C void CBufBase::InsertL(TInt aPos,const TDesC8 &aDes)

//

// Insert aDes.Length() bytes into the buffer.

//

/**

Inserts data into the buffer.

Data at and beyond the insertion position is moved to make way for the inserted 

data. Data before the insertion position remains in place.

Notes:

1. Insertion may require more buffer space to be allocated.

2. In the case of flat buffers, the buffer is extended by a ReAllocL() of the 

   buffer's heap cell, to the smallest multiple of the granularity that will 

   contain the data required. If this reallocation fails, the insertion is

   impossible and a leave occurs.

3. In the case of segmented buffers, a reallocation is performed if the segment 

   containing the insertion position has insufficient space, and

   immediately-neighbouring segments cannot be used to contain the new data.

   As many new segments as are necessary to contain the inserted data are

   allocated. Each new segment's length is the buffer's granularity.

   If extension or new allocation fails, a leave occurs.

4. Insertion may also require data to be shuffled. In the case of flat buffers, 

   data beyond the insertion point is shuffled up to create a gap; the new data 

   is then inserted into this gap. In the case of segmented buffers, shuffling 

   is minimised by inserting the new data into newly-allocated buffers, and

   shuffling only immediately-neighbouring buffers if possible. This may result

   in some wastage of space, but is much more time-efficient for large amounts

   of data.

@param aPos Buffer position before which the data will be inserted; must be 

            in range zero to Size().

@param aDes The data to be inserted; the length of the data is the descriptor

            length.

@leave KErrNoMemory If the insertion requires a bigger buffer, and the

       necessary allocation or re-allocation fails.

*/

	{

	InsertL(aPos,aDes.Ptr(),aDes.Length());

	}

EXPORT_C void CBufBase::InsertL(TInt aPos,const TDesC8 &aDes,TInt aLength)

//

// Insert aLength bytes into the buffer.

//

/**

Inserts the specified number of bytes of data from a descriptor into

the buffer.

aLength bytes of data from aDes are inserted into the buffer at aPos. Data at

and beyond the insertion position is moved to make way for the inserted data. 

Data before the insertion position remains in place.

Notes:

1. Insertion may require more buffer space to be allocated.

2. In the case of flat buffers, the buffer is extended by a ReAllocL() of the 

   buffer's heap cell, to the smallest multiple of the granularity that will 

   contain the data required. If this reallocation fails, the insertion is

   impossible and a leave occurs.

3. In the case of segmented buffers, a reallocation is performed if the segment 

   containing the insertion position has insufficient space, and

   immediately-neighbouring segments cannot be used to contain the new data.

   As many new segments as are necessary to contain the inserted data are

   allocated. Each new segment's length is the buffer's granularity.

   If extension or new allocation fails, a leave occurs.

4. Insertion may also require data to be shuffled. In the case of flat buffers, 

   data beyond the insertion point is shuffled up to create a gap: the new data 

   is then inserted into this gap. In the case of segmented buffers, shuffling 

   is minimised by inserting the new data into newly-allocated buffers,

   and shuffling  only immediately-neighbouring buffers if possible.

   This may result in some  wastage of space, but is much more time-efficient

   for large amounts of data.

@param aPos    Buffer position before which the data will be inserted; must be 

               in range zero to Size().

@param aDes    The data to be inserted.

@param aLength The length of data to be inserted. 

@leave KErrNoMemory If the insertion requires a bigger buffer, and the

       necessary allocation or re-allocation fails.

*/

	{

	InsertL(aPos,aDes.Ptr(),aLength);

	}

EXPORT_C void CBufBase::InsertL(TInt aPos,const TAny *aPtr,TInt aLength)

/**

Inserts bytes of data from the specified address into the buffer.

Inserts aLength bytes of data found at address aPtr into the buffer at aPos. 

Data at and beyond the insertion position is moved to make way for the inserted 

data. Data before the insertion position remains in place.

Notes:

1. Insertion may require more buffer space to be allocated.

2. In the case of flat buffers, the buffer is extended by a ReAllocL() of the 

   buffer's heap cell, to the smallest multiple of the granularity that will 

   contain the data required. If this reallocation fails, the insertion is

   impossible and a leave occurs.

2. In the case of segmented buffers, a reallocation is performed if the segment 

   containing the insertion position has insufficient space, and

   immediately-neighbouring segments cannot be used to contain the new data.

   As many new segments as are necessary to contain the inserted data are

   allocated. Each new segment's length is the buffer's granularity.

   If extension or new allocation fails, a leave occurs.

4. Insertion may also require data to be shuffled. In the case of flat buffers, 

   data beyond the insertion point is shuffled up to create a gap: the new data 

   is then inserted into this gap. In the case of segmented buffers, shuffling 

   is minimised by inserting the new data into newly-allocated buffers, and

   shuffling only immediately-neighbouring buffers if possible. This may result

   in some wastage of space, but is much more time-efficient for large amounts

   of data.

@param aPos    Buffer position before which the data will be inserted: must be 

               in range zero to Size().

@param aPtr    The address of the data to be inserted. 

@param aLength The length of the data to be inserted.

@leave KErrNoMemory If the insertion requires a bigger buffer, and the

       necessary allocation or re-allocation fails.

*/

	{

	if (aLength==0)

		return;

	__ASSERT_ALWAYS(aLength>0,Panic(EBufInsertLengthNegative));

	__ASSERT_ALWAYS(aPtr,Panic(EBufInsertBadPtr));

	DoInsertL(aPos,aPtr,aLength);

	}

EXPORT_C void CBufBase::ExpandL(TInt aPos,TInt aLength)

/**

Inserts an uninitialised region into the buffer.

Data at and beyond the insertion position is moved to make way for the inserted

region. Data before the insertion position remains in place.

Note:

1. The inserted region is not initialised. After using ExpandL(), you should 

   then use a series of Write()s to fill this region with data.

2. Use ExpandL() followed by a series of Write()s when you know the amount of 

   data to be inserted, in advance. It is more efficient than a series of

   InsertL()s. In addition, once the result of the ExpandL() has been checked,

   it is guaranteed that the Write()s do not leave, which can sometimes be

   useful.

@param aPos    Buffer position before which the region will be inserted; must 

               be in range zero to Size(). 

@param aLength The length of the region to be inserted.

*/

	{

	if (aLength==0)

		return;

	__ASSERT_ALWAYS(aLength>0,Panic(EBufInsertLengthNegative));

	DoInsertL(aPos,NULL,aLength);

	}

EXPORT_C void CBufBase::ResizeL(TInt aSize)

/**

Re-sizes the buffer to the specified size.

The new size can be larger or smaller than the existing size.

If the new size is larger than the existing size, the buffer is expanded by 

adding uninitialised data to the end of it.

If the new size is smaller than the existing size, the buffer is reduced; 

any data at the end of the buffer is lost.

Notes:

1. If the new size is larger than the existing size, the function is equivalent 

   to Delete(aSize,Size()-aSize).

2. If the new size is smaller than the existing size, the function is equivalent 

   to ExpandL((Size(),aSize-Size()).

3. The motivations for using ResizeL() are the same as those for using Delete() 

   and ExpandL().

@param aSize The new size of the buffer; this value must be greater than or 

             equal to zero.

*/

	{

	TInt excess=iSize-aSize;

	if (excess>0)

		Delete(aSize,excess);

	else

		ExpandL(iSize,-excess);

	}

EXPORT_C CBufFlat *CBufFlat::NewL(TInt anExpandSize)

/**

Allocates and constructs a flat buffer.

If there is insufficient memory available to allocate the flat buffer, the 

function leaves.

@param anExpandSize The granularity of buffer expansion. Additional space, 

                    when required, is always allocated in multiples of

                    this number. Note: although a value of zero is permitted

                    by this interface, it has no meaning, and risks raising

                    panics later during execution. We suggest that you pass

                    a positive value.

@return A pointer to the flat buffer object.

@panic E32USER-CBase 3 if the granularity is negative.

*/

	{

	return(new(ELeave) CBufFlat(anExpandSize));

	}

EXPORT_C CBufFlat::CBufFlat(TInt anExpandSize)

//

// Constructor

//

/**

@internalComponent

*/

	: CBufBase(anExpandSize)

	{

//	iMaxSize=0;

//	iPtr=NULL;

	}

EXPORT_C CBufFlat::~CBufFlat()

/** 

Destructor.

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

Specifically, it frees the allocated cell used as a buffer.

*/

	{

	User::Free(iPtr);

	}

EXPORT_C void CBufFlat::Compress()

/**

Compresses the buffer so as to occupy minimal space.

This frees any unused memory at the end of the buffer.

@see CBufBase::Compress

*/

	{

	SetReserveL(iSize);

	}

EXPORT_C void CBufFlat::SetReserveL(TInt aSize)

/**

Specifies a minimum amount of space which the flat buffer should occupy.

If the required size is zero, the heap cell is deleted. If it is different 

from the current size, the heap cell is rellocated accordingly.

@param aSize The size of the buffer required. If there is no data in the

             buffer, i.e. Size() returns zero, then this value 

             can be zero, which causes the buffer's allocated heap cell

             to be deleted.

@panic E32USER-CBase 10, if aSize is negative.

@panic E32USER-CBase 11, if there is data in the buffer, and aSize is less than

       the value returned by Size().

*/

	{

	__ASSERT_ALWAYS(aSize>=0,Panic(EBufFlatReserveNegative));

	__ASSERT_ALWAYS(aSize>=iSize,Panic(EBufFlatReserveSetTooSmall));

    if (!aSize)

        {

        User::Free(iPtr);

        iPtr=NULL;

        }

    else

        iPtr=(TUint8 *)User::ReAllocL(iPtr,aSize);

    iMaxSize=aSize;

	}

EXPORT_C void CBufFlat::DoInsertL(TInt aPos,const TAny *aPtr,TInt aLength)

//

// Insert into the buffer. Can cause expansion.

//