| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Distribution.Client.ProjectConfig.Legacy
Description
Project configuration, implementation in terms of legacy types.
Synopsis
- type ProjectConfigSkeleton = CondTree ConfVar ([(Maybe URI, ProjectConfigPath)], ProjectConfig)
- instantiateProjectConfigSkeletonFetchingCompiler :: Monad m => m (OS, Arch, Compiler) -> FlagAssignment -> ProjectConfigSkeleton -> m (ProjectConfig, Maybe Compiler)
- instantiateProjectConfigSkeletonWithCompiler :: OS -> Arch -> CompilerInfo -> FlagAssignment -> ProjectConfigSkeleton -> ProjectConfig
- singletonProjectConfigSkeleton :: ProjectConfig -> ProjectConfigSkeleton
- parseProject :: FilePath -> FilePath -> HttpTransport -> Verbosity -> ProjectConfigToParse -> IO (ProjectParseResult ProjectConfigSkeleton)
- parseLegacyProjectConfig :: FilePath -> ByteString -> ParseResult LegacyProjectConfig
- data LegacyProjectConfig
- showLegacyProjectConfig :: LegacyProjectConfig -> String
- commandLineFlagsToProjectConfig :: GlobalFlags -> NixStyleFlags a -> ClientInstallFlags -> ProjectConfig
- convertLegacyProjectConfig :: LegacyProjectConfig -> ProjectConfig
- convertLegacyGlobalConfig :: SavedConfig -> ProjectConfig
- convertToLegacyProjectConfig :: ProjectConfig -> LegacyProjectConfig
- parsePackageLocationTokenQ :: ReadP String
- renderPackageLocationToken :: String -> String
Skeletons
type ProjectConfigSkeleton = CondTree ConfVar ([(Maybe URI, ProjectConfigPath)], ProjectConfig) Source #
ProjectConfigSkeleton is a tree of conditional blocks and imports wrapping a config. It can be finalized by providing the conditional resolution info and then resolving and downloading the imports
instantiateProjectConfigSkeletonFetchingCompiler :: Monad m => m (OS, Arch, Compiler) -> FlagAssignment -> ProjectConfigSkeleton -> m (ProjectConfig, Maybe Compiler) Source #
instantiateProjectConfigSkeletonWithCompiler :: OS -> Arch -> CompilerInfo -> FlagAssignment -> ProjectConfigSkeleton -> ProjectConfig Source #
Parsing
Arguments
| :: FilePath | The root of the project configuration, typically cabal.project |
| -> FilePath | |
| -> HttpTransport | |
| -> Verbosity | |
| -> ProjectConfigToParse | The contents of the file to parse |
| -> IO (ProjectParseResult ProjectConfigSkeleton) |
Parses a project from its root config file, typically cabal.project.
parseLegacyProjectConfig :: FilePath -> ByteString -> ParseResult LegacyProjectConfig Source #
Legacy Configuration
data LegacyProjectConfig Source #
We already have parsers/pretty-printers for almost all the fields in the project config file, but they're in terms of the types used for the command line flags for Setup.hs or cabal commands. We don't want to redefine them all, at least not yet so for the moment we use the parsers at the old types and use conversion functions.
Ultimately if/when this project-based approach becomes the default then we can redefine the parsers directly for the new types.
Instances
Conversions
commandLineFlagsToProjectConfig :: GlobalFlags -> NixStyleFlags a -> ClientInstallFlags -> ProjectConfig Source #
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.
convertLegacyProjectConfig :: LegacyProjectConfig -> ProjectConfig Source #
Convert the project config from the legacy types to the ProjectConfig
and associated types. See LegacyProjectConfig for an explanation of the
approach.
convertLegacyGlobalConfig :: SavedConfig -> ProjectConfig Source #
Convert from the types currently used for the user-wide Cabal config
file into the ProjectConfig type.
Only a subset of the ProjectConfig can be represented in the user-wide
config. In particular it does not include packages that are in the project,
and it also doesn't support package-specific configuration (only
configuration that applies to all packages).
Internals
These functions are exposed just for tests.
parsePackageLocationTokenQ :: ReadP String Source #
This is a bit tricky since it has to cover globs which have embedded ,
chars. But we don't just want to parse strictly as a glob since we want to
allow http urls which don't parse as globs, and possibly some
system-dependent file paths. So we parse fairly liberally as a token, but
we allow , inside matched {} braces.