|
|
|
Description |
The core state of ide. This module is imported from every other module,
| and all data structures of the state are declared here, to avoid circular
| module dependencies.
|
|
Synopsis |
|
data IDE = IDE {frameState :: FrameState IDEM | recentPanes :: [PaneName] | specialKeys :: SpecialKeyTable IDERef | specialKey :: SpecialKeyCons IDERef | candy :: CandyTable | prefs :: Prefs | workspace :: Maybe Workspace | activePack :: Maybe IDEPackage | bufferProjCache :: Map FilePath (Maybe IDEPackage) | allLogRefs :: [LogRef] | currentEBC :: (Maybe LogRef, Maybe LogRef, Maybe LogRef) | currentHist :: Int | systemInfo :: Maybe GenScope | packageInfo :: Maybe (GenScope, GenScope) | workspaceInfo :: Maybe (GenScope, GenScope) | workspInfoCache :: PackageDescrCache | handlers :: Map String [(Unique, IDEEvent -> IDEM IDEEvent)] | currentState :: IDEState | guiHistory :: (Bool, [GUIHistory], Int) | findbar :: (Bool, Maybe (Toolbar, ListStore String)) | toolbar :: (Bool, Maybe Toolbar) | recentFiles :: [FilePath] | recentWorkspaces :: [FilePath] | runningTool :: Maybe ProcessHandle | debugState :: Maybe (IDEPackage, ToolState) | completion :: ((Int, Int), Maybe CompletionWindow) | yiControl :: Control | server :: Maybe Handle | } | | | | type IDERef = IORef IDE | | type IDEM = ReaderT IDERef IO | | type IDEAction = IDEM () | | | | liftIDE :: IDEM a -> WorkspaceM a | | type WorkspaceM = ReaderT Workspace IDEM | | type WorkspaceAction = WorkspaceM () | | runWorkspace :: WorkspaceM a -> Workspace -> IDEM a | | type PackageM = ReaderT IDEPackage IDEM | | type PackageAction = PackageM () | | runPackage :: PackageM a -> IDEPackage -> IDEM a | | type DebugM = ReaderT (IDEPackage, ToolState) IDEM | | type DebugAction = DebugM () | | runDebug :: DebugM a -> (IDEPackage, ToolState) -> IDEM a | | data IDEPackage = IDEPackage {} | | data Workspace = Workspace {} | | data ActionDescr alpha = AD {} | | type ActionString = String | | type KeyString = String | | data Prefs = Prefs {} | | | | data LogRef = LogRef {} | | logRefFilePath :: LogRef -> FilePath | | logRefFullFilePath :: LogRef -> FilePath | | isError :: LogRef -> Bool | | isBreakpoint :: LogRef -> Bool | | displaySrcSpan :: SrcSpan -> [Char] | | colorHexString :: Color -> [Char] | | | | newtype CandyTable = CT (CandyTableForth, CandyTableBack) | | type CandyTableForth = [(Bool, String, String)] | | type CandyTableBack = [(String, String, Int)] | | newtype KeymapI = KM (Map ActionString [(Maybe (Either KeyString (KeyString, KeyString)), Maybe String)]) | | type SpecialKeyTable alpha = Map (KeyVal, [Modifier]) (Map (KeyVal, [Modifier]) (ActionDescr alpha)) | | type SpecialKeyCons alpha = Maybe (Map (KeyVal, [Modifier]) (ActionDescr alpha), String) | | type PackageDescrCache = Map PackageIdentifier ModuleDescrCache | | type ModuleDescrCache = Map ModuleName (ClockTime, Maybe FilePath, ModuleDescr) | | data CompletionWindow = CompletionWindow {} | | | | type GUIHistory = (GUIHistory', GUIHistory') | | | | | | | | |
|
|
Documentation |
|
|
The IDE state
| Constructors | IDE | | frameState :: FrameState IDEM | state of the windows framework
| recentPanes :: [PaneName] | a list of panes which were selected last
| specialKeys :: SpecialKeyTable IDERef | a structure for emacs like keystrokes
| specialKey :: SpecialKeyCons IDERef | the first of a double keystroke
| candy :: CandyTable | table for source candy
| prefs :: Prefs | configuration preferences
| workspace :: Maybe Workspace | may be a workspace (set of packages)
| activePack :: Maybe IDEPackage | | bufferProjCache :: Map FilePath (Maybe IDEPackage) | | allLogRefs :: [LogRef] | | currentEBC :: (Maybe LogRef, Maybe LogRef, Maybe LogRef) | | currentHist :: Int | | systemInfo :: Maybe GenScope | the system scope
| packageInfo :: Maybe (GenScope, GenScope) | the second are the imports
| workspaceInfo :: Maybe (GenScope, GenScope) | the second are the imports
| workspInfoCache :: PackageDescrCache | | handlers :: Map String [(Unique, IDEEvent -> IDEM IDEEvent)] | event handling table
| currentState :: IDEState | | guiHistory :: (Bool, [GUIHistory], Int) | | findbar :: (Bool, Maybe (Toolbar, ListStore String)) | | toolbar :: (Bool, Maybe Toolbar) | | recentFiles :: [FilePath] | | recentWorkspaces :: [FilePath] | | runningTool :: Maybe ProcessHandle | | debugState :: Maybe (IDEPackage, ToolState) | | completion :: ((Int, Int), Maybe CompletionWindow) | | yiControl :: Control | | server :: Maybe Handle | |
|
|
|
|
|
Constructors | IsStartingUp | Leksah is in startup mode
| IsShuttingDown | Leksah is about to go down
| IsRunning | Leksah is running
| IsFlipping TreeView | The flipper is used to switch between sources
| IsCompleting Connections | The completion feature is used
|
|
|
|
|
A mutable reference to the IDE state
|
|
|
The IDE Monad
|
|
|
A shorthand for a reader monad for a mutable reference to the IDE state
which does not return a value
|
|
|
Constructors | | Instances | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Constructors | | Instances | |
|
|
|
Constructors | | Instances | |
|
|
|
ActionDescr is a data structure from which GtkActions are build, which are used for
menus, toolbars, and accelerator keystrokes
| Constructors | |
|
|
|
|
|
|
|
Preferences is a data structure to hold configuration data
| Constructors | | Instances | |
|
|
|
Other types
| Constructors | WarningRef | | ErrorRef | | BreakpointRef | | ContextRef | |
| Instances | |
|
|
|
Constructors | | Instances | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Constructors | Forward | | Backward | | Insert | | Delete | | Initial | |
| Instances | |
|
|
|
|
|
|
|
|
|
|
Constructors | | Instances | |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Constructors | LogTag | | ErrorTag | | FrameTag | | InputTag | | InfoTag | |
|
|
|
|
the first one is the new and the second the old state
|
|
|
Constructors | ModuleSelected | | | ScopeSelected | | | InfoElementSelected | | | PaneSelected | | |
| Instances | |
|
|
|
Constructors | SensitivityForwardHist | | SensitivityBackwardHist | | SensitivityProjectActive | | SensitivityWorkspaceOpen | | SensitivityError | | SensitivityEditor | | SensitivityInterpreting | |
| Instances | |
|
|
|
Constructors | | Instances | |
|
|
data StatusbarCompartment | Source |
|
|
|
Produced by Haddock version 2.6.1 |