Yi.Layout

This module defines the layout manager interface (see LayoutManager). To desgin a new layout manager, just make an instance of this class.

Concrete layouts

data Layout a

UI-agnostic layout schema. The basic constructs are (horizontal/vertical) stacks with fixed ratios between window sizes; and (horizontal/vertical) pairs with a slider in between (if available).

Constructors

SingleWindow a

Stack

Fields

• orientation :: !Orientation

  Orientation

• wins :: [(Layout a, RelativeSize)]

  The layout stack, with the given weights TODO: fix strictness for stack (it's still lazy)

Pair

Fields

• orientation :: !Orientation

  Orientation

• divPos :: !DividerPosition

  Initial position of the divider

• divRef :: !DividerRef

  Index of the divider (for updating the divider position)

• pairFst :: !(Layout a)

  Upper of of the pair

• pairSnd :: !(Layout a)

  Lower of the pair

Instances

Functor Layout

Methods

fmap :: (a -> b) -> Layout a -> Layout b

(<$) :: a -> Layout b -> Layout a

Eq a => Eq (Layout a)

Methods

(==) :: Layout a -> Layout a -> Bool

(/=) :: Layout a -> Layout a -> Bool

Show a => Show (Layout a)

Methods

showsPrec :: Int -> Layout a -> ShowS

show :: Layout a -> String

showList :: [Layout a] -> ShowS

Default a => Default (Layout a)

The def layout consists of a single window

Methods

def :: Layout a

Transposable (Layout a)

Methods

transpose :: Layout a -> Layout a

data Orientation

Orientations for Stack and Pair

Constructors

Horizontal

Vertical

Instances

Eq Orientation

Methods

(==) :: Orientation -> Orientation -> Bool

(/=) :: Orientation -> Orientation -> Bool

Show Orientation

Methods

showsPrec :: Int -> Orientation -> ShowS

show :: Orientation -> String

showList :: [Orientation] -> ShowS

Transposable Orientation

Methods

transpose :: Orientation -> Orientation

type DividerPosition = Double

Divider position, in the range (0,1)

type DividerRef = Int

Divider reference

type RelativeSize = Double

Relative sizes, for Stack

dividerPositionA :: DividerRef -> Lens' (Layout a) DividerPosition

Accessor for the DividerPosition with given reference

findDivider :: Eq a => Maybe a -> Layout a -> Maybe DividerRef

Find the divider nearest to a given window, or just the first one in case the argument is Nothing

Layout managers

The interface

class (Typeable m, Eq m) => LayoutManager m where

The type of layout managers. See the layout managers tall, hPairNStack and slidyTall for some example implementations.

Minimal complete definition

pureLayout, describeLayout

Methods

pureLayout :: m -> Layout a -> [a] -> Layout a

Given the old layout and the new list of windows, construct a layout for the new list of windows.

If the layout manager uses sliding dividers, then a user will expect that most of these dividers don't move when adding a new window. It is the layout manager's responsibility to ensure that this is the case, and this is the purpose of the Layout a argument.

The old layout may come from a different layout manager, in which case the layout manager is free to ignore it.

describeLayout :: m -> String

Describe the layout in a form suitable for the user.

nextVariant :: m -> m

Cycles to the next variant, if there is one (the default is id)

previousVariant :: m -> m

Cycles to the previous variant, if there is one (the default is id

Instances

LayoutManager AnyLayoutManager

Methods

pureLayout :: AnyLayoutManager -> Layout a -> [a] -> Layout a

describeLayout :: AnyLayoutManager -> String

nextVariant :: AnyLayoutManager -> AnyLayoutManager

previousVariant :: AnyLayoutManager -> AnyLayoutManager

LayoutManager lm => LayoutManager (Transposed lm)

Methods

pureLayout :: Transposed lm -> Layout a -> [a] -> Layout a

describeLayout :: Transposed lm -> String

nextVariant :: Transposed lm -> Transposed lm

previousVariant :: Transposed lm -> Transposed lm

data AnyLayoutManager

Existential wrapper for Layout

Constructors

LayoutManager m => AnyLayoutManager !m

Instances

Eq AnyLayoutManager

Methods

(==) :: AnyLayoutManager -> AnyLayoutManager -> Bool

(/=) :: AnyLayoutManager -> AnyLayoutManager -> Bool

Default AnyLayoutManager

The default layout is tallLayout

Methods

def :: AnyLayoutManager

LayoutManager AnyLayoutManager

Methods

pureLayout :: AnyLayoutManager -> Layout a -> [a] -> Layout a

describeLayout :: AnyLayoutManager -> String

nextVariant :: AnyLayoutManager -> AnyLayoutManager

previousVariant :: AnyLayoutManager -> AnyLayoutManager

layoutManagerSameType :: AnyLayoutManager -> AnyLayoutManager -> Bool

True if the internal layout managers have the same type (but are not necessarily equal).

Standard managers

wide :: AnyLayoutManager

Windows placed on top of one another, equally spaced

tall :: AnyLayoutManager

Windows placed side-by-side, equally spaced.

slidyTall :: AnyLayoutManager

Tall windows, arranged in a balanced binary tree with sliders in between them.

slidyWide :: AnyLayoutManager

Transposed version of slidyTall

hPairNStack :: Int -> AnyLayoutManager

n windows on the left; stack of windows on the right.

vPairNStack :: Int -> AnyLayoutManager

Transposed version of hPairNStack.

Utility functions

Layouts as rectangles

data Rectangle

A general bounding box

Constructors

Rectangle

Fields

• rectX, rectY, rectWidth, rectHeight :: !Double

Instances

Eq Rectangle

Methods

(==) :: Rectangle -> Rectangle -> Bool

(/=) :: Rectangle -> Rectangle -> Bool

Show Rectangle

Methods

showsPrec :: Int -> Rectangle -> ShowS

show :: Rectangle -> String

showList :: [Rectangle] -> ShowS

type HasNeighborWest = Bool

Used by the vty frontend to draw vertical separators

layoutToRectangles :: HasNeighborWest -> Rectangle -> Layout a -> [(a, Rectangle, HasNeighborWest)]

Transposing things

class Transposable r where

Things with orientations which can be flipped

Minimal complete definition

transpose

Methods

transpose :: r -> r

Instances

Transposable Orientation

Methods

transpose :: Orientation -> Orientation

Transposable (Layout a)

Methods

transpose :: Layout a -> Layout a

newtype Transposed lm

Same as lm, but with all Orientations transposed. See slidyWide for an example of its use.

Constructors

Transposed lm

Instances

Eq lm => Eq (Transposed lm)

Methods

(==) :: Transposed lm -> Transposed lm -> Bool

(/=) :: Transposed lm -> Transposed lm -> Bool

LayoutManager lm => LayoutManager (Transposed lm)

Methods

pureLayout :: Transposed lm -> Layout a -> [a] -> Layout a

describeLayout :: Transposed lm -> String

nextVariant :: Transposed lm -> Transposed lm

previousVariant :: Transposed lm -> Transposed lm

DividerRef combinators

It is tedious and error-prone for LayoutManagers to assign DividerRefs themselves. Better is to use these monadic smart constructors for Layout. For example, the layout

Pair Horizontal 0.5 0 (Pair Vertical 0.5 1 (SingleWindow w1) (SingleWindow w2)) (SingleWindow w3)

could be with the combinators below as

runLayoutM $ pair Horizontal 0.5 (pair Vertical 0.5 (singleWindow w1) (singleWindow w2)) (singleWindow w3)

These combinators do will also ensure strictness of the wins field of Stack. They also tidy up and do some error checking: length-1 stacks are removed (they are unnecessary); length-0 stacks raise errors.

data LayoutM a

A 'Layout a' wrapped in a state monad for tracking DividerRefs. This type is not itself a monad, but should rather be thought of as a DividerRef-free version of the Layout type.

pair :: Orientation -> DividerPosition -> LayoutM a -> LayoutM a -> LayoutM a

singleWindow :: a -> LayoutM a

stack :: Orientation -> [(LayoutM a, RelativeSize)] -> LayoutM a

evenStack :: Orientation -> [LayoutM a] -> LayoutM a

Special case of stack with all RelativeSizes equal.

runLayoutM :: LayoutM a -> Layout a