epoc32/include/uri16.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// This file contains the API definition for the classes TUriC16 and 
williamr@2
    15
// CUri16. These classes provide non-modifying (TUriC16) and modifying
williamr@2
    16
// (CUri16) functionality for the components of a Uri as described in 
williamr@2
    17
// RFC2396.
williamr@2
    18
// 
williamr@2
    19
//
williamr@2
    20
williamr@2
    21
williamr@2
    22
williamr@2
    23
/**
williamr@2
    24
 @file Uri16.h
williamr@2
    25
 @publishedAll
williamr@2
    26
 @deprecated Deprecated in 9.1
williamr@2
    27
*/
williamr@2
    28
williamr@2
    29
#ifndef __URI16_H__
williamr@2
    30
#define __URI16_H__
williamr@2
    31
williamr@2
    32
// System includes
williamr@2
    33
//
williamr@2
    34
#include <e32base.h>
williamr@2
    35
#include <f32file.h> 
williamr@2
    36
#include <uricommon.h>
williamr@2
    37
williamr@2
    38
williamr@2
    39
class TUriC16
williamr@2
    40
/**
williamr@2
    41
	Dependencies : TUriComponent.
williamr@2
    42
	Comments : Provides non-modifying functionality on the components of a uri object as
williamr@2
    43
	defined in RFC2396. There are 5 components; scheme, authority, path, query and fragment.
williamr@2
    44
williamr@2
    45
The	object holds descriptor pointers to the parsed uri components and a descriptor pointer 
williamr@2
    46
to the uri. It is non-owning. It uses 16-bit descriptors.
williamr@2
    47
williamr@2
    48
	The functionality provided by this API allows the uri components to be extracted from the 
williamr@2
    49
	parsed uri, checked for their presence in the uri and be compared with those in another 
williamr@2
    50
	TUriC16 object.
williamr@2
    51
	@publishedAll
williamr@2
    52
	@deprecated Deprecated in 9.1
williamr@2
    53
	@since 6.0
williamr@2
    54
*/
williamr@2
    55
	{
williamr@2
    56
public:	// Methods
williamr@2
    57
williamr@2
    58
	IMPORT_C HBufC* GetFileNameL() const;
williamr@2
    59
	IMPORT_C HBufC* GetFileNameL(TUriFileName aType) const;
williamr@2
    60
	IMPORT_C const TDesC16& Extract(TUriComponent aComponent) const;
williamr@2
    61
	IMPORT_C void UriWithoutFragment(TPtrC16& aUriNoFrag) const;
williamr@2
    62
williamr@2
    63
	IMPORT_C TBool IsPresent(TUriComponent aComponent) const;
williamr@2
    64
	IMPORT_C TBool IsSchemeValid() const;
williamr@2
    65
williamr@2
    66
	IMPORT_C TInt Compare(const TUriC16& aUri, TUriComponent aComponent) const;
williamr@2
    67
williamr@2
    68
	IMPORT_C const TDesC16& UriDes() const;
williamr@2
    69
williamr@2
    70
	IMPORT_C TInt Validate() const;
williamr@2
    71
	IMPORT_C TInt Equivalent(const TUriC16& aUri) const;
williamr@2
    72
	IMPORT_C HBufC* DisplayFormL(TUriComponent aComponent = EUriComplete) const;
williamr@2
    73
williamr@2
    74
protected:	// Methods
williamr@2
    75
williamr@2
    76
	IMPORT_C TUriC16();
williamr@2
    77
williamr@2
    78
	void Reset();
williamr@2
    79
	
williamr@2
    80
private:	// Methods
williamr@2
    81
	
williamr@2
    82
	TInt ValidateL() const;
williamr@2
    83
	TInt EquivalentL(const TDesC16& aUri) const;
williamr@2
    84
williamr@2
    85
protected:	// Attributes
williamr@2
    86
williamr@2
    87
	/** The array of descriptor pointers to the uri components.
williamr@2
    88
	 */
williamr@2
    89
	TPtrC16		iComponent[EUriMaxComponents];
williamr@2
    90
williamr@2
    91
	/** The descriptor pointer to the uri.
williamr@2
    92
	 */
williamr@2
    93
	TPtrC16		iUriDes;
williamr@2
    94
williamr@2
    95
/**
williamr@2
    96
	A friend class.
williamr@2
    97
	@see		CUri16 
williamr@2
    98
	@since		6.0
williamr@2
    99
 */
williamr@2
   100
	friend class CUri16;
williamr@2
   101
williamr@2
   102
/**
williamr@2
   103
	A friend class used for testing.
williamr@2
   104
	@see		TUriC16StateAccessor
williamr@2
   105
	@since		6.0
williamr@2
   106
	@internalComponent
williamr@2
   107
 */
williamr@2
   108
	friend class TUriC16StateAccessor;
williamr@2
   109
williamr@2
   110
	};
williamr@2
   111
williamr@2
   112
