Add ReadOnly to FileOfInterestStatus

Author: nlander

ghcide/src/Development/IDE/Core/OfInterest.hs

@@ -130,19 +130,18 @@ scheduleGarbageCollection state = do
 --   Could be improved
 kick :: Action ()
 kick = do
-    files <- HashMap.keys <$> getFilesOfInterestUntracked
+    filesOfInterestMap <- getFilesOfInterestUntracked
     ShakeExtras{exportsMap, ideTesting = IdeTesting testing, lspEnv, progress} <- getShakeExtras
     let signal :: KnownSymbol s => Proxy s -> Action ()
         signal msg = when testing $ liftIO $
             mRunLspT lspEnv $
                 LSP.sendNotification (LSP.SMethod_CustomMethod msg) $
                 toJSON $ map fromNormalizedFilePath files
-        isProjectFile :: NormalizedFilePath -> Bool
-        isProjectFile file = case getSourceFileOrigin file of
-            FromProject -> True
-            FromDependency -> False
+        files :: [NormalizedFilePath]
+        files = HashMap.keys filesOfInterestMap
         projectFiles :: [NormalizedFilePath]
-        projectFiles = filter isProjectFile files
+        projectFiles = HashMap.keys
+            $ HashMap.filter (/= ReadOnly) filesOfInterestMap
 
     signal (Proxy @"kick/start")
     liftIO $ progressUpdate progress KickStarted

ghcide/src/Development/IDE/Core/RuleTypes.hs

@@ -340,6 +340,7 @@ instance Hashable GetFileExists
 
 data FileOfInterestStatus
   = OnDisk
+  | ReadOnly
   | Modified { firstOpen :: !Bool -- ^ was this file just opened
              }
   deriving (Eq, Show, Typeable, Generic)

ghcide/src/Development/IDE/Core/Rules.hs

@@ -569,19 +569,20 @@ reportImportCyclesRule recorder =
 
 getHieAstsRule :: Recorder (WithPriority Log) -> Rules ()
 getHieAstsRule recorder =
-    define (cmapWithPrio LogShake recorder) $ \GetHieAst f ->
-        case getSourceFileOrigin f of
-            FromProject -> do
-                tmr <- use_ TypeCheck f
-                hsc <- hscEnv <$> use_ GhcSessionDeps f
-                getHieAstRuleDefinition f hsc tmr
-            FromDependency -> do
+    define (cmapWithPrio LogShake recorder) $ \GetHieAst f -> do
+        isFoi <- use_ IsFileOfInterest f
+        case isFoi of
+            IsFOI ReadOnly -> do
                 se <- getShakeExtras
                 mHieFile <- liftIO
                     $ runIdeAction "GetHieAst" se
                     $ runMaybeT
                     $ readHieFileForSrcFromDisk recorder f
                 pure ([], makeHieAstResult <$> mHieFile)
+            _ -> do
+                tmr <- use_ TypeCheck f
+                hsc <- hscEnv <$> use_ GhcSessionDeps f
+                getHieAstRuleDefinition f isFoi hsc tmr
     where
         makeHieAstResult :: Compat.HieFile -> HieAstResult
         makeHieAstResult hieFile =
@@ -604,12 +605,11 @@ persistentHieFileRule recorder = addPersistentRule GetHieAst $ \file -> runMaybe
       del = deltaFromDiff (T.decodeUtf8 $ Compat.hie_hs_src res) currentSource
   pure (HAR (Compat.hie_module res) (Compat.hie_asts res) refmap mempty (HieFromDisk res),del,ver)
 
-getHieAstRuleDefinition :: NormalizedFilePath -> HscEnv -> TcModuleResult -> Action (IdeResult HieAstResult)
-getHieAstRuleDefinition f hsc tmr = do
+getHieAstRuleDefinition :: NormalizedFilePath -> IsFileOfInterestResult -> HscEnv -> TcModuleResult -> Action (IdeResult HieAstResult)
+getHieAstRuleDefinition f isFoi hsc tmr = do
   (diags, masts) <- liftIO $ generateHieAsts hsc tmr
   se <- getShakeExtras
 
-  isFoi <- use_ IsFileOfInterest f
   diagsWrite <- case isFoi of
     IsFOI Modified{firstOpen = False} -> do
       when (coerce $ ideTesting se) $ liftIO $ mRunLspT (lspEnv se) $

ghcide/src/Development/IDE/Core/Shake.hs

@@ -1181,9 +1181,9 @@ defineEarlyCutoff' doDiagnostics cmp key file old mode action = do
                                 pure (Nothing, ([ideErrorText file $ T.pack $ show e | not $ isBadDependency e],Nothing))
                     case getSourceFileOrigin file of
                         FromProject -> doAction
-                        FromDependency -> case eqT @k @GetHieAst of
-                            Just Refl -> doAction
-                            Nothing -> error $
+                        FromDependency -> if isSafeDependencyRule key
+                            then doAction
+                            else error $
                                 "defineEarlyCutoff': Undefined action for dependency source files\n"
                                 ++ show file ++ "\n"
                                 ++ show key
@@ -1229,6 +1229,15 @@ defineEarlyCutoff' doDiagnostics cmp key file old mode action = do
         --  * creating a dependency: If everything depends on GetModificationTime, we lose early cutoff
         --  * creating bogus "file does not exists" diagnostics
         | otherwise = useWithoutDependency (GetModificationTime_ False) fp
+    isSafeDependencyRule
+        :: forall k v
+         . IdeRule k v
+        => k
+        -> Bool
+    isSafeDependencyRule _k
+        | Just Refl <- eqT @k @GetHieAst = True
+        | Just Refl <- eqT @k @IsFileOfInterest = True
+        | otherwise = False
 
 traceA :: A v -> String
 traceA (A Failed{})    = "Failed"

ghcide/src/Development/IDE/LSP/Notifications.hs

@@ -61,10 +61,14 @@ descriptor recorder plId = (defaultPluginDescriptor plId) { pluginNotificationHa
       \ide vfs _ (DidOpenTextDocumentParams TextDocumentItem{_uri,_version}) -> liftIO $ do
       atomically $ updatePositionMapping ide (VersionedTextDocumentIdentifier _uri _version) []
       whenUriFile _uri $ \file -> do
+          let foiStatus = case getSourceFileOrigin file of
+                  FromProject -> Modified{firstOpen=True}
+                  FromDependency -> ReadOnly
           -- We don't know if the file actually exists, or if the contents match those on disk
           -- For example, vscode restores previously unsaved contents on open
-          addFileOfInterest ide file Modified{firstOpen=True}
-          setFileModified (cmapWithPrio LogFileStore recorder) (VFSModified vfs) ide False file
+          addFileOfInterest ide file foiStatus
+          unless (foiStatus == ReadOnly)
+              $ setFileModified (cmapWithPrio LogFileStore recorder) (VFSModified vfs) ide False file
           logDebug (ideLogger ide) $ "Opened text document: " <> getUri _uri
 
   , mkPluginNotificationHandler LSP.SMethod_TextDocumentDidChange $