cabal-install-3.10.2.1: The command-line interface for Cabal and Hackage.

Safe Haskell | None
Language | Haskell2010

Distribution.Client.ProjectOrchestration

Contents

- Discovery phase: what is in the project?
- Pre-build phase: decide what to do.
  - Selecting what targets we mean
  - Utils for selecting targets
  - Adjusting the plan
- Build phase: now do it.
- Post build actions
- Dummy projects

Description

This module deals with building and incrementally rebuilding a collection of packages. It is what backs the `cabal build` and `configure` commands, as well as being a core part of `run`, `test`, `bench` and others.

The primary thing is in fact rebuilding (and trying to make that quick by not redoing unnecessary work), so building from scratch is just a special case.

The build process and the code can be understood by breaking it down into three major parts:

- The `ElaboratedInstallPlan` type
- The "what to do" phase, where we look at the all input configuration (project files, .cabal files, command line etc) and produce a detailed plan of what to do -- the `ElaboratedInstallPlan`.
- The "do it" phase, where we take the `ElaboratedInstallPlan` and we re-execute it.

As far as possible, the "what to do" phase embodies all the policy, leaving the "do it" phase policy free. The first phase contains more of the complicated logic, but it is contained in code that is either pure or just has read effects (except cache updates). Then the second phase does all the actions to build packages, but as far as possible it just follows the instructions and avoids any logic for deciding what to do (apart from recompilation avoidance in executing the plan).

This division helps us keep the code under control, making it easier to understand, test and debug. So when you are extending these modules, please think about which parts of your change belong in which part. It is perfectly ok to extend the description of what to do (i.e. the `ElaboratedInstallPlan`) if that helps keep the policy decisions in the first phase. Also, the second phase does not have direct access to any of the input configuration anyway; all the information has to flow via the `ElaboratedInstallPlan`.

Synopsis

- data CurrentCommand
  - = InstallCommand
  - | HaddockCommand
  - | BuildCommand
  - | ReplCommand
  - | OtherCommand
- establishProjectBaseContext :: Verbosity -> ProjectConfig -> CurrentCommand -> IO ProjectBaseContext
- establishProjectBaseContextWithRoot :: Verbosity -> ProjectConfig -> ProjectRoot -> CurrentCommand -> IO ProjectBaseContext
- data ProjectBaseContext = ProjectBaseContext {
  - distDirLayout :: DistDirLayout
  - cabalDirLayout :: CabalDirLayout
  - projectConfig :: ProjectConfig
  - localPackages :: [PackageSpecifier UnresolvedSourcePackage]
  - buildSettings :: BuildTimeSettings
  - currentCommand :: CurrentCommand
  - installedPackages :: Maybe InstalledPackageIndex
  }
- data BuildTimeSettings = BuildTimeSettings {
  - buildSettingDryRun :: Bool
  - buildSettingOnlyDeps :: Bool
  - buildSettingOnlyDownload :: Bool
  - buildSettingSummaryFile :: [PathTemplate]
  - buildSettingLogFile :: Maybe (Compiler -> Platform -> PackageId -> UnitId -> FilePath)
  - buildSettingLogVerbosity :: Verbosity
  - buildSettingBuildReports :: ReportLevel
  - buildSettingReportPlanningFailure :: Bool
  - buildSettingSymlinkBinDir :: [FilePath]
  - buildSettingNumJobs :: Int
  - buildSettingKeepGoing :: Bool
  - buildSettingOfflineMode :: Bool
  - buildSettingKeepTempFiles :: Bool
  - buildSettingRemoteRepos :: [RemoteRepo]
  - buildSettingLocalNoIndexRepos :: [LocalRepo]
  - buildSettingCacheDir :: FilePath
  - buildSettingHttpTransport :: Maybe String
  - buildSettingIgnoreExpiry :: Bool
  - buildSettingProgPathExtra :: [FilePath]
  - buildSettingHaddockOpen :: Bool
  }
- commandLineFlagsToProjectConfig :: GlobalFlags -> NixStyleFlags a -> ClientInstallFlags -> ProjectConfig
- withInstallPlan :: Verbosity -> ProjectBaseContext -> (ElaboratedInstallPlan -> ElaboratedSharedConfig -> IO a) -> IO a
- runProjectPreBuildPhase :: Verbosity -> ProjectBaseContext -> (ElaboratedInstallPlan -> IO (ElaboratedInstallPlan, TargetsMap)) -> IO ProjectBuildContext
- data ProjectBuildContext = ProjectBuildContext {
  - elaboratedPlanOriginal :: ElaboratedInstallPlan
  - elaboratedPlanToExecute :: ElaboratedInstallPlan
  - elaboratedShared :: ElaboratedSharedConfig
  - pkgsBuildStatus :: BuildStatusMap
  - targetsMap :: TargetsMap
  }
- readTargetSelectors :: [PackageSpecifier (SourcePackage (PackageLocation a))] -> Maybe ComponentKindFilter -> [String] -> IO (Either [TargetSelectorProblem] [TargetSelector])
- reportTargetSelectorProblems :: Verbosity -> [TargetSelectorProblem] -> IO a
- resolveTargets :: (forall k. TargetSelector -> [AvailableTarget k] -> Either (TargetProblem err) [k]) -> (forall k. SubComponentTarget -> AvailableTarget k -> Either (TargetProblem err) k) -> ElaboratedInstallPlan -> Maybe SourcePackageDb -> [TargetSelector] -> Either [TargetProblem err] TargetsMap
- type TargetsMap = Map UnitId [(ComponentTarget, NonEmpty TargetSelector)]
- allTargetSelectors :: TargetsMap -> [TargetSelector]
- uniqueTargetSelectors :: TargetsMap -> [TargetSelector]
- data TargetSelector
  - = TargetPackage TargetImplicitCwd [PackageId] (Maybe ComponentKindFilter)
  - | TargetPackageNamed PackageName (Maybe ComponentKindFilter)
  - | TargetAllPackages (Maybe ComponentKindFilter)
  - | TargetComponent PackageId ComponentName SubComponentTarget
  - | TargetComponentUnknown PackageName (Either UnqualComponentName ComponentName) SubComponentTarget
