Copyright	(c) Duncan Coutts 2012
License	BSD-like
Maintainer	duncan@community.haskell.org
Safe Haskell	None
Language	Haskell2010

Distribution.Simple.BuildTarget

Contents

Main interface
Build targets
Parsing user build targets
Resolving build targets

Description

Handling for user-specified build targets

Synopsis

readTargetInfos :: Verbosity -> PackageDescription -> LocalBuildInfo -> [String] -> IO [TargetInfo]
readBuildTargets :: Verbosity -> PackageDescription -> [String] -> IO [BuildTarget]
data BuildTarget
showBuildTarget :: PackageId -> BuildTarget -> String
data QualLevel
- = QL1
- | QL2
- | QL3
buildTargetComponentName :: BuildTarget -> ComponentName
data UserBuildTarget
readUserBuildTargets :: [String] -> ([UserBuildTargetProblem], [UserBuildTarget])
showUserBuildTarget :: UserBuildTarget -> String
data UserBuildTargetProblem = UserBuildTargetUnrecognised String
reportUserBuildTargetProblems :: Verbosity -> [UserBuildTargetProblem] -> IO ()
resolveBuildTargets :: PackageDescription -> [(UserBuildTarget, Bool)] -> ([BuildTargetProblem], [BuildTarget])
data BuildTargetProblem
- = BuildTargetExpected UserBuildTarget [String] String
- | BuildTargetNoSuch UserBuildTarget [(String, String)]
- | BuildTargetAmbiguous UserBuildTarget [(UserBuildTarget, BuildTarget)]
reportBuildTargetProblems :: Verbosity -> [BuildTargetProblem] -> IO ()

Main interface

readTargetInfos :: Verbosity -> PackageDescription -> LocalBuildInfo -> [String] -> IO [TargetInfo] Source #

Take a list of String build targets, and parse and validate them into actual TargetInfo s to be builtregisteredwhatever.

readBuildTargets :: Verbosity -> PackageDescription -> [String] -> IO [BuildTarget] Source #

Read a list of user-supplied build target strings and resolve them to BuildTarget s according to a PackageDescription . If there are problems with any of the targets e.g. they don't exist or are misformatted, throw an IOException .

Build targets

data BuildTarget Source #

A fully resolved build target.

Constructors

BuildTargetComponent ComponentName

A specific component

BuildTargetModule ComponentName ModuleName

A specific module within a specific component.

BuildTargetFile ComponentName FilePath

A specific file within a specific component.

Instances

Instances details

Generic BuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Associated Types

type Rep BuildTarget

Instance details

Defined in Distribution.Simple.BuildTarget

type Rep BuildTarget = D1 ('MetaData "BuildTarget" "Distribution.Simple.BuildTarget" "Cabal-3.16.0.0-1YZHuvI2dgR4GlGeuk23es" 'False) (C1 ('MetaCons "BuildTargetComponent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName)) :+: (C1 ('MetaCons "BuildTargetModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)) :+: C1 ('MetaCons "BuildTargetFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))))

Methods

from :: BuildTarget -> Rep BuildTarget x #

to :: Rep BuildTarget x -> BuildTarget #

Show BuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> BuildTarget -> ShowS #

show :: BuildTarget -> String #

showList :: [BuildTarget] -> ShowS #

Binary BuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

put :: BuildTarget -> Put #

get :: Get BuildTarget #

putList :: [BuildTarget] -> Put #

Eq BuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

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

(/=) :: BuildTarget -> BuildTarget -> Bool #

type Rep BuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

type Rep BuildTarget = D1 ('MetaData "BuildTarget" "Distribution.Simple.BuildTarget" "Cabal-3.16.0.0-1YZHuvI2dgR4GlGeuk23es" 'False) (C1 ('MetaCons "BuildTargetComponent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName)) :+: (C1 ('MetaCons "BuildTargetModule" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleName)) :+: C1 ('MetaCons "BuildTargetFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ComponentName) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath))))

showBuildTarget :: PackageId -> BuildTarget -> String Source #

Unambiguously render a BuildTarget , so that it can be parsed in all situations.

data QualLevel Source #

Constructors

QL1

QL2

QL3

Instances

Instances details

Enum QualLevel Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

succ :: QualLevel -> QualLevel #

pred :: QualLevel -> QualLevel #

toEnum :: Int -> QualLevel #

fromEnum :: QualLevel -> Int #

enumFrom :: QualLevel -> [QualLevel] #

enumFromThen :: QualLevel -> QualLevel -> [QualLevel] #

enumFromTo :: QualLevel -> QualLevel -> [QualLevel] #

enumFromThenTo :: QualLevel -> QualLevel -> QualLevel -> [QualLevel] #

Show QualLevel Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> QualLevel -> ShowS #

show :: QualLevel -> String #

showList :: [QualLevel] -> ShowS #

buildTargetComponentName :: BuildTarget -> ComponentName Source #

Parsing user build targets

data UserBuildTarget Source #

Various ways that a user may specify a build target.

Instances

Instances details

Show UserBuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> UserBuildTarget -> ShowS #

show :: UserBuildTarget -> String #

showList :: [UserBuildTarget] -> ShowS #

Eq UserBuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

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

(/=) :: UserBuildTarget -> UserBuildTarget -> Bool #

Ord UserBuildTarget Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

compare :: UserBuildTarget -> UserBuildTarget -> Ordering #

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

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

(>) :: UserBuildTarget -> UserBuildTarget -> Bool #

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

max :: UserBuildTarget -> UserBuildTarget -> UserBuildTarget #

min :: UserBuildTarget -> UserBuildTarget -> UserBuildTarget #

readUserBuildTargets :: [String] -> ([UserBuildTargetProblem], [UserBuildTarget]) Source #

showUserBuildTarget :: UserBuildTarget -> String Source #

data UserBuildTargetProblem Source #

Constructors

UserBuildTargetUnrecognised String

Instances

Instances details

Show UserBuildTargetProblem Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> UserBuildTargetProblem -> ShowS #

show :: UserBuildTargetProblem -> String #

showList :: [UserBuildTargetProblem] -> ShowS #

reportUserBuildTargetProblems :: Verbosity -> [UserBuildTargetProblem] -> IO () Source #

Resolving build targets

resolveBuildTargets :: PackageDescription -> [(UserBuildTarget, Bool)] -> ([BuildTargetProblem], [BuildTarget]) Source #

Given a bunch of user-specified targets, try to resolve what it is they refer to.

data BuildTargetProblem Source #

Constructors

BuildTargetExpected UserBuildTarget [String] String

expected thing: (actually got)

BuildTargetNoSuch UserBuildTarget [(String, String)]

(no such thing, actually got)

BuildTargetAmbiguous UserBuildTarget [(UserBuildTarget, BuildTarget)]

Instances

Instances details

Show BuildTargetProblem Source #

Instance details

Defined in Distribution.Simple.BuildTarget

Methods

showsPrec :: Int -> BuildTargetProblem -> ShowS #

show :: BuildTargetProblem -> String #

showList :: [BuildTargetProblem] -> ShowS #

reportBuildTargetProblems :: Verbosity -> [BuildTargetProblem] -> IO () Source #