Swarm.TUI.Model

Application state for the brick-based Swarm TUI.

Custom UI label types

These types are used as parameters to various brick types.

data AppEvent

AppEvent represents a type for custom event types our app can receive. At the moment, we only have one custom event, but it's very important: a separate thread sends Frame events as fast as it can, telling the TUI to render a new frame.

Constructors

Frame

UpstreamVersion (Either NewReleaseFailure String)

Instances

Show AppEvent

Defined in Swarm.TUI.Model

Methods

showsPrec :: Int -> AppEvent -> ShowS

show :: AppEvent -> String

showList :: [AppEvent] -> ShowS

data FocusablePanel

Constructors

REPLPanel

The panel containing the REPL.

WorldPanel

The panel containing the world view.

RobotPanel

The panel showing robot info and inventory on the top left.

InfoPanel

The info panel on the bottom left.

Instances

Bounded FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

minBound :: FocusablePanel

maxBound :: FocusablePanel

Enum FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

succ :: FocusablePanel -> FocusablePanel

pred :: FocusablePanel -> FocusablePanel

toEnum :: Int -> FocusablePanel

fromEnum :: FocusablePanel -> Int

enumFrom :: FocusablePanel -> [FocusablePanel]

enumFromThen :: FocusablePanel -> FocusablePanel -> [FocusablePanel]

enumFromTo :: FocusablePanel -> FocusablePanel -> [FocusablePanel]

enumFromThenTo :: FocusablePanel -> FocusablePanel -> FocusablePanel -> [FocusablePanel]

Read FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

readsPrec :: Int -> ReadS FocusablePanel

readList :: ReadS [FocusablePanel]

readPrec :: ReadPrec FocusablePanel

readListPrec :: ReadPrec [FocusablePanel]

Show FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

showsPrec :: Int -> FocusablePanel -> ShowS

show :: FocusablePanel -> String

showList :: [FocusablePanel] -> ShowS

Eq FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

(==) :: FocusablePanel -> FocusablePanel -> Bool

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

Ord FocusablePanel

Defined in Swarm.TUI.Model.Name

Methods

compare :: FocusablePanel -> FocusablePanel -> Ordering

(<) :: FocusablePanel -> FocusablePanel -> Bool

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

(>) :: FocusablePanel -> FocusablePanel -> Bool

(>=) :: FocusablePanel -> FocusablePanel -> Bool

max :: FocusablePanel -> FocusablePanel -> FocusablePanel

min :: FocusablePanel -> FocusablePanel -> FocusablePanel

data Name

Name represents names to uniquely identify various components of the UI, such as forms, panels, caches, extents, lists, and buttons.

Constructors

FocusablePanel FocusablePanel

REPLInput

The REPL input form.

WorldCache

The render cache for the world view.

WorldExtent

The cached extent for the world view.

InventoryList

The list of inventory items for the currently focused robot.

InventoryListItem Int

The inventory item position in the InventoryList.

MenuList

The list of main menu choices.

AchievementList

The list of achievements.

GoalWidgets GoalWidget

The list of goals/objectives.

ScenarioList

The list of scenario choices.

InfoViewport

The scrollable viewport for the info panel.

ModalViewport

The scrollable viewport for any modal dialog.

Button Button

A clickable button in a modal dialog.

Instances

Read Name

Defined in Swarm.TUI.Model.Name

Methods

readsPrec :: Int -> ReadS Name

readList :: ReadS [Name]

readPrec :: ReadPrec Name

readListPrec :: ReadPrec [Name]

Show Name

Defined in Swarm.TUI.Model.Name

Methods

showsPrec :: Int -> Name -> ShowS

show :: Name -> String

showList :: [Name] -> ShowS

Eq Name

Defined in Swarm.TUI.Model.Name

Methods

(==) :: Name -> Name -> Bool

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

Ord Name

Defined in Swarm.TUI.Model.Name

Methods

compare :: Name -> Name -> Ordering

(<) :: Name -> Name -> Bool

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

(>) :: Name -> Name -> Bool

(>=) :: Name -> Name -> Bool

max :: Name -> Name -> Name

min :: Name -> Name -> Name

Menus and dialogs

data ModalType

Constructors

HelpModal

RecipesModal

CommandsModal

MessagesModal

RobotsModal

WinModal

LoseModal

QuitModal

KeepPlayingModal

DescriptionModal Entity

GoalModal

Instances

