Distribution.Parsec

Documentation

class Parsec a where

Class for parsing with parsec. Mainly used for .cabal file fields.

For parsing .cabal like file structure, see Distribution.Fields.

Methods

parsec :: CabalParsing m => m a

Instances

Parsec OpenModule

>>> eitherParsec "Includes2-0.1.0.0-inplace-mysql:Database.MySQL" :: Either String OpenModule
Right (OpenModule (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "Includes2-0.1.0.0-inplace-mysql"})) (ModuleName "Database.MySQL"))

Defined in Distribution.Backpack

Methods

parsec :: CabalParsing m => m OpenModule

Parsec OpenUnitId

>>> eitherParsec "foobar" :: Either String OpenUnitId
Right (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "foobar"}))

>>> eitherParsec "foo[Str=text-1.2.3:Data.Text.Text]" :: Either String OpenUnitId
Right (IndefFullUnitId (ComponentId "foo") (fromList [(ModuleName "Str",OpenModule (DefiniteUnitId (DefUnitId {unDefUnitId = UnitId "text-1.2.3"})) (ModuleName "Data.Text.Text"))]))

Defined in Distribution.Backpack

Methods

parsec :: CabalParsing m => m OpenUnitId

Parsec AbiTag

Defined in Distribution.Compiler

Methods

parsec :: CabalParsing m => m AbiTag

Parsec CompilerFlavor

Defined in Distribution.Compiler

Methods

parsec :: CabalParsing m => m CompilerFlavor

Parsec CompilerId

Defined in Distribution.Compiler

Methods

parsec :: CabalParsing m => m CompilerId

Parsec FilePathNT

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m FilePathNT

Parsec SpecLicense

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m SpecLicense

Parsec SpecVersion

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m SpecVersion

Parsec TestedWith

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m TestedWith

Parsec Token

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m Token

Parsec Token'

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m Token'

Parsec License

Defined in Distribution.License

Methods

parsec :: CabalParsing m => m License

Parsec ModuleName

Defined in Distribution.ModuleName

Methods

parsec :: CabalParsing m => m ModuleName

Parsec CompatFilePath

Defined in Distribution.PackageDescription.FieldGrammar

Methods

parsec :: CabalParsing m => m CompatFilePath

Parsec CompatLicenseFile

Defined in Distribution.PackageDescription.FieldGrammar

Methods

parsec :: CabalParsing m => m CompatLicenseFile

Parsec License

>>> eitherParsec "BSD-3-Clause AND MIT" :: Either String License
Right (License (EAnd (ELicense (ELicenseId BSD_3_Clause) Nothing) (ELicense (ELicenseId MIT) Nothing)))

>>> eitherParsec "NONE" :: Either String License
Right NONE

Defined in Distribution.SPDX.License

Methods

parsec :: CabalParsing m => m License

Parsec LicenseExceptionId

Defined in Distribution.SPDX.LicenseExceptionId

Methods

parsec :: CabalParsing m => m LicenseExceptionId

Parsec LicenseExpression

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m LicenseExpression

Parsec SimpleLicenseExpression

Defined in Distribution.SPDX.LicenseExpression

Methods

parsec :: CabalParsing m => m SimpleLicenseExpression

Parsec LicenseId

>>> eitherParsec "BSD-3-Clause" :: Either String LicenseId
Right BSD_3_Clause

>>> eitherParsec "BSD3" :: Either String LicenseId
Left "...Unknown SPDX license identifier: 'BSD3' Do you mean BSD-3-Clause?"

Defined in Distribution.SPDX.LicenseId

Methods

parsec :: CabalParsing m => m LicenseId

Parsec LicenseRef

Defined in Distribution.SPDX.LicenseReference

Methods

parsec :: CabalParsing m => m LicenseRef

Parsec Arch

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Arch

Parsec OS

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m OS

Parsec Platform

Defined in Distribution.System

Methods

parsec :: CabalParsing m => m Platform

Parsec AbiDependency

Defined in Distribution.Types.AbiDependency

Methods

parsec :: CabalParsing m => m AbiDependency

Parsec AbiHash

Defined in Distribution.Types.AbiHash

Methods

parsec :: CabalParsing m => m AbiHash

Parsec BenchmarkType

Defined in Distribution.Types.BenchmarkType

Methods

parsec :: CabalParsing m => m BenchmarkType

Parsec BuildType

Defined in Distribution.Types.BuildType

Methods

parsec :: CabalParsing m => m BuildType

Parsec ComponentId

Defined in Distribution.Types.ComponentId

Methods

parsec :: CabalParsing m => m ComponentId

Parsec ComponentName

Defined in Distribution.Types.ComponentName

Methods

parsec :: CabalParsing m => m ComponentName

Parsec Dependency

>>> simpleParsec "mylib:sub" :: Maybe Dependency
Just (Dependency (PackageName "mylib") (OrLaterVersion (mkVersion [0])) (fromNonEmpty (LSubLibName (UnqualComponentName "sub") :| [])))

