|
sl@0
|
1 |
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
2 |
// All rights reserved.
|
|
sl@0
|
3 |
// This component and the accompanying materials are made available
|
|
sl@0
|
4 |
// under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
5 |
// which accompanies this distribution, and is available
|
|
sl@0
|
6 |
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
7 |
//
|
|
sl@0
|
8 |
// Initial Contributors:
|
|
sl@0
|
9 |
// Nokia Corporation - initial contribution.
|
|
sl@0
|
10 |
//
|
|
sl@0
|
11 |
// Contributors:
|
|
sl@0
|
12 |
//
|
|
sl@0
|
13 |
// Description:
|
|
sl@0
|
14 |
//
|
|
sl@0
|
15 |
|
|
sl@0
|
16 |
#ifndef __DELIMITEDPATH8_H__
|
|
sl@0
|
17 |
#define __DELIMITEDPATH8_H__
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
/**
|
|
sl@0
|
20 |
@file DelimitedPath8.h
|
|
sl@0
|
21 |
Comments : This file contains the API definition for the classes
|
|
sl@0
|
22 |
TDelimitedPathParser8 and CDelimitedPath16.
|
|
sl@0
|
23 |
@publishedAll
|
|
sl@0
|
24 |
@released
|
|
sl@0
|
25 |
*/
|
|
sl@0
|
26 |
|
|
sl@0
|
27 |
// System includes
|
|
sl@0
|
28 |
//
|
|
sl@0
|
29 |
#include <e32base.h>
|
|
sl@0
|
30 |
#include <delimitedparser8.h>
|
|
sl@0
|
31 |
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
/**
|
|
sl@0
|
34 |
Dependencies : TDelimitedParserBase8
|
|
sl@0
|
35 |
Comments : Derived class from TDelimitedParserBase providing a class for parsing
|
|
sl@0
|
36 |
paths delimited by a '/' as defined in RFC2396.
|
|
sl@0
|
37 |
@publishedAll
|
|
sl@0
|
38 |
@released
|
|
sl@0
|
39 |
@since 6.0
|
|
sl@0
|
40 |
*/
|
|
sl@0
|
41 |
class TDelimitedPathParser8 : public TDelimitedParserBase8
|
|
sl@0
|
42 |
{
|
|
sl@0
|
43 |
public: // Methods
|
|
sl@0
|
44 |
|
|
sl@0
|
45 |
IMPORT_C TDelimitedPathParser8();
|
|
sl@0
|
46 |
|
|
sl@0
|
47 |
IMPORT_C void Parse(const TDesC8& aPath);
|
|
sl@0
|
48 |
|
|
sl@0
|
49 |
IMPORT_C void ParseReverse(const TDesC8& aPath);
|
|
sl@0
|
50 |
};
|
|
sl@0
|
51 |
|
|
sl@0
|
52 |
/**
|
|
sl@0
|
53 |
Dependencies : CDelimitedStringBase8
|
|
sl@0
|
54 |
Comments : Provides functionality to create a delimited path where components of the
|
|
sl@0
|
55 |
path delimited by '/' as defined in RFC2396.
|
|
sl@0
|
56 |
@publishedAll
|
|
sl@0
|
57 |
@released
|
|
sl@0
|
58 |
@since 6.0
|
|
sl@0
|
59 |
*/
|
|
sl@0
|
60 |
class CDelimitedPath8 : public CDelimitedDataBase8
|
|
sl@0
|
61 |
{
|
|
sl@0
|
62 |
public: // Methods
|
|
sl@0
|
63 |
|
|
sl@0
|
64 |
/**
|
|
sl@0
|
65 |
Static factory constructor. Uses two phase construction and leaves nothing
|
|
sl@0
|
66 |
on the CleanupStack.
|
|
sl@0
|
67 |
@since 6.0
|
|
sl@0
|
68 |
@param aPath A descriptor with the initial path.
|
|
sl@0
|
69 |
@return A pointer to created object.
|
|
sl@0
|
70 |
@post Nothing left on the CleanupStack.
|
|
sl@0
|
71 |
*/
|
|
sl@0
|
72 |
IMPORT_C static CDelimitedPath8* NewL(const TDesC8& aPath);
|
|
sl@0
|
73 |
|
|
sl@0
|
74 |
/**
|
|
sl@0
|
75 |
Static factory constructor. Uses two phase construction and leaves a
|
|
sl@0
|
76 |
pointer to created object on the CleanupStack.
|
|
sl@0
|
77 |
@since 6.0
|
|
sl@0
|
78 |
@param aPath A descriptor with the initial path.
|
|
sl@0
|
79 |
@return A pointer to created object.
|
|
sl@0
|
80 |
@post Pointer to created object left of CleanupStack.
|
|
sl@0
|
81 |
*/
|
|
sl@0
|
82 |
IMPORT_C static CDelimitedPath8* NewLC(const TDesC8& aPath);
|
|
sl@0
|
83 |
|
|
sl@0
|
84 |
/**
|
|
sl@0
|
85 |
Destructor.
|
|
sl@0
|
86 |
@since 6.0
|
|
sl@0
|
87 |
*/
|
|
sl@0
|
88 |
IMPORT_C ~CDelimitedPath8();
|
|
sl@0
|
89 |
|
|
sl@0
|
90 |
/**
|
|
sl@0
|
91 |
Escape encodes the segment then inserts the escaped version in a
|
|
sl@0
|
92 |
position before the current parsed segment. The new segment should only contain a
|
|
sl@0
|
93 |
single path segment, as any path delimiters in the segment will be converted to an
|
|
sl@0
|
94 |
escape triple. The parser is left in a state where its current segment is the same
|
|
sl@0
|
95 |
one as before the insertion.
|
|
sl@0
|
96 |
@since 6.0
|
|
sl@0
|
97 |
@param aSegment A descriptor with the unescaped path segment.
|
|
sl@0
|
98 |
@pre The path must have been initially parsed.
|
|
sl@0
|
99 |
@post The path will have been extended to include the new segment. The
|
|
sl@0
|
100 |
current segment will remain as the one before the insertion.
|
|
sl@0
|
101 |
*/
|
|
sl@0
|
102 |
IMPORT_C void InsertAndEscapeCurrentL(const TDesC8& aSegment);
|
|
sl@0
|
103 |
|
|
sl@0
|
104 |
/**
|
|
sl@0
|
105 |
Escape encodes the segment then inserts the escaped version at
|
|
sl@0
|
106 |
the front of the path. The new segment should only contain a single path segment,
|
|
sl@0
|
107 |
as any path delimiters in the segment will be converted to an escape triple. The
|
|
sl@0
|
108 |
parser is left in a state where its current segment is the same one as before
|
|
sl@0
|
109 |
the insertion.
|
|
sl@0
|
110 |
@warning A re-parse is required to ensure that the parser is valid.
|
|
sl@0
|
111 |
@since 6.0
|
|
sl@0
|
112 |
@param aSegment A descriptor with the unescaped path segment.
|
|
sl@0
|
113 |
@pre The delimiter must have been set.
|
|
sl@0
|
114 |
@post The path will have been extended to include the new segment.
|
|
sl@0
|
115 |
*/
|
|
sl@0
|
116 |
IMPORT_C void PushAndEscapeFrontL(const TDesC8& aSegment);
|
|
sl@0
|
117 |
|
|
sl@0
|
118 |
/**
|
|
sl@0
|
119 |
Escape encodes the segment then inserts the escaped version at
|
|
sl@0
|
120 |
the back of the path. The new segment should only contain a single path segment,
|
|
sl@0
|
121 |
as any path delimiters in the segment will be converted to an escape triple. The
|
|
sl@0
|
122 |
parser is left in a state where its current segment is the same one as before
|
|
sl@0
|
123 |
the insertion.
|
|
sl@0
|
124 |
@warning A re-parse is required to ensure that the parser is valid.
|
|
sl@0
|
125 |
@since 6.0
|
|
sl@0
|
126 |
@param aSegment A descriptor with the unescaped path segment.
|
|
sl@0
|
127 |
@pre The delimiter must have been set.
|
|
sl@0
|
128 |
@post The path will have been extended to include the new segment.
|
|
sl@0
|
129 |
*/
|
|
sl@0
|
130 |
IMPORT_C void PushAndEscapeBackL(const TDesC8& aSegment);
|
|
sl@0
|
131 |
|
|
sl@0
|
132 |
private: // Methods
|
|
sl@0
|
133 |
|
|
sl@0
|
134 |
/**
|
|
sl@0
|
135 |
Constructor. First phase of two-phase construction method. Does
|
|
sl@0
|
136 |
non-allocating construction.
|
|
sl@0
|
137 |
@since 6.0
|
|
sl@0
|
138 |
*/
|
|
sl@0
|
139 |
CDelimitedPath8();
|
|
sl@0
|
140 |
|
|
sl@0
|
141 |
/**
|
|
sl@0
|
142 |
Second phase of two-phase construction method. Does any allocations required
|
|
sl@0
|
143 |
to fully construct the object.
|
|
sl@0
|
144 |
@since 6.0
|
|
sl@0
|
145 |
@param aPath A descriptor with the initial path.
|
|
sl@0
|
146 |
@pre First phase of construction is complete.
|
|
sl@0
|
147 |
@post The object is fully constructed.
|
|
sl@0
|
148 |
*/
|
|
sl@0
|
149 |
void ConstructL(const TDesC8& aPath);
|
|
sl@0
|
150 |
|
|
sl@0
|
151 |
};
|
|
sl@0
|
152 |
|
|
sl@0
|
153 |
#endif // __DELIMITEDPATH8_H__
|