Development.IDE.Session

The logic for setting up a ghcide session by tapping into hie-bios.

Documentation

data SessionLoadingOptions

Constructors

SessionLoadingOptions

Fields

• findCradle :: FilePath -> IO (Maybe FilePath)
• loadCradle :: Maybe FilePath -> FilePath -> IO (Cradle Void)

  Load the cradle with an optional 'hie.yaml' location. If a 'hie.yaml' is given, use it to load the cradle. Otherwise, use the provided project root directory to determine the cradle type.

• getCacheDirs :: String -> [String] -> IO CacheDirs

  Given the project name and a set of command line flags, return the path for storing generated GHC artifacts, or Nothing to respect the cradle setting

• getInitialGhcLibDir :: Recorder (WithPriority Log) -> FilePath -> IO (Maybe LibDir)

  Return the GHC lib dir to use for the unsafeGlobalDynFlags

• fakeUid :: UnitId

  unit id used to tag the internal component built by ghcide To reuse external interface files the unit ids must match, thus make sure to build them with `--this-unit-id` set to the same value as the ghcide fake uid

Instances

Default SessionLoadingOptions

Defined in Development.IDE.Session

Methods

def :: SessionLoadingOptions

data CacheDirs

Constructors

CacheDirs

Fields

• hiCacheDir, hieCacheDir, oCacheDir :: Maybe FilePath

loadSession :: Recorder (WithPriority Log) -> FilePath -> IO (Action IdeGhcSession)

Given a root directory, return a Shake Action which setups an IdeGhcSession given a file. Some of the many things this does:

• Find the cradle for the file
• Get the session options,
• Get the GHC lib directory
• Make sure the GHC compiletime and runtime versions match
• Restart the Shake session

This is the key function which implements multi-component support. All components mapping to the same hie.yaml file are mapped to the same HscEnv which is updated as new components are discovered.

loadSessionWithOptions :: Recorder (WithPriority Log) -> SessionLoadingOptions -> FilePath -> IO (Action IdeGhcSession)

setInitialDynFlags :: Recorder (WithPriority Log) -> FilePath -> SessionLoadingOptions -> IO (Maybe LibDir)

Sets unsafeGlobalDynFlags on using the hie-bios cradle and returns the GHC libdir

getHieDbLoc :: FilePath -> IO FilePath

runWithDb :: Recorder (WithPriority Log) -> FilePath -> (WithHieDb -> IndexQueue -> IO ()) -> IO ()

Wraps withHieDb to provide a database connection for reading, and a HieWriterChan for writing. Actions are picked off one by one from the HieWriterChan and executed in serial by a worker thread using a dedicated database connection. This is done in order to serialize writes to the database, or else SQLite becomes unhappy

retryOnSqliteBusy :: (MonadIO m, MonadCatch m, RandomGen g) => Recorder (WithPriority Log) -> g -> m a -> m a

retryOnException

Arguments

:: (MonadIO m, MonadCatch m, RandomGen g, Exception e)

=> (e -> Maybe e)

only retry on exception if this predicate returns Just

-> Recorder (WithPriority Log)

-> Int

maximum backoff delay in microseconds

-> Int

base backoff delay in microseconds

-> Int

maximum number of times to retry

-> g

random number generator

-> m a

action that may throw exception

-> m a

If the action throws exception that satisfies predicate then we sleep for a duration determined by the random exponential backoff formula, `uniformRandom(0, min (maxDelay, (baseDelay * 2) ^ retryAttempt))`, and try the action again for a maximum of maxRetryCount times. MonadIO, MonadCatch are used as constraints because there are a few HieDb functions that don't return IO values.

data Log

Constructors

LogSettingInitialDynFlags

LogGetInitialGhcLibDirDefaultCradleFail !CradleError !FilePath !(Maybe FilePath) !(Cradle Void)

LogGetInitialGhcLibDirDefaultCradleNone

LogHieDbRetry !Int !Int !Int !SomeException

LogHieDbRetriesExhausted !Int !Int !Int !SomeException

LogHieDbWriterThreadSQLiteError !SQLError

LogHieDbWriterThreadException !SomeException

LogInterfaceFilesCacheDir !FilePath

LogKnownFilesUpdated !(HashMap Target (HashSet NormalizedFilePath))

LogMakingNewHscEnv ![UnitId]

LogDLLLoadError !String

LogCradlePath !FilePath

LogCradleNotFound !FilePath

LogSessionLoadingResult !(Either [CradleError] (ComponentOptions, FilePath))

LogCradle !(Cradle Void)

LogNoneCradleFound FilePath

LogNewComponentCache !(([FileDiagnostic], Maybe HscEnvEq), DependencyInfo)

LogHieBios Log

Instances

Show Log

Defined in Development.IDE.Session

Methods

showsPrec :: Int -> Log -> ShowS

show :: Log -> String

showList :: [Log] -> ShowS

Pretty Log

Defined in Development.IDE.Session

Methods

pretty :: Log -> Doc ann

prettyList :: [Log] -> Doc ann