Safe Haskell	None
Language	Haskell98

Debian.Control.Common

Contents

Types

Synopsis

Types

newtype Control' a Source #

Constructors

Control
Fields unControl :: [Paragraph' a]

Instances

Eq a => Eq (Control' a) Source #
Methods (==) :: Control' a -> Control' a -> Bool # (/=) :: Control' a -> Control' a -> Bool #
Ord a => Ord (Control' a) Source #
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 #
Read a => Read (Control' a) Source #
Methods readsPrec :: Int -> ReadS (Control' a) # readList :: ReadS [Control' a] # readPrec :: ReadPrec (Control' a) # readListPrec :: ReadPrec [Control' a] #
Show a => Show (Control' a) Source #
Methods showsPrec :: Int -> Control' a -> ShowS # show :: Control' a -> String # showList :: [Control' a] -> ShowS #
(ControlFunctions a, Pretty (PP a)) => Pretty (Control' a) Source #	This may have bad performance issues (dsf: Whoever wrote this comment should have explained why.)
Methods pPrintPrec :: PrettyLevel -> Rational -> Control' a -> Doc # pPrint :: Control' a -> Doc # pPrintList :: PrettyLevel -> [Control' a] -> Doc #

newtype Paragraph' a Source #

Constructors

Paragraph [Field' a]

Instances

Eq a => Eq (Paragraph' a) Source #
Methods (==) :: Paragraph' a -> Paragraph' a -> Bool # (/=) :: Paragraph' a -> Paragraph' a -> Bool #
Ord a => Ord (Paragraph' a) Source #
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 #
Read a => Read (Paragraph' a) Source #
Methods readsPrec :: Int -> ReadS (Paragraph' a) # readList :: ReadS [Paragraph' a] # readPrec :: ReadPrec (Paragraph' a) # readListPrec :: ReadPrec [Paragraph' a] #
Show a => Show (Paragraph' a) Source #
Methods showsPrec :: Int -> Paragraph' a -> ShowS # show :: Paragraph' a -> String # showList :: [Paragraph' a] -> ShowS #
(ControlFunctions a, Pretty (PP a)) => Pretty (Paragraph' a) Source #
Methods pPrintPrec :: PrettyLevel -> Rational -> Paragraph' a -> Doc # pPrint :: Paragraph' a -> Doc # pPrintList :: PrettyLevel -> [Paragraph' a] -> Doc #

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

Eq a => Eq (Field' a) Source #
Methods (==) :: Field' a -> Field' a -> Bool # (/=) :: Field' a -> Field' a -> Bool #
Ord a => Ord (Field' a) Source #
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 #
Read a => Read (Field' a) Source #
Methods readsPrec :: Int -> ReadS (Field' a) # readList :: ReadS [Field' a] # readPrec :: ReadPrec (Field' a) # readListPrec :: ReadPrec [Field' a] #
Show a => Show (Field' a) Source #
Methods showsPrec :: Int -> Field' a -> ShowS # show :: Field' a -> String # showList :: [Field' a] -> ShowS #
(ControlFunctions a, Pretty (PP a)) => Pretty (Field' a) Source #
Methods pPrintPrec :: PrettyLevel -> Rational -> Field' a -> Doc # pPrint :: Field' a -> Doc # pPrintList :: PrettyLevel -> [Field' a] -> Doc #

class ControlFunctions a where Source #

Minimal complete definition

parseControlFromFile, parseControlFromHandle, parseControl, lookupP, stripWS, protectFieldText, asString

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 #

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.

parseControlFromCmd :: ControlFunctions a => String -> IO (Either String (Control' a)) Source #

Run a command and parse its output as a control file.

md5sumField :: ControlFunctions a => Paragraph' a -> Maybe a Source #

look up the md5sum file in a paragraph Tries several different variations: MD5Sum: Md5Sum: MD5sum:

protectFieldText' :: forall a. (StringLike a, ListLike a Char) => ControlFunctions a => a -> a Source #

This can usually be used as the implementation of protectFieldText