Development.IDE.Graph.Internal.Types

Documentation

unwrapDynamic :: forall a. Typeable a => Dynamic -> a

type TheRules = HashMap TypeRep Dynamic

newtype Rules a

A computation that defines all the rules that form part of the computation graph.

Rules has access to IO through MonadIO. Use of IO is at your own risk: if you write Rules that throw exceptions, then you need to make sure to handle them yourself when you run the resulting Rules.

Constructors

Rules (ReaderT SRules IO a)

Instances

MonadIO Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

liftIO :: IO a -> Rules a

Applicative Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

pure :: a -> Rules a

(<*>) :: Rules (a -> b) -> Rules a -> Rules b

liftA2 :: (a -> b -> c) -> Rules a -> Rules b -> Rules c

(*>) :: Rules a -> Rules b -> Rules b

(<*) :: Rules a -> Rules b -> Rules a

Functor Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

fmap :: (a -> b) -> Rules a -> Rules b

(<$) :: a -> Rules b -> Rules a

Monad Rules

Defined in Development.IDE.Graph.Internal.Types

Methods

(>>=) :: Rules a -> (a -> Rules b) -> Rules b

(>>) :: Rules a -> Rules b -> Rules b

return :: a -> Rules a

Monoid a => Monoid (Rules a)

Defined in Development.IDE.Graph.Internal.Types

Methods

mempty :: Rules a

mappend :: Rules a -> Rules a -> Rules a

mconcat :: [Rules a] -> Rules a

Semigroup a => Semigroup (Rules a)

Defined in Development.IDE.Graph.Internal.Types

Methods

(<>) :: Rules a -> Rules a -> Rules a

sconcat :: NonEmpty (Rules a) -> Rules a

stimes :: Integral b => b -> Rules a -> Rules a

data SRules

Constructors

SRules

Fields

• rulesExtra :: !Dynamic
• rulesActions :: !(IORef [Action ()])
• rulesMap :: !(IORef TheRules)

newtype Action a

An action representing something that can be run as part of a Rule.

Actions can be pure functions but also have access to IO via MonadIO and 'MonadUnliftIO. It should be assumed that actions throw exceptions, these can be caught with actionCatch. In particular, it is permissible to use the MonadFail instance, which will lead to an IOException.

Constructors

Action

Fields

• fromAction :: ReaderT SAction IO a

Instances

MonadFail Action

Defined in Development.IDE.Graph.Internal.Types

Methods

fail :: String -> Action a

MonadIO Action

Defined in Development.IDE.Graph.Internal.Types

Methods

liftIO :: IO a -> Action a

Applicative Action

Defined in Development.IDE.Graph.Internal.Types

Methods

pure :: a -> Action a

(<*>) :: Action (a -> b) -> Action a -> Action b

liftA2 :: (a -> b -> c) -> Action a -> Action b -> Action c

(*>) :: Action a -> Action b -> Action b

(<*) :: Action a -> Action b -> Action a

Functor Action

Defined in Development.IDE.Graph.Internal.Types

Methods

fmap :: (a -> b) -> Action a -> Action b

(<$) :: a -> Action b -> Action a

Monad Action

Defined in Development.IDE.Graph.Internal.Types

Methods

(>>=) :: Action a -> (a -> Action b) -> Action b

(>>) :: Action a -> Action b -> Action b

return :: a -> Action a

MonadCatch Action

Defined in Development.IDE.Graph.Internal.Types

Methods

catch :: (HasCallStack, Exception e) => Action a -> (e -> Action a) -> Action a

MonadMask Action

Defined in Development.IDE.Graph.Internal.Types

Methods

mask :: HasCallStack => ((forall a. Action a -> Action a) -> Action b) -> Action b

uninterruptibleMask :: HasCallStack => ((forall a. Action a -> Action a) -> Action b) -> Action b

generalBracket :: HasCallStack => Action a -> (a -> ExitCase b -> Action c) -> (a -> Action b) -> Action (b, c)

MonadThrow Action

Defined in Development.IDE.Graph.Internal.Types

Methods

throwM :: (HasCallStack, Exception e) => e -> Action a

MonadUnliftIO Action