- data TargetImplicitCwd
  - = TargetImplicitCwd
  - | TargetExplicitNamed
- type PackageId = PackageIdentifier
- data AvailableTarget k = AvailableTarget {
  - availableTargetPackageId :: PackageId
  - availableTargetComponentName :: ComponentName
  - availableTargetStatus :: AvailableTargetStatus k
  - availableTargetLocalToProject :: Bool
  }
- data AvailableTargetStatus k
  - = TargetDisabledByUser
  - | TargetDisabledBySolver
  - | TargetNotBuildable
  - | TargetNotLocal
  - | TargetBuildable k TargetRequested
- data TargetRequested
  - = TargetRequestedByDefault
  - | TargetNotRequestedByDefault
- data ComponentName where
  - CLibName LibraryName
  - CNotLibName NotLibComponentName
  - pattern CBenchName :: UnqualComponentName -> ComponentName
  - pattern CTestName :: UnqualComponentName -> ComponentName
  - pattern CExeName :: UnqualComponentName -> ComponentName
  - pattern CFLibName :: UnqualComponentName -> ComponentName
- data ComponentKind
  - = LibKind
  - | FLibKind
  - | ExeKind
  - | TestKind
  - | BenchKind
- data ComponentTarget = ComponentTarget ComponentName SubComponentTarget
- data SubComponentTarget
  - = WholeComponent
  - | ModuleTarget ModuleName
  - | FileTarget FilePath
- selectComponentTargetBasic :: SubComponentTarget -> AvailableTarget k -> Either (TargetProblem a) k
- distinctTargetComponents :: TargetsMap -> Set (UnitId, ComponentName)
- filterTargetsKind :: ComponentKind -> [AvailableTarget k] -> [AvailableTarget k]
- filterTargetsKindWith :: (ComponentKind -> Bool) -> [AvailableTarget k] -> [AvailableTarget k]
- selectBuildableTargets :: [AvailableTarget k] -> [k]
- selectBuildableTargetsWith :: (TargetRequested -> Bool) -> [AvailableTarget k] -> [k]
- selectBuildableTargets' :: [AvailableTarget k] -> ([k], [AvailableTarget ()])
- selectBuildableTargetsWith' :: (TargetRequested -> Bool) -> [AvailableTarget k] -> ([k], [AvailableTarget ()])
- forgetTargetsDetail :: [AvailableTarget k] -> [AvailableTarget ()]
- pruneInstallPlanToTargets :: TargetAction -> TargetsMap -> ElaboratedInstallPlan -> ElaboratedInstallPlan
- data TargetAction
  - = TargetActionConfigure
  - | TargetActionBuild
  - | TargetActionRepl
  - | TargetActionTest
  - | TargetActionBench
  - | TargetActionHaddock
- pruneInstallPlanToDependencies :: Set UnitId -> ElaboratedInstallPlan -> Either CannotPruneDependencies ElaboratedInstallPlan
- newtype CannotPruneDependencies = CannotPruneDependencies [(ElaboratedPlanPackage, [ElaboratedPlanPackage])]
- printPlan :: Verbosity -> ProjectBaseContext -> ProjectBuildContext -> IO ()
- runProjectBuildPhase :: Verbosity -> ProjectBaseContext -> ProjectBuildContext -> IO BuildOutcomes
- runProjectPostBuildPhase :: Verbosity -> ProjectBaseContext -> ProjectBuildContext -> BuildOutcomes -> IO ()
- dieOnBuildFailures :: Verbosity -> CurrentCommand -> ElaboratedInstallPlan -> BuildOutcomes -> IO ()
- establishDummyProjectBaseContext :: Verbosity -> ProjectConfig -> DistDirLayout -> [PackageSpecifier UnresolvedSourcePackage] -> CurrentCommand -> IO ProjectBaseContext
- establishDummyDistDirLayout :: Verbosity -> ProjectConfig -> FilePath -> IO DistDirLayout

# Discovery phase: what is in the project?

data CurrentCommand #

Tracks what command is being executed, because we need to hide this somewhere for cases that need special handling (usually for error reporting).

Constructors

InstallCommand |
HaddockCommand |
BuildCommand |
ReplCommand |
OtherCommand |

#### Instances

Instances details

Show CurrentCommand # |
Instance details Defined in Distribution.Client.ProjectOrchestration Methods showsPrec :: Int -> CurrentCommand -> ShowS # show :: CurrentCommand -> String # showList :: [CurrentCommand] -> ShowS #
Eq CurrentCommand # |
Instance details Defined in Distribution.Client.ProjectOrchestration Methods (==) :: CurrentCommand -> CurrentCommand -> Bool # (/=) :: CurrentCommand -> CurrentCommand -> Bool #

establishProjectBaseContext :: Verbosity -> ProjectConfig -> CurrentCommand -> IO ProjectBaseContext #

establishProjectBaseContextWithRoot :: Verbosity -> ProjectConfig -> ProjectRoot -> CurrentCommand -> IO ProjectBaseContext #

Like `establishProjectBaseContext` but doesn't search for project root.

