Safe Haskell	None
Language	Haskell2010

Distribution.Client.Errors.Parser

Synopsis

data CabalFileParseError = CabalFileParseError FilePath ByteString (NonEmpty (PErrorWithSource CabalFileSource)) (Maybe Version) [PWarningWithSource CabalFileSource]
renderCabalFileParseError :: CabalFileParseError -> String
data ProjectConfigParseError = ProjectConfigParseError (NonEmpty (PErrorWithSource ProjectFileSource)) [PWarningWithSource ProjectFileSource]
renderProjectConfigParseError :: ProjectConfigParseError -> String
data ProjectFileSource = ProjectFileSource (ProjectConfigPath, ByteString)
renderProjectFileSource :: ProjectFileSource -> String
renderParseErrorCabalFile :: NonEmpty (PErrorWithSource CabalFileSource) -> [PWarningWithSource CabalFileSource] -> String
renderParseError :: Ord src => (src -> ([PError], [PWarning]) -> String) -> NonEmpty (PErrorWithSource src) -> [PWarningWithSource src] -> String
renderParseErrorsWarnings :: PSource (([PError], [PWarning]) -> String) -> ([PError], [PWarning]) -> String
renderCabalFileSourceMsgs :: CabalFileSource -> ([PError], [PWarning]) -> String
renderInstalledPackageInfoSourceMsgs :: InstalledPackageInfoSource -> ([PError], [PWarning]) -> String
renderParseErrorNoFile :: String -> [PError] -> [PWarning] -> String
renderParseErrorFile :: String -> FilePath -> Maybe String -> ByteString -> ([PError], [PWarning]) -> String
renderParseErrorGeneral :: String -> Maybe String -> Maybe String -> (Position -> [String]) -> [PError] -> [PWarning] -> String
data Zipper a = Zipper [a] [a]
listToZipper :: [a] -> Zipper a
advance :: Int -> Zipper a -> Zipper a

Documentation

data CabalFileParseError Source #

Errors reported upon failing to parse a .cabal file.

Constructors

CabalFileParseError
Fields FilePath `.cabal` file path ByteString `.cabal` file contents (NonEmpty (PErrorWithSource CabalFileSource)) errors (Maybe Version) We might discover the spec version the package needs [PWarningWithSource CabalFileSource] warnings

Instances

Instances details

Exception CabalFileParseError Source #
Instance details Defined in Distribution.Client.Errors.Parser Methods toException :: CabalFileParseError -> SomeException # fromException :: SomeException -> Maybe CabalFileParseError # displayException :: CabalFileParseError -> String # backtraceDesired :: CabalFileParseError -> Bool #
Show CabalFileParseError Source #	Manual instance which skips file contents
Instance details Defined in Distribution.Client.Errors.Parser Methods showsPrec :: Int -> CabalFileParseError -> ShowS # show :: CabalFileParseError -> String # showList :: [CabalFileParseError] -> ShowS #

renderCabalFileParseError :: CabalFileParseError -> String Source #

data ProjectConfigParseError Source #

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

Constructors

ProjectConfigParseError
Fields (NonEmpty (PErrorWithSource ProjectFileSource)) errors [PWarningWithSource ProjectFileSource] warnings

Instances

Instances details

Exception ProjectConfigParseError Source #
Instance details Defined in Distribution.Client.Errors.Parser Methods toException :: ProjectConfigParseError -> SomeException # fromException :: SomeException -> Maybe ProjectConfigParseError # displayException :: ProjectConfigParseError -> String # backtraceDesired :: ProjectConfigParseError -> Bool #
Show ProjectConfigParseError Source #	Manual instance which skips file contents
Instance details Defined in Distribution.Client.Errors.Parser Methods showsPrec :: Int -> ProjectConfigParseError -> ShowS # show :: ProjectConfigParseError -> String # showList :: [ProjectConfigParseError] -> ShowS #

renderProjectConfigParseError :: ProjectConfigParseError -> String Source #

data ProjectFileSource Source #

Constructors

ProjectFileSource (ProjectConfigPath, ByteString)

Instances

Instances details

Generic ProjectFileSource Source #

Instance details

Defined in Distribution.Client.Errors.Parser

Associated Types

type Rep ProjectFileSource
Instance details Defined in Distribution.Client.Errors.Parser type Rep ProjectFileSource = D1 ('MetaData "ProjectFileSource" "Distribution.Client.Errors.Parser" "cabal-install-3.18.1.0-inplace" 'False) (C1 ('MetaCons "ProjectFileSource" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProjectConfigPath, ByteString))))

Methods

from :: ProjectFileSource -> Rep ProjectFileSource x #

to :: Rep ProjectFileSource x -> ProjectFileSource #

Show ProjectFileSource Source #

Instance details

Defined in Distribution.Client.Errors.Parser

Methods

showsPrec :: Int -> ProjectFileSource -> ShowS #

show :: ProjectFileSource -> String #

showList :: [ProjectFileSource] -> ShowS #

Eq ProjectFileSource Source #

Instance details

Defined in Distribution.Client.Errors.Parser

Methods

(==) :: ProjectFileSource -> ProjectFileSource -> Bool #

(/=) :: ProjectFileSource -> ProjectFileSource -> Bool #

Ord ProjectFileSource Source #

Instance details

Defined in Distribution.Client.Errors.Parser

Methods

compare :: ProjectFileSource -> ProjectFileSource -> Ordering #

(<) :: ProjectFileSource -> ProjectFileSource -> Bool #

(<=) :: ProjectFileSource -> ProjectFileSource -> Bool #

(>) :: ProjectFileSource -> ProjectFileSource -> Bool #

(>=) :: ProjectFileSource -> ProjectFileSource -> Bool #

max :: ProjectFileSource -> ProjectFileSource -> ProjectFileSource #

min :: ProjectFileSource -> ProjectFileSource -> ProjectFileSource #

type Rep ProjectFileSource Source #

Instance details

Defined in Distribution.Client.Errors.Parser

type Rep ProjectFileSource = D1 ('MetaData "ProjectFileSource" "Distribution.Client.Errors.Parser" "cabal-install-3.18.1.0-inplace" 'False) (C1 ('MetaCons "ProjectFileSource" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ProjectConfigPath, ByteString))))

renderProjectFileSource :: ProjectFileSource -> String Source #

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

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

Render parse error highlighting the part of the input file.

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

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

renderInstalledPackageInfoSourceMsgs :: InstalledPackageInfoSource -> ([PError], [PWarning]) -> String Source #

renderParseErrorNoFile :: String -> [PError] -> [PWarning] -> String Source #

renderParseErrorFile Source #

Arguments

:: 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

Render a parse error which resulted from a file on disk

renderParseErrorGeneral Source #

Arguments

:: 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

A generic rendering function which can render from many sources.

data Zipper a Source #

Constructors

Zipper [a] [a]

listToZipper :: [a] -> Zipper a Source #

advance :: Int -> Zipper a -> Zipper a Source #