Distribution/Simple/LocalBuildInfo.hs

    {-# LANGUAGE DeriveGeneric #-}

    -----------------------------------------------------------------------------
    -- |
    -- Module      :  Distribution.Simple.LocalBuildInfo
    -- Copyright   :  Isaac Jones 2003-2004
    -- License     :  BSD3
    --
    -- Maintainer  :  cabal-devel@haskell.org
    -- Portability :  portable
    --
    -- Once a package has been configured we have resolved conditionals and
    -- dependencies, configured the compiler and other needed external programs.
    -- The 'LocalBuildInfo' is used to hold all this information. It holds the
    -- install dirs, the compiler, the exact package dependencies, the configured
    -- programs, the package database to use and a bunch of miscellaneous configure
    -- flags. It gets saved and reloaded from a file (@dist\/setup-config@). It gets
    -- passed in to very many subsequent build actions.

    module Distribution.Simple.LocalBuildInfo (
            LocalBuildInfo(..),
            externalPackageDeps,
            localComponentId,
            localUnitId,
            localCompatPackageKey,

            -- * Buildable package components
            Component(..),
            ComponentName(..),
            showComponentName,
            ComponentLocalBuildInfo(..),
            foldComponent,
            componentName,
            componentBuildInfo,
            componentEnabled,
            componentDisabledReason,
            ComponentDisabledReason(..),
            pkgComponents,
            pkgEnabledComponents,
            lookupComponent,
            getComponent,
            getComponentLocalBuildInfo,
            allComponentsInBuildOrder,
            componentsInBuildOrder,
            checkComponentsCyclic,
            depLibraryPaths,

            withAllComponentsInBuildOrder,
            withComponentsInBuildOrder,
            withComponentsLBI,
            withLibLBI,
            withExeLBI,
            withTestLBI,

            -- * Installation directories
            module Distribution.Simple.InstallDirs,
            absoluteInstallDirs, prefixRelativeInstallDirs,
            substPathTemplate
      ) where

    import Distribution.Simple.InstallDirs hiding (absoluteInstallDirs,
                                                   prefixRelativeInstallDirs,
                                                   substPathTemplate, )
    import qualified Distribution.Simple.InstallDirs as InstallDirs
    import Distribution.Simple.Program
    import Distribution.PackageDescription
    import qualified Distribution.InstalledPackageInfo as Installed
    import Distribution.Package
    import Distribution.Simple.Compiler
    import Distribution.Simple.PackageIndex
    import Distribution.Simple.Setup
    import Distribution.Simple.Utils
    import Distribution.Text
    import Distribution.System

    import Data.Array ((!))
    import Distribution.Compat.Binary (Binary)
    import Data.Graph
    import Data.List (nub, find, stripPrefix)
    import Data.Maybe
    import Data.Tree  (flatten)
    import GHC.Generics (Generic)
    import Data.Map (Map)

    import System.Directory (doesDirectoryExist, canonicalizePath)

    -- | Data cached after configuration step.  See also
    -- 'Distribution.Simple.Setup.ConfigFlags'.
    data LocalBuildInfo = LocalBuildInfo {
            configFlags   :: ConfigFlags,
            -- ^ Options passed to the configuration step.
            -- Needed to re-run configuration when .cabal is out of date
            flagAssignment :: FlagAssignment,
            -- ^ The final set of flags which were picked for this package
            extraConfigArgs     :: [String],
            -- ^ Extra args on the command line for the configuration step.
            -- Needed to re-run configuration when .cabal is out of date
            installDirTemplates :: InstallDirTemplates,
                    -- ^ The installation directories for the various different
                    -- kinds of files
            --TODO: inplaceDirTemplates :: InstallDirs FilePath
            compiler      :: Compiler,
                    -- ^ The compiler we're building with
            hostPlatform  :: Platform,
                    -- ^ The platform we're building for
            buildDir      :: FilePath,
                    -- ^ Where to build the package.
            componentsConfigs   :: [(ComponentName, ComponentLocalBuildInfo, [ComponentName])],
                    -- ^ All the components to build, ordered by topological sort, and with their dependencies
                    -- over the intrapackage dependency graph
            installedPkgs :: InstalledPackageIndex,
                    -- ^ All the info about the installed packages that the
                    -- current package depends on (directly or indirectly).
            pkgDescrFile  :: Maybe FilePath,
                    -- ^ the filename containing the .cabal file, if available
            localPkgDescr :: PackageDescription,
                    -- ^ The resolved package description, that does not contain
                    -- any conditionals.
            withPrograms  :: ProgramConfiguration, -- ^Location and args for all programs
            withPackageDB :: PackageDBStack,  -- ^What package database to use, global\/user
            withVanillaLib:: Bool,  -- ^Whether to build normal libs.
            withProfLib   :: Bool,  -- ^Whether to build profiling versions of libs.
            withSharedLib :: Bool,  -- ^Whether to build shared versions of libs.
            withDynExe    :: Bool,  -- ^Whether to link executables dynamically
            withProfExe   :: Bool,  -- ^Whether to build executables for profiling.
            withProfLibDetail :: ProfDetailLevel, -- ^Level of automatic profile detail.
            withProfExeDetail :: ProfDetailLevel, -- ^Level of automatic profile detail.
            withOptimization :: OptimisationLevel, -- ^Whether to build with optimization (if available).
            withDebugInfo :: DebugInfoLevel, -- ^Whether to emit debug info (if available).
            withGHCiLib   :: Bool,  -- ^Whether to build libs suitable for use with GHCi.
            splitObjs     :: Bool,  -- ^Use -split-objs with GHC, if available
            stripExes     :: Bool,  -- ^Whether to strip executables during install
            stripLibs     :: Bool,  -- ^Whether to strip libraries during install
            progPrefix    :: PathTemplate, -- ^Prefix to be prepended to installed executables
            progSuffix    :: PathTemplate, -- ^Suffix to be appended to installed executables
            relocatable   :: Bool --  ^Whether to build a relocatable package
      } deriving (Generic, Read, Show)

    instance Binary LocalBuildInfo

    -- | Extract the 'ComponentId' from the library component of a
    -- 'LocalBuildInfo' if it exists, or make a fake component ID based
    -- on the package ID.
    localComponentId :: LocalBuildInfo -> ComponentId
    localComponentId lbi
        = case localUnitId lbi of
            SimpleUnitId cid -> cid

    -- | Extract the 'UnitId' from the library component of a
    -- 'LocalBuildInfo' if it exists, or make a fake unit ID based on
    -- the package ID.
    localUnitId :: LocalBuildInfo -> UnitId
    localUnitId lbi =
        foldr go (mkLegacyUnitId (package (localPkgDescr lbi))) (componentsConfigs lbi)
      where go (_, clbi, _) old_uid = case clbi of
                LibComponentLocalBuildInfo { componentUnitId = uid } -> uid
                _ -> old_uid

    -- | Extract the compatibility 'ComponentId' from the library component of a
    -- 'LocalBuildInfo' if it exists, or make a fake compatibility package
    -- key based on the package ID.
    localCompatPackageKey :: LocalBuildInfo -> String
    localCompatPackageKey lbi =
        foldr go (display (package (localPkgDescr lbi))) (componentsConfigs lbi)
      where go (_, clbi, _) old_pk = case clbi of
                LibComponentLocalBuildInfo { componentCompatPackageKey = pk } -> pk
                _ -> old_pk

    -- | External package dependencies for the package as a whole. This is the
    -- union of the individual 'componentPackageDeps', less any internal deps.
    externalPackageDeps :: LocalBuildInfo -> [(UnitId, PackageId)]
    externalPackageDeps lbi =
        -- TODO:  what about non-buildable components?
        nub [ (ipkgid, pkgid)
            | (_,clbi,_)      <- componentsConfigs lbi
            , (ipkgid, pkgid) <- componentPackageDeps clbi
            , not (internal pkgid) ]
      where
        -- True if this dependency is an internal one (depends on the library
        -- defined in the same package).
        internal pkgid = pkgid == packageId (localPkgDescr lbi)

    -- -----------------------------------------------------------------------------
    -- Buildable components

    data Component = CLib   Library
                   | CExe   Executable
                   | CTest  TestSuite
                   | CBench Benchmark
                   deriving (Show, Eq, Read)

    data ComponentName = CLibName   -- currently only a single lib
                       | CExeName   String
                       | CTestName  String
                       | CBenchName String
                       deriving (Eq, Generic, Ord, Read, Show)

    instance Binary ComponentName

    showComponentName :: ComponentName -> String
    showComponentName CLibName          = "library"
    showComponentName (CExeName   name) = "executable '" ++ name ++ "'"
    showComponentName (CTestName  name) = "test suite '" ++ name ++ "'"
    showComponentName (CBenchName name) = "benchmark '" ++ name ++ "'"

    data ComponentLocalBuildInfo
      = LibComponentLocalBuildInfo {
        -- | Resolved internal and external package dependencies for this component.
        -- The 'BuildInfo' specifies a set of build dependencies that must be
        -- satisfied in terms of version ranges. This field fixes those dependencies
        -- to the specific versions available on this machine for this compiler.
        componentPackageDeps :: [(UnitId, PackageId)],
        componentUnitId :: UnitId,
        componentCompatPackageKey :: String,
        componentExposedModules :: [Installed.ExposedModule],
        componentPackageRenaming :: Map PackageName ModuleRenaming
      }
      | ExeComponentLocalBuildInfo {
        componentPackageDeps :: [(UnitId, PackageId)],
        componentPackageRenaming :: Map PackageName ModuleRenaming
      }
      | TestComponentLocalBuildInfo {
        componentPackageDeps :: [(UnitId, PackageId)],
        componentPackageRenaming :: Map PackageName ModuleRenaming
      }
      | BenchComponentLocalBuildInfo {
        componentPackageDeps :: [(UnitId, PackageId)],
        componentPackageRenaming :: Map PackageName ModuleRenaming
      }
      deriving (Generic, Read, Show)

    instance Binary ComponentLocalBuildInfo

    foldComponent :: (Library -> a)
                  -> (Executable -> a)
                  -> (TestSuite -> a)
                  -> (Benchmark -> a)
                  -> Component
                  -> a
    foldComponent f _ _ _ (CLib   lib) = f lib
    foldComponent _ f _ _ (CExe   exe) = f exe
    foldComponent _ _ f _ (CTest  tst) = f tst
    foldComponent _ _ _ f (CBench bch) = f bch

    componentBuildInfo :: Component -> BuildInfo
    componentBuildInfo =
      foldComponent libBuildInfo buildInfo testBuildInfo benchmarkBuildInfo

    componentName :: Component -> ComponentName
    componentName =
      foldComponent (const CLibName)
                    (CExeName . exeName)
                    (CTestName . testName)
                    (CBenchName . benchmarkName)

    -- | All the components in the package (libs, exes, or test suites).
    --
    pkgComponents :: PackageDescription -> [Component]
    pkgComponents pkg =
        [ CLib  lib | Just lib <- [library pkg] ]
     ++ [ CExe  exe | exe <- executables pkg ]
     ++ [ CTest tst | tst <- testSuites  pkg ]
     ++ [ CBench bm | bm  <- benchmarks  pkg ]

    -- | All the components in the package that are buildable and enabled.
    -- Thus this excludes non-buildable components and test suites or benchmarks
    -- that have been disabled.
    --
    pkgEnabledComponents :: PackageDescription -> [Component]
    pkgEnabledComponents = filter componentEnabled . pkgComponents

    componentEnabled :: Component -> Bool
    componentEnabled = isNothing . componentDisabledReason

    data ComponentDisabledReason = DisabledComponent
                                 | DisabledAllTests
                                 | DisabledAllBenchmarks

    componentDisabledReason :: Component -> Maybe ComponentDisabledReason
    componentDisabledReason (CLib  lib)
      | not (buildable (libBuildInfo lib))      = Just DisabledComponent
    componentDisabledReason (CExe  exe)
      | not (buildable (buildInfo exe))         = Just DisabledComponent
    componentDisabledReason (CTest tst)
      | not (buildable (testBuildInfo tst))     = Just DisabledComponent
      | not (testEnabled tst)                   = Just DisabledAllTests
    componentDisabledReason (CBench bm)
      | not (buildable (benchmarkBuildInfo bm)) = Just DisabledComponent
      | not (benchmarkEnabled bm)               = Just DisabledAllBenchmarks
    componentDisabledReason _                   = Nothing

    lookupComponent :: PackageDescription -> ComponentName -> Maybe Component
    lookupComponent pkg CLibName =
        fmap CLib $ library pkg
    lookupComponent pkg (CExeName name) =
        fmap CExe $ find ((name ==) . exeName) (executables pkg)
    lookupComponent pkg (CTestName name) =
        fmap CTest $ find ((name ==) . testName) (testSuites pkg)
    lookupComponent pkg (CBenchName name) =
        fmap CBench $ find ((name ==) . benchmarkName) (benchmarks pkg)

    getComponent :: PackageDescription -> ComponentName -> Component
    getComponent pkg cname =
        case lookupComponent pkg cname of
          Just cpnt -> cpnt
          Nothing   -> missingComponent
      where
        missingComponent =
          error $ "internal error: the package description contains no "
               ++ "component corresponding to " ++ show cname

    getComponentLocalBuildInfo :: LocalBuildInfo -> ComponentName
                               -> ComponentLocalBuildInfo
    getComponentLocalBuildInfo lbi cname =
        case [ clbi
             | (cname', clbi, _) <- componentsConfigs lbi
             , cname == cname' ] of
          [clbi] -> clbi
          _      -> missingComponent
      where
        missingComponent =
          error $ "internal error: there is no configuration data "
               ++ "for component " ++ show cname

    -- |If the package description has a library section, call the given
    --  function with the library build info as argument.  Extended version of
    -- 'withLib' that also gives corresponding build info.
    withLibLBI :: PackageDescription -> LocalBuildInfo
               -> (Library -> ComponentLocalBuildInfo -> IO ()) -> IO ()
    withLibLBI pkg_descr lbi f =
        withLib pkg_descr $ \lib ->
          f lib (getComponentLocalBuildInfo lbi CLibName)

    -- | Perform the action on each buildable 'Executable' in the package
    -- description.  Extended version of 'withExe' that also gives corresponding
    -- build info.
    withExeLBI :: PackageDescription -> LocalBuildInfo
               -> (Executable -> ComponentLocalBuildInfo -> IO ()) -> IO ()
    withExeLBI pkg_descr lbi f =
        withExe pkg_descr $ \exe ->
          f exe (getComponentLocalBuildInfo lbi (CExeName (exeName exe)))

    withTestLBI :: PackageDescription -> LocalBuildInfo
                -> (TestSuite -> ComponentLocalBuildInfo -> IO ()) -> IO ()
    withTestLBI pkg_descr lbi f =
        withTest pkg_descr $ \test ->
          f test (getComponentLocalBuildInfo lbi (CTestName (testName test)))

    {-# DEPRECATED withComponentsLBI "Use withAllComponentsInBuildOrder" #-}
    withComponentsLBI :: PackageDescription -> LocalBuildInfo
                      -> (Component -> ComponentLocalBuildInfo -> IO ())
                      -> IO ()
    withComponentsLBI = withAllComponentsInBuildOrder

    -- | Perform the action on each buildable 'Library' or 'Executable' (Component)
    -- in the PackageDescription, subject to the build order specified by the
    -- 'compBuildOrder' field of the given 'LocalBuildInfo'
    withAllComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo
                                  -> (Component -> ComponentLocalBuildInfo -> IO ())
                                  -> IO ()
    withAllComponentsInBuildOrder pkg lbi f =
        sequence_
          [ f (getComponent pkg cname) clbi
          | (cname, clbi) <- allComponentsInBuildOrder lbi ]

    withComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo
                               -> [ComponentName]
                               -> (Component -> ComponentLocalBuildInfo -> IO ())
                               -> IO ()
    withComponentsInBuildOrder pkg lbi cnames f =
        sequence_
          [ f (getComponent pkg cname') clbi
          | (cname', clbi) <- componentsInBuildOrder lbi cnames ]

    allComponentsInBuildOrder :: LocalBuildInfo
                              -> [(ComponentName, ComponentLocalBuildInfo)]
    allComponentsInBuildOrder lbi =
        componentsInBuildOrder lbi
          [ cname | (cname, _, _) <- componentsConfigs lbi ]

    componentsInBuildOrder :: LocalBuildInfo -> [ComponentName]
                           -> [(ComponentName, ComponentLocalBuildInfo)]
    componentsInBuildOrder lbi cnames =
          map ((\(clbi,cname,_) -> (cname,clbi)) . vertexToNode)
        . postOrder graph
        . map (\cname -> fromMaybe (noSuchComp cname) (keyToVertex cname))
        $ cnames
      where
        (graph, vertexToNode, keyToVertex) =
          graphFromEdges (map (\(a,b,c) -> (b,a,c)) (componentsConfigs lbi))

        noSuchComp cname = error $ "internal error: componentsInBuildOrder: "
                                ++ "no such component: " ++ show cname

        postOrder :: Graph -> [Vertex] -> [Vertex]
        postOrder g vs = postorderF (dfs g vs) []

        postorderF   :: Forest a -> [a] -> [a]
        postorderF ts = foldr (.) id $ map postorderT ts

        postorderT :: Tree a -> [a] -> [a]
        postorderT (Node a ts) = postorderF ts . (a :)

    checkComponentsCyclic :: Ord key => [(node, key, [key])]
                          -> Maybe [(node, key, [key])]
    checkComponentsCyclic es =
        let (graph, vertexToNode, _) = graphFromEdges es
            cycles                   = [ flatten c | c <- scc graph, isCycle c ]
            isCycle (Node v [])      = selfCyclic v
            isCycle _                = True
            selfCyclic v             = v `elem` graph ! v
         in case cycles of
             []    -> Nothing
             (c:_) -> Just (map vertexToNode c)

    -- | Determine the directories containing the dynamic libraries of the
    -- transitive dependencies of the component we are building.
    --
    -- When wanted, and possible, returns paths relative to the installDirs 'prefix'
    depLibraryPaths :: Bool -- ^ Building for inplace?
                    -> Bool -- ^ Generate prefix-relative library paths
                    -> LocalBuildInfo
                    -> ComponentLocalBuildInfo -- ^ Component that is being built
                    -> IO [FilePath]
    depLibraryPaths inplace relative lbi clbi = do
        let pkgDescr    = localPkgDescr lbi
            installDirs = absoluteInstallDirs pkgDescr lbi NoCopyDest
            executable  = case clbi of
                            ExeComponentLocalBuildInfo {} -> True
                            _                             -> False
            relDir | executable = bindir installDirs
                   | otherwise  = libdir installDirs

        let hasInternalDeps = not $ null
                            $ [ pkgid
                              | (_,pkgid) <- componentPackageDeps clbi
                              , internal pkgid
                              ]

        let ipkgs          = allPackages (installedPkgs lbi)
            -- First look for dynamic libraries in `dynamic-library-dirs`, and use
            -- `library-dirs` as a fall back.
            getDynDir pkg  = case Installed.libraryDynDirs pkg of
                               [] -> Installed.libraryDirs pkg
                               d  -> d
            allDepLibDirs  = concatMap getDynDir ipkgs
            internalLib
              | inplace    = buildDir lbi
              | otherwise  = dynlibdir installDirs
            allDepLibDirs' = if hasInternalDeps
                                then internalLib : allDepLibDirs
                                else allDepLibDirs
        allDepLibDirsC <- mapM canonicalizePathNoFail allDepLibDirs'

        let p                = prefix installDirs
            prefixRelative l = isJust (stripPrefix p l)
            libPaths
              | relative &&
                prefixRelative relDir = map (\l ->
                                              if prefixRelative l
                                                 then shortRelativePath relDir l
                                                 else l
                                            ) allDepLibDirsC
              | otherwise             = allDepLibDirsC

        return libPaths
      where
        internal pkgid = pkgid == packageId (localPkgDescr lbi)
        -- 'canonicalizePath' fails on UNIX when the directory does not exists.
        -- So just don't canonicalize when it doesn't exist.
        canonicalizePathNoFail p = do
          exists <- doesDirectoryExist p
          if exists
             then canonicalizePath p
             else return p

    -- -----------------------------------------------------------------------------
    -- Wrappers for a couple functions from InstallDirs

    -- |See 'InstallDirs.absoluteInstallDirs'
    absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest
                        -> InstallDirs FilePath
    absoluteInstallDirs pkg lbi copydest =
      InstallDirs.absoluteInstallDirs
        (packageId pkg)
        (localUnitId lbi)
        (compilerInfo (compiler lbi))
        copydest
        (hostPlatform lbi)
        (installDirTemplates lbi)

    -- |See 'InstallDirs.prefixRelativeInstallDirs'
    prefixRelativeInstallDirs :: PackageId -> LocalBuildInfo
                              -> InstallDirs (Maybe FilePath)
    prefixRelativeInstallDirs pkg_descr lbi =
      InstallDirs.prefixRelativeInstallDirs
        (packageId pkg_descr)
        (localUnitId lbi)
        (compilerInfo (compiler lbi))
        (hostPlatform lbi)
        (installDirTemplates lbi)

    substPathTemplate :: PackageId -> LocalBuildInfo
                      -> PathTemplate -> FilePath
    substPathTemplate pkgid lbi = fromPathTemplate
                                    . ( InstallDirs.substPathTemplate env )
        where env = initialPathTemplateEnv
                       pkgid
                       (localUnitId lbi)
                       (compilerInfo (compiler lbi))
                       (hostPlatform lbi)