<?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/Prompt/Input.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.Prompt.Input</span> <a name="line-4"></a><span class='hs-comment'>-- Copyright : (c) 2007 Brent Yorgey</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 : <byorgey@gmail.com></span> <a name="line-8"></a><span class='hs-comment'>-- Stability : stable</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'>-- A generic framework for prompting the user for input and passing it</span> <a name="line-12"></a><span class='hs-comment'>-- along to some other action.</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> <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'>Prompt</span><span class='hs-varop'>.</span><span class='hs-conid'>Input</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> <span class='hs-varid'>inputPrompt</span><span class='hs-layout'>,</span> <a name="line-20"></a> <span class='hs-varid'>inputPromptWithCompl</span><span class='hs-layout'>,</span> <a name="line-21"></a> <span class='hs-layout'>(</span><span class='hs-varop'>?+</span><span class='hs-layout'>)</span> <a name="line-22"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-23"></a> <a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>XMonad</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span> <a name="line-25"></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-26"></a> <a name="line-27"></a><span class='hs-comment'>-- $usage</span> <a name="line-28"></a><span class='hs-comment'>--</span> <a name="line-29"></a><span class='hs-comment'>-- To use this module, import it along with "XMonad.Prompt":</span> <a name="line-30"></a><span class='hs-comment'>--</span> <a name="line-31"></a><span class='hs-comment'>-- > import XMonad.Prompt</span> <a name="line-32"></a><span class='hs-comment'>-- > import XMonad.Prompt.Input</span> <a name="line-33"></a><span class='hs-comment'>--</span> <a name="line-34"></a><span class='hs-comment'>-- This module provides no useful functionality in isolation, but</span> <a name="line-35"></a><span class='hs-comment'>-- is intended for use in building other actions which require user</span> <a name="line-36"></a><span class='hs-comment'>-- input.</span> <a name="line-37"></a><span class='hs-comment'>--</span> <a name="line-38"></a><span class='hs-comment'>-- For example, suppose Mr. Big wants a way to easily fire his</span> <a name="line-39"></a><span class='hs-comment'>-- employees. We'll assume that he already has a function</span> <a name="line-40"></a><span class='hs-comment'>--</span> <a name="line-41"></a><span class='hs-comment'>-- > fireEmployee :: String -> X ()</span> <a name="line-42"></a><span class='hs-comment'>--</span> <a name="line-43"></a><span class='hs-comment'>-- which takes as input the name of an employee, and fires them. He</span> <a name="line-44"></a><span class='hs-comment'>-- just wants a convenient way to provide the input for this function</span> <a name="line-45"></a><span class='hs-comment'>-- from within xmonad. Here is where the "XMonad.Prompt.Input" module</span> <a name="line-46"></a><span class='hs-comment'>-- comes into play. He can use the 'inputPrompt' function to create a</span> <a name="line-47"></a><span class='hs-comment'>-- prompt, and the '?+' operator to compose the prompt with the</span> <a name="line-48"></a><span class='hs-comment'>-- @fireEmployee@ action, like so:</span> <a name="line-49"></a><span class='hs-comment'>--</span> <a name="line-50"></a><span class='hs-comment'>-- > firingPrompt :: X ()</span> <a name="line-51"></a><span class='hs-comment'>-- > firingPrompt = inputPrompt defaultXPConfig \"Fire\" ?+ fireEmployee</span> <a name="line-52"></a><span class='hs-comment'>--</span> <a name="line-53"></a><span class='hs-comment'>-- If @employees@ contains a list of all his employees, he could also</span> <a name="line-54"></a><span class='hs-comment'>-- create an autocompleting version, like this:</span> <a name="line-55"></a><span class='hs-comment'>--</span> <a name="line-56"></a><span class='hs-comment'>-- > firingPrompt' = inputPromptWithCompl defaultXPConfig \"Fire\"</span> <a name="line-57"></a><span class='hs-comment'>-- > (mkComplFunFromList employees) ?+ fireEmployee</span> <a name="line-58"></a><span class='hs-comment'>--</span> <a name="line-59"></a><span class='hs-comment'>-- Now all he has to do is add a keybinding to @firingPrompt@ (or</span> <a name="line-60"></a><span class='hs-comment'>-- @firingPrompt'@), such as</span> <a name="line-61"></a><span class='hs-comment'>--</span> <a name="line-62"></a><span class='hs-comment'>-- > , ((modm .|. controlMask, xK_f), firingPrompt)</span> <a name="line-63"></a><span class='hs-comment'>--</span> <a name="line-64"></a><span class='hs-comment'>-- Now when Mr. Big hits mod-ctrl-f, a prompt will pop up saying</span> <a name="line-65"></a><span class='hs-comment'>-- \"Fire: \", waiting for him to type the name of someone to fire.</span> <a name="line-66"></a><span class='hs-comment'>-- If he thinks better of it after hitting mod-ctrl-f and cancels the</span> <a name="line-67"></a><span class='hs-comment'>-- prompt (e.g. by hitting Esc), the @fireEmployee@ action will not be</span> <a name="line-68"></a><span class='hs-comment'>-- invoked.</span> <a name="line-69"></a><span class='hs-comment'>--</span> <a name="line-70"></a><span class='hs-comment'>-- (For detailed instructions on editing your key bindings, see</span> <a name="line-71"></a><span class='hs-comment'>-- "XMonad.Doc.Extending#Editing_key_bindings".)</span> <a name="line-72"></a><span class='hs-comment'>--</span> <a name="line-73"></a><span class='hs-comment'>-- "XMonad.Prompt.Input" is also intended to ease the process of</span> <a name="line-74"></a><span class='hs-comment'>-- developing other modules which require user input. For an example</span> <a name="line-75"></a><span class='hs-comment'>-- of a module developed using this functionality, see</span> <a name="line-76"></a><span class='hs-comment'>-- "XMonad.Prompt.Email", which prompts the user for a recipient,</span> <a name="line-77"></a><span class='hs-comment'>-- subject, and one-line body, and sends a quick email.</span> <a name="line-78"></a> <a name="line-79"></a><a name="InputPrompt"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>InputPrompt</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>InputPrompt</span> <span class='hs-conid'>String</span> <a name="line-80"></a> <a name="line-81"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>XPrompt</span> <span class='hs-conid'>InputPrompt</span> <span class='hs-keyword'>where</span> <a name="line-82"></a> <span class='hs-varid'>showXPrompt</span> <span class='hs-layout'>(</span><span class='hs-conid'>InputPrompt</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>s</span> <span class='hs-varop'>++</span> <span class='hs-str'>": "</span> <a name="line-83"></a> <a name="line-84"></a><a name="inputPrompt"></a><span class='hs-comment'>-- | Given a prompt configuration and some prompt text, create an X</span> <a name="line-85"></a><span class='hs-comment'>-- action which pops up a prompt waiting for user input, and returns</span> <a name="line-86"></a><span class='hs-comment'>-- whatever they type. Note that the type of the action is @X</span> <a name="line-87"></a><span class='hs-comment'>-- (Maybe String)@, which reflects the fact that the user might</span> <a name="line-88"></a><span class='hs-comment'>-- cancel the prompt (resulting in @Nothing@), or enter an input</span> <a name="line-89"></a><span class='hs-comment'>-- string @s@ (resulting in @Just s@).</span> <a name="line-90"></a><span class='hs-definition'>inputPrompt</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>XPConfig</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-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span> <a name="line-91"></a><span class='hs-definition'>inputPrompt</span> <span class='hs-varid'>c</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>inputPromptWithCompl</span> <span class='hs-varid'>c</span> <span class='hs-varid'>p</span> <span class='hs-layout'>(</span><span class='hs-varid'>const</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <a name="line-92"></a> <a name="line-93"></a><a name="inputPromptWithCompl"></a><span class='hs-comment'>-- | The same as 'inputPrompt', but with a completion function. The</span> <a name="line-94"></a><span class='hs-comment'>-- type @ComplFunction@ is @String -> IO [String]@, as defined in</span> <a name="line-95"></a><span class='hs-comment'>-- "XMonad.Prompt". The 'mkComplFunFromList' utility function, also</span> <a name="line-96"></a><span class='hs-comment'>-- defined in "XMonad.Prompt", is useful for creating such a</span> <a name="line-97"></a><span class='hs-comment'>-- function from a known list of possibilities.</span> <a name="line-98"></a><span class='hs-definition'>inputPromptWithCompl</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>XPConfig</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ComplFunction</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-conid'>String</span><span class='hs-layout'>)</span> <a name="line-99"></a><span class='hs-definition'>inputPromptWithCompl</span> <span class='hs-varid'>c</span> <span class='hs-varid'>p</span> <span class='hs-varid'>compl</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mkXPromptWithReturn</span> <span class='hs-layout'>(</span><span class='hs-conid'>InputPrompt</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-varid'>c</span> <span class='hs-varid'>compl</span> <span class='hs-varid'>return</span> <a name="line-100"></a> <a name="line-101"></a> <a name="line-102"></a><span class='hs-keyword'>infixr</span> <span class='hs-num'>1</span> <span class='hs-varop'>?+</span> <a name="line-103"></a> <a name="line-104"></a><a name="?+"></a><span class='hs-comment'>-- | A combinator for hooking up an input prompt action to a function</span> <a name="line-105"></a><span class='hs-comment'>-- which can take the result of the input prompt and produce another</span> <a name="line-106"></a><span class='hs-comment'>-- action. If the user cancels the input prompt, the</span> <a name="line-107"></a><span class='hs-comment'>-- second function will not be run.</span> <a name="line-108"></a><span class='hs-comment'>--</span> <a name="line-109"></a><span class='hs-comment'>-- The astute student of types will note that this is actually a</span> <a name="line-110"></a><span class='hs-comment'>-- very general combinator and has nothing in particular to do</span> <a name="line-111"></a><span class='hs-comment'>-- with input prompts. If you find a more general use for it and</span> <a name="line-112"></a><span class='hs-comment'>-- want to move it to a different module, be my guest.</span> <a name="line-113"></a><span class='hs-layout'>(</span><span class='hs-varop'>?+</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Monad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span> <a name="line-114"></a><a name="x"></a><span class='hs-definition'>x</span> <span class='hs-varop'>?+</span> <span class='hs-varid'>k</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>x</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>maybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-varid'>k</span> </pre></body> </html>
