Move most solver code to new module namespace

Author: BardurArantsson

cabal-install/Distribution/Client/BuildReports/Storage.hs

@@ -28,10 +28,12 @@ import Distribution.Client.BuildReports.Anonymous (BuildReport)
 
 import Distribution.Client.Types
 import qualified Distribution.Client.InstallPlan as InstallPlan
-import qualified Distribution.Client.ComponentDeps as CD
 import Distribution.Client.InstallPlan
          ( InstallPlan )
 
+import qualified Distribution.Solver.Types.ComponentDeps as CD
+import           Distribution.Solver.Types.SourcePackage
+
 import Distribution.Package
          ( PackageId, packageId )
 import Distribution.PackageDescription

cabal-install/Distribution/Client/Configure.hs

@@ -26,8 +26,6 @@ import qualified Distribution.Client.InstallPlan as InstallPlan
 import Distribution.Client.InstallPlan (SolverInstallPlan)
 import Distribution.Client.IndexUtils as IndexUtils
          ( getSourcePackages, getInstalledPackages )
-import Distribution.Client.PackageIndex ( PackageIndex, elemByPackageName )
-import Distribution.Client.PkgConfigDb (PkgConfigDb, readPkgConfigDb)
 import Distribution.Client.Setup
          ( ConfigExFlags(..), configureCommand, filterConfigureFlags
          , RepoContext(..) )
@@ -36,10 +34,17 @@ import Distribution.Client.SetupWrapper
          ( setupWrapper, SetupScriptOptions(..), defaultSetupScriptOptions )
 import Distribution.Client.Targets
          ( userToPackageConstraint, userConstraintPackageName )
-import qualified Distribution.Client.ComponentDeps as CD
 import Distribution.Package (PackageId)
 import Distribution.Client.JobControl (Lock)
 
+import qualified Distribution.Solver.Types.ComponentDeps as CD
+import           Distribution.Solver.Types.OptionalStanza
+import           Distribution.Solver.Types.PackageIndex
+                   ( PackageIndex, elemByPackageName )
+import           Distribution.Solver.Types.PkgConfigDb
+                   (PkgConfigDb, readPkgConfigDb)
+import           Distribution.Solver.Types.SourcePackage
+
 import Distribution.Simple.Compiler
          ( Compiler, CompilerInfo, compilerInfo, PackageDB(..), PackageDBStack )
 import Distribution.Simple.Program (ProgramConfiguration )
@@ -292,7 +297,7 @@ planLocalPackage verbosity comp platform configFlags configExFlags
   let -- We create a local package and ask to resolve a dependency on it
       localPkg = SourcePackage {
         packageInfoId             = packageId pkg,
-        Source.packageDescription = pkg,
+        packageDescription        = pkg,
         packageSource             = LocalUnpackedPackage ".",
         packageDescrOverride      = Nothing
       }

cabal-install/Distribution/Client/Dependency.hs

@@ -63,34 +63,26 @@ module Distribution.Client.Dependency (
 
 import Distribution.Client.Dependency.TopDown
          ( topDownResolver )
-import Distribution.Client.Dependency.Modular
+import Distribution.Solver.Modular
          ( modularResolver, SolverConfig(..) )
-import qualified Distribution.Client.PackageIndex as PackageIndex
 import Distribution.Simple.PackageIndex (InstalledPackageIndex)
 import qualified Distribution.Simple.PackageIndex as InstalledPackageIndex
 import qualified Distribution.Client.InstallPlan as InstallPlan
 import Distribution.Client.InstallPlan (SolverInstallPlan)
-import Distribution.Client.PkgConfigDb (PkgConfigDb)
 import Distribution.Client.Types
-         ( SourcePackageDb(SourcePackageDb), SourcePackage(..)
-         , SolverPackage(..), SolverId(..)
+         ( SourcePackageDb(SourcePackageDb)
          , UnresolvedPkgLoc, UnresolvedSourcePackage
-         , OptionalStanza(..), enableStanzas )
+         , enableStanzas )
 import Distribution.Client.Dependency.Types
          ( PreSolver(..), Solver(..), DependencyResolver, ResolverPackage(..)
-         , ReorderGoals(..), IndependentGoals(..), AvoidReinstalls(..)
-         , ShadowPkgs(..), StrongFlags(..), EnableBackjumping(..)
          , PackageConstraint(..), showPackageConstraint
          , LabeledPackageConstraint(..), unlabelPackageConstraint
          , ConstraintSource(..), showConstraintSource
          , PackagePreferences(..), InstalledPreference(..)
-         , PackagesPreferenceDefault(..)
-         , Progress(..), foldProgress )
+         , PackagesPreferenceDefault(..) )
 import Distribution.Client.Sandbox.Types
          ( SandboxPackageInfo(..) )
 import Distribution.Client.Targets
