bump cabal-version to satisfy hackage

To summarize this allows clicks which change the focus to also be passed on to
that window.

CONFIG

@@ -51,9 +51,9 @@ Ok, looks good.
 
 To have xmonad start using your settings, type 'mod-q'.  xmonad will
 then load this new file, and run it.  If it is unable to, the defaults
-are used. 
+are used.
 
-To load succesfully, both 'xmonad' and 'ghc' must be in your $PATH
+To load successfully, both 'xmonad' and 'ghc' must be in your $PATH
 environment variable.  If GHC isn't in your path, for some reason, you
 can compile the xmonad.hs file yourself:
 

LICENSE

@@ -1,27 +1,31 @@
-Copyright (c) Spencer Janssen
+Copyright (c) 2007,2008 Spencer Janssen
+Copyright (c) 2007,2008 Don Stewart
 
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions
 are met:
+
 1. Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
+
 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.
+
 3. Neither the name of the author nor the names of his contributors
    may be used to endorse or promote products derived from this software
    without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGE.
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

Main.hs

@@ -1,6 +1,6 @@
 ----------------------------------------------------------------------------
 -- |
--- Module      :  Main.hs
+-- Module      :  Main
 -- Copyright   :  (c) Spencer Janssen 2007
 -- License     :  BSD3-style (see LICENSE)
 --
@@ -14,36 +14,96 @@
 
 module Main (main) where
 
-import XMonad.Main
-import XMonad.Config
-import XMonad.Core (getXMonadDir, recompile)
+import XMonad
 
-import Control.Exception (handle)
-import System.IO
+import Control.Monad (unless)
+import System.Info
 import System.Environment
 import System.Posix.Process (executeFile)
+import System.Exit (exitFailure)
+
+import Paths_xmonad (version)
+import Data.Version (showVersion)
+
+import Graphics.X11.Xinerama (compiledWithXinerama)
+
+#ifdef TESTING
+import qualified Properties
+#endif
 
 -- | The entry point into xmonad. Attempts to compile any custom main
 -- for xmonad, and if it doesn't find one, just launches the default.
 main :: IO ()
 main = do
-    handle (hPrint stderr) buildLaunch
-    xmonad defaultConfig -- if buildLaunch returns, execute the trusted core
+    installSignalHandlers -- important to ignore SIGCHLD to avoid zombies
+    args <- getArgs
+    let launch = catchIO buildLaunch >> xmonad defaultConfig
+    case args of
+        []                    -> launch
+        ("--resume":_)        -> launch
+        ["--help"]            -> usage
+        ["--recompile"]       -> recompile True >>= flip unless exitFailure
+        ["--replace"]         -> launch
+        ["--restart"]         -> sendRestart >> return ()
+        ["--version"]         -> putStrLn $ unwords shortVersion
+        ["--verbose-version"] -> putStrLn . unwords $ shortVersion ++ longVersion
+#ifdef TESTING
+        ("--run-tests":_)     -> Properties.main
+#endif
+        _                     -> fail "unrecognized flags"
+ where
+    shortVersion = ["xmonad", showVersion version]
+    longVersion  = [ "compiled by", compilerName, showVersion compilerVersion
+                   , "for",  arch ++ "-" ++ os
+                   , "\nXinerama:", show compiledWithXinerama ]
 
--- | Build "~/.xmonad/xmonad.hs" with ghc, then execute it.  If there are no
+usage :: IO ()
+usage = do
+    self <- getProgName
+    putStr . unlines $
+        concat ["Usage: ", self, " [OPTION]"] :
+        "Options:" :
+        "  --help                       Print this message" :
+        "  --version                    Print the version number" :
+        "  --recompile                  Recompile your ~/.xmonad/xmonad.hs" :
+        "  --replace                    Replace the running window manager with xmonad" :
+        "  --restart                    Request a running xmonad process to restart" :
+#ifdef TESTING
+        "  --run-tests                  Run the test suite" :
+#endif
+        []
+
+-- | Build "~\/.xmonad\/xmonad.hs" with ghc, then execute it.  If there are no
 -- errors, this function does not return.  An exception is raised in any of
 -- these cases:
+--
 --   * ghc missing
---   * ~/.xmonad/xmonad.hs missing
+--
+--   * both "~\/.xmonad\/xmonad.hs" and "~\/.xmonad\/xmonad-$arch-$os" missing
+--
 --   * xmonad.hs fails to compile
+--
 --      ** wrong ghc in path (fails to compile)
+--
 --      ** type error, syntax error, ..
---   * Missing xmonad/XMonadContrib modules due to ghc upgrade
+--
+--   * Missing XMonad\/XMonadContrib modules due to ghc upgrade
 --
 buildLaunch ::  IO ()
 buildLaunch = do
     recompile False
     dir  <- getXMonadDir
     args <- getArgs
-    executeFile (dir ++ "/xmonad") False args Nothing
+    executeFile (dir ++ "/xmonad-"++arch++"-"++os) False args Nothing
     return ()
+
+sendRestart :: IO ()
+sendRestart = do
+    dpy <- openDisplay ""
+    rw <- rootWindow dpy $ defaultScreen dpy
+    xmonad_restart <- internAtom dpy "XMONAD_RESTART" False
+    allocaXEvent $ \e -> do
+        setEventType e clientMessage
+        setClientMessageEvent e rw xmonad_restart 32 0 currentTime
+        sendEvent dpy rw False structureNotifyMask e
+    sync dpy False

README

@@ -12,20 +12,30 @@
     workspace. Xinerama is fully supported, allowing windows to be tiled
     on several physical screens.
 
+Quick start:
+
+Obtain the dependent libraries, then build with:
+
+        runhaskell Setup.lhs configure --user --prefix=$HOME
+        runhaskell Setup.lhs build
+        runhaskell Setup.lhs install --user
+
+For the full story, read on.
+
 Building:
 
- Building is quite straightforward, and requries a basic Haskell toolchain.
+ Building is quite straightforward, and requires a basic Haskell toolchain.
  On many systems xmonad is available as a binary package in your
- package system (e.g. on debian or gentoo). If at all possible, use this
+ package system (e.g. on Debian or Gentoo). If at all possible, use this
  in preference to a source build, as the dependency resolution will be
  simpler.
 
  We'll now walk through the complete list of toolchain dependencies.
 
  * GHC: the Glasgow Haskell Compiler
-  
+
     You first need a Haskell compiler. Your distribution's package
-    system will have binaries of GHC (the Glasgow Haskell Compiler), the 
+    system will have binaries of GHC (the Glasgow Haskell Compiler), the
     compiler we use, so install that first. If your operating system's
     package system doesn't provide a binary version of GHC, you can find
     them here:
@@ -36,7 +46,7 @@ Building:
 
         apt-get install ghc6
 
-    It shouldn't be necessary to compile GHC from source -- every common 
+    It shouldn't be necessary to compile GHC from source -- every common
     system has a pre-build binary version.
 
  * X11 libraries:
@@ -50,13 +60,13 @@ Building:
     Typically you need: libXinerama libXext libX11
 
  * Cabal
- 
+
     xmonad requires a recent version of Cabal, >= 1.2.0. If you're using
     GHC 6.8, then it comes bundled with the right version. If you're
     using GHC 6.6.x, you'll need to build and install Cabal from hackage
     first:
 
-          http://hackage.haskell.org/cgi-bin/hackage-scripts/package/Cabal
+          http://hackage.haskell.org/package/Cabal
 
     You can check which version you have with the command:
 
@@ -70,11 +80,11 @@ Building:
     provided. To check whether you've got a package run 'ghc-pkg list
     some_package_name'. You will need the following packages:
 
-    mtl   http://hackage.haskell.org/cgi-bin/hackage-scripts/package/mtl-1.0
-    unix  http://hackage.haskell.org/cgi-bin/hackage-scripts/package/unix-2.0 
-    X11   http://hackage.haskell.org/cgi-bin/hackage-scripts/package/X11-1.3.0
+    mtl   http://hackage.haskell.org/package/mtl
+    unix  http://hackage.haskell.org/package/unix
+    X11   http://hackage.haskell.org/package/X11
 
- * Build xmonad: 
+ * Build xmonad:
 
     Once you've got all the dependencies in place (which should be
     straightforward), build xmonad:
@@ -87,19 +97,6 @@ Building:
 
 ------------------------------------------------------------------------
 
-Notes for using the darcs version
-
-    If you're building the darcs version of xmonad, be sure to also
-    use the darcs version of the X11 library, which is developed
-    concurrently with xmonad.
-
-        darcs get http://darcs.haskell.org/X11
-
-    Not using X11 from darcs is the most common reason for the
-    darcs version of xmonad to fail to build.
-
-------------------------------------------------------------------------
-
 Running xmonad:
 
     Add:
@@ -123,22 +120,22 @@ XMonadContrib
     prompt/program launcher, and various other useful modules.
     XMonadContrib is available at:
 
-        0.5 release:   http://hackage.haskell.org/cgi-bin/hackage-scripts/package/xmonad-contrib-0.5
+        latest release: http://hackage.haskell.org/package/xmonad-contrib
 
-        darcs version: darcs get http://code.haskell.org/XMonadContrib
+        darcs version:  darcs get http://code.haskell.org/XMonadContrib
 
 ------------------------------------------------------------------------
 
 Other useful programs:
 
- A nicer xterm replacment, that supports resizing better:
+ A nicer xterm replacement, that supports resizing better:
 
     urxvt       http://software.schmorp.de/pkg/rxvt-unicode.html
 
  For custom status bars:
 
     dzen        http://gotmor.googlepages.com/dzen
-    xmobar      http://hackage.haskell.org/cgi-bin/hackage-scripts/package/xmobar
+    xmobar http://hackage.haskell.org/package/xmobar
 
  For a program dispatch menu:
 

STYLE

@@ -2,7 +2,7 @@
 == Coding guidelines for contributing to
 == xmonad and the xmonad contributed extensions
 
-* Comment every top level function (particularly exported funtions), and 
+* Comment every top level function (particularly exported functions), and
   provide a type signature; use Haddock syntax in the comments.
 
 * Follow the coding style of the other modules.
@@ -15,7 +15,7 @@
 * Tabs are illegal. Use 4 spaces for indenting.
 
 * Any pure function added to the core should have QuickCheck properties
-  precisely defining its behaviour.
+  precisely defining its behavior.
 
 * New modules should identify the author, and be submitted under
   the same license as xmonad (BSD3 license or freer).

TODO

@@ -1,7 +1,7 @@
  - Write down invariants for the window life cycle, especially:
     - When are borders set?  Prove that the current handling is sufficient.
 
- - current floating layer handling is unoptimal. FocusUp should raise,
+ - current floating layer handling is nonoptimal. FocusUp should raise,
    for example
 
  - Issues still with stacking order.
@@ -15,6 +15,9 @@
 * double check README build instructions
 * test core with 6.6 and 6.8
 * bump xmonad.cabal version and X11 version
-* upload X11 and xmonad to hackage
+* upload X11 and xmonad to Hackage
+* update links to hackage in download.html
+* update #xmonad topic
 * check examples/text in user-facing Config.hs
 * check tour.html and intro.html are up to date, and mention all core bindings
+* confirm template config is type correct

XMonad/Config.hs

@@ -10,8 +10,12 @@
 -- Portability :  portable
 --
 -- This module specifies the default configuration values for xmonad.
--- Users should not modify this file. Rather, they should provide their
--- own @~\/.xmonad\/xmonad.hs@ that overrides specific fields in defaultConfig.
+--
+-- DO NOT MODIFY THIS FILE!  It won't work.  You may configure xmonad
+-- by providing your own @~\/.xmonad\/xmonad.hs@ that overrides
+-- specific fields in 'defaultConfig'.  For a starting point, you can
+-- copy the @xmonad.hs@ found in the @man@ directory, or look at
+-- examples on the xmonad wiki.
 --
 ------------------------------------------------------------------------
 
@@ -21,20 +25,24 @@ module XMonad.Config (defaultConfig) where
 -- Useful imports
 --
 import XMonad.Core as XMonad hiding
-    (workspaces,manageHook,numlockMask,keys,logHook,borderWidth,mouseBindings
-    ,defaultGaps,layoutHook,modMask,terminal,normalBorderColor,focusedBorderColor)
+    (workspaces,manageHook,keys,logHook,startupHook,borderWidth,mouseBindings
+    ,layoutHook,modMask,terminal,normalBorderColor,focusedBorderColor,focusFollowsMouse
+    ,handleEventHook,clickJustFocuses)
 import qualified XMonad.Core as XMonad
-    (workspaces,manageHook,numlockMask,keys,logHook,borderWidth,mouseBindings
-    ,defaultGaps,layoutHook,modMask,terminal,normalBorderColor,focusedBorderColor)
+    (workspaces,manageHook,keys,logHook,startupHook,borderWidth,mouseBindings
+    ,layoutHook,modMask,terminal,normalBorderColor,focusedBorderColor,focusFollowsMouse
+    ,handleEventHook,clickJustFocuses)
 
 import XMonad.Layout
 import XMonad.Operations
 import XMonad.ManageHook
 import qualified XMonad.StackSet as W
 import Data.Bits ((.|.))
+import Data.Monoid
 import qualified Data.Map as M
 import System.Exit
 import Graphics.X11.Xlib
+import Graphics.X11.Xlib.Extras
 
 -- | The default number of workspaces (virtual screens) and their names.
 -- By default we use numeric strings, but any string may be used as a
@@ -56,22 +64,6 @@ workspaces = map show [1 .. 9 :: Int]
 defaultModMask :: KeyMask
 defaultModMask = mod1Mask
 
--- | The mask for the numlock key. Numlock status is "masked" from the
--- current modifier status, so the keybindings will work with numlock on or
--- off. You may need to change this on some systems.
---
--- You can find the numlock modifier by running "xmodmap" and looking for a
--- modifier with Num_Lock bound to it:
---
--- > $ xmodmap | grep Num
--- > mod2        Num_Lock (0x4d)
---
--- Set numlockMask = 0 if you don't have a numlock key, or want to treat
--- numlock status separately.
---
-numlockMask :: KeyMask
-numlockMask = mod2Mask
-
 -- | Width of the window border in pixels.
 --
 borderWidth :: Dimension
@@ -80,23 +72,8 @@ borderWidth = 1
 -- | Border colors for unfocused and focused windows, respectively.
 --
 normalBorderColor, focusedBorderColor :: String
-normalBorderColor  = "#dddddd"
-focusedBorderColor = "#ff0000"
-
--- | Default offset of drawable screen boundaries from each physical
--- screen. Anything non-zero here will leave a gap of that many pixels
--- on the given edge, on the that screen. A useful gap at top of screen
--- for a menu bar (e.g. 15)
---
--- An example, to set a top gap on monitor 1, and a gap on the bottom of
--- monitor 2, you'd use a list of geometries like so:
---
--- > defaultGaps = [(18,0,0,0),(0,18,0,0)] -- 2 gaps on 2 monitors
---
--- Fields are: top, bottom, left, right.
---
-defaultGaps :: [(Int,Int,Int,Int)]
-defaultGaps = [(0,0,0,0)] -- 15 for default dzen font
+normalBorderColor  = "gray" -- "#dddddd"
+focusedBorderColor = "red"  -- "#ff0000" don't use hex, not <24 bit safe
 
 ------------------------------------------------------------------------
 -- Window rules
@@ -113,16 +90,16 @@ defaultGaps = [(0,0,0,0)] -- 15 for default dzen font
 manageHook :: ManageHook
 manageHook = composeAll
                 [ className =? "MPlayer"        --> doFloat
-                , className =? "Gimp"           --> doFloat
-                , resource  =? "desktop_window" --> doIgnore
-                , resource  =? "kdesktop"       --> doIgnore ]
+                , className =? "Gimp"           --> doFloat ]
 
 ------------------------------------------------------------------------
 -- Logging
 
 -- | Perform an arbitrary action on each internal state change or X event.
 -- Examples include:
+--
 --      * do nothing
+--
 --      * log the state to stdout
 --
 -- See the 'DynamicLog' extension for examples.
@@ -130,6 +107,19 @@ manageHook = composeAll
 logHook :: X ()
 logHook = return ()
 
+------------------------------------------------------------------------
+-- Event handling
+
+-- | Defines a custom handler function for X Events. The function should
+-- return (All True) if the default handler is to be run afterwards.
+-- To combine event hooks, use mappend or mconcat from Data.Monoid.
+handleEventHook :: Event -> X All
+handleEventHook _ = return (All True)
+
+-- | Perform an arbitrary action at xmonad startup.
+startupHook :: X ()
+startupHook = return ()
+
 ------------------------------------------------------------------------
 -- Extensible layouts
 --
@@ -163,6 +153,15 @@ layout = tiled ||| Mirror tiled ||| Full
 terminal :: String
 terminal = "xterm"
 
+-- | Whether focus follows the mouse pointer.
+focusFollowsMouse :: Bool
+focusFollowsMouse = True
+
+-- | Whether a mouse click select the focus or is just passed to the window
+clickJustFocuses :: Bool
+clickJustFocuses = True
+
+
 -- | The xmonad key bindings. Add, modify or remove key bindings here.
 --
 -- (The comment formatting character is used when generating the manpage)
@@ -171,7 +170,7 @@ keys :: XConfig Layout -> M.Map (KeyMask, KeySym) (X ())
 keys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
     -- launching and killing programs
     [ ((modMask .|. shiftMask, xK_Return), spawn $ XMonad.terminal conf) -- %! Launch terminal
-    , ((modMask,               xK_p     ), spawn "exe=`dmenu_path | dmenu` && eval \"exec $exe\"") -- %! Launch dmenu
+    , ((modMask,               xK_p     ), spawn "dmenu_run") -- %! Launch dmenu
     , ((modMask .|. shiftMask, xK_p     ), spawn "gmrun") -- %! Launch gmrun
     , ((modMask .|. shiftMask, xK_c     ), kill) -- %! Close the focused window
 
@@ -182,6 +181,7 @@ keys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
 
     -- move focus up or down the window stack
     , ((modMask,               xK_Tab   ), windows W.focusDown) -- %! Move focus to the next window
+    , ((modMask .|. shiftMask, xK_Tab   ), windows W.focusUp  ) -- %! Move focus to the previous window
     , ((modMask,               xK_j     ), windows W.focusDown) -- %! Move focus to the next window
     , ((modMask,               xK_k     ), windows W.focusUp  ) -- %! Move focus to the previous window
     , ((modMask,               xK_m     ), windows W.focusMaster  ) -- %! Move focus to the master window
@@ -202,12 +202,13 @@ keys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
     , ((modMask              , xK_comma ), sendMessage (IncMasterN 1)) -- %! Increment the number of windows in the master area
     , ((modMask              , xK_period), sendMessage (IncMasterN (-1))) -- %! Deincrement the number of windows in the master area
 
-    -- toggle the status bar gap
-    , ((modMask              , xK_b     ), modifyGap (\i n -> let x = (XMonad.defaultGaps conf ++ repeat (0,0,0,0)) !! i in if n == x then (0,0,0,0) else x)) -- %! Toggle the status bar gap
-
     -- quit, or restart
     , ((modMask .|. shiftMask, xK_q     ), io (exitWith ExitSuccess)) -- %! Quit xmonad
-    , ((modMask              , xK_q     ), broadcastMessage ReleaseResources >> restart (Just "xmonad") True) -- %! Restart xmonad
+    , ((modMask              , xK_q     ), spawn "if type xmonad; then xmonad --recompile && xmonad --restart; else xmessage xmonad not in \\$PATH: \"$PATH\"; fi") -- %! Restart xmonad
+
+    , ((modMask .|. shiftMask, xK_slash ), spawn ("echo \"" ++ help ++ "\" | xmessage -file -")) -- %! Run xmessage with a summary of the default keybindings (useful for beginners)
+    -- repeat the binding for non-American layout keyboards
+    , ((modMask              , xK_question), spawn ("echo \"" ++ help ++ "\" | xmessage -file -"))
     ]
     ++
     -- mod-[1..9] %! Switch to workspace N
@@ -223,30 +224,85 @@ keys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
         , (f, m) <- [(W.view, 0), (W.shift, shiftMask)]]
 
 -- | Mouse bindings: default actions bound to mouse events
---
 mouseBindings :: XConfig Layout -> M.Map (KeyMask, Button) (Window -> X ())
-mouseBindings (XConfig {XMonad.modMask = modMask}) = M.fromList $
+mouseBindings (XConfig {XMonad.modMask = modMask}) = M.fromList
     -- mod-button1 %! Set the window to floating mode and move by dragging
-    [ ((modMask, button1), (\w -> focus w >> mouseMoveWindow w))
+    [ ((modMask, button1), \w -> focus w >> mouseMoveWindow w
+                                          >> windows W.shiftMaster)
     -- mod-button2 %! Raise the window to the top of the stack
-    , ((modMask, button2), (\w -> focus w >> windows W.swapMaster))
+    , ((modMask, button2), windows . (W.shiftMaster .) . W.focusWindow)
     -- mod-button3 %! Set the window to floating mode and resize by dragging
-    , ((modMask, button3), (\w -> focus w >> mouseResizeWindow w))
+    , ((modMask, button3), \w -> focus w >> mouseResizeWindow w
+                                         >> windows W.shiftMaster)
     -- you may also bind events to the mouse scroll wheel (button4 and button5)
     ]
 
--- | And, finally, the default set of configuration values itself
+-- | The default set of configuration values itself
 defaultConfig = XConfig
     { XMonad.borderWidth        = borderWidth
     , XMonad.workspaces         = workspaces
-    , XMonad.defaultGaps        = defaultGaps
     , XMonad.layoutHook         = layout
     , XMonad.terminal           = terminal
     , XMonad.normalBorderColor  = normalBorderColor
     , XMonad.focusedBorderColor = focusedBorderColor
-    , XMonad.numlockMask        = numlockMask
     , XMonad.modMask            = defaultModMask
     , XMonad.keys               = keys
     , XMonad.logHook            = logHook
+    , XMonad.startupHook        = startupHook
     , XMonad.mouseBindings      = mouseBindings
-    , XMonad.manageHook         = manageHook }
+    , XMonad.manageHook         = manageHook
+    , XMonad.handleEventHook    = handleEventHook
+    , XMonad.focusFollowsMouse  = focusFollowsMouse
+    , XMonad.clickJustFocuses       = clickJustFocuses
+    }
+
+-- | Finally, a copy of the default bindings in simple textual tabular format.
+help :: String
+help = unlines ["The default modifier key is 'alt'. Default keybindings:",
+    "",
+    "-- launching and killing programs",
+    "mod-Shift-Enter  Launch xterminal",
+    "mod-p            Launch dmenu",
+    "mod-Shift-p      Launch gmrun",
+    "mod-Shift-c      Close/kill the focused window",
+    "mod-Space        Rotate through the available layout algorithms",
+    "mod-Shift-Space  Reset the layouts on the current workSpace to default",
+    "mod-n            Resize/refresh viewed windows to the correct size",
+    "",
+    "-- move focus up or down the window stack",
+    "mod-Tab        Move focus to the next window",
+    "mod-Shift-Tab  Move focus to the previous window",
+    "mod-j          Move focus to the next window",
+    "mod-k          Move focus to the previous window",
+    "mod-m          Move focus to the master window",
+    "",
+    "-- modifying the window order",
+    "mod-Return   Swap the focused window and the master window",
+    "mod-Shift-j  Swap the focused window with the next window",
+    "mod-Shift-k  Swap the focused window with the previous window",
+    "",
+    "-- resizing the master/slave ratio",
+    "mod-h  Shrink the master area",
+    "mod-l  Expand the master area",
+    "",
+    "-- floating layer support",
+    "mod-t  Push window back into tiling; unfloat and re-tile it",
+    "",
+    "-- increase or decrease number of windows in the master area",
+    "mod-comma  (mod-,)   Increment the number of windows in the master area",
+    "mod-period (mod-.)   Deincrement the number of windows in the master area",
+    "",
+    "-- quit, or restart",
+    "mod-Shift-q  Quit xmonad",
+    "mod-q        Restart xmonad",
+    "mod-[1..9]   Switch to workSpace N",
+    "",
+    "-- Workspaces & screens",
+    "mod-Shift-[1..9]   Move client to workspace N",
+    "mod-{w,e,r}        Switch to physical/Xinerama screens 1, 2, or 3",
+    "mod-Shift-{w,e,r}  Move client to screen 1, 2, or 3",
+    "",
+    "-- Mouse bindings: default actions bound to mouse events",
+    "mod-button1  Set the window to floating mode and move by dragging",
+    "mod-button2  Raise the window to the top of the stack",
+    "mod-button3  Set the window to floating mode and resize by dragging"]

XMonad/Core.hs

