1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/httputils/inc/Uri16.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,228 @@
1.4 +// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// This file contains the API definition for the classes TUriC16 and
1.18 +// CUri16. These classes provide non-modifying (TUriC16) and modifying
1.19 +// (CUri16) functionality for the components of a Uri as described in
1.20 +// RFC2396.
1.21 +//
1.22 +//
1.23 +
1.24 +/**
1.25 + @file Uri16.h
1.26 + @publishedAll
1.27 + @deprecated Deprecated in 9.1
1.28 +*/
1.29 +
1.30 +#ifndef __URI16_H__
1.31 +#define __URI16_H__
1.32 +
1.33 +// System includes
1.34 +//
1.35 +#include <e32base.h>
1.36 +#include <f32file.h>
1.37 +#include <uricommon.h>
1.38 +
1.39 +
1.40 +class TUriC16
1.41 +/**
1.42 + Dependencies : TUriComponent.
1.43 + Comments : Provides non-modifying functionality on the components of a uri object as
1.44 + defined in RFC2396. There are 5 components; scheme, authority, path, query and fragment.
1.45 +
1.46 +The object holds descriptor pointers to the parsed uri components and a descriptor pointer
1.47 +to the uri. It is non-owning. It uses 16-bit descriptors.
1.48 +
1.49 + The functionality provided by this API allows the uri components to be extracted from the
1.50 + parsed uri, checked for their presence in the uri and be compared with those in another
1.51 + TUriC16 object.
1.52 + @publishedAll
1.53 + @deprecated Deprecated in 9.1
1.54 + @since 6.0
1.55 +*/
1.56 + {
1.57 +public: // Methods
1.58 +
1.59 + IMPORT_C HBufC* GetFileNameL() const;
1.60 + IMPORT_C HBufC* GetFileNameL(TUriFileName aType) const;
1.61 + IMPORT_C const TDesC16& Extract(TUriComponent aComponent) const;
1.62 + IMPORT_C void UriWithoutFragment(TPtrC16& aUriNoFrag) const;
1.63 +
1.64 + IMPORT_C TBool IsPresent(TUriComponent aComponent) const;
1.65 + IMPORT_C TBool IsSchemeValid() const;
1.66 +
1.67 + IMPORT_C TInt Compare(const TUriC16& aUri, TUriComponent aComponent) const;
1.68 +
1.69 + IMPORT_C const TDesC16& UriDes() const;
1.70 +
1.71 + IMPORT_C TInt Validate() const;
1.72 + IMPORT_C TInt Equivalent(const TUriC16& aUri) const;
1.73 + IMPORT_C HBufC* DisplayFormL(TUriComponent aComponent = EUriComplete) const;
1.74 +
1.75 +protected: // Methods
1.76 +
1.77 + IMPORT_C TUriC16();
1.78 +
1.79 + void Reset();
1.80 +
1.81 +private: // Methods
1.82 +
1.83 + TInt ValidateL() const;
1.84 + TInt EquivalentL(const TDesC16& aUri) const;
1.85 +
1.86 +protected: // Attributes
1.87 +
1.88 + /** The array of descriptor pointers to the uri components.
1.89 + */
1.90 + TPtrC16 iComponent[EUriMaxComponents];
1.91 +
1.92 + /** The descriptor pointer to the uri.
1.93 + */
1.94 + TPtrC16 iUriDes;
1.95 +
1.96 +/**
1.97 + A friend class.
1.98 + @see CUri16
1.99 + @since 6.0
1.100 + */
1.101 + friend class CUri16;
1.102 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.103 +/**
1.104 + A friend class used for testing.
1.105 + @see TUriC16StateAccessor
1.106 + @since 6.0
1.107 + */
1.108 +#else
1.109 +/**
1.110 + A friend class used for testing.
1.111 + @see TUriC16StateAccessor
1.112 + @since 6.0
1.113 + @internalComponent
1.114 + */
1.115 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
1.116 + friend class TUriC16StateAccessor;
1.117 +
1.118 + };
1.119 +
1.120 +/**
1.121 +Dependencies : TUriC16
1.122 +Comments : Provides functionality to parse a descriptor into the components of a uri as
1.123 +defined in RFC2396. There are 5 components; scheme, authority, path, query and fragment.
1.124 +
1.125 +It uses 16-bit descriptors.
1.126 +
1.127 +Format of a uri is; scheme://authority path?query\#fragment
1.128 +
1.129 +@warning The descriptor that is parsed by an object of this class will be referenced
1.130 +by that object. If the original descriptor is no longer in scope there will be undefined
1.131 +behaviour.
1.132 +@publishedAll
1.133 +@deprecated Deprecated in 9.1. Use UriUtils::CreateUriL() instead
1.134 +@since 6.0
1.135 +*/
1.136 +class TUriParser16 : public TUriC16
1.137 + {
1.138 +public: // Methods
1.139 +
1.140 + IMPORT_C TUriParser16();
1.141 + IMPORT_C TInt Parse(const TDesC16& aUri);
1.142 + };
1.143 +
1.144 +/**
1.145 + Dependencies : CBase, TUriC16.
1.146 + Comments : Provides modifying functionality on the components of a uri object, as
1.147 + defined in RFC2396. There are 5 components; scheme. authority, path, query and fragment.
1.148 +
1.149 + The object holds parsed uri information. It is owning. It uses 16-bit descriptors.
1.150 +
1.151 + The functionality provided by this API allows the uri components to be set or removed
1.152 + from this parsed uri. Also, it provides a reference to TUriC16 object so that the non-modifying
1.153 + functionality can be used.
1.154 + @publishedAll
1.155 + @deprecated Deprecated in 9.1
1.156 + @since 6.0
1.157 +*/
1.158 +class CUri16 : public CBase
1.159 + {
1.160 +public: // Methods
1.161 + IMPORT_C static CUri16* CreateFileUriL(const TDesC& aFullFileName, TUint aFlags = 0);
1.162 + IMPORT_C static CUri16* CreatePrivateFileUriL(const TDesC& aRelativeFileName, TDriveNumber aDrive, TInt aFlags = 0);
1.163 +
1.164 + IMPORT_C static CUri16* NewL(const TUriC16& aUri);
1.165 + IMPORT_C static CUri16* NewLC(const TUriC16& aUri);
1.166 + IMPORT_C static CUri16* NewL();
1.167 + IMPORT_C static CUri16* NewLC();
1.168 +
1.169 + IMPORT_C static CUri16* ResolveL(const TUriC16& aBaseUri, const TUriC16& aRefUri);
1.170 +
1.171 + IMPORT_C ~CUri16();
1.172 + IMPORT_C const TUriC16& Uri() const;
1.173 + IMPORT_C void SetComponentL(const TDesC16& aData, TUriComponent aComponent);
1.174 + IMPORT_C void RemoveComponentL(TUriComponent aComponent);
1.175 +
1.176 +private: // Methods
1.177 +
1.178 + CUri16(const TUriC16& aNewUri);
1.179 + void ConstructL();
1.180 + void FormUriL();
1.181 + void InitializeFileUriComponentsL(const TDesC& aFileName, TDriveNumber aDrive, TUint aFlags);
1.182 +
1.183 +private: // Attributes
1.184 +
1.185 + /** The descriptor buffer that contains the uri.
1.186 + */
1.187 + HBufC16* iUriBuf;
1.188 +
1.189 + /** The parsed uri object.
1.190 + */
1.191 + TUriC16 iUri;
1.192 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.193 +/**
1.194 + A friend class used for testing.
1.195 + @see TUri16StateAccessor
1.196 + @since 6.0
1.197 + */
1.198 +#else
1.199 +/**
1.200 + A friend class used for testing.
1.201 + @see TUri16StateAccessor
1.202 + @since 6.0
1.203 + @internalComponent
1.204 + */
1.205 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
1.206 + friend class TUri16StateAccessor;
1.207 +
1.208 + };
1.209 +
1.210 +/**
1.211 +Do not use. Use TUriC8 instead
1.212 +@publishedAll
1.213 +@deprecated Deprecated in 9.1
1.214 + */
1.215 +typedef TUriC16 TUriC;
1.216 +
1.217 +/**
1.218 +Do not use. Use TUriParser8 instead
1.219 +@publishedAll
1.220 +@deprecated Deprecated in 9.1
1.221 + */
1.222 +typedef TUriParser16 TUriParser;
1.223 +
1.224 +/**
1.225 +Do not use. Use CUri8 instead
1.226 +@publishedAll
1.227 +@deprecated Deprecated in 9.1
1.228 + */
1.229 +typedef CUri16 CUri;
1.230 +
1.231 +#endif // __URI16_H__