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

89 90
-- | The collection of information about packages from one or more 'PackageDB's.
--
Duncan Coutts's avatar
Duncan Coutts committed
91
-- Packages are uniquely identified in by their 'InstalledPackageId', they can
Ian D. Bollinger's avatar
Ian D. Bollinger committed
92
-- also be efficiently looked up by package name or by name and version.
93
--
Duncan Coutts's avatar
Duncan Coutts committed
94 95 96 97 98 99
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
100
  -- This auxiliary index maps package names (case-sensitively) to all the
Duncan Coutts's avatar
Duncan Coutts committed
101 102
  -- versions and instances of that package. This allows us to find all
  -- versions satisfying a dependency.
103
  --
Duncan Coutts's avatar
Duncan Coutts committed
104 105 106 107
  -- 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.
108
  --
Mikhail Glushenkov's avatar
Mikhail Glushenkov committed
109 110
  -- FIXME: Clarify what "preference order" means. Check that this invariant is
  -- preserved. See #1463 for discussion.
Duncan Coutts's avatar
Duncan Coutts committed
111
  !(Map PackageName (Map Version [InstalledPackageInfo]))
112 113

  deriving (Show, Read)
Duncan Coutts's avatar
Duncan Coutts committed
114 115 116

instance Monoid PackageIndex where
  mempty  = PackageIndex Map.empty Map.empty
117 118 119 120 121
  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
122 123 124
invariant :: PackageIndex -> Bool
invariant (PackageIndex pids pnames) =
     map installedPackageId (Map.elems pids)
125 126
  == sort
     [ assert pinstOk (installedPackageId pinst)
Duncan Coutts's avatar
Duncan Coutts committed
127 128 129 130 131 132 133 134 135 136 137
     | (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
     ]

138

139 140 141 142
--
-- * Internal helpers
--

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

149 150 151

--
-- * Construction
152 153
--

154
-- | Build an index out of a bunch of packages.
155
--
Duncan Coutts's avatar
Duncan Coutts committed
156 157
-- If there are duplicates by 'InstalledPackageId' then later ones mask earlier
-- ones.
158
--
Duncan Coutts's avatar
Duncan Coutts committed
159 160
fromList :: [InstalledPackageInfo] -> PackageIndex
fromList pkgs = mkPackageIndex pids pnames
161
  where
Duncan Coutts's avatar
Duncan Coutts committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175
    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
                ]
        ]
176

177 178 179 180
--
-- * Updates
--

181 182
-- | Merge two indexes.
--
Duncan Coutts's avatar
Duncan Coutts committed
183 184
-- Packages from the second mask packages from the first if they have the exact
-- same 'InstalledPackageId'.
185
--
Duncan Coutts's avatar
Duncan Coutts committed
186 187 188 189 190 191 192 193 194 195 196 197 198 199
-- 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)
200

201

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

211
  where
Duncan Coutts's avatar
Duncan Coutts committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
    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
236
  where
Duncan Coutts's avatar
Duncan Coutts committed
237 238 239 240 241 242
    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
243

Duncan Coutts's avatar
Duncan Coutts committed
244 245 246 247 248 249
    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.
250
--
Duncan Coutts's avatar
Duncan Coutts committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
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)

268 269 270

-- | Removes all packages with this (case-sensitive) name from the index.
--
Duncan Coutts's avatar
Duncan Coutts committed
271 272 273 274 275 276 277 278
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)
279

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

288 289 290 291
--
-- * Bulk queries
--

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

-- | Get all the packages from the index.
--
299
-- They are grouped by package name (case-sensitively).
300
--
301
allPackagesByName :: PackageIndex -> [(PackageName, [InstalledPackageInfo])]
Duncan Coutts's avatar
Duncan Coutts committed
302
allPackagesByName (PackageIndex _ pnames) =
303 304 305 306 307 308 309 310 311 312 313 314
  [ (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 ]
315 316 317 318 319

--
-- * Lookups
--

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

329

Duncan Coutts's avatar
Duncan Coutts committed
330 331 332 333 334
-- | 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.
335
--
Duncan Coutts's avatar
Duncan Coutts committed
336 337 338 339 340 341 342
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
343

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

-- | 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.
356 357 358 359
--
-- 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
360 361 362 363 364 365 366 367
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 ]
368 369 370 371

--
-- * Case insensitive name lookups
--
372 373 374