>>> simpleParsec "mylib:{sub1,sub2}" :: Maybe Dependency
Just (Dependency (PackageName "mylib") (OrLaterVersion (mkVersion [0])) (fromNonEmpty (LSubLibName (UnqualComponentName "sub1") :| [LSubLibName (UnqualComponentName "sub2")])))

>>> simpleParsec "mylib:{ sub1 , sub2 }" :: Maybe Dependency
Just (Dependency (PackageName "mylib") (OrLaterVersion (mkVersion [0])) (fromNonEmpty (LSubLibName (UnqualComponentName "sub1") :| [LSubLibName (UnqualComponentName "sub2")])))

>>> simpleParsec "mylib:{ sub1 , sub2 } ^>= 42" :: Maybe Dependency
Just (Dependency (PackageName "mylib") (MajorBoundVersion (mkVersion [42])) (fromNonEmpty (LSubLibName (UnqualComponentName "sub1") :| [LSubLibName (UnqualComponentName "sub2")])))

>>> simpleParsec "mylib:{ } ^>= 42" :: Maybe Dependency
Nothing

>>> traverse_ print (map simpleParsec ["mylib:mylib", "mylib:{mylib}", "mylib:{mylib,sublib}" ] :: [Maybe Dependency])
Just (Dependency (PackageName "mylib") (OrLaterVersion (mkVersion [0])) (fromNonEmpty (LMainLibName :| [])))
Just (Dependency (PackageName "mylib") (OrLaterVersion (mkVersion [0])) (fromNonEmpty (LMainLibName :| [])))
Just (Dependency (PackageName "mylib") (OrLaterVersion (mkVersion [0])) (fromNonEmpty (LMainLibName :| [LSubLibName (UnqualComponentName "sublib")])))

Spaces around colon are not allowed:

>>> map simpleParsec ["mylib: sub", "mylib :sub", "mylib: {sub1,sub2}", "mylib :{sub1,sub2}"] :: [Maybe Dependency]
[Nothing,Nothing,Nothing,Nothing]

Sublibrary syntax is accepted since cabal-version: 3.0

>>> map (`simpleParsec'` "mylib:sub") [CabalSpecV2_4, CabalSpecV3_0] :: [Maybe Dependency]
[Nothing,Just (Dependency (PackageName "mylib") (OrLaterVersion (mkVersion [0])) (fromNonEmpty (LSubLibName (UnqualComponentName "sub") :| [])))]

Defined in Distribution.Types.Dependency

Methods

parsec :: CabalParsing m => m Dependency

Parsec ExeDependency

Examples

>>> simpleParsec "happy:happy" :: Maybe ExeDependency
Just (ExeDependency (PackageName "happy") (UnqualComponentName "happy") (OrLaterVersion (mkVersion [0])))

>>> simpleParsec "happy:happy >= 1.19.12" :: Maybe ExeDependency
Just (ExeDependency (PackageName "happy") (UnqualComponentName "happy") (OrLaterVersion (mkVersion [1,19,12])))

>>> simpleParsec "happy:happy>=1.19.12" :: Maybe ExeDependency
Just (ExeDependency (PackageName "happy") (UnqualComponentName "happy") (OrLaterVersion (mkVersion [1,19,12])))

>>> simpleParsec "happy : happy >= 1.19.12" :: Maybe ExeDependency
Nothing

>>> simpleParsec "happy: happy >= 1.19.12" :: Maybe ExeDependency
Nothing

>>> simpleParsec "happy :happy >= 1.19.12" :: Maybe ExeDependency
Nothing

Defined in Distribution.Types.ExeDependency

Methods

parsec :: CabalParsing m => m ExeDependency

Parsec ExecutableScope

Defined in Distribution.Types.ExecutableScope

Methods

parsec :: CabalParsing m => m ExecutableScope

Parsec ExposedModule

Defined in Distribution.Types.ExposedModule

Methods

parsec :: CabalParsing m => m ExposedModule

Parsec FlagAssignment

>>> simpleParsec "" :: Maybe FlagAssignment
Just (fromList [])

>>> simpleParsec "+foo -bar" :: Maybe FlagAssignment
Just (fromList [(FlagName "bar",(1,False)),(FlagName "foo",(1,True))])

>>> simpleParsec "-none -any" :: Maybe FlagAssignment
Just (fromList [(FlagName "any",(1,False)),(FlagName "none",(1,False))])

>>> simpleParsec "+foo -foo +foo +foo" :: Maybe FlagAssignment
Just (fromList [(FlagName "foo",(4,True))])

>>> simpleParsec "+foo -bar baz" :: Maybe FlagAssignment
Nothing

Issue #7279 was fixed in Cabal-3.8

>>> explicitEitherParsec (parsecCommaList parsec) "+foo , -bar" :: Either String [FlagAssignment]
Right [fromList [(FlagName "foo",(1,True))],fromList [(FlagName "bar",(1,False))]]

