Modulehorizon-config-shell-0.12.1GHC2024

Horizon.Config.Vx

A horizon.vx as a typed value: one Statement per verb of the config language, printed in a canonical flat form and read back. A SetConfig is the set the statements declare, so a converter builds the value and printVx writes it, never concatenating program text.

4 types
6 values

Packagehorizon-config-shell-0.12.1
Exports10
LanguageGHC2024
LicenceBSD-3-Clause
SourceVx.hs

datadata Statement

One statement of a horizon.vx: a verb and its arguments.

Instances2Eq, Show

Eq StatementDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx
Show StatementDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx

datadata Policy

One field of the set-wide build policy, named as its verb.

PolicyDoBenchmark PolicyDoCheck PolicyDoHaddock PolicyDoJailbreak PolicyEnableProfiling PolicyIncludeBenchmarks PolicyIncludeExecutables PolicyIncludeTests

Instances4Bounded, Enum, Eq, Show

Bounded PolicyDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx
Enum PolicyDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx
Eq PolicyDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx
Show PolicyDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx

datadata Export

The file the set is exported to, and as what.

Constructors

ExportPackageSet Text
ExportOverlay Text

Instances2Eq, Show

Eq ExportDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx
Show ExportDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx

datadata SetConfig

What a horizon.vx declares about a set that is not a solve: its metadata, base, repository scope, declared repositories, export, packages under one policy with the facts of the local ones, and roots.

Constructors

MkSetConfig
- setName :: Maybe Text
- setDescription :: Maybe Text
- setOn :: Maybe Base
- setPlatform :: Maybe Platform
- setIndexState :: Maybe IndexState
- setExport :: Export
- setPackages :: PackageSet
- setRoots :: [PackageName]
- setScope :: RepoScope
- setRepositories :: [SecureRepository]
- setFacts :: Map PackageName PackageFacts

Instances2Eq, Show

Eq SetConfigDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx
Show SetConfigDefined in horizon-config-shell-0.12.1 · Horizon.Config.Vx

valuepolicyOf :: Policy -> Modifiers -> Bool

A policy field's value.

valuesetStatements :: SetConfig -> [Statement]

The canonical statements of a set: metadata, compiler, base, export, the policy fields that differ from defaultModifiers, each package (by name) followed by its own facts, then the roots.

valuefromStatements :: [Statement] -> SetConfig

The set some statements declare, folded in order as the host folds the config: a later pin replaces an earlier one and keeps its facts, which accumulate on the package pinned before them.

valuestatementConfig :: Statement -> Config ()

The config verb a statement is.

valueprintVx :: [Statement] -> Text

The statements as a flat horizon.vx: one statement per line at the left margin, each string a Haskell literal.

valueparseVx :: Text -> Either ConfigError [Statement]

Read a flat horizon.vx written in the form printVx writes: one statement per line, blank lines and -- comments skipped.