-
-
Notifications
You must be signed in to change notification settings - Fork 280
New module: X.L.ConditionalLayout #825
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
slotThe
wants to merge
8
commits into
xmonad:master
Choose a base branch
from
slotThe:feat/conditional-layout
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5905483
New module: X.L.ConditionalLayout
slotThe 6251057
fixup! New module: X.L.ConditionalLayout
slotThe 6fcb229
X.L.ConditionalLayout: Add utility functions
slotThe 0a675f5
X.L.ConditionalLayout: Write 'conditional' in terms of condChoose
slotThe b444e79
X.L.IfMax: Rewrite ifMax in terms of condChoose
slotThe 3640010
X.L.PerScreen: Rewrite in terms of X.L.ConditionalLayout
slotThe eafd72b
X.L.PerWorkspace: Rewrite in terms of X.L.ConditionalLayout
slotThe 0e244be
fixup! fixup! New module: X.L.ConditionalLayout
slotThe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| {-# LANGUAGE FlexibleContexts #-} | ||
| {-# LANGUAGE FlexibleInstances #-} | ||
| {-# LANGUAGE InstanceSigs #-} | ||
| {-# LANGUAGE LambdaCase #-} | ||
| {-# LANGUAGE MultiParamTypeClasses #-} | ||
| {-# LANGUAGE ScopedTypeVariables #-} | ||
|
|
||
| {- | | ||
| Module : XMonad.Layout.ConditionalLayout | ||
| Description : Conditionally apply layout and layout modifiers. | ||
| Copyright : (c) Ivan Malison <[email protected]>, | ||
| Tomas Janousek <[email protected]> | ||
| License : BSD | ||
| Maintainer : Tony Zorman <[email protected]> | ||
|
|
||
| This module provides conditional variants of 'ModifiedLayout' and 'Choose', | ||
| so that modifications (specific layouts) are only applied when a particular | ||
| condition is met. | ||
| -} | ||
| module XMonad.Layout.ConditionalLayout ( | ||
| -- * Usage | ||
| -- $usage | ||
|
|
||
| -- * Combinators | ||
| condChoose, | ||
| conditional, | ||
|
|
||
| -- * Building Conditions | ||
| ModifierCondition (shouldApply), | ||
| CondChoose, -- opaque | ||
|
|
||
| -- * Utility functions | ||
| getWorkspace, | ||
| getWorkspaceWindows, | ||
| getScreen, | ||
| ) where | ||
|
|
||
| import XMonad hiding (hide) | ||
| import XMonad.Layout.LayoutModifier | ||
| import XMonad.Prelude | ||
| import XMonad.StackSet (Workspace) | ||
| import qualified XMonad.StackSet as W | ||
|
|
||
| {- $usage | ||
|
|
||
| You can use this module by importing it in your @xmonad.hs@ | ||
|
|
||
| > import XMonad.Layout.ConditionalLayout | ||
|
|
||
| and writing an appropriate condition. Then, when 'conditional' is used, | ||
| a layout modifier will be applied whenever the condition is true. | ||
| Alternatively, 'condChoose' can decide which of two given layouts is to | ||
| be applied. | ||
|
|
||
| Defining a condition works by creating a new type, and making it an | ||
| instance of 'ModifierCondition'. For example, the following condition | ||
| checks whether there are a maximum of two windows on the current | ||
| workspace: | ||
|
|
||
| > import Data.List | ||
| > | ||
| > import XMonad | ||
| > import XMonad.Layout.ConditionalLayout | ||
| > import qualified XMonad.StackSet as W | ||
| > | ||
| > data IfMax2 = IfMax2 deriving (Read, Show) | ||
| > | ||
| > instance ModifierCondition IfMax2 where | ||
| > shouldApply _ wsId = do | ||
| > wsWins <- getWorkspaceWindows wsId | ||
| > pure $ Just 2 >= (length <$> ws) | ||
|
|
||
| the @IfMax2@ type can now be used with the provided combinators. To | ||
| apply tabs, one would write | ||
|
|
||
| > import XMonad.Layout.Tabbed | ||
| > | ||
| > main :: IO () | ||
| > main = xmonad $ def | ||
| > { terminal = "urxvt" | ||
| > , layoutHook = conditional IfMax2 (addTabsAlways shrinkText def) $ layoutHook def | ||
| > } | ||
|
|
||
| alternatively, to conditionally switch between two layouts: | ||
|
|
||
| > -- Full for workspaces with more than 2 windows, Tall otherwise. | ||
| > , layoutHook = condChoose IfMax2 (Tall 1 (3/100) (1/2)) Full $ layoutHook def | ||
| -} | ||
|
|
||
| -- | Conditionally apply a layout modifier. | ||
| -- | ||
| -- > conditional MyCond myModifier myLayout | ||
| conditional :: ModifierCondition c => c -> (l a -> l' a) -> l a -> CondChoose c l' l a | ||
| conditional c ml l = CondChoose True c (Choose CL (ml l) l) | ||
|
|
||
| -- | Conditionally choose between two layouts. | ||
| -- | ||
| -- > condChoose MyCond myLayoutTrue myLayoutFalse | ||
| condChoose :: c -> l a -> r a -> CondChoose c l r a | ||
| condChoose c = CondChoose True c .: Choose CL | ||
|
|
||
| -- The reason that this must exist as a type class and a simple function will | ||
| -- not suffice is that 'ModifierCondition's are used as parameters to | ||
| -- 'CondModifiedLayout', which must implement 'Read' and 'Show' in order to | ||
| -- also implement 'LayoutModifier'. By defining a new type for condition, we | ||
| -- sidestep the issue that functions can not implement these type classes. | ||
|
|
||
| -- | A 'ModifierCondition' is a condition run in 'X' that takes a 'WorkspaceId' | ||
| -- as a parameter. | ||
| class (Read c, Show c) => ModifierCondition c where | ||
| shouldApply :: c -> WorkspaceId -> X Bool | ||
|
|
||
| -- | 'ModifiedLayout' extended with a condition and its last evaluation result | ||
| -- (for methods that can't evaluate it). | ||
| data CondModifiedLayout c m l a = CondModifiedLayout !Bool !c !(ModifiedLayout m l a) | ||
| deriving (Read, Show) | ||
|
|
||
| -- | 'Choose' extended with a condition. | ||
| data CondChoose c l r a = CondChoose !Bool !c !(Choose l r a) | ||
| deriving (Read, Show) | ||
|
|
||
| instance (ModifierCondition c, LayoutClass l a, LayoutClass r a, Typeable c) | ||
| => LayoutClass (CondChoose c l r) a | ||
| where | ||
| runLayout :: (ModifierCondition c, LayoutClass l a, LayoutClass r a, Typeable c) | ||
| => Workspace WorkspaceId (CondChoose c l r a) a | ||
| -> Rectangle | ||
| -> X ([(a, Rectangle)], Maybe (CondChoose c l r a)) | ||
| runLayout (W.Workspace i cl@(CondChoose b c _) ms) rect = do | ||
| a <- shouldApply c i | ||
| cl' <- if a == b then pure Nothing else Just . switch <$> hide cl | ||
| fmap (<|> cl') <$> run (fromMaybe cl cl') | ||
| where | ||
| switch :: CondChoose c l r a -> CondChoose c l r a | ||
| switch (CondChoose b' c' ch') = CondChoose (not b') c' ch' | ||
|
|
||
| run :: CondChoose c l r a -> X ([(a, Rectangle)], Maybe (CondChoose c l r a)) | ||
| run (CondChoose preferLeft c' (Choose _ l r)) = | ||
| fmap (fmap (CondChoose preferLeft c')) | ||
| <$> runLayout (W.Workspace i (Choose (decideSide preferLeft) l r) ms) rect | ||
|
|
||
| handleMessage :: CondChoose c l r a -> SomeMessage -> X (Maybe (CondChoose c l r a)) | ||
| handleMessage (CondChoose a c ch@(Choose _ l r)) m | ||
| | Just ReleaseResources <- fromMessage m = | ||
| fmap (CondChoose a c) <$> handleMessage ch m | ||
| | Just NextLayout <- fromMessage m = | ||
| fmap (CondChoose a c) <$> handleMessage ch m | ||
| | otherwise = | ||
| fmap (CondChoose a c) <$> handleMessage (Choose (decideSide a) l r) m | ||
|
|
||
| description :: CondChoose c l r a -> String | ||
| description (CondChoose a _ (Choose _ l r)) | ||
| | a = description l | ||
| | otherwise = description r | ||
|
|
||
| ------------------------------------------------------------------------ | ||
| -- Util | ||
|
|
||
| decideSide :: Bool -> CLR | ||
| decideSide = \case | ||
| True -> CL | ||
| False -> CR | ||
|
|
||
| hide :: LayoutClass l a => l a -> X (l a) | ||
| hide x = fromMaybe x <$> handleMessage x (SomeMessage Hide) | ||
|
|
||
| getWorkspace :: WorkspaceId -> X (Maybe WindowSpace) | ||
| getWorkspace wsId = gets $ find ((wsId ==) . W.tag) . W.workspaces . windowset | ||
|
|
||
| getWorkspaceWindows :: WorkspaceId -> X (Maybe [Window]) | ||
| getWorkspaceWindows wsId = fmap (W.integrate' . W.stack) <$> getWorkspace wsId | ||
|
|
||
| getScreen :: WorkspaceId -> X (Maybe WindowScreen) | ||
| getScreen wsId = | ||
| find (\s -> wsId == W.tag (W.workspace s)) <$> gets (W.screens . windowset) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we really want this — this gives you two separate instances of
l, so whenever the condition flips, you "lose" (as in, no longer observe, rather than losing the actual data) the internal state ofl.If
lis something likel1 ||| l2 ||| l3, then the actual Chosen layout might switch every time the condition flips, and also the effect ofShrink/Expand/… only applies to the instance you're looking at.So I'd say the implementation simplification this provides isn't worth it.