@@ -20,10 +20,11 @@
20module Language.PureScript.Errors where
20module Language.PureScript.Errors where
22import Data.Either (lefts, rights)
22import Data.Either (lefts, rights)
23−import Data.List (intercalate, transpose, nub)
23+import Data.List (intercalate, transpose, nub, nubBy, partition)
24import Data.Function (on)
24import Data.Function (on)
25#if __GLASGOW_HASKELL__ < 710
25#if __GLASGOW_HASKELL__ < 710
26import Data.Foldable (fold, foldMap)
26import Data.Foldable (fold, foldMap)
27+import Data.Traversable (traverse)
28import Data.Foldable (fold)
29import Data.Foldable (fold)
@@ -53,9 +54,7 @@ import qualified Text.Parsec as P
53import qualified Text.Parsec.Error as PE
54import qualified Text.Parsec.Error as PE
54import Text.Parsec.Error (Message(..))
55import Text.Parsec.Error (Message(..))
57−-- A type of error messages
57+-- | A type of error messages
59data SimpleErrorMessage
58data SimpleErrorMessage
60 = ErrorParsingExterns P.ParseError
59 = ErrorParsingExterns P.ParseError
61 | ErrorParsingFFIModule FilePath
60 | ErrorParsingFFIModule FilePath
@@ -143,45 +142,54 @@ data SimpleErrorMessage
143 | ShadowedTypeVar String
142 | ShadowedTypeVar String
144 | UnusedTypeVar String
143 | UnusedTypeVar String
145 | WildcardInferredType Type
144 | WildcardInferredType Type
145+ | MissingTypeDeclaration Ident
146 | NotExhaustivePattern [[Binder]] Bool
146 | NotExhaustivePattern [[Binder]] Bool
147 | OverlappingPattern [[Binder]] Bool
147 | OverlappingPattern [[Binder]] Bool
148 | IncompleteExhaustivityCheck
148 | IncompleteExhaustivityCheck
149 | ClassOperator ProperName Ident
149 | ClassOperator ProperName Ident
150 | MisleadingEmptyTypeImport ModuleName ProperName
150 | MisleadingEmptyTypeImport ModuleName ProperName
151 | ImportHidingModule ModuleName
151 | ImportHidingModule ModuleName
152− deriving (Show)
152+ deriving Show
154−-- |
154+-- | Error message hints, providing more detailed information about failure.
155−-- Wrapper of simpler errors
155+data ErrorMessageHint
158− = NotYetDefined [Ident] ErrorMessage
156+ = NotYetDefined [Ident]
159− | ErrorUnifyingTypes Type Type ErrorMessage
157+ | ErrorUnifyingTypes Type Type
160− | ErrorInExpression Expr ErrorMessage
158+ | ErrorInExpression Expr
161− | ErrorInModule ModuleName ErrorMessage
159+ | ErrorInModule ModuleName
162− | ErrorInInstance (Qualified ProperName) [Type] ErrorMessage
160+ | ErrorInInstance (Qualified ProperName) [Type]
163− | ErrorInSubsumption Type Type ErrorMessage
161+ | ErrorInSubsumption Type Type
164− | ErrorCheckingType Expr Type ErrorMessage
162+ | ErrorCheckingType Expr Type
165− | ErrorCheckingKind Type ErrorMessage
163+ | ErrorCheckingKind Type
166− | ErrorInferringType Expr ErrorMessage
164+ | ErrorInferringType Expr
167− | ErrorInApplication Expr Type Expr ErrorMessage
165+ | ErrorInApplication Expr Type Expr
168− | ErrorInDataConstructor ProperName ErrorMessage
166+ | ErrorInDataConstructor ProperName
169− | ErrorInTypeConstructor ProperName ErrorMessage
167+ | ErrorInTypeConstructor ProperName
170− | ErrorInBindingGroup [Ident] ErrorMessage
168+ | ErrorInBindingGroup [Ident]
171− | ErrorInDataBindingGroup ErrorMessage
169+ | ErrorInDataBindingGroup
172− | ErrorInTypeSynonym ProperName ErrorMessage
170+ | ErrorInTypeSynonym ProperName
173− | ErrorInValueDeclaration Ident ErrorMessage
171+ | ErrorInValueDeclaration Ident
174− | ErrorInTypeDeclaration Ident ErrorMessage
172+ | ErrorInTypeDeclaration Ident
175− | ErrorInForeignImport Ident ErrorMessage
173+ | ErrorInForeignImport Ident
176− | PositionedError SourceSpan ErrorMessage
174+ | PositionedError SourceSpan
177− | SimpleErrorWrapper SimpleErrorMessage
175+ deriving Show
177+-- | Categories of hints
186+data ErrorMessage = ErrorMessage [ErrorMessageHint] SimpleErrorMessage deriving (Show)
180instance UnificationError Type ErrorMessage where
188instance UnificationError Type ErrorMessage where
181− occursCheckFailed t = SimpleErrorWrapper $ InfiniteType t
189+ occursCheckFailed t = ErrorMessage [] $ InfiniteType t
183instance UnificationError Kind ErrorMessage where
191instance UnificationError Kind ErrorMessage where
184− occursCheckFailed k = SimpleErrorWrapper $ InfiniteKind k
192+ occursCheckFailed k = ErrorMessage [] $ InfiniteKind k
187-- Get the error code for a particular error type
195-- Get the error code for a particular error type
@@ -274,6 +282,7 @@ errorCode em = case unwrapErrorMessage em of
274 ShadowedTypeVar{} -> "ShadowedTypeVar"
282 ShadowedTypeVar{} -> "ShadowedTypeVar"
275 UnusedTypeVar{} -> "UnusedTypeVar"
283 UnusedTypeVar{} -> "UnusedTypeVar"
276 WildcardInferredType{} -> "WildcardInferredType"
284 WildcardInferredType{} -> "WildcardInferredType"
285+ MissingTypeDeclaration{} -> "MissingTypeDeclaration"
277 NotExhaustivePattern{} -> "NotExhaustivePattern"
286 NotExhaustivePattern{} -> "NotExhaustivePattern"
278 OverlappingPattern{} -> "OverlappingPattern"
287 OverlappingPattern{} -> "OverlappingPattern"
279 IncompleteExhaustivityCheck{} -> "IncompleteExhaustivityCheck"
288 IncompleteExhaustivityCheck{} -> "IncompleteExhaustivityCheck"
@@ -301,7 +310,7 @@ nonEmpty = not . null . runMultipleErrors
301-- Create an error set from a single simple error message
310-- Create an error set from a single simple error message
303errorMessage :: SimpleErrorMessage -> MultipleErrors
312errorMessage :: SimpleErrorMessage -> MultipleErrors
304−errorMessage err = MultipleErrors [SimpleErrorWrapper err]
313+errorMessage err = MultipleErrors [ErrorMessage [] err]
@@ -310,12 +319,14 @@ errorMessage err = MultipleErrors [SimpleErrorWrapper err]
310singleError :: ErrorMessage -> MultipleErrors
319singleError :: ErrorMessage -> MultipleErrors
311singleError = MultipleErrors . pure
320singleError = MultipleErrors . pure
314−-- Lift a function on ErrorMessage to a function on MultipleErrors
322+-- | Lift a function on ErrorMessage to a function on MultipleErrors
316onErrorMessages :: (ErrorMessage -> ErrorMessage) -> MultipleErrors -> MultipleErrors
323onErrorMessages :: (ErrorMessage -> ErrorMessage) -> MultipleErrors -> MultipleErrors
317onErrorMessages f = MultipleErrors . map f . runMultipleErrors
324onErrorMessages f = MultipleErrors . map f . runMultipleErrors
326+-- | Add a hint to an error message
327+addHint :: ErrorMessageHint -> MultipleErrors -> MultipleErrors
328+addHint hint = onErrorMessages $ \(ErrorMessage hints se) -> ErrorMessage (hint : hints) se
319-- | The various types of things which might need to be relabelled in errors messages.
330-- | The various types of things which might need to be relabelled in errors messages.
320data LabelType = TypeLabel | SkolemLabel String deriving (Show, Read, Eq, Ord)
331data LabelType = TypeLabel | SkolemLabel String deriving (Show, Read, Eq, Ord)
@@ -329,27 +340,7 @@ data Level = Error | Warning deriving Show
329-- Extract nested error messages from wrapper errors
340-- Extract nested error messages from wrapper errors
331unwrapErrorMessage :: ErrorMessage -> SimpleErrorMessage
342unwrapErrorMessage :: ErrorMessage -> SimpleErrorMessage
332−unwrapErrorMessage em = case em of
343+unwrapErrorMessage (ErrorMessage _ se) = se
333− (ErrorCheckingKind _ err) -> unwrapErrorMessage err
334− (ErrorCheckingType _ _ err) -> unwrapErrorMessage err
335− (ErrorInApplication _ _ _ err) -> unwrapErrorMessage err
336− (ErrorInBindingGroup _ err) -> unwrapErrorMessage err
337− (ErrorInDataBindingGroup err) -> unwrapErrorMessage err
338− (ErrorInDataConstructor _ err) -> unwrapErrorMessage err
339− (ErrorInExpression _ err) -> unwrapErrorMessage err
340− (ErrorInForeignImport _ err) -> unwrapErrorMessage err
341− (ErrorInInstance _ _ err) -> unwrapErrorMessage err
342− (ErrorInModule _ err) -> unwrapErrorMessage err
343− (ErrorInSubsumption _ _ err) -> unwrapErrorMessage err
344− (ErrorInTypeConstructor _ err) -> unwrapErrorMessage err
345− (ErrorInTypeSynonym _ err) -> unwrapErrorMessage err
346− (ErrorInValueDeclaration _ err) -> unwrapErrorMessage err
347− (ErrorInTypeDeclaration _ err) -> unwrapErrorMessage err
348− (ErrorInferringType _ err) -> unwrapErrorMessage err
349− (ErrorUnifyingTypes _ _ err) -> unwrapErrorMessage err
350− (NotYetDefined _ err) -> unwrapErrorMessage err
351− (PositionedError _ err) -> unwrapErrorMessage err
352− (SimpleErrorWrapper sem) -> sem
354replaceUnknowns :: Type -> State UnknownMap Type
345replaceUnknowns :: Type -> State UnknownMap Type
355replaceUnknowns = everywhereOnTypesM replaceTypes
346replaceUnknowns = everywhereOnTypesM replaceTypes
@@ -365,7 +356,7 @@ replaceUnknowns = everywhereOnTypesM replaceTypes
365 replaceTypes other = return other
356 replaceTypes other = return other
367onTypesInErrorMessageM :: (Applicative m) => (Type -> m Type) -> ErrorMessage -> m ErrorMessage
358onTypesInErrorMessageM :: (Applicative m) => (Type -> m Type) -> ErrorMessage -> m ErrorMessage
368−onTypesInErrorMessageM f = g
359+onTypesInErrorMessageM f (ErrorMessage hints simple) = ErrorMessage <$> traverse gHint hints <*> gSimple simple
370 gSimple (InfiniteType t) = InfiniteType <$> f t
361 gSimple (InfiniteType t) = InfiniteType <$> f t
371 gSimple (TypesDoNotUnify t1 t2) = TypesDoNotUnify <$> f t1 <*> f t2
362 gSimple (TypesDoNotUnify t1 t2) = TypesDoNotUnify <$> f t1 <*> f t2
@@ -375,396 +366,396 @@ onTypesInErrorMessageM f = g
375 gSimple (CannotApplyFunction t e) = CannotApplyFunction <$> f t <*> pure e
366 gSimple (CannotApplyFunction t e) = CannotApplyFunction <$> f t <*> pure e
376 gSimple (InvalidInstanceHead t) = InvalidInstanceHead <$> f t
367 gSimple (InvalidInstanceHead t) = InvalidInstanceHead <$> f t
377 gSimple other = pure other
368 gSimple other = pure other
378− g (ErrorInSubsumption t1 t2 em) = ErrorInSubsumption <$> f t1 <*> f t2 <*> g em
369+ gHint (ErrorInSubsumption t1 t2) = ErrorInSubsumption <$> f t1 <*> f t2
379− g (ErrorUnifyingTypes t1 t2 e) = ErrorUnifyingTypes <$> f t1 <*> f t2 <*> g e
370+ gHint (ErrorUnifyingTypes t1 t2) = ErrorUnifyingTypes <$> f t1 <*> f t2
380− g (ErrorCheckingType e t em) = ErrorCheckingType e <$> f t <*> g em
371+ gHint (ErrorCheckingType e t) = ErrorCheckingType e <$> f t
381− g (ErrorCheckingKind t em) = ErrorCheckingKind <$> f t <*> g em
372+ gHint (ErrorCheckingKind t) = ErrorCheckingKind <$> f t
382− g (ErrorInApplication e1 t1 e2 em) = ErrorInApplication e1 <$> f t1 <*> pure e2 <*> g em
373+ gHint (ErrorInApplication e1 t1 e2) = ErrorInApplication e1 <$> f t1 <*> pure e2
383− g (NotYetDefined x e) = NotYetDefined x <$> g e
374+ gHint other = pure other
384− g (ErrorInExpression x e) = ErrorInExpression x <$> g e
385− g (ErrorInModule x e) = ErrorInModule x <$> g e
386− g (ErrorInInstance x y e) = ErrorInInstance x y <$> g e
387− g (ErrorInferringType x e) = ErrorInferringType x <$> g e
388− g (ErrorInDataConstructor x e) = ErrorInDataConstructor x <$> g e
389− g (ErrorInTypeConstructor x e) = ErrorInTypeConstructor x <$> g e
390− g (ErrorInBindingGroup x e) = ErrorInBindingGroup x <$> g e
391− g (ErrorInDataBindingGroup e) = ErrorInDataBindingGroup <$> g e
392− g (ErrorInTypeSynonym x e) = ErrorInTypeSynonym x <$> g e
393− g (ErrorInValueDeclaration x e) = ErrorInValueDeclaration x <$> g e
394− g (ErrorInTypeDeclaration x e) = ErrorInTypeDeclaration x <$> g e
395− g (ErrorInForeignImport x e) = ErrorInForeignImport x <$> g e
396− g (PositionedError x e) = PositionedError x <$> g e
397− g (SimpleErrorWrapper sem) = SimpleErrorWrapper <$> gSimple sem
400-- Pretty print a single error, simplifying if necessary
377-- Pretty print a single error, simplifying if necessary
402prettyPrintSingleError :: Bool -> Level -> ErrorMessage -> State UnknownMap Box.Box
379prettyPrintSingleError :: Bool -> Level -> ErrorMessage -> State UnknownMap Box.Box
403−prettyPrintSingleError full level e = prettyPrintErrorMessage <$> onTypesInErrorMessageM replaceUnknowns (if full then e else simplifyErrorMessage e)
380+prettyPrintSingleError full level e = prettyPrintErrorMessage . positionHintsFirst . reverseHints <$> onTypesInErrorMessageM replaceUnknowns (if full then e else simplifyErrorMessage e)
406 -- Pretty print an ErrorMessage
383 -- Pretty print an ErrorMessage
408 prettyPrintErrorMessage :: ErrorMessage -> Box.Box
384 prettyPrintErrorMessage :: ErrorMessage -> Box.Box
409− prettyPrintErrorMessage em =
385+ prettyPrintErrorMessage (ErrorMessage hints simple) =
387+ map renderHint hints ++
388+ renderSimpleErrorMessage simple :
411− go em:suggestions em ++
389+ suggestions simple ++
412 [line $ "See " ++ wikiUri ++ " for more information, or to contribute content related to this " ++ levelText ++ "."]
390 [line $ "See " ++ wikiUri ++ " for more information, or to contribute content related to this " ++ levelText ++ "."]
414 wikiUri :: String
392 wikiUri :: String
415 wikiUri = "https://github.com/purescript/purescript/wiki/Error-Code-" ++ errorCode e
393 wikiUri = "https://github.com/purescript/purescript/wiki/Error-Code-" ++ errorCode e
417− go :: ErrorMessage -> Box.Box
395+ renderSimpleErrorMessage :: SimpleErrorMessage -> Box.Box
418− goSimple (CannotGetFileInfo path) =
396+ renderSimpleErrorMessage (CannotGetFileInfo path) =
419 paras [ line "Unable to read file info: "
397 paras [ line "Unable to read file info: "
420 , indent . line $ path
398 , indent . line $ path
422− goSimple (CannotReadFile path) =
400+ renderSimpleErrorMessage (CannotReadFile path) =
423 paras [ line "Unable to read file: "
401 paras [ line "Unable to read file: "
424 , indent . line $ path
402 , indent . line $ path
426− goSimple (CannotWriteFile path) =
404+ renderSimpleErrorMessage (CannotWriteFile path) =
427 paras [ line "Unable to write file: "
405 paras [ line "Unable to write file: "
428 , indent . line $ path
406 , indent . line $ path
430− goSimple (ErrorParsingExterns err) =
408+ renderSimpleErrorMessage (ErrorParsingExterns err) =
431 paras [ lineWithLevel "parsing externs files: "
409 paras [ lineWithLevel "parsing externs files: "
432− , indent . prettyPrintParseError $ err
410+ , prettyPrintParseError err
434− goSimple (ErrorParsingFFIModule path) =
412+ renderSimpleErrorMessage (ErrorParsingFFIModule path) =
435 paras [ line "Unable to parse module from FFI file: "
413 paras [ line "Unable to parse module from FFI file: "
436 , indent . line $ path
414 , indent . line $ path
438− goSimple (ErrorParsingModule err) =
416+ renderSimpleErrorMessage (ErrorParsingModule err) =
439 paras [ line "Unable to parse module: "
417 paras [ line "Unable to parse module: "
440− , indent . prettyPrintParseError $ err
418+ , prettyPrintParseError err
442− goSimple (MissingFFIModule mn) =
420+ renderSimpleErrorMessage (MissingFFIModule mn) =
443 line $ "Missing FFI implementations for module " ++ runModuleName mn
421 line $ "Missing FFI implementations for module " ++ runModuleName mn
444− goSimple (UnnecessaryFFIModule mn path) =
422+ renderSimpleErrorMessage (UnnecessaryFFIModule mn path) =
445 paras [ line $ "Unnecessary FFI implementations have been provided for module " ++ runModuleName mn ++ ": "
423 paras [ line $ "Unnecessary FFI implementations have been provided for module " ++ runModuleName mn ++ ": "
446 , indent . line $ path
424 , indent . line $ path
448− goSimple (MultipleFFIModules mn paths) =
426+ renderSimpleErrorMessage (MultipleFFIModules mn paths) =
449− paras $ [ line $ "Multiple FFI implementations have been provided for module " ++ runModuleName mn ++ ": " ]
427+ paras [ line $ "Multiple FFI implementations have been provided for module " ++ runModuleName mn ++ ": "
450− ++ map (indent . line) paths
428+ , indent . paras $ map line paths
451− goSimple (InvalidExternsFile path) =
430+ renderSimpleErrorMessage (InvalidExternsFile path) =
452 paras [ line "Externs file is invalid: "
431 paras [ line "Externs file is invalid: "
453 , indent . line $ path
432 , indent . line $ path
455− goSimple InvalidDoBind =
434+ renderSimpleErrorMessage InvalidDoBind =
456 line "Bind statement cannot be the last statement in a do block. The last statement must be an expression."
435 line "Bind statement cannot be the last statement in a do block. The last statement must be an expression."
457− goSimple InvalidDoLet =
436+ renderSimpleErrorMessage InvalidDoLet =
458 line "Let statement cannot be the last statement in a do block. The last statement must be an expression."
437 line "Let statement cannot be the last statement in a do block. The last statement must be an expression."
459− goSimple CannotReorderOperators =
438+ renderSimpleErrorMessage CannotReorderOperators =
460 line "Unable to reorder operators"
439 line "Unable to reorder operators"
461− goSimple UnspecifiedSkolemScope =
440+ renderSimpleErrorMessage UnspecifiedSkolemScope =
462 line "Skolem variable scope is unspecified"
441 line "Skolem variable scope is unspecified"
463− goSimple OverlappingNamesInLet =
442+ renderSimpleErrorMessage OverlappingNamesInLet =
464 line "Overlapping names in let binding."
443 line "Overlapping names in let binding."
465− goSimple (InfiniteType ty) =
444+ renderSimpleErrorMessage (InfiniteType ty) =
466 paras [ line "An infinite type was inferred for an expression: "
445 paras [ line "An infinite type was inferred for an expression: "
467− , indent $ line $ prettyPrintType ty
446+ , indent $ typeAsBox ty
469− goSimple (InfiniteKind ki) =
448+ renderSimpleErrorMessage (InfiniteKind ki) =
470 paras [ line "An infinite kind was inferred for a type: "
449 paras [ line "An infinite kind was inferred for a type: "
471− , indent $ line $ prettyPrintKind ki
450+ , indent $ kindAsBox ki
473− goSimple (MultipleFixities name) =
452+ renderSimpleErrorMessage (MultipleFixities name) =
474 line $ "Multiple fixity declarations for " ++ showIdent name
453 line $ "Multiple fixity declarations for " ++ showIdent name
475− goSimple (OrphanTypeDeclaration nm) =
454+ renderSimpleErrorMessage (OrphanTypeDeclaration nm) =
476 line $ "Orphan type declaration for " ++ showIdent nm
455 line $ "Orphan type declaration for " ++ showIdent nm
477− goSimple (OrphanFixityDeclaration op) =
456+ renderSimpleErrorMessage (OrphanFixityDeclaration op) =
478 line $ "Orphan fixity declaration for " ++ show op
457 line $ "Orphan fixity declaration for " ++ show op
479− goSimple (RedefinedModule name filenames) =
458+ renderSimpleErrorMessage (RedefinedModule name filenames) =
480− paras $ line ("Module " ++ runModuleName name ++ " has been defined multiple times:")
459+ paras [ line ("Module " ++ runModuleName name ++ " has been defined multiple times:")
481− : map (indent . line . displaySourceSpan) filenames
460+ , indent . paras $ map (line . displaySourceSpan) filenames
482− goSimple (RedefinedIdent name) =
462+ renderSimpleErrorMessage (RedefinedIdent name) =
483 line $ "Name " ++ showIdent name ++ " has been defined multiple times"
463 line $ "Name " ++ showIdent name ++ " has been defined multiple times"
484− goSimple (UnknownModule mn) =
464+ renderSimpleErrorMessage (UnknownModule mn) =
485 line $ "Unknown module " ++ runModuleName mn
465 line $ "Unknown module " ++ runModuleName mn
486− goSimple (UnknownType name) =
466+ renderSimpleErrorMessage (UnknownType name) =
487 line $ "Unknown type " ++ showQualified runProperName name
467 line $ "Unknown type " ++ showQualified runProperName name
488− goSimple (UnknownTypeClass name) =
468+ renderSimpleErrorMessage (UnknownTypeClass name) =
489 line $ "Unknown type class " ++ showQualified runProperName name
469 line $ "Unknown type class " ++ showQualified runProperName name
490− goSimple (UnknownValue name) =
470+ renderSimpleErrorMessage (UnknownValue name) =
491 line $ "Unknown value " ++ showQualified showIdent name
471 line $ "Unknown value " ++ showQualified showIdent name
492− goSimple (UnknownTypeConstructor name) =
472+ renderSimpleErrorMessage (UnknownTypeConstructor name) =
493 line $ "Unknown type constructor " ++ showQualified runProperName name
473 line $ "Unknown type constructor " ++ showQualified runProperName name
494− goSimple (UnknownDataConstructor dc tc) =
474+ renderSimpleErrorMessage (UnknownDataConstructor dc tc) =
495 line $ "Unknown data constructor " ++ showQualified runProperName dc ++ foldMap ((" for type constructor " ++) . showQualified runProperName) tc
475 line $ "Unknown data constructor " ++ showQualified runProperName dc ++ foldMap ((" for type constructor " ++) . showQualified runProperName) tc
496− goSimple (UnknownImportType mn name) =
476+ renderSimpleErrorMessage (UnknownImportType mn name) =
497 line $ "Module " ++ runModuleName mn ++ " does not export type " ++ runProperName name
477 line $ "Module " ++ runModuleName mn ++ " does not export type " ++ runProperName name
498− goSimple (UnknownExportType name) =
478+ renderSimpleErrorMessage (UnknownExportType name) =
499 line $ "Cannot export unknown type " ++ runProperName name
479 line $ "Cannot export unknown type " ++ runProperName name
500− goSimple (UnknownImportTypeClass mn name) =
480+ renderSimpleErrorMessage (UnknownImportTypeClass mn name) =
501 line $ "Module " ++ runModuleName mn ++ " does not export type class " ++ runProperName name
481 line $ "Module " ++ runModuleName mn ++ " does not export type class " ++ runProperName name
502− goSimple (UnknownExportTypeClass name) =
482+ renderSimpleErrorMessage (UnknownExportTypeClass name) =
503 line $ "Cannot export unknown type class " ++ runProperName name
483 line $ "Cannot export unknown type class " ++ runProperName name
504− goSimple (UnknownImportValue mn name) =
484+ renderSimpleErrorMessage (UnknownImportValue mn name) =
505 line $ "Module " ++ runModuleName mn ++ " does not export value " ++ showIdent name
485 line $ "Module " ++ runModuleName mn ++ " does not export value " ++ showIdent name
506− goSimple (UnknownExportValue name) =
486+ renderSimpleErrorMessage (UnknownExportValue name) =
507 line $ "Cannot export unknown value " ++ showIdent name
487 line $ "Cannot export unknown value " ++ showIdent name
508− goSimple (UnknownExportModule name) =
488+ renderSimpleErrorMessage (UnknownExportModule name) =
509 line $ "Cannot export unknown module " ++ runModuleName name ++ ", it either does not exist or has not been imported by the current module"
489 line $ "Cannot export unknown module " ++ runModuleName name ++ ", it either does not exist or has not been imported by the current module"
510− goSimple (UnknownImportDataConstructor mn tcon dcon) =
490+ renderSimpleErrorMessage (UnknownImportDataConstructor mn tcon dcon) =
511 line $ "Module " ++ runModuleName mn ++ " does not export data constructor " ++ runProperName dcon ++ " for type " ++ runProperName tcon
491 line $ "Module " ++ runModuleName mn ++ " does not export data constructor " ++ runProperName dcon ++ " for type " ++ runProperName tcon
512− goSimple (UnknownExportDataConstructor tcon dcon) =
492+ renderSimpleErrorMessage (UnknownExportDataConstructor tcon dcon) =
513 line $ "Cannot export data constructor " ++ runProperName dcon ++ " for type " ++ runProperName tcon ++ " as it has not been declared"
493 line $ "Cannot export data constructor " ++ runProperName dcon ++ " for type " ++ runProperName tcon ++ " as it has not been declared"
514− goSimple (ConflictingImport nm mn) =
494+ renderSimpleErrorMessage (ConflictingImport nm mn) =
515 line $ "Cannot declare " ++ show nm ++ " since another declaration of that name was imported from " ++ runModuleName mn
495 line $ "Cannot declare " ++ show nm ++ " since another declaration of that name was imported from " ++ runModuleName mn
516− goSimple (ConflictingImports nm m1 m2) =
496+ renderSimpleErrorMessage (ConflictingImports nm m1 m2) =
517 line $ "Conflicting imports for " ++ nm ++ " from modules " ++ runModuleName m1 ++ " and " ++ runModuleName m2
497 line $ "Conflicting imports for " ++ nm ++ " from modules " ++ runModuleName m1 ++ " and " ++ runModuleName m2
518− goSimple (ConflictingTypeDecls nm) =
498+ renderSimpleErrorMessage (ConflictingTypeDecls nm) =
519 line $ "Conflicting type declarations for " ++ runProperName nm
499 line $ "Conflicting type declarations for " ++ runProperName nm
520− goSimple (ConflictingCtorDecls nm) =
500+ renderSimpleErrorMessage (ConflictingCtorDecls nm) =
521 line $ "Conflicting data constructor declarations for " ++ runProperName nm
501 line $ "Conflicting data constructor declarations for " ++ runProperName nm
522− goSimple (TypeConflictsWithClass nm) =
502+ renderSimpleErrorMessage (TypeConflictsWithClass nm) =
523 line $ "Type " ++ runProperName nm ++ " conflicts with type class declaration of the same name"
503 line $ "Type " ++ runProperName nm ++ " conflicts with type class declaration of the same name"
524− goSimple (CtorConflictsWithClass nm) =
504+ renderSimpleErrorMessage (CtorConflictsWithClass nm) =
525 line $ "Data constructor " ++ runProperName nm ++ " conflicts with type class declaration of the same name"
505 line $ "Data constructor " ++ runProperName nm ++ " conflicts with type class declaration of the same name"
526− goSimple (ClassConflictsWithType nm) =
506+ renderSimpleErrorMessage (ClassConflictsWithType nm) =
527 line $ "Type class " ++ runProperName nm ++ " conflicts with type declaration of the same name"
507 line $ "Type class " ++ runProperName nm ++ " conflicts with type declaration of the same name"
528− goSimple (ClassConflictsWithCtor nm) =
508+ renderSimpleErrorMessage (ClassConflictsWithCtor nm) =
529 line $ "Type class " ++ runProperName nm ++ " conflicts with data constructor declaration of the same name"
509 line $ "Type class " ++ runProperName nm ++ " conflicts with data constructor declaration of the same name"
530− goSimple (DuplicateModuleName mn) =
510+ renderSimpleErrorMessage (DuplicateModuleName mn) =
531 line $ "Module " ++ runModuleName mn ++ " has been defined multiple times."
511 line $ "Module " ++ runModuleName mn ++ " has been defined multiple times."
532− goSimple (DuplicateClassExport nm) =
512+ renderSimpleErrorMessage (DuplicateClassExport nm) =
533 line $ "Duplicate export declaration for type class " ++ runProperName nm
513 line $ "Duplicate export declaration for type class " ++ runProperName nm
534− goSimple (DuplicateValueExport nm) =
514+ renderSimpleErrorMessage (DuplicateValueExport nm) =
535 line $ "Duplicate export declaration for value " ++ showIdent nm
515 line $ "Duplicate export declaration for value " ++ showIdent nm
536− goSimple (CycleInDeclaration nm) =
516+ renderSimpleErrorMessage (CycleInDeclaration nm) =
537 line $ "Cycle in declaration of " ++ showIdent nm
517 line $ "Cycle in declaration of " ++ showIdent nm
538− goSimple (CycleInModules mns) =
518+ renderSimpleErrorMessage (CycleInModules mns) =
539 line $ "Cycle in module dependencies: " ++ intercalate ", " (map runModuleName mns)
519 line $ "Cycle in module dependencies: " ++ intercalate ", " (map runModuleName mns)
540− goSimple (CycleInTypeSynonym pn) =
520+ renderSimpleErrorMessage (CycleInTypeSynonym pn) =
541 line $ "Cycle in type synonym" ++ foldMap ((" " ++) . runProperName) pn
521 line $ "Cycle in type synonym" ++ foldMap ((" " ++) . runProperName) pn
542− goSimple (NameIsUndefined ident) =
522+ renderSimpleErrorMessage (NameIsUndefined ident) =
543 line $ showIdent ident ++ " is undefined"
523 line $ showIdent ident ++ " is undefined"
544− goSimple (NameNotInScope ident) =
524+ renderSimpleErrorMessage (NameNotInScope ident) =
545 line $ showIdent ident ++ " may not be defined in the current scope"
525 line $ showIdent ident ++ " may not be defined in the current scope"
546− goSimple (UndefinedTypeVariable name) =
526+ renderSimpleErrorMessage (UndefinedTypeVariable name) =
547 line $ "Type variable " ++ runProperName name ++ " is undefined"
527 line $ "Type variable " ++ runProperName name ++ " is undefined"
548− goSimple (PartiallyAppliedSynonym name) =
528+ renderSimpleErrorMessage (PartiallyAppliedSynonym name) =
549 paras [ line $ "Partially applied type synonym " ++ showQualified runProperName name
529 paras [ line $ "Partially applied type synonym " ++ showQualified runProperName name
550 , line "Type synonyms must be applied to all of their type arguments."
530 , line "Type synonyms must be applied to all of their type arguments."
552− goSimple (EscapedSkolem binding) =
532+ renderSimpleErrorMessage (EscapedSkolem binding) =
553 paras $ [ line "A type variable has escaped its scope." ]
533 paras $ [ line "A type variable has escaped its scope." ]
554 <> foldMap (\expr -> [ line "Relevant expression: "
534 <> foldMap (\expr -> [ line "Relevant expression: "
555− , indent $ line $ prettyPrintValue expr
535+ , indent $ prettyPrintValue expr
556 ]) binding
536 ]) binding
557− goSimple (TypesDoNotUnify t1 t2)
537+ renderSimpleErrorMessage (TypesDoNotUnify t1 t2)
558 = paras [ line "Cannot unify type"
538 = paras [ line "Cannot unify type"
559− , indent $ line $ prettyPrintType t1
539+ , indent $ typeAsBox t1
560 , line "with type"
540 , line "with type"
561− , indent $ line $ prettyPrintType t2
541+ , indent $ typeAsBox t2
563− goSimple (KindsDoNotUnify k1 k2) =
543+ renderSimpleErrorMessage (KindsDoNotUnify k1 k2) =
564 paras [ line "Cannot unify kind"
544 paras [ line "Cannot unify kind"
565− , indent $ line $ prettyPrintKind k1
545+ , indent $ kindAsBox k1
566 , line "with kind"
546 , line "with kind"
567− , indent $ line $ prettyPrintKind k2
547+ , indent $ kindAsBox k2
569− goSimple (ConstrainedTypeUnified t1 t2) =
549+ renderSimpleErrorMessage (ConstrainedTypeUnified t1 t2) =
570 paras [ line "Cannot unify constrained type"
550 paras [ line "Cannot unify constrained type"
571− , indent $ line $ prettyPrintType t1
551+ , indent $ typeAsBox t1
572 , line "with type"
552 , line "with type"
573− , indent $ line $ prettyPrintType t2
553+ , indent $ typeAsBox t2
575− goSimple (OverlappingInstances nm ts (d : ds)) =
555+ renderSimpleErrorMessage (OverlappingInstances nm ts (d : ds)) =
576− paras [ line $ "Overlapping instances found for " ++ showQualified runProperName nm ++ " " ++ unwords (map prettyPrintTypeAtom ts) ++ ":"
556+ paras [ line "Overlapping instances found for"
557+ , indent $ Box.hsep 1 Box.left [ line (showQualified runProperName nm)
558+ , Box.vcat Box.left (map typeAtomAsBox ts)
560+ , line "The following instances were found:"
577 , indent $ paras (line (showQualified showIdent d ++ " (chosen)") : map (line . showQualified showIdent) ds)
561 , indent $ paras (line (showQualified showIdent d ++ " (chosen)") : map (line . showQualified showIdent) ds)
579− goSimple OverlappingInstances{} = error "OverlappingInstances: empty instance list"
563+ renderSimpleErrorMessage OverlappingInstances{} = error "OverlappingInstances: empty instance list"
580− goSimple (NoInstanceFound nm ts) =
564+ renderSimpleErrorMessage (NoInstanceFound nm ts) =
581− line $ "No instance found for " ++ showQualified runProperName nm ++ " " ++ unwords (map prettyPrintTypeAtom ts)
565+ paras [ line "No instance found for"
566+ , indent $ Box.hsep 1 Box.left [ line (showQualified runProperName nm)
567+ , Box.vcat Box.left (map typeAtomAsBox ts)
582− goSimple (PossiblyInfiniteInstance nm ts) =
570+ renderSimpleErrorMessage (PossiblyInfiniteInstance nm ts) =
583− line $ "Instance for " ++ showQualified runProperName nm ++ " " ++ unwords (map prettyPrintTypeAtom ts) ++ " is possibly infinite."
571+ paras [ line "Instance for"
572+ , indent $ Box.hsep 1 Box.left [ line (showQualified runProperName nm)
573+ , Box.vcat Box.left (map typeAtomAsBox ts)
575+ , line "is possibly infinite."
584− goSimple (CannotDerive nm ts) =
577+ renderSimpleErrorMessage (CannotDerive nm ts) =
585− line $ "Cannot derive " ++ showQualified runProperName nm ++ " instance for " ++ unwords (map prettyPrintTypeAtom ts)
578+ paras [ line "Cannot derive an instance for"
579+ , indent $ Box.hsep 1 Box.left [ line (showQualified runProperName nm)
580+ , Box.vcat Box.left (map typeAtomAsBox ts)
586− goSimple (CannotFindDerivingType nm) =
583+ renderSimpleErrorMessage (CannotFindDerivingType nm) =
587 line $ "Cannot derive instance, because the type declaration for " ++ runProperName nm ++ " could not be found."
584 line $ "Cannot derive instance, because the type declaration for " ++ runProperName nm ++ " could not be found."
588− goSimple (DuplicateLabel l expr) =
585+ renderSimpleErrorMessage (DuplicateLabel l expr) =
589 paras $ [ line $ "Duplicate label " ++ show l ++ " in row." ]
586 paras $ [ line $ "Duplicate label " ++ show l ++ " in row." ]
590 <> foldMap (\expr' -> [ line "Relevant expression: "
587 <> foldMap (\expr' -> [ line "Relevant expression: "
591− , indent $ line $ prettyPrintValue expr'
588+ , indent $ prettyPrintValue expr'
593− goSimple (DuplicateTypeArgument name) =
590+ renderSimpleErrorMessage (DuplicateTypeArgument name) =
594 line $ "Duplicate type argument " ++ show name
591 line $ "Duplicate type argument " ++ show name
595− goSimple (DuplicateValueDeclaration nm) =
592+ renderSimpleErrorMessage (DuplicateValueDeclaration nm) =
596 line $ "Duplicate value declaration for " ++ showIdent nm
593 line $ "Duplicate value declaration for " ++ showIdent nm
597− goSimple (ArgListLengthsDiffer ident) =
594+ renderSimpleErrorMessage (ArgListLengthsDiffer ident) =
598 line $ "Argument list lengths differ in declaration " ++ showIdent ident
595 line $ "Argument list lengths differ in declaration " ++ showIdent ident
599− goSimple (OverlappingArgNames ident) =
596+ renderSimpleErrorMessage (OverlappingArgNames ident) =
600 line $ "Overlapping names in function/binder" ++ foldMap ((" in declaration" ++) . showIdent) ident
597 line $ "Overlapping names in function/binder" ++ foldMap ((" in declaration" ++) . showIdent) ident
601− goSimple (MissingClassMember ident) =
598+ renderSimpleErrorMessage (MissingClassMember ident) =
602 line $ "Member " ++ showIdent ident ++ " has not been implemented"
599 line $ "Member " ++ showIdent ident ++ " has not been implemented"
603− goSimple (ExtraneousClassMember ident) =
600+ renderSimpleErrorMessage (ExtraneousClassMember ident) =
604 line $ "Member " ++ showIdent ident ++ " is not a member of the class being instantiated"
601 line $ "Member " ++ showIdent ident ++ " is not a member of the class being instantiated"
605− goSimple (ExpectedType ty kind) =
602+ renderSimpleErrorMessage (ExpectedType ty kind) =
606 paras [ line "In a type-annotated expression x :: t, the type t must have kind *."
603 paras [ line "In a type-annotated expression x :: t, the type t must have kind *."
607− , line $ "The error arises from the type " ++ prettyPrintType ty ++ " having the kind " ++ prettyPrintKind kind ++ " instead."
604+ , line "The error arises from the type"
605+ , indent $ typeAsBox ty
606+ , line "having the kind"
607+ , indent $ kindAsBox kind
609− goSimple (IncorrectConstructorArity nm) =
610+ renderSimpleErrorMessage (IncorrectConstructorArity nm) =
610 line $ "Wrong number of arguments to constructor " ++ showQualified runProperName nm
611 line $ "Wrong number of arguments to constructor " ++ showQualified runProperName nm
611− goSimple SubsumptionCheckFailed = line "Unable to check type subsumption"
612+ renderSimpleErrorMessage SubsumptionCheckFailed = line "Unable to check type subsumption"
612− goSimple (ExprDoesNotHaveType expr ty) =
613+ renderSimpleErrorMessage (ExprDoesNotHaveType expr ty) =
613 paras [ line "Expression"
614 paras [ line "Expression"
614− , indent $ line $ prettyPrintValue expr
615+ , indent $ prettyPrintValue expr
615 , line "does not have type"
616 , line "does not have type"
616− , indent $ line $ prettyPrintType ty
617+ , indent $ typeAsBox ty
618− goSimple (PropertyIsMissing prop row) =
619+ renderSimpleErrorMessage (PropertyIsMissing prop row) =
621+ , indent $ prettyPrintRowWith '(' ')' row
619− line $ "Row " ++ prettyPrintRow row ++ " lacks required property " ++ show prop
622+ , line $ "lacks required property " ++ show prop
620− goSimple (CannotApplyFunction fn arg) =
624+ renderSimpleErrorMessage (CannotApplyFunction fn arg) =
621 paras [ line "Cannot apply function of type"
625 paras [ line "Cannot apply function of type"
622− , indent $ line $ prettyPrintType fn
626+ , indent $ typeAsBox fn
623 , line "to argument"
627 , line "to argument"
624− , indent $ line $ prettyPrintValue arg
628+ , indent $ prettyPrintValue arg
626− goSimple TypeSynonymInstance =
630+ renderSimpleErrorMessage TypeSynonymInstance =
627 line "Type synonym instances are disallowed"
631 line "Type synonym instances are disallowed"
628− goSimple (OrphanInstance nm cnm ts) =
632+ renderSimpleErrorMessage (OrphanInstance nm cnm ts) =
629− paras [ line $ "Instance " ++ showIdent nm ++ " for " ++ showQualified runProperName cnm ++ " " ++ unwords (map prettyPrintTypeAtom ts) ++ " is an orphan instance."
633+ paras [ line $ "Instance " ++ showIdent nm ++ " for "
634+ , indent $ Box.hsep 1 Box.left [ line (showQualified runProperName cnm)
635+ , Box.vcat Box.left (map typeAtomAsBox ts)
637+ , line "is an orphan instance."
630 , line "An orphan instance is an instance which is defined in neither the class module nor the data type module."
638 , line "An orphan instance is an instance which is defined in neither the class module nor the data type module."
631 , line "Consider moving the instance, if possible, or using a newtype wrapper."
639 , line "Consider moving the instance, if possible, or using a newtype wrapper."
633− goSimple InvalidNewtype =
641+ renderSimpleErrorMessage InvalidNewtype =
634 line "Newtypes must define a single constructor with a single argument"
642 line "Newtypes must define a single constructor with a single argument"
635− goSimple (InvalidInstanceHead ty) =
643+ renderSimpleErrorMessage (InvalidInstanceHead ty) =
636 paras [ line "Invalid type in class instance head:"
644 paras [ line "Invalid type in class instance head:"
637− , indent $ line $ prettyPrintType ty
645+ , indent $ typeAsBox ty
639− goSimple (TransitiveExportError x ys) =
647+ renderSimpleErrorMessage (TransitiveExportError x ys) =
640 paras $ line ("An export for " ++ prettyPrintExport x ++ " requires the following to also be exported: ")
648 paras $ line ("An export for " ++ prettyPrintExport x ++ " requires the following to also be exported: ")
641 : map (line . prettyPrintExport) ys
649 : map (line . prettyPrintExport) ys
642− goSimple (ShadowedName nm) =
650+ renderSimpleErrorMessage (ShadowedName nm) =
643 line $ "Name '" ++ showIdent nm ++ "' was shadowed"
651 line $ "Name '" ++ showIdent nm ++ "' was shadowed"
644− goSimple (ShadowedTypeVar tv) =
652+ renderSimpleErrorMessage (ShadowedTypeVar tv) =
645 line $ "Type variable '" ++ tv ++ "' was shadowed"
653 line $ "Type variable '" ++ tv ++ "' was shadowed"
646− goSimple (UnusedTypeVar tv) =
654+ renderSimpleErrorMessage (UnusedTypeVar tv) =
647 line $ "Type variable '" ++ tv ++ "' was declared but not used"
655 line $ "Type variable '" ++ tv ++ "' was declared but not used"
648− goSimple (ClassOperator className opName) =
656+ renderSimpleErrorMessage (ClassOperator className opName) =
649 paras [ line $ "Class '" ++ runProperName className ++ "' declares operator " ++ showIdent opName ++ "."
657 paras [ line $ "Class '" ++ runProperName className ++ "' declares operator " ++ showIdent opName ++ "."
650− , indent $ line "This may be disallowed in the future - consider declaring a named member in the class and making the operator an alias:"
658+ , line "This may be disallowed in the future - consider declaring a named member in the class and making the operator an alias:"
651− , indent $ line $ showIdent opName ++ " = someMember"
659+ , indent . line $ showIdent opName ++ " = someMember"
653− goSimple (MisleadingEmptyTypeImport mn name) =
661+ renderSimpleErrorMessage (MisleadingEmptyTypeImport mn name) =
654 line $ "Importing type " ++ runProperName name ++ "(..) from " ++ runModuleName mn ++ " is misleading as it has no exported data constructors"
662 line $ "Importing type " ++ runProperName name ++ "(..) from " ++ runModuleName mn ++ " is misleading as it has no exported data constructors"
655− goSimple (ImportHidingModule name) =
663+ renderSimpleErrorMessage (ImportHidingModule name) =
656 line $ "Attempted to hide module " ++ runModuleName name ++ " in import expression, this is not permitted"
664 line $ "Attempted to hide module " ++ runModuleName name ++ " in import expression, this is not permitted"
657− goSimple (WildcardInferredType ty) =
665+ renderSimpleErrorMessage (WildcardInferredType ty) =
658− line $ "The wildcard type definition has the inferred type " ++ prettyPrintType ty
666+ paras [ line "The wildcard type definition has the inferred type "
667+ , indent $ typeAsBox ty
669+ renderSimpleErrorMessage (MissingTypeDeclaration ident) =
670+ paras [ line $ "No type declaration was provided for the top-level declaration of " ++ showIdent ident ++ "."
671+ , line "It is good practice to provide type declarations as a form of documentation."
672+ , line "Consider using a type wildcard to display the inferred type:"
673+ , indent $ line $ showIdent ident ++ " :: _"
659− goSimple (NotExhaustivePattern bs b) =
675+ renderSimpleErrorMessage (NotExhaustivePattern bs b) =
660 paras $ [ line "A case expression could not be determined to cover all inputs."
676 paras $ [ line "A case expression could not be determined to cover all inputs."
661 , line "The following additional cases are required to cover all inputs:\n"
677 , line "The following additional cases are required to cover all inputs:\n"
662 , Box.hsep 1 Box.left (map (paras . map (line . prettyPrintBinderAtom)) (transpose bs))
678 , Box.hsep 1 Box.left (map (paras . map (line . prettyPrintBinderAtom)) (transpose bs))
664 [ line "..." | not b ]
680 [ line "..." | not b ]
665− goSimple (OverlappingPattern bs b) =
681+ renderSimpleErrorMessage (OverlappingPattern bs b) =
666 paras $ [ line "A case expression contains unreachable cases:\n"
682 paras $ [ line "A case expression contains unreachable cases:\n"
667 , Box.hsep 1 Box.left (map (paras . map (line . prettyPrintBinderAtom)) (transpose bs))
683 , Box.hsep 1 Box.left (map (paras . map (line . prettyPrintBinderAtom)) (transpose bs))
669 [ line "..." | not b ]
685 [ line "..." | not b ]
670− goSimple IncompleteExhaustivityCheck =
686+ renderSimpleErrorMessage IncompleteExhaustivityCheck =
671 paras [ line "An exhaustivity check was abandoned due to too many possible cases."
687 paras [ line "An exhaustivity check was abandoned due to too many possible cases."
672 , line "You may want to decomposing your data types into smaller types."
688 , line "You may want to decomposing your data types into smaller types."
691+ renderHint :: ErrorMessageHint -> Box.Box
674− go (NotYetDefined names err) =
692+ renderHint (NotYetDefined names) =
675− paras [ line $ "The following are not yet defined here: " ++ intercalate ", " (map showIdent names) ++ ":"
693+ line $ "The following are not yet defined here: " ++ intercalate ", " (map showIdent names) ++ ":"
678− go (ErrorUnifyingTypes t1 t2 err) =
694+ renderHint (ErrorUnifyingTypes t1 t2) =
679 paras [ lineWithLevel "unifying type "
695 paras [ lineWithLevel "unifying type "
680− , indent $ line $ prettyPrintType t1
696+ , indent $ typeAsBox t1
681 , line "with type"
697 , line "with type"
682− , indent $ line $ prettyPrintType t2
698+ , indent $ typeAsBox t2
685− go (ErrorInExpression expr err) =
700+ renderHint (ErrorInExpression expr) =
686 paras [ lineWithLevel "in expression:"
701 paras [ lineWithLevel "in expression:"
687− , indent $ line $ prettyPrintValue expr
702+ , indent $ prettyPrintValue expr
690− go (ErrorInModule mn err) =
704+ renderHint (ErrorInModule mn) =
691 paras [ lineWithLevel $ "in module " ++ runModuleName mn ++ ":"
705 paras [ lineWithLevel $ "in module " ++ runModuleName mn ++ ":"
694− go (ErrorInSubsumption t1 t2 err) =
707+ renderHint (ErrorInSubsumption t1 t2) =
695 paras [ lineWithLevel "checking that type "
708 paras [ lineWithLevel "checking that type "
696− , indent $ line $ prettyPrintType t1
709+ , indent $ typeAsBox t1
697 , line "subsumes type"
710 , line "subsumes type"
698− , indent $ line $ prettyPrintType t2
711+ , indent $ typeAsBox t2
701− go (ErrorInInstance name ts err) =
713+ renderHint (ErrorInInstance nm ts) =
702− paras [ lineWithLevel $ "in type class instance " ++ showQualified runProperName name ++ " " ++ unwords (map prettyPrintTypeAtom ts) ++ ":"
714+ paras [ lineWithLevel "in type class instance"
703− , go err
715+ , indent $ Box.hsep 1 Box.left [ line (showQualified runProperName nm)
716+ , Box.vcat Box.left (map typeAtomAsBox ts)
705− go (ErrorCheckingKind ty err) =
719+ renderHint (ErrorCheckingKind ty) =
706 paras [ lineWithLevel "checking kind of type "
720 paras [ lineWithLevel "checking kind of type "
707− , indent $ line $ prettyPrintType ty
721+ , indent $ typeAsBox ty
710− go (ErrorInferringType expr err) =
723+ renderHint (ErrorInferringType expr) =
711 paras [ lineWithLevel "inferring type of value "
724 paras [ lineWithLevel "inferring type of value "
712− , indent $ line $ prettyPrintValue expr
725+ , indent $ prettyPrintValue expr
715− go (ErrorCheckingType expr ty err) =
727+ renderHint (ErrorCheckingType expr ty) =
716 paras [ lineWithLevel "checking that value "
728 paras [ lineWithLevel "checking that value "
717− , indent $ line $ prettyPrintValue expr
729+ , indent $ prettyPrintValue expr
718 , line "has type"
730 , line "has type"
719− , indent $ line $ prettyPrintType ty
731+ , indent $ typeAsBox ty
722− go (ErrorInApplication f t a err) =
733+ renderHint (ErrorInApplication f t a) =
723 paras [ lineWithLevel "applying function"
734 paras [ lineWithLevel "applying function"
724− , indent $ line $ prettyPrintValue f
735+ , indent $ prettyPrintValue f
725 , line "of type"
736 , line "of type"
726− , indent $ line $ prettyPrintType t
737+ , indent $ typeAsBox t
727 , line "to argument"
738 , line "to argument"
728− , indent $ line $ prettyPrintValue a
739+ , indent $ prettyPrintValue a
731− go (ErrorInDataConstructor nm err) =
741+ renderHint (ErrorInDataConstructor nm) =
732− paras [ lineWithLevel $ "in data constructor " ++ runProperName nm ++ ":"
742+ lineWithLevel $ "in data constructor " ++ runProperName nm ++ ":"
735− go (ErrorInTypeConstructor nm err) =
743+ renderHint (ErrorInTypeConstructor nm) =
736− paras [ lineWithLevel $ "in type constructor " ++ runProperName nm ++ ":"
744+ lineWithLevel $ "in type constructor " ++ runProperName nm ++ ":"
739− go (ErrorInBindingGroup nms err) =
745+ renderHint (ErrorInBindingGroup nms) =
740− paras [ lineWithLevel $ "in binding group " ++ intercalate ", " (map showIdent nms) ++ ":"
746+ lineWithLevel $ "in binding group " ++ intercalate ", " (map showIdent nms) ++ ":"
743− go (ErrorInDataBindingGroup err) =
747+ renderHint ErrorInDataBindingGroup =
744− paras [ lineWithLevel "in data binding group:"
748+ lineWithLevel "in data binding group:"
747− go (ErrorInTypeSynonym name err) =
749+ renderHint (ErrorInTypeSynonym name) =
748− paras [ lineWithLevel $ "in type synonym " ++ runProperName name ++ ":"
750+ lineWithLevel $ "in type synonym " ++ runProperName name ++ ":"
751− go (ErrorInValueDeclaration n err) =
751+ renderHint (ErrorInValueDeclaration n) =
752− paras [ lineWithLevel $ "in value declaration " ++ showIdent n ++ ":"
752+ lineWithLevel $ "in value declaration " ++ showIdent n ++ ":"
755− go (ErrorInTypeDeclaration n err) =
753+ renderHint (ErrorInTypeDeclaration n) =
756− paras [ lineWithLevel $ "in type declaration for " ++ showIdent n ++ ":"
754+ lineWithLevel $ "in type declaration for " ++ showIdent n ++ ":"
759− go (ErrorInForeignImport nm err) =
755+ renderHint (ErrorInForeignImport nm) =
760− paras [ lineWithLevel $ "in foreign import " ++ showIdent nm ++ ":"
756+ lineWithLevel $ "in foreign import " ++ showIdent nm ++ ":"
763− go (PositionedError srcSpan err) =
757+ renderHint (PositionedError srcSpan) =
764− paras [ lineWithLevel $ "at " ++ displaySourceSpan srcSpan ++ ":"
758+ lineWithLevel $ "at " ++ displaySourceSpan srcSpan ++ ":"
767− go (SimpleErrorWrapper sem) = goSimple sem
769 lineWithLevel :: String -> Box.Box
760 lineWithLevel :: String -> Box.Box
770 lineWithLevel text = line $ show level ++ " " ++ text
761 lineWithLevel text = line $ show level ++ " " ++ text
@@ -774,23 +765,19 @@ prettyPrintSingleError full level e = prettyPrintErrorMessage <$> onTypesInError
774 Error -> "error"
765 Error -> "error"
775 Warning -> "warning"
766 Warning -> "warning"
777− suggestions :: ErrorMessage -> [Box.Box]
768+ suggestions :: SimpleErrorMessage -> [Box.Box]
778− suggestions = suggestions' . unwrapErrorMessage
780− suggestions' (ConflictingImport nm im) = [ line $ "Possible fix: hide " ++ show nm ++ " when importing " ++ runModuleName im ++ ":"
769+ suggestions (ConflictingImport nm im) = [ line $ "Possible fix: hide " ++ show nm ++ " when importing " ++ runModuleName im ++ ":"
781 , indent . line $ "import " ++ runModuleName im ++ " hiding (" ++ nm ++ ")"
770 , indent . line $ "import " ++ runModuleName im ++ " hiding (" ++ nm ++ ")"
783− suggestions' (TypesDoNotUnify t1 t2)
772+ suggestions (TypesDoNotUnify t1 t2)
784− | isObject t1 && isFunction t2 = [line "Note that function composition in PureScript is defined using (<<<)"]
773+ | isObject t1 && isFunction t2 = [line "Note that function composition in PureScript is defined using (<<<)"]
785− | otherwise = []
774+ | otherwise = []
786− suggestions' _ = []
775+ suggestions _ = []
788 paras :: [Box.Box] -> Box.Box
777 paras :: [Box.Box] -> Box.Box
789 paras = Box.vcat Box.left
778 paras = Box.vcat Box.left
792 -- Pretty print and export declaration
780 -- Pretty print and export declaration
794 prettyPrintExport :: DeclarationRef -> String
781 prettyPrintExport :: DeclarationRef -> String
795 prettyPrintExport (TypeRef pn _) = runProperName pn
782 prettyPrintExport (TypeRef pn _) = runProperName pn
796 prettyPrintExport (ValueRef ident) = showIdent ident
783 prettyPrintExport (ValueRef ident) = showIdent ident
@@ -799,38 +786,44 @@ prettyPrintSingleError full level e = prettyPrintErrorMessage <$> onTypesInError
799 prettyPrintExport (ModuleRef name) = "module " ++ runModuleName name
786 prettyPrintExport (ModuleRef name) = "module " ++ runModuleName name
800 prettyPrintExport (PositionedDeclarationRef _ _ ref) = prettyPrintExport ref
787 prettyPrintExport (PositionedDeclarationRef _ _ ref) = prettyPrintExport ref
802− -- |
789+ -- Hints get added at the front, so we need to reverse them before rendering
803− -- Simplify an error message
790+ reverseHints :: ErrorMessage -> ErrorMessage
804− --
791+ reverseHints (ErrorMessage hints simple) = ErrorMessage (reverse hints) simple
793+ -- | Put positional hints at the front of the list
805− simplifyErrorMessage :: ErrorMessage -> ErrorMessage
794+ positionHintsFirst :: ErrorMessage -> ErrorMessage
806− simplifyErrorMessage = unwrap Nothing
795+ positionHintsFirst (ErrorMessage hints simple) = ErrorMessage (uncurry (++) $ partition (isPositionHint . hintCategory) hints) simple
808− unwrap :: Maybe SourceSpan -> ErrorMessage -> ErrorMessage
797+ isPositionHint :: HintCategory -> Bool
809− unwrap pos (ErrorInExpression _ err) = unwrap pos err
798+ isPositionHint PositionHint = True
810− unwrap pos (ErrorInInstance name ts err) = ErrorInInstance name ts (unwrap pos err)
799+ isPositionHint OtherHint = True
811− unwrap pos (ErrorInSubsumption t1 t2 err) = ErrorInSubsumption t1 t2 (unwrap pos err)
800+ isPositionHint _ = False
812− unwrap pos (ErrorUnifyingTypes _ _ err) = unwrap pos err
813− unwrap pos (ErrorInferringType _ err) = unwrap pos err
814− unwrap pos (ErrorCheckingType _ _ err) = unwrap pos err
815− unwrap pos (ErrorCheckingKind ty err) = ErrorCheckingKind ty (unwrap pos err)
816− unwrap pos (ErrorInModule mn err) = ErrorInModule mn (unwrap pos err)
817− unwrap pos (ErrorInApplication _ _ _ err) = unwrap pos err
818− unwrap pos (ErrorInDataConstructor nm err) = ErrorInDataConstructor nm (unwrap pos err)
819− unwrap pos (ErrorInTypeConstructor nm err) = ErrorInTypeConstructor nm (unwrap pos err)
820− unwrap pos (ErrorInBindingGroup nms err) = ErrorInBindingGroup nms (unwrap pos err)
821− unwrap pos (ErrorInDataBindingGroup err) = ErrorInDataBindingGroup (unwrap pos err)
822− unwrap pos (ErrorInTypeSynonym nm err) = ErrorInTypeSynonym nm (unwrap pos err)
823− unwrap pos (ErrorInValueDeclaration nm err) = ErrorInValueDeclaration nm (unwrap pos err)
824− unwrap pos (ErrorInTypeDeclaration nm err) = ErrorInTypeDeclaration nm (unwrap pos err)
825− unwrap pos (ErrorInForeignImport nm err) = ErrorInForeignImport nm (unwrap pos err)
826− unwrap pos (NotYetDefined ns err) = NotYetDefined ns (unwrap pos err)
827− unwrap _ (PositionedError pos err) = unwrap (Just pos) err
828− unwrap pos other = wrap pos other
830− wrap :: Maybe SourceSpan -> ErrorMessage -> ErrorMessage
832− wrap (Just pos) = PositionedError pos
802+ -- | Simplify an error message
803+ simplifyErrorMessage :: ErrorMessage -> ErrorMessage
804+ simplifyErrorMessage (ErrorMessage hints simple) = ErrorMessage (simplifyHints hints) simple
806+ -- Take the last instance of each "hint category"
807+ simplifyHints :: [ErrorMessageHint] -> [ErrorMessageHint]
808+ simplifyHints = reverse . nubBy categoriesEqual . reverse
810+ -- Don't remove hints in the "other" category
811+ categoriesEqual :: ErrorMessageHint -> ErrorMessageHint -> Bool
812+ categoriesEqual x y =
813+ case (hintCategory x, hintCategory y) of
814+ (OtherHint, _) -> False
815+ (_, OtherHint) -> False
816+ (c1, c2) -> c1 == c2
818+ hintCategory :: ErrorMessageHint -> HintCategory
819+ hintCategory ErrorCheckingType{} = ExprHint
820+ hintCategory ErrorInferringType{} = ExprHint
821+ hintCategory ErrorInExpression{} = ExprHint
822+ hintCategory ErrorUnifyingTypes{} = CheckHint
823+ hintCategory ErrorInSubsumption{} = CheckHint
824+ hintCategory ErrorInApplication{} = CheckHint
825+ hintCategory PositionedError{} = PositionHint
826+ hintCategory _ = OtherHint
836-- Pretty print multiple errors
829-- Pretty print multiple errors
@@ -846,11 +839,11 @@ prettyPrintMultipleWarnings full = renderBox . prettyPrintMultipleWarningsBox fu
847-- | Pretty print warnings as a Box
840-- | Pretty print warnings as a Box
848prettyPrintMultipleWarningsBox :: Bool -> MultipleErrors -> Box.Box
841prettyPrintMultipleWarningsBox :: Bool -> MultipleErrors -> Box.Box
849−prettyPrintMultipleWarningsBox full = flip evalState M.empty . prettyPrintMultipleErrorsWith Warning "Warning found:" "Multiple warnings found:" full
842+prettyPrintMultipleWarningsBox full = flip evalState M.empty . prettyPrintMultipleErrorsWith Warning "Warning found:" "Warning" full
851-- | Pretty print errors as a Box
844-- | Pretty print errors as a Box
852prettyPrintMultipleErrorsBox :: Bool -> MultipleErrors -> Box.Box
845prettyPrintMultipleErrorsBox :: Bool -> MultipleErrors -> Box.Box
853−prettyPrintMultipleErrorsBox full = flip evalState M.empty . prettyPrintMultipleErrorsWith Error "Error found:" "Multiple errors found:" full
846+prettyPrintMultipleErrorsBox full = flip evalState M.empty . prettyPrintMultipleErrorsWith Error "Error found:" "Error" full
855prettyPrintMultipleErrorsWith :: Level -> String -> String -> Bool -> MultipleErrors -> State UnknownMap Box.Box
848prettyPrintMultipleErrorsWith :: Level -> String -> String -> Bool -> MultipleErrors -> State UnknownMap Box.Box
856prettyPrintMultipleErrorsWith level intro _ full (MultipleErrors [e]) = do
849prettyPrintMultipleErrorsWith level intro _ full (MultipleErrors [e]) = do
@@ -860,11 +853,12 @@ prettyPrintMultipleErrorsWith level intro _ full (MultipleErrors [e]) = do
862prettyPrintMultipleErrorsWith level _ intro full (MultipleErrors es) = do
855prettyPrintMultipleErrorsWith level _ intro full (MultipleErrors es) = do
863− result <- forM es $ liftM (Box.moveRight 2) . prettyPrintSingleError full level
856+ result <- forM es $ prettyPrintSingleError full level
864− return $
857+ return $ Box.vsep 1 Box.left $ concat $ zipWith withIntro [1 :: Int ..] result
865− Box.vcat Box.left [ Box.text intro
858+ where
866− , Box.vsep 1 Box.left result
859+ withIntro i err = [ Box.text (intro ++ " " ++ show i ++ " of " ++ show (length es) ++ ":")
860+ , Box.moveRight 2 err
869-- | Pretty print a Parsec ParseError as a Box
863-- | Pretty print a Parsec ParseError as a Box
870prettyPrintParseError :: P.ParseError -> Box.Box
864prettyPrintParseError :: P.ParseError -> Box.Box
@@ -914,8 +908,9 @@ prettyPrintParseErrorMessages msgOr msgUnknown msgExpecting msgUnExpected msgEnd
915 clean = nub . filter (not . null)
909 clean = nub . filter (not . null)
911+-- | Indent to the right, and pad on top and bottom.
917indent :: Box.Box -> Box.Box
912indent :: Box.Box -> Box.Box
918−indent = Box.moveRight 2
913+indent = Box.moveUp 1 . Box.moveDown 1 . Box.moveRight 2
920line :: String -> Box.Box
915line :: String -> Box.Box
921line = Box.text
916line = Box.text
@@ -955,8 +950,7 @@ warnAndRethrowWithPosition :: (MonadError MultipleErrors m, MonadWriter Multiple
955warnAndRethrowWithPosition pos = rethrowWithPosition pos . warnWithPosition pos
950warnAndRethrowWithPosition pos = rethrowWithPosition pos . warnWithPosition pos
957withPosition :: SourceSpan -> ErrorMessage -> ErrorMessage
952withPosition :: SourceSpan -> ErrorMessage -> ErrorMessage
958−withPosition _ (PositionedError pos err) = withPosition pos err
953+withPosition pos (ErrorMessage hints se) = ErrorMessage (PositionedError pos : hints) se
959−withPosition pos err = PositionedError pos err
962-- Collect errors in in parallel
956-- Collect errors in in parallel