Store hie files

Cabal/src/Distribution/Simple/GHC.hs

@@ -107,6 +107,7 @@ import Distribution.Simple.Program.GHC
 import qualified Distribution.Simple.Program.HcPkg as HcPkg
 import qualified Distribution.Simple.Program.Ld as Ld
 import qualified Distribution.Simple.Program.Strip as Strip
+import Distribution.Simple.Setup.Common (extraCompilationArtifacts)
 import Distribution.Simple.Setup.Config
 import Distribution.Simple.Setup.Repl
 import Distribution.Simple.Utils
@@ -2478,7 +2479,7 @@ installLib verbosity lbi targetDir dynlibTargetDir _builtDir pkg lib clbi = do
   whenShared $ copyModuleFiles "dyn_hi"
 
   -- copy extra compilation artifacts that ghc plugins may produce
-  copyDirectoryIfExists "extra-compilation-artifacts"
+  copyDirectoryIfExists extraCompilationArtifacts
 
   -- copy the built library files over:
   whenHasCode $ do

Cabal/src/Distribution/Simple/GHC/ImplInfo.hs

@@ -52,6 +52,8 @@ data GhcImplInfo = GhcImplInfo
   -- ^ use package-conf instead of package-db
   , flagDebugInfo :: Bool
   -- ^ -g flag supported
+  , flagHie :: Bool
+  -- ^ -hiedir flag supported
   , supportsDebugLevels :: Bool
   -- ^ supports numeric @-g@ levels
   , supportsPkgEnvFiles :: Bool
@@ -93,6 +95,7 @@ ghcVersionImplInfo ver =
     , flagProfLate = v >= [9, 4]
     , flagPackageConf = v < [7, 5]
     , flagDebugInfo = v >= [7, 10]
+    , flagHie = v >= [8, 8]
     , supportsDebugLevels = v >= [8, 0]
     , supportsPkgEnvFiles = v >= [8, 0, 1, 20160901] -- broken in 8.0.1, fixed in 8.0.2
     , flagWarnMissingHomeModules = v >= [8, 2]
@@ -118,6 +121,7 @@ ghcjsVersionImplInfo _ghcjsver ghcver =
     , flagProfLate = True
     , flagPackageConf = False
     , flagDebugInfo = False
+    , flagHie = ghcv >= [8, 8]
     , supportsDebugLevels = ghcv >= [8, 0]
     , supportsPkgEnvFiles = ghcv >= [8, 0, 2] -- TODO: check this works in ghcjs
     , flagWarnMissingHomeModules = ghcv >= [8, 2]

Cabal/src/Distribution/Simple/GHC/Internal.hs

@@ -61,11 +61,12 @@ import Distribution.Parsec (simpleParsec)
 import Distribution.Pretty (prettyShow)
 import Distribution.Simple.BuildPaths
 import Distribution.Simple.Compiler
-import Distribution.Simple.Flag (Flag, maybeToFlag, toFlag)
+import Distribution.Simple.Flag (Flag (NoFlag), maybeToFlag, toFlag)
 import Distribution.Simple.GHC.ImplInfo
 import Distribution.Simple.LocalBuildInfo
 import Distribution.Simple.Program
 import Distribution.Simple.Program.GHC
+import Distribution.Simple.Setup.Common (extraCompilationArtifacts)
 import Distribution.Simple.Utils
 import Distribution.System
 import Distribution.Types.ComponentLocalBuildInfo
@@ -78,6 +79,7 @@ import Distribution.Verbosity
 import Distribution.Version (Version)
 import Language.Haskell.Extension
 
+import Data.Bool (bool)
 import qualified Data.ByteString.Lazy.Char8 as BS
 import qualified Data.Map as Map
 import qualified Data.Set as Set
@@ -576,6 +578,7 @@ componentGhcOptions verbosity implInfo lbi bi clbi odir =
     , ghcOptFfiIncludes = toNubListR $ includes bi
     , ghcOptObjDir = toFlag odir
     , ghcOptHiDir = toFlag odir
+    , ghcOptHieDir = bool NoFlag (toFlag $ odir </> extraCompilationArtifacts) $ flagHie implInfo
     , ghcOptStubDir = toFlag odir
     , ghcOptOutputDir = toFlag odir
     , ghcOptOptimisation = toGhcOptimisation (withOptimization lbi)

Cabal/src/Distribution/Simple/Program/GHC.hs

@@ -532,6 +532,7 @@ data GhcOptions = GhcOptions
   , ghcOptDynObjSuffix :: Flag String
   -- ^ only in 'GhcStaticAndDynamic' mode
   , ghcOptHiDir :: Flag FilePath
+  , ghcOptHieDir :: Flag FilePath
   , ghcOptObjDir :: Flag FilePath
   , ghcOptOutputDir :: Flag FilePath
   , ghcOptStubDir :: Flag FilePath
@@ -716,6 +717,7 @@ renderGhcOptions comp _platform@(Platform _arch os) opts
         , concat [["-outputdir", dir] | dir <- flag ghcOptOutputDir]
         , concat [["-odir", dir] | dir <- flag ghcOptObjDir]
         , concat [["-hidir", dir] | dir <- flag ghcOptHiDir]
+        , concat [["-hiedir", dir] | dir <- flag ghcOptHieDir]
         , concat [["-stubdir", dir] | dir <- flag ghcOptStubDir]
         , -----------------------
           -- Source search path

Cabal/src/Distribution/Simple/Setup/Common.hs