Defined in Development.IDE.Graph.Internal.Types

Methods

withRunInIO :: ((forall a. Action a -> IO a) -> IO b) -> Action b

data SAction

Constructors

SAction

Fields

• actionDatabase :: !Database
• actionDeps :: !(IORef ResultDeps)
• actionStack :: !Stack

getDatabase :: Action Database

data ShakeDatabase

Constructors

ShakeDatabase !Int [Action ()] Database

newtype Step

Constructors

Step Int

Instances

Eq Step

Defined in Development.IDE.Graph.Internal.Types

Methods

(==) :: Step -> Step -> Bool

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

Ord Step

Defined in Development.IDE.Graph.Internal.Types

Methods

compare :: Step -> Step -> Ordering

(<) :: Step -> Step -> Bool

(<=) :: Step -> Step -> Bool

(>) :: Step -> Step -> Bool

(>=) :: Step -> Step -> Bool

max :: Step -> Step -> Step

min :: Step -> Step -> Step

Hashable Step

Defined in Development.IDE.Graph.Internal.Types

Methods

hashWithSalt :: Int -> Step -> Int

hash :: Step -> Int

newtype Value

Constructors

Value Dynamic

data KeyDetails

Constructors

KeyDetails

Fields

• keyStatus :: !Status
• keyReverseDeps :: !KeySet

onKeyReverseDeps :: (KeySet -> KeySet) -> KeyDetails -> KeyDetails

data Database

Constructors

Database

Fields

• databaseExtra :: Dynamic
• databaseRules :: TheRules
• databaseStep :: !(TVar Step)
• databaseValues :: !(Map Key KeyDetails)

getDatabaseValues :: Database -> IO [(Key, Status)]

data Status

Constructors

Clean !Result

Dirty (Maybe Result)

Running

Fields

• runningStep :: !Step
• runningWait :: !(IO ())
• runningResult :: Result
• runningPrev :: !(Maybe Result)

viewDirty :: Step -> Status -> Status

getResult :: Status -> Maybe Result

data Result

Constructors

Result

Fields

• resultValue :: !Value
• resultBuilt :: !Step

  the step when it was last recomputed

• resultChanged :: !Step

  the step when it last changed

• resultVisited :: !Step

  the step when it was last looked up

• resultDeps :: !ResultDeps
• resultExecution :: !Seconds

  How long it took, last time it ran

• resultData :: !ByteString

data ResultDeps

Constructors

UnknownDeps

AlwaysRerunDeps !KeySet

ResultDeps !KeySet

Instances

Monoid ResultDeps

Defined in Development.IDE.Graph.Internal.Types

Methods

mempty :: ResultDeps

mappend :: ResultDeps -> ResultDeps -> ResultDeps

mconcat :: [ResultDeps] -> ResultDeps

Semigroup ResultDeps

Defined in Development.IDE.Graph.Internal.Types

Methods

(<>) :: ResultDeps -> ResultDeps -> ResultDeps

sconcat :: NonEmpty ResultDeps -> ResultDeps

stimes :: Integral b => b -> ResultDeps -> ResultDeps

Show ResultDeps

Defined in Development.IDE.Graph.Internal.Types

Methods

showsPrec :: Int -> ResultDeps -> ShowS

show :: ResultDeps -> String

showList :: [ResultDeps] -> ShowS

Eq ResultDeps

Defined in Development.IDE.Graph.Internal.Types

Methods

(==) :: ResultDeps -> ResultDeps -> Bool

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

getResultDepsDefault :: KeySet -> ResultDeps -> KeySet

mapResultDeps :: (KeySet -> KeySet) -> ResultDeps -> ResultDeps

data RunMode

What mode a rule is running in, passed as an argument to BuiltinRun.

Constructors

RunDependenciesSame

My dependencies have not changed.

RunDependenciesChanged

At least one of my dependencies from last time have changed, or I have no recorded dependencies.

Instances

Show RunMode

Defined in Development.IDE.Graph.Internal.Types

Methods

showsPrec :: Int -> RunMode -> ShowS

show :: RunMode -> String

showList :: [RunMode] -> ShowS

NFData RunMode

Defined in Development.IDE.Graph.Internal.Types