>>> explicitEitherParsec (parsecCommaList parsecFlagAssignmentNonEmpty) "+foo , -bar" :: Either String [FlagAssignment]
Right [fromList [(FlagName "foo",(1,True))],fromList [(FlagName "bar",(1,False))]]

>>> simpleParsec "+foo+foo" :: Maybe FlagAssignment
Nothing

Since: 3.4.0.0

Defined in Distribution.Types.Flag

Methods

parsec :: CabalParsing m => m FlagAssignment

Parsec FlagName

Defined in Distribution.Types.Flag

Methods

parsec :: CabalParsing m => m FlagName

Parsec LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

parsec :: CabalParsing m => m LibVersionInfo

Parsec ForeignLibOption

Defined in Distribution.Types.ForeignLibOption

Methods

parsec :: CabalParsing m => m ForeignLibOption

Parsec ForeignLibType

Defined in Distribution.Types.ForeignLibType

Methods

parsec :: CabalParsing m => m ForeignLibType

Parsec IncludeRenaming

Defined in Distribution.Types.IncludeRenaming

Methods

parsec :: CabalParsing m => m IncludeRenaming

Parsec LegacyExeDependency

Defined in Distribution.Types.LegacyExeDependency

Methods

parsec :: CabalParsing m => m LegacyExeDependency

Parsec LibraryVisibility

Defined in Distribution.Types.LibraryVisibility

Methods

parsec :: CabalParsing m => m LibraryVisibility

Parsec Mixin

>>> simpleParsec "mylib" :: Maybe Mixin
Just (Mixin {mixinPackageName = PackageName "mylib", mixinLibraryName = LMainLibName, mixinIncludeRenaming = IncludeRenaming {includeProvidesRn = DefaultRenaming, includeRequiresRn = DefaultRenaming}})

>>> simpleParsec "thatlib:sublib" :: Maybe Mixin
Just (Mixin {mixinPackageName = PackageName "thatlib", mixinLibraryName = LSubLibName (UnqualComponentName "sublib"), mixinIncludeRenaming = IncludeRenaming {includeProvidesRn = DefaultRenaming, includeRequiresRn = DefaultRenaming}})

>>> simpleParsec "thatlib:thatlib" :: Maybe Mixin
Just (Mixin {mixinPackageName = PackageName "thatlib", mixinLibraryName = LMainLibName, mixinIncludeRenaming = IncludeRenaming {includeProvidesRn = DefaultRenaming, includeRequiresRn = DefaultRenaming}})

Sublibrary syntax is accepted since cabal-version: 3.4.

>>> map (`simpleParsec'` "mylib:sub") [CabalSpecV3_0, CabalSpecV3_4] :: [Maybe Mixin]
[Nothing,Just (Mixin {mixinPackageName = PackageName "mylib", mixinLibraryName = LSubLibName (UnqualComponentName "sub"), mixinIncludeRenaming = IncludeRenaming {includeProvidesRn = DefaultRenaming, includeRequiresRn = DefaultRenaming}})]

Defined in Distribution.Types.Mixin

Methods

parsec :: CabalParsing m => m Mixin

Parsec Module

Defined in Distribution.Types.Module

Methods

parsec :: CabalParsing m => m Module

Parsec ModuleReexport

Defined in Distribution.Types.ModuleReexport

Methods

parsec :: CabalParsing m => m ModuleReexport

Parsec ModuleRenaming

Defined in Distribution.Types.ModuleRenaming

Methods

parsec :: CabalParsing m => m ModuleRenaming

Parsec MungedPackageId

>>> simpleParsec "foo-bar-0" :: Maybe MungedPackageId
Just (MungedPackageId {mungedName = MungedPackageName (PackageName "foo-bar") LMainLibName, mungedVersion = mkVersion [0]})

>>> simpleParsec "foo-bar" :: Maybe MungedPackageId
Just (MungedPackageId {mungedName = MungedPackageName (PackageName "foo-bar") LMainLibName, mungedVersion = mkVersion []})

>>> simpleParsec "z-foo-bar-z-baz-0" :: Maybe MungedPackageId
Just (MungedPackageId {mungedName = MungedPackageName (PackageName "foo-bar") (LSubLibName (UnqualComponentName "baz")), mungedVersion = mkVersion [0]})

>>> simpleParsec "foo-bar-0-0" :: Maybe MungedPackageId
Nothing

>>> simpleParsec "foo-bar.0" :: Maybe MungedPackageId
Nothing

>>> simpleParsec "foo-bar.4-2" :: Maybe MungedPackageId
Nothing

Defined in Distribution.Types.MungedPackageId

Methods

parsec :: CabalParsing m => m MungedPackageId

Parsec MungedPackageName

>>> simpleParsec "servant" :: Maybe MungedPackageName
Just (MungedPackageName (PackageName "servant") LMainLibName)

