Yi.Types

This module is the host of the most prevalent types throughout Yi. It is unfortunately a necessary evil to avoid use of bootfiles.

You're encouraged to import from more idiomatic modules which will re-export these where appropriate.

Documentation

data Action

Constructors

Show a => YiA (YiM a)

Show a => EditorA (EditorM a)

Show a => BufferA (BufferM a)

Instances

Eq Action

Methods

(==) :: Action -> Action -> Bool

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

Show Action

Methods

showsPrec :: Int -> Action -> ShowS

show :: Action -> String

showList :: [Action] -> ShowS

YiAction Action ()

Methods

makeAction :: Action -> Action

emptyAction :: Action

class (Default a, Binary a, Typeable a) => YiVariable a

Instances

YiVariable RegionStyle

YiVariable Histories

YiVariable CabalBuffer

class (Default a, Typeable a) => YiConfigVariable a

Instances

YiConfigVariable YiOptions

YiConfigVariable Evaluator

type Interact ev a = I ev Action a

type KeymapM a = Interact Event a

type Keymap = KeymapM ()

type KeymapEndo = Keymap -> Keymap

type KeymapProcess = P Event Action

data IsRefreshNeeded

Constructors

MustRefresh

NoNeedToRefresh

Instances

Eq IsRefreshNeeded

Methods

(==) :: IsRefreshNeeded -> IsRefreshNeeded -> Bool

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

Show IsRefreshNeeded

Methods

showsPrec :: Int -> IsRefreshNeeded -> ShowS

show :: IsRefreshNeeded -> String

showList :: [IsRefreshNeeded] -> ShowS

data Yi

Constructors

Yi

Fields

• yiUi :: UI Editor
• yiInput :: [Event] -> IO ()

  input stream

• yiOutput :: IsRefreshNeeded -> [Action] -> IO ()

  output stream

• yiConfig :: Config
• yiVar :: MVar YiVar

  The only mutable state in the program

Instances

MonadReader Yi YiM

Methods

ask :: YiM Yi

local :: (Yi -> Yi) -> YiM a -> YiM a

reader :: (Yi -> a) -> YiM a

data YiVar

Constructors

YiVar

Fields

• yiEditor :: !Editor
• yiSubprocessIdSupply :: !SubprocessId
• yiSubprocesses :: !(Map SubprocessId SubprocessInfo)

newtype YiM a

The type of user-bindable functions TODO: doc how these are actually user-bindable are they?

Constructors

YiM

Fields

• runYiM :: ReaderT Yi IO a

Instances

Monad YiM

Methods

(>>=) :: YiM a -> (a -> YiM b) -> YiM b

(>>) :: YiM a -> YiM b -> YiM b

return :: a -> YiM a

fail :: String -> YiM a

Functor YiM

Methods

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

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

Applicative YiM

Methods

pure :: a -> YiM a

(<*>) :: YiM (a -> b) -> YiM a -> YiM b

(*>) :: YiM a -> YiM b -> YiM b

(<*) :: YiM a -> YiM b -> YiM a

MonadEditor YiM

Methods

askCfg :: YiM Config

withEditor :: EditorM a -> YiM a

withEditor_ :: EditorM a -> YiM ()

MonadReader Yi YiM

Methods

ask :: YiM Yi

local :: (Yi -> Yi) -> YiM a -> YiM a

reader :: (Yi -> a) -> YiM a

MonadState Editor YiM

Methods

get :: YiM Editor

put :: Editor -> YiM ()

state :: (Editor -> (a, Editor)) -> YiM a

MonadBase IO YiM

Methods

liftBase :: IO α -> YiM α

HookType (YiM a)

Methods

runHookImpl :: YiConfigVariable var => (var -> YiM a) -> YiM a

YiAction (YiM x) x

Methods

makeAction :: YiM x -> Action

unsafeWithEditor :: Config -> MVar YiVar -> EditorM a -> IO a

data KeymapSet

Constructors

KeymapSet

Fields