Methods

rnf :: RunMode -> ()

Eq RunMode

Defined in Development.IDE.Graph.Internal.Types

Methods

(==) :: RunMode -> RunMode -> Bool

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

data RunChanged

How the output of a rule has changed.

Constructors

ChangedNothing

Nothing has changed.

ChangedStore

The stored value has changed, but in a way that should be considered identical (used rarely).

ChangedRecomputeSame

I recomputed the value and it was the same.

ChangedRecomputeDiff

I recomputed the value and it was different.

Instances

FromJSON RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

parseJSON :: Value -> Parser RunChanged

parseJSONList :: Value -> Parser [RunChanged]

omittedField :: Maybe RunChanged

ToJSON RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

toJSON :: RunChanged -> Value

toEncoding :: RunChanged -> Encoding

toJSONList :: [RunChanged] -> Value

toEncodingList :: [RunChanged] -> Encoding

omitField :: RunChanged -> Bool

Generic RunChanged

Defined in Development.IDE.Graph.Internal.Types

Associated Types

type Rep RunChanged :: Type -> Type

Methods

from :: RunChanged -> Rep RunChanged x

to :: Rep RunChanged x -> RunChanged

Show RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

showsPrec :: Int -> RunChanged -> ShowS

show :: RunChanged -> String

showList :: [RunChanged] -> ShowS

NFData RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

rnf :: RunChanged -> ()

Eq RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

(==) :: RunChanged -> RunChanged -> Bool

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

type Rep RunChanged

Defined in Development.IDE.Graph.Internal.Types

type Rep RunChanged = D1 ('MetaData "RunChanged" "Development.IDE.Graph.Internal.Types" "hls-graph-2.7.0.0-LkFdhZo9DGf4tLNtXMb4BZ" 'False) ((C1 ('MetaCons "ChangedNothing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChangedStore" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ChangedRecomputeSame" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChangedRecomputeDiff" 'PrefixI 'False) (U1 :: Type -> Type)))

data RunResult value

The result of BuiltinRun.

Constructors

RunResult

Fields

• runChanged :: RunChanged

  How has the RunResult changed from what happened last time.

• runStore :: ByteString

  The value to store in the Shake database.

• runValue :: value

  The value to return from apply.

Instances

Functor RunResult

Defined in Development.IDE.Graph.Internal.Types

Methods

fmap :: (a -> b) -> RunResult a -> RunResult b

(<$) :: a -> RunResult b -> RunResult a

NFData value => NFData (RunResult value)

Defined in Development.IDE.Graph.Internal.Types

Methods

rnf :: RunResult value -> ()

data GraphException

Constructors

forall e.Exception e => GraphException

Fields

• target :: String

  The key that was being built

• stack :: [String]

  The stack of keys that led to this exception

• inner :: e

  The underlying exception

Instances

Exception GraphException

Defined in Development.IDE.Graph.Internal.Types

Methods

toException :: GraphException -> SomeException

fromException :: SomeException -> Maybe GraphException

displayException :: GraphException -> String

Show GraphException

Defined in Development.IDE.Graph.Internal.Types

Methods

showsPrec :: Int -> GraphException -> ShowS

show :: GraphException -> String

showList :: [GraphException] -> ShowS

fromGraphException :: Typeable b => SomeException -> Maybe b

data Stack

Constructors

Stack [Key] !KeySet

Instances

Show Stack

Defined in Development.IDE.Graph.Internal.Types

Methods

showsPrec :: Int -> Stack -> ShowS

show :: Stack -> String

showList :: [Stack] -> ShowS

newtype StackException

Constructors

StackException Stack

Instances

Exception StackException

Defined in Development.IDE.Graph.Internal.Types

Methods

toException :: StackException -> SomeException

fromException :: SomeException -> Maybe StackException

displayException :: StackException -> String

Show StackException

Defined in Development.IDE.Graph.Internal.Types

Methods

showsPrec :: Int -> StackException -> ShowS

show :: StackException -> String

showList :: [StackException] -> ShowS

addStack :: Key -> Stack -> Either StackException Stack

memberStack :: Key -> Stack -> Bool

emptyStack :: Stack