data ProjectBaseContext #

This holds the context of a project prior to solving: the content of the `cabal.project` and all the local package `.cabal` files.

Constructors

ProjectBaseContext |

Fields

- distDirLayout :: DistDirLayout
- cabalDirLayout :: CabalDirLayout
- projectConfig :: ProjectConfig
- localPackages :: [PackageSpecifier UnresolvedSourcePackage]
- buildSettings :: BuildTimeSettings
- currentCommand :: CurrentCommand
- installedPackages :: Maybe InstalledPackageIndex

data BuildTimeSettings #

Resolved configuration for things that affect how we build and not the value of the things we build. The idea is that this is easier to use than the raw configuration because in the raw configuration everything is optional (monoidial). In the `BuildTimeSettings` every field is filled in, if only with the defaults.

Use `resolveBuildTimeSettings` to make one from the project config (by applying defaults etc).

Constructors

BuildTimeSettings |

Fields

- buildSettingDryRun :: Bool
- buildSettingOnlyDeps :: Bool
- buildSettingOnlyDownload :: Bool
- buildSettingSummaryFile :: [PathTemplate]
- buildSettingLogFile :: Maybe (Compiler -> Platform -> PackageId -> UnitId -> FilePath)
- buildSettingLogVerbosity :: Verbosity
- buildSettingBuildReports :: ReportLevel
- buildSettingReportPlanningFailure :: Bool
- buildSettingSymlinkBinDir :: [FilePath]
- buildSettingNumJobs :: Int
- buildSettingKeepGoing :: Bool
- buildSettingOfflineMode :: Bool
- buildSettingKeepTempFiles :: Bool
- buildSettingRemoteRepos :: [RemoteRepo]
- buildSettingLocalNoIndexRepos :: [LocalRepo]
- buildSettingCacheDir :: FilePath
- buildSettingHttpTransport :: Maybe String
- buildSettingIgnoreExpiry :: Bool
- buildSettingProgPathExtra :: [FilePath]
- buildSettingHaddockOpen :: Bool

commandLineFlagsToProjectConfig :: GlobalFlags -> NixStyleFlags a -> ClientInstallFlags -> ProjectConfig #

Convert configuration from the `cabal configure` or `cabal build` command line into a `ProjectConfig` value that can combined with configuration from other sources.

At the moment this uses the legacy command line flag types. See `LegacyProjectConfig` for an explanation.

# Pre-build phase: decide what to do.

withInstallPlan :: Verbosity -> ProjectBaseContext -> (ElaboratedInstallPlan -> ElaboratedSharedConfig -> IO a) -> IO a #

Pre-build phase: decide what to do.

runProjectPreBuildPhase :: Verbosity -> ProjectBaseContext -> (ElaboratedInstallPlan -> IO (ElaboratedInstallPlan, TargetsMap)) -> IO ProjectBuildContext #

data ProjectBuildContext #

This holds the context between the pre-build, build and post-build phases.

Constructors

ProjectBuildContext |

Fields

- elaboratedPlanOriginal :: ElaboratedInstallPlan

  This is the improved plan, before we select a plan subset based on the build targets, and before we do the dry-run. So this contains all packages in the project.

- elaboratedPlanToExecute :: ElaboratedInstallPlan

  This is the `elaboratedPlanOriginal` after we select a plan subset and do the dry-run phase to find out what is up-to or out-of date. This is the plan that will be executed during the build phase. So this contains only a subset of packages in the project.

- elaboratedShared :: ElaboratedSharedConfig

  The part of the install plan that's shared between all packages in the plan. This does not change between the two plan variants above, so there is just the one copy.

- pkgsBuildStatus :: BuildStatusMap

  The result of the dry-run phase. This tells us about each member of the `elaboratedPlanToExecute`.

- targetsMap :: TargetsMap

  The targets selected by `selectPlanSubset`. This is useful eg. in CmdRun, where we need a valid target to execute.

## Selecting what targets we mean

readTargetSelectors #

Arguments

