<?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/IndependentScreens.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.Layout.IndependentScreens</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) 2009 Daniel Wagner</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD3</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : <daniel@wagner-home.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'>-- Utility functions for simulating independent sets of workspaces on</span>
<a name="line-12"></a><span class='hs-comment'>-- each screen (like dwm's workspace model), using internal tags to</span>
<a name="line-13"></a><span class='hs-comment'>-- distinguish workspaces associated with each screen.</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'>IndependentScreens</span> <span class='hs-layout'>(</span>
<a name="line-17"></a> <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-conid'>VirtualWorkspace</span><span class='hs-layout'>,</span> <span class='hs-conid'>PhysicalWorkspace</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-varid'>workspaces'</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>withScreens</span><span class='hs-layout'>,</span> <span class='hs-varid'>onCurrentScreen</span><span class='hs-layout'>,</span>
<a name="line-22"></a> <span class='hs-varid'>countScreens</span><span class='hs-layout'>,</span>
<a name="line-23"></a> <span class='hs-varid'>marshall</span><span class='hs-layout'>,</span> <span class='hs-varid'>unmarshall</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-comment'>-- for the screen stuff</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Arrow</span> <span class='hs-varid'>hiding</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-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-29"></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-varop'>.</span><span class='hs-conid'>Instances</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'>List</span>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span><span class='hs-varop'>.</span><span class='hs-conid'>Xinerama</span>
<a name="line-32"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>StackSet</span> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-varid'>workspaces</span><span class='hs-layout'>)</span>
<a name="line-34"></a>
<a name="line-35"></a><span class='hs-comment'>-- $usage</span>
<a name="line-36"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-37"></a><span class='hs-comment'>--</span>
<a name="line-38"></a><span class='hs-comment'>-- > import XMonad.Layout.IndependentScreens</span>
<a name="line-39"></a><span class='hs-comment'>--</span>
<a name="line-40"></a><span class='hs-comment'>-- You can define your workspaces by calling @withScreens@:</span>
<a name="line-41"></a><span class='hs-comment'>--</span>
<a name="line-42"></a><span class='hs-comment'>-- > myConfig = defaultConfig { workspaces = withScreens 2 ["web", "email", "irc"] }</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>-- This will create \"physical\" workspaces with distinct internal names for</span>
<a name="line-45"></a><span class='hs-comment'>-- each (screen, virtual workspace) pair.</span>
<a name="line-46"></a><span class='hs-comment'>--</span>
<a name="line-47"></a><span class='hs-comment'>-- Then edit any keybindings that use the list of workspaces or refer</span>
<a name="line-48"></a><span class='hs-comment'>-- to specific workspace names. In the default configuration, only</span>
<a name="line-49"></a><span class='hs-comment'>-- the keybindings for changing workspace do this:</span>
<a name="line-50"></a><span class='hs-comment'>--</span>
<a name="line-51"></a><span class='hs-comment'>-- > [((m .|. modm, k), windows $ f i)</span>
<a name="line-52"></a><span class='hs-comment'>-- > | (i, k) <- zip (XMonad.workspaces conf) [xK_1 .. xK_9]</span>
<a name="line-53"></a><span class='hs-comment'>-- > , (f, m) <- [(W.greedyView, 0), (W.shift, shiftMask)]]</span>
<a name="line-54"></a><span class='hs-comment'>--</span>
<a name="line-55"></a><span class='hs-comment'>-- This should change to</span>
<a name="line-56"></a><span class='hs-comment'>--</span>
<a name="line-57"></a><span class='hs-comment'>-- > [((m .|. modm, k), windows $ onCurrentScreen f i)</span>
<a name="line-58"></a><span class='hs-comment'>-- > | (i, k) <- zip (workspaces' conf) [xK_1 .. xK_9]</span>
<a name="line-59"></a><span class='hs-comment'>-- > , (f, m) <- [(W.greedyView, 0), (W.shift, shiftMask)]]</span>
<a name="line-60"></a><span class='hs-comment'>--</span>
<a name="line-61"></a><span class='hs-comment'>-- In particular, the analogue of @XMonad.workspaces@ is</span>
<a name="line-62"></a><span class='hs-comment'>-- @workspaces'@, and you can use @onCurrentScreen@ to convert functions</span>
<a name="line-63"></a><span class='hs-comment'>-- of virtual workspaces to functions of physical workspaces, which work</span>
<a name="line-64"></a><span class='hs-comment'>-- by marshalling the virtual workspace name and the currently focused</span>
<a name="line-65"></a><span class='hs-comment'>-- screen into a physical workspace name.</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="VirtualWorkspace"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>VirtualWorkspace</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WorkspaceId</span>
<a name="line-68"></a><a name="PhysicalWorkspace"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>PhysicalWorkspace</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WorkspaceId</span>
<a name="line-69"></a>
<a name="line-70"></a><a name="marshall"></a><span class='hs-definition'>marshall</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ScreenId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>VirtualWorkspace</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>PhysicalWorkspace</span>
<a name="line-71"></a><span class='hs-definition'>marshall</span> <span class='hs-layout'>(</span><span class='hs-conid'>S</span> <span class='hs-varid'>sc</span><span class='hs-layout'>)</span> <span class='hs-varid'>vws</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>show</span> <span class='hs-varid'>sc</span> <span class='hs-varop'>++</span> <span class='hs-chr'>'_'</span><span class='hs-conop'>:</span><span class='hs-varid'>vws</span>
<a name="line-72"></a>
<a name="line-73"></a><a name="unmarshall"></a><span class='hs-definition'>unmarshall</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>PhysicalWorkspace</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>ScreenId</span><span class='hs-layout'>,</span> <span class='hs-conid'>VirtualWorkspace</span><span class='hs-layout'>)</span>
<a name="line-74"></a><span class='hs-definition'>unmarshall</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conid'>S</span> <span class='hs-varop'>.</span> <span class='hs-varid'>read</span><span class='hs-layout'>)</span> <span class='hs-varop'>***</span> <span class='hs-varid'>drop</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>break</span> <span class='hs-layout'>(</span><span class='hs-varop'>==</span><span class='hs-chr'>'_'</span><span class='hs-layout'>)</span>
<a name="line-75"></a>
<a name="line-76"></a><span class='hs-comment'>-- ^ You shouldn't need to use @marshall@ and @unmarshall@ very much.</span>
<a name="line-77"></a><span class='hs-comment'>-- They simply convert between the physical and virtual worlds. For</span>
<a name="line-78"></a><span class='hs-comment'>-- example, you might want to use them as part of a status bar</span>
<a name="line-79"></a><span class='hs-comment'>-- configuration. The function @snd . unmarshall@ would discard the</span>
<a name="line-80"></a><span class='hs-comment'>-- screen information from an otherwise unsightly workspace name.</span>
<a name="line-81"></a>
<a name="line-82"></a><a name="workspaces'"></a><span class='hs-definition'>workspaces'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>XConfig</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>VirtualWorkspace</span><span class='hs-keyglyph'>]</span>
<a name="line-83"></a><span class='hs-definition'>workspaces'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>nub</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-varid'>snd</span> <span class='hs-varop'>.</span> <span class='hs-varid'>unmarshall</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>workspaces</span>
<a name="line-84"></a>
<a name="line-85"></a><a name="withScreens"></a><span class='hs-definition'>withScreens</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ScreenId</span> <span class='hs-comment'>-- ^ The number of screens to make workspaces for</span>
<a name="line-86"></a> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>VirtualWorkspace</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ The desired virtual workspace names</span>
<a name="line-87"></a> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>PhysicalWorkspace</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ A list of all internal physical workspace names</span>
<a name="line-88"></a><span class='hs-definition'>withScreens</span> <span class='hs-varid'>n</span> <span class='hs-varid'>vws</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>marshall</span> <span class='hs-varid'>sc</span> <span class='hs-varid'>pws</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>pws</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>vws</span><span class='hs-layout'>,</span> <span class='hs-varid'>sc</span> <span class='hs-keyglyph'><-</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>0</span><span class='hs-keyglyph'>..</span><span class='hs-varid'>n</span><span class='hs-comment'>-</span><span class='hs-num'>1</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-89"></a>
<a name="line-90"></a><a name="onCurrentScreen"></a><span class='hs-definition'>onCurrentScreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>VirtualWorkspace</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>PhysicalWorkspace</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-91"></a><span class='hs-definition'>onCurrentScreen</span> <span class='hs-varid'>f</span> <span class='hs-varid'>vws</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>screen</span> <span class='hs-varop'>.</span> <span class='hs-varid'>current</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>f</span> <span class='hs-varop'>.</span> <span class='hs-varid'>flip</span> <span class='hs-varid'>marshall</span> <span class='hs-varid'>vws</span>
<a name="line-92"></a>
<a name="line-93"></a><a name="countScreens"></a><span class='hs-comment'>-- | In case you don't know statically how many screens there will be, you can call this in main before starting xmonad. For example, part of my config reads</span>
<a name="line-94"></a><span class='hs-comment'>--</span>
<a name="line-95"></a><span class='hs-comment'>-- > main = do</span>
<a name="line-96"></a><span class='hs-comment'>-- > nScreens <- countScreens</span>
<a name="line-97"></a><span class='hs-comment'>-- > xmonad $ defaultConfig {</span>
<a name="line-98"></a><span class='hs-comment'>-- > ...</span>
<a name="line-99"></a><span class='hs-comment'>-- > workspaces = withScreens nScreens (workspaces defaultConfig),</span>
<a name="line-100"></a><span class='hs-comment'>-- > ...</span>
<a name="line-101"></a><span class='hs-comment'>-- > }</span>
<a name="line-102"></a><span class='hs-comment'>--</span>
<a name="line-103"></a><span class='hs-definition'>countScreens</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadIO</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>Integral</span> <span class='hs-varid'>i</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-varid'>i</span>
<a name="line-104"></a><span class='hs-definition'>countScreens</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>liftM</span> <span class='hs-varid'>genericLength</span> <span class='hs-varop'>.</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>openDisplay</span> <span class='hs-str'>""</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>getScreenInfo</span>
</pre></body>
</html>