• topKeymap :: Keymap

  Content of the top-level loop.

• insertKeymap :: Keymap

  For insertion-only modes

extractTopKeymap :: KeymapSet -> Keymap

newtype BufferM a

The BufferM monad writes the updates performed.

Constructors

BufferM

Fields

• fromBufferM :: RWS Window [Update] FBuffer a

Instances

Monad BufferM

Methods

(>>=) :: BufferM a -> (a -> BufferM b) -> BufferM b

(>>) :: BufferM a -> BufferM b -> BufferM b

return :: a -> BufferM a

fail :: String -> BufferM a

Functor BufferM

Methods

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

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

Applicative BufferM

Methods

pure :: a -> BufferM a

(<*>) :: BufferM (a -> b) -> BufferM a -> BufferM b

(*>) :: BufferM a -> BufferM b -> BufferM b

(<*) :: BufferM a -> BufferM b -> BufferM a

MonadReader Window BufferM

Methods

ask :: BufferM Window

local :: (Window -> Window) -> BufferM a -> BufferM a

reader :: (Window -> a) -> BufferM a

MonadState FBuffer BufferM

Methods

get :: BufferM FBuffer

put :: FBuffer -> BufferM ()

state :: (FBuffer -> (a, FBuffer)) -> BufferM a

MonadWriter [Update] BufferM

Methods

writer :: (a, [Update]) -> BufferM a

tell :: [Update] -> BufferM ()

listen :: BufferM a -> BufferM (a, [Update])

pass :: BufferM (a, [Update] -> [Update]) -> BufferM a

YiAction (BufferM x) x

Methods

makeAction :: BufferM x -> Action

data IndentSettings

Currently duplicates some of Vim's indent settings. Allowing a buffer to specify settings that are more dynamic, perhaps via closures, could be useful.

Constructors

IndentSettings

Fields

• expandTabs :: Bool

  Insert spaces instead of tabs as possible

• tabSize :: Int

  Size of a Tab

• shiftWidth :: Int

  Indent by so many columns

Instances

Eq IndentSettings

Methods

(==) :: IndentSettings -> IndentSettings -> Bool

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

Show IndentSettings

Methods

showsPrec :: Int -> IndentSettings -> ShowS

show :: IndentSettings -> String

showList :: [IndentSettings] -> ShowS

data FBuffer

Constructors

FBuffer

Fields

• bmode :: !(Mode syntax)
• rawbuf :: !(BufferImpl syntax)
• attributes :: !Attributes

Instances

Eq FBuffer

Methods

(==) :: FBuffer -> FBuffer -> Bool

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

MonadState FBuffer BufferM

Methods

get :: BufferM FBuffer

put :: FBuffer -> BufferM ()

state :: (FBuffer -> (a, FBuffer)) -> BufferM a

type WinMarks = MarkSet Mark

data MarkSet a

Constructors

MarkSet

Fields

• fromMark, insMark, selMark :: !a

Instances

Functor MarkSet

Methods

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

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

Foldable MarkSet

Methods

fold :: Monoid m => MarkSet m -> m

foldMap :: Monoid m => (a -> m) -> MarkSet a -> m

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

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

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

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

foldr1 :: (a -> a -> a) -> MarkSet a -> a

foldl1 :: (a -> a -> a) -> MarkSet a -> a

toList :: MarkSet a -> [a]

null :: MarkSet a -> Bool

length :: MarkSet a -> Int

elem :: Eq a => a -> MarkSet a -> Bool

maximum :: Ord a => MarkSet a -> a

minimum :: Ord a => MarkSet a -> a

sum :: Num a => MarkSet a -> a

product :: Num a => MarkSet a -> a

Traversable MarkSet

Methods

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

sequenceA :: Applicative f => MarkSet (f a) -> f (MarkSet a)

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

sequence :: Monad m => MarkSet (m a) -> m (MarkSet a)

Binary a => Binary (MarkSet a)

Methods

put :: MarkSet a -> Put

get :: Get (MarkSet a)

