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

   1 {-# LANGUAGE DeriveDataTypeable #-}
   2 {-# LANGUAGE DeriveGeneric #-}
   3 {-# LANGUAGE OverloadedStrings #-}
   4 {-# LANGUAGE TypeFamilies #-}
   5
   6 module Distribution.Types.InstalledPackageInfo
   7   ( InstalledPackageInfo (..)
   8   , emptyInstalledPackageInfo
   9   , mungedPackageId
  10   , mungedPackageName
  11   , AbiDependency (..)
  12   , ExposedModule (..)
  13   ) where
  14
  15 import Distribution.Compat.Prelude
  16 import Prelude ()
  17
  18 import Distribution.Backpack
  19 import Distribution.Compat.Graph (IsNode (..))
  20 import Distribution.License
  21 import Distribution.ModuleName
  22 import Distribution.Package hiding (installedUnitId)
  23 import Distribution.Types.AbiDependency
  24 import Distribution.Types.ExposedModule
  25 import Distribution.Types.LibraryName
  26 import Distribution.Types.LibraryVisibility
  27 import Distribution.Types.MungedPackageId
  28 import Distribution.Types.MungedPackageName
  29 import Distribution.Utils.ShortText (ShortText)
  30 import Distribution.Version (nullVersion)
  31
  32 import qualified Distribution.Package as Package
  33 import qualified Distribution.SPDX as SPDX
  34
  35 -- -----------------------------------------------------------------------------
  36 -- The InstalledPackageInfo type
  37
  38 -- For BC reasons, we continue to name this record an InstalledPackageInfo;
  39 -- but it would more accurately be called an InstalledUnitInfo with Backpack
  40 data InstalledPackageInfo = InstalledPackageInfo
  41   { -- these parts (sourcePackageId, installedUnitId) are
  42     -- exactly the same as PackageDescription
  43     sourcePackageId :: PackageId
  44   , sourceLibName :: LibraryName
  45   , installedComponentId_ :: ComponentId
  46   , libVisibility :: LibraryVisibility
  47   , installedUnitId :: UnitId
  48   , -- INVARIANT: if this package is definite, OpenModule's
  49     -- OpenUnitId directly records UnitId.  If it is
  50     -- indefinite, OpenModule is always an OpenModuleVar
  51     -- with the same ModuleName as the key.
  52     instantiatedWith :: [(ModuleName, OpenModule)]
  53   , compatPackageKey :: String
  54   , license :: Either SPDX.License License
  55   , copyright :: !ShortText
  56   , maintainer :: !ShortText
  57   , author :: !ShortText
  58   , stability :: !ShortText
  59   , homepage :: !ShortText
  60   , pkgUrl :: !ShortText
  61   , synopsis :: !ShortText
  62   , description :: !ShortText
  63   , category :: !ShortText
  64   , -- these parts are required by an installed package only:
  65     abiHash :: AbiHash
  66   , indefinite :: Bool
  67   , exposed :: Bool
  68   , -- INVARIANT: if the package is definite, OpenModule's
  69     -- OpenUnitId directly records UnitId.
  70     exposedModules :: [ExposedModule]
  71   , hiddenModules :: [ModuleName]
  72   , trusted :: Bool
  73   , importDirs :: [FilePath]
  74   , libraryDirs :: [FilePath]
  75   , libraryDirsStatic :: [FilePath]
  76   , libraryDynDirs :: [FilePath]
  77   -- ^ overrides 'libraryDirs'
  78   , dataDir :: FilePath
  79   , hsLibraries :: [String]
  80   , extraLibraries :: [String]
  81   , extraLibrariesStatic :: [String]
  82   , extraGHCiLibraries :: [String] -- overrides extraLibraries for GHCi
  83   , includeDirs :: [FilePath]
  84   , includes :: [String]
  85   , -- INVARIANT: if the package is definite, UnitId is NOT
  86     -- a ComponentId of an indefinite package
  87     depends :: [UnitId]
  88   , abiDepends :: [AbiDependency]
  89   , ccOptions :: [String]
  90   , cxxOptions :: [String]
  91   , ldOptions :: [String]
  92   , frameworkDirs :: [FilePath]
  93   , frameworks :: [String]
  94   , haddockInterfaces :: [FilePath]
  95   , haddockHTMLs :: [FilePath]
  96   , pkgRoot :: Maybe FilePath
  97   }
  98   deriving (Eq, Generic, Typeable, Read, Show)
  99
 100 instance Binary InstalledPackageInfo
 101 instance Structured InstalledPackageInfo
 102
 103 instance NFData InstalledPackageInfo where rnf = genericRnf
 104
 105 instance Package.HasMungedPackageId InstalledPackageInfo where
 106   mungedId = mungedPackageId
 107
 108 instance Package.Package InstalledPackageInfo where
 109   packageId = sourcePackageId
 110
 111 instance Package.HasUnitId InstalledPackageInfo where
 112   installedUnitId = installedUnitId
 113
 114 instance Package.PackageInstalled InstalledPackageInfo where
 115   installedDepends = depends
 116
 117 instance IsNode InstalledPackageInfo where
 118   type Key InstalledPackageInfo = UnitId
 119   nodeKey = installedUnitId
 120   nodeNeighbors = depends
 121
 122 mungedPackageId :: InstalledPackageInfo -> MungedPackageId
 123 mungedPackageId ipi =
 124   MungedPackageId (mungedPackageName ipi) (packageVersion ipi)
 125
 126 -- | Returns the munged package name, which we write into @name@ for
 127 -- compatibility with old versions of GHC.
 128 mungedPackageName :: InstalledPackageInfo -> MungedPackageName
 129 mungedPackageName ipi = MungedPackageName (packageName ipi) (sourceLibName ipi)
 130
 131 emptyInstalledPackageInfo :: InstalledPackageInfo
 132 emptyInstalledPackageInfo =
 133   InstalledPackageInfo
 134     { sourcePackageId = PackageIdentifier (mkPackageName "") nullVersion
 135     , sourceLibName = LMainLibName
 136     , installedComponentId_ = mkComponentId ""
 137     , installedUnitId = mkUnitId ""
 138     , instantiatedWith = []
 139     , compatPackageKey = ""
 140     , license = Left SPDX.NONE
 141     , copyright = ""
 142     , maintainer = ""
 143     , author = ""
 144     , stability = ""
 145     , homepage = ""
 146     , pkgUrl = ""
 147     , synopsis = ""
 148     , description = ""
 149     , category = ""
 150     , abiHash = mkAbiHash ""
 151     , indefinite = False
 152     , exposed = False
 153     , exposedModules = []
 154     , hiddenModules = []
 155     , trusted = False
 156     , importDirs = []
 157     , libraryDirs = []
 158     , libraryDirsStatic = []
 159     , libraryDynDirs = []
 160     , dataDir = ""
 161     , hsLibraries = []
 162     , extraLibraries = []
 163     , extraLibrariesStatic = []
 164     , extraGHCiLibraries = []
 165     , includeDirs = []
 166     , includes = []
 167     , depends = []
 168     , abiDepends = []
 169     , ccOptions = []
 170     , cxxOptions = []
 171     , ldOptions = []
 172     , frameworkDirs = []
 173     , frameworks = []
 174     , haddockInterfaces = []
 175     , haddockHTMLs = []
 176     , pkgRoot = Nothing
 177     , libVisibility = LibraryVisibilityPrivate
 178     }