Personal tools

Xmonad/Mutable state in contrib modules or xmonad.hs

From HaskellWiki

< Xmonad(Difference between revisions)
Jump to: navigation, search
(XMonad.Util.StringProp: link to haddock)
(add implicit params example)
Line 1: Line 1:
 
This page describes how to keep track of mutable state in a module in xmonad-contrib or in the configuration.
 
This page describes how to keep track of mutable state in a module in xmonad-contrib or in the configuration.
  +
 
= General options =
 
= General options =
 
== Layouts ==
 
== Layouts ==
 
Layouts can keep track of their state placing the information in the data type that is an instance of LayoutClass. The various methods of this typeclass allow one to update this information by supplying a new value of this type as a return value.
 
Layouts can keep track of their state placing the information in the data type that is an instance of LayoutClass. The various methods of this typeclass allow one to update this information by supplying a new value of this type as a return value.
  +
  +
Note that this sensible for per-workspace state.
  +
 
== Data.IORef ==
 
== Data.IORef ==
 
A more general way is to store data using [http://hackage.haskell.org/packages/archive/base/latest/doc/html/Data-IORef.html Data.IORef]. To create an IORef, one uses newIORef; the returned value can then be passed to functions for reading from or writing to it.
 
A more general way is to store data using [http://hackage.haskell.org/packages/archive/base/latest/doc/html/Data-IORef.html Data.IORef]. To create an IORef, one uses newIORef; the returned value can then be passed to functions for reading from or writing to it.
Line 25: Line 29:
 
ref <- newIORef 0 -- this is the initival value
 
ref <- newIORef 0 -- this is the initival value
 
xmonad defaultConfig `additionalKeysP` [("M-S-t", updatingBinding ref)]
 
xmonad defaultConfig `additionalKeysP` [("M-S-t", updatingBinding ref)]
  +
</haskell>
  +
  +
=== Implicit Parameters ===
  +
This extension is useful for passing in the iorefs. You generally need these two extensions together, if you like to leave out the type signatures (which are as much work as explicitly passing the parameters):
  +
  +
<haskell>
  +
{-# LANGUAGE ImplicitParams, NoMonomorphismRestriction #-}
  +
  +
main = do
  +
ref <- newIORef 0
  +
let ?ref = ref -- all references to ?ref later on will be this one
  +
xmonad defaultConfig `additionalKeysP` [("M-S-t", updatingBinding)]
  +
  +
-- updatingBinding :: (?ref :: IORef Integer) => X () -- this is the actual type
  +
updatingBinding = do
  +
val <- io $ readIORef ?ref
  +
io $ writeIORef ?ref (val+1)
  +
spawn $ "xmessage I have been pressed " ++ show val ++ " times before!"
 
</haskell>
 
</haskell>
   

Revision as of 19:49, 30 January 2011

This page describes how to keep track of mutable state in a module in xmonad-contrib or in the configuration.

Contents

1 General options

1.1 Layouts

Layouts can keep track of their state placing the information in the data type that is an instance of LayoutClass. The various methods of this typeclass allow one to update this information by supplying a new value of this type as a return value.

Note that this sensible for per-workspace state.

1.2 Data.IORef

A more general way is to store data using Data.IORef. To create an IORef, one uses newIORef; the returned value can then be passed to functions for reading from or writing to it.

Here is an example for a keybinding that keeps track of how many times it has been pressed:

import Data.IORef
..
updatingBinding :: IORef Integer -> X ()
updatingBinding ref = do
  val <- io $ readIORef ref
  io $ writeIORef ref (val+1)
  spawn $ "xmessage I have been pressed " ++ show val ++ " times before!"

To use this, it needs to be passed an IORef as a parameter:

import Data.IORef
import XMonad.Util.EZConfig
..
main = do
  ref <- newIORef 0 -- this is the initival value
  xmonad defaultConfig `additionalKeysP` [("M-S-t", updatingBinding ref)]

1.2.1 Implicit Parameters

This extension is useful for passing in the iorefs. You generally need these two extensions together, if you like to leave out the type signatures (which are as much work as explicitly passing the parameters):

{-# LANGUAGE ImplicitParams, NoMonomorphismRestriction #-}
 
main = do
  ref <- newIORef 0
  let ?ref = ref -- all references to ?ref later on will be this one
  xmonad defaultConfig `additionalKeysP` [("M-S-t", updatingBinding)]
 
-- updatingBinding :: (?ref :: IORef Integer) => X () -- this is the actual type
updatingBinding = do
  val <- io $ readIORef ?ref
  io $ writeIORef ?ref (val+1)
  spawn $ "xmessage I have been pressed " ++ show val ++ " times before!"

1.3 XMonad.Util.StringProp

Refer to haddock documentation.

2 Only available in darcs

2.1 XMonad.Util.ExtensibleState

This module allows you to store data in xmonad's internal state eliminating the need to explicitly pass around the IORef value seen in the previous example.

For information on how to use it, refer to the module's documentation.