putList :: [MarkSet a] -> Put

data Attributes

Constructors

Attributes

Fields

• ident :: !BufferId
• bkey__ :: !BufferRef

  immutable unique key

• undos :: !URList

  undo/redo list

• bufferDynamic :: !DynamicState

  dynamic components

• preferCol :: !(Maybe Int)

  prefered column to arrive at when we do a lineDown / lineUp

• preferVisCol :: !(Maybe Int)

  prefered column to arrive at visually (ie, respecting wrap)

• stickyEol :: !Bool

  stick to the end of line (used by vim bindings mostly)

• pendingUpdates :: ![UIUpdate]

  updates that haven't been synched in the UI yet

• selectionStyle :: !SelectionStyle
• keymapProcess :: !KeymapProcess
• winMarks :: !(Map WindowRef WinMarks)
• lastActiveWindow :: !Window
• lastSyncTime :: !UTCTime

  time of the last synchronization with disk

• readOnly :: !Bool

  read-only flag

• inserting :: !Bool

  the keymap is ready for insertion into this buffer

• directoryContent :: !Bool

  does buffer contain directory contents

• pointFollowsWindow :: !(WindowRef -> Bool)
• updateTransactionInFlight :: !Bool
• updateTransactionAccum :: ![Update]
• fontsizeVariation :: !Int
• encodingConverterName :: Maybe ConverterName

  How many points (frontend-specific) to change the font by in this buffer

Instances

Binary Attributes

Methods

put :: Attributes -> Put

get :: Get Attributes

putList :: [Attributes] -> Put

data BufferId

Constructors

MemBuffer Text

FileBuffer FilePath

Instances

Eq BufferId

Methods

(==) :: BufferId -> BufferId -> Bool

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

Ord BufferId

Methods

compare :: BufferId -> BufferId -> Ordering

(<) :: BufferId -> BufferId -> Bool

(<=) :: BufferId -> BufferId -> Bool

(>) :: BufferId -> BufferId -> Bool

(>=) :: BufferId -> BufferId -> Bool

max :: BufferId -> BufferId -> BufferId

min :: BufferId -> BufferId -> BufferId

Show BufferId

Methods

showsPrec :: Int -> BufferId -> ShowS

show :: BufferId -> String

showList :: [BufferId] -> ShowS

Binary BufferId

Methods

put :: BufferId -> Put

get :: Get BufferId

putList :: [BufferId] -> Put

data SelectionStyle

Constructors

SelectionStyle

Fields

• highlightSelection :: !Bool
• rectangleSelection :: !Bool

Instances

Binary SelectionStyle

Methods

put :: SelectionStyle -> Put

get :: Get SelectionStyle

putList :: [SelectionStyle] -> Put

data AnyMode

Constructors

AnyMode (Mode syntax)

data Mode syntax

A Mode customizes the Yi interface for editing a particular data format. It specifies when the mode should be used and controls file-specific syntax highlighting and command input, among other things.

Constructors

Mode

Fields

• modeName :: Text

  so this can be serialized, debugged.

• modeApplies :: FilePath -> YiString -> Bool

  What type of files does this mode apply to?

• modeHL :: ExtHL syntax

  Syntax highlighter

• modePrettify :: syntax -> BufferM ()

  Prettify current "paragraph"

• modeKeymap :: KeymapSet -> KeymapSet

  Buffer-local keymap modification

• modeIndent :: syntax -> IndentBehaviour -> BufferM ()

  emacs-style auto-indent line

• modeAdjustBlock :: syntax -> Int -> BufferM ()

  adjust the indentation after modification

• modeFollow :: syntax -> Action

  Follow a "link" in the file. (eg. go to location of error message)

• modeIndentSettings :: IndentSettings
• modeToggleCommentSelection :: Maybe (BufferM ())
• modeGetStrokes :: syntax -> Point -> Point -> Point -> [Stroke]

  Strokes that should be applied when displaying a syntax element should this be an Action instead?

