RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSCommon > GStreams > Classes

TBaseStreamToken Class

Represents one token (string) parsed by a parser. However, the token can not only represent the string token parsed from a stream, but also provide methods for retrieving and setting its value based on a type. In other words, if the parser finds a string like '1234', it will create not a string token but an integer token. The TBaseStreamToken class provides properties and methods for:

• accessing the string token

• setting and retrieving the string's type

• determining where in the stream the token came from

Namespace: GStreams

Name

Description

public property

AsString

The AsString property is a read-only property which returns the string parsed from the stream. Usually, this is the exact string parsed from the stream. However, if the parser chooses to, the string returned could be a beautified version of the string. The intent is that the string should be reparsable by the parser to create the exact same token. Also, usually this property will not return the Whitespace found before this token was parsed from the stream.

published property

DataType

The DataType property provides a place where the data type of the string token can be set and retrieved from. Since the exact data types a token may take is specific to a parser, the DataType property is an integer. Parsers need to define integer constants or an enumeration which define the all unique types the token can take.

When the parser sets a token to be a numeric type, it should also place the numeric value in the GStreams.TBaseStreamToken.Number property.

published property

LineNumber

The LineNumber property is intended to hold the line number where the token was found in the parsed stream.

published property

Number

The Number property should hold the numeric value of the string parsed from the stream. When a numeric value (either an integer or float) is found in a stream, the parser creates a token and sets this property to the value parsed. It also should set the GStreams.TBaseStreamToken.DataType property to the correct numeric data type.

Note
Setting the Number property should not set the DataType property unless there is only one numeric type for that parser. Usually, there are at least two numeric types (integer and float) so the DataType should be set separately from the Number property.

published property

Tag

The tag property is intended for the token user to assign whatever value they like to the tag.

published property

Text

The Text property should hold the string representation of the string parsed from the stream. Note that this text string is not necessarily the actual string read from the stream. For example, when RiverSoftAVG's parsers encounter the end of file/stream character, they fill in this Text property not with the actual characters but with a constant 'EOF' string. When a string value is found in a stream, the parser creates a token and sets this property to the value parsed. It also should set the GStreams.TBaseStreamToken.DataType property to the correct string data type.

published property

WhiteSpace

The Whitespace property is intended to hold the white space (spaces, tabs, carraige returns, etc) that was found in the stream from the last token parsed to the current token. The decision of what is white space is up to the parser.

Top

	Name	Description
	Assign(IInterface)	Overloaded. Attempts to copy the fields or data from AValue into the underlying object. If the AValue parameter is not of a IBaseStreamToken interface, it will raise an exception.
	Assign(TPersistent)	Overloaded. Attempts to copy the fields or data from source object into the underlying object.
	Clone	Returns a copy of the token. Note that this method returns an IInterface and needs to be cast to a IBaseStreamToken type.
	Equals(IInterface)	Overloaded. Returns true if AValue equals the current token. If the AValue parameter is not of a IBaseStreamToken interface, it returns false.
	Equals(TPersistent)	Overloaded. Returns true if the token equals the input AValue
	GetDataType	Accessor method for GStreams.TBaseStreamToken.DataType property
	GetLineNumber	Accessor method for GStreams.TBaseStreamToken.LineNumber property
	GetNumber	Accessor method for GStreams.TBaseStreamToken.Number property
	GetTag	Accessor method for GStreams.TBaseStreamToken.Tag property
	GetText	Accessor method for GStreams.TBaseStreamToken.Text property
	GetWhitespace	Accessor method for Whitespace property
	QueryInterface(TGUID,Void)	Represents method QueryInterface(TGUID,Void).
	SetDataType(Integer)	Accessor method for GStreams.TBaseStreamToken.DataType property
	SetLineNumber(Integer)	Accessor method for GStreams.TBaseStreamToken.LineNumber property
	SetNumber(Double)	Accessor method for GStreams.TBaseStreamToken.Number property
	SetTag(TRSTag)	Accessor method for GStreams.TBaseStreamToken.Tag property
	SetText(String)	Accessor method for GStreams.TBaseStreamToken.Text property
	SetWhitespace(String)	Accessor method for Whitespace property
	ToString	The ToString function returns the string parsed from the stream. Usually, this is the exact string parsed from the stream. However, if the parser chooses to, the string returned could be a beautified version of the string. The intent is that the string should be reparsable by the parser to create the exact same token. Also, usually this property will not return the Whitespace found before this token was parsed from the stream.
	_AddRef	Represents method _AddRef.
	_Release	Represents method _Release.

Top

RiverSoftAVG Products Help

Reference