Show ModalType

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> ModalType -> ShowS

show :: ModalType -> String

showList :: [ModalType] -> ShowS

data Button

Clickable buttons in modal dialogs.

Constructors

CancelButton

KeepPlayingButton

StartOverButton

QuitButton

NextButton

Instances

Bounded Button

Defined in Swarm.TUI.Model.Name

Methods

minBound :: Button

maxBound :: Button

Enum Button

Defined in Swarm.TUI.Model.Name

Methods

succ :: Button -> Button

pred :: Button -> Button

toEnum :: Int -> Button

fromEnum :: Button -> Int

enumFrom :: Button -> [Button]

enumFromThen :: Button -> Button -> [Button]

enumFromTo :: Button -> Button -> [Button]

enumFromThenTo :: Button -> Button -> Button -> [Button]

Read Button

Defined in Swarm.TUI.Model.Name

Methods

readsPrec :: Int -> ReadS Button

readList :: ReadS [Button]

readPrec :: ReadPrec Button

readListPrec :: ReadPrec [Button]

Show Button

Defined in Swarm.TUI.Model.Name

Methods

showsPrec :: Int -> Button -> ShowS

show :: Button -> String

showList :: [Button] -> ShowS

Eq Button

Defined in Swarm.TUI.Model.Name

Methods

(==) :: Button -> Button -> Bool

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

Ord Button

Defined in Swarm.TUI.Model.Name

Methods

compare :: Button -> Button -> Ordering

(<) :: Button -> Button -> Bool

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

(>) :: Button -> Button -> Bool

(>=) :: Button -> Button -> Bool

max :: Button -> Button -> Button

min :: Button -> Button -> Button

data ButtonAction

Constructors

Cancel

KeepPlaying

StartOver Seed ScenarioInfoPair

QuitAction

Next ScenarioInfoPair

data Modal

Constructors

Modal

Fields

• _modalType :: ModalType
• _modalDialog :: Dialog ButtonAction Name

modalType :: Lens' Modal ModalType

modalDialog :: Lens' Modal (Dialog ButtonAction Name)

data MainMenuEntry

Constructors

NewGame

Tutorial

Achievements

Messages

About

Quit

Instances

Bounded MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

minBound :: MainMenuEntry

maxBound :: MainMenuEntry

Enum MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

succ :: MainMenuEntry -> MainMenuEntry

pred :: MainMenuEntry -> MainMenuEntry

toEnum :: Int -> MainMenuEntry

fromEnum :: MainMenuEntry -> Int

enumFrom :: MainMenuEntry -> [MainMenuEntry]

enumFromThen :: MainMenuEntry -> MainMenuEntry -> [MainMenuEntry]

enumFromTo :: MainMenuEntry -> MainMenuEntry -> [MainMenuEntry]

enumFromThenTo :: MainMenuEntry -> MainMenuEntry -> MainMenuEntry -> [MainMenuEntry]

Read MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

readsPrec :: Int -> ReadS MainMenuEntry

readList :: ReadS [MainMenuEntry]

readPrec :: ReadPrec MainMenuEntry

readListPrec :: ReadPrec [MainMenuEntry]

Show MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

showsPrec :: Int -> MainMenuEntry -> ShowS

show :: MainMenuEntry -> String

showList :: [MainMenuEntry] -> ShowS

Eq MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

(==) :: MainMenuEntry -> MainMenuEntry -> Bool

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

Ord MainMenuEntry

Defined in Swarm.TUI.Model.Menu

Methods

compare :: MainMenuEntry -> MainMenuEntry -> Ordering

(<) :: MainMenuEntry -> MainMenuEntry -> Bool

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

(>) :: MainMenuEntry -> MainMenuEntry -> Bool

(>=) :: MainMenuEntry -> MainMenuEntry -> Bool

max :: MainMenuEntry -> MainMenuEntry -> MainMenuEntry

min :: MainMenuEntry -> MainMenuEntry -> MainMenuEntry

mainMenu :: MainMenuEntry -> List Name MainMenuEntry

data Menu

Constructors

NoMenu

MainMenu (List Name MainMenuEntry)

NewGameMenu (NonEmpty (List Name ScenarioItem))

AchievementsMenu (List Name CategorizedAchievement)

MessagesMenu

AboutMenu

_NewGameMenu :: Prism' Menu (NonEmpty (List Name ScenarioItem))

mkScenarioList :: Bool -> ScenarioCollection -> List Name ScenarioItem

