<?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/Util/WindowProperties.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.Util.WindowProperties</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) Roman Cheplyaka</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD-style (see LICENSE)</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : Roman Cheplyaka <roma@ro-che.info></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'>-- EDSL for specifying window properties; various utilities related to window</span>
<a name="line-12"></a><span class='hs-comment'>-- properties.</span>
<a name="line-13"></a><span class='hs-comment'>--</span>
<a name="line-14"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<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'>Util</span><span class='hs-varop'>.</span><span class='hs-conid'>WindowProperties</span> <span class='hs-layout'>(</span>
<a name="line-16"></a> <span class='hs-comment'>-- * EDSL for window properties</span>
<a name="line-17"></a> <span class='hs-comment'>-- $edsl</span>
<a name="line-18"></a> <span class='hs-conid'>Property</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'>hasProperty</span><span class='hs-layout'>,</span> <span class='hs-varid'>focusedHasProperty</span><span class='hs-layout'>,</span> <span class='hs-varid'>allWithProperty</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-varid'>propertyToQuery</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-comment'>-- * Helper functions</span>
<a name="line-21"></a> <span class='hs-comment'>-- $helpers</span>
<a name="line-22"></a> <span class='hs-varid'>getProp32</span><span class='hs-layout'>,</span> <span class='hs-varid'>getProp32s</span><span class='hs-layout'>)</span>
<a name="line-23"></a><span class='hs-keyword'>where</span>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</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-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Foreign</span><span class='hs-varop'>.</span><span class='hs-conid'>C</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span><span class='hs-conid'>CLong</span><span class='hs-layout'>)</span>
<a name="line-27"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-28"></a>
<a name="line-29"></a><span class='hs-comment'>-- $edsl</span>
<a name="line-30"></a><span class='hs-comment'>-- Allows to specify window properties, such as title, classname or</span>
<a name="line-31"></a><span class='hs-comment'>-- resource, and to check them.</span>
<a name="line-32"></a><span class='hs-comment'>--</span>
<a name="line-33"></a><span class='hs-comment'>-- In contrast to ManageHook properties, these are instances of Show and Read,</span>
<a name="line-34"></a><span class='hs-comment'>-- so they can be used in layout definitions etc. For example usage see "XMonad.Layout.IM"</span>
<a name="line-35"></a>
<a name="line-36"></a><a name="Property"></a><span class='hs-comment'>-- | Most of the property constructors are quite self-explaining.</span>
<a name="line-37"></a><a name="Property"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Property</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Title</span> <span class='hs-conid'>String</span>
<a name="line-38"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ClassName</span> <span class='hs-conid'>String</span>
<a name="line-39"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Resource</span> <span class='hs-conid'>String</span>
<a name="line-40"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Role</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ WM_WINDOW_ROLE property</span>
<a name="line-41"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Machine</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ WM_CLIENT_MACHINE property</span>
<a name="line-42"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>And</span> <span class='hs-conid'>Property</span> <span class='hs-conid'>Property</span>
<a name="line-43"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Or</span> <span class='hs-conid'>Property</span> <span class='hs-conid'>Property</span>
<a name="line-44"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Not</span> <span class='hs-conid'>Property</span>
<a name="line-45"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Const</span> <span class='hs-conid'>Bool</span>
<a name="line-46"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Read</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-47"></a><span class='hs-keyword'>infixr</span> <span class='hs-num'>9</span> <span class='hs-varop'>`And`</span>
<a name="line-48"></a><span class='hs-keyword'>infixr</span> <span class='hs-num'>8</span> <span class='hs-varop'>`Or`</span>
<a name="line-49"></a>
<a name="line-50"></a><a name="hasProperty"></a><span class='hs-comment'>-- | Does given window have this property?</span>
<a name="line-51"></a><span class='hs-definition'>hasProperty</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Property</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Window</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span>
<a name="line-52"></a><span class='hs-definition'>hasProperty</span> <span class='hs-varid'>p</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runQuery</span> <span class='hs-layout'>(</span><span class='hs-varid'>propertyToQuery</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-varid'>w</span>
<a name="line-53"></a>
<a name="line-54"></a><a name="focusedHasProperty"></a><span class='hs-comment'>-- | Does the focused window have this property?</span>
<a name="line-55"></a><span class='hs-definition'>focusedHasProperty</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Property</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>Bool</span>
<a name="line-56"></a><span class='hs-definition'>focusedHasProperty</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-57"></a> <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-58"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>ms</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>stack</span> <span class='hs-varop'>$</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>workspace</span> <span class='hs-varop'>$</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>current</span> <span class='hs-varid'>ws</span>
<a name="line-59"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>ms</span> <span class='hs-keyword'>of</span>
<a name="line-60"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>hasProperty</span> <span class='hs-varid'>p</span> <span class='hs-varop'>$</span> <span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>focus</span> <span class='hs-varid'>s</span>
<a name="line-61"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>return</span> <span class='hs-conid'>False</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="allWithProperty"></a><span class='hs-comment'>-- | Find all existing windows with specified property</span>
<a name="line-64"></a><span class='hs-definition'>allWithProperty</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Property</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Window</span><span class='hs-keyglyph'>]</span>
<a name="line-65"></a><span class='hs-definition'>allWithProperty</span> <span class='hs-varid'>prop</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'>dpy</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-66"></a> <span class='hs-varid'>rootw</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>asks</span> <span class='hs-varid'>theRoot</span>
<a name="line-67"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span><span class='hs-varid'>wins</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'>queryTree</span> <span class='hs-varid'>dpy</span> <span class='hs-varid'>rootw</span>
<a name="line-68"></a> <span class='hs-varid'>hasProperty</span> <span class='hs-varid'>prop</span> <span class='hs-varop'>`filterM`</span> <span class='hs-varid'>wins</span>
<a name="line-69"></a>
<a name="line-70"></a><a name="propertyToQuery"></a><span class='hs-comment'>-- | Convert property to 'Query' 'Bool' (see "XMonad.ManageHook")</span>
<a name="line-71"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Property</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Query</span> <span class='hs-conid'>Bool</span>
<a name="line-72"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>Title</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>title</span> <span class='hs-varop'>=?</span> <span class='hs-varid'>s</span>
<a name="line-73"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>Resource</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>resource</span> <span class='hs-varop'>=?</span> <span class='hs-varid'>s</span>
<a name="line-74"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>ClassName</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>className</span> <span class='hs-varop'>=?</span> <span class='hs-varid'>s</span>
<a name="line-75"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>Role</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stringProperty</span> <span class='hs-str'>"WM_WINDOW_ROLE"</span> <span class='hs-varop'>=?</span> <span class='hs-varid'>s</span>
<a name="line-76"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>Machine</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>stringProperty</span> <span class='hs-str'>"WM_CLIENT_MACHINE"</span> <span class='hs-varop'>=?</span> <span class='hs-varid'>s</span>
<a name="line-77"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>And</span> <span class='hs-varid'>p1</span> <span class='hs-varid'>p2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>propertyToQuery</span> <span class='hs-varid'>p1</span> <span class='hs-varop'><&&></span> <span class='hs-varid'>propertyToQuery</span> <span class='hs-varid'>p2</span>
<a name="line-78"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>Or</span> <span class='hs-varid'>p1</span> <span class='hs-varid'>p2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>propertyToQuery</span> <span class='hs-varid'>p1</span> <span class='hs-varop'><||></span> <span class='hs-varid'>propertyToQuery</span> <span class='hs-varid'>p2</span>
<a name="line-79"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>Not</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>not</span> <span class='hs-varop'>`fmap`</span> <span class='hs-varid'>propertyToQuery</span> <span class='hs-varid'>p</span>
<a name="line-80"></a><span class='hs-definition'>propertyToQuery</span> <span class='hs-layout'>(</span><span class='hs-conid'>Const</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-varid'>b</span>
<a name="line-81"></a>
<a name="line-82"></a><span class='hs-comment'>-- $helpers</span>
<a name="line-83"></a>
<a name="line-84"></a><a name="getProp32"></a><span class='hs-comment'>-- | Get a window property from atom</span>
<a name="line-85"></a><span class='hs-definition'>getProp32</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Atom</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Window</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>CLong</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-86"></a><span class='hs-definition'>getProp32</span> <span class='hs-varid'>a</span> <span class='hs-varid'>w</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'>dpy</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getWindowProperty32</span> <span class='hs-varid'>dpy</span> <span class='hs-varid'>a</span> <span class='hs-varid'>w</span>
<a name="line-87"></a>
<a name="line-88"></a><a name="getProp32s"></a><span class='hs-comment'>-- | Get a window property from string</span>
<a name="line-89"></a><span class='hs-definition'>getProp32s</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Window</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>CLong</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-90"></a><span class='hs-definition'>getProp32s</span> <span class='hs-varid'>str</span> <span class='hs-varid'>w</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-layout'>{</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getAtom</span> <span class='hs-varid'>str</span><span class='hs-layout'>;</span> <span class='hs-varid'>getProp32</span> <span class='hs-varid'>a</span> <span class='hs-varid'>w</span> <span class='hs-layout'>}</span>
</pre></body>
</html>
