cabal-install-1.24.0.1: Distribution/Client/ProjectConfig.hs
{-# LANGUAGE CPP, RecordWildCards, NamedFieldPuns, DeriveDataTypeable #-}
-- | Handling project configuration.
--
module Distribution.Client.ProjectConfig (
-- * Types for project config
ProjectConfig(..),
ProjectConfigBuildOnly(..),
ProjectConfigShared(..),
PackageConfig(..),
MapLast(..),
MapMappend(..),
-- * Project config files
findProjectRoot,
readProjectConfig,
writeProjectLocalExtraConfig,
writeProjectConfigFile,
commandLineFlagsToProjectConfig,
-- * Packages within projects
ProjectPackageLocation(..),
BadPackageLocations(..),
BadPackageLocation(..),
BadPackageLocationMatch(..),
findProjectPackages,
readSourcePackage,
-- * Resolving configuration
lookupLocalPackageConfig,
projectConfigWithBuilderRepoContext,
projectConfigWithSolverRepoContext,
SolverSettings(..),
resolveSolverSettings,
BuildTimeSettings(..),
resolveBuildTimeSettings,
-- * Checking configuration
checkBadPerPackageCompilerPaths,
BadPerPackageCompilerPaths(..)
) where
import Distribution.Client.ProjectConfig.Types
import Distribution.Client.ProjectConfig.Legacy
import Distribution.Client.RebuildMonad
import Distribution.Client.Glob
( isTrivialFilePathGlob )
import Distribution.Client.Types
import Distribution.Client.DistDirLayout
( CabalDirLayout(..) )
import Distribution.Client.GlobalFlags
( RepoContext(..), withRepoContext' )
import Distribution.Client.BuildReports.Types
( ReportLevel(..) )
import Distribution.Client.Config
( loadConfig, defaultConfigFile )
import Distribution.Package
( PackageName, PackageId, packageId, UnitId, Dependency )
import Distribution.System
( Platform )
import Distribution.PackageDescription
( SourceRepo(..) )
import Distribution.PackageDescription.Parse
( readPackageDescription )
import Distribution.Simple.Compiler
( Compiler, compilerInfo )
import Distribution.Simple.Program
( ConfiguredProgram(..) )
import Distribution.Simple.Setup
( Flag(Flag), toFlag, flagToMaybe, flagToList
, fromFlag, AllowNewer(..) )
import Distribution.Client.Setup
( defaultSolver, defaultMaxBackjumps, )
import Distribution.Simple.InstallDirs
( PathTemplate, fromPathTemplate
, toPathTemplate, substPathTemplate, initialPathTemplateEnv )
import Distribution.Simple.Utils
( die, warn )
import Distribution.Client.Utils
( determineNumJobs )
import Distribution.Utils.NubList
( fromNubList )
import Distribution.Verbosity
( Verbosity, verbose )
import Distribution.Text
import Distribution.ParseUtils
( ParseResult(..), locatedErrorMsg, showPWarning )
#if !MIN_VERSION_base(4,8,0)
import Control.Applicative
#endif
import Control.Monad
import Control.Monad.Trans (liftIO)
import Control.Exception
import Data.Typeable
import Data.Maybe
import Data.Either
import qualified Data.Map as Map
import Data.Map (Map)
import qualified Data.Set as Set
import Distribution.Compat.Semigroup
import System.FilePath hiding (combine)
import System.Directory
import Network.URI (URI(..), URIAuth(..), parseAbsoluteURI)
----------------------------------------
-- Resolving configuration to settings
--
-- | Look up a 'PackageConfig' field in the 'ProjectConfig' for a specific
-- 'PackageName'. This returns the configuration that applies to all local
-- packages plus any package-specific configuration for this package.
--
lookupLocalPackageConfig :: (Semigroup a, Monoid a)
=> (PackageConfig -> a)
-> ProjectConfig
-> PackageName -> a
lookupLocalPackageConfig field ProjectConfig {
projectConfigLocalPackages,
projectConfigSpecificPackage
} pkgname =
field projectConfigLocalPackages
<> maybe mempty field
(Map.lookup pkgname (getMapMappend projectConfigSpecificPackage))
-- | Use a 'RepoContext' based on the 'BuildTimeSettings'.
--
projectConfigWithBuilderRepoContext :: Verbosity
-> BuildTimeSettings
-> (RepoContext -> IO a) -> IO a
projectConfigWithBuilderRepoContext verbosity BuildTimeSettings{..} =
withRepoContext'
verbosity
buildSettingRemoteRepos
buildSettingLocalRepos
buildSettingCacheDir
buildSettingHttpTransport
(Just buildSettingIgnoreExpiry)
-- | Use a 'RepoContext', but only for the solver. The solver does not use the
-- full facilities of the 'RepoContext' so we can get away with making one
-- that doesn't have an http transport. And that avoids having to have access
-- to the 'BuildTimeSettings'
--
projectConfigWithSolverRepoContext :: Verbosity
-> FilePath
-> ProjectConfigShared
-> ProjectConfigBuildOnly
-> (RepoContext -> IO a) -> IO a
projectConfigWithSolverRepoContext verbosity downloadCacheRootDir
ProjectConfigShared{..}
ProjectConfigBuildOnly{..} =
withRepoContext'
verbosity
(fromNubList projectConfigRemoteRepos)
(fromNubList projectConfigLocalRepos)
downloadCacheRootDir
(flagToMaybe projectConfigHttpTransport)
(flagToMaybe projectConfigIgnoreExpiry)
-- | Resolve the project configuration, with all its optional fields, into
-- 'SolverSettings' with no optional fields (by applying defaults).
--
resolveSolverSettings :: ProjectConfig -> SolverSettings
resolveSolverSettings ProjectConfig{
projectConfigShared,
projectConfigLocalPackages,
projectConfigSpecificPackage
} =
SolverSettings {..}
where
--TODO: [required eventually] some of these settings need validation, e.g.
-- the flag assignments need checking.
solverSettingRemoteRepos = fromNubList projectConfigRemoteRepos
solverSettingLocalRepos = fromNubList projectConfigLocalRepos
solverSettingConstraints = projectConfigConstraints
solverSettingPreferences = projectConfigPreferences
solverSettingFlagAssignment = packageConfigFlagAssignment projectConfigLocalPackages
solverSettingFlagAssignments = fmap packageConfigFlagAssignment
(getMapMappend projectConfigSpecificPackage)
solverSettingCabalVersion = flagToMaybe projectConfigCabalVersion
solverSettingSolver = fromFlag projectConfigSolver
solverSettingAllowNewer = fromJust projectConfigAllowNewer
solverSettingMaxBackjumps = case fromFlag projectConfigMaxBackjumps of
n | n < 0 -> Nothing
| otherwise -> Just n
solverSettingReorderGoals = fromFlag projectConfigReorderGoals
solverSettingStrongFlags = fromFlag projectConfigStrongFlags
--solverSettingIndependentGoals = fromFlag projectConfigIndependentGoals
--solverSettingShadowPkgs = fromFlag projectConfigShadowPkgs
--solverSettingReinstall = fromFlag projectConfigReinstall
--solverSettingAvoidReinstalls = fromFlag projectConfigAvoidReinstalls
--solverSettingOverrideReinstall = fromFlag projectConfigOverrideReinstall
--solverSettingUpgradeDeps = fromFlag projectConfigUpgradeDeps
ProjectConfigShared {..} = defaults <> projectConfigShared
defaults = mempty {
projectConfigSolver = Flag defaultSolver,
projectConfigAllowNewer = Just AllowNewerNone,
projectConfigMaxBackjumps = Flag defaultMaxBackjumps,
projectConfigReorderGoals = Flag False,
projectConfigStrongFlags = Flag False
--projectConfigIndependentGoals = Flag False,
--projectConfigShadowPkgs = Flag False,
--projectConfigReinstall = Flag False,
--projectConfigAvoidReinstalls = Flag False,
--projectConfigOverrideReinstall = Flag False,
--projectConfigUpgradeDeps = Flag False
}
-- | Resolve the project configuration, with all its optional fields, into
-- 'BuildTimeSettings' with no optional fields (by applying defaults).
--
resolveBuildTimeSettings :: Verbosity
-> CabalDirLayout
-> ProjectConfigShared
-> ProjectConfigBuildOnly
-> ProjectConfigBuildOnly
-> BuildTimeSettings
resolveBuildTimeSettings verbosity
CabalDirLayout {
cabalLogsDirectory,
cabalPackageCacheDirectory
}
ProjectConfigShared {
projectConfigRemoteRepos,
projectConfigLocalRepos
}
fromProjectFile
fromCommandLine =
BuildTimeSettings {..}
where
buildSettingDryRun = fromFlag projectConfigDryRun
buildSettingOnlyDeps = fromFlag projectConfigOnlyDeps
buildSettingSummaryFile = fromNubList projectConfigSummaryFile
--buildSettingLogFile -- defined below, more complicated
--buildSettingLogVerbosity -- defined below, more complicated
buildSettingBuildReports = fromFlag projectConfigBuildReports
buildSettingSymlinkBinDir = flagToList projectConfigSymlinkBinDir
buildSettingOneShot = fromFlag projectConfigOneShot
buildSettingNumJobs = determineNumJobs projectConfigNumJobs
buildSettingOfflineMode = fromFlag projectConfigOfflineMode
buildSettingKeepTempFiles = fromFlag projectConfigKeepTempFiles
buildSettingRemoteRepos = fromNubList projectConfigRemoteRepos
buildSettingLocalRepos = fromNubList projectConfigLocalRepos
buildSettingCacheDir = cabalPackageCacheDirectory
buildSettingHttpTransport = flagToMaybe projectConfigHttpTransport
buildSettingIgnoreExpiry = fromFlag projectConfigIgnoreExpiry
buildSettingReportPlanningFailure
= fromFlag projectConfigReportPlanningFailure
buildSettingRootCmd = flagToMaybe projectConfigRootCmd
ProjectConfigBuildOnly{..} = defaults
<> fromProjectFile
<> fromCommandLine
defaults = mempty {
projectConfigDryRun = toFlag False,
projectConfigOnlyDeps = toFlag False,
projectConfigBuildReports = toFlag NoReports,
projectConfigReportPlanningFailure = toFlag False,
projectConfigOneShot = toFlag False,
projectConfigOfflineMode = toFlag False,
projectConfigKeepTempFiles = toFlag False,
projectConfigIgnoreExpiry = toFlag False
}
-- The logging logic: what log file to use and what verbosity.
--
-- If the user has specified --remote-build-reporting=detailed, use the
-- default log file location. If the --build-log option is set, use the
-- provided location. Otherwise don't use logging, unless building in
-- parallel (in which case the default location is used).
--
buildSettingLogFile :: Maybe (Compiler -> Platform
-> PackageId -> UnitId -> FilePath)
buildSettingLogFile
| useDefaultTemplate = Just (substLogFileName defaultTemplate)
| otherwise = fmap substLogFileName givenTemplate
defaultTemplate = toPathTemplate $
cabalLogsDirectory </> "$pkgid" <.> "log"
givenTemplate = flagToMaybe projectConfigLogFile
useDefaultTemplate
| buildSettingBuildReports == DetailedReports = True
| isJust givenTemplate = False
| isParallelBuild = True
| otherwise = False
isParallelBuild = buildSettingNumJobs >= 2
substLogFileName :: PathTemplate
-> Compiler -> Platform
-> PackageId -> UnitId -> FilePath
substLogFileName template compiler platform pkgid uid =
fromPathTemplate (substPathTemplate env template)
where
env = initialPathTemplateEnv
pkgid uid (compilerInfo compiler) platform
-- If the user has specified --remote-build-reporting=detailed or
-- --build-log, use more verbose logging.
--
buildSettingLogVerbosity
| overrideVerbosity = max verbose verbosity
| otherwise = verbosity
overrideVerbosity
| buildSettingBuildReports == DetailedReports = True
| isJust givenTemplate = True
| isParallelBuild = False
| otherwise = False
---------------------------------------------
-- Reading and writing project config files
--
-- | Find the root of this project.
--
-- Searches for an explicit @cabal.project@ file, in the current directory or
-- parent directories. If no project file is found then the current dir is the
-- project root (and the project will use an implicit config).
--
findProjectRoot :: IO FilePath
findProjectRoot = do
curdir <- getCurrentDirectory
homedir <- getHomeDirectory
-- Search upwards. If we get to the users home dir or the filesystem root,
-- then use the current dir
let probe dir | isDrive dir || dir == homedir
= return curdir -- implicit project root
probe dir = do
exists <- doesFileExist (dir </> "cabal.project")
if exists
then return dir -- explicit project root
else probe (takeDirectory dir)
probe curdir
--TODO: [nice to have] add compat support for old style sandboxes
-- | Read all the config relevant for a project. This includes the project
-- file if any, plus other global config.
--
readProjectConfig :: Verbosity -> FilePath -> Rebuild ProjectConfig
readProjectConfig verbosity projectRootDir = do
global <- readGlobalConfig verbosity
local <- readProjectLocalConfig verbosity projectRootDir
extra <- readProjectLocalExtraConfig verbosity projectRootDir
return (global <> local <> extra)
-- | Reads an explicit @cabal.project@ file in the given project root dir,
-- or returns the default project config for an implicitly defined project.
--
readProjectLocalConfig :: Verbosity -> FilePath -> Rebuild ProjectConfig
readProjectLocalConfig verbosity projectRootDir = do
usesExplicitProjectRoot <- liftIO $ doesFileExist projectFile
if usesExplicitProjectRoot
then do
monitorFiles [monitorFileHashed projectFile]
liftIO readProjectFile
else do
monitorFiles [monitorNonExistentFile projectFile]
return defaultImplicitProjectConfig
where
projectFile = projectRootDir </> "cabal.project"
readProjectFile =
reportParseResult verbosity "project file" projectFile
. parseProjectConfig
=<< readFile projectFile
defaultImplicitProjectConfig :: ProjectConfig
defaultImplicitProjectConfig =
mempty {
-- We expect a package in the current directory.
projectPackages = [ "./*.cabal" ],
-- This is to automatically pick up deps that we unpack locally.
projectPackagesOptional = [ "./*/*.cabal" ]
}
-- | Reads a @cabal.project.extra@ file in the given project root dir,
-- or returns empty. This file gets written by @cabal configure@, or in
-- principle can be edited manually or by other tools.
--
readProjectLocalExtraConfig :: Verbosity -> FilePath -> Rebuild ProjectConfig
readProjectLocalExtraConfig verbosity projectRootDir = do
hasExtraConfig <- liftIO $ doesFileExist projectExtraConfigFile
if hasExtraConfig
then do monitorFiles [monitorFileHashed projectExtraConfigFile]
liftIO readProjectExtraConfigFile
else do monitorFiles [monitorNonExistentFile projectExtraConfigFile]
return mempty
where
projectExtraConfigFile = projectRootDir </> "cabal.project.local"
readProjectExtraConfigFile =
reportParseResult verbosity "project local configuration file"
projectExtraConfigFile
. parseProjectConfig
=<< readFile projectExtraConfigFile
-- | Parse the 'ProjectConfig' format.
--
-- For the moment this is implemented in terms of parsers for legacy
-- configuration types, plus a conversion.
--
parseProjectConfig :: String -> ParseResult ProjectConfig
parseProjectConfig content =
convertLegacyProjectConfig <$>
parseLegacyProjectConfig content
-- | Render the 'ProjectConfig' format.
--
-- For the moment this is implemented in terms of a pretty printer for the
-- legacy configuration types, plus a conversion.
--
showProjectConfig :: ProjectConfig -> String
showProjectConfig =
showLegacyProjectConfig . convertToLegacyProjectConfig
-- | Write a @cabal.project.extra@ file in the given project root dir.
--
writeProjectLocalExtraConfig :: FilePath -> ProjectConfig -> IO ()
writeProjectLocalExtraConfig projectRootDir =
writeProjectConfigFile projectExtraConfigFile
where
projectExtraConfigFile = projectRootDir </> "cabal.project.local"
-- | Write in the @cabal.project@ format to the given file.
--
writeProjectConfigFile :: FilePath -> ProjectConfig -> IO ()
writeProjectConfigFile file =
writeFile file . showProjectConfig
-- | Read the user's @~/.cabal/config@ file.
--
readGlobalConfig :: Verbosity -> Rebuild ProjectConfig
readGlobalConfig verbosity = do
config <- liftIO (loadConfig verbosity mempty)
configFile <- liftIO defaultConfigFile
monitorFiles [monitorFileHashed configFile]
return (convertLegacyGlobalConfig config)
--TODO: do this properly, there's several possible locations
-- and env vars, and flags for selecting the global config
reportParseResult :: Verbosity -> String -> FilePath -> ParseResult a -> IO a
reportParseResult verbosity _filetype filename (ParseOk warnings x) = do
unless (null warnings) $
let msg = unlines (map (showPWarning filename) warnings)
in warn verbosity msg
return x
reportParseResult _verbosity filetype filename (ParseFailed err) =
let (line, msg) = locatedErrorMsg err
in die $ "Error parsing " ++ filetype ++ " " ++ filename
++ maybe "" (\n -> ':' : show n) line ++ ":\n" ++ msg
---------------------------------------------
-- Reading packages in the project
--
-- | The location of a package as part of a project. Local file paths are
-- either absolute (if the user specified it as such) or they are relative
-- to the project root.
--
data ProjectPackageLocation =
ProjectPackageLocalCabalFile FilePath
| ProjectPackageLocalDirectory FilePath FilePath -- dir and .cabal file
| ProjectPackageLocalTarball FilePath
| ProjectPackageRemoteTarball URI
| ProjectPackageRemoteRepo SourceRepo
| ProjectPackageNamed Dependency
deriving Show
-- | Exception thrown by 'findProjectPackages'.
--
newtype BadPackageLocations = BadPackageLocations [BadPackageLocation]
deriving (Show, Typeable)
instance Exception BadPackageLocations
--TODO: [required eventually] displayException for nice rendering
--TODO: [nice to have] custom exception subclass for Doc rendering, colour etc
data BadPackageLocation
= BadPackageLocationFile BadPackageLocationMatch
| BadLocGlobEmptyMatch String
| BadLocGlobBadMatches String [BadPackageLocationMatch]
| BadLocUnexpectedUriScheme String
| BadLocUnrecognisedUri String
| BadLocUnrecognised String
deriving Show
data BadPackageLocationMatch
= BadLocUnexpectedFile String
| BadLocNonexistantFile String
| BadLocDirNoCabalFile String
| BadLocDirManyCabalFiles String
deriving Show
-- | Given the project config,
--
-- Throws 'BadPackageLocations'.
--
findProjectPackages :: FilePath -> ProjectConfig
-> Rebuild [ProjectPackageLocation]
findProjectPackages projectRootDir ProjectConfig{..} = do
requiredPkgs <- findPackageLocations True projectPackages
optionalPkgs <- findPackageLocations False projectPackagesOptional
let repoPkgs = map ProjectPackageRemoteRepo projectPackagesRepo
namedPkgs = map ProjectPackageNamed projectPackagesNamed
return (concat [requiredPkgs, optionalPkgs, repoPkgs, namedPkgs])
where
findPackageLocations required pkglocstr = do
(problems, pkglocs) <-
partitionEithers <$> mapM (findPackageLocation required) pkglocstr
unless (null problems) $
liftIO $ throwIO $ BadPackageLocations problems
return (concat pkglocs)
findPackageLocation :: Bool -> String
-> Rebuild (Either BadPackageLocation
[ProjectPackageLocation])
findPackageLocation _required@True pkglocstr =
-- strategy: try first as a file:// or http(s):// URL.
-- then as a file glob (usually encompassing single file)
-- finally as a single file, for files that fail to parse as globs
checkIsUriPackage pkglocstr
`mplusMaybeT` checkIsFileGlobPackage pkglocstr
`mplusMaybeT` checkIsSingleFilePackage pkglocstr
>>= maybe (return (Left (BadLocUnrecognised pkglocstr))) return
findPackageLocation _required@False pkglocstr = do
-- just globs for optional case
res <- checkIsFileGlobPackage pkglocstr
case res of
Nothing -> return (Left (BadLocUnrecognised pkglocstr))
Just (Left _) -> return (Right []) -- it's optional
Just (Right pkglocs) -> return (Right pkglocs)
checkIsUriPackage, checkIsFileGlobPackage, checkIsSingleFilePackage
:: String -> Rebuild (Maybe (Either BadPackageLocation
[ProjectPackageLocation]))
checkIsUriPackage pkglocstr =
return $!
case parseAbsoluteURI pkglocstr of
Just uri@URI {
uriScheme = scheme,
uriAuthority = Just URIAuth { uriRegName = host }
}
| recognisedScheme && not (null host) ->
Just (Right [ProjectPackageRemoteTarball uri])
| not recognisedScheme && not (null host) ->
Just (Left (BadLocUnexpectedUriScheme pkglocstr))
| recognisedScheme && null host ->
Just (Left (BadLocUnrecognisedUri pkglocstr))
where
recognisedScheme = scheme == "http:" || scheme == "https:"
|| scheme == "file:"
_ -> Nothing
checkIsFileGlobPackage pkglocstr =
case simpleParse pkglocstr of
Nothing -> return Nothing
Just glob -> liftM Just $ do
matches <- matchFileGlob glob
case matches of
[] | isJust (isTrivialFilePathGlob glob)
-> return (Left (BadPackageLocationFile
(BadLocNonexistantFile pkglocstr)))
[] -> return (Left (BadLocGlobEmptyMatch pkglocstr))
_ -> do
(failures, pkglocs) <- partitionEithers <$>
mapM checkFilePackageMatch matches
if null pkglocs
then return (Left (BadLocGlobBadMatches pkglocstr failures))
else return (Right pkglocs)
checkIsSingleFilePackage pkglocstr = do
let filename = projectRootDir </> pkglocstr
isFile <- liftIO $ doesFileExist filename
isDir <- liftIO $ doesDirectoryExist filename
if isFile || isDir
then checkFilePackageMatch pkglocstr
>>= either (return . Just . Left . BadPackageLocationFile)
(return . Just . Right . (\x->[x]))
else return Nothing
checkFilePackageMatch :: String -> Rebuild (Either BadPackageLocationMatch
ProjectPackageLocation)
checkFilePackageMatch pkglocstr = do
-- The pkglocstr may be absolute or may be relative to the project root.
-- Either way, </> does the right thing here. We return relative paths if
-- they were relative in the first place.
let abspath = projectRootDir </> pkglocstr
isDir <- liftIO $ doesDirectoryExist abspath
parentDirExists <- case takeDirectory abspath of
[] -> return False
dir -> liftIO $ doesDirectoryExist dir
case () of
_ | isDir
-> do matches <- matchFileGlob (globStarDotCabal pkglocstr)
case matches of
[cabalFile]
-> return (Right (ProjectPackageLocalDirectory
pkglocstr cabalFile))
[] -> return (Left (BadLocDirNoCabalFile pkglocstr))
_ -> return (Left (BadLocDirManyCabalFiles pkglocstr))
| extensionIsTarGz pkglocstr
-> return (Right (ProjectPackageLocalTarball pkglocstr))
| takeExtension pkglocstr == ".cabal"
-> return (Right (ProjectPackageLocalCabalFile pkglocstr))
| parentDirExists
-> return (Left (BadLocNonexistantFile pkglocstr))
| otherwise
-> return (Left (BadLocUnexpectedFile pkglocstr))
extensionIsTarGz f = takeExtension f == ".gz"
&& takeExtension (dropExtension f) == ".tar"
-- | A glob to find all the cabal files in a directory.
--
-- For a directory @some/dir/@, this is a glob of the form @some/dir/\*.cabal@.
-- The directory part can be either absolute or relative.
--
globStarDotCabal :: FilePath -> FilePathGlob
globStarDotCabal dir =
FilePathGlob
(if isAbsolute dir then FilePathRoot root else FilePathRelative)
(foldr (\d -> GlobDir [Literal d])
(GlobFile [WildCard, Literal ".cabal"]) dirComponents)
where
(root, dirComponents) = fmap splitDirectories (splitDrive dir)
--TODO: [code cleanup] use sufficiently recent transformers package
mplusMaybeT :: Monad m => m (Maybe a) -> m (Maybe a) -> m (Maybe a)
mplusMaybeT ma mb = do
mx <- ma
case mx of
Nothing -> mb
Just x -> return (Just x)
-- | Read the @.cabal@ file of the given package.
--
-- Note here is where we convert from project-root relative paths to absolute
-- paths.
--
readSourcePackage :: Verbosity -> ProjectPackageLocation
-> Rebuild SourcePackage
readSourcePackage verbosity (ProjectPackageLocalCabalFile cabalFile) =
readSourcePackage verbosity (ProjectPackageLocalDirectory dir cabalFile)
where
dir = takeDirectory cabalFile
readSourcePackage verbosity (ProjectPackageLocalDirectory dir cabalFile) = do
monitorFiles [monitorFileHashed cabalFile]
root <- askRoot
pkgdesc <- liftIO $ readPackageDescription verbosity (root </> cabalFile)
return SourcePackage {
packageInfoId = packageId pkgdesc,
packageDescription = pkgdesc,
packageSource = LocalUnpackedPackage (root </> dir),
packageDescrOverride = Nothing
}
readSourcePackage _verbosity _ =
fail $ "TODO: add support for fetching and reading local tarballs, remote "
++ "tarballs, remote repos and passing named packages through"
---------------------------------------------
-- Checking configuration sanity
--
data BadPerPackageCompilerPaths
= BadPerPackageCompilerPaths [(PackageName, String)]
deriving (Show, Typeable)
instance Exception BadPerPackageCompilerPaths
--TODO: [required eventually] displayException for nice rendering
--TODO: [nice to have] custom exception subclass for Doc rendering, colour etc
-- | The project configuration is not allowed to specify program locations for
-- programs used by the compiler as these have to be the same for each set of
-- packages.
--
-- We cannot check this until we know which programs the compiler uses, which
-- in principle is not until we've configured the compiler.
--
-- Throws 'BadPerPackageCompilerPaths'
--
checkBadPerPackageCompilerPaths :: [ConfiguredProgram]
-> Map PackageName PackageConfig
-> IO ()
checkBadPerPackageCompilerPaths compilerPrograms packagesConfig =
case [ (pkgname, progname)
| let compProgNames = Set.fromList (map programId compilerPrograms)
, (pkgname, pkgconf) <- Map.toList packagesConfig
, progname <- Map.keys (getMapLast (packageConfigProgramPaths pkgconf))
, progname `Set.member` compProgNames ] of
[] -> return ()
ps -> throwIO (BadPerPackageCompilerPaths ps)