Safe Haskell	None
Language	Haskell2010

Development.IDE.Core.Shake

Description

A Shake implementation of the compiler service.

There are two primary locations where data lives, and both of these contain much the same data:

The Shake database (inside shakeDb) stores a map of shake keys to shake values. In our case, these are all of type Q to A. During a single run all the values in the Shake database are consistent so are used in conjunction with each other, e.g. in uses.
The Values type stores a map of keys to values. These values are always stored as real Haskell values, whereas Shake serialises all A values between runs. To deserialise a Shake value, we just consult Values.

Synopsis

data IdeState
shakeExtras :: IdeState -> ShakeExtras
data ShakeExtras = ShakeExtras {
- eventer :: FromServerMessage -> IO ()
- debouncer :: Debouncer NormalizedUri
- logger :: Logger
- globals :: Var (HashMap TypeRep Dynamic)
- state :: Var Values
- diagnostics :: Var DiagnosticStore
- hiddenDiagnostics :: Var DiagnosticStore
- publishedDiagnostics :: Var (HashMap NormalizedUri [Diagnostic])
- positionMapping :: Var (HashMap NormalizedUri (Map TextDocumentVersion (PositionDelta, PositionMapping)))
- inProgress :: Var (HashMap NormalizedFilePath Int)
- progressUpdate :: ProgressEvent -> IO ()
- ideTesting :: IdeTesting
- session :: MVar ShakeSession
- withProgress :: WithProgressFunc
- withIndefiniteProgress :: WithIndefiniteProgressFunc
- restartShakeSession :: [DelayedAction ()] -> IO ()
- ideNc :: IORef NameCache
}
getShakeExtras :: Action ShakeExtras
getShakeExtrasRules :: Rules ShakeExtras
type IdeRule k v = (RuleResult k ~ v, ShakeValue k, Show v, Typeable v, NFData v)
type IdeResult v = ([FileDiagnostic], Maybe v)
data GetModificationTime where
- GetModificationTime_ {
  - missingFileDiagnostics :: Bool
  }
