Distribution.Helper

Running Queries

data Query m a

A lazy, cached, query against a package's Cabal configuration. Use runQuery to execute it.

Instances

MonadTrans Query

Defined in Distribution.Helper

Methods

lift :: Monad m => m a -> Query m a

Monad m => Monad (Query m)

Defined in Distribution.Helper

Methods

(>>=) :: Query m a -> (a -> Query m b) -> Query m b

(>>) :: Query m a -> Query m b -> Query m b

return :: a -> Query m a

fail :: String -> Query m a

Functor m => Functor (Query m)

Defined in Distribution.Helper

Methods

fmap :: (a -> b) -> Query m a -> Query m b

(<$) :: a -> Query m b -> Query m a

Monad m => Applicative (Query m)

Defined in Distribution.Helper

Methods

pure :: a -> Query m a

(<*>) :: Query m (a -> b) -> Query m a -> Query m b

liftA2 :: (a -> b -> c) -> Query m a -> Query m b -> Query m c

(*>) :: Query m a -> Query m b -> Query m b

(<*) :: Query m a -> Query m b -> Query m a

MonadIO m => MonadIO (Query m)

Defined in Distribution.Helper

Methods

liftIO :: IO a -> Query m a

runQuery :: Monad m => QueryEnv -> Query m a -> m a

runQuery env query. Run a Query under a given QueryEnv.

Queries against Cabal's on disk state

Package queries

packageId :: MonadIO m => Query m (String, Version)

Package identifier, i.e. package name and version

packageDbStack :: MonadIO m => Query m [ChPkgDb]

List of package databases to use.

packageFlags :: MonadIO m => Query m [(String, Bool)]

Flag definitions from cabal file

compilerVersion :: MonadIO m => Query m (String, Version)

The version of GHC the project is configured to use

ghcMergedPkgOptions :: MonadIO m => Query m [String]

Like ghcPkgOptions but for the whole package not just one component

cabal-install queries

configFlags :: MonadIO m => Query m [(String, Bool)]

Flag assignments from setup-config

nonDefaultConfigFlags :: MonadIO m => Query m [(String, Bool)]

Flag assignments from setup-config which differ from the default setting. This can also include flags which cabal decided to modify, i.e. don't rely on these being the flags set by the user directly.

Component queries

data ComponentQuery m a

A Query to run on all components of a package. Use components to get a regular Query.

Instances

Functor m => Functor (ComponentQuery m)

Defined in Distribution.Helper

Methods

fmap :: (a -> b) -> ComponentQuery m a -> ComponentQuery m b

(<$) :: a -> ComponentQuery m b -> ComponentQuery m a

(Functor m, Monad m) => Apply (ComponentQuery m)

Defined in Distribution.Helper

Methods

(<.>) :: ComponentQuery m (a -> b) -> ComponentQuery m a -> ComponentQuery m b

(.>) :: ComponentQuery m a -> ComponentQuery m b -> ComponentQuery m b

(<.) :: ComponentQuery m a -> ComponentQuery m b -> ComponentQuery m a

liftF2 :: (a -> b -> c) -> ComponentQuery m a -> ComponentQuery m b -> ComponentQuery m c

components :: Monad m => ComponentQuery m (ChComponentName -> b) -> Query m [b]

Run a ComponentQuery on all components of the package.

ghcSrcOptions :: MonadIO m => ComponentQuery m [String]

Only search path related GHC options.

ghcPkgOptions :: MonadIO m => ComponentQuery m [String]

Only package related GHC options, sufficient for things don't need to access any home modules.

ghcLangOptions :: MonadIO m => ComponentQuery m [String]

Only language related options, i.e. -XSomeExtension

ghcOptions :: MonadIO m => ComponentQuery m [String]

All options Cabal would pass to GHC.

sourceDirs :: MonadIO m => ComponentQuery m [FilePath]

A component's source-dirs field, beware since if this is empty implicit behaviour in GHC kicks in.

entrypoints :: MonadIO m => ComponentQuery m ChEntrypoint

Modules or files Cabal would have the compiler build directly. Can be used to compute the home module closure for a component.

needsBuildOutput :: MonadIO m => ComponentQuery m NeedsBuildOutput

