Support for 9.10

.github/workflows/supported-ghc-versions.json

@@ -1 +1 @@
-[ "9.8", "9.6", "9.4" , "9.2" ]
+["9.10", "9.8", "9.6", "9.4" , "9.2" ]

cabal.project

@@ -7,12 +7,12 @@ packages:
          ./hls-plugin-api
          ./hls-test-utils
 
-index-state: 2024-05-10T00:00:00Z
+index-state: 2024-05-28T06:12:34Z
 
 tests: True
 test-show-details: direct
 
-benchmarks: True
+-- benchmarks: True
 
 write-ghc-environment-files: never
 
@@ -40,4 +40,35 @@ constraints:
   -- the flag '-fopen-simd', which blocked the release 2.2.0.0.
   -- We want to be able to benefit from the performance optimisations
   -- in the future, thus: TODO: remove this flag.
-  bitvec -simd
+  bitvec -simd,
+
+
+if impl(ghc >= 9.9)
+  benchmarks: False
+  source-repository-package
+    type:git
+    location: https://github.com/wz1000/retrie.git
+    tag: 2f089092a563b06eccf196751782f1d70000d589
+  constraints:
+    lens >= 5.3.2,
+    -- See
+    -- https://github.com/haskell/stylish-haskell/issues/479
+    -- https://github.com/fourmolu/fourmolu/issues/412
+    -- https://github.com/ennocramer/floskell/issues/81
+    -- https://github.com/ndmitchell/hlint/pull/1594
+    haskell-language-server -stylishHaskell -fourmolu -floskell -hlint,
+  allow-newer:
+    entropy:base,
+    entropy:directory,
+    entropy:filepath,
+    entropy:process,
+    haddock-library:base,
+    haddock-library:containers,
+    hiedb:base,
+    hiedb:ghc,
+    -- These can be removed when we get a new lsp release
+    quickcheck-instances:base,
+    quickcheck-instances:containers,
+    uuid-types:template-haskell,
+else
+  benchmarks: True

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

@@ -69,14 +69,14 @@
 import           Data.Tuple.Extra                  (dupe)
 import           Data.Unique                       as Unique
 import           Debug.Trace
 import           Development.IDE.Core.FileStore    (resetInterfaceStore)
 import           Development.IDE.Core.Preprocessor
 import           Development.IDE.Core.RuleTypes
 import           Development.IDE.Core.Shake
 import           Development.IDE.Core.Tracing      (withTrace)
 import           Development.IDE.GHC.Compat        hiding (loadInterface,
                                                     parseHeader, parseModule,
-                                                    tcRnModule, writeHieFile)
+                                                    tcRnModule, writeHieFile, assert)
 import qualified Development.IDE.GHC.Compat        as Compat
 import qualified Development.IDE.GHC.Compat        as GHC
 import qualified Development.IDE.GHC.Compat.Util   as Util

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

@@ -129,7 +129,7 @@ progressReporting (Just lspEnv) optProgressStyle = do
                         when (nextPct == prevPct) retry
                         pure (todo, done, nextPct)
 
-                    update (ProgressAmount (Just nextPct) (Just $ T.pack $ show done <> "/" <> show todo))
+                    _ <- update (ProgressAmount (Just nextPct) (Just $ T.pack $ show done <> "/" <> show todo))
                     loop update nextPct
         updateStateForFile inProgress file = actionBracket (f succ) (const $ f pred) . const
             -- This functions are deliberately eta-expanded to avoid space leaks.

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

@@ -16,7 +16,7 @@ module Development.IDE.Core.RuleTypes(
     ) where
 
 import           Control.DeepSeq
-import           Control.Exception                            (assert)
+import qualified Control.Exception                            as E
 import           Control.Lens
 import           Data.Aeson.Types                             (Value)
 import           Data.Hashable
@@ -188,9 +188,9 @@ hiFileFingerPrint HiFileResult{..} = hirIfaceFp <> maybe "" snd hirCoreFp
 
 mkHiFileResult :: ModSummary -> ModIface -> ModDetails -> ModuleEnv ByteString -> Maybe (CoreFile, ByteString) -> HiFileResult
 mkHiFileResult hirModSummary hirModIface hirModDetails hirRuntimeModules hirCoreFp =
-    assert (case hirCoreFp of Just (CoreFile{cf_iface_hash}, _)
-                                -> getModuleHash hirModIface == cf_iface_hash
-                              _ -> True)
+    E.assert (case hirCoreFp of
+                   Just (CoreFile{cf_iface_hash}, _) -> getModuleHash hirModIface == cf_iface_hash
+                   _ -> True)
     HiFileResult{..}
   where
     hirIfaceFp = fingerprintToBS . getModuleHash $ hirModIface -- will always be two bytes

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