- pattern GetModificationTime :: GetModificationTime
shakeOpen :: IO LspId -> (FromServerMessage -> IO ()) -> WithProgressFunc -> WithIndefiniteProgressFunc -> Logger -> Debouncer NormalizedUri -> Maybe FilePath -> IdeReportProgress -> IdeTesting -> ShakeOptions -> Rules () -> IO IdeState
shakeShut :: IdeState -> IO ()
shakeRestart :: IdeState -> [DelayedAction a] -> IO ()
shakeEnqueue :: IdeState -> DelayedAction a -> IO (IO a)
shakeProfile :: IdeState -> FilePath -> IO ()
use :: IdeRule k v => k -> NormalizedFilePath -> Action (Maybe v)
useNoFile :: IdeRule k v => k -> Action (Maybe v)
uses :: IdeRule k v => k -> [NormalizedFilePath] -> Action [Maybe v]
useWithStaleFast :: IdeRule k v => k -> NormalizedFilePath -> IdeAction (Maybe (v, PositionMapping))
useWithStaleFast' :: IdeRule k v => k -> NormalizedFilePath -> IdeAction (FastResult v)
delayedAction :: DelayedAction a -> IdeAction (IO a)
data FastResult a = FastResult {
- stale :: Maybe (a, PositionMapping)
- uptoDate :: IO (Maybe a)
}
use_ :: IdeRule k v => k -> NormalizedFilePath -> Action v
useNoFile_ :: IdeRule k v => k -> Action v
uses_ :: IdeRule k v => k -> [NormalizedFilePath] -> Action [v]
useWithStale :: IdeRule k v => k -> NormalizedFilePath -> Action (Maybe (v, PositionMapping))
usesWithStale :: IdeRule k v => k -> [NormalizedFilePath] -> Action [Maybe (v, PositionMapping)]
useWithStale_ :: IdeRule k v => k -> NormalizedFilePath -> Action (v, PositionMapping)
usesWithStale_ :: IdeRule k v => k -> [NormalizedFilePath] -> Action [(v, PositionMapping)]
define :: IdeRule k v => (k -> NormalizedFilePath -> Action (IdeResult v)) -> Rules ()
defineEarlyCutoff :: IdeRule k v => (k -> NormalizedFilePath -> Action (Maybe ByteString, IdeResult v)) -> Rules ()
defineOnDisk :: (ShakeValue k, RuleResult k ~ ()) => (k -> NormalizedFilePath -> OnDiskRule) -> Rules ()
needOnDisk :: (ShakeValue k, RuleResult k ~ ()) => k -> NormalizedFilePath -> Action ()
needOnDisks :: (ShakeValue k, RuleResult k ~ ()) => k -> [NormalizedFilePath] -> Action ()
getDiagnostics :: IdeState -> IO [FileDiagnostic]
unsafeClearDiagnostics :: IdeState -> IO ()
getHiddenDiagnostics :: IdeState -> IO [FileDiagnostic]
class Typeable a => IsIdeGlobal a
addIdeGlobal :: IsIdeGlobal a => a -> Rules ()
addIdeGlobalExtras :: IsIdeGlobal a => ShakeExtras -> a -> IO ()
getIdeGlobalState :: forall a. IsIdeGlobal a => IdeState -> IO a
getIdeGlobalAction :: forall a. IsIdeGlobal a => Action a
getIdeGlobalExtras :: forall a. IsIdeGlobal a => ShakeExtras -> IO a
getIdeOptions :: Action IdeOptions
getIdeOptionsIO :: ShakeExtras -> IO IdeOptions
newtype GlobalIdeOptions = GlobalIdeOptions IdeOptions
garbageCollect :: (NormalizedFilePath -> Bool) -> Action ()
setPriority :: Priority -> Action ()
sendEvent :: FromServerMessage -> Action ()
ideLogger :: IdeState -> Logger
actionLogger :: Action Logger
data FileVersion
- = VFSVersion !Int
- | ModificationTime !Int64 !Int64
newtype Priority = Priority Double
updatePositionMapping :: IdeState -> VersionedTextDocumentIdentifier -> List TextDocumentContentChangeEvent -> IO ()
deleteValue :: (Typeable k, Hashable k, Eq k, Show k) => IdeState -> k -> NormalizedFilePath -> IO ()
data OnDiskRule = OnDiskRule {
- getHash :: Action ByteString
- runRule :: Action (IdeResult ByteString)
}
type WithProgressFunc = forall a. Text -> ProgressCancellable -> ((Progress -> IO ()) -> IO a) -> IO a
type WithIndefiniteProgressFunc = forall a. Text -> ProgressCancellable -> IO a -> IO a
data ProgressEvent
- = KickStarted
- | KickCompleted
data DelayedAction a
mkDelayedAction :: String -> Priority -> Action a -> DelayedAction a
newtype IdeAction a = IdeAction {
- runIdeActionT :: ReaderT ShakeExtras IO a
}
runIdeAction :: String -> ShakeExtras -> IdeAction a -> IO a
mkUpdater :: MaybeT IdeAction NameCacheUpdater
newtype Q k = Q (k, NormalizedFilePath)

Documentation

data IdeState Source #

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

shakeExtras :: IdeState -> ShakeExtras Source #

data ShakeExtras Source #

Constructors

ShakeExtras

Fields

eventer :: FromServerMessage -> IO ()
debouncer :: Debouncer NormalizedUri
logger :: Logger
globals :: Var (HashMap TypeRep Dynamic)
state :: Var Values
diagnostics :: Var DiagnosticStore
hiddenDiagnostics :: Var DiagnosticStore
publishedDiagnostics :: Var (HashMap NormalizedUri [Diagnostic])
This represents the set of diagnostics that we have published. Due to debouncing not every change might get published.
positionMapping :: Var (HashMap NormalizedUri (Map TextDocumentVersion (PositionDelta, PositionMapping)))
Map from a text document version to a PositionMapping that describes how to map positions in a version of that document to positions in the latest version First mapping is delta from previous version and second one is an accumlation of all previous mappings.
inProgress :: Var (HashMap NormalizedFilePath Int)
How many rules are running for each file
progressUpdate :: ProgressEvent -> IO ()
The generator for unique Lsp identifiers
ideTesting :: IdeTesting
Whether to enable additional lsp messages used by the test suite for checking invariants
session :: MVar ShakeSession
Used in the GhcSession rule to forcefully restart the session after adding a new component
withProgress :: WithProgressFunc
Report progress about some long running operation (on top of the progress shown by lspShakeProgress)
withIndefiniteProgress :: WithIndefiniteProgressFunc
Same as withProgress, but for processes that do not report the percentage complete
restartShakeSession :: [DelayedAction ()] -> IO ()
ideNc :: IORef NameCache

Instances