>>> simpleParsec "z-servant-z-lackey" :: Maybe MungedPackageName
Just (MungedPackageName (PackageName "servant") (LSubLibName (UnqualComponentName "lackey")))

>>> simpleParsec "z-servant-zz" :: Maybe MungedPackageName
Just (MungedPackageName (PackageName "z-servant-zz") LMainLibName)

Defined in Distribution.Types.MungedPackageName

Methods

parsec :: CabalParsing m => m MungedPackageName

Parsec PackageIdentifier

>>> simpleParsec "foo-bar-0" :: Maybe PackageIdentifier
Just (PackageIdentifier {pkgName = PackageName "foo-bar", pkgVersion = mkVersion [0]})

>>> simpleParsec "foo-bar" :: Maybe PackageIdentifier
Just (PackageIdentifier {pkgName = PackageName "foo-bar", pkgVersion = mkVersion []})

Note: Stricter than Text instance

>>> simpleParsec "foo-bar-0-0" :: Maybe PackageIdentifier
Nothing

>>> simpleParsec "foo-bar.0" :: Maybe PackageIdentifier
Nothing

>>> simpleParsec "foo-bar.4-2" :: Maybe PackageIdentifier
Nothing

>>> simpleParsec "1.2.3" :: Maybe PackageIdentifier
Nothing

Defined in Distribution.Types.PackageId

Methods

parsec :: CabalParsing m => m PackageIdentifier

Parsec PackageName

Defined in Distribution.Types.PackageName

Methods

parsec :: CabalParsing m => m PackageName

Parsec PackageVersionConstraint

>>> simpleParsec "foo" :: Maybe PackageVersionConstraint
Just (PackageVersionConstraint (PackageName "foo") (OrLaterVersion (mkVersion [0])))

>>> simpleParsec "foo >=2.0" :: Maybe PackageVersionConstraint
Just (PackageVersionConstraint (PackageName "foo") (OrLaterVersion (mkVersion [2,0])))

>>> simpleParsec "foo-2.0" :: Maybe PackageVersionConstraint
Just (PackageVersionConstraint (PackageName "foo") (ThisVersion (mkVersion [2,0])))

Defined in Distribution.Types.PackageVersionConstraint

Methods

parsec :: CabalParsing m => m PackageVersionConstraint

Parsec PkgconfigDependency

Defined in Distribution.Types.PkgconfigDependency

Methods

parsec :: CabalParsing m => m PkgconfigDependency

Parsec PkgconfigName

Defined in Distribution.Types.PkgconfigName

Methods

parsec :: CabalParsing m => m PkgconfigName

Parsec PkgconfigVersion

>>> simpleParsec "1.0.2n" :: Maybe PkgconfigVersion
Just (PkgconfigVersion "1.0.2n")

>>> simpleParsec "0.3.5+ds" :: Maybe PkgconfigVersion
Nothing

Defined in Distribution.Types.PkgconfigVersion

Methods

parsec :: CabalParsing m => m PkgconfigVersion

Parsec PkgconfigVersionRange

Defined in Distribution.Types.PkgconfigVersionRange

Methods

parsec :: CabalParsing m => m PkgconfigVersionRange

Parsec KnownRepoType

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m KnownRepoType

Parsec RepoKind

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoKind

Parsec RepoType

Defined in Distribution.Types.SourceRepo

Methods

parsec :: CabalParsing m => m RepoType

Parsec TestType

Defined in Distribution.Types.TestType

Methods

parsec :: CabalParsing m => m TestType

Parsec DefUnitId

Defined in Distribution.Types.UnitId

Methods

parsec :: CabalParsing m => m DefUnitId

Parsec UnitId

The textual format for UnitId coincides with the format GHC accepts for -package-id.

Defined in Distribution.Types.UnitId

Methods

parsec :: CabalParsing m => m UnitId

Parsec UnqualComponentName

Defined in Distribution.Types.UnqualComponentName

Methods

parsec :: CabalParsing m => m UnqualComponentName

Parsec Version

Defined in Distribution.Types.Version

Methods

parsec :: CabalParsing m => m Version

Parsec VersionRange

>>> simpleParsec "^>= 3.4" :: Maybe VersionRange
Just (MajorBoundVersion (mkVersion [3,4]))

Small history:

-any and -none removed in 3.4 Use >=0 and <0 instead.

>>> map (`simpleParsec'` "-none") [CabalSpecV3_0, CabalSpecV3_4] :: [Maybe VersionRange]
[Just (EarlierVersion (mkVersion [0])),Nothing]

Set operations are introduced in 3.0

>>> map (`simpleParsec'` "^>= { 1.2 , 1.3 }") [CabalSpecV2_4, CabalSpecV3_0] :: [Maybe VersionRange]
[Nothing,Just (UnionVersionRanges (MajorBoundVersion (mkVersion [1,2])) (MajorBoundVersion (mkVersion [1,3])))]

^>= is introduced in 2.0

