<?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/Layout/MessageControl.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE FlexibleInstances, MultiParamTypeClasses, DeriveDataTypeable #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-4"></a><span class='hs-comment'>-- |</span>
<a name="line-5"></a><span class='hs-comment'>-- Module : XMonad.Layout.MessageControl</span>
<a name="line-6"></a><span class='hs-comment'>-- Copyright : (c) 2008 Quentin Moser</span>
<a name="line-7"></a><span class='hs-comment'>-- License : BSD3</span>
<a name="line-8"></a><span class='hs-comment'>--</span>
<a name="line-9"></a><span class='hs-comment'>-- Maintainer : <quentin.moser@unifr.ch></span>
<a name="line-10"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-11"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-12"></a><span class='hs-comment'>--</span>
<a name="line-13"></a><span class='hs-comment'>-- Provides message \"escaping\" and filtering facilities which</span>
<a name="line-14"></a><span class='hs-comment'>-- help control complex nested layouts.</span>
<a name="line-15"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>MessageControl</span> <span class='hs-layout'>(</span>
<a name="line-18"></a> <span class='hs-comment'>-- * Usage</span>
<a name="line-19"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-20"></a> <span class='hs-conid'>Ignore</span><span class='hs-conid'>()</span>
<a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>ignore</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>UnEscape</span><span class='hs-conid'>()</span>
<a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>unEscape</span>
<a name="line-24"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>EscapedMessage</span><span class='hs-layout'>(</span><span class='hs-conid'>Escape</span><span class='hs-layout'>)</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>escape</span>
<a name="line-26"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-27"></a>
<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'>Core</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>
<a name="line-29"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>fromMessage</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>
<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'>StackSet</span> <span class='hs-layout'>(</span><span class='hs-conid'>Workspace</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-31"></a>
<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'>Layout</span><span class='hs-varop'>.</span><span class='hs-conid'>LayoutModifier</span> <span class='hs-layout'>(</span><span class='hs-conid'>LayoutModifier</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'>ModifiedLayout</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</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'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-35"></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-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Arrow</span> <span class='hs-layout'>(</span><span class='hs-varid'>second</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 by importing it into your @~\/.xmonad\/xmonad.hs@ file:</span>
<a name="line-40"></a><span class='hs-comment'>--</span>
<a name="line-41"></a><span class='hs-comment'>-- > import XMonad.Layout.MessageEscape</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></a><span class='hs-comment'>-- Then, if you use a modified layout where the modifier would intercept</span>
<a name="line-44"></a><span class='hs-comment'>-- a message, but you'd want to be able to send it to the inner layout </span>
<a name="line-45"></a><span class='hs-comment'>-- only, add the 'unEscape' modifier to the inner layout like so:</span>
<a name="line-46"></a><span class='hs-comment'>--</span>
<a name="line-47"></a><span class='hs-comment'>-- > import XMonad.Layout.Master (mastered)</span>
<a name="line-48"></a><span class='hs-comment'>-- > import XMonad.Layout.Tabbed (simpleTabbed)</span>
<a name="line-49"></a><span class='hs-comment'>-- > import XMonad.Layout.LayoutCombinators ((|||))</span>
<a name="line-50"></a><span class='hs-comment'>-- ></span>
<a name="line-51"></a><span class='hs-comment'>-- > myLayout = Tall ||| unEscape (mastered 0.01 0.5 $ Full ||| simpleTabbed)</span>
<a name="line-52"></a><span class='hs-comment'>--</span>
<a name="line-53"></a><span class='hs-comment'>-- you can now send a message to the inner layout with</span>
<a name="line-54"></a><span class='hs-comment'>-- @sendMessage $ escape message@, e.g.</span>
<a name="line-55"></a><span class='hs-comment'>--</span>
<a name="line-56"></a><span class='hs-comment'>-- > -- Change the inner layout</span>
<a name="line-57"></a><span class='hs-comment'>-- > ((modm .|. controlMask, xK_space), sendMessage $ escape NextLayout)</span>
<a name="line-58"></a><span class='hs-comment'>--</span>
<a name="line-59"></a><span class='hs-comment'>-- If you want unescaped messages to be handled /only/ by the enclosing</span>
<a name="line-60"></a><span class='hs-comment'>-- layout, use the 'ignore' modifier:</span>
<a name="line-61"></a><span class='hs-comment'>--</span>
<a name="line-62"></a><span class='hs-comment'>-- > myLayout = Tall ||| (ignore NextLayout $ ignore (JumpToLayout "") $</span>
<a name="line-63"></a><span class='hs-comment'>-- > unEscape $ mastered 0.01 0.5 </span>
<a name="line-64"></a><span class='hs-comment'>-- > $ Full ||| simpleTabbed)</span>
<a name="line-65"></a><span class='hs-comment'>--</span>
<a name="line-66"></a><span class='hs-comment'>-- /IMPORTANT NOTE:/ The standard '(|||)' operator from "XMonad.Layout"</span>
<a name="line-67"></a><span class='hs-comment'>-- does not behave correctly with 'ignore'. Make sure you use the one</span>
<a name="line-68"></a><span class='hs-comment'>-- from "XMonad.Layout.LayoutCombinators".</span>
<a name="line-69"></a>
<a name="line-70"></a><span class='hs-comment'>-- | the Ignore layout modifier. Prevents its inner layout from receiving</span>
<a name="line-71"></a><span class='hs-comment'>-- messages of a certain type.</span>
<a name="line-72"></a>
<a name="line-73"></a><a name="Ignore"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Ignore</span> <span class='hs-varid'>m</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>I</span> <span class='hs-layout'>(</span><span class='hs-varid'>l</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span>
<a name="line-74"></a> <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'>Read</span><span class='hs-layout'>)</span>
<a name="line-75"></a>
<a name="line-76"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span><span class='hs-conid'>Message</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>LayoutClass</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>LayoutClass</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ignore</span> <span class='hs-varid'>m</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-varid'>w</span> <span class='hs-keyword'>where</span>
<a name="line-77"></a> <span class='hs-varid'>runLayout</span> <span class='hs-varid'>ws</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>second</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span> <span class='hs-varop'><$></span><span class='hs-layout'>)</span> <span class='hs-varop'><$></span> <span class='hs-varid'>runLayout</span> <span class='hs-layout'>(</span><span class='hs-varid'>unILayout</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span> <span class='hs-varid'>r</span>
<a name="line-78"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>unILayout</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Workspace</span> <span class='hs-varid'>i</span> <span class='hs-layout'>(</span><span class='hs-conid'>Ignore</span> <span class='hs-varid'>m</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Workspace</span> <span class='hs-varid'>i</span> <span class='hs-layout'>(</span><span class='hs-varid'>l</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span> <span class='hs-varid'>w</span>
<a name="line-79"></a> <span class='hs-varid'>unILayout</span> <span class='hs-varid'>w</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>Workspace</span> <span class='hs-layout'>{</span> <span class='hs-varid'>layout</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>w</span> <span class='hs-layout'>{</span> <span class='hs-varid'>layout</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>l</span> <span class='hs-layout'>}</span>
<a name="line-80"></a> <span class='hs-varid'>handleMessage</span> <span class='hs-varid'>l</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>I</span> <span class='hs-varid'>l'</span><span class='hs-layout'>)</span> <span class='hs-varid'>sm</span>
<a name="line-81"></a> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>fromMessageAs</span> <span class='hs-varid'>sm</span> <span class='hs-varid'>l</span> <span class='hs-keyword'>of</span>
<a name="line-82"></a> <span class='hs-conid'>Just</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>Nothing</span>
<a name="line-83"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span> <span class='hs-varop'><$></span><span class='hs-layout'>)</span> <span class='hs-varop'><$></span> <span class='hs-varid'>handleMessage</span> <span class='hs-varid'>l'</span> <span class='hs-varid'>sm</span>
<a name="line-84"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>fromMessageAs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Message</span> <span class='hs-varid'>m'</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>SomeMessage</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Ignore</span> <span class='hs-varid'>m'</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Maybe</span> <span class='hs-varid'>m'</span>
<a name="line-85"></a> <span class='hs-varid'>fromMessageAs</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromMessage</span> <span class='hs-varid'>a</span>
<a name="line-86"></a> <span class='hs-varid'>description</span> <span class='hs-layout'>(</span><span class='hs-conid'>I</span> <span class='hs-varid'>l</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"Ignore "</span><span class='hs-varop'>++</span><span class='hs-varid'>description</span> <span class='hs-varid'>l</span>
<a name="line-87"></a>
<a name="line-88"></a><span class='hs-comment'>-- | the UnEscape layout modifier. Listens to 'EscapedMessage's and sends</span>
<a name="line-89"></a><span class='hs-comment'>-- their nested message to the inner layout.</span>
<a name="line-90"></a>
<a name="line-91"></a><a name="UnEscape"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>UnEscape</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>UE</span>
<a name="line-92"></a> <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'>Read</span><span class='hs-layout'>)</span>
<a name="line-93"></a>
<a name="line-94"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>LayoutModifier</span> <span class='hs-conid'>UnEscape</span> <span class='hs-varid'>a</span> <span class='hs-keyword'>where</span>
<a name="line-95"></a> <span class='hs-varid'>handleMessOrMaybeModifyIt</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>mess</span>
<a name="line-96"></a> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>fromMessage</span> <span class='hs-varid'>mess</span> <span class='hs-keyword'>of</span>
<a name="line-97"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>Escape</span> <span class='hs-varid'>mess'</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Just</span> <span class='hs-varop'>$</span> <span class='hs-conid'>Right</span> <span class='hs-varid'>mess'</span>
<a name="line-98"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Nothing</span>
<a name="line-99"></a>
<a name="line-100"></a>
<a name="line-101"></a><span class='hs-comment'>-- | Data type for an escaped message. Send with 'escape'.</span>
<a name="line-102"></a>
<a name="line-103"></a><a name="EscapedMessage"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>EscapedMessage</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Escape</span> <span class='hs-conid'>SomeMessage</span>
<a name="line-104"></a> <span class='hs-keyword'>deriving</span> <span class='hs-conid'>Typeable</span>
<a name="line-105"></a>
<a name="line-106"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Message</span> <span class='hs-conid'>EscapedMessage</span>
<a name="line-107"></a>
<a name="line-108"></a>
<a name="line-109"></a><span class='hs-comment'>-- | Creates an 'EscapedMessage'.</span>
<a name="line-110"></a>
<a name="line-111"></a><a name="escape"></a><span class='hs-definition'>escape</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Message</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>EscapedMessage</span>
<a name="line-112"></a><span class='hs-definition'>escape</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Escape</span> <span class='hs-varop'>.</span> <span class='hs-conid'>SomeMessage</span>
<a name="line-113"></a>
<a name="line-114"></a>
<a name="line-115"></a><span class='hs-comment'>-- | Applies the UnEscape layout modifier to a layout.</span>
<a name="line-116"></a>
<a name="line-117"></a><a name="unEscape"></a><span class='hs-definition'>unEscape</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>LayoutClass</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>UnEscape</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span>
<a name="line-118"></a><span class='hs-definition'>unEscape</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ModifiedLayout</span> <span class='hs-conid'>UE</span> <span class='hs-varid'>l</span>
<a name="line-119"></a>
<a name="line-120"></a>
<a name="line-121"></a><span class='hs-comment'>-- | Applies the Ignore layout modifier to a layout, blocking</span>
<a name="line-122"></a><span class='hs-comment'>-- all messages of the same type as the one passed as its first argument.</span>
<a name="line-123"></a>
<a name="line-124"></a><a name="ignore"></a><span class='hs-definition'>ignore</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Message</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>LayoutClass</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span>
<a name="line-125"></a> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>Ignore</span> <span class='hs-varid'>m</span> <span class='hs-varid'>l</span> <span class='hs-varid'>w</span><span class='hs-layout'>)</span>
<a name="line-126"></a><span class='hs-definition'>ignore</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>l</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>I</span> <span class='hs-varid'>l</span>
</pre></body>
</html>
