Class CFragmentedString

class CFragmentedString : protected CArrayPtrFlat< HBufC >;

Description

Utility that allows a single string to be built from an array of consecutive sub-strings.

The sub-strings can be inserted by reference or copied.

The object maintains information that points to a current position within the string. A typical use is to test the contents of the string using one of the Match...() functions, and then use CFragmentedString::ConsumeMatched() to advance past the matched area.

The class also supports inserting an unlimited number of marks in the string, and performing operations relative to the head (i.e. last inserted) mark.

Derivation

• CArrayPtrFlat< HBufC > - No description.

• CFragmentedString - Utility that allows a single string to be built from an array of consecutive sub...

Members

Defined in CFragmentedString:

• AddStringL(HBufC *)Appends a sub-string to the string.
• AddStringL(const TDesC &)Copies a sub-string and then appends the copy to the string.
• CFragmentedString()Constructor
• CMarkStackA stack of string position marks.
• ConsumeMatched()Removes and deletes all sub-strings occurring before the position of the last su...
• ContentL()constGets the entire string in a newly-allocated buffer.
• DeleteMark()Deletes the head mark.
• DeleteToMark(const TStringMark &)Deletes from the current index position to the specified mark.
• EInsufficientDataString contained insufficient data to perform the match operation.
• EMatchThere was a complete match.
• ENoMatchThere was no match.
• InsertStringL(HBufC *)Inserts a specified string at the current index position.
• InsertStringToL(HBufC *,TInt,TInt)Inserts a string at a specified position.
• Length()constGets the length of the string.
• Mark()Adds a mark at the current index position.
• MarkedL()Gets a new string containing the string contents from the head mark to the curre...
• MarkedWithInitialTextL(const TDesC &)Gets a new string containing the string contents from the head mark to the curre...
• Match(const TDesC &)Tests if a specified target string occurs at the current position.
• MatchNotSelect(const TDesC &)Tests if the character at the current position does not match any character in a...
• MatchRange(const TUint,const TUint)Tests if the character at the current position is within a specified character c...
• MatchSelect(const TDesC &)Tests if the character at the current position matches any character in a specif...
• ReplaceMarkedAndSkipL(HBufC *)Replaces the string contents to the head mark with a specified string, and then ...
• ReplaceMarkedL(HBufC *)Replaces the string contents to the head mark with a specified string.
• Reset()Resets the string.
• ResetToMark()Moves the current index position to the head mark.
• StringL()constGets a string containing all sub-strings after the current position in a newly-a...
• TStringMarkA mark at a string position.
• TStringMatchDefines possible results of a string matching operation for this class.
• iCurrentCharacterCurrent character position within the current sub-string.
• iCurrentIndexArray index of the current sub-string.
• iMarkStackStack of marks in the string.
• iMatchedResult of the last match operation.
• iMatchedToCharacterCurrent character position within the iMatchedToIndex sub-string found in the la...
• iMatchedToIndexArray index of the sub-string found in the last match operation.
• ~CFragmentedString()Destructor.

IMPORT_C CFragmentedString();

Description

Constructor

IMPORT_C ~CFragmentedString();

Description

Destructor.

This resets and destroys the HBufC array.

IMPORT_C void AddStringL(HBufC *aString);

Description

Appends a sub-string to the string.

Parameters

IMPORT_C void AddStringL(const TDesC &aString);

Description

Copies a sub-string and then appends the copy to the string.

Parameters

IMPORT_C TInt Length() const;

Description

Gets the length of the string.

Return value

IMPORT_C HBufC* StringL() const;

Description

Gets a string containing all sub-strings after the current position in a newly-allocated buffer.

It is the caller's responsibility to clean up the returned string.

Return value

IMPORT_C HBufC* ContentL() const;

Description

Gets the entire string in a newly-allocated buffer.

It is the caller's responsibility to clean up the returned string.

Return value

IMPORT_C void Reset();

Description

Resets the string.

This resets and destroys the HBufC array, and clears all indexes and marks.

IMPORT_C TStringMatch Match(const TDesC &aString);

Description

Tests if a specified target string occurs at the current position.

The function does a byte-for-byte comparison of the string contents from the current position against aString.

Parameters

Return value

