| 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
- newtype TransitiveDependencies = TransitiveDependencies {}
- 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])
- refsAtPoint :: NormalizedFilePath -> Position -> Action [Location]
- workspaceSymbols :: Text -> IdeAction (Maybe [SymbolInformation])
- getDependencies :: NormalizedFilePath -> Action (Maybe [NormalizedFilePath])
- getParsedModule :: NormalizedFilePath -> Action (Maybe ParsedModule)
- getParsedModuleWithComments :: NormalizedFilePath -> Action (Maybe ParsedModule)
- getClientConfigAction :: Config -> Action Config
- newtype CompiledLinkables = CompiledLinkables {}
- data IsHiFileStable = IsHiFileStable
- getParsedModuleRule :: Rules ()
- getParsedModuleWithCommentsRule :: Rules ()
- getLocatedImportsRule :: Rules ()
- getDependencyInformationRule :: Rules ()
- reportImportCyclesRule :: Rules ()
- getDependenciesRule :: Rules ()
- typeCheckRule :: Rules ()
- getDocMapRule :: Rules ()
- loadGhcSession :: Rules ()
- getModIfaceFromDiskRule :: Rules ()
- getModIfaceRule :: Rules ()
- getModIfaceWithoutLinkableRule :: Rules ()
- getModSummaryRule :: Rules ()
- isHiFileStableRule :: Rules ()
- getModuleGraphRule :: Rules ()
- knownFilesRule :: Rules ()
- getClientSettingsRule :: Rules ()
- getHieAstsRule :: Rules ()
- getBindingsRule :: Rules ()
- needsCompilationRule :: Rules ()
- generateCoreRule :: Rules ()
- getImportMapRule :: Rules ()
- regenerateHiFile :: HscEnvEq -> NormalizedFilePath -> ModSummary -> Maybe LinkableType -> Action ([FileDiagnostic], Maybe HiFileResult)
- ghcSessionDepsDefinition :: NormalizedFilePath -> Action (IdeResult HscEnvEq)
- getParsedModuleDefinition :: HscEnv -> IdeOptions -> NormalizedFilePath -> ModSummary -> IO (Maybe ByteString, ([FileDiagnostic], Maybe ParsedModule))
- typeCheckRuleDefinition :: HscEnv -> ParsedModule -> Action (IdeResult TcModuleResult)
Types
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
data GetParsedModule Source #
Constructors
| GetParsedModule |
Instances
newtype TransitiveDependencies Source #
Constructors
| TransitiveDependencies | |
Fields
| |
Instances
data GhcSessionIO Source #
Constructors
| GhcSessionIO |
Instances
| Eq GhcSessionIO Source # | |
Defined in Development.IDE.Core.RuleTypes | |
| Show GhcSessionIO Source # | |
Defined in Development.IDE.Core.RuleTypes Methods showsPrec :: Int -> GhcSessionIO -> ShowS # show :: GhcSessionIO -> String # showList :: [GhcSessionIO] -> ShowS # | |
| Generic GhcSessionIO Source # | |
Defined in Development.IDE.Core.RuleTypes Associated Types type Rep GhcSessionIO :: Type -> Type # | |
| Hashable GhcSessionIO Source # | |
Defined in Development.IDE.Core.RuleTypes | |
| Binary GhcSessionIO Source # | |
Defined in Development.IDE.Core.RuleTypes | |
| NFData GhcSessionIO Source # | |
Defined in Development.IDE.Core.RuleTypes Methods rnf :: GhcSessionIO -> () # | |
| type Rep GhcSessionIO Source # | |
| type RuleResult GhcSessionIO Source # | |
Defined in Development.IDE.Core.RuleTypes | |
data GetClientSettings Source #
Get the vscode client settings stored in the ide state
Constructors
| GetClientSettings |
Instances
Functions
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.
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.
defineEarlyCutOffNoFile :: IdeRule k v => (k -> Action (ByteString, v)) -> Rules () Source #
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 #
refsAtPoint :: NormalizedFilePath -> Position -> Action [Location] Source #
workspaceSymbols :: Text -> IdeAction (Maybe [SymbolInformation]) 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 haskell file.
getParsedModuleWithComments :: NormalizedFilePath -> Action (Maybe ParsedModule) Source #
Parse the contents of a haskell file, ensuring comments are preserved in annotations
getClientConfigAction Source #
Returns the client configurarion stored in the IdeState. You can use this function to access it from shake Rules
Rules
newtype CompiledLinkables Source #
Tracks which linkables are current, so we don't need to unload them
Constructors
| CompiledLinkables | |
Fields | |
Instances
data IsHiFileStable Source #
Given the path to a module src file, this rule returns True if the corresponding `.hi` file is stable, that is, if it is newer than the src file, and all its dependencies are stable too.
Constructors
| IsHiFileStable |
Instances
getParsedModuleRule :: Rules () Source #
WARNING:
We currently parse the module both with and without Opt_Haddock, and
return the one with Haddocks if it -- succeeds. However, this may not work
for hlint or any client code that might need the parsed source with all
annotations, including comments.
For that use case you might want to use getParsedModuleWithCommentsRule
See https://github.com/haskell/ghcide/pull/350#discussion_r370878197
and https://github.com/mpickering/ghcide/pull/22#issuecomment-625070490
GHC wiki about: https://gitlab.haskell.org/ghc/ghc/-/wikis/api-annotations
getParsedModuleWithCommentsRule :: Rules () Source #
This rule provides a ParsedModule preserving all annotations, including keywords, punctuation and comments. So it is suitable for use cases where you need a perfect edit.
getLocatedImportsRule :: Rules () Source #
reportImportCyclesRule :: Rules () Source #
getDependenciesRule :: Rules () Source #
typeCheckRule :: Rules () Source #
Typechecks a module.
getDocMapRule :: Rules () Source #
loadGhcSession :: Rules () Source #
getModIfaceFromDiskRule :: Rules () Source #
Load a iface from disk, or generate it if there isn't one or it is out of date This rule also ensures that the `.hie` and `.o` (if needed) files are written out.
getModIfaceRule :: Rules () Source #
getModSummaryRule :: Rules () Source #
isHiFileStableRule :: Rules () Source #
getModuleGraphRule :: Rules () Source #
knownFilesRule :: Rules () Source #
getClientSettingsRule :: Rules () Source #
getHieAstsRule :: Rules () Source #
getBindingsRule :: Rules () Source #
needsCompilationRule :: Rules () Source #
generateCoreRule :: Rules () Source #
getImportMapRule :: Rules () Source #
regenerateHiFile :: HscEnvEq -> NormalizedFilePath -> ModSummary -> Maybe LinkableType -> Action ([FileDiagnostic], Maybe HiFileResult) Source #
Also generates and indexes the `.hie` file, along with the `.o` file if needed Invariant maintained is that if the `.hi` file was successfully written, then the `.hie` and `.o` file (if needed) were also successfully written
getParsedModuleDefinition :: HscEnv -> IdeOptions -> NormalizedFilePath -> ModSummary -> IO (Maybe ByteString, ([FileDiagnostic], Maybe ParsedModule)) Source #