-import Distribution.Client.ComponentDeps (ComponentDeps)
-import qualified Distribution.Client.ComponentDeps as CD
 import qualified Distribution.InstalledPackageInfo as Installed
 import Distribution.Package
          ( PackageName(..), PackageIdentifier(PackageIdentifier), PackageId
@@ -122,6 +114,17 @@ import Distribution.Text
 import Distribution.Verbosity
          ( Verbosity )
 
+import           Distribution.Solver.Types.ComponentDeps (ComponentDeps)
+import qualified Distribution.Solver.Types.ComponentDeps as CD
+import           Distribution.Solver.Types.OptionalStanza
+import qualified Distribution.Solver.Types.PackageIndex as PackageIndex
+import           Distribution.Solver.Types.PkgConfigDb (PkgConfigDb)
+import           Distribution.Solver.Types.Progress
+import           Distribution.Solver.Types.Settings
+import           Distribution.Solver.Types.SolverId
+import           Distribution.Solver.Types.SolverPackage
+import           Distribution.Solver.Types.SourcePackage
+
 import Data.List
          ( foldl', sort, sortBy, nubBy, maximumBy, intercalate, nub )
 import Data.Function (on)

cabal-install/Distribution/Client/Dependency/Modular/Configured.hs

@@ -20,24 +20,16 @@ import qualified Distribution.Client.Dependency.TopDown.Constraints as Constrain
 import Distribution.Client.Dependency.TopDown.Constraints
          ( Satisfiable(..) )
 import Distribution.Client.Types
-         ( SourcePackage(..), SolverPackage(..)
-         , UnresolvedPkgLoc, UnresolvedSourcePackage
-         , enableStanzas, SolverId(..) )
+         ( UnresolvedPkgLoc
+         , UnresolvedSourcePackage, enableStanzas )
 import Distribution.Client.Dependency.Types
          ( DependencyResolver, ResolverPackage(..)
          , PackageConstraint(..), unlabelPackageConstraint
-         , PackagePreferences(..), InstalledPreference(..)
-         , Progress(..), foldProgress )
+         , PackagePreferences(..), InstalledPreference(..) )
 
-import qualified Distribution.Client.PackageIndex as PackageIndex
 import qualified Distribution.Simple.PackageIndex  as InstalledPackageIndex
 import Distribution.Simple.PackageIndex (InstalledPackageIndex)
 import qualified Distribution.InstalledPackageInfo as InstalledPackageInfo
-import Distribution.Client.ComponentDeps
-         ( ComponentDeps )
-import qualified Distribution.Client.ComponentDeps as CD
-import Distribution.Client.PackageIndex
-         ( PackageIndex )
 import Distribution.Package
          ( PackageName(..), PackageId, PackageIdentifier(..)
          , UnitId(..), ComponentId(..)
@@ -61,6 +53,15 @@ import Distribution.Simple.Utils
 import Distribution.Text
          ( display )
 
+import           Distribution.Solver.Types.ComponentDeps ( ComponentDeps )
+import qualified Distribution.Solver.Types.ComponentDeps as CD
+import qualified Distribution.Solver.Types.PackageIndex as PackageIndex
+import           Distribution.Solver.Types.PackageIndex ( PackageIndex )
+import           Distribution.Solver.Types.Progress
+import           Distribution.Solver.Types.SolverId
+import           Distribution.Solver.Types.SolverPackage
+import           Distribution.Solver.Types.SourcePackage
+
 import Data.List
          ( foldl', maximumBy, minimumBy, nub, sort, sortBy, groupBy )
 import Data.Maybe

cabal-install/Distribution/Client/Dependency/TopDown.hs

@@ -25,9 +25,6 @@ module Distribution.Client.Dependency.TopDown.Constraints (
   ) where
 
 import Distribution.Client.Dependency.TopDown.Types
-import qualified Distribution.Client.PackageIndex as PackageIndex
-import Distribution.Client.PackageIndex
-        ( PackageIndex )
 import Distribution.Package
          ( PackageName, PackageId, PackageIdentifier(..)
          , Package(packageId), packageName, packageVersion
@@ -37,6 +34,9 @@ import Distribution.Version
 import Distribution.Client.Utils
          ( mergeBy, MergeResult(..) )
 
+import qualified Distribution.Solver.Types.PackageIndex as PackageIndex
+import           Distribution.Solver.Types.PackageIndex ( PackageIndex )
+
 #if !MIN_VERSION_base(4,8,0)
 import Data.Monoid
          ( Monoid(mempty) )

cabal-install/Distribution/Client/Dependency/TopDown/Constraints.hs

@@ -14,11 +14,14 @@
 module Distribution.Client.Dependency.TopDown.Types where
 
 import Distribution.Client.Types
-         ( UnresolvedPkgLoc, UnresolvedSourcePackage
-         , OptionalStanza, SolverPackage(..), SolverId(..) )
+         ( UnresolvedPkgLoc, UnresolvedSourcePackage )
 import Distribution.InstalledPackageInfo
          ( InstalledPackageInfo )
-import qualified Distribution.Client.ComponentDeps as CD
+
+import qualified Distribution.Solver.Types.ComponentDeps as CD
+import           Distribution.Solver.Types.OptionalStanza
+import           Distribution.Solver.Types.SolverPackage
+import           Distribution.Solver.Types.SolverId
 
 import Distribution.Package
          ( PackageId, PackageIdentifier, Dependency

cabal-install/Distribution/Client/Dependency/TopDown/Types.hs

@@ -18,13 +18,6 @@ module Distribution.Client.Dependency.Types (
     PreSolver(..),
     Solver(..),
 
-    ReorderGoals(..),
-    IndependentGoals(..),
-    AvoidReinstalls(..),
-    ShadowPkgs(..),
-    StrongFlags(..),
-    EnableBackjumping(..),
-
     DependencyResolver,
     ResolverPackage(..),
 
@@ -34,9 +27,6 @@ module Distribution.Client.Dependency.Types (
     InstalledPreference(..),
     PackagesPreferenceDefault(..),
 
-    Progress(..),
-    foldProgress,
-
     LabeledPackageConstraint(..),
     ConstraintSource(..),
     unlabelPackageConstraint,
@@ -48,8 +38,6 @@ module Distribution.Client.Dependency.Types (
 import Control.Applicative
          ( Applicative(..) )
 #endif
-import Control.Applicative
-         ( Alternative(..) )
 
 import Data.Char
          ( isAlpha, toLower )
@@ -58,21 +46,20 @@ import Data.Monoid
          ( Monoid(..) )
 #endif
 
-import Distribution.Client.PkgConfigDb
-         ( PkgConfigDb )
-import Distribution.Client.Types
-         ( OptionalStanza(..), SourcePackage(..), SolverPackage )
+import Distribution.Solver.Types.OptionalStanza
+import Distribution.Solver.Types.PkgConfigDb ( PkgConfigDb )
+import Distribution.Solver.Types.PackageIndex ( PackageIndex )
+import Distribution.Solver.Types.Progress
+import Distribution.Solver.Types.SourcePackage
+import Distribution.Solver.Types.SolverPackage
 
 import qualified Distribution.Compat.ReadP as Parse
          ( pfail, munch1 )
 import Distribution.PackageDescription
          ( FlagAssignment, FlagName(..) )
 import Distribution.InstalledPackageInfo
          ( InstalledPackageInfo )
-import qualified Distribution.Client.PackageIndex as PackageIndex
-         ( PackageIndex )
 import Distribution.Simple.PackageIndex ( InstalledPackageIndex )
-import Distribution.Simple.Setup ( BooleanFlag(..) )
 import Distribution.Package
          ( PackageName )
 import Distribution.Version
@@ -115,30 +102,6 @@ instance Text PreSolver where
       "choose"  -> return Choose
       _         -> Parse.pfail
 
-newtype ReorderGoals = ReorderGoals Bool
-  deriving (BooleanFlag, Eq, Generic, Show)
-
-newtype IndependentGoals = IndependentGoals Bool
-  deriving (BooleanFlag, Eq, Generic, Show)
-
-newtype AvoidReinstalls = AvoidReinstalls Bool
-  deriving (BooleanFlag, Eq, Generic, Show)
-
-newtype ShadowPkgs = ShadowPkgs Bool
-  deriving (BooleanFlag, Eq, Generic, Show)
-
-newtype StrongFlags = StrongFlags Bool
-  deriving (BooleanFlag, Eq, Generic, Show)
-
-newtype EnableBackjumping = EnableBackjumping Bool
-  deriving (BooleanFlag, Eq, Generic, Show)
-
-instance Binary ReorderGoals
-instance Binary IndependentGoals
-instance Binary AvoidReinstalls
-instance Binary ShadowPkgs
-instance Binary StrongFlags
-
 -- | A dependency resolver is a function that works out an installation plan
 -- given the set of installed and available packages and a set of deps to
 -- solve for.
@@ -150,7 +113,7 @@ instance Binary StrongFlags
 type DependencyResolver loc = Platform
                            -> CompilerInfo
                            -> InstalledPackageIndex
-                           -> PackageIndex.PackageIndex (SourcePackage loc)
+                           -> PackageIndex (SourcePackage loc)
                            -> PkgConfigDb
                            -> (PackageName -> PackagePreferences)
                            -> [LabeledPackageConstraint]
@@ -247,41 +210,6 @@ data PackagesPreferenceDefault =
    | PreferLatestForSelected
   deriving Show
 
--- | A type to represent the unfolding of an expensive long running
--- calculation that may fail. We may get intermediate steps before the final
--- result which may be used to indicate progress and\/or logging messages.
---
-data Progress step fail done = Step step (Progress step fail done)
-                             | Fail fail
-                             | Done done
-  deriving (Functor)
-
--- | Consume a 'Progress' calculation. Much like 'foldr' for lists but with two
--- base cases, one for a final result and one for failure.
---
--- Eg to convert into a simple 'Either' result use:
---
--- > foldProgress (flip const) Left Right
---
-foldProgress :: (step -> a -> a) -> (fail -> a) -> (done -> a)
-             -> Progress step fail done -> a
-foldProgress step fail done = fold
-  where fold (Step s p) = step s (fold p)
-        fold (Fail f)   = fail f
-        fold (Done r)   = done r
-
-instance Monad (Progress step fail) where
-  return   = pure
-  p >>= f  = foldProgress Step Fail f p
-
-instance Applicative (Progress step fail) where
-  pure a  = Done a
-  p <*> x = foldProgress Step Fail (flip fmap x) p
-
-instance Monoid fail => Alternative (Progress step fail) where
-  empty   = Fail mempty
-  p <|> q = foldProgress Step (const q) Done p
-
 -- | 'PackageConstraint' labeled with its source.
 data LabeledPackageConstraint
    = LabeledPackageConstraint PackageConstraint ConstraintSource

cabal-install/Distribution/Client/Dependency/Types.hs

@@ -22,11 +22,13 @@ import Distribution.Client.Dependency
 import Distribution.Client.IndexUtils as IndexUtils
          ( getSourcePackages, getInstalledPackages )
 import qualified Distribution.Client.InstallPlan as InstallPlan
-import Distribution.Client.PkgConfigDb
-         ( PkgConfigDb, readPkgConfigDb )
 import Distribution.Client.Setup
          ( GlobalFlags(..), FetchFlags(..), RepoContext(..) )
 
+import Distribution.Solver.Types.PkgConfigDb ( PkgConfigDb, readPkgConfigDb )
+import Distribution.Solver.Types.SolverPackage
+import Distribution.Solver.Types.SourcePackage
+
 import Distribution.Package
          ( packageId )
 import Distribution.Simple.Compiler

cabal-install/Distribution/Client/Fetch.hs

@@ -27,8 +27,6 @@ import Distribution.Client.IndexUtils as IndexUtils
 import Distribution.Client.InstallPlan
          ( SolverInstallPlan, SolverPlanPackage )
 import qualified Distribution.Client.InstallPlan as InstallPlan
-import Distribution.Client.PkgConfigDb
-         ( PkgConfigDb, readPkgConfigDb )
 import Distribution.Client.Setup
          ( GlobalFlags(..), FreezeFlags(..), ConfigExFlags(..)
          , RepoContext(..) )
@@ -38,6 +36,11 @@ import Distribution.Client.Sandbox.PackageEnvironment
 import Distribution.Client.Sandbox.Types
          ( SandboxPackageInfo(..) )
 
+import Distribution.Solver.Types.OptionalStanza
+import Distribution.Solver.Types.PkgConfigDb
+         ( PkgConfigDb, readPkgConfigDb )
+import Distribution.Solver.Types.SolverId
+
 import Distribution.Package
          ( Package, packageId, packageName, packageVersion, installedUnitId )
 import Distribution.Simple.Compiler

cabal-install/Distribution/Client/Freeze.hs

@@ -43,6 +43,8 @@ import Distribution.Client.Compat.Process
 import Distribution.Compat.Exception
         ( catchIO )
 
+import Distribution.Solver.Types.SourcePackage
+
 import Control.Exception
          ( finally )
 import Control.Monad