Rasa.Internal.Extensions

Documentation

data Ext

A wrapper around an extension of any type so it can be stored in an ExtMap

Constructors

Show a => Ext a

Instances

Show Ext

Methods

showsPrec :: Int -> Ext -> ShowS

show :: Ext -> String

showList :: [Ext] -> ShowS

type ExtMap = Map TypeRep Ext

A map of extension types to their current value.

class HasExts s where

Members of this class have access to editor extensions.

Minimal complete definition

exts

Methods

exts :: Lens' s (Map TypeRep Ext)

This lens focuses the Extensions States

Instances

HasExts Buffer

Methods

exts :: Lens' Buffer (Map TypeRep Ext)

HasExts Editor

Methods

exts :: Lens' Editor (Map TypeRep Ext)

class (Typeable m, Monad m) => HasExtMonad m where

Minimal complete definition

getExt, setExt

Methods

getExt :: (Typeable ext, Show ext, Default ext) => m ext

Retrieve some extension state

setExt :: (Typeable ext, Show ext, Default ext) => ext -> m ()

Set some extension state

overExt :: (Typeable ext, Show ext, Default ext) => (ext -> ext) -> m ()

Set some extension state

Instances

HasExtMonad BufAction

Methods

getExt :: (Typeable * ext, Show ext, Default ext) => BufAction ext

setExt :: (Typeable * ext, Show ext, Default ext) => ext -> BufAction ()

overExt :: (Typeable * ext, Show ext, Default ext) => (ext -> ext) -> BufAction ()

HasExtMonad Action

Methods

getExt :: (Typeable * ext, Show ext, Default ext) => Action ext

setExt :: (Typeable * ext, Show ext, Default ext) => ext -> Action ()

overExt :: (Typeable * ext, Show ext, Default ext) => (ext -> ext) -> Action ()

ext :: forall a e. (Show a, Typeable a, Default a, HasExts e) => Lens' e a

This is a lens which will focus the extension state that matches the type inferred as the focal point. It's a little bit of magic, if you treat the focus as a member of your extension state it should just work out.

This lens falls back on the extension's Default instance (when getting) if nothing has yet been stored.