<?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/MessageFeedback.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.MessageFeedback</span> <a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Quentin Moser <quentin.moser@unifr.ch></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 : None</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'>-- Alternative to 'XMonad.Operations.sendMessage' that provides knowledge</span> <a name="line-12"></a><span class='hs-comment'>-- of whether the message was handled, and utility functions based on</span> <a name="line-13"></a><span class='hs-comment'>-- this facility.</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'>Actions</span><span class='hs-varop'>.</span><span class='hs-conid'>MessageFeedback</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> <a name="line-20"></a> <span class='hs-varid'>send</span> <a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>tryMessage</span> <a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>tryMessage_</span> <a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>tryInOrder</span> <a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>tryInOrder_</span> <a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sm</span> <a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sendSM</span> <a name="line-27"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sendSM_</span> <a name="line-28"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-29"></a> <a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</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-conid'>Message</span><span class='hs-layout'>,</span> <span class='hs-conid'>SomeMessage</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>LayoutClass</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>windowset</span><span class='hs-layout'>,</span> <span class='hs-varid'>catchX</span> <span class='hs-layout'>)</span> <a name="line-31"></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-layout'>(</span> <span class='hs-varid'>current</span><span class='hs-layout'>,</span> <span class='hs-varid'>workspace</span><span class='hs-layout'>,</span> <span class='hs-varid'>layout</span><span class='hs-layout'>,</span> <span class='hs-varid'>tag</span> <span class='hs-layout'>)</span> <a name="line-32"></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'>updateLayout</span> <span class='hs-layout'>)</span> <a name="line-33"></a> <a name="line-34"></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-35"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span> <span class='hs-varid'>isJust</span> <span class='hs-layout'>)</span> <a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Applicative</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-37"></a> <a name="line-38"></a><span class='hs-comment'>-- $usage</span> <a name="line-39"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span> <a name="line-40"></a><span class='hs-comment'>--</span> <a name="line-41"></a><span class='hs-comment'>-- > import XMonad.Actions.MessageFeedback</span> <a name="line-42"></a><span class='hs-comment'>--</span> <a name="line-43"></a><span class='hs-comment'>-- You can then use this module's functions wherever an action is expected.</span> <a name="line-44"></a><span class='hs-comment'>--</span> <a name="line-45"></a><span class='hs-comment'>-- Note that most functions in this module have a return type of @X Bool@</span> <a name="line-46"></a><span class='hs-comment'>-- whereas configuration options will expect a @X ()@ action.</span> <a name="line-47"></a><span class='hs-comment'>-- For example, the key binding</span> <a name="line-48"></a><span class='hs-comment'>--</span> <a name="line-49"></a><span class='hs-comment'>-- > -- Shrink the master area of a tiled layout, or move the focused window</span> <a name="line-50"></a><span class='hs-comment'>-- > -- to the left in a WindowArranger-based layout</span> <a name="line-51"></a><span class='hs-comment'>-- > ((modKey, xK_Left), tryMessage Shrink (MoveLeft 50))</span> <a name="line-52"></a><span class='hs-comment'>--</span> <a name="line-53"></a><span class='hs-comment'>-- is mis-typed. For this reason, this module provides alternatives (ending with</span> <a name="line-54"></a><span class='hs-comment'>-- an underscore, e.g. tryMessage_) that discard their result and return an @X ()@.</span> <a name="line-55"></a><span class='hs-comment'>-- For example, to correct the previous example:</span> <a name="line-56"></a><span class='hs-comment'>--</span> <a name="line-57"></a><span class='hs-comment'>-- > ((modKey, xK_Left), tryMessage_ Shrink (MoveLeft 50))</span> <a name="line-58"></a><span class='hs-comment'>--</span> <a name="line-59"></a> <a name="line-60"></a> <a name="line-61"></a><a name="send"></a><span class='hs-comment'>-- | Behaves like 'XMonad.Operations.sendMessage', but returns True of the</span> <a name="line-62"></a><span class='hs-comment'>-- message was handled by the layout, False otherwise.</span> <a name="line-63"></a><span class='hs-definition'>send</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Message</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span> <a name="line-64"></a><span class='hs-definition'>send</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sendSM</span> <span class='hs-varop'>.</span> <span class='hs-varid'>sm</span> <a name="line-65"></a> <a name="line-66"></a><a name="tryMessage"></a><span class='hs-comment'>-- | Sends the first message, and if it was not handled, sends the second.</span> <a name="line-67"></a><span class='hs-comment'>-- Returns True if either message was handled, False otherwise.</span> <a name="line-68"></a><span class='hs-definition'>tryMessage</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Message</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Message</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span> <a name="line-69"></a><span class='hs-definition'>tryMessage</span> <span class='hs-varid'>m1</span> <span class='hs-varid'>m2</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>send</span> <span class='hs-varid'>m1</span> <a name="line-70"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>b</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>True</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>send</span> <span class='hs-varid'>m2</span> <a name="line-71"></a> <a name="line-72"></a><a name="tryMessage_"></a><span class='hs-definition'>tryMessage_</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Message</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Message</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>b</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'>tryMessage_</span> <span class='hs-varid'>m1</span> <span class='hs-varid'>m2</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tryMessage</span> <span class='hs-varid'>m1</span> <span class='hs-varid'>m2</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span> <a name="line-74"></a> <a name="line-75"></a><a name="tryInOrder"></a><span class='hs-comment'>-- | Tries sending every message of the list in order until one of them</span> <a name="line-76"></a><span class='hs-comment'>-- is handled. Returns True if one of the messages was handled, False otherwise.</span> <a name="line-77"></a><span class='hs-definition'>tryInOrder</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SomeMessage</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span> <a name="line-78"></a><span class='hs-definition'>tryInOrder</span> <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-conid'>False</span> <a name="line-79"></a><span class='hs-definition'>tryInOrder</span> <span class='hs-layout'>(</span><span class='hs-varid'>m</span><span class='hs-conop'>:</span><span class='hs-varid'>ms</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>sendSM</span> <span class='hs-varid'>m</span> <a name="line-80"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>b</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>return</span> <span class='hs-conid'>True</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>tryInOrder</span> <span class='hs-varid'>ms</span> <a name="line-81"></a> <a name="line-82"></a><a name="tryInOrder_"></a><span class='hs-definition'>tryInOrder_</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SomeMessage</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'>tryInOrder_</span> <span class='hs-varid'>ms</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tryInOrder</span> <span class='hs-varid'>ms</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span> <a name="line-84"></a> <a name="line-85"></a> <a name="line-86"></a><a name="sm"></a><span class='hs-comment'>-- | Convenience shorthand for 'XMonad.Core.SomeMessage'.</span> <a name="line-87"></a><span class='hs-definition'>sm</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Message</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SomeMessage</span> <a name="line-88"></a><span class='hs-definition'>sm</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>SomeMessage</span> <a name="line-89"></a> <a name="line-90"></a> <a name="line-91"></a><a name="sendSM"></a><span class='hs-definition'>sendSM</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SomeMessage</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span> <a name="line-92"></a><span class='hs-definition'>sendSM</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>workspace</span> <span class='hs-varop'>.</span> <span class='hs-varid'>current</span> <span class='hs-varop'><$></span> <span class='hs-varid'>gets</span> <span class='hs-varid'>windowset</span> <a name="line-93"></a> <span class='hs-varid'>ml'</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>handleMessage</span> <span class='hs-layout'>(</span><span class='hs-varid'>layout</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-varid'>m</span> <span class='hs-varop'>`catchX`</span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span> <a name="line-94"></a> <span class='hs-varid'>updateLayout</span> <span class='hs-layout'>(</span><span class='hs-varid'>tag</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-varid'>ml'</span> <a name="line-95"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>isJust</span> <span class='hs-varid'>ml'</span> <a name="line-96"></a> <a name="line-97"></a> <a name="line-98"></a><a name="sendSM_"></a><span class='hs-definition'>sendSM_</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SomeMessage</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span> <a name="line-99"></a><span class='hs-definition'>sendSM_</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sendSM</span> <span class='hs-varid'>m</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span> </pre></body> </html>
