From 7c778511f296c74f36c2b4967707c87ebf2fb808 Mon Sep 17 00:00:00 2001
From: Enrico Maria De Angelis <enricomaria.dean6elis@gmail.com>
Date: Sat, 30 Mar 2024 09:12:15 +0000
Subject: Add ctor for Locks plugin to accpet on/off labels

---
 doc/plugins.org             | 19 +++++++++++++++
 src/Xmobar/Plugins/Locks.hs | 58 ++++++++++++++++++++++++++++++++-------------
 xmobar.cabal                |  1 +
 3 files changed, 62 insertions(+), 16 deletions(-)

diff --git a/doc/plugins.org b/doc/plugins.org
index e408dec..ebe5a5b 100644
--- a/doc/plugins.org
+++ b/doc/plugins.org
@@ -698,18 +698,37 @@
       #+begin_src haskell
         Run Brightness ["-t", "<bar>"] 60
       #+end_src
+
 *** =Locks=
 
     - Displays the status of Caps Lock, Num Lock and Scroll Lock.
 
     - Aliases to =locks=
 
+    - Contructors:
+
+        - =Locks= is nullary and uses the strings =CAPS=, =NUM=, =SCROLL= to signal
+          that a lock is enabled (and empty strings to signal it's disabled)
+
+        - =Locks'= allow customizing the strings for the enabled/disabled states
+          of the 3 locks by accepting an assoc list of type =[(String, (String, String))]=,
+          which is expected to contain exactly 3 elements with keys
+          ="CAPS"=, ="NUM"=, ="SCROLL"=.
+
     - Example:
 
       #+begin_src haskell
+        -- using default labels
         Run Locks
       #+end_src
 
+      #+begin_src haskell
+        -- using custom labels
+        Run $ Locks' [("CAPS"  , ("<fc=#00ff00>\xf023</fc>", "<fc=#777777>\xf09c</fc>") )
+                     ,("NUM"   , ("<fc=#777777>\xf047</fc>", "<fc=#00ff00>\xf047</fc>" ) )
+                     ,("SCROLL", ("SlOCK", "" ))]
+      #+end_src
+
 ** Load and Process monitors
 *** =Load Args RefreshRate=
 
diff --git a/src/Xmobar/Plugins/Locks.hs b/src/Xmobar/Plugins/Locks.hs
index 9176312..35a3f97 100644
--- a/src/Xmobar/Plugins/Locks.hs
+++ b/src/Xmobar/Plugins/Locks.hs
@@ -1,3 +1,4 @@
+{-# LANGUAGE TupleSections #-}
 -----------------------------------------------------------------------------
 -- |
 -- Module      :  Plugins.Locks
@@ -16,45 +17,70 @@ module Xmobar.Plugins.Locks(Locks(..)) where
 
 import Graphics.X11
 import Data.List
+import Data.List.Extra (trim)
 import Data.Bits
+import Data.Maybe  (fromJust)
 import Control.Monad
+import Control.Monad.Extra (ifM)
 import Graphics.X11.Xlib.Extras
 import Xmobar.Run.Exec
 import Xmobar.System.Kbd
 import Xmobar.X11.Events (nextEvent')
 
-data Locks = Locks
+data Locks = Locks | Locks' [(String, (String, String))]
     deriving (Read, Show)
 
 locks :: [ ( KeySym, String )]
-locks = [ ( xK_Caps_Lock,   "CAPS"   )
-        , ( xK_Num_Lock,    "NUM"    )
+locks = [ ( xK_Caps_Lock,   "CAPS" )
+        , ( xK_Num_Lock,    "NUM" )
         , ( xK_Scroll_Lock, "SCROLL" )
         ]
 
-run' :: Display -> Window -> IO String
-run' d root = do
+type Labels = [ ( String, (String, String) )]
+defaultLabels :: Labels
+defaultLabels = let nms = map snd locks
+                in zip nms (map (, mempty) nms)
+
+type LabelledLock = (KeySym, String, String, String)
+
+attach :: (KeySym, String) -> Labels -> LabelledLock
+(key, lock) `attach` lbls = let (enb, dis) = fromJust $ lookup lock lbls
+                            in (key, lock, enb, dis)
+
+enabled :: (a, b, c, d) -> c
+enabled (_, _, c, _) = c
+disabled :: (a, b, c, d) -> d
+disabled (_, _, _, d) = d
+
+isEnabled :: (Bits a1, Foldable t, Foldable t1, Integral a)
+  => Display -> t (a, t1 KeyCode) -> a1 -> (KeySym, b, c, d) -> IO Bool
+isEnabled d modMap m ( ks, _, _, _ ) = do
+    kc <- keysymToKeycode d ks
+    return $ case find (elem kc . snd) modMap of
+        Nothing       -> False
+        Just ( i, _ ) -> testBit m (fromIntegral i)
+
+run' :: Display -> Window -> Labels -> IO String
+run' d root labels = do
     modMap <- getModifierMapping d
     ( _, _, _, _, _, _, _, m ) <- queryPointer d root
 
-    ls <- filterM ( \( ks, _ ) -> do
-        kc <- keysymToKeycode d ks
-        return $ case find (elem kc . snd) modMap of
-            Nothing       -> False
-            Just ( i, _ ) -> testBit m (fromIntegral i)
-        ) locks
-
-    return $ unwords $ map snd ls
+    ls' <- forM (map (`attach` labels) locks)
+                (\l -> ifM (isEnabled d modMap m l)
+                           (return (enabled l))
+                           (return (disabled l)))
+    return $ trim $ unwords ls'
 
 instance Exec Locks where
-    alias Locks = "locks"
-    start Locks cb = do
+    alias _ = "locks"
+    start Locks cb = start (Locks' defaultLabels) cb
+    start (Locks' labels) cb = do
         d <- openDisplay ""
         root <- rootWindow d (defaultScreen d)
         _ <- xkbSelectEventDetails d xkbUseCoreKbd xkbIndicatorStateNotify m m
 
         allocaXEvent $ \ep -> forever $ do
-            cb =<< run' d root
+            cb =<< run' d root labels
             nextEvent' d ep
             getEvent ep
 
diff --git a/xmobar.cabal b/xmobar.cabal
index 7559af2..c366f53 100644
--- a/xmobar.cabal
+++ b/xmobar.cabal
@@ -204,6 +204,7 @@ library
                   colour >= 2.3.6,
                   containers,
                   directory,
+                  extra,
                   extensible-exceptions == 0.1.*,
                   filepath,
                   mtl >= 2.1 && < 2.4,
-- 
cgit v1.2.3