Rasa.Ext.Views

Documentation

viewports :: Action ()

Main export from the views extension, add this to your rasa config.

Working with Views

data View

A View contains info about a viewport; Whether it's selected and which buffer should be displayed.

Constructors

View

Fields

• _active :: Bool
• _viewable :: Viewable
• _scrollPos :: Int

Instances

HasWidgets View

This represents types which can provide a set of widgets

Methods

computeWidgets :: View -> Action Widgets

viewable :: Lens' View Viewable

splitRule :: Lens' Split SplitRule

active :: Lens' View Bool

scrollPos :: Lens' View Int

getViews :: Action (Maybe Window)

Gets the stored views

View Structure

Views are stored as a Tree, with Splits determining the layout of each branch.

data Split

A Split contains info about a the direction and allocation of a split branch.

Constructors

Split

Fields

• _dir :: Dir
• _splitRule :: SplitRule

Instances

Show Split

Methods

showsPrec :: Int -> Split -> ShowS

show :: Split -> String

showList :: [Split] -> ShowS

Default Split

Methods

def :: Split

data Dir

• Hor denotes a horizontal split.
• Vert denotes a vertical split.

Constructors

Hor

Vert

Instances

Show Dir

Methods

showsPrec :: Int -> Dir -> ShowS

show :: Dir -> String

showList :: [Dir] -> ShowS

Default Dir

Methods

def :: Dir

data SplitRule

A SplitRule determines size of each half of the split.

• Ratio Double sets the split to the given ratio; the double must be between 0 and 1; for example a value of 0.25 sets the first portion of the split to 1/4 of the available space; the other portion takes the remaining 3/4 of the space
• FromStart Int makes the first half of the split (top/left respectively) the set number of rows or columns respectively, the other half of the split gets the rest.
• FromEnd Int makes the first half of the split (top/left respectively) the set number of rows or columns respectively, the other half of the split gets the rest.

Constructors

Ratio Double

FromStart Int

FromEnd Int

Instances

Show SplitRule

Methods

showsPrec :: Int -> SplitRule -> ShowS

show :: SplitRule -> String

showList :: [SplitRule] -> ShowS

Default SplitRule

Methods

def :: SplitRule

type Window = BiTree Split View

A tree of windows branched with splits.

data BiTree b l

Constructors

Branch b (BiTree b l) (BiTree b l)

Leaf l

Instances

Bifunctor BiTree

Methods

bimap :: (a -> b) -> (c -> d) -> BiTree a c -> BiTree b d

first :: (a -> b) -> BiTree a c -> BiTree b c

second :: (b -> c) -> BiTree a b -> BiTree a c

Functor (BiTree b)

Methods

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

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

Foldable (BiTree b)

Methods

fold :: Monoid m => BiTree b m -> m

foldMap :: Monoid m => (a -> m) -> BiTree b a -> m

foldr :: (a -> b -> b) -> b -> BiTree b a -> b

foldr' :: (a -> b -> b) -> b -> BiTree b a -> b

foldl :: (b -> a -> b) -> b -> BiTree b a -> b

foldl' :: (b -> a -> b) -> b -> BiTree b a -> b

foldr1 :: (a -> a -> a) -> BiTree b a -> a

foldl1 :: (a -> a -> a) -> BiTree b a -> a

toList :: BiTree b a -> [a]

null :: BiTree b a -> Bool

length :: BiTree b a -> Int

elem :: Eq a => a -> BiTree b a -> Bool

maximum :: Ord a => BiTree b a -> a

minimum :: Ord a => BiTree b a -> a

sum :: Num a => BiTree b a -> a

product :: Num a => BiTree b a -> a

Traversable (BiTree b)

Methods

traverse :: Applicative f => (a -> f b) -> BiTree b a -> f (BiTree b b)

sequenceA :: Applicative f => BiTree b (f a) -> f (BiTree b a)

mapM :: Monad m => (a -> m b) -> BiTree b a -> m (BiTree b b)

sequence :: Monad m => BiTree b (m a) -> m (BiTree b a)

(Show l, Show b) => Show (BiTree b l)

Methods

showsPrec :: Int -> BiTree b l -> ShowS

show :: BiTree b l -> String

showList :: [BiTree b l] -> ShowS

Recursive (BiTree a b)

Methods

project :: BiTree a b -> Base (BiTree a b) (BiTree a b)

cata :: (Base (BiTree a b) a -> a) -> BiTree a b -> a

para :: (Base (BiTree a b) (BiTree a b, a) -> a) -> BiTree a b -> a

gpara :: (Corecursive (BiTree a b), Comonad w) => (forall c. Base (BiTree a b) (w c) -> w (Base (BiTree a b) c)) -> (Base (BiTree a b) (EnvT (BiTree a b) w a) -> a) -> BiTree a b -> a

prepro :: Corecursive (BiTree a b) => (forall c. Base (BiTree a b) c -> Base (BiTree a b) c) -> (Base (BiTree a b) a -> a) -> BiTree a b -> a

