Development.IDE.Core.Shake

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.

Documentation

data IdeState

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

data ShakeExtras

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 (Map NormalizedUri [Diagnostic])

  This represents the set of diagnostics that we have published. Due to debouncing not every change might get published.

• positionMapping :: Var (Map NormalizedUri (Map TextDocumentVersion 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

• inProgress :: Var (Map NormalizedFilePath Int)

  How many rules are running for each file

getShakeExtras :: Action ShakeExtras

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

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

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

Constructors

GetModificationTime

Instances

Eq GetModificationTime

Defined in Development.IDE.Core.Shake

Methods

(==) :: GetModificationTime -> GetModificationTime -> Bool

(/=) :: GetModificationTime -> GetModificationTime -> Bool

Show GetModificationTime

Defined in Development.IDE.Core.Shake

Methods

showsPrec :: Int -> GetModificationTime -> ShowS

show :: GetModificationTime -> String

showList :: [GetModificationTime] -> ShowS

Generic GetModificationTime

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

Defined in Development.IDE.Core.Shake

Methods

hashWithSalt :: Int -> GetModificationTime -> Int

hash :: GetModificationTime -> Int

Binary GetModificationTime

Defined in Development.IDE.Core.Shake

Methods

put :: GetModificationTime -> Put

get :: Get GetModificationTime

putList :: [GetModificationTime] -> Put

NFData GetModificationTime

Defined in Development.IDE.Core.Shake

Methods

rnf :: GetModificationTime -> ()

type Rep GetModificationTime

Defined in Development.IDE.Core.Shake

type Rep GetModificationTime = D1 (MetaData "GetModificationTime" "Development.IDE.Core.Shake" "ghcide-0.1.0-C0d1MTwub4dDHKtuFGkKNT" False) (C1 (MetaCons "GetModificationTime" PrefixI False) (U1 :: Type -> Type))

type RuleResult GetModificationTime

Get the modification time of a file.

Defined in Development.IDE.Core.Shake

type RuleResult GetModificationTime = FileVersion

shakeOpen

Arguments

:: IO LspId

-> (FromServerMessage -> IO ())

diagnostic handler

-> Logger

-> Maybe FilePath

-> IdeReportProgress

-> ShakeOptions

-> Rules ()

-> IO IdeState

Open a IdeState, should be shut using shakeShut.

shakeShut :: IdeState -> IO ()

shakeRun :: IdeState -> [Action a] -> IO (IO [a])

Spawn immediately. If you are already inside a call to shakeRun that will be aborted with an exception.

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

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

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

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

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

Return up2date results. Stale results will be ignored.

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

Return the last computed result which might be stale.

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

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

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

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 ()

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

getHiddenDiagnostics :: IdeState -> IO [FileDiagnostic]

class Typeable a => IsIdeGlobal a

Instances

IsIdeGlobal VFSHandle

Defined in Development.IDE.Core.FileStore

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

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

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

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

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

setPriority :: Priority -> Action ()

sendEvent :: FromServerMessage -> Action ()

ideLogger :: IdeState -> Logger

actionLogger :: Action Logger

data FileVersion

We store the modification time as a ByteString since we need a ByteString anyway for Shake and we do not care about how times are represented.

Constructors

VFSVersion Int

ModificationTime ByteString

Instances

Show FileVersion

Defined in Development.IDE.Core.Shake

Methods

showsPrec :: Int -> FileVersion -> ShowS

show :: FileVersion -> String

showList :: [FileVersion] -> ShowS

Generic FileVersion

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

Defined in Development.IDE.Core.Shake

Methods

rnf :: FileVersion -> ()

type Rep FileVersion

Defined in Development.IDE.Core.Shake

type Rep FileVersion = D1 (MetaData "FileVersion" "Development.IDE.Core.Shake" "ghcide-0.1.0-C0d1MTwub4dDHKtuFGkKNT" False) (C1 (MetaCons "VFSVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :+: C1 (MetaCons "ModificationTime" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

newtype Priority

Constructors

Priority Double

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

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

Delete the value stored for a given ide build key

data OnDiskRule

Constructors

OnDiskRule

Fields

• getHash :: Action ByteString
• runRule :: Action (IdeResult ByteString)