Safe Haskell	Safe-Inferred
Language	Haskell2010

Ghcitui.Brick

Contents

Configuration settings for the BrickUI
Display BrickUI

Synopsis

data AppConfig = AppConfig {
- getInterpreterPrompt :: !Text
- getDebugConsoleOnStart :: !Bool
- getDebugLogPath :: !FilePath
- getVerbosity :: !Int
- getStartupSplashPath :: !(Maybe FilePath)
- getCmd :: !Text
- getStartupCommands :: ![Text]
}
defaultConfig :: AppConfig
loadStartupSplash :: IsString s => AppConfig -> IO (Maybe s)
userConfigDir :: IO FilePath
launchBrick :: AppConfig -> Text -> FilePath -> IO ()
data AppState n = AppState {
- interpState :: InterpState ()
- getCurrentWorkingDir :: !FilePath
- _appInterpState :: AppInterpState Text n
- interpLogs :: ![Text]
- appConfig :: !AppConfig
- activeWindow :: !ActiveWindow
- _selectedFile :: !(Maybe FilePath)
- _sourceWindow :: !(SourceWindow n Text)
- _infoPanelSelectedModule :: !Int
- sourceMap :: Map FilePath Text
- _currentWidgetSizes :: WidgetSizes
- displayDebugConsoleLogs :: !Bool
- debugConsoleLogs :: [Text]
- splashContents :: !(Maybe Text)
}

Configuration settings for the BrickUI

data AppConfig Source #

Constructors

AppConfig
Fields getInterpreterPrompt :: !Text Prompt to show for the live interpreter. getDebugConsoleOnStart :: !Bool Display the debug console on start up. getDebugLogPath :: !FilePath getVerbosity :: !Int Verbosity level. getStartupSplashPath :: !(Maybe FilePath) getCmd :: !Text Command to run to initialise the interpreter. getStartupCommands :: ![Text] Commands to run in ghci during start up.

Instances

Instances details

Show AppConfig Source #
Instance details Defined in Ghcitui.Brick.AppConfig Methods showsPrec :: Int -> AppConfig -> ShowS # show :: AppConfig -> String # showList :: [AppConfig] -> ShowS #

defaultConfig :: AppConfig Source #

loadStartupSplash :: IsString s => AppConfig -> IO (Maybe s) Source #

Return the startup screen splash as an IsString.

userConfigDir :: IO FilePath Source #

Display BrickUI

launchBrick :: AppConfig -> Text -> FilePath -> IO () Source #

Start the Brick UI

data AppState n Source #

Application state wrapper.

Contains information about the UI and configuration. It also holds a handle to the actual interpreter under the hood, but on the high level it should not hold anything internal to GHCi or GHCiD.

Prefer to create this with makeInitialState.

Constructors

AppState

Fields

interpState :: InterpState ()
The interpreter handle.
getCurrentWorkingDir :: !FilePath
The current working directory.
_appInterpState :: AppInterpState Text n
The live interpreter state (separate from the interpreter and the app state itself.
interpLogs :: ![Text]
appConfig :: !AppConfig
Program launch configuration.
activeWindow :: !ActiveWindow
Currently active window.
_selectedFile :: !(Maybe FilePath)
Filepath to the current code viewport contents, if set.
_sourceWindow :: !(SourceWindow n Text)
_infoPanelSelectedModule :: !Int
Currently selected module in the info sidebar, zero indexed.
sourceMap :: Map FilePath Text
Mapping between source filepaths and their contents.
_currentWidgetSizes :: WidgetSizes
Current windowboxpanel sizes (since it can change). Do not edit directly.
displayDebugConsoleLogs :: !Bool
Whether to display debug Console logs.
debugConsoleLogs :: [Text]
Place for debug output to go.
splashContents :: !(Maybe Text)
Splash to show on start up.

Instances

Instances details

Show n => Show (AppState n) Source #
Instance details Defined in Ghcitui.Brick.AppState Methods showsPrec :: Int -> AppState n -> ShowS # show :: AppState n -> String # showList :: [AppState n] -> ShowS #