/**
williamr@2
   113
Dependencies : TUriC16
williamr@2
   114
Comments : Provides functionality to parse a descriptor into the components of a uri as 
williamr@2
   115
defined in RFC2396. There are 5 components; scheme, authority, path, query and fragment.
williamr@2
   116
williamr@2
   117
It uses 16-bit descriptors.
williamr@2
   118
williamr@2
   119
Format of a uri is; scheme://authority path?query\#fragment
williamr@2
   120
williamr@2
   121
@warning The descriptor that is parsed by an object of this class will be referenced 
williamr@2
   122
by that object. If the original descriptor is no longer in scope there will be undefined 
williamr@2
   123
behaviour.
williamr@2
   124
@publishedAll
williamr@2
   125
@deprecated Deprecated in 9.1. Use UriUtils::CreateUriL() instead
williamr@2
   126
@since 6.0
williamr@2
   127
*/
williamr@2
   128
class TUriParser16 : public TUriC16
williamr@2
   129
	{
williamr@2
   130
public:	// Methods
williamr@2
   131
williamr@2
   132
	IMPORT_C TUriParser16();
williamr@2
   133
	IMPORT_C TInt Parse(const TDesC16& aUri);
williamr@2
   134
	};
williamr@2
   135
williamr@2
   136
/**
williamr@2
   137
	Dependencies : CBase, TUriC16.
williamr@2
   138
	Comments : Provides modifying functionality on the components of a uri object, as
williamr@2
   139
	defined in RFC2396. There are 5 components; scheme. authority, path, query and fragment.
williamr@2
   140
williamr@2
   141
	The	object holds parsed uri information. It is owning. It uses 16-bit descriptors.
williamr@2
   142
williamr@2
   143
	The functionality provided by this API allows the uri components to be set or removed 
williamr@2
   144
	from this parsed uri. Also, it provides a reference to TUriC16 object so that the non-modifying 
williamr@2
   145
	functionality can be used.
williamr@2
   146
	@publishedAll
williamr@2
   147
	@deprecated Deprecated in 9.1
williamr@2
   148
	@since 6.0
williamr@2
   149
*/
williamr@2
   150
class CUri16 : public CBase
williamr@2
   151
	{
williamr@2
   152
public: // Methods
williamr@2
   153
	IMPORT_C static CUri16* CreateFileUriL(const TDesC& aFullFileName, TUint aFlags = 0);
williamr@2
   154
	IMPORT_C static CUri16* CreatePrivateFileUriL(const TDesC& aRelativeFileName, TDriveNumber aDrive, TInt aFlags = 0);
williamr@2
   155
williamr@2
   156
	IMPORT_C static CUri16* NewL(const TUriC16& aUri);
williamr@2
   157
	IMPORT_C static CUri16* NewLC(const TUriC16& aUri);
williamr@2
   158
	IMPORT_C static CUri16* NewL();
williamr@2
   159
	IMPORT_C static CUri16* NewLC();
williamr@2
   160
williamr@2
   161
	IMPORT_C static CUri16* ResolveL(const TUriC16& aBaseUri, const TUriC16& aRefUri);
williamr@2
   162
williamr@2
   163
	IMPORT_C ~CUri16();
williamr@2
   164
	IMPORT_C const TUriC16& Uri() const;
williamr@2
   165
	IMPORT_C void SetComponentL(const TDesC16& aData, TUriComponent aComponent);
williamr@2
   166
	IMPORT_C void RemoveComponentL(TUriComponent aComponent);
williamr@2
   167
williamr@2
   168
private:	// Methods
williamr@2
   169
williamr@2
   170
	CUri16(const TUriC16& aNewUri);
williamr@2
   171
	void ConstructL();
williamr@2
   172
	void FormUriL();
williamr@2
   173
	void InitializeFileUriComponentsL(const TDesC& aFileName, TDriveNumber aDrive, TUint aFlags);
williamr@2
   174
williamr@2
   175
private:	// Attributes
williamr@2
   176
williamr@2
   177
	/** The descriptor buffer that contains the uri.
williamr@2
   178
	 */
williamr@2
   179
	HBufC16*	iUriBuf;
williamr@2
   180
williamr@2
   181
	/** The parsed uri object.
williamr@2
   182
	 */
williamr@2
   183
	TUriC16	iUri;
williamr@2
   184
williamr@2
   185
/**
williamr@2
   186
	A friend class used for testing.
williamr@2
   187
	@see		TUri16StateAccessor
williamr@2
   188
	@since		6.0
williamr@2
   189
	@internalComponent
williamr@2
   190
 */
williamr@2
   191
	friend class TUri16StateAccessor;
williamr@2
   192
williamr@2
   193
	};
williamr@2
   194
williamr@2
   195
/** 	
williamr@2
   196
Do not use. Use TUriC8 instead
williamr@2
   197
@publishedAll
williamr@2
   198
@deprecated Deprecated in 9.1 
williamr@2
   199
 */
williamr@2
   200
typedef TUriC16			TUriC;
williamr@2
   201
williamr@2
   202
/** 
williamr@2
   203
Do not use. Use TUriParser8 instead
williamr@2
   204
@publishedAll
williamr@2
   205
@deprecated Deprecated in 9.1 
williamr@2
   206
 */
williamr@2
   207
typedef TUriParser16	TUriParser;
williamr@2
   208
williamr@2
   209
/** 
williamr@2
   210
Do not use. Use CUri8 instead
williamr@2
   211
@publishedAll
williamr@2
   212
@deprecated Deprecated in 9.1 
williamr@2
   213
 */
williamr@2
   214
typedef CUri16			CUri;
williamr@2
   215
williamr@2
   216
#endif	// __URI16_H__