@@ -1,19 +1,17 @@
 {-# LANGUAGE ExistentialQuantification, FlexibleInstances, GeneralizedNewtypeDeriving,
-             MultiParamTypeClasses, TypeSynonymInstances #-}
--- required for deriving Typeable
-{-# OPTIONS_GHC -fglasgow-exts #-}
+             MultiParamTypeClasses, TypeSynonymInstances, CPP, DeriveDataTypeable #-}
 
 -----------------------------------------------------------------------------
 -- |
--- Module      :  XMonad/Core.hs
+-- Module      :  XMonad.Core
 -- Copyright   :  (c) Spencer Janssen 2007
 -- License     :  BSD3-style (see LICENSE)
 --
--- Maintainer  :  sjanssen@cse.unl.edu
+-- Maintainer  :  spencerjanssen@gmail.com
 -- Stability   :  unstable
 -- Portability :  not portable, uses cunning newtype deriving
 --
--- The X monad, a state monad transformer over IO, for the window
+-- The 'X' monad, a state monad transformer over 'IO', for the window
 -- manager state, and support routines.
 --
 -----------------------------------------------------------------------------
@@ -23,42 +21,57 @@ module XMonad.Core (
     ScreenId(..), ScreenDetail(..), XState(..),
     XConf(..), XConfig(..), LayoutClass(..),
     Layout(..), readsLayout, Typeable, Message,
-    SomeMessage(..), fromMessage, runLayout, LayoutMessages(..),
-    runX, catchX, userCode, io, catchIO,
-    withDisplay, withWindowSet, isRoot,
-    getAtom, spawn, restart, getXMonadDir, recompile, trace, whenJust, whenX,
-    atom_WM_STATE, atom_WM_PROTOCOLS, atom_WM_DELETE_WINDOW, ManageHook, Query(..), runManageHook
+    SomeMessage(..), fromMessage, LayoutMessages(..),
+    StateExtension(..), ExtensionClass(..),
+    runX, catchX, userCode, userCodeDef, io, catchIO, installSignalHandlers, uninstallSignalHandlers,
+    withDisplay, withWindowSet, isRoot, runOnWorkspaces,
+    getAtom, spawn, spawnPID, xfork, getXMonadDir, recompile, trace, whenJust, whenX,
+    atom_WM_STATE, atom_WM_PROTOCOLS, atom_WM_DELETE_WINDOW, atom_WM_TAKE_FOCUS, ManageHook, Query(..), runQuery
   ) where
 
-import XMonad.StackSet
+import XMonad.StackSet hiding (modify)
 
 import Prelude hiding ( catch )
-import Control.Exception (catch, bracket, throw, Exception(ExitException))
+import Codec.Binary.UTF8.String (encodeString)
+import Control.Exception.Extensible (catch, fromException, try, bracket, throw, finally, SomeException(..))
 import Control.Applicative
 import Control.Monad.State
 import Control.Monad.Reader
+import System.FilePath
 import System.IO
-import System.Posix.Process (executeFile, forkProcess, getProcessStatus, createSession)
+import System.Info
+import System.Posix.Process (executeFile, forkProcess, getAnyProcessStatus, createSession)
+import System.Posix.Signals
+import System.Posix.IO
+import System.Posix.Types (ProcessID)
 import System.Process
 import System.Directory
 import System.Exit
-import System.Environment
 import Graphics.X11.Xlib
 import Graphics.X11.Xlib.Extras (Event)
 import Data.Typeable
+import Data.List ((\\))
+import Data.Maybe (isJust,fromMaybe)
 import Data.Monoid
 
 import qualified Data.Map as M
 import qualified Data.Set as S
 
--- | XState, the window manager state.
--- Just the display, width, height and a window list
+-- | XState, the (mutable) window manager state.
 data XState = XState
-    { windowset    :: !WindowSet           -- ^ workspace list
-    , mapped       :: !(S.Set Window)      -- ^ the Set of mapped windows
-    , waitingUnmap :: !(M.Map Window Int)  -- ^ the number of expected UnmapEvents
-    , dragging     :: !(Maybe (Position -> Position -> X (), X ())) }
+    { windowset        :: !WindowSet                     -- ^ workspace list
+    , mapped           :: !(S.Set Window)                -- ^ the Set of mapped windows
+    , waitingUnmap     :: !(M.Map Window Int)            -- ^ the number of expected UnmapEvents
+    , dragging         :: !(Maybe (Position -> Position -> X (), X ()))
+    , numberlockMask   :: !KeyMask                       -- ^ The numlock modifier
+    , extensibleState  :: !(M.Map String (Either String StateExtension))
+    -- ^ stores custom state information.
+    --
+    -- The module "XMonad.Utils.ExtensibleState" in xmonad-contrib
+    -- provides additional information and a simple interface for using this.
+    }
 
+-- | XConf, the (read-only) window manager configuration.
 data XConf = XConf
     { display       :: Display        -- ^ the X11 display
     , config        :: !(XConfig Layout)       -- ^ initial user configuration
@@ -69,56 +82,66 @@ data XConf = XConf
                                       -- ^ a mapping of key presses to actions
     , buttonActions :: !(M.Map (KeyMask, Button) (Window -> X ()))
                                       -- ^ a mapping of button presses to actions
+    , mouseFocused :: !Bool           -- ^ was refocus caused by mouse action?
+    , mousePosition :: !(Maybe (Position, Position))
+                                      -- ^ position of the mouse according to
+                                      -- the event currently being processed
+    , currentEvent :: !(Maybe Event)
+                                      -- ^ event currently being processed
     }
 
 -- todo, better name
 data XConfig l = XConfig
-    { normalBorderColor  :: !String             -- ^ Non focused windows border color. Default: \"#dddddd\"
-    , focusedBorderColor :: !String             -- ^ Focused windows border color. Default: \"#ff0000\"
-    , terminal           :: !String             -- ^ The preferred terminal application. Default: \"xterm\"
-    , layoutHook         :: !(l Window)         -- ^ The avaiable layouts
-    , manageHook         :: !ManageHook
-                                                -- ^ The action to run when a new window is opened
-    , workspaces         :: [String]            -- ^ The list of workspaces' names
-    , defaultGaps        :: [(Int,Int,Int,Int)] -- ^ The list of gaps, per screen
-    , numlockMask        :: !KeyMask            -- ^ The numlock modifier
-    , modMask            :: !KeyMask            -- ^ the mod modifier
-    , keys               :: XConfig Layout -> M.Map (ButtonMask,KeySym) (X ())
-                                                -- ^ The key binding: a map from key presses and actions
-    , mouseBindings      :: XConfig Layout -> M.Map (ButtonMask, Button) (Window -> X ())
-                                                -- ^ The mouse bindings
-    , borderWidth        :: !Dimension          -- ^ The border width
-    , logHook            :: X ()                -- ^ The action to perform when the windows set is changed
+    { normalBorderColor  :: !String              -- ^ Non focused windows border color. Default: \"#dddddd\"
+    , focusedBorderColor :: !String              -- ^ Focused windows border color. Default: \"#ff0000\"
+    , terminal           :: !String              -- ^ The preferred terminal application. Default: \"xterm\"
+    , layoutHook         :: !(l Window)          -- ^ The available layouts
+    , manageHook         :: !ManageHook          -- ^ The action to run when a new window is opened
+    , handleEventHook    :: !(Event -> X All)    -- ^ Handle an X event, returns (All True) if the default handler
+                                                 -- should also be run afterwards. mappend should be used for combining
+                                                 -- event hooks in most cases.
+    , workspaces         :: ![String]            -- ^ The list of workspaces' names
+    , modMask            :: !KeyMask             -- ^ the mod modifier
+    , keys               :: !(XConfig Layout -> M.Map (ButtonMask,KeySym) (X ()))
+                                                 -- ^ The key binding: a map from key presses and actions
+    , mouseBindings      :: !(XConfig Layout -> M.Map (ButtonMask, Button) (Window -> X ()))
+                                                 -- ^ The mouse bindings
+    , borderWidth        :: !Dimension           -- ^ The border width
+    , logHook            :: !(X ())              -- ^ The action to perform when the windows set is changed
+    , startupHook        :: !(X ())              -- ^ The action to perform on startup
+    , focusFollowsMouse  :: !Bool                -- ^ Whether window entry events can change focus
+    , clickJustFocuses   :: !Bool                -- ^ False to make a click which changes focus to be additionally passed to the window
     }
 
 
 type WindowSet   = StackSet  WorkspaceId (Layout Window) Window ScreenId ScreenDetail
 type WindowSpace = Workspace WorkspaceId (Layout Window) Window
 
--- | Virtual workspace indicies
+-- | Virtual workspace indices
 type WorkspaceId = String
 
--- | Physical screen indicies
+-- | Physical screen indices
 newtype ScreenId    = S Int deriving (Eq,Ord,Show,Read,Enum,Num,Integral,Real)
 
--- | The 'Rectangle' with screen dimensions and the list of gaps
-data ScreenDetail   = SD { screenRect :: !Rectangle
-                         , statusGap  :: !(Int,Int,Int,Int) -- ^ width of status bar on the screen
-                         } deriving (Eq,Show, Read)
+-- | The 'Rectangle' with screen dimensions
+data ScreenDetail   = SD { screenRect :: !Rectangle } deriving (Eq,Show, Read)
 
 ------------------------------------------------------------------------
 
--- | The X monad, a StateT transformer over IO encapsulating the window
--- manager state
+-- | The X monad, 'ReaderT' and 'StateT' transformers over 'IO'
+-- encapsulating the window manager configuration and state,
+-- respectively.
 --
 -- Dynamic components may be retrieved with 'get', static components
 -- with 'ask'. With newtype deriving we get readers and state monads
--- instantiated on XConf and XState automatically.
+-- instantiated on 'XConf' and 'XState' automatically.
 --
 newtype X a = X (ReaderT XConf (StateT XState IO) a)
-#ifndef __HADDOCK__
-    deriving (Functor, Monad, MonadIO, MonadState XState, MonadReader XConf)
-#endif
+    deriving (Functor, Monad, MonadIO, MonadState XState, MonadReader XConf, Typeable)
+
+instance Applicative X where
+  pure = return
+  (<*>) = ap
 
 instance (Monoid a) => Monoid (X a) where
     mempty  = return mempty
@@ -126,38 +149,41 @@ instance (Monoid a) => Monoid (X a) where
 
 type ManageHook = Query (Endo WindowSet)
 newtype Query a = Query (ReaderT Window X a)
-#ifndef __HADDOCK__
     deriving (Functor, Monad, MonadReader Window, MonadIO)
-#endif
 
-runManageHook :: ManageHook -> Window -> X (WindowSet -> WindowSet)
-runManageHook (Query m) w = appEndo <$> runReaderT m w
+runQuery :: Query a -> Window -> X a
+runQuery (Query m) w = runReaderT m w
 
 instance Monoid a => Monoid (Query a) where
     mempty  = return mempty
     mappend = liftM2 mappend
 
--- | Run the X monad, given a chunk of X monad code, and an initial state
+-- | Run the 'X' monad, given a chunk of 'X' monad code, and an initial state
 -- Return the result, and final state
 runX :: XConf -> XState -> X a -> IO (a, XState)
 runX c st (X a) = runStateT (runReaderT a c) st
 
--- | Run in the X monad, and in case of exception, and catch it and log it
+-- | Run in the 'X' monad, and in case of exception, and catch it and log it
 -- to stderr, and run the error case.
 catchX :: X a -> X a -> X a
 catchX job errcase = do
     st <- get
     c <- ask
-    (a, s') <- io $ runX c st job `catch` \e -> case e of
-                            ExitException {} -> throw e
-                            _ -> do hPrint stderr e; runX c st errcase
+    (a, s') <- io $ runX c st job `catch` \e -> case fromException e of
+                        Just x -> throw e `const` (x `asTypeOf` ExitSuccess)
+                        _ -> do hPrint stderr e; runX c st errcase
     put s'
     return a
 
 -- | Execute the argument, catching all exceptions.  Either this function or
--- catchX should be used at all callsites of user customized code.
-userCode :: X () -> X ()
-userCode a = catchX (a >> return ()) (return ())
+-- 'catchX' should be used at all callsites of user customized code.
+userCode :: X a -> X (Maybe a)
+userCode a = catchX (Just `liftM` a) (return Nothing)
+
+-- | Same as userCode but with a default argument to return instead of using
+-- Maybe, provided for convenience.
+userCodeDef :: a -> X a -> X a
+userCodeDef def a = fromMaybe def `liftM` userCode a
 
 -- ---------------------------------------------------------------------
 -- Convenient wrappers to state
@@ -179,97 +205,142 @@ getAtom :: String -> X Atom
 getAtom str = withDisplay $ \dpy -> io $ internAtom dpy str False
 
 -- | Common non-predefined atoms
-atom_WM_PROTOCOLS, atom_WM_DELETE_WINDOW, atom_WM_STATE :: X Atom
+atom_WM_PROTOCOLS, atom_WM_DELETE_WINDOW, atom_WM_STATE, atom_WM_TAKE_FOCUS :: X Atom
 atom_WM_PROTOCOLS       = getAtom "WM_PROTOCOLS"
 atom_WM_DELETE_WINDOW   = getAtom "WM_DELETE_WINDOW"
 atom_WM_STATE           = getAtom "WM_STATE"
+atom_WM_TAKE_FOCUS      = getAtom "WM_TAKE_FOCUS"
 
 ------------------------------------------------------------------------
--- | LayoutClass handling. See particular instances in Operations.hs
+-- LayoutClass handling. See particular instances in Operations.hs
 
--- | An existential type that can hold any object that is in Read and LayoutClass.
+-- | An existential type that can hold any object that is in 'Read'
+--   and 'LayoutClass'.
 data Layout a = forall l. (LayoutClass l a, Read (l a)) => Layout (l a)
 
 -- | Using the 'Layout' as a witness, parse existentially wrapped windows
--- from a 'String'
+-- from a 'String'.
 readsLayout :: Layout a -> String -> [(Layout a, String)]
 readsLayout (Layout l) s = [(Layout (asTypeOf x l), rs) | (x, rs) <- reads s]
 
--- | The different layout modes
+-- | Every layout must be an instance of 'LayoutClass', which defines
+-- the basic layout operations along with a sensible default for each.
 --
--- 'doLayout': given a Rectangle and a Stack, layout the stack elements
--- inside the given Rectangle.  If an element is not given a Rectangle
--- by 'doLayout', then it is not shown on screen.  Windows are restacked
--- according to the order they are returned by 'doLayout'.
+-- Minimal complete definition:
 --
+-- * 'runLayout' || (('doLayout' || 'pureLayout') && 'emptyLayout'), and
+--
+-- * 'handleMessage' || 'pureMessage'
+--
+-- You should also strongly consider implementing 'description',
+-- although it is not required.
+--
+-- Note that any code which /uses/ 'LayoutClass' methods should only
+-- ever call 'runLayout', 'handleMessage', and 'description'!  In
+-- other words, the only calls to 'doLayout', 'pureMessage', and other
+-- such methods should be from the default implementations of
+-- 'runLayout', 'handleMessage', and so on.  This ensures that the
+-- proper methods will be used, regardless of the particular methods
+-- that any 'LayoutClass' instance chooses to define.
 class Show (layout a) => LayoutClass layout a where
 
-    -- | Given a Rectangle in which to place the windows, and a Stack of
-    -- windows, return a list of windows and their corresponding Rectangles.
-    -- The order of windows in this list should be the desired stacking order.
-    -- Also return a modified layout, if this layout needs to be modified
-    -- (e.g. if we keep track of the windows we have displayed).
-    doLayout    :: layout a -> Rectangle -> Stack a -> X ([(a, Rectangle)], Maybe (layout a))
+    -- | By default, 'runLayout' calls 'doLayout' if there are any
+    --   windows to be laid out, and 'emptyLayout' otherwise.  Most
+    --   instances of 'LayoutClass' probably do not need to implement
+    --   'runLayout'; it is only useful for layouts which wish to make
+    --   use of more of the 'Workspace' information (for example,
+    --   "XMonad.Layout.PerWorkspace").
+    runLayout :: Workspace WorkspaceId (layout a) a
+              -> Rectangle
+              -> X ([(a, Rectangle)], Maybe (layout a))
+    runLayout (Workspace _ l ms) r = maybe (emptyLayout l r) (doLayout l r) ms
+
+    -- | Given a 'Rectangle' in which to place the windows, and a 'Stack'
+    -- of windows, return a list of windows and their corresponding
+    -- Rectangles.  If an element is not given a Rectangle by
+    -- 'doLayout', then it is not shown on screen.  The order of
+    -- windows in this list should be the desired stacking order.
+    --
+    -- Also possibly return a modified layout (by returning @Just
+    -- newLayout@), if this layout needs to be modified (e.g. if it
+    -- keeps track of some sort of state).  Return @Nothing@ if the
+    -- layout does not need to be modified.
+    --
+    -- Layouts which do not need access to the 'X' monad ('IO', window
+    -- manager state, or configuration) and do not keep track of their
+    -- own state should implement 'pureLayout' instead of 'doLayout'.
+    doLayout    :: layout a -> Rectangle -> Stack a
+                -> X ([(a, Rectangle)], Maybe (layout a))
     doLayout l r s   = return (pureLayout l r s, Nothing)
 
-    -- | This is a pure version of doLayout, for cases where we don't need
-    -- access to the X monad to determine how to layout the windows, and
-    -- we don't need to modify our layout itself.
+    -- | This is a pure version of 'doLayout', for cases where we
+    -- don't need access to the 'X' monad to determine how to lay out
+    -- the windows, and we don't need to modify the layout itself.
     pureLayout  :: layout a -> Rectangle -> Stack a -> [(a, Rectangle)]
     pureLayout _ r s = [(focus s, r)]
 
-    -- | 'handleMessage' performs message handling for that layout.  If
-    -- 'handleMessage' returns Nothing, then the layout did not respond to
-    -- that message and the screen is not refreshed.  Otherwise, 'handleMessage'
-    -- returns an updated 'Layout' and the screen is refreshed.
+    -- | 'emptyLayout' is called when there are no windows.
+    emptyLayout :: layout a -> Rectangle -> X ([(a, Rectangle)], Maybe (layout a))
+    emptyLayout _ _ = return ([], Nothing)
+
+    -- | 'handleMessage' performs message handling.  If
+    -- 'handleMessage' returns @Nothing@, then the layout did not
+    -- respond to the message and the screen is not refreshed.
+    -- Otherwise, 'handleMessage' returns an updated layout and the
+    -- screen is refreshed.
     --
+    -- Layouts which do not need access to the 'X' monad to decide how
+    -- to handle messages should implement 'pureMessage' instead of
+    -- 'handleMessage' (this restricts the risk of error, and makes
+    -- testing much easier).
     handleMessage :: layout a -> SomeMessage -> X (Maybe (layout a))
     handleMessage l  = return . pureMessage l
 
-    -- | Respond to a message by (possibly) changing our layout, but taking
-    -- no other action.  If the layout changes, the screen will be refreshed.
+    -- | Respond to a message by (possibly) changing our layout, but
+    -- taking no other action.  If the layout changes, the screen will
+    -- be refreshed.
     pureMessage :: layout a -> SomeMessage -> Maybe (layout a)
     pureMessage _ _  = Nothing
 
-    -- | This should be a human-readable string that is used when selecting
-    -- layouts by name.
+    -- | This should be a human-readable string that is used when
+    -- selecting layouts by name.  The default implementation is
+    -- 'show', which is in some cases a poor default.
     description :: layout a -> String
     description      = show
 
 instance LayoutClass Layout Window where
+    runLayout (Workspace i (Layout l) ms) r = fmap (fmap Layout) `fmap` runLayout (Workspace i l ms) r
     doLayout (Layout l) r s  = fmap (fmap Layout) `fmap` doLayout l r s
+    emptyLayout (Layout l) r = fmap (fmap Layout) `fmap` emptyLayout l r
     handleMessage (Layout l) = fmap (fmap Layout) . handleMessage l
     description (Layout l)   = description l
 
 instance Show (Layout a) where show (Layout l) = show l
 
--- | This calls doLayout if there are any windows to be laid out.
-runLayout :: LayoutClass l a => l a -> Rectangle -> Maybe (Stack a) -> X ([(a, Rectangle)], Maybe (l a))
-runLayout l r = maybe (return ([], Nothing)) (doLayout l r)
-
--- | Based on ideas in /An Extensible Dynamically-Typed Hierarchy of Exceptions/,
--- Simon Marlow, 2006. Use extensible messages to the handleMessage handler.
+-- | Based on ideas in /An Extensible Dynamically-Typed Hierarchy of
+-- Exceptions/, Simon Marlow, 2006. Use extensible messages to the
+-- 'handleMessage' handler.
 --
 -- User-extensible messages must be a member of this class.
 --
 class Typeable a => Message a
 
 -- |
--- A wrapped value of some type in the Message class.
+-- A wrapped value of some type in the 'Message' class.
 --
 data SomeMessage = forall a. Message a => SomeMessage a
 
 -- |
--- And now, unwrap a given, unknown Message type, performing a (dynamic)
+-- And now, unwrap a given, unknown 'Message' type, performing a (dynamic)
 -- type check on the result.
 --
 fromMessage :: Message m => SomeMessage -> Maybe m
 fromMessage (SomeMessage m) = cast m
 
--- | X Events are valid Messages
+-- X Events are valid Messages.
 instance Message Event
 
--- | LayoutMessages are core messages that all layouts (especially stateful
+-- | 'LayoutMessages' are core messages that all layouts (especially stateful
 -- layouts) should consider handling.
 data LayoutMessages = Hide              -- ^ sent when a layout becomes non-visible
                     | ReleaseResources  -- ^ sent when xmonad is exiting or restarting
@@ -277,94 +348,173 @@ data LayoutMessages = Hide              -- ^ sent when a layout becomes non-visi
 
 instance Message LayoutMessages
 
+-- ---------------------------------------------------------------------
+-- Extensible state
+--
+
+-- | Every module must make the data it wants to store
+-- an instance of this class.
+--
+-- Minimal complete definition: initialValue
+class Typeable a => ExtensionClass a where
+    -- | Defines an initial value for the state extension
+    initialValue :: a
+    -- | Specifies whether the state extension should be
+    -- persistent. Setting this method to 'PersistentExtension'
+    -- will make the stored data survive restarts, but
+    -- requires a to be an instance of Read and Show.
+    --
+    -- It defaults to 'StateExtension', i.e. no persistence.
+    extensionType :: a -> StateExtension
+    extensionType = StateExtension
+
+-- | Existential type to store a state extension.
+data StateExtension =
+    forall a. ExtensionClass a => StateExtension a
+    -- ^ Non-persistent state extension
+  | forall a. (Read a, Show a, ExtensionClass a) => PersistentExtension a
+    -- ^ Persistent extension
+
 -- ---------------------------------------------------------------------
 -- | General utilities
 --
--- Lift an IO action into the X monad
+-- Lift an 'IO' action into the 'X' monad
 io :: MonadIO m => IO a -> m a
 io = liftIO
 
--- | Lift an IO action into the X monad.  If the action results in an IO
+-- | Lift an 'IO' action into the 'X' monad.  If the action results in an 'IO'
 -- exception, log the exception to stderr and continue normal execution.
-catchIO :: IO () -> X ()
-catchIO f = io (f `catch` \e -> hPrint stderr e >> hFlush stderr)
+catchIO :: MonadIO m => IO () -> m ()
+catchIO f = io (f `catch` \(SomeException e) -> hPrint stderr e >> hFlush stderr)
 
--- | spawn. Launch an external application
+-- | spawn. Launch an external application. Specifically, it double-forks and
+-- runs the 'String' you pass as a command to \/bin\/sh.
+--
+-- Note this function assumes your locale uses utf8.
 spawn :: MonadIO m => String -> m ()
-spawn x = doubleFork $ executeFile "/bin/sh" False ["-c", x] Nothing
+spawn x = spawnPID x >> return ()
 
--- | Double fork and execute an IO action (usually one of the exec family of
--- functions)
-doubleFork :: MonadIO m => IO () -> m ()
-doubleFork m = io $ do
-    pid <- forkProcess $ do
-        forkProcess (createSession >> m)
-        exitWith ExitSuccess
-    getProcessStatus True False pid
-    return ()
+-- | Like 'spawn', but returns the 'ProcessID' of the launched application
+spawnPID :: MonadIO m => String -> m ProcessID
+spawnPID x = xfork $ executeFile "/bin/sh" False ["-c", encodeString x] Nothing
 
--- | Restart xmonad via exec().
---
--- If the first parameter is 'Just name', restart will attempt to execute the
--- program corresponding to 'name'.  Otherwise, xmonad will attempt to execute
--- the name of the current program.
---
--- When the second parameter is 'True', xmonad will attempt to resume with the
--- current window state.
-restart :: Maybe String -> Bool -> X ()
-restart mprog resume = do
-    prog <- maybe (io getProgName) return mprog
-    args <- if resume then gets (("--resume":) . return . showWs . windowset) else return []
-    catchIO (executeFile prog True args Nothing)
- where showWs = show . mapLayout show
+-- | A replacement for 'forkProcess' which resets default signal handlers.
+xfork :: MonadIO m => IO () -> m ProcessID
+xfork x = io . forkProcess . finally nullStdin $ do
+                uninstallSignalHandlers
+                createSession
+                x
+ where
+    nullStdin = do
+        fd <- openFd "/dev/null" ReadOnly Nothing defaultFileFlags
+        dupTo fd stdInput
+        closeFd fd
+
+-- | This is basically a map function, running a function in the 'X' monad on
+-- each workspace with the output of that function being the modified workspace.
+runOnWorkspaces :: (WindowSpace -> X WindowSpace) -> X ()
+runOnWorkspaces job = do
+    ws <- gets windowset
+    h <- mapM job $ hidden ws
+    c:v <- mapM (\s -> (\w -> s { workspace = w}) <$> job (workspace s))
+             $ current ws : visible ws
+    modify $ \s -> s { windowset = ws { current = c, visible = v, hidden = h } }
 
 -- | Return the path to @~\/.xmonad@.
 getXMonadDir :: MonadIO m => m String
 getXMonadDir = io $ getAppUserDataDirectory "xmonad"
 
--- | 'recompile force', recompile ~\/.xmonad\/xmonad.hs when any of the
+-- | 'recompile force', recompile @~\/.xmonad\/xmonad.hs@ when any of the
 -- following apply:
---      * force is True
---      * the xmonad executable does not exist
---      * the xmonad executable is older than xmonad.hs
 --
--- The -i flag is used to restrict recompilation to the xmonad.hs file only.
+--      * force is 'True'
+--
+--      * the xmonad executable does not exist
+--
+--      * the xmonad executable is older than xmonad.hs or any file in
+--        ~\/.xmonad\/lib
+--
+-- The -i flag is used to restrict recompilation to the xmonad.hs file only,
+-- and any files in the ~\/.xmonad\/lib directory.
 --
 -- Compilation errors (if any) are logged to ~\/.xmonad\/xmonad.errors.  If
--- GHC indicates failure with a non-zero exit code, an xmessage containing
--- GHC's is spawned.
+-- GHC indicates failure with a non-zero exit code, an xmessage displaying
+-- that file is spawned.
 --
-recompile :: MonadIO m => Bool -> m ()
+-- 'False' is returned if there are compilation errors.
+--
+recompile :: MonadIO m => Bool -> m Bool
 recompile force = io $ do
     dir <- getXMonadDir
-    let bin = dir ++ "/" ++ "xmonad"
-        err = bin ++ ".errors"
-        src = bin ++ ".hs"
+    let binn = "xmonad-"++arch++"-"++os
+        bin  = dir </> binn
+        base = dir </> "xmonad"
+        err  = base ++ ".errors"
+        src  = base ++ ".hs"
+        lib  = dir </> "lib"
+    libTs <- mapM getModTime . Prelude.filter isSource =<< allFiles lib
     srcT <- getModTime src
     binT <- getModTime bin
-    when (force || srcT > binT) $ do
-        status <- bracket (openFile err WriteMode) hClose $ \h -> do
-            waitForProcess =<< runProcess "ghc" ["--make", "xmonad.hs", "-i", "-no-recomp", "-v0"] (Just dir)
+    if force || any (binT <) (srcT : libTs)
+      then do
+        -- temporarily disable SIGCHLD ignoring:
+        uninstallSignalHandlers
+        status <- bracket (openFile err WriteMode) hClose $ \h ->
+            waitForProcess =<< runProcess "ghc" ["--make", "xmonad.hs", "-i", "-ilib", "-fforce-recomp", "-v0", "-o",binn] (Just dir)
                                     Nothing Nothing Nothing (Just h)
 
+        -- re-enable SIGCHLD:
+        installSignalHandlers
+
         -- now, if it fails, run xmessage to let the user know:
         when (status /= ExitSuccess) $ do
             ghcErr <- readFile err
             let msg = unlines $
                     ["Error detected while loading xmonad configuration file: " ++ src]
-                    ++ lines ghcErr ++ ["","Please check the file for errors."]
-            doubleFork $ executeFile "xmessage" True [msg] Nothing
- where getModTime f = catch (Just <$> getModificationTime f) (const $ return Nothing)
+                    ++ lines (if null ghcErr then show status else ghcErr)
+                    ++ ["","Please check the file for errors."]
+            -- nb, the ordering of printing, then forking, is crucial due to
+            -- lazy evaluation
+            hPutStrLn stderr msg
+            forkProcess $ executeFile "xmessage" True ["-default", "okay", msg] Nothing
+            return ()
+        return (status == ExitSuccess)
+      else return True
+ where getModTime f = catch (Just <$> getModificationTime f) (\(SomeException _) -> return Nothing)
+       isSource = flip elem [".hs",".lhs",".hsc"] . takeExtension
+       allFiles t = do
+            let prep = map (t</>) . Prelude.filter (`notElem` [".",".."])
+            cs <- prep <$> catch (getDirectoryContents t) (\(SomeException _) -> return [])
+            ds <- filterM doesDirectoryExist cs
+            concat . ((cs \\ ds):) <$> mapM allFiles ds
 
--- | Run a side effecting action with the current workspace. Like 'when' but
+-- | Conditionally run an action, using a @Maybe a@ to decide.
 whenJust :: Monad m => Maybe a -> (a -> m ()) -> m ()
 whenJust mg f = maybe (return ()) f mg
 
--- | Conditionally run an action, using a X event to decide
+-- | Conditionally run an action, using a 'X' event to decide
 whenX :: X Bool -> X () -> X ()
 whenX a f = a >>= \b -> when b f
 
--- | A 'trace' for the X monad. Logs a string to stderr. The result may
+-- | A 'trace' for the 'X' monad. Logs a string to stderr. The result may
 -- be found in your .xsession-errors file
 trace :: MonadIO m => String -> m ()
 trace = io . hPutStrLn stderr
+
+-- | Ignore SIGPIPE to avoid termination when a pipe is full, and SIGCHLD to
+-- avoid zombie processes, and clean up any extant zombie processes.
+installSignalHandlers :: MonadIO m => m ()
+installSignalHandlers = io $ do
+    installHandler openEndedPipe Ignore Nothing
+    installHandler sigCHLD Ignore Nothing
+    (try :: IO a -> IO (Either SomeException a))
+      $ fix $ \more -> do
+        x <- getAnyProcessStatus False False
+        when (isJust x) more
+    return ()
+
+uninstallSignalHandlers :: MonadIO m => m ()
+uninstallSignalHandlers = io $ do
+    installHandler openEndedPipe Default Nothing
+    installHandler sigCHLD Default Nothing
+    return ()

XMonad/Layout.hs

@@ -1,13 +1,12 @@
-{-# OPTIONS_GHC -fglasgow-exts    #-} -- For deriving Data/Typeable
-{-# LANGUAGE FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances #-}
+{-# LANGUAGE FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances, DeriveDataTypeable #-}
 
 -- --------------------------------------------------------------------------
 -- |
--- Module      :  Layouts.hs
+-- Module      :  XMonad.Layout
 -- Copyright   :  (c) Spencer Janssen 2007
 -- License     :  BSD3-style (see LICENSE)
 --
--- Maintainer  :  sjanssen@cse.unl.edu
+-- Maintainer  :  spencerjanssen@gmail.com
 -- Stability   :  unstable
 -- Portability :  not portable, Typeable deriving, mtl, posix
 --
@@ -15,9 +14,15 @@
 --
 -----------------------------------------------------------------------------
 
-module XMonad.Layout (ChangeLayout(..), Choose, (|||), Resize(..), IncMasterN(..),
-                Full(..), Tall(..), Mirror(..), mirrorRect, splitVertically,
-                splitHorizontally, splitHorizontallyBy, splitVerticallyBy) where
+module XMonad.Layout (
+    Full(..), Tall(..), Mirror(..),
+    Resize(..), IncMasterN(..), Choose, (|||), ChangeLayout(..),
+    mirrorRect, splitVertically,
+    splitHorizontally, splitHorizontallyBy, splitVerticallyBy,
+
+    tile
+
+  ) where
 
 import XMonad.Core
 
@@ -27,128 +32,59 @@ import Control.Arrow ((***), second)
 import Control.Monad
 import Data.Maybe (fromMaybe)
 
-
 ------------------------------------------------------------------------
--- LayoutClass selection manager
 
--- | A layout that allows users to switch between various layout options.
-
--- | Messages to change the current layout.
-data ChangeLayout = FirstLayout | NextLayout deriving (Eq, Show, Typeable)
-
-instance Message ChangeLayout
-
--- | The layout choice combinator
-(|||) :: (LayoutClass l a, LayoutClass r a) => l a -> r a -> Choose l r a
-(|||) = flip SLeft
-infixr 5 |||
-
-data Choose l r a = SLeft  (r a) (l a)
-                  | SRight (l a) (r a) deriving (Read, Show)
-
-data NextNoWrap = NextNoWrap deriving (Eq, Show, Typeable)
-instance Message NextNoWrap
-
--- This has lots of pseudo duplicated code, we must find a better way
-instance (LayoutClass l a, LayoutClass r a) => LayoutClass (Choose l r) a where
-    doLayout (SLeft  r l) = (fmap (second . fmap $ SLeft r) .) . doLayout l
-    doLayout (SRight l r) = (fmap (second . fmap $ SRight l) .) . doLayout r
-
-    description (SLeft _ l)  = description l
-    description (SRight _ r) = description r
-
-    handleMessage lr m | Just FirstLayout <- fromMessage m = case lr of
-        SLeft {}   -> return Nothing
-        SRight l r -> fmap (Just . flip SLeft l . fromMaybe r)
-                        $ handleMessage r (SomeMessage Hide)
-
-    handleMessage lr m | Just NextLayout <- fromMessage m = do
-        mlr <- handleMessage lr $ SomeMessage NextNoWrap
-        maybe (handleMessage lr $ SomeMessage FirstLayout) (return . Just) mlr
-
-    handleMessage (SLeft r l) m | Just NextNoWrap <- fromMessage m = do
-        handleMessage l (SomeMessage Hide)
-        mr <- handleMessage r (SomeMessage FirstLayout)
-        return . Just . SRight l $ fromMaybe r mr
-
-    handleMessage lr m | Just ReleaseResources <- fromMessage m =
-        liftM2 ((Just .) . cons)
-                    (fmap (fromMaybe l) $ handleMessage l m)
-                    (fmap (fromMaybe r) $ handleMessage r m)
-     where (cons, l, r) = case lr of
-                            (SLeft  r' l') -> (flip SLeft, l', r')
-                            (SRight l' r') -> (SRight, l', r')
-
-    -- The default cases for left and right:
-    handleMessage (SLeft  r l) m = fmap (fmap $ SLeft  r) $ handleMessage l m
-    handleMessage (SRight l r) m = fmap (fmap $ SRight l) $ handleMessage r m
-
---
--- | Builtin layout algorithms:
---
--- > fullscreen mode
--- > tall mode
---
--- The latter algorithms support the following operations:
---
--- >    Shrink
--- >    Expand
---
+-- | Change the size of the master pane.
 data Resize     = Shrink | Expand   deriving Typeable
 
--- | You can also increase the number of clients in the master pane
-data IncMasterN = IncMasterN Int    deriving Typeable
+-- | Increase the number of clients in the master pane.
+data IncMasterN = IncMasterN !Int    deriving Typeable
 
 instance Message Resize
 instance Message IncMasterN
 
--- | Simple fullscreen mode, just render all windows fullscreen.
+-- | Simple fullscreen mode. Renders the focused window fullscreen.
 data Full a = Full deriving (Show, Read)
 
 instance LayoutClass Full a
 
--- | The inbuilt tiling mode of xmonad, and its operations.
-data Tall a = Tall Int Rational Rational deriving (Show, Read)
+-- | The builtin tiling mode of xmonad. Supports 'Shrink', 'Expand' and
+-- 'IncMasterN'.
+data Tall a = Tall { tallNMaster :: !Int               -- ^ The default number of windows in the master pane (default: 1)
+                   , tallRatioIncrement :: !Rational   -- ^ Percent of screen to increment by when resizing panes (default: 3/100)
+                   , tallRatio :: !Rational            -- ^ Default proportion of screen occupied by master pane (default: 1/2)
+                   }
+                deriving (Show, Read)
+                        -- TODO should be capped [0..1] ..
 
+-- a nice pure layout, lots of properties for the layout, and its messages, in Properties.hs
 instance LayoutClass Tall a where
     pureLayout (Tall nmaster _ frac) r s = zip ws rs
       where ws = W.integrate s
             rs = tile frac r nmaster (length ws)
 
-    pureMessage (Tall nmaster delta frac) m = msum [fmap resize (fromMessage m)
-                                                   ,fmap incmastern (fromMessage m)]
-        where resize Shrink = Tall nmaster delta (max 0 $ frac-delta)
-              resize Expand = Tall nmaster delta (min 1 $ frac+delta)
-              incmastern (IncMasterN d) = Tall (max 0 (nmaster+d)) delta frac
+    pureMessage (Tall nmaster delta frac) m =
+            msum [fmap resize     (fromMessage m)
+                 ,fmap incmastern (fromMessage m)]
+
+      where resize Shrink             = Tall nmaster delta (max 0 $ frac-delta)
+            resize Expand             = Tall nmaster delta (min 1 $ frac+delta)
+            incmastern (IncMasterN d) = Tall (max 0 (nmaster+d)) delta frac
+
     description _ = "Tall"
 
--- | Mirror a rectangle
-mirrorRect :: Rectangle -> Rectangle
-mirrorRect (Rectangle rx ry rw rh) = (Rectangle ry rx rh rw)
-
--- | Mirror a layout, compute its 90 degree rotated form.
-data Mirror l a = Mirror (l a) deriving (Show, Read)
-
-instance LayoutClass l a => LayoutClass (Mirror l) a where
-    doLayout (Mirror l) r s = (map (second mirrorRect) *** fmap Mirror)
-                                `fmap` doLayout l (mirrorRect r) s
-    handleMessage (Mirror l) = fmap (fmap Mirror) . handleMessage l
-    description (Mirror l) = "Mirror "++ description l
-
--- | tile.  Compute the positions for windows using the default 2 pane tiling algorithm.
+-- | Compute the positions for windows using the default two-pane tiling
+-- algorithm.
 --
--- The screen is divided (currently) into two panes. all clients are
--- then partioned between these two panes. one pane, the `master', by
--- convention has the least number of windows in it (by default, 1).
--- the variable `nmaster' controls how many windows are rendered in the
--- master pane.
---
--- `delta' specifies the ratio of the screen to resize by.
---
--- 'frac' specifies what proportion of the screen to devote to the
--- master area.
---
-tile :: Rational -> Rectangle -> Int -> Int -> [Rectangle]
+-- The screen is divided into two panes. All clients are
+-- then partioned between these two panes. One pane, the master, by
+-- convention has the least number of windows in it.
+tile
+    :: Rational  -- ^ @frac@, what proportion of the screen to devote to the master area
+    -> Rectangle -- ^ @r@, the rectangle representing the screen
+    -> Int       -- ^ @nmaster@, the number of windows in the master pane
+    -> Int       -- ^ @n@, the total number of windows to tile
+    -> [Rectangle]
 tile f r nmaster n = if n <= nmaster || nmaster == 0
     then splitVertically n r
     else splitVertically nmaster r1 ++ splitVertically (n-nmaster) r2 -- two columns
@@ -163,6 +99,7 @@ splitVertically n (Rectangle sx sy sw sh) = Rectangle sx sy sw smallh :
     splitVertically (n-1) (Rectangle sx (sy+fromIntegral smallh) sw (sh-smallh))
   where smallh = sh `div` fromIntegral n --hmm, this is a fold or map.
 
+-- Not used in the core, but exported
 splitHorizontally n = map mirrorRect . splitVertically n . mirrorRect
 
 -- Divide the screen into two rectangles, using a rational to specify the ratio
@@ -172,4 +109,102 @@ splitHorizontallyBy f (Rectangle sx sy sw sh) =
     , Rectangle (sx + fromIntegral leftw) sy (sw-fromIntegral leftw) sh)
   where leftw = floor $ fromIntegral sw * f
 
+-- Not used in the core, but exported
 splitVerticallyBy f = (mirrorRect *** mirrorRect) . splitHorizontallyBy f . mirrorRect
+
+------------------------------------------------------------------------
+
+-- | Mirror a layout, compute its 90 degree rotated form.
+newtype Mirror l a = Mirror (l a) deriving (Show, Read)
+
+instance LayoutClass l a => LayoutClass (Mirror l) a where
+    runLayout (W.Workspace i (Mirror l) ms) r = (map (second mirrorRect) *** fmap Mirror)
+                                                `fmap` runLayout (W.Workspace i l ms) (mirrorRect r)
+    handleMessage (Mirror l) = fmap (fmap Mirror) . handleMessage l
+    description (Mirror l) = "Mirror "++ description l
+
+-- | Mirror a rectangle.
+mirrorRect :: Rectangle -> Rectangle
+mirrorRect (Rectangle rx ry rw rh) = Rectangle ry rx rh rw
+
+------------------------------------------------------------------------
+-- LayoutClass selection manager
+-- Layouts that transition between other layouts
+
+-- | Messages to change the current layout.
+data ChangeLayout = FirstLayout | NextLayout deriving (Eq, Show, Typeable)
+
+instance Message ChangeLayout
+
+-- | The layout choice combinator
+(|||) :: (LayoutClass l a, LayoutClass r a) => l a -> r a -> Choose l r a
+(|||) = Choose L
+infixr 5 |||
+
+-- | A layout that allows users to switch between various layout options.
+data Choose l r a = Choose LR (l a) (r a) deriving (Read, Show)
+
+-- | Are we on the left or right sub-layout?
+data LR = L | R deriving (Read, Show, Eq)
+
+data NextNoWrap = NextNoWrap deriving (Eq, Show, Typeable)
+instance Message NextNoWrap
+
+-- | A small wrapper around handleMessage, as it is tedious to write
+-- SomeMessage repeatedly.
+handle :: (LayoutClass l a, Message m) => l a -> m -> X (Maybe (l a))
+handle l m = handleMessage l (SomeMessage m)
+
+-- | A smart constructor that takes some potential modifications, returns a
+-- new structure if any fields have changed, and performs any necessary cleanup
+-- on newly non-visible layouts.
+choose :: (LayoutClass l a, LayoutClass r a)
+       => Choose l r a-> LR -> Maybe (l a) -> Maybe (r a) -> X (Maybe (Choose l r a))
+choose (Choose d _ _) d' Nothing Nothing | d == d' = return Nothing
+choose (Choose d l r) d' ml      mr = f lr
+ where
+    (l', r') = (fromMaybe l ml, fromMaybe r mr)
+    lr       = case (d, d') of
+                    (L, R) -> (hide l'  , return r')
+                    (R, L) -> (return l', hide r'  )
+                    (_, _) -> (return l', return r')
+    f (x,y)  = fmap Just $ liftM2 (Choose d') x y
+    hide x   = fmap (fromMaybe x) $ handle x Hide
+
+instance (LayoutClass l a, LayoutClass r a) => LayoutClass (Choose l r) a where
+    runLayout (W.Workspace i (Choose L l r) ms) =
+        fmap (second . fmap $ flip (Choose L) r) . runLayout (W.Workspace i l ms)
+    runLayout (W.Workspace i (Choose R l r) ms) =
+        fmap (second . fmap $ Choose R l) . runLayout (W.Workspace i r ms)
+
+    description (Choose L l _) = description l
+    description (Choose R _ r) = description r
+
+    handleMessage lr m | Just NextLayout <- fromMessage m = do
+        mlr' <- handle lr NextNoWrap
+        maybe (handle lr FirstLayout) (return . Just) mlr'
+
+    handleMessage c@(Choose d l r) m | Just NextNoWrap <- fromMessage m =
+        case d of
+            L -> do
+                ml <- handle l NextNoWrap
+                case ml of
+                    Just _  -> choose c L ml Nothing
+                    Nothing -> choose c R Nothing =<< handle r FirstLayout
+
+            R -> choose c R Nothing =<< handle r NextNoWrap
+
+    handleMessage c@(Choose _ l _) m | Just FirstLayout <- fromMessage m =
+        flip (choose c L) Nothing =<< handle l FirstLayout
+
+    handleMessage c@(Choose d l r) m | Just ReleaseResources <- fromMessage m =
+        join $ liftM2 (choose c d) (handle l ReleaseResources) (handle r ReleaseResources)
+
+    handleMessage c@(Choose d l r) m = do
+        ml' <- case d of
+                L -> handleMessage l m
+                R -> return Nothing
+        mr' <- case d of
+                L -> return Nothing
+                R -> handleMessage r m
+        choose c d ml' mr'

XMonad/Main.hsc

@@ -1,11 +1,11 @@
-{-# LANGUAGE MultiParamTypeClasses, FlexibleContexts #-}
+{-# LANGUAGE MultiParamTypeClasses, FlexibleContexts, ForeignFunctionInterface #-}
 ----------------------------------------------------------------------------
 -- |
--- Module      :  Core.hs
+-- Module      :  XMonad.Main
 -- Copyright   :  (c) Spencer Janssen 2007
 -- License     :  BSD3-style (see LICENSE)
 --
--- Maintainer  :  sjanssen@cse.unl.edu
+-- Maintainer  :  spencerjanssen@gmail.com
 -- Stability   :  unstable
 -- Portability :  not portable, uses mtl, X11, posix
 --
@@ -15,47 +15,89 @@
 
 module XMonad.Main (xmonad) where
 
+import Control.Arrow (second)
 import Data.Bits
+import Data.List ((\\))
+import Data.Function
 import qualified Data.Map as M
 import qualified Data.Set as S
 import Control.Monad.Reader
 import Control.Monad.State
 import Data.Maybe (fromMaybe)
+import Data.Monoid (getAll)
+
+import Foreign.C
+import Foreign.Ptr
 
 import System.Environment (getArgs)
 
 import Graphics.X11.Xlib hiding (refreshKeyboardMapping)
 import Graphics.X11.Xlib.Extras
-import Graphics.X11.Xinerama    (getScreenInfo)
 
 import XMonad.Core
+import qualified XMonad.Config as Default
 import XMonad.StackSet (new, floating, member)
 import qualified XMonad.StackSet as W
 import XMonad.Operations
 
 import System.IO
 
+------------------------------------------------------------------------
+-- Locale support
+
+#include <locale.h>
+
+foreign import ccall unsafe "locale.h setlocale"
+    c_setlocale :: CInt -> Ptr CChar -> IO (Ptr CChar)
+
+------------------------------------------------------------------------
+
 -- |
 -- The main entry point
 --
 xmonad :: (LayoutClass l Window, Read (l Window)) => XConfig l -> IO ()
 xmonad initxmc = do
+    -- setup locale information from environment
+    withCString "" $ c_setlocale (#const LC_ALL)
+    -- ignore SIGPIPE and SIGCHLD
+    installSignalHandlers
     -- First, wrap the layout in an existential, to keep things pretty:
     let xmc = initxmc { layoutHook = Layout $ layoutHook initxmc }
     dpy   <- openDisplay ""
     let dflt = defaultScreen dpy
 
     rootw  <- rootWindow dpy dflt
-    xinesc <- getScreenInfo dpy
-    nbc    <- initColor dpy $ normalBorderColor xmc
-    fbc    <- initColor dpy $ focusedBorderColor xmc
-    hSetBuffering stdout NoBuffering
+
     args <- getArgs
 
+    when ("--replace" `elem` args) $ replace dpy dflt rootw
+
+    -- If another WM is running, a BadAccess error will be returned.  The
+    -- default error handler will write the exception to stderr and exit with
+    -- an error.
+    selectInput dpy rootw $  substructureRedirectMask .|. substructureNotifyMask
+                         .|. enterWindowMask .|. leaveWindowMask .|. structureNotifyMask
+                         .|. buttonPressMask
+    sync dpy False -- sync to ensure all outstanding errors are delivered
+
+    -- turn off the default handler in favor of one that ignores all errors
+    -- (ugly, I know)
+    xSetErrorHandler -- in C, I'm too lazy to write the binding: dons
+
+    xinesc <- getCleanedScreenInfo dpy
+    nbc    <- do v            <- initColor dpy $ normalBorderColor  xmc
+                 ~(Just nbc_) <- initColor dpy $ normalBorderColor Default.defaultConfig
+                 return (fromMaybe nbc_ v)
+
+    fbc    <- do v <- initColor dpy $ focusedBorderColor xmc
+                 ~(Just fbc_)  <- initColor dpy $ focusedBorderColor Default.defaultConfig
+                 return (fromMaybe fbc_ v)
+
+    hSetBuffering stdout NoBuffering
+
     let layout = layoutHook xmc
         lreads = readsLayout layout
-        initialWinset = new layout (workspaces xmc) $ zipWith SD xinesc gaps
-
+        initialWinset = new layout (workspaces xmc) $ map SD xinesc
         maybeRead reads' s = case reads' s of
                                 [(x, "")] -> Just x
                                 _         -> Nothing
@@ -65,8 +107,10 @@ xmonad initxmc = do
                     ws                   <- maybeRead reads s
                     return . W.ensureTags layout (workspaces xmc)
                            $ W.mapLayout (fromMaybe layout . maybeRead lreads) ws
-
-        gaps = take (length xinesc) $ defaultGaps xmc ++ repeat (0,0,0,0)
+        extState = fromMaybe M.empty $ do
+                     ("--resume" : _ : dyns : _) <- return args
+                     vals                        <- maybeRead reads dyns
+                     return . M.fromList . map (second Left) $ vals
 
         cf = XConf
             { display       = dpy
@@ -75,45 +119,63 @@ xmonad initxmc = do
             , normalBorder  = nbc
             , focusedBorder = fbc
             , keyActions    = keys xmc xmc
-            , buttonActions = mouseBindings xmc xmc }
+            , buttonActions = mouseBindings xmc xmc
+            , mouseFocused  = False
+            , mousePosition = Nothing
+            , currentEvent  = Nothing }
+
         st = XState
-            { windowset     = initialWinset
-            , mapped        = S.empty
-            , waitingUnmap  = M.empty
-            , dragging      = Nothing }
-
-    xSetErrorHandler -- in C, I'm too lazy to write the binding: dons
-
-    -- setup initial X environment
-    sync dpy False
-    selectInput dpy rootw $  substructureRedirectMask .|. substructureNotifyMask
-                         .|. enterWindowMask .|. leaveWindowMask .|. structureNotifyMask
-
+            { windowset       = initialWinset
+            , numberlockMask   = 0
+            , mapped          = S.empty
+            , waitingUnmap    = M.empty
+            , dragging        = Nothing
+            , extensibleState = extState
+            }
     allocaXEvent $ \e ->
         runX cf st $ do
 
+            setNumlockMask
             grabKeys
             grabButtons
 
             io $ sync dpy False
 
+            ws <- io $ scan dpy rootw
+
             -- bootstrap the windowset, Operations.windows will identify all
             -- the windows in winset as new and set initial properties for
-            -- those windows
-            windows (const winset)
+            -- those windows.  Remove all windows that are no longer top-level
+            -- children of the root, they may have disappeared since
+            -- restarting.
+            windows . const . foldr W.delete winset $ W.allWindows winset \\ ws
 
-            -- scan for all top-level windows, add the unmanaged ones to the
-            -- windowset
-            ws <- io $ scan dpy rootw
-            mapM_ manage ws
+            -- manage the as-yet-unmanaged windows
+            mapM_ manage (ws \\ W.allWindows winset)
+
+            userCode $ startupHook initxmc
 
             -- main loop, for all you HOF/recursion fans out there.
-            forever_ $ handle =<< io (nextEvent dpy e >> getEvent e)
+            forever $ prehandle =<< io (nextEvent dpy e >> getEvent e)
 
     return ()
-      where forever_ a = a >> forever_ a
+      where
+        -- if the event gives us the position of the pointer, set mousePosition
+        prehandle e = let mouse = do guard (ev_event_type e `elem` evs)
+                                     return (fromIntegral (ev_x_root e)
+                                            ,fromIntegral (ev_y_root e))
+                      in local (\c -> c { mousePosition = mouse, currentEvent = Just e }) (handleWithHook e)
+        evs = [ keyPress, keyRelease, enterNotify, leaveNotify
+              , buttonPress, buttonRelease]
 
 
+-- | Runs handleEventHook from the configuration and runs the default handler
+-- function if it returned True.
+handleWithHook :: Event -> X ()
+handleWithHook e = do
+  evHook <- asks (handleEventHook . config)
+  whenX (userCodeDef True $ getAll `fmap` evHook e) (handle e)
+
 -- ---------------------------------------------------------------------
 -- | Event handler. Map X events onto calls into Operations.hs, which
 -- modify our internal model of the window manager state.
@@ -132,7 +194,7 @@ handle (KeyEvent {ev_event_type = t, ev_state = m, ev_keycode = code})
         s  <- io $ keycodeToKeysym dpy code 0
         mClean <- cleanMask m
         ks <- asks keyActions
-        userCode $ whenJust (M.lookup (mClean, s) ks) id
+        userCodeDef () $ whenJust (M.lookup (mClean, s) ks) id
 
 -- manage a new window
 handle (MapRequestEvent    {ev_window = w}) = withDisplay $ \dpy -> do
@@ -143,7 +205,10 @@ handle (MapRequestEvent    {ev_window = w}) = withDisplay $ \dpy -> do
 
 -- window destroyed, unmanage it
 -- window gone,      unmanage it
-handle (DestroyWindowEvent {ev_window = w}) = whenX (isClient w) $ unmanage w
+handle (DestroyWindowEvent {ev_window = w}) = whenX (isClient w) $ do
+    unmanage w
+    modify (\s -> s { mapped       = S.delete w (mapped s)
+                    , waitingUnmap = M.delete w (waitingUnmap s)})
 
 -- We track expected unmap events in waitingUnmap.  We ignore this event unless
 -- it is synthetic or we are not expecting an unmap notification from a window.
@@ -151,12 +216,16 @@ handle (UnmapEvent {ev_window = w, ev_send_event = synthetic}) = whenX (isClient
     e <- gets (fromMaybe 0 . M.lookup w . waitingUnmap)
     if (synthetic || e == 0)
         then unmanage w
-        else modify (\s -> s { waitingUnmap = M.adjust pred w (waitingUnmap s) })
+        else modify (\s -> s { waitingUnmap = M.update mpred w (waitingUnmap s) })
+ where mpred 1 = Nothing
+       mpred n = Just $ pred n
 
 -- set keyboard mapping
 handle e@(MappingNotifyEvent {}) = do
     io $ refreshKeyboardMapping e
-    when (ev_request e == mappingKeyboard) grabKeys
+    when (ev_request e `elem` [mappingKeyboard, mappingModifier]) $ do
+        setNumlockMask
+        grabKeys
 
 -- handle button release, which may finish dragging.
 handle e@(ButtonEvent {ev_event_type = t})
@@ -179,17 +248,23 @@ handle e@(ButtonEvent {ev_window = w,ev_event_type = t,ev_button = b })
     | t == buttonPress = do
     -- If it's the root window, then it's something we
     -- grabbed in grabButtons. Otherwise, it's click-to-focus.
+    dpy <- asks display
     isr <- isRoot w
     m <- cleanMask $ ev_state e
-    ba <- asks buttonActions
-    if isr then userCode $ whenJust (M.lookup (m, b) ba) ($ ev_subwindow e)
-           else focus w
-    sendMessage e -- Always send button events.
+    mact <- asks (M.lookup (m, b) . buttonActions)
+    case mact of
+        Just act | isr -> act $ ev_subwindow e
+        _              -> do
+            focus w
+            ctf <- asks (clickJustFocuses . config)
+            unless ctf $ io (allowEvents dpy replayPointer currentTime)
+    broadcastMessage e -- Always send button events.
 
--- entered a normal window, makes this focused.
+-- entered a normal window: focus it if focusFollowsMouse is set to
+-- True in the user's config.
 handle e@(CrossingEvent {ev_window = w, ev_event_type = t})
     | t == enterNotify && ev_mode   e == notifyNormal
-                       && ev_detail e /= notifyInferior = focus w
+    = whenX (asks $ focusFollowsMouse . config) (focus w)
 
 -- left a window, check if we need to focus root
 handle e@(CrossingEvent {ev_event_type = t})
@@ -227,8 +302,15 @@ handle e@(ConfigureRequestEvent {ev_window = w}) = withDisplay $ \dpy -> do
 handle (ConfigureEvent {ev_window = w}) = whenX (isRoot w) rescreen
 
 -- property notify
-handle PropertyEvent { ev_event_type = t, ev_atom = a }
-    | t == propertyNotify && a == wM_NAME = userCode =<< asks (logHook . config)
+handle event@(PropertyEvent { ev_event_type = t, ev_atom = a })
+    | t == propertyNotify && a == wM_NAME = asks (logHook . config) >>= userCodeDef () >>
+                                         broadcastMessage event
+
+handle e@ClientMessageEvent { ev_message_type = mt } = do
+    a <- getAtom "XMONAD_RESTART"
+    if (mt == a)
+        then restart "xmonad" True
+        else broadcastMessage e
 
 handle e = broadcastMessage e -- trace (eventName e) -- ignoring
 
@@ -254,6 +336,18 @@ scan dpy rootw = do
                   return $ not (wa_override_redirect wa)
                          && (wa_map_state wa == waIsViewable || ic)
 
+setNumlockMask :: X ()
+setNumlockMask = do
+    dpy <- asks display
+    ms <- io $ getModifierMapping dpy
+    xs <- sequence [ do
+                        ks <- io $ keycodeToKeysym dpy kc 0
+                        if ks == xK_Num_Lock
+                            then return (setBit 0 (fromIntegral m))
+                            else return (0 :: KeyMask)
+                        | (m, kcs) <- ms, kc <- kcs, kc /= 0]
+    modify (\s -> s { numberlockMask = foldr (.|.) 0 xs })
+
 -- | Grab the keys back
 grabKeys :: X ()
 grabKeys = do
@@ -265,7 +359,7 @@ grabKeys = do
          kc <- io $ keysymToKeycode dpy sym
          -- "If the specified KeySym is not defined for any KeyCode,
          -- XKeysymToKeycode() returns zero."
-         when (kc /= '\0') $ mapM_ (grab kc . (mask .|.)) =<< extraModifiers
+         when (kc /= 0) $ mapM_ (grab kc . (mask .|.)) =<< extraModifiers
 
 -- | XXX comment me
 grabButtons :: X ()
@@ -277,3 +371,36 @@ grabButtons = do
     ems <- extraModifiers
     ba <- asks buttonActions
     mapM_ (\(m,b) -> mapM_ (grab b . (m .|.)) ems) (M.keys $ ba)
+
+-- | @replace@ to signals compliant window managers to exit.
+replace :: Display -> ScreenNumber -> Window -> IO ()
+replace dpy dflt rootw = do
+    -- check for other WM
+    wmSnAtom <- internAtom dpy ("WM_S" ++ show dflt) False
+    currentWmSnOwner <- xGetSelectionOwner dpy wmSnAtom
+    when (currentWmSnOwner /= 0) $ do
+        -- prepare to receive destroyNotify for old WM
+        selectInput dpy currentWmSnOwner structureNotifyMask
+
+        -- create off-screen window
+        netWmSnOwner <- allocaSetWindowAttributes $ \attributes -> do
+            set_override_redirect attributes True
+            set_event_mask attributes propertyChangeMask
+            let screen = defaultScreenOfDisplay dpy
+                visual = defaultVisualOfScreen screen
+                attrmask = cWOverrideRedirect .|. cWEventMask
+            createWindow dpy rootw (-100) (-100) 1 1 0 copyFromParent copyFromParent visual attrmask attributes
+
+        -- try to acquire wmSnAtom, this should signal the old WM to terminate
+        xSetSelectionOwner dpy wmSnAtom netWmSnOwner currentTime
+
+        -- SKIPPED: check if we acquired the selection
+        -- SKIPPED: send client message indicating that we are now the WM
+
+        -- wait for old WM to go away
+        fix $ \again -> do
+            evt <- allocaXEvent $ \event -> do
+                windowEvent dpy currentWmSnOwner structureNotifyMask event
+                get_EventType event
+
+            when (evt /= destroyNotify) again

XMonad/ManageHook.hs

@@ -2,11 +2,11 @@
 
 -----------------------------------------------------------------------------
 -- |
--- Module      :  XMonad/ManageHook.hs
+-- Module      :  XMonad.ManageHook
 -- Copyright   :  (c) Spencer Janssen 2007
 -- License     :  BSD3-style (see LICENSE)
 --
--- Maintainer  :  sjanssen@cse.unl.edu
+-- Maintainer  :  spencerjanssen@gmail.com
 -- Stability   :  unstable
 -- Portability :  not portable, uses cunning newtype deriving
 --
@@ -18,55 +18,92 @@
 
 module XMonad.ManageHook where
 
+import Prelude hiding (catch)
 import XMonad.Core
 import Graphics.X11.Xlib.Extras
+import Graphics.X11.Xlib (Display, Window, internAtom, wM_NAME)
+import Control.Exception.Extensible (bracket, catch, SomeException(..))
 import Control.Monad.Reader
 import Data.Maybe
 import Data.Monoid
 import qualified XMonad.StackSet as W
 import XMonad.Operations (floatLocation, reveal)
 
+-- | Lift an 'X' action to a 'Query'.
 liftX :: X a -> Query a
 liftX = Query . lift
 
 -- | The identity hook that returns the WindowSet unchanged.
-idHook :: ManageHook
-idHook = doF id
+idHook :: Monoid m => m
+idHook = mempty
 
--- | Compose two 'ManageHook's
-(<+>) :: ManageHook -> ManageHook -> ManageHook
+-- | Infix 'mappend'. Compose two 'ManageHook' from right to left.
+(<+>) :: Monoid m => m -> m -> m
 (<+>) = mappend
 
--- | Compose the list of 'ManageHook's
-composeAll :: [ManageHook] -> ManageHook
+-- | Compose the list of 'ManageHook's.
+composeAll :: Monoid m => [m] -> m
 composeAll = mconcat
 
--- | 'p --> x'.  If 'p' returns 'True', execute the 'ManageHook'.
-(-->) :: Query Bool -> ManageHook -> ManageHook
-p --> f = p >>= \b -> if b then f else mempty
+infix 0 -->
 
--- | 'q =? x'. if the result of 'q' equals 'x', return 'True'.
+-- | @p --> x@.  If @p@ returns 'True', execute the 'ManageHook'.
+--
+-- > (-->) :: Monoid m => Query Bool -> Query m -> Query m -- a simpler type
+(-->) :: (Monad m, Monoid a) => m Bool -> m a -> m a
+p --> f = p >>= \b -> if b then f else return mempty
+
+-- | @q =? x@. if the result of @q@ equals @x@, return 'True'.
 (=?) :: Eq a => Query a -> a -> Query Bool
 q =? x = fmap (== x) q
 
 infixr 3 <&&>, <||>
 
--- | 'p <&&> q'.  '&&' lifted to a Monad.
+-- | '&&' lifted to a 'Monad'.
 (<&&>) :: Monad m => m Bool -> m Bool -> m Bool
 (<&&>) = liftM2 (&&)
 
--- | 'p <||> q'.  '||' lifted to a Monad.
+-- | '||' lifted to a 'Monad'.
 (<||>) :: Monad m => m Bool -> m Bool -> m Bool
 (<||>) = liftM2 (||)
 
--- | Queries that return the window title, resource, or class.
-title, resource, className :: Query String
-title     = ask >>= (\w -> liftX $ withDisplay $ \d -> fmap (fromMaybe "") $ io $ fetchName    d w)
-resource  = ask >>= (\w -> liftX $ withDisplay $ \d -> fmap resName        $ io $ getClassHint d w)
-className = ask >>= (\w -> liftX $ withDisplay $ \d -> fmap resClass       $ io $ getClassHint d w)
+-- | Return the window title.
+title :: Query String
+title = ask >>= \w -> liftX $ do
+    d <- asks display
+    let
+        getProp =
+            (internAtom d "_NET_WM_NAME" False >>= getTextProperty d w)
+                `catch` \(SomeException _) -> getTextProperty d w wM_NAME
+        extract prop = do l <- wcTextPropertyToTextList d prop
+                          return $ if null l then "" else head l
+    io $ bracket getProp (xFree . tp_value) extract `catch` \(SomeException _) -> return ""
+
+-- | Return the application name.
+appName :: Query String
+appName = ask >>= (\w -> liftX $ withDisplay $ \d -> fmap resName $ io $ getClassHint d w)
+
+-- | Backwards compatible alias for 'appName'.
+resource :: Query String
+resource = appName
+
+-- | Return the resource class.
+className :: Query String
+className = ask >>= (\w -> liftX $ withDisplay $ \d -> fmap resClass $ io $ getClassHint d w)
+
+-- | A query that can return an arbitrary X property of type 'String',
+--   identified by name.
+stringProperty :: String -> Query String
+stringProperty p = ask >>= (\w -> liftX $ withDisplay $ \d -> fmap (fromMaybe "") $ getStringProperty d w p)
+
+getStringProperty :: Display -> Window -> String -> X (Maybe String)
+getStringProperty d w p = do
+  a  <- getAtom p
+  md <- io $ getWindowProperty8 d a w
+  return $ fmap (map (toEnum . fromIntegral)) md
 
 -- | Modify the 'WindowSet' with a pure function.
-doF :: (WindowSet -> WindowSet) -> ManageHook
+doF :: (s -> s) -> Query (Endo s)
 doF = return . Endo
 
 -- | Move the window to the floating layer.
@@ -76,3 +113,7 @@ doFloat = ask >>= \w -> doF . W.float w . snd =<< liftX (floatLocation w)
 -- | Map the window and remove it from the 'WindowSet'.
 doIgnore :: ManageHook
 doIgnore = ask >>= \w -> liftX (reveal w) >> doF (W.delete w)
+
+-- | Move the window to a given workspace
+doShift :: WorkspaceId -> ManageHook
+doShift i = doF . W.shiftWin i =<< ask

XMonad/Operations.hs

@@ -1,10 +1,9 @@
 {-# OPTIONS_GHC -fno-warn-orphans #-}
-{-# OPTIONS_GHC -fglasgow-exts    #-} -- For deriving Data/Typeable
 {-# LANGUAGE FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances #-}
 
 -- --------------------------------------------------------------------------
 -- |
--- Module      :  Operations.hs
+-- Module      :  XMonad.Operations
 -- Copyright   :  (c) Spencer Janssen 2007
 -- License     :  BSD3-style (see LICENSE)
 --
@@ -23,17 +22,19 @@ import XMonad.Layout (Full(..))
 import qualified XMonad.StackSet as W
 
 import Data.Maybe
+import Data.Monoid          (Endo(..))
 import Data.List            (nub, (\\), find)
-import Data.Bits            ((.|.), (.&.), complement)
+import Data.Bits            ((.|.), (.&.), complement, testBit)
 import Data.Ratio
 import qualified Data.Map as M
 import qualified Data.Set as S
 
 import Control.Applicative
-import Control.Monad.State
 import Control.Monad.Reader
+import Control.Monad.State
+import qualified Control.Exception.Extensible as C
 
-import System.IO
+import System.Posix.Process (executeFile)
 import Graphics.X11.Xlib
 import Graphics.X11.Xinerama (getScreenInfo)
 import Graphics.X11.Xlib.Extras
@@ -54,7 +55,7 @@ manage w = whenX (not <$> isClient w) $ withDisplay $ \d -> do
     let isFixedSize = sh_min_size sh /= Nothing && sh_min_size sh == sh_max_size sh
     isTransient <- isJust <$> io (getTransientForHint d w)
 
-    (sc, rr) <- floatLocation w
+    rr <- snd `fmap` floatLocation w
     -- ensure that float windows don't go over the edge of the screen
     let adjust (W.RationalRect x y wid h) | x + wid > 1 || y + h > 1 || x < 0 || y < 0
                                               = W.RationalRect (0.5 - wid/2) (0.5 - h/2) wid h
@@ -62,40 +63,26 @@ manage w = whenX (not <$> isClient w) $ withDisplay $ \d -> do
 
         f ws | isFixedSize || isTransient = W.float w (adjust rr) . W.insertUp w . W.view i $ ws
              | otherwise                  = W.insertUp w ws
-            where i = fromMaybe (W.tag . W.workspace . W.current $ ws) $ W.lookupWorkspace sc ws
+            where i = W.tag $ W.workspace $ W.current ws
 
     mh <- asks (manageHook . config)
-    g <- runManageHook mh w `catchX` return id
+    g <- appEndo <$> userCodeDef (Endo id) (runQuery mh w)
     windows (g . f)
 
 -- | unmanage. A window no longer exists, remove it from the window
 -- list, on whatever workspace it is.
 --
--- should also unmap?
---
 unmanage :: Window -> X ()
-unmanage w = do
-    windows (W.delete w)
-    setWMState w withdrawnState
-    modify (\s -> s {mapped = S.delete w (mapped s), waitingUnmap = M.delete w (waitingUnmap s)})
+unmanage = windows . W.delete
 
--- | Modify the size of the status gap at the top of the current screen
--- Taking a function giving the current screen, and current geometry.
-modifyGap :: (Int -> (Int,Int,Int,Int) -> (Int,Int,Int,Int)) -> X ()
-modifyGap f = do
-    windows $ \ws@(W.StackSet { W.current = c@(W.Screen { W.screenDetail = sd }) }) ->
-        let n = fromIntegral . W.screen $ c
-            g = f n . statusGap $ sd
-        in ws { W.current = c { W.screenDetail = sd { statusGap = g } } }
-
--- | Kill the currently focused client. If we do kill it, we'll get a
+-- | Kill the specified window. If we do kill it, we'll get a
 -- delete notify back from X.
 --
 -- There are two ways to delete a window. Either just kill it, or if it
 -- supports the delete protocol, send a delete event (e.g. firefox)
 --
-kill :: X ()
-kill = withDisplay $ \d -> withFocused $ \w -> do
+killWindow :: Window -> X ()
+killWindow w = withDisplay $ \d -> do
     wmdelt <- atom_WM_DELETE_WINDOW  ;  wmprot <- atom_WM_PROTOCOLS
 
     protocols <- io $ getWMProtocols d w
@@ -106,6 +93,10 @@ kill = withDisplay $ \d -> withFocused $ \w -> do
                 sendEvent d w False noEventMask ev
         else killClient d w >> return ()
 
+-- | Kill the currently focused client.
+kill :: X ()
+kill = withFocused killWindow
+
 -- ---------------------------------------------------------------------
 -- Managing windows
 
@@ -114,64 +105,75 @@ windows :: (WindowSet -> WindowSet) -> X ()
 windows f = do
     XState { windowset = old } <- get
     let oldvisible = concatMap (W.integrate' . W.stack . W.workspace) $ W.current old : W.visible old
+        newwindows = W.allWindows ws \\ W.allWindows old
         ws = f old
     XConf { display = d , normalBorder = nbc, focusedBorder = fbc } <- ask
-    mapM_ setInitialProperties (W.allWindows ws \\ W.allWindows old)
+
+    mapM_ setInitialProperties newwindows
+
     whenJust (W.peek old) $ \otherw -> io $ setWindowBorder d otherw nbc
     modify (\s -> s { windowset = ws })
 
     -- notify non visibility
     let tags_oldvisible = map (W.tag . W.workspace) $ W.current old : W.visible old
-        gottenhidden    = filter (`elem` tags_oldvisible) $ map W.tag $ W.hidden ws
-    sendMessageToWorkspaces Hide gottenhidden
+        gottenhidden    = filter (flip elem tags_oldvisible . W.tag) $ W.hidden ws
+    mapM_ (sendMessageWithNoRefresh Hide) gottenhidden
 
     -- for each workspace, layout the currently visible workspaces
     let allscreens     = W.screens ws
         summed_visible = scanl (++) [] $ map (W.integrate' . W.stack . W.workspace) allscreens
-    visible <- fmap concat $ forM (zip allscreens summed_visible) $ \ (w, vis) -> do
-        let n      = W.tag (W.workspace w)
-            this   = W.view n ws
-            l = W.layout (W.workspace w)
-            flt = filter (flip M.member (W.floating ws)) (W.index this)
+    rects <- fmap concat $ forM (zip allscreens summed_visible) $ \ (w, vis) -> do
+        let wsp   = W.workspace w
+            this  = W.view n ws
+            n     = W.tag wsp
             tiled = (W.stack . W.workspace . W.current $ this)
                     >>= W.filter (`M.notMember` W.floating ws)
                     >>= W.filter (`notElem` vis)
-            (SD (Rectangle sx sy sw sh)
-                (gt,gb,gl,gr))          = W.screenDetail w
-            viewrect = Rectangle (sx + fromIntegral gl)        (sy + fromIntegral gt)
-                                 (sw - fromIntegral (gl + gr)) (sh - fromIntegral (gt + gb))
+            viewrect = screenRect $ W.screenDetail w
 
         -- just the tiled windows:
         -- now tile the windows on this workspace, modified by the gap
-        (rs, ml') <- runLayout l viewrect tiled `catchX` runLayout (Layout Full) viewrect tiled
-        mapM_ (uncurry tileWindow) rs
-        whenJust ml' $ \l' -> runOnWorkspaces (\ww -> if W.tag ww == n
-                                                      then return $ ww { W.layout = l'}
-                                                      else return ww)
+        (rs, ml') <- runLayout wsp { W.stack = tiled } viewrect `catchX`
+                     runLayout wsp { W.stack = tiled, W.layout = Layout Full } viewrect
+        updateLayout n ml'
 
-        -- now the floating windows:
-        -- move/resize the floating windows, if there are any
-        forM_ flt $ \fw -> whenJust (M.lookup fw (W.floating ws)) $
-          \(W.RationalRect rx ry rw rh) -> do
-            tileWindow fw $ Rectangle
-                (sx + floor (toRational sw*rx)) (sy + floor (toRational sh*ry))
-                (floor (toRational sw*rw)) (floor (toRational sh*rh))
+        let m   = W.floating ws
+            flt = [(fw, scaleRationalRect viewrect r)
+                    | fw <- filter (flip M.member m) (W.index this)
+                    , Just r <- [M.lookup fw m]]
+            vs = flt ++ rs
 
-        let vs = flt ++ map fst rs
-        io $ restackWindows d vs
+        io $ restackWindows d (map fst vs)
         -- return the visible windows for this workspace:
         return vs
 
+    let visible = map fst rects
+
+    mapM_ (uncurry tileWindow) rects
+
     whenJust (W.peek ws) $ \w -> io $ setWindowBorder d w fbc
+
+    mapM_ reveal visible
     setTopFocus
-    asks (logHook . config) >>= userCode
-    -- io performGC -- really helps, but seems to trigger GC bugs?
 
     -- hide every window that was potentially visible before, but is not
     -- given a position by a layout now.
-    mapM_ hide (nub oldvisible \\ visible)
+    mapM_ hide (nub (oldvisible ++ newwindows) \\ visible)
 
-    clearEvents enterWindowMask
+    -- all windows that are no longer in the windowset are marked as
+    -- withdrawn, it is important to do this after the above, otherwise 'hide'
+    -- will overwrite withdrawnState with iconicState
+    mapM_ (flip setWMState withdrawnState) (W.allWindows old \\ W.allWindows ws)
+
+    isMouseFocused <- asks mouseFocused
+    unless isMouseFocused $ clearEvents enterWindowMask
+    asks (logHook . config) >>= userCodeDef ()
+
+-- | Produce the actual rectangle from a screen and a ratio on that screen.
+scaleRationalRect :: Rectangle -> W.RationalRect -> Rectangle
+scaleRationalRect (Rectangle sx sy sw sh) (W.RationalRect rx ry rw rh)
+ = Rectangle (sx + scale sw rx) (sy + scale sh ry) (scale sw rw) (scale sh rh)
+ where scale s r = floor (toRational s * r)
 
 -- | setWMState.  set the WM_STATE property
 setWMState :: Window -> Int -> X ()
@@ -197,7 +199,7 @@ reveal :: Window -> X ()
 reveal w = withDisplay $ \d -> do
     setWMState w normalState
     io $ mapWindow d w
-    modify (\s -> s { mapped = S.insert w (mapped s) })
+    whenX (isClient w) $ modify (\s -> s { mapped = S.insert w (mapped s) })
 
 -- | The client events that xmonad is interested in
 clientMask :: EventMask
@@ -207,7 +209,7 @@ clientMask = structureNotifyMask .|. enterWindowMask .|. propertyChangeMask
 setInitialProperties :: Window -> X ()
 setInitialProperties w = asks normalBorder >>= \nb -> withDisplay $ \d -> do
     setWMState w iconicState
-    io $ selectInput d w $ clientMask
+    io $ selectInput d w clientMask
     bw <- asks (borderWidth . config)
     io $ setWindowBorderWidth d w bw
     -- we must initially set the color of new windows, to maintain invariants
@@ -215,7 +217,7 @@ setInitialProperties w = asks normalBorder >>= \nb -> withDisplay $ \d -> do
     io $ setWindowBorder d w nb
 
 -- | refresh. Render the currently visible workspaces, as determined by
--- the StackSet. Also, set focus to the focused window.
+-- the 'StackSet'. Also, set focus to the focused window.
 --
 -- This is our 'view' operation (MVC), in that it pretty prints our model
 -- with X calls.
@@ -241,21 +243,38 @@ tileWindow w r = withDisplay $ \d -> do
                 | otherwise  = x - bw*2
     io $ moveResizeWindow d w (rect_x r) (rect_y r)
                               (least $ rect_width r) (least $ rect_height r)
-    reveal w
 
 -- ---------------------------------------------------------------------
 
+-- | Returns 'True' if the first rectangle is contained within, but not equal
+-- to the second.
+containedIn :: Rectangle -> Rectangle -> Bool
+containedIn r1@(Rectangle x1 y1 w1 h1) r2@(Rectangle x2 y2 w2 h2)
+ = and [ r1 /= r2
+       , x1 >= x2
+       , y1 >= y2
+       , fromIntegral x1 + w1 <= fromIntegral x2 + w2
+       , fromIntegral y1 + h1 <= fromIntegral y2 + h2 ]
+
+-- | Given a list of screens, remove all duplicated screens and screens that
+-- are entirely contained within another.
+nubScreens :: [Rectangle] -> [Rectangle]
+nubScreens xs = nub . filter (\x -> not $ any (x `containedIn`) xs) $ xs
+
+-- | Cleans the list of screens according to the rules documented for
+-- nubScreens.
+getCleanedScreenInfo :: MonadIO m => Display -> m [Rectangle]
+getCleanedScreenInfo = io .  fmap nubScreens . getScreenInfo
+
 -- | rescreen.  The screen configuration may have changed (due to
 -- xrandr), update the state and refresh the screen, and reset the gap.
 rescreen :: X ()
 rescreen = do
-    xinesc <- withDisplay (io . getScreenInfo)
+    xinesc <- withDisplay getCleanedScreenInfo
 
     windows $ \ws@(W.StackSet { W.current = v, W.visible = vs, W.hidden = hs }) ->
         let (xs, ys) = splitAt (length xinesc) $ map W.workspace (v:vs) ++ hs
-            (a:as)   = zipWith3 W.Screen xs [0..] $ zipWith SD xinesc gs
-            sgs      = map (statusGap . W.screenDetail) (v:vs)
-            gs       = take (length xinesc) (sgs ++ repeat (0,0,0,0))
+            (a:as)   = zipWith3 W.Screen xs [0..] $ map SD xinesc
         in  ws { W.current = a
                , W.visible = as
                , W.hidden  = ys }
@@ -264,11 +283,14 @@ rescreen = do
 
 -- | setButtonGrab. Tell whether or not to intercept clicks on a given window
 setButtonGrab :: Bool -> Window -> X ()
-setButtonGrab grab w = withDisplay $ \d -> io $
-    if grab
+setButtonGrab grab w = do
+    pointerMode <- asks $ \c -> if clickJustFocuses (config c)
+                                    then grabModeAsync
+                                    else grabModeSync
+    withDisplay $ \d -> io $ if grab
         then forM_ [button1, button2, button3] $ \b ->
             grabButton d b anyModifier w False buttonPressMask
-                       grabModeAsync grabModeSync none none
+                       pointerMode grabModeSync none none
         else ungrabButton d anyButton anyModifier w
 
 -- ---------------------------------------------------------------------
@@ -282,9 +304,17 @@ setTopFocus = withWindowSet $ maybe (setFocusX =<< asks theRoot) setFocusX . W.p
 -- This happens if X notices we've moved the mouse (and perhaps moved
 -- the mouse to a new screen).
 focus :: Window -> X ()
-focus w = withWindowSet $ \s -> do
-    if W.member w s then when (W.peek s /= Just w) $ windows (W.focusWindow w)
-                    else whenX (isRoot w) $ setFocusX w
+focus w = local (\c -> c { mouseFocused = True }) $ withWindowSet $ \s -> do
+    let stag = W.tag . W.workspace
+        curr = stag $ W.current s
+    mnew <- maybe (return Nothing) (fmap (fmap stag) . uncurry pointScreen)
+            =<< asks mousePosition
+    root <- asks theRoot
+    case () of
+        _ | W.member w s && W.peek s /= Just w -> windows (W.focusWindow w)
+          | Just new <- mnew, w == root && curr /= new
+                                               -> windows (W.view new)
+          | otherwise                          -> return ()
 
 -- | Call X to set the keyboard focus details.
 setFocusX :: Window -> X ()
@@ -292,53 +322,66 @@ setFocusX w = withWindowSet $ \ws -> do
     dpy <- asks display
 
     -- clear mouse button grab and border on other windows
-    forM_ (W.current ws : W.visible ws) $ \wk -> do
-        forM_ (W.index (W.view (W.tag (W.workspace wk)) ws)) $ \otherw -> do
+    forM_ (W.current ws : W.visible ws) $ \wk ->
+        forM_ (W.index (W.view (W.tag (W.workspace wk)) ws)) $ \otherw ->
             setButtonGrab True otherw
 
     -- If we ungrab buttons on the root window, we lose our mouse bindings.
     whenX (not <$> isRoot w) $ setButtonGrab False w
-    io $ do setInputFocus dpy w revertToPointerRoot 0
-            -- raiseWindow dpy w
+
+    hints <- io $ getWMHints dpy w
+    protocols <- io $ getWMProtocols dpy w
+    wmprot <- atom_WM_PROTOCOLS
+    wmtf <- atom_WM_TAKE_FOCUS
+    currevt <- asks currentEvent
+    let inputHintSet = wmh_flags hints `testBit` inputHintBit
+
+    when ((inputHintSet && wmh_input hints) || (not inputHintSet)) $
+      io $ do setInputFocus dpy w revertToPointerRoot 0
+    when (wmtf `elem` protocols) $
+      io $ allocaXEvent $ \ev -> do
+        setEventType ev clientMessage
+        setClientMessageEvent ev w wmprot 32 wmtf $ maybe currentTime event_time currevt
+        sendEvent dpy w False noEventMask ev
+        where event_time ev =
+                if (ev_event_type ev) `elem` timedEvents then
+                  ev_time ev
+                else
+                  currentTime
+              timedEvents = [ keyPress, keyRelease, buttonPress, buttonRelease, enterNotify, leaveNotify, selectionRequest ]
 
 ------------------------------------------------------------------------
 -- Message handling
 
--- | Throw a message to the current LayoutClass possibly modifying how we
+-- | Throw a message to the current 'LayoutClass' possibly modifying how we
 -- layout the windows, then refresh.
 sendMessage :: Message a => a -> X ()
 sendMessage a = do
     w <- W.workspace . W.current <$> gets windowset
     ml' <- handleMessage (W.layout w) (SomeMessage a) `catchX` return Nothing
-    whenJust ml' $ \l' -> do
+    whenJust ml' $ \l' ->
         windows $ \ws -> ws { W.current = (W.current ws)
                                 { W.workspace = (W.workspace $ W.current ws)
                                   { W.layout = l' }}}
 
--- | Send a message to a list of workspaces' layouts, without necessarily refreshing.
-sendMessageToWorkspaces :: Message a => a -> [WorkspaceId] -> X ()
-sendMessageToWorkspaces a l = runOnWorkspaces $ \w ->
-   if W.tag w `elem` l
-      then do ml' <- handleMessage (W.layout w) (SomeMessage a) `catchX` return Nothing
-              return $ w { W.layout = maybe (W.layout w) id ml' }
-      else return w
-
--- | Send a message to all visible layouts, without necessarily refreshing.
--- This is how we implement the hooks, such as UnDoLayout.
+-- | Send a message to all layouts, without refreshing.
 broadcastMessage :: Message a => a -> X ()
-broadcastMessage a = runOnWorkspaces $ \w -> do
-    ml' <- handleMessage (W.layout w) (SomeMessage a) `catchX` return Nothing
-    return $ w { W.layout = maybe (W.layout w) id ml' }
+broadcastMessage a = withWindowSet $ \ws -> do
+   let c = W.workspace . W.current $ ws
+       v = map W.workspace . W.visible $ ws
+       h = W.hidden ws
+   mapM_ (sendMessageWithNoRefresh a) (c : v ++ h)
 
--- | This is basically a map function, running a function in the X monad on
--- each workspace with the output of that function being the modified workspace.
-runOnWorkspaces :: (WindowSpace -> X WindowSpace) -> X ()
-runOnWorkspaces job =do
-    ws <- gets windowset
-    h <- mapM job $ W.hidden ws
-    c:v <- mapM (\s -> (\w -> s { W.workspace = w}) <$> job (W.workspace s))
-             $ W.current ws : W.visible ws
-    modify $ \s -> s { windowset = ws { W.current = c, W.visible = v, W.hidden = h } }
+-- | Send a message to a layout, without refreshing.
+sendMessageWithNoRefresh :: Message a => a -> W.Workspace WorkspaceId (Layout Window) Window -> X ()
+sendMessageWithNoRefresh a w =
+    handleMessage (W.layout w) (SomeMessage a) `catchX` return Nothing >>=
+    updateLayout  (W.tag w)
+
+-- | Update the layout field of a workspace
+updateLayout :: WorkspaceId -> Maybe (Layout Window) -> X ()
+updateLayout i ml = whenJust ml $ \l ->
+    runOnWorkspaces $ \ww -> return $ if W.tag ww == i then ww { W.layout = l} else ww
 
 -- | Set the layout of the currently viewed workspace
 setLayout :: Layout Window -> X ()
@@ -350,15 +393,15 @@ setLayout l = do
 ------------------------------------------------------------------------
 -- Utilities
 
--- | Return workspace visible on screen 'sc', or Nothing.
+-- | Return workspace visible on screen 'sc', or 'Nothing'.
 screenWorkspace :: ScreenId -> X (Maybe WorkspaceId)
 screenWorkspace sc = withWindowSet $ return . W.lookupWorkspace sc
 
--- | Apply an X operation to the currently focused window, if there is one.
+-- | Apply an 'X' operation to the currently focused window, if there is one.
 withFocused :: (Window -> X ()) -> X ()
 withFocused f = withWindowSet $ \w -> whenJust (W.peek w) f
 
--- | True if window is under management by us
+-- | 'True' if window is under management by us
 isClient :: Window -> X Bool
 isClient w = withWindowSet $ return . W.member w
 
@@ -366,20 +409,38 @@ isClient w = withWindowSet $ return . W.member w
 -- (numlock and capslock)
 extraModifiers :: X [KeyMask]
 extraModifiers = do
-    nlm <- asks (numlockMask . config)
+    nlm <- gets numberlockMask
     return [0, nlm, lockMask, nlm .|. lockMask ]
 
 -- | Strip numlock\/capslock from a mask
 cleanMask :: KeyMask -> X KeyMask
 cleanMask km = do
-    nlm <- asks (numlockMask . config)
+    nlm <- gets numberlockMask
     return (complement (nlm .|. lockMask) .&. km)
 
--- | Get the Pixel value for a named color
-initColor :: Display -> String -> IO Pixel
-initColor dpy c = (color_pixel . fst) <$> allocNamedColor dpy colormap c
+-- | Get the 'Pixel' value for a named color
+initColor :: Display -> String -> IO (Maybe Pixel)
+initColor dpy c = C.handle (\(C.SomeException _) -> return Nothing) $
+    (Just . color_pixel . fst) <$> allocNamedColor dpy colormap c
     where colormap = defaultColormap dpy (defaultScreen dpy)
 
+------------------------------------------------------------------------
+
+-- | @restart name resume@. Attempt to restart xmonad by executing the program
+-- @name@.  If @resume@ is 'True', restart with the current window state.
+-- When executing another window manager, @resume@ should be 'False'.
+restart :: String -> Bool -> X ()
+restart prog resume = do
+    broadcastMessage ReleaseResources
+    io . flush =<< asks display
+    let wsData = show . W.mapLayout show . windowset
+        maybeShow (t, Right (PersistentExtension ext)) = Just (t, show ext)
+        maybeShow (t, Left str) = Just (t, str)
+        maybeShow _ = Nothing
+        extState = return . show . catMaybes . map maybeShow . M.toList . extensibleState
+    args <- if resume then gets (\s -> "--resume":wsData s:extState s) else return []
+    catchIO (executeFile prog True args Nothing)
+
 ------------------------------------------------------------------------
 -- | Floating layer support
 
@@ -390,31 +451,39 @@ floatLocation w = withDisplay $ \d -> do
     ws <- gets windowset
     wa <- io $ getWindowAttributes d w
     bw <- fi <$> asks (borderWidth . config)
+    sc <- fromMaybe (W.current ws) <$> pointScreen (fi $ wa_x wa) (fi $ wa_y wa)
 
-    -- XXX horrible
-    let sc = fromMaybe (W.current ws) $ find (pointWithin (fi $ wa_x wa) (fi $ wa_y wa) . screenRect . W.screenDetail) $ W.screens ws
-        sr = screenRect . W.screenDetail $ sc
+    let sr = screenRect . W.screenDetail $ sc
         rr = W.RationalRect ((fi (wa_x wa) - fi (rect_x sr)) % fi (rect_width sr))
                             ((fi (wa_y wa) - fi (rect_y sr)) % fi (rect_height sr))
                             (fi (wa_width  wa + bw*2) % fi (rect_width sr))
                             (fi (wa_height wa + bw*2) % fi (rect_height sr))
 
-    return (W.screen $ sc, rr)
+    return (W.screen sc, rr)
   where fi x = fromIntegral x
-        pointWithin :: Integer -> Integer -> Rectangle -> Bool
-        pointWithin x y r = x >= fi (rect_x r) &&
-                            x <  fi (rect_x r) + fi (rect_width r) &&
-                            y >= fi (rect_y r) &&
-                            y <  fi (rect_y r) + fi (rect_height r)
+
+-- | Given a point, determine the screen (if any) that contains it.
+pointScreen :: Position -> Position
+            -> X (Maybe (W.Screen WorkspaceId (Layout Window) Window ScreenId ScreenDetail))
+pointScreen x y = withWindowSet $ return . find p . W.screens
+  where p = pointWithin x y . screenRect . W.screenDetail
+
+-- | @pointWithin x y r@ returns 'True' if the @(x, y)@ co-ordinate is within
+-- @r@.
+pointWithin :: Position -> Position -> Rectangle -> Bool
+pointWithin x y r = x >= rect_x r &&
+                    x <  rect_x r + fromIntegral (rect_width r) &&
+                    y >= rect_y r &&
+                    y <  rect_y r + fromIntegral (rect_height r)
 
 -- | Make a tiled window floating, using its suggested rectangle
 float :: Window -> X ()
 float w = do
     (sc, rr) <- floatLocation w
     windows $ \ws -> W.float w rr . fromMaybe ws $ do
-        i <- W.findTag w ws
+        i  <- W.findTag w ws
         guard $ i `elem` map (W.tag . W.workspace) (W.screens ws)
-        f <- W.peek ws
+        f  <- W.peek ws
         sw <- W.lookupWorkspace sc ws
         return (W.focusWindow f . W.shiftWin sw w $ ws)
 
@@ -460,10 +529,10 @@ mouseResizeWindow w = whenX (isClient w) $ withDisplay $ \d -> do
     wa <- io $ getWindowAttributes d w
     sh <- io $ getWMNormalHints d w
     io $ warpPointer d none w 0 0 0 0 (fromIntegral (wa_width wa)) (fromIntegral (wa_height wa))
-    mouseDrag (\ex ey -> do
+    mouseDrag (\ex ey ->
                  io $ resizeWindow d w `uncurry`
-                    applySizeHints sh (ex - fromIntegral (wa_x wa),
-                                       ey - fromIntegral (wa_y wa)))
+                    applySizeHintsContents sh (ex - fromIntegral (wa_x wa),
+                                               ey - fromIntegral (wa_y wa)))
               (float w)
 
 -- ---------------------------------------------------------------------
@@ -471,10 +540,26 @@ mouseResizeWindow w = whenX (isClient w) $ withDisplay $ \d -> do
 
 type D = (Dimension, Dimension)
 
+-- | Given a window, build an adjuster function that will reduce the given
+-- dimensions according to the window's border width and size hints.
+mkAdjust :: Window -> X (D -> D)
+mkAdjust w = withDisplay $ \d -> liftIO $ do
+    sh <- getWMNormalHints d w
+    bw <- fmap (fromIntegral . wa_border_width) $ getWindowAttributes d w
+    return $ applySizeHints bw sh
+
+-- | Reduce the dimensions if needed to comply to the given SizeHints, taking
+-- window borders into account.
+applySizeHints :: Integral a => Dimension -> SizeHints -> (a, a) -> D
+applySizeHints bw sh =
+    tmap (+ 2 * bw) . applySizeHintsContents sh . tmap (subtract $ 2 * fromIntegral bw)
+    where
+    tmap f (x, y) = (f x, f y)
+
 -- | Reduce the dimensions if needed to comply to the given SizeHints.
-applySizeHints :: Integral a => SizeHints -> (a,a) -> D
-applySizeHints sh (w,h) = applySizeHints' sh (fromIntegral $ max 1 w,
-                                              fromIntegral $ max 1 h)
+applySizeHintsContents :: Integral a => SizeHints -> (a, a) -> D
+applySizeHintsContents sh (w, h) =
+    applySizeHints' sh (fromIntegral $ max 1 w, fromIntegral $ max 1 h)
 
 -- | XXX comment me
 applySizeHints' :: SizeHints -> D -> D

XMonad/StackSet.hs

@@ -2,7 +2,7 @@
 
 -----------------------------------------------------------------------------
 -- |
--- Module      :  StackSet
+-- Module      :  XMonad.StackSet
 -- Copyright   :  (c) Don Stewart 2007
 -- License     :  BSD3-style (see LICENSE)
 --
@@ -31,18 +31,18 @@ module XMonad.StackSet (
         -- * Xinerama operations
         -- $xinerama
         lookupWorkspace,
-        screens, workspaces, allWindows,
+        screens, workspaces, allWindows, currentTag,
         -- *  Operations on the current stack
         -- $stackOperations
         peek, index, integrate, integrate', differentiate,
-        focusUp, focusDown, focusMaster, focusWindow,
+        focusUp, focusDown, focusUp', focusDown', focusMaster, focusWindow,
         tagMember, renameTag, ensureTags, member, findTag, mapWorkspace, mapLayout,
         -- * Modifying the stackset
         -- $modifyStackset
         insertUp, delete, delete', filter,
         -- * Setting the master window
         -- $settingMW
-        swapUp, swapDown, swapMaster, modify, modify', float, sink, -- needed by users
+        swapUp, swapDown, swapMaster, shiftMaster, modify, modify', float, sink, -- needed by users
         -- * Composite operations
         -- $composite
         shift, shiftWin,
@@ -52,7 +52,7 @@ module XMonad.StackSet (
     ) where
 
 import Prelude hiding (filter)
-import Data.Maybe   (listToMaybe,fromJust,isJust)
+import Data.Maybe   (listToMaybe,isJust,fromMaybe)
 import qualified Data.List as L (deleteBy,find,splitAt,filter,nub)
 import Data.List ( (\\) )
 import qualified Data.Map  as M (Map,insert,delete,empty)
@@ -111,8 +111,8 @@ import qualified Data.Map  as M (Map,insert,delete,empty)
 -- receive keyboard events), other workspaces may be passively
 -- viewable.  We thus need to track which virtual workspaces are
 -- associated (viewed) on which physical screens.  To keep track of
--- this, StackSet keeps separate lists of visible but non-focused
--- workspaces, and non-visible workspaces.  
+-- this, 'StackSet' keeps separate lists of visible but non-focused
+-- workspaces, and non-visible workspaces.
 
 -- $focus
 --
@@ -122,38 +122,6 @@ import qualified Data.Map  as M (Map,insert,delete,empty)
 -- 'delete'.
 --
 
--- |
--- API changes from xmonad 0.1:
--- StackSet constructor arguments changed. StackSet workspace window screen
---
--- * new,                    -- was: empty
---
--- * view,
---
--- * index,
---
--- * peek,                   -- was: peek\/peekStack
---
--- * focusUp, focusDown,     -- was: rotate
---
--- * swapUp, swapDown
---
--- * focus                   -- was: raiseFocus
---
--- * insertUp,               -- was: insert\/push
---
--- * delete,
---
--- * swapMaster,             -- was: promote\/swap
---
--- * member,
---
--- * shift,
---
--- * lookupWorkspace,        -- was: workspace
---
--- * visibleWorkspaces       -- gone.
---
 ------------------------------------------------------------------------
 -- |
 -- A cursor into a non-empty list of workspaces.
@@ -177,7 +145,7 @@ data Screen i l a sid sd = Screen { workspace :: !(Workspace i l a)
     deriving (Show, Read, Eq)
 
 -- |
--- A workspace is just a tag - its index - and a stack
+-- A workspace is just a tag, a layout, and a stack.
 --
 data Workspace i l a = Workspace  { tag :: !i, layout :: l, stack :: Maybe (Stack a) }
     deriving (Show, Read, Eq)
@@ -187,7 +155,7 @@ data RationalRect = RationalRect Rational Rational Rational Rational
     deriving (Show, Read, Eq)
 
 -- |
--- A stack is a cursor onto a (possibly empty) window list.
+-- A stack is a cursor onto a window list.
 -- The data structure tracks focus by construction, and
 -- the master window is by convention the top-most item.
 -- Focus operations will not reorder the list that results from
@@ -226,7 +194,8 @@ abort x = error $ "xmonad: StackSet: " ++ x
 -- Xinerama: Virtual workspaces are assigned to physical screens, starting at 0.
 --
 new :: (Integral s) => l -> [i] -> [sd] -> StackSet i l a s sd
-new l wids m | not (null wids) && length m <= length wids = StackSet cur visi unseen M.empty
+new l wids m | not (null wids) && length m <= length wids && not (null m)
+  = StackSet cur visi unseen M.empty
   where (seen,unseen) = L.splitAt (length m) $ map (\i -> Workspace i l Nothing) wids
         (cur:visi)    = [ Screen i s sd |  (i, s, sd) <- zip3 seen [0..] m ]
                 -- now zip up visibles with their screen id
@@ -234,7 +203,7 @@ new _ _ _ = abort "non-positive argument to StackSet.new"
 
 -- |
 -- /O(w)/. Set focus to the workspace with index \'i\'.
--- If the index is out of range, return the original StackSet.
+-- If the index is out of range, return the original 'StackSet'.
 --
 -- Xinerama: If the workspace is not visible on any Xinerama screen, it
 -- becomes the current screen. If it is in the visible list, it becomes
@@ -242,8 +211,7 @@ new _ _ _ = abort "non-positive argument to StackSet.new"
 
 view :: (Eq s, Eq i) => i -> StackSet i l a s sd -> StackSet i l a s sd
 view i s
-    | not (i `tagMember` s)
-      || i == tag (workspace (current s)) = s  -- out of bounds or current
+    | i == currentTag s = s  -- current
 
     | Just x <- L.find ((i==).tag.workspace) (visible s)
     -- if it is visible, it is just raised
@@ -254,7 +222,7 @@ view i s
     = s { current = (current s) { workspace = x }
         , hidden = workspace (current s) : L.deleteBy (equating tag) x (hidden s) }
 
-    | otherwise = s -- can't happen: all workspaces are either invalid, current, visible, or hidden
+    | otherwise = s -- not a member of the stackset
 
   where equating f = \x y -> f x == f y
 
@@ -285,7 +253,7 @@ greedyView w ws
 -- $xinerama
 
 -- | Find the tag of the workspace visible on Xinerama screen 'sc'.
--- Nothing if screen is out of bounds.
+-- 'Nothing' if screen is out of bounds.
 lookupWorkspace :: Eq s => s -> StackSet i l a s sd -> Maybe i
 lookupWorkspace sc w = listToMaybe [ tag i | Screen i s _ <- current w : visible w, s == sc ]
 
@@ -302,7 +270,7 @@ with :: b -> (Stack a -> b) -> StackSet i l a s sd -> b
 with dflt f = maybe dflt f . stack . workspace . current
 
 -- |
--- Apply a function, and a default value for Nothing, to modify the current stack.
+-- Apply a function, and a default value for 'Nothing', to modify the current stack.
 --
 modify :: Maybe (Stack a) -> (Stack a -> Maybe (Stack a)) -> StackSet i l a s sd -> StackSet i l a s sd
 modify d f s = s { current = (current s)
@@ -317,13 +285,13 @@ modify' f = modify Nothing (Just . f)
 
 -- |
 -- /O(1)/. Extract the focused element of the current stack.
--- Return Just that element, or Nothing for an empty stack.
+-- Return 'Just' that element, or 'Nothing' for an empty stack.
 --
 peek :: StackSet i l a s sd -> Maybe a
 peek = with Nothing (return . focus)
 
 -- |
--- /O(n)/. Flatten a Stack into a list.
+-- /O(n)/. Flatten a 'Stack' into a list.
 --
 integrate :: Stack a -> [a]
 integrate (Stack x l r) = reverse l ++ x : r
@@ -333,7 +301,7 @@ integrate (Stack x l r) = reverse l ++ x : r
 integrate' :: Maybe (Stack a) -> [a]
 integrate' = maybe [] integrate
 
--- | 
+-- |
 -- /O(n)/. Turn a list into a possibly empty stack (i.e., a zipper):
 -- the first element of the list is current, and the rest of the list
 -- is down.
@@ -343,7 +311,7 @@ differentiate (x:xs) = Just $ Stack x [] xs
 
 -- |
 -- /O(n)/. 'filter p s' returns the elements of 's' such that 'p' evaluates to
--- True.  Order is preserved, and focus moves as described for 'delete'.
+-- 'True'.  Order is preserved, and focus moves as described for 'delete'.
 --
 filter :: (a -> Bool) -> Stack a -> Maybe (Stack a)
 filter p (Stack f ls rs) = case L.filter p (f:rs) of
@@ -375,15 +343,19 @@ index = with [] integrate
 --
 focusUp, focusDown, swapUp, swapDown :: StackSet i l a s sd -> StackSet i l a s sd
 focusUp   = modify' focusUp'
-focusDown = modify' (reverseStack . focusUp' . reverseStack)
+focusDown = modify' focusDown'
 
 swapUp    = modify' swapUp'
 swapDown  = modify' (reverseStack . swapUp' . reverseStack)
 
-focusUp', swapUp' :: Stack a -> Stack a
+-- | Variants of 'focusUp' and 'focusDown' that work on a
+-- 'Stack' rather than an entire 'StackSet'.
+focusUp', focusDown' :: Stack a -> Stack a
 focusUp' (Stack t (l:ls) rs) = Stack l ls (t:rs)
 focusUp' (Stack t []     rs) = Stack x xs [] where (x:xs) = reverse (t:rs)
+focusDown'                   = reverseStack . focusUp' . reverseStack
 
+swapUp' :: Stack a -> Stack a
 swapUp'  (Stack t (l:ls) rs) = Stack t ls (l:rs)
 swapUp'  (Stack t []     rs) = Stack t (reverse rs) []
 
@@ -397,27 +369,31 @@ reverseStack (Stack t ls rs) = Stack t rs ls
 --
 focusWindow :: (Eq s, Eq a, Eq i) => a -> StackSet i l a s sd -> StackSet i l a s sd
 focusWindow w s | Just w == peek s = s
-                | otherwise        = maybe s id $ do
+                | otherwise        = fromMaybe s $ do
                     n <- findTag w s
                     return $ until ((Just w ==) . peek) focusUp (view n s)
 
--- | Get a list of all screens in the StackSet.
+-- | Get a list of all screens in the 'StackSet'.
 screens :: StackSet i l a s sd -> [Screen i l a s sd]
 screens s = current s : visible s
 
--- | Get a list of all workspaces in the StackSet.
+-- | Get a list of all workspaces in the 'StackSet'.
 workspaces :: StackSet i l a s sd -> [Workspace i l a]
 workspaces s = workspace (current s) : map workspace (visible s) ++ hidden s
 
--- | Get a list of all windows in the StackSet in no particular order
+-- | Get a list of all windows in the 'StackSet' in no particular order
 allWindows :: Eq a => StackSet i l a s sd -> [a]
 allWindows = L.nub . concatMap (integrate' . stack) . workspaces
 
--- | Is the given tag present in the StackSet?
+-- | Get the tag of the currently focused workspace.
+currentTag :: StackSet i l a s sd -> i
+currentTag = tag . workspace . current
+
+-- | Is the given tag present in the 'StackSet'?
 tagMember :: Eq i => i -> StackSet i l a s sd -> Bool
 tagMember t = elem t . map tag . workspaces
 
--- | Rename a given tag if present in the StackSet.
+-- | Rename a given tag if present in the 'StackSet'.
 renameTag :: Eq i => i -> i -> StackSet i l a s sd -> StackSet i l a s sd
 renameTag o n = mapWorkspace rename
     where rename w = if tag w == o then w { tag = n } else w
@@ -432,27 +408,27 @@ ensureTags l allt st = et allt (map tag (workspaces st) \\ allt) st
           et (i:is) [] s = et is [] (s { hidden = Workspace i l Nothing : hidden s })
           et (i:is) (r:rs) s = et is rs $ renameTag r i s
 
--- | Map a function on all the workspaces in the StackSet.
+-- | Map a function on all the workspaces in the 'StackSet'.
 mapWorkspace :: (Workspace i l a -> Workspace i l a) -> StackSet i l a s sd -> StackSet i l a s sd
 mapWorkspace f s = s { current = updScr (current s)
                      , visible = map updScr (visible s)
                      , hidden  = map f (hidden s) }
     where updScr scr = scr { workspace = f (workspace scr) }
 
--- | Map a function on all the layouts in the StackSet.
+-- | Map a function on all the layouts in the 'StackSet'.
 mapLayout :: (l -> l') -> StackSet i l a s sd -> StackSet i l' a s sd
 mapLayout f (StackSet v vs hs m) = StackSet (fScreen v) (map fScreen vs) (map fWorkspace hs) m
  where
     fScreen (Screen ws s sd) = Screen (fWorkspace ws) s sd
     fWorkspace (Workspace t l s) = Workspace t (f l) s
 
--- | /O(n)/. Is a window in the StackSet.
+-- | /O(n)/. Is a window in the 'StackSet'?
 member :: Eq a => a -> StackSet i l a s sd -> Bool
 member a s = isJust (findTag a s)
 
 -- | /O(1) on current window, O(n) in general/.
--- Return Just the workspace tag of the given window, or Nothing
--- if the window is not in the StackSet.
+-- Return 'Just' the workspace tag of the given window, or 'Nothing'
+-- if the window is not in the 'StackSet'.
 findTag :: Eq a => a -> StackSet i l a s sd -> Maybe i
 findTag a s = listToMaybe
     [ tag w | w <- workspaces s, has a (stack w) ]
@@ -487,21 +463,25 @@ insertUp a s = if member a s then s else insert
 -- /O(1) on current window, O(n) in general/. Delete window 'w' if it exists.
 -- There are 4 cases to consider:
 --
---   * delete on an Nothing workspace leaves it Nothing
+--   * delete on an 'Nothing' workspace leaves it Nothing
+--
 --   * otherwise, try to move focus to the down
+--
 --   * otherwise, try to move focus to the up
---   * otherwise, you've got an empty workspace, becomes Nothing
+--
+--   * otherwise, you've got an empty workspace, becomes 'Nothing'
 --
 -- Behaviour with respect to the master:
 --
 --   * deleting the master window resets it to the newly focused window
+--
 --   * otherwise, delete doesn't affect the master.
 --
 delete :: (Ord a, Eq s) => a -> StackSet i l a s sd -> StackSet i l a s sd
 delete w = sink w . delete' w
 
 -- | Only temporarily remove the window from the stack, thereby not destroying special
--- information saved in the Stackset
+-- information saved in the 'Stackset'
 delete' :: (Eq a, Eq s) => a -> StackSet i l a s sd -> StackSet i l a s sd
 delete' w s = s { current = removeFromScreen        (current s)
                 , visible = map removeFromScreen    (visible s)
@@ -512,7 +492,7 @@ delete' w s = s { current = removeFromScreen        (current s)
 ------------------------------------------------------------------------
 
 -- | Given a window, and its preferred rectangle, set it as floating
--- A floating window should already be managed by the StackSet.
+-- A floating window should already be managed by the 'StackSet'.
 float :: Ord a => a -> RationalRect -> StackSet i l a s sd -> StackSet i l a s sd
 float w r s = s { floating = M.insert w r (floating s) }
 
@@ -533,6 +513,15 @@ swapMaster = modify' $ \c -> case c of
 
 -- natural! keep focus, move current to the top, move top to current.
 
+-- | /O(s)/. Set the master window to the focused window.
+-- The other windows are kept in order and shifted down on the stack, as if you
+-- just hit mod-shift-k a bunch of times.
+-- Focus stays with the item moved.
+shiftMaster :: StackSet i l a s sd -> StackSet i l a s sd
+shiftMaster = modify' $ \c -> case c of
+    Stack _ [] _ -> c     -- already master.
+    Stack t ls rs -> Stack t [] (reverse ls ++ rs)
+
 -- | /O(s)/. Set focus to the master window.
 focusMaster :: StackSet i l a s sd -> StackSet i l a s sd
 focusMaster = modify' $ \c -> case c of
@@ -550,10 +539,7 @@ focusMaster = modify' $ \c -> case c of
 -- element on the current stack, the original stackSet is returned.
 --
 shift :: (Ord a, Eq s, Eq i) => i -> StackSet i l a s sd -> StackSet i l a s sd
-shift n s | n `tagMember` s && n /= curtag = maybe s go (peek s)
-          | otherwise                      = s
-    where go w = view curtag . insertUp w . view n . delete' w $ s
-          curtag = tag (workspace (current s))
+shift n s = maybe s (\w -> shiftWin n w s) (peek s)
 
 -- | /O(n)/. shiftWin. Searches for the specified window 'w' on all workspaces
 -- of the stackSet and moves it to stack 'n', leaving it as the focused
@@ -561,14 +547,12 @@ shift n s | n `tagMember` s && n /= curtag = maybe s go (peek s)
 -- focused element on that workspace.
 -- The actual focused workspace doesn't change. If the window is not
 -- found in the stackSet, the original stackSet is returned.
--- TODO how does this duplicate 'shift's behaviour?
 shiftWin :: (Ord a, Eq a, Eq s, Eq i) => i -> a -> StackSet i l a s sd -> StackSet i l a s sd
-shiftWin n w s | from == Nothing                     = s -- not found
-               | n `tagMember` s && (Just n) /= from = go
-               | otherwise                           = s
-    where from   = findTag w s
-
-          go     = on n (insertUp w) . on (fromJust from) (delete' w) $ s
-          curtag = tag (workspace (current s))
-          on i f = view curtag . f . view i
+shiftWin n w s = case findTag w s of
+                    Just from | n `tagMember` s && n /= from -> go from s
+                    _                                        -> s
+ where go from = onWorkspace n (insertUp w) . onWorkspace from (delete' w)
 
+onWorkspace :: (Eq i, Eq s) => i -> (StackSet i l a s sd -> StackSet i l a s sd)
+            -> (StackSet i l a s sd -> StackSet i l a s sd)
+onWorkspace n f s = view (currentTag s) . f . view n $ s

man/HCAR.tex

@@ -0,0 +1,71 @@
+% xmonad-Gx.tex
+\begin{hcarentry}{xmonad}
+\label{xmonad}
+\report{Gwern Branwen}%11/11
+\status{active development}
+\makeheader
+
+XMonad is a tiling window manager for X. Windows are arranged
+automatically to tile the screen without gaps or overlap, maximizing
+screen use. Window manager features are accessible from the keyboard; a
+mouse is optional. XMonad is written, configured, and extensible in
+Haskell. Custom layout algorithms, key bindings, and other extensions may
+be written by the user in config files. Layouts are applied
+dynamically, and different layouts may be used on each workspace.
+Xinerama is fully supported, allowing windows to be tiled on several
+physical screens.
+
+Development since the last report has continued; XMonad founder Don Stewart
+has stepped down and Adam Vogt is the new maintainer.
+After gestating for 2 years, version 0.10 has been released, with simultaneous
+releases of the XMonadContrib library of customizations (which has now grown to
+no less than 216 modules encompassing a dizzying array of features) and the
+xmonad-extras package of extensions,
+
+Details of changes between releases can be found in the release notes:
+\begin{compactitem}
+\item \url{http://haskell.org/haskellwiki/Xmonad/Notable_changes_since_0.8}
+\item \url{http://haskell.org/haskellwiki/Xmonad/Notable_changes_since_0.9}
+% \item \url{http://haskell.org/haskellwiki/Xmonad/Notable_changes_since_0.10}
+\item the Darcs repositories have been upgraded to the hashed format
+\item XMonad.Config.PlainConfig allows writing configs in a more 'normal' style, and not raw Haskell
+\item Supports using local modules in xmonad.hs; for example: to use definitions from \~/.xmonad/lib/XMonad/Stack/MyAdditions.hs
+\item xmonad --restart CLI option
+\item xmonad --replace CLI option
+\item XMonad.Prompt now has customizable keymaps
+\item Actions.GridSelect - a GUI menu for selecting windows or workspaces \& substring search on window names
+\item Actions.OnScreen
+\item Extensions now can have state
+\item Actions.SpawnOn - uses state to spawn applications on the workspace the user was originally on,
+  and not where the user happens to be
+\item Markdown manpages and not man/troff
+\item  XMonad.Layout.ImageButtonDecoration \&\\ XMonad.Util.Image
+\item XMonad.Layout.Groups
+\item XMonad.Layout.ZoomRow
+\item XMonad.Layout.Renamed
+\item XMonad.Layout.Drawer
+\item XMonad.Layout.FullScreen
+\item XMonad.Hooks.ScreenCorners
+\item XMonad.Actions.DynamicWorkspaceOrder
+\item XMonad.Actions.WorkspaceNames
+\item XMonad.Actions.DynamicWorkspaceGroups
+\end{compactitem}
+
+Binary packages of XMonad and XMonadContrib are available for all major Linux distributions.
+
+\FurtherReading
+\begin{compactitem}
+\item Homepage:
+ \url{http://xmonad.org/}
+
+\item Darcs source:
+
+ \texttt{darcs get} \url{http://code.haskell.org/xmonad}
+
+\item IRC channel:
+ \verb+#xmonad @@ irc.freenode.org+
+
+\item Mailing list:
+ \email{xmonad@@haskell.org}
+\end{compactitem}
+\end{hcarentry}

man/xmonad.1

@@ -0,0 +1,281 @@
+.TH xmonad 1 "31 December 2012" xmonad-0.11 "xmonad manual".TH  "" "" 
+.SH Name
+.PP
+xmonad - a tiling window manager
+.SH Description
+.PP
+\f[I]xmonad\f[] is a minimalist tiling window manager for X, written in
+Haskell.
+Windows are managed using automatic layout algorithms, which can be
+dynamically reconfigured.
+At any time windows are arranged so as to maximize the use of screen
+real estate.
+All features of the window manager are accessible purely from the
+keyboard: a mouse is entirely optional.
+\f[I]xmonad\f[] is configured in Haskell, and custom layout algorithms
+may be implemented by the user in config files.
+A principle of \f[I]xmonad\f[] is predictability: the user should know
+in advance precisely the window arrangement that will result from any
+action.
+.PP
+By default, \f[I]xmonad\f[] provides three layout algorithms: tall, wide
+and fullscreen.
+In tall or wide mode, windows are tiled and arranged to prevent overlap
+and maximize screen use.
+Sets of windows are grouped together on virtual screens, and each screen
+retains its own layout, which may be reconfigured dynamically.
+Multiple physical monitors are supported via Xinerama, allowing
+simultaneous display of a number of screens.
+.PP
+By utilizing the expressivity of a modern functional language with a
+rich static type system, \f[I]xmonad\f[] provides a complete, featureful
+window manager in less than 1200 lines of code, with an emphasis on
+correctness and robustness.
+Internal properties of the window manager are checked using a
+combination of static guarantees provided by the type system, and
+type-based automated testing.
+A benefit of this is that the code is simple to understand, and easy to
+modify.
+.SH Usage
+.PP
+\f[I]xmonad\f[] places each window into a "workspace".
+Each workspace can have any number of windows, which you can cycle
+though with mod-j and mod-k.
+Windows are either displayed full screen, tiled horizontally, or tiled
+vertically.
+You can toggle the layout mode with mod-space, which will cycle through
+the available modes.
+.PP
+You can switch to workspace N with mod-N.
+For example, to switch to workspace 5, you would press mod-5.
+Similarly, you can move the current window to another workspace with
+mod-shift-N.
+.PP
+When running with multiple monitors (Xinerama), each screen has exactly
+1 workspace visible.
+mod-{w,e,r} switch the focus between screens, while shift-mod-{w,e,r}
+move the current window to that screen.
+When \f[I]xmonad\f[] starts, workspace 1 is on screen 1, workspace 2 is
+on screen 2, etc.
+When switching workspaces to one that is already visible, the current
+and visible workspaces are swapped.
+.SS Flags
+.PP
+xmonad has several flags which you may pass to the executable.
+These flags are:
+.TP
+.B --recompile
+Recompiles your configuration in \f[I]~/.xmonad/xmonad.hs\f[]
+.RS
+.RE
+.TP
+.B --restart
+Causes the currently running \f[I]xmonad\f[] process to restart
+.RS
+.RE
+.TP
+.B --replace
+Replace the current window manager with xmonad
+.RS
+.RE
+.TP
+.B --version
+Display version of \f[I]xmonad\f[]
+.RS
+.RE
+.TP
+.B --verbose-version
+Display detailed version of \f[I]xmonad\f[]
+.RS
+.RE
+.SS Default keyboard bindings
+.TP
+.B mod-shift-return
+Launch terminal
+.RS
+.RE
+.TP
+.B mod-p
+Launch dmenu
+.RS
+.RE
+.TP
+.B mod-shift-p
+Launch gmrun
+.RS
+.RE
+.TP
+.B mod-shift-c
+Close the focused window
+.RS
+.RE
+.TP
+.B mod-space
+Rotate through the available layout algorithms
+.RS
+.RE
+.TP
+.B mod-shift-space
+Reset the layouts on the current workspace to default
+.RS
+.RE
+.TP
+.B mod-n
+Resize viewed windows to the correct size
+.RS
+.RE
+.TP
+.B mod-tab
+Move focus to the next window
+.RS
+.RE
+.TP
+.B mod-shift-tab
+Move focus to the previous window
+.RS
+.RE
+.TP
+.B mod-j
+Move focus to the next window
+.RS
+.RE
+.TP
+.B mod-k
+Move focus to the previous window
+.RS
+.RE
+.TP
+.B mod-m
+Move focus to the master window
+.RS
+.RE
+.TP
+.B mod-return
+Swap the focused window and the master window
+.RS
+.RE
+.TP
+.B mod-shift-j
+Swap the focused window with the next window
+.RS
+.RE
+.TP
+.B mod-shift-k
+Swap the focused window with the previous window
+.RS
+.RE
+.TP
+.B mod-h
+Shrink the master area
+.RS
+.RE
+.TP
+.B mod-l
+Expand the master area
+.RS
+.RE
+.TP
+.B mod-t
+Push window back into tiling
+.RS
+.RE
+.TP
+.B mod-comma
+Increment the number of windows in the master area
+.RS
+.RE
+.TP
+.B mod-period
+Deincrement the number of windows in the master area
+.RS
+.RE
+.TP
+.B mod-shift-q
+Quit xmonad
+.RS
+.RE
+.TP
+.B mod-q
+Restart xmonad
+.RS
+.RE
+.TP
+.B mod-shift-slash
+Run xmessage with a summary of the default keybindings (useful for
+beginners)
+.RS
+.RE
+.TP
+.B mod-[1..9]
+Switch to workspace N
+.RS
+.RE
+.TP
+.B mod-shift-[1..9]
+Move client to workspace N
+.RS
+.RE
+.TP
+.B mod-{w,e,r}
+Switch to physical/Xinerama screens 1, 2, or 3
+.RS
+.RE
+.TP
+.B mod-shift-{w,e,r}
+Move client to screen 1, 2, or 3
+.RS
+.RE
+.TP
+.B mod-button1
+Set the window to floating mode and move by dragging
+.RS
+.RE
+.TP
+.B mod-button2
+Raise the window to the top of the stack
+.RS
+.RE
+.TP
+.B mod-button3
+Set the window to floating mode and resize by dragging
+.RS
+.RE
+.SH Examples
+.PP
+To use xmonad as your window manager add to your \f[I]~/.xinitrc\f[]
+file:
+.IP
+.nf
+\f[C]
+exec\ xmonad
+\f[]
+.fi
+.SH Customization
+.PP
+xmonad is customized in ~/.xmonad/xmonad.hs, and then restarting with
+mod-q.
+.PP
+You can find many extensions to the core feature set in the xmonad-
+contrib package, available through your package manager or from
+xmonad.org (http://xmonad.org).
+.SS Modular Configuration
+.PP
+As of \f[I]xmonad-0.9\f[], any additional Haskell modules may be placed
+in \f[I]~/.xmonad/lib/\f[] are available in GHC\[aq]s searchpath.
+Hierarchical modules are supported: for example, the file
+\f[I]~/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[] could contain:
+.IP
+.nf
+\f[C]
+module\ XMonad.Stack.MyAdditions\ (function1)\ where
+\ \ \ \ function1\ =\ error\ "function1:\ Not\ implemented\ yet!"
+\f[]
+.fi
+.PP
+Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that
+module was contained within xmonad or xmonad-contrib.
+.SH Bugs
+.PP
+Probably.
+If you find any, please report them to the
+bugtracker (http://code.google.com/p/xmonad/issues/list)

man/xmonad.1.html

@@ -0,0 +1,181 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta http-equiv="Content-Style-Type" content="text/css" />
+  <meta name="generator" content="pandoc" />
+  <title></title>
+  <style type="text/css">
+table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
+  margin: 0; padding: 0; vertical-align: baseline; border: none; }
+table.sourceCode { width: 100%; }
+td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
+td.sourceCode { padding-left: 5px; }
+code > span.kw { color: #007020; font-weight: bold; }
+code > span.dt { color: #902000; }
+code > span.dv { color: #40a070; }
+code > span.bn { color: #40a070; }
+code > span.fl { color: #40a070; }
+code > span.ch { color: #4070a0; }
+code > span.st { color: #4070a0; }
+code > span.co { color: #60a0b0; font-style: italic; }
+code > span.ot { color: #007020; }
+code > span.al { color: #ff0000; font-weight: bold; }
+code > span.fu { color: #06287e; }
+code > span.er { color: #ff0000; font-weight: bold; }
+  </style>
+</head>
+<body>
+<h1>xmonad-0.11</h1><p>Section: xmonad manual (1)<br/>Updated: 31 December 2012</p><hr/>
+<div id="TOC">
+<ul>
+<li><a href="#name">Name</a></li>
+<li><a href="#description">Description</a></li>
+<li><a href="#usage">Usage</a><ul>
+<li><a href="#flags">Flags</a></li>
+<li><a href="#default-keyboard-bindings">Default keyboard bindings</a></li>
+</ul></li>
+<li><a href="#examples">Examples</a></li>
+<li><a href="#customization">Customization</a><ul>
+<li><a href="#modular-configuration">Modular Configuration</a></li>
+</ul></li>
+<li><a href="#bugs">Bugs</a></li>
+</ul>
+</div>
+<h1 id="name"><a href="#TOC">Name</a></h1>
+<p>xmonad - a tiling window manager</p>
+<h1 id="description"><a href="#TOC">Description</a></h1>
+<p><em>xmonad</em> is a minimalist tiling window manager for X, written in Haskell. Windows are managed using automatic layout algorithms, which can be dynamically reconfigured. At any time windows are arranged so as to maximize the use of screen real estate. All features of the window manager are accessible purely from the keyboard: a mouse is entirely optional. <em>xmonad</em> is configured in Haskell, and custom layout algorithms may be implemented by the user in config files. A principle of <em>xmonad</em> is predictability: the user should know in advance precisely the window arrangement that will result from any action.</p>
+<p>By default, <em>xmonad</em> provides three layout algorithms: tall, wide and fullscreen. In tall or wide mode, windows are tiled and arranged to prevent overlap and maximize screen use. Sets of windows are grouped together on virtual screens, and each screen retains its own layout, which may be reconfigured dynamically. Multiple physical monitors are supported via Xinerama, allowing simultaneous display of a number of screens.</p>
+<p>By utilizing the expressivity of a modern functional language with a rich static type system, <em>xmonad</em> provides a complete, featureful window manager in less than 1200 lines of code, with an emphasis on correctness and robustness. Internal properties of the window manager are checked using a combination of static guarantees provided by the type system, and type-based automated testing. A benefit of this is that the code is simple to understand, and easy to modify.</p>
+<h1 id="usage"><a href="#TOC">Usage</a></h1>
+<p><em>xmonad</em> places each window into a &quot;workspace&quot;. Each workspace can have any number of windows, which you can cycle though with mod-j and mod-k. Windows are either displayed full screen, tiled horizontally, or tiled vertically. You can toggle the layout mode with mod-space, which will cycle through the available modes.</p>
+<p>You can switch to workspace N with mod-N. For example, to switch to workspace 5, you would press mod-5. Similarly, you can move the current window to another workspace with mod-shift-N.</p>
+<p>When running with multiple monitors (Xinerama), each screen has exactly 1 workspace visible. mod-{w,e,r} switch the focus between screens, while shift-mod-{w,e,r} move the current window to that screen. When <em>xmonad</em> starts, workspace 1 is on screen 1, workspace 2 is on screen 2, etc. When switching workspaces to one that is already visible, the current and visible workspaces are swapped.</p>
+<h2 id="flags"><a href="#TOC">Flags</a></h2>
+<p>xmonad has several flags which you may pass to the executable. These flags are:</p>
+<dl>
+<dt>--recompile</dt>
+<dd><p>Recompiles your configuration in <em>~/.xmonad/xmonad.hs</em></p>
+</dd>
+<dt>--restart</dt>
+<dd><p>Causes the currently running <em>xmonad</em> process to restart</p>
+</dd>
+<dt>--replace</dt>
+<dd><p>Replace the current window manager with xmonad</p>
+</dd>
+<dt>--version</dt>
+<dd><p>Display version of <em>xmonad</em></p>
+</dd>
+<dt>--verbose-version</dt>
+<dd><p>Display detailed version of <em>xmonad</em></p>
+</dd>
+</dl>
+<h2 id="default-keyboard-bindings"><a href="#TOC">Default keyboard bindings</a></h2>
+<dl>
+<dt>mod-shift-return</dt>
+<dd><p>Launch terminal</p>
+</dd>
+<dt>mod-p</dt>
+<dd><p>Launch dmenu</p>
+</dd>
+<dt>mod-shift-p</dt>
+<dd><p>Launch gmrun</p>
+</dd>
+<dt>mod-shift-c</dt>
+<dd><p>Close the focused window</p>
+</dd>
+<dt>mod-space</dt>
+<dd><p>Rotate through the available layout algorithms</p>
+</dd>
+<dt>mod-shift-space</dt>
+<dd><p>Reset the layouts on the current workspace to default</p>
+</dd>
+<dt>mod-n</dt>
+<dd><p>Resize viewed windows to the correct size</p>
+</dd>
+<dt>mod-tab</dt>
+<dd><p>Move focus to the next window</p>
+</dd>
+<dt>mod-shift-tab</dt>
+<dd><p>Move focus to the previous window</p>
+</dd>
+<dt>mod-j</dt>
+<dd><p>Move focus to the next window</p>
+</dd>
+<dt>mod-k</dt>
+<dd><p>Move focus to the previous window</p>
+</dd>
+<dt>mod-m</dt>
+<dd><p>Move focus to the master window</p>
+</dd>
+<dt>mod-return</dt>
+<dd><p>Swap the focused window and the master window</p>
+</dd>
+<dt>mod-shift-j</dt>
+<dd><p>Swap the focused window with the next window</p>
+</dd>
+<dt>mod-shift-k</dt>
+<dd><p>Swap the focused window with the previous window</p>
+</dd>
+<dt>mod-h</dt>
+<dd><p>Shrink the master area</p>
+</dd>
+<dt>mod-l</dt>
+<dd><p>Expand the master area</p>
+</dd>
+<dt>mod-t</dt>
+<dd><p>Push window back into tiling</p>
+</dd>
+<dt>mod-comma</dt>
+<dd><p>Increment the number of windows in the master area</p>
+</dd>
+<dt>mod-period</dt>
+<dd><p>Deincrement the number of windows in the master area</p>
+</dd>
+<dt>mod-shift-q</dt>
+<dd><p>Quit xmonad</p>
+</dd>
+<dt>mod-q</dt>
+<dd><p>Restart xmonad</p>
+</dd>
+<dt>mod-shift-slash</dt>
+<dd><p>Run xmessage with a summary of the default keybindings (useful for beginners)</p>
+</dd>
+<dt>mod-[1..9]</dt>
+<dd><p>Switch to workspace N</p>
+</dd>
+<dt>mod-shift-[1..9]</dt>
+<dd><p>Move client to workspace N</p>
+</dd>
+<dt>mod-{w,e,r}</dt>
+<dd><p>Switch to physical/Xinerama screens 1, 2, or 3</p>
+</dd>
+<dt>mod-shift-{w,e,r}</dt>
+<dd><p>Move client to screen 1, 2, or 3</p>
+</dd>
+<dt>mod-button1</dt>
+<dd><p>Set the window to floating mode and move by dragging</p>
+</dd>
+<dt>mod-button2</dt>
+<dd><p>Raise the window to the top of the stack</p>
+</dd>
+<dt>mod-button3</dt>
+<dd><p>Set the window to floating mode and resize by dragging</p>
+</dd>
+</dl>
+<h1 id="examples"><a href="#TOC">Examples</a></h1>
+<p>To use xmonad as your window manager add to your <em>~/.xinitrc</em> file:</p>
+<pre class="sourceCode literate haskell"><code class="sourceCode haskell">exec xmonad</code></pre>
+<h1 id="customization"><a href="#TOC">Customization</a></h1>
+<p>xmonad is customized in ~/.xmonad/xmonad.hs, and then restarting with mod-q.</p>
+<p>You can find many extensions to the core feature set in the xmonad- contrib package, available through your package manager or from <a href="http://xmonad.org">xmonad.org</a>.</p>
+<h2 id="modular-configuration"><a href="#TOC">Modular Configuration</a></h2>
+<p>As of <em>xmonad-0.9</em>, any additional Haskell modules may be placed in <em>~/.xmonad/lib/</em> are available in GHC's searchpath. Hierarchical modules are supported: for example, the file <em>~/.xmonad/lib/XMonad/Stack/MyAdditions.hs</em> could contain:</p>
+<pre class="sourceCode literate haskell"><code class="sourceCode haskell"><span class="kw">module</span> <span class="dt">XMonad.Stack.MyAdditions</span> (function1) <span class="kw">where</span>
+    function1 <span class="fu">=</span> <span class="fu">error</span> <span class="st">&quot;function1: Not implemented yet!&quot;</span></code></pre>
+<p>Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that module was contained within xmonad or xmonad-contrib.</p>
+<h1 id="bugs"><a href="#TOC">Bugs</a></h1>
+<p>Probably. If you find any, please report them to the <a href="http://code.google.com/p/xmonad/issues/list">bugtracker</a></p>
+</body>
+</html>

man/xmonad.1.in

@@ -1,49 +0,0 @@
-./" man page created by David Lazar on April 24, 2007
-./" uses ``tmac.an'' macro set
-.TH xmonad 1 "18 April 07" xmonad\-1.0 "xmonad manual"
-.SH NAME
-xmonad \- a tiling window manager
-.SH DESCRIPTION
-.PP
-\fBxmonad\fR is a minimalist tiling window manager for X, written in Haskell. Windows are managed using automatic layout algorithms, which can be dynamically reconfigured. At any time windows are arranged so as to maximise the use of screen real estate. All features of the window manager are accessible purely from the keyboard: a mouse is entirely optional. \fBxmonad\fR is configured in Haskell, and custom layout algorithms may be implemented by the user in config files. A principle of \fBxmonad\fR is predictability: the user should know in advance precisely the window arrangement that will result from any action.
-.PP
-By default, \fBxmonad\fR provides three layout algorithms: tall, wide and fullscreen. In tall or wide mode, windows are tiled and arranged to prevent overlap and maximise screen use. Sets of windows are grouped together on virtual screens, and each screen retains its own layout, which may be reconfigured dynamically. Multiple physical monitors are supported via Xinerama, allowing simultaneous display of a number of screens.
-.PP
-By utilising the expressivity of a modern functional language with a rich static type system, \fBxmonad\fR provides a complete, featureful window manager in less than 500 lines of code, with an emphasis on correctness and robustness. Internal properties of the window manager are checked using a combination of static guarantees provided by the type system, and type-based automated testing. A benefit of this is that the code is simple to understand, and easy to modify.
-.SH USAGE
-.PP
-\fBxmonad\fR places each window into a "workspace". Each workspace can have any number of windows, which you can cycle though with mod-j and mod-k. Windows are either displayed full screen, tiled horizontally, or tiled vertically. You can toggle the layout mode with mod-space, which will cycle through the available modes.
-.PP
-You can switch to workspace N with mod-N. For example, to switch to workspace 5, you would press mod-5. Similarly, you can move the current window to another workspace with mod-shift-N.
-.PP
-When running with multiple monitors (Xinerama), each screen has exactly 1 workspace visible. When \fBxmonad\fR starts, workspace 1 is on screen 1, workspace 2 is on screen 2, etc. If you switch to a workspace which is currently visible on another screen, \fBxmonad\fR simply switches focus to that screen. If you switch to a workspace which is *not* visible, \fBxmonad\fR replaces the workspace on the *current* screen with the workspace you selected.
-.PP
-For example, if you have the following configuration:
-.RS
-.PP
-Screen 1: Workspace 2
-.PP
-Screen 2: Workspace 5 (current workspace)
-.RE
-.PP
-and you wanted to view workspace 7 on screen 1, you would press:
-.RS
-.PP
-mod-2 (to select workspace 2, and make screen 1 the current screen)
-.PP
-mod-7 (to select workspace 7)
-.RE
-.PP
-Since switching to the workspace currently visible on a given screen is such a common operation, shortcuts are provided: mod-{w,e,r} switch to the workspace currently visible on screens 1, 2, and 3 respectively. Likewise, shift-mod-{w,e,r} moves the current window to the workspace on that screen. Using these keys, the above example would become mod-w mod-7.
-.SS Default keyboard bindings
-___KEYBINDINGS___
-.SH EXAMPLES
-To use \fBxmonad\fR as your window manager add:
-.RS
-xmonad
-.RE
-to your \fI~/.xinitrc\fR file
-.SH CUSTOMIZATION
-\fBxmonad\fR is customized by creating a custom Config.hs and (re)compiling the source code. After recompiling, 'restart' is used to fork the new version, with changes reflected immediately.
-.SH BUGS
-Probably. If you find any, please report them: http://code.google.com/p/xmonad/issues/list

man/xmonad.1.markdown

@@ -0,0 +1,102 @@
+#Name
+xmonad - a tiling window manager
+
+#Description
+
+_xmonad_ is a minimalist tiling window manager for X, written in Haskell.
+Windows are managed using automatic layout algorithms, which can be
+dynamically reconfigured. At any time windows are arranged so as to
+maximize the use of screen real estate. All features of the window manager
+are accessible purely from the keyboard: a mouse is entirely optional.
+_xmonad_ is configured in Haskell, and custom layout algorithms may be
+implemented by the user in config files. A principle of _xmonad_ is
+predictability: the user should know in advance precisely the window
+arrangement that will result from any action.
+
+By default, _xmonad_ provides three layout algorithms: tall, wide and
+fullscreen. In tall or wide mode, windows are tiled and arranged to prevent
+overlap and maximize screen use. Sets of windows are grouped together on
+virtual screens, and each screen retains its own layout, which may be
+reconfigured dynamically. Multiple physical monitors are supported via
+Xinerama, allowing simultaneous display of a number of screens.
+
+By utilizing the expressivity of a modern functional language with a rich
+static type system, _xmonad_ provides a complete, featureful window manager
+in less than 1200 lines of code, with an emphasis on correctness and
+robustness. Internal properties of the window manager are checked using a
+combination of static guarantees provided by the type system, and
+type-based automated testing. A benefit of this is that the code is simple
+to understand, and easy to modify.
+
+#Usage
+
+_xmonad_ places each window into a "workspace". Each workspace can have
+any number of windows, which you can cycle though with mod-j and mod-k.
+Windows are either displayed full screen, tiled horizontally, or tiled
+vertically. You can toggle the layout mode with mod-space, which will cycle
+through the available modes.
+
+You can switch to workspace N with mod-N. For example, to switch to
+workspace 5, you would press mod-5. Similarly, you can move the current
+window to another workspace with mod-shift-N.
+
+When running with multiple monitors (Xinerama), each screen has exactly 1
+workspace visible. mod-{w,e,r} switch the focus between screens, while
+shift-mod-{w,e,r} move the current window to that screen. When _xmonad_
+starts, workspace 1 is on screen 1, workspace 2 is on screen 2, etc. When
+switching workspaces to one that is already visible, the current and
+visible workspaces are swapped.
+
+##Flags
+xmonad  has  several flags which  you may pass to the executable.
+These flags are:
+
+--recompile
+:   Recompiles your configuration in _~/.xmonad/xmonad.hs_
+
+--restart
+:   Causes the currently running _xmonad_ process to restart
+
+--replace
+:   Replace the current window manager with xmonad
+
+--version
+:   Display version of _xmonad_
+
+--verbose-version
+:   Display detailed version of _xmonad_
+
+##Default keyboard bindings
+
+___KEYBINDINGS___
+
+#Examples
+To use xmonad as your window manager add to your _~/.xinitrc_ file:
+
+> exec xmonad
+
+#Customization
+xmonad is customized in ~/.xmonad/xmonad.hs,  and  then  restarting
+with mod-q.
+
+You can find many extensions to the core feature set in the xmonad-
+contrib package, available through your  package  manager  or  from
+[xmonad.org].
+
+##Modular Configuration
+As of _xmonad-0.9_, any additional Haskell modules may be placed in
+_~/.xmonad/lib/_ are available in GHC's searchpath. Hierarchical modules
+are supported: for example, the file
+_~/.xmonad/lib/XMonad/Stack/MyAdditions.hs_ could contain:
+
+> module XMonad.Stack.MyAdditions (function1) where
+>     function1 = error "function1: Not implemented yet!"
+
+Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that
+module was contained within xmonad or xmonad-contrib.
+
+#Bugs
+Probably. If you find any, please report them to the [bugtracker]
+
+[xmonad.org]: http://xmonad.org
+[bugtracker]: http://code.google.com/p/xmonad/issues/list

man/xmonad.hs

@@ -8,6 +8,7 @@
 --
 
 import XMonad
+import Data.Monoid
 import System.Exit
 
 import qualified XMonad.StackSet as W
@@ -18,6 +19,14 @@ import qualified Data.Map        as M
 --
 myTerminal      = "xterm"
 
+-- Whether focus follows the mouse pointer.
+myFocusFollowsMouse :: Bool
+myFocusFollowsMouse = True
+
+-- Whether clicking on a window to focus also passes the click to the window
+myClickJustFocuses :: Bool
+myClickJustFocuses = False
+
 -- Width of the window border in pixels.
 --
 myBorderWidth   = 1
@@ -29,21 +38,6 @@ myBorderWidth   = 1
 --
 myModMask       = mod1Mask
 
--- The mask for the numlock key. Numlock status is "masked" from the
--- current modifier status, so the keybindings will work with numlock on or
--- off. You may need to change this on some systems.
---
--- You can find the numlock modifier by running "xmodmap" and looking for a
--- modifier with Num_Lock bound to it:
---
--- > $ xmodmap | grep Num
--- > mod2        Num_Lock (0x4d)
---
--- Set numlockMask = 0 if you don't have a numlock key, or want to treat
--- numlock status separately.
---
-myNumlockMask   = mod2Mask
-
 -- The default number of workspaces (virtual screens) and their names.
 -- By default we use numeric strings, but any string may be used as a
 -- workspace name. The number of workspaces is determined by the length
@@ -60,93 +54,82 @@ myWorkspaces    = ["1","2","3","4","5","6","7","8","9"]
 myNormalBorderColor  = "#dddddd"
 myFocusedBorderColor = "#ff0000"
 
--- Default offset of drawable screen boundaries from each physical
--- screen. Anything non-zero here will leave a gap of that many pixels
--- on the given edge, on the that screen. A useful gap at top of screen
--- for a menu bar (e.g. 15)
---
--- An example, to set a top gap on monitor 1, and a gap on the bottom of
--- monitor 2, you'd use a list of geometries like so:
---
--- > defaultGaps = [(18,0,0,0),(0,18,0,0)] -- 2 gaps on 2 monitors
---
--- Fields are: top, bottom, left, right.
---
-myDefaultGaps   = [(0,0,0,0)]
-
 ------------------------------------------------------------------------
 -- Key bindings. Add, modify or remove key bindings here.
 --
-myKeys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
+myKeys conf@(XConfig {XMonad.modMask = modm}) = M.fromList $
 
     -- launch a terminal
-    [ ((modMask .|. shiftMask, xK_Return), spawn $ XMonad.terminal conf)
+    [ ((modm .|. shiftMask, xK_Return), spawn $ XMonad.terminal conf)
 
     -- launch dmenu
-    , ((modMask,               xK_p     ), spawn "exe=`dmenu_path | dmenu` && eval \"exec $exe\"")
+    , ((modm,               xK_p     ), spawn "dmenu_run")
 
     -- launch gmrun
-    , ((modMask .|. shiftMask, xK_p     ), spawn "gmrun")
+    , ((modm .|. shiftMask, xK_p     ), spawn "gmrun")
 
-    -- close focused window 
-    , ((modMask .|. shiftMask, xK_c     ), kill)
+    -- close focused window
+    , ((modm .|. shiftMask, xK_c     ), kill)
 
      -- Rotate through the available layout algorithms
-    , ((modMask,               xK_space ), sendMessage NextLayout)
+    , ((modm,               xK_space ), sendMessage NextLayout)
 
     --  Reset the layouts on the current workspace to default
-    , ((modMask .|. shiftMask, xK_space ), setLayout $ XMonad.layoutHook conf)
+    , ((modm .|. shiftMask, xK_space ), setLayout $ XMonad.layoutHook conf)
 
     -- Resize viewed windows to the correct size
-    , ((modMask,               xK_n     ), refresh)
+    , ((modm,               xK_n     ), refresh)
 
     -- Move focus to the next window
-    , ((modMask,               xK_Tab   ), windows W.focusDown)
+    , ((modm,               xK_Tab   ), windows W.focusDown)
 
     -- Move focus to the next window
-    , ((modMask,               xK_j     ), windows W.focusDown)
+    , ((modm,               xK_j     ), windows W.focusDown)
 
     -- Move focus to the previous window
-    , ((modMask,               xK_k     ), windows W.focusUp  )
+    , ((modm,               xK_k     ), windows W.focusUp  )
 
     -- Move focus to the master window
-    , ((modMask,               xK_m     ), windows W.focusMaster  )
+    , ((modm,               xK_m     ), windows W.focusMaster  )
 
     -- Swap the focused window and the master window
-    , ((modMask,               xK_Return), windows W.swapMaster)
+    , ((modm,               xK_Return), windows W.swapMaster)
 
     -- Swap the focused window with the next window
-    , ((modMask .|. shiftMask, xK_j     ), windows W.swapDown  )
+    , ((modm .|. shiftMask, xK_j     ), windows W.swapDown  )
 
     -- Swap the focused window with the previous window
-    , ((modMask .|. shiftMask, xK_k     ), windows W.swapUp    )
+    , ((modm .|. shiftMask, xK_k     ), windows W.swapUp    )
 
     -- Shrink the master area
-    , ((modMask,               xK_h     ), sendMessage Shrink)
+    , ((modm,               xK_h     ), sendMessage Shrink)
 
     -- Expand the master area
-    , ((modMask,               xK_l     ), sendMessage Expand)
+    , ((modm,               xK_l     ), sendMessage Expand)
 
     -- Push window back into tiling
-    , ((modMask,               xK_t     ), withFocused $ windows . W.sink)
+    , ((modm,               xK_t     ), withFocused $ windows . W.sink)
 
     -- Increment the number of windows in the master area
-    , ((modMask              , xK_comma ), sendMessage (IncMasterN 1))
+    , ((modm              , xK_comma ), sendMessage (IncMasterN 1))
 
     -- Deincrement the number of windows in the master area
-    , ((modMask              , xK_period), sendMessage (IncMasterN (-1)))
+    , ((modm              , xK_period), sendMessage (IncMasterN (-1)))
 
-    -- toggle the status bar gap
-    , ((modMask              , xK_b     ),
-          modifyGap (\i n -> let x = (XMonad.defaultGaps conf ++ repeat (0,0,0,0)) !! i
-                             in if n == x then (0,0,0,0) else x))
+    -- Toggle the status bar gap
+    -- Use this binding with avoidStruts from Hooks.ManageDocks.
+    -- See also the statusBar function from Hooks.DynamicLog.
+    --
+    -- , ((modm              , xK_b     ), sendMessage ToggleStruts)
 
     -- Quit xmonad
-    , ((modMask .|. shiftMask, xK_q     ), io (exitWith ExitSuccess))
+    , ((modm .|. shiftMask, xK_q     ), io (exitWith ExitSuccess))
 
     -- Restart xmonad
-    , ((modMask              , xK_q     ),
-          broadcastMessage ReleaseResources >> restart (Just "xmonad") True)
+    , ((modm              , xK_q     ), spawn "xmonad --recompile; xmonad --restart")
+
+    -- Run xmessage with a summary of the default keybindings (useful for beginners)
+    , ((modMask .|. shiftMask, xK_slash ), spawn ("echo \"" ++ help ++ "\" | xmessage -file -"))
     ]
     ++
 
@@ -154,7 +137,7 @@ myKeys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
     -- mod-[1..9], Switch to workspace N
     -- mod-shift-[1..9], Move client to workspace N
     --
-    [((m .|. modMask, k), windows $ f i)
+    [((m .|. modm, k), windows $ f i)
         | (i, k) <- zip (XMonad.workspaces conf) [xK_1 .. xK_9]
         , (f, m) <- [(W.greedyView, 0), (W.shift, shiftMask)]]
     ++
@@ -163,7 +146,7 @@ myKeys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
     -- mod-{w,e,r}, Switch to physical/Xinerama screens 1, 2, or 3
     -- mod-shift-{w,e,r}, Move client to screen 1, 2, or 3
     --
-    [((m .|. modMask, key), screenWorkspace sc >>= flip whenJust (windows . f))
+    [((m .|. modm, key), screenWorkspace sc >>= flip whenJust (windows . f))
         | (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]
         , (f, m) <- [(W.view, 0), (W.shift, shiftMask)]]
 
@@ -171,16 +154,18 @@ myKeys conf@(XConfig {XMonad.modMask = modMask}) = M.fromList $
 ------------------------------------------------------------------------
 -- Mouse bindings: default actions bound to mouse events
 --
-myMouseBindings (XConfig {XMonad.modMask = modMask}) = M.fromList $
+myMouseBindings (XConfig {XMonad.modMask = modm}) = M.fromList $
 
     -- mod-button1, Set the window to floating mode and move by dragging
-    [ ((modMask, button1), (\w -> focus w >> mouseMoveWindow w))
+    [ ((modm, button1), (\w -> focus w >> mouseMoveWindow w
+                                       >> windows W.shiftMaster))
 
     -- mod-button2, Raise the window to the top of the stack
-    , ((modMask, button2), (\w -> focus w >> windows W.swapMaster))
+    , ((modm, button2), (\w -> focus w >> windows W.shiftMaster))
 
     -- mod-button3, Set the window to floating mode and resize by dragging
-    , ((modMask, button3), (\w -> focus w >> mouseResizeWindow w))
+    , ((modm, button3), (\w -> focus w >> mouseResizeWindow w
+                                       >> windows W.shiftMaster))
 
     -- you may also bind events to the mouse scroll wheel (button4 and button5)
     ]
@@ -222,25 +207,44 @@ myLayout = tiled ||| Mirror tiled ||| Full
 -- > xprop | grep WM_CLASS
 -- and click on the client you're interested in.
 --
+-- To match on the WM_NAME, you can use 'title' in the same way that
+-- 'className' and 'resource' are used below.
+--
 myManageHook = composeAll
     [ className =? "MPlayer"        --> doFloat
     , className =? "Gimp"           --> doFloat
     , resource  =? "desktop_window" --> doIgnore
     , resource  =? "kdesktop"       --> doIgnore ]
 
+------------------------------------------------------------------------
+-- Event handling
+
+-- * EwmhDesktops users should change this to ewmhDesktopsEventHook
+--
+-- Defines a custom handler function for X Events. The function should
+-- return (All True) if the default handler is to be run afterwards. To
+-- combine event hooks use mappend or mconcat from Data.Monoid.
+--
+myEventHook = mempty
 
 ------------------------------------------------------------------------
 -- Status bars and logging
 
 -- Perform an arbitrary action on each internal state change or X event.
--- See the 'DynamicLog' extension for examples.
---
--- To emulate dwm's status bar
---
--- > logHook = dynamicLogDzen
+-- See the 'XMonad.Hooks.DynamicLog' extension for examples.
 --
 myLogHook = return ()
 
+------------------------------------------------------------------------
+-- Startup hook
+
+-- Perform an arbitrary action each time xmonad starts or is restarted
+-- with mod-q.  Used by, e.g., XMonad.Layout.PerWorkspace to initialize
+-- per-workspace layout choices.
+--
+-- By default, do nothing.
+myStartupHook = return ()
+
 ------------------------------------------------------------------------
 -- Now run xmonad with all the defaults we set up.
 
@@ -249,21 +253,21 @@ myLogHook = return ()
 main = xmonad defaults
 
 -- A structure containing your configuration settings, overriding
--- fields in the default config. Any you don't override, will 
+-- fields in the default config. Any you don't override, will
 -- use the defaults defined in xmonad/XMonad/Config.hs
--- 
+--
 -- No need to modify this.
 --
 defaults = defaultConfig {
       -- simple stuff
         terminal           = myTerminal,
+        focusFollowsMouse  = myFocusFollowsMouse,
+        clickJustFocuses   = myClickJustFocuses,
         borderWidth        = myBorderWidth,
         modMask            = myModMask,
-        numlockMask        = myNumlockMask,
         workspaces         = myWorkspaces,
         normalBorderColor  = myNormalBorderColor,
         focusedBorderColor = myFocusedBorderColor,
-        defaultGaps        = myDefaultGaps,
 
       -- key bindings
         keys               = myKeys,
@@ -272,5 +276,7 @@ defaults = defaultConfig {
       -- hooks, layouts
         layoutHook         = myLayout,
         manageHook         = myManageHook,
-        logHook            = myLogHook
+        handleEventHook    = myEventHook,
+        logHook            = myLogHook,
+        startupHook        = myStartupHook
     }

tests/Main.hs

@@ -1,8 +0,0 @@
-module Main where
-
-import qualified Properties
-
--- This will run all of the QC files for xmonad core. Currently, that's just
--- Properties. If any more get added, sequence the main actions together.
-main = do
-  Properties.main

tests/Properties.hs

@@ -1,7 +1,10 @@
-{-# OPTIONS -fglasgow-exts #-}
+{-# OPTIONS -fglasgow-exts -w #-}
 module Properties where
 
 import XMonad.StackSet hiding (filter)
+import XMonad.Layout
+import XMonad.Core hiding (workspaces,trace)
+import XMonad.Operations  ( applyResizeIncHint, applyMaxSizeHint )
 import qualified XMonad.StackSet as S (filter)
 
 import Debug.Trace
@@ -11,7 +14,7 @@ import Data.Ratio
 import Data.Maybe
 import System.Environment
 import Control.Exception    (assert)
-import qualified Control.Exception as C
+import qualified Control.Exception.Extensible as C
 import Control.Monad
 import Test.QuickCheck hiding (promote)
 import System.IO.Unsafe
@@ -52,7 +55,6 @@ instance (Integral i, Integral s, Eq a, Arbitrary a, Arbitrary l, Arbitrary sd)
                        | s <- ls ]
 
         return $ fromList (fromIntegral n, sds,fs,ls,lay)
-    coarbitrary = error "no coarbitrary for StackSet"
 
 
 -- | fromList. Build a new StackSet from a list of list of elements,
@@ -137,10 +139,10 @@ prop_empty_I  (n :: Positive Int) l = forAll (choose (1,fromIntegral n)) $  \m -
         invariant $ new l [0..fromIntegral n-1] ms
 
 prop_view_I (n :: NonNegative Int) (x :: T) =
-    n `tagMember` x ==> invariant $ view (fromIntegral n) x
+    invariant $ view (fromIntegral n) x
 
 prop_greedyView_I (n :: NonNegative Int) (x :: T) =
-    n `tagMember` x ==> invariant $ view (fromIntegral n) x
+    invariant $ greedyView (fromIntegral n) x
 
 prop_focusUp_I (n :: NonNegative Int) (x :: T) =
     invariant $ foldr (const focusUp) x [1..n]
@@ -237,6 +239,13 @@ prop_greedyView_current (x :: T) (n :: NonNegative Int) = i `tagMember` x ==>
   where
     i = fromIntegral n
 
+-- greedyView leaves things unchanged for invalid workspaces
+prop_greedyView_current_id (x :: T) (n :: NonNegative Int) = not (i `tagMember` x) ==>
+    tag (workspace $ current (greedyView i x)) == j
+  where
+    i = fromIntegral n
+    j = tag (workspace (current x))
+
 -- greedyView *only* sets the current workspace, and touches Xinerama.
 -- no workspace contents will be changed.
 prop_greedyView_local  (x :: T) (n :: NonNegative Int) = i `tagMember` x ==>
@@ -349,6 +358,10 @@ prop_focusWindow_local (n :: NonNegative Int) (x::T ) =
                        i = fromIntegral n `mod` length s
                    in hidden_spaces (focusWindow (s !! i) x) == hidden_spaces x
 
+-- On an invalid window, the stackset is unmodified
+prop_focusWindow_identity (n :: Char) (x::T ) =
+    not (n `member` x) ==> focusWindow n x == x
+
 -- ---------------------------------------------------------------------
 -- member/findTag
 
@@ -365,6 +378,9 @@ prop_findIndex (x :: T) =
 
 prop_allWindowsMember w (x :: T) = (w `elem` allWindows x) ==> member w x
 
+prop_currentTag (x :: T) =
+    currentTag x == tag (workspace (current x))
+
 -- ---------------------------------------------------------------------
 -- 'insert'
 
@@ -512,6 +528,18 @@ prop_shift_reversible i (x :: T) =
         y = swapMaster x
         n = tag (workspace $ current y)
 
+------------------------------------------------------------------------
+-- shiftMaster
+
+-- focus/local/idempotent same as swapMaster:
+prop_shift_master_focus (x :: T) = peek x == (peek $ shiftMaster x)
+prop_shift_master_local (x :: T) = hidden_spaces x == hidden_spaces (shiftMaster x)
+prop_shift_master_idempotent (x :: T) = shiftMaster (shiftMaster x) == shiftMaster x
+-- ordering is constant modulo the focused window:
+prop_shift_master_ordering (x :: T) = case peek x of
+    Nothing -> True
+    Just m  -> L.delete m (index x) == L.delete m (index $ shiftMaster x)
+
 -- ---------------------------------------------------------------------
 -- shiftWin
 
@@ -541,13 +569,19 @@ prop_float_reversible n (x :: T) =
         where
             geom = RationalRect 100 100 100 100
 
--- check rectanges were set
-{-
-prop_float_sets_geometry n (x :: T) =
-    n `member` x ==> let y = float n geom x in M.lookup y (floating x) == Just geom
+prop_float_geometry n (x :: T) =
+    n `member` x ==> let s = float n geom x
+                     in M.lookup n (floating s) == Just geom
         where
             geom = RationalRect 100 100 100 100
--}
+
+prop_float_delete n (x :: T) =
+    n `member` x ==> let s = float n geom x
+                         t = delete n s
+                     in not (n `member` t)
+        where
+            geom = RationalRect 100 100 100 100
+
 
 ------------------------------------------------------------------------
 
@@ -579,13 +613,13 @@ prop_lookup_visible (x :: T) =
 
 -- and help out hpc
 prop_abort x = unsafePerformIO $ C.catch (abort "fail")
-                                         (\e -> return $  show e == "xmonad: StackSet: fail" )
+                                         (\(C.SomeException e) -> return $  show e == "xmonad: StackSet: fail" )
    where
      _ = x :: Int
 
 -- new should fail with an abort
 prop_new_abort x = unsafePerformIO $ C.catch f
-                                         (\e -> return $ show e == "xmonad: StackSet: non-positive argument to StackSet.new" )
+                                         (\(C.SomeException e) -> return $ show e == "xmonad: StackSet: non-positive argument to StackSet.new" )
    where
      f = new undefined{-layout-} [] [] `seq` return False
 
@@ -606,9 +640,26 @@ prop_rename1 (x::T) o n = o `tagMember` x && not (n `tagMember` x) ==>
     let y = renameTag o n x
             in n `tagMember` y
 
+-- | 
+-- Ensure that a given set of workspace tags is present by renaming
+-- existing workspaces and\/or creating new hidden workspaces as
+-- necessary.
+--
 prop_ensure (x :: T) l xs = let y = ensureTags l xs x
                                 in and [ n `tagMember` y | n <- xs ]
 
+-- adding a tag should create a new hidden workspace
+prop_ensure_append (x :: T) l n =
+    not (n  `tagMember` x)
+      ==>
+   (hidden y /= hidden x        -- doesn't append, renames
+   &&
+   and [ isNothing (stack z) && layout z == l | z <- hidden y, tag z == n ]
+   )
+  where
+    y  = ensureTags l (n:ts) x
+    ts = [ tag z | z <- workspaces x ]
+
 prop_mapWorkspaceId (x::T) = x == mapWorkspace id x
 
 prop_mapWorkspaceInverse (x::T) = x == mapWorkspace predTag (mapWorkspace succTag x)
@@ -620,17 +671,145 @@ prop_mapLayoutId (x::T) = x == mapLayout id x
 prop_mapLayoutInverse (x::T) = x == mapLayout pred (mapLayout succ x)
 
 ------------------------------------------------------------------------
--- some properties for layouts:
+-- The Tall layout
 
 -- 1 window should always be tiled fullscreen
-{-
 prop_tile_fullscreen rect = tile pct rect 1 1 == [rect]
+    where pct = 1/2
 
 -- multiple windows
 prop_tile_non_overlap rect windows nmaster = noOverlaps (tile pct rect nmaster windows)
   where _ = rect :: Rectangle
+        pct = 3 % 100
 
-pct = 3 % 100
+-- splitting horizontally yields sensible results
+prop_split_hoziontal (NonNegative n) x =
+{-
+    trace (show (rect_x x
+                ,rect_width x
+                ,rect_x x + fromIntegral (rect_width x)
+                ,map rect_x xs))
+          $
+-}
+
+        sum (map rect_width xs) == rect_width x
+     &&
+        all (== rect_height x) (map rect_height xs)
+     &&
+        (map rect_x xs) == (sort $ map rect_x xs)
+
+    where
+        xs = splitHorizontally n x
+
+-- splitting horizontally yields sensible results
+prop_splitVertically (r :: Rational) x =
+
+        rect_x x == rect_x a && rect_x x == rect_x b
+      &&
+        rect_width x == rect_width a && rect_width x == rect_width b
+
+{-
+    trace (show (rect_x x
+                ,rect_width x
+                ,rect_x x + fromIntegral (rect_width x)
+                ,map rect_x xs))
+          $
+-}
+
+    where
+        (a,b) = splitVerticallyBy r x
+
+
+-- pureLayout works.
+prop_purelayout_tall n r1 r2 rect (t :: T) =
+    isJust (peek t) ==>
+        length ts == length (index t)
+      &&
+        noOverlaps (map snd ts)
+      &&
+        description layoot == "Tall"
+    where layoot = Tall n r1 r2
+          st = fromJust . stack . workspace . current $ t
+          ts = pureLayout layoot rect st
+
+-- Test message handling of Tall
+
+-- what happens when we send a Shrink message to Tall
+prop_shrink_tall (NonNegative n) (NonZero (NonNegative delta)) (NonNegative frac) =
+        n == n' && delta == delta' -- these state components are unchanged
+    && frac' <= frac  && (if frac' < frac then frac' == 0 || frac' == frac - delta
+                                          else frac == 0 )
+        -- remaining fraction should shrink
+    where
+         l1                   = Tall n delta frac
+         Just l2@(Tall n' delta' frac') = l1 `pureMessage` (SomeMessage Shrink)
+        --  pureMessage :: layout a -> SomeMessage -> Maybe (layout a)
+
+
+-- what happens when we send a Shrink message to Tall
+prop_expand_tall (NonNegative n)
+                 (NonZero (NonNegative delta))
+                 (NonNegative n1)
+                 (NonZero (NonNegative d1)) =
+
+       n == n'
+    && delta == delta' -- these state components are unchanged
+    && frac' >= frac
+    && (if frac' > frac
+           then frac' == 1 || frac' == frac + delta
+           else frac == 1 )
+
+        -- remaining fraction should shrink
+    where
+         frac                 = min 1 (n1 % d1)
+         l1                   = Tall n delta frac
+         Just l2@(Tall n' delta' frac') = l1 `pureMessage` (SomeMessage Expand)
+        --  pureMessage :: layout a -> SomeMessage -> Maybe (layout a)
+
+-- what happens when we send an IncMaster message to Tall
+prop_incmaster_tall (NonNegative n) (NonZero (NonNegative delta)) (NonNegative frac)
+                    (NonNegative k) =
+       delta == delta'  && frac == frac' && n' == n + k
+    where
+         l1                   = Tall n delta frac
+         Just l2@(Tall n' delta' frac') = l1 `pureMessage` (SomeMessage (IncMasterN k))
+        --  pureMessage :: layout a -> SomeMessage -> Maybe (layout a)
+
+
+
+     --   toMessage LT = SomeMessage Shrink
+     --   toMessage EQ = SomeMessage Expand
+     --   toMessage GT = SomeMessage (IncMasterN 1)
+
+
+------------------------------------------------------------------------
+-- Full layout
+
+-- pureLayout works for Full
+prop_purelayout_full rect (t :: T) =
+    isJust (peek t) ==>
+        length ts == 1        -- only one window to view
+      &&
+        snd (head ts) == rect -- and sets fullscreen
+      &&
+        fst (head ts) == fromJust (peek t) -- and the focused window is shown
+
+    where layoot = Full
+          st = fromJust . stack . workspace . current $ t
+          ts = pureLayout layoot rect st
+
+-- what happens when we send an IncMaster message to Full --- Nothing
+prop_sendmsg_full (NonNegative k) =
+         isNothing (Full `pureMessage` (SomeMessage (IncMasterN k)))
+
+prop_desc_full = description Full == show Full
+
+------------------------------------------------------------------------
+
+prop_desc_mirror n r1 r2 = description (Mirror $! t) == "Mirror Tall"
+    where t = Tall n r1 r2
+
+------------------------------------------------------------------------
 
 noOverlaps []  = True
 noOverlaps [_] = True
@@ -646,15 +825,36 @@ noOverlaps xs  = and [ verts a `notOverlap` verts b
         =  (top1 < bottom2 || top2 < bottom1)
         || (right1 < left2 || right2 < left1)
 
--}
+------------------------------------------------------------------------
+-- Aspect ratios
+
+prop_resize_inc (NonZero (NonNegative inc_w),NonZero (NonNegative inc_h))  b@(w,h) =
+    w' `mod` inc_w == 0 && h' `mod` inc_h == 0
+   where (w',h') = applyResizeIncHint a b
+         a = (inc_w,inc_h)
+
+prop_resize_inc_extra ((NonNegative inc_w))  b@(w,h) =
+     (w,h) == (w',h')
+   where (w',h') = applyResizeIncHint a b
+         a = (-inc_w,0::Dimension)-- inc_h)
+
+prop_resize_max (NonZero (NonNegative inc_w),NonZero (NonNegative inc_h))  b@(w,h) =
+    w' <= inc_w && h' <= inc_h
+   where (w',h') = applyMaxSizeHint a b
+         a = (inc_w,inc_h)
+
+prop_resize_max_extra ((NonNegative inc_w))  b@(w,h) =
+     (w,h) == (w',h')
+   where (w',h') = applyMaxSizeHint a b
+         a = (-inc_w,0::Dimension)-- inc_h)
 
 ------------------------------------------------------------------------
 
 main :: IO ()
 main = do
-    args <- getArgs
+    args <- fmap (drop 1) getArgs
     let n = if null args then 100 else read (head args)
-    (results, passed) <- liftM unzip $ mapM (\(s,a) -> printf "%-25s: " s >> a n) tests
+    (results, passed) <- liftM unzip $ mapM (\(s,a) -> printf "%-40s: " s >> a n) tests
     printf "Passed %d tests!\n" (sum passed)
     when (not . and $ results) $ fail "Not all tests passed!"
  where
@@ -676,6 +876,7 @@ main = do
 
         ,("greedyView : invariant"    , mytest prop_greedyView_I)
         ,("greedyView sets current"   , mytest prop_greedyView_current)
+        ,("greedyView is safe "   ,   mytest prop_greedyView_current_id)
         ,("greedyView idempotent"     , mytest prop_greedyView_idem)
         ,("greedyView reversible"     , mytest prop_greedyView_reversible)
         ,("greedyView is local"       , mytest prop_greedyView_local)
@@ -705,9 +906,11 @@ main = do
 
         ,("focusWindow is local", mytest prop_focusWindow_local)
         ,("focusWindow works"   , mytest prop_focusWindow_works)
+        ,("focusWindow identity", mytest prop_focusWindow_identity)
 
         ,("findTag"           , mytest prop_findIndex)
         ,("allWindows/member"   , mytest prop_allWindowsMember)
+        ,("currentTag"          , mytest prop_currentTag)
 
         ,("insert: invariant"   , mytest prop_insertUp_I)
         ,("insert/new"          , mytest prop_insert_empty)
@@ -742,6 +945,11 @@ main = do
         ,("swapUp is local"   , mytest prop_swap_left_local)
         ,("swapDown is local"  , mytest prop_swap_right_local)
 
+        ,("shiftMaster id on focus", mytest prop_shift_master_focus)
+        ,("shiftMaster is local", mytest prop_shift_master_local)
+        ,("shiftMaster is idempotent", mytest prop_shift_master_idempotent)
+        ,("shiftMaster preserves ordering", mytest prop_shift_master_ordering)
+
         ,("shift: invariant"    , mytest prop_shift_I)
         ,("shift is reversible" , mytest prop_shift_reversible)
         ,("shiftWin: invariant" , mytest prop_shift_win_I)
@@ -749,13 +957,17 @@ main = do
         ,("shiftWin fix current" , mytest prop_shift_win_fix_current)
 
         ,("floating is reversible" , mytest prop_float_reversible)
+        ,("floating sets geometry" , mytest prop_float_geometry)
+        ,("floats can be deleted", mytest prop_float_delete)
         ,("screens includes current", mytest prop_screens)
+
         ,("differentiate works", mytest prop_differentiate)
         ,("lookupTagOnScreen", mytest prop_lookup_current)
         ,("lookupTagOnVisbleScreen", mytest prop_lookup_visible)
         ,("screens works",      mytest prop_screens_works)
         ,("renaming works",     mytest prop_rename1)
         ,("ensure works",     mytest prop_ensure)
+        ,("ensure hidden semantics",     mytest prop_ensure_append)
 
         ,("mapWorkspace id", mytest prop_mapWorkspaceId)
         ,("mapWorkspace inverse", mytest prop_mapWorkspaceInverse)
@@ -767,12 +979,31 @@ main = do
         ,("new fails with abort",   mytest prop_new_abort)
         ,("shiftWin identity",      mytest prop_shift_win_indentity)
 
-        -- renaming
+        -- tall layout
 
-{-
         ,("tile 1 window fullsize", mytest prop_tile_fullscreen)
         ,("tiles never overlap",    mytest prop_tile_non_overlap)
--}
+        ,("split hozizontally",     mytest prop_split_hoziontal)
+        ,("split verticalBy",       mytest prop_splitVertically)
+
+        ,("pure layout tall",       mytest prop_purelayout_tall)
+        ,("send shrink    tall",    mytest prop_shrink_tall)
+        ,("send expand    tall",    mytest prop_expand_tall)
+        ,("send incmaster tall",    mytest prop_incmaster_tall)
+
+        -- full layout
+
+        ,("pure layout full",       mytest prop_purelayout_full)
+        ,("send message full",      mytest prop_sendmsg_full)
+        ,("describe full",          mytest prop_desc_full)
+
+        ,("describe mirror",        mytest prop_desc_mirror)
+
+        -- resize hints
+        ,("window hints: inc",      mytest prop_resize_inc)
+        ,("window hints: inc all",  mytest prop_resize_inc_extra)
+        ,("window hints: max",      mytest prop_resize_max)
+        ,("window hints: max all ", mytest prop_resize_max_extra)
 
         ]
 
@@ -941,6 +1172,7 @@ instance Arbitrary EmptyStackSet where
         l <- arbitrary
         -- there cannot be more screens than workspaces:
         return . EmptyStackSet . new l ns $ take (min (length ns) (length sds)) sds
+    coarbitrary = error "coarbitrary EmptyStackSet"
 
 -- | Generates a value that satisfies a predicate.
 suchThat :: Gen a -> (a -> Bool) -> Gen a

tests/coverage.hs

@@ -0,0 +1,10 @@
+#!/usr/bin/env runhaskell
+
+import System.Cmd
+
+-- generate appropriate .hpc files
+main = do
+    system $ "rm -rf *.tix"
+    system $ "dist/build/xmonad/xmonad --run-tests"
+    system $ "hpc markup xmonad --exclude=Main --exclude=Properties --exclude=XMonad --exclude=Paths_xmonad"
+    system $ "hpc report xmonad --exclude=Main --exclude=Properties --exclude=XMonad --exclude=Paths_xmonad"

tests/loc.hs

@@ -5,9 +5,9 @@ main = do foo <- getContents
           let actual_loc = filter (not.null) $ filter isntcomment $
                            map (dropWhile (==' ')) $ lines foo
               loc = length actual_loc
-          putStrLn $ show loc
+          print loc
           -- uncomment the following to check for mistakes in isntcomment
-          -- putStr $ unlines $ actual_loc
+          -- print actual_loc
 
 isntcomment ('-':'-':_) = False
 isntcomment ('{':'-':_) = False -- pragmas

util/GenerateManpage.hs

@@ -1,7 +1,14 @@
+-- Unlike the rest of xmonad, this file is copyright under the terms of the
+-- GPL.
+
 --
 -- Generates man/xmonad.1 from man/xmonad.1.in by filling the list of
 -- keybindings with values scraped from Config.hs
 --
+-- Uses cabal to grab the xmonad version from xmonad.cabal
+--
+-- Uses pandoc to convert the "xmonad.1.markdown" to "xmonad.1"
+--
 -- Format for the docstrings in Config.hs takes the following form:
 --
 -- -- mod-x %! Frob the whatsit
@@ -14,12 +21,23 @@
 -- [ ((modMask .|. shiftMask, xK_Return), spawn "xterm") -- %! Launch an xterm
 --
 -- Here, mod-shift-return will be used as the keybinding name.
---
 import Control.Monad
+import Control.Applicative
 import Text.Regex.Posix
 import Data.Char
 import Data.List
 
+import Distribution.PackageDescription.Parse
+import Distribution.Verbosity
+import Distribution.Package
+import Distribution.PackageDescription
+import Text.PrettyPrint.HughesPJ
+import Distribution.Text
+
+import Text.Pandoc -- works with 1.6
+
+releaseDate = "31 December 2012"
+
 trim :: String -> String
 trim = reverse . dropWhile isSpace . reverse . dropWhile isSpace
 
@@ -35,13 +53,47 @@ allBindings :: String -> [(String, String)]
 allBindings xs = map (binding . map trim) (xs =~ "(.*)--(.*)%!(.*)")
 
 -- FIXME: What escaping should we be doing on these strings?
-troff :: (String, String) -> String
-troff (key, desc) = ".IP\n \\fB" ++ key ++ "\\fR\n" ++ desc ++ "\n"
+markdownDefn :: (String, String) -> String
+markdownDefn (key, desc) = key ++ "\n:     " ++ desc
 
 replace :: Eq a => a -> a -> [a] -> [a]
 replace x y = map (\a -> if a == x then y else a)
 
+-- rawSystem "pandoc" ["--read=markdown","--write=man","man/xmonad.1.markdown"]
+
 main = do
-    troffBindings <- (concatMap troff . allBindings) `liftM` readFile "./XMonad/Config.hs"
-    let sed = unlines . replace "___KEYBINDINGS___" troffBindings . lines
-    readFile "./man/xmonad.1.in" >>= return . sed >>= writeFile "./man/xmonad.1"
+    releaseName <- (show . disp . package . packageDescription)
+                    `liftM`readPackageDescription normal "xmonad.cabal"
+    keybindings <- (intercalate "\n\n" . map markdownDefn . allBindings)
+                    `liftM` readFile "./XMonad/Config.hs"
+
+    let manHeader = unwords [".TH xmonad 1","\""++releaseDate++"\"",releaseName,"\"xmonad manual\""]
+        writeOpts = defaultWriterOptions -- { writerLiterateHaskell = True }
+
+    parsed <- readMarkdown defaultParserState { stateLiterateHaskell = True }
+        . unlines
+        . replace "___KEYBINDINGS___" keybindings
+        . lines
+        <$> readFile "./man/xmonad.1.markdown"
+
+    Right template <- getDefaultTemplate Nothing "man"
+    writeFile "./man/xmonad.1"
+        . (manHeader ++)
+        . writeMan writeOpts{ writerStandalone = True, writerTemplate = template }
+        $ parsed
+    putStrLn "Documentation created: man/xmonad.1"
+
+    Right template <- getDefaultTemplate Nothing "html"
+    writeFile "./man/xmonad.1.html"
+        . writeHtmlString writeOpts
+            { writerVariables =
+                        [("include-before"
+                            ,"<h1>"++releaseName++"</h1>"++
+                             "<p>Section: xmonad manual (1)<br/>"++
+                             "Updated: "++releaseDate++"</p>"++
+                             "<hr/>")]
+            , writerStandalone = True
+            , writerTemplate = template
+            , writerTableOfContents = True }
+        $ parsed
+    putStrLn "Documentation created: man/xmonad.1.html"

xmonad.cabal

@@ -1,5 +1,5 @@
 name:               xmonad
-version:            0.5
+version:            0.11
 homepage:           http://xmonad.org
 synopsis:           A tiling window manager
 description:
@@ -18,12 +18,30 @@ license-file:       LICENSE
 author:             Spencer Janssen
 maintainer:         xmonad@haskell.org
 extra-source-files: README TODO CONFIG STYLE tests/loc.hs tests/Properties.hs
-                    man/xmonad.1.in man/xmonad.1 man/xmonad.html man/xmonad.hs
+                    man/xmonad.1.markdown man/xmonad.1 man/xmonad.1.html
                     util/GenerateManpage.hs
-cabal-version:      >= 1.2
+cabal-version:      >= 1.6
+bug-reports:        http://code.google.com/p/xmonad/issues/list
+build-type:         Simple
+
+tested-with:        GHC==7.6.1,
+                    GHC==7.4.1,
+                    GHC==7.2.1,
+                    GHC==6.12.3,
+                    GHC==6.10.4
+
+data-files:         man/xmonad.hs, man/xmonad.1, man/xmonad.1.html
+
+source-repository head
+  type:     darcs
+  location: http://code.haskell.org/xmonad
 
 flag small_base
-  description: Choose the new smaller, split-up base package.
+    description: Choose the new smaller, split-up base package.
+
+flag testing
+    description: Testing mode, only build minimal components
+    default: False
 
 library
     exposed-modules:    XMonad
@@ -36,20 +54,48 @@ library
                         XMonad.StackSet
 
     if flag(small_base)
-        build-depends: base >= 3, containers, directory, process
+        build-depends: base < 5 && >=3, containers, directory, process, filepath, extensible-exceptions
     else
         build-depends: base < 3
-    build-depends: X11>=1.4.0, mtl, unix
+    build-depends: X11>=1.5 && < 1.7, mtl, unix,
+                   utf8-string >= 0.3 && < 0.4
+
+    if true
+        ghc-options:        -funbox-strict-fields -Wall
+
+    if impl(ghc >= 6.12.1)
+        ghc-options:        -fno-warn-unused-do-bind
 
-    ghc-options:        -funbox-strict-fields -Wall -Werror -optl-Wl,-s
     ghc-prof-options:   -prof -auto-all
     extensions:         CPP
 
+    if flag(testing)
+        buildable: False
+
 executable xmonad
     main-is:            Main.hs
-    other-modules:      XMonad.Core XMonad.Main XMonad.Layout
-                        XMonad.Operations XMonad.StackSet XMonad
+    other-modules:      XMonad
+                        XMonad.Main
+                        XMonad.Core
+                        XMonad.Config
+                        XMonad.Layout
+                        XMonad.ManageHook
+                        XMonad.Operations
+                        XMonad.StackSet
+
+    if true 
+        ghc-options:    -funbox-strict-fields -Wall
+
+    if impl(ghc >= 6.12.1)
+        ghc-options:    -fno-warn-unused-do-bind
 
-    ghc-options:        -funbox-strict-fields -Wall -Werror -optl-Wl,-s
     ghc-prof-options:   -prof -auto-all
     extensions:         CPP
+
+    if flag(testing)
+        cpp-options:    -DTESTING
+        hs-source-dirs: . tests/
+        build-depends:  QuickCheck < 2
+        ghc-options:    -Werror
+    if flag(testing) && flag(small_base)
+        build-depends:  filepath, process, directory, mtl, unix, X11, base, containers, random, extensible-exceptions