Development.IDE.Graph.Rule

Defining builtin rules

Functions and types for defining new types of Shake rules.

addRule :: forall key value. (RuleResult key ~ value, Typeable key, Hashable key, Eq key, Typeable value) => (key -> Maybe ByteString -> RunMode -> Action (RunResult value)) -> Rules ()

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

Eq RunMode

Defined in Development.IDE.Graph.Internal.Types

Methods

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

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

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

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

Eq RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

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

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

Show RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

showsPrec :: Int -> RunChanged -> ShowS

show :: RunChanged -> String

showList :: [RunChanged] -> ShowS

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

ToJSON RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

toJSON :: RunChanged -> Value

toEncoding :: RunChanged -> Encoding

toJSONList :: [RunChanged] -> Value

toEncodingList :: [RunChanged] -> Encoding

FromJSON RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

parseJSON :: Value -> Parser RunChanged

parseJSONList :: Value -> Parser [RunChanged]

NFData RunChanged

Defined in Development.IDE.Graph.Internal.Types

Methods

rnf :: RunChanged -> ()

type Rep RunChanged

Defined in Development.IDE.Graph.Internal.Types

type Rep RunChanged = D1 ('MetaData "RunChanged" "Development.IDE.Graph.Internal.Types" "hls-graph-1.7.0.0-CJkZOl3urMP8mW2nXb6rkm" '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 -> ()

Calling builtin rules

Wrappers around calling Shake rules. In general these should be specialised to a builtin rule.

apply :: (RuleResult key ~ value, ShakeValue key, Typeable value) => [key] -> Action [value]

apply1 :: (RuleResult key ~ value, ShakeValue key, Typeable value) => key -> Action value

applyWithoutDependency :: (RuleResult key ~ value, ShakeValue key, Typeable value) => [key] -> Action [value]

Evaluate a list of keys without recording any dependencies.