Documentation

A Shake database plus persistent store. Can be thought of as storing mappings from (FilePath, k) to RuleResult k.

Must be called in the Initialized handler and only once

See Note [Root Directory]

A mapping of module name to known files

The result of an IDE operation. Warnings and errors are in the Diagnostic, and a value is in the Maybe. For operations that throw an error you expect a non-empty list of diagnostics, at least one of which is an error, and a Nothing. For operations that succeed you expect perhaps some warnings and a Just. For operations that depend on other failing operations you may get empty diagnostics and a Nothing, to indicate this phase throws no fresh errors but still failed.

A rule on a file should only return diagnostics for that given file. It should not propagate diagnostic errors through multiple phases.

Open a IdeState, should be shut using shakeShut.

Enqueue an action in the existing ShakeSession. Returns a computation to block until the action is run, propagating exceptions. Assumes a ShakeSession is available.

Appropriate for user actions other than edits.

Set up a new ShakeSession with a set of initial actions Will crash if there is an existing ShakeSession running.

Request a Rule result if available

Plural version of use

Lookup value in the database and return with the stale value immediately Will queue an action to refresh the value. Might block the first time the rule runs, but never blocks after that.

Same as useWithStaleFast but lets you wait for an up to date result

These actions are run asynchronously after the current action is finished running. For example, to trigger a key build after a rule has already finished as is the case with useWithStaleFast

A (maybe) stale result now, and an up to date one later

Plural version of use_

Throws an BadDependency exception which is caught by the rule system if none available.

WARNING: Not suitable for PluginHandlers. Use usesE instead.

Request a Rule result, it not available return the last computed result, if any, which may be stale

Return the last computed result which might be stale.

Request a Rule result, it not available return the last computed result which may be stale.

Throws an BadDependency exception which is caught by the rule system if none available.

WARNING: Not suitable for PluginHandlers. Use useWithStaleE instead.

Plural version of useWithStale_

Throws an BadDependency exception which is caught by the rule system if none available.

WARNING: Not suitable for PluginHandlers.

When we depend on something that reported an error, and we fail as a direct result, throw BadDependency which short-circuits the rest of the action

Define a new Rule without early cutoff

Define a new Rule with early cutoff

Returns the current client configuration. It is not wise to permanently cache the returned value of this function, as clients can at runtime change their configuration.

Get all the files in the project

Read a virtual file from the current snapshot

Either the mtime from disk or an LSP version LSP versions always compare as greater than on disk versions

Delete the value stored for a given ide build key and return the key that was deleted.

IdeActions are used when we want to return a result immediately, even if it is stale Useful for UI actions like hover, completion where we don't want to block.

Run via runIdeAction.

Actions to queue up on the index worker thread The inner `(HieDb -> IO ()) -> IO ()` wraps `HieDb -> IO ()` with (currently) retry functionality

We need to serialize writes to the database, so we send any function that needs to write to the database over the channel, where it will be picked up by a worker thread.

Register a function that will be called to get the "stale" result of a rule, possibly from disk This is called when we don't already have a result, or computing the rule failed. The result of this function will always be marked as $sel:stale:FastResult, and a proper rebuild of the rule will be queued if the rule hasn't run before.

Find and release old keys from the state Hashmap For the record, there are other state sources that this process does not release: * diagnostics store (normal, hidden and published) * position mapping store * indexing queue * exports map

Returns the client configuration, creating a build dependency. You should always use this function when accessing client configuration from build rules.