@@ -123,7 +123,7 @@
 import           Development.IDE.Core.ProgressReporting
 import           Development.IDE.Core.RuleTypes
 import           Development.IDE.Core.Tracing
 import           Development.IDE.GHC.Compat             (NameCache,
                                                          initNameCache,
                                                          knownKeyNames)
 import           Development.IDE.GHC.Orphans            ()
@@ -658,7 +658,7 @@
           -> IO IdeState
 shakeOpen recorder lspEnv defaultConfig idePlugins debouncer
   shakeProfileDir (IdeReportProgress reportProgress)
-  ideTesting@(IdeTesting testing)
+  ideTesting
   withHieDb indexQueue opts monitoring rules rootDir = mdo
 
 #if MIN_VERSION_ghc(9,3,0)

ghcide/src/Development/IDE/GHC/CPP.hs

@@ -34,6 +34,10 @@ import qualified GHC.Driver.Pipeline.Execute     as Pipeline
 import qualified GHC.SysTools.Cpp                as Pipeline
 #endif
 
+#if MIN_VERSION_ghc(9,11,0)
+import qualified GHC.SysTools.Tasks              as Pipeline
+#endif
+
 addOptP :: String -> DynFlags -> DynFlags
 addOptP f = alterToolSettings $ \s -> s
           { toolSettings_opt_P             = f : toolSettings_opt_P s
@@ -52,7 +56,9 @@ doCpp env input_fn output_fn =
 #if MIN_VERSION_ghc(9,5,0)
     let cpp_opts = Pipeline.CppOpts
                  { cppLinePragmas = True
-#if MIN_VERSION_ghc(9,9,0)
+#if MIN_VERSION_ghc(9,11,0)
+                 , sourceCodePreprocessor = Pipeline.SCPHsCpp
+#elif MIN_VERSION_ghc(9,10,0)
                  , useHsCpp = True
 #else
                  , cppUseCc = False

ghcide/src/Development/IDE/GHC/Compat.hs

@@ -334,7 +334,11 @@ myCoreToStg logger dflags ictxt
 
     return (stg_binds2, denv, cost_centre_info)
 
-
+#if MIN_VERSION_ghc(9,9,0)
+reLocA :: (HasLoc (GenLocated a e), HasAnnotation b)
+      => GenLocated a e -> GenLocated b e
+reLocA = reLoc
+#endif
 
 getDependentMods :: ModIface -> [ModuleName]
 #if MIN_VERSION_ghc(9,3,0)
@@ -510,13 +514,16 @@ data GhcVersion
   | GHC94
   | GHC96
   | GHC98
-  deriving (Eq, Ord, Show)
+  | GHC910
+  deriving (Eq, Ord, Show, Enum)
 
 ghcVersionStr :: String
 ghcVersionStr = VERSION_ghc
 
 ghcVersion :: GhcVersion
-#if MIN_VERSION_GLASGOW_HASKELL(9,8,0,0)
+#if MIN_VERSION_GLASGOW_HASKELL(9,10,0,0)
+ghcVersion = GHC910
+#elif MIN_VERSION_GLASGOW_HASKELL(9,8,0,0)
 ghcVersion = GHC98
 #elif MIN_VERSION_GLASGOW_HASKELL(9,6,0,0)
 ghcVersion = GHC96

ghcide/src/Development/IDE/GHC/Compat/Core.hs

@@ -197,7 +197,9 @@ module Development.IDE.GHC.Compat.Core (
     pattern RealSrcLoc,
     SrcLoc.SrcLoc(SrcLoc.UnhelpfulLoc),
     BufSpan,
+#if !MIN_VERSION_ghc(9,9,0)
     GHC.SrcAnn,
+#endif
     SrcLoc.leftmost_smallest,
     SrcLoc.containsSpan,
     SrcLoc.mkGeneralSrcSpan,
@@ -494,8 +496,11 @@ import           Data.Foldable               (toList)
 import           GHC.Core.Multiplicity       (scaledThing)
 import           GHC.Data.Bag
 import           GHC.Driver.Env
-import           GHC.Hs                      (HsModule (..), SrcSpanAnn')
-import           GHC.Hs.Decls                hiding (FunDep)
+import           GHC.Hs                       (HsModule (..))
+#if !MIN_VERSION_ghc(9,9,0)
+import           GHC.Hs                       (SrcSpanAnn')
+#endif
+import           GHC.Hs.Decls                 hiding (FunDep)
 import           GHC.Hs.Doc
 import           GHC.Hs.Expr
 import           GHC.Hs.Extension
@@ -651,20 +656,36 @@ instance HasSrcSpan SrcSpan where
 instance HasSrcSpan (SrcLoc.GenLocated SrcSpan a) where
   getLoc = GHC.getLoc
 
+#if MIN_VERSION_ghc(9,9,0)
+instance HasSrcSpan (EpAnn a) where
+  getLoc = GHC.getHasLoc
+#endif
+
+#if MIN_VERSION_ghc(9,9,0)
+instance HasSrcSpan (SrcLoc.GenLocated (EpAnn ann) a) where
+  getLoc (L l _) = getLoc l
+#else
 instance HasSrcSpan (SrcSpanAnn' ann) where
   getLoc = GHC.locA
 instance HasSrcSpan (SrcLoc.GenLocated (SrcSpanAnn' ann) a) where
   getLoc (L l _) = l
+#endif
 
 pattern L :: HasSrcSpan a => SrcSpan -> e -> SrcLoc.GenLocated a e
 pattern L l a <- GHC.L (getLoc -> l) a
 {-# COMPLETE L #-}
 
 -- This is from the old api, but it still simplifies
 pattern ConPatIn :: SrcLoc.Located (ConLikeP GhcPs) -> HsConPatDetails GhcPs -> Pat GhcPs
+#if MIN_VERSION_ghc(9,9,0)
+pattern ConPatIn con args <- ConPat _ (L _ (SrcLoc.noLoc -> con)) args
+  where
+    ConPatIn con args = ConPat GHC.noAnn (GHC.noLocA $ SrcLoc.unLoc con) args
+#else
 pattern ConPatIn con args <- ConPat EpAnnNotUsed (L _ (SrcLoc.noLoc -> con)) args
   where
     ConPatIn con args = ConPat EpAnnNotUsed (GHC.noLocA $ SrcLoc.unLoc con) args
+#endif
 
 conPatDetails :: Pat p -> Maybe (HsConPatDetails p)
 conPatDetails (ConPat _ _ args) = Just args
@@ -680,8 +701,16 @@ initObjLinker env =
     GHCi.initObjLinker (GHCi.hscInterp env)
 
 loadDLL :: HscEnv -> String -> IO (Maybe String)
-loadDLL env =
-    GHCi.loadDLL (GHCi.hscInterp env)
+loadDLL env str = do
+    res <- GHCi.loadDLL (GHCi.hscInterp env) str
+#if MIN_VERSION_ghc(9,11,0)
+    pure $
+      case res of
+        Left err_msg -> Just err_msg
+        Right _      -> Nothing
+#else
+    pure res
+#endif
 
 unload :: HscEnv -> [Linkable] -> IO ()
 unload hsc_env linkables =

ghcide/src/Development/IDE/GHC/Orphans.hs

@@ -109,14 +109,19 @@ instance NFData ModSummary where
 instance Ord FastString where
     compare a b = if a == b then EQ else compare (fs_sbs a) (fs_sbs b)
 
+
+#if MIN_VERSION_ghc(9,9,0)
+instance NFData (EpAnn a) where
+  rnf = rwhnf
+#else
 instance NFData (SrcSpanAnn' a) where
     rnf = rwhnf
+deriving instance Functor SrcSpanAnn'
+#endif
 
 instance Bifunctor GenLocated where
     bimap f g (L l x) = L (f l) (g x)
 
-deriving instance Functor SrcSpanAnn'
-
 instance NFData ParsedModule where
     rnf = rwhnf
 

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

@@ -271,7 +271,9 @@ hsConDeclsBinders cons
 
     get_flds_gadt :: HsConDeclGADTDetails GhcPs
                   -> [LFieldOcc GhcPs]
-#if MIN_VERSION_ghc(9,3,0)
+#if MIN_VERSION_ghc(9,9,0)
+    get_flds_gadt (RecConGADT _ flds) = get_flds (reLoc flds)
+#elif MIN_VERSION_ghc(9,3,0)
     get_flds_gadt (RecConGADT flds _) = get_flds (reLoc flds)
 #else
     get_flds_gadt (RecConGADT flds) = get_flds (reLoc flds)

ghcide/src/Development/IDE/Main.hs

@@ -24,7 +24,6 @@ import           Control.Monad.IO.Class                   (liftIO)
 import qualified Data.Aeson                               as J
 import           Data.Coerce                              (coerce)
 import           Data.Default                             (Default (def))
-import           Data.Foldable                            (traverse_)
 import           Data.Hashable                            (hashed)
 import qualified Data.HashMap.Strict                      as HashMap
 import           Data.List.Extra                          (intercalate,

ghcide/test/exe/BootTests.hs

@@ -17,7 +17,6 @@ import           Language.LSP.Protocol.Types     hiding
                                                   mkRange)
 import           Language.LSP.Test
 import           System.FilePath                 ((</>))
-import           Test.Hls.FileSystem             (toAbsFp)
 import           Test.Tasty
 import           Test.Tasty.HUnit
 

ghcide/test/exe/ClientSettingsTests.hs

@@ -1,7 +1,7 @@
 {-# LANGUAGE GADTs #-}
 module ClientSettingsTests (tests) where
 
 import           Config                          (lspTestCaps, testWithConfig)
 import           Control.Applicative.Combinators
 import           Control.Monad
 import           Data.Aeson                      (toJSON)
@@ -16,9 +16,8 @@
                                                   mkRange)
 import           Language.LSP.Test
 import           Test.Hls                        (testConfigCaps,
                                                   waitForProgressDone)
 import           Test.Tasty
-import           TestUtils
 
 tests :: TestTree
 tests = testGroup "client settings handling"

ghcide/test/exe/CodeLensTests.hs

@@ -88,7 +88,11 @@ addSigLensesTests =
         , ("symbolKindTest = Proxy @\"qwq\"", "symbolKindTest :: Proxy \"qwq\"")
         , ("promotedKindTest = Proxy @Nothing", if ghcVersion >= GHC96 then "promotedKindTest :: Proxy Nothing" else "promotedKindTest :: Proxy 'Nothing")
         , ("typeOperatorTest = Refl", "typeOperatorTest :: forall {k} {a :: k}. a :~: a")
-        , ("notInScopeTest = mkCharType", "notInScopeTest :: String -> Data.Data.DataType")
+        , ("notInScopeTest = mkCharType"
+          , if ghcVersion < GHC910
+              then "notInScopeTest :: String -> Data.Data.DataType"
+              else "notInScopeTest :: String -> GHC.Internal.Data.Data.DataType"
+          )
         , ("aVeryLongSignature a b c d e f g h i j k l m n = a && b && c && d && e && f && g && h && i && j && k && l && m && n", "aVeryLongSignature :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool")
         ]
    in testGroup

ghcide/test/exe/CompletionTests.hs

@@ -33,6 +33,7 @@ import           Test.Hls.FileSystem            (file, text)
 import           Test.Hls.Util                  (knownBrokenOnWindows)
 import           Test.Tasty
 import           Test.Tasty.HUnit
+import           TestUtils
 
 
 tests :: TestTree
@@ -217,7 +218,7 @@ localCompletionTests = [
 
 nonLocalCompletionTests :: [TestTree]
 nonLocalCompletionTests =
-  [ brokenForWinGhc $ completionTest
+  [ brokenForWinOldGhc $ completionTest
       "variable"
       ["module A where", "f = hea"]
       (Position 1 7)
@@ -276,6 +277,7 @@ nonLocalCompletionTests =
   ]
   where
     brokenForWinGhc = knownBrokenOnWindows "Windows has strange things in scope for some reason"
+    brokenForWinOldGhc = knownBrokenFor (BrokenSpecific Windows [GHC92 .. GHC98]) "Windows (GHC <= 9.8) has strange things in scope for some reason"
 
 otherCompletionTests :: [TestTree]
 otherCompletionTests = [
@@ -352,7 +354,7 @@ packageCompletionTests =
               , "'GHC.Exts"
               ] ++ (["'GHC.IsList" | ghcVersion >= GHC94]))
 
-  , testSessionEmpty "Map" $ do
+  , testSessionEmptyWithCradle "Map" "cradle: {direct: {arguments: [-hide-all-packages, -package, base, -package, containers, A]}}" $ do
         doc <- createDoc "A.hs" "haskell" $ T.unlines
             [ "{-# OPTIONS_GHC -Wunused-binds #-}",
                 "module A () where",

ghcide/test/exe/Config.hs

@@ -33,7 +33,6 @@ import           Control.Lens.Setter         ((.~))
 import           Data.Foldable               (traverse_)
 import           Data.Function               ((&))
 import qualified Data.Text                   as T
-import           Development.IDE             (Pretty)
 import           Development.IDE.Test        (canonicalizeUri)
 import           Ide.Types                   (defaultPluginDescriptor)
 import qualified Language.LSP.Protocol.Lens  as L
@@ -90,20 +89,12 @@ testWithExtraFiles testName dirName action = testCase testName $ runWithExtraFil
 runInDir :: FilePath -> Session a -> IO a
 runInDir fs = runSessionWithServer def dummyPlugin fs
 
-testSession' :: TestName -> (FilePath -> Session ()) -> TestTree
-testSession' name = testCase name . run'
-
 run :: Session a -> IO a
 run = runSessionWithTestConfig def
     { testDirLocation = Right (mkIdeTestFs [])
     , testPluginDescriptor = dummyPlugin }
     . const
 
-run' :: (FilePath -> Session a) -> IO a
-run' = runSessionWithTestConfig def
-    { testDirLocation = Right (mkIdeTestFs [])
-    , testPluginDescriptor = dummyPlugin }
-
 pattern R :: UInt -> UInt -> UInt -> UInt -> Range
 pattern R x y x' y' = Range (Position x y) (Position x' y')