November 2008 - xmonad

Compile-time verification of keymaps
by Gwern Branwen 28 Mar '10

28 Mar '10

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 So today I edited into my xmonad.hs a binding to the Isohunt.com XMonad.Actions.Search engine for convenience. I naturally chose xK_i for the bound key. When I reloaded, I was surprised to see that mod-i failed to do as it was supposed to. Trying it again, it brought up irssi. That was when I realized mod-i had already been bound in my xmonad.hs, to runOrRaise for irssi, and that the irssi binding happened to be later in the list and so it quietly overwrote the Isohunt binding. After picking a new & unused key, I began reflecting on this. Certainly, this is expected behavior if you're familiar with Data.Map. fromList will do that - a list may have multiple values for a single key (such as xK_i) and the last value wins. But I think in an xmonad.hs, the context is somewhat different. There the semantics are somewhat different. We use 'M.fromList [stuff, more stuff, and the rest]' syntax because Haskell supports list syntax, and it makes life easier on the user to use such a common method. But do we *really* mean to say that it is a sensible thing to bind the same key to multiple contradictory definitions? It just so happens that [xK_i isohunt, xK_i irssi] is equivalent to a destructive update style of 'i = isohunt; i = irssi' when fed through the Map functions. So I thought to myself that maybe there was some static way of specifying a list without duplicates we could use in xmonad.hs. It would be nice to know that one cannot run xmonad.hs with inconsistent sets of bindings*. This checking would, even better, be done at compile-time so one could verify this by simply loading in GHCi (good for everyone who routinely reloads in Emacs or Vim). How to do this? Someone in #haskell suggested extensible records, but that sounds quite difficult. Another approach would be to scrap the static requirement, and simply provide the user a redefined 'fromList' which runs something like 'let x = map fst list in nub x == x' and does something if there are duplicates (calls error, spawns xmessage, etc.) I decided to try a variant of the latter at compile-time, using Template Haskell. I got fairly far with the help of mmorrow, but I didn't actually succeed. -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.9 (GNU/Linux) iEYEAREKAAYFAkkgYvgACgkQvpDo5Pfl1oLE3gCgkuHMlUO1+YT4oEFLzhHqmeuB QA4An3X72j1z+StumSOmnTXlTJhHeTft =fBDz -----END PGP SIGNATURE----- The idea is that one should be able to do something like this in xmonad.hs > '{-# LANGUAGE TemplateHaskell #-} > import XMonad.Utils.VerifyKeys > .... > myKeys conf@(XConfig {modMask = m}) = M.fromList $(uniqueTupleListQ [ -- rebind standard actions > ((m .|. shiftMask,xK_p), shellPrompt greenXPConfig) > , ((m, xK_d), raiseBrowser) ] ) VerifyKeys looks something like this: > {-# LANGUAGE TemplateHaskell #-} > module XMonad.Utils.VerifyKeys where > > import Data.List(nub) > import qualified Data.Map > import Language.Haskell.TH.Lib > import Language.Haskell.TH.Syntax > > uniqueTupleListQ :: (Eq a, Lift a, Lift b) => [(a, b)] -> ExpQ > uniqueTupleListQ xs = let ys = map fst xs > ns = nub ys > in case ys == ns of > False -> fail "uniqueTupleListQ: List has conflicting entries." > True -> lift xs The idea is that since we know the keymap at compile-time, we pass it, before it gets turned into a Map (and the relevant information lost), we analyze the list. 'fail' aborts the compilation if the list is bad. You can easily test this out in a different module with some simple expressions: > keymap1, keymap2 :: [(Char, String)] > keymap1 = $(uniqueTupleListQ [('a', "foo"), ('b', "bar")] ) > keymap2 = $(uniqueTupleListQ [('a', "foo"), ('b', "bar"), ('c', "bar"), ('a', "quux")] ) Compiling, this gives us something like this: > [1 of 2] Compiling Tmp ( Tmp.hs, Tmp.o ) > [2 of 2] Compiling Main ( xmonad.hs, xmonad.o ) > Loading package base ... linking ... done. > Loading package array-0.1.0.0 ... linking ... done. > Loading package packedstring-0.1.0.0 ... linking ... done. > Loading package containers-0.1.0.1 ... linking ... done. > Loading package pretty-1.0.0.0 ... linking ... done. > Loading package template-haskell ... linking ... done. > > xmonad.hs:113:12: uniqueTupleListQ: List has conflicting entries. Line 133 is keymap2. If we remove '('a', "quux")', which conflicts with the very first entry, we get: > [1 of 2] Compiling Tmp ( Tmp.hs, Tmp.o ) > [2 of 2] Compiling Main ( xmonad.hs, xmonad.o ) > Loading package base ... linking ... done. > Loading package array-0.1.0.0 ... linking ... done. > Loading package packedstring-0.1.0.0 ... linking ... done. > Loading package containers-0.1.0.1 ... linking ... done. > Loading package pretty-1.0.0.0 ... linking ... done. > Loading package template-haskell ... linking ... done. > Linking foo ... Now, this seems to be exactly what we want, doesn't it? But ultimately I had to admit failure. Template Haskell has a number of restrictions and omissions that make it unfeasible to use. For starters: If we apply uniqueTupleList to an actual keymap (like mine), we discover that uniqueTupleList's constraints are unworkable. Per the type sig, we need 'Lift b', the second half of each tuple in the key list. But XMonad requires b to be a X (), and X () is not instantiated for Lift**. Were it, we would still need Lift instances for Word64 and also CUInt. Lift instances probably wouldn't be too hard to write. The real killer, from an xmonad.hs perspective, is the module restrictions. Fundamentally, one *cannot* use inside a $() anything defined in the same file. {modMask = m}? Nope. greenXPConfig? Nope. 'term = XMonad.terminal conf'? Nope. And so on. It is a minimal set of bindings indeed which only makes use of literals and imported functions. So until Template Haskell improves, that avenue seems to be out. I'm not sure where to go from here. Had Template Haskell worked out, the path would've been easy, a matter of having users make a relatively small modification to their xmonad.hs, and perhaps avoiding entirely TH syntax. Does anyone have a better approach, or is this a foolish thing to want static safety in? ksf suggested that Yi has a combinator approach to keybindings which could solve it, but I am unsure how that works or could be adapted for XMonad.*** * Obviously the consistency is only valuable _in_ a specific Map; if we insisted that all Maps be consistent, then we couldn't override the default Map with our own. ** I may be misinterpreting the type error; possibly we actually need Lift for (X()) *** I'm cc'ing yi-devel since I suspect the topic may be of interest. -- gwern

5 7

Call for xmonad.hs
by Gwern Branwen 16 Jan '10

16 Jan '10

Hi everyone. So a while ago we were discussing how to improve defaults and what sorts of types and functions XM and XMC could provide which encapsulate common behavior, when Devon asked me what exactly I saw being repeated (besides the 2 or 3 examples I provided), and it occurred to me that I really didn't know. There're ~30 xmonad.hs's here <http://haskell.org/haskellwiki/Xmonad/Config_archive>, but perhaps 1/3 to 1/2 are obsolete or don't compile with darcs XM/XMC (at a very rough guess). I'd like more. So here's what I would greatly appreciate everyone doing: 1) Upload your config 2) If you've uploaded your config, update it! 3) If you use someone else's config, why not mention it? I'd appreciate knowing who's using what, so I can count the popular configurations proportionately* 4) If you don't want to do any of 1-3, perhaps you could email me privately with your config? Thanks in advance all. * I think it's fair to say that if 10 people are using a particular xmonad.hs, and there's a simplification which could be made, that change should count 10x -- gwern ANZUS nuclear Lebed .ch Domination .tm top Amherst USSS Hugo

10 27

darcs patch: UpdatePointer even to empty workspaces (and 1 more)
by Joachim Breitner 19 Mar '09

19 Mar '09

Hi, this is just an update for my patch, now since pointWithin is available from the core Thanks, Joachim Tue Oct 7 10:00:41 CEST 2008 Joachim Breitner <mail(a)joachim-breitner.de> * UpdatePointer even to empty workspaces This makes UpdatePointer more Xinerama-compatible: If the user switches to a screen with an empty workspace, the pointer is moved to that workspace, which I think is expected behavoiur. Wed Oct 8 17:42:45 CEST 2008 Joachim Breitner <mail(a)joachim-breitner.de> * pointWithin has moved to the core

6 6

Extensible programs & defaults: the Gosling Emacs experience
by Gwern Branwen 21 Feb '09

21 Feb '09

