Distribution.Helper

cabal-helper-0.7.1.0: Simple interface to some of Cabal's configuration state used by ghc-mod

Safe Haskell | None
Language | Haskell2010

Distribution.Helper

Contents

- Running Queries
- Queries against Cabal's on disk state
- Result types
- General information
- Stuff that cabal-install really should export
- Managing `dist/`
- $libexec related error handling

Synopsis

- data Programs = Programs {
  - cabalProgram :: FilePath
  - ghcProgram :: FilePath
  - ghcPkgProgram :: FilePath
  }
- defaultPrograms :: Programs
- data QueryEnv
- qeReadProcess :: QueryEnv -> FilePath -> [String] -> String -> IO String
- qePrograms :: QueryEnv -> Programs
- qeProjectDir :: QueryEnv -> FilePath
- qeDistDir :: QueryEnv -> FilePath
- qeCabalPkgDb :: QueryEnv -> Maybe FilePath
- qeCabalVer :: QueryEnv -> Maybe Version
- defaultQueryEnv :: FilePath -> FilePath -> QueryEnv
- data Query m a
- runQuery :: Monad m => QueryEnv -> Query m a -> m a
- packageDbStack :: MonadIO m => Query m [ChPkgDb]
- entrypoints :: MonadIO m => Query m [(ChComponentName, ChEntrypoint)]
- sourceDirs :: MonadIO m => Query m [(ChComponentName, [FilePath])]
- ghcOptions :: MonadIO m => Query m [(ChComponentName, [String])]
- ghcSrcOptions :: MonadIO m => Query m [(ChComponentName, [String])]
- ghcPkgOptions :: MonadIO m => Query m [(ChComponentName, [String])]
- ghcMergedPkgOptions :: MonadIO m => Query m [String]
- ghcLangOptions :: MonadIO m => Query m [(ChComponentName, [String])]
- pkgLicenses :: MonadIO m => Query m [(String, [(String, Version)])]
- flags :: MonadIO m => Query m [(String, Bool)]
- configFlags :: MonadIO m => Query m [(String, Bool)]
- nonDefaultConfigFlags :: MonadIO m => Query m [(String, Bool)]
- packageId :: MonadIO m => Query m (String, Version)
- compilerVersion :: MonadIO m => Query m (String, Version)
- newtype ChModuleName = ChModuleName String
- data ChComponentName
  - = ChSetupHsName
  - | ChLibName String
  - | ChExeName String
  - | ChTestName String
  - | ChBenchName String
- data ChPkgDb
  - = ChPkgGlobal
  - | ChPkgUser
  - | ChPkgSpecific FilePath
- data ChEntrypoint
  - = ChSetupEntrypoint
  - | ChLibEntrypoint {
    - chExposedModules :: [ChModuleName]
    - chOtherModules :: [ChModuleName]
    }
  - | ChExeEntrypoint {
    - chMainIs :: FilePath
    - chOtherModules :: [ChModuleName]
    }
- buildPlatform :: (FilePath -> [String] -> String -> IO String) -> IO String
- getSandboxPkgDb :: (FilePath -> [String] -> String -> IO String) -> FilePath -> Version -> IO (Maybe FilePath)
- prepare :: MonadIO m => (FilePath -> [String] -> String -> IO String) -> FilePath -> FilePath -> m ()
- prepare' :: MonadIO m => QueryEnv -> m ()
- reconfigure :: MonadIO m => (FilePath -> [String] -> String -> IO String) -> Programs -> [String] -> m ()
- writeAutogenFiles :: MonadIO m => (FilePath -> [String] -> String -> IO String) -> FilePath -> FilePath -> m ()
- writeAutogenFiles' :: MonadIO m => QueryEnv -> m ()
- data LibexecNotFoundError = LibexecNotFoundError String FilePath
- libexecNotFoundError :: String -> FilePath -> String -> String

# Documentation

data Programs

Paths or names of various programs we need.

Constructors

Programs |
Fields cabalProgram :: FilePath ghcProgram :: FilePath ghcPkgProgram :: FilePath

Instances

Eq Programs |
Ord Programs |
Read Programs |
Show Programs |
Generic Programs |
type Rep Programs |

defaultPrograms :: Programs

