New module: XMonad.Util.WindowState

Ignore-this: 14a6fa263c423cd8cca3b2645b3930d7

Save almost arbitary data per window

darcs-hash:20140218100229-71adb-e69daa4b2d56a5308e37cb9bb41a893ab3905fbe.gz

2 files changed, 93 insertions, 0 deletions

diff --git a/XMonad/Util/WindowState.hs b/XMonad/Util/WindowState.hs
new file mode 100644
index 0000000..09c98c9
--- /dev/null
+++ b/XMonad/Util/WindowState.hs
@@ -0,0 +1,92 @@
+{-#
+  LANGUAGE ScopedTypeVariables, GeneralizedNewtypeDeriving,
+  FlexibleInstances, MultiParamTypeClasses
+  #-}
+-----------------------------------------------------------------------------
+-- |
+-- Module       : XMonad.Util.WindowState
+-- Copyright    : (c) Dmitry Bogatov <KAction@gnu.org>
+-- License      : BSD
+--
+-- Maintainer   : Dmitry Bogatov <KAction@gnu.org>
+-- Stability    : unstable
+-- Portability  : unportable
+--
+-- Functions for saving per-window data.
+-----------------------------------------------------------------------------
+
+module XMonad.Util.WindowState ( -- * Usage
+                                 -- $usage
+                                 get,
+                                 put,
+                                 StateQuery(..),
+                                 runStateQuery,
+                                 getQuery ) where
+import XMonad hiding (get, put, modify)
+import Control.Monad.Reader(ReaderT(..))
+import Control.Monad.State.Class
+import Control.Monad.State(StateT(..), evalStateT)
+import Control.Monad.Trans(MonadTrans, lift)
+import Data.Typeable (Typeable, typeOf)
+import Control.Applicative((<$>))
+-- $usage
+--
+-- This module allow to store state data with some 'Window'.
+-- It is implemented with XProperties, so resources will be freed when
+-- 'Window' is destoyed.
+--
+-- This module have advantage over "XMonad.Actions.TagWindows" in that it
+-- hides from you implementation details and provides simple type-safe
+-- interface.  Main datatype is "StateQuery", which is simple wrapper around
+-- "Query", which is instance of MonadState, with 'put' and 'get' are
+-- functions to acess data, stored in "Window".
+--
+-- To save some data in window you probably want to do following:
+-- > (runStateQuery  (put $ Just value)  win) :: X ()
+-- To retrive it, you can use
+-- > (runStateQuery get win) :: X (Maybe YourValueType)
+-- "Query" can be promoted to "StateQuery" simply by constructor,
+-- and reverse is 'getQuery'.
+--
+-- For example, I use it to have all X applications @russian@ or @dvorak@
+-- layout, but emacs have only @us@, to not screw keybindings. Use your
+-- imagination!
+
+-- | Wrapper around "Query" with phanom type @s@, representing state, saved in
+-- window.
+newtype StateQuery s a = StateQuery {
+      getQuery :: Query a
+    } deriving (Monad, MonadIO, Functor)
+
+packIntoQuery :: (Window -> X a) -> Query a
+packIntoQuery = Query . ReaderT
+
+-- | Apply "StateQuery" to "Window".
+runStateQuery :: StateQuery s a -> Window ->  X a
+runStateQuery = runQuery . getQuery
+
+-- | Lifted to "Query" version of 'catchX'
+catchQuery :: Query a -> Query (Maybe a)
+catchQuery q = packIntoQuery $ \win -> userCode $ runQuery q win
+
+-- | Instance of MonadState for StateQuery.
+instance (Show s, Read s, Typeable s) => MonadState (Maybe s) (StateQuery s) where
+    get = StateQuery  $ read' <$> get' undefined where
+        get'   :: (Maybe s) -> Query String
+        get' x = stringProperty (typePropertyName x)
+        read'  :: (Read s) => String -> Maybe s
+        read' "" = Nothing
+        read' s  = Just $ read s
+    put = StateQuery . packIntoQuery <$> setWindowProperty' where
+        setWindowProperty' val = setWindowProperty prop strValue where
+            prop = typePropertyName val
+            strValue = maybe "" show val
+
+typePropertyName :: (Typeable a) => a -> String
+typePropertyName x = "_XMONAD_WINSTATE__" ++ show (typeOf x)
+
+type PropertyName = String
+setWindowProperty :: PropertyName -> String -> Window -> X ()
+setWindowProperty prop val win = withDisplay $ \d -> io $
+                                 internAtom d prop False >>=
+                                 setTextProperty d win val
diff --git a/xmonad-contrib.cabal b/xmonad-contrib.cabal
index 95f6f64..3b65628 100644
--- a/xmonad-contrib.cabal
+++ b/xmonad-contrib.cabal
@@ -317,6 +317,7 @@ library
                         XMonad.Util.Timer
                         XMonad.Util.Types
                         XMonad.Util.WindowProperties
+                        XMonad.Util.WindowState
                         XMonad.Util.WorkspaceCompare
                         XMonad.Util.XSelection
                         XMonad.Util.XUtils