So, I happened to be reading a PhD thesis on exokernels, when I came across a reference. The context was that an exokernel is a maximally minimalistic operating system kernel; the kernel solely divides up resources among running programs. The programs get all other abstractions and standard OS services by linking in customized libraries, 'libOSes' as the developers put it. The point was that while an exokernel is designed so that any program can customize the operating system as much as possible, the defaults are still profoundly important, and the authors mentioned an Emacs retrospective which covered that. "UNIX Emacs: A Retrospective. Lessons for Flexible System Design" (by Gosling & Borenstein). I managed to get a copy, and I found some of it very instructive reading. Indeed, I find it instructive to look at various xmonad.hses after reading some excerpts: "The one point on which nearly everyone seems to agree is that the best thing about UNIX Emacs is that mlisp exists. No one even suggested that Emacs would be better without the powerful facility for extension and customization, although it is clear that such facilities, if abused, can create an environment that changes so radically from day to day as to be unusable for most people." "The integration of powerful editing facilities with a full-fledged programming language seems unquestionably useful, though it remains a matter of some debate whether this combination is best achieved by an extension language for a text editor or by implementing the text editor as a subroutine library in an existing programming language." "The key principle is that there is *simple syntax for simple operations*. This does not mean that a more complex syntax should not be available for more complex operations, only that the complexity should not be forced on the programmer in a simple context." "It didn't have to be that way. In the development of Emacs, it was far too easy to say that, since the support for the kind of basic interface was entirely customizable, it wasn't important to devote a lot of attention to getting the default interface to be correct. After all, anyone who didn't like the interface could change it. What this attitude ignored, however, was the old rule our mothers used to teach us about the lasting value of first impressions. Many people tried Emacs, couldn't stand the basic interface, and went back to their old standard editors, such as the vi editor on UNIX." "It is worth noting that this happened despite the fact that several people, independently, implemented more or less complete vi emulation packages for Emacs in mlisp. It seems that even if a package existed that was an absolutely perfect simulation of vi, most of the people who prefer vi to Emacs would stick with the clearly less powerful vi. While this is in part due to the smaller size of vi, it is also attributable to the unacceptable difficulty, in the minds of such people, of having to learn how to turn the vi emulation package on in the first place." "The clear lesson to be learned from this is that, while flexibility in such a system is indeed essential, great care must be paid to get the default behaviours to be simple and natural, and to provide very clear and simple ways to use a carefully chosen small set of the most commonly desired customizations. It may be, organizationally, that the people who build the flexible tools are not necessarily the right people to figure out which are the correct defaults and 'standard options'. The process of making such choices probably requires serious observation of users, or even controlled experiments, to compare possible system configurations." ----- I'm not sure how well XMonad works on the above criteria. It seems to me that there are a number of things which could be improved. For example, one of the most common changes is to switch the modifier from Alt to Win, for the simple reason that stealing Alt renders many programs nearly unusable. The arguments I've seen is that we should follow dwm tradition, and that we have no guarantee that Win is mapped to a real key, but is it really impossible for us to, say, autodetect whether Win is usable and only fallback to Alt? Or perhaps on running XMonad the first time with a xmonad.hs, there could be a prompt. Or... there are many ways we could tackle this issue. Another example: some function usages are copied all over the place. How many configurations have a line that looks like: > , keys = \c -> myKeys c `M.union` keys defaultConfig c Yes, it's neat that we can use basic Data.Map functions to union the default and custom keymaps (with the implication we can be flexible and combine them any other way we like), but it strikes me as wrong to have a relatively opaque task repeated time and again. Why don't we have a helper function such that we could write instead: > , keys = overrideDefaultWith myKeys Or if one is setting ManageHooks. Sure, one *could* write > , className =? "Firefox" --> doF (W.shift "web") 2, 3, 4, 6, or however many different entries one has in one's ManageHooks. But wouldn't a helper function be warranted so one could write: > , shiftClassToWS "Firefox" "web" For that matter, am I the only one who wants to be able to unfloat windows in ManageHook? Leaving aside how there is no actual unfloat function, I was eventually able, thanks to #xmonad, to write in my xmonad.hs: > className =? "defcon.bin.x86" --> ask >>= doF . W.sink But heck, do I understand that? Would someone else have any idea what that means? I mean, we're got 4 operators in there, 3 unusual functions (ask isn't even an xmonad function, it's from the State monad. I think. It seems a little much to expect customizers to understand monads, and the State monad, just to do a basic thing like 'unfloat an application when it opens'). ------ In short, perhaps a goal for 0.9 could be to make customizing XMonad easier on the xmonad.hs level. I think a second goal would be to change defaults in the XMonad core, and to perhaps add in some extensions by default - but that's an entirely other discussion. I'm not sure how people would react if I suggested making SmartBorders the default for the fullscreen layout. :) -- gwern Echelon Herald Islamic VHF CTP BATF POCSAG MDA USCG burhop

3 3

[xmonad-contrib] darcs patch: FocusNth again
by Aleksey P. Artamonov 20 Feb '09

20 Feb '09

