causerie

Introduction

Units

Class Hierarchy

Classes, Interfaces, Objects and Records

Types

Variables

Constants

Functions and Procedures

Identifiers

Classes hierarchy graph

Class AStreamEndingTokenFromSource

DescriptionHierarchyFieldsMethodsProperties

Unit

parsing

Declaration

type AStreamEndingTokenFromSource = class(ATokenFromSource)

Description

This class represents the end of a source stream. While it is possible that some language definitions may specify one or more characters to mark the end of a source stream, it is more likely that this token will be returned when the source stream indicates that its end has been reached.

Hierarchy

Overview

Methods

Public function init: boolean; override;
Public procedure returnTo(const Source: AStream); override;
Public function readFrom(const Source: AStream): TStreamIOSize; override;
Public function toString: AnsiString; override;

Description

Methods

Public function init: boolean; override;

Initializer

Public procedure returnTo(const Source: AStream); override;

Return the token to its source.

This method overrides the behavior inherited from AToken. It does nothing.

Public function readFrom(const Source: AStream): TStreamIOSize; override;

Read the token from the given source stream.

To avoid attempts to read beyond the end of the stream, this method does nothing when called.

Returns

The total number of bytes read from Source, which will always be zero (0).

Public function toString: AnsiString; override;

Construct and return a string representation of the token, suitable for output to a text-based device, such as a console.

This method overrides the behavior inherited from AToken; it simply returns the value defined by setkStringRepresentation.

Generated by PasDoc 0.13.0 on 2015-01-10 17:13:18