-- | Does a case-insensitive search by package name.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
375
-- If there is only one package that compares case-insensitively to this name
376
-- then the search is unambiguous and we get back all versions of that package.
Ian D. Bollinger's avatar
Ian D. Bollinger committed
377
-- If several match case-insensitively but one matches exactly then it is also
378 379
-- unambiguous.
--
Ian D. Bollinger's avatar
Ian D. Bollinger committed
380
-- If however several match case-insensitively and none match exactly then we
381 382 383 384
-- 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
385 386 387
searchByName :: PackageIndex -> String -> SearchResult [InstalledPackageInfo]
searchByName (PackageIndex _ pnames) name =
  case [ pkgs | pkgs@(PackageName name',_) <- Map.toList pnames
388
              , lowercase name' == lname ] of
Duncan Coutts's avatar
Duncan Coutts committed
389 390 391 392 393
    []               -> 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)
394
  where lname = lowercase name
395 396 397 398 399 400 401

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
402 403
searchByNameSubstring :: PackageIndex -> String -> [InstalledPackageInfo]
searchByNameSubstring (PackageIndex _ pnames) searchterm =
404
  [ pkg
Duncan Coutts's avatar
Duncan Coutts committed
405
  | (PackageName name, pvers) <- Map.toList pnames
406
  , lsearchterm `isInfixOf` lowercase name
Duncan Coutts's avatar
Duncan Coutts committed
407
  , pkgs <- Map.elems pvers
408
  , pkg <- pkgs ]
409
  where lsearchterm = lowercase searchterm
410

Duncan Coutts's avatar
Duncan Coutts committed
411 412 413 414 415 416 417 418

--
-- * Special queries
--

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

419 420 421 422 423 424 425
-- | 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
426
dependencyCycles :: PackageIndex -> [[InstalledPackageInfo]]
427 428 429
dependencyCycles index =
  [ vs | Graph.CyclicSCC vs <- Graph.stronglyConnComp adjacencyList ]
  where
Duncan Coutts's avatar
Duncan Coutts committed
430
    adjacencyList = [ (pkg, installedPackageId pkg, IPI.depends pkg)
431 432 433
                    | pkg <- allPackages index ]


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

446

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

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

485 486 487 488 489
  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
490
topologicalOrder :: PackageIndex -> [InstalledPackageInfo]
491 492 493 494 495
topologicalOrder index = map toPkgId
                       . Graph.topSort
                       $ graph
  where (graph, toPkgId, _) = dependencyGraph index

Duncan Coutts's avatar
Duncan Coutts committed
496
reverseTopologicalOrder :: PackageIndex -> [InstalledPackageInfo]
497 498 499 500 501 502 503 504 505 506 507
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
508
dependencyGraph :: PackageIndex
509
                -> (Graph.Graph,
510 511 512
                    Graph.Vertex -> InstalledPackageInfo,
                    InstalledPackageId -> Maybe Graph.Vertex)
dependencyGraph index = (graph, vertex_to_pkg, id_to_vertex)
513 514
  where
    graph = Array.listArray bounds
515
              [ [ v | Just v <- map id_to_vertex (IPI.depends pkg) ]
516
              | pkg <- pkgs ]
517

Duncan Coutts's avatar
Duncan Coutts committed
518
    pkgs             = sortBy (comparing packageId) (allPackages index)
519 520 521 522 523
    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
524 525 526 527 528

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

529 530 531 532 533 534 535 536 537 538
-- | 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
539 540
dependencyInconsistencies :: PackageIndex
                          -> [(PackageName, [(PackageId, Version)])]
541 542 543 544 545 546 547 548 549 550 551 552
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
553
                                 (InstalledPackageInfo, [PackageId]))
554 555 556
        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
557
          | pkg <- allPackages index
558
          , ipid <- IPI.depends pkg
Duncan Coutts's avatar
Duncan Coutts committed
559
          , Just dep <- [lookupInstalledPackageId index ipid]
560 561 562 563 564 565 566 567 568
          ]

        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
569 570


571 572 573
-- | 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
574 575
moduleNameIndex :: PackageIndex -> Map ModuleName [InstalledPackageInfo]
moduleNameIndex index =
576 577
  Map.fromListWith (++) . concat $
    [ [(m,  [pkg]) | m <- IPI.exposedModules pkg ] ++
578 579 580 581
      [(m', [pkg]) | IPI.ModuleReexport {
                       IPI.moduleReexportDefiningName = m,
                       IPI.moduleReexportName         = m'
                     } <- IPI.reexportedModules pkg
582 583 584 585 586 587 588
                   , 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 ]