The component has a non-default module renaming, so needs build output ().

Query environment

data QueryEnv

Environment for running a Query. The real constructor is not exposed, the field accessors are however. See below. Use the mkQueryEnv smart constructor to construct one.

mkQueryEnv

Arguments

:: FilePath

Path to the project directory, i.e. the directory containing a project.cabal file

-> FilePath

Path to the dist/ directory, called builddir in Cabal terminology.

-> QueryEnv

mkQueryEnv projdir distdir. Smart constructor for QueryEnv. Sets fields qeProjectDir and qeDistDir to projdir and distdir respectively and provides sensible defaults for the other fields.

qeReadProcess :: QueryEnv -> FilePath -> [String] -> String -> IO String

Field accessor for QueryEnv. Defines how to start the cabal-helper process. Useful if you need to capture stderr output from the helper.

qePrograms :: QueryEnv -> Programs

Field accessor for QueryEnv.

qeProjectDir :: QueryEnv -> FilePath

Field accessor for QueryEnv. Defines path to the project directory, i.e. a directory containing a project.cabal file

qeDistDir :: QueryEnv -> FilePath

Field accessor for QueryEnv. Defines path to the dist/ directory, builddir in Cabal terminology.

qeCabalPkgDb :: QueryEnv -> Maybe FilePath

Field accessor for QueryEnv. Defines where to look for the Cabal library when linking the helper.

qeCabalVer :: QueryEnv -> Maybe Version

Field accessor for QueryEnv. If dist/setup-config wasn't written by this version of Cabal an error is thrown when running the query.

data Programs

Paths or names of various programs we need.

Constructors

Programs

Fields

• cabalProgram :: FilePath

  The path to the cabal program.

• ghcProgram :: FilePath

  The path to the ghc program.

• ghcPkgProgram :: FilePath

  The path to the ghc-pkg program. If not changed it will be derived from the path to ghcProgram.

Instances

Eq Programs

Defined in Distribution.Helper

Methods

(==) :: Programs -> Programs -> Bool

(/=) :: Programs -> Programs -> Bool

Ord Programs

Defined in Distribution.Helper

Methods

compare :: Programs -> Programs -> Ordering

(<) :: Programs -> Programs -> Bool

(<=) :: Programs -> Programs -> Bool

(>) :: Programs -> Programs -> Bool

(>=) :: Programs -> Programs -> Bool

max :: Programs -> Programs -> Programs

min :: Programs -> Programs -> Programs

Read Programs

Defined in Distribution.Helper

Methods

readsPrec :: Int -> ReadS Programs

readList :: ReadS [Programs]

readPrec :: ReadPrec Programs

readListPrec :: ReadPrec [Programs]

Show Programs

Defined in Distribution.Helper

Methods

showsPrec :: Int -> Programs -> ShowS

show :: Programs -> String

showList :: [Programs] -> ShowS

Generic Programs

Defined in Distribution.Helper

Associated Types

type Rep Programs :: * -> *

Methods

from :: Programs -> Rep Programs x

to :: Rep Programs x -> Programs

type Rep Programs

Defined in Distribution.Helper

type Rep Programs = D1 (MetaData "Programs" "Distribution.Helper" "cabal-helper-0.8.1.0-1ndY4V2r1ga1SdRkfK8Qqm" False) (C1 (MetaCons "Programs" PrefixI True) (S1 (MetaSel (Just "cabalProgram") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: (S1 (MetaSel (Just "ghcProgram") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "ghcPkgProgram") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))))

defaultPrograms :: Programs

Default all programs to their unqualified names, i.e. they will be searched for on PATH.

Result types

newtype ChModuleName

Constructors

ChModuleName String

Instances

Eq ChModuleName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

(==) :: ChModuleName -> ChModuleName -> Bool

(/=) :: ChModuleName -> ChModuleName -> Bool

Ord ChModuleName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

compare :: ChModuleName -> ChModuleName -> Ordering

(<) :: ChModuleName -> ChModuleName -> Bool

(<=) :: ChModuleName -> ChModuleName -> Bool

(>) :: ChModuleName -> ChModuleName -> Bool

(>=) :: ChModuleName -> ChModuleName -> Bool

max :: ChModuleName -> ChModuleName -> ChModuleName

