1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
-- cabal-helper: Simple interface to Cabal's configuration state
-- Copyright (C) 2018 Daniel Gröber <cabal-helper@dxld.at>
--
-- SPDX-License-Identifier: Apache-2.0
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
{-|
Module : CabalHelper.Compiletime.Program.GHC
Description : GHC program interface
License : Apache-2.0
-}
module CabalHelper.Compiletime.Program.GHC where
import Control.Monad
import Control.Monad.Trans.Maybe
import Control.Monad.IO.Class
import Data.Char
import Data.List
import Data.Maybe
import Data.Version
import System.Exit
import System.FilePath
import System.Directory
import CabalHelper.Shared.Common
(parseVer, trim, appCacheDir, parsePkgId)
import CabalHelper.Compiletime.Types
import CabalHelper.Compiletime.Cabal
( ResolvedCabalVersion, showResolvedCabalVersion, UnpackedCabalVersion
, unpackedToResolvedCabalVersion, CabalVersion'(..) )
import CabalHelper.Compiletime.Process
import CabalHelper.Compiletime.Log
data GhcPackageSource
= GPSAmbient
| GPSPackageDBs ![PackageDbDir]
| GPSPackageEnv !PackageEnvFile
data GhcInvocation = GhcInvocation
{ giOutDir :: !FilePath
, giOutput :: !FilePath
, giCPPOptions :: ![String]
, giPackageSource :: !GhcPackageSource
, giIncludeDirs :: ![FilePath]
, giHideAllPackages :: !Bool
, giPackages :: ![String]
, giWarningFlags :: ![String]
, giInputs :: ![String]
}
newtype GhcVersion = GhcVersion { unGhcVersion :: Version }
deriving (Eq, Ord, Read, Show)
showGhcVersion :: GhcVersion -> String
showGhcVersion (GhcVersion v) = showVersion v
ghcVersion :: (Verbose, Progs) => IO GhcVersion
ghcVersion = GhcVersion .
parseVer . trim <$> readProcess' (ghcProgram ?progs) ["--numeric-version"] ""
ghcLibdir :: (Verbose, Progs) => IO FilePath
ghcLibdir = do
trim <$> readProcess' (ghcProgram ?progs) ["--print-libdir"] ""
ghcPkgVersion :: (Verbose, Progs) => IO Version
ghcPkgVersion =
parseVer . trim . dropWhile (not . isDigit)
<$> readProcess' (ghcPkgProgram ?progs) ["--version"] ""
createPkgDb :: (Verbose, Progs) => UnpackedCabalVersion -> IO PackageDbDir
createPkgDb cabalVer = do
db@(PackageDbDir db_path)
<- getPrivateCabalPkgDb $ unpackedToResolvedCabalVersion cabalVer
exists <- doesDirectoryExist db_path
when (not exists) $
callProcessStderr Nothing [] (ghcPkgProgram ?progs) ["init", db_path]
return db
getPrivateCabalPkgDb :: (Verbose, Progs) => ResolvedCabalVersion -> IO PackageDbDir
getPrivateCabalPkgDb cabalVer = do
appdir <- appCacheDir
ghcVer <- ghcVersion
let db_path =
appdir </> "ghc-" ++ showGhcVersion ghcVer ++ ".package-dbs"
</> "Cabal-" ++ showResolvedCabalVersion cabalVer
return $ PackageDbDir db_path
getPrivateCabalPkgEnv
:: Verbose => GhcVersion -> ResolvedCabalVersion -> IO PackageEnvFile
getPrivateCabalPkgEnv ghcVer cabalVer = do
appdir <- appCacheDir
let env_path =
appdir </> "ghc-" ++ showGhcVersion ghcVer ++ ".package-envs"
</> "Cabal-" ++ showResolvedCabalVersion cabalVer ++ ".package-env"
return $ PackageEnvFile env_path
listCabalVersions
:: (Verbose, Progs) => Maybe PackageDbDir -> MaybeT IO [Version]
listCabalVersions mdb = do
let mdb_path = unPackageDbDir <$> mdb
exists <- fromMaybe True <$>
traverse (liftIO . doesDirectoryExist) mdb_path
case exists of
True -> MaybeT $ logIOError "listCabalVersions" $ Just <$> do
let mdbopt = ("--package-conf="++) <$> mdb_path
args = ["list", "--simple-output", "Cabal"] ++ maybeToList mdbopt
catMaybes . map (fmap snd . parsePkgId) . words
<$> readProcess' (ghcPkgProgram ?progs) args ""
_ -> mzero
cabalVersionExistsInPkgDb
:: (Verbose, Progs) => CabalVersion' a -> PackageDbDir -> IO Bool
cabalVersionExistsInPkgDb cabalVer db@(PackageDbDir db_path) = do
fromMaybe False <$> runMaybeT (do
vers <- listCabalVersions (Just db)
return $
case (cabalVer, vers) of
(CabalVersion ver, _) -> ver `elem` vers
(CabalHEAD _, []) -> False
(CabalHEAD _, [_headver]) -> True
(CabalHEAD _, _) ->
error $ msg ++ db_path)
where
msg = "\
\Multiple Cabal versions in a HEAD package-db!\n\
\This shouldn't happen. However you can manually delete the following\n\
\directory to resolve this:\n "
invokeGhc :: Env => GhcInvocation -> IO (Either ExitCode FilePath)
invokeGhc GhcInvocation {..} = do
giOutDirAbs <- makeAbsolute giOutDir
giOutputAbs <- makeAbsolute giOutput
giIncludeDirsAbs <- mapM makeAbsolute giIncludeDirs
giInputsAbs <- mapM makeAbsolute giInputs
-- We unset some interferring envvars here for stack, see:
-- https://github.com/DanielG/cabal-helper/issues/78#issuecomment-557860898
let eos = [("GHC_ENVIRONMENT", EnvUnset), ("GHC_PACKAGE_PATH", EnvUnset)]
rv <- callProcessStderr' (Just "/") eos (ghcProgram ?progs) $ concat
[ [ "-outputdir", giOutDirAbs
, "-o", giOutputAbs
]
, map ("-optP"++) giCPPOptions
, if giHideAllPackages then ["-hide-all-packages"] else []
, let packageFlags = concatMap (\p -> ["-package", p]) giPackages in
case giPackageSource of
GPSAmbient -> packageFlags
GPSPackageDBs dbs -> concat
[ map ("-package-conf="++) $ unPackageDbDir <$> dbs
, packageFlags
]
GPSPackageEnv env -> [ "-package-env=" ++ unPackageEnvFile env ]
, map ("-i"++) $ nub $ "" : giIncludeDirsAbs
, giWarningFlags
, ["--make"]
, giInputsAbs
]
return $
case rv of
ExitSuccess -> Right giOutput
e@(ExitFailure _) -> Left e
|