| 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 {}
- 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
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
data TransitiveDependencies Source #
Constructors
| TransitiveDependencies | |
Fields
| |
Instances
data GhcSessionIO Source #
Constructors
| GhcSessionIO |
Instances
| Eq GhcSessionIO Source # | |
Defined in Development.IDE.Core.Rules | |
| Show GhcSessionIO Source # | |
Defined in Development.IDE.Core.Rules Methods showsPrec :: Int -> GhcSessionIO -> ShowS # show :: GhcSessionIO -> String # showList :: [GhcSessionIO] -> ShowS # | |
| Generic GhcSessionIO Source # | |
Defined in Development.IDE.Core.Rules Associated Types type Rep GhcSessionIO :: Type -> Type # | |
| Hashable GhcSessionIO Source # | |
Defined in Development.IDE.Core.Rules | |
| Binary GhcSessionIO Source # | |
Defined in Development.IDE.Core.Rules | |
| NFData GhcSessionIO Source # | |
Defined in Development.IDE.Core.Rules Methods rnf :: GhcSessionIO -> () # | |
| type Rep GhcSessionIO Source # | |
| type RuleResult GhcSessionIO Source # | |
Defined in Development.IDE.Core.Rules | |
data GetClientSettings Source #
Get the vscode client settings stored in the ide state
Constructors
| GetClientSettings |
Instances
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 #
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.