Safe Haskell	None
Language	Haskell2010

Development.IDE.Core.Rules

Description

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

Synopsis

data IdeState
data GetDependencies = GetDependencies
data GetParsedModule = GetParsedModule
data TransitiveDependencies = TransitiveDependencies {
- transitiveModuleDeps :: [NormalizedFilePath]
- transitiveNamedModuleDeps :: [NamedModuleDep]
- transitivePkgDeps :: [InstalledUnitId]
}
newtype Priority = Priority Double
data GhcSessionIO = GhcSessionIO
data GetClientSettings = GetClientSettings
priorityTypeCheck :: Priority
priorityGenerateCore :: Priority
priorityFilesOfInterest :: Priority
runAction :: String -> IdeState -> Action a -> IO a
useE :: IdeRule k v => k -> NormalizedFilePath -> MaybeT IdeAction (v, PositionMapping)
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
defineNoFile :: IdeRule k v => (k -> Action v) -> Rules ()
defineEarlyCutOffNoFile :: IdeRule k v => (k -> Action (ByteString, v)) -> Rules ()
mainRule :: Rules ()
getAtPoint :: NormalizedFilePath -> Position -> IdeAction (Maybe (Maybe Range, [Text]))
getDefinition :: NormalizedFilePath -> Position -> IdeAction (Maybe Location)
getTypeDefinition :: NormalizedFilePath -> Position -> IdeAction (Maybe [Location])
highlightAtPoint :: NormalizedFilePath -> Position -> IdeAction (Maybe [DocumentHighlight])
getDependencies :: NormalizedFilePath -> Action (Maybe [NormalizedFilePath])
getParsedModule :: NormalizedFilePath -> Action (Maybe ParsedModule)

Documentation

data IdeState Source #

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

data GetDependencies Source #

Constructors

GetDependencies

Instances

Instances details

