Documentation

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

Fields

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

Fields

• runYiM :: ReaderT Yi IO a
   

Fields

• topKeymap :: Keymap

  Content of the top-level loop.

• insertKeymap :: Keymap

  For insertion-only modes

Fields

• fromBufferM :: ReaderT Window (State FBuffer) a
   

Fields

• expandTabs :: !Bool

  Insert spaces instead of tabs as possible

• tabSize :: !Int

  Size of a Tab

• shiftWidth :: !Int

  Indent by so many columns

Fields

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

Fields

• fromMark :: !a
   
• insMark :: !a
   
• selMark :: !a
   

Fields

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

  immutable unique key

• undos :: !URList

  undo/redo list

• bufferDynamic :: !DynamicState

  dynamic components

• preferCol :: !(Maybe Int)

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

• preferVisCol :: !(Maybe Int)

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

• stickyEol :: !Bool

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

• pendingUpdates :: !(Seq 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 :: !(Set WindowRef)
   
• updateTransactionInFlight :: !Bool
   
• updateTransactionAccum :: !(Seq Update)
   
• fontsizeVariation :: !Int

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

• updateStream :: !(Seq Update)

  Updates that we've seen in this buffer, basically "write-only". Work-around for broken WriterT.

Fields

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

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

• 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

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.

Fields

• fromEditorM :: ReaderT Config (State Editor) a
   

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

• configLineNumbers :: Bool

  Should we show line numbers by default?

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 :: !(Seq (Seq Update -> BufferM ()))
   
• layoutManagers :: ![AnyLayoutManager]

  List of layout managers for cycleLayoutManagersNext

• configVars :: !DynamicState

  Custom configuration, containing the YiConfigVariables. Configure with configVariableA.