data QueryEnv

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

How to start the cabal-helper process. Useful if you need to capture stderr output from the helper.

qePrograms :: QueryEnv -> Programs

qeProjectDir :: QueryEnv -> FilePath

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

qeDistDir :: QueryEnv -> FilePath

Path to the `dist/` directory

qeCabalPkgDb :: QueryEnv -> Maybe FilePath

Where to look for the Cabal library when linking the helper

qeCabalVer :: QueryEnv -> Maybe Version

If `dist/setup-config` wasn't written by this version of Cabal throw an error

defaultQueryEnv

Arguments

:: FilePath | Path to project directory, i.e. the one containing the `project.cabal` file
-> FilePath | Path to the `dist/` directory
-> QueryEnv |

# Running Queries

data Query m a

Caches helper executable result so it doesn't have to be run more than once as reading in Cabal's `LocalBuildInfo` datatype from disk is very slow but running all possible queries against it at once is cheap.

Instances

MonadTrans Query |
Monad m => Monad (Query m) |
Functor m => Functor (Query m) |
Monad m => Applicative (Query m) |
MonadIO m => MonadIO (Query m) |

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

`runQuery query distdir`. Run a `Query`. `distdir` is where Cabal's `setup-config` file is located.

# Queries against Cabal's on disk state

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

List of package databases to use.

entrypoints :: MonadIO m => Query m [(ChComponentName, ChEntrypoint)]

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

sourceDirs :: MonadIO m => Query m [(ChComponentName, [FilePath])]

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

ghcOptions :: MonadIO m => Query m [(ChComponentName, [String])]

All options cabal would pass to GHC.

ghcSrcOptions :: MonadIO m => Query m [(ChComponentName, [String])]

Only search path related GHC options.

ghcPkgOptions :: MonadIO m => Query m [(ChComponentName, [String])]

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

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

Like `ghcPkgOptions` but for the whole package not just one component

ghcLangOptions :: MonadIO m => Query m [(ChComponentName, [String])]

Only language related options, i.e. `-XSomeExtension`

pkgLicenses :: MonadIO m => Query m [(String, [(String, Version)])]

Get the licenses of the packages the current project is linking against.

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

Flag definitions from cabal file

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.

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

Package identifier, i.e. package name and version

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

The version of GHC the project is configured to use

# Result types

newtype ChModuleName

Constructors

ChModuleName String |

Instances

Eq ChModuleName |
Ord ChModuleName |
Read ChModuleName |
Show ChModuleName |
Generic ChModuleName |
type Rep ChModuleName |

data ChComponentName

Constructors

ChSetupHsName |
ChLibName String |
ChExeName String |
ChTestName String |
ChBenchName String |

Instances

Eq ChComponentName |
Ord ChComponentName |
Read ChComponentName |
Show ChComponentName |
Generic ChComponentName |
type Rep ChComponentName |

data ChPkgDb

Constructors

ChPkgGlobal |
ChPkgUser |
ChPkgSpecific FilePath |

Instances

Eq ChPkgDb |
Ord ChPkgDb |
Read ChPkgDb |
Show ChPkgDb |
Generic ChPkgDb |
type Rep ChPkgDb |

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]
ChExeEntrypoint |
Fields chMainIs :: FilePath chOtherModules :: [ChModuleName]

Instances

Eq ChEntrypoint |
Ord ChEntrypoint |
Read ChEntrypoint |
Show ChEntrypoint |
Generic ChEntrypoint |
type Rep ChEntrypoint |

# General information

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

# Stuff that cabal-install really should export

getSandboxPkgDb

Arguments

:: (FilePath -> [String] -> String -> IO String) |
-> FilePath | 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 => (FilePath -> [String] -> String -> IO String) -> FilePath -> FilePath -> m ()

Deprecated: Will be replaced by prepare' in the next major release

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

Arguments

:: MonadIO m |
=> (FilePath -> [String] -> String -> IO String) |
-> FilePath | Path to project directory, i.e. the one containing the `project.cabal` file
-> FilePath | Path to the `dist/` directory
-> m () |

Deprecated: Will be replaced by writeAutogenFiles' in the next major release

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 |
Exception LibexecNotFoundError |

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 |