>>> map (`simpleParsec'` "^>=1.2") [CabalSpecV1_24, CabalSpecV2_0] :: [Maybe VersionRange]
[Nothing,Just (MajorBoundVersion (mkVersion [1,2]))]

-none is introduced in 1.22

>>> map (`simpleParsec'` "-none") [CabalSpecV1_20, CabalSpecV1_22] :: [Maybe VersionRange]
[Nothing,Just (EarlierVersion (mkVersion [0]))]

Operators are introduced in 1.8. Issues only a warning.

>>> map (`simpleParsecW'` "== 1 || ==2") [CabalSpecV1_6, CabalSpecV1_8] :: [Maybe VersionRange]
[Nothing,Just (UnionVersionRanges (ThisVersion (mkVersion [1])) (ThisVersion (mkVersion [2])))]

Wild-version ranges are introduced in 1.6. Issues only a warning.

>>> map (`simpleParsecW'` "== 1.2.*") [CabalSpecV1_4, CabalSpecV1_6] :: [Maybe VersionRange]
[Nothing,Just (IntersectVersionRanges (OrLaterVersion (mkVersion [1,2])) (EarlierVersion (mkVersion [1,3])))]

Defined in Distribution.Types.VersionRange.Internal

Methods

parsec :: CabalParsing m => m VersionRange

Parsec Extension

Defined in Language.Haskell.Extension

Methods

parsec :: CabalParsing m => m Extension

Parsec Language

Defined in Language.Haskell.Extension

Methods

parsec :: CabalParsing m => m Language

Parsec Bool

Defined in Distribution.Parsec

Methods

parsec :: CabalParsing m => m Bool

FieldGrammar Parsec ParsecFieldGrammar

Defined in Distribution.FieldGrammar.Parsec

Methods

blurFieldGrammar :: ALens' a b -> ParsecFieldGrammar b d -> ParsecFieldGrammar a d