min :: ChModuleName -> ChModuleName -> ChModuleName

Read ChModuleName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

readsPrec :: Int -> ReadS ChModuleName

readList :: ReadS [ChModuleName]

readPrec :: ReadPrec ChModuleName

readListPrec :: ReadPrec [ChModuleName]

Show ChModuleName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

showsPrec :: Int -> ChModuleName -> ShowS

show :: ChModuleName -> String

showList :: [ChModuleName] -> ShowS

Generic ChModuleName

Defined in CabalHelper.Shared.InterfaceTypes

Associated Types

type Rep ChModuleName :: * -> *

Methods

from :: ChModuleName -> Rep ChModuleName x

to :: Rep ChModuleName x -> ChModuleName

type Rep ChModuleName

Defined in CabalHelper.Shared.InterfaceTypes

type Rep ChModuleName = D1 (MetaData "ChModuleName" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-0.8.1.0-1ndY4V2r1ga1SdRkfK8Qqm" True) (C1 (MetaCons "ChModuleName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

data ChComponentName

Constructors

ChSetupHsName

ChLibName

ChSubLibName String

ChFLibName String

ChExeName String

ChTestName String

ChBenchName String

Instances

Eq ChComponentName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

(==) :: ChComponentName -> ChComponentName -> Bool

(/=) :: ChComponentName -> ChComponentName -> Bool

Ord ChComponentName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

compare :: ChComponentName -> ChComponentName -> Ordering

(<) :: ChComponentName -> ChComponentName -> Bool

(<=) :: ChComponentName -> ChComponentName -> Bool

(>) :: ChComponentName -> ChComponentName -> Bool

(>=) :: ChComponentName -> ChComponentName -> Bool

max :: ChComponentName -> ChComponentName -> ChComponentName

min :: ChComponentName -> ChComponentName -> ChComponentName

Read ChComponentName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

readsPrec :: Int -> ReadS ChComponentName

readList :: ReadS [ChComponentName]

readPrec :: ReadPrec ChComponentName

readListPrec :: ReadPrec [ChComponentName]

Show ChComponentName

Defined in CabalHelper.Shared.InterfaceTypes

Methods

showsPrec :: Int -> ChComponentName -> ShowS

show :: ChComponentName -> String

showList :: [ChComponentName] -> ShowS

Generic ChComponentName

Defined in CabalHelper.Shared.InterfaceTypes

Associated Types

type Rep ChComponentName :: * -> *

Methods

from :: ChComponentName -> Rep ChComponentName x

to :: Rep ChComponentName x -> ChComponentName

type Rep ChComponentName

Defined in CabalHelper.Shared.InterfaceTypes

type Rep ChComponentName = D1 (MetaData "ChComponentName" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-0.8.1.0-1ndY4V2r1ga1SdRkfK8Qqm" False) ((C1 (MetaCons "ChSetupHsName" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ChLibName" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ChSubLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :+: ((C1 (MetaCons "ChFLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "ChExeName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) :+: (C1 (MetaCons "ChTestName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "ChBenchName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))

data ChPkgDb

Constructors

ChPkgGlobal

ChPkgUser

ChPkgSpecific FilePath

Instances

Eq ChPkgDb

Defined in CabalHelper.Shared.InterfaceTypes

Methods

(==) :: ChPkgDb -> ChPkgDb -> Bool

(/=) :: ChPkgDb -> ChPkgDb -> Bool

Ord ChPkgDb

Defined in CabalHelper.Shared.InterfaceTypes

Methods

compare :: ChPkgDb -> ChPkgDb -> Ordering

(<) :: ChPkgDb -> ChPkgDb -> Bool

(<=) :: ChPkgDb -> ChPkgDb -> Bool

(>) :: ChPkgDb -> ChPkgDb -> Bool

(>=) :: ChPkgDb -> ChPkgDb -> Bool

max :: ChPkgDb -> ChPkgDb -> ChPkgDb

min :: ChPkgDb -> ChPkgDb -> ChPkgDb

Read ChPkgDb

Defined in CabalHelper.Shared.InterfaceTypes

Methods

readsPrec :: Int -> ReadS ChPkgDb

readList :: ReadS [ChPkgDb]

readPrec :: ReadPrec ChPkgDb

readListPrec :: ReadPrec [ChPkgDb]

Show ChPkgDb

Defined in CabalHelper.Shared.InterfaceTypes

Methods

showsPrec :: Int -> ChPkgDb -> ShowS

show :: ChPkgDb -> String

showList :: [ChPkgDb] -> ShowS

Generic ChPkgDb

Defined in CabalHelper.Shared.InterfaceTypes

Associated Types

type Rep ChPkgDb :: * -> *

Methods

from :: ChPkgDb -> Rep ChPkgDb x

to :: Rep ChPkgDb x -> ChPkgDb

type Rep ChPkgDb

Defined in CabalHelper.Shared.InterfaceTypes

type Rep ChPkgDb = D1 (MetaData "ChPkgDb" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-0.8.1.0-1ndY4V2r1ga1SdRkfK8Qqm" False) (C1 (MetaCons "ChPkgGlobal" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ChPkgUser" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "ChPkgSpecific" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))))

data ChEntrypoint

Constructors

ChSetupEntrypoint

Almost like ChExeEntrypoint but main-is could either be "Setup.hs" or "Setup.lhs". Since we don't know where the source directory is you have to find these files.

ChLibEntrypoint

Fields

• chExposedModules :: [ChModuleName]
• chOtherModules :: [ChModuleName]
• chSignatures :: [ChModuleName]

ChExeEntrypoint

Fields

• chMainIs :: FilePath
• chOtherModules :: [ChModuleName]

Instances

Eq ChEntrypoint

Defined in CabalHelper.Shared.InterfaceTypes

Methods

(==) :: ChEntrypoint -> ChEntrypoint -> Bool

(/=) :: ChEntrypoint -> ChEntrypoint -> Bool

Ord ChEntrypoint

Defined in CabalHelper.Shared.InterfaceTypes

Methods

compare :: ChEntrypoint -> ChEntrypoint -> Ordering

(<) :: ChEntrypoint -> ChEntrypoint -> Bool

(<=) :: ChEntrypoint -> ChEntrypoint -> Bool

(>) :: ChEntrypoint -> ChEntrypoint -> Bool

(>=) :: ChEntrypoint -> ChEntrypoint -> Bool

max :: ChEntrypoint -> ChEntrypoint -> ChEntrypoint

min :: ChEntrypoint -> ChEntrypoint -> ChEntrypoint

Read ChEntrypoint

Defined in CabalHelper.Shared.InterfaceTypes

Methods

readsPrec :: Int -> ReadS ChEntrypoint

readList :: ReadS [ChEntrypoint]

readPrec :: ReadPrec ChEntrypoint

readListPrec :: ReadPrec [ChEntrypoint]

Show ChEntrypoint

Defined in CabalHelper.Shared.InterfaceTypes

Methods

showsPrec :: Int -> ChEntrypoint -> ShowS

show :: ChEntrypoint -> String

showList :: [ChEntrypoint] -> ShowS

Generic ChEntrypoint

Defined in CabalHelper.Shared.InterfaceTypes

Associated Types

type Rep ChEntrypoint :: * -> *

Methods

from :: ChEntrypoint -> Rep ChEntrypoint x

to :: Rep ChEntrypoint x -> ChEntrypoint

type Rep ChEntrypoint

Defined in CabalHelper.Shared.InterfaceTypes

type Rep ChEntrypoint = D1 (MetaData "ChEntrypoint" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-0.8.1.0-1ndY4V2r1ga1SdRkfK8Qqm" False) (C1 (MetaCons "ChSetupEntrypoint" PrefixI False) (U1 :: * -> *) :+: (C1 (MetaCons "ChLibEntrypoint" PrefixI True) (S1 (MetaSel (Just "chExposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]) :*: (S1 (MetaSel (Just "chOtherModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]) :*: S1 (MetaSel (Just "chSignatures") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]))) :+: C1 (MetaCons "ChExeEntrypoint" PrefixI True) (S1 (MetaSel (Just "chMainIs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "chOtherModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]))))

data NeedsBuildOutput

Constructors

ProduceBuildOutput

NoBuildOutput

Instances

Eq NeedsBuildOutput

Defined in CabalHelper.Shared.InterfaceTypes

Methods

(==) :: NeedsBuildOutput -> NeedsBuildOutput -> Bool

(/=) :: NeedsBuildOutput -> NeedsBuildOutput -> Bool

Ord NeedsBuildOutput

Defined in CabalHelper.Shared.InterfaceTypes

Methods

compare :: NeedsBuildOutput -> NeedsBuildOutput -> Ordering

(<) :: NeedsBuildOutput -> NeedsBuildOutput -> Bool

(<=) :: NeedsBuildOutput -> NeedsBuildOutput -> Bool

(>) :: NeedsBuildOutput -> NeedsBuildOutput -> Bool

(>=) :: NeedsBuildOutput -> NeedsBuildOutput -> Bool

max :: NeedsBuildOutput -> NeedsBuildOutput -> NeedsBuildOutput

min :: NeedsBuildOutput -> NeedsBuildOutput -> NeedsBuildOutput

Read NeedsBuildOutput

Defined in CabalHelper.Shared.InterfaceTypes

Methods

readsPrec :: Int -> ReadS NeedsBuildOutput

readList :: ReadS [NeedsBuildOutput]

readPrec :: ReadPrec NeedsBuildOutput

readListPrec :: ReadPrec [NeedsBuildOutput]

Show NeedsBuildOutput

Defined in CabalHelper.Shared.InterfaceTypes

Methods

showsPrec :: Int -> NeedsBuildOutput -> ShowS

show :: NeedsBuildOutput -> String

showList :: [NeedsBuildOutput] -> ShowS

Generic NeedsBuildOutput

Defined in CabalHelper.Shared.InterfaceTypes

Associated Types

type Rep NeedsBuildOutput :: * -> *

Methods

from :: NeedsBuildOutput -> Rep NeedsBuildOutput x

to :: Rep NeedsBuildOutput x -> NeedsBuildOutput

type Rep NeedsBuildOutput

Defined in CabalHelper.Shared.InterfaceTypes

type Rep NeedsBuildOutput = D1 (MetaData "NeedsBuildOutput" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-0.8.1.0-1ndY4V2r1ga1SdRkfK8Qqm" False) (C1 (MetaCons "ProduceBuildOutput" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "NoBuildOutput" PrefixI False) (U1 :: * -> *))

General information

buildPlatform :: (FilePath -> [String] -> String -> IO String) -> IO String

Stuff that cabal-install really should export

getSandboxPkgDb

Arguments

:: (FilePath -> [String] -> String -> IO String)

-> String

Cabal build platform, i.e. buildPlatform

-> Version

GHC version (cProjectVersion is your friend)

-> IO (Maybe FilePath)

Get the path to the sandbox package-db in a project

Managing dist/

prepare :: MonadIO m => QueryEnv -> m ()

Make sure the appropriate helper executable for the given project is installed and ready to run queries.

reconfigure

Arguments

:: MonadIO m

=> (FilePath -> [String] -> String -> IO String)

-> Programs

Program paths

-> [String]

Command line arguments to be passed to cabal

-> m ()

Run cabal configure

writeAutogenFiles :: MonadIO m => QueryEnv -> m ()

Create cabal_macros.h and Paths_<pkg> possibly other generated files in the usual place.

$libexec related error handling

data LibexecNotFoundError

This exception is thrown by all runQuery functions if the internal wrapper executable cannot be found. You may catch this and present the user an appropriate error message however the default is to print libexecNotFoundError.

Constructors

LibexecNotFoundError String FilePath

Instances

Show LibexecNotFoundError

Defined in Distribution.Helper

Methods

showsPrec :: Int -> LibexecNotFoundError -> ShowS

show :: LibexecNotFoundError -> String

showList :: [LibexecNotFoundError] -> ShowS

Exception LibexecNotFoundError

Defined in Distribution.Helper

Methods

toException :: LibexecNotFoundError -> SomeException

fromException :: SomeException -> Maybe LibexecNotFoundError

displayException :: LibexecNotFoundError -> String

libexecNotFoundError

Arguments

:: String

Name of the executable we were trying to find

-> FilePath

Path to $libexecdir

-> String

URL the user will be directed towards to report a bug.

-> String

Reexports

module Data.Functor.Apply