Overhaul how Wml is implemented.

This adds a new "KeyFeed" monad which is reminiscent of a parsec-type
monad. This allows keys like 'g' to be mapped using a subbind and the
actual WML part be handled in the catch-all handler.

This also significantly cleans up the typing and complexity of the Wml
implementation.

1 files changed, 215 insertions, 229 deletions

diff --git a/src/Rahm/Desktop/Keys.hs b/src/Rahm/Desktop/Keys.hs
index a4415da..a29f080 100644
--- a/src/Rahm/Desktop/Keys.hs
+++ b/src/Rahm/Desktop/Keys.hs
@@ -63,26 +63,9 @@ import Rahm.Desktop.History
     jumpToLastLocation,
   )
 import Rahm.Desktop.Keys.Dsl2
-import Rahm.Desktop.Keys.Grab (KeySymOrKeyCode(..))
+import Rahm.Desktop.Keys.Grab (KeySymOrKeyCode (..))
+import Rahm.Desktop.Keys.KeyFeed (execKeyFeed, liftXToFeed, pushKey, runKeyFeed, runKeyFeedX)
 import Rahm.Desktop.Keys.Wml
-  ( addWindowToSelection,
-    clearWindowSelection,
-    getAndResetWindowSelection,
-    gotoWorkspaceFn,
-    moveWindowToWorkspaceFn,
-    readNextLocationSet,
-    readNextLocationSet',
-    readNextWorkspace,
-    readNextWorkspaceName,
-    readWindowsetMacro,
-    readWorkspaceMacro,
-    removeWindowFromSelection,
-    toggleWindowInSelection,
-    withNextWorkspaceOrKey,
-    workspaceForString,
-    workspaceForStringT,
-    workspaceName,
-  )
 import Rahm.Desktop.Layout (nLayouts)
 import Rahm.Desktop.Layout.ConsistentMosaic
   ( expandPositionAlt,
@@ -276,13 +259,13 @@ bindings = do
         ifM
           D.isDragging
           (D.finishDrag >> withFocused D.sinkByWindowUnderCursor)
-          $ pushPendingBuffer "' " $
-            do
-              runMaybeT_ $ do
-                l <- readNextLocationSet'
-                case l of
-                  (h : _) -> lift (focusLocation h)
-                  _ -> return ()
+          $ pushPendingBuffer "' "
+          $ do
+            runMaybeT_ $ do
+              l <- runKeyFeed readNextLocationSet'
+              case l of
+                (h : _) -> lift (focusLocation h)
+                _ -> return ()
     shiftMod $
       doc "Drag workspace to another." D.dragWindow
 
@@ -296,10 +279,10 @@ bindings = do
       doc "Swap windows with other windows" $
         pushPendingBuffer "w " $ do
           runMaybeT_ $ do
-            l1 <- mapMaybe (\(Location _ w) -> w) <$> readNextLocationSet
+            l1 <- mapMaybe (\(Location _ w) -> w) <$> runKeyFeed readNextLocationSet
             withBorderColorM selectedWindowsColor l1 $ do
               lift $ addStringToPendingBuffer " "
-              l2 <- mapMaybe (\(Location _ w) -> w) <$> readNextLocationSet
+              l2 <- mapMaybe (\(Location _ w) -> w) <$> runKeyFeed readNextLocationSet
               let (l1', l2') =
                     if length l1 > length l2
                       then (l1, l2)
@@ -309,20 +292,20 @@ bindings = do
               lift $ do
                 setAlternateWindows (l1'' ++ l2')
                 windows $ W.swapWindows $ zip l1'' l2' ++ zip l2' l1''
-    shiftMod $
-      doc
+    shiftMod
+      $ doc
         "Swap two workspaces (or rename the current one). \
         \(only works on normal workspaces)."
-        $ pushPendingBuffer "W " $
-          do
-            logs Debug "%s" . W.dbgStackSet =<< gets windowset
-            runMaybeT_ $ do
-              w1 <- readNextWorkspaceName
-              wins <- lift $ W.windowsOnWorkspace w1 <$> gets windowset
-              withBorderColorM selectedWindowsColor wins $ do
-                lift $ addStringToPendingBuffer " "
-                w2 <- readNextWorkspaceName
-                lift $ windows $ W.swapWorkspaces w1 w2
+      $ pushPendingBuffer "W "
+      $ do
+        logs Debug "%s" . W.dbgStackSet =<< gets windowset
+        runMaybeT_ $ do
+          w1 <- runKeyFeed readNextWorkspaceName
+          wins <- lift $ W.windowsOnWorkspace w1 <$> gets windowset
+          withBorderColorM selectedWindowsColor wins $ do
+            lift $ addStringToPendingBuffer " "
+            w2 <- runKeyFeed readNextWorkspaceName
+            lift $ windows $ W.swapWorkspaces w1 w2
 
   bind xK_BackSpace $ do
     -- Moves xmobar to different monitors.
@@ -350,12 +333,12 @@ bindings = do
             ++ documentation config bindings
 
   bind xK_F1 $ do
-    justMod $
-      doc
+    justMod
+      $ doc
         "Print this documentation"
-        $ do
-          doc <- getDoc
-          safeSpawn "gxmessage" ["-fn", "Source Code Pro", doc]
+      $ do
+        doc <- getDoc
+        safeSpawn "gxmessage" ["-fn", "Source Code Pro", doc]
 
   bind xK_F7 $ do
     justMod $
@@ -406,14 +389,15 @@ bindings = do
       doc "Kill the current window" CopyWindow.kill1
 
   bind xK_f $ do
-    justMod $
-      doc
+    justMod
+      $ doc
         "Focus (non-greedily) a workspace. Useful for focusing between \
         \screens with ',.', '$', '^', etc."
-        $ pushPendingBuffer "f " $ do
-          runMaybeT_ $ do
-            ws <- readNextWorkspaceName
-            lift $ windows $ W.view ws
+      $ pushPendingBuffer "f "
+      $ do
+        runMaybeT_ $ do
+          ws <- runKeyFeed readNextWorkspaceName
+          lift $ windows $ W.view ws
 
   bind xK_a $ do
     justMod $
@@ -431,8 +415,8 @@ bindings = do
           lift $ windows $ W.view ws
 
   bind xK_g $ do
-    justMod $
-      doc
+    justMod
+      $ doc
         "Goto To a workspace\n\n\t\
         \Workspacs are alphanumeric characters. So if the next key typed is an\n\t\
         \alphanumeric character, that's the workspace to operate on\n\n\
@@ -451,66 +435,70 @@ bindings = do
         \_: Black hole. Sending a window here closes it.\n\n\t\
         \Other keybindings starting with H-g\n\t\t\
         \F1: display this help.\n\n\t"
-        $ pushPendingBuffer "g " $
-          runMaybeT_ $
-            withNextWorkspaceOrKey
-              gotoWorkspaceFn
-              ( \case
-                  (_, s, _) | s == xK_F1 -> do
-                    doc <- getDoc
-                    safeSpawn "gxmessage" ["-fn", "Source Code Pro", doc]
-                  (_, s, _) | s == xK_F5 -> do
-                    spawnX "xmonad --recompile && xmonad --restart"
-                  _ -> return ()
-              )
-    shiftMod $
-      doc
+      $ subbind
+      $ do
+        bind xK_F1 $
+          (noMod -|- justMod) $ do
+            doc <- getDoc
+            safeSpawn "gxmessage" ["-fn", "Source Code Pro", doc]
+
+        bind xK_F5 $
+          (noMod -|- justMod) $
+            spawnX "xmonad --recompile && xmonad --restart"
+
+        bindOtherKeys $ \key -> execKeyFeed $ do
+          pushKey key
+          ws <- readNextWorkspace
+          liftXToFeed $ gotoWorkspaceFn ws
+
+    shiftMod
+      $ doc
         "Switch a workspace with another workspace. \
         \This is a more powerful version of the 'g' command, which does not\
         \assume the current workspace.\
         \which takes two workspaces as arguments and switches them whereas\
         \the 'g' command operates only on the current workspace (.).\
         \thereby G.<ws> is the same as g<ws>"
-        $ do
-          pushPendingBuffer "G " $ do
-            runMaybeT_ $ do
-              w1 <- readNextWorkspaceName
-              lift $ addStringToPendingBuffer " "
-              w2 <- readNextWorkspaceName
-              lift $ windows $ W.switchWorkspaces w1 w2
+      $ do
+        pushPendingBuffer "G " $ do
+          runMaybeT_ $ do
+            w1 <- runKeyFeed readNextWorkspaceName
+            lift $ addStringToPendingBuffer " "
+            w2 <- runKeyFeed readNextWorkspaceName
+            lift $ windows $ W.switchWorkspaces w1 w2
 
   bind xK_d $
     justMod $
       doc "Record (define) macros." $
         subbind $ do
-          bind xK_w $
-            noMod $
-              doc
-                "Record a windowset macro.\n\n\t\
-                \To record a 'windowset' macro, type <M-d>w<key> and then\n\t\
-                \type a character sequence followed by Enter. Now <key> can\n\t\
-                \be used anywhere a 'windowset' is required and that macro\n\t\
-                \will be used.\n\n\t\
-                \For example, if one wants to define '+' as 'all windows \n\t\
-                \not on the current workspace, one can type:\n\n\t\
-                \<M-d>w+\\%@.<Enter>\n"
-                $ pushPendingBuffer "Win Macro " $
-                  runMaybeT_ readWindowsetMacro
-
-          bind xK_t $
-            noMod $
-              doc
-                "Record a workspace macro\n\n\t\
-                \To record a 'workspace' macro, type <M-d>t<key> and then\n\t\
-                \type a character sequence followed by Enter. Now <key> can\n\t\
-                \be used anywhere a 'workspace' is required and that macro\n\t\
-                \will be used.\n\n\t\
-                \For example, if one wants to define '<c-s>' as 'the workspace with\n\t\
-                \the window 's' on it or the last workspace if already on that \n\t\
-                \workspace (more useful that one would think):\n\n\t\
-                \<M-d>t<c-s>?&s@.'s<Enter>\n"
-                $ pushPendingBuffer "Wksp Macro " $
-                  runMaybeT_ readWorkspaceMacro
+          bind xK_w
+            $ noMod
+            $ doc
+              "Record a windowset macro.\n\n\t\
+              \To record a 'windowset' macro, type <M-d>w<key> and then\n\t\
+              \type a character sequence followed by Enter. Now <key> can\n\t\
+              \be used anywhere a 'windowset' is required and that macro\n\t\
+              \will be used.\n\n\t\
+              \For example, if one wants to define '+' as 'all windows \n\t\
+              \not on the current workspace, one can type:\n\n\t\
+              \<M-d>w+\\%@.<Enter>\n"
+            $ pushPendingBuffer "Win Macro "
+            $ runMaybeT_ readWindowsetMacro
+
+          bind xK_t
+            $ noMod
+            $ doc
+              "Record a workspace macro\n\n\t\
+              \To record a 'workspace' macro, type <M-d>t<key> and then\n\t\
+              \type a character sequence followed by Enter. Now <key> can\n\t\
+              \be used anywhere a 'workspace' is required and that macro\n\t\
+              \will be used.\n\n\t\
+              \For example, if one wants to define '<c-s>' as 'the workspace with\n\t\
+              \the window 's' on it or the last workspace if already on that \n\t\
+              \workspace (more useful that one would think):\n\n\t\
+              \<M-d>t<c-s>?&s@.'s<Enter>\n"
+            $ pushPendingBuffer "Wksp Macro "
+            $ runMaybeT_ readWorkspaceMacro
 
   bind xK_h $ do
     justMod $
@@ -570,24 +558,24 @@ bindings = do
         pushPendingBuffer "p " $
           runMaybeT_ $
             do
-              windows <- mapMaybe locationWindow <$> readNextLocationSet
+              windows <- mapMaybe locationWindow <$> runKeyFeed readNextLocationSet
               lift $ mapM_ pinWindow windows
 
     shiftMod $
       doc "Unpin a windowset" $
         pushPendingBuffer "P " $
           runMaybeT_ $ do
-            windows <- mapMaybe locationWindow <$> readNextLocationSet
+            windows <- mapMaybe locationWindow <$> runKeyFeed readNextLocationSet
             lift $ mapM_ unpinWindow windows
 
   bind xK_minus $ do
-    justMod $
-      doc
+    justMod
+      $ doc
         "Decrease the number of windows in the  master region, or decrease\n\t\
         \the size of the master region if the current layout cannot have more\n\t\
         \than one window in the master region."
-        $ sendMessage $
-          IncMasterN (-1)
+      $ sendMessage
+      $ IncMasterN (-1)
 
     shiftMod $
       doc "For mosaic layout, shrink the size-share of the current window" $
@@ -611,7 +599,7 @@ bindings = do
           doc d $
             pushPendingBuffer ch $ do
               runMaybeT_ $ do
-                locset <- readNextLocationSet'
+                locset <- runKeyFeed readNextLocationSet'
                 lift $
                   forM_ locset $ \(Location _ mWin) ->
                     mapM_ fn mWin
@@ -622,34 +610,35 @@ bindings = do
         flip whenJust toggleWindowInSelection =<< withWindowSet (return . W.peek)
 
   bind xK_m $ do
-    rawMask mod2Mask
+    rawMask
+      mod2Mask
       (logs Info "Testing Mod2Mask" :: X ())
 
-    justMod $
-      doc
+    justMod
+      $ doc
         "Mark the windows described by the window set with a given character.\n\n\t\
         \For example, to mark the current window use <M-m>.<character>. That window\n\n\t\
         \can then be recalled anywhere that requires a WML window.\n"
-        $ do
-          pushPendingBuffer "m " $ do
-            locs <- fromMaybe [] <$> runMaybeT readNextLocationSet
-            let wins = mapMaybe locationWindow locs
-            unless (null wins) $ do
-              withBorderColor selectedWindowsColor wins $ do
-                runMaybeT_ $ do
-                  mapNextString $ \_ str -> lift $
-                    case str of
-                      [ch] | isAlpha ch -> markAllLocations str locs
-                      _ -> return ()
+      $ do
+        pushPendingBuffer "m " $ do
+          locs <- fromMaybe [] <$> runKeyFeedX readNextLocationSet
+          let wins = mapMaybe locationWindow locs
+          unless (null wins) $ do
+            withBorderColor selectedWindowsColor wins $ do
+              runMaybeT_ $ do
+                mapNextString $ \_ str -> lift $
+                  case str of
+                    [ch] | isAlpha ch -> markAllLocations str locs
+                    _ -> return ()
 
   bind xK_plus $ do
-    justMod $
-      doc
+    justMod
+      $ doc
         "Increase the number of windows in the  master region, or increase\n\t\
         \the size of the master region if the current layout cannot have more\n\t\
         \than one window in the master region.\n"
-        $ sendMessage $
-          IncMasterN 1
+      $ sendMessage
+      $ IncMasterN 1
 
     shiftMod $
       doc "For mosaic layout, increase the size-share of the current window." $
@@ -673,8 +662,8 @@ bindings = do
         (ShiftAndFollow, controlMod)
       ]
       $ \(shiftType, f) ->
-        f $
-          doc
+        f
+          $ doc
             ( case shiftType of
                 ShiftAndFollow ->
                   "Shift-and-follow: Like shift-and-swap with the implicit \
@@ -686,54 +675,54 @@ bindings = do
                   \Note that this command will only work with normal workspaces."
                 JustShift -> "Shift a windowset to a workspace"
             )
-            $ pushPendingBuffer
-              ( case shiftType of
-                  ShiftAndSwap -> "S "
-                  JustShift -> "s "
-                  ShiftAndFollow -> "^s "
-              )
-              $ runMaybeT_ $
-                do
-                  stackset <- lift $ X.windowset <$> X.get
-                  selection <- mapMaybe locationWindow <$> readNextLocationSet
-                  withBorderColorM selectedWindowsColor selection $ do
+          $ pushPendingBuffer
+            ( case shiftType of
+                ShiftAndSwap -> "S "
+                JustShift -> "s "
+                ShiftAndFollow -> "^s "
+            )
+          $ runMaybeT_
+          $ do
+            stackset <- lift $ X.windowset <$> X.get
+            selection <- mapMaybe locationWindow <$> runKeyFeed readNextLocationSet
+            withBorderColorM selectedWindowsColor selection $ do
+              lift $ addStringToPendingBuffer " "
+              ws <- runKeyFeed readNextWorkspace
+              finalSwap <-
+                case shiftType of
+                  ShiftAndSwap -> do
                     lift $ addStringToPendingBuffer " "
-                    ws <- readNextWorkspace
-                    finalSwap <-
-                      case shiftType of
-                        ShiftAndSwap -> do
-                          lift $ addStringToPendingBuffer " "
-                          wsName <- MaybeT . return $ workspaceName ws
-                          W.switchWorkspaces wsName <$> readNextWorkspaceName
-                        _ -> return id
-
-                    lift $ do
-                      (Endo allMovements) <-
-                        mconcat
-                          <$> mapM (fmap Endo . moveWindowToWorkspaceFn ws) selection
-
-                      setAlternateWindows selection
-
-                      forM_ selection $ \win -> do
-                        mapM_
-                          ( \t -> do
-                              logs Debug "Set alternate workspace %s -> %s" (show win) t
-                              setAlternateWorkspace win t
-                          )
-                          (W.findTag win stackset)
-
-                      withWindowsUnpinned selection $
-                        windows $
-                          finalSwap
-                            . ( \ss ->
-                                  case shiftType of
-                                    ShiftAndFollow
-                                      | (w : _) <- selection,
-                                        Just ws <- W.findTag w ss ->
-                                        W.greedyView ws ss
-                                    _ -> ss
-                              )
-                            . allMovements
+                    wsName <- MaybeT . return $ workspaceName ws
+                    W.switchWorkspaces wsName <$> runKeyFeed readNextWorkspaceName
+                  _ -> return id
+
+              lift $ do
+                (Endo allMovements) <-
+                  mconcat
+                    <$> mapM (fmap Endo . moveWindowToWorkspaceFn ws) selection
+
+                setAlternateWindows selection
+
+                forM_ selection $ \win -> do
+                  mapM_
+                    ( \t -> do
+                        logs Debug "Set alternate workspace %s -> %s" (show win) t
+                        setAlternateWorkspace win t
+                    )
+                    (W.findTag win stackset)
+
+                withWindowsUnpinned selection $
+                  windows $
+                    finalSwap
+                      . ( \ss ->
+                            case shiftType of
+                              ShiftAndFollow
+                                | (w : _) <- selection,
+                                  Just ws <- W.findTag w ss ->
+                                    W.greedyView ws ss
+                              _ -> ss
+                        )
+                      . allMovements
 
     altMod $ spawnX "sudo -A systemctl suspend && xsecurelock"
 
@@ -743,7 +732,8 @@ bindings = do
         sendMessage ToggleStruts
     shiftMod $
       doc "Remove the border from the focused window" $
-        withFocused $ setBorderWidth 0 . (: [])
+        withFocused $
+          setBorderWidth 0 . (: [])
 
   bind xK_space $ do
     justMod $
@@ -789,25 +779,25 @@ bindings = do
               doc "Jump to the middle layout." $
                 sendMessage (toIndexedLayout (nLayouts `div` 2))
 
-          bind xK_g $
-            (noMod -|- justMod) $
-              doc
-                "Switch to a different theater.\n\n\t\
-                \Theaters are like super-workspaces. They are used for different\n\t\
-                \'contexts'. Theaters share all the windows with eachother, but\n\t\
-                \but each theater has its own mappings for window -> workspace. i.e.\n\t\
-                \one theater can have window 'x' on workspace 'y', but another might\n\t\
-                \have 'x' on 'z' instead. If a theater does explicity place a window,\n\t\
-                \the window is placed in the hidden workspace (which is '*')\n"
-                $ do
-                  addStringToPendingBuffer " g "
-                  runMaybeT_ $
-                    do
-                      mapNextString $ \_ str -> lift $
-                        case str of
-                          [ch] | isAlpha ch -> restoreTheater (Just [ch])
-                          [' '] -> restoreTheater Nothing
-                          _ -> return ()
+          bind xK_g
+            $ (noMod -|- justMod)
+            $ doc
+              "Switch to a different theater.\n\n\t\
+              \Theaters are like super-workspaces. They are used for different\n\t\
+              \'contexts'. Theaters share all the windows with eachother, but\n\t\
+              \but each theater has its own mappings for window -> workspace. i.e.\n\t\
+              \one theater can have window 'x' on workspace 'y', but another might\n\t\
+              \have 'x' on 'z' instead. If a theater does explicity place a window,\n\t\
+              \the window is placed in the hidden workspace (which is '*')\n"
+            $ do
+              addStringToPendingBuffer " g "
+              runMaybeT_ $
+                do
+                  mapNextString $ \_ str -> lift $
+                    case str of
+                      [ch] | isAlpha ch -> restoreTheater (Just [ch])
+                      [' '] -> restoreTheater Nothing
+                      _ -> return ()
 
           bind xK_x $ do
             shiftMod $
@@ -859,10 +849,6 @@ bindings = do
       doc "Spawn a floating terminal" $
         spawnX =<< asks ((++ " -t Floating\\ Term") . terminal . config)
 
-  bind xK_i $ do
-    justMod $ do
-      logs Info "Numlock mask: %s" =<< (gets (show . numberlockMask)) :: X ()
-
   bind xK_z $ do
     justMod $
       doc "Less often used keybindings." $
@@ -933,8 +919,8 @@ bindings = do
         sendMessage togglePop
 
   bind xK_F8 $ do
-    justMod $
-      doc
+    justMod
+      $ doc
         "Set the log level.\n\
         \Log levels are, in order\n\n\t\
         \Trace\n\t\
@@ -944,15 +930,15 @@ bindings = do
         \Error\n\t\
         \Fatal\n\n\
         \Log is sent to stdout."
-        $ do
-          ll <- getLogLevel
-          let next = if minBound == ll then maxBound else pred ll
+      $ do
+        ll <- getLogLevel
+        let next = if minBound == ll then maxBound else pred ll
 
-          safeSpawnX
-            "notify-send"
-            ["-t", "2000", printf "LogLevel set to %s" (show next)]
-          setLogLevel next
-          logs next "LogLevel set to %s." (show next)
+        safeSpawnX
+          "notify-send"
+          ["-t", "2000", printf "LogLevel set to %s" (show next)]
+        setLogLevel next
+        logs next "LogLevel set to %s." (show next)
 
   bind xF86XK_Calculator $ do
     noMod $
@@ -1220,25 +1206,25 @@ bindings = do
 
             forM_ [(button7, ",.", "right"), (button6, ";.", "left")] $
               \(b, mot, d) -> do
-                bind b $
-                  noMod $
-                    doc
-                      ( "Move the selected windows to the workspace on the \
-                        \screen to the "
-                          ++ d
-                      )
-                      $ noWindow $
-                        do
-                          wins <- getAndResetWindowSelection
-                          runMaybeT_ $ do
-                            ws' <- workspaceForStringT mot
-                            ws <- MaybeT . return $ workspaceName ws'
-                            lift $
-                              let f =
-                                    appEndo
-                                      ( mconcat (map (Endo . W.shiftWin ws) wins)
-                                      )
-                               in windows f >> escape
+                bind b
+                  $ noMod
+                  $ doc
+                    ( "Move the selected windows to the workspace on the \
+                      \screen to the "
+                        ++ d
+                    )
+                  $ noWindow
+                  $ do
+                    wins <- getAndResetWindowSelection
+                    runMaybeT_ $ do
+                      ws' <- workspaceForStringT mot
+                      ws <- MaybeT . return $ workspaceName ws'
+                      lift $
+                        let f =
+                              appEndo
+                                ( mconcat (map (Endo . W.shiftWin ws) wins)
+                                )
+                         in windows f >> escape
 
   -- Keycode Bindings.
   --