Compute the source hash before the preprocessor runs because this is

how GHC does it.

This reduces spurious rebuilds of modules using CPP on GHC 9.4

Author: wz1000

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

@@ -1090,7 +1090,8 @@ getModSummaryFromImports
   -> Maybe Util.StringBuffer
   -> ExceptT [FileDiagnostic] IO ModSummaryResult
 getModSummaryFromImports env fp modTime contents = do
-    (contents, opts, env) <- preprocessor env fp contents
+
+    (contents, opts, env, src_hash) <- preprocessor env fp contents
 
     let dflags = hsc_dflags env
 
@@ -1141,9 +1142,6 @@ getModSummaryFromImports env fp modTime contents = do
     liftIO $ evaluate $ rnf srcImports
     liftIO $ evaluate $ rnf textualImports
 
-#if MIN_VERSION_ghc (9,3,0)
-    !src_hash <- liftIO $ fingerprintFromStringBuffer contents
-#endif
 
     modLoc <- liftIO $ if mod == mAIN_NAME
         -- specially in tests it's common to have lots of nameless modules

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

@@ -36,7 +36,7 @@ import           GHC.Utils.Outputable              (renderWithContext)
 
 -- | Given a file and some contents, apply any necessary preprocessors,
 --   e.g. unlit/cpp. Return the resulting buffer and the DynFlags it implies.
-preprocessor :: HscEnv -> FilePath -> Maybe Util.StringBuffer -> ExceptT [FileDiagnostic] IO (Util.StringBuffer, [String], HscEnv)
+preprocessor :: HscEnv -> FilePath -> Maybe Util.StringBuffer -> ExceptT [FileDiagnostic] IO (Util.StringBuffer, [String], HscEnv, Util.Fingerprint)
 preprocessor env filename mbContents = do
     -- Perform unlit
     (isOnDisk, contents) <-
@@ -48,6 +48,10 @@ preprocessor env filename mbContents = do
             let isOnDisk = isNothing mbContents
             return (isOnDisk, contents)
 
+    -- Compute the source hash before the preprocessor because this is
+    -- how GHC does it.
+    !src_hash <- liftIO $ Util.fingerprintFromStringBuffer contents
+
     -- Perform cpp
     (opts, env) <- ExceptT $ parsePragmasIntoHscEnv env filename contents
     let dflags = hsc_dflags env
@@ -73,11 +77,11 @@ preprocessor env filename mbContents = do
 
     -- Perform preprocessor
     if not $ gopt Opt_Pp dflags then
-        return (contents, opts, env)
+        return (contents, opts, env, src_hash)
     else do
         contents <- liftIO $ runPreprocessor env filename $ if isOnDisk then Nothing else Just contents
         (opts, env) <- ExceptT $ parsePragmasIntoHscEnv env filename contents
-        return (contents, opts, env)
+        return (contents, opts, env, src_hash)
   where
     logAction :: IORef [CPPLog] -> LogActionCompat
     logAction cppLogs dflags _reason severity srcSpan _style msg = do