LineStream Module Client Specifications

Purpose

Client Data Model

Importing Information

#include "LineScanner.h"
#include "LineStream.h"

Public Data Types

Public Functions

LineScanner access

• int moreLines(void)
  moreLines() returns true if there are more lines in the line stream.

• LineScanner getLineScanner(void)
  getLineScanner() returns a LineScanner for the line at the current position in the line stream and advances the current position to the next line.

  Preconditions:
  moreLineScanner() is true.

• void turnEchoOn(void)
  turnEchoOn() turns echoing on for the current file in the line stream. This has no effect if the current file is interactive.

• void turnEchoOff(void)
  turnEchoOff() turns echoing off for the current file in the line stream. This has no effect if the current file is interactive.

• void insertBatchLines(FILE * f)
  insertBatchLines(f) inserts lines read from the file f into the stream of lines read by the line stream.

  Preconditions:
  The file f is open for reading.

• void insertInteractiveLines(void)
  insertInteractiveLines() inserts lines read from the terminal into the stream of lines read by the line stream.

• void endInsert(void)
  endInsert() terminates an insert begun by insertInteractiveLines() or insertBatchLines().

• void turnEchoOn(LineScanner args)
  turnEchoOn(args) turns echoing on for the current file in the line stream. This has no effect if the current file is interactive. The parameter args is ignored.

• void turnEchoOff(LineScanner args)
  turnEchoOff(args) turns echoing off for the current file in the line stream. This has no effect if the current file is interactive. The parameter args is ignored.

• void insertLines(LineScanner args)
  insertLines(args) inserts lines read from a file into the stream of lines read by the line stream. If there are one or more tokens in args then the inserted lines are read from the file that is named by the first token. Otherwise, the inserted lines are read from the terminal.

• void endInsert(LineScanner args)
  endInsert(args) terminates an insert begun by insertLines(). The parameter args is ignored.