Safe Haskell	Safe-Inferred
Language	Haskell2010

Debian.Control

Contents

Types
Control File Parser
Helper Functions
Policy classes and functions

Description

A module for working with Debian control files http://www.debian.org/doc/debian-policy/ch-controlfields.html

Synopsis

newtype Control' a = Control {
- unControl :: [Paragraph' a]
}
newtype Paragraph' a = Paragraph [Field' a]
data Field' a
- = Field (a, a)
- | Comment a
type Control = Control' String
type Paragraph = Paragraph' String
type Field = Field' String
type ControlParser a = CharParser () a
class ControlFunctions a where
- parseControlFromFile :: FilePath -> IO (Either ParseError (Control' a))
- parseControlFromHandle :: String -> Handle -> IO (Either ParseError (Control' a))
- parseControl :: String -> a -> Either ParseError (Control' a)
- lookupP :: String -> Paragraph' a -> Maybe (Field' a)
- stripWS :: a -> a
- protectFieldText :: a -> a
- asString :: a -> String
pControl :: ControlParser Control
mergeControls :: [Control' a] -> Control' a
fieldValue :: ControlFunctions a => String -> Paragraph' a -> Maybe a
removeField :: Eq a => a -> Paragraph' a -> Paragraph' a
prependFields :: [Field' a] -> Paragraph' a -> Paragraph' a
appendFields :: [Field' a] -> Paragraph' a -> Paragraph' a
renameField :: Eq a => a -> a -> Paragraph' a -> Paragraph' a
modifyField :: Eq a => a -> (a -> a) -> Paragraph' a -> Paragraph' a
raiseFields :: Eq a => (a -> Bool) -> Paragraph' a -> Paragraph' a
packParagraph :: Paragraph -> Paragraph
packField :: Field' String -> Field' Text
formatControl :: Control' Text -> [Text]
formatParagraph :: Paragraph' Text -> Text
formatField :: Field' Text -> Text
class Show a => HasDebianControl a where
- debianControl :: a -> DebianControl
data ControlFileError
- = NoParagraphs {
  - locs :: [Loc]
  }
- | NoBinaryParagraphs {
  - locs :: [Loc]
  - ctl :: String
  }
- | MissingField {
  - locs :: [Loc]
  - field :: String
  }
- | ParseRelationsError {
  - locs :: [Loc]
  - parseError :: ParseError
  }
- | ParseControlError {
  - locs :: [Loc]
  - parseError :: ParseError
  }
- | IOError {
  - locs :: [Loc]
  - ioError :: IOError
  }
parseDebianControlFromFile :: FilePath -> IO (Either ControlFileError DebianControl)
validateDebianControl :: MonadCatch m => Control' Text -> m (Either ControlFileError DebianControl)
unsafeDebianControl :: Control' Text -> DebianControl
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)
debianBuildDeps :: HasDebianControl a => a -> Maybe Relations
debianBuildDepsIndep :: HasDebianControl a => a -> Maybe Relations

Types

newtype Control' a Source #

Constructors

Control
Fields unControl :: [Paragraph' a]

Instances

Instances details

(ControlFunctions a, Pretty (PP a)) => Pretty (Control' a) Source #	This may have bad performance issues (dsf: Whoever wrote this comment should have explained why.)
Instance details Defined in Debian.Control.Common Methods pretty :: Control' a -> Doc # prettyVersioned :: CabalSpecVersion -> Control' a -> Doc #
Read a => Read (Control' a) Source #
Instance details Defined in Debian.Control.Common Methods readsPrec :: Int -> ReadS (Control' a) # readList :: ReadS [Control' a] # readPrec :: ReadPrec (Control' a) # readListPrec :: ReadPrec [Control' a] #
Show a => Show (Control' a) Source #
Instance details Defined in Debian.Control.Common Methods showsPrec :: Int -> Control' a -> ShowS # show :: Control' a -> String # showList :: [Control' a] -> ShowS #
Eq a => Eq (Control' a) Source #
Instance details Defined in Debian.Control.Common Methods (==) :: Control' a -> Control' a -> Bool # (/=) :: Control' a -> Control' a -> Bool #
Ord a => Ord (Control' a) Source #
Instance details Defined in Debian.Control.Common Methods compare :: Control' a -> Control' a -> Ordering # (<) :: Control' a -> Control' a -> Bool # (<=) :: Control' a -> Control' a -> Bool # (>) :: Control' a -> Control' a -> Bool # (>=) :: Control' a -> Control' a -> Bool # max :: Control' a -> Control' a -> Control' a # min :: Control' a -> Control' a -> Control' a #

newtype Paragraph' a Source #

Constructors

Paragraph [Field' a]

Instances

Instances details

(ControlFunctions a, Pretty (PP a)) => Pretty (Paragraph' a) Source #
Instance details Defined in Debian.Control.Common Methods pretty :: Paragraph' a -> Doc # prettyVersioned :: CabalSpecVersion -> Paragraph' a -> Doc #
Read a => Read (Paragraph' a) Source #
Instance details Defined in Debian.Control.Common Methods readsPrec :: Int -> ReadS (Paragraph' a) # readList :: ReadS [Paragraph' a] # readPrec :: ReadPrec (Paragraph' a) # readListPrec :: ReadPrec [Paragraph' a] #
Show a => Show (Paragraph' a) Source #
Instance details Defined in Debian.Control.Common Methods showsPrec :: Int -> Paragraph' a -> ShowS # show :: Paragraph' a -> String # showList :: [Paragraph' a] -> ShowS #
Eq a => Eq (Paragraph' a) Source #
Instance details Defined in Debian.Control.Common Methods (==) :: Paragraph' a -> Paragraph' a -> Bool # (/=) :: Paragraph' a -> Paragraph' a -> Bool #
Ord a => Ord (Paragraph' a) Source #
Instance details Defined in Debian.Control.Common Methods compare :: Paragraph' a -> Paragraph' a -> Ordering # (<) :: Paragraph' a -> Paragraph' a -> Bool # (<=) :: Paragraph' a -> Paragraph' a -> Bool # (>) :: Paragraph' a -> Paragraph' a -> Bool # (>=) :: Paragraph' a -> Paragraph' a -> Bool # max :: Paragraph' a -> Paragraph' a -> Paragraph' a # min :: Paragraph' a -> Paragraph' a -> Paragraph' a #

data Field' a Source #

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

Constructors

Field (a, a)
Comment a	Lines beginning with #

Instances

Instances details

(ControlFunctions a, Pretty (PP a)) => Pretty (Field' a) Source #
Instance details Defined in Debian.Control.Common Methods pretty :: Field' a -> Doc # prettyVersioned :: CabalSpecVersion -> Field' a -> Doc #
Read a => Read (Field' a) Source #
Instance details Defined in Debian.Control.Common Methods readsPrec :: Int -> ReadS (Field' a) # readList :: ReadS [Field' a] # readPrec :: ReadPrec (Field' a) # readListPrec :: ReadPrec [Field' a] #
Show a => Show (Field' a) Source #
Instance details Defined in Debian.Control.Common Methods showsPrec :: Int -> Field' a -> ShowS # show :: Field' a -> String # showList :: [Field' a] -> ShowS #
Eq a => Eq (Field' a) Source #
Instance details Defined in Debian.Control.Common Methods (==) :: Field' a -> Field' a -> Bool # (/=) :: Field' a -> Field' a -> Bool #
Ord a => Ord (Field' a) Source #
Instance details Defined in Debian.Control.Common Methods compare :: Field' a -> Field' a -> Ordering # (<) :: Field' a -> Field' a -> Bool # (<=) :: Field' a -> Field' a -> Bool # (>) :: Field' a -> Field' a -> Bool # (>=) :: Field' a -> Field' a -> Bool # max :: Field' a -> Field' a -> Field' a # min :: Field' a -> Field' a -> Field' a #

type Control = Control' String Source #

type Paragraph = Paragraph' String Source #

type Field = Field' String Source #

type ControlParser a = CharParser () a Source #

class ControlFunctions a where Source #

Methods

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 #

Instances

Instances details

ControlFunctions ByteString Source #
Instance details Defined in Debian.Control.ByteString Methods parseControlFromFile :: FilePath -> IO (Either ParseError (Control' ByteString)) Source # parseControlFromHandle :: String -> Handle -> IO (Either ParseError (Control' ByteString)) Source # parseControl :: String -> ByteString -> Either ParseError (Control' ByteString) Source # lookupP :: String -> Paragraph' ByteString -> Maybe (Field' ByteString) Source # stripWS :: ByteString -> ByteString Source # protectFieldText :: ByteString -> ByteString Source # asString :: ByteString -> String Source #
ControlFunctions Text Source #
Instance details Defined in Debian.Control.Text Methods parseControlFromFile :: FilePath -> IO (Either ParseError (Control' Text)) Source # parseControlFromHandle :: String -> Handle -> IO (Either ParseError (Control' Text)) Source # parseControl :: String -> Text -> Either ParseError (Control' Text) Source # lookupP :: String -> Paragraph' Text -> Maybe (Field' Text) Source # stripWS :: Text -> Text Source # protectFieldText :: Text -> Text Source # asString :: Text -> String Source #
ControlFunctions Builder Source #
Instance details Defined in Debian.Control.Builder Methods parseControlFromFile :: FilePath -> IO (Either ParseError (Control' Builder)) Source # parseControlFromHandle :: String -> Handle -> IO (Either ParseError (Control' Builder)) Source # parseControl :: String -> Builder -> Either ParseError (Control' Builder) Source # lookupP :: String -> Paragraph' Builder -> Maybe (Field' Builder) Source # stripWS :: Builder -> Builder Source # protectFieldText :: Builder -> Builder Source # asString :: Builder -> String Source #
ControlFunctions Text Source #
Instance details Defined in Debian.Control.TextLazy Methods parseControlFromFile :: FilePath -> IO (Either ParseError (Control' Text)) Source # parseControlFromHandle :: String -> Handle -> IO (Either ParseError (Control' Text)) Source # parseControl :: String -> Text -> Either ParseError (Control' Text) Source # lookupP :: String -> Paragraph' Text -> Maybe (Field' Text) Source # stripWS :: Text -> Text Source # protectFieldText :: Text -> Text Source # asString :: Text -> String Source #
ControlFunctions String Source #
Instance details Defined in Debian.Control.String Methods parseControlFromFile :: FilePath -> IO (Either ParseError (Control' String)) Source # parseControlFromHandle :: String -> Handle -> IO (Either ParseError (Control' String)) Source # parseControl :: String -> String -> Either ParseError (Control' String) Source # lookupP :: String -> Paragraph' String -> Maybe (Field' String) Source # stripWS :: String -> String Source # protectFieldText :: String -> String Source # asString :: String -> 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

mergeControls :: [Control' a] -> Control' a Source #

fieldValue :: ControlFunctions a => String -> Paragraph' a -> Maybe a Source #

removeField :: Eq a => a -> Paragraph' a -> Paragraph' a Source #

prependFields :: [Field' a] -> Paragraph' a -> Paragraph' a Source #

appendFields :: [Field' a] -> Paragraph' a -> Paragraph' a Source #

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.

packParagraph :: Paragraph -> Paragraph Source #

packField :: Field' String -> Field' Text Source #

formatControl :: Control' Text -> [Text] Source #

formatParagraph :: Paragraph' Text -> Text Source #

formatField :: Field' Text -> Text Source #

Policy classes and functions

class Show a => HasDebianControl a where Source #

Class of things that contain a validated Debian control file.

Methods

debianControl :: a -> DebianControl Source #

Instances

Instances details

HasDebianControl DebianControl Source #
Instance details Defined in Debian.Control.Policy Methods debianControl :: DebianControl -> DebianControl Source #

data ControlFileError Source #

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

Instances details

Exception ControlFileError Source #
Instance details Defined in Debian.Control.Policy Methods toException :: ControlFileError -> SomeException # fromException :: SomeException -> Maybe ControlFileError # displayException :: ControlFileError -> String #
Show ControlFileError Source #
Instance details Defined in Debian.Control.Policy Methods showsPrec :: Int -> ControlFileError -> ShowS # show :: ControlFileError -> String # showList :: [ControlFileError] -> ShowS #
Eq ControlFileError Source #
Instance details Defined in Debian.Control.Policy Methods (==) :: ControlFileError -> ControlFileError -> Bool # (/=) :: ControlFileError -> ControlFileError -> Bool #

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

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

unsafeDebianControl :: Control' Text -> DebianControl Source #

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

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

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

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

debianSourcePackageName :: HasDebianControl a => a -> SrcPkgName Source #

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

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.

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

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