sl@0: // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Incremental matcher class
sl@0: // 
sl@0: //
sl@0: 
sl@0: #if !defined (__BAMATCH_H__)
sl@0: #define __BAMATCH_H__
sl@0: 
sl@0: #if !defined(__E32STD_H__)
sl@0: #include <e32std.h>
sl@0: #endif
sl@0: 
sl@0: #if !defined(__E32BASE_H__)
sl@0: #include <e32base.h>
sl@0: #endif
sl@0: 
sl@0: #if !defined(__BAMDESCA_H__)
sl@0: #include <bamdesca.h>
sl@0: #endif
sl@0: 
sl@0: 
sl@0: class RTextBuf
sl@0: /** A simple class that encapsulates a text string.
sl@0: 
sl@0: As with the descriptor classes, the class sets a maximum length for the encapsulated 
sl@0: string, which cannot be exceeded. The class might be preferred to a descriptor 
sl@0: in some circumstances as its maximum length can be increased (unlike a TBuf), 
sl@0: and it can be created on the stack (unlike an HBufC) . 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C RTextBuf();
sl@0: 	IMPORT_C ~RTextBuf();
sl@0: public:
sl@0: 	inline TPtr& Text();
sl@0: 	inline const TPtr& Text() const;
sl@0: 	inline TInt MaxLength() const;
sl@0: 	inline void SetText(const TDesC &aDes);
sl@0: 	IMPORT_C void SetMaxLengthL(TInt aMaxLength);
sl@0: 	IMPORT_C void Close();
sl@0: private:
sl@0: 	TPtr iPtr;
sl@0: 	TText* iText;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: 
sl@0: class RIncrMatcherBase
sl@0: /** Base class for incremental matcher classes.
sl@0: 
sl@0: An incremental matcher compares two text buffers from left-to-right. For example, 
sl@0: the match between "garage" and "gander" is "ga".
sl@0: 
sl@0: The class provides the interface for getting and setting the text to be matched 
sl@0: against, and for performing match tests. Each type of match test is available 
sl@0: in three versions, one using binary comparison, one using locale collation 
sl@0: rules (comparison of strings to produce a dictionary-like ('lexicographic') 
sl@0: ordering, e.g. ignoring punctuation), and one using locale folding rules (e.g. 
sl@0: ignoring case). 
sl@0: 
sl@0: "bafl.lib" 
sl@0: @since 5.0
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0:     IMPORT_C virtual ~RIncrMatcherBase();
sl@0: protected:
sl@0: 	/** Default constructor. */
sl@0: 	inline RIncrMatcherBase() {}
sl@0: protected:
sl@0: 	/** Gets the match text.
sl@0: 	
sl@0: 	@return Match text */
sl@0: 	virtual TDes& MatchDes()=0;
sl@0: 
sl@0: 	/** Gets the match text.
sl@0: 	
sl@0: 	@return Match text */
sl@0: 	virtual const TDes& MatchDes() const=0; 
sl@0: public:
sl@0: 	inline TInt MaxLength() const;
sl@0: 	inline TInt MatchLength() const;
sl@0: 	inline TPtrC MatchText() const;
sl@0: //
sl@0: 	inline void Clear();
sl@0: 	IMPORT_C void DeleteLastChar();
sl@0: 	IMPORT_C void AppendChar(TChar aLetter);
sl@0: 	inline void SetMatchText(const TDesC& aText);
sl@0: //
sl@0: 	IMPORT_C void SetBestMatch(const TDesC& aBuf);
sl@0: 	IMPORT_C void SetBestMatchC(const TDesC& aBuf);
sl@0: 	IMPORT_C void SetBestMatchF(const TDesC& aBuf);
sl@0: 	IMPORT_C TBool IsMatch(const TDesC& aBuf) const;
sl@0: 	IMPORT_C TBool IsMatchC(const TDesC& aBuf) const;
sl@0: 	IMPORT_C TBool IsMatchF(const TDesC& aBuf) const;
sl@0: 	IMPORT_C TInt FirstMatchingIndex(TInt& aResult,const MDesCArray& aDesArray,TInt aStartIndex=0) const;
sl@0: 	IMPORT_C TInt FirstMatchingIndexC(TInt& aResult,const MDesCArray& aDesArray,TInt aStartIndex=0) const;
sl@0: 	IMPORT_C TInt FirstMatchingIndexF(TInt& aResult,const MDesCArray& aDesArray,TInt aStartIndex=0) const;
sl@0: private:
sl@0: 	typedef TInt (*TCompareFunc)(const TText*,TInt,const TText*,TInt);
sl@0: 	TBool DoIsMatch(const TDesC& aQuery,TCompareFunc aCompare) const;
sl@0: 	TInt DoFirstMatchingIndex(TInt& aIndex,const MDesCArray& aDesArray,TCompareFunc aCompare) const;
sl@0: 	void DoSetBestMatch(const TDesC& aBuf,TCompareFunc aCompare);
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class RIncrMatcherPtr : public RIncrMatcherBase
sl@0: /** Incrementally matches text against a descriptor, accessed via a pointer.
sl@0: 
sl@0: The class does not take a copy of the text to match against, but only stores 
sl@0: the pointer. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	IMPORT_C RIncrMatcherPtr();
sl@0: 	IMPORT_C RIncrMatcherPtr(TDes& aDes);
sl@0:     IMPORT_C virtual ~RIncrMatcherPtr();
sl@0: public:
sl@0: 	inline void SetMatcherPtr(TDes& aDes);
sl@0: protected:
sl@0: 	IMPORT_C TDes& MatchDes();
sl@0: 	IMPORT_C const TDes& MatchDes() const;
sl@0: private:
sl@0: 	TDes* iDesPtr;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: class RIncrMatcherTextBuf : public RIncrMatcherBase
sl@0: /** Incrementally matches text against a text buffer with variable maximum 
sl@0: length. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0:     IMPORT_C RIncrMatcherTextBuf();
sl@0:     IMPORT_C virtual ~RIncrMatcherTextBuf();
sl@0: 	inline void SetMatcherLengthL(TInt aMaxLength);
sl@0: protected:
sl@0: 	IMPORT_C TDes& MatchDes();
sl@0: 	IMPORT_C const TDes& MatchDes() const;
sl@0: private:
sl@0: 	RTextBuf iTextBuf;
sl@0: 	};
sl@0: 
sl@0: template <TInt aMaximumSize> 
sl@0: class RIncrMatcherBuf : public RIncrMatcherBase
sl@0: /**
sl@0: Incrementally matches text against a modifiable descriptor buffer.
sl@0: Set aMaximumSize to be the maximum size of this buffer. 
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: 	{
sl@0: public:
sl@0: 	/** Default constructor. */
sl@0: 	RIncrMatcherBuf() {}
sl@0: protected:
sl@0: 
sl@0: 	/**	 Gets the match text.
sl@0: 	 
sl@0: 	  @return   Match text (non const) */
sl@0: 	inline TDes& MatchDes() {return(iMatchBuf);}
sl@0: 
sl@0: 	/**	 Gets the match text.
sl@0: 	 
sl@0: 	  @return   Match text (const)*/
sl@0: 	inline const TDes& MatchDes() const {return(iMatchBuf);}
sl@0: 
sl@0: 	/** Copy constructor.
sl@0: 	
sl@0: 	@param aMatcher RIncrMatcherBuf to copy */
sl@0: 	inline RIncrMatcherBuf(const RIncrMatcherBuf& aMatcher) {iMatchBuf=aMatcher.iMatchBuf;}
sl@0: private:
sl@0: 	TBuf<aMaximumSize> iMatchBuf;
sl@0:     };
sl@0: 
sl@0: inline TPtr& RTextBuf::Text()
sl@0: /** Gets the text as a descriptor. 
sl@0: 
sl@0: @return   Match text descriptor (non const) */
sl@0: 	{return(iPtr);}
sl@0: 
sl@0: inline const TPtr& RTextBuf::Text() const
sl@0: /** Gets the text as a descriptor. 
sl@0: 
sl@0: @return   Match text descriptor (const) */
sl@0: 	{return(iPtr);}
sl@0: 
sl@0: inline TInt RTextBuf::MaxLength() const
sl@0: /** Gets the maximum length of the text. 
sl@0: 
sl@0: @return The maximum length of the text.*/
sl@0: 	{return(iPtr.MaxLength());}
sl@0: 
sl@0: inline void RTextBuf::SetText(const TDesC &aDes)
sl@0: /** Sets the text. You must have set the maximum length appropriately first with
sl@0: SetMaxLengthL(). */
sl@0: 	{iPtr.Copy(aDes);}
sl@0: 
sl@0: inline TInt RIncrMatcherBase::MaxLength() const
sl@0: /** Gets the maximum length of the match text buffer. */
sl@0: 	{return(MatchDes().MaxLength());}
sl@0: inline TInt RIncrMatcherBase::MatchLength() const
sl@0: /** Gets the current length of the match text buffer. */
sl@0: 	{return(MatchDes().Length());}
sl@0: inline TPtrC RIncrMatcherBase::MatchText() const
sl@0: /** Gets the match text as a TPtrC. */
sl@0: 	{return(TPtrC(MatchDes()));}
sl@0: inline void RIncrMatcherBase::SetMatchText(const TDesC& aText)
sl@0: /** Sets the match text.
sl@0: 	
sl@0: @param aText String to which to set the match text. */
sl@0: 	{MatchDes()=aText;}
sl@0: 
sl@0: inline void RIncrMatcherBase::Clear()
sl@0: /** Clears the match text. */
sl@0: 	{MatchDes().Zero();}
sl@0: 
sl@0: inline void RIncrMatcherPtr::SetMatcherPtr(TDes& aDes)
sl@0: /** Sets the text to be matched against.
sl@0: 	
sl@0: @param aDes Text to be matched against */
sl@0: 	{iDesPtr=&aDes;}
sl@0: 
sl@0: 
sl@0: inline void RIncrMatcherTextBuf::SetMatcherLengthL(TInt aMaxLength)
sl@0: /** Sets the maximum length of text that can be stored through SetMatchText() 
sl@0: etc.
sl@0: 	
sl@0: @param aMaxLength Maximum length of text that can be stored */
sl@0: 	{iTextBuf.SetMaxLengthL(aMaxLength);}
sl@0: 
sl@0: 
sl@0: #endif