<?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/Workscreen.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.Actions.Workscreen</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) 2012 kedals0</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 : Dal <kedasl0@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'>-- A workscreen permits to display a set of workspaces on several</span>
<a name="line-12"></a><span class='hs-comment'>-- screens. In xinerama mode, when a workscreen is viewed, workspaces</span>
<a name="line-13"></a><span class='hs-comment'>-- associated to all screens are visible.</span>
<a name="line-14"></a><span class='hs-comment'>--</span>
<a name="line-15"></a><span class='hs-comment'>-- The first workspace of a workscreen is displayed on first screen,</span>
<a name="line-16"></a><span class='hs-comment'>-- second on second screen, etc. Workspace position can be easily</span>
<a name="line-17"></a><span class='hs-comment'>-- changed. If the current workscreen is called again, workspaces are</span>
<a name="line-18"></a><span class='hs-comment'>-- shifted.</span>
<a name="line-19"></a><span class='hs-comment'>--</span>
<a name="line-20"></a><span class='hs-comment'>-- This also permits to see all workspaces of a workscreen even if just</span>
<a name="line-21"></a><span class='hs-comment'>-- one screen is present, and to move windows from workspace to workscreen.</span>
<a name="line-22"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-23"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable #-}</span>
<a name="line-24"></a>
<a name="line-25"></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'>Workscreen</span> <span class='hs-layout'>(</span>
<a name="line-26"></a> <span class='hs-comment'>-- * Usage</span>
<a name="line-27"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-28"></a> <span class='hs-varid'>configWorkscreen</span>
<a name="line-29"></a> <span class='hs-layout'>,</span><span class='hs-varid'>viewWorkscreen</span>
<a name="line-30"></a> <span class='hs-layout'>,</span><span class='hs-conid'>Workscreen</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-31"></a> <span class='hs-layout'>,</span><span class='hs-varid'>shiftToWorkscreen</span>
<a name="line-32"></a> <span class='hs-layout'>,</span><span class='hs-varid'>fromWorkspace</span>
<a name="line-33"></a> <span class='hs-layout'>,</span><span class='hs-varid'>expandWorkspace</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> <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-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-keyword'>qualified</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'>ExtensibleState</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>XS</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'>Actions</span><span class='hs-varop'>.</span><span class='hs-conid'>OnScreen</span>
<a name="line-40"></a>
<a name="line-41"></a><span class='hs-comment'>-- $usage</span>
<a name="line-42"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>-- > import XMonad.Actions.Workscreen</span>
<a name="line-45"></a><span class='hs-comment'>-- > myWorkspaces = let myOldWorkspaces = ["adm","work","mail"]</span>
<a name="line-46"></a><span class='hs-comment'>-- > in Workscreen.expandWorkspace 2 myOldWorkspaces</span>
<a name="line-47"></a><span class='hs-comment'>-- > myStartupHook = do Workscreen.configWorkscreen (Workscreen.fromWorkspace 2 myWorkspaces)</span>
<a name="line-48"></a><span class='hs-comment'>-- > return ()</span>
<a name="line-49"></a><span class='hs-comment'>--</span>
<a name="line-50"></a><span class='hs-comment'>-- Then, replace normal workspace view and shift keybinding:</span>
<a name="line-51"></a><span class='hs-comment'>--</span>
<a name="line-52"></a><span class='hs-comment'>-- > [((m .|. modm, k), f i)</span>
<a name="line-53"></a><span class='hs-comment'>-- > | (i, k) <- zip [0..] [1..12]</span>
<a name="line-54"></a><span class='hs-comment'>-- > , (f, m) <- [(Workscreen.viewWorkscreen, 0), (Workscreen.shiftToWorkscreen, shiftMask)]]</span>
<a name="line-55"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><span class='hs-comment'>-- For detailed instructions on editing your key bindings, see</span>
<a name="line-57"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_key_bindings".</span>
<a name="line-58"></a>
<a name="line-59"></a>
<a name="line-60"></a><a name="Workscreen"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Workscreen</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Workscreen</span><span class='hs-layout'>{</span><span class='hs-varid'>workscreenId</span><span class='hs-keyglyph'>::</span><span class='hs-conid'>Int</span><span class='hs-layout'>,</span><span class='hs-varid'>workspaces</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-layout'>}</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'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-61"></a><a name="WorkscreenId"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>WorkscreenId</span><span class='hs-keyglyph'>=</span><span class='hs-conid'>Int</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="WorkscreenStorage"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>WorkscreenStorage</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WorkscreenStorage</span> <span class='hs-conid'>WorkscreenId</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Workscreen</span><span class='hs-keyglyph'>]</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'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-64"></a><a name="instance%20ExtensionClass%20WorkscreenStorage"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>ExtensionClass</span> <span class='hs-conid'>WorkscreenStorage</span> <span class='hs-keyword'>where</span>
<a name="line-65"></a> <span class='hs-varid'>initialValue</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WorkscreenStorage</span> <span class='hs-num'>0</span> <span class='hs-conid'>[]</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="expandWorkspace"></a><span class='hs-comment'>-- | Helper to group workspaces. Multiply workspace by screens number.</span>
<a name="line-68"></a><span class='hs-definition'>expandWorkspace</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</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-keyglyph'>[</span><span class='hs-conid'>WorkspaceId</span><span class='hs-keyglyph'>]</span>
<a name="line-69"></a><span class='hs-definition'>expandWorkspace</span> <span class='hs-varid'>nscr</span> <span class='hs-varid'>ws</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>concat</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-varid'>expandId</span> <span class='hs-varid'>ws</span>
<a name="line-70"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>expandId</span> <span class='hs-varid'>wsId</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>wsId</span> <span class='hs-varop'>++</span> <span class='hs-str'>"_"</span>
<a name="line-71"></a> <span class='hs-keyword'>in</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'>++</span><span class='hs-layout'>)</span> <span class='hs-varid'>t</span> <span class='hs-varop'>.</span> <span class='hs-varid'>show</span> <span class='hs-layout'>)</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>1</span><span class='hs-keyglyph'>..</span><span class='hs-varid'>nscr</span><span class='hs-keyglyph'>]</span>
<a name="line-72"></a>
<a name="line-73"></a><a name="fromWorkspace"></a><span class='hs-comment'>-- | Create workscreen list from workspace list. Group workspaces to</span>
<a name="line-74"></a><span class='hs-comment'>-- packets of screens number size.</span>
<a name="line-75"></a><span class='hs-definition'>fromWorkspace</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</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-keyglyph'>[</span><span class='hs-conid'>Workscreen</span><span class='hs-keyglyph'>]</span>
<a name="line-76"></a><span class='hs-definition'>fromWorkspace</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ws</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-varid'>a</span><span class='hs-layout'>,</span><span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Workscreen</span> <span class='hs-varid'>a</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>zip</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>0</span><span class='hs-keyglyph'>..</span><span class='hs-keyglyph'>]</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromWorkspace'</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span>
<a name="line-77"></a><a name="fromWorkspace'"></a><span class='hs-definition'>fromWorkspace'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</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-keyglyph'>[</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>WorkspaceId</span><span class='hs-keyglyph'>]</span><span class='hs-keyglyph'>]</span>
<a name="line-78"></a><span class='hs-definition'>fromWorkspace'</span> <span class='hs-keyword'>_</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span>
<a name="line-79"></a><span class='hs-definition'>fromWorkspace'</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ws</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>take</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ws</span> <span class='hs-conop'>:</span> <span class='hs-varid'>fromWorkspace'</span> <span class='hs-varid'>n</span> <span class='hs-layout'>(</span><span class='hs-varid'>drop</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span>
<a name="line-80"></a>
<a name="line-81"></a><a name="configWorkscreen"></a><span class='hs-comment'>-- | Initial configuration of workscreens</span>
<a name="line-82"></a><span class='hs-definition'>configWorkscreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Workscreen</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-83"></a><span class='hs-definition'>configWorkscreen</span> <span class='hs-varid'>wscrn</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>XS</span><span class='hs-varop'>.</span><span class='hs-varid'>put</span> <span class='hs-layout'>(</span><span class='hs-conid'>WorkscreenStorage</span> <span class='hs-num'>0</span> <span class='hs-varid'>wscrn</span><span class='hs-layout'>)</span>
<a name="line-84"></a>
<a name="line-85"></a><a name="viewWorkscreen"></a><span class='hs-comment'>-- | View workscreen of index @WorkscreenId@. If current workscreen is asked</span>
<a name="line-86"></a><span class='hs-comment'>-- workscreen, workscreen's workspaces are shifted.</span>
<a name="line-87"></a><span class='hs-definition'>viewWorkscreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WorkscreenId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-88"></a><span class='hs-definition'>viewWorkscreen</span> <span class='hs-varid'>wscrId</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-layout'>(</span><span class='hs-conid'>WorkscreenStorage</span> <span class='hs-varid'>c</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>XS</span><span class='hs-varop'>.</span><span class='hs-varid'>get</span>
<a name="line-89"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>wscr</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>wscrId</span> <span class='hs-varop'>==</span> <span class='hs-varid'>c</span>
<a name="line-90"></a> <span class='hs-keyword'>then</span> <span class='hs-conid'>Workscreen</span> <span class='hs-varid'>wscrId</span> <span class='hs-varop'>$</span> <span class='hs-varid'>shiftWs</span> <span class='hs-layout'>(</span><span class='hs-varid'>workspaces</span> <span class='hs-varop'>$</span> <span class='hs-varid'>a</span> <span class='hs-varop'>!!</span> <span class='hs-varid'>wscrId</span><span class='hs-layout'>)</span>
<a name="line-91"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>a</span> <span class='hs-varop'>!!</span> <span class='hs-varid'>wscrId</span>
<a name="line-92"></a> <span class='hs-layout'>(</span><span class='hs-varid'>x</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-conop'>:</span><span class='hs-varid'>ys</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>splitAt</span> <span class='hs-varid'>wscrId</span> <span class='hs-varid'>a</span>
<a name="line-93"></a> <span class='hs-varid'>newWorkscreenStorage</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>WorkscreenStorage</span> <span class='hs-varid'>wscrId</span> <span class='hs-layout'>(</span><span class='hs-varid'>x</span> <span class='hs-varop'>++</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>wscr</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>++</span> <span class='hs-varid'>ys</span><span class='hs-layout'>)</span>
<a name="line-94"></a> <span class='hs-varid'>windows</span> <span class='hs-layout'>(</span><span class='hs-varid'>viewWorkscreen'</span> <span class='hs-varid'>wscr</span><span class='hs-layout'>)</span>
<a name="line-95"></a> <span class='hs-conid'>XS</span><span class='hs-varop'>.</span><span class='hs-varid'>put</span> <span class='hs-varid'>newWorkscreenStorage</span>
<a name="line-96"></a>
<a name="line-97"></a><a name="viewWorkscreen'"></a><span class='hs-definition'>viewWorkscreen'</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Workscreen</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>WindowSet</span>
<a name="line-98"></a><span class='hs-definition'>viewWorkscreen'</span> <span class='hs-layout'>(</span><span class='hs-conid'>Workscreen</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>s</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>foldl</span> <span class='hs-varid'>wsToSc'</span> <span class='hs-varid'>s</span> <span class='hs-layout'>(</span><span class='hs-varid'>zip</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>0</span><span class='hs-keyglyph'>..</span><span class='hs-keyglyph'>]</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span>
<a name="line-99"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>wsToSc'</span> <span class='hs-varid'>s</span> <span class='hs-layout'>(</span><span class='hs-varid'>scr</span><span class='hs-layout'>,</span><span class='hs-varid'>wsId</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>greedyViewOnScreen</span> <span class='hs-varid'>scr</span> <span class='hs-varid'>wsId</span> <span class='hs-varid'>s</span>
<a name="line-100"></a>
<a name="line-101"></a><a name="shiftWs"></a><span class='hs-definition'>shiftWs</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-keyglyph'>[</span><span class='hs-conid'>WorkspaceId</span><span class='hs-keyglyph'>]</span>
<a name="line-102"></a><span class='hs-definition'>shiftWs</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>drop</span> <span class='hs-num'>1</span> <span class='hs-varid'>a</span> <span class='hs-varop'>++</span> <span class='hs-varid'>take</span> <span class='hs-num'>1</span> <span class='hs-varid'>a</span>
<a name="line-103"></a>
<a name="line-104"></a><a name="shiftToWorkscreen"></a><span class='hs-comment'>-- | Shift a window on the first workspace of workscreen</span>
<a name="line-105"></a><span class='hs-comment'>-- @WorkscreenId@.</span>
<a name="line-106"></a><span class='hs-definition'>shiftToWorkscreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WorkscreenId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-107"></a><span class='hs-definition'>shiftToWorkscreen</span> <span class='hs-varid'>wscrId</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-layout'>(</span><span class='hs-conid'>WorkscreenStorage</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>XS</span><span class='hs-varop'>.</span><span class='hs-varid'>get</span>
<a name="line-108"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>ws</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>head</span> <span class='hs-varop'>.</span> <span class='hs-varid'>workspaces</span> <span class='hs-varop'>$</span> <span class='hs-varid'>a</span> <span class='hs-varop'>!!</span> <span class='hs-varid'>wscrId</span>
<a name="line-109"></a> <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> <span class='hs-varid'>ws</span>
</pre></body>
</html>
