<?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/SpawnOn.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable #-}</span>
<a name="line-2"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : XMonad.Actions.SpawnOn</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) Spencer Janssen</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : Spencer Janssen <spencerjanssen@gmail.com></span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : unstable</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : unportable</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- Provides a way to modify a window spawned by a command(e.g shift it to the workspace</span>
<a name="line-13"></a><span class='hs-comment'>-- it was launched on) by using the _NET_WM_PID property that most windows set on creation.</span>
<a name="line-14"></a><span class='hs-comment'>-- Hence this module won't work on applications that don't set this property.</span>
<a name="line-15"></a><span class='hs-comment'>--</span>
<a name="line-16"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-17"></a>
<a name="line-18"></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'>SpawnOn</span> <span class='hs-layout'>(</span>
<a name="line-19"></a> <span class='hs-comment'>-- * Usage</span>
<a name="line-20"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-21"></a> <span class='hs-conid'>Spawner</span><span class='hs-layout'>,</span>
<a name="line-22"></a> <span class='hs-varid'>manageSpawn</span><span class='hs-layout'>,</span>
<a name="line-23"></a> <span class='hs-varid'>spawnHere</span><span class='hs-layout'>,</span>
<a name="line-24"></a> <span class='hs-varid'>spawnOn</span><span class='hs-layout'>,</span>
<a name="line-25"></a> <span class='hs-varid'>spawnAndDo</span><span class='hs-layout'>,</span>
<a name="line-26"></a> <span class='hs-varid'>shellPromptHere</span><span class='hs-layout'>,</span>
<a name="line-27"></a> <span class='hs-varid'>shellPromptOn</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'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span> <span class='hs-layout'>(</span><span class='hs-varid'>isInfixOf</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'>Posix</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span><span class='hs-conid'>ProcessID</span><span class='hs-layout'>)</span>
<a name="line-32"></a>
<a name="line-33"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span>
<a name="line-34"></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-35"></a>
<a name="line-36"></a><span class='hs-keyword'>import</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'>ManageHelpers</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Prompt</span>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Prompt</span><span class='hs-varop'>.</span><span class='hs-conid'>Shell</span>
<a name="line-39"></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'>Util</span><span class='hs-varop'>.</span><span class='hs-conid'>ExtensibleState</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>XS</span>
<a name="line-40"></a>
<a name="line-41"></a><span class='hs-comment'>-- $usage</span>
<a name="line-42"></a><span class='hs-comment'>-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:</span>
<a name="line-43"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><span class='hs-comment'>-- > import XMonad.Actions.SpawnOn</span>
<a name="line-45"></a><span class='hs-comment'>--</span>
<a name="line-46"></a><span class='hs-comment'>-- > main = do</span>
<a name="line-47"></a><span class='hs-comment'>-- > xmonad defaultConfig {</span>
<a name="line-48"></a><span class='hs-comment'>-- > ...</span>
<a name="line-49"></a><span class='hs-comment'>-- > manageHook = manageSpawn <+> manageHook defaultConfig</span>
<a name="line-50"></a><span class='hs-comment'>-- > ...</span>
<a name="line-51"></a><span class='hs-comment'>-- > }</span>
<a name="line-52"></a><span class='hs-comment'>--</span>
<a name="line-53"></a><span class='hs-comment'>-- To ensure that application appears on a workspace it was launched at, add keybindings like:</span>
<a name="line-54"></a><span class='hs-comment'>--</span>
<a name="line-55"></a><span class='hs-comment'>-- > , ((mod1Mask,xK_o), spawnHere "urxvt")</span>
<a name="line-56"></a><span class='hs-comment'>-- > , ((mod1Mask,xK_s), shellPromptHere defaultXPConfig)</span>
<a name="line-57"></a><span class='hs-comment'>--</span>
<a name="line-58"></a><span class='hs-comment'>-- The module can also be used to apply other manage hooks to the window of</span>
<a name="line-59"></a><span class='hs-comment'>-- the spawned application(e.g. float or resize it).</span>
<a name="line-60"></a><span class='hs-comment'>--</span>
<a name="line-61"></a><span class='hs-comment'>-- For detailed instructions on editing your key bindings, see</span>
<a name="line-62"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_key_bindings".</span>
<a name="line-63"></a>
<a name="line-64"></a><a name="Spawner"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Spawner</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Spawner</span> <span class='hs-layout'>{</span><span class='hs-varid'>pidsRef</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>ProcessID</span><span class='hs-layout'>,</span> <span class='hs-conid'>ManageHook</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>}</span> <span class='hs-keyword'>deriving</span> <span class='hs-conid'>Typeable</span>
<a name="line-65"></a>
<a name="line-66"></a><a name="instance%20ExtensionClass%20Spawner"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>ExtensionClass</span> <span class='hs-conid'>Spawner</span> <span class='hs-keyword'>where</span>
<a name="line-67"></a> <span class='hs-varid'>initialValue</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Spawner</span> <span class='hs-conid'>[]</span>
<a name="line-68"></a>
<a name="line-69"></a><a name="maxPids"></a><span class='hs-definition'>maxPids</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span>
<a name="line-70"></a><span class='hs-definition'>maxPids</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>5</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="modifySpawner"></a><span class='hs-comment'>-- | Get the current Spawner or create one if it doesn't exist.</span>
<a name="line-73"></a><span class='hs-definition'>modifySpawner</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>ProcessID</span><span class='hs-layout'>,</span> <span class='hs-conid'>ManageHook</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>ProcessID</span><span class='hs-layout'>,</span> <span class='hs-conid'>ManageHook</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</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-74"></a><span class='hs-definition'>modifySpawner</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>XS</span><span class='hs-varop'>.</span><span class='hs-varid'>modify</span> <span class='hs-layout'>(</span><span class='hs-conid'>Spawner</span> <span class='hs-varop'>.</span> <span class='hs-varid'>f</span> <span class='hs-varop'>.</span> <span class='hs-varid'>pidsRef</span><span class='hs-layout'>)</span>
<a name="line-75"></a>
<a name="line-76"></a><a name="manageSpawn"></a><span class='hs-comment'>-- | Provides a manage hook to react on process spawned with</span>
<a name="line-77"></a><span class='hs-comment'>-- 'spawnOn', 'spawnHere' etc.</span>
<a name="line-78"></a><span class='hs-definition'>manageSpawn</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ManageHook</span>
<a name="line-79"></a><span class='hs-definition'>manageSpawn</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-80"></a> <span class='hs-conid'>Spawner</span> <span class='hs-varid'>pids</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>liftX</span> <span class='hs-conid'>XS</span><span class='hs-varop'>.</span><span class='hs-varid'>get</span>
<a name="line-81"></a> <span class='hs-varid'>mp</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>pid</span>
<a name="line-82"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>flip</span> <span class='hs-varid'>lookup</span> <span class='hs-varid'>pids</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>mp</span> <span class='hs-keyword'>of</span>
<a name="line-83"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>idHook</span>
<a name="line-84"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>mh</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-85"></a> <span class='hs-varid'>whenJust</span> <span class='hs-varid'>mp</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>p</span> <span class='hs-keyglyph'>-></span>
<a name="line-86"></a> <span class='hs-varid'>liftX</span> <span class='hs-varop'>.</span> <span class='hs-varid'>modifySpawner</span> <span class='hs-varop'>$</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varop'>/=</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fst</span><span class='hs-layout'>)</span>
<a name="line-87"></a> <span class='hs-varid'>mh</span>
<a name="line-88"></a>
<a name="line-89"></a><a name="mkPrompt"></a><span class='hs-definition'>mkPrompt</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></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'>XPConfig</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-90"></a><span class='hs-definition'>mkPrompt</span> <span class='hs-varid'>cb</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-91"></a> <span class='hs-varid'>cmds</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>getCommands</span>
<a name="line-92"></a> <span class='hs-varid'>mkXPrompt</span> <span class='hs-conid'>Shell</span> <span class='hs-varid'>c</span> <span class='hs-layout'>(</span><span class='hs-varid'>getShellCompl</span> <span class='hs-varid'>cmds</span><span class='hs-layout'>)</span> <span class='hs-varid'>cb</span>
<a name="line-93"></a>
<a name="line-94"></a><a name="shellPromptHere"></a><span class='hs-comment'>-- | Replacement for Shell prompt ("XMonad.Prompt.Shell") which launches</span>
<a name="line-95"></a><span class='hs-comment'>-- application on current workspace.</span>
<a name="line-96"></a><span class='hs-definition'>shellPromptHere</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>XPConfig</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-97"></a><span class='hs-definition'>shellPromptHere</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkPrompt</span> <span class='hs-varid'>spawnHere</span>
<a name="line-98"></a>
<a name="line-99"></a><a name="shellPromptOn"></a><span class='hs-comment'>-- | Replacement for Shell prompt ("XMonad.Prompt.Shell") which launches</span>
<a name="line-100"></a><span class='hs-comment'>-- application on given workspace.</span>
<a name="line-101"></a><span class='hs-definition'>shellPromptOn</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WorkspaceId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>XPConfig</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-102"></a><span class='hs-definition'>shellPromptOn</span> <span class='hs-varid'>ws</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkPrompt</span> <span class='hs-layout'>(</span><span class='hs-varid'>spawnOn</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span>
<a name="line-103"></a>
<a name="line-104"></a><a name="spawnHere"></a><span class='hs-comment'>-- | Replacement for 'spawn' which launches</span>
<a name="line-105"></a><span class='hs-comment'>-- application on current workspace.</span>
<a name="line-106"></a><span class='hs-definition'>spawnHere</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-107"></a><span class='hs-definition'>spawnHere</span> <span class='hs-varid'>cmd</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withWindowSet</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>ws</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>spawnOn</span> <span class='hs-layout'>(</span><span class='hs-conid'>W</span><span class='hs-varop'>.</span><span class='hs-varid'>currentTag</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span> <span class='hs-varid'>cmd</span>
<a name="line-108"></a>
<a name="line-109"></a><a name="spawnOn"></a><span class='hs-comment'>-- | Replacement for 'spawn' which launches</span>
<a name="line-110"></a><span class='hs-comment'>-- application on given workspace.</span>
<a name="line-111"></a><span class='hs-definition'>spawnOn</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>WorkspaceId</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-112"></a><span class='hs-definition'>spawnOn</span> <span class='hs-varid'>ws</span> <span class='hs-varid'>cmd</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>spawnAndDo</span> <span class='hs-layout'>(</span><span class='hs-varid'>doShift</span> <span class='hs-varid'>ws</span><span class='hs-layout'>)</span> <span class='hs-varid'>cmd</span>
<a name="line-113"></a>
<a name="line-114"></a><a name="spawnAndDo"></a><span class='hs-comment'>-- | Spawn an application and apply the manage hook when it opens.</span>
<a name="line-115"></a><span class='hs-definition'>spawnAndDo</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ManageHook</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-116"></a><span class='hs-definition'>spawnAndDo</span> <span class='hs-varid'>mh</span> <span class='hs-varid'>cmd</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-117"></a> <span class='hs-varid'>p</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>spawnPID</span> <span class='hs-varop'>$</span> <span class='hs-varid'>mangle</span> <span class='hs-varid'>cmd</span>
<a name="line-118"></a> <span class='hs-varid'>modifySpawner</span> <span class='hs-varop'>$</span> <span class='hs-layout'>(</span><span class='hs-varid'>take</span> <span class='hs-varid'>maxPids</span> <span class='hs-varop'>.</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-varid'>p</span><span class='hs-layout'>,</span><span class='hs-varid'>mh</span><span class='hs-layout'>)</span> <span class='hs-conop'>:</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-119"></a> <span class='hs-keyword'>where</span>
<a name="line-120"></a> <span class='hs-comment'>-- TODO this is silly, search for a better solution</span>
<a name="line-121"></a> <span class='hs-varid'>mangle</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>any</span> <span class='hs-layout'>(</span><span class='hs-varop'>`elem`</span> <span class='hs-varid'>metaChars</span><span class='hs-layout'>)</span> <span class='hs-varid'>xs</span> <span class='hs-varop'>||</span> <span class='hs-str'>"exec"</span> <span class='hs-varop'>`isInfixOf`</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>xs</span>
<a name="line-122"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"exec "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>xs</span>
<a name="line-123"></a> <span class='hs-varid'>metaChars</span> <span class='hs-keyglyph'>=</span> <span class='hs-str'>"&|;"</span>
</pre></body>
</html>
