sl@0: // Copyright (c) 2001-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: // This file contains the API definition for the classes TDelimitedParserBase16
sl@0: // and CDelimitedData16.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file DelimitedParser16.h
sl@0:  @publishedAll
sl@0:  @released	
sl@0: */
sl@0: 
sl@0: #ifndef __DELIMITEDPARSER16_H__
sl@0: #define __DELIMITEDPARSER16_H__
sl@0: 
sl@0: // System includes
sl@0: //
sl@0: #include <e32base.h>
sl@0: #include <delimitedparsercommon.h>
sl@0: 
sl@0: 
sl@0: /**
sl@0: Comments : Provides non-modifying functionality for parsing data delimited by
sl@0: a single character. The data is delimited into segments. Uses 16-bit descriptors.
sl@0: 
sl@0: The object contains a descriptor with the data which can be parsed from left
sl@0: to right, or right to left. It is non-owning. The current segment can be extracted,
sl@0: which then parses the string for the next segment.
sl@0: 
sl@0: This is a base class and an object of this type cannot be instantiated. It should
sl@0: be derived. The derived class should ensure that the data iDataDes is set before
sl@0: calling one of the protected parsing functions. The derived class should also ensure
sl@0: that the delimiting character has been set.
sl@0: 
sl@0: If the data iDataDes has not been parsed, then calling any functionality that
sl@0: requires the data to have been parsed will result in a panic
sl@0: KDelimitedParserErrNotParsed. The data can only be parsed by calling one of the
sl@0: protected parsing functions from the derived class.
sl@0: 
sl@0: If the delimiting character iDelimiter has not been set, then calling the protected
sl@0: parsing functions and some of the other public functionality that requires the
sl@0: delimiter to be set will result in a panic KDelimitingParserErrNoDelimiter.
sl@0: @publishedAll
sl@0: @released
sl@0: @since 6.0
sl@0: */
sl@0: class TDelimitedParserBase16
sl@0: 	{
sl@0: public:	// Methods
sl@0: 
sl@0: 	IMPORT_C void Reset() const;
sl@0: 	
sl@0: 	IMPORT_C TInt GetNext(TPtrC16& aSegment) const;
sl@0: 
sl@0: 	IMPORT_C TInt Inc() const;
sl@0: 
sl@0: 	IMPORT_C TInt Dec() const;
sl@0: 
sl@0: 	IMPORT_C TInt Peek(TPtrC16& aSegment) const;
sl@0: 
sl@0: 	IMPORT_C TBool Eos() const;
sl@0: 
sl@0: 	IMPORT_C TBool FrontDelimiter() const;
sl@0: 
sl@0: 	IMPORT_C TBool BackDelimiter() const;
sl@0: 
sl@0: 	IMPORT_C const TDesC16& Des() const;
sl@0: 
sl@0: 	IMPORT_C TInt Remainder(TPtrC16& aRemainder) const;
sl@0: 
sl@0: protected:	// Methods
sl@0: 
sl@0: 	IMPORT_C TDelimitedParserBase16();
sl@0: 
sl@0: 	IMPORT_C void Parse(const TDesC16& aData);
sl@0: 
sl@0: 	IMPORT_C void ParseReverse(const TDesC16& aData);
sl@0: 
sl@0: 	IMPORT_C void SetDelimiter(TChar aDelimiter);
sl@0: 
sl@0: private:	// Methods
sl@0: 
sl@0: 	void DoParse(const TDesC16& aData);
sl@0: 
sl@0: 	TInt FindNextSegment(TInt aStartPos) const;
sl@0: 
sl@0: 	TInt FindPrevSegment(TInt aStartPos) const;
sl@0: 
sl@0: private:	// Attributes
sl@0: 
sl@0: 	/** Descriptor with the string
sl@0: 	 */
sl@0: 	TPtrC16						iDataDes;
sl@0: 
sl@0: 	/** Descriptor with the current segment.
sl@0: 	 */
sl@0: 	mutable TPtrC16				iCurrentSegment;
sl@0: 
sl@0: 	/** Position of next segment.
sl@0: 	 */
sl@0: 	mutable TInt				iNextSegmentPos;
sl@0: 
sl@0: 	/** Direction of parsing.
sl@0: 	 */
sl@0: 	TDelimitedDataParseMode		iMode;
sl@0: 
sl@0: 	/** Delimiting character
sl@0: 	*/
sl@0: 	TInt						iDelimiter;
sl@0: 
sl@0: /**
sl@0: 	A friend class.
sl@0: 	@see		CDelimitedDataBase16
sl@0: 	@since		6.0
sl@0:  */
sl@0: 	friend class CDelimitedDataBase16;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: typedef 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef TDelimitedParserBase16 TDelimitedParserBase;
sl@0: 
sl@0: /**
sl@0: Dependencies : CBase, TDelimitedParserBase16
sl@0: Comments : Provides functionality for creating and editing a delimited data object.
sl@0: Uses 16-bit descriptors
sl@0: 
sl@0: The object contains a descriptor buffer with the data. Functionality is provided
sl@0: to allow segments to be added or removed from the data. There is access to the
sl@0: internal delimited data parser to provide parsing functionality to be excercised
sl@0: on the created data.
sl@0: 
sl@0: This a base class that cannot be instantiated. It should be derived. The derived
sl@0: class must set the delimited data parser, which is an object derived from
sl@0: TDelimitedParserBase. This helper class must set the delimiting object
sl@0: 
sl@0: If the delimiting character has not been set, then calling any of the functionality
sl@0: will cause a panic KDelimitedParserErrNoDelimiter.
sl@0: @publishedAll
sl@0: @released
sl@0: @since 6.0
sl@0: */
sl@0: class CDelimitedDataBase16 : public CBase
sl@0: 	{
sl@0: public: // Methods
sl@0: 
sl@0: 
sl@0: 	IMPORT_C ~CDelimitedDataBase16();
sl@0: 
sl@0: 	IMPORT_C void InsertCurrentL(const TDesC16& aSegment);
sl@0: 
sl@0: 	IMPORT_C void RemoveCurrentL();
sl@0: 
sl@0: 	IMPORT_C void PushBackL(const TDesC16& aSegment);
sl@0: 
sl@0: 	IMPORT_C void PopBackL();
sl@0: 
sl@0: 	IMPORT_C void PushFrontL(const TDesC16& aSegment);
sl@0: 
sl@0: 	IMPORT_C void PopFrontL();
sl@0: 
sl@0: 	IMPORT_C void TrimFrontDelimiterL();
sl@0: 
sl@0: 	IMPORT_C void AddFrontDelimiterL();
sl@0: 
sl@0: 	IMPORT_C void TrimBackDelimiterL();
sl@0: 
sl@0: 	IMPORT_C void AddBackDelimiterL();
sl@0: 
sl@0: 	IMPORT_C void Parse();
sl@0: 
sl@0: 	IMPORT_C void ParseReverse();
sl@0: 
sl@0: 	IMPORT_C const TDelimitedParserBase16& Parser() const;
sl@0: 
sl@0: protected:	// Methods
sl@0: 
sl@0: 	IMPORT_C CDelimitedDataBase16();
sl@0: 
sl@0: 	IMPORT_C void ConstructL(const TDesC16& aData);
sl@0: 
sl@0: 	IMPORT_C void SetDelimiter(TChar aDelimiter);
sl@0: 
sl@0: private:	// Methods
sl@0: 
sl@0: 	void SetDataL(const TDesC16& aData);
sl@0: 
sl@0: 	void SetData(HBufC16* aDataBuf);
sl@0: 
sl@0: 	void DoInsertL(const TDesC16& aSegment);
sl@0: 
sl@0: 	void DoRemoveL();
sl@0: 
sl@0: private:	// Attributes
sl@0: 
sl@0: 	/** Descriptor buffer.
sl@0: 	 */
sl@0: 	HBufC16*				iDataBuf;
sl@0: 
sl@0: 	/** Parser object
sl@0: 	 */
sl@0: 	TDelimitedParserBase16	iParser;
sl@0: 
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: typedef 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: typedef CDelimitedDataBase16 CDelimitedDataBase;
sl@0: 
sl@0: #endif	// __DELIMITEDPARSER16_H__