epoc32/include/uriutilscommon.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100 (2010-03-31)
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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
// 
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file UriUtilsCommon.h
williamr@2
    20
 @publishedAll
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
#ifndef __URIUTILSCOMMON_H__
williamr@2
    25
#define __URIUTILSCOMMON_H__
williamr@2
    26
williamr@2
    27
// System includes
williamr@2
    28
//
williamr@2
    29
#include <e32base.h>
williamr@2
    30
williamr@2
    31
/** Error Base value */
williamr@2
    32
const TInt KUriUtilsErrorBase		= -5000;
williamr@2
    33
williamr@2
    34
/**	
williamr@2
    35
enum TUriError
williamr@2
    36
Enum defining the error and panic codes used in the UriUtils components.
williamr@2
    37
@publishedAll
williamr@2
    38
@released
williamr@2
    39
@since 6.0
williamr@2
    40
*/
williamr@2
    41
enum TUriUtilsError
williamr@2
    42
	{
williamr@2
    43
	/** Error specifying the use of an invalid component index */
williamr@2
    44
	KUriUtilsErrBadComponentIndex			= KUriUtilsErrorBase,
williamr@2
    45
	/** Error specifying the use of a base uri path is not absolute and not empty */
williamr@2
    46
	KUriUtilsErrBadBasePath					= KUriUtilsErrorBase - 1,
williamr@2
    47
	/** Error specifying that a buffer is not big enough to append a component and delimiters */
williamr@2
    48
	KUriUtilsErrBufferOverflow				= KUriUtilsErrorBase - 2,
williamr@2
    49
	/** Error specifying the use of an supported parsing mode */
williamr@2
    50
	KUriUtilsErrBadDelimitedParserMode		= KUriUtilsErrorBase - 3,
williamr@2
    51
	/** Error specifying that the delimiting character is not set */
williamr@2
    52
	KUriUtilsErrNoDelimiter					= KUriUtilsErrorBase - 4,
williamr@2
    53
	/** Error specifying that the data has not been parsed */
williamr@2
    54
	KUriUtilsErrNotParsed					= KUriUtilsErrorBase - 5,
williamr@2
    55
	/** Error specifying that a 16-bit character was found in data to be escape encode */
williamr@2
    56
	KUriUtilsErr16BitChar					= KUriUtilsErrorBase - 6,
williamr@2
    57
	/** Error specifying that a badly formed escape triple was found in data being escape decoded */
williamr@2
    58
	KUriUtilsErrBadEscapeTriple				= KUriUtilsErrorBase - 7,
williamr@2
    59
	/** Error specifying that charconv was unable to convert the input data */
williamr@2
    60
	KUriUtilsCannotConvert					= KUriUtilsErrorBase - 8,
williamr@2
    61
	/** Error specifying that there	was empty data */
williamr@2
    62
	KUriUtilsErrEmptyData					= KUriUtilsErrorBase - 9,
williamr@2
    63
	/** Error specifying that there is no character representation of an integer */
williamr@2
    64
	KUriUtilsErrNoIntegerInData			= KUriUtilsErrorBase - 10,
williamr@2
    65
	/** Error code specifying an invalid uri */
williamr@2
    66
	KUriUtilsErrInvalidUri					= KUriUtilsErrorBase - 11,
williamr@2
    67
	/** Error code for unsupported escaping mode */
williamr@2
    68
	KUriUtilsErrBadEscapeMode				= KUriUtilsErrorBase - 12,
williamr@2
    69
	/** Error code for unsupported text whitespace removal mode */
williamr@2
    70
	KUriUtilsErrBadTextRemoveMode			= KUriUtilsErrorBase - 13,
williamr@2
    71
	/**	Quoted string could not be decoded as it is malformed. */
williamr@2
    72
	KUriUtilsErrDecodeMalformedQuotedString	= KUriUtilsErrorBase - 14,
williamr@2
    73
	/** Error code specifying an invalid scheme */
williamr@2
    74
	KUriUtilsErrInvalidScheme				= KUriUtilsErrorBase - 15,
williamr@2
    75
	/** Error code specifying an invalid username and/or password */
williamr@2
    76
	KUriUtilsErrInvalidUserInfo				= KUriUtilsErrorBase - 16,
williamr@2
    77
	/** Error code specifying an invalid host */
williamr@2
    78
	KUriUtilsErrInvalidHost					= KUriUtilsErrorBase - 17,
williamr@2
    79
	/** Error code specifying an invalid port */
williamr@2
    80
	KUriUtilsErrInvalidPort					= KUriUtilsErrorBase - 18,
williamr@2
    81
	/** Error code specifying an invalid path */
williamr@2
    82
	KUriUtilsErrInvalidPath					= KUriUtilsErrorBase - 19,
williamr@2
    83
	/** Error code specifying an invalid sip parameter */
williamr@2
    84
	KUriUtilsErrInvalidParam				= KUriUtilsErrorBase - 20,
williamr@2
    85
	/** Error code specifying an invalid query */
williamr@2
    86
	KUriUtilsErrInvalidQuery				= KUriUtilsErrorBase - 21,
williamr@2
    87
	/** Error code specifying an invalid sip headers */
williamr@2
    88
	KUriUtilsErrInvalidHeaders				= KUriUtilsErrorBase - 22,
williamr@2
    89
	/** Error code specifying an invalid fragment */
williamr@2
    90
	KUriUtilsErrInvalidFragment				= KUriUtilsErrorBase - 23,
williamr@2
    91
	/** Error code specifying that schemes are not equivalent */
williamr@2
    92
	KUriUtilsErrDifferentScheme				= KUriUtilsErrorBase - 24, 
williamr@2
    93
	/** Error code specifying that usernames and passwords are not equivalent */
williamr@2
    94
	KUriUtilsErrDifferentUserInfo			= KUriUtilsErrorBase - 25,
williamr@2
    95
	/** Error code specifying that hosts are not equivalent */
williamr@2
    96
	KUriUtilsErrDifferentHost				= KUriUtilsErrorBase - 26,
williamr@2
    97
	/** Error code specifying that ports are not equivalent */
williamr@2
    98
	KUriUtilsErrDifferentPort				= KUriUtilsErrorBase - 27,
williamr@2
    99
	/** Error code specifying that paths are not equivalent */
williamr@2
   100
	KUriUtilsErrDifferentPath				= KUriUtilsErrorBase - 28,
williamr@2
   101
	/** Error code specifying that queries are not equivalent */
williamr@2
   102
	KUriUtilsErrDifferentQuery				= KUriUtilsErrorBase - 30,
williamr@2
   103
	/** Error code specifying that fragments are not equivalent */
williamr@2
   104
    KUriUtilsErrDifferentFragment			= KUriUtilsErrorBase - 32,
williamr@2
   105
	/** Error code specifying that a non-numeric character was found in data */
williamr@2
   106
    KUriUtilsErrMalformedInteger			= KUriUtilsErrorBase - 33
williamr@2
   107
	};
