Modulecabal-install-3.18.1.0Haskell2010

Distribution.Client.Errors.Parser

Synopsis

data CabalFileParseError
value renderCabalFileParseError
data ProjectConfigParseError
value renderProjectConfigParseError
data ProjectFileSource
value renderProjectFileSource
value renderParseErrorCabalFile
value renderParseError
value renderParseErrorsWarnings
value renderCabalFileSourceMsgs
value renderInstalledPackageInfoSourceMsgs
value renderParseErrorNoFile
value renderParseErrorFile
value renderParseErrorGeneral
data Zipper
value listToZipper
value advance

Packagecabal-install-3.18.1.0
Exports17
LanguageHaskell2010
LicenceBSD-3-Clause
SourceParser.hs

datadata CabalFileParseError

Source#

Errors reported upon failing to parse a .cabal file.

Constructors

CabalFileParseError FilePath ByteString (NonEmpty (PErrorWithSource CabalFileSource)) (Maybe Version) [PWarningWithSource CabalFileSource]

Instances2Show, Exception

Show CabalFileParseErrorDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser
Manual instance which skips file contents
Exception CabalFileParseErrorDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser

valuerenderCabalFileParseError :: CabalFileParseError -> String

datadata ProjectConfigParseError

Source#

Errors reported upon failing to parse a cabal.project file.

Constructors

ProjectConfigParseError (NonEmpty (PErrorWithSource ProjectFileSource)) [PWarningWithSource ProjectFileSource]

Instances2Show, Exception

Show ProjectConfigParseErrorDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser
Manual instance which skips file contents
Exception ProjectConfigParseErrorDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser

valuerenderProjectConfigParseError :: ProjectConfigParseError -> String

datadata ProjectFileSource

Constructors

ProjectFileSource (ProjectConfigPath, ByteString)

Instances5Eq, Ord, Show, Generic, Rep

Eq ProjectFileSourceDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser
Ord ProjectFileSourceDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser
Show ProjectFileSourceDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser
Generic ProjectFileSourceDefined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser
type Rep ProjectFileSource = D1 ('MetaData "ProjectFileSource" "Distribution.Client.Errors.Parser" "cabal-install-3.18.1.0-4MgBWnQbRpBByysMMKvgoy" 'False) (C1 ('MetaCons "ProjectFileSource" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProjectConfigPath, ByteString))))Defined in cabal-install-3.18.1.0 · Distribution.Client.Errors.Parser

valuerenderProjectFileSource :: ProjectFileSource -> String

valuerenderParseErrorCabalFile

:: NonEmpty (PErrorWithSource CabalFileSource)
-> [PWarningWithSource CabalFileSource]
-> String

valuerenderParseError

:: Ord src
=> src -> ([PError], [PWarning]) -> String
-> NonEmpty (PErrorWithSource src)
-> [PWarningWithSource src]
-> String

Source#

Render parse error highlighting the part of the input file.

valuerenderParseErrorsWarnings

:: PSource (([PError], [PWarning]) -> String)
-> ([PError], [PWarning])
-> String

valuerenderCabalFileSourceMsgs

:: CabalFileSource
-> ([PError], [PWarning])
-> String

valuerenderInstalledPackageInfoSourceMsgs

valuerenderParseErrorNoFile :: String -> [PError] -> [PWarning] -> String

valuerenderParseErrorFile

:: String
Human name for the kind of file (i.e. cabal, project "file")
-> FilePath
Path to the file
-> Maybe String
Provenance, any additional contextual info to print
-> ByteString
Contents of the file
-> ([PError], [PWarning])
-> String

Source#

Render a parse error which resulted from a file on disk

valuerenderParseErrorGeneral

:: String
What we were parsing when the error occurred.
-> Maybe String
A simpler/shorter header to display when displaying each error (normally a filepath)
-> Maybe String
Provenance, used to print additional context about what file failed (used to print the import path of a project file which failed to parse)
-> (Position -> [String])
Extra information to render based on the position
-> [PError]
-> [PWarning]
-> String

Source#

A generic rendering function which can render from many sources.

datadata Zipper a

Constructors

Zipper [a] [a]

valuelistToZipper :: [a] -> Zipper a

valueadvance :: Int -> Zipper a -> Zipper a