Modulecabal-install-3.18.1.0Haskell2010

Distribution.Deprecated.ParseUtils

Utilities for parsing PackageDescription and InstalledPackageInfo.

The .cabal file format is not trivial, especially with the introduction of configurations and the section syntax that goes with that. This module has a bunch of parsing functions that is used by the .cabal parser and a couple others. It has the parsing framework code and also little parsers for many of the formats we get in various .cabal file fields, like module names, comma separated lists etc.

Synopsis

type LineNo
data PError
data PWarning
value locatedErrorMsg
value syntaxError
value warning
value runP
value runE
data ParseResult
value parseFail
value showPWarning
data Field
value lineNo
data FieldDescr
value readFields
value parseHaskellString
value parseTokenQ
value parseSpaceList
value parseOptCommaList
value showFilePath
value showToken
value showFreeText
value field
value simpleField
value monoidField
value listField
value listFieldWithSep
value spaceListField
value newLineListField
value liftField
value readPToMaybe
value fieldParsec
value simpleFieldParsec
value monoidFieldParsec
value listFieldParsec
value commaListFieldParsec
value commaNewLineListFieldParsec
type UnrecFieldParser

Packagecabal-install-3.18.1.0
Exports38
LanguageHaskell2010
LicenceBSD-3-Clause
SourceParseUtils.hs

typetype LineNo = Int

datadata PError

Constructors

AmbiguousParse String LineNo
NoParse String LineNo
TabsError LineNo
FieldShouldBeStanza String LineNo
FromString String (Maybe LineNo)

Instances2Eq, Show

Eq PErrorDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Show PErrorDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils

datadata PWarning

Constructors

PWarning String
UTFWarning LineNo String

Instances2Eq, Show

Eq PWarningDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Show PWarningDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils

valuelocatedErrorMsg :: PError -> (Maybe LineNo, String)

valuesyntaxError :: LineNo -> String -> ParseResult a

valuewarning :: String -> ParseResult ()

valuerunP :: LineNo -> String -> ReadP a -> String -> ParseResult a

valuerunE :: LineNo -> String -> ReadE a -> String -> ParseResult a

datadata ParseResult a

Constructors

ParseFailed PError
ParseOk [PWarning] a

Instances7Monad, Functor, MonadFail, Applicative, Foldable, Traversable, …

Monad ParseResultDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Functor ParseResultDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
MonadFail ParseResultDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Applicative ParseResultDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Foldable ParseResultDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Traversable ParseResultDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Show a => Show (ParseResult a)Defined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils

valueparseFail :: PError -> ParseResult a

valueshowPWarning :: FilePath -> PWarning -> String

datadata Field

Constructors

F LineNo String String
A regular property: value field
Section LineNo String String [Field]
A section with a name and possible parameter. The syntactic structure is:
```
  sectionname arg {
    field*
  }
```

Instances2Eq, Show

Eq FieldDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils
Show FieldDefined in cabal-install-3.18.1.0 · Distribution.Deprecated.ParseUtils

valuelineNo :: Field -> LineNo

datadata FieldDescr a

Source#

Field descriptor. The parameter a parameterizes over where the field's value is stored in.

Constructors

FieldDescr
- fieldName :: String
- fieldGet :: a -> Doc
- fieldSet :: LineNo -> String -> a -> ParseResult a
  fieldSet n str x Parses the field value from the given input string str and stores the result in x if the parse was successful. Otherwise, reports an error on line number n.

valuereadFields :: ByteString -> ParseResult [Field]

valueparseHaskellString :: ReadP String

valueparseTokenQ :: ReadP String

valueparseSpaceList

:: ReadP a
The parser for the stuff between commas
-> ReadP [a]

valueparseOptCommaList :: ReadP a -> ReadP [a]

valueshowFilePath :: FilePath -> Doc

valueshowToken :: String -> Doc

valueshowFreeText :: String -> Doc

Source#

Pretty-print free-format text, ensuring that it is vertically aligned, and with blank lines replaced by dots for correct re-parsing.

valuefield :: String -> (a -> Doc) -> ReadP a -> FieldDescr a

valuesimpleField

:: String
-> a -> Doc
-> ReadP a
-> b -> a
-> a -> b -> b
-> FieldDescr b

valuemonoidField

:: Semigroup a
=> String
-> a -> Doc
-> ReadP a
-> b -> a
-> a -> b -> b
-> FieldDescr b

valuelistField

:: String
-> a -> Doc
-> ReadP a
-> b -> [a]
-> [a] -> b -> b
-> FieldDescr b

valuelistFieldWithSep

:: Separator
-> String
-> a -> Doc
-> ReadP a
-> b -> [a]
-> [a] -> b -> b
-> FieldDescr b

valuespaceListField

:: String
-> a -> Doc
-> ReadP a
-> b -> [a]
-> [a] -> b -> b
-> FieldDescr b

valuenewLineListField

:: String
-> a -> Doc
-> ReadP a
-> b -> [a]
-> [a] -> b -> b
-> FieldDescr b

valueliftField :: (b -> a) -> (a -> b -> b) -> FieldDescr a -> FieldDescr b

valuereadPToMaybe :: ReadP a -> String -> Maybe a

valuefieldParsec :: String -> (a -> Doc) -> ParsecParser a -> FieldDescr a

valuesimpleFieldParsec

:: String
-> a -> Doc
-> ParsecParser a
-> b -> a
-> a -> b -> b
-> FieldDescr b

valuemonoidFieldParsec

:: Semigroup a
=> String
-> a -> Doc
-> ParsecParser a
-> b -> a
-> a -> b -> b
-> FieldDescr b

valuelistFieldParsec

:: String
-> a -> Doc
-> ParsecParser a
-> b -> [a]
-> [a] -> b -> b
-> FieldDescr b

valuecommaListFieldParsec

:: String
-> a -> Doc
-> ParsecParser a
-> b -> [a]
-> [a] -> b -> b
-> FieldDescr b

valuecommaNewLineListFieldParsec

:: String
-> a -> Doc
-> ParsecParser a
-> b -> [a]
-> [a] -> b -> b
-> FieldDescr b

typetype UnrecFieldParser a = (String, String) -> a -> Maybe a

Source#

The type of a function which, given a name-value pair of an unrecognized field, and the current structure being built, decides whether to incorporate the unrecognized field (by returning Just x, where x is a possibly modified version of the structure being built), or not (by returning Nothing).