:: [PackageSpecifier (SourcePackage (PackageLocation a))] |
-> Maybe ComponentKindFilter | This parameter is used when there are ambiguous selectors. If it is `Just`, then we attempt to resolve ambiguity by applying it, since otherwise there is no way to allow contextually valid yet syntactically ambiguous selectors. (#4676, #5461)
-> [String] |
-> IO (Either [TargetSelectorProblem] [TargetSelector]) |

Parse a bunch of command line args as `TargetSelector`s, failing with an error if any are unrecognised. The possible target selectors are based on the available packages (and their locations).

reportTargetSelectorProblems :: Verbosity -> [TargetSelectorProblem] -> IO a #

Throw an exception with a formatted message if there are any problems.

resolveTargets :: (forall k. TargetSelector -> [AvailableTarget k] -> Either (TargetProblem err) [k]) -> (forall k. SubComponentTarget -> AvailableTarget k -> Either (TargetProblem err) k) -> ElaboratedInstallPlan -> Maybe SourcePackageDb -> [TargetSelector] -> Either [TargetProblem err] TargetsMap #

Given a set of `TargetSelector`s, resolve which `UnitId`s and `ComponentTarget`s they ought to refer to.

The idea is that every user target identifies one or more roots in the `ElaboratedInstallPlan`, which we will use to determine the closure of what packages need to be built, dropping everything from the plan that is unnecessary. This closure and pruning is done by `pruneInstallPlanToTargets` and this needs to be told the roots in terms of `UnitId`s and the `ComponentTarget`s within those.

This means we first need to translate the `TargetSelector`s into the `UnitId`s and `ComponentTarget`s. This translation has to be different for the different command line commands, like `build`, `repl` etc. For example the command `build pkgfoo` could select a different set of components in pkgfoo than `repl pkgfoo`. The `build` command would select any library and all executables, whereas `repl` would select the library or a single executable. Furthermore, both of these examples could fail, and fail in different ways and each needs to be able to produce helpful error messages.

So `resolveTargets` takes two helpers: one to select the targets to be used by user targets that refer to a whole package (`TargetPackage`), and another to check user targets that refer to a component (or a module or file within a component). These helpers can fail, and use their own error type. Both helpers get given the `AvailableTarget` info about the component(s).

While commands vary quite a bit in their behaviour about which components to select for a whole-package target, most commands have the same behaviour for checking a user target that refers to a specific component. To help with this commands can use `selectComponentTargetBasic`, either directly or as a basis for their own `selectComponentTarget` implementation.

type TargetsMap = Map UnitId [(ComponentTarget, NonEmpty TargetSelector)] #

The set of components to build, represented as a mapping from `UnitId`s to the `ComponentTarget`s within the unit that will be selected (e.g. selected to build, test or repl).

Associated with each `ComponentTarget` is the set of `TargetSelector`s that matched this target. Typically this is exactly one, but in general it is possible to for different selectors to match the same target. This extra information is primarily to help make helpful error messages.

allTargetSelectors :: TargetsMap -> [TargetSelector] #

Get all target selectors.

uniqueTargetSelectors :: TargetsMap -> [TargetSelector] #

Get all unique target selectors.

data TargetSelector #

A target selector is expression selecting a set of components (as targets for a actions like `build`, `run`, `test` etc). A target selector corresponds to the user syntax for referring to targets on the command line.

From the users point of view a target can be many things: packages, dirs, component names, files etc. Internally we consider a target to be a specific component (or module/file within a component), and all the users' notions of targets are just different ways of referring to these component targets.

So target selectors are expressions in the sense that they are interpreted to refer to one or more components. For example a `TargetPackage` gets interpreted differently by different commands to refer to all or a subset of components within the package.

The syntax has lots of optional parts:

    [ package name | package dir | package .cabal file ]
    [ [lib:|exe:] component name ]
    [ module name | source file ]

Constructors

TargetPackage TargetImplicitCwd [PackageId] (Maybe ComponentKindFilter) | One (or more) packages as a whole, or all the components of a particular kind within the package(s). These are always packages that are local to the project. In the case that there is more than one, they all share the same directory location.
TargetPackageNamed PackageName (Maybe ComponentKindFilter) | A package specified by name. This may refer to `extra-packages` from the `cabal.project` file, or a dependency of a known project package or could refer to a package from a hackage archive. It needs further context to resolve to a specific package.
TargetAllPackages (Maybe ComponentKindFilter) | All packages, or all components of a particular kind in all packages.
TargetComponent PackageId ComponentName SubComponentTarget | A specific component in a package within the project.
TargetComponentUnknown PackageName (Either UnqualComponentName ComponentName) SubComponentTarget | A component in a package, but where it cannot be verified that the package has such a component, or because the package is itself not known.

#### Instances

Instances details

Generic TargetSelector # |

Instance details

Defined in Distribution.Client.TargetSelector

Associated Types

type Rep TargetSelector |

Instance details

Defined in Distribution.Client.TargetSelector

type Rep TargetSelector = D1 ('MetaData "TargetSelector" "Distribution.Client.TargetSelector" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) ((C1 ('MetaCons "TargetPackage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TargetImplicitCwd) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PackageId]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ComponentKindFilter)))) :+: C1 ('MetaCons "TargetPackageNamed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ComponentKindFilter)))) :+: (C1 ('MetaCons "TargetAllPackages" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ComponentKindFilter))) :+: (C1 ('MetaCons "TargetComponent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageId) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubComponentTarget))) :+: C1 ('MetaCons "TargetComponentUnknown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either UnqualComponentName ComponentName)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubComponentTarget))))))

Methods

from :: TargetSelector -> Rep TargetSelector x #

to :: Rep TargetSelector x -> TargetSelector #

Show TargetSelector # |
Instance details Defined in Distribution.Client.TargetSelector Methods showsPrec :: Int -> TargetSelector -> ShowS # show :: TargetSelector -> String # showList :: [TargetSelector] -> ShowS #
Eq TargetSelector # |
Instance details Defined in Distribution.Client.TargetSelector Methods (==) :: TargetSelector -> TargetSelector -> Bool # (/=) :: TargetSelector -> TargetSelector -> Bool #
Ord TargetSelector # |

Instance details

Defined in Distribution.Client.TargetSelector

Methods

compare :: TargetSelector -> TargetSelector -> Ordering #

(<) :: TargetSelector -> TargetSelector -> Bool #

(<=) :: TargetSelector -> TargetSelector -> Bool #

(>) :: TargetSelector -> TargetSelector -> Bool #

(>=) :: TargetSelector -> TargetSelector -> Bool #

max :: TargetSelector -> TargetSelector -> TargetSelector #

min :: TargetSelector -> TargetSelector -> TargetSelector #

type Rep TargetSelector # |

Instance details

Defined in Distribution.Client.TargetSelector

type Rep TargetSelector = D1 ('MetaData "TargetSelector" "Distribution.Client.TargetSelector" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) ((C1 ('MetaCons "TargetPackage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TargetImplicitCwd) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [PackageId]) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ComponentKindFilter)))) :+: C1 ('MetaCons "TargetPackageNamed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ComponentKindFilter)))) :+: (C1 ('MetaCons "TargetAllPackages" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ComponentKindFilter))) :+: (C1 ('MetaCons "TargetComponent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageId) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubComponentTarget))) :+: C1 ('MetaCons "TargetComponentUnknown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Either UnqualComponentName ComponentName)) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubComponentTarget))))))

