Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell98 |
- newtype Control' a = Control {
- unControl :: [Paragraph' a]
- newtype Paragraph' a = Paragraph [Field' a]
- data Field' a
- type Control = Control' ByteString
- type Paragraph = Paragraph' ByteString
- type Field = Field' ByteString
- 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
- asString :: a -> String
- 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
Documentation
Control | |
|
newtype Paragraph' a Source
Eq a => Eq (Paragraph' a) | |
Ord a => Ord (Paragraph' a) | |
Read a => Read (Paragraph' a) | |
Show a => Show (Paragraph' a) | |
Pretty a => Pretty (Paragraph' a) |
NOTE: we do not strip the leading or trailing whitespace in the name or value
type Control = Control' ByteString Source
type Paragraph = Paragraph' ByteString Source
type Field = Field' ByteString Source
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.
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.
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.