Debian.Control.ByteString

Documentation

newtype Control' a

Constructors

Control

Fields

• unControl :: [Paragraph' a]

Instances

Eq a => Eq (Control' a)

Methods

(==) :: Control' a -> Control' a -> Bool

(/=) :: Control' a -> Control' a -> Bool

Ord a => Ord (Control' a)

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)

Methods

readsPrec :: Int -> ReadS (Control' a)

readList :: ReadS [Control' a]

readPrec :: ReadPrec (Control' a)

readListPrec :: ReadPrec [Control' a]

Show a => Show (Control' a)

Methods

showsPrec :: Int -> Control' a -> ShowS

show :: Control' a -> String

showList :: [Control' a] -> ShowS

(ControlFunctions a, Pretty (PP a)) => Pretty (Control' a)

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

Constructors

Paragraph [Field' a]

Instances

Eq a => Eq (Paragraph' a)

Methods

(==) :: Paragraph' a -> Paragraph' a -> Bool

(/=) :: Paragraph' a -> Paragraph' a -> Bool

Ord a => Ord (Paragraph' a)

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)

Methods

readsPrec :: Int -> ReadS (Paragraph' a)

readList :: ReadS [Paragraph' a]

readPrec :: ReadPrec (Paragraph' a)

readListPrec :: ReadPrec [Paragraph' a]

Show a => Show (Paragraph' a)

Methods

showsPrec :: Int -> Paragraph' a -> ShowS

show :: Paragraph' a -> String

showList :: [Paragraph' a] -> ShowS

(ControlFunctions a, Pretty (PP a)) => Pretty (Paragraph' a)

Methods

pPrintPrec :: PrettyLevel -> Rational -> Paragraph' a -> Doc

pPrint :: Paragraph' a -> Doc

pPrintList :: PrettyLevel -> [Paragraph' a] -> Doc

data Field' a

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)

Methods

(==) :: Field' a -> Field' a -> Bool

(/=) :: Field' a -> Field' a -> Bool

Ord a => Ord (Field' a)

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)

Methods

readsPrec :: Int -> ReadS (Field' a)

readList :: ReadS [Field' a]

readPrec :: ReadPrec (Field' a)

readListPrec :: ReadPrec [Field' a]

Show a => Show (Field' a)

Methods

showsPrec :: Int -> Field' a -> ShowS

show :: Field' a -> String

showList :: [Field' a] -> ShowS

(ControlFunctions a, Pretty (PP a)) => Pretty (Field' a)

Methods

pPrintPrec :: PrettyLevel -> Rational -> Field' a -> Doc

pPrint :: Field' a -> Doc

pPrintList :: PrettyLevel -> [Field' a] -> Doc

type Control = Control' ByteString

type Paragraph = Paragraph' ByteString

type Field = Field' ByteString

class ControlFunctions a where

Minimal complete definition

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

Methods

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

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

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

parseControlFromHandle sourceName handle - sourceName is only used for error reporting

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

parseControlFromString sourceName text - sourceName is only used for error reporting

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

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

stripWS :: a -> a

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

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

Helper Functions

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

Move selected fields to the beginning of a paragraph.

Orphan instances

ControlFunctions ByteString

Methods

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

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

parseControl :: String -> ByteString -> Either ParseError (Control' ByteString)

lookupP :: String -> Paragraph' ByteString -> Maybe (Field' ByteString)

stripWS :: ByteString -> ByteString

protectFieldText :: ByteString -> ByteString

asString :: ByteString -> String