• modeOnLoad :: BufferM ()

  An action that is to be executed when this mode is set

• modeModeLine :: [Text] -> BufferM Text

  buffer-local modeline formatting method

• modeGotoDeclaration :: BufferM ()

  go to the point where the variable is declared

data IndentBehaviour

Used to specify the behaviour of the automatic indent command.

Constructors

IncreaseCycle

Increase the indentation to the next higher indentation hint. If we are currently at the highest level of indentation then cycle back to the lowest.

DecreaseCycle

Decrease the indentation to the next smaller indentation hint. If we are currently at the smallest level then cycle back to the largest

IncreaseOnly

Increase the indentation to the next higher hint if no such hint exists do nothing.

DecreaseOnly

Decrease the indentation to the next smaller indentation hint, if no such hint exists do nothing.

Instances

Eq IndentBehaviour

Methods

(==) :: IndentBehaviour -> IndentBehaviour -> Bool

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

Show IndentBehaviour

Methods

showsPrec :: Int -> IndentBehaviour -> ShowS

show :: IndentBehaviour -> String

showList :: [IndentBehaviour] -> ShowS

type Status = ([Text], StyleName)

type Statuses = DelayList Status

data Editor

The Editor state

Constructors

Editor

Fields

• bufferStack :: !(NonEmpty BufferRef)

  Stack of all the buffers. Invariant: first buffer is the current one.

• buffers :: !(Map BufferRef FBuffer)
• refSupply :: !Int

  Supply for buffer, window and tab ids.

• tabs_ :: !(PointedList Tab)

  current tab contains the visible windows pointed list.

• dynamic :: !DynamicState

  dynamic components

• statusLines :: !Statuses
• maxStatusHeight :: !Int
• killring :: !Killring
• currentRegex :: !(Maybe SearchExp)

  currently highlighted regex (also most recent regex for use in vim bindings)

• searchDirection :: !Direction
• pendingEvents :: ![Event]

  Processed events that didn't yield any action yet.

• onCloseActions :: !(Map BufferRef (EditorM ()))

  Actions to be run when the buffer is closed; should be scrapped.

Instances

MonadState Editor EditorM

Methods

get :: EditorM Editor

put :: Editor -> EditorM ()

state :: (Editor -> (a, Editor)) -> EditorM a

MonadState Editor YiM

Methods

get :: YiM Editor

put :: Editor -> YiM ()

state :: (Editor -> (a, Editor)) -> YiM a

newtype EditorM a

Constructors

EditorM

Fields

• fromEditorM :: ReaderT Config (State Editor) a

Instances

Monad EditorM

Methods

(>>=) :: EditorM a -> (a -> EditorM b) -> EditorM b

(>>) :: EditorM a -> EditorM b -> EditorM b

return :: a -> EditorM a

fail :: String -> EditorM a

Functor EditorM

Methods

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

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

Applicative EditorM

Methods

pure :: a -> EditorM a

(<*>) :: EditorM (a -> b) -> EditorM a -> EditorM b

(*>) :: EditorM a -> EditorM b -> EditorM b

(<*) :: EditorM a -> EditorM b -> EditorM a

MonadEditor EditorM

Methods

askCfg :: EditorM Config

withEditor :: EditorM a -> EditorM a

withEditor_ :: EditorM a -> EditorM ()

MonadReader Config EditorM

Methods

ask :: EditorM Config

local :: (Config -> Config) -> EditorM a -> EditorM a

reader :: (Config -> a) -> EditorM a

MonadState Editor EditorM

Methods

get :: EditorM Editor

put :: Editor -> EditorM ()

state :: (Editor -> (a, Editor)) -> EditorM a

HookType (EditorM a)

Methods

runHookImpl :: YiConfigVariable var => (var -> EditorM a) -> EditorM a

YiAction (EditorM x) x

Methods

makeAction :: EditorM x -> Action

class (Monad m, MonadState Editor m) => MonadEditor m where

Minimal complete definition

askCfg

Methods

askCfg :: m Config

