Merge branch 'master' into cleanup-main-module

Author: isovector

cabal.project

@@ -24,7 +24,7 @@ package ghcide
 
 write-ghc-environment-files: never
 
-index-state: 2021-02-15T19:11:03Z
+index-state: 2021-02-15T19:02:22Z
 
 allow-newer:
 	active:base,

exe/Wrapper.hs

@@ -4,10 +4,11 @@
 module Main where
 
 import Control.Monad.Extra
+import Data.Default
 import Data.Foldable
 import Data.List
 import Data.Void
-import Development.IDE.Session (findCradle, defaultLoadingOptions)
+import Development.IDE.Session (findCradle)
 import HIE.Bios hiding (findCradle)
 import HIE.Bios.Environment
 import HIE.Bios.Types
@@ -140,7 +141,7 @@ getRuntimeGhcVersion' cradle = do
 -- of the project that may or may not be accurate.
 findLocalCradle :: FilePath -> IO (Cradle Void)
 findLocalCradle fp = do
-  cradleConf <- findCradle defaultLoadingOptions fp
+  cradleConf <- findCradle def fp
   crdl       <- case cradleConf of
     Just yaml -> do
       hPutStrLn stderr $ "Found \"" ++ yaml ++ "\" for \"" ++ fp ++ "\""

ghcide/CHANGELOG.md

@@ -1,5 +1,14 @@
 ### 0.7.5 (2021-02-??)
