Copyright	(c) 2023 Bodigrim
License	BSD-3-Clause
Safe Haskell	None
Language	GHC2021

Distribution.Client.Add

Description

Building blocks of cabal-add executable.

Synopsis

parseCabalFile :: MonadError String m => FilePath -> ByteString -> m ([Field Position], GenericPackageDescription)
resolveComponent :: MonadError String m => FilePath -> ([Field a], GenericPackageDescription) -> Maybe String -> m (Either CommonStanza ComponentName)
newtype CommonStanza = CommonStanza {
- unCommonStanza :: ByteString
}
validateDependency :: MonadError String m => CabalSpecVersion -> String -> m ByteString
data AddConfig = AddConfig {
- cnfOrigContents :: !ByteString
- cnfFields :: ![Field Position]
- cnfComponent :: !(Either CommonStanza ComponentName)
- cnfTargetField :: !TargetField
- cnfAdditions :: !(NonEmpty ByteString)
}
executeAddConfig :: (Either CommonStanza ComponentName -> ByteString -> Bool) -> AddConfig -> Maybe ByteString
validateChanges :: GenericPackageDescription -> Either CommonStanza ComponentName -> ByteString -> Bool
data TargetField
- = BuildDepends
- | ExposedModules
- | OtherModules

Documentation

parseCabalFile Source #

Arguments

:: MonadError String m
=> FilePath	File name, just for error reporting.
-> ByteString	Contents of the Cabal file.
-> m ([Field Position], GenericPackageDescription)	Parsed data, suitable for `resolveComponent`.

Parse Cabal file into two representations.

resolveComponent Source #

Arguments

:: MonadError String m
=> FilePath	File name, just for error reporting.
-> ([Field a], GenericPackageDescription)	Parsed Cabal file, as returned by `parseCabalFile`.
-> Maybe String	Component name (or default component if `Nothing`), roughly adhering to the syntax of component targets.
-> m (Either CommonStanza ComponentName)	Resolved component.

Resolve a raw component name.

newtype CommonStanza Source #

Just a newtype wrapper, since Cabal-syntax does not provide any.

Constructors

CommonStanza
Fields unCommonStanza :: ByteString

Instances

Instances details

Show CommonStanza Source #
Instance details Defined in Distribution.Client.Common Methods showsPrec :: Int -> CommonStanza -> ShowS # show :: CommonStanza -> String # showList :: [CommonStanza] -> ShowS #
Eq CommonStanza Source #
Instance details Defined in Distribution.Client.Common Methods (==) :: CommonStanza -> CommonStanza -> Bool # (/=) :: CommonStanza -> CommonStanza -> Bool #
Ord CommonStanza Source #
Instance details Defined in Distribution.Client.Common Methods compare :: CommonStanza -> CommonStanza -> Ordering # (<) :: CommonStanza -> CommonStanza -> Bool # (<=) :: CommonStanza -> CommonStanza -> Bool # (>) :: CommonStanza -> CommonStanza -> Bool # (>=) :: CommonStanza -> CommonStanza -> Bool # max :: CommonStanza -> CommonStanza -> CommonStanza # min :: CommonStanza -> CommonStanza -> CommonStanza #

validateDependency Source #

Arguments

:: MonadError String m
=> CabalSpecVersion	Cabal format version to adhere to.
-> String	Raw dependency to add.
-> m ByteString	Validated dependency as `ByteString` (or an error).

Validate dependency syntax, checking whether Cabal would be able to parse it.

data AddConfig Source #

An input for executeAddConfig.

Constructors

AddConfig

Fields

cnfOrigContents :: !ByteString
Original Cabal file (with quirks patched, see Distribution.PackageDescription.Quirks), must be in sync with cnfFields.
cnfFields :: ![Field Position]
Parsed (by readFields or, more specifically, by parseCabalFile) representation of the Cabal file, must be in sync with cnfOrigContents.
cnfComponent :: !(Either CommonStanza ComponentName)
Which component to update? Usually constructed by resolveComponent.
cnfTargetField :: !TargetField
Which field to add the provided content to?
cnfAdditions :: !(NonEmpty ByteString)
Which content to add to the target field? Usually constructed by validateDependency.

Instances

Instances details

Show AddConfig Source #
Instance details Defined in Distribution.Client.Add Methods showsPrec :: Int -> AddConfig -> ShowS # show :: AddConfig -> String # showList :: [AddConfig] -> ShowS #
Eq AddConfig Source #
Instance details Defined in Distribution.Client.Add Methods (==) :: AddConfig -> AddConfig -> Bool # (/=) :: AddConfig -> AddConfig -> Bool #

executeAddConfig Source #

Arguments

:: (Either CommonStanza ComponentName -> ByteString -> Bool)	How to validate results? See `validateChanges`.
-> AddConfig	Input arguments.
-> Maybe ByteString	Updated contents, if validated successfully.

The main workhorse, adding fields to a specified component in the Cabal file.

validateChanges Source #

Arguments

:: GenericPackageDescription	Original package description.
-> Either CommonStanza ComponentName	Which component was supposed to be updated? Usually constructed by `resolveComponent`.
-> ByteString	Updated Cabal file.
-> Bool	Was the update successful?

Validate that updates did not cause unexpected effects on other sections of the Cabal file.

data TargetField Source #

A field in a cabal file, new content can be added to

Constructors

BuildDepends	Corresponds to `build-depends` in the cabal file
ExposedModules	Corresponds to `exposed-modules` in the cabal file
OtherModules	Corresponds to `other-modules` in the cabal file

Instances

Instances details

Show TargetField Source #
Instance details Defined in Distribution.Client.Common Methods showsPrec :: Int -> TargetField -> ShowS # show :: TargetField -> String # showList :: [TargetField] -> ShowS #
Eq TargetField Source #
Instance details Defined in Distribution.Client.Common Methods (==) :: TargetField -> TargetField -> Bool # (/=) :: TargetField -> TargetField -> Bool #
Ord TargetField Source #
Instance details Defined in Distribution.Client.Common Methods compare :: TargetField -> TargetField -> Ordering # (<) :: TargetField -> TargetField -> Bool # (<=) :: TargetField -> TargetField -> Bool # (>) :: TargetField -> TargetField -> Bool # (>=) :: TargetField -> TargetField -> Bool # max :: TargetField -> TargetField -> TargetField # min :: TargetField -> TargetField -> TargetField #