<?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/DynamicHooks.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.DynamicHooks</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Braden Shepherdson 2008</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD-style (as xmonad)</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : Braden.Shepherdson@gmail.com</span>
<a name="line-8"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-9"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-10"></a><span class='hs-comment'>--</span>
<a name="line-11"></a><span class='hs-comment'>-- One-shot and permanent ManageHooks that can be updated at runtime.</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-14"></a>
<a name="line-15"></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'>DynamicHooks</span> <span class='hs-layout'>(</span>
<a name="line-16"></a> <span class='hs-comment'>-- * Usage</span>
<a name="line-17"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-18"></a> <span class='hs-varid'>initDynamicHooks</span>
<a name="line-19"></a> <span class='hs-layout'>,</span><span class='hs-varid'>dynamicMasterHook</span>
<a name="line-20"></a> <span class='hs-layout'>,</span><span class='hs-varid'>addDynamicHook</span>
<a name="line-21"></a> <span class='hs-layout'>,</span><span class='hs-varid'>updateDynamicHook</span>
<a name="line-22"></a> <span class='hs-layout'>,</span><span class='hs-varid'>oneShotHook</span>
<a name="line-23"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>listToMaybe</span><span class='hs-layout'>)</span>
<a name="line-30"></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-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>IORef</span>
<a name="line-32"></a>
<a name="line-33"></a><span class='hs-comment'>-- $usage</span>
<a name="line-34"></a><span class='hs-comment'>-- Provides two new kinds of 'ManageHooks' that can be defined at runtime.</span>
<a name="line-35"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><span class='hs-comment'>-- * One-shot 'ManageHooks' that are deleted after they execute.</span>
<a name="line-37"></a><span class='hs-comment'>--</span>
<a name="line-38"></a><span class='hs-comment'>-- * Permanent 'ManageHooks' (unless you want to destroy them)</span>
<a name="line-39"></a><span class='hs-comment'>--</span>
<a name="line-40"></a><span class='hs-comment'>-- Note that you will lose all dynamically defined 'ManageHook's when you @mod+q@!</span>
<a name="line-41"></a><span class='hs-comment'>-- If you want them to last, you should create them as normal in your @xmonad.hs@.</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></a><span class='hs-comment'>-- First, you must execute 'initDynamicHooks' from 'main' in your @xmonad.hs@:</span>
<a name="line-44"></a><span class='hs-comment'>--</span>
<a name="line-45"></a><span class='hs-comment'>-- > dynHooksRef <- initDynamicHooks</span>
<a name="line-46"></a><span class='hs-comment'>--</span>
<a name="line-47"></a><span class='hs-comment'>-- and then pass this value to the other functions in this module.</span>
<a name="line-48"></a><span class='hs-comment'>--</span>
<a name="line-49"></a><span class='hs-comment'>-- You also need to add the base 'ManageHook':</span>
<a name="line-50"></a><span class='hs-comment'>--</span>
<a name="line-51"></a><span class='hs-comment'>-- > xmonad { manageHook = myManageHook <+> dynamicMasterHook dynHooksRef }</span>
<a name="line-52"></a><span class='hs-comment'>--</span>
<a name="line-53"></a><span class='hs-comment'>-- You must include this @dynHooksRef@ value when using the functions in this</span>
<a name="line-54"></a><span class='hs-comment'>-- module:</span>
<a name="line-55"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><span class='hs-comment'>-- > xmonad { keys = myKeys `Data.Map.union` Data.Map.fromList</span>
<a name="line-57"></a><span class='hs-comment'>-- > [((modm, xK_i), oneShotHook dynHooksRef</span>
<a name="line-58"></a><span class='hs-comment'>-- > "FFlaunchHook" (className =? "firefox") (doShift "3")</span>
<a name="line-59"></a><span class='hs-comment'>-- > >> spawn "firefox")</span>
<a name="line-60"></a><span class='hs-comment'>-- > ,((modm, xK_u), addDynamicHook dynHooksRef</span>
<a name="line-61"></a><span class='hs-comment'>-- > (className =? "example" --> doFloat))</span>
<a name="line-62"></a><span class='hs-comment'>-- > ,((modm, xK_y), updatePermanentHook dynHooksRef</span>
<a name="line-63"></a><span class='hs-comment'>-- > (const idHook))) ] -- resets the permanent hook.</span>
<a name="line-64"></a><span class='hs-comment'>--</span>
<a name="line-65"></a>
<a name="line-66"></a><a name="DynamicHooks"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>DynamicHooks</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>DynamicHooks</span>
<a name="line-67"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>transients</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>Query</span> <span class='hs-conid'>Bool</span><span class='hs-layout'>,</span> <span class='hs-conid'>ManageHook</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-68"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>permanent</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ManageHook</span> <span class='hs-layout'>}</span>
<a name="line-69"></a>
<a name="line-70"></a>
<a name="line-71"></a><a name="initDynamicHooks"></a><span class='hs-comment'>-- | Creates the 'IORef' that stores the dynamically created 'ManageHook's.</span>
<a name="line-72"></a><span class='hs-definition'>initDynamicHooks</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>IORef</span> <span class='hs-conid'>DynamicHooks</span><span class='hs-layout'>)</span>
<a name="line-73"></a><span class='hs-definition'>initDynamicHooks</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>newIORef</span> <span class='hs-layout'>(</span><span class='hs-conid'>DynamicHooks</span> <span class='hs-layout'>{</span> <span class='hs-varid'>transients</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span>
<a name="line-74"></a> <span class='hs-varid'>permanent</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>idHook</span> <span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-75"></a>
<a name="line-76"></a>
<a name="line-77"></a><a name="dynamicMasterHook"></a><span class='hs-comment'>-- this hook is always executed, and the IORef's contents checked.</span>
<a name="line-78"></a><span class='hs-comment'>-- note that transient hooks are run second, therefore taking precedence</span>
<a name="line-79"></a><span class='hs-comment'>-- over permanent ones on matters such as which workspace to shift to.</span>
<a name="line-80"></a><span class='hs-comment'>-- doFloat and doIgnore are idempotent.</span>
<a name="line-81"></a><span class='hs-comment'>-- | Master 'ManageHook' that must be in your @xmonad.hs@ 'ManageHook'.</span>
<a name="line-82"></a><span class='hs-definition'>dynamicMasterHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IORef</span> <span class='hs-conid'>DynamicHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManageHook</span>
<a name="line-83"></a><span class='hs-definition'>dynamicMasterHook</span> <span class='hs-varid'>ref</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>True</span> <span class='hs-varop'>--></span>
<a name="line-84"></a> <span class='hs-layout'>(</span><span class='hs-varid'>ask</span> <span class='hs-varop'>>>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>w</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>liftX</span> <span class='hs-layout'>(</span><span class='hs-keyword'>do</span>
<a name="line-85"></a> <span class='hs-varid'>dh</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>readIORef</span> <span class='hs-varid'>ref</span>
<a name="line-86"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Endo</span> <span class='hs-varid'>f</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>runQuery</span> <span class='hs-layout'>(</span><span class='hs-varid'>permanent</span> <span class='hs-varid'>dh</span><span class='hs-layout'>)</span> <span class='hs-varid'>w</span>
<a name="line-87"></a> <span class='hs-varid'>ts</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mapM</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>q</span><span class='hs-layout'>,</span><span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>runQuery</span> <span class='hs-varid'>q</span> <span class='hs-varid'>w</span> <span class='hs-varop'>>>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span><span class='hs-layout'>,</span><span class='hs-layout'>(</span><span class='hs-varid'>q</span><span class='hs-layout'>,</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>transients</span> <span class='hs-varid'>dh</span><span class='hs-layout'>)</span>
<a name="line-88"></a> <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-varid'>ts'</span><span class='hs-layout'>,</span><span class='hs-varid'>nts</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>partition</span> <span class='hs-varid'>fst</span> <span class='hs-varid'>ts</span>
<a name="line-89"></a> <span class='hs-varid'>gs</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>mapM</span> <span class='hs-layout'>(</span><span class='hs-varid'>flip</span> <span class='hs-varid'>runQuery</span> <span class='hs-varid'>w</span> <span class='hs-varop'>.</span> <span class='hs-varid'>snd</span> <span class='hs-varop'>.</span> <span class='hs-varid'>snd</span><span class='hs-layout'>)</span> <span class='hs-varid'>ts'</span>
<a name="line-90"></a> <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-conid'>Endo</span> <span class='hs-varid'>g</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>Endo</span> <span class='hs-varid'>id</span><span class='hs-layout'>)</span> <span class='hs-varid'>id</span> <span class='hs-varop'>$</span> <span class='hs-varid'>listToMaybe</span> <span class='hs-varid'>gs</span>
<a name="line-91"></a> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeIORef</span> <span class='hs-varid'>ref</span> <span class='hs-varop'>$</span> <span class='hs-varid'>dh</span> <span class='hs-layout'>{</span> <span class='hs-varid'>transients</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-varid'>snd</span> <span class='hs-varid'>nts</span> <span class='hs-layout'>}</span>
<a name="line-92"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Endo</span> <span class='hs-varop'>$</span> <span class='hs-varid'>f</span> <span class='hs-varop'>.</span> <span class='hs-varid'>g</span>
<a name="line-93"></a> <span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-94"></a>
<a name="line-95"></a><a name="addDynamicHook"></a><span class='hs-comment'>-- | Appends the given 'ManageHook' to the permanent dynamic 'ManageHook'.</span>
<a name="line-96"></a><span class='hs-definition'>addDynamicHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IORef</span> <span class='hs-conid'>DynamicHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManageHook</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-97"></a><span class='hs-definition'>addDynamicHook</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>updateDynamicHook</span> <span class='hs-varid'>ref</span> <span class='hs-layout'>(</span><span class='hs-varop'><+></span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-98"></a>
<a name="line-99"></a>
<a name="line-100"></a><a name="updateDynamicHook"></a><span class='hs-comment'>-- | Modifies the permanent 'ManageHook' with an arbitrary function.</span>
<a name="line-101"></a><span class='hs-definition'>updateDynamicHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IORef</span> <span class='hs-conid'>DynamicHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>ManageHook</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManageHook</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-102"></a><span class='hs-definition'>updateDynamicHook</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span>
<a name="line-103"></a> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>modifyIORef</span> <span class='hs-varid'>ref</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>dh</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>dh</span> <span class='hs-layout'>{</span> <span class='hs-varid'>permanent</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-varid'>permanent</span> <span class='hs-varid'>dh</span><span class='hs-layout'>)</span> <span class='hs-layout'>}</span>
<a name="line-104"></a>
<a name="line-105"></a>
<a name="line-106"></a><a name="oneShotHook"></a><span class='hs-comment'>-- | Creates a one-shot 'ManageHook'. Note that you have to specify the two</span>
<a name="line-107"></a><span class='hs-comment'>-- parts of the 'ManageHook' separately. Where you would usually write:</span>
<a name="line-108"></a><span class='hs-comment'>--</span>
<a name="line-109"></a><span class='hs-comment'>-- > className =? "example" --> doFloat</span>
<a name="line-110"></a><span class='hs-comment'>--</span>
<a name="line-111"></a><span class='hs-comment'>-- you must call 'oneShotHook' as</span>
<a name="line-112"></a><span class='hs-comment'>--</span>
<a name="line-113"></a><span class='hs-comment'>-- > oneShotHook dynHooksRef (className =? "example) doFloat</span>
<a name="line-114"></a><span class='hs-comment'>--</span>
<a name="line-115"></a><span class='hs-definition'>oneShotHook</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IORef</span> <span class='hs-conid'>DynamicHooks</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Query</span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ManageHook</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-116"></a><span class='hs-definition'>oneShotHook</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>q</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span>
<a name="line-117"></a> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>modifyIORef</span> <span class='hs-varid'>ref</span>
<a name="line-118"></a> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>dh</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>dh</span> <span class='hs-layout'>{</span> <span class='hs-varid'>transients</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>q</span><span class='hs-layout'>,</span><span class='hs-varid'>a</span><span class='hs-layout'>)</span><span class='hs-conop'>:</span><span class='hs-layout'>(</span><span class='hs-varid'>transients</span> <span class='hs-varid'>dh</span><span class='hs-layout'>)</span> <span class='hs-layout'>}</span>
<a name="line-119"></a>
<a name="line-120"></a>
<a name="line-121"></a>
<a name="line-122"></a>
</pre></body>
</html>
