Add compiler to PackageId

(cherry picked from commit 79b31e1)

Author: angerman

Cabal-syntax/src/Distribution/Compiler.hs

@@ -174,7 +174,7 @@ instance (Semigroup a, Monoid a) => Monoid (PerCompilerFlavor a) where
 -- ------------------------------------------------------------
 
 data CompilerId = CompilerId CompilerFlavor Version
-  deriving (Eq, Generic, Ord, Read, Show)
+  deriving (Eq, Generic, Ord, Read, Show, Data)
 
 instance Binary CompilerId
 instance Structured CompilerId

Cabal-syntax/src/Distribution/PackageDescription/FieldGrammar.hs

@@ -74,7 +74,7 @@ import Prelude ()
 
 import Distribution.CabalSpecVersion
 import Distribution.Compat.Newtype (Newtype, pack', unpack')
-import Distribution.Compiler (CompilerFlavor (..), PerCompilerFlavor (..))
+import Distribution.Compiler (CompilerFlavor (..), PerCompilerFlavor (..), CompilerId)
 import Distribution.FieldGrammar
 import Distribution.Fields
 import Distribution.ModuleName (ModuleName)
@@ -101,6 +101,7 @@ packageDescriptionFieldGrammar
      , c (Identity BuildType)
      , c (Identity PackageName)
      , c (Identity Version)
+     , c (Identity CompilerId)
      , forall from to. c (List FSep (RelativePathNT from to) (RelativePath from to))
      , forall from to. c (List VCat (RelativePathNT from to) (RelativePath from to))
      , c (List FSep TestedWith (CompilerFlavor, VersionRange))
@@ -150,6 +151,7 @@ packageDescriptionFieldGrammar =
       PackageIdentifier
         <$> uniqueField "name" L.pkgName
         <*> uniqueField "version" L.pkgVersion
+        <*> optionalField "compiler" L.pkgCompiler
 
     licenseFilesGrammar =
       (++)

Cabal-syntax/src/Distribution/Types/InstalledPackageInfo.hs

@@ -16,10 +16,10 @@ import Prelude ()
 
 import Distribution.Backpack
 import Distribution.Compat.Graph (IsNode (..))
-import Distribution.Compiler (CompilerId)
+import Distribution.Compiler (CompilerId, buildCompilerId)
 import Distribution.License
 import Distribution.ModuleName
-import Distribution.Package hiding (installedUnitId)
+import Distribution.Package hiding (installedUnitId, pkgCompiler)
 import Distribution.Types.AbiDependency
 import Distribution.Types.ExposedModule
 import Distribution.Types.LibraryName
@@ -121,8 +121,8 @@ instance IsNode InstalledPackageInfo where
   nodeNeighbors = depends
 
 mungedPackageId :: InstalledPackageInfo -> MungedPackageId
-mungedPackageId ipi =
-  MungedPackageId (mungedPackageName ipi) (packageVersion ipi)
+mungedPackageId ipi@InstalledPackageInfo{pkgCompiler = comp} =
+  MungedPackageId (mungedPackageName ipi) (packageVersion ipi) comp
 
 -- | Returns the munged package name, which we write into @name@ for
 -- compatibility with old versions of GHC.
@@ -132,7 +132,7 @@ mungedPackageName ipi = MungedPackageName (packageName ipi) (sourceLibName ipi)
 emptyInstalledPackageInfo :: InstalledPackageInfo
 emptyInstalledPackageInfo =
   InstalledPackageInfo
-    { sourcePackageId = PackageIdentifier (mkPackageName "") nullVersion
+    { sourcePackageId = PackageIdentifier (mkPackageName "") nullVersion Nothing
     , sourceLibName = LMainLibName
     , installedComponentId_ = mkComponentId ""
     , installedUnitId = mkUnitId ""

Cabal-syntax/src/Distribution/Types/InstalledPackageInfo/FieldGrammar.hs

@@ -20,7 +20,7 @@ import Distribution.FieldGrammar
 import Distribution.FieldGrammar.FieldDescrs
 import Distribution.License
 import Distribution.ModuleName
-import Distribution.Package
+import Distribution.Package hiding (pkgCompiler)
 import Distribution.Parsec
 import Distribution.Pretty
 import Distribution.Types.LibraryName
@@ -38,7 +38,7 @@ import qualified Text.PrettyPrint as Disp
 import Distribution.Types.InstalledPackageInfo
 
 import qualified Distribution.Types.InstalledPackageInfo.Lens as L
-import qualified Distribution.Types.PackageId.Lens as L
+import qualified Distribution.Types.PackageId.Lens as L hiding (pkgCompiler)
 
 -- Note: GHC goes nuts and inlines everything,
 -- One can see e.g. in -ddump-simpl-stats:
@@ -133,7 +133,7 @@ ipiFieldGrammar =
       InstalledPackageInfo
         -- _basicPkgName is not used
         -- setMaybePackageId says it can be no-op.
-        (PackageIdentifier pn _basicVersion)
+        (PackageIdentifier pn _basicVersion _basicCompilerId)
         (combineLibraryName ln _basicLibName)
         (mkComponentId "") -- installedComponentId_, not in use
         _basicLibVisibility
@@ -256,6 +256,7 @@ data Basic = Basic
   , _basicPkgName :: Maybe PackageName
   , _basicLibName :: LibraryName
   , _basicLibVisibility :: LibraryVisibility
+  , _basicCompilerId :: Maybe CompilerId
   }
 
 basic :: Lens' InstalledPackageInfo Basic
@@ -268,14 +269,16 @@ basic f ipi = g <$> f b
         (maybePackageName ipi)
         (sourceLibName ipi)
         (libVisibility ipi)
+        (pkgCompiler ipi)
 
-    g (Basic n v pn ln lv) =
+    g (Basic n v pn ln lv compid) =
       ipi
         & setMungedPackageName n
         & L.sourcePackageId . L.pkgVersion .~ v
         & setMaybePackageName pn
         & L.sourceLibName .~ ln
         & L.libVisibility .~ lv
+        & L.pkgCompiler .~ compid
 
 basicName :: Lens' Basic MungedPackageName
 basicName f b = (\x -> b{_basicName = x}) <$> f (_basicName b)
@@ -319,7 +322,7 @@ basicFieldGrammar =
     <*> optionalField "lib-name" basicLibName
     <*> optionalFieldDef "visibility" basicLibVisibility LibraryVisibilityPrivate
   where
-    mkBasic n v pn ln lv = Basic n v pn ln' lv'
+    mkBasic n v pn ln lv = Basic n v pn ln' lv' Nothing
       where
         ln' = maybe LMainLibName LSubLibName ln
         -- Older GHCs (<8.8) always report installed libraries as private

Cabal-syntax/src/Distribution/Types/MungedPackageId.hs

@@ -15,6 +15,7 @@ import Distribution.Types.LibraryName
 import Distribution.Types.MungedPackageName
 import Distribution.Types.PackageId
 import Distribution.Version (Version, nullVersion)
+import Distribution.Compiler (CompilerId)
 
 import qualified Text.PrettyPrint as Disp
 
@@ -27,6 +28,7 @@ data MungedPackageId = MungedPackageId
   -- 'MungedPackageName'.
   , mungedVersion :: Version
   -- ^ The version of this package / component, eg 1.2
+  , mingledCompilerId :: Maybe CompilerId
   }
   deriving (Generic, Read, Show, Eq, Ord, Data)
 
@@ -41,8 +43,9 @@ instance Structured MungedPackageId
 -- >>> prettyShow $ MungedPackageId (MungedPackageName "servant" (LSubLibName "lackey")) (mkVersion [0,1,2])
 -- "z-servant-z-lackey-0.1.2"
 instance Pretty MungedPackageId where
-  pretty (MungedPackageId n v)
-    | v == nullVersion = pretty n -- if no version, don't show version.
+  pretty (MungedPackageId n v c)
+    | v == nullVersion = pretty c <<>> Disp.char '-' <<>> pretty n -- if no version, don't show version.
+    | Just c' <- c = pretty c' <<>> Disp.char '-' <<>> pretty n <<>> Disp.char '-' <<>> pretty v
     | otherwise = pretty n <<>> Disp.char '-' <<>> pretty v
 
 -- |
@@ -66,15 +69,15 @@ instance Pretty MungedPackageId where
 -- Nothing
 instance Parsec MungedPackageId where
   parsec = do
-    PackageIdentifier pn v <- parsec
-    return $ MungedPackageId (decodeCompatPackageName pn) v
+    PackageIdentifier pn v comp <- parsec
+    return $ MungedPackageId (decodeCompatPackageName pn) v comp
 
 instance NFData MungedPackageId where
-  rnf (MungedPackageId name version) = rnf name `seq` rnf version
+  rnf (MungedPackageId name version compiler) = rnf name `seq` rnf version `seq` rnf compiler
 
 computeCompatPackageId :: PackageId -> LibraryName -> MungedPackageId
-computeCompatPackageId (PackageIdentifier pn vr) ln =
-  MungedPackageId (MungedPackageName pn ln) vr
+computeCompatPackageId (PackageIdentifier pn vr comp) ln =
+  MungedPackageId (MungedPackageName pn ln) vr comp
 
 -- $setup
 -- >>> :seti -XOverloadedStrings

Cabal-syntax/src/Distribution/Types/PackageDescription.hs

@@ -207,6 +207,7 @@ emptyPackageDescription =
         PackageIdentifier
           (mkPackageName "")
           nullVersion
+          Nothing
     , licenseRaw = Right UnspecifiedLicense -- TODO:
     , licenseFiles = []
     , specVersion = CabalSpecV1_0

Cabal-syntax/src/Distribution/Types/PackageId.hs

