<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>XMonad/Hooks/PositionStoreHooks.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : XMonad.Hooks.PositionStoreHooks</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Jan Vornberger 2009</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD3-style (see LICENSE)</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : jan.vornberger@informatik.uni-oldenburg.de</span>
<a name="line-8"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-9"></a><span class='hs-comment'>-- Portability : not portable</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- This module contains two hooks for the</span>
<a name="line-12"></a><span class='hs-comment'>-- PositionStore (see "XMonad.Util.PositionStore") - a ManageHook and</span>
<a name="line-13"></a><span class='hs-comment'>-- an EventHook.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-- The ManageHook can be used to fill the PositionStore with position and size</span>
<a name="line-16"></a><span class='hs-comment'>-- information about new windows. The advantage of using this hook is, that the</span>
<a name="line-17"></a><span class='hs-comment'>-- information is recorded independent of the currently active layout. So the</span>
<a name="line-18"></a><span class='hs-comment'>-- floating shape of the window can later be restored even if it was opened in a</span>
<a name="line-19"></a><span class='hs-comment'>-- tiled layout initially.</span>
<a name="line-20"></a><span class='hs-comment'>--</span>
<a name="line-21"></a><span class='hs-comment'>-- For windows, that do not request a particular position, a random position will</span>
<a name="line-22"></a><span class='hs-comment'>-- be assigned. This prevents windows from piling up exactly on top of each other.</span>
<a name="line-23"></a><span class='hs-comment'>--</span>
<a name="line-24"></a><span class='hs-comment'>-- The EventHook makes sure that windows are deleted from the PositionStore</span>
<a name="line-25"></a><span class='hs-comment'>-- when they are closed.</span>
<a name="line-26"></a><span class='hs-comment'>--</span>
<a name="line-27"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-28"></a>
<a name="line-29"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Hooks</span><span class='hs-varop'>.</span><span class='hs-conid'>PositionStoreHooks</span> <span class='hs-layout'>(</span>
<a name="line-30"></a> <span class='hs-comment'>-- * Usage</span>
<a name="line-31"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-32"></a> <span class='hs-varid'>positionStoreManageHook</span><span class='hs-layout'>,</span>
<a name="line-33"></a> <span class='hs-varid'>positionStoreEventHook</span>
<a name="line-34"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-35"></a>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>StackSet</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>W</span>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Util</span><span class='hs-varop'>.</span><span class='hs-conid'>PositionStore</span>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Hooks</span><span class='hs-varop'>.</span><span class='hs-conid'>ManageDocks</span>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>Decoration</span>
<a name="line-41"></a>
<a name="line-42"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Random</span><span class='hs-layout'>(</span><span class='hs-varid'>randomRIO</span><span class='hs-layout'>)</span>
<a name="line-43"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Applicative</span><span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'><$></span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-44"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-layout'>(</span><span class='hs-varid'>when</span><span class='hs-layout'>)</span>
<a name="line-45"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span>
<a name="line-46"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Monoid</span>
<a name="line-47"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Set</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>S</span>
<a name="line-48"></a>
<a name="line-49"></a><span class='hs-comment'>-- $usage</span>
<a name="line-50"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-51"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><span class='hs-comment'>-- > import XMonad.Hooks.PositionStoreHooks</span>
<a name="line-53"></a><span class='hs-comment'>--</span>
<a name="line-54"></a><span class='hs-comment'>-- and adding 'positionStoreManageHook' to your 'ManageHook' as well</span>
<a name="line-55"></a><span class='hs-comment'>-- as 'positionStoreEventHook' to your event hooks. To be accurate</span>
<a name="line-56"></a><span class='hs-comment'>-- about window sizes, the module needs to know if any decoration is in effect.</span>
<a name="line-57"></a><span class='hs-comment'>-- This is specified with the first argument: Supply 'Nothing' for no decoration,</span>
<a name="line-58"></a><span class='hs-comment'>-- otherwise use 'Just defaultTheme' or similar to inform the module about the</span>
<a name="line-59"></a><span class='hs-comment'>-- decoration theme used.</span>
<a name="line-60"></a><span class='hs-comment'>--</span>
<a name="line-61"></a><span class='hs-comment'>-- > myManageHook = positionStoreManageHook Nothing <+> manageHook defaultConfig</span>
<a name="line-62"></a><span class='hs-comment'>-- > myHandleEventHook = positionStoreEventHook</span>
<a name="line-63"></a><span class='hs-comment'>-- ></span>
<a name="line-64"></a><span class='hs-comment'>-- > main = xmonad defaultConfig { manageHook = myManageHook</span>
<a name="line-65"></a><span class='hs-comment'>-- > , handleEventHook = myHandleEventHook</span>
<a name="line-66"></a><span class='hs-comment'>-- > }</span>
<a name="line-67"></a><span class='hs-comment'>--</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="positionStoreManageHook"></a><span class='hs-definition'>positionStoreManageHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Theme</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManageHook</span>
<a name="line-70"></a><span class='hs-definition'>positionStoreManageHook</span> <span class='hs-varid'>mDecoTheme</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ask</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>liftX</span> <span class='hs-varop'>.</span> <span class='hs-varid'>positionStoreInit</span> <span class='hs-varid'>mDecoTheme</span> <span class='hs-varop'>>></span> <span class='hs-varid'>idHook</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="positionStoreInit"></a><span class='hs-definition'>positionStoreInit</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>Theme</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Window</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-73"></a><span class='hs-definition'>positionStoreInit</span> <span class='hs-varid'>mDecoTheme</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withDisplay</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>d</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-74"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>decoH</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maybe</span> <span class='hs-num'>0</span> <span class='hs-varid'>decoHeight</span> <span class='hs-varid'>mDecoTheme</span> <span class='hs-comment'>-- take decoration into account, which - in its current</span>
<a name="line-75"></a> <span class='hs-comment'>-- form - makes windows smaller to make room for it</span>
<a name="line-76"></a> <span class='hs-varid'>wa</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getWindowAttributes</span> <span class='hs-varid'>d</span> <span class='hs-varid'>w</span>
<a name="line-77"></a> <span class='hs-varid'>ws</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>gets</span> <span class='hs-varid'>windowset</span>
<a name="line-78"></a> <span class='hs-varid'>arbitraryOffsetX</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>randomIntOffset</span>
<a name="line-79"></a> <span class='hs-varid'>arbitraryOffsetY</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>randomIntOffset</span>
<a name="line-80"></a> <span class='hs-keyword'>if</span> <span class='hs-layout'>(</span><span class='hs-varid'>wa_x</span> <span class='hs-varid'>wa</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span><span class='hs-layout'>)</span> <span class='hs-varop'>&&</span> <span class='hs-layout'>(</span><span class='hs-varid'>wa_y</span> <span class='hs-varid'>wa</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span><span class='hs-layout'>)</span>
<a name="line-81"></a> <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span>
<a name="line-82"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>sr</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>Rectangle</span> <span class='hs-varid'>srX</span> <span class='hs-varid'>srY</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>screenRect</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>screenDetail</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>current</span> <span class='hs-varop'>$</span> <span class='hs-varid'>ws</span>
<a name="line-83"></a> <span class='hs-varid'>modifyPosStore</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>ps</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>posStoreInsert</span> <span class='hs-varid'>ps</span> <span class='hs-varid'>w</span>
<a name="line-84"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Rectangle</span> <span class='hs-layout'>(</span><span class='hs-varid'>srX</span> <span class='hs-varop'>+</span> <span class='hs-varid'>fi</span> <span class='hs-varid'>arbitraryOffsetX</span><span class='hs-layout'>)</span>
<a name="line-85"></a> <span class='hs-layout'>(</span><span class='hs-varid'>srY</span> <span class='hs-varop'>+</span> <span class='hs-varid'>fi</span> <span class='hs-varid'>arbitraryOffsetY</span><span class='hs-layout'>)</span>
<a name="line-86"></a> <span class='hs-layout'>(</span><span class='hs-varid'>fi</span> <span class='hs-varop'>$</span> <span class='hs-varid'>wa_width</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span>
<a name="line-87"></a> <span class='hs-layout'>(</span><span class='hs-varid'>decoH</span> <span class='hs-varop'>+</span> <span class='hs-varid'>fi</span> <span class='hs-layout'>(</span><span class='hs-varid'>wa_height</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>sr</span> <span class='hs-layout'>)</span>
<a name="line-88"></a> <span class='hs-keyword'>else</span> <span class='hs-keyword'>do</span>
<a name="line-89"></a> <span class='hs-varid'>sc</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>fromMaybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>current</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span> <span class='hs-varop'><$></span> <span class='hs-varid'>pointScreen</span> <span class='hs-layout'>(</span><span class='hs-varid'>fi</span> <span class='hs-varop'>$</span> <span class='hs-varid'>wa_x</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>fi</span> <span class='hs-varop'>$</span> <span class='hs-varid'>wa_y</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span>
<a name="line-90"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>sr</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>screenRect</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>screenDetail</span> <span class='hs-varop'>$</span> <span class='hs-varid'>sc</span>
<a name="line-91"></a> <span class='hs-varid'>sr'</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>fmap</span> <span class='hs-layout'>(</span><span class='hs-varop'>$</span> <span class='hs-varid'>sr</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>calcGap</span> <span class='hs-varop'>$</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>minBound</span> <span class='hs-keyglyph'>..</span> <span class='hs-varid'>maxBound</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- take docks into account, accepting</span>
<a name="line-92"></a> <span class='hs-comment'>-- a somewhat unfortunate inter-dependency</span>
<a name="line-93"></a> <span class='hs-comment'>-- with 'XMonad.Hooks.ManageDocks'</span>
<a name="line-94"></a> <span class='hs-varid'>modifyPosStore</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>ps</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>posStoreInsert</span> <span class='hs-varid'>ps</span> <span class='hs-varid'>w</span>
<a name="line-95"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Rectangle</span> <span class='hs-layout'>(</span><span class='hs-varid'>fi</span> <span class='hs-varop'>$</span> <span class='hs-varid'>wa_x</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>fi</span> <span class='hs-layout'>(</span><span class='hs-varid'>wa_y</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span> <span class='hs-comment'>-</span> <span class='hs-varid'>fi</span> <span class='hs-varid'>decoH</span><span class='hs-layout'>)</span>
<a name="line-96"></a> <span class='hs-layout'>(</span><span class='hs-varid'>fi</span> <span class='hs-varop'>$</span> <span class='hs-varid'>wa_width</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>decoH</span> <span class='hs-varop'>+</span> <span class='hs-varid'>fi</span> <span class='hs-layout'>(</span><span class='hs-varid'>wa_height</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>sr'</span> <span class='hs-layout'>)</span>
<a name="line-97"></a> <span class='hs-keyword'>where</span>
<a name="line-98"></a> <span class='hs-varid'>randomIntOffset</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-layout'>(</span><span class='hs-conid'>Int</span><span class='hs-layout'>)</span>
<a name="line-99"></a> <span class='hs-varid'>randomIntOffset</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>randomRIO</span> <span class='hs-layout'>(</span><span class='hs-num'>42</span><span class='hs-layout'>,</span> <span class='hs-num'>242</span><span class='hs-layout'>)</span>
<a name="line-100"></a>
<a name="line-101"></a><a name="positionStoreEventHook"></a><span class='hs-definition'>positionStoreEventHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Event</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>All</span>
<a name="line-102"></a><span class='hs-definition'>positionStoreEventHook</span> <span class='hs-layout'>(</span><span class='hs-conid'>DestroyWindowEvent</span> <span class='hs-layout'>{</span><span class='hs-varid'>ev_window</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>w</span><span class='hs-layout'>,</span> <span class='hs-varid'>ev_event_type</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>et</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-103"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>et</span> <span class='hs-varop'>==</span> <span class='hs-varid'>destroyNotify</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-104"></a> <span class='hs-varid'>modifyPosStore</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>ps</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>posStoreRemove</span> <span class='hs-varid'>ps</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span>
<a name="line-105"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>All</span> <span class='hs-conid'>True</span><span class='hs-layout'>)</span>
<a name="line-106"></a><span class='hs-definition'>positionStoreEventHook</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>All</span> <span class='hs-conid'>True</span><span class='hs-layout'>)</span>
</pre></body>
</html>
