sl@0: // Copyright (c) 1998-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: //
sl@0: 
sl@0: #include "UM_STD.H"
sl@0: 
sl@0: /**
sl@0: Constructs the RMemReadStream object and prepares the stream hosted
sl@0: in the specified plain memory location for reading.
sl@0: 
sl@0: @param aPtr The start address for the area of memory that will be
sl@0: the source of this stream.
sl@0: @param aLength The length of the area of memory.
sl@0: 
sl@0: @see RMemReadStream::Open
sl@0: */
sl@0: EXPORT_C RMemReadStream::RMemReadStream(const TAny* aPtr,TInt aLength)
sl@0: 	{
sl@0: 	Open(aPtr,aLength);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Open a stream that reads from a pointer of any type.
sl@0: 
sl@0: To close the stream and free its resources call Close()
sl@0: 
sl@0: @param aPtr The start address for the area of memory that will be
sl@0: the source of this stream.
sl@0: @param aLength The length of the area of memory.
sl@0: 
sl@0: @see TMemBuf::Set
sl@0: @see RReadStream::Attach
sl@0: */
sl@0: EXPORT_C void RMemReadStream::Open(const TAny* aPtr,TInt aLength)
sl@0: 	{
sl@0: 	iSource.Set((TUint8*)aPtr,(TUint8*)aPtr+aLength,iSource.ERead);
sl@0: 	RReadStream::Attach(&iSource);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructs the RMemWriteStream object and prepares a stream to be hosted
sl@0: in the specified memory location (described by the TAny aPtr argument)
sl@0: for writing using the Open() function.
sl@0: 
sl@0: @param aPtr The start address for the area of memory that is the sink of
sl@0: this stream.
sl@0: @param aMaxLength The maximum length of the area of memory.
sl@0: 
sl@0: @see RMemWriteStream::Open
sl@0: */
sl@0: EXPORT_C RMemWriteStream::RMemWriteStream(TAny* aPtr,TInt aMaxLength)
sl@0: 	{
sl@0: 	Open(aPtr,aMaxLength);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Prepares a stream for writing.
sl@0: 
sl@0: When streaming takes place any existing data in the memory location will
sl@0: be replaced. Note that the length of memory must be big enough to accommodate
sl@0: the expected streamed data otherwise the subsequent streaming operation will
sl@0: leave with KErrOverFlow.
sl@0: 
sl@0: To close the stream and free its resources call Close()
sl@0: 
sl@0: @param aPtr The start address for the area of memory that is the sink of
sl@0: this stream.
sl@0: @param aMaxLength The maximum length of the area of memory.
sl@0: 
sl@0: @see TMemBuf::Set
sl@0: @see RWriteStream::Attach
sl@0: */
sl@0: EXPORT_C void RMemWriteStream::Open(TAny* aPtr,TInt aMaxLength)
sl@0: 	{
sl@0: 	iSink.Set((TUint8*)aPtr,(TUint8*)aPtr+aMaxLength,iSink.EWrite);
sl@0: 	RWriteStream::Attach(&iSink);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructs the RDesReadStream object and prepares the stream hosted
sl@0: by the specified descriptor for reading.
sl@0: 
sl@0: @param aDes The descriptor that will be the source of this stream.
sl@0: 
sl@0: @see RDesReadStream::Open
sl@0: */
sl@0: EXPORT_C RDesReadStream::RDesReadStream(const TDesC8& aDes)
sl@0: 	{
sl@0: 	Open(aDes);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Open a stream that reads from a descriptor.
sl@0: 
sl@0: To close the stream and free its resources call Close()
sl@0: 
sl@0: @param aDes The descriptor that will be the source of this stream.
sl@0: 
sl@0: @see TDesBuf::Set
sl@0: @see RReadStream::Attach
sl@0: */
sl@0: EXPORT_C void RDesReadStream::Open(const TDesC8& aDes)
sl@0: 	{
sl@0: 	TUint8* ptr=(TUint8*)aDes.Ptr();
sl@0: 	iSource.Set(ptr,ptr+aDes.Length(),iSource.ERead);
sl@0: 	RReadStream::Attach(&iSource);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructs the RDesWriteStream object and prepares a stream to be
sl@0: hosted by the specified 8-bit descriptor for writing using the Open()
sl@0: function.
sl@0: 
sl@0: 
sl@0: @param aDes The descriptor hosting the stream.
sl@0: 
sl@0: @see RDesWriteStream::Open
sl@0: */
sl@0: EXPORT_C RDesWriteStream::RDesWriteStream(TDes8& aDes)
sl@0: 	{
sl@0: 	Open(aDes);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Prepares a stream for writing.
sl@0: 
sl@0: When streaming takes place, any existing data in the descriptor will
sl@0: be replaced. Note that the maximum length of the descriptor must be
sl@0: big enough to accommodate the expected streamed data, otherwise the
sl@0: subsequent streaming operation will leave with KErrOverFlow.
sl@0: 
sl@0: A subsequent call to CommitL() sets the length of the descriptor.
sl@0: 
sl@0: To close the stream and free its resources call Close()
sl@0: 
sl@0: @param aDes The descriptor that will be the sink of this stream.
sl@0: 
sl@0: @see TDesBuf::Set
sl@0: @see RWriteStream::Attach
sl@0: */
sl@0: EXPORT_C void RDesWriteStream::Open(TDes8& aDes)
sl@0: 	{
sl@0: 	aDes.SetLength(0);
sl@0: 	iSink.Set(aDes,iSink.EWrite);
sl@0: 	RWriteStream::Attach(&iSink);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructs the RBufReadStream object and opens the stream hosted by the
sl@0: specified dynamic buffer for reading using the Open() method.
sl@0: 
sl@0: @param aBuf The dynamic buffer that will be the source of this stream.
sl@0: @param aPos The offset within the dynamic buffer where the stream starts.
sl@0: 
sl@0: @see RBufReadStream::Open
sl@0: */
sl@0: EXPORT_C RBufReadStream::RBufReadStream(const CBufBase& aBuf,TInt aPos)
sl@0: 	{
sl@0: 	Open(aBuf,aPos);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Prepares the stream hosted by the specified dynamic buffer for reading.
sl@0: 
sl@0: To close the stream and free its resources call Close()
sl@0: 
sl@0: @param aBuf The dynamic buffer that will be the source of this stream.
sl@0: @param aPos The offset within the dynamic buffer where the stream starts.
sl@0: 
sl@0: @see TBufBuf::Set
sl@0: @see RReadStream::Attach
sl@0: */
sl@0: EXPORT_C void RBufReadStream::Open(const CBufBase& aBuf,TInt aPos)
sl@0: 	{
sl@0: 	iSource.Set((CBufBase&)aBuf,aPos,iSource.ERead);
sl@0: 	RReadStream::Attach(&iSource);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Constructs the RBufWriteStream object and opens a stream that writes to
sl@0: the specified dynamic buffer using the Open() function.
sl@0: 
sl@0: @param aBuf The dynamic buffer hosting the stream.
sl@0: @param aPos The offset within the dynamic buffer where the stream is to
sl@0: start. Defaults to zero, if not explicitly specified. The value cannot
sl@0: be greater than the current size of the buffer, otherwise a E32USER-CBase 5
sl@0: panic will be raised when streaming starts.
sl@0: 
sl@0: @see RBufWriteStream::Open
sl@0: */
sl@0: EXPORT_C RBufWriteStream::RBufWriteStream(CBufBase& aBuf,TInt aPos)
sl@0: 	{
sl@0: 	Open(aBuf,aPos);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Open a stream that writes to the dynamic buffer specified in the aBuf argument.
sl@0: 
sl@0: To close the stream and free its resources call Close()
sl@0: 
sl@0: @param aBuf The dynamic buffer hosting the stream.
sl@0: @param aPos The offset within the dynamic buffer where the stream is to
sl@0: start. Defaults to zero, if not explicitly specified. The value cannot
sl@0: be greater than the current size of the buffer, otherwise a E32USER-CBase 5
sl@0: panic will be raised when streaming starts.
sl@0: 
sl@0: @see TBufBuf::Set
sl@0: @see RWriteStream::Attach
sl@0: */
sl@0: EXPORT_C void RBufWriteStream::Open(CBufBase& aBuf,TInt aPos)
sl@0: 	{
sl@0: 	iSink.Set(aBuf,aPos,iSink.EWrite);
sl@0: 	RWriteStream::Attach(&iSink);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Open a stream that writes into the dynamic buffer specified in the aBuf argument
sl@0: using truncate mode.
sl@0: 
sl@0: @param aBuf The dynamic buffer hosting the stream.
sl@0: @param aPos The offset within the dynamic buffer where the stream is to
sl@0: start. Defaults to zero, if not explicitly specified. The value cannot
sl@0: be greater than the current size of the buffer, otherwise a E32USER-CBase 5
sl@0: panic will be raised when streaming starts.
sl@0: 
sl@0: @see TBufBuf::Set
sl@0: @see TBufBuf::ETruncate
sl@0: @see RWriteStream::Attach
sl@0: */
sl@0: EXPORT_C void RBufWriteStream::Truncate(CBufBase& aBuf,TInt aPos)
sl@0: 	{
sl@0: 	iSink.Set(aBuf,aPos,iSink.ETruncate);
sl@0: 	RWriteStream::Attach(&iSink);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: Open a stream that writes into the dynamic buffer specified in the aBuf argument
sl@0: using insert mode.
sl@0: 
sl@0: @param aBuf The dynamic buffer hosting the stream.
sl@0: @param aPos The offset within the dynamic buffer where the stream is to
sl@0: start. Defaults to zero, if not explicitly specified. The value cannot
sl@0: be greater than the current size of the buffer, otherwise a E32USER-CBase 5
sl@0: panic will be raised when streaming starts.
sl@0: 
sl@0: @see TBufBuf::Set
sl@0: @see TBufBuf::EInsert
sl@0: @see RWriteStream::Attach
sl@0: */
sl@0: EXPORT_C void RBufWriteStream::Insert(CBufBase& aBuf,TInt aPos)
sl@0: 	{
sl@0: 	iSink.Set(aBuf,aPos,iSink.EInsert);
sl@0: 	RWriteStream::Attach(&iSink);
sl@0: 	}
sl@0: