-- (c) The University of Glasgow, 2004
--
+-- | Package configuration information: essentially the interface to Cabal, with some utilities
module PackageConfig (
+ -- $package_naming
+
-- * PackageId
- mkPackageId, packageConfigId, unpackPackageId,
+ mkPackageId, packageConfigId,
-- * The PackageConfig type: information about a package
PackageConfig,
Version(..),
PackageIdentifier(..),
defaultPackageConfig,
- packageConfigToInstalledPackageInfo,
- installedPackageInfoToPackageConfig,
+ packageConfigToInstalledPackageInfo,
+ installedPackageInfoToPackageConfig,
) where
#include "HsVersions.h"
-import Data.Maybe
+import Maybes
import Module
import Distribution.InstalledPackageInfo
import Distribution.ModuleName
-import Distribution.Package
+import Distribution.Package hiding (PackageId)
import Distribution.Text
import Distribution.Version
-import Distribution.Compat.ReadP
-- -----------------------------------------------------------------------------
-- Our PackageConfig type is just InstalledPackageInfo from Cabal. Later we
-- -----------------------------------------------------------------------------
-- PackageId (package names with versions)
--- Mostly the compiler deals in terms of PackageNames, which don't
+-- $package_naming
+-- #package_naming#
+-- Mostly the compiler deals in terms of 'PackageName's, which don't
-- have the version suffix. This is so that we don't need to know the
--- version for the -package-name flag, or know the versions of
--- wired-in packages like base & rts. Versions are confined to the
+-- version for the @-package-name@ flag, or know the versions of
+-- wired-in packages like @base@ & @rts@. Versions are confined to the
-- package sub-system.
--
-- This means that in theory you could have multiple base packages installed
--- (for example), and switch between them using -package/-hide-package.
+-- (for example), and switch between them using @-package@\/@-hide-package@.
--
--- A PackageId is a string of the form <pkg>-<version>.
+-- A 'PackageId' is a string of the form @<pkg>-<version>@.
+-- | Turn a Cabal 'PackageIdentifier' into a GHC 'PackageId'
mkPackageId :: PackageIdentifier -> PackageId
mkPackageId = stringToPackageId . display
+-- | Get the GHC 'PackageId' right out of a Cabalish 'PackageConfig'
packageConfigId :: PackageConfig -> PackageId
-packageConfigId = mkPackageId . package
-
-unpackPackageId :: PackageId -> Maybe PackageIdentifier
-unpackPackageId p
- = case [ pid | (pid,"") <- readP_to_S parse str ] of
- [] -> Nothing
- (pid:_) -> Just pid
- where str = packageIdString p
+packageConfigId = mkPackageId . sourcePackageId
+-- | Turn a 'PackageConfig', which contains GHC 'Module.ModuleName's into a Cabal specific
+-- 'InstalledPackageInfo' which contains Cabal 'Distribution.ModuleName.ModuleName's
packageConfigToInstalledPackageInfo :: PackageConfig -> InstalledPackageInfo
packageConfigToInstalledPackageInfo
(pkgconf@(InstalledPackageInfo { exposedModules = e,
pkgconf{ exposedModules = map convert e,
hiddenModules = map convert h }
where convert :: Module.ModuleName -> Distribution.ModuleName.ModuleName
- convert = fromJust . simpleParse . moduleNameString
+ convert = (expectJust "packageConfigToInstalledPackageInfo") . simpleParse . moduleNameString
-installedPackageInfoToPackageConfig :: InstalledPackageInfo -> PackageConfig
+-- | Turn an 'InstalledPackageInfo', which contains Cabal 'Distribution.ModuleName.ModuleName's
+-- into a GHC specific 'PackageConfig' which contains GHC 'Module.ModuleName's
+installedPackageInfoToPackageConfig :: InstalledPackageInfo_ String -> PackageConfig
installedPackageInfoToPackageConfig
(pkgconf@(InstalledPackageInfo { exposedModules = e,
hiddenModules = h })) =
- pkgconf{ exposedModules = map convert e,
- hiddenModules = map convert h }
- where convert :: Distribution.ModuleName.ModuleName -> Module.ModuleName
- convert = mkModuleName . display
+ pkgconf{ exposedModules = map mkModuleName e,
+ hiddenModules = map mkModuleName h }