Copyright | (c) Spencer Janssen 2007 |
---|---|
License | BSD3-style (see LICENSE) |
Maintainer | spencerjanssen@gmail.com |
Stability | unstable |
Portability | not portable, uses cunning newtype deriving |
Safe Haskell | None |
Language | Haskell98 |
Synopsis
- data X a
- type WindowSet = StackSet WorkspaceId (Layout Window) Window ScreenId ScreenDetail
- type WindowSpace = Workspace WorkspaceId (Layout Window) Window
- type WorkspaceId = String
- newtype ScreenId = S Int
- data ScreenDetail = SD {
- screenRect :: !Rectangle
- data XState = XState {}
- data XConf = XConf {
- display :: Display
- config :: !(XConfig Layout)
- theRoot :: !Window
- normalBorder :: !Pixel
- focusedBorder :: !Pixel
- keyActions :: !(Map (KeyMask, KeySym) (X ()))
- buttonActions :: !(Map (KeyMask, Button) (Window -> X ()))
- mouseFocused :: !Bool
- mousePosition :: !(Maybe (Position, Position))
- currentEvent :: !(Maybe Event)
- data XConfig l = XConfig {
- normalBorderColor :: !String
- focusedBorderColor :: !String
- terminal :: !String
- layoutHook :: !(l Window)
- manageHook :: !ManageHook
- handleEventHook :: !(Event -> X All)
- workspaces :: ![String]
- modMask :: !KeyMask
- keys :: !(XConfig Layout -> Map (ButtonMask, KeySym) (X ()))
- mouseBindings :: !(XConfig Layout -> Map (ButtonMask, Button) (Window -> X ()))
- borderWidth :: !Dimension
- logHook :: !(X ())
- startupHook :: !(X ())
- focusFollowsMouse :: !Bool
- clickJustFocuses :: !Bool
- clientMask :: !EventMask
- rootMask :: !EventMask
- handleExtraArgs :: !([String] -> XConfig Layout -> IO (XConfig Layout))
- class Show (layout a) => LayoutClass layout a where
- data Layout a = (LayoutClass l a, Read (l a)) => Layout (l a)
- readsLayout :: Layout a -> String -> [(Layout a, String)]
- class Typeable (a :: k)
- class Typeable a => Message a
- data SomeMessage = Message a => SomeMessage a
- fromMessage :: Message m => SomeMessage -> Maybe m
- data LayoutMessages
- data StateExtension
- = ExtensionClass a => StateExtension a
- | (Read a, Show a, ExtensionClass a) => PersistentExtension a
- class Typeable a => ExtensionClass a where
- runX :: XConf -> XState -> X a -> IO (a, XState)
- catchX :: X a -> X a -> X a
- userCode :: X a -> X (Maybe a)
- userCodeDef :: a -> X a -> X a
- io :: MonadIO m => IO a -> m a
- catchIO :: MonadIO m => IO () -> m ()
- installSignalHandlers :: MonadIO m => m ()
- uninstallSignalHandlers :: MonadIO m => m ()
- withDisplay :: (Display -> X a) -> X a
- withWindowSet :: (WindowSet -> X a) -> X a
- isRoot :: Window -> X Bool
- runOnWorkspaces :: (WindowSpace -> X WindowSpace) -> X ()
- getAtom :: String -> X Atom
- spawn :: MonadIO m => String -> m ()
- spawnPID :: MonadIO m => String -> m ProcessID
- xfork :: MonadIO m => IO () -> m ProcessID
- recompile :: MonadIO m => Bool -> m Bool
- trace :: MonadIO m => String -> m ()
- whenJust :: Monad m => Maybe a -> (a -> m ()) -> m ()
- whenX :: X Bool -> X () -> X ()
- getXMonadDir :: MonadIO m => m String
- getXMonadCacheDir :: MonadIO m => m String
- getXMonadDataDir :: MonadIO m => m String
- stateFileName :: (Functor m, MonadIO m) => m FilePath
- atom_WM_STATE :: X Atom
- atom_WM_PROTOCOLS :: X Atom
- atom_WM_DELETE_WINDOW :: X Atom
- atom_WM_TAKE_FOCUS :: X Atom
- withWindowAttributes :: Display -> Window -> (WindowAttributes -> X ()) -> X ()
- type ManageHook = Query (Endo WindowSet)
- newtype Query a = Query (ReaderT Window X a)
- runQuery :: Query a -> Window -> X a
Documentation
The X monad, ReaderT
and StateT
transformers over IO
encapsulating the window manager configuration and state,
respectively.
Dynamic components may be retrieved with get
, static components
with ask
. With newtype deriving we get readers and state monads
instantiated on XConf
and XState
automatically.
Instances
Monad X Source # | |
Functor X Source # | |
MonadFail X Source # | |
Defined in XMonad.Core | |
Applicative X Source # | |
MonadIO X Source # | |
Defined in XMonad.Core | |
MonadState XState X Source # | |
MonadReader XConf X Source # | |
Semigroup a => Semigroup (X a) Source # | |
Monoid a => Monoid (X a) Source # | |
Default a => Default (X a) Source # | |
Defined in XMonad.Core |
type WindowSpace = Workspace WorkspaceId (Layout Window) Window Source #
type WorkspaceId = String Source #
Virtual workspace indices
Physical screen indices
Instances
Enum ScreenId Source # | |
Eq ScreenId Source # | |
Integral ScreenId Source # | |
Defined in XMonad.Core | |
Num ScreenId Source # | |
Ord ScreenId Source # | |
Defined in XMonad.Core | |
Read ScreenId Source # | |
Real ScreenId Source # | |
Defined in XMonad.Core toRational :: ScreenId -> Rational # | |
Show ScreenId Source # | |
data ScreenDetail Source #
The Rectangle
with screen dimensions
SD | |
|
Instances
Eq ScreenDetail Source # | |
Defined in XMonad.Core (==) :: ScreenDetail -> ScreenDetail -> Bool # (/=) :: ScreenDetail -> ScreenDetail -> Bool # | |
Read ScreenDetail Source # | |
Defined in XMonad.Core readsPrec :: Int -> ReadS ScreenDetail # readList :: ReadS [ScreenDetail] # | |
Show ScreenDetail Source # | |
Defined in XMonad.Core showsPrec :: Int -> ScreenDetail -> ShowS # show :: ScreenDetail -> String # showList :: [ScreenDetail] -> ShowS # |
XState, the (mutable) window manager state.
XState | |
|
XConf, the (read-only) window manager configuration.
XConf | |
|
XConfig | |
|
class Show (layout a) => LayoutClass layout a where Source #
Every layout must be an instance of LayoutClass
, which defines
the basic layout operations along with a sensible default for each.
Minimal complete definition:
runLayout
|| ((doLayout
||pureLayout
) &&emptyLayout
), andhandleMessage
||pureMessage
You should also strongly consider implementing description
,
although it is not required.
Note that any code which uses LayoutClass
methods should only
ever call runLayout
, handleMessage
, and description
! In
other words, the only calls to doLayout
, pureMessage
, and other
such methods should be from the default implementations of
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.
runLayout :: Workspace WorkspaceId (layout a) a -> Rectangle -> X ([(a, Rectangle)], Maybe (layout a)) Source #
By default, runLayout
calls doLayout
if there are any
windows to be laid out, and emptyLayout
otherwise. Most
instances of LayoutClass
probably do not need to implement
runLayout
; it is only useful for layouts which wish to make
use of more of the Workspace
information (for example,
XMonad.Layout.PerWorkspace).
doLayout :: layout a -> Rectangle -> Stack a -> X ([(a, Rectangle)], Maybe (layout a)) Source #
Given a Rectangle
in which to place the windows, and a Stack
of windows, return a list of windows and their corresponding
Rectangles. If an element is not given a Rectangle by
doLayout
, then it is not shown on screen. The order of
windows in this list should be the desired stacking order.
Also possibly return a modified layout (by returning Just
newLayout
), if this layout needs to be modified (e.g. if it
keeps track of some sort of state). Return Nothing
if the
layout does not need to be modified.
Layouts which do not need access to the X
monad (IO
, window
manager state, or configuration) and do not keep track of their
own state should implement pureLayout
instead of doLayout
.
pureLayout :: layout a -> Rectangle -> Stack a -> [(a, Rectangle)] Source #
This is a pure version of doLayout
, for cases where we
don't need access to the X
monad to determine how to lay out
the windows, and we don't need to modify the layout itself.
emptyLayout :: layout a -> Rectangle -> X ([(a, Rectangle)], Maybe (layout a)) Source #
emptyLayout
is called when there are no windows.
handleMessage :: layout a -> SomeMessage -> X (Maybe (layout a)) Source #
handleMessage
performs message handling. If
handleMessage
returns Nothing
, then the layout did not
respond to the message and the screen is not refreshed.
Otherwise, handleMessage
returns an updated layout and the
screen is refreshed.
Layouts which do not need access to the X
monad to decide how
to handle messages should implement pureMessage
instead of
handleMessage
(this restricts the risk of error, and makes
testing much easier).
pureMessage :: layout a -> SomeMessage -> Maybe (layout a) Source #
Respond to a message by (possibly) changing our layout, but taking no other action. If the layout changes, the screen will be refreshed.
description :: layout a -> String Source #
This should be a human-readable string that is used when
selecting layouts by name. The default implementation is
show
, which is in some cases a poor default.
Instances
An existential type that can hold any object that is in Read
and LayoutClass
.
(LayoutClass l a, Read (l a)) => Layout (l a) |
Instances
LayoutClass Layout Window Source # | |
Defined in XMonad.Core runLayout :: Workspace WorkspaceId (Layout Window) Window -> Rectangle -> X ([(Window, Rectangle)], Maybe (Layout Window)) Source # doLayout :: Layout Window -> Rectangle -> Stack Window -> X ([(Window, Rectangle)], Maybe (Layout Window)) Source # pureLayout :: Layout Window -> Rectangle -> Stack Window -> [(Window, Rectangle)] Source # emptyLayout :: Layout Window -> Rectangle -> X ([(Window, Rectangle)], Maybe (Layout Window)) Source # handleMessage :: Layout Window -> SomeMessage -> X (Maybe (Layout Window)) Source # pureMessage :: Layout Window -> SomeMessage -> Maybe (Layout Window) Source # | |
Show (Layout a) Source # | |
The class Typeable
allows a concrete representation of a type to
be calculated.
typeRep#
class Typeable a => Message a Source #
Based on ideas in /An Extensible Dynamically-Typed Hierarchy of
Exceptions/, Simon Marlow, 2006. Use extensible messages to the
handleMessage
handler.
User-extensible messages must be a member of this class.
Instances
Message Event Source # | |
Defined in XMonad.Core | |
Message LayoutMessages Source # | |
Defined in XMonad.Core | |
Message ChangeLayout Source # | |
Defined in XMonad.Layout | |
Message IncMasterN Source # | |
Defined in XMonad.Layout | |
Message Resize Source # | |
Defined in XMonad.Layout |
data SomeMessage Source #
A wrapped value of some type in the Message
class.
Message a => SomeMessage a |
fromMessage :: Message m => SomeMessage -> Maybe m Source #
And now, unwrap a given, unknown Message
type, performing a (dynamic)
type check on the result.
data LayoutMessages Source #
LayoutMessages
are core messages that all layouts (especially stateful
layouts) should consider handling.
Hide | sent when a layout becomes non-visible |
ReleaseResources | sent when xmonad is exiting or restarting |
Instances
Eq LayoutMessages Source # | |
Defined in XMonad.Core (==) :: LayoutMessages -> LayoutMessages -> Bool # (/=) :: LayoutMessages -> LayoutMessages -> Bool # | |
Message LayoutMessages Source # | |
Defined in XMonad.Core |
data StateExtension Source #
Existential type to store a state extension.
ExtensionClass a => StateExtension a | Non-persistent state extension |
(Read a, Show a, ExtensionClass a) => PersistentExtension a | Persistent extension |
class Typeable a => ExtensionClass a where Source #
Every module must make the data it wants to store an instance of this class.
Minimal complete definition: initialValue
initialValue :: a Source #
Defines an initial value for the state extension
extensionType :: a -> StateExtension Source #
Specifies whether the state extension should be
persistent. Setting this method to PersistentExtension
will make the stored data survive restarts, but
requires a to be an instance of Read and Show.
It defaults to StateExtension
, i.e. no persistence.
catchX :: X a -> X a -> X a Source #
Run in the X
monad, and in case of exception, and catch it and log it
to stderr, and run the error case.
userCode :: X a -> X (Maybe a) Source #
Execute the argument, catching all exceptions. Either this function or
catchX
should be used at all callsites of user customized code.
userCodeDef :: a -> X a -> X a Source #
Same as userCode but with a default argument to return instead of using Maybe, provided for convenience.
installSignalHandlers :: MonadIO m => m () Source #
Ignore SIGPIPE to avoid termination when a pipe is full, and SIGCHLD to avoid zombie processes, and clean up any extant zombie processes.
uninstallSignalHandlers :: MonadIO m => m () Source #
runOnWorkspaces :: (WindowSpace -> X WindowSpace) -> X () Source #
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.
spawn :: MonadIO m => String -> m () Source #
spawn. Launch an external application. Specifically, it double-forks and
runs the String
you pass as a command to /bin/sh.
Note this function assumes your locale uses utf8.
xfork :: MonadIO m => IO () -> m ProcessID Source #
A replacement for forkProcess
which resets default signal handlers.
recompile :: MonadIO m => Bool -> m Bool Source #
'recompile force', recompile the xmonad configuration file when any of the following apply:
- force is
True
- 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 -i flag is used to restrict recompilation to the xmonad.hs file only,
and any files in the aforementioned lib
directory.
Compilation errors (if any) are logged to the xmonad.errors
file
in the xmonad data directory. If GHC indicates failure with a
non-zero exit code, an xmessage displaying that file is spawned.
False
is returned if there are compilation errors.
whenJust :: Monad m => Maybe a -> (a -> m ()) -> m () Source #
Conditionally run an action, using a Maybe a
to decide.
getXMonadDir :: MonadIO m => m String Source #
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:
- The directory specified in the
XMONAD_CONFIG_DIR
environment variable. - The
~/.xmonad
directory. - The
XDG_CONFIG_HOME/xmonad
directory.
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 Source #
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.
Several directories are considered. In order of preference:
- The directory specified in the
XMONAD_CACHE_DIR
environment variable. - The
~/.xmonad
directory. - The
XDG_CACHE_HOME/xmonad
directory.
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 Source #
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.
Several directories are considered. In order of preference:
- The directory specified in the
XMONAD_DATA_DIR
environment variable. - The
~/.xmonad
directory. - The
XDG_DATA_HOME/xmonad
directory.
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.
stateFileName :: (Functor m, MonadIO m) => m FilePath Source #
Get the name of the file used to store the xmonad window state.
atom_WM_STATE :: X Atom Source #
Common non-predefined atoms
atom_WM_PROTOCOLS :: X Atom Source #
Common non-predefined atoms
atom_WM_DELETE_WINDOW :: X Atom Source #
Common non-predefined atoms
atom_WM_TAKE_FOCUS :: X Atom Source #
Common non-predefined atoms
withWindowAttributes :: Display -> Window -> (WindowAttributes -> X ()) -> X () Source #
Safely access window attributes.
Instances
Monad Query Source # | |
Functor Query Source # | |
Applicative Query Source # | |
MonadIO Query Source # | |
Defined in XMonad.Core | |
MonadReader Window Query Source # | |
Semigroup a => Semigroup (Query a) Source # | |
Monoid a => Monoid (Query a) Source # | |
Default a => Default (Query a) Source # | |
Defined in XMonad.Core |