<?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/Warp.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.Warp</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) daniel@wagner-home.com</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 : 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'>-- Warp the pointer to a given window or screen.</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'>Actions</span><span class='hs-varop'>.</span><span class='hs-conid'>Warp</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'>banish</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-varid'>banishScreen</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-conid'>Corner</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>warpToScreen</span><span class='hs-layout'>,</span>
<a name="line-22"></a> <span class='hs-varid'>warpToWindow</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'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Ratio</span>
<a name="line-26"></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-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</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'>StackSet</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>W</span>
<a name="line-29"></a>
<a name="line-30"></a><span class='hs-comment'>{- $usage
<a name="line-31"></a>You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
<a name="line-32"></a>
<a name="line-33"></a>> import XMonad.Actions.Warp
<a name="line-34"></a>
<a name="line-35"></a>then add appropriate keybindings to warp the pointer; for example:
<a name="line-36"></a>
<a name="line-37"></a>> , ((modm, xK_z ), warpToWindow (1%2) (1%2)) -- @@ Move pointer to currently focused window
<a name="line-38"></a>>
<a name="line-39"></a>>-- mod-ctrl-{w,e,r} @@ Move mouse pointer to screen 1, 2, or 3
<a name="line-40"></a>>
<a name="line-41"></a>> [((modm .|. controlMask, key), warpToScreen sc (1%2) (1%2))
<a name="line-42"></a>> | (key, sc) <- zip [xK_w, xK_e, xK_r] [0..]]
<a name="line-43"></a>
<a name="line-44"></a>Note that warping to a particular screen may change the focus.
<a name="line-45"></a>-}</span>
<a name="line-46"></a>
<a name="line-47"></a><span class='hs-comment'>-- For detailed instructions on editing your key bindings, see</span>
<a name="line-48"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_key_bindings".</span>
<a name="line-49"></a>
<a name="line-50"></a>
<a name="line-51"></a><a name="Corner"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Corner</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>UpperLeft</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>UpperRight</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>LowerLeft</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>LowerRight</span>
<a name="line-52"></a>
<a name="line-53"></a><a name="banish"></a><span class='hs-comment'>{- | Move the mouse cursor to a corner of the focused window. Useful for
<a name="line-54"></a> uncluttering things.
<a name="line-55"></a>
<a name="line-56"></a> Internally, this uses numerical parameters. We parametrize on the 'Corner'
<a name="line-57"></a> type so the user need not see the violence inherent in
<a name="line-58"></a> the system.
<a name="line-59"></a>
<a name="line-60"></a> 'warpToScreen' and 'warpToWindow' can be used in a variety of
<a name="line-61"></a> ways. Suppose you wanted to emulate Ratpoison's \'banish\' command,
<a name="line-62"></a> which moves the mouse pointer to a corner? warpToWindow can do that! -}</span>
<a name="line-63"></a><span class='hs-definition'>banish</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Corner</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-64"></a><span class='hs-definition'>banish</span> <span class='hs-varid'>direction</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>direction</span> <span class='hs-keyword'>of</span>
<a name="line-65"></a> <span class='hs-conid'>LowerRight</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToWindow</span> <span class='hs-num'>1</span> <span class='hs-num'>1</span>
<a name="line-66"></a> <span class='hs-conid'>LowerLeft</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToWindow</span> <span class='hs-num'>0</span> <span class='hs-num'>1</span>
<a name="line-67"></a> <span class='hs-conid'>UpperLeft</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToWindow</span> <span class='hs-num'>0</span> <span class='hs-num'>0</span>
<a name="line-68"></a> <span class='hs-conid'>UpperRight</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToWindow</span> <span class='hs-num'>1</span> <span class='hs-num'>0</span>
<a name="line-69"></a>
<a name="line-70"></a><a name="banishScreen"></a><span class='hs-comment'>{- | Same as 'banish' but moves the mouse to the corner of the
<a name="line-71"></a> currently focused screen -}</span>
<a name="line-72"></a><span class='hs-definition'>banishScreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Corner</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-73"></a><span class='hs-definition'>banishScreen</span> <span class='hs-varid'>direction</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>direction</span> <span class='hs-keyword'>of</span>
<a name="line-74"></a> <span class='hs-conid'>LowerRight</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToCurrentScreen</span> <span class='hs-num'>1</span> <span class='hs-num'>1</span>
<a name="line-75"></a> <span class='hs-conid'>LowerLeft</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToCurrentScreen</span> <span class='hs-num'>0</span> <span class='hs-num'>1</span>
<a name="line-76"></a> <span class='hs-conid'>UpperLeft</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToCurrentScreen</span> <span class='hs-num'>0</span> <span class='hs-num'>0</span>
<a name="line-77"></a> <span class='hs-conid'>UpperRight</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>warpToCurrentScreen</span> <span class='hs-num'>1</span> <span class='hs-num'>0</span>
<a name="line-78"></a> <span class='hs-keyword'>where</span>
<a name="line-79"></a> <span class='hs-varid'>warpToCurrentScreen</span> <span class='hs-varid'>h</span> <span class='hs-varid'>v</span> <span class='hs-keyglyph'>=</span>
<a name="line-80"></a> <span class='hs-keyword'>do</span> <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-81"></a> <span class='hs-varid'>warpToScreen</span> <span class='hs-layout'>(</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'>current</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span> <span class='hs-varid'>h</span> <span class='hs-varid'>v</span>
<a name="line-82"></a> <span class='hs-varid'>windows</span> <span class='hs-layout'>(</span><span class='hs-varid'>const</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span>
<a name="line-83"></a>
<a name="line-84"></a>
<a name="line-85"></a><a name="fraction"></a><span class='hs-definition'>fraction</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Integral</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Integral</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Rational</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span>
<a name="line-86"></a><span class='hs-definition'>fraction</span> <span class='hs-varid'>f</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>floor</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varop'>*</span> <span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-87"></a>
<a name="line-88"></a><a name="warp"></a><span class='hs-definition'>warp</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Window</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Position</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Position</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-89"></a><span class='hs-definition'>warp</span> <span class='hs-varid'>w</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withDisplay</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>d</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>warpPointer</span> <span class='hs-varid'>d</span> <span class='hs-varid'>none</span> <span class='hs-varid'>w</span> <span class='hs-num'>0</span> <span class='hs-num'>0</span> <span class='hs-num'>0</span> <span class='hs-num'>0</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span>
<a name="line-90"></a>
<a name="line-91"></a><a name="warpToWindow"></a><span class='hs-comment'>-- | Warp the pointer to a given position relative to the currently</span>
<a name="line-92"></a><span class='hs-comment'>-- focused window. Top left = (0,0), bottom right = (1,1).</span>
<a name="line-93"></a><span class='hs-definition'>warpToWindow</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Rational</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Rational</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-94"></a><span class='hs-definition'>warpToWindow</span> <span class='hs-varid'>h</span> <span class='hs-varid'>v</span> <span class='hs-keyglyph'>=</span>
<a name="line-95"></a> <span class='hs-varid'>withDisplay</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>d</span> <span class='hs-keyglyph'>-></span>
<a name="line-96"></a> <span class='hs-varid'>withFocused</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-keyword'>do</span>
<a name="line-97"></a> <span class='hs-varid'>wa</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getWindowAttributes</span> <span class='hs-varid'>d</span> <span class='hs-varid'>w</span>
<a name="line-98"></a> <span class='hs-varid'>warp</span> <span class='hs-varid'>w</span> <span class='hs-layout'>(</span><span class='hs-varid'>fraction</span> <span class='hs-varid'>h</span> <span class='hs-layout'>(</span><span class='hs-varid'>wa_width</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>fraction</span> <span class='hs-varid'>v</span> <span class='hs-layout'>(</span><span class='hs-varid'>wa_height</span> <span class='hs-varid'>wa</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-99"></a>
<a name="line-100"></a><a name="warpToScreen"></a><span class='hs-comment'>-- | Warp the pointer to the given position (top left = (0,0), bottom</span>
<a name="line-101"></a><span class='hs-comment'>-- right = (1,1)) on the given screen.</span>
<a name="line-102"></a><span class='hs-definition'>warpToScreen</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ScreenId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Rational</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Rational</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-103"></a><span class='hs-definition'>warpToScreen</span> <span class='hs-varid'>n</span> <span class='hs-varid'>h</span> <span class='hs-varid'>v</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-104"></a> <span class='hs-varid'>root</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>asks</span> <span class='hs-varid'>theRoot</span>
<a name="line-105"></a> <span class='hs-layout'>(</span><span class='hs-conid'>StackSet</span> <span class='hs-layout'>{</span><span class='hs-varid'>current</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>x</span><span class='hs-layout'>,</span> <span class='hs-varid'>visible</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>xs</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>gets</span> <span class='hs-varid'>windowset</span>
<a name="line-106"></a> <span class='hs-varid'>whenJust</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</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-varop'>.</span> <span class='hs-varid'>find</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>n</span><span class='hs-varop'>==</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-varop'>$</span> <span class='hs-varid'>x</span> <span class='hs-conop'>:</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-107"></a> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span>
<a name="line-108"></a> <span class='hs-varid'>warp</span> <span class='hs-varid'>root</span> <span class='hs-layout'>(</span><span class='hs-varid'>rect_x</span> <span class='hs-varid'>r</span> <span class='hs-varop'>+</span> <span class='hs-varid'>fraction</span> <span class='hs-varid'>h</span> <span class='hs-layout'>(</span><span class='hs-varid'>rect_width</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-109"></a> <span class='hs-layout'>(</span><span class='hs-varid'>rect_y</span> <span class='hs-varid'>r</span> <span class='hs-varop'>+</span> <span class='hs-varid'>fraction</span> <span class='hs-varid'>v</span> <span class='hs-layout'>(</span><span class='hs-varid'>rect_height</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
</pre></body>
</html>
