From 35a32b22d057b18c2febb61df3fd982f7e18f3e1 Mon Sep 17 00:00:00 2001
From: slotThe <soliditsallgood@mailbox.org>
Date: Mon, 10 May 2021 09:09:36 +0200
Subject: [PATCH] X.A.TopicSpace: Add TopicItem and helper functions

Add the convenience type `TopicItem`, for easier (and safer!)
specification of topics, as well as several small helper functions to
help users work with it.
---
 XMonad/Actions/TopicSpace.hs | 45 +++++++++++++++++++++++++++++++++---
 1 file changed, 42 insertions(+), 3 deletions(-)

diff --git a/XMonad/Actions/TopicSpace.hs b/XMonad/Actions/TopicSpace.hs
index 2f0dab71..a8170d58 100644
--- a/XMonad/Actions/TopicSpace.hs
+++ b/XMonad/Actions/TopicSpace.hs
@@ -1,3 +1,4 @@
+{-# LANGUAGE NamedFieldPuns #-}
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  XMonad.Actions.TopicSpace
@@ -23,6 +24,7 @@ module XMonad.Actions.TopicSpace
     Topic
   , Dir
   , TopicConfig(..)
+  , TopicItem(..)
 
     -- * Default Topic Config
   , def
@@ -39,6 +41,13 @@ module XMonad.Actions.TopicSpace
   , topicAction
   , currentTopicAction
 
+    -- * Managing 'TopicItem's
+  , topicNames
+  , tiActions
+  , tiDirs
+  , noAction
+  , inHome
+
     -- * Getting the Topic History
   , getLastFocusedTopics
   , workspaceHistory
@@ -69,6 +78,7 @@ import qualified Data.Map.Strict         as M
 import qualified XMonad.Hooks.DynamicLog as DL
 import qualified XMonad.StackSet         as W
 
+import Data.Map (Map)
 import System.IO (hClose, hPutStr)
 
 import XMonad.Prompt (XPConfig)
@@ -109,7 +119,7 @@ import XMonad.Util.Run (spawnPipe)
 --
 -- You will then have to
 --
---   * Define new a new 'TopicConfig'
+--   * Define a new 'TopicConfig'
 --
 --   * Add the appropriate keybindings
 --
@@ -267,9 +277,9 @@ type Topic = WorkspaceId
 type Dir = FilePath
 
 -- | Here is the topic space configuration area.
-data TopicConfig = TopicConfig { topicDirs          :: M.Map Topic Dir
+data TopicConfig = TopicConfig { topicDirs          :: Map Topic Dir
                                  -- ^ This mapping associates a directory to each topic.
-                               , topicActions       :: M.Map Topic (X ())
+                               , topicActions       :: Map Topic (X ())
                                  -- ^ This mapping associates an action to trigger when
                                  -- switching to a given topic which workspace is empty.
                                , defaultTopicAction :: Topic -> X ()
@@ -414,3 +424,32 @@ xmessage s = do
   h <- spawnPipe "xmessage -file -"
   hPutStr h s
   hClose h
+
+-- | Convenience type for specifying topics.
+data TopicItem = TI
+  { tiName   :: !Topic  -- ^ 'Topic' ≡ 'String'
+  , tiDir    :: !Dir    -- ^ Directory associated with topic; 'Dir' ≡ 'String'
+  , tiAction :: !(X ()) -- ^ Startup hook when topic is empty
+  }
+
+-- | Extract the names from a given list of 'TopicItem's.
+topicNames :: [TopicItem] -> [Topic]
+topicNames = map tiName
+
+-- | From a list of 'TopicItem's, build a map that can be supplied as
+-- the 'topicDirs'.
+tiDirs :: [TopicItem] -> Map Topic Dir
+tiDirs = M.fromList . map (\TI{ tiName, tiDir } -> (tiName, tiDir))
+
+-- | From a list of 'TopicItem's, build a map that can be supplied as
+-- the 'topicActions'.
+tiActions :: [TopicItem] -> Map Topic (X ())
+tiActions = M.fromList . map (\TI{ tiName, tiAction } -> (tiName, tiAction))
+
+-- | Associate a directory with the topic, but don't spawn anything.
+noAction :: Topic -> Dir -> TopicItem
+noAction n d = TI n d (pure ())
+
+-- | Topic with @tiDir = ~/@.
+inHome :: Topic -> X () -> TopicItem
+inHome n = TI n "."