MonadReader ShakeExtras IdeAction Source #
Instance details Defined in Development.IDE.Core.Shake Methods ask :: IdeAction ShakeExtras # local :: (ShakeExtras -> ShakeExtras) -> IdeAction a -> IdeAction a # reader :: (ShakeExtras -> a) -> IdeAction a #

getShakeExtras :: Action ShakeExtras Source #

getShakeExtrasRules :: Rules ShakeExtras Source #

type IdeRule k v = (RuleResult k ~ v, ShakeValue k, Show v, Typeable v, NFData v) Source #

type IdeResult v = ([FileDiagnostic], Maybe v) Source #

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.

data GetModificationTime Source #

Constructors

GetModificationTime_
Fields missingFileDiagnostics :: Bool If false, missing file diagnostics are not reported

Bundled Patterns

pattern GetModificationTime :: GetModificationTime

Instances

Eq GetModificationTime Source #
Instance details Defined in Development.IDE.Core.Shake Methods (==) :: GetModificationTime -> GetModificationTime -> Bool # (/=) :: GetModificationTime -> GetModificationTime -> Bool #
Show GetModificationTime Source #
Instance details Defined in Development.IDE.Core.Shake Methods showsPrec :: Int -> GetModificationTime -> ShowS # show :: GetModificationTime -> String # showList :: [GetModificationTime] -> ShowS #
Generic GetModificationTime Source #
Instance details Defined in Development.IDE.Core.Shake Associated Types type Rep GetModificationTime :: Type -> Type # Methods from :: GetModificationTime -> Rep GetModificationTime x # to :: Rep GetModificationTime x -> GetModificationTime #
Hashable GetModificationTime Source #
Instance details Defined in Development.IDE.Core.Shake Methods hashWithSalt :: Int -> GetModificationTime -> Int # hash :: GetModificationTime -> Int #
Binary GetModificationTime Source #
Instance details Defined in Development.IDE.Core.Shake Methods put :: GetModificationTime -> Put # get :: Get GetModificationTime # putList :: [GetModificationTime] -> Put #
NFData GetModificationTime Source #
Instance details Defined in Development.IDE.Core.Shake Methods rnf :: GetModificationTime -> () #
type Rep GetModificationTime Source #
Instance details Defined in Development.IDE.Core.Shake type Rep GetModificationTime = D1 (MetaData "GetModificationTime" "Development.IDE.Core.Shake" "ghcide-0.3.0-Dfp4umcHt6s1wVYFQXPyfq" False) (C1 (MetaCons "GetModificationTime_" PrefixI True) (S1 (MetaSel (Just "missingFileDiagnostics") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)))
type RuleResult GetModificationTime Source #	Get the modification time of a file.
Instance details Defined in Development.IDE.Core.Shake type RuleResult GetModificationTime = FileVersion

shakeOpen Source #

Arguments

:: IO LspId
-> (FromServerMessage -> IO ())	diagnostic handler
-> WithProgressFunc
-> WithIndefiniteProgressFunc
-> Logger
-> Debouncer NormalizedUri
-> Maybe FilePath
-> IdeReportProgress
-> IdeTesting
-> ShakeOptions
-> Rules ()
-> IO IdeState

Open a IdeState, should be shut using shakeShut.

shakeShut :: IdeState -> IO () Source #

shakeRestart :: IdeState -> [DelayedAction a] -> IO () Source #

Restart the current ShakeSession with the given system actions. Any computation running in the current session will be aborted, but user actions (added via shakeEnqueue) will be requeued. Progress is reported only on the system actions.

shakeEnqueue :: IdeState -> DelayedAction a -> IO (IO a) Source #

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.

shakeProfile :: IdeState -> FilePath -> IO () Source #

use :: IdeRule k v => k -> NormalizedFilePath -> Action (Maybe v) Source #

useNoFile :: IdeRule k v => k -> Action (Maybe v) Source #

uses :: IdeRule k v => k -> [NormalizedFilePath] -> Action [Maybe v] Source #

Return up2date results. Stale results will be ignored.

useWithStaleFast :: IdeRule k v => k -> NormalizedFilePath -> IdeAction (Maybe (v, PositionMapping)) Source #

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.

useWithStaleFast' :: IdeRule k v => k -> NormalizedFilePath -> IdeAction (FastResult v) Source #

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

delayedAction :: DelayedAction a -> IdeAction (IO a) Source #

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

data FastResult a Source #

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

Constructors

