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: //
sl@0: 
sl@0: #ifndef __DELIMITEDPATH8_H__
sl@0: #define __DELIMITEDPATH8_H__
sl@0: 
sl@0: /**
sl@0: 	@file DelimitedPath8.h
sl@0: 	Comments :	This file contains the API definition for the classes 
sl@0: 				TDelimitedPathParser8 and CDelimitedPath16. 
sl@0: 	@publishedAll
sl@0: 	@released	
sl@0:  */
sl@0: 
sl@0: // System includes
sl@0: //
sl@0: #include <e32base.h>
sl@0: #include <delimitedparser8.h>
sl@0: 
sl@0: 
sl@0: /**
sl@0: Dependencies : TDelimitedParserBase8
sl@0: Comments : Derived class from TDelimitedParserBase providing a class for parsing 
sl@0: paths delimited by a '/' as defined in RFC2396.
sl@0: @publishedAll
sl@0: @released
sl@0: @since 6.0
sl@0: */
sl@0: class TDelimitedPathParser8 : public TDelimitedParserBase8
sl@0: 	{
sl@0: public:	// Methods
sl@0: 
sl@0: 	IMPORT_C TDelimitedPathParser8();
sl@0: 
sl@0: 	IMPORT_C void Parse(const TDesC8& aPath);
sl@0: 
sl@0: 	IMPORT_C void ParseReverse(const TDesC8& aPath);
sl@0: 	};
sl@0: 
sl@0: /**
sl@0: Dependencies : CDelimitedStringBase8
sl@0: Comments : Provides functionality to create a delimited path where components of the 
sl@0: path delimited by '/' as defined in RFC2396.
sl@0: @publishedAll
sl@0: @released
sl@0: @since 6.0
sl@0: */
sl@0: class CDelimitedPath8 : public CDelimitedDataBase8
sl@0: 	{
sl@0: public:	// Methods
sl@0: 
sl@0: /**
sl@0: 	Static factory constructor. Uses two phase construction and leaves nothing
sl@0: 	on the CleanupStack.
sl@0: 	@since			6.0
sl@0: 	@param			aPath	A descriptor with the initial path.
sl@0: 	@return			A pointer to created object.
sl@0: 	@post			Nothing left on the CleanupStack.
sl@0:  */
sl@0: 	IMPORT_C static CDelimitedPath8* NewL(const TDesC8& aPath);
sl@0: 
sl@0: /**
sl@0: 	Static factory constructor. Uses two phase construction and leaves a
sl@0: 	pointer to created object on the CleanupStack.
sl@0: 	@since			6.0
sl@0: 	@param			aPath	A descriptor with the initial path.
sl@0: 	@return			A pointer to created object.
sl@0: 	@post			Pointer to created object left of CleanupStack.
sl@0:  */
sl@0: 	IMPORT_C static CDelimitedPath8* NewLC(const TDesC8& aPath);
sl@0: 
sl@0: /**
sl@0: 	Destructor.
sl@0: 	@since			6.0
sl@0:  */
sl@0: 	IMPORT_C ~CDelimitedPath8();
sl@0: 
sl@0: /**
sl@0: 	Escape encodes the segment then inserts the escaped version in a 
sl@0: 	position before the current parsed segment. The new segment should only contain a
sl@0: 	single path segment, as any path delimiters in the segment will be converted to an
sl@0: 	escape triple. The parser is left in a state where its current segment is the same
sl@0: 	one as before the insertion.
sl@0: 	@since			6.0
sl@0: 	@param			aSegment	A descriptor with the unescaped path segment.
sl@0: 	@pre 			The path must have been initially parsed.
sl@0: 	@post			The path will have been extended to include the new segment. The 
sl@0: 	current segment will remain as the one before the insertion.
sl@0:  */
sl@0: 	IMPORT_C void InsertAndEscapeCurrentL(const TDesC8& aSegment);
sl@0: 
sl@0: /**
sl@0: 	Escape encodes the segment then inserts the escaped version at 
sl@0: 	the front of the path. The new segment should only contain a single path segment, 
sl@0: 	as any path delimiters in the segment will be converted to an escape triple. The 
sl@0: 	parser is left in a state where its current segment is the same one as before 
sl@0: 	the insertion.
sl@0: 	@warning		A re-parse is required to ensure that the parser is valid.
sl@0: 	@since			6.0
sl@0: 	@param			aSegment	A descriptor with the unescaped path segment.
sl@0: 	@pre 			The delimiter must have been set. 
sl@0: 	@post			The path will have been extended to include the new segment.
sl@0:  */
sl@0: 	IMPORT_C void PushAndEscapeFrontL(const TDesC8& aSegment);
sl@0: 
sl@0: /**
sl@0: 	Escape encodes the segment then inserts the escaped version at 
sl@0: 	the back of the path. The new segment should only contain a single path segment, 
sl@0: 	as any path delimiters in the segment will be converted to an escape triple. The 
sl@0: 	parser is left in a state where its current segment is the same one as before 
sl@0: 	the insertion.
sl@0: 	@warning		A re-parse is required to ensure that the parser is valid.
sl@0: 	@since			6.0
sl@0: 	@param			aSegment	A descriptor with the unescaped path segment.
sl@0: 	@pre 			The delimiter must have been set. 
sl@0: 	@post			The path will have been extended to include the new segment.
sl@0:  */
sl@0: 	IMPORT_C void PushAndEscapeBackL(const TDesC8& aSegment);
sl@0: 
sl@0: private:	// Methods
sl@0: 
sl@0: /**
sl@0: 	Constructor. First phase of two-phase construction method. Does
sl@0: 	non-allocating construction.
sl@0: 	@since			6.0
sl@0:  */
sl@0: 	CDelimitedPath8();
sl@0: 
sl@0: /**
sl@0: 	Second phase of two-phase construction method. Does any allocations required
sl@0: 	to fully construct the object.
sl@0: 	@since			6.0
sl@0: 	@param			aPath	A descriptor with the initial path.
sl@0: 	@pre 			First phase of construction is complete.
sl@0: 	@post			The object is fully constructed.
sl@0:  */
sl@0: 	void ConstructL(const TDesC8& aPath);
sl@0: 
sl@0: 	};
sl@0: 
sl@0: #endif	// __DELIMITEDPATH8_H__