1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/genericservices/httputils/inc/DelimitedParser8.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,215 @@
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 TDelimitedParserBase8
1.18 +// and CDelimitedData8.
1.19 +//
1.20 +//
1.21 +
1.22 +/**
1.23 + @file DelimitedParser8.h
1.24 + @publishedAll
1.25 + @released
1.26 +*/
1.27 +
1.28 +#ifndef __DELIMITEDPARSER8_H__
1.29 +#define __DELIMITEDPARSER8_H__
1.30 +
1.31 +// System includes
1.32 +//
1.33 +#include <e32base.h>
1.34 +#include <delimitedparsercommon.h>
1.35 +
1.36 +
1.37 +/**
1.38 +Comments : Provides non-modifying functionality for parsing data delimited by
1.39 +a single character. The data is delimited into segments. Uses 8-bit descriptors.
1.40 +
1.41 +The object contains a descriptor with the data which can be parsed from left
1.42 +to right, or right to left. It is non-owning. The current segment can be extracted,
1.43 +which then parses the string for the next segment.
1.44 +
1.45 +This is a base class and an object of this type cannot be instantiated. It should
1.46 +be derived. The derived class should ensure that the data iDataDes is set before
1.47 +calling one of the protected parsing functions. The derived class should also ensure
1.48 +that the delimiting character has been set.
1.49 +
1.50 +If the data iDataDes has not been parsed, then calling any functionality that
1.51 +requires the data to have been parsed will result in a panic
1.52 +KDelimitedParserErrNotParsed. The data can only be parsed by calling one of the
1.53 +protected parsing functions from the derived class.
1.54 +
1.55 +If the delimiting character iDelimiter has not been set, then calling the protected
1.56 +parsing functions and some of the other public functionality that requires the
1.57 +delimiter to be set will result in a panic KDelimitingParserErrNoDelimiter.
1.58 +@publishedAll
1.59 +@released
1.60 +@since 6.0
1.61 +*/
1.62 +class TDelimitedParserBase8
1.63 + {
1.64 +public: // Methods
1.65 +
1.66 + IMPORT_C void Reset() const;
1.67 +
1.68 + IMPORT_C TInt GetNext(TPtrC8& aSegment) const;
1.69 +
1.70 + IMPORT_C TInt Inc() const;
1.71 +
1.72 + IMPORT_C TInt Dec() const;
1.73 +
1.74 + IMPORT_C TInt Peek(TPtrC8& aSegment) const;
1.75 +
1.76 + IMPORT_C TBool Eos() const;
1.77 +
1.78 + IMPORT_C TBool FrontDelimiter() const;
1.79 +
1.80 + IMPORT_C TBool BackDelimiter() const;
1.81 +
1.82 + IMPORT_C const TDesC8& Des() const;
1.83 +
1.84 + IMPORT_C TInt Remainder(TPtrC8& aRemainder) const;
1.85 +
1.86 +protected: // Methods
1.87 +
1.88 + IMPORT_C TDelimitedParserBase8();
1.89 +
1.90 + IMPORT_C void Parse(const TDesC8& aData);
1.91 +
1.92 + IMPORT_C void ParseReverse(const TDesC8& aData);
1.93 +
1.94 + IMPORT_C void SetDelimiter(TChar aDelimiter);
1.95 +
1.96 +private: // Methods
1.97 +
1.98 + void DoParse(const TDesC8& aData);
1.99 +
1.100 + TInt FindNextSegment(TInt aStartPos) const;
1.101 +
1.102 + TInt FindPrevSegment(TInt aStartPos) const;
1.103 +
1.104 +private: // Attributes
1.105 +
1.106 + /** Descriptor with the string
1.107 + */
1.108 + TPtrC8 iDataDes;
1.109 +
1.110 + /** Descriptor with the current segment.
1.111 + */
1.112 + mutable TPtrC8 iCurrentSegment;
1.113 +
1.114 + /** Position of next segment.
1.115 + */
1.116 + mutable TInt iNextSegmentPos;
1.117 +
1.118 + /** Direction of parsing.
1.119 + */
1.120 + TDelimitedDataParseMode iMode;
1.121 +
1.122 + /** Delimiting character
1.123 + */
1.124 + TInt iDelimiter;
1.125 +
1.126 +/**
1.127 + A friend class.
1.128 + @see CDelimitedDataBase8
1.129 + @since 6.0
1.130 + */
1.131 + friend class CDelimitedDataBase8;
1.132 +
1.133 + };
1.134 +
1.135 +/**
1.136 +Dependencies : CBase, TDelimitedParserBase8
1.137 +Comments : Provides functionality for creating and editing a delimited data object.
1.138 +Uses 8-bit descriptors
1.139 +
1.140 +The object contains a descriptor buffer with the data. Functionality is provided
1.141 +to allow segments to be added or removed from the data. There is access to the
1.142 +internal delimited data parser to provide parsing functionality to be excercised
1.143 +on the created data.
1.144 +
1.145 +This a base class that cannot be instantiated. It should be derived. The derived
1.146 +class must set the delimited data parser, which is an object derived from
1.147 +TDelimitedParserBase. This helper class must set the delimiting object
1.148 +
1.149 +If the delimiting character has not been set, then calling any of the functionality
1.150 +will cause a panic KDelimitedParserErrNoDelimiter.
1.151 +@publishedAll
1.152 +@released
1.153 +@since 6.0
1.154 +*/
1.155 +class CDelimitedDataBase8 : public CBase
1.156 + {
1.157 +public: // Methods
1.158 +
1.159 + IMPORT_C ~CDelimitedDataBase8();
1.160 +
1.161 + IMPORT_C void InsertCurrentL(const TDesC8& aSegment);
1.162 +
1.163 + IMPORT_C void RemoveCurrentL();
1.164 +
1.165 + IMPORT_C void PushBackL(const TDesC8& aSegment);
1.166 +
1.167 + IMPORT_C void PopBackL();
1.168 +
1.169 + IMPORT_C void PushFrontL(const TDesC8& aSegment);
1.170 +
1.171 + IMPORT_C void PopFrontL();
1.172 +
1.173 + IMPORT_C void TrimFrontDelimiterL();
1.174 +
1.175 + IMPORT_C void AddFrontDelimiterL();
1.176 +
1.177 + IMPORT_C void TrimBackDelimiterL();
1.178 +
1.179 + IMPORT_C void AddBackDelimiterL();
1.180 +
1.181 + IMPORT_C void Parse();
1.182 +
1.183 + IMPORT_C void ParseReverse();
1.184 +
1.185 + IMPORT_C const TDelimitedParserBase8& Parser() const;
1.186 +
1.187 +protected: // Methods
1.188 +
1.189 + IMPORT_C CDelimitedDataBase8();
1.190 +
1.191 + IMPORT_C void ConstructL(const TDesC8& aData);
1.192 +
1.193 + IMPORT_C void SetDelimiter(TChar aDelimiter);
1.194 +
1.195 +private: // Methods
1.196 +
1.197 +
1.198 + void SetDataL(const TDesC8& aData);
1.199 +
1.200 + void SetData(HBufC8* aDataBuf);
1.201 +
1.202 + void DoInsertL(const TDesC8& aSegment);
1.203 +
1.204 + void DoRemoveL();
1.205 +
1.206 +private: // Attributes
1.207 +
1.208 + /** Descriptor buffer.
1.209 + */
1.210 + HBufC8* iDataBuf;
1.211 +
1.212 + /** Parser object
1.213 + */
1.214 + TDelimitedParserBase8 iParser;
1.215 +
1.216 + };
1.217 +
1.218 +#endif // __DELIMITEDPARSER8_H__