Create a brick List of scenario items from a ScenarioCollection.

mkNewGameMenu :: Bool -> ScenarioCollection -> FilePath -> Maybe Menu

Given a ScenarioCollection and a FilePath which is the canonical path to some folder or scenario, construct a NewGameMenu stack focused on the given item, if possible.

UI state

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.

Inventory

data InventoryListEntry

An entry in the inventory list displayed in the info panel. We can either have an entity with a count in the robot's inventory, an entity equipped on the robot, or a labelled separator. The purpose of the separators is to show a clear distinction between the robot's inventory and its equipped devices.

Constructors

Separator Text

InventoryEntry Count Entity

EquippedEntry Entity

Instances

Eq InventoryListEntry

Defined in Swarm.TUI.Model.Menu

Methods

(==) :: InventoryListEntry -> InventoryListEntry -> Bool

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

_Separator :: Prism' InventoryListEntry Text

_InventoryEntry :: Prism' InventoryListEntry (Count, Entity)

_EquippedEntry :: Prism' InventoryListEntry Entity

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

Updating

populateInventoryList :: MonadState UIState m => Maybe Robot -> m ()

Given the focused robot, populate the UI inventory list in the info panel with information about its inventory.

infoScroll :: ViewportScroll Name

modalScroll :: ViewportScroll Name

Runtime state

data RuntimeState

webPort :: Lens' RuntimeState (Maybe Port)

The port on which the HTTP debug service is running.

upstreamRelease :: Lens' RuntimeState (Either NewReleaseFailure String)

The upstream release version.

eventLog :: Lens' RuntimeState (Notifications LogEntry)

A log of runtime events.

This logging is separate from the logging done during game-play. If some error happens before a game is even selected, this is the place to log it.

logEvent :: LogSource -> (Text, RID) -> Text -> Notifications LogEntry -> Notifications LogEntry

Simply log to the runtime event log.

App state

data AppState

The AppState just stores together the other states.

This is so you can use a smaller state when e.g. writing some game logic or updating the UI. Also consider that GameState can change when loading a new scenario - if the state should persist games, use RuntimeState.

Constructors

AppState GameState UIState RuntimeState

gameState :: Lens' AppState GameState

The GameState record.

uiState :: Lens' AppState UIState

The UIState record.

runtimeState :: Lens' AppState RuntimeState

The RuntimeState record

Initialization

data AppOpts

Command-line options for configuring the app.

Constructors

AppOpts

Fields

• userSeed :: Maybe Seed

  Explicit seed chosen by the user.

• userScenario :: Maybe FilePath

  Scenario the user wants to play.

• scriptToRun :: Maybe FilePath

  Code to be run on base.

• autoPlay :: Bool

  Automatically run the solution defined in the scenario file

• cheatMode :: Bool

  Should cheat mode be enabled?

• colorMode :: Maybe ColorMode

  What colour mode should be used?

• userWebPort :: Maybe Port

  Explicit port on which to run the web API

• repoGitInfo :: Maybe GitInfo

  Information about the Git repository (not present in release).

type Seed = Int

Re-exported types used in options

data ColorMode

Constructors

NoColor

ColorMode8

ColorMode16

ColorMode240 !Word8

FullColor

Instances

Show ColorMode

Defined in Graphics.Vty.Attributes.Color

Methods

showsPrec :: Int -> ColorMode -> ShowS

show :: ColorMode -> String

showList :: [ColorMode] -> ShowS

Eq ColorMode

Defined in Graphics.Vty.Attributes.Color

Methods

(==) :: ColorMode -> ColorMode -> Bool

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

Utility

topContext :: AppState -> RobotContext

Context for the REPL commands to execute in. Contains the base robot context plus the it variable that refer to the previously computed values. (Note that `it{n}` variables are set in the base robot context; we only set it here because it's so transient)

focusedItem :: AppState -> Maybe InventoryListEntry

Get the currently focused InventoryListEntry from the robot info panel (if any).

focusedEntity :: AppState -> Maybe Entity

Get the currently focused entity from the robot info panel (if any). This is just like focusedItem but forgets the distinction between plain inventory items and equipped devices.

nextScenario :: Menu -> Maybe ScenarioInfoPair

Extract the scenario which would come next in the menu from the currently selected scenario (if any). Can return Nothing if either we are not in the NewGameMenu, or the current scenario is the last among its siblings.

initRuntimeState :: RuntimeState