Eq GetDependencies Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods (==) :: GetDependencies -> GetDependencies -> Bool # (/=) :: GetDependencies -> GetDependencies -> Bool #
Show GetDependencies Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods showsPrec :: Int -> GetDependencies -> ShowS # show :: GetDependencies -> String # showList :: [GetDependencies] -> ShowS #
Generic GetDependencies Source #
Instance details 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 Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods hashWithSalt :: Int -> GetDependencies -> Int # hash :: GetDependencies -> Int #
Binary GetDependencies Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods put :: GetDependencies -> Put # get :: Get GetDependencies # putList :: [GetDependencies] -> Put #
NFData GetDependencies Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods rnf :: GetDependencies -> () #
type Rep GetDependencies Source #
Instance details Defined in Development.IDE.Core.RuleTypes type Rep GetDependencies = D1 ('MetaData "GetDependencies" "Development.IDE.Core.RuleTypes" "ghcide-0.5.0-44qfEMOy50OD1DtXc48AUP" 'False) (C1 ('MetaCons "GetDependencies" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult GetDependencies Source #	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.
Instance details Defined in Development.IDE.Core.RuleTypes type RuleResult GetDependencies = TransitiveDependencies

data GetParsedModule Source #

Constructors

GetParsedModule

Instances

Instances details

Eq GetParsedModule Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods (==) :: GetParsedModule -> GetParsedModule -> Bool # (/=) :: GetParsedModule -> GetParsedModule -> Bool #
Show GetParsedModule Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods showsPrec :: Int -> GetParsedModule -> ShowS # show :: GetParsedModule -> String # showList :: [GetParsedModule] -> ShowS #
Generic GetParsedModule Source #
Instance details 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 Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods hashWithSalt :: Int -> GetParsedModule -> Int # hash :: GetParsedModule -> Int #
Binary GetParsedModule Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods put :: GetParsedModule -> Put # get :: Get GetParsedModule # putList :: [GetParsedModule] -> Put #
NFData GetParsedModule Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods rnf :: GetParsedModule -> () #
type Rep GetParsedModule Source #
Instance details Defined in Development.IDE.Core.RuleTypes type Rep GetParsedModule = D1 ('MetaData "GetParsedModule" "Development.IDE.Core.RuleTypes" "ghcide-0.5.0-44qfEMOy50OD1DtXc48AUP" 'False) (C1 ('MetaCons "GetParsedModule" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult GetParsedModule Source #	The parse tree for the file using GetFileContents
Instance details Defined in Development.IDE.Core.RuleTypes type RuleResult GetParsedModule = ParsedModule

data TransitiveDependencies Source #

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

Instances details

Eq TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods (==) :: TransitiveDependencies -> TransitiveDependencies -> Bool # (/=) :: TransitiveDependencies -> TransitiveDependencies -> Bool #
Show TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods showsPrec :: Int -> TransitiveDependencies -> ShowS # show :: TransitiveDependencies -> String # showList :: [TransitiveDependencies] -> ShowS #
Generic TransitiveDependencies Source #
Instance details 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 Source #
Instance details Defined in Development.IDE.Import.DependencyInformation Methods rnf :: TransitiveDependencies -> () #
type Rep TransitiveDependencies Source #
Instance details Defined in Development.IDE.Import.DependencyInformation type Rep TransitiveDependencies = D1 ('MetaData "TransitiveDependencies" "Development.IDE.Import.DependencyInformation" "ghcide-0.5.0-44qfEMOy50OD1DtXc48AUP" '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 Source #

Constructors

Priority Double

data GhcSessionIO Source #

Constructors

GhcSessionIO

Instances

Instances details

Eq GhcSessionIO Source #
Instance details Defined in Development.IDE.Core.Rules Methods (==) :: GhcSessionIO -> GhcSessionIO -> Bool # (/=) :: GhcSessionIO -> GhcSessionIO -> Bool #
Show GhcSessionIO Source #
Instance details Defined in Development.IDE.Core.Rules Methods showsPrec :: Int -> GhcSessionIO -> ShowS # show :: GhcSessionIO -> String # showList :: [GhcSessionIO] -> ShowS #
Generic GhcSessionIO Source #
Instance details 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 Source #
Instance details Defined in Development.IDE.Core.Rules Methods hashWithSalt :: Int -> GhcSessionIO -> Int # hash :: GhcSessionIO -> Int #
Binary GhcSessionIO Source #
Instance details Defined in Development.IDE.Core.Rules Methods put :: GhcSessionIO -> Put # get :: Get GhcSessionIO # putList :: [GhcSessionIO] -> Put #
NFData GhcSessionIO Source #
Instance details Defined in Development.IDE.Core.Rules Methods rnf :: GhcSessionIO -> () #
type Rep GhcSessionIO Source #
Instance details Defined in Development.IDE.Core.Rules type Rep GhcSessionIO = D1 ('MetaData "GhcSessionIO" "Development.IDE.Core.Rules" "ghcide-0.5.0-44qfEMOy50OD1DtXc48AUP" 'False) (C1 ('MetaCons "GhcSessionIO" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult GhcSessionIO Source #
Instance details Defined in Development.IDE.Core.Rules type RuleResult GhcSessionIO = IdeGhcSession

data GetClientSettings Source #

Get the vscode client settings stored in the ide state

Constructors

GetClientSettings

Instances

Instances details

Eq GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods (==) :: GetClientSettings -> GetClientSettings -> Bool # (/=) :: GetClientSettings -> GetClientSettings -> Bool #
Show GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods showsPrec :: Int -> GetClientSettings -> ShowS # show :: GetClientSettings -> String # showList :: [GetClientSettings] -> ShowS #
Generic GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes Associated Types type Rep GetClientSettings :: Type -> Type # Methods from :: GetClientSettings -> Rep GetClientSettings x # to :: Rep GetClientSettings x -> GetClientSettings #
Hashable GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods hashWithSalt :: Int -> GetClientSettings -> Int # hash :: GetClientSettings -> Int #
Binary GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods put :: GetClientSettings -> Put # get :: Get GetClientSettings # putList :: [GetClientSettings] -> Put #
NFData GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods rnf :: GetClientSettings -> () #
type Rep GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes type Rep GetClientSettings = D1 ('MetaData "GetClientSettings" "Development.IDE.Core.RuleTypes" "ghcide-0.5.0-44qfEMOy50OD1DtXc48AUP" 'False) (C1 ('MetaCons "GetClientSettings" 'PrefixI 'False) (U1 :: Type -> Type))
type RuleResult GetClientSettings Source #
Instance details Defined in Development.IDE.Core.RuleTypes type RuleResult GetClientSettings = Hashed (Maybe Value)

priorityTypeCheck :: Priority Source #

priorityGenerateCore :: Priority Source #

priorityFilesOfInterest :: Priority Source #

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

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

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 Source #

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

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

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

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

mainRule :: Rules () Source #

A rule that wires per-file rules together

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

Try to get hover text for the name under point.

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

Goto Definition.

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

highlightAtPoint :: NormalizedFilePath -> Position -> IdeAction (Maybe [DocumentHighlight]) Source #

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

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

getParsedModule :: NormalizedFilePath -> Action (Maybe ParsedModule) Source #

Parse the contents of a daml file.