IMPORT_C TStringMatch MatchRange(const TUint aLower, const TUint aUpper);

Description

Tests if the character at the current position is within a specified character code range.

Parameters

Return value

IMPORT_C TStringMatch MatchSelect(const TDesC &aSelection);

Description

Tests if the character at the current position matches any character in a specified string.

Parameters

Return value

IMPORT_C TStringMatch MatchNotSelect(const TDesC &aSelection);

Description

Tests if the character at the current position does not match any character in a specified string.

Parameters

Return value

IMPORT_C void ConsumeMatched();

Description

Removes and deletes all sub-strings occurring before the position of the last successful match.

Any sub-strings at or after a mark are not deleted, regardless of the last successful match position.

IMPORT_C HBufC* MarkedL();

Description

Gets a new string containing the string contents from the head mark to the current index position.

It is the caller's responsibility to clean up the returned string.

Return value

IMPORT_C HBufC* MarkedWithInitialTextL(const TDesC &aInitialText);

Description

Gets a new string containing the string contents from the head mark to the current index position, prepended with a specified string.

It is the caller's responsibility to clean up the returned string.

Parameters

Return value

IMPORT_C void Mark();

Description

Adds a mark at the current index position.

This mark becomes the head mark.

Note this function can leave with an out of memory error.

IMPORT_C void DeleteMark();

Description

Deletes the head mark.

IMPORT_C void ResetToMark();

Description

Moves the current index position to the head mark.

IMPORT_C void ReplaceMarkedL(HBufC *aString);

Description

Replaces the string contents to the head mark with a specified string.

Parameters

IMPORT_C void ReplaceMarkedAndSkipL(HBufC *aString);

Description

Replaces the string contents to the head mark with a specified string, and then advances the current index position to the next sub-string.

Parameters

IMPORT_C void InsertStringL(HBufC *aString);

Description

Inserts a specified string at the current index position.

Parameters

protected: IMPORT_C void DeleteToMark(const TStringMark &aStringMark);

Description

Deletes from the current index position to the specified mark.

Parameters

protected: IMPORT_C void InsertStringToL(HBufC *aString, TInt aStringIndex, TInt aLengthIntoString);

Description

Inserts a string at a specified position.

1. if aLengthIntoString is 0, the function inserts a new sub-string at array position aStringIndex

2. if aLengthIntoString is equal to the length of the sub-string at aStringIndex, then it inserts a new sub-string at array position aStringIndex+1.

3. If aLengthIntoString is in the middle of theaStringIndex sub-string, then it:

a) inserts a new sub-string at aStringIndex+1 holdingaString

b) inserts a new sub-string at aStringIndex+2 holding the data from aStringIndex after aLengthIntoString

c) truncates the original aStringIndex to hold only the data before aLengthIntoString

Parameters

protected: class TStringMark;

Description

A mark at a string position.

Members

Defined in CFragmentedString::TStringMark:

• TStringMark(TInt,TInt)Constructor.
• iMarkCharacterCharacter position within the sub-string for the mark.
• iMarkIndexArray index of the marked sub-string.

Construction and destruction

TStringMark(TInt,TInt)

inline TStringMark(TInt aIndex, TInt aCharacter);

Description

Constructor.

Parameters

Member data

iMarkIndex

TInt iMarkIndex;

Description

Array index of the marked sub-string.

iMarkCharacter

TInt iMarkCharacter;

Description

Character position within the sub-string for the mark.

TStringMatch

Description

Defines possible results of a string matching operation for this class.

protected: typedef CStack<TStringMark, ETrue> CFragmentedString::CMarkStack;

Description

A stack of string position marks.

protected: TStringMatch iMatched;

Description

Result of the last match operation.

protected: TInt iMatchedToIndex;

Description

Array index of the sub-string found in the last match operation.

protected: TInt iMatchedToCharacter;

Description

Current character position within the iMatchedToIndex sub-string found in the last match operation.

protected: TInt iCurrentIndex;

Description

Array index of the current sub-string.

protected: TInt iCurrentCharacter;

Description

Current character position within the current sub-string.

protected: CMarkStack iMarkStack;

Description

Stack of marks in the string.

CFragmentedString::Mark() pushes a mark on the stack; CFragmentedString::DeleteMark() pops one off.