Modulecabal-install-3.16.0.0Haskell2010

Distribution.Client.Targets

Handling for user-specified targets

Contents

User targets
Resolving user targets to package specifiers
Detailed interface
User constraints

Synopsis

data UserTarget
value readUserTargets
value resolveUserTargets
data UserTargetProblem
value readUserTarget
value reportUserTargetProblems
value expandUserTarget
data PackageTarget
value fetchPackageTarget
value readPackageTarget
data PackageTargetProblem
value reportPackageTargetProblems
value disambiguatePackageTargets
value disambiguatePackageName
data UserQualifier
data UserConstraintScope
data UserConstraint
value userConstraintPackageName
value readUserConstraint
value userToPackageConstraint

Packagecabal-install-3.16.0.0
Exports20
LanguageHaskell2010
LicenceBSD-3-Clause
SourceTargets.hs

User targets

datadata UserTarget

Source#

Various ways that a user may specify a package or package collection.

Constructors

UserTargetNamed PackageVersionConstraint
A partially specified package, identified by name and possibly with an exact version or a version constraint.
```
cabal install foo
cabal install foo-1.0
cabal install 'foo < 2'
```
UserTargetLocalDir FilePath
A specific package that is unpacked in a local directory, often the current directory.
```
cabal install .
cabal install ../lib/other
```
- Note: in future, if multiple .cabal files are allowed in a single directory then this will refer to the collection of packages.
UserTargetLocalCabalFile FilePath
A specific local unpacked package, identified by its .cabal file.
```
cabal install foo.cabal
cabal install ../lib/other/bar.cabal
```
UserTargetLocalTarball FilePath
A specific package that is available as a local tarball file
```
cabal install dist/foo-1.0.tar.gz
cabal install ../build/baz-1.0.tar.gz
```
UserTargetRemoteTarball URI
A specific package that is available as a remote tarball file
```
cabal install http://code.haskell.org/~user/foo/foo-0.9.tar.gz
```

Instances2Eq, Show

Eq UserTargetDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Show UserTargetDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets

valuereadUserTargets :: Verbosity -> [String] -> IO [UserTarget]

Resolving user targets to package specifiers

valueresolveUserTargets

:: Package pkg
=> Verbosity
-> RepoContext
-> PackageIndex pkg
-> [UserTarget]
-> IO [PackageSpecifier UnresolvedSourcePackage]

Source#

Given a bunch of user-specified targets, try to resolve what it is they refer to. They can either be specific packages (local dirs, tarballs etc) or they can be named packages (with or without version info).

Detailed interface

datadata UserTargetProblem

Constructors

UserTargetUnexpectedFile String
UserTargetNonexistantFile String
UserTargetUnexpectedUriScheme String
UserTargetUnrecognisedUri String
UserTargetUnrecognised String

Instances1Show

Show UserTargetProblemDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets

valuereadUserTarget :: String -> IO (Either UserTargetProblem UserTarget)

valuereportUserTargetProblems :: Verbosity -> [UserTargetProblem] -> IO ()

valueexpandUserTarget

:: Verbosity
-> UserTarget
-> IO [PackageTarget (PackageLocation ())]

Source#

Given a user-specified target, expand it to a bunch of package targets (each of which refers to only one package).

datadata PackageTarget pkg

Source#

An intermediate between a UserTarget and a resolved PackageSpecifier. Unlike a UserTarget, a PackageTarget refers only to a single package.

Constructors

PackageTargetNamed PackageName [PackageProperty] UserTarget
PackageTargetNamedFuzzy PackageName [PackageProperty] UserTarget
A package identified by name, but case insensitively, so it needs to be resolved to the right case-sensitive name.
PackageTargetLocation pkg

Instances4Functor, Foldable, Traversable, Show

Functor PackageTargetDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Foldable PackageTargetDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Traversable PackageTargetDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Show pkg => Show (PackageTarget pkg)Defined in cabal-install-3.16.0.0 · Distribution.Client.Targets

valuefetchPackageTarget

Source#

Fetch any remote targets so that they can be read.

valuereadPackageTarget

:: Verbosity
-> PackageTarget ResolvedPkgLoc
-> IO (PackageTarget UnresolvedSourcePackage)

Source#

Given a package target that has been fetched, read the .cabal file.

This only affects targets given by location, named targets are unaffected.

