<?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/Paste.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{- |
<a name="line-2"></a>Module : XMonad.Util.Paste
<a name="line-3"></a>Copyright : (C) 2008 Jérémy Bobbio, gwern
<a name="line-4"></a>License : BSD3
<a name="line-5"></a>
<a name="line-6"></a>Maintainer : gwern <gwern0@gmail.com>
<a name="line-7"></a>Stability : unstable
<a name="line-8"></a>Portability : unportable
<a name="line-9"></a>
<a name="line-10"></a>A module for sending key presses to windows. This modules provides generalized
<a name="line-11"></a>and specialized functions for this task.
<a name="line-12"></a>-}</span>
<a name="line-13"></a>
<a name="line-14"></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'>Paste</span> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Usage</span>
<a name="line-15"></a> <span class='hs-comment'>-- $usage</span>
<a name="line-16"></a> <span class='hs-varid'>pasteSelection</span><span class='hs-layout'>,</span>
<a name="line-17"></a> <span class='hs-varid'>pasteString</span><span class='hs-layout'>,</span>
<a name="line-18"></a> <span class='hs-varid'>pasteChar</span><span class='hs-layout'>,</span>
<a name="line-19"></a> <span class='hs-varid'>sendKey</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-varid'>sendKeyWindow</span><span class='hs-layout'>,</span>
<a name="line-21"></a> <span class='hs-varid'>noModMask</span>
<a name="line-22"></a> <span class='hs-layout'>)</span>
<a name="line-23"></a> <span class='hs-keyword'>where</span>
<a name="line-24"></a>
<a name="line-25"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span> <span class='hs-layout'>(</span><span class='hs-varid'>io</span><span class='hs-layout'>,</span> <span class='hs-varid'>theRoot</span><span class='hs-layout'>,</span> <span class='hs-varid'>withDisplay</span><span class='hs-layout'>,</span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-26"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Graphics</span><span class='hs-varop'>.</span><span class='hs-conid'>X11</span>
<a name="line-27"></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> <span class='hs-layout'>(</span><span class='hs-varid'>none</span><span class='hs-layout'>,</span> <span class='hs-varid'>setEventType</span><span class='hs-layout'>,</span> <span class='hs-varid'>setKeyEvent</span><span class='hs-layout'>)</span>
<a name="line-28"></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'>Reader</span> <span class='hs-layout'>(</span><span class='hs-varid'>asks</span><span class='hs-layout'>)</span>
<a name="line-29"></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'>withFocused</span><span class='hs-layout'>)</span>
<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'>Char</span> <span class='hs-layout'>(</span><span class='hs-varid'>isUpper</span><span class='hs-layout'>)</span>
<a name="line-31"></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'>Misc</span> <span class='hs-layout'>(</span><span class='hs-varid'>stringToKeysym</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'>Util</span><span class='hs-varop'>.</span><span class='hs-conid'>XSelection</span> <span class='hs-layout'>(</span><span class='hs-varid'>getSelection</span><span class='hs-layout'>)</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-comment'>{- $usage
<a name="line-35"></a>
<a name="line-36"></a>Import this module into your xmonad.hs as usual:
<a name="line-37"></a>
<a name="line-38"></a>> import XMonad.Util.Paste
<a name="line-39"></a>
<a name="line-40"></a>And use the functions. They all return 'X' (), and so are appropriate
<a name="line-41"></a>for use as keybindings. Example:
<a name="line-42"></a>
<a name="line-43"></a>> , ((m, xK_d), pasteString "foo bar") ]
<a name="line-44"></a>
<a name="line-45"></a>Don't expect too much of the functions; they probably don't work on complex
<a name="line-46"></a>texts.
<a name="line-47"></a>-}</span>
<a name="line-48"></a>
<a name="line-49"></a><a name="pasteSelection"></a><span class='hs-comment'>-- | Paste the current X mouse selection. Note that this uses 'getSelection' from</span>
<a name="line-50"></a><span class='hs-comment'>-- "XMonad.Util.XSelection" and so is heir to its flaws.</span>
<a name="line-51"></a><span class='hs-definition'>pasteSelection</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-52"></a><span class='hs-definition'>pasteSelection</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>getSelection</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>pasteString</span>
<a name="line-53"></a>
<a name="line-54"></a><a name="pasteString"></a><span class='hs-comment'>-- | Send a string to the window which is currently focused. This function correctly</span>
<a name="line-55"></a><span class='hs-comment'>-- handles capitalization.</span>
<a name="line-56"></a><span class='hs-definition'>pasteString</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-57"></a><span class='hs-definition'>pasteString</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapM_</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>if</span> <span class='hs-varid'>isUpper</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>pasteChar</span> <span class='hs-varid'>shiftMask</span> <span class='hs-varid'>x</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>pasteChar</span> <span class='hs-varid'>noModMask</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-58"></a>
<a name="line-59"></a><a name="pasteChar"></a><span class='hs-comment'>{- | Send a character to the current window. This is more low-level.
<a name="line-60"></a> Remember that you must handle the case of capitalization appropriately.
<a name="line-61"></a> That is, from the window's perspective:
<a name="line-62"></a>
<a name="line-63"></a> > pasteChar mod2Mask 'F' ~> "f"
<a name="line-64"></a>
<a name="line-65"></a> You would want to do something like:
<a name="line-66"></a>
<a name="line-67"></a> > pasteChar shiftMask 'F'
<a name="line-68"></a>
<a name="line-69"></a> Note that this function makes use of 'stringToKeysym', and so will probably
<a name="line-70"></a> have trouble with any 'Char' outside ASCII.
<a name="line-71"></a>-}</span>
<a name="line-72"></a><span class='hs-definition'>pasteChar</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>KeyMask</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Char</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'>pasteChar</span> <span class='hs-varid'>m</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sendKey</span> <span class='hs-varid'>m</span> <span class='hs-varop'>$</span> <span class='hs-varid'>stringToKeysym</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>c</span><span class='hs-keyglyph'>]</span>
<a name="line-74"></a>
<a name="line-75"></a><a name="sendKey"></a><span class='hs-definition'>sendKey</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>KeyMask</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>KeySym</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>X</span> <span class='hs-conid'>()</span>
<a name="line-76"></a><span class='hs-definition'>sendKey</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>withFocused</span> <span class='hs-varop'>.</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>sendKeyWindow</span>
<a name="line-77"></a>
<a name="line-78"></a><a name="sendKeyWindow"></a><span class='hs-comment'>-- | The primitive. Allows you to send any combination of 'KeyMask' and 'KeySym' to any 'Window' you specify.</span>
<a name="line-79"></a><span class='hs-definition'>sendKeyWindow</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>KeyMask</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>KeySym</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'>()</span>
<a name="line-80"></a><span class='hs-definition'>sendKeyWindow</span> <span class='hs-varid'>mods</span> <span class='hs-varid'>key</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'>d</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-81"></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-82"></a> <span class='hs-varid'>keycode</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>keysymToKeycode</span> <span class='hs-varid'>d</span> <span class='hs-varid'>key</span>
<a name="line-83"></a> <span class='hs-varid'>io</span> <span class='hs-varop'>$</span> <span class='hs-varid'>allocaXEvent</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>ev</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-84"></a> <span class='hs-varid'>setEventType</span> <span class='hs-varid'>ev</span> <span class='hs-varid'>keyPress</span>
<a name="line-85"></a> <span class='hs-varid'>setKeyEvent</span> <span class='hs-varid'>ev</span> <span class='hs-varid'>w</span> <span class='hs-varid'>rootw</span> <span class='hs-varid'>none</span> <span class='hs-varid'>mods</span> <span class='hs-varid'>keycode</span> <span class='hs-conid'>True</span>
<a name="line-86"></a> <span class='hs-varid'>sendEvent</span> <span class='hs-varid'>d</span> <span class='hs-varid'>w</span> <span class='hs-conid'>True</span> <span class='hs-varid'>keyPressMask</span> <span class='hs-varid'>ev</span>
<a name="line-87"></a> <span class='hs-varid'>setEventType</span> <span class='hs-varid'>ev</span> <span class='hs-varid'>keyRelease</span>
<a name="line-88"></a> <span class='hs-varid'>sendEvent</span> <span class='hs-varid'>d</span> <span class='hs-varid'>w</span> <span class='hs-conid'>True</span> <span class='hs-varid'>keyReleaseMask</span> <span class='hs-varid'>ev</span>
<a name="line-89"></a>
<a name="line-90"></a><a name="noModMask"></a><span class='hs-comment'>-- | A null 'KeyMask'. Used when you don't want a character or string shifted, control'd, or what.</span>
<a name="line-91"></a><span class='hs-comment'>--</span>
<a name="line-92"></a><span class='hs-comment'>-- TODO: This really should be a function in the X11 binding. When noModMask shows up there, remove.</span>
<a name="line-93"></a><span class='hs-definition'>noModMask</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>KeyMask</span>
<a name="line-94"></a><span class='hs-definition'>noModMask</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>0</span>
</pre></body>
</html>
