Debian.Control.String

Types

newtype Control' a

Constructors

Control [Paragraph' a]

Instances

Eq a => Eq (Control' a)

Defined in Debian.Control.Common

Methods

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

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

Ord a => Ord (Control' a)

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

Read a => Read (Control' a)

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)

Defined in Debian.Control.Common

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

Defined in Debian.Control.Common

Methods

pretty :: Control' a -> Doc

prettyVersioned :: CabalSpecVersion -> Control' a -> Doc

newtype Paragraph' a

Constructors

Paragraph [Field' a]

Instances

Eq a => Eq (Paragraph' a)

Defined in Debian.Control.Common

Methods

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

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

Ord a => Ord (Paragraph' a)

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

Read a => Read (Paragraph' a)

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)

Defined in Debian.Control.Common

Methods

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

show :: Paragraph' a -> String

showList :: [Paragraph' a] -> ShowS

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

Defined in Debian.Control.Common

Methods

pretty :: Paragraph' a -> Doc

prettyVersioned :: CabalSpecVersion -> 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)

Defined in Debian.Control.Common

Methods

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

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

Ord a => Ord (Field' a)

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

Read a => Read (Field' a)

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)

Defined in Debian.Control.Common

Methods

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

show :: Field' a -> String

showList :: [Field' a] -> ShowS

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

Defined in Debian.Control.Common

Methods

pretty :: Field' a -> Doc

prettyVersioned :: CabalSpecVersion -> Field' a -> Doc

type Control = Control' String

type Paragraph = Paragraph' String

type Field = Field' String

type ControlParser a = CharParser () a

class ControlFunctions a where

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

Instances

ControlFunctions ByteString

Defined in Debian.Control.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

ControlFunctions String

Defined in Debian.Control.String

Methods

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

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

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

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

stripWS :: String -> String

protectFieldText :: String -> String

asString :: String -> String

ControlFunctions Text

Defined in Debian.Control.TextLazy

Methods

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

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

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

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

stripWS :: Text -> Text

protectFieldText :: Text -> Text

asString :: Text -> String

ControlFunctions Builder

Defined in Debian.Control.Builder

Methods

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

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

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

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

stripWS :: Builder -> Builder

protectFieldText :: Builder -> Builder

asString :: Builder -> String

ControlFunctions Text

Defined in Debian.Control.Text

Methods

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

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

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

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

stripWS :: Text -> Text

protectFieldText :: Text -> Text

asString :: Text -> String

Control File Parser

pControl :: ControlParser Control

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

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 String

Methods

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

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

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

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

stripWS :: String -> String

protectFieldText :: String -> String

asString :: String -> String