williamr@2
   108
williamr@2
   109
// Constants
williamr@2
   110
//
williamr@2
   111
/** Scheme Delimiter */
williamr@2
   112
const TInt KSchemeDelimiter		= ':';
williamr@2
   113
/** Userinfo Delimiter */
williamr@2
   114
const TInt KUserinfoDelimiter	= '@';
williamr@2
   115
/** Equals Separator */
williamr@2
   116
const TInt KUserPwdSeparator	= ':';
williamr@2
   117
/** close Brace */
williamr@2
   118
const TInt KEqualsSeparator		= '=';
williamr@2
   119
/** Slash Delimiter */
williamr@2
   120
const TInt KPortDelimiter		= ':';
williamr@2
   121
/** close Brace */
williamr@2
   122
const TInt KSlashDelimiter		= '/';
williamr@2
   123
/** Fragment Delimiter */
williamr@2
   124
const TInt KQueryDelimiter		= '?';
williamr@2
   125
/** close Brace */
williamr@2
   126
const TInt KFragmentDelimiter	= '#';
williamr@2
   127
/** param delimiter */
williamr@2
   128
const TInt KParamDelimiter		= ';';
williamr@2
   129
/** open Brace */
williamr@2
   130
const TInt KIPv6UriOpenBrace	= '[';
williamr@2
   131
/** close Brace */
williamr@2
   132
const TInt KIPv6UriCloseBrace	= ']';
williamr@2
   133
williamr@2
   134
#endif	// __URIUTILSCOMMON_H__