Safe Haskell	Safe-Inferred
Language	GHC2021

Development.IDE.Core.OfInterest

Description

Utilities and state for the files of interest - those which are currently open in the editor. The rule is IsFileOfInterest

Synopsis

ofInterestRules :: Recorder (WithPriority Log) -> Rules ()
getFilesOfInterest :: IdeState -> IO (HashMap NormalizedFilePath FileOfInterestStatus)
getFilesOfInterestUntracked :: Action (HashMap NormalizedFilePath FileOfInterestStatus)
addFileOfInterest :: IdeState -> NormalizedFilePath -> FileOfInterestStatus -> IO [Key]
deleteFileOfInterest :: IdeState -> NormalizedFilePath -> IO [Key]
setFilesOfInterest :: IdeState -> HashMap NormalizedFilePath FileOfInterestStatus -> IO ()
kick :: Action ()
data FileOfInterestStatus
- = OnDisk
- | Modified {
  - firstOpen :: !Bool
  }
newtype OfInterestVar = OfInterestVar (Var (HashMap NormalizedFilePath FileOfInterestStatus))
scheduleGarbageCollection :: IdeState -> IO ()
data Log = LogShake Log

Documentation

ofInterestRules :: Recorder (WithPriority Log) -> Rules () Source #

The rule that initialises the files of interest state.

getFilesOfInterest :: IdeState -> IO (HashMap NormalizedFilePath FileOfInterestStatus) Source #

getFilesOfInterestUntracked :: Action (HashMap NormalizedFilePath FileOfInterestStatus) Source #

addFileOfInterest :: IdeState -> NormalizedFilePath -> FileOfInterestStatus -> IO [Key] Source #

deleteFileOfInterest :: IdeState -> NormalizedFilePath -> IO [Key] Source #

setFilesOfInterest :: IdeState -> HashMap NormalizedFilePath FileOfInterestStatus -> IO () Source #

Set the files-of-interest - not usually necessary or advisable. The LSP client will keep this information up to date.

kick :: Action () Source #

Typecheck all the files of interest. Could be improved

data FileOfInterestStatus Source #

Constructors

OnDisk
Modified
Fields firstOpen :: !Bool was this file just opened

Instances

Instances details

Generic FileOfInterestStatus Source #
Instance details Defined in Development.IDE.Core.RuleTypes Associated Types type Rep FileOfInterestStatus :: Type -> Type # Methods from :: FileOfInterestStatus -> Rep FileOfInterestStatus x # to :: Rep FileOfInterestStatus x -> FileOfInterestStatus #
Show FileOfInterestStatus Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods showsPrec :: Int -> FileOfInterestStatus -> ShowS # show :: FileOfInterestStatus -> String # showList :: [FileOfInterestStatus] -> ShowS #
NFData FileOfInterestStatus Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods rnf :: FileOfInterestStatus -> () #
Eq FileOfInterestStatus Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods (==) :: FileOfInterestStatus -> FileOfInterestStatus -> Bool # (/=) :: FileOfInterestStatus -> FileOfInterestStatus -> Bool #
Hashable FileOfInterestStatus Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods hashWithSalt :: Int -> FileOfInterestStatus -> Int # hash :: FileOfInterestStatus -> Int #
Pretty FileOfInterestStatus Source #
Instance details Defined in Development.IDE.Core.RuleTypes Methods pretty :: FileOfInterestStatus -> Doc ann # prettyList :: [FileOfInterestStatus] -> Doc ann #
type Rep FileOfInterestStatus Source #
Instance details Defined in Development.IDE.Core.RuleTypes type Rep FileOfInterestStatus = D1 ('MetaData "FileOfInterestStatus" "Development.IDE.Core.RuleTypes" "ghcide-2.9.0.0-5fVLSF6BuTDBEO5GZ0xNyi" 'False) (C1 ('MetaCons "OnDisk" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Modified" 'PrefixI 'True) (S1 ('MetaSel ('Just "firstOpen") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)))

newtype OfInterestVar Source #

Constructors

OfInterestVar (Var (HashMap NormalizedFilePath FileOfInterestStatus))

Instances

Instances details

IsIdeGlobal OfInterestVar Source #
Instance details Defined in Development.IDE.Core.OfInterest

scheduleGarbageCollection :: IdeState -> IO () Source #

data Log Source #

Constructors

LogShake Log

Instances

Instances details

Show Log Source #
Instance details Defined in Development.IDE.Core.OfInterest Methods showsPrec :: Int -> Log -> ShowS # show :: Log -> String # showList :: [Log] -> ShowS #
Pretty Log Source #
Instance details Defined in Development.IDE.Core.OfInterest Methods pretty :: Log -> Doc ann # prettyList :: [Log] -> Doc ann #