datadata PackageTargetProblem

Constructors

PackageNameUnknown PackageName UserTarget
PackageNameAmbiguous PackageName [PackageName] UserTarget

Instances1Show

Show PackageTargetProblemDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets

valuereportPackageTargetProblems :: Verbosity -> [PackageTargetProblem] -> IO ()

Source#

Report problems to the user. That is, if there are any problems then raise an exception.

valuedisambiguatePackageTargets

:: Package pkg'
=> PackageIndex pkg'
-> [PackageName]
-> [PackageTarget pkg]
-> ([PackageTargetProblem], [PackageSpecifier pkg])

Source#

Users are allowed to give package names case-insensitively, so we must disambiguate named package references.

valuedisambiguatePackageName

:: PackageNameEnv
-> PackageName
-> MaybeAmbiguous PackageName

Source#

Given a package name and a list of matching names, figure out which one it might be referring to. If there is an exact case-sensitive match then that's ok (i.e. returned via Unambiguous). If it matches just one package case-insensitively or if it matches multiple packages case-insensitively, in that case the result is Ambiguous.

Note: Before cabal 2.2, when only a single package matched case-insensitively it would be considered Unambiguous.

User constraints

datadata UserQualifier

Source#

Version of Qualifier that a user may specify on the command line.

Constructors

UserQualToplevel
Top-level dependency.
UserQualSetup PackageName
Setup dependency.
UserQualExe PackageName PackageName
Executable dependency.

Instances6Eq, Show, Generic, Binary, Structured, Rep

Eq UserQualifierDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Show UserQualifierDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Generic UserQualifierDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Binary UserQualifierDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Structured UserQualifierDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
type Rep UserQualifier = D1 ('MetaData "UserQualifier" "Distribution.Client.Targets" "cabal-install-3.16.0.0-uJtb9D6RBHJ63rvXLCPUM" 'False) (C1 ('MetaCons "UserQualToplevel" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "UserQualSetup" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName)) :+: C1 ('MetaCons "UserQualExe" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName))))Defined in cabal-install-3.16.0.0 · Distribution.Client.Targets

datadata UserConstraintScope

Source#

Version of ConstraintScope that a user may specify on the command line.

Constructors

UserQualified UserQualifier PackageName
Scope that applies to the package when it has the specified qualifier.
UserAnySetupQualifier PackageName
Scope that applies to the package when it has a setup qualifier.
UserAnyQualifier PackageName
Scope that applies to the package when it has any qualifier.

Instances6Eq, Show, Generic, Binary, Structured, Rep

Eq UserConstraintScopeDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Show UserConstraintScopeDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Generic UserConstraintScopeDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Binary UserConstraintScopeDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Structured UserConstraintScopeDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
type Rep UserConstraintScope = D1 ('MetaData "UserConstraintScope" "Distribution.Client.Targets" "cabal-install-3.16.0.0-uJtb9D6RBHJ63rvXLCPUM" 'False) (C1 ('MetaCons "UserQualified" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserQualifier) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName)) :+: (C1 ('MetaCons "UserAnySetupQualifier" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName)) :+: C1 ('MetaCons "UserAnyQualifier" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageName))))Defined in cabal-install-3.16.0.0 · Distribution.Client.Targets

datadata UserConstraint

Source#

Version of PackageConstraint that the user can specify on the command line.

Constructors

UserConstraint UserConstraintScope PackageProperty

Instances8Eq, Show, Generic, Binary, Parsec, Pretty, …

Eq UserConstraintDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Show UserConstraintDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Generic UserConstraintDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Binary UserConstraintDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Parsec UserConstraintDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Pretty UserConstraintDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
Structured UserConstraintDefined in cabal-install-3.16.0.0 · Distribution.Client.Targets
type Rep UserConstraint = D1 ('MetaData "UserConstraint" "Distribution.Client.Targets" "cabal-install-3.16.0.0-uJtb9D6RBHJ63rvXLCPUM" 'False) (C1 ('MetaCons "UserConstraint" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UserConstraintScope) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PackageProperty)))Defined in cabal-install-3.16.0.0 · Distribution.Client.Targets

valueuserConstraintPackageName :: UserConstraint -> PackageName

valuereadUserConstraint :: String -> Either String UserConstraint

valueuserToPackageConstraint :: UserConstraint -> PackageConstraint