data TargetImplicitCwd #

Does this `TargetPackage` selector arise from syntax referring to a package in the current directory (e.g. `tests` or no giving no explicit target at all) or does it come from syntax referring to a package name or location.

Constructors

TargetImplicitCwd |
TargetExplicitNamed |

#### Instances

Instances details

Generic TargetImplicitCwd # |

Instance details

Defined in Distribution.Client.TargetSelector

Associated Types

type Rep TargetImplicitCwd |
Instance details Defined in Distribution.Client.TargetSelector type Rep TargetImplicitCwd = D1 ('MetaData "TargetImplicitCwd" "Distribution.Client.TargetSelector" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) (C1 ('MetaCons "TargetImplicitCwd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TargetExplicitNamed" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: TargetImplicitCwd -> Rep TargetImplicitCwd x #

to :: Rep TargetImplicitCwd x -> TargetImplicitCwd #

Show TargetImplicitCwd # |
Instance details Defined in Distribution.Client.TargetSelector Methods showsPrec :: Int -> TargetImplicitCwd -> ShowS # show :: TargetImplicitCwd -> String # showList :: [TargetImplicitCwd] -> ShowS #
Eq TargetImplicitCwd # |
Instance details Defined in Distribution.Client.TargetSelector Methods (==) :: TargetImplicitCwd -> TargetImplicitCwd -> Bool # (/=) :: TargetImplicitCwd -> TargetImplicitCwd -> Bool #
Ord TargetImplicitCwd # |

Instance details

Defined in Distribution.Client.TargetSelector

Methods

compare :: TargetImplicitCwd -> TargetImplicitCwd -> Ordering #

(<) :: TargetImplicitCwd -> TargetImplicitCwd -> Bool #

(<=) :: TargetImplicitCwd -> TargetImplicitCwd -> Bool #

(>) :: TargetImplicitCwd -> TargetImplicitCwd -> Bool #

(>=) :: TargetImplicitCwd -> TargetImplicitCwd -> Bool #

max :: TargetImplicitCwd -> TargetImplicitCwd -> TargetImplicitCwd #

min :: TargetImplicitCwd -> TargetImplicitCwd -> TargetImplicitCwd #

type Rep TargetImplicitCwd # |
Instance details Defined in Distribution.Client.TargetSelector type Rep TargetImplicitCwd = D1 ('MetaData "TargetImplicitCwd" "Distribution.Client.TargetSelector" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) (C1 ('MetaCons "TargetImplicitCwd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TargetExplicitNamed" 'PrefixI 'False) (U1 :: Type -> Type))

type PackageId = PackageIdentifier #

Type alias so we can use the shorter name PackageId.

data AvailableTarget k #

An available target represents a component within a package that a user command could plausibly refer to. In this sense, all the components defined within the package are things the user could refer to, whether or not it would actually be possible to build that component.

In particular the available target contains an `AvailableTargetStatus` which informs us about whether it's actually possible to select this component to be built, and if not why not. This detail makes it possible for command implementations (like `build`, `test` etc) to accurately report why a target cannot be used.

Note that the type parameter is used to help enforce that command implementations can only select targets that can actually be built (by forcing them to return the `k` value for the selected targets). In particular `resolveTargets` makes use of this (with `k` as `(`UnitId`, ComponentName')`) to identify the targets thus selected.

Constructors

AvailableTarget |

Fields

- availableTargetPackageId :: PackageId
- availableTargetComponentName :: ComponentName
- availableTargetStatus :: AvailableTargetStatus k
- availableTargetLocalToProject :: Bool

#### Instances

Instances details

Functor AvailableTarget # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods fmap :: (a -> b) -> AvailableTarget a -> AvailableTarget b # (<$) :: a -> AvailableTarget b -> AvailableTarget a #
Show k => Show (AvailableTarget k) # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods showsPrec :: Int -> AvailableTarget k -> ShowS # show :: AvailableTarget k -> String # showList :: [AvailableTarget k] -> ShowS #
Eq k => Eq (AvailableTarget k) # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods (==) :: AvailableTarget k -> AvailableTarget k -> Bool # (/=) :: AvailableTarget k -> AvailableTarget k -> Bool #

data AvailableTargetStatus k #

The status of a an `AvailableTarget` component. This tells us whether it's actually possible to select this component to be built, and if not why not.

Constructors

TargetDisabledByUser | When the user does `tests: False`
TargetDisabledBySolver | When the solver could not enable tests
TargetNotBuildable | When the component has `buildable: False`
TargetNotLocal | When the component is non-core in a non-local package
TargetBuildable k TargetRequested | The target can or should be built

#### Instances

Instances details

Functor AvailableTargetStatus # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods fmap :: (a -> b) -> AvailableTargetStatus a -> AvailableTargetStatus b # (<$) :: a -> AvailableTargetStatus b -> AvailableTargetStatus a #
Show k => Show (AvailableTargetStatus k) # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods showsPrec :: Int -> AvailableTargetStatus k -> ShowS # show :: AvailableTargetStatus k -> String # showList :: [AvailableTargetStatus k] -> ShowS #
Eq k => Eq (AvailableTargetStatus k) # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods (==) :: AvailableTargetStatus k -> AvailableTargetStatus k -> Bool # (/=) :: AvailableTargetStatus k -> AvailableTargetStatus k -> Bool #
Ord k => Ord (AvailableTargetStatus k) # |

Instance details

