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 :: FilePath -> IO (Cradle Void)
• 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 :: IO (Maybe LibDir)

  Return the GHC lib dir to use for the unsafeGlobalDynFlags

Instances

Default SessionLoadingOptions

Defined in Development.IDE.Session

Methods

def :: SessionLoadingOptions

data CacheDirs

Constructors

CacheDirs

Fields

• hiCacheDir, hieCacheDir, oCacheDir :: Maybe FilePath

loadSession :: 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 :: SessionLoadingOptions -> FilePath -> IO (Action IdeGhcSession)

setInitialDynFlags :: SessionLoadingOptions -> IO (Maybe LibDir)

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

getHieDbLoc :: FilePath -> IO FilePath

runWithDb :: FilePath -> (HieDb -> 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