PackageIndex.hs 20.6 KB
Newer Older
1 2
-----------------------------------------------------------------------------
-- |
3
-- Module      :  Distribution.Simple.PackageIndex
4 5
-- Copyright   :  (c) David Himmelstrup 2005,
--                    Bjorn Bringert 2007,
Duncan Coutts's avatar
Duncan Coutts committed
6
--                    Duncan Coutts 2008-2009
7
--
Duncan Coutts's avatar
Duncan Coutts committed
8
-- Maintainer  :  cabal-devel@haskell.org
9 10
-- Portability :  portable
--
11
-- An index of packages.
Duncan Coutts's avatar
Duncan Coutts committed
12
--
13 14 15
module Distribution.Simple.PackageIndex (
  -- * Package index data type
  PackageIndex,
16

17
  -- * Creating an index
18 19
  fromList,

20
  -- * Updates
21
  merge,
Duncan Coutts's avatar
Duncan Coutts committed
22

23
  insert,
Duncan Coutts's avatar
Duncan Coutts committed
24 25 26

  deleteInstalledPackageId,
  deleteSourcePackageId,
27
  deletePackageName,
Duncan Coutts's avatar
Duncan Coutts committed
28
--  deleteDependency,
29 30 31 32

  -- * Queries

  -- ** Precise lookups
Duncan Coutts's avatar
Duncan Coutts committed
33 34
  lookupInstalledPackageId,
  lookupSourcePackageId,
35
  lookupPackageName,
36 37 38 39 40 41 42 43 44 45
  lookupDependency,

  -- ** Case-insensitive searches
  searchByName,
  SearchResult(..),
  searchByNameSubstring,

  -- ** Bulk queries
  allPackages,
  allPackagesByName,
46
  allPackagesBySourcePackageId,
47 48 49 50 51 52 53 54 55 56

  -- ** Special queries
  brokenPackages,
  dependencyClosure,
  reverseDependencyClosure,
  topologicalOrder,
  reverseTopologicalOrder,
  dependencyInconsistencies,
  dependencyCycles,
  dependencyGraph,
Duncan Coutts's avatar
Duncan Coutts committed
57
  moduleNameIndex,
58 59 60 61 62 63
  ) where

import Prelude hiding (lookup)
import Control.Exception (assert)
import qualified Data.Map as Map
import Data.Map (Map)
64 65 66 67
import qualified Data.Tree  as Tree
import qualified Data.Graph as Graph
import qualified Data.Array as Array
import Data.Array ((!))
Duncan Coutts's avatar
Duncan Coutts committed
68
import Data.List as List
69
         ( null, foldl', sort
Duncan Coutts's avatar
Duncan Coutts committed
70
         , groupBy, sortBy, find, isInfixOf, nubBy, deleteBy, deleteFirstsBy )
71
import Data.Monoid (Monoid(..))
72
import Data.Maybe (isNothing, fromMaybe)
73

74
import Distribution.Package
Duncan Coutts's avatar
Duncan Coutts committed
75
         ( PackageName(..), PackageId
76
         , Package(..), packageName, packageVersion
Duncan Coutts's avatar
Duncan Coutts committed
77
         , Dependency(Dependency)--, --PackageFixedDeps(..)
78
         , InstalledPackageId(..) )
Duncan Coutts's avatar
Duncan Coutts committed
79 80
import Distribution.ModuleName
         ( ModuleName )
81
import Distribution.InstalledPackageInfo
Duncan Coutts's avatar
Duncan Coutts committed
82
         ( InstalledPackageInfo, installedPackageId )
83
import qualified Distribution.InstalledPackageInfo as IPI
84
import Distribution.Version
85
         ( Version, withinRange )
Duncan Coutts's avatar
Duncan Coutts committed
86
import Distribution.Simple.Utils (lowercase, comparing, equating)
87 88
import Distribution.ModuleExport
         ( ModuleExport(..) )
89

90