As you can see I sent patch to XMonad.Actions.FocusNth last week. There were some stupid mistakes I didn't notice although these were big mistakes. Now I hope they've gone. So it's my second attempt. Please provide me with information about "state of approving". Besides, I've got a question which appeared while I was fixing mistakes in this patch. The best way to understand it is simply to simulate it by yourself. So choose a workspace with fullscreen layout. Execute one full screen program. Then one floating. Then full screen again. It would be better if you could tell both full screen apps apart easily. Now focus the application you ran most recent (let's call it A). Then focus down to the floating application. Now this floating application is really in the focus but application A has gone from the background. Instead application you ran the first is in the background. So my question is about whether it is possible to by-pass this behavior. Thanks. Sun Oct 19 17:03:30 EEST 2008 Aleksey Artamonov <aleksey.artamonov(a)gmail.com> * FocusNth improvements fixed There were some stupid mistakes in the previous version I sent. The main idea has not changed. This patch provides a way of altering switching order of FocusNth. New patches: [FocusNth improvements fixed Aleksey Artamonov <aleksey.artamonov(a)gmail.com>**20081019140330 There were some stupid mistakes in the previous version I sent. The main idea has not changed. This patch provides a way of altering switching order of FocusNth. ] { hunk ./XMonad/Actions/FocusNth.hs 17 - focusNth) where + focusNth, + focusNthExt + ) where hunk ./XMonad/Actions/FocusNth.hs 21 -import XMonad.StackSet +import XMonad.StackSet hiding (filter) hunk ./XMonad/Actions/FocusNth.hs 35 +-- Sometimes it is really convenient to alter the order +-- of windows' switching or to omit some of the windows +-- at all. To fulfill this 'focusNthExt' should be used. +-- The following code switches to the floating windows +-- only after all the others (uses XMonad.Util.EZConfig): +-- +-- > -- mod-[F1 .. F9] +-- > ++ +-- > [ ("M-<F" ++ k ++ ">", do +-- > state <- get +-- > floating <- return $ W.floating (windowset state) +-- > focusNthExt (\x -> let (a, b) = partition (not . (flip M.member) floating) x in a ++ b) +-- > i) +-- > | (k, i) <- zip (map show [1..]) [0..8] +-- > ] +-- hunk ./XMonad/Actions/FocusNth.hs 56 -focusNth = windows . modify' . focusNth' - -focusNth' :: Int -> Stack a -> Stack a -focusNth' n s@(Stack _ ls rs) | (n < 0) || (n > length(ls) + length(rs)) = s - | otherwise = listToStack n (integrate s) +focusNth = focusNthExt (\x -> x) hunk ./XMonad/Actions/FocusNth.hs 58 -listToStack :: Int -> [a] -> Stack a -listToStack n l = Stack t ls rs - where - (t:rs) = drop n l - ls = reverse (take n l) +-- | Give focus to the nth window taking into consideration windows' rearranging +-- function. +focusNthExt :: ([Window] -> [Window]) -> Int -> X() +focusNthExt t = windows . modify' . (focusNth' t) hunk ./XMonad/Actions/FocusNth.hs 63 +focusNth' :: ([Window] -> [Window]) -> Int -> Stack Window -> Stack Window +focusNth' transform n s = + let integrated = integrate s + transformed = transform $ integrated + matching = length transformed + in if (n < 0) || (n >= matching) + then s + else listToStack n transformed integrated hunk ./XMonad/Actions/FocusNth.hs 72 +listToStack :: Int -> [Window] -> [Window] -> Stack Window +listToStack num transformed real = Stack t (reverse rls) rs + where + t = transformed !! num + (rls, _ : rs) = span (/= t) real } Context: [Prompt.hs rename deleteConsecutiveDuplicates gwern0(a)gmail.com**20081008205131 That name is really unwieldy and long. ] [Prompt.hs: have historyCompletion filter dupes gwern0(a)gmail.com**20081008204710 Specifically, it calls deleteConsecutiveDuplicates on the end product. uniqSort reverses order in an unfortunate way, so we don't use that. The use-case is when a user has added the same input many times - as it stands, if the history records 30 'top's or whatever, the completion will show 30 'top' entries! This fixes that. ] [Prompt.hs: tweak haddocks gwern0(a)gmail.com**20081008204649] [Prompt.hs: mv uniqSort to next to its confreres, and mention the trade-off gwern0(a)gmail.com**20081008192645] [Do not consider XMONAD_TIMER unknown Joachim Breitner <mail(a)joachim-breitner.de>**20081008195643] [Kill window without focusing it first Joachim Breitner <mail(a)joachim-breitner.de>**20081005002533 This patch requires the patch "add killWindow function" in xmonad. Before this patch, people would experience “workspace flicker” when closing a window via EWMH that is not on the current workspace, for example when quitting pidgin via the panel icon. ] [let MagnifyLess actually magnify less daniel(a)wagner-home.com**20081015153911] [Depend on X11 >= 1.4.3 Spencer Janssen <spencerjanssen(a)gmail.com>**20080921055456] [Actions.Search: add a few search engines intrigeri(a)boum.org**20081008104033 Add Debian {package, bug, tracking system} search engines, as well as Google Images and isohunt. ] [Implement HiddenNonEmptyWS with HiddenWS and NonEmptyWS Joachim Breitner <mail(a)joachim-breitner.de>**20081006211027 (Just to reduce code duplication) ] [Add straightforward HiddenWS to WSType Joachim Breitner <mail(a)joachim-breitner.de>**20081006210548 With NonEmptyWS and HiddenNonEmptyWS present, HiddenWS is obviously missing. ] [Merge emptyLayoutMod into redoLayout Joachim Breitner <mail(a)joachim-breitner.de>**20081005190220 This removes the emptyLayoutMod method from the LayoutModifier class, and change the Stack parameter to redoLayout to a Maybe Stack one. It also changes all affected code. This should should be a refactoring without any change in program behaviour. ] [SmartBorders even for empty layouts Joachim Breitner <mail(a)joachim-breitner.de>**20081005184426 Fixes: http://code.google.com/p/xmonad/issues/detail?id=223 ] [Paste.hs: improve haddocks gwern0(a)gmail.com**20080927150158] [Paste.hs: fix haddock gwern0(a)gmail.com**20080927145238] [minor explanatory comment daniel(a)wagner-home.com**20081003015919] [XMonad.Layout.HintedGrid: add GridRatio (--no-test because of haddock breakage) Lukas Mai <l.mai(a)web.de>**20080930141715] [XMonad.Util.Font: UTF8 -> USE_UTF8 Lukas Mai <l.mai(a)web.de>**20080930140056] [Paste.hs: implement noModMask suggestion gwern0(a)gmail.com**20080926232056] [fix a divide by zero error in Grid daniel(a)wagner-home.com**20080926204148] [-DUTF8 flag with -DUSE_UTF8 gwern0(a)gmail.com**20080921154014] [XSelection.hs: use CPP to compile against utf8-string gwern0(a)gmail.com**20080920151615] [add XMonad.Config.Azerty Devin Mullins <me(a)twifkak.com>**20080924044946] [flip GridRatio to match convention (x/y) Devin Mullins <me(a)twifkak.com>**20080922033354] [let Grid have a configurable aspect ratio goal daniel(a)wagner-home.com**20080922010950] [Paste.hs: +warning about ASCII limitations gwern0(a)gmail.com**20080921155038] [Paste.hs: shorten comment lines to under 80 columns per sjanssen gwern0(a)gmail.com**20080921154950] [Forgot to enable historyFilter :( Spencer Janssen <spencerjanssen(a)gmail.com>**20080921094254] [Prompt: add configurable history filters Spencer Janssen <spencerjanssen(a)gmail.com>**20080921093453] [Update my config to use 'statusBar' Spencer Janssen <spencerjanssen(a)gmail.com>**20080921063513] [Rename pasteKey functions to sendKey Spencer Janssen <spencerjanssen(a)gmail.com>**20080921062016] [DynamicLog: doc fixes Spencer Janssen <spencerjanssen(a)gmail.com>**20080921061314] [Move XMonad.Util.XPaste to XMonad.Util.Paste Spencer Janssen <spencerjanssen(a)gmail.com>**20080921060947] [statusBar now supplies the action to toggle struts Spencer Janssen <spencerjanssen(a)gmail.com>**20080918013858] [cleanup - use currentTag Devin Mullins <me(a)twifkak.com>**20080921011159] [XPaste.hs: improve author info gwern0(a)gmail.com**20080920152342] [+XMonad.Util.XPaste: a module for pasting strings to windows gwern0(a)gmail.com**20080920152106] [UrgencyHook bug fix: cleanupUrgents should clean up reminders, too Devin Mullins <me(a)twifkak.com>**20080920062117] [Sketch of XMonad.Config.Monad Spencer Janssen <spencerjanssen(a)gmail.com>**20080917081838] [raiseMaster seanmce33(a)gmail.com**20080912184830] [Add missing space between dzen command and flags Daniel Neri <daniel.neri(a)sigicom.com>**20080915131009] [Big DynamicLog refactor. Added statusBar, improved compositionality for dzen and xmobar Spencer Janssen <spencerjanssen(a)gmail.com>**20080913205931 Compatibility notes: - dzen type change - xmobar type change - dynamicLogDzen removed - dynamicLogXmobar removed ] [Take maintainership of XMonad.Prompt Spencer Janssen <spencerjanssen(a)gmail.com>**20080911230442] [Overhaul Prompt to use a zipper for history navigation. Fixes issue #216 Spencer Janssen <spencerjanssen(a)gmail.com>**20080911225940] [Use the new completion on tab setting Spencer Janssen <spencerjanssen(a)gmail.com>**20080911085940] [Only start to show the completion window with more than one match Joachim Breitner <mail(a)joachim-breitner.de>**20080908110129] [XPrompt: Add showCompletionOnTab option Joachim Breitner <mail(a)joachim-breitner.de>**20080908105758 This patch partially implements http://code.google.com/p/xmonad/issues/detail?id=215 It adds a XPConfig option that, if enabled, hides the completion window until the user presses Tab once. Default behaviour is preserved. TODO: If Tab causes a unique completion, continue to hide the completion window. ] [XMonad.Actions.Plane.planeKeys: function to make easier to configure Marco Túlio Gontijo e Silva <marcot(a)riseup.net>**20080714153601] [XMonad.Actions.Plane: removed unneeded hiding Marco Túlio Gontijo e Silva <marcot(a)riseup.net>**20080714152631] [Improvements in documentation Marco Túlio Gontijo e Silva <marcot(a)riseup.net>**20080709002425] [Fix haddock typos in XMonad.Config.{Desktop,Gnome,Kde} Spencer Janssen <spencerjanssen(a)gmail.com>**20080911040808] [add clearUrgents for your keys Devin Mullins <me(a)twifkak.com>**20080909055425] [add reminder functionality to UrgencyHook Devin Mullins <me(a)twifkak.com>**20080824200548 I'm considering rewriting remindWhen and suppressWhen as UrgencyHookModifiers, so to speak. Bleh. ] [TAG 0.8 Spencer Janssen <spencerjanssen(a)gmail.com>**20080905195420] Patch bundle hash: c25bdc9fad76dda0fec8dc42650397a3cdf980f5

3 3

darcs patch: keyActions moved to XState
by Marco Túlio Gontijo e Silva 09 Feb '09

09 Feb '09

Tue Jul 15 11:34:36 BRT 2008 Marco Túlio Gontijo e Silva <marcot(a)riseup.net> * keyActions moved to XState

2 2

darcs patch: Improvements in documentation (and 3 more)
by Marco Túlio Gontijo e Silva 06 Feb '09

06 Feb '09

Tue Jul 8 21:24:25 BRT 2008 Marco Túlio Gontijo e Silva <marcot(a)riseup.net> * Improvements in documentation Mon Jul 14 12:26:31 BRT 2008 Marco Túlio Gontijo e Silva <marcot(a)riseup.net> * XMonad.Actions.Plane: removed unneeded hiding Mon Jul 14 12:32:48 BRT 2008 Marco Túlio Gontijo e Silva <marcot(a)riseup.net> * XMonad.Config.Gnome: using XMonad.Actions.Plane Mon Jul 14 12:36:01 BRT 2008 Marco Túlio Gontijo e Silva <marcot(a)riseup.net> * XMonad.Actions.Plane.planeKeys: function to make easier to configure

3 3

darcs patch: XMonad.Actions.DynamicKeys: utilities to update key bi...
by Marco Túlio Gontijo e Silva 06 Feb '09

06 Feb '09

Thu Jul 10 19:04:10 BRT 2008 Marco Túlio Gontijo e Silva <marcot(a)riseup.net> * XMonad.Actions.DynamicKeys: utilities to update key bindings at runtime

2 1

xmonad-contrib patch
by Lanny Ripple 06 Feb '09

06 Feb '09

Hi all, Just wanted to say Thanks! to everyone for XMonad. I've got it running with gnome for the panels but it blows the gnome WM out of the water. I did run across some functionality I wanted that didn't exist so I wrote it up (attached). On reflection I should have added a long patch message. I found WindowGo for runOrRaise but often I want to pull a window (browser, mail, etc) to my current workspace instead of going to the one it's in. copyOrRun (and underlying copyMaybe) do that. Cheers, -ljr New patches: [XMonad.Actions.CopyWindow runOrCopy lan3ny(a)gmail.com**20080602205742] { hunk ./XMonad/Actions/CopyWindow.hs 5 --- Copyright : (c) David Roundy <droundy(a)darcs.net>, Ivan Veselov <veselov(a)gmail.com> +-- Copyright : (c) David Roundy <droundy(a)darcs.net>, Ivan Veselov <veselov(a)gmail.com>, Lanny Ripple <lan3ny(a)gmail.com> hunk ./XMonad/Actions/CopyWindow.hs 20 - copy, copyToAll, copyWindow, killAllOtherCopies, kill1 + copy, copyToAll, copyWindow, runOrCopy + , killAllOtherCopies, kill1 hunk ./XMonad/Actions/CopyWindow.hs 25 +import Control.Monad (filterM) hunk ./XMonad/Actions/CopyWindow.hs 55 +-- Instead of copying a window from a workset to a workset maybe you don't +-- want to have to remember where you placed it. For that consider: +-- +-- > , ((modMask x, xK_b ), runOrCopy "firefox" (className =? "Firefox")) -- @@ run or copy firefox +-- hunk ./XMonad/Actions/CopyWindow.hs 68 --- > , ((modMask x, xK_v )", windows copyToAll) -- @@ Make focused window always visible +-- > , ((modMask x, xK_v ), windows copyToAll) -- @@ Make focused window always visible hunk ./XMonad/Actions/CopyWindow.hs 74 --- | copy. Copy the focussed window to a new workspace. +-- | copy. Copy the focused window to a new workspace. hunk ./XMonad/Actions/CopyWindow.hs 94 + +-- | runOrCopy . runOrCopy will run the provided shell command unless it can +-- find a specified window in which case it will copy the window to +-- the current workspace. Similar to (i.e., stolen from) "XMonad.Actions.WindowGo". +runOrCopy :: String -> Query Bool -> X () +runOrCopy action = copyMaybe $ spawn action + +-- | copyMaybe. Flatters "XMonad.Actions.WindowGo" ('raiseMaybe') +copyMaybe :: X () -> Query Bool -> X () +copyMaybe f thatUserQuery = withWindowSet $ \s -> do + maybeResult <- filterM (runQuery thatUserQuery) (allWindows s) + case maybeResult of + [] -> f + (x:_) -> windows $ copyWindow x (currentTag s) + } Context: [Add missing xfce module to .cabal Don Stewart <dons(a)galois.com>**20080602174219] [Use lines instead of columns in configuration (similar to GNOME and KDE) Malebria <malebria(a)riseup.net>**20080526225337] [Bug correction when areasColumn > 1 Malebria <malebria(a)riseup.net>**20080526223220] [more documentation for WindowNavigation and UrgencyHook Devin Mullins <me(a)twifkak.com>**20080525050231] [X.A.WindowNavigation: add logHook for better state tracking Devin Mullins <me(a)twifkak.com>**20080525032325] [doco tweaks Devin Mullins <me(a)twifkak.com>**20080524211849] [made fadeInactiveLogHook take an argument amount to fade Justin Bogner <mail(a)justinbogner.com>**20080523213937] [add FadeInactive to fade out inactive windows using xcompmgr Justin Bogner <mail(a)justinbogner.com>**20080523205838] [add close window functionality to EwmhDesktops Justin Bogner <mail(a)justinbogner.com>**20080523185908] [Add XMonad.Actions.Plane Malebria <malebria(a)riseup.net>**20080523004357] [Default Xfce config, this time with me holding the copyright, maintainership, etc. Ivan.Miljenovic(a)gmail.com**20080522105316] [StackTile: minor documentation fix Joachim Fasting <joachim.fasting(a)gmail.com>**20080521182637 That '[]' in the example seems incorrect ] [StackTile acura(a)allyourbase.se**20080520195559 A simple patch to get a dishes like stacking, but with the ability to resize master pane. ] [revamp Search.hs to export a replacement for simpleEngine gwern0(a)gmail.com**20080519190912 It's called searchEngine now, and is a wrapper around the SearchEngine type. Different type as well ] [sp ShowWName.hs gwern0(a)gmail.com**20080519190520] [remove ScratchWorkspace. David Roundy <droundy(a)darcs.net>**20080516185729 It's ugly code, and I'd be surprised if anyone actually uses it. I see no reason to continue to maintain it. ] [Fixed location of xmonad.conf Roman Cheplyaka <roma(a)ro-che.info>**20080518204602] [add site name in search prompt dialog zhen.sydow(a)gmail.com**20080518101357] [add youtube to search engines zhen.sydow(a)gmail.com**20080513212508] [SwapWorkspaces: swapTo Next|Prev Devin Mullins <me(a)twifkak.com>**20080518024121] [UrgencyHook: removeVisiblesFromUrgents -> cleanupUrgents Devin Mullins <me(a)twifkak.com>**20080515164436 Now only removes windows based on SuppressWhen setting. ] [Added XMonad.Config.PlainConfig: proof-of-concept GHC-less plain text configuration file parser Braden Shepherdson <Braden.Shepherdson(a)gmail.com>**20080517222916 An example of the config file format can be found in the Haddock. Notably missing features are docks and more layouts than just the standard three. ] [XMonad.Hooks.SetWMName: Update documentation to reflect the addition of startupHook. lithis <xmonad(a)selg.hethrael.org>**20080516221011] [I no longer use ScratchWorkspace. David Roundy <droundy(a)darcs.net>**20080516185715] [fix bug in smartBorders when combined with decorated windows. David Roundy <droundy(a)darcs.net>**20080516184855] [decent documentation for UrgencyHook Devin Mullins <me(a)twifkak.com>**20080515082222 Blame it on lack of sleep. Or perhaps the causation is the reverse. ] [X.A.WindowNavigation: currentPosition and setPosition share the same `inside` logic, now Devin Mullins <me(a)twifkak.com>**20080515062211 Aside from documentation, this is pretty much usable, now. ] [X.A.WindowNavigation: have currentPosition handle axes independently Devin Mullins <me(a)twifkak.com>**20080515053330 This improves some subtle interactions between mod-j/k and mod-w/a/s/d, though that might not become very apparent until I fix setPosition. ] [fix compile warnings in BoringWindows Devin Mullins <me(a)twifkak.com>**20080515051728] [add BoringWindows module to make certain windows skipped when rotating focus. David Roundy <droundy(a)darcs.net>**20080514162846] [UrgencyHook: some documentation (more is needed) Devin Mullins <me(a)twifkak.com>**20080514080104] [UrgencyHook: got rid of the need for instances to know about suppressWhen Devin Mullins <me(a)twifkak.com>**20080514072217 This changes the API a little bit, but that's what you get for using a day-old feature from darcs. ] [move AppLauncher from Actions module to Prompt module zhen.sydow(a)gmail.com**20080513201252] [X.A.WindowNavigation: comment cleanup Devin Mullins <me(a)twifkak.com>**20080513091313] [windowRect now compensates for border width Devin Mullins <me(a)twifkak.com>**20080513090151 Odd that I have to do (Rectangle x y (w + 2 * bw) (h + 2 * bw)) -- you'd think the window would be centered within the bordered area. ] [X.A.WindowNavigation: update TODO Devin Mullins <me(a)twifkak.com>**20080513044229] [X.A.WindowNavigation: minor cleanup Devin Mullins <me(a)twifkak.com>**20080512170410] [X.A.WindowNavigation: simplify inr somewhat Devin Mullins <me(a)twifkak.com>**20080512090647] [X.A.WindowNavigation: clarity Devin Mullins <me(a)twifkak.com>**20080512085338] [X.A.WindowNavigation: ugh, typo Devin Mullins <me(a)twifkak.com>**20080512082228] [X.A.WindowNavigation: implement swap, extract withTargetWindow commonality Devin Mullins <me(a)twifkak.com>**20080512064715 Why doesn't mapWindows exist already? ] [add more flexible withWindowNavigationKeys Devin Mullins <me(a)twifkak.com>**20080512050637 Names aren't permanent yet, so don't cry if they change. ] [X.A.WindowNavigation: TODO Devin Mullins <me(a)twifkak.com>**20080511222116] [X.A.WindowNavigation: add withWindowNavigation, for easy setup Devin Mullins <me(a)twifkak.com>**20080511220458 This should be more flexible than it is -- I've got an idea, but am interested to hear others. ] [X.A.WindowNavigation: fix currentPosition Devin Mullins <me(a)twifkak.com>**20080511212128 Now properly deals with an unitialized state (e.g. from a restart) or an inconsistent state (e.g. from using mod-j/k). Deserves cleanup. ] [X.A.WindowNavigation: add TODOs Devin Mullins <me(a)twifkak.com>**20080511211326] [X.A.WindowNavigation state is now workspace-specific Devin Mullins <me(a)twifkak.com>**20080511071656 racking up some code debt, here... ] [X.A.WindowNavigation: minor doco changes Devin Mullins <me(a)twifkak.com>**20080506074235] [add draft XMonad.Actions.WindowNavigation Devin Mullins <me(a)twifkak.com>**20080504050022 This is an experiment with replacing the WindowNavigation LayoutModifier with one that simply adds keybindings and stores state in an IORef. Credit to droundy for the original code -- hopefully I'm not butchering it. The end intent is to add Xinerama support, but it'll be a little while before I get there. ] [new contrib module to launch apps with command line parameters zhen.sydow(a)gmail.com**20080513134754] [pull suppressWhen logic into main WithUrgencyHook handler Devin Mullins <me(a)twifkak.com>**20080513075247 In order for this to work, I added a new UrgencyHook method to communicate the SuppressWhen value. I'm not sure if this is actually better than just providing a convenience function, but it's an easy switch. ] [add suppressWhen option to dzenUrgencyHook Devin Mullins <me(a)twifkak.com>**20080513054615] [WindowNavigation: extract navigable function Devin Mullins <me(a)twifkak.com>**20080422045248] [UrgencyHook: doc typo Devin Mullins <me(a)twifkak.com>**20080512052137] [UrgencyHook: extract whenNotVisible Devin Mullins <me(a)twifkak.com>**20080512041852] [SpawnUrgencyHook, FWIW Devin Mullins <me(a)twifkak.com>**20080512040449] [make UrgencyHook an EventHook Devin Mullins <me(a)twifkak.com>**20080512024822 This gets rid of the stupid bug that led to a need for the clearBit hack, and allowed me to simplify the types (since EventHooks aren't required to parameterize on the window type). Config files need not change, unless they declare instances of UrgencyHook, in which case, they should remove "Window" as is seen in this patch. ] ['xmobar' function added to DynamicLog for running xmobar with some defaults Ivan N. Veselov <veselov(a)gmail.com>**20080508194918] [HintedTile: Fix mistake in documentation. lithis <xmonad(a)selg.hethrael.org>**20080508003552] [Use gnome-session-save for the mod-shift-q binding Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507082205] [Use the named constant 'none' rather than 0 Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507081854] [HintedTile: Improve documentation. lithis <xmonad(a)selg.hethrael.org>**20080508000245] [Whitespace only Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507031306] [Add a binding for Gnome's "Run Application" dialog Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507031127] [Add some keybindings to the Kde config Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507022658] [Indentation Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507022553] [Add ToggleStruts to the desktop config Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507022516] [Refactor my config Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507021504] [Add XMonad.Config.Kde Spencer Janssen <sjanssen(a)cse.unl.edu>**20080507020833] [Don't move the pointer if the user is moving the mouse Klaus Weidner <kweidner(a)pobox.com>**20080417022234 This patch depends on the following xmonad core patch: Remember if focus changes were caused by mouse actions or by key commands If the user was moving the mouse, it's not appropriate to move the pointer around in resonse to focus changes. Do that only in response to keyboard commands. ] [Missing pragmas Don Stewart <dons(a)galois.com>**20080506053402] [Add full documentation Don Stewart <dons(a)galois.com>**20080505210546] [minor cleanup on getName Devin Mullins <me(a)twifkak.com>**20080504054923] [bug doco for UrgencyHook Devin Mullins <me(a)twifkak.com>**20080426203638] [NamedWindows: when converting the text property, handle the empty list. Spencer Janssen <sjanssen(a)cse.unl.edu>**20080502104249 This fixes a "Prelude.head" exception observed with windows that have no title. Reproduce by placing several windows in the tabbed layout, then starting 'xterm -name ""'. Thanks to Andrea for pointing out the issue. ] [Fix issue #179 by handling events correctly Andrea Rossato <andrea.rossato(a)unibz.it>**20080501062357] [My monitor is larger now :) Spencer Janssen <sjanssen(a)cse.unl.edu>**20080430083026] [manageHooks for my config Spencer Janssen <sjanssen(a)cse.unl.edu>**20080430082536] [Remove redundant type signature Spencer Janssen <sjanssen(a)cse.unl.edu>**20080430082447] [Add XMonad.Config.Desktop and XMonad.Config.Gnome Spencer Janssen <sjanssen(a)cse.unl.edu>**20080430082253] [Alphabetize exposed-modules Spencer Janssen <sjanssen(a)cse.unl.edu>**20080430035453] [new contrib layout: XMonad.Layout.SimplestFloat - A floating layout like SimpleFloat, but without decoration joamaki(a)gmail.com**20080424220957] [stricitfy some gap fields Don Stewart <dons(a)galois.com>**20080427191247] [XMonad.Hooks.ManageHelpers: quick&dirty support for _NET_WM_STATE_FULLSCREEN Lukas Mai <l.mai(a)web.de>**20080426132745] [XMonad.Hooks.Script: haddock fixes Lukas Mai <l.mai(a)web.de>**20080426132629] [Error fix for Tabbed when tabbar always shown Ivan.Miljenovic(a)gmail.com**20080424063135] [remove my config file -- the wiki is where its at. Don Stewart <dons(a)galois.com>**20080419195650] [tweaks to docs for SimpleDecoration Don Stewart <dons(a)galois.com>**20080418215155] [Allow tabbar to always be shown. Ivan.Miljenovic(a)gmail.com**20080415043728 Patch take 4, hopefully the final version. Includes droundy's suggestions. ] [polish Don Stewart <dons(a)galois.com>**20080418033133] [Script-based hooks Trevor Elliott <trevor(a)galois.com>**20080416213024] [Don't strictify the Display component, this triggers a bug in GHC 6.6 Spencer Janssen <sjanssen(a)cse.unl.edu>**20080416185733] [Fix to IM modifier. Roman Cheplyaka <roma(a)ro-che.info>**20080414232437 Avoid differentiating integrated stack by using StackSet.filter. ] [IM layout converted to LayoutModifier, which can be applied to any layout Ivan N. Veselov <veselov(a)gmail.com>**20080413205824] [stictify some fields Don Stewart <dons(a)galois.com>**20080413070117] [strictify some fields Don Stewart <dons(a)galois.com>**20080413065958] [Fix window order in EWMH Joachim Breitner <mail(a)joachim-breitner.de>**20080411134411 For pagers to draw the stacking order correctly, the focused window has to be the last in the list. Thus put an appropriate implementation of allWindows into the Module. This does not work perfectly with floating windows. ] [remove myself as maintainer of CopyWindow. David Roundy <droundy(a)darcs.net>**20080409144333 I'm not sure who's maintaining this, but it's not me. ] [XMonad.Util.WindowProperties: add WM_WINDOW_ROLE as Role Roman Cheplyaka <roma(a)ro-che.info>**20080409174935] [Generalize copyWindow, minor style change Spencer Janssen <sjanssen(a)cse.unl.edu>**20080408210050] [XMonad.Actions.CopyWindow: added copyToAll and killAllOtherCopies functions Ivan N. Veselov <veselov(a)gmail.com>**20080408195111] [XMonad.Actions.UpdatePointer: doc fix Lukas Mai <l.mai(a)web.de>**20080407152741] [XMonad.Util.Font: minor reformatting Lukas Mai <l.mai(a)web.de>**20080406020935] [DynamicLog: resolve merge conflict Lukas Mai <l.mai(a)web.de>**20080406020527] [Encode the entire DynamicLog output, instead of just window title. lithis <xmonad(a)selg.hethrael.org>**20080329031537] [DynamicLog: add support for UTF-8 locales when compiled with XFT or UFT-8 support Andrea Rossato <andrea.rossato(a)unibz.it>**20080313102643] [XMonad.Util.Font: don't call setlocale; core does it for us Lukas Mai <l.mai(a)web.de>**20080406013123] [XMonad.Util.NamedWindows: fix imports Lukas Mai <l.mai(a)web.de>**20080326172745] [Changed getName to use locale-aware functions Mats Jansborg <mats(a)jansb.org>**20070819132104 Rewrote getName using getTextProperty and wcTextPropertyToTextList. ] [Added next-window versions of the raise* functions. Ian Zerny <ian(a)zerny.dk>**20080405182900] [XMonad.Layout.Master: initial import Lukas Mai <l.mai(a)web.de>**20080404220734] [update contrib for applySizeHints changes Lukas Mai <l.mai(a)web.de>**20080404220558] [XMonad.Hooks.ManageDocks: haddock fix Lukas Mai <l.mai(a)web.de>**20080404220532] [MultiToggle/Instances: ghc 6.6 can't parse LANGUAGE pragma Brent Yorgey <byorgey(a)gmail.com>**20080404200157] [Document _NET_ACTIVE_WINDOW behaviour more exactly Joachim Breitner <mail(a)joachim-breitner.de>**20080404072944] [_NET_ACTIVE_WINDOW moves windows if necessary Joachim Breitner <mail(a)joachim-breitner.de>*-20080402143811 This makes EWMH behave a bit more like metacity: If _NET_ACTIVE_WINDOW is received and the window is not on the current worspace, it is brought here (instead of the workspace switched to the other one). So for example, if you click on the pidgin icon in the panel and the buddy list is already open some where it is moved here. ] [onstart=lower, solves floating dzen issue Don Stewart <dons(a)galois.com>**20080403203425] [some bang patterns Don Stewart <dons(a)galois.com>**20080403172246] [have 'dzen' use autoStruts to detect the gaps Don Stewart <dons(a)galois.com>**20080403003130] [Actions/Search.hs: add dictionary.com search Brent Yorgey <byorgey(a)gmail.com>**20080402150521] [_NET_ACTIVE_WINDOW moves windows if necessary Joachim Breitner <mail(a)joachim-breitner.de>**20080402143811 This makes EWMH behave a bit more like metacity: If _NET_ACTIVE_WINDOW is received and the window is not on the current worspace, it is brought here (instead of the workspace switched to the other one). So for example, if you click on the pidgin icon in the panel and the buddy list is already open some where it is moved here. ] [HintedGrid: guesstimate window flexibility and layout rigid windows first Lukas Mai <l.mai(a)web.de>**20080402042846] [HintedGrid: try both bottom-up/top-down window placement to minimize unused space Lukas Mai <l.mai(a)web.de>**20080402012538] [Grid/HintedGrid: use an ncolumns formula inspired by dwm's "optimal" mode Lukas Mai <l.mai(a)web.de>**20080402012126] [XMonad.Layout.Gaps: new contrib module for manual gap support, in the few cases where ManageDocks is not appropriate (dock apps that don't set STRUTS properly, adjusting for a display that is cut off on one edge, etc.) Brent Yorgey <byorgey(a)gmail.com>**20080402003742] [improve WindowGo.hs Haddock formatting gwern0(a)gmail.com**20080401023130] [forgot a haddock for getEditor in Shell.hs gwern0(a)gmail.com**20080401022012] [WindowGo.hs: +raiseBrowser, raiseEditor gwern0(a)gmail.com**20080401021740 Specialize runOrRaise in the same way as with Actions.Search, for one's browser and one's editors. ] [RunOrRaise.hs: FF 3 doesn't use the "Firefox-bin" classname gwern0(a)gmail.com**20080401015049] [Search.hs: remove an argument from selectSearch and promptSearch gwern0(a)gmail.com**20080401013947 The new getBrowser function allows us to mv the old selectSearch and promptSearch aside as too-general functions, and replace them with new versions, which employ getBrowser to supply one more argument. This allows us to replace the tedious 'selectSearch google "firefox"; selectSearch yahoo "firefox"...' with shorter 'selectSearch google' and so on. One less argument. Also, update the docs. ] [Shell.hs: +getBrowser, getEditor, helper function gwern0(a)gmail.com**20080401013447 The helper function asks the shell for the value of a variable, else returns the second argument. getBrowser and getEditor obviously specialize it for two particular possibly queries ] [XMonad.Layout.HintedGrid: initial import Lukas Mai <l.mai(a)web.de>**20080401231722] [Documentation improvement. Roman Cheplyaka <roma(a)ro-che.info>**20080401134305] [Remove broken link to screenshot. Roman Cheplyaka <roma(a)ro-che.info>**20080331210854] [MultiToggle: add new XMonad.Layout.MultiToggle.Instances module for common instances of Transformer, update MultiToggle docs accordingly Brent Yorgey <byorgey(a)gmail.com>**20080331201739] [XMonad.Actions.CycleRecentWS: initial import Michal Janeczek <janeczek(a)gmail.com>**20080331111906] [XMonad.Hooks.ManageDocks: export checkDoc Lukas Mai <l.mai(a)web.de>**20080331012911] [XMonad.Layout.Grid: fix indentation Lukas Mai <l.mai(a)web.de>**20080330004859] [move Direction type from WindowNavigation to ManageDocks (ManageDocks will move into the core, taking Direction with it) Brent Yorgey <byorgey(a)gmail.com>**20080331010127] [ManageDocks: clean up + add more documentation Brent Yorgey <byorgey(a)gmail.com>**20080331002929] [Util.Run, Hooks.DynamicLog: re-export hPutStrLn and hPutStr from Util.Run for convenience, and update DynamicLog documentation to show proper imports Brent Yorgey <byorgey(a)gmail.com>**20080328205446] [ManageDocks: add avoidStrutsOn, for covering some docks and not others by default. Brent Yorgey <byorgey(a)gmail.com>**20080327203940] [ManageDocks: add ability to toggle individual gaps independently Brent Yorgey <byorgey(a)gmail.com>**20080327111722] [PerWorkspace: add modWorkspace(s) combinators, for selectively applying layout modifiers to certain workspaces but not others Brent Yorgey <byorgey(a)gmail.com>**20080326214351] [Haddock fix Roman Cheplyaka <roma(a)ro-che.info>**20080330134435] [Remove stale status gaps code Spencer Janssen <sjanssen(a)cse.unl.edu>**20080329230737] [TAG 0.7 Spencer Janssen <sjanssen(a)cse.unl.edu>**20080329202416] Patch bundle hash: 5157bf911d10104199e1082ce9ab21409a87d1bd

2 5

darcs patch: Actions.DisplayUI, for displaying bindings onscreen during screencasts
by wirtwolff 27 Jan '09

27 Jan '09

This is an XConfig modifier designed to be used with external display program like dzen2 or osd_cat. You give it a String -> X(), it modifies bindings so when you use one, whatever your function does with the string representing that key or mouse binding is sequenced with the normal action. There's a custom format version too. It doesn't work with submapped keys, i.e. sequences like "M-x f". Amazing how something with the potential to screw up every single action in XMonad never once broke my xmonad. Yay for xmonad's design, monads, and functional programming! regards, Wirt Sat Nov 1 22:51:09 MDT 2008 Wirt Wolff <wirtwolff(a)gmail.com> * Actions.DisplayUI, for displaying bindings onscreen during screencasts New patches: [Actions.DisplayUI, for displaying bindings onscreen during screencasts Wirt Wolff <wirtwolff(a)gmail.com>**20081102045109] { addfile ./XMonad/Actions/DisplayUI.hs hunk ./XMonad/Actions/DisplayUI.hs 1 +-------------------------------------------------------------------- +-- | +-- Module : XMonad.Actions.DisplayUI +-- Copyright : Wirt Wolff <wirtwolff(a)gmail.com> +-- License : BSD3-style (see LICENSE) +-- +-- Maintainer : Wirt Wolff <wirtwolff(a)gmail.com> +-- +-- Functions for displaying key and mouse bindings on screen while +-- making screencasts, along with related helper functions. DisplayUI +-- does not provide a way to display or parse the related X() actions +-- from files. It also does not display submapped keys, i.e. a sequence +-- like \"M1-x f\" will only display \"M1-x\". It was designed to be used with +-- an external on screen display program like osd_cat or dzen2, but can +-- be used for any String -> X(). +-- +-- (See also "XMonad.Util.EZConfig", "XMonad.Actions.Submap" in xmonad-contrib.) +-- +-------------------------------------------------------------------- + +module XMonad.Actions.DisplayUI ( + -- * Usage + -- $usage + + displayUI, + + -- * Using a custom UI display format + -- $formats + displayUIWith, + UIFormat (..), + defaultUIFormat, altUIFormat, longUIFormat, hsUIFormat, + + -- * Troubleshooting + -- $troubleshooting + + -- * toString utilities + -- $tostring + keyToString, mouseToString, + modifierToString, + keyToStringWith, mouseToStringWith, + modifierToStringWith + + ) where + + +import XMonad + +import Data.Bits ((.&.)) +import Graphics.X11.Xlib (keysymToString) +import Data.List (zip, filter, intercalate) +import qualified Data.Map as M (mapWithKey) + + +-- $usage +-- To use this module, first add it to the imports in your @~\/.xmonad\/xmonad.hs@: +-- Import "XMonad.Util.Run", too, if you haven't already, to spawn shell programs. +-- +-- > import XMonad +-- > -- other imports ... +-- > import XMonad.Actions.DisplayUI +-- > import XMonad.Util.Run +-- +-- Choose an on screen display program, such as dzen2, or osd_cat (part of the +-- xosd library.) You probably want something which accepts text on its stdin. +-- osd_cat gives a transparent background effect like television OSD's. dzen2 has +-- an opaque background of whatever color you choose. Define a function from type +-- String to X() with parameters appropriate for your configuration. Anything you +-- could bind a key to will work for the value of your function. +-- +-- For example: +-- If running the command @echo \"Some message\" | osd_cat -o 100 -i 500 -c '#4f2'@ +-- @ -d 1 -f '-*-terminus-bold-r-*-*-32-*-*-*-*-*-*-*'@ in a shell gives the effect +-- you are after, add the following @osd_cat = ...@ definition outside your existing +-- xmonad configuration. Also include a type signature, e.g. @osd_cat :: String -> X()@. +-- +-- > main = xmonad $ defaultConfig { terminal = "urxvt" } +-- > `additionalKeys` +-- > [ ((mod1Mask, xK_F12), spawn "xscreensaver-command -lock") +-- > , ((mod1Mask .|. controlMask, xK_Return), spawn "specialTerminal") +-- > ] +-- > +-- > osd_cat :: String -> X() +-- > osd_cat = \ui -> spawn $ "echo '" ++ ui ++ "' | osd_cat --offset 100 \ +-- > \ --indent 500 --color '#4f2' --delay 1 \ +-- > \ --font '-*-terminus-bold-r-*-*-32-*-*-*-*-*-*-*'" +-- +-- Using dzen2 it would be something like this: +-- +-- > osdDzen :: String -> X() +-- > osdDzen = \ui -> spawn $ "echo '" ++ ui ++ "' | dzen2 -x 500 -y 100 -w 600 \ +-- > \ -ta c -fg '#4f2' -p 1 -h 48 \ +-- > \ -fn '-*-terminus-bold-r-*-*-32-*-*-*-*-*-*-*'" +-- +-- (Note the \' \' quotes around the ui string, colors, and fonts.) To +-- see what core fonts and sizes are available, run @xfontsel@. dzen2 +-- and osd_cat do not currently support fontconfig/xft. +-- +-- Now add a 'displayUI' or 'displayUIWith' line to modify your XMonad config +-- to run the X() action you set up and have XMonad display user interface +-- bindings as you use them. +-- +-- > main = xmonad $ +-- > displayUI osdDzen $ +-- > defaultConfig { terminal = "urxvt" } +-- > `additionalKeys` +-- > [ ((mod1Mask, xK_F12), spawn "xscreensaver-command -lock") +-- > , ((mod1Mask .|. controlMask, xK_Return), spawn "specialTerminal") +-- > ] +-- +-- You don't have to put @displayUI osdDzen $@ on a separate line, but +-- it's easier to comment out since you're probably only using this module +-- for making screencasts. Now if all's in place, simply save the file, +-- @mod-q@ and you should have bindings being displayed when you use them. +-- +-- The default 'displayUI' format is very close to the one in "XMonad.Util.EZConfig"\'s +-- @additionalKeysP@ and @additionalMouseBindings@ functions, but without the +-- angle brackets, e.g. \"M3-C-S-F9\", \"M4-button3\". DisplayUI always uses "Graphics.X11" +-- @keysymToString@ to choose what string will be displayed for keys. These are +-- as in the keysymdef.h file (usually in \/usr\/include\/X11\/) less the xK_ part. + +-- $formats +-- 'displayUIWith' takes an additional argument: a 'UIFormat' record describing +-- how to format the user interface binding strings. In addition to the default, +-- some ready made ones are provided: 'longUIFormat' (\"Mod4-Shift-space\", +-- \"Mod4-MouseButton3\", etc.) 'altUIFormat' (\"alt-win-F9\"), and for fun, 'hsUIFormat' +-- that builds strings like \"shiftMask .|. mod1Mask, xK_F4\". For example: +-- +-- > main = xmonad $ +-- > displayUIWith altUIFormat osd_cat $ +-- > defaultConfig { terminal = "urxvt" } +-- + +-- | UIFormat records define how to display the modifiers, keys, buttons, and bindings +-- as a whole. The modifier string list, @mods@, is in bit order, least significant bit first, +-- the same as xmodmap. (caps) lockMask is left as empty string in the predefined UIFormats. +-- For example, here is the definition of altUIFormat: +-- +-- > altUIFormat :: UIFormat +-- > altUIFormat = UIFormat { +-- > mods = ["shift", "", "ctrl", "alt", "mod2", "mod3", "win", "mod5"] +-- > , modSep = "-" -- string to separate modifiers +-- > , lastSep = "-" -- string to separate modifiers from key or button +-- > , button = "mouse" +-- > } +-- +data UIFormat = UIFormat + { mods :: [String] -- string used to display each modifier (in bit order 0..) + , modSep :: String + , lastSep :: String + , button :: String + } + +-- | Close to "XMonad.Util.EZConfig" parser format, but no angle brackets +defaultUIFormat :: UIFormat +defaultUIFormat = UIFormat + { mods = ["S", "", "C"] ++ ['M': show n | n <- [1..5]::[Int] ] + , modSep = "-" + , lastSep = "-" + , button = "button" + } + +-- | Common names from ms US keys, lower case (\"ctrl\", \"alt\",\"win\", \"mouse\") +altUIFormat :: UIFormat +altUIFormat = defaultUIFormat + { mods = ["shift", "", "ctrl", "alt", "mod2", "mod3", "win", "mod5"] + , button = "mouse" + } + +-- | Longer capitalized format (\"Control\", \"MouseButton\") +longUIFormat :: UIFormat +longUIFormat = defaultUIFormat + { mods = ["Shift", "", "Control"] ++ ["Mod" ++ show n | n <- [1..5]::[Int] ] + , button = "MouseButton" + } + +-- | May as well have a default haskell format (as in xmonad.hs) +hsUIFormat :: UIFormat +hsUIFormat = UIFormat + { mods = ["shiftMask", "", "controlMask", "mod1Mask", "mod2Mask", "mod3Mask", "mod4Mask", "mod5Mask"] + , modSep = " .|. " + , lastSep = ", xK_" + , button = "button" + } + +-- | Modifies the xmonad key and mouse bindings so that whenever one's used, +-- the normal action is performed along with a displayUI action that has use +-- of the ui binding string. displayUI's first parameter is the function from +-- a binding string to X() defining what to do. +displayUI :: (String -> X()) -> XConfig l -> XConfig l +displayUI sa conf = conf + { keys = \c -> M.mapWithKey (sequenceXk sa) (keys conf c) + , mouseBindings = \c -> M.mapWithKey (sequenceXm sa) (mouseBindings conf c) } + +-- | Combine a key binding action with a displayUI action using the default +-- "S-M4-Return" format similar to "XMonad.Util.EZConfig" additionalKeysP +sequenceXk :: (String -> X()) -> (Modifier, KeySym) -> X() -> X() +sequenceXk sa k f = (sa $ keyToString k) >> f + +-- | Combine a mouse binding action with a displayUI action using the default +-- "M4-button1" format. +sequenceXm :: (String -> X()) -> (Modifier, Button) -> (Window -> X()) -> (Window -> X()) +sequenceXm sa k f = (>> ( sa $ mouseToString k)) . f + +-- | Like displayUI, but using a custom format from UIFormat fields. +displayUIWith :: UIFormat -> (String -> X()) -> XConfig l -> XConfig l +displayUIWith fmt sa conf = conf + { keys = \c -> M.mapWithKey (sequenceXk' fmt sa) (keys conf c) + , mouseBindings = \c -> M.mapWithKey (sequenceXm' fmt sa) (mouseBindings conf c) } + +-- | Combine a key binding action with a displayUI action using a custom format. +sequenceXk' :: UIFormat -> (String -> X()) -> (Modifier, KeySym) -> X() -> X() +sequenceXk' fmt sa k f = (sa $ keyToStringWith fmt k) >> f + +-- | Combine a mouse binding action with a displayUI action using a custom format. +sequenceXm' :: UIFormat -> (String -> X()) -> (Modifier, Button) -> (Window -> X()) -> (Window -> X()) +sequenceXm' fmt sa k f = (>> (sa $ mouseToStringWith fmt k)) . f + +-- $troubleshooting +-- @osd_cat@ refused to use anything but the default --align left during my +-- testing, so if your display doesn't show, check that. Also, a common +-- problem from forums is using fonts or colors without wrapping with +-- \' \', e.g. use \'\#f00\' not \#f00 and '-*-fixed-...' not -*-fixed-... +-- +-- Key sequences, aka "XMonad.Actions.Submap" submaps aren't displayed. Only +-- the first key is shown. At some point that may get added, if it seems worth it. + +-- $tostring +-- The 'modifierToString' and 'modifierToStringWith' functions complement +-- keySymToString from the Graphics.X11 package. 'modifierToStringWith' will +-- work on buttonMasks if you add the button mask strings you want to a custom +-- UIFormat, but xmonad bindings seem to only use key masks so button masks +-- are ignored in the default 'UIFormat's. + +-- String utilities using a default format +-- | Build a default format keybinding string. e.g. \"S-M1-Space\" +keyToString :: (Modifier, KeySym) -> String +keyToString k = keyToStringWith defaultUIFormat k + +-- | Build a default format mouse binding string. e.g. \"S-M1-button3\" +mouseToString :: (Modifier, Button) -> String +mouseToString b = mouseToStringWith defaultUIFormat b + +-- | Build a default format modifier masks string. e.g. \"S-C-M4\" +modifierToString :: Modifier -> String +modifierToString m = modifierToStringWith defaultUIFormat m + +-- String utilities using a custom format +-- | Build a keybinding string using the given format. For example: +-- @keyToStringWith longUIFormat (controlMask, xK_h) == \"Control-h\"@ +keyToStringWith :: UIFormat -> (Modifier, KeySym) -> String +keyToStringWith fmt (m, sym) = + modifierToStringWith fmt m ++ (lastSep fmt) ++ keysymToString sym + +-- | Build a mouse binding string using the given format. +mouseToStringWith :: UIFormat -> (Modifier, Button) -> String +mouseToStringWith fmt (m, b) = + modifierToStringWith fmt m ++ (lastSep fmt) ++ (button fmt) ++ show b + +-- | Build a modifier masks string using the given format. +modifierToStringWith :: UIFormat -> Modifier -> String +modifierToStringWith fmt mask = intercalate (modSep fmt) $ + map snd . filter (sharesMask mask) $ zip maskList $ mods fmt + where sharesMask m (m',_) = 0 /= m .&. m' + +-- | List of modifier masks in bit order, least signifigant bit first +maskList :: [Modifier] +maskList = [shiftMask,lockMask,controlMask,mod1Mask,mod2Mask,mod3Mask,mod4Mask,mod5Mask] + ++ [button1Mask,button2Mask,button3Mask,button4Mask,button5Mask] hunk ./xmonad-contrib.cabal 77 + XMonad.Actions.DisplayUI } Context: [Prompt.hs rename deleteConsecutiveDuplicates gwern0(a)gmail.com**20081008205131 That name is really unwieldy and long. ] [Prompt.hs: have historyCompletion filter dupes gwern0(a)gmail.com**20081008204710 Specifically, it calls deleteConsecutiveDuplicates on the end product. uniqSort reverses order in an unfortunate way, so we don't use that. The use-case is when a user has added the same input many times - as it stands, if the history records 30 'top's or whatever, the completion will show 30 'top' entries! This fixes that. ] [Prompt.hs: tweak haddocks gwern0(a)gmail.com**20081008204649] [Prompt.hs: mv uniqSort to next to its confreres, and mention the trade-off gwern0(a)gmail.com**20081008192645] [Do not consider XMONAD_TIMER unknown Joachim Breitner <mail(a)joachim-breitner.de>**20081008195643] [Kill window without focusing it first Joachim Breitner <mail(a)joachim-breitner.de>**20081005002533 This patch requires the patch "add killWindow function" in xmonad. Before this patch, people would experience “workspace flicker” when closing a window via EWMH that is not on the current workspace, for example when quitting pidgin via the panel icon. ] [let MagnifyLess actually magnify less daniel(a)wagner-home.com**20081015153911] [Actions.Search: add a few search engines intrigeri(a)boum.org**20081008104033 Add Debian {package, bug, tracking system} search engines, as well as Google Images and isohunt. ] [Implement HiddenNonEmptyWS with HiddenWS and NonEmptyWS Joachim Breitner <mail(a)joachim-breitner.de>**20081006211027 (Just to reduce code duplication) ] [Add straightforward HiddenWS to WSType Joachim Breitner <mail(a)joachim-breitner.de>**20081006210548 With NonEmptyWS and HiddenNonEmptyWS present, HiddenWS is obviously missing. ] [Merge emptyLayoutMod into redoLayout Joachim Breitner <mail(a)joachim-breitner.de>**20081005190220 This removes the emptyLayoutMod method from the LayoutModifier class, and change the Stack parameter to redoLayout to a Maybe Stack one. It also changes all affected code. This should should be a refactoring without any change in program behaviour. ] [SmartBorders even for empty layouts Joachim Breitner <mail(a)joachim-breitner.de>**20081005184426 Fixes: http://code.google.com/p/xmonad/issues/detail?id=223 ] [Paste.hs: improve haddocks gwern0(a)gmail.com**20080927150158] [Paste.hs: fix haddock gwern0(a)gmail.com**20080927145238] [minor explanatory comment daniel(a)wagner-home.com**20081003015919] [XMonad.Layout.HintedGrid: add GridRatio (--no-test because of haddock breakage) Lukas Mai <l.mai(a)web.de>**20080930141715] [XMonad.Util.Font: UTF8 -> USE_UTF8 Lukas Mai <l.mai(a)web.de>**20080930140056] [Paste.hs: implement noModMask suggestion gwern0(a)gmail.com**20080926232056] [fix a divide by zero error in Grid daniel(a)wagner-home.com**20080926204148] [-DUTF8 flag with -DUSE_UTF8 gwern0(a)gmail.com**20080921154014] [XSelection.hs: use CPP to compile against utf8-string gwern0(a)gmail.com**20080920151615] [add XMonad.Config.Azerty Devin Mullins <me(a)twifkak.com>**20080924044946] [flip GridRatio to match convention (x/y) Devin Mullins <me(a)twifkak.com>**20080922033354] [let Grid have a configurable aspect ratio goal daniel(a)wagner-home.com**20080922010950] [Paste.hs: +warning about ASCII limitations gwern0(a)gmail.com**20080921155038] [Paste.hs: shorten comment lines to under 80 columns per sjanssen gwern0(a)gmail.com**20080921154950] [Forgot to enable historyFilter :( Spencer Janssen <spencerjanssen(a)gmail.com>**20080921094254] [Prompt: add configurable history filters Spencer Janssen <spencerjanssen(a)gmail.com>**20080921093453] [Update my config to use 'statusBar' Spencer Janssen <spencerjanssen(a)gmail.com>**20080921063513] [Rename pasteKey functions to sendKey Spencer Janssen <spencerjanssen(a)gmail.com>**20080921062016] [DynamicLog: doc fixes Spencer Janssen <spencerjanssen(a)gmail.com>**20080921061314] [Move XMonad.Util.XPaste to XMonad.Util.Paste Spencer Janssen <spencerjanssen(a)gmail.com>**20080921060947] [Depend on X11 >= 1.4.3 Spencer Janssen <spencerjanssen(a)gmail.com>**20080921055456] [statusBar now supplies the action to toggle struts Spencer Janssen <spencerjanssen(a)gmail.com>**20080918013858] [cleanup - use currentTag Devin Mullins <me(a)twifkak.com>**20080921011159] [XPaste.hs: improve author info gwern0(a)gmail.com**20080920152342] [+XMonad.Util.XPaste: a module for pasting strings to windows gwern0(a)gmail.com**20080920152106] [UrgencyHook bug fix: cleanupUrgents should clean up reminders, too Devin Mullins <me(a)twifkak.com>**20080920062117] [Sketch of XMonad.Config.Monad Spencer Janssen <spencerjanssen(a)gmail.com>**20080917081838] [raiseMaster seanmce33(a)gmail.com**20080912184830] [Add missing space between dzen command and flags Daniel Neri <daniel.neri(a)sigicom.com>**20080915131009] [Big DynamicLog refactor. Added statusBar, improved compositionality for dzen and xmobar Spencer Janssen <spencerjanssen(a)gmail.com>**20080913205931 Compatibility notes: - dzen type change - xmobar type change - dynamicLogDzen removed - dynamicLogXmobar removed ] [Take maintainership of XMonad.Prompt Spencer Janssen <spencerjanssen(a)gmail.com>**20080911230442] [Overhaul Prompt to use a zipper for history navigation. Fixes issue #216 Spencer Janssen <spencerjanssen(a)gmail.com>**20080911225940] [Use the new completion on tab setting Spencer Janssen <spencerjanssen(a)gmail.com>**20080911085940] [Only start to show the completion window with more than one match Joachim Breitner <mail(a)joachim-breitner.de>**20080908110129] [XPrompt: Add showCompletionOnTab option Joachim Breitner <mail(a)joachim-breitner.de>**20080908105758 This patch partially implements http://code.google.com/p/xmonad/issues/detail?id=215 It adds a XPConfig option that, if enabled, hides the completion window until the user presses Tab once. Default behaviour is preserved. TODO: If Tab causes a unique completion, continue to hide the completion window. ] [XMonad.Actions.Plane.planeKeys: function to make easier to configure Marco Túlio Gontijo e Silva <marcot(a)riseup.net>**20080714153601] [XMonad.Actions.Plane: removed unneeded hiding Marco Túlio Gontijo e Silva <marcot(a)riseup.net>**20080714152631] [Improvements in documentation Marco Túlio Gontijo e Silva <marcot(a)riseup.net>**20080709002425] [Fix haddock typos in XMonad.Config.{Desktop,Gnome,Kde} Spencer Janssen <spencerjanssen(a)gmail.com>**20080911040808] [add clearUrgents for your keys Devin Mullins <me(a)twifkak.com>**20080909055425] [add reminder functionality to UrgencyHook Devin Mullins <me(a)twifkak.com>**20080824200548 I'm considering rewriting remindWhen and suppressWhen as UrgencyHookModifiers, so to speak. Bleh. ] [TAG 0.8 Spencer Janssen <spencerjanssen(a)gmail.com>**20080905195420] Patch bundle hash: dc8f746c1319799df0ed431610cc259c77dc7a48

2 2