<?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/Hooks/DebugKeyEvents.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.Hooks.DebugKeyEvents</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) 2011 Brandon S Allbery <allbery.b@gmail.com></span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : Brandon S Allbery <allbery.b@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 debugging module to track key events, useful when you can't tell whether</span>
<a name="line-12"></a><span class='hs-comment'>-- xmonad is processing some or all key events.</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'>Hooks</span><span class='hs-varop'>.</span><span class='hs-conid'>DebugKeyEvents</span> <span class='hs-layout'>(</span><span class='hs-comment'>-- * Usage</span>
<a name="line-16"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-17"></a> <span class='hs-varid'>debugKeyEvents</span>
<a name="line-18"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-19"></a>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span>
<a name="line-21"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Operations</span> <span class='hs-layout'>(</span><span class='hs-varid'>cleanMask</span><span class='hs-layout'>)</span>
<a name="line-22"></a>
<a name="line-23"></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'>Xlib</span>
<a name="line-24"></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'>Xlib</span><span class='hs-varop'>.</span><span class='hs-conid'>Extras</span>
<a name="line-25"></a>
<a name="line-26"></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'>State</span> <span class='hs-layout'>(</span><span class='hs-varid'>gets</span><span class='hs-layout'>)</span>
<a name="line-27"></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-28"></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'>intercalate</span><span class='hs-layout'>)</span>
<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'>Monoid</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Numeric</span> <span class='hs-layout'>(</span><span class='hs-varid'>showHex</span><span class='hs-layout'>)</span>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>hPutStrLn</span>
<a name="line-32"></a> <span class='hs-layout'>,</span><span class='hs-varid'>stderr</span><span class='hs-layout'>)</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-comment'>-- $usage</span>
<a name="line-35"></a><span class='hs-comment'>-- Add this to your handleEventHook to print received key events to the</span>
<a name="line-36"></a><span class='hs-comment'>-- log (the console if you use @startx@/@xinit@, otherwise usually</span>
<a name="line-37"></a><span class='hs-comment'>-- @~/.xsession-errors@).</span>
<a name="line-38"></a><span class='hs-comment'>--</span>
<a name="line-39"></a><span class='hs-comment'>-- > , handleEventHook = debugKeyEvents</span>
<a name="line-40"></a><span class='hs-comment'>--</span>
<a name="line-41"></a><span class='hs-comment'>-- If you already have a handleEventHook then you should append it:</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></a><span class='hs-comment'>-- > , handleEventHook = ... <+> debugKeyEvents</span>
<a name="line-44"></a><span class='hs-comment'>--</span>
<a name="line-45"></a><span class='hs-comment'>-- Logged key events look like:</span>
<a name="line-46"></a><span class='hs-comment'>--</span>
<a name="line-47"></a><span class='hs-comment'>-- @keycode 53 sym 120 (0x78, "x") mask 0x0 () clean 0x0 ()@</span>
<a name="line-48"></a><span class='hs-comment'>--</span>
<a name="line-49"></a><span class='hs-comment'>-- The @mask@ and @clean@ indicate the modifiers pressed along with</span>
<a name="line-50"></a><span class='hs-comment'>-- the key; @mask@ is raw, and @clean@ is what @xmonad@ sees after</span>
<a name="line-51"></a><span class='hs-comment'>-- sanitizing it (removing @numberLockMask@, etc.)</span>
<a name="line-52"></a><span class='hs-comment'>--</span>
<a name="line-53"></a><span class='hs-comment'>-- For more detailed instructions on editing the logHook see:</span>
<a name="line-54"></a><span class='hs-comment'>--</span>
<a name="line-55"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#The_log_hook_and_external_status_bars"</span>
<a name="line-56"></a>
<a name="line-57"></a><a name="debugKeyEvents"></a><span class='hs-comment'>-- | Print key events to stderr for debugging</span>
<a name="line-58"></a><span class='hs-definition'>debugKeyEvents</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Event</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>All</span>
<a name="line-59"></a><span class='hs-definition'>debugKeyEvents</span> <span class='hs-layout'>(</span><span class='hs-conid'>KeyEvent</span> <span class='hs-layout'>{</span><span class='hs-varid'>ev_event_type</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</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-varid'>ev_keycode</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>code</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span>
<a name="line-60"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>t</span> <span class='hs-varop'>==</span> <span class='hs-varid'>keyPress</span> <span class='hs-keyglyph'>=</span>
<a name="line-61"></a> <span class='hs-varid'>withDisplay</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>dpy</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-62"></a> <span class='hs-varid'>sym</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>keycodeToKeysym</span> <span class='hs-varid'>dpy</span> <span class='hs-varid'>code</span> <span class='hs-num'>0</span>
<a name="line-63"></a> <span class='hs-varid'>msk</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>cleanMask</span> <span class='hs-varid'>m</span>
<a name="line-64"></a> <span class='hs-varid'>nl</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>gets</span> <span class='hs-varid'>numberlockMask</span>
<a name="line-65"></a> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>hPutStrLn</span> <span class='hs-varid'>stderr</span> <span class='hs-varop'>$</span> <span class='hs-varid'>intercalate</span> <span class='hs-str'>" "</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"keycode"</span>
<a name="line-66"></a> <span class='hs-layout'>,</span><span class='hs-varid'>show</span> <span class='hs-varid'>code</span>
<a name="line-67"></a> <span class='hs-layout'>,</span><span class='hs-str'>"sym"</span>
<a name="line-68"></a> <span class='hs-layout'>,</span><span class='hs-varid'>show</span> <span class='hs-varid'>sym</span>
<a name="line-69"></a> <span class='hs-layout'>,</span><span class='hs-str'>" ("</span>
<a name="line-70"></a> <span class='hs-layout'>,</span><span class='hs-varid'>hex</span> <span class='hs-varid'>sym</span>
<a name="line-71"></a> <span class='hs-layout'>,</span><span class='hs-str'>" \""</span>
<a name="line-72"></a> <span class='hs-layout'>,</span><span class='hs-varid'>keysymToString</span> <span class='hs-varid'>sym</span>
<a name="line-73"></a> <span class='hs-layout'>,</span><span class='hs-str'>"\") mask"</span>
<a name="line-74"></a> <span class='hs-layout'>,</span><span class='hs-varid'>hex</span> <span class='hs-varid'>m</span>
<a name="line-75"></a> <span class='hs-layout'>,</span><span class='hs-str'>"("</span> <span class='hs-varop'>++</span> <span class='hs-varid'>vmask</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>m</span> <span class='hs-varop'>++</span> <span class='hs-str'>")"</span>
<a name="line-76"></a> <span class='hs-layout'>,</span><span class='hs-str'>"clean"</span>
<a name="line-77"></a> <span class='hs-layout'>,</span><span class='hs-varid'>hex</span> <span class='hs-varid'>msk</span>
<a name="line-78"></a> <span class='hs-layout'>,</span><span class='hs-str'>"("</span> <span class='hs-varop'>++</span> <span class='hs-varid'>vmask</span> <span class='hs-varid'>nl</span> <span class='hs-varid'>msk</span> <span class='hs-varop'>++</span> <span class='hs-str'>")"</span>
<a name="line-79"></a> <span class='hs-keyglyph'>]</span>
<a name="line-80"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>All</span> <span class='hs-conid'>True</span><span class='hs-layout'>)</span>
<a name="line-81"></a><span class='hs-definition'>debugKeyEvents</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-conid'>All</span> <span class='hs-conid'>True</span><span class='hs-layout'>)</span>
<a name="line-82"></a>
<a name="line-83"></a><a name="hex"></a><span class='hs-comment'>-- | Convenient showHex variant</span>
<a name="line-84"></a><span class='hs-definition'>hex</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Integral</span> <span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>n</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-85"></a><span class='hs-definition'>hex</span> <span class='hs-varid'>v</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"0x"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>showHex</span> <span class='hs-varid'>v</span> <span class='hs-str'>""</span>
<a name="line-86"></a>
<a name="line-87"></a><a name="vmask"></a><span class='hs-comment'>-- | Convert a modifier mask into a useful string</span>
<a name="line-88"></a><span class='hs-definition'>vmask</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>KeyMask</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>KeyMask</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span>
<a name="line-89"></a><span class='hs-definition'>vmask</span> <span class='hs-varid'>numLockMask</span> <span class='hs-varid'>msk</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>intercalate</span> <span class='hs-str'>" "</span> <span class='hs-varop'>$</span>
<a name="line-90"></a> <span class='hs-varid'>reverse</span> <span class='hs-varop'>$</span>
<a name="line-91"></a> <span class='hs-varid'>fst</span> <span class='hs-varop'>$</span>
<a name="line-92"></a> <span class='hs-varid'>foldr</span> <span class='hs-varid'>vmask'</span> <span class='hs-layout'>(</span><span class='hs-conid'>[]</span><span class='hs-layout'>,</span><span class='hs-varid'>msk</span><span class='hs-layout'>)</span> <span class='hs-varid'>masks</span>
<a name="line-93"></a> <span class='hs-keyword'>where</span>
<a name="line-94"></a> <span class='hs-varid'>masks</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-varid'>m</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>m</span><span class='hs-layout'>,</span><span class='hs-varid'>show</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>0</span><span class='hs-keyglyph'>..</span><span class='hs-varid'>toEnum</span> <span class='hs-layout'>(</span><span class='hs-varid'>bitSize</span> <span class='hs-varid'>msk</span> <span class='hs-comment'>-</span> <span class='hs-num'>1</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-varop'>++</span>
<a name="line-95"></a> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-varid'>numLockMask</span><span class='hs-layout'>,</span><span class='hs-str'>"num"</span> <span class='hs-layout'>)</span>
<a name="line-96"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span> <span class='hs-varid'>lockMask</span><span class='hs-layout'>,</span><span class='hs-str'>"lock"</span> <span class='hs-layout'>)</span>
<a name="line-97"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span><span class='hs-varid'>controlMask</span><span class='hs-layout'>,</span><span class='hs-str'>"ctrl"</span> <span class='hs-layout'>)</span>
<a name="line-98"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span> <span class='hs-varid'>shiftMask</span><span class='hs-layout'>,</span><span class='hs-str'>"shift"</span><span class='hs-layout'>)</span>
<a name="line-99"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span> <span class='hs-varid'>mod5Mask</span><span class='hs-layout'>,</span><span class='hs-str'>"mod5"</span> <span class='hs-layout'>)</span>
<a name="line-100"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span> <span class='hs-varid'>mod4Mask</span><span class='hs-layout'>,</span><span class='hs-str'>"mod4"</span> <span class='hs-layout'>)</span>
<a name="line-101"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span> <span class='hs-varid'>mod3Mask</span><span class='hs-layout'>,</span><span class='hs-str'>"mod3"</span> <span class='hs-layout'>)</span>
<a name="line-102"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span> <span class='hs-varid'>mod2Mask</span><span class='hs-layout'>,</span><span class='hs-str'>"mod2"</span> <span class='hs-layout'>)</span>
<a name="line-103"></a> <span class='hs-layout'>,</span><span class='hs-layout'>(</span> <span class='hs-varid'>mod1Mask</span><span class='hs-layout'>,</span><span class='hs-str'>"mod1"</span> <span class='hs-layout'>)</span>
<a name="line-104"></a> <span class='hs-keyglyph'>]</span>
<a name="line-105"></a> <span class='hs-varid'>vmask'</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-num'>0</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>a</span>
<a name="line-106"></a> <span class='hs-varid'>vmask'</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-layout'>(</span><span class='hs-varid'>ss</span><span class='hs-layout'>,</span><span class='hs-varid'>v</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>v</span> <span class='hs-varop'>.&.</span> <span class='hs-varid'>m</span> <span class='hs-varop'>==</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>s</span><span class='hs-conop'>:</span><span class='hs-varid'>ss</span><span class='hs-layout'>,</span><span class='hs-varid'>v</span> <span class='hs-varop'>.&.</span> <span class='hs-varid'>complement</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-107"></a> <span class='hs-varid'>vmask'</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>r</span>
</pre></body>
</html>
