Interface ITokenStream

src/parser/streams/token-stream.ts:8–49

 * トークンの読み取りに関するインターフェース
*/
export interface ITokenStream {
	/**
	 * カーソル位置にあるトークンを取得します。
	*/
	getToken(): Token;

	/**
	 * カーソル位置にあるトークンの種類が指定したトークンの種類と一致するかどうかを示す値を取得します。
	*/
	is(kind: TokenKind): boolean;

	/**
	 * カーソル位置にあるトークンの種類を取得します。
	*/
	getTokenKind(): TokenKind;

	/**
	 * カーソル位置にあるトークンに含まれる値を取得します。
	*/
	getTokenValue(): string;

	/**
	 * カーソル位置にあるトークンの位置情報を取得します。
	*/
	getPos(): TokenPosition;

	/**
	 * カーソル位置を次のトークンへ進めます。
	*/
	next(): void;

	/**
	 * トークンの先読みを行います。カーソル位置は移動されません。
	*/
	lookahead(offset: number): Token;

	/**
	 * カーソル位置にあるトークンの種類が指定したトークンの種類と一致することを確認します。
	 * 一致しなかった場合には文法エラーを発生させます。
	*/
	expect(kind: TokenKind): void;
}

/**
 * トークン列からトークンを読み取るクラス