Defined in Distribution.Client.ProjectPlanning

Methods

compare :: AvailableTargetStatus k -> AvailableTargetStatus k -> Ordering #

(<) :: AvailableTargetStatus k -> AvailableTargetStatus k -> Bool #

(<=) :: AvailableTargetStatus k -> AvailableTargetStatus k -> Bool #

(>) :: AvailableTargetStatus k -> AvailableTargetStatus k -> Bool #

(>=) :: AvailableTargetStatus k -> AvailableTargetStatus k -> Bool #

max :: AvailableTargetStatus k -> AvailableTargetStatus k -> AvailableTargetStatus k #

min :: AvailableTargetStatus k -> AvailableTargetStatus k -> AvailableTargetStatus k #

data TargetRequested #

This tells us whether a target ought to be built by default, or only if specifically requested. The policy is that components like libraries and executables are built by default by `build`, but test suites and benchmarks are not, unless this is overridden in the project configuration.

Constructors

TargetRequestedByDefault | To be built by default
TargetNotRequestedByDefault | Not to be built by default

#### Instances

Instances details

Show TargetRequested # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods showsPrec :: Int -> TargetRequested -> ShowS # show :: TargetRequested -> String # showList :: [TargetRequested] -> ShowS #
Eq TargetRequested # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods (==) :: TargetRequested -> TargetRequested -> Bool # (/=) :: TargetRequested -> TargetRequested -> Bool #
Ord TargetRequested # |

Instance details

Defined in Distribution.Client.ProjectPlanning

Methods

compare :: TargetRequested -> TargetRequested -> Ordering #

(<) :: TargetRequested -> TargetRequested -> Bool #

(<=) :: TargetRequested -> TargetRequested -> Bool #

(>) :: TargetRequested -> TargetRequested -> Bool #

(>=) :: TargetRequested -> TargetRequested -> Bool #

max :: TargetRequested -> TargetRequested -> TargetRequested #

min :: TargetRequested -> TargetRequested -> TargetRequested #

data ComponentName #

Constructors

CLibName LibraryName |
CNotLibName NotLibComponentName |

Bundled Patterns

pattern CBenchName :: UnqualComponentName -> ComponentName |
pattern CTestName :: UnqualComponentName -> ComponentName |
pattern CExeName :: UnqualComponentName -> ComponentName |
pattern CFLibName :: UnqualComponentName -> ComponentName |

#### Instances

Instances details

Parsec ComponentName |
Instance details Defined in Distribution.Types.ComponentName Methods parsec :: CabalParsing m => m ComponentName #
Pretty ComponentName |
Instance details Defined in Distribution.Types.ComponentName Methods pretty :: ComponentName -> Doc # prettyVersioned :: CabalSpecVersion -> ComponentName -> Doc #
Structured ComponentName |
Instance details Defined in Distribution.Types.ComponentName Methods structure :: Proxy ComponentName -> Structure # structureHash' :: Tagged ComponentName MD5
Generic ComponentName |

Instance details

Defined in Distribution.Types.ComponentName

Associated Types

type Rep ComponentName |

Instance details

Defined in Distribution.Types.ComponentName

