Class: TTextMatch

Declaration: Formatter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TAlternateTextMatch

Purpose:

Provides the abstract protocol for doing text matching for particular ranges of text within the template of a TParameterFormatter. TAlternateTextMatch provides a concrete implementation.

Instantiation:

Abstract class; do not allocate.

Deriving Classes:

Any text match class for use with formatters should derive from this class. Examples of such classes are regular expression text matches or alternate text matches. The system provides the concrete class TAlternateTextMatch. Derived classes must provide the Match function.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTextMatch::TTextMatch

TTextMatch ()
TTextMatch (const TTextMatch &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TTextMatch & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextMatch::~TTextMatch

virtual ~ TTextMatch ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextMatch::operator=

TTextMatch & operator =(const TTextMatch &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TTextMatch & -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextMatch::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextMatch::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTextMatch::Match

virtual bool Match (const TText & targetText, TTextCount & matchLength) const

Interface Category:

API.

Purpose:

To see if there is a match in the given text. Returns true if a match is found.

Calling Context:

This function is called by the Scan member function of the associated formatter.

Parameters:

const TText & targetText -The text to be matched.
TTextCount & matchLength -Returns the number of characters that this match has consumed.

Return Value:

Returns true if a match is found.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.