Swarm.TUI.Model.Repl

REPL

data REPLHistItem

An item in the REPL history.

Constructors

REPLEntry Text

Something entered by the user.

REPLOutput Text

A response printed by the system.

Instances

Read REPLHistItem

Defined in Swarm.TUI.Model.Repl

Methods

readsPrec :: Int -> ReadS REPLHistItem

readList :: ReadS [REPLHistItem]

readPrec :: ReadPrec REPLHistItem

readListPrec :: ReadPrec [REPLHistItem]

Show REPLHistItem

Defined in Swarm.TUI.Model.Repl

Methods

showsPrec :: Int -> REPLHistItem -> ShowS

show :: REPLHistItem -> String

showList :: [REPLHistItem] -> ShowS

Eq REPLHistItem

Defined in Swarm.TUI.Model.Repl

Methods

(==) :: REPLHistItem -> REPLHistItem -> Bool

(/=) :: REPLHistItem -> REPLHistItem -> Bool

Ord REPLHistItem

Defined in Swarm.TUI.Model.Repl

Methods

compare :: REPLHistItem -> REPLHistItem -> Ordering

(<) :: REPLHistItem -> REPLHistItem -> Bool

(<=) :: REPLHistItem -> REPLHistItem -> Bool

(>) :: REPLHistItem -> REPLHistItem -> Bool

(>=) :: REPLHistItem -> REPLHistItem -> Bool

max :: REPLHistItem -> REPLHistItem -> REPLHistItem

min :: REPLHistItem -> REPLHistItem -> REPLHistItem

replItemText :: REPLHistItem -> Text

Get the text of REPL input/output.

isREPLEntry :: REPLHistItem -> Bool

Useful helper function to filter out REPL output.

getREPLEntry :: REPLHistItem -> Maybe Text

Useful helper function to only get user input text.

data REPLHistory

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.

replIndex :: Lens' REPLHistory Int

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

replLength :: REPLHistory -> Int

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

replSeq :: Lens' REPLHistory (Seq REPLHistItem)

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

newREPLHistory :: [REPLHistItem] -> REPLHistory

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

addREPLItem :: REPLHistItem -> REPLHistory -> REPLHistory

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.

restartREPLHistory :: REPLHistory -> REPLHistory

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

getLatestREPLHistoryItems :: Int -> REPLHistory -> [REPLHistItem]

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.

moveReplHistIndex :: TimeDir -> Text -> REPLHistory -> REPLHistory

getCurrentItemText :: REPLHistory -> Maybe Text

replIndexIsAtInput :: REPLHistory -> Bool

data TimeDir

Constructors

Newer

Older

Instances

Show TimeDir

Defined in Swarm.TUI.Model.Repl

Methods

showsPrec :: Int -> TimeDir -> ShowS

show :: TimeDir -> String

showList :: [TimeDir] -> ShowS

Eq TimeDir

Defined in Swarm.TUI.Model.Repl

Methods

(==) :: TimeDir -> TimeDir -> Bool

(/=) :: TimeDir -> TimeDir -> Bool

Ord TimeDir

Defined in Swarm.TUI.Model.Repl

Methods

compare :: TimeDir -> TimeDir -> Ordering

(<) :: TimeDir -> TimeDir -> Bool

(<=) :: TimeDir -> TimeDir -> Bool

(>) :: TimeDir -> TimeDir -> Bool

(>=) :: TimeDir -> TimeDir -> Bool

max :: TimeDir -> TimeDir -> TimeDir

min :: TimeDir -> TimeDir -> TimeDir

Prompt utils

data REPLPrompt

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

Constructors

CmdPrompt [Text]

Interpret the prompt text as a regular command. The list is for potential completions, which we can cycle through by hitting Tab repeatedly

SearchPrompt REPLHistory

Interpret the prompt text as "search this text in history"

removeEntry :: Text -> REPLHistory -> REPLHistory

Given some text, removes the REPLEntry within REPLHistory which is equal to that. This is used when the user enters in search mode and want 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.

REPL Panel Model

data REPLState

data ReplControlMode

Constructors

Piloting

Typing

Instances

Bounded ReplControlMode

Defined in Swarm.TUI.Model.Repl

Methods

minBound :: ReplControlMode

maxBound :: ReplControlMode

Enum ReplControlMode

Defined in Swarm.TUI.Model.Repl

Methods

succ :: ReplControlMode -> ReplControlMode

pred :: ReplControlMode -> ReplControlMode

toEnum :: Int -> ReplControlMode

fromEnum :: ReplControlMode -> Int

enumFrom :: ReplControlMode -> [ReplControlMode]

enumFromThen :: ReplControlMode -> ReplControlMode -> [ReplControlMode]

enumFromTo :: ReplControlMode -> ReplControlMode -> [ReplControlMode]

enumFromThenTo :: ReplControlMode -> ReplControlMode -> ReplControlMode -> [ReplControlMode]

Eq ReplControlMode

Defined in Swarm.TUI.Model.Repl

Methods

(==) :: ReplControlMode -> ReplControlMode -> Bool

(/=) :: ReplControlMode -> ReplControlMode -> Bool

replPromptType :: Lens' REPLState REPLPrompt

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

replPromptEditor :: Lens' REPLState (Editor Text Name)

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

replPromptText :: Lens' REPLState Text

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

replValid :: Lens' REPLState Bool

Whether the prompt text is a valid Term.

replLast :: Lens' REPLState Text

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.

replType :: Lens' REPLState (Maybe Polytype)

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

replControlMode :: Lens' REPLState ReplControlMode

Piloting or Typing mode

replHistory :: Lens' REPLState REPLHistory

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

newREPLEditor :: Text -> Editor Text Name

Initialization

initREPLState :: REPLHistory -> REPLState

defaultPrompt :: REPLPrompt

lastEntry :: Text -> REPLHistory -> Maybe Text

Get the last REPLEntry in REPLHistory matching the given text