Development.IDE.Core.Rules

A Shake implementation of the compiler service, built using the Shaker abstraction layer for in-memory use.

Documentation

data IdeState

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

data GetDependencies

Constructors

GetDependencies

Instances

Eq GetDependencies

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetDependencies -> GetDependencies -> Bool

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

Show GetDependencies

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetDependencies -> ShowS

show :: GetDependencies -> String

showList :: [GetDependencies] -> ShowS

Generic GetDependencies

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetDependencies :: Type -> Type

Methods

from :: GetDependencies -> Rep GetDependencies x

to :: Rep GetDependencies x -> GetDependencies

Hashable GetDependencies

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetDependencies -> Int

hash :: GetDependencies -> Int

Binary GetDependencies

Defined in Development.IDE.Core.RuleTypes

Methods

put :: GetDependencies -> Put

get :: Get GetDependencies

putList :: [GetDependencies] -> Put

NFData GetDependencies

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetDependencies -> ()

type Rep GetDependencies

Defined in Development.IDE.Core.RuleTypes

type Rep GetDependencies = D1 (MetaData "GetDependencies" "Development.IDE.Core.RuleTypes" "ghcide-0.4.0-98cFz095V7v2i8ymOuBUUo" False) (C1 (MetaCons "GetDependencies" PrefixI False) (U1 :: Type -> Type))

type RuleResult GetDependencies

Transitive module and pkg dependencies based on the information produced by GetDependencyInformation. This rule is also responsible for calling ReportImportCycles for each file in the transitive closure.

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetDependencies = TransitiveDependencies

data GetParsedModule

Constructors

GetParsedModule

Instances

Eq GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

(==) :: GetParsedModule -> GetParsedModule -> Bool

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

Show GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

showsPrec :: Int -> GetParsedModule -> ShowS

show :: GetParsedModule -> String

showList :: [GetParsedModule] -> ShowS

Generic GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Associated Types

type Rep GetParsedModule :: Type -> Type

Methods

from :: GetParsedModule -> Rep GetParsedModule x

to :: Rep GetParsedModule x -> GetParsedModule

Hashable GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

hashWithSalt :: Int -> GetParsedModule -> Int

hash :: GetParsedModule -> Int

Binary GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

put :: GetParsedModule -> Put

get :: Get GetParsedModule

putList :: [GetParsedModule] -> Put

NFData GetParsedModule

Defined in Development.IDE.Core.RuleTypes

Methods

rnf :: GetParsedModule -> ()

type Rep GetParsedModule

Defined in Development.IDE.Core.RuleTypes

type Rep GetParsedModule = D1 (MetaData "GetParsedModule" "Development.IDE.Core.RuleTypes" "ghcide-0.4.0-98cFz095V7v2i8ymOuBUUo" False) (C1 (MetaCons "GetParsedModule" PrefixI False) (U1 :: Type -> Type))

type RuleResult GetParsedModule

The parse tree for the file using GetFileContents

Defined in Development.IDE.Core.RuleTypes

type RuleResult GetParsedModule = ParsedModule

data TransitiveDependencies

Constructors

TransitiveDependencies

Fields

• transitiveModuleDeps :: [NormalizedFilePath]

  Transitive module dependencies in topological order. The module itself is not included.

• transitiveNamedModuleDeps :: [NamedModuleDep]

  Transitive module dependencies in topological order. The module itself is not included.

• transitivePkgDeps :: [InstalledUnitId]

  Transitive pkg dependencies in unspecified order.

Instances

Eq TransitiveDependencies

Defined in Development.IDE.Import.DependencyInformation

Methods

(==) :: TransitiveDependencies -> TransitiveDependencies -> Bool

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

Show TransitiveDependencies

Defined in Development.IDE.Import.DependencyInformation

Methods

showsPrec :: Int -> TransitiveDependencies -> ShowS

show :: TransitiveDependencies -> String

showList :: [TransitiveDependencies] -> ShowS

Generic TransitiveDependencies

Defined in Development.IDE.Import.DependencyInformation

Associated Types

type Rep TransitiveDependencies :: Type -> Type

Methods

from :: TransitiveDependencies -> Rep TransitiveDependencies x

to :: Rep TransitiveDependencies x -> TransitiveDependencies

NFData TransitiveDependencies

Defined in Development.IDE.Import.DependencyInformation

Methods

rnf :: TransitiveDependencies -> ()

