Make robot grid simpler (#2443)

* Closes #2440

Author: xsebek

src/swarm-tui/Swarm/TUI/Controller.hs

@@ -34,7 +34,7 @@ import Brick.Widgets.Dialog
 import Brick.Widgets.Edit (Editor, applyEdit, editContentsL, handleEditorEvent)
 import Brick.Widgets.List (handleListEvent, listElements)
 import Brick.Widgets.List qualified as BL
-import Brick.Widgets.TabularList.Mixed
+import Brick.Widgets.TabularList.Grid qualified as BG
 import Control.Applicative ((<|>))
 import Control.Category ((>>>))
 import Control.Lens as Lens
@@ -108,7 +108,7 @@ import Swarm.TUI.Model.StateUpdate
 import Swarm.TUI.Model.UI
 import Swarm.TUI.Model.UI.Gameplay
 import Swarm.TUI.View.Popup (startPopupAnimation)
-import Swarm.TUI.View.Robot (getList)
+import Swarm.TUI.View.Robot
 import Swarm.TUI.View.Robot.Type
 import Swarm.Util hiding (both, (<<.=))
 
@@ -296,8 +296,7 @@ handleNewGameMenuEvent scenarioStack@(curMenu :| rest) = \case
         invalidateCache
         let remaining = getScenariosAfterSelection curMenu pos
         startGame (siPair :| remaining) Nothing
-      SICollection _ c -> do
-        uiState . uiMenu .= NewGameMenu (NE.cons (mkScenarioList c) scenarioStack)
+      SICollection _ c -> uiState . uiMenu .= NewGameMenu (NE.cons (mkScenarioList c) scenarioStack)
   CharKey 'o' -> showLaunchDialog
   CharKey 'O' -> showLaunchDialog
   Key V.KEsc -> exitNewGameMenu scenarioStack
@@ -318,7 +317,7 @@ handleNewGameMenuEvent scenarioStack@(curMenu :| rest) = \case
 exitNewGameMenu ::
   NonEmpty (BL.List Name (ScenarioItem ScenarioPath)) ->
   EventM Name AppState ()
-exitNewGameMenu stk = do
+exitNewGameMenu stk =
   uiState
     . uiMenu
     .= case snd (NE.uncons stk) of
@@ -445,7 +444,7 @@ closeModal m = do
   safeAutoUnpause
   uiGameplay . uiDialogs . uiModal .= Nothing
   -- message modal is not autopaused, so update notifications when leaving it
-  when ((m ^. modalType) == MidScenarioModal MessagesModal) $ do
+  when (m ^. modalType == MidScenarioModal MessagesModal) $ do
     t <- use $ gameState . temporal . ticks
     gameState . messageInfo . lastSeenMessageTime .= t
 
@@ -458,11 +457,11 @@ handleModalEvent = \case
       Just (MidScenarioModal RobotsModal) -> do
         robotDialog <- use $ playState . scenarioState . uiGameplay . uiDialogs . uiRobot
         unless (robotDialog ^. isDetailsOpened) $ do
-          let widget = robotDialog ^. robotListContent . robotsListWidget
-          forM_ (BL.listSelectedElement $ getList widget) $ \x -> do
-            Brick.zoom (playState . scenarioState . uiGameplay . uiDialogs . uiRobot) $ do
-              isDetailsOpened .= True
-              updateRobotDetailsPane $ snd x
+          g <- use $ playState . scenarioState . gameState
+          let widget = robotDialog ^. robotsGridList
+          forM_ (getSelectedRobot g widget) $ \rob -> Brick.zoom (playState . scenarioState . uiGameplay . uiDialogs . uiRobot) $ do
+            isDetailsOpened .= True
+            Brick.zoom robotDetailsPaneState $ updateRobotDetailsPane rob
       _ -> do
         menu <- use $ uiState . uiMenu
 
@@ -490,8 +489,7 @@ handleModalEvent = \case
     case modal of
       Just (MidScenarioModal TerrainPaletteModal) ->
         refreshList $ uiGameplay . uiWorldEditor . terrainList
-      Just (MidScenarioModal EntityPaletteModal) -> do
-        refreshList $ uiGameplay . uiWorldEditor . entityPaintList
+      Just (MidScenarioModal EntityPaletteModal) -> refreshList $ uiGameplay . uiWorldEditor . entityPaintList
       Just (MidScenarioModal GoalModal) -> case ev of
         V.EvKey (V.KChar '\t') [] -> uiGameplay . uiDialogs . uiGoal . focus %= focusNext
         _ -> do
@@ -514,19 +512,20 @@ handleModalEvent = \case
                 refreshList $ uiGameplay . uiDialogs . uiStructure . structurePanelListWidget
               StructureSummary -> handleInfoPanelEvent modalScroll (VtyEvent ev)
             _ -> handleInfoPanelEvent modalScroll (VtyEvent ev)
-      Just (MidScenarioModal RobotsModal) -> Brick.zoom (uiGameplay . uiDialogs . uiRobot) $ case ev of
-        V.EvKey (V.KChar '\t') [] -> robotDetailsFocus %= focusNext
-        _ -> do
-          isInDetailsMode <- use isDetailsOpened
-          if isInDetailsMode
-            then Brick.zoom (robotListContent . robotDetailsPaneState . logsList) $ handleListEvent ev
-            else do
-              Brick.zoom (robotListContent . robotsListWidget) $
-                handleMixedListEvent ev
-
-              -- Ensure list widget content is updated immediately
-              widget <- use $ robotListContent . robotsListWidget
-              forM_ (BL.listSelectedElement $ getList widget) $ updateRobotDetailsPane . snd
+      Just (MidScenarioModal RobotsModal) -> do
+        uiGame <- use uiGameplay
+        g <- use gameState
+        Brick.zoom (uiGameplay . uiDialogs . uiRobot) $ case ev of
+          V.EvKey (V.KChar '\t') [] -> robotDetailsPaneState . detailFocus %= focusNext
+          _ -> do
+            isInDetailsMode <- use isDetailsOpened
+            if isInDetailsMode
+              then Brick.zoom (robotDetailsPaneState . logsList) $ handleListEvent ev
+              else do
+                Brick.zoom robotsGridList $ BG.handleGridListEvent (robotGridRenderers uiGame g) ev
+                -- Ensure list widget content is updated immediately
+                mRob <- use $ robotsGridList . to (getSelectedRobot g)
+                forM_ mRob $ Brick.zoom robotDetailsPaneState . updateRobotDetailsPane
       _ -> handleInfoPanelEvent modalScroll (VtyEvent ev)
    where
     refreshGoalList lw = nestEventM' lw $ handleListEventWithSeparators ev shouldSkipSelection
@@ -651,7 +650,7 @@ runBaseWebCode uinput ureply = do
   if s ^. gameState . gameControls . replWorking
     then liftIO . ureply $ Rejected AlreadyRunning
     else do
-      gameState . gameControls . replListener .= (ureply . Complete . T.unpack)
+      gameState . gameControls . replListener .= ureply . Complete . T.unpack
       runBaseCode uinput
         >>= liftIO . ureply . \case
           Left err -> Rejected . ParseError $ T.unpack err
@@ -847,9 +846,7 @@ tabComplete CompletionContext {..} names em theRepl = case theRepl ^. replPrompt
     FunctionName -> (possibleWords, isIdentChar)
 
   possibleWords =
-    names <> case ctxCreativeMode of
-      True -> S.toList reservedWords
-      False -> S.toList $ reservedWords `S.difference` creativeWords
+    names <> (if ctxCreativeMode then S.toList reservedWords else S.toList $ reservedWords `S.difference` creativeWords)
 
   entityNames = M.keys $ entitiesByName em
 
@@ -904,7 +901,7 @@ adjReplHistIndex d s =
     newREPL :: REPLState
     newREPL = theRepl & replHistory %~ moveReplHistIndex d oldEntry
 
-    saveLastEntry = replLast .~ (theRepl ^. replPromptText)
+    saveLastEntry = replLast .~ theRepl ^. replPromptText
     showNewEntry = (replPromptEditor .~ newREPLEditor newEntry) . (replPromptType .~ CmdPrompt [])
     -- get REPL data
     getCurrEntry = fromMaybe (theRepl ^. replLast) . getCurrentItemText . view replHistory

src/swarm-tui/Swarm/TUI/Controller/UpdateUI.hs

@@ -19,7 +19,6 @@ import Control.Lens as Lens
 import Control.Monad (forM_, unless, when)
 import Control.Monad.IO.Class (liftIO)
 import Data.Foldable (toList)
-import Data.Function (on)
 import Data.List.Extra (enumerate)
 import Data.Map.Strict qualified as M
 import Data.Maybe (isNothing)
@@ -53,7 +52,6 @@ import Swarm.TUI.Model.UI.Gameplay
 import Swarm.TUI.View.Objective qualified as GR
 import Swarm.TUI.View.Robot
 import Swarm.TUI.View.Robot.Type
-import Swarm.Util (applyJust)
 import Witch (into)
 
 -- | Update the UI and redraw if needed.
@@ -191,8 +189,9 @@ updateUI = do
 
   -- Update the robots modal only when it is enabled.  See #2370.
   curModal <- use $ playState . scenarioState . uiGameplay . uiDialogs . uiModal
-  when ((view modalType <$> curModal) == Just (MidScenarioModal RobotsModal)) $ do
-    Brick.zoom (playState . scenarioState) $ doRobotListUpdate dOps g
+  when ((view modalType <$> curModal) == Just (MidScenarioModal RobotsModal)) $
+    Brick.zoom (playState . scenarioState . uiGameplay . uiDialogs . uiRobot) $
+      doRobotListUpdate dOps g
 
   let redraw =
         g ^. needsRedraw
@@ -203,36 +202,18 @@ updateUI = do
           || newPopups
   pure redraw
 
-doRobotListUpdate :: Set DebugOption -> GameState -> EventM Name ScenarioState ()
+doRobotListUpdate :: Set DebugOption -> GameState -> EventM Name RobotDisplay ()
 doRobotListUpdate dOps g = do
-  gp <- use uiGameplay
-
-  let rd =
-        mkRobotDisplay $
-          RobotRenderingContext
-            { _mygs = g
-            , _gameplay = gp
-            , _timing = gp ^. uiTiming
-            , _uiDbg = dOps
-            }
-      oldList = getList $ gp ^. uiDialogs . uiRobot . robotListContent . robotsListWidget
-      maybeOldSelected = snd <$> BL.listSelectedElement oldList
-
-      -- Since we're replacing the entire contents of the list, we need to preserve the
-      -- selected row here.
-      maybeModificationFunc =
-        updateList . BL.listFindBy . ((==) `on` view (robot . robotID)) <$> maybeOldSelected
-
-  uiGameplay . uiDialogs . uiRobot . robotListContent . robotsListWidget .= applyJust maybeModificationFunc rd
-
-  Brick.zoom (uiGameplay . uiDialogs . uiRobot) $
-    forM_ maybeOldSelected updateRobotDetailsPane
-
-updateRobotDetailsPane :: RobotWidgetRow -> EventM Name RobotDisplay ()
-updateRobotDetailsPane robotPayload =
-  Brick.zoom robotListContent $ do
-    robotDetailsPaneState . cmdHistogramList . BL.listElementsL .= V.fromList (M.toList (robotPayload ^. robot . activityCounts . commandsHistogram))
-    robotDetailsPaneState . logsList . BL.listElementsL .= robotPayload ^. robot . robotLog
+  robotsGridList %= updateRobotList dOps g
+  rList <- use robotsGridList
+  let mRob = getSelectedRobot g rList
+  forM_ mRob $ \r -> do
+    Brick.zoom robotDetailsPaneState $ updateRobotDetailsPane r
+
+updateRobotDetailsPane :: Robot -> EventM Name RobotDetailsPaneState ()
+updateRobotDetailsPane rob = do
+  cmdHistogramList . BL.listElementsL .= V.fromList (M.toList (rob ^. activityCounts . commandsHistogram))
+  logsList . BL.listElementsL .= (rob ^. robotLog)
 
 -- | Either pops up the updated Goals modal
 -- or pops up the Congratulations (Win) modal, or pops

src/swarm-tui/Swarm/TUI/Model/StateUpdate.hs

@@ -102,7 +102,6 @@ import Swarm.TUI.Model.UI.Gameplay
 import Swarm.TUI.View.Attribute.Attr (getWorldAttrName, swarmAttrMap)
 import Swarm.TUI.View.Attribute.CustomStyling (toAttrPair)
 import Swarm.TUI.View.Robot
-import Swarm.TUI.View.Robot.Type
 import Swarm.TUI.View.Structure qualified as SR
 import Swarm.Util
 import Swarm.Util.Effect (asExceptT, withThrow)
@@ -262,12 +261,7 @@ constructAppState (PersistentState rs ui key progState) opts@(AppOpts {..}) mCha
             { _uiModal = Nothing
             , _uiGoal = emptyGoalDisplay
             , _uiStructure = emptyStructureDisplay
-            , _uiRobot =
-                RobotDisplay
-                  { _robotDetailsFocus = focusRing $ map (RobotsListDialog . SingleRobotDetails) enumerate
-                  , _isDetailsOpened = False
-                  , _robotListContent = emptyRobotDisplay debugOptions
-                  }
+            , _uiRobot = emptyRobotDisplay debugOptions
             }
       , _uiIsAutoPlay = False
       , _uiAutoShowObjectives = autoShowObjectives

src/swarm-tui/Swarm/TUI/View.hs

@@ -20,7 +20,6 @@ module Swarm.TUI.View (
   -- * Robot panel
   drawRobotPanel,
   drawItem,
-  renderDutyCycle,
 
   -- * Info panel
   drawInfoPanel,
@@ -652,7 +651,7 @@ drawModal ::
 drawModal h ps isNoMenu = \case
   MidScenarioModal x -> case x of
     HelpModal -> helpWidget h $ gs ^. randomness . seed
-    RobotsModal -> drawRobotsModal $ uig ^. uiDialogs . uiRobot
+    RobotsModal -> drawRobotsDisplayModal uig gs $ uig ^. uiDialogs . uiRobot
     RecipesModal -> availableListWidget gs RecipeList
     CommandsModal -> commandsListWidget gs
     MessagesModal -> availableListWidget gs MessageList