IdeSession.Query

Session queries

We have to be very careful in the types in this module. We should not be using internal types (with explicit sharing or types such as StrictMap), except as part of abstract XShared types.

Types

type Query a = IdeSession -> IO a

The type of queries in a given session state.

Queries are in IO because they depend on the current state of the session but they promise not to alter the session state (at least not in any visible way; they might update caches, etc.).

data ManagedFiles

The collection of source and data files submitted by the user.

Constructors

ManagedFiles

Fields

sourceFiles :: [FilePath]

dataFiles :: [FilePath]

Instances

Show ManagedFiles

data InvalidSessionStateQueries

Constructors

InvalidSessionStateQueries

Instances

Show InvalidSessionStateQueries

Exception InvalidSessionStateQueries

Typeable * InvalidSessionStateQueries

Queries that rely on the static part of the state only

getSessionConfig :: Query SessionConfig

Recover the fixed config the session was initialized with.

getSourcesDir :: Query FilePath

Obtain the source files directory for this session.

getDataDir :: Query FilePath

Obtain the data files directory for this session.

getDistDir :: Query FilePath

Obtain the directory prefix for results of Cabal invocations. Executables compiled in this session end up in a subdirectory build, haddocks in doc, concatenated licenses in file licenses, etc.

getSourceModule :: FilePath -> Query ByteString

Read the current value of one of the source modules.

getDataFile :: FilePath -> Query ByteString

Read the current value of one of the data files.

getAllDataFiles :: Query [FilePath]

Get the list of all data files currently available to the session: both the files copied via an update and files created by user code.

getCabalMacros :: Query ByteString

Queries that do not rely on computed state

getCodeGeneration :: Query Bool

Is code generation currently enabled?

getEnv :: Query [(String, Maybe String)]

Get all current environment overrides

getArgs :: Query [String]

Get all current snippet args

getGhcServer :: Query GhcServer

Get the RPC server used by the session.

getGhcVersion :: Query GhcVersion

Which GHC version is `ide-backend-server` using?

getManagedFiles :: Query ManagedFiles

Get the collection of files submitted by the user and not deleted yet. The module names are those supplied by the user as the first arguments of the updateSourceFile and updateSourceFileFromFile calls, as opposed to the compiler internal module ... end module names. Usually the two names are equal, but they needn't be.

getBuildExeStatus :: Query (Maybe ExitCode)

Get exit status of the last invocation of buildExe, if any.

getBuildDocStatus :: Query (Maybe ExitCode)

Get exit status of the last invocation of buildDoc, if any.

getBuildLicensesStatus :: Query (Maybe ExitCode)

Get exit status of the last invocation of buildLicenses, if any.

getBreakInfo :: Query (Maybe BreakInfo)

Get information about the last breakpoint that we hit

Returns Nothing if we are not currently stopped on a breakpoint.

Queries that rely on computed state

getSourceErrors :: Query [SourceError]

Get any compilation errors or warnings in the current state of the session, meaning errors that GHC reports for the current state of all the source modules.

Note that in the initial implementation this will only return warnings from the modules that changed in the last update, the intended semantics is that morally it be a pure function of the current state of the files, and so it would return all warnings (as if you did clean and rebuild each time).

getSourceErrors does internal normalization. This simplifies the life of the client and anyway there shouldn't be that many source errors that it really makes a big difference.

getLoadedModules :: Query [ModuleName]

Get the list of correctly compiled modules, as reported by the compiler

getFileMap :: Query (FilePath -> Maybe ModuleId)

Get the mapping from filenames to modules (as computed by GHC)

getSpanInfo :: Query (ModuleName -> SourceSpan -> [(SourceSpan, SpanInfo)])

Get information about an identifier at a specific location

getExpTypes :: Query (ModuleName -> SourceSpan -> [(SourceSpan, Text)])

Get information the type of a subexpressions and the subexpressions around it

getImports :: Query (ModuleName -> Maybe [Import])

Get import information

This information is available even for modules with parse/type errors

getAutocompletion :: Query (ModuleName -> String -> [IdInfo])

Autocompletion

Use idInfoQN to translate these IdInfos into qualified names, taking into account the module imports.

getPkgDeps :: Query (ModuleName -> Maybe [PackageId])

(Transitive) package dependencies

These are only available for modules that got compiled successfully.

getUseSites :: Query (ModuleName -> SourceSpan -> [SourceSpan])

Use sites

Use sites are only reported in modules that get compiled successfully.

getDotCabal :: Query (String -> Version -> ByteString)

Minimal .cabal file for the loaded modules seen as a library. The argument specifies the name of the library.

License is set to AllRightsReserved. All transitive package dependencies are included, with package versions set to the currently used versions. Only modules that get compiled successfully are included. Source directory is the currently used session source directory. Warning: all modules named Main (even in subdirectories or files with different names) are ignored so that they don't get in the way when we build an executable using the library and so that the behaviour is consistent with that of buildExe.

Debugging (internal use only)

dumpIdInfo :: IdeSession -> IO ()

Print the id info maps to stdout (for debugging purposes only)

dumpAutocompletion :: IdeSession -> IO ()

Print autocompletion to stdout (for debugging purposes only)

dumpFileMap :: IdeSession -> IO ()

Print file mapping to stdout (for debugging purposes only)