+* Tone down some logInfos to logDebug (#1385) - Pepe Iborra
+* Show window message when auto extending import lists (#1371) - Potato Hatsue
+* Catch GHC errors in listing module names (#1367) - Potato Hatsue
+* Upgrade to lsp-1.0 (#1284) - wz1000
 * Added Development.IDE.Main (#1338) - Pepe Iborra
+* Fix completion snippets on DuplicateRecordFields (#1360) - Potato Hatsue
+* Add code action for hiding shadowed identifiers from imports (#1322) - Potato Hatsue
+* Make find-definition work better with multi-components (#1357) - wz1000
+* Index files on first open (#1358) - wz1000
+* Fix code actions regression (#1349) - Pepe Iborra
 
 ### 0.7.4 (2021-02-08)
 * Support for references via hiedb (#704) - wz1000

ghcide/bench/config.yaml

@@ -24,15 +24,15 @@ examples:
         - src/Language/LSP/VFS.hs
         - src/Language/LSP/Types/Lens.hs
   # Small but heavily multi-component example
-  - path: bench/example/HLS
-    modules:
-        - hls-plugin-api/src/Ide/Plugin/Config.hs
-        - ghcide/src/Development/IDE/Plugin/CodeAction/ExactPrint.hs
-        # Things get too slow with more than 2 components, hie-bios 0.7.3 will help here
-        # - ghcide/bench/hist/Main.hs
-        # - ghcide/bench/lib/Experiments/Types.hs
-        # - ghcide/test/exe/Main.hs
-        # - exe/Plugins.hs
+  # Disabled as it is far to slow. hie-bios >0.7.2 should help
+  # - path: bench/example/HLS
+  #   modules:
+  #       - hls-plugin-api/src/Ide/Plugin/Config.hs
+  #       - ghcide/src/Development/IDE/Plugin/CodeAction/ExactPrint.hs
+  #       - ghcide/bench/hist/Main.hs
+  #       - ghcide/bench/lib/Experiments/Types.hs
+  #       - ghcide/test/exe/Main.hs
+  #       - exe/Plugins.hs
 
 # The set of experiments to execute
 experiments:

ghcide/exe/Main.hs

@@ -66,7 +66,7 @@ main = do
       DbCmd opts cmd -> do
         dir <- IO.getCurrentDirectory
         dbLoc <- getHieDbLoc dir
-        mlibdir <- setInitialDynFlags
+        mlibdir <- setInitialDynFlags def
         case mlibdir of
           Nothing -> exitWith $ ExitFailure 1
           Just libdir -> runCommand libdir opts{database = dbLoc} cmd
@@ -79,7 +79,7 @@ main = do
                 hPutStrLn stderr "If you are seeing this in a terminal, you probably should have run ghcide WITHOUT the --lsp option!"
               _ -> return ()
 
-          Main.defaultMain Main.defArguments
+          Main.defaultMain def
             {Main.argFiles = case argFilesOrCmd of
                 Typecheck x | not argLSP -> Just x
                 _ -> Nothing

ghcide/ghcide.cabal

@@ -27,11 +27,6 @@ source-repository head
     type:     git
     location: https://github.com/haskell/ghcide.git
 
-flag ghc-lib
-  description: build against ghc-lib instead of the ghc package
-  default: False
-  manual: True
-
 library
     default-language:   Haskell2010
     build-depends:
@@ -62,7 +57,7 @@ library
         lens,
         hiedb == 0.3.0.1,
         lsp-types == 1.1.*,
-        lsp == 1.1.*,
+        lsp == 1.1.1.0,
         mtl,
         network-uri,
         parallel,
@@ -92,19 +87,10 @@ library
         opentelemetry >=0.6.1,
         heapsize ==0.3.*,
         unliftio,
-        unliftio-core
-    if flag(ghc-lib)
-      build-depends:
-        ghc-lib >= 8.8,
-        ghc-lib-parser >= 8.8
-      cpp-options: -DGHC_LIB
-    else
-      build-depends:
+        unliftio-core,
         ghc-boot-th,
         ghc-boot,
         ghc >= 8.6,
-        -- These dependencies are used by Development.IDE.Session and are
-        -- Haskell specific. So don't use them when building with -fghc-lib!
         ghc-check >=0.5.0.1,
         ghc-paths,
         cryptohash-sha1 >=0.11.100 && <0.12,
@@ -141,6 +127,7 @@ library
 
     hs-source-dirs:
         src
+        session-loader
     include-dirs:
         include
     exposed-modules:
@@ -169,6 +156,7 @@ library
         Development.IDE.LSP.LanguageServer
         Development.IDE.LSP.Outline
         Development.IDE.LSP.Server
+        Development.IDE.Session
         Development.IDE.Spans.Common
         Development.IDE.Spans.Documentation
         Development.IDE.Spans.AtPoint
@@ -191,26 +179,14 @@ library
         Development.IDE.Plugin.Test
         Development.IDE.Plugin.TypeLenses
 
-    -- Unfortunately, we cannot use loadSession with ghc-lib since hie-bios uses
-    -- the real GHC library and the types are incompatible. Furthermore, when
-    -- building with ghc-lib we need to make this Haskell agnostic, so no
-    -- hie-bios!
-    -- We also put these modules into a separate hs-source-dirs so we can avoid
-    -- compiling them at all if ghc-lib is not set
-    if !flag(ghc-lib)
-      hs-source-dirs:
-        session-loader
-      exposed-modules:
-        Development.IDE.Session
-      other-modules:
-        Development.IDE.Session.VersionCheck
     other-modules:
         Development.IDE.Core.FileExists
         Development.IDE.GHC.CPP
         Development.IDE.GHC.Warnings
         Development.IDE.LSP.Notifications
         Development.IDE.Plugin.CodeAction.PositionIndexed
         Development.IDE.Plugin.Completions.Logic
+        Development.IDE.Session.VersionCheck
         Development.IDE.Types.Action
     ghc-options: -Wall -Wno-name-shadowing -Wincomplete-uni-patterns -Wno-unticked-promoted-constructors
 
@@ -261,8 +237,6 @@ benchmark benchHist
         yaml
 
 executable ghcide
-    if flag(ghc-lib)
-      buildable: False
     default-language:   Haskell2010
     include-dirs:
         include
@@ -322,8 +296,6 @@ executable ghcide
         ViewPatterns
 
 test-suite ghcide-tests
-    if flag(ghc-lib)
-      buildable: False
     type: exitcode-stdio-1.0
     default-language: Haskell2010
     build-tool-depends:

ghcide/session-loader/Development/IDE/Session.hs

@@ -8,7 +8,6 @@ The logic for setting up a ghcide session by tapping into hie-bios.
 module Development.IDE.Session
   (SessionLoadingOptions(..)
   ,CacheDirs(..)
-  ,defaultLoadingOptions
   ,loadSession
   ,loadSessionWithOptions
   ,setInitialDynFlags
@@ -34,6 +33,7 @@ import qualified Data.Text as T
 import Data.Aeson
 import Data.Bifunctor
 import qualified Data.ByteString.Base16 as B16
+import Data.Default
 import Data.Either.Extra
 import Data.Function
 import Data.Hashable
@@ -98,31 +98,38 @@ data SessionLoadingOptions = SessionLoadingOptions
   --   return the path for storing generated GHC artifacts,
   --   or 'Nothing' to respect the cradle setting
   , getCacheDirs :: String -> [String] -> IO CacheDirs
+  -- | Return the GHC lib dir to use for the 'unsafeGlobalDynFlags'
+  , getInitialGhcLibDir :: IO (Maybe LibDir)
   }
 
-defaultLoadingOptions :: SessionLoadingOptions
-defaultLoadingOptions = SessionLoadingOptions
-    {findCradle = HieBios.findCradle
-    ,loadCradle = HieBios.loadCradle
-    ,getCacheDirs = getCacheDirsDefault
-    }
+instance Default SessionLoadingOptions where
+    def = SessionLoadingOptions
+        {findCradle = HieBios.findCradle
+        ,loadCradle = HieBios.loadCradle
+        ,getCacheDirs = getCacheDirsDefault
+        ,getInitialGhcLibDir = getInitialGhcLibDirDefault
+        }
 
--- | Sets `unsafeGlobalDynFlags` on using the hie-bios cradle and returns the GHC libdir
-setInitialDynFlags :: IO (Maybe LibDir)
-setInitialDynFlags = do
+getInitialGhcLibDirDefault :: IO (Maybe LibDir)
+getInitialGhcLibDirDefault = do
   dir <- IO.getCurrentDirectory
   hieYaml <- runMaybeT $ yamlConfig dir
   cradle <- maybe (loadImplicitHieCradle $ addTrailingPathSeparator dir) HieBios.loadCradle hieYaml
   hPutStrLn stderr $ "setInitialDynFlags cradle: " ++ show cradle
   libDirRes <- getRuntimeGhcLibDir cradle
-  libdir <- case libDirRes of
+  case libDirRes of
       CradleSuccess libdir -> pure $ Just $ LibDir libdir
       CradleFail err -> do
         hPutStrLn stderr $ "Couldn't load cradle for libdir: " ++ show (err,dir,hieYaml,cradle)
         pure Nothing
       CradleNone -> do
         hPutStrLn stderr $ "Couldn't load cradle (CradleNone)"
         pure Nothing
+
+-- | Sets `unsafeGlobalDynFlags` on using the hie-bios cradle and returns the GHC libdir
+setInitialDynFlags :: SessionLoadingOptions -> IO (Maybe LibDir)
+setInitialDynFlags SessionLoadingOptions{..} = do
+  libdir <- getInitialGhcLibDir
   dynFlags <- mapM dynFlagsForPrinting libdir
   mapM_ setUnsafeGlobalDynFlags dynFlags
   pure libdir
@@ -177,7 +184,7 @@ getHieDbLoc dir = do
 -- components mapping to the same hie.yaml file are mapped to the same
 -- HscEnv which is updated as new components are discovered.
 loadSession :: FilePath -> IO (Action IdeGhcSession)
-loadSession = loadSessionWithOptions defaultLoadingOptions
+loadSession = loadSessionWithOptions def
 
 loadSessionWithOptions :: SessionLoadingOptions -> FilePath -> IO (Action IdeGhcSession)
 loadSessionWithOptions SessionLoadingOptions{..} dir = do
@@ -614,7 +621,7 @@ should be filtered out, such that we dont have to re-compile everything.
 -- For the exact reason, see Note [Avoiding bad interface files].
 setCacheDirs :: MonadIO m => Logger -> CacheDirs -> DynFlags -> m DynFlags
 setCacheDirs logger CacheDirs{..} dflags = do
-    liftIO $ logInfo logger $ "Using interface files cache dir: " <> T.pack cacheDir
+    liftIO $ logInfo logger $ "Using interface files cache dir: " <> T.pack (fromMaybe cacheDir hiCacheDir)
     pure $ dflags
           & maybe id setHiDir hiCacheDir
           & maybe id setHieDir hieCacheDir

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

@@ -57,7 +57,11 @@ module Development.IDE.Core.Rules(
     getBindingsRule,
     needsCompilationRule,
     generateCoreRule,
-    getImportMapRule
+    getImportMapRule,
+    regenerateHiFile,
+    ghcSessionDepsDefinition,
+    getParsedModuleDefinition,
+    typeCheckRuleDefinition,
     ) where
 
 import Fingerprint
@@ -633,17 +637,7 @@ getDocMapRule =
       (hscEnv -> hsc, _)        <- useWithStale_ GhcSessionDeps file
       (HAR{refMap=rf}, _)       <- useWithStale_ GetHieAst file
 
--- When possible, rely on the haddocks embedded in our interface files
--- This creates problems on ghc-lib, see comment on 'getDocumentationTryGhc'
-#if !defined(GHC_LIB)
-      let parsedDeps = []
-#else
-      deps <- fromMaybe (TransitiveDependencies [] [] []) <$> use GetDependencies file
-      let tdeps = transitiveModuleDeps deps
-      parsedDeps <- uses_ GetParsedModule tdeps
-#endif
-
-      dkMap <- liftIO $ mkDocMap hsc parsedDeps rf tc
+      dkMap <- liftIO $ mkDocMap hsc rf tc
       return ([],Just dkMap)
 
 -- | Persistent rule to ensure that hover doesn't block on startup
@@ -662,7 +656,7 @@ readHieFileForSrcFromDisk file = do
 readHieFileFromDisk :: FilePath -> ExceptT SomeException IdeAction HieFile
 readHieFileFromDisk hie_loc = do
   nc <- asks ideNc
-  log <- asks $ L.logInfo . logger
+  log <- asks $ L.logDebug . logger
   res <- liftIO $ tryAny $ loadHieFile (mkUpdater nc) hie_loc
   liftIO . log $ either (const $ "FAILED LOADING HIE FILE FOR:" <> T.pack (show hie_loc))
                         (const $ "SUCCEEDED LOADING HIE FILE FOR:" <> T.pack (show hie_loc))
@@ -835,7 +829,7 @@ getModIfaceFromDiskAndIndexRule = defineEarlyCutoff $ \GetModIfaceFromDiskAndInd
         Left err -> fail $ "failed to read .hie file " ++ show hie_loc ++ ": " ++ displayException err
         -- can just re-index the file we read from disk
         Right hf -> liftIO $ do
-          L.logInfo (logger se) $ "Re-indexing hie file for" <> T.pack (show f)
+          L.logDebug (logger se) $ "Re-indexing hie file for" <> T.pack (show f)
           indexHieFile se ms f hash hf
 
   let fp = hiFileFingerPrint x
@@ -921,7 +915,6 @@ generateCoreRule =
 
 getModIfaceRule :: Rules ()
 getModIfaceRule = defineEarlyCutoff $ \GetModIface f -> do
-#if !defined(GHC_LIB)
   fileOfInterest <- use_ IsFileOfInterest f
   res@(_,(_,mhmi)) <- case fileOfInterest of
     IsFOI status -> do
@@ -948,13 +941,6 @@ getModIfaceRule = defineEarlyCutoff $ \GetModIface f -> do
       compiledLinkables <- getCompiledLinkables <$> getIdeGlobalAction
       liftIO $ modifyVar_ compiledLinkables $ \old -> pure $ extendModuleEnv old mod time
   pure res
-#else
-    tm <- use_ TypeCheck f
-    hsc <- hscEnv <$> use_ GhcSessionDeps f
-    (diags, !hiFile) <- liftIO $ compileToObjCodeIfNeeded hsc Nothing (error "can't compile with ghc-lib") tm
-    let fp = hiFileFingerPrint <$> hiFile
-    return (fp, (diags, hiFile))
-#endif
 
 getModIfaceWithoutLinkableRule :: Rules ()
 getModIfaceWithoutLinkableRule = defineEarlyCutoff $ \GetModIfaceWithoutLinkable f -> do