Safe Haskell | None |
---|---|
Language | Haskell2010 |
Distribution.Parsec
Synopsis
- class Parsec a where
- newtype ParsecParser a = PP {
- unPP :: CabalSpecVersion -> Parsec FieldLineStream [PWarning] a
- runParsecParser :: ParsecParser a -> FilePath -> FieldLineStream -> Either ParseError a
- runParsecParser' :: CabalSpecVersion -> ParsecParser a -> FilePath -> FieldLineStream -> Either ParseError a
- simpleParsec :: Parsec a => String -> Maybe a
- lexemeParsec :: (CabalParsing m, Parsec a) => m a
- eitherParsec :: Parsec a => String -> Either String a
- explicitEitherParsec :: ParsecParser a -> String -> Either String a
- class (CharParsing m, MonadPlus m, MonadFail m) => CabalParsing m where
- data PWarnType
- = PWTOther
- | PWTUTF
- | PWTBoolCase
- | PWTVersionTag
- | PWTNewSyntax
- | PWTOldSyntax
- | PWTDeprecatedField
- | PWTInvalidSubsection
- | PWTUnknownField
- | PWTUnknownSection
- | PWTTrailingFields
- | PWTExtraMainIs
- | PWTExtraTestModule
- | PWTExtraBenchmarkModule
- | PWTLexNBSP
- | PWTLexBOM
- | PWTLexTab
- | PWTQuirkyCabalFile
- | PWTDoubleDash
- | PWTMultipleSingularField
- | PWTBuildTypeDefault
- data PWarning = PWarning !PWarnType !Position String
- showPWarning :: FilePath -> PWarning -> String
- data PError = PError Position String
- showPError :: FilePath -> PError -> String
- data Position = Position !Int !Int
- incPos :: Int -> Position -> Position
- retPos :: Position -> Position
- showPos :: Position -> String
- zeroPos :: Position
- parsecToken :: CabalParsing m => m String
- parsecToken' :: CabalParsing m => m String
- parsecFilePath :: CabalParsing m => m FilePath
- parsecQuoted :: CabalParsing m => m a -> m a
- parsecMaybeQuoted :: CabalParsing m => m a -> m a
- parsecCommaList :: CabalParsing m => m a -> m [a]
- parsecLeadingCommaList :: CabalParsing m => m a -> m [a]
- parsecOptCommaList :: CabalParsing m => m a -> m [a]
- parsecLeadingOptCommaList :: CabalParsing m => m a -> m [a]
- parsecStandard :: (CabalParsing m, Parsec ver) => (ver -> String -> a) -> m a
- parsecUnqualComponentName :: CabalParsing m => m String
Documentation
Class for parsing with parsec
. Mainly used for .cabal
file fields.
For parsing .cabal
like file structure, see Distribution.Fields.
Minimal complete definition
Methods
parsec :: CabalParsing m => m a #
Instances
Parsec Bool # | |
Defined in Distribution.Parsec Methods parsec :: CabalParsing m => m Bool # | |
Parsec Version # | |
Defined in Distribution.Types.Version Methods parsec :: CabalParsing m => m Version # | |
Parsec VersionRange # | |
Defined in Distribution.Types.VersionRange.Internal Methods parsec :: CabalParsing m => m VersionRange # | |
Parsec RepoType # | |
Defined in Distribution.Types.SourceRepo Methods parsec :: CabalParsing m => m RepoType # | |
Parsec RepoKind # | |
Defined in Distribution.Types.SourceRepo Methods parsec :: CabalParsing m => m RepoKind # | |
Parsec PkgconfigVersion # |
|
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 PkgconfigName # | |
Defined in Distribution.Types.PkgconfigName Methods parsec :: CabalParsing m => m PkgconfigName # | |
Parsec PkgconfigDependency # | |
Defined in Distribution.Types.PkgconfigDependency Methods parsec :: CabalParsing m => m PkgconfigDependency # | |
Parsec PackageName # | |
Defined in Distribution.Types.PackageName Methods parsec :: CabalParsing m => m PackageName # | |
Parsec UnqualComponentName # | |
Defined in Distribution.Types.UnqualComponentName Methods parsec :: CabalParsing m => m UnqualComponentName # | |
Parsec PackageVersionConstraint # | |
Defined in Distribution.Types.PackageVersionConstraint Methods parsec :: CabalParsing m => m PackageVersionConstraint # | |
Parsec LibraryVisibility # | |
Defined in Distribution.Types.LibraryVisibility Methods parsec :: CabalParsing m => m LibraryVisibility # | |
Parsec MungedPackageName # |
|
Defined in Distribution.Types.MungedPackageName Methods parsec :: CabalParsing m => m MungedPackageName # | |
Parsec ForeignLibType # | |
Defined in Distribution.Types.ForeignLibType Methods parsec :: CabalParsing m => m ForeignLibType # | |
Parsec ForeignLibOption # | |
Defined in Distribution.Types.ForeignLibOption Methods parsec :: CabalParsing m => m ForeignLibOption # | |
Parsec FlagName # | |
Defined in Distribution.Types.Flag Methods parsec :: CabalParsing m => m FlagName # | |
Parsec ExecutableScope # | |
Defined in Distribution.Types.ExecutableScope Methods parsec :: CabalParsing m => m ExecutableScope # | |
Parsec ComponentName # | |
Defined in Distribution.Types.ComponentName Methods parsec :: CabalParsing m => m ComponentName # | |
Parsec ComponentId # | |
Defined in Distribution.Types.ComponentId Methods parsec :: CabalParsing m => m ComponentId # | |
Parsec BuildType # | |
Defined in Distribution.Types.BuildType Methods parsec :: CabalParsing m => m BuildType # | |
Parsec AbiHash # | |
Defined in Distribution.Types.AbiHash Methods parsec :: CabalParsing m => m AbiHash # | |
Parsec Platform # | |
Defined in Distribution.System Methods parsec :: CabalParsing m => m Platform # | |
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 LicenseRef # | |
Defined in Distribution.SPDX.LicenseReference Methods parsec :: CabalParsing m => m LicenseRef # | |
Parsec LicenseId # |
|
Defined in Distribution.SPDX.LicenseId Methods parsec :: CabalParsing m => m LicenseId # | |
Parsec LicenseExceptionId # | |
Defined in Distribution.SPDX.LicenseExceptionId Methods parsec :: CabalParsing m => m LicenseExceptionId # | |
Parsec SimpleLicenseExpression # | |
Defined in Distribution.SPDX.LicenseExpression Methods parsec :: CabalParsing m => m SimpleLicenseExpression # | |
Parsec LicenseExpression # | |
Defined in Distribution.SPDX.LicenseExpression Methods parsec :: CabalParsing m => m LicenseExpression # | |
Parsec License # |
|
Defined in Distribution.SPDX.License Methods parsec :: CabalParsing m => m License # | |
Parsec ModuleName # | |
Defined in Distribution.ModuleName Methods parsec :: CabalParsing m => m ModuleName # | |
Parsec ModuleRenaming # | |
Defined in Distribution.Types.ModuleRenaming Methods parsec :: CabalParsing m => m ModuleRenaming # | |
Parsec IncludeRenaming # | |
Defined in Distribution.Types.IncludeRenaming Methods parsec :: CabalParsing m => m IncludeRenaming # | |
Parsec Mixin # | |
Defined in Distribution.Types.Mixin Methods parsec :: CabalParsing m => m Mixin # | |
Parsec ModuleReexport # | |
Defined in Distribution.Types.ModuleReexport Methods parsec :: CabalParsing m => m ModuleReexport # | |
Parsec TestType # | |
Defined in Distribution.Types.TestType Methods parsec :: CabalParsing m => m TestType # | |
Parsec PackageIdentifier # |
Note: Stricter than
|
Defined in Distribution.Types.PackageId Methods parsec :: CabalParsing m => m PackageIdentifier # | |
Parsec DefUnitId # | |
Defined in Distribution.Types.UnitId Methods parsec :: CabalParsing m => m DefUnitId # | |
Parsec UnitId # | The textual format for |
Defined in Distribution.Types.UnitId Methods parsec :: CabalParsing m => m UnitId # | |
Parsec Module # | |
Defined in Distribution.Types.Module Methods parsec :: CabalParsing m => m Module # | |
Parsec OpenModule # |
|
Defined in Distribution.Backpack Methods parsec :: CabalParsing m => m OpenModule # | |
Parsec OpenUnitId # |
|
Defined in Distribution.Backpack Methods parsec :: CabalParsing m => m OpenUnitId # | |
Parsec ExposedModule # | |
Defined in Distribution.Types.ExposedModule Methods parsec :: CabalParsing m => m ExposedModule # | |
Parsec MungedPackageId # |
|
Defined in Distribution.Types.MungedPackageId Methods parsec :: CabalParsing m => m MungedPackageId # | |
Parsec LegacyExeDependency # | |
Defined in Distribution.Types.LegacyExeDependency Methods parsec :: CabalParsing m => m LegacyExeDependency # | |
Parsec ExeDependency # | Examples
|
Defined in Distribution.Types.ExeDependency Methods parsec :: CabalParsing m => m ExeDependency # | |
Parsec Dependency # |
Spaces around colon are not allowed:
|
Defined in Distribution.Types.Dependency Methods parsec :: CabalParsing m => m Dependency # | |
Parsec BenchmarkType # | |
Defined in Distribution.Types.BenchmarkType Methods parsec :: CabalParsing m => m BenchmarkType # | |
Parsec AbiDependency # | |
Defined in Distribution.Types.AbiDependency Methods parsec :: CabalParsing m => m AbiDependency # | |
Parsec License # | |
Defined in Distribution.License Methods parsec :: CabalParsing m => m License # | |
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 AbiTag # | |
Defined in Distribution.Compiler Methods parsec :: CabalParsing m => m AbiTag # | |
Parsec CompilerId # | |
Defined in Distribution.Compiler Methods parsec :: CabalParsing m => m CompilerId # | |
Parsec CompilerFlavor # | |
Defined in Distribution.Compiler Methods parsec :: CabalParsing m => m CompilerFlavor # | |
Parsec LibVersionInfo # | |
Defined in Distribution.Types.ForeignLib Methods parsec :: CabalParsing m => m LibVersionInfo # | |
Parsec FilePathNT # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m FilePathNT # | |
Parsec TestedWith # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m TestedWith # | |
Parsec SpecLicense # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m SpecLicense # | |
Parsec SpecVersion # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m SpecVersion # | |
Parsec Token' # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m Token' # | |
Parsec Token # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m Token # | |
Parsec TestShowDetails # | |
Defined in Distribution.Simple.Setup Methods parsec :: CabalParsing m => m TestShowDetails # | |
Parsec HaddockTarget # | |
Defined in Distribution.Simple.Setup Methods parsec :: CabalParsing m => m HaddockTarget # | |
Parsec a => Parsec (Identity a) # | |
Defined in Distribution.Parsec Methods parsec :: CabalParsing m => m (Identity a) # | |
Parsec a => Parsec (MQuoted a) # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m (MQuoted a) # | |
(Newtype a b, Ord a, Sep sep, Parsec b) => Parsec (Set' sep b a) # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m (Set' sep b a) # | |
(Newtype a b, Sep sep, Parsec b) => Parsec (List sep b a) # | |
Defined in Distribution.Parsec.Newtypes Methods parsec :: CabalParsing m => m (List sep b a) # |
newtype ParsecParser a #
Constructors
PP | |
Fields
|
Instances
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
.
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.
CabalParsing and 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
Instances
CabalParsing ParsecParser # | |
Defined in Distribution.Parsec Methods parsecWarning :: PWarnType -> String -> ParsecParser () # |
Warnings
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 |
|
PWTVersionTag | there are version with tags |
PWTNewSyntax | New syntax used, but no |
PWTOldSyntax | Old syntax used, and |
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. |
Instances
Parser warning.
Instances
Show PWarning # | |
Generic PWarning # | |
Binary PWarning # | |
NFData PWarning # | |
Defined in Distribution.Parsec.Warning | |
type Rep PWarning # | |
Defined in Distribution.Parsec.Warning type Rep PWarning = D1 (MetaData "PWarning" "Distribution.Parsec.Warning" "Cabal-3.3.0.0-inplace" 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
Parser error.
Instances
Show PError # | |
Generic PError # | |
Binary PError # | |
NFData PError # | |
Defined in Distribution.Parsec.Error | |
type Rep PError # | |
Defined in Distribution.Parsec.Error type Rep PError = D1 (MetaData "PError" "Distribution.Parsec.Error" "Cabal-3.3.0.0-inplace" 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
1-indexed row and column positions in a file.
Instances
Eq Position # | |
Ord Position # | |
Defined in Distribution.Parsec.Position | |
Show Position # | |
Generic Position # | |
Binary Position # | |
NFData Position # | |
Defined in Distribution.Parsec.Position | |
type Rep Position # | |
Defined in Distribution.Parsec.Position type Rep Position = D1 (MetaData "Position" "Distribution.Parsec.Position" "Cabal-3.3.0.0-inplace" 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))) |
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] #
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
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 :: CabalParsing m => m String #