1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/httputils/inc/Uri8.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,208 @@
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 TUriC8 and
1.18 +// CUri8. These classes provide non-modifying (TUriC8) and modifying
1.19 +// (CUri8) functionality for the components of a Uri as described in
1.20 +// RFC2396.
1.21 +//
1.22 +//
1.23 +
1.24 +/**
1.25 + @file Uri8.h
1.26 + @publishedAll
1.27 + @released
1.28 +*/
1.29 +
1.30 +#ifndef __URI8_H__
1.31 +#define __URI8_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 +/**
1.41 +Dependencies : TUriComponent.
1.42 +Comments : Provides non-modifying functionality on the components of a uri object as
1.43 +defined in RFC2396. There are 5 components; scheme, authority, path, query and fragment.
1.44 +
1.45 +The object holds descriptor pointers to the parsed uri components and a descriptor pointer
1.46 +to the uri. It is non-owning. It uses 8-bit descriptors.
1.47 +
1.48 +The functionality provided by this API allows the uri components to be extracted from the
1.49 +parsed uri, checked for their presence in the uri and be compared with those in another
1.50 +TUriC8 object.
1.51 +@publishedAll
1.52 +@released
1.53 +@since 6.0
1.54 +*/
1.55 +class TUriC8
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 +
1.62 + IMPORT_C const TDesC8& Extract(TUriComponent aComponent) const;
1.63 + IMPORT_C void UriWithoutFragment(TPtrC8& aUriNoFrag) const;
1.64 +
1.65 + IMPORT_C TBool IsPresent(TUriComponent aComponent) const;
1.66 + IMPORT_C TBool IsSchemeValid() const;
1.67 + IMPORT_C TInt Compare(const TUriC8& aUri, TUriComponent aComponent) const;
1.68 +
1.69 + IMPORT_C const TDesC8& UriDes() const;
1.70 +
1.71 + IMPORT_C TInt Validate() const;
1.72 + IMPORT_C TInt Equivalent(const TUriC8& aUri) const;
1.73 + IMPORT_C HBufC* DisplayFormL(TUriComponent aComponent = EUriComplete) const;
1.74 +
1.75 +protected: // Methods
1.76 +
1.77 + IMPORT_C TUriC8();
1.78 + void Reset();
1.79 +
1.80 +protected: // Attributes
1.81 +
1.82 + /** The array of descriptor pointers to the uri components.
1.83 + */
1.84 + TPtrC8 iComponent[EUriMaxComponents];
1.85 +
1.86 + /** The descriptor pointer to the uri.
1.87 + */
1.88 + TPtrC8 iUriDes;
1.89 +
1.90 +/**
1.91 + A friend class.
1.92 + @see CUri8
1.93 + @since 6.0
1.94 + */
1.95 + friend class CUri8;
1.96 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.97 +/**
1.98 + A friend class used for testing.
1.99 + @see TUriC8StateAccessor
1.100 + @since 6.0
1.101 + */
1.102 +#else
1.103 +/**
1.104 + A friend class used for testing.
1.105 + @see TUriC8StateAccessor
1.106 + @since 6.0
1.107 + @internalComponent
1.108 + */
1.109 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
1.110 + friend class TUriC8StateAccessor;
1.111 +
1.112 + };
1.113 +
1.114 +/**
1.115 +Dependencies : TUriC8
1.116 +Comments : Provides functionality to parse a descriptor into the components of a uri as
1.117 +defined in RFC2396. There are 5 components; scheme, authority, path, query and fragment.
1.118 +
1.119 +It uses 8-bit descriptors.
1.120 +
1.121 +Format of a uri is; scheme://authority path?query\#fragment
1.122 +
1.123 +@warning The descriptor that is parsed by an object of this class will be referenced
1.124 +by that object. If the original descriptor is no longer in scope there will be undefined
1.125 +behaviour.
1.126 +@publishedAll
1.127 +@released
1.128 +@since 6.0
1.129 +*/
1.130 +class TUriParser8 : public TUriC8
1.131 + {
1.132 +public: // Methods
1.133 +
1.134 + IMPORT_C TUriParser8();
1.135 +
1.136 + IMPORT_C TInt Parse(const TDesC8& aUri);
1.137 +
1.138 +private: // Methods
1.139 + void RetrieveScheme(const TPtrC8& aUri, TPtrC8& aScheme);
1.140 + };
1.141 +
1.142 +class CUri8 : public CBase
1.143 +/**
1.144 +Dependencies : CBase, TUriC8.
1.145 +Comments : Provides modifying functionality on the components of a uri object, as
1.146 +defined in RFC2396. There are 5 components; scheme. authority, path, query and fragment.
1.147 +
1.148 +The object holds parsed uri information. It is owning. It uses 8-bit descriptors.
1.149 +
1.150 +The functionality provided by this API allows the uri components to be set or removed
1.151 +from this parsed uri. Also, it provides a reference to TUriC8 object so that the non-modifying
1.152 +functionality can be used.
1.153 +@publishedAll
1.154 +@released
1.155 +@since 6.0
1.156 +*/
1.157 + {
1.158 +public: // Methods
1.159 +
1.160 + IMPORT_C static CUri8* CreateFileUriL(const TDesC& aFullFileName, TUint aFlags = 0);
1.161 + IMPORT_C static CUri8* CreatePrivateFileUriL(const TDesC& aRelativeFileName, TDriveNumber aDrive, TInt aFlags = 0);
1.162 +
1.163 + IMPORT_C static CUri8* NewL(const TUriC8& aUri);
1.164 + IMPORT_C static CUri8* NewLC(const TUriC8& aUri);
1.165 + IMPORT_C static CUri8* NewL();
1.166 + IMPORT_C static CUri8* NewLC();
1.167 +
1.168 + IMPORT_C static CUri8* ResolveL(const TUriC8& aBaseUri, const TUriC8& aRefUri);
1.169 +
1.170 + IMPORT_C ~CUri8();
1.171 +
1.172 + IMPORT_C const TUriC8& Uri() const;
1.173 + IMPORT_C void SetComponentL(const TDesC8& aData, TUriComponent aComponent);
1.174 + IMPORT_C void RemoveComponentL(TUriComponent aComponent);
1.175 +
1.176 +private: // Methods
1.177 +
1.178 + CUri8(const TUriC8& 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 + HBufC8* iUriBuf;
1.188 +
1.189 + /** The parsed uri object.
1.190 + */
1.191 + TUriC8 iUri;
1.192 +
1.193 +#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
1.194 +/**
1.195 + A friend class used for testing.
1.196 + @see TUri8StateAccessor
1.197 + @since 6.0
1.198 + */
1.199 +#else
1.200 +/**
1.201 + A friend class used for testing.
1.202 + @see TUri8StateAccessor
1.203 + @since 6.0
1.204 + @internalComponent
1.205 + */
1.206 +#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
1.207 + friend class TUri8StateAccessor;
1.208 +
1.209 + };
1.210 +
1.211 +#endif // __URI8_H__