type Rep TransitiveDependencies

Defined in Development.IDE.Import.DependencyInformation

type Rep TransitiveDependencies = D1 (MetaData "TransitiveDependencies" "Development.IDE.Import.DependencyInformation" "ghcide-0.4.0-98cFz095V7v2i8ymOuBUUo" False) (C1 (MetaCons "TransitiveDependencies" PrefixI True) (S1 (MetaSel (Just "transitiveModuleDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [NormalizedFilePath]) :*: (S1 (MetaSel (Just "transitiveNamedModuleDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [NamedModuleDep]) :*: S1 (MetaSel (Just "transitivePkgDeps") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [InstalledUnitId]))))

newtype Priority

Constructors

Priority Double

data GhcSessionIO

Constructors

GhcSessionIO

Instances

Eq GhcSessionIO

Defined in Development.IDE.Core.Rules

Methods

(==) :: GhcSessionIO -> GhcSessionIO -> Bool

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

Show GhcSessionIO

Defined in Development.IDE.Core.Rules

Methods

showsPrec :: Int -> GhcSessionIO -> ShowS

show :: GhcSessionIO -> String

showList :: [GhcSessionIO] -> ShowS

Generic GhcSessionIO

Defined in Development.IDE.Core.Rules

Associated Types

type Rep GhcSessionIO :: Type -> Type

Methods

from :: GhcSessionIO -> Rep GhcSessionIO x

to :: Rep GhcSessionIO x -> GhcSessionIO

Hashable GhcSessionIO

Defined in Development.IDE.Core.Rules

Methods

hashWithSalt :: Int -> GhcSessionIO -> Int

hash :: GhcSessionIO -> Int

Binary GhcSessionIO

Defined in Development.IDE.Core.Rules

Methods

put :: GhcSessionIO -> Put

get :: Get GhcSessionIO

putList :: [GhcSessionIO] -> Put

NFData GhcSessionIO

Defined in Development.IDE.Core.Rules

Methods

rnf :: GhcSessionIO -> ()

type Rep GhcSessionIO

Defined in Development.IDE.Core.Rules

type Rep GhcSessionIO = D1 (MetaData "GhcSessionIO" "Development.IDE.Core.Rules" "ghcide-0.4.0-98cFz095V7v2i8ymOuBUUo" False) (C1 (MetaCons "GhcSessionIO" PrefixI False) (U1 :: Type -> Type))

type RuleResult GhcSessionIO

Defined in Development.IDE.Core.Rules

type RuleResult GhcSessionIO = IdeGhcSession

priorityTypeCheck :: Priority

priorityGenerateCore :: Priority

priorityFilesOfInterest :: Priority

runAction :: String -> IdeState -> Action a -> IO a

useE :: IdeRule k v => k -> NormalizedFilePath -> MaybeT IdeAction (v, PositionMapping)

useE is useful to implement functions that aren’t rules but need shortcircuiting e.g. getDefinition.

useNoFileE :: IdeRule k v => IdeState -> k -> MaybeT IdeAction v

usesE :: IdeRule k v => k -> [NormalizedFilePath] -> MaybeT IdeAction [(v, PositionMapping)]

toIdeResult :: Either [FileDiagnostic] v -> IdeResult v

This is useful for rules to convert rules that can only produce errors or a result into the more general IdeResult type that supports producing warnings while also producing a result.

defineNoFile :: IdeRule k v => (k -> Action v) -> Rules ()

defineEarlyCutOffNoFile :: IdeRule k v => (k -> Action (ByteString, v)) -> Rules ()

mainRule :: Rules ()

A rule that wires per-file rules together

getAtPoint :: NormalizedFilePath -> Position -> IdeAction (Maybe (Maybe Range, [Text]))

Try to get hover text for the name under point.

getDefinition :: NormalizedFilePath -> Position -> IdeAction (Maybe Location)

Goto Definition.

getTypeDefinition :: NormalizedFilePath -> Position -> IdeAction (Maybe [Location])

getDependencies :: NormalizedFilePath -> Action (Maybe [NormalizedFilePath])

Get all transitive file dependencies of a given module. Does not include the file itself.

getParsedModule :: NormalizedFilePath -> Action (Maybe ParsedModule)

Parse the contents of a daml file.

generateCore :: RunSimplifier -> NormalizedFilePath -> Action (IdeResult (SafeHaskellMode, CgGuts, ModDetails))