Safe Haskell	None
Language	Haskell2010

Development.IDE.Core.FileStore

Synopsis

getFileContents :: NormalizedFilePath -> Action (UTCTime, Maybe Text)
getVirtualFile :: VFSHandle -> NormalizedUri -> IO (Maybe VirtualFile)
setFileModified :: IdeState -> Bool -> NormalizedFilePath -> IO ()
setSomethingModified :: IdeState -> IO ()
fileStoreRules :: VFSHandle -> (NormalizedFilePath -> Action Bool) -> Rules ()
modificationTime :: FileVersion -> Maybe UTCTime
typecheckParents :: IdeState -> NormalizedFilePath -> IO ()
data VFSHandle
makeVFSHandle :: IO VFSHandle
makeLSPVFSHandle :: LanguageContextEnv c -> VFSHandle
isFileOfInterestRule :: Rules ()
resetFileStore :: IdeState -> [FileEvent] -> IO ()
resetInterfaceStore :: ShakeExtras -> NormalizedFilePath -> IO ()
getModificationTimeImpl :: VFSHandle -> (NormalizedFilePath -> Action Bool) -> Bool -> NormalizedFilePath -> Action (Maybe ByteString, ([FileDiagnostic], Maybe FileVersion))
addIdeGlobal :: IsIdeGlobal a => a -> Rules ()
getFileContentsImpl :: VFSHandle -> NormalizedFilePath -> Action ([FileDiagnostic], Maybe (FileVersion, Maybe Text))

Documentation

getFileContents :: NormalizedFilePath -> Action (UTCTime, Maybe Text) Source #

Returns the modification time and the contents. For VFS paths, the modification time is the current time.

getVirtualFile :: VFSHandle -> NormalizedUri -> IO (Maybe VirtualFile) Source #

get the contents of a virtual file

setFileModified Source #

Arguments

:: IdeState
-> Bool	Was the file saved?
-> NormalizedFilePath
-> IO ()

Note that some buffer for a specific file has been modified but not with what changes.

setSomethingModified :: IdeState -> IO () Source #

Note that some buffer somewhere has been modified, but don't say what. Only valid if the virtual file system was initialised by LSP, as that independently tracks which files are modified.

fileStoreRules :: VFSHandle -> (NormalizedFilePath -> Action Bool) -> Rules () Source #

modificationTime :: FileVersion -> Maybe UTCTime Source #

typecheckParents :: IdeState -> NormalizedFilePath -> IO () Source #

data VFSHandle Source #

haskell-lsp manages the VFS internally and automatically so we cannot use the builtin VFS without spawning up an LSP server. To be able to test things like setBufferModified we abstract over the VFS implementation.

Instances

Instances details

IsIdeGlobal VFSHandle Source #
Instance details Defined in Development.IDE.Core.Shake

makeVFSHandle :: IO VFSHandle Source #

makeLSPVFSHandle :: LanguageContextEnv c -> VFSHandle Source #

isFileOfInterestRule :: Rules () Source #

resetFileStore :: IdeState -> [FileEvent] -> IO () Source #

Reset the GetModificationTime state of watched files

resetInterfaceStore :: ShakeExtras -> NormalizedFilePath -> IO () Source #

Reset the GetModificationTime state of interface files

getModificationTimeImpl :: VFSHandle -> (NormalizedFilePath -> Action Bool) -> Bool -> NormalizedFilePath -> Action (Maybe ByteString, ([FileDiagnostic], Maybe FileVersion)) Source #

addIdeGlobal :: IsIdeGlobal a => a -> Rules () Source #

getFileContentsImpl :: VFSHandle -> NormalizedFilePath -> Action ([FileDiagnostic], Maybe (FileVersion, Maybe Text)) Source #