packages feed

xmonad 0.15 → 0.17.0

raw patch · 27 files changed

+2957/−874 lines, 27 filesdep +data-default-classdep +quickcheck-classesdep +timedep −data-defaultdep −extensible-exceptionsdep −pandocdep ~X11dep ~basedep ~mtlnew-uploader

Dependencies added: data-default-class, quickcheck-classes, time, transformers

Dependencies removed: data-default, extensible-exceptions, pandoc, regex-posix, text, utf8-string

Dependency ranges changed: X11, base, mtl, unix

Files

CHANGES.md view
@@ -1,6 +1,81 @@ # Change Log / Release Notes -## unknown (unknown)+## 0.17.0 (October 27, 2021)++### Enhancements++  * Migrated `X.L.LayoutCombinators.(|||)` into `XMonad.Layout`, providing the+    ability to directly jump to a layout with the `JumpToLayout` message.++  * Recompilation now detects `stack.yaml` (can be a symlink) alongside+    `xmonad.hs` and switches to using `stack ghc`. We also updated INSTALL.md+    with instructions for cabal-install that lead to correct recompilation.++    Deprecation warnings during recompilation are no longer suppressed to make+    it easier for us to clean up the codebase. These can still be suppressed+    manually using an `OPTIONS_GHC` pragma with `-Wno-deprecations`.++  * Improve handling of XDG directories.++      1. If all three of xmonad's environment variables (`XMONAD_DATA_DIR,`+         `XMONAD_CONFIG_DIR`, and `XMONAD_CACHE_DIR`) are set, use them.+      2. If there is a build script called `build` (see [these build scripts]+         for usage examples) or configuration `xmonad.hs` in `~/.xmonad`, set+         all three directories to `~/.xmonad`.+      3. Otherwise, use the `xmonad` directory in `XDG_DATA_HOME`,+         `XDG_CONFIG_HOME`, and `XDG_CACHE_HOME` (or their respective+         fallbacks). These directories are created if necessary.++    In the cases of 1. and 3., the build script or executable is expected to be+    in the config dir.++    Additionally, the xmonad config binary and intermediate object files were+    moved to the cache directory (only relevant if using XDG or+    `XMONAD_CACHE_DIR`).++  * Added `Foldable`, `Functor`, and `Traversable` instances for `Stack`.++  * Added `Typeable layout` constraint to `LayoutClass`, making it possible to+    cast `Layout` back into a concrete type and extract current layout state+    from it.++  * Export constructor for `Choose` and `CLR` from `Module.Layout` to allow+    pattern-matching on the left and right sub-layouts of `Choose l r a`.++  * Added `withUnfocused` function to `XMonad.Operations`, allowing for `X`+    operations to be applied to unfocused windows.++[these build scripts]: https://github.com/xmonad/xmonad-testing/tree/master/build-scripts++### Bug Fixes++  * Fixed a bug when using multiple screens with different dimensions, causing+    some floating windows to be smaller/larger than the size they requested.++  * Compatibility with GHC 9.0++  * Fixed dunst notifications being obscured when moving floats.+    https://github.com/xmonad/xmonad/issues/208++### Breaking Changes++  * Made `(<&&>)` and `(<||>)` non-strict in their right operand; i.e., these+    operators now implement short-circuit evaluation so the right operand is+    evaluated only if the left operand does not suffice to determine the+    result.++  * Change `ScreenDetail` to a newtype and make `RationalRect` strict in its+    contents.++  * Added the `extensibleConf` field to `XConfig` which makes it easier for+    contrib modules to have composable configuration (custom hooks, …).++  * `util/GenerateManpage.hs` is no longer distributed in the tarball.+    Instead, the manpage source is regenerated and manpage rebuilt+    automatically in CI.++  * `DestroyWindowEvent` is now broadcasted to layouts to let them know+    window-specific resources can be discarded.  ## 0.15 (September 30, 2018)
− CONFIG 
@@ -1,82 +0,0 @@-== Configuring xmonad ==--xmonad is configured by creating and editing the file:--    ~/.xmonad/xmonad.hs--xmonad then uses settings from this file as arguments to the window manager,-on startup. For a complete example of possible settings, see the file:--    man/xmonad.hs--Further examples are on the website, wiki and extension documentation.--    http://haskell.org/haskellwiki/Xmonad--== A simple example ==--Here is a basic example, which overrides the default border width,-default terminal, and some colours. This text goes in the file-$HOME/.xmonad/xmonad.hs :--    import XMonad--    main = xmonad $ def-        { borderWidth        = 2-        , terminal           = "urxvt"-        , normalBorderColor  = "#cccccc"-        , focusedBorderColor = "#cd8b00" }--You can find the defaults in the file:--    XMonad/Config.hs--== Checking your xmonad.hs is correct ==--Place this text in ~/.xmonad/xmonad.hs, and then check that it is-syntactically and type correct by loading it in the Haskell-interpreter:--    $ ghci ~/.xmonad/xmonad.hs-    GHCi, version 6.8.1: http://www.haskell.org/ghc/  :? for help-    Loading package base ... linking ... done.-    Ok, modules loaded: Main.--    Prelude Main> :t main-    main :: IO ()--Ok, looks good.--== Loading your configuration ==--To have xmonad start using your settings, type 'mod-q'.  xmonad will-then load this new file, and run it.  If it is unable to, the defaults-are used.--To load successfully, both 'xmonad' and 'ghc' must be in your $PATH-environment variable.  If GHC isn't in your path, for some reason, you-can compile the xmonad.hs file yourself:--    $ cd ~/.xmonad-    $ ghc --make xmonad.hs-    $ ls-    xmonad    xmonad.hi xmonad.hs xmonad.o--When you hit mod-q, this newly compiled xmonad will be used.--== Where are the defaults? ==--The default configuration values are defined in the source file:--    XMonad/Config.hs--the XConfig data structure itself is defined in:--    XMonad/Core.hs--== Extensions ==--Since the xmonad.hs file is just another Haskell module, you may import-and use any Haskell code or libraries you wish. For example, you can use-things from the xmonad-contrib library, or other code you write-yourself.
+ CONTRIBUTING.md view
@@ -0,0 +1,193 @@+# Contributing to xmonad and xmonad-contrib++## Before Creating a GitHub Issue++New issue submissions should adhere to the following guidelines:++  * Does your issue have to do with [xmonad][], [xmonad-contrib][], or+    maybe even with the [X11][] library?++    Please submit your issue to the **correct** GitHub repository.++  * To help you figure out which repository to submit your issue to,+    and to help us resolve the problem you are having, create the+    smallest configuration file you can that reproduces the problem.++    You may find that the [xmonad-testing][] repository is helpful in+    reproducing the problem with a smaller configuration file.++    Once you've done that please include the configuration file with+    your GitHub issue.++  * If possible, use the [xmonad-testing][] repository to test your+    configuration with the bleeding-edge development version of xmonad+    and xmonad-contrib.  We might have already fixed your problem.++## Contributing Changes/Patches++Have a change to xmonad that you want included in the next release?+Awesome!  Here are a few things to keep in mind:++  * Review the above section about creating GitHub issues.++  * It's always best to talk with the community before making any+    nontrivial changes to xmonad.  There are a couple of ways you can+    chat with us:++    - Join the [`#xmonad` IRC channel] on `irc.libera.chat` or the+      official [matrix channel], which is linked to IRC.  This is the+      preferred (and fastest!) way to get into contact with us.++    - Post a message to the [mailing list][ml].++  * [XMonad.Doc.Developing][xmonad-doc-developing] is a great+    resource to get an overview of xmonad.  Make sure to also check+    it if you want more details on the coding style.++  * Continue reading this document!++## Expediting Reviews and Merges++Here are some tips for getting your changes merged into xmonad:++  * If your changes can go into [xmonad-contrib][] instead+    of [xmonad][], please do so.  We rarely accept new features to+    xmonad.  (Not that we don't accept changes to xmonad, just that we+    prefer changes to xmonad-contrib instead.)++  * Change the fewest files as possible.  If it makes sense, submit a+    completely new module to xmonad-contrib.++  * Your changes should include relevant entries in the `CHANGES.md`+    file.  Help us communicate changes to the community.++  * Make sure you test your changes against the most recent commit of+    [xmonad][] (and [xmonad-contrib][], if you're contributing there).+    If you're adding a new module or functionality, make sure to add an+    example in the documentation and in the PR description.++  * Make sure you run the automated tests.  Both [xmonad-contrib][]+    and [xmonad][] have test-suites that you could run with+    `stack test` for example.++  * Make sure you read the section on rebasing and squashing commits+    below.++## Style Guidelines++Below are some common style guidelines that all of the core modules+follow.  Before submitting a pull request, make sure that your code does+as well!++  * Comment every top level function (particularly exported functions),+    and provide a type signature; use Haddock syntax in the comments.++  * Follow the coding style of the module that you are making changes to+    (`n` spaces for indentation, where to break long type signatures, …)++  * New code should not introduce any new warnings.  If you want to+    check this yourself before submitting a pull request, there is the+    `pedantic` flag, which is enforced in our CI.  You can enable it by+    building your changes with `stack build --flag xmonad:pedantic` or+    `cabal build --flag pedantic`.++  * Likewise, your code should be free of [hlint] warnings; this is also+    enforced in our GitHub CI.++  * Partial functions are to be avoided: the window manager should not+    crash, so do not call `error` or `undefined`++  * Any pure function added to the core should have QuickCheck+    properties precisely defining its behavior.++  * New modules should identify the author, and be submitted under the+    same license as xmonad (BSD3 license).++## Rebasing and Squashing Commits++Under no circumstances should you ever merge the master branch into+your feature branch.  This makes it nearly impossible to review your+changes and we *will not accept your PR* if you do this.++Instead of merging you should rebase your changes on top of the master+branch.  If a core team member asks you to "rebase your changes" this+is what they are talking about.++It's also helpful to squash all of your commits so that your pull+request only contains a single commit.  Again, this makes it easier to+review your changes and identify the changes later on in the Git+history.++### How to Rebase Your Changes++The goal of rebasing is to bring recent changes from the master branch+into your feature branch.  This often helps resolve conflicts where+you have changed a file that also changed in a recently merged pull+request (i.e. the `CHANGES.md` file).  Here is how you do that.++  1. Make sure that you have a `git remote` configured for the main+     repository.  I like to call this remote `upstream`:+     ```shell+     $ git remote add upstream https://github.com/xmonad/xmonad-contrib.git+     ```++  2. Pull from upstream and rewrite your changes on top of master.  For+     this to work you should not have any modified files in your+     working directory.  Run these commands from within your feature+     branch (the branch you are asking to be merged):++     ```shell+     $ git fetch --all+     $ git pull --rebase upstream master+     ```++  3. If the rebase was successful you can now push your feature branch+     back to GitHub.  You need to force the push since your commits+     have been rewritten and have new IDs:++     ```shell+     $ git push --force-with-lease+     ```++  4. Your pull request should now be conflict-free and only contain the+     changes that you actually made.++### How to Squash Commits++The goal of squashing commits is to produce a clean Git history where+each pull request contains just one commit.++  1. Use `git log` to see how many commits you are including in your+     pull request.  (If you've already submitted your pull request you+     can see this in the GitHub interface.)++  2. Rebase all of those commits into a single commit.  Assuming you+     want to squash the last four (4) commits into a single commit:+     ```shell+     $ git rebase -i HEAD~4+     ```++  3. Git will open your editor and display the commits you are+     rebasing with the word "pick" in front of them.++  4. Leave the first listed commit as "pick" and change the remaining+     commits from "pick" to "squash".++  5. Save the file and exit your editor.  Git will create a new commit+     and open your editor so you can modify the commit message.++  6. If everything was successful you can push your changed history+     back up to GitHub:+     ```shell+     $ git push --force-with-lease+     ```++[hlint]: https://github.com/ndmitchell/hlint+[xmonad]: https://github.com/xmonad/xmonad+[xmonad-contrib]: https://github.com/xmonad/xmonad-contrib+[xmonad-testing]: https://github.com/xmonad/xmonad-testing+[x11]: https://github.com/xmonad/X11+[ml]: https://mail.haskell.org/cgi-bin/mailman/listinfo/xmonad+[xmonad-doc-developing]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Doc-Developing.html+[`#xmonad` IRC channel]: https://web.libera.chat/#xmonad+[matrix channel]: https://matrix.to/#/#xmonad:matrix.org
+ INSTALL.md view
@@ -0,0 +1,376 @@+# Install XMonad++On many systems xmonad is available as a binary package in your+distribution (Debian, Ubuntu, Fedora, Arch, Gentoo, …).+It's by far the easiest way to get xmonad, although you'll miss out on the+latest features and fixes that may not have been released yet.++If you do want the latest and greatest, continue reading.+Those who install from distro can skip this and go straight to+[the XMonad Configuration Tutorial](TUTORIAL.md).++<!-- https://github.com/frnmst/md-toc -->+<!-- regenerate via: md_toc -s1 -p github INSTALL.md -->+<!--TOC-->++- [Dependencies](#dependencies)+- [Preparation](#preparation)+- [Download XMonad sources](#download-xmonad-sources)+- [Build XMonad](#build-xmonad)+  - [Build using Stack](#build-using-stack)+  - [Build using cabal-install](#build-using-cabal-install)+- [Make XMonad your window manager](#make-xmonad-your-window-manager)+- [Custom Build Script](#custom-build-script)++<!--TOC-->++## Dependencies++#### Debian, Ubuntu++``` console+$ sudo apt install \+> git \+> libx11-dev libxft-dev libxinerama-dev libxrandr-dev libxss-dev+```++#### Fedora++``` console+$ sudo dnf install \+> git \+> libX11-devel libXft-devel libXinerama-devel libXrandr-devel libXScrnSaver-devel+```++#### Arch++``` console+$ sudo pacman -S \+> git \+> libx11 libxft libxinerama libxrandr libxss \+> pkgconf+```++## Preparation++We'll use the [XDG] directory specifications here, meaning our+configuration will reside within `$XDG_CONFIG_HOME`, which is+`~/.config` on most systems.  Let's create this directory and move to+it:++``` console+$ mkdir -p ~/.config/xmonad && cd ~/.config/xmonad+```++If you already have an `xmonad.hs` configuration, you can copy it over+now.  If not, you can use the defaults: create a file called `xmonad.hs`+with the following content:++``` haskell+import XMonad++main :: IO ()+main = xmonad def+```++Older versions of xmonad used `~/.xmonad` instead.+This is still supported, but XDG is preferred.++## Download XMonad sources++Still in `~/.config/xmonad`, clone `xmonad` and `xmonad-contrib` repositories+using [git][]:++``` console+$ git clone https://github.com/xmonad/xmonad+$ git clone https://github.com/xmonad/xmonad-contrib+```++This will give you the latest `HEAD`; if you want you can also check+out a tagged release, e.g.:++``` console+$ git clone --branch v0.15 https://github.com/xmonad/xmonad+$ git clone --branch v0.16 https://github.com/xmonad/xmonad-contrib+```++(Sources and binaries don't usually go into `~/.config`.  In our case,+however, it avoids complexities related to Haskell build tools and lets us+focus on the important bits of XMonad installation.)++## Build XMonad++There are two widely used Haskell build tools:++* [Stack][stack]+* [cabal-install][cabal-install]++We include instructions for both.+Unless you already know which one you prefer, use Stack, which is easier.++### Build using Stack++#### Install Stack++The easiest way to get [stack] is probably via your system's package+manager:++``` console+$ sudo apt install haskell-stack    # Debian, Ubuntu+$ sudo dnf install stack            # Fedora+$ sudo pacman -S stack              # Arch+```++If you install stack via this method, it is advisable that you run+`stack upgrade` after installation.  This will make sure that you are on+the most recent version of the program, regardless of which version your+distribution actually packages.++If your distribution does not package stack, you can also easily install+it via the following command (this is the recommended way to install+stack via its [documentation][stack]):++``` console+$ curl -sSL https://get.haskellstack.org/ | sh+```++Yet another way would be via [ghcup]; this is similar to installers like+`rustup`, in case you prefer that.++#### Create a New Project++Let's create a stack project.  Since we're already in the correct+directory (`~/.config/xmonad`) with `xmonad` and `xmonad-contrib`+subdirectories, starting a new stack project is as simple as running `stack+init`.++Stack should now inform you that it will use the relevant `stack` and+`cabal` files from `xmonad` and `xmonad-contrib` to generate its+`stack.yaml` file.  At the time of writing, this looks a little bit like+this:++``` console+$ stack init+Looking for .cabal or package.yaml files to use to init the project.+Using cabal packages:+- xmonad-contrib/+- xmonad/++Selecting the best among 19 snapshots...++* Matches https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/17/9.yaml++Selected resolver: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/17/9.yaml+Initialising configuration using resolver: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/17/9.yaml+Total number of user packages considered: 2+Writing configuration to file: stack.yaml+All done.+```++If you look into your current directory now, you should see a freshly+generated `stack.yaml` file:++``` console+$ ls+xmonad  xmonad-contrib  stack.yaml  xmonad.hs+```++The meat of that file (comments start with `#`, we've omitted them here)+will look a little bit like++``` yaml+resolver:+  url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/17/9.yaml++packages:+- xmonad+- xmonad-contrib+```++With `stack.yaml` alongside `xmonad.hs`, xmonad now knows that it needs to use+`stack ghc` instead of just `ghc` when (re)compiling its configuration.+If you want to keep xmonad sources and the stack project elsewhere, but still+use `xmonad --recompile`, symlink your real `stack.yaml` into the xmonad+configuration directory, or [use a custom build script](#custom-build-script).++#### Install Everything++Installing things is as easy as typing `stack install`.  This will+install the correct version of GHC, as well as build all of the required+packages (`stack build`) and then copy the relevant executables+(`xmonad`, in our case) to `~/.local/bin`.  Make sure to add that+directory to your `$PATH`!++If you're getting build failures while building the `X11` package it may+be that you don't have the required C libraries installed.  See+[above](#dependencies).++### Build using cabal-install++#### Install cabal-install++The easiest way to get [cabal-install] is probably via your system's package+manager:++``` console+$ sudo apt install cabal-install    # Debian, Ubuntu+$ sudo dnf install cabal-install    # Fedora+$ sudo pacman -S cabal-install      # Arch+```++If your distribution does not package cabal-install, [ghcup][] is another+option.  See also <https://www.haskell.org/cabal/#install-upgrade>.++#### Create a New Project++Let's create a cabal project.  Since we're already in the correct+directory (`~/.config/xmonad`) with `xmonad` and `xmonad-contrib`+subdirectories, we'll instruct cabal to use them.  Create a file named+`cabal.project` containing:++```+packages: */*.cabal+```++(If you skip this step, cabal will use the latest releases from [Hackage][]+instead.)++#### Install Everything++You'll need to update the cabal package index, build xmonad and xmonad-contrib+libraries and then build the xmonad binary:++``` console+$ cabal update+$ cabal install --package-env=$HOME/.config/xmonad --lib xmonad xmonad-contrib+$ cabal install --package-env=$HOME/.config/xmonad xmonad+```++This will create a GHC environment in `~/.config/xmonad` so that the libraries+are available for recompilation of the config file, and also install the+xmonad binary to `~/.cabal/bin/xmonad`.  Make sure you have that directory in+your `$PATH`!++If you're getting build failures while building the `X11` package it may+be that you don't have the required C libraries installed.  See+[above](#dependencies).++## Make XMonad your window manager++This step varies depending on your distribution and X display manager (if+any).++#### Debian, Ubuntu++`/etc/X11/xinit/xinitrc` runs `/etc/X11/Xsession` which runs `~/.xsession`, so+you probably want to put `exec xmonad` there (don't forget the shebang and chmod).++(Tested with `startx`, `xdm`, `lightdm`.)++By using `~/.xsession`, the distro takes care of stuff like dbus, ssh-agent, X+resources, etc.  If you want a completely manual X session, use `~/.xinitrc`+instead.  Or invoke `startx`/`xinit` with an explicit path.++Some newer display managers require an entry in `/usr/share/xsessions`.+To use your custom `~/.xsession`, put these lines to+`/usr/share/xsessions/default.desktop`:++```+[Desktop Entry]+Name=Default X session+Type=Application+Exec=default+```++(Tested with `sddm`.)++#### Fedora++`/etc/X11/xinit/xinitrc` runs `~/.Xclients`, so you probably want to put `exec+xmonad` there (don't forget the shebang and chmod).  Like in Debian, this can+be overridden by having a completely custom `~/.xinitrc` or passing arguments+to `startx`/`xinit`.++X display managers (e.g. `lightdm`) usually invoke `/etc/X11/xinit/Xsession`+instead, which additionally redirects output to `~/.xsession-errors` and also+tries `~/.xsession` before `~/.Xclients`.++Newer display managers require an entry in `/usr/share/xsessions`, which is+available in the `xorg-x11-xinit-session` package.++#### Arch++`/etc/X11/xinit/xinitrc` runs `twm`, `xclock` and 3 `xterm`s; users are+meant to just copy that to `~/.xinitrc` and+[customize](https://wiki.archlinux.org/title/Xinit#xinitrc) it: replace the+last few lines with `exec xmonad`.++Display managers like `lightdm` have their own `Xsession` script which invokes+`~/.xsession`.  Other display managers need an entry in+`/usr/share/xsessions`, <https://aur.archlinux.org/packages/xinit-xsession/>+provides one.++#### See also++* <https://xmonad.org/documentation.html#in-your-environment>+* [FAQ: How can I use xmonad with a display manager? (xdm, kdm, gdm)](https://wiki.haskell.org/Xmonad/Frequently_asked_questions#How_can_I_use_xmonad_with_a_display_manager.3F_.28xdm.2C_kdm.2C_gdm.29)++## Custom Build Script++If you need to customize what happens during `xmonad --recompile` (bound to+`M-q` by default), perhaps because your xmonad configuration is a whole+separate Haskell package, you need to create a so-called `build` file.  This+is quite literally just a shell script called `build` in your xmonad directory+(which is `~/.config/xmonad` for us) that tells xmonad how it should build its+executable.++A good starting point (this is essentially [what xmonad would do][]+without a build file, with the exception that we are invoking `stack+ghc` instead of plain `ghc`) would be++``` shell+#!/bin/sh++exec stack ghc --  \+  --make xmonad.hs \+  -i               \+  -ilib            \+  -fforce-recomp   \+  -main-is main    \+  -v0              \+  -o "$1"+```++Don't forget to mark the file as `+x`: `chmod +x build`!++#### Don't Recompile on Every Startup++By default, xmonad always recompiles itself when a build script is used+(because the build script could contain arbitrary code, so a simple+check whether the `xmonad.hs` file changed is not enough).  If you find+that too annoying, then you can use the `xmonad-ARCH` executable that+`xmonad --recompile` generates instead of `xmonad` in your startup.  For+example, instead of writing++``` shell+exec xmonad+```++in your `~/.xinitrc`, you would write++``` shell+exec $HOME/.cache/xmonad/xmonad-x86_64-linux+```++The `~/.cache` prefix is the `$XDG_CACHE_HOME` directory.  Note that+if your xmonad configuration resides within `~/.xmonad`, then the+executable will also be within that directory and not in+`$XDG_CACHE_HOME`.++[XDG]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html+[git]: https://git-scm.com/+[stack]: https://docs.haskellstack.org/en/stable/README/+[cabal-install]: https://www.haskell.org/cabal/+[ghcup]: https://www.haskell.org/ghcup/+[what xmonad would do]: https://github.com/xmonad/xmonad/blob/master/src/XMonad/Core.hs#L659-L667+[Hackage]: https://hackage.haskell.org/
LICENSE view
@@ -1,31 +1,28 @@ Copyright (c) 2007,2008 Spencer Janssen Copyright (c) 2007,2008 Don Stewart--All rights reserved.+Copyright (c) The Xmonad Community. All rights reserved. -Redistribution and use in source and binary forms, with or without-modification, are permitted provided that the following conditions-are met:+Redistribution and use in source and binary forms, with or without modification,+are permitted provided that the following conditions are met: -1. Redistributions of source code must retain the above copyright-   notice, this list of conditions and the following disclaimer.+1. Redistributions of source code must retain the above copyright notice,+this list of conditions and the following disclaimer. -2. Redistributions in binary form must reproduce the above copyright-   notice, this list of conditions and the following disclaimer in the-   documentation and/or other materials provided with the distribution.+2. Redistributions in binary form must reproduce the above copyright notice,+this list of conditions and the following disclaimer in the documentation+and/or other materials provided with the distribution. -3. Neither the name of the author nor the names of his contributors-   may be used to endorse or promote products derived from this software-   without specific prior written permission.+3. Neither the name of the copyright holder nor the names of its contributors+may be used to endorse or promote products derived from this software without+specific prior written permission. -THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE-DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR-ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS-OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,-STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN-ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE-POSSIBILITY OF SUCH DAMAGE.+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ MAINTAINERS.md view
@@ -0,0 +1,133 @@+# XMonad Maintainers++## The XMonad Core Team++  * Brandon S Allbery [GitHub][geekosaur], IRC: `geekosaur`++  * Brent Yorgey [GitHub][byorgey], IRC: `byorgey`++  * Daniel Wagner [GitHub][dmwit], [Twitter][twitter:dmwit], IRC: `dmwit`++  * Sibi Prabakaran [GitHub][psibi], [Twitter][twitter:psibi], IRC: `sibi`++  * slotThe [GitHub][slotThe], IRC: `Solid`++  * Tomáš Janoušek [GitHub][liskin], [Twitter][twitter:liskin], IRC: `liskin`, [GPG][gpg:liskin]++[geekosaur]: https://github.com/geekosaur+[byorgey]: https://github.com/byorgey+[dmwit]: https://github.com/dmwit+[psibi]: https://github.com/psibi+[liskin]: https://github.com/liskin+[slotThe]: https://github.com/slotThe++[gpg:liskin]: https://github.com/liskin.gpg++[twitter:dmwit]: https://twitter.com/dmwit13+[twitter:psibi]: https://twitter.com/psibi+[twitter:liskin]: https://twitter.com/Liskni_si++## Hall of Fame (past maintainers/developers)++  * Adam Vogt [GitHub](https://github.com/aavogt)++  * Peter Simons [GitHub](https://github.com/peti), [Twitter](https://twitter.com/OriginalPeti)++  * Spencer Janssen [GitHub](https://github.com/spencerjanssen)++  * Don Stewart [GitHub](https://github.com/donsbot), [Twitter](https://twitter.com/donsbot)++  * Jason Creighton [GitHub](https://github.com/JasonCreighton)++  * David Roundy [GitHub](https://github.com/droundy)++  * Daniel Schoepe [GitHub](https://github.com/dschoepe)++  * Eric Mertens [GitHub](https://github.com/glguy)++  * Nicolas Pouillard [GitHub](https://github.com/np)++  * Roman Cheplyaka [GitHub](https://github.com/UnkindPartition)++  * Gwern Branwen [GitHub](https://github.com/gwern)++  * Lukas Mai [GitHub](https://github.com/mauke)++  * Braden Shepherdson [GitHub](https://github.com/shepheb)++  * Devin Mullins [GitHub](https://github.com/twifkak)++  * David Lazar [GitHub](https://github.com/davidlazar)++  * Peter J. Jones [GitHub](https://github.com/pjones)++## Release Procedures++When the time comes to release another version of xmonad and xmonad-contrib:++  1. Update the version number in all the `*.cabal` files and let the CI+     verify that it all builds together.++  2. Review documentation files and make sure they are accurate:++     - [`README.md`](README.md)+     - [`CHANGES.md`](CHANGES.md)+     - [`INSTALL.md`](INSTALL.md)+     - [`man/xmonad.1.markdown.in`](man/xmonad.1.markdown.in)+     - [haddocks](https://xmonad.github.io/xmonad-docs/)++     If the manpage changes, wait for the CI to rebuild the rendered outputs.++  3. Make sure that `tested-with:` covers several recent releases of GHC, that+     `.github/workflows/haskell-ci.yml` had been updated to test all these GHC+     versions and that `.github/workflows/stack.yml` tests with several recent+     revisions of [Stackage][] LTS.++  4. Create a release on GitHub:++     - https://github.com/xmonad/xmonad/releases/new+     - https://github.com/xmonad/xmonad-contrib/releases/new++     CI will upload a release candidate to Hackage. Check again that+     everything looks good. To publish a final release, run the CI workflow+     once again with the correct version number:++     - https://github.com/xmonad/xmonad/actions/workflows/haskell-ci.yml+     - https://github.com/xmonad/xmonad-contrib/actions/workflows/haskell-ci.yml++     See [haskell-ci-hackage.patch][] for details about the release infrastructure.++  5. Update the website:++     - Post a [new release announcement][web-announce]+     - Check install instructions, guided tour, keybindings cheat sheet, …++  7. Post announcement to:++     - [xmonad.org website](https://github.com/xmonad/xmonad-web/tree/gh-pages/news/_posts)+     - [XMonad mailing list](https://mail.haskell.org/mailman/listinfo/xmonad)+     - [Haskell Cafe](https://mail.haskell.org/cgi-bin/mailman/listinfo/haskell-cafe)+     - [Haskell Discourse](https://discourse.haskell.org/)+     - [Twitter](https://twitter.com/xmonad)+     - [Reddit](https://www.reddit.com/r/xmonad/)++     See [old announcements][old-announce] for inspiration.++[packdeps]: https://hackage.haskell.org/package/packdeps+[Stackage]: https://www.stackage.org/+[haskell-ci-hackage.patch]: .github/workflows/haskell-ci-hackage.patch+[web-announce]: https://github.com/xmonad/xmonad-web/tree/gh-pages/news/_posts+[old-announce]: https://github.com/xmonad/xmonad-web/tree/55614349421ebafaef4a47424fcb16efa80ff768++## Website and Other Accounts++* The [xmonad twitter] is tended to by [liskin].++* The [xmonad.org] domain is owned by [eyenx] and the website itself is+  deployed via GitHub Pages.  It can be updated by making a pull request+  against the [xmonad-web] repository.++[eyenx]: https://github.com/eyenx+[xmonad-web]: https://github.com/xmonad/xmonad-web/+[xmonad.org]: https://xmonad.org/+[xmonad twitter]: https://twitter.com/xmonad
README.md view
@@ -1,8 +1,42 @@-# xmonad: A Tiling Window Manager+<p align="center">+  <a href="https://xmonad.org/">+    <img alt="XMonad logo" src="https://xmonad.org/images/logo-wrapped.svg" height=150>+  </a>+</p>+<p align="center">+  <a href="https://hackage.haskell.org/package/xmonad">+    <img alt="Hackage" src="https://img.shields.io/hackage/v/xmonad?logo=haskell">+  </a>+  <a href="https://github.com/xmonad/xmonad/blob/readme/LICENSE">+    <img alt="License" src="https://img.shields.io/github/license/xmonad/xmonad">+  </a>+  <a href="https://haskell.org/">+    <img alt="Made in Haskell" src="https://img.shields.io/badge/Made%20in-Haskell-%235e5086?logo=haskell">+  </a>+  <br>+  <a href="https://github.com/xmonad/xmonad/actions/workflows/stack.yml">+    <img alt="Stack" src="https://img.shields.io/github/workflow/status/xmonad/xmonad/Stack?label=Stack&logo=githubactions&logoColor=white">+  </a>+  <a href="https://github.com/xmonad/xmonad/actions/workflows/haskell-ci.yml">+    <img alt="Cabal" src="https://img.shields.io/github/workflow/status/xmonad/xmonad/Haskell-CI?label=Cabal&logo=githubactions&logoColor=white">+  </a>+  <a href="https://github.com/xmonad/xmonad/actions/workflows/nix.yml">+    <img alt="Nix" src="https://img.shields.io/github/workflow/status/xmonad/xmonad/Nix?label=Nix&logo=githubactions&logoColor=white">+  </a>+  <br>+  <a href="https://github.com/sponsors/xmonad">+    <img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/xmonad?label=GitHub%20Sponsors&logo=githubsponsors">+  </a>+  <a href="https://opencollective.com/xmonad">+    <img alt="Open Collective" src="https://img.shields.io/opencollective/all/xmonad?label=Open%20Collective&logo=opencollective">+  </a>+</p> -[![Build Status](https://travis-ci.org/xmonad/xmonad.svg?branch=master)](https://travis-ci.org/xmonad/xmonad)+# xmonad -[xmonad][] is a tiling window manager for X. Windows are arranged+**A tiling window manager for X11.**++[XMonad][web:xmonad] is a tiling window manager for X11. Windows are arranged automatically to tile the screen without gaps or overlap, maximising screen use. Window manager features are accessible from the keyboard: a mouse is optional. xmonad is written, configured and extensible in@@ -12,118 +46,74 @@ workspace. Xinerama is fully supported, allowing windows to be tiled on several physical screens. -## Quick Start--  * From hackage:--        cabal update-        cabal install xmonad xmonad-contrib--  * Alternatively, build from source using the following repositories:--    - <https://github.com/xmonad/xmonad>--    - <https://github.com/xmonad/xmonad-contrib>--For the full story, read on.--## Building--Building is quite straightforward, and requires a basic Haskell toolchain.-On many systems xmonad is available as a binary package in your-package system (e.g. on Debian or Gentoo). If at all possible, use this-in preference to a source build, as the dependency resolution will be-simpler.--We'll now walk through the complete list of toolchain dependencies.--  * GHC: the Glasgow Haskell Compiler--    You first need a Haskell compiler. Your distribution's package-    system will have binaries of GHC (the Glasgow Haskell Compiler),-    the compiler we use, so install that first. If your operating-    system's package system doesn't provide a binary version of GHC-    and the `cabal-install` tool, you can install both using the-    [Haskell Platform][platform].--    It shouldn't be necessary to compile GHC from source -- every common-    system has a pre-build binary version.  However, if you want to-    build from source, the following links will be helpful:--      - GHC: <http://haskell.org/ghc/>--      - Cabal: <http://haskell.org/cabal/download.html>--  * X11 libraries:--    Since you're building an X application, you'll need the C X11-    library headers. On many platforms, these come pre-installed. For-    others, such as Debian, you can get them from your package manager:--        # for xmonad-        $ apt-get install libx11-dev libxinerama-dev libxext-dev libxrandr-dev libxss-dev--        # for xmonad-contrib-        $ apt-get install libxft-dev--Then build and install with:--    $ cabal install--## Running xmonad--If you built XMonad using `cabal` then add:--    exec $HOME/.cabal/bin/xmonad--to the last line of your `.xsession` or `.xinitrc` file.--## Configuring--See the [CONFIG][] document and the [example configuration file][example-config].--## XMonadContrib--There are many extensions to xmonad available in the XMonadContrib-(xmc) library. Examples include an ion3-like tabbed layout, a-prompt/program launcher, and various other useful modules.-XMonadContrib is available at:--  * Latest release: <http://hackage.haskell.org/package/xmonad-contrib>--  * Git version: <https://github.com/xmonad/xmonad-contrib>--## Other Useful Programs--A nicer xterm replacement, that supports resizing better:--  * urxvt: <http://software.schmorp.de/pkg/rxvt-unicode.html>+This repository contains the [xmonad][hackage:xmonad] package, a minimal,+stable, yet extensible core. It is accompanied by+[xmonad-contrib][gh:xmonad-contrib], a library of hundreds of additional+community-maintained tiling algorithms and extension modules. The two combined+make for a powerful X11 window-manager with endless customization+possibilities. They are, quite literally, libraries for creating your own+window manager. -For custom status bars:+## Installation -  * xmobar: <http://hackage.haskell.org/package/xmobar>+For installation and configuration instructions, please see: -  * taffybar: <https://github.com/travitch/taffybar>+ * [downloading and installing xmonad][web:download]+ * [installing latest xmonad snapshot from git][web:install]+ * [configuring xmonad][web:tutorial] -  * dzen: <http://gotmor.googlepages.com/dzen>+If you run into any trouble, consult our [documentation][web:documentation] or+ask the [community][web:community] for help. -For a program dispatch menu:+## Contributing -  * [XMonad.Prompt.Shell][xmc-prompt-shell]: (from [XMonadContrib][])+We welcome all forms of contributions: -  * dmenu: <http://www.suckless.org/download/>+ * [bug reports and feature ideas][gh:xmonad:issues]+   (also to [xmonad-contrib][gh:xmonad-contrib:issues])+ * [bug fixes, new features, new extensions][gh:xmonad:pulls]+   (usually to [xmonad-contrib][gh:xmonad-contrib:pulls])+ * documentation fixes and improvements: [xmonad][gh:xmonad],+   [xmonad-contrib][gh:xmonad-contrib], [xmonad-web][gh:xmonad-web]+ * helping others in the [community][web:community]+ * financial support: [GitHub Sponsors][gh:xmonad:sponsors],+   [Open Collective][opencollective:xmonad] -  * gmrun: (in your package system)+Please do read the [CONTRIBUTING][gh:xmonad:contributing] document for more+information about bug reporting and code contributions. For a brief overview+of the architecture and code conventions, see the [documentation for the+`XMonad.Doc.Developing` module][doc:developing]. If in doubt, [talk to+us][web:community].  ## Authors -  * Spencer Janssen-  * Don Stewart-  * Jason Creighton+Started in 2007 by [Spencer Janssen][gh:spencerjanssen], [Don+Stewart][gh:donsbot] and [Jason Creighton][gh:JasonCreighton], the+[XMonad][web:xmonad] project lives on thanks to [new generations of+maintainers][gh:xmonad:maintainers] and [dozens of+contributors][gh:xmonad:contributors]. -[xmonad]: http://xmonad.org-[xmonadcontrib]: https://hackage.haskell.org/package/xmonad-contrib-[xmc-prompt-shell]: https://hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Prompt-Shell.html-[platform]: http://haskell.org/platform/-[example-config]: https://github.com/xmonad/xmonad-testing/blob/master/example-config.hs-[config]: https://github.com/xmonad/xmonad/blob/master/CONFIG+[gh:spencerjanssen]: https://github.com/spencerjanssen+[gh:donsbot]: https://github.com/donsbot+[gh:JasonCreighton]: https://github.com/JasonCreighton++[doc:developing]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Doc-Developing.html+[gh:xmonad-contrib:issues]: https://github.com/xmonad/xmonad-contrib/issues+[gh:xmonad-contrib:pulls]: https://github.com/xmonad/xmonad-contrib/pulls+[gh:xmonad-contrib]: https://github.com/xmonad/xmonad-contrib+[gh:xmonad-web]: https://github.com/xmonad/xmonad-web+[gh:xmonad:contributing]: https://github.com/xmonad/xmonad/blob/master/CONTRIBUTING.md+[gh:xmonad:contributors]: https://github.com/xmonad/xmonad/graphs/contributors+[gh:xmonad:issues]: https://github.com/xmonad/xmonad/issues+[gh:xmonad:maintainers]: https://github.com/xmonad/xmonad/blob/master/MAINTAINERS.md+[gh:xmonad:pulls]: https://github.com/xmonad/xmonad/pulls+[gh:xmonad:sponsors]: https://github.com/sponsors/xmonad+[gh:xmonad]: https://github.com/xmonad/xmonad+[hackage:xmonad]: https://hackage.haskell.org/package/xmonad+[opencollective:xmonad]: https://opencollective.com/xmonad+[web:community]: https://xmonad.org/community.html+[web:documentation]: https://xmonad.org/documentation.html+[web:download]: https://xmonad.org/download.html+[web:install]: https://xmonad.org/INSTALL.html+[web:tutorial]: https://xmonad.org/TUTORIAL.html+[web:xmonad]: https://xmonad.org/
− STYLE 
@@ -1,22 +0,0 @@--== Coding guidelines for contributing to-== xmonad and the xmonad contributed extensions--* Comment every top level function (particularly exported functions), and-  provide a type signature; use Haddock syntax in the comments.--* Follow the coding style of the other modules.--* Code should be compilable with -Wall -Werror -fno-warn-unused-do-bind -fwarn-tabs.-  There should be no warnings.--* Partial functions should be avoided: the window manager should not-  crash, so do not call `error` or `undefined`--* Use 4 spaces for indenting.--* Any pure function added to the core should have QuickCheck properties-  precisely defining its behavior.--* New modules should identify the author, and be submitted under-  the same license as xmonad (BSD3 license or freer).
+ TUTORIAL.md view
@@ -0,0 +1,1267 @@+# XMonad Configuration Tutorial++We're going to take you, step-by-step, through the process of+configuring xmonad, setting up [xmobar] as a status bar, configuring+[trayer-srg] as a tray, and making it all play nicely together.++We assume that you have read the [xmonad guided tour] already.  It is a+bit dated at this point but, because xmonad is stable, the guide should+still give you a good overview of the most basic functionality.++Before we begin, here are two screenshots of the kind of desktop we will+be creating together.  In particular, a useful layout we'll conjure into+being—the three columns layout from [XMonad.Layout.ThreeColumns] with+the ability to magnify stack windows via [XMonad.Layout.Magnifier]:++<p>+<img alt="blank desktop" src="https://user-images.githubusercontent.com/50166980/111586872-c0eb0e00-87c1-11eb-9129-c2781bbbf227.png" width="550">+<img alt="blank desktop" src="https://user-images.githubusercontent.com/50166980/111586885-c47e9500-87c1-11eb-8e8e-83d4d33c4c8d.png" width="550">+</p>++So let's get started!++## Preliminaries++First you'll want to install xmonad.  You can either do this with your+system's package manager or via `stack`/`cabal`.  The latter may be+necessary if your distribution does not package `xmonad` and+`xmonad-contrib` (or packages a version that's very old) or you want to+use the git versions instead of a tagged release.  You can find+instructions for how to do this in [INSTALL.md].++One more word of warning: if you are on a distribution that installs+every Haskell package dynamically linked—thus essentially breaking+Haskell—(Arch Linux being a prominent example) then we would highly+recommend installing via `stack` or `cabal` as instructed in+[INSTALL.md].  If you still want to install xmonad via your system's+package manager, you will need to `xmonad --recompile` _every time_ a+Haskell dependency is updated—else xmonad may fail to start when you+want to log in!++We're going to assume xmonad version `0.17.0` and xmonad-contrib version+`0.17.0` here, though most of these steps should work with older+versions as well.  When we get to the relevant parts, will point you to+alternatives that work with at least xmonad version `0.15` and+xmonad-contrib version `0.16`.  This will usually be accompanied by a+big "_IF YOU ARE ON A VERSION `< 0.17.0`_", so don't worry about missing+it!++Throughout the tutorial we will use, for keybindings, a syntax very akin+to the [GNU Emacs conventions] for the same thing—so `C-x` means "hold+down the control key and then press the `x` key".  One exception is that+in our case `M` will not necessarily mean Alt (also called `Meta`), but+"your modifier key"; this is Alt by default, although many people map it+to Super instead (I will show you how to do this below).++This guide should work for any GNU/Linux distribution and even for BSD+folks.  Because debian-based distributions are still rather popular, we+will give you the `apt` commands when it comes to installing software.+If you use another distribution, just substitute the appropriate+commands for your system.++To install xmonad, as well as some utilities, via `apt` you can just run++``` console+$ apt-get install xmonad libghc-xmonad-contrib-dev libghc-xmonad-dev suckless-tools+```++This installs xmonad itself, everything you need to configure it, and+`suckless-tools`, which provides the application launcher `dmenu`.  This+program is used as the default application launcher on `M-p`.++If you are installing xmonad with `stack` or `cabal`, remember to _not_+install `xmonad` and its libraries here!++For the remainder of this document, we will assume that you are running+a live xmonad session in some capacity.  If you have set up your+`~/.xinitrc` as directed in the xmonad guided tour, you should be good+to go!  If not, just smack an `exec xmonad` at the bottom of that file.++## Installing Xmobar++What we need to do now—provided we want to use a bar at all—is to+install [xmobar].  If you visit [xmobar's `Installation` section] you+will find everything from how to install it with your system's package+manager all the way to how to compile it yourself.++We will show you how we make these programs talk to each other a bit+later on.  For now, let's start to explore how we can customize this+window manager of ours!++## Customizing XMonad++Xmonad's configuration file is written in [Haskell]—but don't worry, we+won't assume that you know the language for the purposes of this+tutorial.  The configuration file can either reside within+`$XDG_CONFIG_HOME/xmonad`, `~/.xmonad`, or `$XMONAD_CONFIG_DIR`; see+`man 1 xmonad` for further details (the likes of `$XDG_CONFIG_HOME` is+called a [shell variable]).  Let's use `$XDG_CONFIG_HOME/xmonad` for the+purposes of this tutorial, which resolves to `~/.config/xmonad` on most+systems—the `~/.config` directory is also the place where things will+default to should `$XDG_CONFIG_HOME` not be set.++First, we need to create `~/.config/xmonad` and, in this directory, a+file called `xmonad.hs`.  We'll start off with importing some of the+utility modules we will use.  At the very top of the file, write++``` haskell+import XMonad++import XMonad.Util.EZConfig+import XMonad.Util.Ungrab+```++All of these imports are _unqualified_, meaning we are importing all of+the functions in the respective modules.  For configuration files this+is what most people want.  If you prefer to import things explicitly+you can do so by adding the necessary function to the `import` statement+in parentheses.  For example++``` haskell+import XMonad.Util.EZConfig (additionalKeysP)+```++For the purposes of this tutorial, we will be importing everything+coming from xmonad directly unqualified.++Next, a basic configuration—which is the same as the default config—is+this:++``` haskell+main :: IO ()+main = xmonad def+```++In case you're interested in what this default configuration actually+looks like, you can find it under [XMonad.Config].  Do note that it is+_not_ advised to copy that file and use it as the basis of your+configuration, as you won't notice when a default changes!++You should be able to save the above file, with the import lines plus+the other two and then press `M-q` to load it up.  Another way to+validate your `xmonad.hs` is to simply run `xmonad --recompile` in a+terminal.  You'll see errors (in an `xmessage` popup, so make sure that+is installed on your system) if it's bad, and nothing if it's good.+It's not the end of the world if you restart xmonad and get errors, as+you will still be on your old, working, configuration and have all the+time in the world to fix your errors before trying again!++Let's add a few additional things.  The default modifier key is Alt,+which is also used in Emacs.  Sometimes Emacs and xmonad want to use the+same key for different actions.  Rather than remap every common key,+many people just change Mod to be the Super key—the one between Ctrl and+Alt on most keyboards.  We can do this by changing the above `main`+function in the following way:++``` haskell+main :: IO ()+main = xmonad $ def+    { modMask = mod4Mask  -- Rebind Mod to the Super key+    }+```++The two dashes signify a comment to the end of the line.  Notice the+curly braces; these stand for a [record update] in Haskell (records are+sometimes called "structs" in C-like languages).  What it means is "take+`def` and change its `modMask` field to the thing **I** want".  Taking a+record that already has some defaults set and modifying only the fields+one cares about is a pattern that is often used within xmonad, so it's+worth pausing for a bit here to really take this new syntax in.++Don't mind the dollar sign too much; it essentially serves to split+apart the `xmonad` function and the `def { .. }` record update visually.+Haskell people really don't like writing parentheses, so they sometimes+use a dollar sign instead.  For us this is particularly nice, because+now we don't have to awkwardly write++``` haskell+main :: IO ()+main = xmonad (def+    { modMask = mod4Mask  -- Rebind Mod to the Super key+    })+```++This will be especially handy when adding more combinators; something we+will talk about later on.  The dollar sign is superfluous in this+example, but that will change soon enough so it's worth introducing it+here as well.++What if we wanted to add other keybindings?  Say you also want to bind+`M-S-z` to lock your screen with the screensaver, `M-S-=` to take a+snapshot of one window, and `M-]` to spawn Firefox.  This can be+achieved with the `additionalKeysP` function from the+[XMonad.Util.EZConfig] module—luckily we already have it imported!  Our+config file, starting with `main`, now looks like:++``` haskell+main :: IO ()+main = xmonad $ def+    { modMask = mod4Mask  -- Rebind Mod to the Super key+    }+  `additionalKeysP`+    [ ("M-S-z", spawn "xscreensaver-command -lock")+    , ("M-S-=", unGrab *> spawn "scrot -s"        )+    , ("M-]"  , spawn "firefox"                   )+    ]+```++That syntax look familiar?++You can find the names for special keys, like `Print` or the `F`-keys,+in the [XMonad.Util.EZConfig] documentation.++We will cover setting up the screensaver later in this tutorial.++The `unGrab` before running the `scrot -s` command tells xmonad to+release its keyboard grab before `scrot -s` tries to grab the keyboard+itself.  The little `*>` operator essentially just sequences two+functions, i.e. `f *> g` says++> first do `f` and then, discarding any result that `f` may have given+> me, do `g`.++Do note that you may need to install `scrot` if you don't have it on+your system already.++What if we wanted to augment our xmonad experience just a little more?+We already have `xmonad-contrib`, which means endless possibilities!+Say we want to add a three column layout to our layouts and also magnify+focused stack windows, making it more useful on smaller screens.++We start by visiting the documentation for [XMonad.Layout.ThreeColumns].+The very first sentence of the `Usage` section tells us exactly what we+want to start with:++> You can use this module with the following in your `~/.xmonad/xmonad.hs`:+>+> `import XMonad.Layout.ThreeColumns`++Ignoring the part about where exactly our `xmonad.hs` is (we have opted+to put it into `~/.config/xmonad/xmonad.hs`, remember?) we can follow+that documentation word for word.  Let's add++``` haskell+import XMonad.Layout.ThreeColumns+```++to the top of our configuration file.  Most modules have a lot of+accompanying text and usage examples in them—so while the type+signatures may seem scary, don't be afraid to look up the+[xmonad-contrib documentation] on hackage!++Next we just need to tell xmonad that we want to use that particular+layout.  To do this, there is the `layoutHook`.  Let's use the default+layout as a base:++``` haskell+myLayout = tiled ||| Mirror tiled ||| Full+  where+    tiled   = Tall nmaster delta ratio+    nmaster = 1      -- Default number of windows in the master pane+    ratio   = 1/2    -- Default proportion of screen occupied by master pane+    delta   = 3/100  -- Percent of screen to increment by when resizing panes+```++The so-called `where`-clause above simply consists of local declarations+that might clutter things up where they all declared at the top-level+like this++``` haskell+myLayout = Tall 1 (3/100) (1/2) ||| Mirror (Tall 1 (3/100) (1/2)) ||| Full+```++It also gives us the chance of documenting what the individual numbers+mean!++Now we can add the layout according to the [XMonad.Layout.ThreeColumns]+documentation.  At this point, we would encourage you to try this+yourself with just the docs guiding you.  If you can't do it, don't+worry; it'll come with time!++We can, for example, add the additional layout like this:++``` haskell+myLayout = tiled ||| Mirror tiled ||| Full ||| ThreeColMid 1 (3/100) (1/2)+  where+    tiled   = Tall nmaster delta ratio+    nmaster = 1      -- Default number of windows in the master pane+    ratio   = 1/2    -- Default proportion of screen occupied by master pane+    delta   = 3/100  -- Percent of screen to increment by when resizing panes+```++or even, because the numbers happen to line up, like this:++``` haskell+myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol+  where+    threeCol = ThreeColMid nmaster delta ratio+    tiled    = Tall nmaster delta ratio+    nmaster  = 1      -- Default number of windows in the master pane+    ratio    = 1/2    -- Default proportion of screen occupied by master pane+    delta    = 3/100  -- Percent of screen to increment by when resizing panes+```++Now we just need to tell xmonad that we want to use this modified+`layoutHook` instead of the default.  Again, try to reason this out for+yourself by just looking at the documentation.  Ready?  Here we go:++``` haskell+main :: IO ()+main = xmonad $ def+    { modMask    = mod4Mask  -- Rebind Mod to the Super key+    , layoutHook = myLayout  -- Use custom layouts+    }+  `additionalKeysP`+    [ ("M-S-z", spawn "xscreensaver-command -lock")+    , ("M-S-=", unGrab *> spawn "scrot -s"        )+    , ("M-]"  , spawn "firefox"                   )+    ]+```++But we also wanted to add magnification, right?  Luckily for us, there's+a module for that as well!  It's called [XMonad.Layout.Magnifier].+Again, take a look at the documentation before reading on—see if you can+reason out what to do by yourself.  Let's pick the `magnifiercz'`+modifier from the library; it magnifies a window by a given amount, but+only if it's a stack window.  Add it to your three column layout thusly:++``` haskell+myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol+  where+    threeCol = magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio+    tiled    = Tall nmaster delta ratio+    nmaster  = 1      -- Default number of windows in the master pane+    ratio    = 1/2    -- Default proportion of screen occupied by master pane+    delta    = 3/100  -- Percent of screen to increment by when resizing panes+```++Don't forget to import the module!++You can think of the `$` here as putting everything into parentheses+from the dollar to the end of the line.  If you don't like that you can+also write++``` haskell+threeCol = magnifiercz' 1.3 (ThreeColMid nmaster delta ratio)+```++instead.++That's it!  Now we have a perfectly functioning three column layout with+a magnified stack.  If you compare this with the starting screenshots,+you will see that that's exactly the behaviour we wanted to achieve!++A last thing that's worth knowing about are so-called "combinators"—at+least we call them that, we can't tell you what to do.  These are+functions that compose with the `xmonad` function and add a lot of hooks+and other things for you (trying to achieve a specific goal), so you+don't have to do all the manual work yourself.  For example, xmonad—by+default—is only [ICCCM] compliant.  Nowadays, however, a lot of programs+(including many compositors) expect the window manager to _also_ be+[EWMH] compliant.  So let's save ourselves a lot of future trouble and+add that to xmonad straight away!++This functionality is to be found in the [XMonad.Hooks.EwmhDesktops]+module, so let's import it:++``` haskell+import XMonad.Hooks.EwmhDesktops+```++We might also consider using the `ewmhFullscreen` combinator.  By+default, a "fullscreened" application is still bound by its window+dimensions; this means that if the window occupies half of the screen+before it was fullscreened, it will also do so afterwards.  Some people+really like this behaviour, as applications thinking they're in+fullscreen mode tend to remove a lot of clutter (looking at you,+Firefox).  However, because a lot of people explicitly do not want this+effect (and some applications, like chromium, will misbehave and need+some [Hacks] to make this work), we will also add the relevant function+to get "proper" fullscreen behaviour here.++_IF YOU ARE ON A VERSION `< 0.17.0`_: The `ewmhFullscreen` function does+  not exist in these versions.  Instead of it, you can try to add+  `fullscreenEventHook` to your `handleEventHook` to achieve similar+  functionality (how to do this is explained in the documentation of+  [XMonad.Hooks.EwmhDesktops]).++To use the two combinators, we compose them with the `xmonad` function+in the following way:++``` haskell+main :: IO ()+main = xmonad $ ewmhFullscreen $ ewmh $ def+    { modMask    = mod4Mask  -- Rebind Mod to the Super key+    , layoutHook = myLayout  -- Use custom layouts+    }+  `additionalKeysP`+    [ ("M-S-z", spawn "xscreensaver-command -lock")+    , ("M-S-=", unGrab *> spawn "scrot -s"        )+    , ("M-]"  , spawn "firefox"                   )+    ]+```++Do mind the order of the two combinators—by a particularly awkward set+of circumstances, they do not commute!++This `main` function is getting pretty crowded now, so let's refactor it+a little bit.  A good way to do this is to split the config part into+one function and the "main and all the combinators" part into another.+Let's call the config part `myConfig` for... obvious reasons.  It would+look like this:++``` haskell+main :: IO ()+main = xmonad $ ewmhFullscreen $ ewmh $ myConfig++myConfig = def+    { modMask    = mod4Mask  -- Rebind Mod to the Super key+    , layoutHook = myLayout  -- Use custom layouts+    }+  `additionalKeysP`+    [ ("M-S-z", spawn "xscreensaver-command -lock")+    , ("M-S-=", unGrab *> spawn "scrot -s"        )+    , ("M-]"  , spawn "firefox"                   )+    ]+```++Much better!++## Make XMonad and Xmobar Talk to Each Other++Onto the main dish.  First, we have to import the necessary modules.+Add the following to your list of imports:++``` haskell+import XMonad.Hooks.DynamicLog+import XMonad.Hooks.StatusBar+import XMonad.Hooks.StatusBar.PP+```++_IF YOU ARE ON A VERSION `< 0.17.0`_: The `XMonad.Hooks.StatusBar` and+  `XMonad.Hooks.StatusBar.PP` modules don't exist yet.  You can find+  everything you need in the `XMonad.Hooks.DynamicLog` module, so remove+  these two imports.++Replace your `main` function above with:++``` haskell+main :: IO ()+main = xmonad $ ewmhFullscreen $ ewmh $ xmobarProp $ myConfig+```++_IF YOU ARE ON A VERSION `< 0.17.0`_: The `xmobarProp` function does not+  exist in these versions.  Instead of it, use `xmobar` via+  `main = xmonad . ewmh =<< xmobar myConfig` and carefully read the part+  about pipes later on (`xmobar` uses pipes to make xmobar talk to+  xmonad).++As a quick side-note, we could have also written++``` haskell+main :: IO ()+main = xmonad . ewmhFullscreen . ewmh . xmobarProp $ myConfig+```++Notice how `$` became `.`!  The dot operator `(.)` in Haskell means+function composition and is read from right to left.  What this means in+this specific case is essentially the following:++> take the four functions `xmonad`, `ewmhFullscreen`, `ewmh`, and+> `xmobarProp` and give me the big new function+> `xmonad . ewmhFullscreen . ewmh . xmobarProp` that first executes+> `xmobarProp`, then `ewmh`, then `ewmhFullscreen`, and finally+> `xmonad`.  Then give it `myConfig` as its argument so it can do its+> thing.++This should strike you as nothing more than a syntactical quirk, at+least in this case.  And indeed, since `($)` is just function+application there is a very nice relationship between `(.)` and `($)`.+This may be more obvious if we write everything with parentheses and+apply the `(.)` operator (because we do have an argument):++``` haskell+-- ($) version+main = xmonad $ ewmhFullscreen $ ewmh $ xmobarProp $ myConfig+-- ($) version with parentheses+main = xmonad (ewmhFullscreen (ewmh (xmobarProp (myConfig))))++-- (.) version with parentheses+main = (xmonad . ewmhFullscreen . ewmh . xmobarProp) (myConfig)+-- xmobarProp applied+main = (xmonad . ewmhFullscreen . ewmh) (xmobarProp (myConfig))+-- ewmh applied+main = (xmonad . ewmhFullscreen) (ewmh (xmobarProp (myConfig)))+-- xmonad and ewmhFullscreen applied+main = (xmonad (ewmhFullscreen (ewmh (xmobarProp (myConfig))))+```++It's the same!  This is special to the interplay with `(.)` and `($)`+though; if you're on an older version of xmonad and xmonad-contrib and+use `xmobar` instead of `xmobarProp`, then you _have_ to write++``` haskell+main = xmonad . ewmhFullscreen . ewmh =<< xmobar myConfig+```++and this is _not_ equivalent to++``` haskell+main = xmonad (ewmhFullscreen (ewmh =<< xmobar myConfig))+```++Consult a Haskell book of your choice for why this is the case.++Back to our actual goal: customizing xmonad.  What the code we've+written does is take our tweaked default configuration `myConfig` and+add the support we need to make xmobar our status bar.  Do note that you+will also need to add the `XMonadLog` plugin to your xmobar+configuration; we will do this together below, so don't sweat it for+now.++To understand why this is necessary, let's talk a little bit about how+xmonad and xmobar fit together.  You can make them talk to each other in+several different ways.++By default, xmobar accepts input on its stdin, which it can display at+an arbitrary position on the screen.  We want xmonad to send xmobar the+stuff that you can see at the upper left of the starting screenshots:+information about available workspaces, current layout, and open+windows.  Naïvely, we can achieve this by spawning a pipe and letting+xmonad feed the relevant information to that pipe.  The problem with+that approach is that when the pipe is not being read and gets full,+xmonad will freeze!++It is thus much better to switch over to property based logging, where+we are writing to an X11 property and having xmobar read that; no danger+when things are not being read!  For this reason we have to use+`XMonadLog` instead of `StdinReader` in our xmobar.  There's also an+`UnsafeXMonadLog` available, should you want to send actions to xmobar+(this is useful, for example, for [XMonad.Util.ClickableWorkspaces],+which is a new feature in `0.17.0`).++_IF YOU ARE ON A VERSION `< 0.17.0`_: As discussed above, the `xmobar`+  function uses pipes, so you actually do want to use the `StdinReader`.+  Simply replace _all_ occurences of `XMonadLog` with `StdinReader`+  below (don't forget the template!)++## Configuring Xmobar++Now, before this will work, we have to configure xmobar.  Here's a nice+starting point.  Be aware that, while Haskell syntax highlighting is+used here to make this pretty, xmobar's config is _not_ a Haskell file+and thus can't execute arbitrary code—at least not by default.  If you+do want to configure xmobar in Haskell there is a note about that at the+end of this section.++``` haskell+Config { overrideRedirect = False+       , font     = "xft:iosevka-9"+       , bgColor  = "#5f5f5f"+       , fgColor  = "#f8f8f2"+       , position = TopW L 90+       , commands = [ Run Weather "EGPF"+                        [ "--template", "<weather> <tempC>°C"+                        , "-L", "0"+                        , "-H", "25"+                        , "--low"   , "lightblue"+                        , "--normal", "#f8f8f2"+                        , "--high"  , "red"+                        ] 36000+                    , Run Cpu+                        [ "-L", "3"+                        , "-H", "50"+                        , "--high"  , "red"+                        , "--normal", "green"+                        ] 10+                    , Run Alsa "default" "Master"+                        [ "--template", "<volumestatus>"+                        , "--suffix"  , "True"+                        , "--"+                        , "--on", ""+                        ]+                    , Run Memory ["--template", "Mem: <usedratio>%"] 10+                    , Run Swap [] 10+                    , Run Date "%a %Y-%m-%d <fc=#8be9fd>%H:%M</fc>" "date" 10+                    , Run XMonadLog+                    ]+       , sepChar  = "%"+       , alignSep = "}{"+       , template = "%XMonadLog% }{ %alsa:default:Master% | %cpu% | %memory% * %swap% | %EGPF% | %date% "+       }+```++First, we set the font to use for the bar, as well as the colors.  The+position options are documented well on the [xmobar home page] or,+alternatively, in the [quick-start.org] on GitHub.  The particular+option of `TopW L 90` says to put the bar in the upper left of the+screen, and make it consume 90% of the width of the screen (we need to+leave a little bit of space for `trayer-srg`).  If you're up for it—and+this really requires more shell-scripting than Haskell knowledge—you can+also try to seamlessly embed trayer into xmobar by using+[trayer-padding-icon.sh] and following the advice given in that thread.++In the commands list you, well, define commands.  Commands are the+pieces that generate the content to be displayed in your bar.  These+will later be combined together in the `template`.  Here, we have+defined a weather widget, a CPU widget, memory and swap widgets, a date,+a volume indicator, and of course the data from xmonad via `XMonadLog`.++The `EGPF` in the weather command is a particular station.  Replace both+(!) occurences of it with your choice of ICAO weather stations.  For a+list of ICAO codes you can visit the relevant [Wikipedia page].  You can+of course monitor more than one if you like; see xmobar's [weather+monitor] documentation for further details.++The `template` then combines everything together.  The `alignSep`+variable controls the alignment of all of the monitors.  Stuff to be+left-justified goes before the `}` character, things to be centered+after it, and things to be right justified after `{`.  We have nothing+centered so there is nothing in-between them.++Save the file to `~/.xmobarrc`.  Now press `M-q` to reload xmonad; you+should now see xmobar with your new configuration!  Please note that, at+this point, the config _has_ to reside in `~/.xmobarrc`.  We will,+however, discuss how to change this soon.++It is also possible to completely configure xmobar in Haskell, just like+xmonad.  If you want to know more about that, you can check out the+[xmobar.hs] example in the official documentation.  For a more+complicated example, you can also check out [jao's xmobar.hs] (he's the+current maintainer of xmobar).++## Changing What XMonad Sends to Xmobar++Now that the xmobar side of the picture looks nice, what about the stuff+that xmonad sends to xmobar?  It would be nice to visually match these+two.  Sadly, this is not quite possible with our `xmobarProp` function;+however, looking at the implementation of the function (or, indeed, the+top-level documentation of the module!) should give us some ideas for+how to proceed:++``` haskell+xmobarProp config =+  withEasySB (statusBarProp "xmobar" (pure xmobarPP)) toggleStrutsKey config+```++This means that `xmobarProp` just calls the functions `withEasySB` and+`statusBarProp` with some arguments; crucially for us, notice the+`xmobarPP`.  In this context "PP" stands for "pretty-printer"—exactly+what we want to modify!++Let's copy the implementation over into our main function:++``` haskell+main :: IO ()+main = xmonad+     . ewmhFullscreen+     . ewmh+     . withEasySB (statusBarProp "xmobar" (pure def)) defToggleStrutsKey+     $ myConfig+```++_IF YOU ARE ON A VERSION `< 0.17.0`_: `xmobar` has a similar definition,+  relying on `statusBar` alone: `xmobar = statusBar "xmobar" xmobarPP+    toggleStrutsKey`.  Sadly, the `defToggleStrutsKey` function is not yet+  exported, so you will have to define it yourself:++``` haskell+main :: IO ()+main = xmonad+     . ewmhFullscreen+     . ewmh+   =<< statusBar "xmobar" def toggleStrutsKey myConfig+  where+    toggleStrutsKey :: XConfig Layout -> (KeyMask, KeySym)+    toggleStrutsKey XConfig{ modMask = m } = (m, xK_b)+```++The `defToggleStrutsKey` here is just the key with which you can toggle+the bar; it is bound to `M-b`.  If you want to change this, you can also+define your own:++``` haskell+main :: IO ()+main = xmonad+     . ewmhFullscreen+     . ewmh+     . withEasySB (statusBarProp "xmobar" (pure def)) toggleStrutsKey+     $ myConfig+  where+    toggleStrutsKey :: XConfig Layout -> (KeyMask, KeySym)+    toggleStrutsKey XConfig{ modMask = m } = (m, xK_b)+```++Feel free to change the binding by modifying the `(m, xK_b)` tuple to+your liking.++If you want your xmobar configuration file to reside somewhere else than+`~/.xmobarrc`, you can now simply give the file to xmobar as a+positional argument!  For example:++``` haskell+main :: IO ()+main = xmonad+     . ewmhFullscreen+     . ewmh+     . withEasySB (statusBarProp "xmobar ~/.config/xmobar/xmobarrc" (pure def)) defToggleStrutsKey+     $ myConfig+```++Back to controlling what exactly we send to xmobar.  The `def`+pretty-printer just gives us the same result that the internal+`xmobarPP` would have given us.  Let's try to build something on top of+this.  To prepare, we can first create a new function `myXmobarPP` with+the default configuration:++``` haskell+myXmobarPP :: PP+myXmobarPP = def+```++and then plug that into our main function:++``` haskell+main :: IO ()+main = xmonad+     . ewmhFullscreen+     . ewmh+     . withEasySB (statusBarProp "xmobar" (pure myXmobarPP)) defToggleStrutsKey+     $ myConfig+```++As before, we now change things by modifying that `def` record until we+find something that we like.  First, for some functionality that we need+further down we need to import one more module:++``` haskell+import XMonad.Util.Loggers+```++Now we are finally ready to make things pretty.  There are _a lot_ of+options for the [PP record]; I'd advise you to read through all of them+now, so you don't get lost!++``` haskell+myXmobarPP :: PP+myXmobarPP = def+    { ppSep             = magenta " • "+    , ppTitleSanitize   = xmobarStrip+    , ppCurrent         = wrap " " "" . xmobarBorder "Top" "#8be9fd" 2+    , ppHidden          = white . wrap " " ""+    , ppHiddenNoWindows = lowWhite . wrap " " ""+    , ppUrgent          = red . wrap (yellow "!") (yellow "!")+    , ppOrder           = \[ws, l, _, wins] -> [ws, l, wins]+    , ppExtras          = [logTitles formatFocused formatUnfocused]+    }+  where+    formatFocused   = wrap (white    "[") (white    "]") . magenta . ppWindow+    formatUnfocused = wrap (lowWhite "[") (lowWhite "]") . blue    . ppWindow++    -- | Windows should have *some* title, which should not not exceed a+    -- sane length.+    ppWindow :: String -> String+    ppWindow = xmobarRaw . (\w -> if null w then "untitled" else w) . shorten 30++    blue, lowWhite, magenta, red, white, yellow :: String -> String+    magenta  = xmobarColor "#ff79c6" ""+    blue     = xmobarColor "#bd93f9" ""+    white    = xmobarColor "#f8f8f2" ""+    yellow   = xmobarColor "#f1fa8c" ""+    red      = xmobarColor "#ff5555" ""+    lowWhite = xmobarColor "#bbbbbb" ""+```++_IF YOU ARE ON A VERSION `< 0.17`_: Both `logTitles` and `xmobarBorder`+  are not available yet, so you will have to remove them.  As an+  alternative to `xmobarBorder`, a common way to "mark" the currently+  focused workspace is by using brackets; you can try something like+  `ppCurrent = wrap (blue "[") (blue "]")` and see if you like it.  Also+  read the bit about `ppOrder` further down!++That's a lot!  But don't worry, take a deep breath and remind yourself+of what you read above in the documentation of the [PP record].  Even if+you haven't read the documentation yet, most of the fields should be+pretty self-explanatory; `ppTitle` formats the title of the currently+focused window, `ppCurrent` formats the currently focused workspace,+`ppHidden` is for the hidden workspaces that have windows on them, etc.+The rest is just deciding on some pretty colours and formatting things+just how we like it.++An important thing to talk about may be `ppOrder`.  Quoting from its+documentation:++> By default, this function receives a list with three formatted+> strings, representing the workspaces, the layout, and the current+> window title, respectively. If you have specified any extra loggers+> in ppExtras, their output will also be appended to the list.++So the first three argument of the list (`ws`, `l`, and `_` in our case,+where the `_` just means we want to ignore that argument and not give it+a name) are the workspaces to show, the currently active layout, and the+title of the focused window.  The last element—`wins`—is what we gave to+`ppExtras`; if you added more loggers to that then you would have to add+more items to the list, like this:++``` haskell+ppOrder = \[ws, l, _, wins, more, more2] -> [ws, l, wins, more, more2]+```++However, many people want to show _all_ window titles on the currently+focused workspace instead.  For that, one can use `logTitles` from+[XMonad.Util.Loggers] (remember that module we just imported?).+However, `logTitles` logs _all_ titles.  Naturally, we don't want to+show the focused window twice and so we suppress it here by ignoring the+third argument of `ppOrder` and not returning it.  The functions+`formatFocused` and `formatUnfocused` should be relatively self+explanitory—they decide how to format the focused resp. unfocused+windows.++By the way, the `\ ... ->` syntax in there is Haskell's way to express a+[lambda abstraction] (or anonymous function, as some languages call it).+All of the arguments of the function come directly after the `\` and+before the `->`; in our case, this is a list with exactly four elements+in it.  Basically, it's a nice way to write a function inline and not+having to define it inside e.g. a `where` clause.  The above could have+also be written as++``` haskell+myXmobarPP :: PP+myXmobarPP = def+    { -- stuff here+    , ppOrder = myOrder+      -- more stuff here+    }+  where+    myOrder [ws, l, _, wins] = [ws, l, wins]+    -- more stuff here+```++If you're unsure of the number of elements that your `ppOrder` will+take, you can also specify the list like this:++``` haskell+ppOrder = \(ws : l : _ : wins : _) -> [ws, l, wins]+```++This says that it is a list of _at least_ four elements (`ws`, `l`, the+unnamed argument, and `wins`), but that afterwards everything is+possible.++This config is really quite complicated.  If this is too much for you,+you can also really just start with the blank++``` haskell+myXmobarPP :: PP+myXmobarPP = def+```++then add something, reload xmonad, see how things change and whether you+like them.  If not, remove that part and try something else.  If you do,+try to understand how that particular piece of code works.  You'll have+something approaching the above that you fully understand in no time!++## Configuring Related Utilities++So now you've got a status bar and xmonad.  We still need a few more+things: a screensaver, a tray for our apps that have tray icons, a way+to set our desktop background, and the like.++For this, we will need a few pieces of software.++``` shell+apt-get install trayer xscreensaver+```++If you want a network applet, something to set your desktop background,+and a power-manager:++``` shell+apt-get install nm-applet feh xfce4-power-manager+```++First, configure xscreensaver how you like it with the+`xscreensaver-demo` command.  Now, we will set these things up in+`~/.xinitrc` (we could also do most of this in xmonad's `startupHook`,+but `~/.xinitrc` is perhaps more standard).  If you want to use xmonad+with a desktop environment, see [Basic Desktop Environment Integration]+for how to do this.++Your `~/.xinitrc` may wind up looking like this:++``` shell+#!/bin/sh++# [... default stuff that your distro may throw in here ...] #++# Set up an icon tray+trayer --edge top --align right --SetDockType true --SetPartialStrut true \+ --expand true --width 10 --transparent true --tint 0x5f5f5f --height 18 &++# Set the default X cursor to the usual pointer+xsetroot -cursor_name left_ptr++# Set a nice background+feh --bg-fill --no-fehbg ~/.wallpapers/haskell-red-noise.png++# Fire up screensaver+xscreensaver -no-splash &++# Power Management+xfce4-power-manager &++if [ -x /usr/bin/nm-applet ] ; then+   nm-applet --sm-disable &+fi++exec xmonad+```++Notice the call to `trayer` above.  The options tell it to go on the top+right, with a default width of 10% of the screen (to nicely match up+with xmobar, which we set to a width of 90% of the screen).  We give it+a color and a height.++Then we fire up the rest of the programs that interest us.++Finally, we start xmonad.++<img alt="blank desktop" src="https://user-images.githubusercontent.com/50166980/111529498-84d49080-8762-11eb-9e81-c15dd844b0a9.png" width="660">++Mission accomplished!++Of course substitute the wallpaper for one of your own.  If you like the+one used above, you can find it [here](https://i.imgur.com/9MQHuZx.png).++## Final Touches++There may be some programs that you don't want xmonad to tile.  The+classic example here is the [GNU Image Manipulation Program]; it pops up+all sorts of new windows all the time, and they work best at defined+sizes.  It makes sense for xmonad to float these kinds of windows by+default.++This kind of behaviour can be achieved via the `manageHook`, which runs+when windows are created.  There are several functions to help you match+on a certain window in [XMonad.ManageHook].  For example, suppose we'd+want to match on the class name of the application.  With the+application open, open another terminal and invoke the `xprop` command.+Then click on the application that you would like to know the properties+of.  In our case you should see (among other things)++``` shell+WM_CLASS(STRING) = "gimp", "Gimp"+```++The second string in `WM_CLASS` is the class name, which we can access+with `className` from [XMonad.ManageHook].  The first one is usually+called the instance name and is matched-on via `appName` from the same+module.++Let's use the class name for now.  We can tell all windows with that+class name to float by defining the following manageHook:++``` haskell+myManageHook = (className =? "Gimp" --> doFloat)+```++Say we also want to float all dialogs.  This is easy with the `isDialog`+function from [XMonad.Hooks.ManageHelpers] (which you should import) and+a little modification to the `myManageHook` function:++``` haskell+myManageHook :: ManageHook+myManageHook = composeAll+    [ className =? "Gimp" --> doFloat+    , isDialog            --> doFloat+    ]+```++Now we just need to tell xmonad to actually use our manageHook.  This is+as easy as overriding the `manageHook` field in `myConfig`.  You can do+it like this:++``` haskell+myConfig = def+    { modMask    = mod4Mask      -- Rebind Mod to the Super key+    , layoutHook = myLayout      -- Use custom layouts+    , manageHook = myManageHook  -- Match on certain windows+    }+  `additionalKeysP`+    [ ("M-S-z", spawn "xscreensaver-command -lock")+    , ("M-S-=", unGrab *> spawn "scrot -s"        )+    , ("M-]"  , spawn "firefox"                   )+    ]+```++## The Whole Thing++The full `~/.config/xmonad/xmonad.hs`, in all its glory, now looks like+this:++``` haskell+import XMonad++import XMonad.Hooks.DynamicLog+import XMonad.Hooks.ManageDocks+import XMonad.Hooks.ManageHelpers+import XMonad.Hooks.StatusBar+import XMonad.Hooks.StatusBar.PP++import XMonad.Util.EZConfig+import XMonad.Util.Loggers+import XMonad.Util.Ungrab++import XMonad.Layout.Magnifier+import XMonad.Layout.ThreeColumns++import XMonad.Hooks.EwmhDesktops+++main :: IO ()+main = xmonad+     . ewmhFullscreen+     . ewmh+     . withEasySB (statusBarProp "xmobar" (pure myXmobarPP)) defToggleStrutsKey+     $ myConfig++myConfig = def+    { modMask    = mod4Mask      -- Rebind Mod to the Super key+    , layoutHook = myLayout      -- Use custom layouts+    , manageHook = myManageHook  -- Match on certain windows+    }+  `additionalKeysP`+    [ ("M-S-z", spawn "xscreensaver-command -lock")+    , ("M-S-=", unGrab *> spawn "scrot -s"        )+    , ("M-]"  , spawn "firefox"                   )+    ]++myManageHook :: ManageHook+myManageHook = composeAll+    [ className =? "Gimp" --> doFloat+    , isDialog            --> doFloat+    ]++myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol+  where+    threeCol = magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio+    tiled    = Tall nmaster delta ratio+    nmaster  = 1      -- Default number of windows in the master pane+    ratio    = 1/2    -- Default proportion of screen occupied by master pane+    delta    = 3/100  -- Percent of screen to increment by when resizing panes++myXmobarPP :: PP+myXmobarPP = def+    { ppSep             = magenta " • "+    , ppTitleSanitize   = xmobarStrip+    , ppCurrent         = wrap " " "" . xmobarBorder "Top" "#8be9fd" 2+    , ppHidden          = white . wrap " " ""+    , ppHiddenNoWindows = lowWhite . wrap " " ""+    , ppUrgent          = red . wrap (yellow "!") (yellow "!")+    , ppOrder           = \[ws, l, _, wins] -> [ws, l, wins]+    , ppExtras          = [logTitles formatFocused formatUnfocused]+    }+  where+    formatFocused   = wrap (white    "[") (white    "]") . magenta . ppWindow+    formatUnfocused = wrap (lowWhite "[") (lowWhite "]") . blue    . ppWindow++    -- | Windows should have *some* title, which should not not exceed a+    -- sane length.+    ppWindow :: String -> String+    ppWindow = xmobarRaw . (\w -> if null w then "untitled" else w) . shorten 30++    blue, lowWhite, magenta, red, white, yellow :: String -> String+    magenta  = xmobarColor "#ff79c6" ""+    blue     = xmobarColor "#bd93f9" ""+    white    = xmobarColor "#f8f8f2" ""+    yellow   = xmobarColor "#f1fa8c" ""+    red      = xmobarColor "#ff5555" ""+    lowWhite = xmobarColor "#bbbbbb" ""+```++## Further Customizations++The following section mostly consists of extra bits—feel free to skip+this and jump directly to [Get in Touch](#get-in-touch).  We've covered+a lot of ground here and sometimes it's really better to let things+settle a bit before going further; much more so if you're happy with how+things are looking and feeling right now!++### Beautifying Xmobar++A usual starting point for beautifying xmobar is either to use `xpm`+icons, or a font like `font-awesome` to add icons to the rest of the+text.  We will show you how to do the latter.  Xmobar, thankfully, makes+this very easy; just put a font down under `additionalFonts` and wrap+your Icons with `<fn>` tags and the respective index of the font+(starting from `1`).  As an example, consider how we would extend our+configuration above with this new functionality:++``` haskell+Config { overrideRedirect = False+       , font             = "xft:iosevka-9"+       , additionalFonts  = ["xft:FontAwesome-9"]+       ...+       , Run Battery+           [ ...+           , "--lows"   , "<fn=1>\62020</fn>  "+           , "--mediums", "<fn=1>\62018</fn>  "+           , "--highs"  , "<fn=1>\62016</fn>  "+             ...+           ]+       ...+       }+```++For an explanation of the battery commands used above, see xmobars+[battery] documentation.++You can also specify workspaces in the same way and feed them to xmobar+via the property (e.g. have `"<fn=1>\xf120</fn>"` as one of your+workspace names).++As an example how this would look like in a real configuration, you can+look at [Liskin's], [slotThe's], or [TheMC47's] xmobar configuration.+Do note that the last two are Haskell-based and thus may be a little+hard to understand for newcomers.++[Liskin's]: https://github.com/liskin/dotfiles/blob/home/.xmobarrc+[TheMC47's]: https://github.com/TheMC47/dotfiles/tree/master/xmobar/xmobarrc+[slotThe's]: https://gitlab.com/slotThe/dotfiles/-/blob/master/xmobar/.config/xmobarrc/src/xmobarrc.hs++### Renaming Layouts++`Magnifier NoMaster ThreeCol` is quite a mouthful to show in your bar,+right?  Thankfully there is the nifty [XMonad.Layout.Renamed], which+makes renaming layouts easy!  We will focus on the `Replace` constructor+here, as a lot of people will find that that's all they need.  To use it+we again follow the documentation (try it yourself!)—import the module+and then change `myLayout` like this:++``` haskell+myLayout = tiled ||| Mirror tiled ||| Full ||| threeCol+  where+    threeCol+        = renamed [Replace "ThreeCol"]+        $ magnifiercz' 1.3+        $ ThreeColMid nmaster delta ratio+    tiled   = Tall nmaster delta ratio+    nmaster = 1      -- Default number of windows in the master pane+    ratio   = 1/2    -- Default proportion of screen occupied by master pane+    delta   = 3/100  -- Percent of screen to increment by when resizing panes+```++The new line `renamed [Replace "ThreeCol"]` tells the layout to throw+its current name away and use `ThreeCol` instead.  After reloading+xmonad, you should now see this shorter name in your bar.  The line+breaks here are just cosmetic, by the way; if you want you can write+everything in one line:++``` haskell+threeCol = renamed [Replace "ThreeCol"] $ magnifiercz' 1.3 $ ThreeColMid nmaster delta ratio+```++## Get in Touch++The `irc.libera.chat/#xmonad` channel is very friendly and helpful.  It+is possible that people will not immediately answer—we do have lives as+well, after all :).  Eventually though, people will usually chime in if+they have something helpful to say; sometimes this takes 10 minutes,+other times it may well take 10 hours.  If you don't have an IRC client+ready to go, the easiest way to join is via [webchat]—just jot down a+username and you should be good to go!  There is a [log] of the channel+available, in case you do have to disconnect at some point, so don't+worry about missing any messages.++If you're not a fan of real-time interactions, you can also post to the+[xmonad mailing list] or the [xmonad subreddit].++## Trouble?++Check `~/.xsession-errors` or your distribution's equivalent first.  If+you're using a distribution that does not log into a file automatically,+you will have to set this up manually.  For example, you could put+something like++``` shell+if [[ ! $DISPLAY ]]; then+  exec startx >& ~/.xsession-errors+fi+```++into your `~/.profile` file to explicitly log everything into+`~/.xsession-errors`.++If you can't figure out what's wrong, don't hesitate to+[get in touch](#get-in-touch)!++## Closing Thoughts++That was quite a ride!  Don't worry if you didn't understand everything+perfectly, these things take time.  You can re-read parts of this guide+as often as you need to and—with the risk of sounding like a broken+record—if you can't figure something out really do not be afraid to+[get in touch](#get-in-touch).++If you want to see a few more complicated examples of other peoples+xmonad configurations, look no further!  Below are (in alphabetical+order) the configurations of a few of xmonad's maintainers.  Just keep+in mind that these setups are very customized and perhaps a little bit+hard to replicate (some may rely on features only available in personal+forks or git), may or may not be documented, and most aren't very pretty+either :)++  - [byorgey](https://github.com/byorgey/dotfiles)+  - [geekosaur](https://github.com/geekosaur/xmonad.hs/tree/pyanfar)+  - [liskin](https://github.com/liskin/dotfiles/tree/home/.xmonad)+  - [psibi](https://github.com/psibi/dotfiles/tree/master/xmonad)+  - [slotThe](https://gitlab.com/slotThe/dotfiles/-/tree/master/xmonad/.config/xmonad)+  - [TheMC47](https://github.com/TheMC47/dotfiles/tree/master/xmonad/.xmonad)+++[log]: https://ircbrowse.tomsmeding.com/browse/lcxmonad+[EWMH]: https://specifications.freedesktop.org/wm-spec/wm-spec-1.3.html+[ICCCM]: https://tronche.com/gui/x/icccm/+[webchat]: https://kiwiirc.com/nextclient/irc.libera.chat/?#xmonad+[about xmonad]: https://xmonad.org/about.html+[shell variable]: https://www.shellscript.sh/variables1.html+[xmonad-testing]: https://github.com/xmonad/xmonad-testing+[xmonad subreddit]: https://old.reddit.com/r/xmonad/+[xmonad guided tour]: https://xmonad.org/tour.html+[xmonad mailing list]: https://mail.haskell.org/mailman/listinfo/xmonad+[xmonad's GitHub page]: https://github.com/xmonad/xmonad+[trayer-padding-icon.sh]: https://github.com/jaor/xmobar/issues/239#issuecomment-233206552+[xmonad-contrib documentation]: https://hackage.haskell.org/package/xmonad-contrib+[GNU Image Manipulation Program]: https://www.gimp.org/+[Basic Desktop Environment Integration]: https://wiki.haskell.org/Xmonad/Basic_Desktop_Environment_Integration++[Hacks]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Util-Hacks.html+[PP record]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Hooks-DynamicLog.html#t:PP+[INSTALL.md]: INSTALL.md+[XMonad.Config]: https://github.com/xmonad/xmonad/blob/master/src/XMonad/Config.hs+[XMonad.ManageHook]: https://xmonad.github.io/xmonad-docs/xmonad/XMonad-ManageHook.html+[XMonad.Util.Loggers]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Util-Loggers.html+[XMonad.Util.EZConfig]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Util-EZConfig.html+[XMonad.Layout.Renamed]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Layout-Renamed.html+[XMonad.Layout.Magnifier]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Layout-Magnifier.html+[XMonad.Doc.Contributing]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Doc-Configuring.html+[XMonad.Hooks.EwmhDesktops]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Hooks-EwmhDesktops.html+[XMonad.Layout.ThreeColumns]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Layout-ThreeColumns.html+[XMonad.Hooks.ManageHelpers]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Hooks-ManageHelpers.html+[XMonad.Util.ClickableWorkspaces]: https://xmonad.github.io/xmonad-docs/xmonad-contrib/XMonad-Util-ClickableWorkspaces.html++[xmobar]: https://xmobar.org/+[battery]: https://github.com/jaor/xmobar/blob/master/doc/plugins.org#batteryp-dirs-args-refreshrate+[xmobar.hs]: https://github.com/jaor/xmobar/blob/master/examples/xmobar.hs+[Wikipedia page]: https://en.wikipedia.org/wiki/ICAO_airport_code#Prefixes+[quick-start.org]: https://github.com/jaor/xmobar/blob/master/doc/quick-start.org#configuration-options+[jao's xmobar.hs]: https://codeberg.org/jao/xmobar-config+[weather monitor]: https://github.com/jaor/xmobar/blob/master/doc/plugins.org#weather-monitors+[xmobar home page]: https://xmobar.org/+[xmobar's `Installation` section]: https://github.com/jaor/xmobar#installation++[Haskell]: https://www.haskell.org/+[trayer-srg]: https://github.com/sargon/trayer-srg+[record update]: http://learnyouahaskell.com/making-our-own-types-and-typeclasses+[lambda abstraction]: https://wiki.haskell.org/Lambda_abstraction+[GNU Emacs conventions]: https://www.gnu.org/software/emacs/manual/html_node/elisp/Key-Sequences.html#Key-Sequences
man/xmonad.1 view
@@ -1,13 +1,13 @@-.\" Automatically generated by Pandoc 2.2.1+.\" Automatically generated by Pandoc 2.5 .\"-.TH "XMONAD" "1" "30 September 2018" "Tiling Window Manager" ""+.TH "XMONAD" "1" "27 October 2021" "Tiling Window Manager" "" .hy .SH Name .PP xmonad \- Tiling Window Manager .SH Description .PP-\f[I]xmonad\f[] is a minimalist tiling window manager for X, written in+\f[I]xmonad\f[R] is a minimalist tiling window manager for X, written in Haskell. Windows are managed using automatic layout algorithms, which can be dynamically reconfigured.@@ -15,14 +15,14 @@ real estate. All features of the window manager are accessible purely from the keyboard: a mouse is entirely optional.-\f[I]xmonad\f[] is configured in Haskell, and custom layout algorithms+\f[I]xmonad\f[R] is configured in Haskell, and custom layout algorithms may be implemented by the user in config files.-A principle of \f[I]xmonad\f[] is predictability: the user should know+A principle of \f[I]xmonad\f[R] is predictability: the user should know in advance precisely the window arrangement that will result from any action. .PP-By default, \f[I]xmonad\f[] provides three layout algorithms: tall, wide-and fullscreen.+By default, \f[I]xmonad\f[R] provides three layout algorithms: tall,+wide and fullscreen. In tall or wide mode, windows are tiled and arranged to prevent overlap and maximize screen use. Sets of windows are grouped together on virtual screens, and each screen@@ -31,9 +31,9 @@ simultaneous display of a number of screens. .PP By utilizing the expressivity of a modern functional language with a-rich static type system, \f[I]xmonad\f[] provides a complete, featureful-window manager in less than 1200 lines of code, with an emphasis on-correctness and robustness.+rich static type system, \f[I]xmonad\f[R] provides a complete,+featureful window manager in less than 1200 lines of code, with an+emphasis on correctness and robustness. Internal properties of the window manager are checked using a combination of static guarantees provided by the type system, and type\-based automated testing.@@ -41,7 +41,7 @@ modify. .SH Usage .PP-\f[I]xmonad\f[] places each window into a \[lq]workspace\[rq].+\f[I]xmonad\f[R] places each window into a \[lq]workspace\[rq]. Each workspace can have any number of windows, which you can cycle though with mod\-j and mod\-k. Windows are either displayed full screen, tiled horizontally, or tiled@@ -58,7 +58,7 @@ 1 workspace visible. mod\-{w,e,r} switch the focus between screens, while shift\-mod\-{w,e,r} move the current window to that screen.-When \f[I]xmonad\f[] starts, workspace 1 is on screen 1, workspace 2 is+When \f[I]xmonad\f[R] starts, workspace 1 is on screen 1, workspace 2 is on screen 2, etc. When switching workspaces to one that is already visible, the current and visible workspaces are swapped.@@ -68,216 +68,155 @@ These flags are: .TP .B \[en]recompile-Recompiles your configuration in \f[I]~/.xmonad/xmonad.hs\f[]-.RS-.RE+Recompiles your \f[I]xmonad.hs\f[R] configuration .TP .B \[en]restart-Causes the currently running \f[I]xmonad\f[] process to restart-.RS-.RE+Causes the currently running \f[I]xmonad\f[R] process to restart .TP .B \[en]replace Replace the current window manager with xmonad-.RS-.RE .TP .B \[en]version-Display version of \f[I]xmonad\f[]-.RS-.RE+Display version of \f[I]xmonad\f[R] .TP .B \[en]verbose\-version-Display detailed version of \f[I]xmonad\f[]-.RS-.RE-.PP-##Default keyboard bindings+Display detailed version of \f[I]xmonad\f[R]+.SS Default keyboard bindings .TP .B mod\-shift\-return Launch terminal-.RS-.RE .TP .B mod\-p Launch dmenu-.RS-.RE .TP .B mod\-shift\-p Launch gmrun-.RS-.RE .TP .B mod\-shift\-c Close the focused window-.RS-.RE .TP .B mod\-space Rotate through the available layout algorithms-.RS-.RE .TP .B mod\-shift\-space Reset the layouts on the current workspace to default-.RS-.RE .TP .B mod\-n Resize viewed windows to the correct size-.RS-.RE .TP .B mod\-tab Move focus to the next window-.RS-.RE .TP .B mod\-shift\-tab Move focus to the previous window-.RS-.RE .TP .B mod\-j Move focus to the next window-.RS-.RE .TP .B mod\-k Move focus to the previous window-.RS-.RE .TP .B mod\-m Move focus to the master window-.RS-.RE .TP .B mod\-return Swap the focused window and the master window-.RS-.RE .TP .B mod\-shift\-j Swap the focused window with the next window-.RS-.RE .TP .B mod\-shift\-k Swap the focused window with the previous window-.RS-.RE .TP .B mod\-h Shrink the master area-.RS-.RE .TP .B mod\-l Expand the master area-.RS-.RE .TP .B mod\-t Push window back into tiling-.RS-.RE .TP .B mod\-comma Increment the number of windows in the master area-.RS-.RE .TP .B mod\-period Deincrement the number of windows in the master area-.RS-.RE .TP .B mod\-shift\-q Quit xmonad-.RS-.RE .TP .B mod\-q Restart xmonad-.RS-.RE .TP .B mod\-shift\-slash Run xmessage with a summary of the default keybindings (useful for beginners)-.RS-.RE .TP .B mod\-question Run xmessage with a summary of the default keybindings (useful for beginners)-.RS-.RE .TP .B mod\-[1..9] Switch to workspace N-.RS-.RE .TP .B mod\-shift\-[1..9] Move client to workspace N-.RS-.RE .TP .B mod\-{w,e,r} Switch to physical/Xinerama screens 1, 2, or 3-.RS-.RE .TP .B mod\-shift\-{w,e,r} Move client to screen 1, 2, or 3-.RS-.RE .TP .B mod\-button1 Set the window to floating mode and move by dragging-.RS-.RE .TP .B mod\-button2 Raise the window to the top of the stack-.RS-.RE .TP .B mod\-button3 Set the window to floating mode and resize by dragging-.RS-.RE .SH Examples .PP-To use xmonad as your window manager add to your \f[I]~/.xinitrc\f[]-file:+To use xmonad as your window manager add to your+\f[I]\[ti]/.xinitrc\f[R] file: .RS .PP exec xmonad .RE .SH Customization .PP-xmonad is customized in ~/.xmonad/xmonad.hs, and then restarted with-mod\-q.+xmonad is customized in your \f[I]xmonad.hs\f[R], and then restarted+with mod\-q.+You can choose where your configuration file lives by+.IP "1." 3+Setting \f[C]XMONAD_DATA_DIR,\f[R] \f[C]XMONAD_CONFIG_DIR\f[R], and+\f[C]XMONAD_CACHE_DIR\f[R]; \f[I]xmonad.hs\f[R] is then expected to be+in \f[C]XMONAD_CONFIG_DIR\f[R].+.IP "2." 3+Creating \f[I]xmonad.hs\f[R] in \f[I]\[ti]/.xmonad\f[R].+.IP "3." 3+Creating \f[I]xmonad.hs\f[R] in \f[C]XDG_CONFIG_HOME\f[R].+Note that, in this case, xmonad will use \f[C]XDG_DATA_HOME\f[R] and+\f[C]XDG_CACHE_HOME\f[R] for its data and cache directory respectively. .PP You can find many extensions to the core feature set in the xmonad\- contrib package, available through your package manager or from-xmonad.org (http://xmonad.org).+xmonad.org (https://xmonad.org). .SS Modular Configuration .PP-As of \f[I]xmonad\-0.9\f[], any additional Haskell modules may be placed-in \f[I]~/.xmonad/lib/\f[] are available in GHC's searchpath.+As of \f[I]xmonad\-0.9\f[R], any additional Haskell modules may be+placed in \f[I]\[ti]/.xmonad/lib/\f[R] are available in GHC\[cq]s+searchpath. Hierarchical modules are supported: for example, the file-\f[I]~/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[] could contain:+\f[I]\[ti]/.xmonad/lib/XMonad/Stack/MyAdditions.hs\f[R] could contain: .IP .nf \f[C]-module\ XMonad.Stack.MyAdditions\ (function1)\ where-\ \ function1\ =\ error\ "function1:\ Not\ implemented\ yet!"-\f[]+module XMonad.Stack.MyAdditions (function1) where+  function1 = error \[dq]function1: Not implemented yet!\[dq]+\f[R] .fi .PP Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that
man/xmonad.1.html view
@@ -5,7 +5,7 @@   <meta name="generator" content="pandoc" />   <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />   <meta name="author" content="" />-  <meta name="dcterms.date" content="2018-09-30" />+  <meta name="dcterms.date" content="2021-10-27" />   <title>XMONAD(1) Tiling Window Manager</title>   <style type="text/css">       code{white-space: pre-wrap;}@@ -31,7 +31,7 @@ pre.numberSource a.sourceLine   { position: relative; left: -4em; } pre.numberSource a.sourceLine::before-  { content: attr(data-line-number);+  { content: attr(title);     position: relative; left: -1em; text-align: right; vertical-align: baseline;     border: none; pointer-events: all; display: inline-block;     -webkit-touch-callout: none; -webkit-user-select: none;@@ -76,15 +76,12 @@ code span.vs { color: #4070a0; } /* VerbatimString */ code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */   </style>-  <!--[if lt IE 9]>-    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>-  <![endif]--> </head> <body>-<header>+<header id="title-block-header"> <h1 class="title">XMONAD(1) Tiling Window Manager</h1> <p class="author"></p>-<p class="date">30 September 2018</p>+<p class="date">27 October 2021</p> </header> <nav id="TOC"> <ul>@@ -92,6 +89,7 @@ <li><a href="#description">Description</a></li> <li><a href="#usage">Usage</a><ul> <li><a href="#flags">Flags</a></li>+<li><a href="#default-keyboard-bindings">Default keyboard bindings</a></li> </ul></li> <li><a href="#examples">Examples</a></li> <li><a href="#customization">Customization</a><ul>@@ -114,7 +112,7 @@ <p>xmonad has several flags which you may pass to the executable. These flags are:</p> <dl> <dt>–recompile</dt>-<dd>Recompiles your configuration in <em>~/.xmonad/xmonad.hs</em>+<dd>Recompiles your <em>xmonad.hs</em> configuration </dd> <dt>–restart</dt> <dd>Causes the currently running <em>xmonad</em> process to restart@@ -129,7 +127,7 @@ <dd>Display detailed version of <em>xmonad</em> </dd> </dl>-<p>##Default keyboard bindings</p>+<h2 id="default-keyboard-bindings">Default keyboard bindings</h2> <dl> <dt>mod-shift-return</dt> <dd>Launch terminal@@ -231,12 +229,17 @@ <p>exec xmonad</p> </blockquote> <h1 id="customization">Customization</h1>-<p>xmonad is customized in ~/.xmonad/xmonad.hs, and then restarted with mod-q.</p>-<p>You can find many extensions to the core feature set in the xmonad- contrib package, available through your package manager or from <a href="http://xmonad.org">xmonad.org</a>.</p>+<p>xmonad is customized in your <em>xmonad.hs</em>, and then restarted with mod-q. You can choose where your configuration file lives by</p>+<ol type="1">+<li>Setting <code>XMONAD_DATA_DIR,</code> <code>XMONAD_CONFIG_DIR</code>, and <code>XMONAD_CACHE_DIR</code>; <em>xmonad.hs</em> is then expected to be in <code>XMONAD_CONFIG_DIR</code>.</li>+<li>Creating <em>xmonad.hs</em> in <em>~/.xmonad</em>.</li>+<li>Creating <em>xmonad.hs</em> in <code>XDG_CONFIG_HOME</code>. Note that, in this case, xmonad will use <code>XDG_DATA_HOME</code> and <code>XDG_CACHE_HOME</code> for its data and cache directory respectively.</li>+</ol>+<p>You can find many extensions to the core feature set in the xmonad- contrib package, available through your package manager or from <a href="https://xmonad.org">xmonad.org</a>.</p> <h2 id="modular-configuration">Modular Configuration</h2> <p>As of <em>xmonad-0.9</em>, any additional Haskell modules may be placed in <em>~/.xmonad/lib/</em> are available in GHC’s searchpath. Hierarchical modules are supported: for example, the file <em>~/.xmonad/lib/XMonad/Stack/MyAdditions.hs</em> could contain:</p>-<div class="sourceCode" id="cb1"><pre class="sourceCode haskell"><code class="sourceCode haskell"><a class="sourceLine" id="cb1-1" data-line-number="1"><span class="kw">module</span> <span class="dt">XMonad.Stack.MyAdditions</span> (function1) <span class="kw">where</span></a>-<a class="sourceLine" id="cb1-2" data-line-number="2">  function1 <span class="fu">=</span> error <span class="st">&quot;function1: Not implemented yet!&quot;</span></a></code></pre></div>+<div class="sourceCode" id="cb1"><pre class="sourceCode haskell"><code class="sourceCode haskell"><a class="sourceLine" id="cb1-1" title="1"><span class="kw">module</span> <span class="dt">XMonad.Stack.MyAdditions</span> (function1) <span class="kw">where</span></a>+<a class="sourceLine" id="cb1-2" title="2">  function1 <span class="ot">=</span> <span class="fu">error</span> <span class="st">&quot;function1: Not implemented yet!&quot;</span></a></code></pre></div> <p>Your xmonad.hs may then import XMonad.Stack.MyAdditions as if that module was contained within xmonad or xmonad-contrib.</p> <h1 id="bugs">Bugs</h1> <p>Probably. If you find any, please report them to the <a href="https://github.com/xmonad/xmonad/issues">bugtracker</a></p>
man/xmonad.1.markdown view
@@ -1,6 +1,6 @@ % XMONAD(1) Tiling Window Manager %-% 30 September 2018+% 27 October 2021  # Name @@ -58,7 +58,7 @@ These flags are:  --recompile-:   Recompiles your configuration in _~/.xmonad/xmonad.hs_+:   Recompiles your _xmonad.hs_ configuration  --restart :   Causes the currently running _xmonad_ process to restart@@ -72,10 +72,101 @@ --verbose-version :   Display detailed version of _xmonad_ -##Default keyboard bindings+## Default keyboard bindings -___KEYBINDINGS___+mod-shift-return+:     Launch terminal +mod-p+:     Launch dmenu++mod-shift-p+:     Launch gmrun++mod-shift-c+:     Close the focused window++mod-space+:     Rotate through the available layout algorithms++mod-shift-space+:     Reset the layouts on the current workspace to default++mod-n+:     Resize viewed windows to the correct size++mod-tab+:     Move focus to the next window++mod-shift-tab+:     Move focus to the previous window++mod-j+:     Move focus to the next window++mod-k+:     Move focus to the previous window++mod-m+:     Move focus to the master window++mod-return+:     Swap the focused window and the master window++mod-shift-j+:     Swap the focused window with the next window++mod-shift-k+:     Swap the focused window with the previous window++mod-h+:     Shrink the master area++mod-l+:     Expand the master area++mod-t+:     Push window back into tiling++mod-comma+:     Increment the number of windows in the master area++mod-period+:     Deincrement the number of windows in the master area++mod-shift-q+:     Quit xmonad++mod-q+:     Restart xmonad++mod-shift-slash+:     Run xmessage with a summary of the default keybindings (useful for beginners)++mod-question+:     Run xmessage with a summary of the default keybindings (useful for beginners)++mod-[1..9]+:     Switch to workspace N++mod-shift-[1..9]+:     Move client to workspace N++mod-{w,e,r}+:     Switch to physical/Xinerama screens 1, 2, or 3++mod-shift-{w,e,r}+:     Move client to screen 1, 2, or 3++mod-button1+:     Set the window to floating mode and move by dragging++mod-button2+:     Raise the window to the top of the stack++mod-button3+:     Set the window to floating mode and resize by dragging+ # Examples  To use xmonad as your window manager add to your _~/.xinitrc_ file:@@ -83,9 +174,17 @@ > exec xmonad  # Customization-xmonad is customized in ~/.xmonad/xmonad.hs, and then restarted-with mod-q.+xmonad is customized in your _xmonad.hs_, and then restarted with mod-q.+You can choose where your configuration file lives by +  1. Setting `XMONAD_DATA_DIR,` `XMONAD_CONFIG_DIR`, and+     `XMONAD_CACHE_DIR`; _xmonad.hs_ is then expected to be in+     `XMONAD_CONFIG_DIR`.+  2. Creating _xmonad.hs_ in _~/.xmonad_.+  3. Creating _xmonad.hs_ in `XDG_CONFIG_HOME`.  Note that, in this+     case, xmonad will use `XDG_DATA_HOME` and `XDG_CACHE_HOME` for its+     data and cache directory respectively.+ You can find many extensions to the core feature set in the xmonad- contrib package, available through your  package  manager  or  from [xmonad.org].@@ -107,5 +206,5 @@ # Bugs Probably. If you find any, please report them to the [bugtracker] -[xmonad.org]: http://xmonad.org+[xmonad.org]: https://xmonad.org [bugtracker]: https://github.com/xmonad/xmonad/issues
man/xmonad.hs view
@@ -129,7 +129,7 @@     , ((modm              , xK_q     ), spawn "xmonad --recompile; xmonad --restart")      -- Run xmessage with a summary of the default keybindings (useful for beginners)-    , ((modm .|. shiftMask, xK_slash ), spawn ("echo \"" ++ help ++ "\" | xmessage -file -"))+    , ((modm .|. shiftMask, xK_slash ), xmessage help)     ]     ++ @@ -293,6 +293,7 @@     "mod-Space        Rotate through the available layout algorithms",     "mod-Shift-Space  Reset the layouts on the current workSpace to default",     "mod-n            Resize/refresh viewed windows to the correct size",+    "mod-Shift-/      Show this help message with the default keybindings",     "",     "-- move focus up or down the window stack",     "mod-Tab        Move focus to the next window",
src/XMonad/Config.hs view
@@ -39,7 +39,7 @@ import XMonad.ManageHook import qualified XMonad.StackSet as W import Data.Bits ((.|.))-import Data.Default+import Data.Default.Class import Data.Monoid import qualified Data.Map as M import System.Exit@@ -239,7 +239,7 @@         , (f, m) <- [(W.view, 0), (W.shift, shiftMask)]]   where     helpCommand :: X ()-    helpCommand = spawn ("echo " ++ show help ++ " | xmessage -file -")+    helpCommand = xmessage help  -- | Mouse bindings: default actions bound to mouse events mouseBindings :: XConfig Layout -> M.Map (KeyMask, Button) (Window -> X ())@@ -277,6 +277,7 @@     , XMonad.handleExtraArgs = \ xs theConf -> case xs of                 [] -> return theConf                 _ -> fail ("unrecognized flags:" ++ show xs)+    , XMonad.extensibleConf     = M.empty     }  -- | The default set of configuration values itself@@ -296,6 +297,7 @@     "mod-Space        Rotate through the available layout algorithms",     "mod-Shift-Space  Reset the layouts on the current workSpace to default",     "mod-n            Resize/refresh viewed windows to the correct size",+    "mod-Shift-/      Show this help message with the default keybindings",     "",     "-- move focus up or down the window stack",     "mod-Tab        Move focus to the next window",
src/XMonad/Core.hs view
@@ -1,5 +1,6 @@ {-# LANGUAGE ExistentialQuantification, FlexibleInstances, GeneralizedNewtypeDeriving,-             MultiParamTypeClasses, TypeSynonymInstances, DeriveDataTypeable #-}+             MultiParamTypeClasses, TypeSynonymInstances, DeriveDataTypeable,+             LambdaCase, NamedFieldPuns, DeriveTraversable #-}  ----------------------------------------------------------------------------- -- |@@ -22,26 +23,29 @@     XConf(..), XConfig(..), LayoutClass(..),     Layout(..), readsLayout, Typeable, Message,     SomeMessage(..), fromMessage, LayoutMessages(..),-    StateExtension(..), ExtensionClass(..),+    StateExtension(..), ExtensionClass(..), ConfExtension(..),     runX, catchX, userCode, userCodeDef, io, catchIO, installSignalHandlers, uninstallSignalHandlers,     withDisplay, withWindowSet, isRoot, runOnWorkspaces,-    getAtom, spawn, spawnPID, xfork, recompile, trace, whenJust, whenX,-    getXMonadDir, getXMonadCacheDir, getXMonadDataDir, stateFileName,+    getAtom, spawn, spawnPID, xfork, xmessage, recompile, trace, whenJust, whenX,+    getXMonadDir, getXMonadCacheDir, getXMonadDataDir, stateFileName, binFileName,     atom_WM_STATE, atom_WM_PROTOCOLS, atom_WM_DELETE_WINDOW, atom_WM_TAKE_FOCUS, withWindowAttributes,-    ManageHook, Query(..), runQuery+    ManageHook, Query(..), runQuery, Directories'(..), Directories, getDirectories,   ) where  import XMonad.StackSet hiding (modify)  import Prelude-import Control.Exception.Extensible (fromException, try, bracket, throw, finally, SomeException(..))-import qualified Control.Exception.Extensible as E-import Control.Applicative(Applicative, pure, (<$>), (<*>))+import Control.Exception (fromException, try, bracket, bracket_, throw, finally, SomeException(..))+import qualified Control.Exception as E+import Control.Applicative ((<|>), empty) import Control.Monad.Fail import Control.Monad.State import Control.Monad.Reader import Data.Semigroup-import Data.Default+import Data.Traversable (for)+import Data.Time.Clock (UTCTime)+import Data.Default.Class+import Data.List (isInfixOf) import System.FilePath import System.IO import System.Info@@ -58,8 +62,6 @@ import Data.Typeable import Data.List ((\\)) import Data.Maybe (isJust,fromMaybe)-import Data.Monoid hiding ((<>))-import System.Environment (lookupEnv)  import qualified Data.Map as M import qualified Data.Set as S@@ -93,8 +95,8 @@     , mousePosition :: !(Maybe (Position, Position))                                       -- ^ position of the mouse according to                                       -- the event currently being processed-    , currentEvent :: !(Maybe Event)-                                      -- ^ event currently being processed+    , currentEvent :: !(Maybe Event)  -- ^ event currently being processed+    , directories  :: !Directories    -- ^ directories to use     }  -- todo, better name@@ -122,6 +124,11 @@     , rootMask           :: !EventMask           -- ^ The root events that xmonad is interested in     , handleExtraArgs    :: !([String] -> XConfig Layout -> IO (XConfig Layout))                                                  -- ^ Modify the configuration, complain about extra arguments etc. with arguments that are not handled by default+    , extensibleConf     :: !(M.Map TypeRep ConfExtension)+                                                 -- ^ Stores custom config information.+                                                 --+                                                 -- The module "XMonad.Util.ExtensibleConf" in xmonad-contrib+                                                 -- provides additional information and a simple interface for using this.     }  @@ -135,7 +142,8 @@ newtype ScreenId    = S Int deriving (Eq,Ord,Show,Read,Enum,Num,Integral,Real)  -- | The 'Rectangle' with screen dimensions-data ScreenDetail   = SD { screenRect :: !Rectangle } deriving (Eq,Show, Read)+newtype ScreenDetail = SD { screenRect :: Rectangle }+    deriving (Eq,Show, Read)  ------------------------------------------------------------------------ @@ -148,7 +156,7 @@ -- instantiated on 'XConf' and 'XState' automatically. -- newtype X a = X (ReaderT XConf (StateT XState IO) a)-    deriving (Functor, Monad, MonadFail, MonadIO, MonadState XState, MonadReader XConf, Typeable)+    deriving (Functor, Monad, MonadFail, MonadIO, MonadState XState, MonadReader XConf)  instance Applicative X where   pure = return@@ -255,14 +263,18 @@ -- | Every layout must be an instance of 'LayoutClass', which defines -- the basic layout operations along with a sensible default for each. ----- Minimal complete definition:+-- All of the methods have default implementations, so there is no+-- minimal complete definition.  They do, however, have a dependency+-- structure by default; this is something to be aware of should you+-- choose to implement one of these methods.  Here is how a minimal+-- complete definition would look like if we did not provide any default+-- implementations: ----- * 'runLayout' || (('doLayout' || 'pureLayout') && 'emptyLayout'), and+-- * 'runLayout' || (('doLayout' || 'pureLayout') && 'emptyLayout') -- -- * 'handleMessage' || 'pureMessage' ----- You should also strongly consider implementing 'description',--- although it is not required.+-- * 'description' -- -- Note that any code which /uses/ 'LayoutClass' methods should only -- ever call 'runLayout', 'handleMessage', and 'description'!  In@@ -271,7 +283,7 @@ -- 'runLayout', 'handleMessage', and so on.  This ensures that the -- proper methods will be used, regardless of the particular methods -- that any 'LayoutClass' instance chooses to define.-class Show (layout a) => LayoutClass layout a where+class (Show (layout a), Typeable layout) => LayoutClass layout a where      -- | By default, 'runLayout' calls 'doLayout' if there are any     --   windows to be laid out, and 'emptyLayout' otherwise.  Most@@ -373,12 +385,12 @@ -- layouts) should consider handling. data LayoutMessages = Hide              -- ^ sent when a layout becomes non-visible                     | ReleaseResources  -- ^ sent when xmonad is exiting or restarting-    deriving (Typeable, Eq)+    deriving Eq  instance Message LayoutMessages  -- ------------------------------------------------------------------------ Extensible state+-- Extensible state/config --  -- | Every module must make the data it wants to store@@ -386,6 +398,7 @@ -- -- Minimal complete definition: initialValue class Typeable a => ExtensionClass a where+    {-# MINIMAL initialValue #-}     -- | Defines an initial value for the state extension     initialValue :: a     -- | Specifies whether the state extension should be@@ -404,6 +417,9 @@   | forall a. (Read a, Show a, ExtensionClass a) => PersistentExtension a     -- ^ Persistent extension +-- | Existential type to store a config extension.+data ConfExtension = forall a. Typeable a => ConfExtension a+ -- --------------------------------------------------------------------- -- | General utilities --@@ -439,6 +455,16 @@         dupTo fd stdInput         closeFd fd +-- | Use @xmessage@ to show information to the user.+xmessage :: MonadIO m => String -> m ()+xmessage msg = void . xfork $ do+    executeFile "xmessage" True+        [ "-default", "okay"+        , "-xrm", "*international:true"+        , "-xrm", "*fontSet:-*-fixed-medium-r-normal-*-18-*-*-*-*-*-*-*,-*-fixed-*-*-*-*-18-*-*-*-*-*-*-*,-*-*-*-*-*-*-18-*-*-*-*-*-*-*"+        , msg+        ] Nothing+ -- | This is basically a map function, running a function in the 'X' monad on -- each workspace with the output of that function being the modified workspace. runOnWorkspaces :: (WindowSpace -> X WindowSpace) -> X ()@@ -449,138 +475,255 @@              $ current ws : visible ws     modify $ \s -> s { windowset = ws { current = c, visible = v, hidden = h } } --- | Return the path to the xmonad configuration directory.  This--- directory is where user configuration files are stored (e.g, the--- xmonad.hs file).  You may also create a @lib@ subdirectory in the--- configuration directory and the default recompile command will add--- it to the GHC include path.------ Several directories are considered.  In order of--- preference:+-- | All the directories that xmonad will use.  They will be used for+-- the following purposes: -----   1. The directory specified in the @XMONAD_CONFIG_DIR@ environment variable.---   2. The @~\/.xmonad@ directory.---   3. The @XDG_CONFIG_HOME/xmonad@ directory.+-- * @dataDir@: This directory is used by XMonad to store data files+-- such as the run-time state file. ----- The first directory that exists will be used.  If none of the--- directories exist then (1) will be used if it is set, otherwise (2)--- will be used.  Either way, a directory will be created if necessary.-getXMonadDir :: MonadIO m => m String-getXMonadDir =-    findFirstDirWithEnv "XMONAD_CONFIG_DIR"-      [ getAppUserDataDirectory "xmonad"-      , getXDGDirectory XDGConfig "xmonad"-      ]---- | Return the path to the xmonad cache directory.  This directory is--- used to store temporary files that can easily be recreated.  For--- example, the XPrompt history file.+-- * @cfgDir@: This directory is where user configuration files are+-- stored (e.g, the xmonad.hs file).  You may also create a @lib@+-- subdirectory in the configuration directory and the default recompile+-- command will add it to the GHC include path. ----- Several directories are considered.  In order of preference:+-- * @cacheDir@: This directory is used to store temporary files that+-- can easily be recreated such as the configuration binary and any+-- intermediate object files generated by GHC.+-- Also, the XPrompt history file goes here. -----   1. The directory specified in the @XMONAD_CACHE_DIR@ environment variable.---   2. The @~\/.xmonad@ directory.---   3. The @XDG_CACHE_HOME/xmonad@ directory.+-- For how these directories are chosen, see 'getDirectories'. ----- The first directory that exists will be used.  If none of the--- directories exist then (1) will be used if it is set, otherwise (2)--- will be used.  Either way, a directory will be created if necessary.-getXMonadCacheDir :: MonadIO m => m String-getXMonadCacheDir =-    findFirstDirWithEnv "XMONAD_CACHE_DIR"-      [ getAppUserDataDirectory "xmonad"-      , getXDGDirectory XDGCache "xmonad"-      ]+data Directories' a = Directories+    { dataDir  :: !a+    , cfgDir   :: !a+    , cacheDir :: !a+    }+    deriving (Show, Functor, Foldable, Traversable) --- | Return the path to the xmonad data directory.  This directory is--- used by XMonad to store data files such as the run-time state file--- and the configuration binary generated by GHC.+-- | Convenient type alias for the most common case in which one might+-- want to use the 'Directories' type.+type Directories = Directories' FilePath++-- | Build up the 'Dirs' that xmonad will use.  They are chosen as+-- follows: ----- Several directories are considered.  In order of preference:+-- 1. If all three of xmonad's environment variables (@XMONAD_DATA_DIR@,+--    @XMONAD_CONFIG_DIR@, and @XMONAD_CACHE_DIR@) are set, use them.+-- 2. If there is a build script called @build@ or configuration+--    @xmonad.hs@ in @~\/.xmonad@, set all three directories to+--    @~\/.xmonad@.+-- 3. Otherwise, use the @xmonad@ directory in @XDG_DATA_HOME@,+--    @XDG_CONFIG_HOME@, and @XDG_CACHE_HOME@ (or their respective+--    fallbacks).  These directories are created if necessary. -----   1. The directory specified in the @XMONAD_DATA_DIR@ environment variable.---   2. The @~\/.xmonad@ directory.---   3. The @XDG_DATA_HOME/xmonad@ directory.+-- The xmonad configuration file (or the build script, if present) is+-- always assumed to be in @cfgDir@. ----- The first directory that exists will be used.  If none of the--- directories exist then (1) will be used if it is set, otherwise (2)--- will be used.  Either way, a directory will be created if necessary.-getXMonadDataDir :: MonadIO m => m String-getXMonadDataDir =-    findFirstDirWithEnv "XMONAD_DATA_DIR"-      [ getAppUserDataDirectory "xmonad"-      , getXDGDirectory XDGData "xmonad"-      ]+getDirectories :: IO Directories+getDirectories = xmEnvDirs <|> xmDirs <|> xdgDirs+  where+    -- | Check for xmonad's environment variables first+    xmEnvDirs :: IO Directories+    xmEnvDirs = do+        let xmEnvs = Directories{ dataDir  = "XMONAD_DATA_DIR"+                                , cfgDir   = "XMONAD_CONFIG_DIR"+                                , cacheDir = "XMONAD_CACHE_DIR"+                                }+        maybe empty pure . sequenceA =<< traverse getEnv xmEnvs --- | Helper function that will find the first existing directory and--- return its path.  If none of the directories can be found, create--- and return the first from the list.  If the list is empty this--- function returns the historical @~\/.xmonad@ directory.-findFirstDirOf :: MonadIO m => [IO FilePath] -> m FilePath-findFirstDirOf []        = findFirstDirOf [getAppUserDataDirectory "xmonad"]-findFirstDirOf possibles = do-    found <- go possibles+    -- | Check whether the config file or a build script is in the+    -- @~\/.xmonad@ directory+    xmDirs :: IO Directories+    xmDirs = do+        xmDir <- getAppUserDataDirectory "xmonad"+        conf  <- doesFileExist $ xmDir </> "xmonad.hs"+        build <- doesFileExist $ xmDir </> "build" -    case found of-      Just path -> return path-      Nothing   -> do-        primary <- io (head possibles)-        io (createDirectoryIfMissing True primary)-        return primary+        -- Place *everything* in ~/.xmonad if yes+        guard $ conf || build+        pure Directories{ dataDir = xmDir, cfgDir = xmDir, cacheDir = xmDir } +    -- | Use XDG directories as a fallback+    xdgDirs :: IO Directories+    xdgDirs =+        for Directories{ dataDir = XdgData, cfgDir = XdgConfig, cacheDir = XdgCache }+            $ \dir -> do d <- getXdgDirectory dir "xmonad"+                         d <$ createDirectoryIfMissing True d++-- | Return the path to the xmonad configuration directory.+getXMonadDir :: X String+getXMonadDir = asks (cfgDir . directories)+{-# DEPRECATED getXMonadDir "Use `asks (cfgDir . directories)' instead." #-}++-- | Return the path to the xmonad cache directory.+getXMonadCacheDir :: X String+getXMonadCacheDir = asks (cacheDir . directories)+{-# DEPRECATED getXMonadCacheDir "Use `asks (cacheDir . directories)' instead." #-}++-- | Return the path to the xmonad data directory.+getXMonadDataDir :: X String+getXMonadDataDir = asks (dataDir . directories)+{-# DEPRECATED getXMonadDataDir "Use `asks (dataDir . directories)' instead." #-}++binFileName, buildDirName :: Directories -> FilePath+binFileName  Directories{ cacheDir } = cacheDir </> "xmonad-" <> arch <> "-" <> os+buildDirName Directories{ cacheDir } = cacheDir </> "build-" <> arch <> "-" <> os++errFileName, stateFileName :: Directories -> FilePath+errFileName   Directories{ dataDir } = dataDir </> "xmonad.errors"+stateFileName Directories{ dataDir } = dataDir </> "xmonad.state"++srcFileName, libFileName :: Directories -> FilePath+srcFileName Directories{ cfgDir } = cfgDir </> "xmonad.hs"+libFileName Directories{ cfgDir } = cfgDir </> "lib"++buildScriptFileName, stackYamlFileName :: Directories -> FilePath+buildScriptFileName Directories{ cfgDir } = cfgDir </> "build"+stackYamlFileName   Directories{ cfgDir } = cfgDir </> "stack.yaml"++-- | Compilation method for xmonad configuration.+data Compile = CompileGhc | CompileStackGhc FilePath | CompileScript FilePath+    deriving (Show)++-- | Detect compilation method by looking for known file names in xmonad+-- configuration directory.+detectCompile :: Directories -> IO Compile+detectCompile dirs = tryScript <|> tryStack <|> useGhc   where-    go []     = return Nothing-    go (x:xs) = do-      dir    <- io x-      exists <- io (doesDirectoryExist dir)-      if exists then return (Just dir) else go xs+    buildScript = buildScriptFileName dirs+    stackYaml = stackYamlFileName dirs --- | Simple wrapper around @findFirstDirOf@ that allows the primary--- path to be specified by an environment variable.-findFirstDirWithEnv :: MonadIO m => String -> [IO FilePath] -> m FilePath-findFirstDirWithEnv envName paths = do-    envPath' <- io (getEnv envName)+    tryScript = do+        guard =<< doesFileExist buildScript+        isExe <- isExecutable buildScript+        if isExe+          then do+            trace $ "XMonad will use build script at " <> show buildScript <> " to recompile."+            pure $ CompileScript buildScript+          else do+            trace $ "XMonad will not use build script, because " <> show buildScript <> " is not executable."+            trace $ "Suggested resolution to use it: chmod u+x " <> show buildScript+            empty -    case envPath' of-      Nothing      -> findFirstDirOf paths-      Just envPath -> findFirstDirOf (return envPath:paths)+    tryStack = do+        guard =<< doesFileExist stackYaml+        canonStackYaml <- canonicalizePath stackYaml+        trace $ "XMonad will use stack ghc --stack-yaml " <> show canonStackYaml <> " to recompile."+        pure $ CompileStackGhc canonStackYaml --- | Helper function to retrieve the various XDG directories.--- This has been based on the implementation shipped with GHC version 8.0.1 or--- higher. Put here to preserve compatibility with older GHC versions.-getXDGDirectory :: XDGDirectory -> FilePath -> IO FilePath-getXDGDirectory xdgDir suffix =-  normalise . (</> suffix) <$>-  case xdgDir of-    XDGData   -> get "XDG_DATA_HOME"   ".local/share"-    XDGConfig -> get "XDG_CONFIG_HOME" ".config"-    XDGCache  -> get "XDG_CACHE_HOME"  ".cache"+    useGhc = do+        trace $ "XMonad will use ghc to recompile, because neither "+                <> show buildScript <> " nor " <> show stackYaml <> " exists."+        pure CompileGhc++    isExecutable f = E.catch (executable <$> getPermissions f) (\(SomeException _) -> return False)++-- | Should we recompile xmonad configuration? Is it newer than the compiled+-- binary?+shouldCompile :: Directories -> Compile -> IO Bool+shouldCompile dirs CompileGhc = do+    libTs <- mapM getModTime . Prelude.filter isSource =<< allFiles (libFileName dirs)+    srcT <- getModTime (srcFileName dirs)+    binT <- getModTime (binFileName dirs)+    if any (binT <) (srcT : libTs)+        then True <$ trace "XMonad recompiling because some files have changed."+        else False <$ trace "XMonad skipping recompile because it is not forced (e.g. via --recompile), and neither xmonad.hs nor any *.hs / *.lhs / *.hsc files in lib/ have been changed."   where-    get name fallback = do-      env <- lookupEnv name-      case env of-        Nothing -> fallback'-        Just path-          | isRelative path -> fallback'-          | otherwise -> return path-      where-        fallback' = (</> fallback) <$> getHomeDirectory-data XDGDirectory = XDGData | XDGConfig | XDGCache+    isSource = flip elem [".hs",".lhs",".hsc"] . takeExtension+    allFiles t = do+        let prep = map (t</>) . Prelude.filter (`notElem` [".",".."])+        cs <- prep <$> E.catch (getDirectoryContents t) (\(SomeException _) -> return [])+        ds <- filterM doesDirectoryExist cs+        concat . ((cs \\ ds):) <$> mapM allFiles ds+shouldCompile dirs CompileStackGhc{} = do+    stackYamlT <- getModTime (stackYamlFileName dirs)+    binT <- getModTime (binFileName dirs)+    if binT < stackYamlT+        then True <$ trace "XMonad recompiling because some files have changed."+        else shouldCompile dirs CompileGhc+shouldCompile _dirs CompileScript{} =+    True <$ trace "XMonad recompiling because a custom build script is being used." --- | Get the name of the file used to store the xmonad window state.-stateFileName :: (Functor m, MonadIO m) => m FilePath-stateFileName = (</> "xmonad.state") <$> getXMonadDataDir+getModTime :: FilePath -> IO (Maybe UTCTime)+getModTime f = E.catch (Just <$> getModificationTime f) (\(SomeException _) -> return Nothing) --- | 'recompile force', recompile the xmonad configuration file when--- any of the following apply:+-- | Compile the configuration.+compile :: Directories -> Compile -> IO ExitCode+compile dirs method =+    bracket_ uninstallSignalHandlers installSignalHandlers $+        bracket (openFile (errFileName dirs) WriteMode) hClose $ \err -> do+            let run = runProc (cfgDir dirs) err+            case method of+                CompileGhc ->+                    run "ghc" ghcArgs+                CompileStackGhc stackYaml ->+                    run "stack" ["build", "--silent", "--stack-yaml", stackYaml] .&&.+                    run "stack" ("ghc" : "--stack-yaml" : stackYaml : "--" : ghcArgs)+                CompileScript script ->+                    run script [binFileName dirs]+  where+    ghcArgs = [ "--make"+              , "xmonad.hs"+              , "-i" -- only look in @lib@+              , "-ilib"+              , "-fforce-recomp"+              , "-main-is", "main"+              , "-v0"+              , "-outputdir", buildDirName dirs+              , "-o", binFileName dirs+              ]++    -- waitForProcess =<< System.Process.runProcess, but without closing the err handle+    runProc cwd err exe args = do+        hPutStrLn err $ unwords $ "$" : exe : args+        hFlush err+        (_, _, _, h) <- createProcess_ "runProc" (proc exe args){ cwd = Just cwd, std_err = UseHandle err }+        waitForProcess h++    cmd1 .&&. cmd2 = cmd1 >>= \case+        ExitSuccess -> cmd2+        e -> pure e++-- | Check GHC output for deprecation warnings and notify the user if there+-- were any. Report success otherwise.+checkCompileWarnings :: Directories -> IO ()+checkCompileWarnings dirs = do+    ghcErr <- readFile (errFileName dirs)+    if "-Wdeprecations" `isInfixOf` ghcErr+      then do+        let msg = unlines $+                ["Deprecations detected while compiling xmonad config: " <> srcFileName dirs]+                ++ lines ghcErr+                ++ ["","Please correct them or silence using {-# OPTIONS_GHC -Wno-deprecations #-}."]+        trace msg+        xmessage msg+      else+        trace "XMonad recompilation process exited with success!"++-- | Notify the user that compilation failed and what was wrong.+compileFailed :: Directories -> ExitCode -> IO ()+compileFailed dirs status = do+    ghcErr <- readFile (errFileName dirs)+    let msg = unlines $+            ["Errors detected while compiling xmonad config: " <> srcFileName dirs]+            ++ lines (if null ghcErr then show status else ghcErr)+            ++ ["","Please check the file for errors."]+    -- nb, the ordering of printing, then forking, is crucial due to+    -- lazy evaluation+    trace msg+    xmessage msg++-- | Recompile the xmonad configuration file when any of the following apply: -----      * force is 'True'+--  * force is 'True' -----      * the xmonad executable does not exist+--  * the xmonad executable does not exist -----      * the xmonad executable is older than xmonad.hs or any file in---        the @lib@ directory (under the configuration directory).+--  * the xmonad executable is older than @xmonad.hs@ or any file in+--    the @lib@ directory (under the configuration directory) --+--  * custom @build@ script is being used+-- -- The -i flag is used to restrict recompilation to the xmonad.hs file only, -- and any files in the aforementioned @lib@ directory. --@@ -590,106 +733,21 @@ -- -- 'False' is returned if there are compilation errors. ---recompile :: MonadIO m => Bool -> m Bool-recompile force = io $ do-    cfgdir  <- getXMonadDir-    datadir <- getXMonadDataDir-    let binn = "xmonad-"++arch++"-"++os-        bin  = datadir </> binn-        err  = datadir </> "xmonad.errors"-        src  = cfgdir </> "xmonad.hs"-        lib  = cfgdir </> "lib"-        buildscript = cfgdir </> "build"--    libTs <- mapM getModTime . Prelude.filter isSource =<< allFiles lib-    srcT <- getModTime src-    binT <- getModTime bin--    useBuildscript <- do-      exists <- doesFileExist buildscript-      if exists-        then do-          isExe <- isExecutable buildscript-          if isExe-            then do-              trace $ "XMonad will use build script at " ++ show buildscript ++ " to recompile."-              return True-            else do-              trace $ unlines-                [ "XMonad will not use build script, because " ++ show buildscript ++ " is not executable."-                , "Suggested resolution to use it: chmod u+x " ++ show buildscript-                ]-              return False-        else do-          trace $-            "XMonad will use ghc to recompile, because " ++ show buildscript ++ " does not exist."-          return False--    shouldRecompile <--      if useBuildscript || force-        then return True-        else if any (binT <) (srcT : libTs)-          then do-            trace "XMonad doing recompile because some files have changed."-            return True-          else do-            trace "XMonad skipping recompile because it is not forced (e.g. via --recompile), and neither xmonad.hs nor any *.hs / *.lhs / *.hsc files in lib/ have been changed."-            return False--    if shouldRecompile+recompile :: MonadIO m => Directories -> Bool -> m Bool+recompile dirs force = io $ do+    method <- detectCompile dirs+    willCompile <- if force+        then True <$ trace "XMonad recompiling (forced)."+        else shouldCompile dirs method+    if willCompile       then do-        -- temporarily disable SIGCHLD ignoring:-        uninstallSignalHandlers-        status <- bracket (openFile err WriteMode) hClose $ \errHandle ->-            waitForProcess =<< if useBuildscript-                               then compileScript bin cfgdir buildscript errHandle-                               else compileGHC bin cfgdir errHandle--        -- re-enable SIGCHLD:-        installSignalHandlers--        -- now, if it fails, run xmessage to let the user know:+        status <- compile dirs method         if status == ExitSuccess-            then trace "XMonad recompilation process exited with success!"-            else do-                ghcErr <- readFile err-                let msg = unlines $-                        ["Error detected while loading xmonad configuration file: " ++ src]-                        ++ lines (if null ghcErr then show status else ghcErr)-                        ++ ["","Please check the file for errors."]-                -- nb, the ordering of printing, then forking, is crucial due to-                -- lazy evaluation-                hPutStrLn stderr msg-                forkProcess $ executeFile "xmessage" True ["-default", "okay", replaceUnicode msg] Nothing-                return ()-        return (status == ExitSuccess)-      else return True- where getModTime f = E.catch (Just <$> getModificationTime f) (\(SomeException _) -> return Nothing)-       isSource = flip elem [".hs",".lhs",".hsc"] . takeExtension-       isExecutable f = E.catch (executable <$> getPermissions f) (\(SomeException _) -> return False)-       allFiles t = do-            let prep = map (t</>) . Prelude.filter (`notElem` [".",".."])-            cs <- prep <$> E.catch (getDirectoryContents t) (\(SomeException _) -> return [])-            ds <- filterM doesDirectoryExist cs-            concat . ((cs \\ ds):) <$> mapM allFiles ds-       -- Replace some of the unicode symbols GHC uses in its output-       replaceUnicode = map $ \c -> case c of-           '\8226' -> '*'  -- •-           '\8216' -> '`'  -- ‘-           '\8217' -> '`'  -- ’-           _ -> c-       compileGHC bin dir errHandle =-         runProcess "ghc" ["--make"-                          , "xmonad.hs"-                          , "-i"-                          , "-ilib"-                          , "-fforce-recomp"-                          , "-main-is", "main"-                          , "-v0"-                          , "-o", bin-                          ] (Just dir) Nothing Nothing Nothing (Just errHandle)-       compileScript bin dir script errHandle =-         runProcess script [bin] (Just dir) Nothing Nothing Nothing (Just errHandle)+            then checkCompileWarnings dirs+            else compileFailed dirs status+        pure $ status == ExitSuccess+      else+        pure True  -- | Conditionally run an action, using a @Maybe a@ to decide. whenJust :: Monad m => Maybe a -> (a -> m ()) -> m ()
src/XMonad/Layout.hs view
@@ -1,4 +1,4 @@-{-# LANGUAGE FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances, DeriveDataTypeable #-}+{-# LANGUAGE FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances, DeriveDataTypeable, LambdaCase, MultiWayIf #-}  -- -------------------------------------------------------------------------- -- |@@ -8,7 +8,7 @@ -- -- Maintainer  :  spencerjanssen@gmail.com -- Stability   :  unstable--- Portability :  not portable, Typeable deriving, mtl, posix+-- Portability :  not portable, mtl, posix -- -- The collection of core layouts. --@@ -16,7 +16,7 @@  module XMonad.Layout (     Full(..), Tall(..), Mirror(..),-    Resize(..), IncMasterN(..), Choose, (|||), ChangeLayout(..),+    Resize(..), IncMasterN(..), Choose(..), (|||), CLR(..), ChangeLayout(..), JumpToLayout(..),     mirrorRect, splitVertically,     splitHorizontally, splitHorizontallyBy, splitVerticallyBy, @@ -27,6 +27,7 @@ import XMonad.Core  import Graphics.X11 (Rectangle(..))+import Graphics.X11.Xlib.Extras ( Event(DestroyWindowEvent) ) import qualified XMonad.StackSet as W import Control.Arrow ((***), second) import Control.Monad@@ -35,10 +36,10 @@ ------------------------------------------------------------------------  -- | Change the size of the master pane.-data Resize     = Shrink | Expand   deriving Typeable+data Resize     = Shrink | Expand  -- | Increase the number of clients in the master pane.-data IncMasterN = IncMasterN !Int    deriving Typeable+data IncMasterN = IncMasterN !Int  instance Message Resize instance Message IncMasterN@@ -77,7 +78,7 @@ -- algorithm. -- -- The screen is divided into two panes. All clients are--- then partioned between these two panes. One pane, the master, by+-- then partitioned between these two panes. One pane, the master, by -- convention has the least number of windows in it. tile     :: Rational  -- ^ @frac@, what proportion of the screen to devote to the master area@@ -131,23 +132,53 @@ -- LayoutClass selection manager -- Layouts that transition between other layouts --- | Messages to change the current layout.-data ChangeLayout = FirstLayout | NextLayout deriving (Eq, Show, Typeable)+-- | Messages to change the current layout.  Also see 'JumpToLayout'.+data ChangeLayout = FirstLayout | NextLayout deriving (Eq, Show)  instance Message ChangeLayout +-- | A message to jump to a particular layout, specified by its+-- description string.+--+-- The argument given to a 'JumpToLayout' message should be the+-- @description@ of the layout to be selected.  If you use+-- "XMonad.Hooks.DynamicLog" from @xmonad-contrib@, this is the name of+-- the layout displayed in your status bar.  Alternatively, you can use+-- GHCi to determine the proper name to use.  For example:+--+-- > $ ghci+-- > GHCi, version 6.8.2: http://www.haskell.org/ghc/  :? for help+-- > Loading package base ... linking ... done.+-- > :set prompt "> "    -- don't show loaded module names+-- > > :m +XMonad.Core   -- load the xmonad core+-- > > :m +XMonad.Layout.Grid  -- load whatever module you want to use+-- > > description Grid  -- find out what it's called+-- > "Grid"+--+-- As yet another (possibly easier) alternative, you can use the+-- "XMonad.Layout.Renamed" module (also in @xmonad-contrib@) to give+-- custom names to your layouts, and use those.+--+-- For example, if you want to jump directly to the 'Full' layout you+-- can do+--+-- > , ((modm .|. controlMask, xK_f), sendMessage $ JumpToLayout "Full")+--+newtype JumpToLayout = JumpToLayout String+instance Message JumpToLayout+ -- | The layout choice combinator (|||) :: l a -> r a -> Choose l r a-(|||) = Choose L+(|||) = Choose CL infixr 5 |||  -- | A layout that allows users to switch between various layout options.-data Choose l r a = Choose LR (l a) (r a) deriving (Read, Show)+data Choose l r a = Choose CLR (l a) (r a) deriving (Read, Show) --- | Are we on the left or right sub-layout?-data LR = L | R deriving (Read, Show, Eq)+-- | Choose the current sub-layout (left or right) in 'Choose'.+data CLR = CL | CR deriving (Read, Show, Eq) -data NextNoWrap = NextNoWrap deriving (Eq, Show, Typeable)+data NextNoWrap = NextNoWrap deriving (Eq, Show) instance Message NextNoWrap  -- | A small wrapper around handleMessage, as it is tedious to write@@ -159,26 +190,26 @@ -- new structure if any fields have changed, and performs any necessary cleanup -- on newly non-visible layouts. choose :: (LayoutClass l a, LayoutClass r a)-       => Choose l r a-> LR -> Maybe (l a) -> Maybe (r a) -> X (Maybe (Choose l r a))+       => Choose l r a -> CLR -> Maybe (l a) -> Maybe (r a) -> X (Maybe (Choose l r a)) choose (Choose d _ _) d' Nothing Nothing | d == d' = return Nothing choose (Choose d l r) d' ml      mr = f lr  where     (l', r') = (fromMaybe l ml, fromMaybe r mr)     lr       = case (d, d') of-                    (L, R) -> (hide l'  , return r')-                    (R, L) -> (return l', hide r'  )-                    (_, _) -> (return l', return r')+                    (CL, CR) -> (hide l'  , return r')+                    (CR, CL) -> (return l', hide r'  )+                    (_ , _ ) -> (return l', return r')     f (x,y)  = fmap Just $ liftM2 (Choose d') x y     hide x   = fmap (fromMaybe x) $ handle x Hide  instance (LayoutClass l a, LayoutClass r a) => LayoutClass (Choose l r) a where-    runLayout (W.Workspace i (Choose L l r) ms) =-        fmap (second . fmap $ flip (Choose L) r) . runLayout (W.Workspace i l ms)-    runLayout (W.Workspace i (Choose R l r) ms) =-        fmap (second . fmap $ Choose R l) . runLayout (W.Workspace i r ms)+    runLayout (W.Workspace i (Choose CL l r) ms) =+        fmap (second . fmap $ flip (Choose CL) r) . runLayout (W.Workspace i l ms)+    runLayout (W.Workspace i (Choose CR l r) ms) =+        fmap (second . fmap $ Choose CR l) . runLayout (W.Workspace i r ms) -    description (Choose L l _) = description l-    description (Choose R _ r) = description r+    description (Choose CL l _) = description l+    description (Choose CR _ r) = description r      handleMessage lr m | Just NextLayout <- fromMessage m = do         mlr' <- handle lr NextNoWrap@@ -186,25 +217,36 @@      handleMessage c@(Choose d l r) m | Just NextNoWrap <- fromMessage m =         case d of-            L -> do+            CL -> do                 ml <- handle l NextNoWrap                 case ml of-                    Just _  -> choose c L ml Nothing-                    Nothing -> choose c R Nothing =<< handle r FirstLayout+                    Just _  -> choose c CL ml Nothing+                    Nothing -> choose c CR Nothing =<< handle r FirstLayout -            R -> choose c R Nothing =<< handle r NextNoWrap+            CR -> choose c CR Nothing =<< handle r NextNoWrap      handleMessage c@(Choose _ l _) m | Just FirstLayout <- fromMessage m =-        flip (choose c L) Nothing =<< handle l FirstLayout+        flip (choose c CL) Nothing =<< handle l FirstLayout      handleMessage c@(Choose d l r) m | Just ReleaseResources <- fromMessage m =         join $ liftM2 (choose c d) (handle l ReleaseResources) (handle r ReleaseResources) +    handleMessage c@(Choose d l r) m | Just e@DestroyWindowEvent{} <- fromMessage m =+        join $ liftM2 (choose c d) (handle l e) (handle r e)++    handleMessage c@(Choose d l r) m | Just (JumpToLayout desc) <- fromMessage m = do+        ml <- handleMessage l m+        mr <- handleMessage r m+        let md | desc == description (fromMaybe l ml) = CL+               | desc == description (fromMaybe r mr) = CR+               | otherwise = d+        choose c md ml mr+     handleMessage c@(Choose d l r) m = do         ml' <- case d of-                L -> handleMessage l m-                R -> return Nothing+                CL -> handleMessage l m+                CR -> return Nothing         mr' <- case d of-                L -> return Nothing-                R -> handleMessage r m+                CL -> return Nothing+                CR -> handleMessage r m         choose c d ml' mr'
src/XMonad/Main.hs view
@@ -1,4 +1,4 @@-{-# LANGUAGE MultiParamTypeClasses, FlexibleContexts #-}+{-# LANGUAGE MultiParamTypeClasses, FlexibleContexts, NamedFieldPuns #-} ---------------------------------------------------------------------------- -- | -- Module      :  XMonad.Main@@ -16,7 +16,7 @@ module XMonad.Main (xmonad, launch) where  import System.Locale.SetLocale-import qualified Control.Exception.Extensible as E+import qualified Control.Exception as E import Data.Bits import Data.List ((\\)) import Data.Function@@ -24,7 +24,7 @@ import qualified Data.Set as S import Control.Monad.Reader import Control.Monad.State-import Data.Maybe (fromMaybe)+import Data.Maybe (fromMaybe, isJust) import Data.Monoid (getAll)  import Graphics.X11.Xlib hiding (refreshKeyboardMapping)@@ -39,7 +39,7 @@ import System.IO import System.Directory import System.Info-import System.Environment+import System.Environment (getArgs, getProgName, withArgs) import System.Posix.Process (executeFile) import System.Exit (exitFailure) import System.FilePath@@ -48,6 +48,7 @@ import Data.Version (showVersion)  import Graphics.X11.Xinerama (compiledWithXinerama)+import Graphics.X11.Xrandr (xrrQueryExtension, xrrUpdateConfiguration)  ------------------------------------------------------------------------ @@ -59,17 +60,17 @@ xmonad conf = do     installSignalHandlers -- important to ignore SIGCHLD to avoid zombies +    dirs <- getDirectories     let launch' args = do-              catchIO buildLaunch-              conf' @ XConfig { layoutHook = Layout l }+              catchIO (buildLaunch dirs)+              conf'@XConfig { layoutHook = Layout l }                   <- handleExtraArgs conf args conf{ layoutHook = Layout (layoutHook conf) }-              withArgs [] $ launch (conf' { layoutHook = l })+              withArgs [] $ launch (conf' { layoutHook = l }) dirs      args <- getArgs     case args of-        ("--resume": ws : xs : args') -> migrateState ws xs >> launch' args'         ["--help"]            -> usage-        ["--recompile"]       -> recompile True >>= flip unless exitFailure+        ["--recompile"]       -> recompile dirs True >>= flip unless exitFailure         ["--restart"]         -> sendRestart         ["--version"]         -> putStrLn $ unwords shortVersion         ["--verbose-version"] -> putStrLn . unwords $ shortVersion ++ longVersion@@ -90,7 +91,7 @@         "Options:" :         "  --help                       Print this message" :         "  --version                    Print the version number" :-        "  --recompile                  Recompile your ~/.xmonad/xmonad.hs" :+        "  --recompile                  Recompile your xmonad.hs" :         "  --replace                    Replace the running window manager with xmonad" :         "  --restart                    Request a running xmonad process to restart" :         []@@ -111,21 +112,21 @@ -- --   * Missing XMonad\/XMonadContrib modules due to ghc upgrade ---buildLaunch ::  IO ()-buildLaunch = do+buildLaunch :: Directories -> IO ()+buildLaunch dirs = do     whoami <- getProgName-    let compiledConfig = "xmonad-"++arch++"-"++os+    let bin = binFileName dirs+    let compiledConfig = takeFileName bin     unless (whoami == compiledConfig) $ do       trace $ concat-        [ "XMonad is recompiling and replacing itself another XMonad process because the current process is called "+        [ "XMonad is recompiling and replacing itself with another XMonad process because the current process is called "         , show whoami         , " but the compiled configuration should be called "         , show compiledConfig         ]-      recompile False-      dir  <- getXMonadDataDir+      recompile dirs False       args <- getArgs-      executeFile (dir </> compiledConfig) False args Nothing+      executeFile bin False args Nothing  sendRestart :: IO () sendRestart = do@@ -134,7 +135,7 @@     xmonad_restart <- internAtom dpy "XMONAD_RESTART" False     allocaXEvent $ \e -> do         setEventType e clientMessage-        setClientMessageEvent e rw xmonad_restart 32 0 currentTime+        setClientMessageEvent' e rw xmonad_restart 32 []         sendEvent dpy rw False structureNotifyMask e     sync dpy False @@ -166,8 +167,8 @@ -- function instead of 'xmonad'.  You probably also want to have a key -- binding to the 'XMonad.Operations.restart` function that restarts -- your custom binary with the resume flag set to @True@.-launch :: (LayoutClass l Window, Read (l Window)) => XConfig l -> IO ()-launch initxmc = do+launch :: (LayoutClass l Window, Read (l Window)) => XConfig l -> Directories -> IO ()+launch initxmc drs = do     -- setup locale information from environment     setLocale LC_ALL (Just "")     -- ignore SIGPIPE and SIGCHLD@@ -216,7 +217,9 @@             , buttonActions = mouseBindings xmc xmc             , mouseFocused  = False             , mousePosition = Nothing-            , currentEvent  = Nothing }+            , currentEvent  = Nothing+            , directories   = drs+            }          st = XState             { windowset       = initialWinset@@ -231,7 +234,7 @@         runX cf st $ do             -- check for serialized state in a file.             serializedSt <- do-                path <- stateFileName+                path <- asks $ stateFileName . directories                 exists <- io (doesFileExist path)                 if exists then readStateFile initxmc else return Nothing @@ -260,8 +263,11 @@              userCode $ startupHook initxmc +            rrData <- io $ xrrQueryExtension dpy+            let rrUpdate = when (isJust rrData) . void . xrrUpdateConfiguration+             -- main loop, for all you HOF/recursion fans out there.-            forever $ prehandle =<< io (nextEvent dpy e >> getEvent e)+            forever $ prehandle =<< io (nextEvent dpy e >> rrUpdate e >> getEvent e)      return ()       where@@ -310,10 +316,15 @@  -- window destroyed, unmanage it -- window gone,      unmanage it-handle (DestroyWindowEvent {ev_window = w}) = whenX (isClient w) $ do+-- broadcast to layouts+handle e@(DestroyWindowEvent {ev_window = w}) = do+  whenX (isClient w) $ do     unmanage w     modify (\s -> s { mapped       = S.delete w (mapped s)                     , waitingUnmap = M.delete w (waitingUnmap s)})+  -- the window is already unmanged, but we broadcast the event to all layouts+  -- to trigger garbage-collection in case they hold window-specific resources+  broadcastMessage e  -- We track expected unmap events in waitingUnmap.  We ignore this event unless -- it is synthetic or we are not expecting an unmap notification from a window.@@ -472,8 +483,11 @@     -- build a map from keysyms to lists of keysyms (doing what     -- XGetKeyboardMapping would do if the X11 package bound it)     syms <- forM allCodes $ \code -> io (keycodeToKeysym dpy code 0)-    let keysymMap = M.fromListWith (++) (zip syms [[code] | code <- allCodes])-        keysymToKeycodes sym = M.findWithDefault [] sym keysymMap+    let keysymMap' = M.fromListWith (++) (zip syms [[code] | code <- allCodes])+    -- keycodeToKeysym returns noSymbol for all unbound keycodes, and we don't+    -- want to grab those whenever someone accidentally uses def :: KeySym+    let keysymMap = M.delete noSymbol keysymMap'+    let keysymToKeycodes sym = M.findWithDefault [] sym keysymMap     forM_ (M.keys ks) $ \(mask,sym) ->          forM_ (keysymToKeycodes sym) $ \kc ->               mapM_ (grab kc . (mask .|.)) =<< extraModifiers
src/XMonad/ManageHook.hs view
@@ -21,8 +21,8 @@ import XMonad.Core import Graphics.X11.Xlib.Extras import Graphics.X11.Xlib (Display, Window, internAtom, wM_NAME)-import Control.Exception.Extensible (bracket, SomeException(..))-import qualified Control.Exception.Extensible as E+import Control.Exception (bracket, SomeException(..))+import qualified Control.Exception as E import Control.Monad.Reader import Data.Maybe import Data.Monoid@@ -61,11 +61,15 @@  -- | '&&' lifted to a 'Monad'. (<&&>) :: Monad m => m Bool -> m Bool -> m Bool-(<&&>) = liftM2 (&&)+(<&&>) x y = ifM x y (pure False)  -- | '||' lifted to a 'Monad'. (<||>) :: Monad m => m Bool -> m Bool -> m Bool-(<||>) = liftM2 (||)+(<||>) x y = ifM x (pure True) y++-- | If-then-else lifted to a 'Monad'.+ifM :: Monad m => m Bool -> m a -> m a -> m a+ifM mb t f = mb >>= \b -> if b then t else f  -- | Return the window title. title :: Query String
src/XMonad/Operations.hs view
@@ -1,5 +1,4 @@-{-# OPTIONS_GHC -fno-warn-orphans #-}-{-# LANGUAGE FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, PatternGuards, TypeSynonymInstances #-}+{-# LANGUAGE FlexibleContexts, FlexibleInstances, MultiParamTypeClasses, PatternGuards #-} -- -------------------------------------------------------------------------- -- | -- Module      :  XMonad.Operations@@ -8,14 +7,49 @@ -- -- Maintainer  :  dons@cse.unsw.edu.au -- Stability   :  unstable--- Portability :  not portable, Typeable deriving, mtl, posix+-- Portability :  not portable, mtl, posix ----- Operations.+-- Operations. A module for functions that don't cleanly fit anywhere else. -- ----------------------------------------------------------------------------- -module XMonad.Operations where+module XMonad.Operations (+    -- * Manage One Window+    manage, unmanage, killWindow, kill, isClient,+    setInitialProperties, setWMState, setWindowBorderWithFallback,+    hide, reveal, tileWindow,+    setTopFocus, focus, +    -- * Manage Windows+    windows, refresh, rescreen, modifyWindowSet, windowBracket, windowBracket_, clearEvents, getCleanedScreenInfo,+    withFocused, withUnfocused,++    -- * Keyboard and Mouse+    cleanMask, extraModifiers,+    mouseDrag, mouseMoveWindow, mouseResizeWindow,+    setButtonGrab, setFocusX,++    -- * Messages+    sendMessage, broadcastMessage, sendMessageWithNoRefresh,++    -- * Save and Restore State+    StateFile (..), writeStateToFile, readStateFile, restart,++    -- * Floating Layer+    float, floatLocation,++    -- * Window Size Hints+    D, mkAdjust, applySizeHints, applySizeHints', applySizeHintsContents,+    applyAspectHint, applyResizeIncHint, applyMaxSizeHint,++    -- * Rectangles+    containedIn, nubScreens, pointWithin, scaleRationalRect,++    -- * Other Utilities+    initColor, pointScreen, screenWorkspace,+    setLayout, updateLayout,+    ) where+ import XMonad.Core import XMonad.Layout (Full(..)) import qualified XMonad.StackSet as W@@ -24,16 +58,15 @@ import Data.Monoid          (Endo(..),Any(..)) import Data.List            (nub, (\\), find) import Data.Bits            ((.|.), (.&.), complement, testBit)+import Data.Function        (on) import Data.Ratio import qualified Data.Map as M import qualified Data.Set as S -import Control.Applicative((<$>), (<*>)) import Control.Arrow (second)-import Control.Monad (void) import Control.Monad.Reader import Control.Monad.State-import qualified Control.Exception.Extensible as C+import qualified Control.Exception as C  import System.IO import System.Directory@@ -43,9 +76,10 @@ import Graphics.X11.Xlib.Extras  -- ------------------------------------------------------------------------ | -- Window manager operations--- manage. Add a new window to be managed in the current workspace.++-- |+-- Add a new window to be managed in the current workspace. -- Bring it into focus. -- -- Whether the window is already managed, or not, it is mapped, has its@@ -72,7 +106,7 @@     g <- appEndo <$> userCodeDef (Endo id) (runQuery mh w)     windows (g . f) --- | unmanage. A window no longer exists, remove it from the window+-- | A window no longer exists; remove it from the window -- list, on whatever workspace it is. -- unmanage :: Window -> X ()@@ -92,7 +126,7 @@     io $ if wmdelt `elem` protocols         then allocaXEvent $ \ev -> do                 setEventType ev clientMessage-                setClientMessageEvent ev w wmprot 32 wmdelt 0+                setClientMessageEvent ev w wmprot 32 wmdelt currentTime                 sendEvent d w False noEventMask ev         else killClient d w >> return () @@ -103,7 +137,7 @@ -- --------------------------------------------------------------------- -- Managing windows --- | windows. Modify the current window list with a pure function, and refresh+-- | Modify the current window list with a pure function, and refresh windows :: (WindowSet -> WindowSet) -> X () windows f = do     XState { windowset = old } <- get@@ -191,8 +225,10 @@     windows         $ \_ -> new   return a --- | A version of @windowBracket@ that discards the return value, and handles an--- @X@ action reporting its need for refresh via @Any@.+-- | Perform an @X@ action. If it returns @Any True@, unwind the+-- changes to the @WindowSet@ and replay them using @windows@. This is+-- a version of @windowBracket@ that discards the return value and+-- handles an @X@ action that reports its need for refresh via @Any@. windowBracket_ :: X Any -> X () windowBracket_ = void . windowBracket getAny @@ -202,14 +238,14 @@  = Rectangle (sx + scale sw rx) (sy + scale sh ry) (scale sw rw) (scale sh rh)  where scale s r = floor (toRational s * r) --- | setWMState.  set the WM_STATE property+-- | Set a window's WM_STATE property. setWMState :: Window -> Int -> X () setWMState w v = withDisplay $ \dpy -> do     a <- atom_WM_STATE     io $ changeProperty32 dpy w a a propModeReplace [fromIntegral v, fromIntegral none] --- | Set the border color using the window's color map, if possible,--- otherwise fallback to the color in @Pixel@.+-- | Set the border color using the window's color map, if possible;+-- otherwise fall back to the color in @Pixel@. setWindowBorderWithFallback :: Display -> Window -> String -> Pixel -> X () setWindowBorderWithFallback dpy w color basic = io $     C.handle fallback $ do@@ -221,7 +257,7 @@     fallback e = do hPrint stderr e >> hFlush stderr                     setWindowBorder dpy w basic --- | hide. Hide a window by unmapping it, and setting Iconified.+-- | Hide a window by unmapping it and setting Iconified. hide :: Window -> X () hide w = whenX (gets (S.member w . mapped)) $ withDisplay $ \d -> do     cMask <- asks $ clientMask . config@@ -234,15 +270,15 @@     modify (\s -> s { waitingUnmap = M.insertWith (+) w 1 (waitingUnmap s)                     , mapped       = S.delete w (mapped s) }) --- | reveal. Show a window by mapping it and setting Normal--- this is harmless if the window was already visible+-- | Show a window by mapping it and setting Normal.+-- This is harmless if the window was already visible. reveal :: Window -> X () reveal w = withDisplay $ \d -> do     setWMState w normalState     io $ mapWindow d w     whenX (isClient w) $ modify (\s -> s { mapped = S.insert w (mapped s) }) --- | Set some properties when we initially gain control of a window+-- | Set some properties when we initially gain control of a window. setInitialProperties :: Window -> X () setInitialProperties w = asks normalBorder >>= \nb -> withDisplay $ \d -> do     setWMState w iconicState@@ -253,7 +289,7 @@     -- required by the border setting in 'windows'     io $ setWindowBorder d w nb --- | refresh. Render the currently visible workspaces, as determined by+-- | Render the currently visible workspaces, as determined by -- the 'StackSet'. Also, set focus to the focused window. -- -- This is our 'view' operation (MVC), in that it pretty prints our model@@ -262,7 +298,7 @@ refresh :: X () refresh = windows id --- | clearEvents.  Remove all events of a given type from the event queue.+-- | Remove all events of a given type from the event queue. clearEvents :: EventMask -> X () clearEvents mask = withDisplay $ \d -> io $ do     sync d False@@ -270,8 +306,8 @@         more <- checkMaskEvent d mask p         when more again -- beautiful --- | tileWindow. Moves and resizes w such that it fits inside the given--- rectangle, including its border.+-- | Move and resize @w@ such that it fits inside the given rectangle,+-- including its border. tileWindow :: Window -> Rectangle -> X () tileWindow w r = withDisplay $ \d -> withWindowAttributes d w $ \wa -> do     -- give all windows at least 1x1 pixels@@ -298,13 +334,13 @@ nubScreens :: [Rectangle] -> [Rectangle] nubScreens xs = nub . filter (\x -> not $ any (x `containedIn`) xs) $ xs --- | Cleans the list of screens according to the rules documented for+-- | Clean the list of screens according to the rules documented for -- nubScreens. getCleanedScreenInfo :: MonadIO m => Display -> m [Rectangle] getCleanedScreenInfo = io .  fmap nubScreens . getScreenInfo --- | rescreen.  The screen configuration may have changed (due to--- xrandr), update the state and refresh the screen, and reset the gap.+-- | The screen configuration may have changed (due to -- xrandr),+-- update the state and refresh the screen, and reset the gap. rescreen :: X () rescreen = do     xinesc <- withDisplay getCleanedScreenInfo@@ -318,7 +354,7 @@  -- --------------------------------------------------------------------- --- | setButtonGrab. Tell whether or not to intercept clicks on a given window+-- | Tell whether or not to intercept clicks on a given window setButtonGrab :: Bool -> Window -> X () setButtonGrab grab w = do     pointerMode <- asks $ \c -> if clickJustFocuses (config c)@@ -405,23 +441,28 @@ -- | Send a message to all layouts, without refreshing. broadcastMessage :: Message a => a -> X () broadcastMessage a = withWindowSet $ \ws -> do-   let c = W.workspace . W.current $ ws-       v = map W.workspace . W.visible $ ws-       h = W.hidden ws-   mapM_ (sendMessageWithNoRefresh a) (c : v ++ h)+    -- this is O(n²), but we can't really fix this as there's code in+    -- xmonad-contrib that touches the windowset during handleMessage+    -- (returning Nothing for changes to not get overwritten), so we+    -- unfortunately need to do this one by one and persist layout states+    -- of each workspace separately)+    let c = W.workspace . W.current $ ws+        v = map W.workspace . W.visible $ ws+        h = W.hidden ws+    mapM_ (sendMessageWithNoRefresh a) (c : v ++ h)  -- | Send a message to a layout, without refreshing.-sendMessageWithNoRefresh :: Message a => a -> W.Workspace WorkspaceId (Layout Window) Window -> X ()+sendMessageWithNoRefresh :: Message a => a -> WindowSpace -> X () sendMessageWithNoRefresh a w =     handleMessage (W.layout w) (SomeMessage a) `catchX` return Nothing >>=     updateLayout  (W.tag w) --- | Update the layout field of a workspace+-- | Update the layout field of a workspace. updateLayout :: WorkspaceId -> Maybe (Layout Window) -> X () updateLayout i ml = whenJust ml $ \l ->     runOnWorkspaces $ \ww -> return $ if W.tag ww == i then ww { W.layout = l} else ww --- | Set the layout of the currently viewed workspace+-- | Set the layout of the currently viewed workspace. setLayout :: Layout Window -> X () setLayout l = do     ss@(W.StackSet { W.current = c@(W.Screen { W.workspace = ws })}) <- gets windowset@@ -431,7 +472,7 @@ ------------------------------------------------------------------------ -- Utilities --- | Return workspace visible on screen 'sc', or 'Nothing'.+-- | Return workspace visible on screen @sc@, or 'Nothing'. screenWorkspace :: ScreenId -> X (Maybe WorkspaceId) screenWorkspace sc = withWindowSet $ return . W.lookupWorkspace sc @@ -439,7 +480,14 @@ withFocused :: (Window -> X ()) -> X () withFocused f = withWindowSet $ \w -> whenJust (W.peek w) f --- | 'True' if window is under management by us+-- | Apply an 'X' operation to all unfocused windows on the current workspace, if there are any.+withUnfocused :: (Window -> X ()) -> X ()+withUnfocused f = withWindowSet $ \ws ->+    whenJust (W.peek ws) $ \w ->+        let unfocusedWindows = filter (/= w) $ W.index ws+        in mapM_ f unfocusedWindows++-- | Is the window is under management by xmonad? isClient :: Window -> X Bool isClient w = withWindowSet $ return . W.member w @@ -450,13 +498,13 @@     nlm <- gets numberlockMask     return [0, nlm, lockMask, nlm .|. lockMask ] --- | Strip numlock\/capslock from a mask+-- | Strip numlock\/capslock from a mask. cleanMask :: KeyMask -> X KeyMask cleanMask km = do     nlm <- gets numberlockMask     return (complement (nlm .|. lockMask) .&. km) --- | Get the 'Pixel' value for a named color+-- | Get the 'Pixel' value for a named color. initColor :: Display -> String -> IO (Maybe Pixel) initColor dpy c = C.handle (\(C.SomeException _) -> return Nothing) $     (Just . color_pixel . fst) <$> allocNamedColor dpy colormap c@@ -481,7 +529,7 @@         wsData   = W.mapLayout show . windowset         extState = catMaybes . map maybeShow . M.toList . extensibleState -    path  <- stateFileName+    path <- asks $ stateFileName . directories     stateData <- gets (\s -> StateFile (wsData s) (extState s))     catchIO (writeFile path $ show stateData) @@ -489,7 +537,7 @@ -- return that state.  The state file is removed after reading it. readStateFile :: (LayoutClass l Window, Read (l Window)) => XConfig l -> X (Maybe XState) readStateFile xmc = do-    path <- stateFileName+    path <- asks $ stateFileName . directories      -- I'm trying really hard here to make sure we read the entire     -- contents of the file before it is removed from the file system.@@ -522,23 +570,8 @@     readStrict :: Handle -> IO String     readStrict h = hGetContents h >>= \s -> length s `seq` return s --- | Migrate state from a previously running xmonad instance that used--- the older @--resume@ technique.-{-# DEPRECATED migrateState "will be removed some point in the future." #-}-migrateState :: (Functor m, MonadIO m) => String -> String -> m ()-migrateState ws xs = do-    io (putStrLn "WARNING: --resume is no longer supported.")-    whenJust stateData $ \s -> do-      path <- stateFileName-      catchIO (writeFile path $ show s)-  where-    stateData = StateFile <$> maybeRead ws <*> maybeRead xs-    maybeRead s = case reads s of-                    [(x, "")] -> Just x-                    _         -> Nothing---- | @restart name resume@. Attempt to restart xmonad by executing the program--- @name@.  If @resume@ is 'True', restart with the current window state.+-- | @restart name resume@ attempts to restart xmonad by executing the program+-- @name@. If @resume@ is 'True', restart with the current window state. -- When executing another window manager, @resume@ should be 'False'. restart :: String -> Bool -> X () restart prog resume = do@@ -548,10 +581,10 @@     catchIO (executeFile prog True [] Nothing)  --------------------------------------------------------------------------- | Floating layer support+-- Floating layer support  -- | Given a window, find the screen it is located on, and compute--- the geometry of that window wrt. that screen.+-- the geometry of that window WRT that screen. floatLocation :: Window -> X (ScreenId, W.RationalRect) floatLocation w =     catchX go $ do@@ -565,13 +598,25 @@           ws <- gets windowset           wa <- io $ getWindowAttributes d w           let bw = (fromIntegral . wa_border_width) wa-          sc <- fromMaybe (W.current ws) <$> pointScreen (fi $ wa_x wa) (fi $ wa_y wa)+          point_sc <- pointScreen (fi $ wa_x wa) (fi $ wa_y wa)+          managed <- isClient w -          let sr = screenRect . W.screenDetail $ sc-              rr = W.RationalRect ((fi (wa_x wa) - fi (rect_x sr)) % fi (rect_width sr))-                                  ((fi (wa_y wa) - fi (rect_y sr)) % fi (rect_height sr))-                                  (fi (wa_width  wa + bw*2) % fi (rect_width sr))-                                  (fi (wa_height wa + bw*2) % fi (rect_height sr))+          -- ignore pointScreen for new windows unless it's the current+          -- screen, otherwise the float's relative size is computed against+          -- a different screen and the float ends up with the wrong size+          let sr_eq = (==) `on` fmap (screenRect . W.screenDetail)+              sc = fromMaybe (W.current ws) $+                  if managed || point_sc `sr_eq` Just (W.current ws) then point_sc else Nothing+              sr = screenRect . W.screenDetail $ sc+              x = (fi (wa_x wa) - fi (rect_x sr)) % fi (rect_width sr)+              y = (fi (wa_y wa) - fi (rect_y sr)) % fi (rect_height sr)+              width  = fi (wa_width  wa + bw*2) % fi (rect_width sr)+              height = fi (wa_height wa + bw*2) % fi (rect_height sr)+              -- adjust x/y of unmanaged windows if we ignored or didn't get pointScreen,+              -- it might be out of bounds otherwise+              rr = if managed || point_sc `sr_eq` Just sc+                  then W.RationalRect x y width height+                  else W.RationalRect (0.5 - width/2) (0.5 - height/2) width height            return (W.screen sc, rr) @@ -623,10 +668,9 @@                     clearEvents pointerMotionMask                     return z --- | drag the window under the cursor with the mouse while it is dragged+-- | Drag the window under the cursor with the mouse while it is dragged. mouseMoveWindow :: Window -> X () mouseMoveWindow w = whenX (isClient w) $ withDisplay $ \d -> do-    io $ raiseWindow d w     wa <- io $ getWindowAttributes d w     (_, _, _, ox', oy', _, _, _) <- io $ queryPointer d w     let ox = fromIntegral ox'@@ -638,10 +682,9 @@               )               (float w) --- | resize the window under the cursor with the mouse while it is dragged+-- | Resize the window under the cursor with the mouse while it is dragged. mouseResizeWindow :: Window -> X () mouseResizeWindow w = whenX (isClient w) $ withDisplay $ \d -> do-    io $ raiseWindow d w     wa <- io $ getWindowAttributes d w     sh <- io $ getWMNormalHints d w     io $ warpPointer d none w 0 0 0 0 (fromIntegral (wa_width wa)) (fromIntegral (wa_height wa))@@ -654,8 +697,9 @@               (float w)  -- ------------------------------------------------------------------------ | Support for window size hints+-- Support for window size hints +-- | An alias for a (width, height) pair type D = (Dimension, Dimension)  -- | Given a window, build an adjuster function that will reduce the given@@ -683,7 +727,7 @@ applySizeHintsContents sh (w, h) =     applySizeHints' sh (fromIntegral $ max 1 w, fromIntegral $ max 1 h) --- | XXX comment me+-- | Use X11 size hints to scale a pair of dimensions. applySizeHints' :: SizeHints -> D -> D applySizeHints' sh =       maybe id applyMaxSizeHint                   (sh_max_size   sh)
src/XMonad/StackSet.hs view
@@ -1,4 +1,5 @@ {-# LANGUAGE PatternGuards #-}+{-# LANGUAGE DeriveFunctor #-}  ----------------------------------------------------------------------------- -- |@@ -52,6 +53,8 @@     ) where  import Prelude hiding (filter)+import Control.Applicative.Backwards (Backwards (Backwards, forwards))+import Data.Foldable (foldr, toList) import Data.Maybe   (listToMaybe,isJust,fromMaybe) import qualified Data.List as L (deleteBy,find,splitAt,filter,nub) import Data.List ( (\\) )@@ -85,7 +88,7 @@ --    continuation reified as a data structure. -- --    The Zipper lets us replace an item deep in a complex data---    structure, e.g., a tree or a term, without an  mutation.  The+--    structure, e.g., a tree or a term, without a mutation.  The --    resulting data structure will share as much of its components with --    the old structure as possible. --@@ -151,7 +154,7 @@     deriving (Show, Read, Eq)  -- | A structure for window geometries-data RationalRect = RationalRect Rational Rational Rational Rational+data RationalRect = RationalRect !Rational !Rational !Rational !Rational     deriving (Show, Read, Eq)  -- |@@ -175,8 +178,19 @@ data Stack a = Stack { focus  :: !a        -- focused thing in this set                      , up     :: [a]       -- clowns to the left                      , down   :: [a] }     -- jokers to the right-    deriving (Show, Read, Eq)+    deriving (Show, Read, Eq, Functor) +instance Foldable Stack where+    toList = integrate+    foldr f z = foldr f z . toList++instance Traversable Stack where+    traverse f s =+        flip Stack+            -- 'Backwards' applies the Applicative in reverse order.+            <$> forwards (traverse (Backwards . f) (up s))+            <*> f (focus s)+            <*> traverse f (down s)  -- | this function indicates to catch that an error is expected abort :: String -> a
tests/Properties.hs view
@@ -1,6 +1,6 @@ import Test.QuickCheck --- Our QC instances and properties.+-- Our QC instances and properties: import Instances import Properties.Delete import Properties.Failure@@ -196,6 +196,5 @@   ,("pointWithin",        property prop_point_within)   ,("pointWithin mirror", property prop_point_within_mirror) -  ]--+  ] <>+  prop_laws_Stack
tests/Properties/Failure.hs view
@@ -2,7 +2,7 @@  import XMonad.StackSet hiding (filter) -import qualified Control.Exception.Extensible as C+import qualified Control.Exception as C import System.IO.Unsafe import Data.List (isPrefixOf)
tests/Properties/Screen.hs view
@@ -52,15 +52,14 @@ -- applyAspectHint does nothing when the supplied (x,y) fits -- the desired range prop_aspect_fits =-    forAll ((,,,) <$> pos <*> pos <*> pos <*> pos) $ \ (x,y,a,b) -> +    forAll ((,,,) <$> pos <*> pos <*> pos <*> pos) $ \ (x,y,a,b) ->     let f v = applyAspectHint ((x, y+a), (x+b, y)) v     in  and [ noOverflows (*) x (y+a), noOverflows (*) (x+b) y ]             ==> f (x,y) == (x,y)    where pos = choose (0, 65535)-        mul a b = toInteger (a*b) /= toInteger a * toInteger b -prop_point_within r @ (Rectangle x y w h) =+prop_point_within r@(Rectangle x y w h) =     forAll ((,) <$>               choose (0, fromIntegral w - 1) <*>               choose (0, fromIntegral h - 1)) $
tests/Properties/Stack.hs view
@@ -1,3 +1,5 @@+{-# LANGUAGE CPP #-}+{-# LANGUAGE GeneralizedNewtypeDeriving #-} {-# LANGUAGE ScopedTypeVariables #-} module Properties.Stack where @@ -9,7 +11,15 @@  import Data.Maybe +#ifdef VERSION_quickcheck_classes+import Data.Proxy+import Test.QuickCheck.Classes (+    Laws (lawsTypeclass, lawsProperties), Proxy1 (Proxy1),+    foldableLaws, traversableLaws,+    )+#endif + -- The list returned by index should be the same length as the actual -- windows kept in the zipper prop_index_length (x :: T) =@@ -49,3 +59,25 @@         if null xs then differentiate xs == Nothing                    else (differentiate xs) == Just (Stack (head xs) [] (tail xs))     where _ = xs :: [Int]+++#ifdef VERSION_quickcheck_classes+-- Check type class laws of 'Data.Foldable.Foldable' and 'Data.Traversable.Traversable'.+newtype TestStack a = TestStack (Stack a)+    deriving (Eq, Read, Show, Foldable, Functor)++instance (Arbitrary a) => Arbitrary (TestStack a) where+   arbitrary = TestStack <$> (Stack <$> arbitrary <*> arbitrary <*> arbitrary)+   shrink = traverse shrink++instance Traversable TestStack where+   traverse f (TestStack sx) = fmap TestStack (traverse f sx)++prop_laws_Stack = format (foldableLaws p) <> format (traversableLaws p)+  where+    p = Proxy :: Proxy TestStack+    format laws = [ ("Stack: " <> lawsTypeclass laws <> ": " <> name, prop)+                  | (name, prop) <- lawsProperties laws ]+#else+prop_laws_Stack = []+#endif
− tests/loc.hs 
@@ -1,14 +0,0 @@-import Control.Monad-import System.Exit--main = do foo <- getContents-          let actual_loc = filter (not.null) $ filter isntcomment $-                           map (dropWhile (==' ')) $ lines foo-              loc = length actual_loc-          print loc-          -- uncomment the following to check for mistakes in isntcomment-          -- print actual_loc--isntcomment ('-':'-':_) = False-isntcomment ('{':'-':_) = False -- pragmas-isntcomment _ = True
− util/GenerateManpage.hs 
@@ -1,92 +0,0 @@-{-# LANGUAGE FlexibleContexts #-}---- Generates a in-memory version of "man/xmonad.1.markdown" that has the list--- of known key-bindings is inserted automatically from "Config.hs". That--- document is then rendered with Pandoc as "man/xmonad.1" and--- "man/xmonad.1.html".------ Unlike the rest of xmonad, this file is released under the GNU General--- Public License version 2 or later.--import Control.Monad.IO.Class (liftIO)-import Data.Char-import Data.List-import qualified Data.Text as T-import qualified Data.Text.IO as TIO-import Text.Pandoc-import Text.Regex.Posix--main :: IO ()-main = do-    keybindings <- guessBindings--    markdownSource <- readFile "./man/xmonad.1.markdown"--    runIOorExplode $ do-        parsed <- readMarkdown (def { readerStandalone = True, readerExtensions = pandocExtensions })-            . T.pack-            . unlines-            . replace "___KEYBINDINGS___" keybindings-            . lines-            $ markdownSource--        manTemplate <- getDefaultTemplate "man"-        manBody <- writeMan def { writerTemplate = Just manTemplate } parsed-        liftIO $ TIO.writeFile "./man/xmonad.1" $ manBody-        liftIO $ putStrLn "Documentation created: man/xmonad.1"--        htmltemplate <- getDefaultTemplate "html"-        htmlBody <- writeHtml5String def-                                     { writerTemplate = Just htmltemplate-                                     , writerTableOfContents = True }-                                     parsed-        liftIO $ TIO.writeFile "./man/xmonad.1.html" htmlBody-        liftIO $ putStrLn "Documentation created: man/xmonad.1.html"---- | The format for the docstrings in "Config.hs" takes the following form:------ @---   -- mod-x %! Frob the whatsit--- @------ "Frob the whatsit" will be used as the description for keybinding "mod-x".----- If the name of the key binding is omitted, the function tries to guess it--- from the rest of the line. For example:------ @---   [ ((modMask .|. shiftMask, xK_Return), spawn "xterm") -- %! Launch an xterm--- @------ Here, "mod-shift-return" will be used as the key binding name.--guessBindings :: IO String-guessBindings = do-  buf <- readFile "./src/XMonad/Config.hs"-  return (intercalate "\n\n" (map markdownDefn (allBindings buf)))--allBindings :: String -> [(String, String)]-allBindings xs = map (binding . map trim) (xs =~ "(.*)--(.*)%!(.*)")--binding :: [String] -> (String, String)-binding [ _, bindingLine, "", desc ] = (guessKeys bindingLine, desc)-binding [ _, _, keyCombo, desc ] = (keyCombo, desc)-binding x = error ("binding: called with unexpected argument " ++ show x)--guessKeys :: String -> String-guessKeys line =-  case keys of-    [key] -> concat $ intersperse "-" (modifiers ++ [map toLower key])-    _     -> error ("guessKeys: unexpected number of keys " ++ show keys)-  where-    modifiers = map (!!1) (line =~ "(mod|shift|control)Mask")-    (_, _, _, keys) = line =~ "xK_([_[:alnum:]]+)" :: (String, String, String, [String])---- FIXME: What escaping should we be doing on these strings?-markdownDefn :: (String, String) -> String-markdownDefn (key, desc) = key ++ "\n:     " ++ desc--replace :: Eq a => a -> a -> [a] -> [a]-replace x y = map (\a -> if a == x then y else a)--trim :: String -> String-trim = reverse . dropWhile isSpace . reverse . dropWhile isSpace
xmonad.cabal view
@@ -1,5 +1,5 @@ name:               xmonad-version:            0.15+version:            0.17.0 synopsis:           A tiling window manager description:        xmonad is a tiling window manager for X. Windows are arranged                     automatically to tile the screen without gaps or overlap, maximising@@ -27,39 +27,34 @@                     Ondřej Súkup, Paul Hebble, Shachaf Ben-Kiki, Siim Põder, Tim McIver,                     Trevor Elliott, Wouter Swierstra, Conrad Irwin, Tim Thelion maintainer:         xmonad@haskell.org-tested-with:        GHC == 8.0.2, GHC == 8.2.2, GHC == 8.4.3, GHC == 8.6.1+tested-with:        GHC == 8.4.4 || == 8.6.5 || == 8.8.4 || == 8.10.4 || == 9.0.1 category:           System homepage:           http://xmonad.org bug-reports:        https://github.com/xmonad/xmonad/issues build-type:         Simple extra-source-files: README.md                     CHANGES.md-                    CONFIG-                    STYLE-                    tests/*.hs-                    tests/Properties/*.hs-                    tests/Properties/Layout/*.hs+                    CONTRIBUTING.md+                    INSTALL.md+                    MAINTAINERS.md+                    TUTORIAL.md                     man/xmonad.1.markdown                     man/xmonad.1                     man/xmonad.1.html                     man/xmonad.hs-                    util/GenerateManpage.hs                     util/hpcReport.sh-cabal-version:      >= 1.8+cabal-version:      1.12  source-repository head   type:     git   location: https://github.com/xmonad/xmonad -flag testing+flag pedantic+  description: Be pedantic (-Werror and the like)   default:     False   manual:      True-  description: Testing mode, only build minimal components -flag generatemanpage-  default:     False-  manual:      True-  description: Build the tool for generating the man page+flag quickcheck-classes  library   exposed-modules: XMonad@@ -72,36 +67,40 @@                    XMonad.StackSet   other-modules:   Paths_xmonad   hs-source-dirs:  src-  build-depends:   base                  >= 4.9 && < 5-                 , X11                   >= 1.8 && < 1.10+  build-depends:   base                  >= 4.11 && < 5+                 , X11                   >= 1.10 && < 1.11                  , containers-                 , data-default+                 , data-default-class                  , directory-                 , extensible-exceptions                  , filepath                  , mtl                  , process                  , setlocale+                 , time+                 , transformers          >= 0.3                  , unix-                 , utf8-string           >= 0.3 && < 1.1-  ghc-options:     -funbox-strict-fields -Wall -fno-warn-unused-do-bind+  ghc-options:     -funbox-strict-fields -Wall -Wno-unused-do-bind+  default-language: Haskell2010 -  if flag(testing)-    buildable: False+  -- Keep this in sync with the oldest version in 'tested-with'+  if impl(ghc > 8.4.4)+    ghc-options:   -Wno-unused-imports +  if flag(pedantic)+    ghc-options:   -Werror+ executable xmonad   main-is:       Main.hs-  build-depends: base, X11, mtl, unix, xmonad-  ghc-options:   -Wall -fno-warn-unused-do-bind+  build-depends: base, xmonad+  ghc-options:   -Wall -Wno-unused-do-bind+  default-language: Haskell2010 -executable generatemanpage-  main-is:        GenerateManpage.hs-  hs-source-dirs: util+  -- Keep this in sync with the oldest version in 'tested-with'+  if impl(ghc > 8.4.4)+    ghc-options:   -Wno-unused-imports -  if flag(generatemanpage)-    build-depends: base, pandoc >= 2, regex-posix, text-  else-    buildable: False+  if flag(pedantic)+    ghc-options:   -Werror  test-suite properties   type:           exitcode-stdio-1.0@@ -124,4 +123,17 @@                   Properties.Workspace                   Utils   hs-source-dirs: tests-  build-depends:  base, QuickCheck >= 2, X11, containers, extensible-exceptions, xmonad+  build-depends:  base+                , QuickCheck >= 2+                , X11+                , containers+                , xmonad+  default-language: Haskell2010++  if flag(quickcheck-classes) && impl(ghc > 8.5)+    -- no quickcheck-classes in LTS-12+    -- GHC 8.4 and lower needs too much boilerplate (Eq1, Show1, …)+    build-depends: quickcheck-classes >= 0.4.3++  if flag(pedantic)+    ghc-options:   -Werror