91 92
-- | The collection of information about packages from one or more 'PackageDB's.
--
Duncan Coutts's avatar
Duncan Coutts committed
93
-- Packages are uniquely identified in by their 'InstalledPackageId', they can
Ian D. Bollinger's avatar
Ian D. Bollinger committed
94
-- also be efficiently looked up by package name or by name and version.
95
--
Duncan Coutts's avatar
Duncan Coutts committed
96 97 98 99 100 101
data PackageIndex = PackageIndex
  -- The primary index. Each InstalledPackageInfo record is uniquely identified
  -- by its InstalledPackageId.
  --
  !(Map InstalledPackageId InstalledPackageInfo)

Ian D. Bollinger's avatar
Ian D. Bollinger committed
102
  -- This auxiliary index maps package names (case-sensitively) to all the
Duncan Coutts's avatar
Duncan Coutts committed
103 104
  -- versions and instances of that package. This allows us to find all
  -- versions satisfying a dependency.
105
  --
Duncan Coutts's avatar
Duncan Coutts committed
106 107 108 109
  -- It is a three-level index. The first level is the package name,
  -- the second is the package version and the final level is instances
  -- of the same package version. These are unique by InstalledPackageId
  -- and are kept in preference order.
110
  --
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
111 112
  -- FIXME: Clarify what "preference order" means. Check that this invariant is
  -- preserved. See #1463 for discussion.
Duncan Coutts's avatar
Duncan Coutts committed
113
  !(Map PackageName (Map Version [InstalledPackageInfo]))
114 115

  deriving (Show, Read)
Duncan Coutts's avatar
Duncan Coutts committed
116 117 118

instance Monoid PackageIndex where
  mempty  = PackageIndex Map.empty Map.empty
119 120 121 122 123
  mappend = merge
  --save one mappend with empty in the common case:
  mconcat [] = mempty
  mconcat xs = foldr1 mappend xs

Duncan Coutts's avatar
Duncan Coutts committed
124 125 126
invariant :: PackageIndex -> Bool
invariant (PackageIndex pids pnames) =
     map installedPackageId (Map.elems pids)