withEditor :: EditorM a -> m a

withEditor_ :: EditorM a -> m ()

Instances

MonadEditor EditorM

Methods

askCfg :: EditorM Config

withEditor :: EditorM a -> EditorM a

withEditor_ :: EditorM a -> EditorM ()

MonadEditor YiM

Methods

askCfg :: YiM Config

withEditor :: EditorM a -> YiM a

withEditor_ :: EditorM a -> YiM ()

runEditor :: Config -> EditorM a -> Editor -> (Editor, a)

data UIConfig

Constructors

UIConfig

Fields

• configFontName :: Maybe String

  Font name, for the UI that support it.

• configFontSize :: Maybe Int

  Font size, for the UI that support it.

• configScrollStyle :: Maybe ScrollStyle

  Style of scroll

• configScrollWheelAmount :: Int

  Amount to move the buffer when using the scroll wheel

• configLeftSideScrollBar :: Bool

  Should the scrollbar be shown on the left side?

• configAutoHideScrollBar :: Bool

  Hide scrollbar automatically if text fits on one page.

• configAutoHideTabBar :: Bool

  Hide the tabbar automatically if only one tab is present

• configLineWrap :: Bool

  Wrap lines at the edge of the window if too long to display.

• configCursorStyle :: CursorStyle
• configWindowFill :: Char

  The char with which to fill empty window space. Usually '~' for vi-like editors, ' ' for everything else.

• configTheme :: Theme

  UI colours

type UIBoot = Config -> ([Event] -> IO ()) -> ([Action] -> IO ()) -> Editor -> IO (UI Editor)

data CursorStyle

When should we use a "fat" cursor (i.e. 2 pixels wide, rather than 1)? Fat cursors have only been implemented for the Pango frontend.

Constructors

AlwaysFat

NeverFat

FatWhenFocused

FatWhenFocusedAndInserting

data Config

Configuration record. All Yi hooks can be set here.

Constructors

Config

Fields

• startFrontEnd :: UIBoot

  UI to use.

• configUI :: UIConfig

  UI-specific configuration.

• startActions :: [Action]

  Actions to run when the editor is started.

• initialActions :: [Action]

  Actions to run after startup (after startActions) or reload.

• defaultKm :: KeymapSet

  Default keymap to use.

• configInputPreprocess :: P Event Event
• modeTable :: [AnyMode]

  List modes by order of preference.

• debugMode :: Bool

  Produce a .yi.dbg file with a lot of debug information.

• configRegionStyle :: RegionStyle

  Set to Exclusive for an emacs-like behaviour.

• configKillringAccumulate :: Bool

  Set to True for an emacs-like behaviour, where all deleted text is accumulated in a killring.

• configCheckExternalChangesObsessively :: Bool
• bufferUpdateHandler :: [[Update] -> BufferM ()]
• layoutManagers :: [AnyLayoutManager]

  List of layout managers for cycleLayoutManagersNext

• configVars :: DynamicState

  Custom configuration, containing the YiConfigVariables. Configure with configVariableA.

Instances

MonadReader Config EditorM

Methods

ask :: EditorM Config

local :: (Config -> Config) -> EditorM a -> EditorM a

reader :: (Config -> a) -> EditorM a

MonadState Config ConfigM

Methods

get :: ConfigM Config

put :: Config -> ConfigM ()

state :: (Config -> (a, Config)) -> ConfigM a

data RegionStyle

Constructors

LineWise

Inclusive

Exclusive

Block

Instances

Eq RegionStyle

Methods

(==) :: RegionStyle -> RegionStyle -> Bool

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

Show RegionStyle

Methods

showsPrec :: Int -> RegionStyle -> ShowS

show :: RegionStyle -> String

showList :: [RegionStyle] -> ShowS

Binary RegionStyle

Methods

put :: RegionStyle -> Put

get :: Get RegionStyle

putList :: [RegionStyle] -> Put

Default RegionStyle

Methods

def :: RegionStyle

YiVariable RegionStyle