debian-3.87.2: Modules for working with the Debian package system

Safe HaskellNone




A module for working with Debian control files



newtype Control' a Source




unControl :: [Paragraph' a]


Eq a => Eq (Control' a) 
Ord a => Ord (Control' a) 
Read a => Read (Control' a) 
Show a => Show (Control' a) 
(ControlFunctions a, Pretty (PP a)) => Pretty (Control' a)

This may have bad performance issues (dsf: Whoever wrote this comment should have explained why.)

newtype Paragraph' a Source


Paragraph [Field' a] 


Eq a => Eq (Paragraph' a) 
Ord a => Ord (Paragraph' a) 
Read a => Read (Paragraph' a) 
Show a => Show (Paragraph' a) 
(ControlFunctions a, Pretty (PP a)) => Pretty (Paragraph' a) 

data Field' a Source

NOTE: we do not strip the leading or trailing whitespace in the name or value


Field (a, a) 
Comment a

Lines beginning with #


Eq a => Eq (Field' a) 
Ord a => Ord (Field' a) 
Read a => Read (Field' a) 
Show a => Show (Field' a) 
(ControlFunctions a, Pretty (PP a)) => Pretty (Field' a) 

class ControlFunctions a where Source


parseControlFromFile :: FilePath -> IO (Either ParseError (Control' a)) Source

parseControlFromFile filepath is a simple wrapper function that parses filepath using pControl

parseControlFromHandle :: String -> Handle -> IO (Either ParseError (Control' a)) Source

parseControlFromHandle sourceName handle - sourceName is only used for error reporting

parseControl :: String -> a -> Either ParseError (Control' a) Source

parseControlFromString sourceName text - sourceName is only used for error reporting

lookupP :: String -> Paragraph' a -> Maybe (Field' a) Source

lookupP fieldName paragraph looks up a Field in a Paragraph. N.B. trailing and leading whitespace is not stripped.

stripWS :: a -> a Source

Strip the trailing and leading space and tab characters from a string. Folded whitespace is not unfolded. This should probably be moved to someplace more general purpose.

protectFieldText :: a -> a Source

Protect field value text so the parser doesn't split it into multiple fields or paragraphs. This must modify all field text to enforce two conditions: (1) All lines other than the initial one must begin with a space or a tab, and (2) the trailing white space must not contain newlines. This is called before pretty printing to prevent the parser from misinterpreting field text as multiple fields or paragraphs.

asString :: a -> String Source

Control File Parser

pControl :: ControlParser Control Source

A parser for debian control file. This parser handles control files that end without a newline as well as ones that have several blank lines at the end. It is very liberal and does not attempt validate the fields in any way. All trailing, leading, and folded whitespace is preserved in the field values. See stripWS.

Helper Functions

renameField :: Eq a => a -> a -> Paragraph' a -> Paragraph' a Source

modifyField :: Eq a => a -> (a -> a) -> Paragraph' a -> Paragraph' a Source

raiseFields :: Eq a => (a -> Bool) -> Paragraph' a -> Paragraph' a Source

Move selected fields to the beginning of a paragraph.

Policy classes and functions

class HasDebianControl a where Source

Class of things that contain a validated Debian control file.

data ControlFileError Source

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




locs :: [Loc]


locs :: [Loc]


locs :: [Loc]
field :: String


locs :: [Loc]
parseError :: ParseError


locs :: [Loc]
parseError :: ParseError


locs :: [Loc]
ioError :: IOError

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

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.)

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

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.