1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/BAMATCH.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,253 @@
1.4 +// Copyright (c) 2003-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 +// Incremental matcher class
1.18 +//
1.19 +//
1.20 +
1.21 +#if !defined (__BAMATCH_H__)
1.22 +#define __BAMATCH_H__
1.23 +
1.24 +#if !defined(__E32STD_H__)
1.25 +#include <e32std.h>
1.26 +#endif
1.27 +
1.28 +#if !defined(__E32BASE_H__)
1.29 +#include <e32base.h>
1.30 +#endif
1.31 +
1.32 +#if !defined(__BAMDESCA_H__)
1.33 +#include <bamdesca.h>
1.34 +#endif
1.35 +
1.36 +
1.37 +class RTextBuf
1.38 +/** A simple class that encapsulates a text string.
1.39 +
1.40 +As with the descriptor classes, the class sets a maximum length for the encapsulated
1.41 +string, which cannot be exceeded. The class might be preferred to a descriptor
1.42 +in some circumstances as its maximum length can be increased (unlike a TBuf),
1.43 +and it can be created on the stack (unlike an HBufC) .
1.44 +@publishedAll
1.45 +@released
1.46 +*/
1.47 + {
1.48 +public:
1.49 + IMPORT_C RTextBuf();
1.50 + IMPORT_C ~RTextBuf();
1.51 +public:
1.52 + inline TPtr& Text();
1.53 + inline const TPtr& Text() const;
1.54 + inline TInt MaxLength() const;
1.55 + inline void SetText(const TDesC &aDes);
1.56 + IMPORT_C void SetMaxLengthL(TInt aMaxLength);
1.57 + IMPORT_C void Close();
1.58 +private:
1.59 + TPtr iPtr;
1.60 + TText* iText;
1.61 + };
1.62 +
1.63 +
1.64 +
1.65 +class RIncrMatcherBase
1.66 +/** Base class for incremental matcher classes.
1.67 +
1.68 +An incremental matcher compares two text buffers from left-to-right. For example,
1.69 +the match between "garage" and "gander" is "ga".
1.70 +
1.71 +The class provides the interface for getting and setting the text to be matched
1.72 +against, and for performing match tests. Each type of match test is available
1.73 +in three versions, one using binary comparison, one using locale collation
1.74 +rules (comparison of strings to produce a dictionary-like ('lexicographic')
1.75 +ordering, e.g. ignoring punctuation), and one using locale folding rules (e.g.
1.76 +ignoring case).
1.77 +
1.78 +"bafl.lib"
1.79 +@since 5.0
1.80 +@publishedAll
1.81 +@released
1.82 +*/
1.83 + {
1.84 +public:
1.85 + IMPORT_C virtual ~RIncrMatcherBase();
1.86 +protected:
1.87 + /** Default constructor. */
1.88 + inline RIncrMatcherBase() {}
1.89 +protected:
1.90 + /** Gets the match text.
1.91 +
1.92 + @return Match text */
1.93 + virtual TDes& MatchDes()=0;
1.94 +
1.95 + /** Gets the match text.
1.96 +
1.97 + @return Match text */
1.98 + virtual const TDes& MatchDes() const=0;
1.99 +public:
1.100 + inline TInt MaxLength() const;
1.101 + inline TInt MatchLength() const;
1.102 + inline TPtrC MatchText() const;
1.103 +//
1.104 + inline void Clear();
1.105 + IMPORT_C void DeleteLastChar();
1.106 + IMPORT_C void AppendChar(TChar aLetter);
1.107 + inline void SetMatchText(const TDesC& aText);
1.108 +//
1.109 + IMPORT_C void SetBestMatch(const TDesC& aBuf);
1.110 + IMPORT_C void SetBestMatchC(const TDesC& aBuf);
1.111 + IMPORT_C void SetBestMatchF(const TDesC& aBuf);
1.112 + IMPORT_C TBool IsMatch(const TDesC& aBuf) const;
1.113 + IMPORT_C TBool IsMatchC(const TDesC& aBuf) const;
1.114 + IMPORT_C TBool IsMatchF(const TDesC& aBuf) const;
1.115 + IMPORT_C TInt FirstMatchingIndex(TInt& aResult,const MDesCArray& aDesArray,TInt aStartIndex=0) const;
1.116 + IMPORT_C TInt FirstMatchingIndexC(TInt& aResult,const MDesCArray& aDesArray,TInt aStartIndex=0) const;
1.117 + IMPORT_C TInt FirstMatchingIndexF(TInt& aResult,const MDesCArray& aDesArray,TInt aStartIndex=0) const;
1.118 +private:
1.119 + typedef TInt (*TCompareFunc)(const TText*,TInt,const TText*,TInt);
1.120 + TBool DoIsMatch(const TDesC& aQuery,TCompareFunc aCompare) const;
1.121 + TInt DoFirstMatchingIndex(TInt& aIndex,const MDesCArray& aDesArray,TCompareFunc aCompare) const;
1.122 + void DoSetBestMatch(const TDesC& aBuf,TCompareFunc aCompare);
1.123 + };
1.124 +
1.125 +
1.126 +class RIncrMatcherPtr : public RIncrMatcherBase
1.127 +/** Incrementally matches text against a descriptor, accessed via a pointer.
1.128 +
1.129 +The class does not take a copy of the text to match against, but only stores
1.130 +the pointer.
1.131 +@publishedAll
1.132 +@released
1.133 +*/
1.134 + {
1.135 +public:
1.136 + IMPORT_C RIncrMatcherPtr();
1.137 + IMPORT_C RIncrMatcherPtr(TDes& aDes);
1.138 + IMPORT_C virtual ~RIncrMatcherPtr();
1.139 +public:
1.140 + inline void SetMatcherPtr(TDes& aDes);
1.141 +protected:
1.142 + IMPORT_C TDes& MatchDes();
1.143 + IMPORT_C const TDes& MatchDes() const;
1.144 +private:
1.145 + TDes* iDesPtr;
1.146 + };
1.147 +
1.148 +
1.149 +class RIncrMatcherTextBuf : public RIncrMatcherBase
1.150 +/** Incrementally matches text against a text buffer with variable maximum
1.151 +length.
1.152 +@publishedAll
1.153 +@released
1.154 +*/
1.155 + {
1.156 +public:
1.157 + IMPORT_C RIncrMatcherTextBuf();
1.158 + IMPORT_C virtual ~RIncrMatcherTextBuf();
1.159 + inline void SetMatcherLengthL(TInt aMaxLength);
1.160 +protected:
1.161 + IMPORT_C TDes& MatchDes();
1.162 + IMPORT_C const TDes& MatchDes() const;
1.163 +private:
1.164 + RTextBuf iTextBuf;
1.165 + };
1.166 +
1.167 +template <TInt aMaximumSize>
1.168 +class RIncrMatcherBuf : public RIncrMatcherBase
1.169 +/**
1.170 +Incrementally matches text against a modifiable descriptor buffer.
1.171 +Set aMaximumSize to be the maximum size of this buffer.
1.172 +@publishedAll
1.173 +@released
1.174 +*/
1.175 + {
1.176 +public:
1.177 + /** Default constructor. */
1.178 + RIncrMatcherBuf() {}
1.179 +protected:
1.180 +
1.181 + /** Gets the match text.
1.182 +
1.183 + @return Match text (non const) */
1.184 + inline TDes& MatchDes() {return(iMatchBuf);}
1.185 +
1.186 + /** Gets the match text.
1.187 +
1.188 + @return Match text (const)*/
1.189 + inline const TDes& MatchDes() const {return(iMatchBuf);}
1.190 +
1.191 + /** Copy constructor.
1.192 +
1.193 + @param aMatcher RIncrMatcherBuf to copy */
1.194 + inline RIncrMatcherBuf(const RIncrMatcherBuf& aMatcher) {iMatchBuf=aMatcher.iMatchBuf;}
1.195 +private:
1.196 + TBuf<aMaximumSize> iMatchBuf;
1.197 + };
1.198 +
1.199 +inline TPtr& RTextBuf::Text()
1.200 +/** Gets the text as a descriptor.
1.201 +
1.202 +@return Match text descriptor (non const) */
1.203 + {return(iPtr);}
1.204 +
1.205 +inline const TPtr& RTextBuf::Text() const
1.206 +/** Gets the text as a descriptor.
1.207 +
1.208 +@return Match text descriptor (const) */
1.209 + {return(iPtr);}
1.210 +
1.211 +inline TInt RTextBuf::MaxLength() const
1.212 +/** Gets the maximum length of the text.
1.213 +
1.214 +@return The maximum length of the text.*/
1.215 + {return(iPtr.MaxLength());}
1.216 +
1.217 +inline void RTextBuf::SetText(const TDesC &aDes)
1.218 +/** Sets the text. You must have set the maximum length appropriately first with
1.219 +SetMaxLengthL(). */
1.220 + {iPtr.Copy(aDes);}
1.221 +
1.222 +inline TInt RIncrMatcherBase::MaxLength() const
1.223 +/** Gets the maximum length of the match text buffer. */
1.224 + {return(MatchDes().MaxLength());}
1.225 +inline TInt RIncrMatcherBase::MatchLength() const
1.226 +/** Gets the current length of the match text buffer. */
1.227 + {return(MatchDes().Length());}
1.228 +inline TPtrC RIncrMatcherBase::MatchText() const
1.229 +/** Gets the match text as a TPtrC. */
1.230 + {return(TPtrC(MatchDes()));}
1.231 +inline void RIncrMatcherBase::SetMatchText(const TDesC& aText)
1.232 +/** Sets the match text.
1.233 +
1.234 +@param aText String to which to set the match text. */
1.235 + {MatchDes()=aText;}
1.236 +
1.237 +inline void RIncrMatcherBase::Clear()
1.238 +/** Clears the match text. */
1.239 + {MatchDes().Zero();}
1.240 +
1.241 +inline void RIncrMatcherPtr::SetMatcherPtr(TDes& aDes)
1.242 +/** Sets the text to be matched against.
1.243 +
1.244 +@param aDes Text to be matched against */
1.245 + {iDesPtr=&aDes;}
1.246 +
1.247 +
1.248 +inline void RIncrMatcherTextBuf::SetMatcherLengthL(TInt aMaxLength)
1.249 +/** Sets the maximum length of text that can be stored through SetMatchText()
1.250 +etc.
1.251 +
1.252 +@param aMaxLength Maximum length of text that can be stored */
1.253 + {iTextBuf.SetMaxLengthL(aMaxLength);}
1.254 +
1.255 +
1.256 +#endif