<?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/Layout/MagicFocus.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, TypeSynonymInstances #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : XMonad.Layout.MagicFocus</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (c) Peter De Wachter <pdewacht@gmail.com></span>
<a name="line-7"></a><span class='hs-comment'>-- License : BSD</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer : Peter De Wachter <pdewacht@gmail.com></span>
<a name="line-10"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-11"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- Automagically put the focused window in the master area.</span>
<a name="line-14"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-15"></a>
<a name="line-16"></a><span class='hs-keyword'>module</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'>MagicFocus</span>
<a name="line-17"></a> <span class='hs-layout'>(</span><span class='hs-comment'>-- * Usage</span>
<a name="line-18"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-19"></a> <span class='hs-varid'>magicFocus</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-varid'>promoteWarp</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>promoteWarp'</span><span class='hs-layout'>,</span>
<a name="line-22"></a> <span class='hs-varid'>followOnlyIf</span><span class='hs-layout'>,</span>
<a name="line-23"></a> <span class='hs-varid'>disableFollowOnWS</span>
<a name="line-24"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-27"></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-28"></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'>LayoutModifier</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Actions</span><span class='hs-varop'>.</span><span class='hs-conid'>UpdatePointer</span><span class='hs-layout'>(</span><span class='hs-varid'>updatePointer</span><span class='hs-layout'>,</span> <span class='hs-conid'>PointerPosition</span><span class='hs-layout'>(</span><span class='hs-conid'>TowardsCentre</span><span class='hs-layout'>)</span><span class='hs-layout'>)</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'>Monoid</span><span class='hs-layout'>(</span><span class='hs-conid'>All</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-32"></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'>Map</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>M</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-comment'>-- $usage</span>
<a name="line-35"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-36"></a><span class='hs-comment'>--</span>
<a name="line-37"></a><span class='hs-comment'>-- > import XMonad.Layout.MagicFocus</span>
<a name="line-38"></a><span class='hs-comment'>--</span>
<a name="line-39"></a><span class='hs-comment'>-- Then edit your @layoutHook@ by adding the magicFocus layout</span>
<a name="line-40"></a><span class='hs-comment'>-- modifier:</span>
<a name="line-41"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><span class='hs-comment'>-- > myLayout = magicFocus (Tall 1 (3/100) (1/2)) ||| Full ||| etc..</span>
<a name="line-43"></a><span class='hs-comment'>-- > main = xmonad defaultConfig { layoutHook = myLayout,</span>
<a name="line-44"></a><span class='hs-comment'>-- > handleEventHook = promoteWarp }</span>
<a name="line-45"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><span class='hs-comment'>-- For more detailed instructions on editing the layoutHook see:</span>
<a name="line-47"></a><span class='hs-comment'>--</span>
<a name="line-48"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_the_layout_hook"</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="magicFocus"></a><span class='hs-comment'>-- | Create a new layout which automagically puts the focused window</span>
<a name="line-51"></a><span class='hs-comment'>-- in the master area.</span>
<a name="line-52"></a><span class='hs-definition'>magicFocus</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>l</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>MagicFocus</span> <span class='hs-varid'>l</span> <span class='hs-varid'>a</span>
<a name="line-53"></a><span class='hs-definition'>magicFocus</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>MagicFocus</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="MagicFocus"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>MagicFocus</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>MagicFocus</span> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Read</span><span class='hs-layout'>)</span>
<a name="line-56"></a>
<a name="line-57"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>LayoutModifier</span> <span class='hs-conid'>MagicFocus</span> <span class='hs-conid'>Window</span> <span class='hs-keyword'>where</span>
<a name="line-58"></a> <span class='hs-varid'>modifyLayout</span> <span class='hs-conid'>MagicFocus</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>Workspace</span> <span class='hs-varid'>i</span> <span class='hs-varid'>l</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span>
<a name="line-59"></a> <span class='hs-varid'>withWindowSet</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>wset</span> <span class='hs-keyglyph'>-></span>
<a name="line-60"></a> <span class='hs-varid'>runLayout</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>Workspace</span> <span class='hs-varid'>i</span> <span class='hs-varid'>l</span> <span class='hs-layout'>(</span><span class='hs-varid'>s</span> <span class='hs-varop'>>>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>st</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-varid'>swap</span> <span class='hs-varid'>st</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>peek</span> <span class='hs-varid'>wset</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>r</span>
<a name="line-61"></a>
<a name="line-62"></a><a name="swap"></a><span class='hs-definition'>swap</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>Stack</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>Stack</span> <span class='hs-varid'>a</span>
<a name="line-63"></a><span class='hs-definition'>swap</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>Stack</span> <span class='hs-varid'>f</span> <span class='hs-varid'>u</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-varid'>focused</span>
<a name="line-64"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>f</span> <span class='hs-varop'>==</span> <span class='hs-varid'>focused</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>Stack</span> <span class='hs-varid'>f</span> <span class='hs-conid'>[]</span> <span class='hs-layout'>(</span><span class='hs-varid'>reverse</span> <span class='hs-varid'>u</span> <span class='hs-varop'>++</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span>
<a name="line-65"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-conid'>Stack</span> <span class='hs-varid'>f</span> <span class='hs-varid'>u</span> <span class='hs-varid'>d</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="promoteWarp"></a><span class='hs-comment'>-- | An eventHook that overrides the normal focusFollowsMouse. When the mouse</span>
<a name="line-68"></a><span class='hs-comment'>-- it moved to another window, that window is replaced as the master, and the</span>
<a name="line-69"></a><span class='hs-comment'>-- mouse is warped to inside the new master.</span>
<a name="line-70"></a><span class='hs-comment'>--</span>
<a name="line-71"></a><span class='hs-comment'>-- It prevents infinite loops when focusFollowsMouse is true (the default), and</span>
<a name="line-72"></a><span class='hs-comment'>-- MagicFocus is in use when changing focus with the mouse.</span>
<a name="line-73"></a><span class='hs-comment'>--</span>
<a name="line-74"></a><span class='hs-comment'>-- This eventHook does nothing when there are floating windows on the current</span>
<a name="line-75"></a><span class='hs-comment'>-- workspace.</span>
<a name="line-76"></a><span class='hs-definition'>promoteWarp</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-77"></a><span class='hs-definition'>promoteWarp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>promoteWarp'</span> <span class='hs-layout'>(</span><span class='hs-conid'>TowardsCentre</span> <span class='hs-num'>0.15</span> <span class='hs-num'>0.15</span><span class='hs-layout'>)</span>
<a name="line-78"></a>
<a name="line-79"></a><a name="promoteWarp'"></a><span class='hs-comment'>-- | promoteWarp' allows you to specify an arbitrary PointerPosition to apply</span>
<a name="line-80"></a><span class='hs-comment'>-- when the mouse enters another window.</span>
<a name="line-81"></a><span class='hs-definition'>promoteWarp'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PointerPosition</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-82"></a><span class='hs-definition'>promoteWarp'</span> <span class='hs-varid'>pos</span> <span class='hs-varid'>e</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>CrossingEvent</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'>t</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-83"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>t</span> <span class='hs-varop'>==</span> <span class='hs-varid'>enterNotify</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>ev_mode</span> <span class='hs-varid'>e</span> <span class='hs-varop'>==</span> <span class='hs-varid'>notifyNormal</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-84"></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-85"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>foc</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>peek</span> <span class='hs-varid'>ws</span>
<a name="line-86"></a> <span class='hs-varid'>st</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>integrate'</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>stack</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>workspace</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-varid'>ws</span>
<a name="line-87"></a> <span class='hs-varid'>wsFloats</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>M</span><span class='hs-varop'>.</span><span class='hs-varid'>filterWithKey</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>k</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>k</span> <span class='hs-varop'>`elem`</span> <span class='hs-varid'>st</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>floating</span> <span class='hs-varid'>ws</span>
<a name="line-88"></a> <span class='hs-keyword'>if</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>w</span> <span class='hs-varop'>/=</span> <span class='hs-varid'>foc</span> <span class='hs-varop'>&&</span> <span class='hs-conid'>M</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>wsFloats</span> <span class='hs-keyword'>then</span> <span class='hs-keyword'>do</span>
<a name="line-89"></a> <span class='hs-varid'>windows</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>swapMaster</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>focusWindow</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span>
<a name="line-90"></a> <span class='hs-varid'>updatePointer</span> <span class='hs-varid'>pos</span>
<a name="line-91"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>All</span> <span class='hs-conid'>False</span>
<a name="line-92"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>All</span> <span class='hs-conid'>True</span>
<a name="line-93"></a><span class='hs-definition'>promoteWarp'</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>All</span> <span class='hs-conid'>True</span>
<a name="line-94"></a>
<a name="line-95"></a><a name="followOnlyIf"></a><span class='hs-comment'>-- | Another event hook to override the focusFollowsMouse and make the pointer</span>
<a name="line-96"></a><span class='hs-comment'>-- only follow if a given condition is satisfied. This could be used to disable</span>
<a name="line-97"></a><span class='hs-comment'>-- focusFollowsMouse only for given workspaces or layouts.</span>
<a name="line-98"></a><span class='hs-comment'>-- Beware that your focusFollowsMouse setting is ignored if you use this event hook.</span>
<a name="line-99"></a><span class='hs-definition'>followOnlyIf</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</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-100"></a><span class='hs-definition'>followOnlyIf</span> <span class='hs-varid'>cond</span> <span class='hs-varid'>e</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>CrossingEvent</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'>t</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-101"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>t</span> <span class='hs-varop'>==</span> <span class='hs-varid'>enterNotify</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>ev_mode</span> <span class='hs-varid'>e</span> <span class='hs-varop'>==</span> <span class='hs-varid'>notifyNormal</span>
<a name="line-102"></a> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>whenX</span> <span class='hs-varid'>cond</span> <span class='hs-layout'>(</span><span class='hs-varid'>focus</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>All</span> <span class='hs-conid'>False</span><span class='hs-layout'>)</span>
<a name="line-103"></a><span class='hs-definition'>followOnlyIf</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>All</span> <span class='hs-conid'>True</span>
<a name="line-104"></a>
<a name="line-105"></a><a name="disableFollowOnWS"></a><span class='hs-comment'>-- | Disables focusFollow on the given workspaces:</span>
<a name="line-106"></a><span class='hs-definition'>disableFollowOnWS</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>WorkspaceId</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span>
<a name="line-107"></a><span class='hs-definition'>disableFollowOnWS</span> <span class='hs-varid'>wses</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>`notElem`</span> <span class='hs-varid'>wses</span><span class='hs-layout'>)</span> <span class='hs-varop'>`fmap`</span> <span class='hs-varid'>gets</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>currentTag</span> <span class='hs-varop'>.</span> <span class='hs-varid'>windowset</span><span class='hs-layout'>)</span>
</pre></body>
</html>