@@ -29,6 +29,7 @@ module Distribution.Simple.Setup.Common
   , splitArgs
   , testOrBenchmarkHelpText
   , defaultDistPref
+  , extraCompilationArtifacts
   , optionDistPref
   , Flag (..)
   , toFlag
@@ -63,6 +64,11 @@ import Distribution.Verbosity
 defaultDistPref :: FilePath
 defaultDistPref = "dist"
 
+-- | The name of the directory where optional compilation artifacts
+-- go, such as ghc plugins and .hie files.
+extraCompilationArtifacts :: FilePath
+extraCompilationArtifacts = "extra-compilation-artifacts"
+
 -- | Help text for @test@ and @bench@ commands.
 testOrBenchmarkHelpText
   :: String

cabal-testsuite/PackageTests/CopyHie/HieLocal.hs

@@ -0,0 +1,2 @@
+module HieLocal where
+hieLocal = "INSTALL ME"

cabal-testsuite/PackageTests/CopyHie/cabal.out

@@ -0,0 +1,15 @@
+# cabal v2-update
+Downloading the latest package list from test-local-repo
+# cabal v2-build
+Resolving dependencies...
+Build profile: -w ghc-<GHCVER> -O1
+In order, the following will be built:
+ - hie-dependency-0.1.0.0 (lib) (requires build)
+ - hie-0.1.0.0 (lib) (first run)
+Configuring library for hie-dependency-0.1.0.0...
+Preprocessing library for hie-dependency-0.1.0.0...
+Building library for hie-dependency-0.1.0.0...
+Installing library in <PATH>
+Configuring library for hie-0.1.0.0...
+Preprocessing library for hie-0.1.0.0...
+Building library for hie-0.1.0.0...

cabal-testsuite/PackageTests/CopyHie/cabal.project

@@ -0,0 +1,3 @@
+packages: hie .
+package hie-dependency
+  ghc-options: -fwrite-ide-info

cabal-testsuite/PackageTests/CopyHie/cabal.test.hs

@@ -0,0 +1,8 @@
+import Test.Cabal.Prelude
+
+main = withShorterPathForNewBuildStore $ \storeDir -> cabalTest $ withRepo "repo" $ do
+  skipUnlessGhcVersion ">= 8.8"
+  cabalG ["--store-dir=" ++ storeDir] "v2-build" ["hie"]
+  liftIO $ do
+    installedDependencyLibDir <- findDependencyInStore storeDir "hie-dependency"
+    shouldExist $ installedDependencyLibDir </> "lib" </> "extra-compilation-artifacts" </> "HieDependency.hie"

cabal-testsuite/PackageTests/CopyHie/hie-local.cabal

@@ -0,0 +1,13 @@
+name:                hie-local
+version:             0.1.0.0
+license:             BSD3
+author:              Elodie Lander
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.10
+
+library
+  exposed-modules:     HieLocal
+  build-depends:       base
+  default-language:    Haskell2010
+  ghc-options:         -fwrite-ide-info

cabal-testsuite/PackageTests/CopyHie/hie/Hie.hs

@@ -0,0 +1,3 @@
+module Hie where
+import HieDependency (hieDependency)
+hie = hieDependency

cabal-testsuite/PackageTests/CopyHie/hie/hie.cabal

@@ -0,0 +1,13 @@
+name:                hie
+version:             0.1.0.0
+license:             BSD3
+author:              Elodie Lander
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.10
+
+library
+  exposed-modules:     Hie
+  build-depends:       base
+                     , hie-dependency
+  default-language:    Haskell2010

cabal-testsuite/PackageTests/CopyHie/repo/hie-dependency-0.1.0.0/HieDependency.hs

@@ -0,0 +1,2 @@
+module HieDependency where
+hieDependency = "INSTALL ME"

cabal-testsuite/PackageTests/CopyHie/repo/hie-dependency-0.1.0.0/hie-dependency.cabal

@@ -0,0 +1,12 @@
+name:                hie-dependency
+version:             0.1.0.0
+license:             BSD3
+author:              Elodie Lander
+maintainer:          [email protected]
+build-type:          Simple
+cabal-version:       >=1.10
+
+library
+  exposed-modules:     HieDependency
+  build-depends:       base
+  default-language:    Haskell2010

cabal-testsuite/PackageTests/CopyHie/setup.cabal.out

@@ -0,0 +1,9 @@
+# Setup configure
+Configuring library for hie-local-0.1.0.0...
+# Setup build
+Preprocessing library for hie-local-0.1.0.0...
+Building library for hie-local-0.1.0.0...
+# Setup copy
+Installing library in <PATH>
+# Setup register
+Registering library for hie-local-0.1.0.0...

cabal-testsuite/PackageTests/CopyHie/setup.out

@@ -0,0 +1,9 @@
+# Setup configure
+Configuring library for hie-local-0.1.0.0...
+# Setup build
+Preprocessing library for hie-local-0.1.0.0...
+Building library for hie-local-0.1.0.0...
+# Setup copy
+Installing library in <PATH>
+# Setup register
+Registering library for hie-local-0.1.0.0...

cabal-testsuite/PackageTests/CopyHie/setup.test.hs

@@ -0,0 +1,7 @@
+import Test.Cabal.Prelude
+
+main = setupAndCabalTest $ withPackageDb $ do
+  skipUnlessGhcVersion ">= 8.8"
+  setup_install ["hie-local"]
+  env <- getTestEnv
+  shouldExist $ testLibInstallDir env </> "hie-local-0.1.0.0" </> "extra-compilation-artifacts" </> "HieLocal.hie"