127 128
  == sort
     [ assert pinstOk (installedPackageId pinst)
Duncan Coutts's avatar
Duncan Coutts committed
129 130 131 132 133 134 135 136 137 138 139
     | (pname, pvers)  <- Map.toList pnames
     , let pversOk = not (Map.null pvers)
     , (pver,  pinsts) <- assert pversOk $ Map.toList pvers
     , let pinsts'  = sortBy (comparing installedPackageId) pinsts
           pinstsOk = all (\g -> length g == 1)
                          (groupBy (equating installedPackageId) pinsts')
     , pinst           <- assert pinstsOk $ pinsts'
     , let pinstOk = packageName    pinst == pname
                  && packageVersion pinst == pver
     ]

140

141 142 143 144
--
-- * Internal helpers
--

Duncan Coutts's avatar
Duncan Coutts committed
145 146 147 148 149
mkPackageIndex :: Map InstalledPackageId InstalledPackageInfo
               -> Map PackageName (Map Version [InstalledPackageInfo])
               -> PackageIndex
mkPackageIndex pids pnames = assert (invariant index) index
  where index = PackageIndex pids pnames
150

151 152 153

--
-- * Construction
154 155
--

156
-- | Build an index out of a bunch of packages.
157
--
Duncan Coutts's avatar
Duncan Coutts committed
158 159
-- If there are duplicates by 'InstalledPackageId' then later ones mask earlier
-- ones.
160
--
Duncan Coutts's avatar
Duncan Coutts committed
161 162
fromList :: [InstalledPackageInfo] -> PackageIndex
fromList pkgs = mkPackageIndex pids pnames
163
  where
Duncan Coutts's avatar
Duncan Coutts committed
164 165 166 167 168 169 170 171 172 173 174 175 176 177
    pids      = Map.fromList [ (installedPackageId pkg, pkg) | pkg <- pkgs ]
    pnames    =
      Map.fromList
        [ (packageName (head pkgsN), pvers)
        | pkgsN <- groupBy (equating  packageName)
                 . sortBy  (comparing packageId)
                 $ pkgs
        , let pvers =
                Map.fromList
                [ (packageVersion (head pkgsNV),
                   nubBy (equating installedPackageId) (reverse pkgsNV))
                | pkgsNV <- groupBy (equating packageVersion) pkgsN
                ]
        ]
178

179 180 181 182
--
-- * Updates
--

183 184
-- | Merge two indexes.
--
Duncan Coutts's avatar
Duncan Coutts committed
185 186
-- Packages from the second mask packages from the first if they have the exact
-- same 'InstalledPackageId'.
187
--
Duncan Coutts's avatar
Duncan Coutts committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201
-- For packages with the same source 'PackageId', packages from the second are
-- \"preferred\" over those from the first. Being preferred means they are top
-- result when we do a lookup by source 'PackageId'. This is the mechanism we
-- use to prefer user packages over global packages.
--
merge :: PackageIndex -> PackageIndex -> PackageIndex
merge (PackageIndex pids1 pnames1) (PackageIndex pids2 pnames2) =
  mkPackageIndex (Map.union pids1 pids2)
                 (Map.unionWith (Map.unionWith mergeBuckets) pnames1 pnames2)
  where
    -- Packages in the second list mask those in the first, however preferred
    -- packages go first in the list.
    mergeBuckets xs ys = ys ++ (xs \\ ys)
    (\\) = deleteFirstsBy (equating installedPackageId)
202

203

Duncan Coutts's avatar
Duncan Coutts committed
204
-- | Inserts a single package into the index.
205 206 207 208
--
-- This is equivalent to (but slightly quicker than) using 'mappend' or
-- 'merge' with a singleton index.
--
Duncan Coutts's avatar
Duncan Coutts committed
209 210 211 212
insert :: InstalledPackageInfo -> PackageIndex -> PackageIndex
insert pkg (PackageIndex pids pnames) =
    mkPackageIndex pids' pnames'

213
  where
Duncan Coutts's avatar
Duncan Coutts committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    pids'   = Map.insert (installedPackageId pkg) pkg pids
    pnames' = insertPackageName pnames
    insertPackageName =
      Map.insertWith' (\_ -> insertPackageVersion)
                     (packageName pkg)
                     (Map.singleton (packageVersion pkg) [pkg])

    insertPackageVersion =
      Map.insertWith' (\_ -> insertPackageInstance)
                     (packageVersion pkg) [pkg]

    insertPackageInstance pkgs =
      pkg : deleteBy (equating installedPackageId) pkg pkgs


-- | Removes a single installed package from the index.
--
deleteInstalledPackageId :: InstalledPackageId -> PackageIndex -> PackageIndex
deleteInstalledPackageId ipkgid original@(PackageIndex pids pnames) =
  case Map.updateLookupWithKey (\_ _ -> Nothing) ipkgid pids of
    (Nothing,     _)     -> original
    (Just spkgid, pids') -> mkPackageIndex pids'
                                          (deletePkgName spkgid pnames)

Duncan Coutts's avatar
Duncan Coutts committed
238
  where
Duncan Coutts's avatar
Duncan Coutts committed
239 240 241 242 243 244
    deletePkgName spkgid =
      Map.update (deletePkgVersion spkgid) (packageName spkgid)

    deletePkgVersion spkgid =
        (\m -> if Map.null m then Nothing else Just m)
      . Map.update deletePkgInstance (packageVersion spkgid)
Duncan Coutts's avatar
Duncan Coutts committed
245

Duncan Coutts's avatar
Duncan Coutts committed
246 247 248 249 250 251
    deletePkgInstance =
        (\xs -> if List.null xs then Nothing else Just xs)
      . List.deleteBy (\_ pkg -> installedPackageId pkg == ipkgid) undefined


-- | Removes all packages with this source 'PackageId' from the index.
252
--
Duncan Coutts's avatar
Duncan Coutts committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
deleteSourcePackageId :: PackageId -> PackageIndex -> PackageIndex
deleteSourcePackageId pkgid original@(PackageIndex pids pnames) =
  case Map.lookup (packageName pkgid) pnames of
    Nothing     -> original
    Just pvers  -> case Map.lookup (packageVersion pkgid) pvers of
      Nothing   -> original
      Just pkgs -> mkPackageIndex
                     (foldl' (flip (Map.delete . installedPackageId)) pids pkgs)
                     (deletePkgName pnames)
  where
    deletePkgName =
      Map.update deletePkgVersion (packageName pkgid)

    deletePkgVersion =
        (\m -> if Map.null m then Nothing else Just m)
      . Map.delete (packageVersion pkgid)

270 271 272

-- | Removes all packages with this (case-sensitive) name from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
273 274 275 276 277 278 279 280
deletePackageName :: PackageName -> PackageIndex -> PackageIndex
deletePackageName name original@(PackageIndex pids pnames) =
  case Map.lookup name pnames of
    Nothing     -> original
    Just pvers  -> mkPackageIndex
                     (foldl' (flip (Map.delete . installedPackageId)) pids
                             (concat (Map.elems pvers)))
                     (Map.delete name pnames)
281

Duncan Coutts's avatar
Duncan Coutts committed
282
{-
283 284
-- | Removes all packages satisfying this dependency from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
285
deleteDependency :: Dependency -> PackageIndex -> PackageIndex
286
deleteDependency (Dependency name verstionRange) =
Duncan Coutts's avatar
Duncan Coutts committed
287 288
  delete' name (\pkg -> packageVersion pkg `withinRange` verstionRange)
-}
289

290 291 292 293
--
-- * Bulk queries
--

294 295
-- | Get all the packages from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
296 297
allPackages :: PackageIndex -> [InstalledPackageInfo]
allPackages (PackageIndex pids _) = Map.elems pids
298 299 300

-- | Get all the packages from the index.
--
301
-- They are grouped by package name (case-sensitively).
302
--
303
allPackagesByName :: PackageIndex -> [(PackageName, [InstalledPackageInfo])]
Duncan Coutts's avatar
Duncan Coutts committed
304
allPackagesByName (PackageIndex _ pnames) =
305 306 307 308 309 310 311 312 313 314 315 316
  [ (pkgname, concat (Map.elems pvers))
  | (pkgname, pvers) <- Map.toList pnames ]

-- | Get all the packages from the index.
--
-- They are grouped by source package id (package name and version).
--
allPackagesBySourcePackageId :: PackageIndex -> [(PackageId, [InstalledPackageInfo])]
allPackagesBySourcePackageId (PackageIndex _ pnames) =
  [ (packageId ipkg, ipkgs)
  | pvers <- Map.elems pnames
  , ipkgs@(ipkg:_) <- Map.elems pvers ]
317 318 319 320 321

--
-- * Lookups
--

Duncan Coutts's avatar
Duncan Coutts committed
322
-- | Does a lookup by source package id (name & version).
323
--
Duncan Coutts's avatar
Duncan Coutts committed
324
-- Since multiple package DBs mask each other by 'InstalledPackageId',
325 326
-- then we get back at most one package.
--
Duncan Coutts's avatar
Duncan Coutts committed
327 328 329 330
lookupInstalledPackageId :: PackageIndex -> InstalledPackageId
                         -> Maybe InstalledPackageInfo
lookupInstalledPackageId (PackageIndex pids _) pid = Map.lookup pid pids

331

Duncan Coutts's avatar
Duncan Coutts committed
332 333 334 335 336
-- | Does a lookup by source package id (name & version).
--
-- There can be multiple installed packages with the same source 'PackageId'
-- but different 'InstalledPackageId'. They are returned in order of
-- preference, with the most preferred first.
337
--
Duncan Coutts's avatar
Duncan Coutts committed
338 339 340 341 342 343 344
lookupSourcePackageId :: PackageIndex -> PackageId -> [InstalledPackageInfo]
lookupSourcePackageId (PackageIndex _ pnames) pkgid =
  case Map.lookup (packageName pkgid) pnames of
    Nothing     -> []
    Just pvers  -> case Map.lookup (packageVersion pkgid) pvers of
      Nothing   -> []
      Just pkgs -> pkgs -- in preference order
345

Duncan Coutts's avatar
Duncan Coutts committed
346 347 348 349 350 351 352 353 354 355 356 357

-- | Does a lookup by source package name.
--
lookupPackageName :: PackageIndex -> PackageName
                  -> [(Version, [InstalledPackageInfo])]
lookupPackageName (PackageIndex _ pnames) name =
  case Map.lookup name pnames of
    Nothing     -> []
    Just pvers  -> Map.toList pvers


-- | Does a lookup by source package name and a range of versions.
358 359 360 361
--
-- We get back any number of versions of the specified package name, all
-- satisfying the version range constraint.
--
Duncan Coutts's avatar
Duncan Coutts committed
362 363 364 365 366 367 368 369
lookupDependency :: PackageIndex -> Dependency
                 -> [(Version, [InstalledPackageInfo])]
lookupDependency (PackageIndex _ pnames) (Dependency name versionRange) =
  case Map.lookup name pnames of
    Nothing    -> []
    Just pvers -> [ entry
                  | entry@(ver, _) <- Map.toList pvers
                  , ver `withinRange` versionRange ]
370 371 372 373

--
-- * Case insensitive name lookups
--
374 375 376

-- | Does a case-insensitive search by package name.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
377
-- If there is only one package that compares case-insensitively to this name
378
-- then the search is unambiguous and we get back all versions of that package.
Ian D. Bollinger's avatar
Ian D. Bollinger committed
379
-- If several match case-insensitively but one matches exactly then it is also
380 381
-- unambiguous.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
382
-- If however several match case-insensitively and none match exactly then we
383 384 385 386
-- have an ambiguous result, and we get back all the versions of all the
-- packages. The list of ambiguous results is split by exact package name. So
-- it is a non-empty list of non-empty lists.
--
Duncan Coutts's avatar
Duncan Coutts committed
387 388 389
searchByName :: PackageIndex -> String -> SearchResult [InstalledPackageInfo]
searchByName (PackageIndex _ pnames) name =
  case [ pkgs | pkgs@(PackageName name',_) <- Map.toList pnames
390
              , lowercase name' == lname ] of
Duncan Coutts's avatar
Duncan Coutts committed
391 392 393 394 395
    []               -> None
    [(_,pvers)]      -> Unambiguous (concat (Map.elems pvers))
    pkgss            -> case find ((PackageName name==) . fst) pkgss of
      Just (_,pvers) -> Unambiguous (concat (Map.elems pvers))
      Nothing        -> Ambiguous (map (concat . Map.elems . snd) pkgss)
396
  where lname = lowercase name
397 398 399 400 401 402 403

data SearchResult a = None | Unambiguous a | Ambiguous [a]

-- | Does a case-insensitive substring search by package name.
--
-- That is, all packages that contain the given string in their name.
--
Duncan Coutts's avatar
Duncan Coutts committed
404 405
searchByNameSubstring :: PackageIndex -> String -> [InstalledPackageInfo]
searchByNameSubstring (PackageIndex _ pnames) searchterm =
406
  [ pkg
Duncan Coutts's avatar
Duncan Coutts committed
407
  | (PackageName name, pvers) <- Map.toList pnames
408
  , lsearchterm `isInfixOf` lowercase name
Duncan Coutts's avatar
Duncan Coutts committed
409
  , pkgs <- Map.elems pvers
410
  , pkg <- pkgs ]
411
  where lsearchterm = lowercase searchterm
412

Duncan Coutts's avatar
Duncan Coutts committed
413 414 415 416 417 418 419 420

--
-- * Special queries
--

-- None of the stuff below depends on the internal representation of the index.
--

421 422 423 424 425 426 427
-- | Find if there are any cycles in the dependency graph. If there are no
-- cycles the result is @[]@.
--
-- This actually computes the strongly connected components. So it gives us a
-- list of groups of packages where within each group they all depend on each
-- other, directly or indirectly.
--
Duncan Coutts's avatar
Duncan Coutts committed
428
dependencyCycles :: PackageIndex -> [[InstalledPackageInfo]]
429 430 431
dependencyCycles index =
  [ vs | Graph.CyclicSCC vs <- Graph.stronglyConnComp adjacencyList ]
  where
Duncan Coutts's avatar
Duncan Coutts committed
432
    adjacencyList = [ (pkg, installedPackageId pkg, IPI.depends pkg)
433 434 435
                    | pkg <- allPackages index ]


Duncan Coutts's avatar
Duncan Coutts committed
436
-- | All packages that have immediate dependencies that are not in the index.
437
--
438 439
-- Returns such packages along with the dependencies that they're missing.
--
Duncan Coutts's avatar
Duncan Coutts committed
440
brokenPackages :: PackageIndex -> [(InstalledPackageInfo, [InstalledPackageId])]
441 442
brokenPackages index =
  [ (pkg, missing)
Duncan Coutts's avatar
Duncan Coutts committed
443
  | pkg  <- allPackages index
444
  , let missing = [ pkg' | pkg' <- IPI.depends pkg
Duncan Coutts's avatar
Duncan Coutts committed
445
                         , isNothing (lookupInstalledPackageId index pkg') ]
446 447
  , not (null missing) ]

448

449
-- | Tries to take the transitive closure of the package dependencies.
450
--
451
-- If the transitive closure is complete then it returns that subset of the
452 453 454
-- index. Otherwise it returns the broken packages as in 'brokenPackages'.
--
-- * Note that if the result is @Right []@ it is because at least one of
Duncan Coutts's avatar
Duncan Coutts committed
455
-- the original given 'PackageId's do not occur in the index.
456
--
Duncan Coutts's avatar
Duncan Coutts committed
457
dependencyClosure :: PackageIndex
458
                  -> [InstalledPackageId]
Duncan Coutts's avatar
Duncan Coutts committed
459
                  -> Either PackageIndex
460
                            [(InstalledPackageInfo, [InstalledPackageId])]
461 462 463
dependencyClosure index pkgids0 = case closure mempty [] pkgids0 of
  (completed, []) -> Left completed
  (completed, _)  -> Right (brokenPackages completed)
464
 where
465
    closure completed failed []             = (completed, failed)
Duncan Coutts's avatar
Duncan Coutts committed
466
    closure completed failed (pkgid:pkgids) = case lookupInstalledPackageId index pkgid of
467
      Nothing   -> closure completed (pkgid:failed) pkgids
Duncan Coutts's avatar
Duncan Coutts committed
468
      Just pkg  -> case lookupInstalledPackageId completed (installedPackageId pkg) of
469 470
        Just _  -> closure completed  failed pkgids
        Nothing -> closure completed' failed pkgids'
Duncan Coutts's avatar
Duncan Coutts committed
471
          where completed' = insert pkg completed
472
                pkgids'    = IPI.depends pkg ++ pkgids
473

474
-- | Takes the transitive closure of the packages reverse dependencies.
475
--
Duncan Coutts's avatar
Duncan Coutts committed
476
-- * The given 'PackageId's must be in the index.
477
--
Duncan Coutts's avatar
Duncan Coutts committed
478
reverseDependencyClosure :: PackageIndex
479 480
                         -> [InstalledPackageId]
                         -> [InstalledPackageInfo]
481 482 483 484 485
reverseDependencyClosure index =
    map vertexToPkg
  . concatMap Tree.flatten
  . Graph.dfs reverseDepGraph
  . map (fromMaybe noSuchPkgId . pkgIdToVertex)
486

487 488 489 490 491
  where
    (depGraph, vertexToPkg, pkgIdToVertex) = dependencyGraph index
    reverseDepGraph = Graph.transposeG depGraph
    noSuchPkgId = error "reverseDependencyClosure: package is not in the graph"

Duncan Coutts's avatar
Duncan Coutts committed
492
topologicalOrder :: PackageIndex -> [InstalledPackageInfo]
493 494 495 496 497
topologicalOrder index = map toPkgId
                       . Graph.topSort
                       $ graph
  where (graph, toPkgId, _) = dependencyGraph index

Duncan Coutts's avatar
Duncan Coutts committed
498
reverseTopologicalOrder :: PackageIndex -> [InstalledPackageInfo]
499 500 501 502 503 504 505 506 507 508 509
reverseTopologicalOrder index = map toPkgId
                              . Graph.topSort
                              . Graph.transposeG
                              $ graph
  where (graph, toPkgId, _) = dependencyGraph index

-- | Builds a graph of the package dependencies.
--
-- Dependencies on other packages that are not in the index are discarded.
-- You can check if there are any such dependencies with 'brokenPackages'.
--
Duncan Coutts's avatar
Duncan Coutts committed
510
dependencyGraph :: PackageIndex
511
                -> (Graph.Graph,
512 513 514
                    Graph.Vertex -> InstalledPackageInfo,
                    InstalledPackageId -> Maybe Graph.Vertex)
dependencyGraph index = (graph, vertex_to_pkg, id_to_vertex)
515 516
  where
    graph = Array.listArray bounds
517
              [ [ v | Just v <- map id_to_vertex (IPI.depends pkg) ]
518
              | pkg <- pkgs ]
519

Duncan Coutts's avatar
Duncan Coutts committed
520
    pkgs             = sortBy (comparing packageId) (allPackages index)
521 522 523 524 525
    vertices         = zip (map installedPackageId pkgs) [0..]
    vertex_map       = Map.fromList vertices
    id_to_vertex pid = Map.lookup pid vertex_map

    vertex_to_pkg vertex = pkgTable ! vertex
526 527 528 529 530

    pkgTable   = Array.listArray bounds pkgs
    topBound = length pkgs - 1
    bounds = (0, topBound)

531 532 533 534 535 536 537 538 539 540
-- | Given a package index where we assume we want to use all the packages
-- (use 'dependencyClosure' if you need to get such a index subset) find out
-- if the dependencies within it use consistent versions of each package.
-- Return all cases where multiple packages depend on different versions of
-- some other package.
--
-- Each element in the result is a package name along with the packages that
-- depend on it and the versions they require. These are guaranteed to be
-- distinct.
--
Duncan Coutts's avatar
Duncan Coutts committed
541 542
dependencyInconsistencies :: PackageIndex
                          -> [(PackageName, [(PackageId, Version)])]
543 544 545 546 547 548 549 550 551 552 553 554
dependencyInconsistencies index =
  [ (name, [ (pid,packageVersion dep) | (dep,pids) <- uses, pid <- pids])
  | (name, ipid_map) <- Map.toList inverseIndex
  , let uses = Map.elems ipid_map
  , reallyIsInconsistent (map fst uses) ]

  where -- for each PackageName,
        --   for each package with that name,
        --     the InstalledPackageInfo and the package Ids of packages
        --     that depend on it.
        inverseIndex :: Map PackageName
                            (Map InstalledPackageId
Duncan Coutts's avatar
Duncan Coutts committed
555
                                 (InstalledPackageInfo, [PackageId]))
556 557 558
        inverseIndex = Map.fromListWith (Map.unionWith (\(a,b) (_,b') -> (a,b++b')))
          [ (packageName dep,
             Map.fromList [(ipid,(dep,[packageId pkg]))])
Duncan Coutts's avatar
Duncan Coutts committed
559
          | pkg <- allPackages index
560
          , ipid <- IPI.depends pkg
Duncan Coutts's avatar
Duncan Coutts committed
561
          , Just dep <- [lookupInstalledPackageId index ipid]
562 563 564 565 566 567 568 569 570
          ]

        reallyIsInconsistent :: [InstalledPackageInfo] -> Bool
        reallyIsInconsistent []       = False
        reallyIsInconsistent [_p]     = False
        reallyIsInconsistent [p1, p2] =
             installedPackageId p1 `notElem` IPI.depends p2
          && installedPackageId p2 `notElem` IPI.depends p1
        reallyIsInconsistent _ = True
Duncan Coutts's avatar
Duncan Coutts committed
571 572


573 574 575
-- | A rough approximation of GHC's module finder, takes a 'PackageIndex' and
-- turns it into a map from module names to their source packages.  It's used to
-- initialize the @build-deps@ field in @cabal init@.
Duncan Coutts's avatar
Duncan Coutts committed
576 577
moduleNameIndex :: PackageIndex -> Map ModuleName [InstalledPackageInfo]
moduleNameIndex index =
578 579 580 581 582 583 584 585 586 587 588 589
  Map.fromListWith (++) . concat $
    [ [(m,  [pkg]) | m <- IPI.exposedModules pkg ] ++
      [(m', [pkg]) | ModuleExport{ exportOrigName = m
                                 , exportName = m'
                                 } <- IPI.reexportedModules pkg
                   , m /= m' ]
        -- The heuristic is this: we want to prefer the original package
        -- which originally exported a module.  However, if a reexport
        -- also *renamed* the module (m /= m'), then we have to use the
        -- downstream package, since the upstream package has the wrong
        -- module name!
    | pkg        <- allPackages index ]