Whether a user REPL entry was submitted or merely saved.

Various types of REPL history items (user input, output, error).

An item in the REPL history.

Useful helper function to filter out REPL output. Returns True for all user input, including both submitted and saved history items.

Helper function to get only submitted user input text.

Useful helper function to filter out saved REPL entries (which should not be shown in the scrollback).

Useful helper function to only get user input text. Gets all user input, including both submitted and saved history items.

History of the REPL with indices (0 is first entry) to the current line and to the first entry since loading saved history. We also (ab)use the length of the REPL as the index of current input line, since that number is one past the index of last entry.

The current index in the REPL history (if the user is going back through the history using up/down keys).

Current number lines of the REPL history - (ab)used as index of input buffer.

Keep track of whether the user has explicitly executed commands at the REPL prompt, thus making them ineligible for code size scoring.

Note: Instead of adding a dedicated field to the REPLHistory record, an early attempt entailed checking for:

_replIndex > _replStart

However, executing an initial script causes a REPLOutput to be appended to the REPL history, which increments the replIndex, and thus makes the Index greater than the Start even though the player has not input commands directly into the REPL.

Therefore, a dedicated boolean is introduced into REPLHistory which simply latches True when the user has input a command.

An alternative is described in issue #974.

Sequence of REPL inputs and outputs, oldest entry is leftmost.

Create new REPL history (i.e. from loaded history file lines).

Add new REPL input - the index must have been pointing one past the last element already, so we increment it to keep it that way.

Point the start of REPL history after current last line. See replStart.

Get the latest N items in history, starting with the oldest one.

This is used to show previous REPL lines in UI, so we need the items sorted in the order they were entered and will be drawn top to bottom.

Get only the items from the REPL history that were entered during the current session.

This data type tells us how to interpret the text typed by the player at the prompt (which is stored in Editor).

Given some text, removes the REPLEntry within REPLHistory which is equal to that. This is used when the user enters search mode and wants to traverse the history. If a command has been used many times, the history will be populated with it causing the effect that search command always finds the same command.

What is being done with user input to the REPL panel?

The way we interpret text typed by the player in the REPL prompt.

The prompt where the user can type input at the REPL.

Convenience lens to get text from editor and replace it with new one that has the provided text.

Whether the prompt text is a valid Term. If it is invalid, the location of error. (NoLoc means the whole text causes the error.)

The last thing the user has typed which isn't part of the history. This is used to restore the repl form after the user visited the history.

The type of the current REPL input which should be displayed to the user (if any).

The current REPL control mode, i.e. how user input to the REPL panel is being handled.

History of things the user has typed at the REPL, interleaved with outputs the system has generated.

Get the last REPLEntry in REPLHistory matching the given text