{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE ConstraintKinds #-}
module Stack.Ghci
( GhciOpts(..)
, GhciPkgInfo(..)
, GhciException(..)
, ghci
) where
import Stack.Prelude hiding (Display (..))
import Control.Monad.State.Strict (State, execState, get, modify)
import qualified Data.ByteString.Char8 as S8
import qualified Data.ByteString.Lazy as LBS
import Data.List
import qualified Data.Map.Strict as M
import qualified Data.Set as S
import qualified Data.Text as T
import qualified Data.Text.Lazy as TL
import qualified Data.Text.Lazy.Encoding as TLE
import qualified Distribution.PackageDescription as C
import Path
import Path.Extra (toFilePathNoTrailingSep)
import Path.IO hiding (withSystemTempDir)
import qualified RIO
import RIO.Process (HasProcessContext, exec, proc, readProcess_)
import Stack.Build
import Stack.Build.Installed
import Stack.Build.Source
import Stack.Build.Target
import Stack.Config (getLocalPackages)
import Stack.Constants.Config
import Stack.Ghci.Script
import Stack.Package
import Stack.PrettyPrint
import Stack.Types.Build
import Stack.Types.Compiler
import Stack.Types.Config
import Stack.Types.FlagName
import Stack.Types.NamedComponent
import Stack.Types.Package
import Stack.Types.PackageIdentifier
import Stack.Types.PackageName
import Stack.Types.Runner
import System.IO (putStrLn, putStr, getLine)
import System.IO.Temp (getCanonicalTemporaryDirectory)
#ifndef WINDOWS
import qualified System.Posix.Files as Posix
#endif
data GhciOpts = GhciOpts
{ ghciTargets :: ![Text]
, ghciArgs :: ![String]
, ghciGhcOptions :: ![Text]
, ghciFlags :: !(Map (Maybe PackageName) (Map FlagName Bool))
, ghciGhcCommand :: !(Maybe FilePath)
, ghciNoLoadModules :: !Bool
, ghciAdditionalPackages :: ![String]
, ghciMainIs :: !(Maybe Text)
, ghciLoadLocalDeps :: !Bool
, ghciSkipIntermediate :: !Bool
, ghciHidePackages :: !(Maybe Bool)
, ghciNoBuild :: !Bool
, ghciOnlyMain :: !Bool
} deriving Show
data GhciPkgInfo = GhciPkgInfo
{ ghciPkgName :: !PackageName
, ghciPkgOpts :: ![(NamedComponent, BuildInfoOpts)]
, ghciPkgDir :: !(Path Abs Dir)
, ghciPkgModules :: !ModuleMap
, ghciPkgCFiles :: !(Set (Path Abs File))
, ghciPkgMainIs :: !(Map NamedComponent (Set (Path Abs File)))
, ghciPkgTargetFiles :: !(Maybe (Set (Path Abs File)))
, ghciPkgPackage :: !Package
} deriving Show
type ModuleMap = Map ModuleName (Map (Path Abs File) (Set (PackageName, NamedComponent)))
unionModuleMaps :: [ModuleMap] -> ModuleMap
unionModuleMaps = M.unionsWith (M.unionWith S.union)
data GhciException
= InvalidPackageOption String
| LoadingDuplicateModules
| MissingFileTarget String
| Can'tSpecifyFilesAndTargets
| Can'tSpecifyFilesAndMainIs
| GhciTargetParseException [Text]
deriving (Typeable)
instance Exception GhciException
instance Show GhciException where
show (InvalidPackageOption name) =
"Failed to parse --package option " ++ name
show LoadingDuplicateModules = unlines
[ "Not attempting to start ghci due to these duplicate modules."
, "Use --no-load to try to start it anyway, without loading any modules (but these are still likely to cause errors)"
]
show (MissingFileTarget name) =
"Cannot find file target " ++ name
show Can'tSpecifyFilesAndTargets =
"Cannot use 'stack ghci' with both file targets and package targets"
show Can'tSpecifyFilesAndMainIs =
"Cannot use 'stack ghci' with both file targets and --main-is flag"
show (GhciTargetParseException xs) =
show (TargetParseException xs) ++
"\nNote that to specify options to be passed to GHCi, use the --ghci-options flag"
ghci :: HasEnvConfig env => GhciOpts -> RIO env ()
ghci opts@GhciOpts{..} = do
let buildOptsCLI = defaultBuildOptsCLI
{ boptsCLITargets = []
, boptsCLIFlags = ghciFlags
}
(locals, sourceMap) <- loadSourceMap AllowNoTargets buildOptsCLI
mainIsTargets <- parseMainIsTargets buildOptsCLI ghciMainIs
etargets <- preprocessTargets buildOptsCLI ghciTargets
(inputTargets, mfileTargets) <- case etargets of
Right packageTargets -> return (packageTargets, Nothing)
Left rawFileTargets -> do
case mainIsTargets of
Nothing -> return ()
Just _ -> throwM Can'tSpecifyFilesAndMainIs
(targetMap, fileInfo, extraFiles) <- findFileTargets locals rawFileTargets
return (targetMap, Just (fileInfo, extraFiles))
localTargets <- getAllLocalTargets opts inputTargets mainIsTargets sourceMap
nonLocalTargets <- getAllNonLocalTargets inputTargets
addPkgs <- checkAdditionalPackages ghciAdditionalPackages
stackYaml <- view stackYamlL
buildDepsAndInitialSteps opts (map (packageNameText . fst) localTargets)
targetWarnings stackYaml localTargets nonLocalTargets mfileTargets
pkgs <- getGhciPkgInfos buildOptsCLI sourceMap addPkgs (fmap fst mfileTargets) localTargets
checkForIssues pkgs
runGhci opts localTargets mainIsTargets pkgs (maybe [] snd mfileTargets) (nonLocalTargets ++ addPkgs)
preprocessTargets :: HasEnvConfig env => BuildOptsCLI -> [Text] -> RIO env (Either [Path Abs File] (Map PackageName Target))
preprocessTargets buildOptsCLI rawTargets = do
let (fileTargetsRaw, normalTargetsRaw) =
partition (\t -> ".hs" `T.isSuffixOf` t || ".lhs" `T.isSuffixOf` t)
rawTargets
if not (null fileTargetsRaw) && null normalTargetsRaw
then do
fileTargets <- forM fileTargetsRaw $ \fp0 -> do
let fp = T.unpack fp0
mpath <- liftIO $ forgivingAbsence (resolveFile' fp)
case mpath of
Nothing -> throwM (MissingFileTarget fp)
Just path -> return path
return (Left fileTargets)
else do
(_,_,normalTargets) <- parseTargets AllowNoTargets buildOptsCLI { boptsCLITargets = normalTargetsRaw }
`catch` \ex -> case ex of
TargetParseException xs -> throwM (GhciTargetParseException xs)
_ -> throwM ex
unless (null fileTargetsRaw) $ throwM Can'tSpecifyFilesAndTargets
return (Right normalTargets)
parseMainIsTargets :: HasEnvConfig env => BuildOptsCLI -> Maybe Text -> RIO env (Maybe (Map PackageName Target))
parseMainIsTargets buildOptsCLI mtarget = forM mtarget $ \target -> do
(_,_,targets) <- parseTargets AllowNoTargets buildOptsCLI
{ boptsCLITargets = [target] }
return targets
findFileTargets
:: HasEnvConfig env
=> [LocalPackage]
-> [Path Abs File]
-> RIO env (Map PackageName Target, Map PackageName (Set (Path Abs File)), [Path Abs File])
findFileTargets locals fileTargets = do
filePackages <- forM locals $ \lp -> do
(_,compFiles,_,_) <- getPackageFiles (packageFiles (lpPackage lp)) (lpCabalFile lp)
return (lp, M.map (S.map dotCabalGetPath) compFiles)
let foundFileTargetComponents :: [(Path Abs File, [(PackageName, NamedComponent)])]
foundFileTargetComponents =
map (\fp -> (fp, ) $ sort $
concatMap (\(lp, files) -> map ((packageName (lpPackage lp), ) . fst)
(filter (S.member fp . snd) (M.toList files))
) filePackages
) fileTargets
results <- forM foundFileTargetComponents $ \(fp, xs) ->
case xs of
[] -> do
prettyWarn $ vsep
[ "Couldn't find a component for file target" <+>
display fp <>
". This means that the correct ghc options might not be used."
, "Attempting to load the file anyway."
]
return $ Left fp
[x] -> do
prettyInfo $
"Using configuration for" <+> display x <+>
"to load" <+> display fp
return $ Right (fp, x)
(x:_) -> do
prettyWarn $
"Multiple components contain file target" <+>
display fp <> ":" <+>
mconcat (intersperse ", " (map display xs)) <> line <>
"Guessing the first one," <+> display x <> "."
return $ Right (fp, x)
let (extraFiles, associatedFiles) = partitionEithers results
targetMap =
foldl unionTargets M.empty $
map (\(_, (name, comp)) -> M.singleton name (TargetComps (S.singleton comp)))
associatedFiles
infoMap =
foldl (M.unionWith S.union) M.empty $
map (\(fp, (name, _)) -> M.singleton name (S.singleton fp))
associatedFiles
return (targetMap, infoMap, extraFiles)
getAllLocalTargets
:: HasEnvConfig env
=> GhciOpts
-> Map PackageName Target
-> Maybe (Map PackageName Target)
-> SourceMap
-> RIO env [(PackageName, (Path Abs File, Target))]
getAllLocalTargets GhciOpts{..} targets0 mainIsTargets sourceMap = do
let targets = maybe targets0 (unionTargets targets0) mainIsTargets
packages <- lpProject <$> getLocalPackages
directlyWanted <-
forMaybeM (M.toList packages) $
\(name, lpv) ->
case M.lookup name targets of
Just simpleTargets -> return (Just (name, (lpvCabalFP lpv, simpleTargets)))
Nothing -> return Nothing
let extraLoadDeps = getExtraLoadDeps ghciLoadLocalDeps sourceMap directlyWanted
if (ghciSkipIntermediate && not ghciLoadLocalDeps) || null extraLoadDeps
then return directlyWanted
else do
let extraList =
mconcat $ intersperse ", " (map (RIO.display . fst) extraLoadDeps)
if ghciLoadLocalDeps
then logInfo $
"The following libraries will also be loaded into GHCi because " <>
"they are local dependencies of your targets, and you specified --load-local-deps:\n " <>
extraList
else logInfo $
"The following libraries will also be loaded into GHCi because " <>
"they are intermediate dependencies of your targets:\n " <>
extraList <>
"\n(Use --skip-intermediate-deps to omit these)"
return (directlyWanted ++ extraLoadDeps)
getAllNonLocalTargets
:: Map PackageName Target
-> RIO env [PackageName]
getAllNonLocalTargets targets = do
let isNonLocal (TargetAll Dependency) = True
isNonLocal _ = False
return $ map fst $ filter (isNonLocal . snd) (M.toList targets)
buildDepsAndInitialSteps :: HasEnvConfig env => GhciOpts -> [Text] -> RIO env ()
buildDepsAndInitialSteps GhciOpts{..} targets0 = do
let targets = targets0 ++ map T.pack ghciAdditionalPackages
when (not ghciNoBuild && not (null targets)) $ do
eres <- tryAny $ build (const (return ())) Nothing defaultBuildOptsCLI
{ boptsCLITargets = targets
, boptsCLIInitialBuildSteps = True
, boptsCLIFlags = ghciFlags
, boptsCLIGhcOptions = ghciGhcOptions
}
case eres of
Right () -> return ()
Left err -> do
prettyError $ fromString (show err)
prettyWarn "Build failed, but trying to launch GHCi anyway"
checkAdditionalPackages :: MonadThrow m => [String] -> m [PackageName]
checkAdditionalPackages pkgs = forM pkgs $ \name -> do
let mres = (packageIdentifierName <$> parsePackageIdentifierFromString name)
<|> parsePackageNameFromString name
maybe (throwM $ InvalidPackageOption name) return mres
runGhci
:: HasEnvConfig env
=> GhciOpts
-> [(PackageName, (Path Abs File, Target))]
-> Maybe (Map PackageName Target)
-> [GhciPkgInfo]
-> [Path Abs File]
-> [PackageName]
-> RIO env ()
runGhci GhciOpts{..} targets mainIsTargets pkgs extraFiles exposePackages = do
config <- view configL
wc <- view $ actualCompilerVersionL.whichCompilerL
let pkgopts = hidePkgOpts ++ genOpts ++ ghcOpts
shouldHidePackages =
fromMaybe (not (null pkgs && null exposePackages)) ghciHidePackages
hidePkgOpts =
if shouldHidePackages
then
["-hide-all-packages"] ++
(if null targets then ["-package", "base"] else []) ++
concatMap (\n -> ["-package", packageNameString n]) exposePackages
else []
oneWordOpts bio
| shouldHidePackages = bioOneWordOpts bio ++ bioPackageFlags bio
| otherwise = bioOneWordOpts bio
genOpts = nubOrd (concatMap (concatMap (oneWordOpts . snd) . ghciPkgOpts) pkgs)
(omittedOpts, ghcOpts) = partition badForGhci $
concatMap (concatMap (bioOpts . snd) . ghciPkgOpts) pkgs ++ map T.unpack
( fold (configGhcOptionsByCat config)
++ concatMap (getUserOptions . ghciPkgName) pkgs
)
getUserOptions pkg = M.findWithDefault [] pkg (configGhcOptionsByName config)
badForGhci x =
isPrefixOf "-O" x || elem x (words "-debug -threaded -ticky -static -Werror")
unless (null omittedOpts) $
logWarn
("The following GHC options are incompatible with GHCi and have not been passed to it: " <>
mconcat (intersperse " " (fromString <$> nubOrd omittedOpts)))
oiDir <- view objectInterfaceDirL
let odir =
[ "-odir=" <> toFilePathNoTrailingSep oiDir
, "-hidir=" <> toFilePathNoTrailingSep oiDir ]
logInfo $
"Configuring GHCi with the following packages: " <>
mconcat (intersperse ", " (map (RIO.display . ghciPkgName) pkgs))
let execGhci extras = do
menv <- liftIO $ configProcessContextSettings config defaultEnvSettings
withProcessContext menv $ exec
(fromMaybe (compilerExeName wc) ghciGhcCommand)
(("--interactive" : ) $
(if null pkgs then id else ("-i" : )) $
odir <> pkgopts <> extras <> map T.unpack ghciGhcOptions <> ghciArgs)
checkIsIntero =
case pkgs of
[_] -> do
menv <- liftIO $ configProcessContextSettings config defaultEnvSettings
output <- withProcessContext menv
$ runGrabFirstLine (fromMaybe (compilerExeName wc) ghciGhcCommand) ["--version"]
return $ "Intero" `isPrefixOf` output
_ -> return False
tmpDirectory <-
(</> $(mkRelDir "haskell-stack-ghci")) <$>
(parseAbsDir =<< liftIO getCanonicalTemporaryDirectory)
ensureDir tmpDirectory
macrosOptions <- writeMacrosFile tmpDirectory pkgs
if ghciNoLoadModules
then execGhci macrosOptions
else do
checkForDuplicateModules pkgs
isIntero <- checkIsIntero
bopts <- view buildOptsL
mainFile <- figureOutMainFile bopts mainIsTargets targets pkgs
scriptOptions <- writeGhciScript tmpDirectory (renderScript isIntero pkgs mainFile ghciOnlyMain extraFiles)
execGhci (macrosOptions ++ scriptOptions)
writeMacrosFile :: HasRunner env => Path Abs Dir -> [GhciPkgInfo] -> RIO env [String]
writeMacrosFile tmpDirectory pkgs = do
fps <- fmap (nubOrd . catMaybes . concat) $
forM pkgs $ \pkg -> forM (ghciPkgOpts pkg) $ \(_, bio) -> do
let cabalMacros = bioCabalMacros bio
exists <- liftIO $ doesFileExist cabalMacros
if exists
then return $ Just cabalMacros
else do
prettyWarnL ["Didn't find expected autogen file:", display cabalMacros]
return Nothing
files <- liftIO $ mapM (S8.readFile . toFilePath) fps
if null files then return [] else do
out <- liftIO $ writeHashedFile tmpDirectory $(mkRelFile "cabal_macros.h") $
S8.concat $ map (<> "\n#undef CURRENT_PACKAGE_KEY\n#undef CURRENT_COMPONENT_ID\n") files
return ["-optP-include", "-optP" <> toFilePath out]
writeGhciScript :: (MonadIO m) => Path Abs Dir -> GhciScript -> m [String]
writeGhciScript tmpDirectory script = do
scriptPath <- liftIO $ writeHashedFile tmpDirectory $(mkRelFile "ghci-script") $
LBS.toStrict $ scriptToLazyByteString script
let scriptFilePath = toFilePath scriptPath
setScriptPerms scriptFilePath
return ["-ghci-script=" <> scriptFilePath]
writeHashedFile :: Path Abs Dir -> Path Rel File -> ByteString -> IO (Path Abs File)
writeHashedFile tmpDirectory relFile contents = do
relSha <- shaPathForBytes contents
let outDir = tmpDirectory </> relSha
outFile = outDir </> relFile
alreadyExists <- doesFileExist outFile
unless alreadyExists $ do
ensureDir outDir
S8.writeFile (toFilePath outFile) contents
return outFile
renderScript :: Bool -> [GhciPkgInfo] -> Maybe (Path Abs File) -> Bool -> [Path Abs File] -> GhciScript
renderScript isIntero pkgs mainFile onlyMain extraFiles = do
let cdPhase = case (isIntero, pkgs) of
(True, [pkg]) -> cmdCdGhc (ghciPkgDir pkg)
_ -> mempty
addPhase = cmdAdd $ S.fromList (map Left allModules ++ addMain)
addMain = case mainFile of
Just path -> [Right path]
_ -> []
modulePhase = cmdModule $ S.fromList allModules
allModules = nubOrd $ concatMap (M.keys . ghciPkgModules) pkgs
case getFileTargets pkgs <> extraFiles of
[] ->
if onlyMain
then cdPhase <> if isJust mainFile then cmdAdd (S.fromList addMain) else mempty
else cdPhase <> addPhase <> modulePhase
fileTargets -> cmdAdd (S.fromList (map Right fileTargets))
getFileTargets :: [GhciPkgInfo] -> [Path Abs File]
getFileTargets = concatMap (concatMap S.toList . maybeToList . ghciPkgTargetFiles)
figureOutMainFile
:: HasRunner env
=> BuildOpts
-> Maybe (Map PackageName Target)
-> [(PackageName, (Path Abs File, Target))]
-> [GhciPkgInfo]
-> RIO env (Maybe (Path Abs File))
figureOutMainFile bopts mainIsTargets targets0 packages = do
case candidates of
[] -> return Nothing
[c@(_,_,fp)] -> do logInfo ("Using main module: " <> RIO.display (renderCandidate c))
return (Just fp)
candidate:_ -> do
borderedWarning $ do
logWarn "The main module to load is ambiguous. Candidates are: "
forM_ (map renderCandidate candidates) (logWarn . RIO.display)
logWarn
"You can specify which one to pick by: "
logWarn
(" * Specifying targets to stack ghci e.g. stack ghci " <>
RIO.display ( sampleTargetArg candidate))
logWarn
(" * Specifying what the main is e.g. stack ghci " <>
RIO.display (sampleMainIsArg candidate))
logWarn
(" * Choosing from the candidate above [1.." <>
RIO.display (length candidates) <> "]")
liftIO userOption
where
targets = fromMaybe (M.fromList $ map (\(k, (_, x)) -> (k, x)) targets0)
mainIsTargets
candidates = do
pkg <- packages
case M.lookup (ghciPkgName pkg) targets of
Nothing -> []
Just target -> do
(component,mains) <-
M.toList $
M.filterWithKey (\k _ -> k `S.member` wantedComponents)
(ghciPkgMainIs pkg)
main <- S.toList mains
return (ghciPkgName pkg, component, main)
where
wantedComponents =
wantedPackageComponents bopts target (ghciPkgPackage pkg)
renderCandidate c@(pkgName,namedComponent,mainIs) =
let candidateIndex = T.pack . show . (+1) . fromMaybe 0 . elemIndex c
in candidateIndex candidates <> ". Package `" <>
packageNameText pkgName <>
"' component " <>
renderComp namedComponent <>
" with main-is file: " <>
T.pack (toFilePath mainIs)
candidateIndices = take (length candidates) [1 :: Int ..]
userOption = do
putStr "Specify main module to use (press enter to load none): "
option <- getLine
let selected = fromMaybe
((+1) $ length candidateIndices)
(readMaybe option :: Maybe Int)
case elemIndex selected candidateIndices of
Nothing -> do
putStrLn
"Not loading any main modules, as no valid module selected"
putStrLn ""
return Nothing
Just op -> do
let (_,_,fp) = candidates !! op
putStrLn
("Loading main module from candidate " <>
show (op + 1) <> ", --main-is " <>
toFilePath fp)
putStrLn ""
return $ Just fp
renderComp c =
case c of
CLib -> "lib"
CInternalLib name -> "internal-lib:" <> name
CExe name -> "exe:" <> name
CTest name -> "test:" <> name
CBench name -> "bench:" <> name
sampleTargetArg (pkg,comp,_) =
packageNameText pkg <> ":" <> renderComp comp
sampleMainIsArg (pkg,comp,_) =
"--main-is " <> packageNameText pkg <> ":" <> renderComp comp
getGhciPkgInfos
:: HasEnvConfig env
=> BuildOptsCLI
-> SourceMap
-> [PackageName]
-> Maybe (Map PackageName (Set (Path Abs File)))
-> [(PackageName, (Path Abs File, Target))]
-> RIO env [GhciPkgInfo]
getGhciPkgInfos buildOptsCLI sourceMap addPkgs mfileTargets localTargets = do
(installedMap, _, _, _) <- getInstalled
GetInstalledOpts
{ getInstalledProfiling = False
, getInstalledHaddock = False
, getInstalledSymbols = False
}
sourceMap
let localLibs = [name | (name, (_, target)) <- localTargets, hasLocalComp isCLib target]
forM localTargets $ \(name, (cabalfp, target)) ->
makeGhciPkgInfo buildOptsCLI sourceMap installedMap localLibs addPkgs mfileTargets name cabalfp target
makeGhciPkgInfo
:: HasEnvConfig env
=> BuildOptsCLI
-> SourceMap
-> InstalledMap
-> [PackageName]
-> [PackageName]
-> Maybe (Map PackageName (Set (Path Abs File)))
-> PackageName
-> Path Abs File
-> Target
-> RIO env GhciPkgInfo
makeGhciPkgInfo buildOptsCLI sourceMap installedMap locals addPkgs mfileTargets name cabalfp target = do
bopts <- view buildOptsL
econfig <- view envConfigL
bconfig <- view buildConfigL
compilerVersion <- view actualCompilerVersionL
let config =
PackageConfig
{ packageConfigEnableTests = True
, packageConfigEnableBenchmarks = True
, packageConfigFlags = getLocalFlags bconfig buildOptsCLI name
, packageConfigGhcOptions = getGhcOptions bconfig buildOptsCLI name True True
, packageConfigCompilerVersion = compilerVersion
, packageConfigPlatform = view platformL econfig
}
(gpkgdesc, _cabalfp) <- readPackageUnresolvedDir (parent cabalfp) True
buildinfofp <- parseRelFile (T.unpack (packageNameText name) ++ ".buildinfo")
hasDotBuildinfo <- doesFileExist (parent cabalfp </> buildinfofp)
let mbuildinfofp
| hasDotBuildinfo = Just (parent cabalfp </> buildinfofp)
| otherwise = Nothing
mbuildinfo <- forM mbuildinfofp readDotBuildinfo
let pdp = resolvePackageDescription config gpkgdesc
pkg =
packageFromPackageDescription config (C.genPackageFlags gpkgdesc) $
maybe
pdp
(\bi ->
let PackageDescriptionPair x y = pdp
in PackageDescriptionPair
(C.updatePackageDescription bi x)
(C.updatePackageDescription bi y))
mbuildinfo
(mods,files,opts) <- getPackageOpts (packageOpts pkg) sourceMap installedMap locals addPkgs cabalfp
let filteredOpts = filterWanted opts
filterWanted = M.filterWithKey (\k _ -> k `S.member` allWanted)
allWanted = wantedPackageComponents bopts target pkg
setMapMaybe f = S.fromList . mapMaybe f . S.toList
return
GhciPkgInfo
{ ghciPkgName = packageName pkg
, ghciPkgOpts = M.toList filteredOpts
, ghciPkgDir = parent cabalfp
, ghciPkgModules = unionModuleMaps $
map (\(comp, mp) -> M.map (\fp -> M.singleton fp (S.singleton (packageName pkg, comp))) mp)
(M.toList (filterWanted mods))
, ghciPkgMainIs = M.map (setMapMaybe dotCabalMainPath) files
, ghciPkgCFiles = mconcat (M.elems (filterWanted (M.map (setMapMaybe dotCabalCFilePath) files)))
, ghciPkgTargetFiles = mfileTargets >>= M.lookup name
, ghciPkgPackage = pkg
}
wantedPackageComponents :: BuildOpts -> Target -> Package -> Set NamedComponent
wantedPackageComponents _ (TargetComps cs) _ = cs
wantedPackageComponents bopts (TargetAll ProjectPackage) pkg = S.fromList $
(case packageLibraries pkg of
NoLibraries -> []
HasLibraries _names -> [CLib]) ++
map CExe (S.toList (packageExes pkg)) <>
(if boptsTests bopts then map CTest (M.keys (packageTests pkg)) else []) <>
(if boptsBenchmarks bopts then map CBench (S.toList (packageBenchmarks pkg)) else [])
wantedPackageComponents _ _ _ = S.empty
checkForIssues :: HasLogFunc env => [GhciPkgInfo] -> RIO env ()
checkForIssues pkgs = do
unless (null issues) $ borderedWarning $ do
logWarn "Warning: There are cabal settings for this project which may prevent GHCi from loading your code properly."
logWarn "In some cases it can also load some projects which would otherwise fail to build."
logWarn ""
mapM_ (logWarn . RIO.display) $ intercalate [""] issues
logWarn ""
logWarn "To resolve, remove the flag(s) from the cabal file(s) and instead put them at the top of the haskell files."
logWarn ""
logWarn "It isn't yet possible to load multiple packages into GHCi in all cases - see"
logWarn "https://ghc.haskell.org/trac/ghc/ticket/10827"
where
issues = concat
[ mixedFlag "-XNoImplicitPrelude"
[ "-XNoImplicitPrelude will be used, but GHCi will likely fail to build things which depend on the implicit prelude." ]
, mixedFlag "-XCPP"
[ "-XCPP will be used, but it can cause issues with multiline strings."
, "See https://downloads.haskell.org/~ghc/7.10.2/docs/html/users_guide/options-phases.html#cpp-string-gaps"
]
, mixedFlag "-XNoTraditionalRecordSyntax"
[ "-XNoTraditionalRecordSyntax will be used, but it break modules which use record syntax." ]
, mixedFlag "-XTemplateHaskell"
[ "-XTemplateHaskell will be used, but it may cause compilation issues due to different parsing of '$' when there's no space after it." ]
, mixedFlag "-XQuasiQuotes"
[ "-XQuasiQuotes will be used, but it may cause parse failures due to a different meaning for list comprehension syntax like [x| ... ]" ]
, mixedFlag "-XSafe"
[ "-XSafe will be used, but it will fail to compile unsafe modules." ]
, mixedFlag "-XArrows"
[ "-XArrows will be used, but it will cause non-arrow usages of proc, (-<), (-<<) to fail" ]
, mixedFlag "-XOverloadedStrings"
[ "-XOverloadedStrings will be used, but it can cause type ambiguity in code not usually compiled with it." ]
, mixedFlag "-XOverloadedLists"
[ "-XOverloadedLists will be used, but it can cause type ambiguity in code not usually compiled with it." ]
, mixedFlag "-XMonoLocalBinds"
[ "-XMonoLocalBinds will be used, but it can cause type errors in code which expects generalized local bindings." ]
, mixedFlag "-XTypeFamilies"
[ "-XTypeFamilies will be used, but it implies -XMonoLocalBinds, and so can cause type errors in code which expects generalized local bindings." ]
, mixedFlag "-XGADTs"
[ "-XGADTs will be used, but it implies -XMonoLocalBinds, and so can cause type errors in code which expects generalized local bindings." ]
, mixedFlag "-XNewQualifiedOperators"
[ "-XNewQualifiedOperators will be used, but this will break usages of the old qualified operator syntax." ]
]
mixedFlag flag msgs =
let x = partitionComps (== flag) in
[ msgs ++ showWhich x | mixedSettings x ]
mixedSettings (xs, ys) = xs /= [] && ys /= []
showWhich (haveIt, don'tHaveIt) =
[ "It is specified for:"
, " " <> renderPkgComponents haveIt
, "But not for: "
, " " <> renderPkgComponents don'tHaveIt
]
partitionComps f = (map fst xs, map fst ys)
where
(xs, ys) = partition (any f . snd) compsWithOpts
compsWithOpts = map (\(k, bio) -> (k, bioOneWordOpts bio ++ bioOpts bio)) compsWithBios
compsWithBios =
[ ((ghciPkgName pkg, c), bio)
| pkg <- pkgs
, (c, bio) <- ghciPkgOpts pkg
]
borderedWarning :: HasLogFunc env => RIO env a -> RIO env a
borderedWarning f = do
logWarn ""
logWarn "* * * * * * * *"
x <- f
logWarn "* * * * * * * *"
logWarn ""
return x
checkForDuplicateModules :: HasRunner env => [GhciPkgInfo] -> RIO env ()
checkForDuplicateModules pkgs = do
unless (null duplicates) $ do
borderedWarning $ do
prettyError $ "Multiple files use the same module name:" <>
line <> bulletedList (map prettyDuplicate duplicates)
throwM LoadingDuplicateModules
where
duplicates :: [(ModuleName, Map (Path Abs File) (Set (PackageName, NamedComponent)))]
duplicates =
filter (\(_, mp) -> M.size mp > 1) $
M.toList $
unionModuleMaps (map ghciPkgModules pkgs)
prettyDuplicate :: (ModuleName, Map (Path Abs File) (Set (PackageName, NamedComponent))) -> AnsiDoc
prettyDuplicate (mn, mp) =
styleError (display mn) <+> "found at the following paths" <> line <>
bulletedList (map fileDuplicate (M.toList mp))
fileDuplicate :: (Path Abs File, Set (PackageName, NamedComponent)) -> AnsiDoc
fileDuplicate (fp, comps) =
display fp <+> parens (fillSep (punctuate "," (map display (S.toList comps))))
targetWarnings
:: HasRunner env
=> Path Abs File
-> [(PackageName, (Path Abs File, Target))]
-> [PackageName]
-> Maybe (Map PackageName (Set (Path Abs File)), [Path Abs File])
-> RIO env ()
targetWarnings stackYaml localTargets nonLocalTargets mfileTargets = do
unless (null nonLocalTargets) $
prettyWarnL
[ flow "Some targets"
, parens $ fillSep $ punctuate "," $ map (styleGood . display) nonLocalTargets
, flow "are not local packages, and so cannot be directly loaded."
, flow "In future versions of stack, this might be supported - see"
, styleUrl "https://github.com/commercialhaskell/stack/issues/1441"
, "."
, flow "It can still be useful to specify these, as they will be passed to ghci via -package flags."
]
when (null localTargets && isNothing mfileTargets) $
prettyNote $ vsep
[ flow "No local targets specified, so a plain ghci will be started with no package hiding or package options."
, ""
, flow "If you want to use package hiding and options, then you can try one of the following:"
, ""
, bulletedList
[ fillSep
[ flow "If you want to start a different project configuration than" <+> display stackYaml <> ", then you can use"
, styleShell "stack init"
, flow "to create a new stack.yaml for the packages in the current directory."
, line
]
, flow "If you want to use the project configuration at" <+> display stackYaml <> ", then you can add to its 'packages' field."
]
, ""
]
getExtraLoadDeps
:: Bool
-> SourceMap
-> [(PackageName, (Path Abs File, Target))]
-> [(PackageName, (Path Abs File, Target))]
getExtraLoadDeps loadAllDeps sourceMap targets =
M.toList $
(\mp -> foldl' (flip M.delete) mp (map fst targets)) $
M.mapMaybe id $
execState (mapM_ (mapM_ go . getDeps . fst) targets)
(M.fromList (map (second Just) targets))
where
getDeps :: PackageName -> [PackageName]
getDeps name =
case M.lookup name sourceMap of
Just (PSFiles lp _) -> M.keys (packageDeps (lpPackage lp))
_ -> []
go :: PackageName -> State (Map PackageName (Maybe (Path Abs File, Target))) Bool
go name = do
cache <- get
case (M.lookup name cache, M.lookup name sourceMap) of
(Just (Just _), _) -> return True
(Just Nothing, _) | not loadAllDeps -> return False
(_, Just (PSFiles lp _)) -> do
let deps = M.keys (packageDeps (lpPackage lp))
shouldLoad <- liftM or $ mapM go deps
if shouldLoad
then do
modify (M.insert name (Just (lpCabalFile lp, TargetComps (S.singleton CLib))))
return True
else do
modify (M.insert name Nothing)
return False
(_, Just PSIndex{}) -> return loadAllDeps
(_, _) -> return False
setScriptPerms :: MonadIO m => FilePath -> m ()
#ifdef WINDOWS
setScriptPerms _ = do
return ()
#else
setScriptPerms fp = do
liftIO $ Posix.setFileMode fp $ foldl1 Posix.unionFileModes
[ Posix.ownerReadMode
, Posix.ownerWriteMode
, Posix.groupReadMode
, Posix.otherReadMode
]
#endif
unionTargets :: Ord k => Map k Target -> Map k Target -> Map k Target
unionTargets = M.unionWith $ \l r ->
case (l, r) of
(TargetAll Dependency, _) -> r
(TargetComps sl, TargetComps sr) -> TargetComps (S.union sl sr)
(TargetComps _, TargetAll ProjectPackage) -> TargetAll ProjectPackage
(TargetComps _, _) -> l
(TargetAll ProjectPackage, _) -> TargetAll ProjectPackage
hasLocalComp :: (NamedComponent -> Bool) -> Target -> Bool
hasLocalComp p t =
case t of
TargetComps s -> any p (S.toList s)
TargetAll ProjectPackage -> True
_ -> False
runGrabFirstLine :: (HasProcessContext env, HasLogFunc env) => String -> [String] -> RIO env String
runGrabFirstLine cmd0 args =
proc cmd0 args $ \pc -> do
(out, _err) <- readProcess_ pc
return
$ TL.unpack
$ TL.filter (/= '\r')
$ TL.concat
$ take 1
$ TL.lines
$ TLE.decodeUtf8With lenientDecode out