<?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/Submap.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.Submap</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Jason Creighton <jcreigh@gmail.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 : Jason Creighton <jcreigh@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 module that allows the user to create a sub-mapping of key bindings.</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'>Submap</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'>submap</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-varid'>submapDefault</span>
<a name="line-20"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Bits</span>
<a name="line-22"></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'>keys</span><span class='hs-layout'>)</span>
<a name="line-23"></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-24"></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'>Fix</span> <span class='hs-layout'>(</span><span class='hs-varid'>fix</span><span class='hs-layout'>)</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-comment'>{- $usage
<a name="line-27"></a>
<a name="line-28"></a>
<a name="line-29"></a>
<a name="line-30"></a>
<a name="line-31"></a>First, import this module into your @~\/.xmonad\/xmonad.hs@:
<a name="line-32"></a>
<a name="line-33"></a>> import XMonad.Actions.Submap
<a name="line-34"></a>
<a name="line-35"></a>Allows you to create a sub-mapping of keys. Example:
<a name="line-36"></a>
<a name="line-37"></a>> , ((modm, xK_a), submap . M.fromList $
<a name="line-38"></a>> [ ((0, xK_n), spawn "mpc next")
<a name="line-39"></a>> , ((0, xK_p), spawn "mpc prev")
<a name="line-40"></a>> , ((0, xK_z), spawn "mpc random")
<a name="line-41"></a>> , ((0, xK_space), spawn "mpc toggle")
<a name="line-42"></a>> ])
<a name="line-43"></a>
<a name="line-44"></a>So, for example, to run 'spawn \"mpc next\"', you would hit mod-a (to
<a name="line-45"></a>trigger the submapping) and then 'n' to run that action. (0 means \"no
<a name="line-46"></a>modifier\"). You are, of course, free to use any combination of
<a name="line-47"></a>modifiers in the submapping. However, anyModifier will not work,
<a name="line-48"></a>because that is a special value passed to XGrabKey() and not an actual
<a name="line-49"></a>modifier.
<a name="line-50"></a>
<a name="line-51"></a>For detailed instructions on editing your key bindings, see
<a name="line-52"></a>"XMonad.Doc.Extending#Editing_key_bindings".
<a name="line-53"></a>
<a name="line-54"></a>-}</span>
<a name="line-55"></a>
<a name="line-56"></a><a name="submap"></a><span class='hs-comment'>-- | Given a 'Data.Map.Map' from key bindings to X () actions, return</span>
<a name="line-57"></a><span class='hs-comment'>-- an action which waits for a user keypress and executes the</span>
<a name="line-58"></a><span class='hs-comment'>-- corresponding action, or does nothing if the key is not found in</span>
<a name="line-59"></a><span class='hs-comment'>-- the map.</span>
<a name="line-60"></a><span class='hs-definition'>submap</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>M</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-layout'>(</span><span class='hs-conid'>KeyMask</span><span class='hs-layout'>,</span> <span class='hs-conid'>KeySym</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>X</span> <span class='hs-conid'>()</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-61"></a><span class='hs-definition'>submap</span> <span class='hs-varid'>keys</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>submapDefault</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-varid'>keys</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="submapDefault"></a><span class='hs-comment'>-- | Like 'submap', but executes a default action if the key did not match.</span>
<a name="line-64"></a><span class='hs-definition'>submapDefault</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>M</span><span class='hs-varop'>.</span><span class='hs-conid'>Map</span> <span class='hs-layout'>(</span><span class='hs-conid'>KeyMask</span><span class='hs-layout'>,</span> <span class='hs-conid'>KeySym</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>X</span> <span class='hs-conid'>()</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-65"></a><span class='hs-definition'>submapDefault</span> <span class='hs-varid'>def</span> <span class='hs-varid'>keys</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-66"></a> <span class='hs-conid'>XConf</span> <span class='hs-layout'>{</span> <span class='hs-varid'>theRoot</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>root</span><span class='hs-layout'>,</span> <span class='hs-varid'>display</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>d</span> <span class='hs-layout'>}</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>ask</span>
<a name="line-67"></a>
<a name="line-68"></a> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>grabKeyboard</span> <span class='hs-varid'>d</span> <span class='hs-varid'>root</span> <span class='hs-conid'>False</span> <span class='hs-varid'>grabModeAsync</span> <span class='hs-varid'>grabModeAsync</span> <span class='hs-varid'>currentTime</span>
<a name="line-69"></a>
<a name="line-70"></a> <span class='hs-layout'>(</span><span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>allocaXEvent</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>p</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>fix</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>nextkey</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-71"></a> <span class='hs-varid'>maskEvent</span> <span class='hs-varid'>d</span> <span class='hs-varid'>keyPressMask</span> <span class='hs-varid'>p</span>
<a name="line-72"></a> <span class='hs-conid'>KeyEvent</span> <span class='hs-layout'>{</span> <span class='hs-varid'>ev_keycode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>code</span><span class='hs-layout'>,</span> <span class='hs-varid'>ev_state</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>m</span> <span class='hs-layout'>}</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getEvent</span> <span class='hs-varid'>p</span>
<a name="line-73"></a> <span class='hs-varid'>keysym</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>keycodeToKeysym</span> <span class='hs-varid'>d</span> <span class='hs-varid'>code</span> <span class='hs-num'>0</span>
<a name="line-74"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>isModifierKey</span> <span class='hs-varid'>keysym</span>
<a name="line-75"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>nextkey</span>
<a name="line-76"></a> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-varid'>keysym</span><span class='hs-layout'>)</span>
<a name="line-77"></a> <span class='hs-comment'>-- Remove num lock mask and Xkb group state bits</span>
<a name="line-78"></a> <span class='hs-varid'>m'</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>cleanMask</span> <span class='hs-varop'>$</span> <span class='hs-varid'>m</span> <span class='hs-varop'>.&.</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-num'>1</span> <span class='hs-varop'>`shiftL`</span> <span class='hs-num'>12</span><span class='hs-layout'>)</span> <span class='hs-comment'>-</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span>
<a name="line-79"></a> <span class='hs-varid'>maybe</span> <span class='hs-varid'>def</span> <span class='hs-varid'>id</span> <span class='hs-layout'>(</span><span class='hs-conid'>M</span><span class='hs-varop'>.</span><span class='hs-varid'>lookup</span> <span class='hs-layout'>(</span><span class='hs-varid'>m'</span><span class='hs-layout'>,</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-varid'>keys</span><span class='hs-layout'>)</span>
<a name="line-80"></a>
<a name="line-81"></a> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>ungrabKeyboard</span> <span class='hs-varid'>d</span> <span class='hs-varid'>currentTime</span>
</pre></body>
</html>
