Debian.Control.Policy

Access to things that Debian policy says should be in a valid control file. The pure functions will not throw ControlFileError if they are operating on a DebianControl value returned by validateDebianControl. However, they might if they are created using unsafeDebianControl.

Validated debian control file type

data DebianControl

Opaque (constructor not exported) type to hold a validated Debian Control File

Instances

Show DebianControl

Methods

showsPrec :: Int -> DebianControl -> ShowS

show :: DebianControl -> String

showList :: [DebianControl] -> ShowS

HasDebianControl DebianControl

Methods

debianControl :: DebianControl -> DebianControl

validateDebianControl :: MonadCatch m => Control' Text -> m (Either ControlFileError DebianControl)

Validate and return a control file in an opaque wrapper. May throw a ControlFileError. Currently we only verify that it has a Source field in the first paragraph and one or more subsequent paragraphs each with a Package field, and no syntax errors in the build dependencies (though they may be absent.)

unsafeDebianControl :: Control' Text -> DebianControl

parseDebianControlFromFile :: FilePath -> IO (Either ControlFileError DebianControl)

parseDebianControl :: MonadCatch m => String -> Text -> m (Either ControlFileError DebianControl)

data ControlFileError

Errors that control files might throw, with source file name and line number generated by template haskell.

Constructors

NoParagraphs

Fields

• locs :: [Loc]

NoBinaryParagraphs

Fields

• locs :: [Loc]
• ctl :: String

MissingField

Fields

• locs :: [Loc]
• field :: String

ParseRelationsError

Fields

• locs :: [Loc]
• parseError :: ParseError

ParseControlError

Fields

• locs :: [Loc]
• parseError :: ParseError

IOError

Fields

• locs :: [Loc]
• ioError :: IOError

Instances

Eq ControlFileError

Methods

(==) :: ControlFileError -> ControlFileError -> Bool

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

Show ControlFileError

Methods

showsPrec :: Int -> ControlFileError -> ShowS

show :: ControlFileError -> String

showList :: [ControlFileError] -> ShowS

Exception ControlFileError

Methods

toException :: ControlFileError -> SomeException

fromException :: SomeException -> Maybe ControlFileError

displayException :: ControlFileError -> String

Class of things that contain one DebianControl value

class Show a => HasDebianControl a where

Class of things that contain a validated Debian control file.

Minimal complete definition

debianControl

Methods

debianControl :: a -> DebianControl

Instances

HasDebianControl DebianControl

Methods

debianControl :: DebianControl -> DebianControl

Pure functions that operate on validated control files

debianSourceParagraph :: HasDebianControl a => a -> Paragraph' Text

debianBinaryParagraphs :: HasDebianControl a => a -> [Paragraph' Text]

debianPackageParagraphs :: HasDebianControl a => a -> (Paragraph' Text, [Paragraph' Text])

debianPackageNames :: HasDebianControl a => a -> (SrcPkgName, [BinPkgName])

debianSourcePackageName :: HasDebianControl a => a -> SrcPkgName

debianBinaryPackageNames :: HasDebianControl a => a -> [BinPkgName]

debianRelations :: HasDebianControl a => String -> a -> Either ControlFileError (Maybe Relations)

This could access fields we haven't validated, so it can return an error. Additionally, the field might be absent, in which case it returns Nothing.

debianBuildDeps :: HasDebianControl a => a -> Maybe Relations

debianBuildDepsIndep :: HasDebianControl a => a -> Maybe Relations