gprepro :: (Corecursive (BiTree a b), Comonad w) => (forall c. Base (BiTree a b) (w c) -> w (Base (BiTree a b) c)) -> (forall c. Base (BiTree a b) c -> Base (BiTree a b) c) -> (Base (BiTree a b) (w a) -> a) -> BiTree a b -> a

Corecursive (BiTree a b)

Methods

embed :: Base (BiTree a b) (BiTree a b) -> BiTree a b

ana :: (a -> Base (BiTree a b) a) -> a -> BiTree a b

apo :: (a -> Base (BiTree a b) (Either (BiTree a b) a)) -> a -> BiTree a b

postpro :: Recursive (BiTree a b) => (forall c. Base (BiTree a b) c -> Base (BiTree a b) c) -> (a -> Base (BiTree a b) a) -> a -> BiTree a b

gpostpro :: (Recursive (BiTree a b), Monad m) => (forall c. m (Base (BiTree a b) c) -> Base (BiTree a b) (m c)) -> (forall c. Base (BiTree a b) c -> Base (BiTree a b) c) -> (a -> Base (BiTree a b) (m a)) -> a -> BiTree a b

type Base (BiTree a b)

type Base (BiTree a b) = BiTreeF a b

data BiTreeF b l r

Constructors

BranchF b r r

LeafF l

Instances

Functor (BiTreeF b l)

Methods

fmap :: (a -> b) -> BiTreeF b l a -> BiTreeF b l b

(<$) :: a -> BiTreeF b l b -> BiTreeF b l a

(Show l, Show r, Show b) => Show (BiTreeF b l r)

Methods

showsPrec :: Int -> BiTreeF b l r -> ShowS

show :: BiTreeF b l r -> String

showList :: [BiTreeF b l r] -> ShowS

Provided Actions

rotate :: Action ()

Flip all Horizontal splits to Vertical ones and vice versa.

closeInactive :: Action ()

Close all inactive viewports

focusViewLeft :: Action ()

Move focus from any viewports one viewport to the left

focusViewRight :: Action ()

Move focus from any viewports one viewport to the right

focusViewAbove :: Action ()

Move focus from any viewports one viewport above

focusViewBelow :: Action ()

Move focus from any viewports one viewport below

hSplit :: Action ()

Split active views horizontally

vSplit :: Action ()

Split active views vertically

addSplit :: BufAdded -> Action ()

Add a new split at the top level in the given direction containing the given buffer.

nextBuf :: Action ()

Select the next buffer in any active viewports

prevBuf :: Action ()

Select the previous buffer in any active viewports

focusDo :: BufAction a -> Action [a]

Run a bufAction over all focused buffers and return any results.

focusDo_ :: BufAction a -> Action ()

focusDo with a void return

focusedBufs :: Action [BufRef]

Get bufRefs for all buffers that are selected in at least one viewport

isFocused :: BufAction Bool

Returns whether the current buffer is focused in at least one view.

scrollBy :: Int -> Action ()

Scrolls each focused viewport by the given amount.

Creating Widgets

data Widgets

Represents all widgets for a given view. Can be added onto using the Monoid instance.

Instances

Monoid Widgets

Methods

mempty :: Widgets

mappend :: Widgets -> Widgets -> Widgets

mconcat :: [Widgets] -> Widgets

Lenses for accessing parts of Widgets:

topBar :: Lens' Widgets [AnyRenderable]

bottomBar :: Lens' Widgets [AnyRenderable]

leftBar :: Lens' Widgets [AnyRenderable]

rightBar :: Lens' Widgets [AnyRenderable]

class HasWidgets r where

Minimal complete definition

computeWidgets

Methods

computeWidgets :: r -> Action Widgets

Instances

HasWidgets View

This represents types which can provide a set of widgets

Methods

computeWidgets :: View -> Action Widgets

Providing Widgets

The following functions register a BufAction which yields some renderable; On each render that renderable will be used as a topbottomleft/right bar respectively.

addTopBar :: Renderable r => BufAction r -> BufAction ListenerId

Use the computed renderer as a top-bar widget

addBottomBar :: Renderable r => BufAction r -> BufAction ListenerId

Use the computed renderer as a bottom-bar widget

addLeftBar :: Renderable r => BufAction r -> BufAction ListenerId

Use the computed renderer as a left-bar widget

addRightBar :: Renderable r => BufAction r -> BufAction ListenerId

Use the computed renderer as a right-bar widget

Provided Widgets

enableLineNumbers :: BufAction ()

disableLineNumbers :: BufAction ()

toggleLineNumbers :: BufAction ()

checkLineNumbers :: BufAction Bool

Returns whether line numbers are currently enabled.

addTopStatus :: Renderable r => BufAction r -> BufAction ListenerId

This registers a BufAction which results in a renderable and runs it at render time to add the resulting Renderable to the status bar.

addBottomStatus :: Renderable r => BufAction r -> BufAction ListenerId