FastResult
Fields stale :: Maybe (a, PositionMapping) uptoDate :: IO (Maybe a)

use_ :: IdeRule k v => k -> NormalizedFilePath -> Action v Source #

useNoFile_ :: IdeRule k v => k -> Action v Source #

uses_ :: IdeRule k v => k -> [NormalizedFilePath] -> Action [v] Source #

useWithStale :: IdeRule k v => k -> NormalizedFilePath -> Action (Maybe (v, PositionMapping)) Source #

usesWithStale :: IdeRule k v => k -> [NormalizedFilePath] -> Action [Maybe (v, PositionMapping)] Source #

Return the last computed result which might be stale.

useWithStale_ :: IdeRule k v => k -> NormalizedFilePath -> Action (v, PositionMapping) Source #

usesWithStale_ :: IdeRule k v => k -> [NormalizedFilePath] -> Action [(v, PositionMapping)] Source #

define :: IdeRule k v => (k -> NormalizedFilePath -> Action (IdeResult v)) -> Rules () Source #

defineEarlyCutoff :: IdeRule k v => (k -> NormalizedFilePath -> Action (Maybe ByteString, IdeResult v)) -> Rules () Source #

defineOnDisk :: (ShakeValue k, RuleResult k ~ ()) => (k -> NormalizedFilePath -> OnDiskRule) -> Rules () Source #

needOnDisk :: (ShakeValue k, RuleResult k ~ ()) => k -> NormalizedFilePath -> Action () Source #

needOnDisks :: (ShakeValue k, RuleResult k ~ ()) => k -> [NormalizedFilePath] -> Action () Source #

getDiagnostics :: IdeState -> IO [FileDiagnostic] Source #

unsafeClearDiagnostics :: IdeState -> IO () Source #

FIXME: This function is temporary! Only required because the files of interest doesn't work

getHiddenDiagnostics :: IdeState -> IO [FileDiagnostic] Source #

class Typeable a => IsIdeGlobal a Source #

Instances

IsIdeGlobal GlobalIdeOptions Source #
Instance details Defined in Development.IDE.Core.Shake
IsIdeGlobal VFSHandle Source #
Instance details Defined in Development.IDE.Core.FileStore

addIdeGlobal :: IsIdeGlobal a => a -> Rules () Source #

addIdeGlobalExtras :: IsIdeGlobal a => ShakeExtras -> a -> IO () Source #

getIdeGlobalState :: forall a. IsIdeGlobal a => IdeState -> IO a Source #

getIdeGlobalAction :: forall a. IsIdeGlobal a => Action a Source #

getIdeGlobalExtras :: forall a. IsIdeGlobal a => ShakeExtras -> IO a Source #

getIdeOptions :: Action IdeOptions Source #

getIdeOptionsIO :: ShakeExtras -> IO IdeOptions Source #

newtype GlobalIdeOptions Source #

Constructors

GlobalIdeOptions IdeOptions

Instances

IsIdeGlobal GlobalIdeOptions Source #
Instance details Defined in Development.IDE.Core.Shake

garbageCollect :: (NormalizedFilePath -> Bool) -> Action () Source #

Clear the results for all files that do not match the given predicate.

setPriority :: Priority -> Action () Source #

sendEvent :: FromServerMessage -> Action () Source #

ideLogger :: IdeState -> Logger Source #

actionLogger :: Action Logger Source #

data FileVersion Source #

Constructors

VFSVersion !Int
ModificationTime
Fields !Int64 Large unit (platform dependent, do not make assumptions) !Int64 Small unit (platform dependent, do not make assumptions)

Instances

