<?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/Actions/PhysicalScreens.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE GeneralizedNewtypeDeriving #-}</span>
<a name="line-2"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : XMonad.Actions.PhysicalScreens</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) Nelson Elhage <nelhage@mit.edu></span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : Nelson Elhage <nelhage@mit.edu></span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Manipulate screens ordered by physical location instead of ID</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'>Actions</span><span class='hs-varop'>.</span><span class='hs-conid'>PhysicalScreens</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-conid'>PhysicalScreen</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-19"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>getScreen</span>
<a name="line-20"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>viewScreen</span>
<a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sendToScreen</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>onNextNeighbour</span>
<a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>onPrevNeighbour</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>
<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'>List</span> <span class='hs-layout'>(</span><span class='hs-varid'>sortBy</span><span class='hs-layout'>,</span><span class='hs-varid'>findIndex</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'>Function</span> <span class='hs-layout'>(</span><span class='hs-varid'>on</span><span class='hs-layout'>)</span>
<a name="line-31"></a>
<a name="line-32"></a><span class='hs-comment'>{- $usage
<a name="line-33"></a>
<a name="line-34"></a>This module allows you name Xinerama screens from XMonad using their
<a name="line-35"></a>physical location relative to each other (as reported by Xinerama),
<a name="line-36"></a>rather than their @ScreenID@ s, which are arbitrarily determined by
<a name="line-37"></a>your X server and graphics hardware.
<a name="line-38"></a>
<a name="line-39"></a>Screens are ordered by the upper-left-most corner, from top-to-bottom
<a name="line-40"></a>and then left-to-right.
<a name="line-41"></a>
<a name="line-42"></a>Example usage in your @~\/.xmonad\/xmonad.hs@ file:
<a name="line-43"></a>
<a name="line-44"></a>> import XMonad.Actions.PhysicalScreens
<a name="line-45"></a>
<a name="line-46"></a>> , ((modMask, xK_a), onPrevNeighbour W.view)
<a name="line-47"></a>> , ((modMask, xK_o), onNextNeighbour W.view)
<a name="line-48"></a>> , ((modMask .|. shiftMask, xK_a), onPrevNeighbour W.shift)
<a name="line-49"></a>> , ((modMask .|. shiftMask, xK_o), onNextNeighbour W.shift)
<a name="line-50"></a>
<a name="line-51"></a>> --
<a name="line-52"></a>> -- mod-{w,e,r}, Switch to physical/Xinerama screens 1, 2, or 3
<a name="line-53"></a>> -- mod-shift-{w,e,r}, Move client to screen 1, 2, or 3
<a name="line-54"></a>> --
<a name="line-55"></a>> [((modm .|. mask, key), f sc)
<a name="line-56"></a>> | (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]
<a name="line-57"></a>> , (f, mask) <- [(viewScreen, 0), (sendToScreen, shiftMask)]]
<a name="line-58"></a>
<a name="line-59"></a>For detailed instructions on editing your key bindings, see
<a name="line-60"></a>"XMonad.Doc.Extending#Editing_key_bindings".
<a name="line-61"></a> -}</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="PhysicalScreen"></a><span class='hs-comment'>-- | The type of the index of a screen by location</span>
<a name="line-64"></a><a name="PhysicalScreen"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>PhysicalScreen</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>P</span> <span class='hs-conid'>Int</span> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span><span class='hs-conid'>Ord</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><span class='hs-conid'>Enum</span><span class='hs-layout'>,</span><span class='hs-conid'>Num</span><span class='hs-layout'>,</span><span class='hs-conid'>Integral</span><span class='hs-layout'>,</span><span class='hs-conid'>Real</span><span class='hs-layout'>)</span>
<a name="line-65"></a>
<a name="line-66"></a><a name="getScreen"></a><span class='hs-comment'>-- | Translate a physical screen index to a "ScreenId"</span>
<a name="line-67"></a><span class='hs-definition'>getScreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PhysicalScreen</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>ScreenId</span><span class='hs-layout'>)</span>
<a name="line-68"></a><span class='hs-definition'>getScreen</span> <span class='hs-layout'>(</span><span class='hs-conid'>P</span> <span class='hs-varid'>i</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>gets</span> <span class='hs-varid'>windowset</span>
<a name="line-69"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>screens</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>current</span> <span class='hs-varid'>w</span> <span class='hs-conop'>:</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>visible</span> <span class='hs-varid'>w</span>
<a name="line-70"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>i</span><span class='hs-varop'><</span><span class='hs-num'>0</span> <span class='hs-varop'>||</span> <span class='hs-varid'>i</span> <span class='hs-varop'>>=</span> <span class='hs-varid'>length</span> <span class='hs-varid'>screens</span>
<a name="line-71"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-72"></a> <span class='hs-keyword'>else</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>ss</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sortBy</span> <span class='hs-layout'>(</span><span class='hs-varid'>cmpScreen</span> <span class='hs-varop'>`on`</span> <span class='hs-layout'>(</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-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>screens</span>
<a name="line-73"></a> <span class='hs-keyword'>in</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>screen</span> <span class='hs-varop'>$</span> <span class='hs-varid'>ss</span> <span class='hs-varop'>!!</span> <span class='hs-varid'>i</span>
<a name="line-74"></a>
<a name="line-75"></a><a name="viewScreen"></a><span class='hs-comment'>-- | Switch to a given physical screen</span>
<a name="line-76"></a><span class='hs-definition'>viewScreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PhysicalScreen</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-77"></a><span class='hs-definition'>viewScreen</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getScreen</span> <span class='hs-varid'>p</span>
<a name="line-78"></a> <span class='hs-varid'>whenJust</span> <span class='hs-varid'>i</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>s</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-79"></a> <span class='hs-varid'>w</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>screenWorkspace</span> <span class='hs-varid'>s</span>
<a name="line-80"></a> <span class='hs-varid'>whenJust</span> <span class='hs-varid'>w</span> <span class='hs-varop'>$</span> <span class='hs-varid'>windows</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>view</span>
<a name="line-81"></a>
<a name="line-82"></a><a name="sendToScreen"></a><span class='hs-comment'>-- | Send the active window to a given physical screen</span>
<a name="line-83"></a><span class='hs-definition'>sendToScreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PhysicalScreen</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-84"></a><span class='hs-definition'>sendToScreen</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getScreen</span> <span class='hs-varid'>p</span>
<a name="line-85"></a> <span class='hs-varid'>whenJust</span> <span class='hs-varid'>i</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>s</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-86"></a> <span class='hs-varid'>w</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>screenWorkspace</span> <span class='hs-varid'>s</span>
<a name="line-87"></a> <span class='hs-varid'>whenJust</span> <span class='hs-varid'>w</span> <span class='hs-varop'>$</span> <span class='hs-varid'>windows</span> <span class='hs-varop'>.</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>shift</span>
<a name="line-88"></a>
<a name="line-89"></a><a name="cmpScreen"></a><span class='hs-comment'>-- | Compare two screens by their top-left corners, ordering</span>
<a name="line-90"></a><span class='hs-comment'>-- | top-to-bottom and then left-to-right.</span>
<a name="line-91"></a><span class='hs-definition'>cmpScreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Rectangle</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Rectangle</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ordering</span>
<a name="line-92"></a><span class='hs-definition'>cmpScreen</span> <span class='hs-layout'>(</span><span class='hs-conid'>Rectangle</span> <span class='hs-varid'>x1</span> <span class='hs-varid'>y1</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>Rectangle</span> <span class='hs-varid'>x2</span> <span class='hs-varid'>y2</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'>compare</span> <span class='hs-layout'>(</span><span class='hs-varid'>y1</span><span class='hs-layout'>,</span><span class='hs-varid'>x1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>y2</span><span class='hs-layout'>,</span><span class='hs-varid'>x2</span><span class='hs-layout'>)</span>
<a name="line-93"></a>
<a name="line-94"></a>
<a name="line-95"></a><a name="getNeighbour"></a><span class='hs-comment'>-- | Get ScreenId for neighbours of the current screen based on position offset.</span>
<a name="line-96"></a><span class='hs-definition'>getNeighbour</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>ScreenId</span>
<a name="line-97"></a><span class='hs-definition'>getNeighbour</span> <span class='hs-varid'>d</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>gets</span> <span class='hs-varid'>windowset</span>
<a name="line-98"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>ss</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>screen</span> <span class='hs-varop'>$</span> <span class='hs-varid'>sortBy</span> <span class='hs-layout'>(</span><span class='hs-varid'>cmpScreen</span> <span class='hs-varop'>`on`</span> <span class='hs-layout'>(</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-layout'>)</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'>current</span> <span class='hs-varid'>w</span> <span class='hs-conop'>:</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>visible</span> <span class='hs-varid'>w</span>
<a name="line-99"></a> <span class='hs-varid'>curPos</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maybe</span> <span class='hs-num'>0</span> <span class='hs-varid'>id</span> <span class='hs-varop'>$</span> <span class='hs-varid'>findIndex</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'>screen</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'>w</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>ss</span>
<a name="line-100"></a> <span class='hs-varid'>pos</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>curPos</span> <span class='hs-varop'>+</span> <span class='hs-varid'>d</span><span class='hs-layout'>)</span> <span class='hs-varop'>`mod`</span> <span class='hs-varid'>length</span> <span class='hs-varid'>ss</span>
<a name="line-101"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>ss</span> <span class='hs-varop'>!!</span> <span class='hs-varid'>pos</span>
<a name="line-102"></a>
<a name="line-103"></a><a name="neighbourWindows"></a><span class='hs-definition'>neighbourWindows</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>WorkspaceId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</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-104"></a><span class='hs-definition'>neighbourWindows</span> <span class='hs-varid'>d</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getNeighbour</span> <span class='hs-varid'>d</span>
<a name="line-105"></a> <span class='hs-varid'>w</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>screenWorkspace</span> <span class='hs-varid'>s</span>
<a name="line-106"></a> <span class='hs-varid'>whenJust</span> <span class='hs-varid'>w</span> <span class='hs-varop'>$</span> <span class='hs-varid'>windows</span> <span class='hs-varop'>.</span> <span class='hs-varid'>f</span>
<a name="line-107"></a>
<a name="line-108"></a><a name="onNextNeighbour"></a><span class='hs-comment'>-- | Apply operation on a WindowSet with the WorkspaceId of the next screen in the physical order as parameter.</span>
<a name="line-109"></a><span class='hs-definition'>onNextNeighbour</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>WorkspaceId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</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-110"></a><span class='hs-definition'>onNextNeighbour</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>neighbourWindows</span> <span class='hs-num'>1</span>
<a name="line-111"></a>
<a name="line-112"></a><a name="onPrevNeighbour"></a><span class='hs-comment'>-- | Apply operation on a WindowSet with the WorkspaceId of the previous screen in the physical order as parameter.</span>
<a name="line-113"></a><span class='hs-definition'>onPrevNeighbour</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>WorkspaceId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</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-114"></a><span class='hs-definition'>onPrevNeighbour</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>neighbourWindows</span> <span class='hs-layout'>(</span><span class='hs-comment'>-</span><span class='hs-num'>1</span><span class='hs-layout'>)</span>
</pre></body>
</html>