@@ -13,6 +13,7 @@ import Distribution.Parsec (Parsec (..), simpleParsec)
 import Distribution.Pretty
 import Distribution.Types.PackageName
 import Distribution.Version (Version, nullVersion)
+import Distribution.Compiler (CompilerId)
 
 import qualified Data.List.NonEmpty as NE
 import qualified Distribution.Compat.CharParsing as P
@@ -27,15 +28,17 @@ data PackageIdentifier = PackageIdentifier
   -- ^ The name of this package, eg. foo
   , pkgVersion :: Version
   -- ^ the version of this package, eg 1.2
+  , pkgCompiler :: Maybe CompilerId
   }
   deriving (Generic, Read, Show, Eq, Ord, Data)
 
 instance Binary PackageIdentifier
 instance Structured PackageIdentifier
 
 instance Pretty PackageIdentifier where
-  pretty (PackageIdentifier n v)
-    | v == nullVersion = pretty n -- if no version, don't show version.
+  pretty (PackageIdentifier n v c)
+    | v == nullVersion = pretty c <<>> Disp.char '-' <<>> pretty n -- if no version, don't show version.
+    | Just c' <- c = pretty c' <<>> Disp.char '-' <<>> pretty n <<>> Disp.char '-' <<>> pretty v
     | otherwise = pretty n <<>> Disp.char '-' <<>> pretty v
 
 -- |
@@ -61,15 +64,16 @@ instance Pretty PackageIdentifier where
 -- Nothing
 instance Parsec PackageIdentifier where
   parsec = do
+    comp <- parsec <* P.char '-'
     xs' <- P.sepByNonEmpty component (P.char '-')
     (v, xs) <- case simpleParsec (NE.last xs') of
       Nothing -> return (nullVersion, toList xs') -- all components are version
       Just v -> return (v, NE.init xs')
     if not (null xs) && all (\c -> all (/= '.') c && not (all isDigit c)) xs
-      then return $ PackageIdentifier (mkPackageName (intercalate "-" xs)) v
+      then return $ PackageIdentifier (mkPackageName (intercalate "-" xs)) v comp
       else fail "all digits or a dot in a portion of package name"
     where
       component = P.munch1 (\c -> isAlphaNum c || c == '.')
 
 instance NFData PackageIdentifier where
-  rnf (PackageIdentifier name version) = rnf name `seq` rnf version
+  rnf (PackageIdentifier name version compiler) = rnf name `seq` rnf version `seq` rnf compiler

Cabal-syntax/src/Distribution/Types/PackageId/Lens.hs

@@ -10,6 +10,7 @@ import Prelude ()
 import Distribution.Types.PackageId (PackageIdentifier)
 import Distribution.Types.PackageName (PackageName)
 import Distribution.Version (Version)
+import Distribution.Compiler (CompilerId)
 
 import qualified Distribution.Types.PackageId as T
 
@@ -20,3 +21,8 @@ pkgName f s = fmap (\x -> s{T.pkgName = x}) (f (T.pkgName s))
 pkgVersion :: Lens' PackageIdentifier Version
 pkgVersion f s = fmap (\x -> s{T.pkgVersion = x}) (f (T.pkgVersion s))
 {-# INLINE pkgVersion #-}
+
+pkgCompiler :: Lens' PackageIdentifier (Maybe CompilerId)
+pkgCompiler f s = fmap (\x -> s{T.pkgCompiler = x}) (f (T.pkgCompiler s))
+{-# INLINE pkgCompiler #-}
+

Cabal-syntax/src/Distribution/Types/PackageVersionConstraint.hs

@@ -53,7 +53,7 @@ instance Pretty PackageVersionConstraint where
 -- Just (PackageVersionConstraint (PackageName "foo") (ThisVersion (mkVersion [2,0])))
 instance Parsec PackageVersionConstraint where
   parsec = do
-    PackageIdentifier name ver <- parsec
+    PackageIdentifier name ver comp <- parsec
     if ver == nullVersion
       then do
         P.spaces
@@ -64,7 +64,7 @@ instance Parsec PackageVersionConstraint where
 
 -- | @since 3.4.0.0
 thisPackageVersionConstraint :: PackageIdentifier -> PackageVersionConstraint
-thisPackageVersionConstraint (PackageIdentifier pn vr) =
+thisPackageVersionConstraint (PackageIdentifier pn vr comp) =
   PackageVersionConstraint pn (thisVersion vr)
 
 -- | @since 3.4.0.0

Cabal/src/Distribution/Backpack/PreExistingComponent.hs

@@ -71,9 +71,9 @@ instance HasMungedPackageId PreExistingComponent where
   mungedId = pc_munged_id
 
 instance Package PreExistingComponent where
-  packageId pec = PackageIdentifier (pc_pkgname pec) v
+  packageId pec = PackageIdentifier (pc_pkgname pec) v compid
     where
-      MungedPackageId _ v = pc_munged_id pec
+      MungedPackageId _ v compid = pc_munged_id pec
 
 instance HasUnitId PreExistingComponent where
   installedUnitId = pc_uid