uniqueFieldAla :: (Parsec b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> ParsecFieldGrammar s Bool

optionalFieldAla :: (Parsec b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> ParsecFieldGrammar s (Maybe a)

optionalFieldDefAla :: (Parsec b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> ParsecFieldGrammar s a

freeTextField :: FieldName -> ALens' s (Maybe String) -> ParsecFieldGrammar s (Maybe String)

freeTextFieldDef :: FieldName -> ALens' s String -> ParsecFieldGrammar s String

freeTextFieldDefST :: FieldName -> ALens' s ShortText -> ParsecFieldGrammar s ShortText

monoidalFieldAla :: (Parsec b, Monoid a, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> ParsecFieldGrammar s a

prefixedFields :: FieldName -> ALens' s [(String, String)] -> ParsecFieldGrammar s [(String, String)]

knownField :: FieldName -> ParsecFieldGrammar s ()

hiddenField :: ParsecFieldGrammar s a -> ParsecFieldGrammar s a

deprecatedSince :: CabalSpecVersion -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

removedIn :: CabalSpecVersion -> String -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

availableSince :: CabalSpecVersion -> a -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

availableSinceWarn :: CabalSpecVersion -> ParsecFieldGrammar s a -> ParsecFieldGrammar s a

Parsec a => Parsec (MQuoted a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (MQuoted a)

Parsec a => Parsec (Identity a)

Defined in Distribution.Parsec

Methods

parsec :: CabalParsing m => m (Identity a)

Parsec (SymbolicPath from to)

Defined in Distribution.Utils.Path

Methods

parsec :: CabalParsing m => m (SymbolicPath from to)

(Newtype a b, Sep sep, Parsec b) => Parsec (List sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (List sep b a)

(Newtype a b, Sep sep, Parsec b) => Parsec (NonEmpty' sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (NonEmpty' sep b a)

(Newtype a b, Ord a, Sep sep, Parsec b) => Parsec (Set' sep b a)

Defined in Distribution.FieldGrammar.Newtypes

Methods

parsec :: CabalParsing m => m (Set' sep b a)

newtype ParsecParser a

Constructors

PP

Fields

• unPP :: CabalSpecVersion -> Parsec FieldLineStream [PWarning] a

Instances

CharParsing ParsecParser

Defined in Distribution.Parsec

Methods

satisfy :: (Char -> Bool) -> ParsecParser Char

char :: Char -> ParsecParser Char

notChar :: Char -> ParsecParser Char

anyChar :: ParsecParser Char

string :: String -> ParsecParser String

text :: Text -> ParsecParser Text

Parsing ParsecParser

Defined in Distribution.Parsec

Methods

try :: ParsecParser a -> ParsecParser a

(<?>) :: ParsecParser a -> String -> ParsecParser a

skipMany :: ParsecParser a -> ParsecParser ()

skipSome :: ParsecParser a -> ParsecParser ()

unexpected :: String -> ParsecParser a

eof :: ParsecParser ()

notFollowedBy :: Show a => ParsecParser a -> ParsecParser ()

CabalParsing ParsecParser

Defined in Distribution.Parsec

Methods

parsecWarning :: PWarnType -> String -> ParsecParser ()

parsecHaskellString :: ParsecParser String

askCabalSpecVersion :: ParsecParser CabalSpecVersion

MonadFail ParsecParser

Defined in Distribution.Parsec

Methods

fail :: String -> ParsecParser a

Alternative ParsecParser

Defined in Distribution.Parsec

Methods

empty :: ParsecParser a

(<|>) :: ParsecParser a -> ParsecParser a -> ParsecParser a

some :: ParsecParser a -> ParsecParser [a]

many :: ParsecParser a -> ParsecParser [a]

Applicative ParsecParser

Defined in Distribution.Parsec

Methods

pure :: a -> ParsecParser a

(<*>) :: ParsecParser (a -> b) -> ParsecParser a -> ParsecParser b

liftA2 :: (a -> b -> c) -> ParsecParser a -> ParsecParser b -> ParsecParser c

(*>) :: ParsecParser a -> ParsecParser b -> ParsecParser b

(<*) :: ParsecParser a -> ParsecParser b -> ParsecParser a

Functor ParsecParser

Defined in Distribution.Parsec

Methods

fmap :: (a -> b) -> ParsecParser a -> ParsecParser b

(<$) :: a -> ParsecParser b -> ParsecParser a

Monad ParsecParser

Defined in Distribution.Parsec

Methods

(>>=) :: ParsecParser a -> (a -> ParsecParser b) -> ParsecParser b

(>>) :: ParsecParser a -> ParsecParser b -> ParsecParser b

return :: a -> ParsecParser a

MonadPlus ParsecParser

Defined in Distribution.Parsec

Methods

mzero :: ParsecParser a

mplus :: ParsecParser a -> ParsecParser a -> ParsecParser a

runParsecParser :: ParsecParser a -> FilePath -> FieldLineStream -> Either ParseError a

Run ParsecParser with cabalSpecLatest.

runParsecParser' :: CabalSpecVersion -> ParsecParser a -> FilePath -> FieldLineStream -> Either ParseError a

Like runParsecParser but lets specify CabalSpecVersion used.

Since: 3.0.0.0

simpleParsec :: Parsec a => String -> Maybe a

Parse a String with lexemeParsec.

simpleParsecBS :: Parsec a => ByteString -> Maybe a

Like simpleParsec but for ByteString

simpleParsec' :: Parsec a => CabalSpecVersion -> String -> Maybe a

Parse a String with lexemeParsec using specific CabalSpecVersion.

Since: 3.4.0.0

simpleParsecW' :: Parsec a => CabalSpecVersion -> String -> Maybe a

Parse a String with lexemeParsec using specific CabalSpecVersion. Fail if there are any warnings.

Since: 3.4.0.0

lexemeParsec :: (CabalParsing m, Parsec a) => m a

parsec could consume trailing spaces, this function will consume.

eitherParsec :: Parsec a => String -> Either String a

Parse a String with lexemeParsec.

explicitEitherParsec :: ParsecParser a -> String -> Either String a

Parse a String with given ParsecParser. Trailing whitespace is accepted.

explicitEitherParsec' :: CabalSpecVersion -> ParsecParser a -> String -> Either String a

Parse a String with given ParsecParser and CabalSpecVersion. Trailing whitespace is accepted. See explicitEitherParsec.

Since: 3.4.0.0

CabalParsing and diagnostics

class (CharParsing m, MonadPlus m, MonadFail m) => CabalParsing m where

Parsing class which

• can report Cabal parser warnings.
• knows cabal-version we work with

Minimal complete definition

parsecWarning, askCabalSpecVersion

Methods

parsecWarning :: PWarnType -> String -> m ()

parsecHaskellString :: m String

askCabalSpecVersion :: m CabalSpecVersion

Instances

CabalParsing ParsecParser

Defined in Distribution.Parsec

Methods

parsecWarning :: PWarnType -> String -> ParsecParser ()

parsecHaskellString :: ParsecParser String

askCabalSpecVersion :: ParsecParser CabalSpecVersion

Warnings

data PWarnType

Type of parser warning. We do classify warnings.

Different application may decide not to show some, or have fatal behaviour on others

Constructors

PWTOther

Unclassified warning

PWTUTF

Invalid UTF encoding

PWTBoolCase

true or false, not True or False

PWTVersionTag

there are version with tags

PWTNewSyntax

New syntax used, but no cabal-version: >= 1.2 specified

PWTOldSyntax

Old syntax used, and cabal-version >= 1.2 specified

PWTDeprecatedField

PWTInvalidSubsection

PWTUnknownField

PWTUnknownSection

PWTTrailingFields

PWTExtraMainIs

extra main-is field

PWTExtraTestModule

extra test-module field

PWTExtraBenchmarkModule

extra benchmark-module field

PWTLexNBSP

PWTLexBOM

PWTLexTab

PWTQuirkyCabalFile

legacy cabal file that we know how to patch

PWTDoubleDash

Double dash token, most likely it's a mistake - it's not a comment

PWTMultipleSingularField

e.g. name or version should be specified only once.

PWTBuildTypeDefault

Workaround for derive-package having build-type: Default. See https://github.com/haskell/cabal/issues/5020.

PWTVersionOperator

Version operators used (without cabal-version: 1.8)

PWTVersionWildcard

Version wildcard used (without cabal-version: 1.6)

PWTSpecVersion

Warnings about cabal-version format.

PWTEmptyFilePath

Empty filepath, i.e. literally ""

PWTInconsistentIndentation

sections contents (sections and fields) are indented inconsistently

PWTExperimental

Experimental feature

Instances

Bounded PWarnType

Defined in Distribution.Parsec.Warning

Methods

minBound :: PWarnType

maxBound :: PWarnType

Enum PWarnType

Defined in Distribution.Parsec.Warning

Methods

succ :: PWarnType -> PWarnType

pred :: PWarnType -> PWarnType

toEnum :: Int -> PWarnType

fromEnum :: PWarnType -> Int

enumFrom :: PWarnType -> [PWarnType]

enumFromThen :: PWarnType -> PWarnType -> [PWarnType]

enumFromTo :: PWarnType -> PWarnType -> [PWarnType]

enumFromThenTo :: PWarnType -> PWarnType -> PWarnType -> [PWarnType]

Generic PWarnType

Defined in Distribution.Parsec.Warning

Associated Types

type Rep PWarnType :: Type -> Type

Methods

from :: PWarnType -> Rep PWarnType x

to :: Rep PWarnType x -> PWarnType

Show PWarnType

Defined in Distribution.Parsec.Warning

Methods

showsPrec :: Int -> PWarnType -> ShowS

show :: PWarnType -> String

showList :: [PWarnType] -> ShowS

Binary PWarnType

Defined in Distribution.Parsec.Warning

Methods

put :: PWarnType -> Put

get :: Get PWarnType

putList :: [PWarnType] -> Put

NFData PWarnType

Defined in Distribution.Parsec.Warning

Methods

rnf :: PWarnType -> ()

Eq PWarnType

Defined in Distribution.Parsec.Warning

Methods

(==) :: PWarnType -> PWarnType -> Bool

(/=) :: PWarnType -> PWarnType -> Bool

Ord PWarnType

Defined in Distribution.Parsec.Warning

Methods

compare :: PWarnType -> PWarnType -> Ordering

(<) :: PWarnType -> PWarnType -> Bool

(<=) :: PWarnType -> PWarnType -> Bool

(>) :: PWarnType -> PWarnType -> Bool

(>=) :: PWarnType -> PWarnType -> Bool

max :: PWarnType -> PWarnType -> PWarnType

min :: PWarnType -> PWarnType -> PWarnType

type Rep PWarnType

Defined in Distribution.Parsec.Warning

type Rep PWarnType = D1 ('MetaData "PWarnType" "Distribution.Parsec.Warning" "Cabal-syntax-3.12.1.0-IdRA6VeQqeX5uBVqXABfjL" 'False) ((((C1 ('MetaCons "PWTOther" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTUTF" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTBoolCase" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "PWTVersionTag" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTNewSyntax" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTOldSyntax" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTDeprecatedField" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTInvalidSubsection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTUnknownField" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTUnknownSection" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTTrailingFields" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTExtraMainIs" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExtraTestModule" 'PrefixI 'False) (U1 :: Type -> Type))))) :+: (((C1 ('MetaCons "PWTExtraBenchmarkModule" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTLexNBSP" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTLexBOM" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTLexTab" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTQuirkyCabalFile" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTDoubleDash" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTMultipleSingularField" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PWTBuildTypeDefault" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PWTVersionOperator" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTVersionWildcard" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "PWTSpecVersion" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTEmptyFilePath" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PWTInconsistentIndentation" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PWTExperimental" 'PrefixI 'False) (U1 :: Type -> Type))))))

data PWarning

Parser warning.

Constructors

PWarning !PWarnType !Position String

Instances

Generic PWarning

Defined in Distribution.Parsec.Warning

Associated Types

type Rep PWarning :: Type -> Type

Methods

from :: PWarning -> Rep PWarning x

to :: Rep PWarning x -> PWarning

Show PWarning

Defined in Distribution.Parsec.Warning

Methods

showsPrec :: Int -> PWarning -> ShowS

show :: PWarning -> String

showList :: [PWarning] -> ShowS

Binary PWarning

Defined in Distribution.Parsec.Warning

Methods

put :: PWarning -> Put

get :: Get PWarning

putList :: [PWarning] -> Put

NFData PWarning

Defined in Distribution.Parsec.Warning

Methods

rnf :: PWarning -> ()

Eq PWarning

Defined in Distribution.Parsec.Warning

Methods

(==) :: PWarning -> PWarning -> Bool

(/=) :: PWarning -> PWarning -> Bool

Ord PWarning

Defined in Distribution.Parsec.Warning

Methods

compare :: PWarning -> PWarning -> Ordering

(<) :: PWarning -> PWarning -> Bool

(<=) :: PWarning -> PWarning -> Bool

(>) :: PWarning -> PWarning -> Bool

(>=) :: PWarning -> PWarning -> Bool

max :: PWarning -> PWarning -> PWarning

min :: PWarning -> PWarning -> PWarning

type Rep PWarning

Defined in Distribution.Parsec.Warning

type Rep PWarning = D1 ('MetaData "PWarning" "Distribution.Parsec.Warning" "Cabal-syntax-3.12.1.0-IdRA6VeQqeX5uBVqXABfjL" 'False) (C1 ('MetaCons "PWarning" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PWarnType) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

showPWarning :: FilePath -> PWarning -> String

Errors

data PError

Parser error.

Constructors

PError Position String

Instances

Generic PError

Defined in Distribution.Parsec.Error

Associated Types

type Rep PError :: Type -> Type

Methods

from :: PError -> Rep PError x

to :: Rep PError x -> PError

Show PError

Defined in Distribution.Parsec.Error

Methods

showsPrec :: Int -> PError -> ShowS

show :: PError -> String

showList :: [PError] -> ShowS

Binary PError

Defined in Distribution.Parsec.Error

Methods

put :: PError -> Put

get :: Get PError

putList :: [PError] -> Put

NFData PError

Defined in Distribution.Parsec.Error

Methods

rnf :: PError -> ()

type Rep PError

Defined in Distribution.Parsec.Error

type Rep PError = D1 ('MetaData "PError" "Distribution.Parsec.Error" "Cabal-syntax-3.12.1.0-IdRA6VeQqeX5uBVqXABfjL" 'False) (C1 ('MetaCons "PError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Position) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

showPError :: FilePath -> PError -> String

Position

data Position

1-indexed row and column positions in a file.

Constructors

Position !Int !Int

Instances

Generic Position

Defined in Distribution.Parsec.Position

Associated Types

type Rep Position :: Type -> Type

Methods

from :: Position -> Rep Position x

to :: Rep Position x -> Position

Show Position

Defined in Distribution.Parsec.Position

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Binary Position

Defined in Distribution.Parsec.Position

Methods

put :: Position -> Put

get :: Get Position

putList :: [Position] -> Put

NFData Position

Defined in Distribution.Parsec.Position

Methods

rnf :: Position -> ()

Eq Position

Defined in Distribution.Parsec.Position

Methods

(==) :: Position -> Position -> Bool

(/=) :: Position -> Position -> Bool

Ord Position

Defined in Distribution.Parsec.Position

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

type Rep Position

Defined in Distribution.Parsec.Position

type Rep Position = D1 ('MetaData "Position" "Distribution.Parsec.Position" "Cabal-syntax-3.12.1.0-IdRA6VeQqeX5uBVqXABfjL" 'False) (C1 ('MetaCons "Position" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Int)))

incPos :: Int -> Position -> Position

Shift position by n columns to the right.

retPos :: Position -> Position

Shift position to beginning of next row.

showPos :: Position -> String

zeroPos :: Position

Utilities

parsecToken :: CabalParsing m => m String

[^ ,]

parsecToken' :: CabalParsing m => m String

[^ ]

parsecFilePath :: CabalParsing m => m FilePath

parsecQuoted :: CabalParsing m => m a -> m a

Content isn't unquoted

parsecMaybeQuoted :: CabalParsing m => m a -> m a

parsecMaybeQuoted p = parsecQuoted p | p.

parsecCommaList :: CabalParsing m => m a -> m [a]

parsecCommaNonEmpty :: CabalParsing m => m a -> m (NonEmpty a)

parsecLeadingCommaList :: CabalParsing m => m a -> m [a]

Like parsecCommaList but accept leading or trailing comma.

p (comma p)*  -- p sepBy comma
(comma p)*    -- leading comma
(p comma)*    -- trailing comma

parsecLeadingCommaNonEmpty :: CabalParsing m => m a -> m (NonEmpty a)

Since: 3.4.0.0

parsecOptCommaList :: CabalParsing m => m a -> m [a]

parsecLeadingOptCommaList :: CabalParsing m => m a -> m [a]

Like parsecOptCommaList but

• require all or none commas
• accept leading or trailing comma.

p (comma p)*  -- p sepBy comma
(comma p)*    -- leading comma
(p comma)*    -- trailing comma
p*            -- no commas: many p

Since: 3.0.0.0

parsecStandard :: (CabalParsing m, Parsec ver) => (ver -> String -> a) -> m a

Parse a benchmark/test-suite types.

parsecUnqualComponentName :: forall m. CabalParsing m => m String