type Rep ComponentName = D1 ('MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-syntax-3.10.2.0-inplace" 'False) (C1 ('MetaCons "CLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LibraryName)) :+: C1 ('MetaCons "CNotLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NotLibComponentName)))

Methods

from :: ComponentName -> Rep ComponentName x #

to :: Rep ComponentName x -> ComponentName #

Read ComponentName |
Instance details Defined in Distribution.Types.ComponentName Methods readsPrec :: Int -> ReadS ComponentName # readList :: ReadS [ComponentName] # readPrec :: ReadPrec ComponentName # readListPrec :: ReadPrec [ComponentName] #
Show ComponentName |
Instance details Defined in Distribution.Types.ComponentName Methods showsPrec :: Int -> ComponentName -> ShowS # show :: ComponentName -> String # showList :: [ComponentName] -> ShowS #
Binary ComponentName |
Instance details Defined in Distribution.Types.ComponentName Methods put :: ComponentName -> Put # get :: Get ComponentName # putList :: [ComponentName] -> Put #
Eq ComponentName |
Instance details Defined in Distribution.Types.ComponentName Methods (==) :: ComponentName -> ComponentName -> Bool # (/=) :: ComponentName -> ComponentName -> Bool #
Ord ComponentName |

Instance details

Defined in Distribution.Types.ComponentName

Methods

compare :: ComponentName -> ComponentName -> Ordering #

(<) :: ComponentName -> ComponentName -> Bool #

(<=) :: ComponentName -> ComponentName -> Bool #

(>) :: ComponentName -> ComponentName -> Bool #

(>=) :: ComponentName -> ComponentName -> Bool #

max :: ComponentName -> ComponentName -> ComponentName #

min :: ComponentName -> ComponentName -> ComponentName #

type Rep ComponentName |

Instance details

Defined in Distribution.Types.ComponentName

type Rep ComponentName = D1 ('MetaData "ComponentName" "Distribution.Types.ComponentName" "Cabal-syntax-3.10.2.0-inplace" 'False) (C1 ('MetaCons "CLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LibraryName)) :+: C1 ('MetaCons "CNotLibName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NotLibComponentName)))

data ComponentKind #

Constructors

LibKind |
FLibKind |
ExeKind |
TestKind |
BenchKind |

#### Instances

Instances details

Enum ComponentKind # |

Instance details

Defined in Distribution.Client.TargetSelector

Methods

succ :: ComponentKind -> ComponentKind #

pred :: ComponentKind -> ComponentKind #

toEnum :: Int -> ComponentKind #

fromEnum :: ComponentKind -> Int #

enumFrom :: ComponentKind -> [ComponentKind] #

enumFromThen :: ComponentKind -> ComponentKind -> [ComponentKind] #

enumFromTo :: ComponentKind -> ComponentKind -> [ComponentKind] #

enumFromThenTo :: ComponentKind -> ComponentKind -> ComponentKind -> [ComponentKind] #

Show ComponentKind # |
Instance details Defined in Distribution.Client.TargetSelector Methods showsPrec :: Int -> ComponentKind -> ShowS # show :: ComponentKind -> String # showList :: [ComponentKind] -> ShowS #
Eq ComponentKind # |
Instance details Defined in Distribution.Client.TargetSelector Methods (==) :: ComponentKind -> ComponentKind -> Bool # (/=) :: ComponentKind -> ComponentKind -> Bool #
Ord ComponentKind # |

Instance details

Defined in Distribution.Client.TargetSelector

Methods

compare :: ComponentKind -> ComponentKind -> Ordering #

(<) :: ComponentKind -> ComponentKind -> Bool #

(<=) :: ComponentKind -> ComponentKind -> Bool #

(>) :: ComponentKind -> ComponentKind -> Bool #

(>=) :: ComponentKind -> ComponentKind -> Bool #

max :: ComponentKind -> ComponentKind -> ComponentKind #

min :: ComponentKind -> ComponentKind -> ComponentKind #

data ComponentTarget #

Specific targets within a package or component to act on e.g. to build, haddock or open a repl.

Constructors

ComponentTarget ComponentName SubComponentTarget |

#### Instances

Instances details

Structured ComponentTarget # |
Instance details Defined in Distribution.Client.ProjectPlanning.Types Methods structure :: Proxy ComponentTarget -> Structure # structureHash' :: Tagged ComponentTarget MD5
Generic ComponentTarget # |

Instance details

Defined in Distribution.Client.ProjectPlanning.Types

Associated Types

type Rep ComponentTarget |

Instance details

Defined in Distribution.Client.ProjectPlanning.Types

type Rep ComponentTarget = D1 ('MetaData "ComponentTarget" "Distribution.Client.ProjectPlanning.Types" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) (C1 ('MetaCons "ComponentTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubComponentTarget)))

Methods

from :: ComponentTarget -> Rep ComponentTarget x #

to :: Rep ComponentTarget x -> ComponentTarget #

Show ComponentTarget # |
Instance details Defined in Distribution.Client.ProjectPlanning.Types Methods showsPrec :: Int -> ComponentTarget -> ShowS # show :: ComponentTarget -> String # showList :: [ComponentTarget] -> ShowS #
Binary ComponentTarget # |
Instance details Defined in Distribution.Client.ProjectPlanning.Types Methods put :: ComponentTarget -> Put # get :: Get ComponentTarget # putList :: [ComponentTarget] -> Put #
Eq ComponentTarget # |
Instance details Defined in Distribution.Client.ProjectPlanning.Types Methods (==) :: ComponentTarget -> ComponentTarget -> Bool # (/=) :: ComponentTarget -> ComponentTarget -> Bool #
Ord ComponentTarget # |

Instance details

Defined in Distribution.Client.ProjectPlanning.Types

Methods

compare :: ComponentTarget -> ComponentTarget -> Ordering #

(<) :: ComponentTarget -> ComponentTarget -> Bool #

(<=) :: ComponentTarget -> ComponentTarget -> Bool #

(>) :: ComponentTarget -> ComponentTarget -> Bool #

(>=) :: ComponentTarget -> ComponentTarget -> Bool #

max :: ComponentTarget -> ComponentTarget -> ComponentTarget #

min :: ComponentTarget -> ComponentTarget -> ComponentTarget #

type Rep ComponentTarget # |

Instance details

Defined in Distribution.Client.ProjectPlanning.Types

type Rep ComponentTarget = D1 ('MetaData "ComponentTarget" "Distribution.Client.ProjectPlanning.Types" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) (C1 ('MetaCons "ComponentTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SubComponentTarget)))

data SubComponentTarget #

Either the component as a whole or detail about a file or module target within a component.

Constructors

WholeComponent | The component as a whole
ModuleTarget ModuleName | A specific module within a component.
FileTarget FilePath | A specific file within a component. Note that this does not carry the file extension.

#### Instances

Instances details

Structured SubComponentTarget # |
Instance details Defined in Distribution.Client.TargetSelector Methods structure :: Proxy SubComponentTarget -> Structure # structureHash' :: Tagged SubComponentTarget MD5
Generic SubComponentTarget # |

Instance details

Defined in Distribution.Client.TargetSelector

Associated Types

type Rep SubComponentTarget |

Instance details

Defined in Distribution.Client.TargetSelector

type Rep SubComponentTarget = D1 ('MetaData "SubComponentTarget" "Distribution.Client.TargetSelector" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) (C1 ('MetaCons "WholeComponent" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ModuleTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)) :+: C1 ('MetaCons "FileTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))))

Methods

from :: SubComponentTarget -> Rep SubComponentTarget x #

to :: Rep SubComponentTarget x -> SubComponentTarget #

Show SubComponentTarget # |
Instance details Defined in Distribution.Client.TargetSelector Methods showsPrec :: Int -> SubComponentTarget -> ShowS # show :: SubComponentTarget -> String # showList :: [SubComponentTarget] -> ShowS #
Binary SubComponentTarget # |
Instance details Defined in Distribution.Client.TargetSelector Methods put :: SubComponentTarget -> Put # get :: Get SubComponentTarget # putList :: [SubComponentTarget] -> Put #
Eq SubComponentTarget # |
Instance details Defined in Distribution.Client.TargetSelector Methods (==) :: SubComponentTarget -> SubComponentTarget -> Bool # (/=) :: SubComponentTarget -> SubComponentTarget -> Bool #
Ord SubComponentTarget # |

Instance details

Defined in Distribution.Client.TargetSelector

Methods

compare :: SubComponentTarget -> SubComponentTarget -> Ordering #

(<) :: SubComponentTarget -> SubComponentTarget -> Bool #

(<=) :: SubComponentTarget -> SubComponentTarget -> Bool #

(>) :: SubComponentTarget -> SubComponentTarget -> Bool #

(>=) :: SubComponentTarget -> SubComponentTarget -> Bool #

max :: SubComponentTarget -> SubComponentTarget -> SubComponentTarget #

min :: SubComponentTarget -> SubComponentTarget -> SubComponentTarget #

type Rep SubComponentTarget # |

Instance details

Defined in Distribution.Client.TargetSelector

type Rep SubComponentTarget = D1 ('MetaData "SubComponentTarget" "Distribution.Client.TargetSelector" "cabal-install-3.10.2.1-EH6AEtqwlbKE3rh89dIk81" 'False) (C1 ('MetaCons "WholeComponent" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ModuleTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)) :+: C1 ('MetaCons "FileTarget" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))))

selectComponentTargetBasic :: SubComponentTarget -> AvailableTarget k -> Either (TargetProblem a) k #

A basic `selectComponentTarget` implementation to use or pass to `resolveTargets`, that does the basic checks that the component is buildable and isn't a test suite or benchmark that is disabled. This can also be used to do these basic checks as part of a custom impl that

distinctTargetComponents :: TargetsMap -> Set (UnitId, ComponentName) #

Utility used by repl and run to check if the targets spans multiple components, since those commands do not support multiple components.

## Utils for selecting targets

filterTargetsKind :: ComponentKind -> [AvailableTarget k] -> [AvailableTarget k] #

filterTargetsKindWith :: (ComponentKind -> Bool) -> [AvailableTarget k] -> [AvailableTarget k] #

selectBuildableTargets :: [AvailableTarget k] -> [k] #

selectBuildableTargetsWith :: (TargetRequested -> Bool) -> [AvailableTarget k] -> [k] #

selectBuildableTargets' :: [AvailableTarget k] -> ([k], [AvailableTarget ()]) #

selectBuildableTargetsWith' :: (TargetRequested -> Bool) -> [AvailableTarget k] -> ([k], [AvailableTarget ()]) #

forgetTargetsDetail :: [AvailableTarget k] -> [AvailableTarget ()] #

## Adjusting the plan

pruneInstallPlanToTargets :: TargetAction -> TargetsMap -> ElaboratedInstallPlan -> ElaboratedInstallPlan #

Wrapper around `pruneInstallPlanToTargets` that adjusts for the extra unneeded info in the `TargetsMap`.

data TargetAction #

How `pruneInstallPlanToTargets` should interpret the per-package `ComponentTarget`s: as build, repl or haddock targets.

Constructors

TargetActionConfigure |
TargetActionBuild |
TargetActionRepl |
TargetActionTest |
TargetActionBench |
TargetActionHaddock |

pruneInstallPlanToDependencies :: Set UnitId -> ElaboratedInstallPlan -> Either CannotPruneDependencies ElaboratedInstallPlan #

Try to remove the given targets from the install plan.

This is not always possible.

newtype CannotPruneDependencies #

It is not always possible to prune to only the dependencies of a set of targets. It may be the case that removing a package leaves something else that still needed the pruned package.

This lists all the packages that would be broken, and their dependencies that would be missing if we did prune.

Constructors

CannotPruneDependencies [(ElaboratedPlanPackage, [ElaboratedPlanPackage])] |

#### Instances

Instances details

Show CannotPruneDependencies # |
Instance details Defined in Distribution.Client.ProjectPlanning Methods showsPrec :: Int -> CannotPruneDependencies -> ShowS # show :: CannotPruneDependencies -> String # showList :: [CannotPruneDependencies] -> ShowS #

printPlan :: Verbosity -> ProjectBaseContext -> ProjectBuildContext -> IO () #

Print a user-oriented presentation of the install plan, indicating what will be built.

# Build phase: now do it.

runProjectBuildPhase :: Verbosity -> ProjectBaseContext -> ProjectBuildContext -> IO BuildOutcomes #

Build phase: now do it.

Execute all or parts of the description of what to do to build or rebuild the various packages needed.

# Post build actions

runProjectPostBuildPhase :: Verbosity -> ProjectBaseContext -> ProjectBuildContext -> BuildOutcomes -> IO () #

Post-build phase: various administrative tasks

Update bits of state based on the build outcomes and report any failures.

dieOnBuildFailures :: Verbosity -> CurrentCommand -> ElaboratedInstallPlan -> BuildOutcomes -> IO () #

If there are build failures then report them and throw an exception.

# Dummy projects

establishDummyProjectBaseContext #

Arguments

:: Verbosity |
-> ProjectConfig | Project configuration including the global config if needed
-> DistDirLayout | Where to put the dist directory
-> [PackageSpecifier UnresolvedSourcePackage] | The packages to be included in the project
-> CurrentCommand |
-> IO ProjectBaseContext |

Create a dummy project context, without a .cabal or a .cabal.project file (a place where to put a temporary dist directory is still needed)

establishDummyDistDirLayout :: Verbosity -> ProjectConfig -> FilePath -> IO DistDirLayout #