Show FileVersion Source #
Instance details Defined in Development.IDE.Core.Shake Methods showsPrec :: Int -> FileVersion -> ShowS # show :: FileVersion -> String # showList :: [FileVersion] -> ShowS #
Generic FileVersion Source #
Instance details Defined in Development.IDE.Core.Shake Associated Types type Rep FileVersion :: Type -> Type # Methods from :: FileVersion -> Rep FileVersion x # to :: Rep FileVersion x -> FileVersion #
NFData FileVersion Source #
Instance details Defined in Development.IDE.Core.Shake Methods rnf :: FileVersion -> () #
type Rep FileVersion Source #
Instance details Defined in Development.IDE.Core.Shake type Rep FileVersion = D1 (MetaData "FileVersion" "Development.IDE.Core.Shake" "ghcide-0.3.0-Dfp4umcHt6s1wVYFQXPyfq" False) (C1 (MetaCons "VFSVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :+: C1 (MetaCons "ModificationTime" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int64) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int64)))

newtype Priority Source #

Constructors

Priority Double

updatePositionMapping :: IdeState -> VersionedTextDocumentIdentifier -> List TextDocumentContentChangeEvent -> IO () Source #

deleteValue :: (Typeable k, Hashable k, Eq k, Show k) => IdeState -> k -> NormalizedFilePath -> IO () Source #

Delete the value stored for a given ide build key

data OnDiskRule Source #

Constructors

OnDiskRule
Fields getHash :: Action ByteString runRule :: Action (IdeResult ByteString)

type WithProgressFunc = forall a. Text -> ProgressCancellable -> ((Progress -> IO ()) -> IO a) -> IO a Source #

type WithIndefiniteProgressFunc = forall a. Text -> ProgressCancellable -> IO a -> IO a Source #

data ProgressEvent Source #

Constructors

KickStarted
KickCompleted

data DelayedAction a Source #

Instances

Show (DelayedAction a) Source #
Instance details Defined in Development.IDE.Core.Shake Methods showsPrec :: Int -> DelayedAction a -> ShowS # show :: DelayedAction a -> String # showList :: [DelayedAction a] -> ShowS #

mkDelayedAction :: String -> Priority -> Action a -> DelayedAction a Source #

newtype IdeAction a Source #

Constructors

IdeAction
Fields runIdeActionT :: ReaderT ShakeExtras IO a

Instances

Monad IdeAction Source #
Instance details Defined in Development.IDE.Core.Shake Methods (>>=) :: IdeAction a -> (a -> IdeAction b) -> IdeAction b # (>>) :: IdeAction a -> IdeAction b -> IdeAction b # return :: a -> IdeAction a # fail :: String -> IdeAction a #
Functor IdeAction Source #
Instance details Defined in Development.IDE.Core.Shake Methods fmap :: (a -> b) -> IdeAction a -> IdeAction b # (<$) :: a -> IdeAction b -> IdeAction a #
Applicative IdeAction Source #
Instance details Defined in Development.IDE.Core.Shake Methods pure :: a -> IdeAction a # (<>) :: IdeAction (a -> b) -> IdeAction a -> IdeAction b # liftA2 :: (a -> b -> c) -> IdeAction a -> IdeAction b -> IdeAction c # (>) :: IdeAction a -> IdeAction b -> IdeAction b # (<*) :: IdeAction a -> IdeAction b -> IdeAction a #
MonadIO IdeAction Source #
Instance details Defined in Development.IDE.Core.Shake Methods liftIO :: IO a -> IdeAction a #
MonadReader ShakeExtras IdeAction Source #
Instance details Defined in Development.IDE.Core.Shake Methods ask :: IdeAction ShakeExtras # local :: (ShakeExtras -> ShakeExtras) -> IdeAction a -> IdeAction a # reader :: (ShakeExtras -> a) -> IdeAction a #

runIdeAction :: String -> ShakeExtras -> IdeAction a -> IO a Source #

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.

mkUpdater :: MaybeT IdeAction NameCacheUpdater Source #

newtype Q k Source #

Constructors

Q (k, NormalizedFilePath)

Instances

Eq k => Eq (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake Methods (==) :: Q k -> Q k -> Bool # (/=) :: Q k -> Q k -> Bool #
Show k => Show (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake Methods showsPrec :: Int -> Q k -> ShowS # show :: Q k -> String # showList :: [Q k] -> ShowS #
Generic (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake Associated Types type Rep (Q k) :: Type -> Type # Methods from :: Q k -> Rep (Q k) x # to :: Rep (Q k) x -> Q k #
Hashable k => Hashable (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake Methods hashWithSalt :: Int -> Q k -> Int # hash :: Q k -> Int #
Binary k => Binary (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake Methods put :: Q k -> Put # get :: Get (Q k) # putList :: [Q k] -> Put #
NFData k => NFData (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake Methods rnf :: Q k -> () #
type Rep (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake type Rep (Q k) = D1 (MetaData "Q" "Development.IDE.Core.Shake" "ghcide-0.3.0-Dfp4umcHt6s1wVYFQXPyfq" True) (C1 (MetaCons "Q" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (k, NormalizedFilePath))))
type RuleResult (Q k) Source #
Instance details Defined in Development.IDE.Core.Shake type RuleResult (Q k)