forked from purescript/purescript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathErrors.hs
More file actions
1341 lines (1223 loc) · 64.6 KB
/
Errors.hs
File metadata and controls
1341 lines (1223 loc) · 64.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE NamedFieldPuns #-}
module Language.PureScript.Errors
( module Language.PureScript.AST
, module Language.PureScript.Errors
) where
import Prelude.Compat
import Control.Arrow ((&&&))
import Control.Monad
import Control.Monad.Error.Class (MonadError(..))
import Control.Monad.Trans.State.Lazy
import Control.Monad.Writer
import Data.Char (isSpace)
import Data.Either (lefts, rights)
import Data.Foldable (fold)
import Data.Functor.Identity (Identity(..))
import Data.List (transpose, nub, nubBy, sortBy, partition)
import Data.Maybe (maybeToList, fromMaybe, mapMaybe)
import Data.Ord (comparing)
import Data.String (fromString)
import qualified Data.Map as M
import qualified Data.Text as T
import Data.Text (Text)
import Language.PureScript.AST
import qualified Language.PureScript.Bundle as Bundle
import qualified Language.PureScript.Constants as C
import Language.PureScript.Crash
import Language.PureScript.Environment
import Language.PureScript.Label (Label(..))
import Language.PureScript.Names
import Language.PureScript.Pretty
import Language.PureScript.Pretty.Common (endWith)
import Language.PureScript.PSString (PSString, decodeStringWithReplacement)
import Language.PureScript.Traversals
import Language.PureScript.Types
import qualified Language.PureScript.Publish.BoxesHelpers as BoxHelpers
import qualified System.Console.ANSI as ANSI
import qualified Text.Parsec as P
import qualified Text.Parsec.Error as PE
import Text.Parsec.Error (Message(..))
import qualified Text.PrettyPrint.Boxes as Box
newtype ErrorSuggestion = ErrorSuggestion Text
-- | Get the source span for an error
errorSpan :: ErrorMessage -> Maybe SourceSpan
errorSpan = findHint matchSpan
where
matchSpan (PositionedError ss) = Just ss
matchSpan _ = Nothing
-- | Get the module name for an error
errorModule :: ErrorMessage -> Maybe ModuleName
errorModule = findHint matchModule
where
matchModule (ErrorInModule mn) = Just mn
matchModule _ = Nothing
findHint :: (ErrorMessageHint -> Maybe a) -> ErrorMessage -> Maybe a
findHint f (ErrorMessage hints _) = getLast . foldMap (Last . f) $ hints
-- | Remove the module name and span hints from an error
stripModuleAndSpan :: ErrorMessage -> ErrorMessage
stripModuleAndSpan (ErrorMessage hints e) = ErrorMessage (filter (not . shouldStrip) hints) e
where
shouldStrip (ErrorInModule _) = True
shouldStrip (PositionedError _) = True
shouldStrip _ = False
-- | Get the error code for a particular error type
errorCode :: ErrorMessage -> Text
errorCode em = case unwrapErrorMessage em of
ModuleNotFound{} -> "ModuleNotFound"
ErrorParsingFFIModule{} -> "ErrorParsingFFIModule"
ErrorParsingModule{} -> "ErrorParsingModule"
MissingFFIModule{} -> "MissingFFIModule"
MultipleFFIModules{} -> "MultipleFFIModules"
UnnecessaryFFIModule{} -> "UnnecessaryFFIModule"
MissingFFIImplementations{} -> "MissingFFIImplementations"
UnusedFFIImplementations{} -> "UnusedFFIImplementations"
InvalidFFIIdentifier{} -> "InvalidFFIIdentifier"
CannotGetFileInfo{} -> "CannotGetFileInfo"
CannotReadFile{} -> "CannotReadFile"
CannotWriteFile{} -> "CannotWriteFile"
InfiniteType{} -> "InfiniteType"
InfiniteKind{} -> "InfiniteKind"
MultipleValueOpFixities{} -> "MultipleValueOpFixities"
MultipleTypeOpFixities{} -> "MultipleTypeOpFixities"
OrphanTypeDeclaration{} -> "OrphanTypeDeclaration"
RedefinedIdent{} -> "RedefinedIdent"
OverlappingNamesInLet -> "OverlappingNamesInLet"
UnknownName{} -> "UnknownName"
UnknownImport{} -> "UnknownImport"
UnknownImportDataConstructor{} -> "UnknownImportDataConstructor"
UnknownExport{} -> "UnknownExport"
UnknownExportDataConstructor{} -> "UnknownExportDataConstructor"
ScopeConflict{} -> "ScopeConflict"
ScopeShadowing{} -> "ScopeShadowing"
DeclConflict{} -> "DeclConflict"
ExportConflict{} -> "ExportConflict"
DuplicateModule{} -> "DuplicateModule"
DuplicateTypeArgument{} -> "DuplicateTypeArgument"
InvalidDoBind -> "InvalidDoBind"
InvalidDoLet -> "InvalidDoLet"
CycleInDeclaration{} -> "CycleInDeclaration"
CycleInTypeSynonym{} -> "CycleInTypeSynonym"
CycleInModules{} -> "CycleInModules"
NameIsUndefined{} -> "NameIsUndefined"
UndefinedTypeVariable{} -> "UndefinedTypeVariable"
PartiallyAppliedSynonym{} -> "PartiallyAppliedSynonym"
EscapedSkolem{} -> "EscapedSkolem"
TypesDoNotUnify{} -> "TypesDoNotUnify"
KindsDoNotUnify{} -> "KindsDoNotUnify"
ConstrainedTypeUnified{} -> "ConstrainedTypeUnified"
OverlappingInstances{} -> "OverlappingInstances"
NoInstanceFound{} -> "NoInstanceFound"
AmbiguousTypeVariables{} -> "AmbiguousTypeVariables"
UnknownClass{} -> "UnknownClass"
PossiblyInfiniteInstance{} -> "PossiblyInfiniteInstance"
CannotDerive{} -> "CannotDerive"
InvalidNewtypeInstance{} -> "InvalidNewtypeInstance"
CannotFindDerivingType{} -> "CannotFindDerivingType"
DuplicateLabel{} -> "DuplicateLabel"
DuplicateValueDeclaration{} -> "DuplicateValueDeclaration"
ArgListLengthsDiffer{} -> "ArgListLengthsDiffer"
OverlappingArgNames{} -> "OverlappingArgNames"
MissingClassMember{} -> "MissingClassMember"
ExtraneousClassMember{} -> "ExtraneousClassMember"
ExpectedType{} -> "ExpectedType"
IncorrectConstructorArity{} -> "IncorrectConstructorArity"
ExprDoesNotHaveType{} -> "ExprDoesNotHaveType"
PropertyIsMissing{} -> "PropertyIsMissing"
AdditionalProperty{} -> "AdditionalProperty"
TypeSynonymInstance -> "TypeSynonymInstance"
OrphanInstance{} -> "OrphanInstance"
InvalidNewtype{} -> "InvalidNewtype"
InvalidInstanceHead{} -> "InvalidInstanceHead"
TransitiveExportError{} -> "TransitiveExportError"
TransitiveDctorExportError{} -> "TransitiveDctorExportError"
ShadowedName{} -> "ShadowedName"
ShadowedTypeVar{} -> "ShadowedTypeVar"
UnusedTypeVar{} -> "UnusedTypeVar"
WildcardInferredType{} -> "WildcardInferredType"
HoleInferredType{} -> "HoleInferredType"
MissingTypeDeclaration{} -> "MissingTypeDeclaration"
OverlappingPattern{} -> "OverlappingPattern"
IncompleteExhaustivityCheck{} -> "IncompleteExhaustivityCheck"
MisleadingEmptyTypeImport{} -> "MisleadingEmptyTypeImport"
ImportHidingModule{} -> "ImportHidingModule"
UnusedImport{} -> "UnusedImport"
UnusedExplicitImport{} -> "UnusedExplicitImport"
UnusedDctorImport{} -> "UnusedDctorImport"
UnusedDctorExplicitImport{} -> "UnusedDctorExplicitImport"
DuplicateSelectiveImport{} -> "DuplicateSelectiveImport"
DuplicateImport{} -> "DuplicateImport"
DuplicateImportRef{} -> "DuplicateImportRef"
DuplicateExportRef{} -> "DuplicateExportRef"
IntOutOfRange{} -> "IntOutOfRange"
ImplicitQualifiedImport{} -> "ImplicitQualifiedImport"
ImplicitImport{} -> "ImplicitImport"
HidingImport{} -> "HidingImport"
CaseBinderLengthDiffers{} -> "CaseBinderLengthDiffers"
IncorrectAnonymousArgument -> "IncorrectAnonymousArgument"
InvalidOperatorInBinder{} -> "InvalidOperatorInBinder"
CannotGeneralizeRecursiveFunction{} -> "CannotGeneralizeRecursiveFunction"
CannotDeriveNewtypeForData{} -> "CannotDeriveNewtypeForData"
ExpectedWildcard{} -> "ExpectedWildcard"
CannotUseBindWithDo{} -> "CannotUseBindWithDo"
ClassInstanceArityMismatch{} -> "ClassInstanceArityMismatch"
UserDefinedWarning{} -> "UserDefinedWarning"
UnusableDeclaration{} -> "UnusableDeclaration"
-- | A stack trace for an error
newtype MultipleErrors = MultipleErrors
{ runMultipleErrors :: [ErrorMessage]
} deriving (Show, Monoid)
-- | Check whether a collection of errors is empty or not.
nonEmpty :: MultipleErrors -> Bool
nonEmpty = not . null . runMultipleErrors
-- | Create an error set from a single simple error message
errorMessage :: SimpleErrorMessage -> MultipleErrors
errorMessage err = MultipleErrors [ErrorMessage [] err]
-- | Create an error set from a single error message
singleError :: ErrorMessage -> MultipleErrors
singleError = MultipleErrors . pure
-- | Lift a function on ErrorMessage to a function on MultipleErrors
onErrorMessages :: (ErrorMessage -> ErrorMessage) -> MultipleErrors -> MultipleErrors
onErrorMessages f = MultipleErrors . map f . runMultipleErrors
-- | Add a hint to an error message
addHint :: ErrorMessageHint -> MultipleErrors -> MultipleErrors
addHint hint = addHints [hint]
-- | Add hints to an error message
addHints :: [ErrorMessageHint] -> MultipleErrors -> MultipleErrors
addHints hints = onErrorMessages $ \(ErrorMessage hints' se) -> ErrorMessage (hints ++ hints') se
-- | A map from rigid type variable name/unknown variable pairs to new variables.
data TypeMap = TypeMap
{ umSkolemMap :: M.Map Int (String, Int, Maybe SourceSpan)
-- ^ a map from skolems to their new names, including source and naming info
, umUnknownMap :: M.Map Int Int
-- ^ a map from unification variables to their new names
, umNextIndex :: Int
-- ^ unknowns and skolems share a source of names during renaming, to
-- avoid overlaps in error messages. This is the next label for either case.
} deriving Show
defaultUnknownMap :: TypeMap
defaultUnknownMap = TypeMap M.empty M.empty 0
-- | How critical the issue is
data Level = Error | Warning deriving Show
-- | Extract nested error messages from wrapper errors
unwrapErrorMessage :: ErrorMessage -> SimpleErrorMessage
unwrapErrorMessage (ErrorMessage _ se) = se
replaceUnknowns :: Type -> State TypeMap Type
replaceUnknowns = everywhereOnTypesM replaceTypes where
replaceTypes :: Type -> State TypeMap Type
replaceTypes (TUnknown u) = do
m <- get
case M.lookup u (umUnknownMap m) of
Nothing -> do
let u' = umNextIndex m
put $ m { umUnknownMap = M.insert u u' (umUnknownMap m), umNextIndex = u' + 1 }
return (TUnknown u')
Just u' -> return (TUnknown u')
replaceTypes (Skolem name s sko ss) = do
m <- get
case M.lookup s (umSkolemMap m) of
Nothing -> do
let s' = umNextIndex m
put $ m { umSkolemMap = M.insert s (T.unpack name, s', ss) (umSkolemMap m), umNextIndex = s' + 1 }
return (Skolem name s' sko ss)
Just (_, s', _) -> return (Skolem name s' sko ss)
replaceTypes other = return other
onTypesInErrorMessage :: (Type -> Type) -> ErrorMessage -> ErrorMessage
onTypesInErrorMessage f = runIdentity . onTypesInErrorMessageM (Identity . f)
onTypesInErrorMessageM :: Applicative m => (Type -> m Type) -> ErrorMessage -> m ErrorMessage
onTypesInErrorMessageM f (ErrorMessage hints simple) = ErrorMessage <$> traverse gHint hints <*> gSimple simple
where
gSimple (InfiniteType t) = InfiniteType <$> f t
gSimple (TypesDoNotUnify t1 t2) = TypesDoNotUnify <$> f t1 <*> f t2
gSimple (ConstrainedTypeUnified t1 t2) = ConstrainedTypeUnified <$> f t1 <*> f t2
gSimple (ExprDoesNotHaveType e t) = ExprDoesNotHaveType e <$> f t
gSimple (InvalidInstanceHead t) = InvalidInstanceHead <$> f t
gSimple (NoInstanceFound con) = NoInstanceFound <$> overConstraintArgs (traverse f) con
gSimple (AmbiguousTypeVariables t con) = AmbiguousTypeVariables <$> f t <*> pure con
gSimple (OverlappingInstances cl ts insts) = OverlappingInstances cl <$> traverse f ts <*> pure insts
gSimple (PossiblyInfiniteInstance cl ts) = PossiblyInfiniteInstance cl <$> traverse f ts
gSimple (CannotDerive cl ts) = CannotDerive cl <$> traverse f ts
gSimple (InvalidNewtypeInstance cl ts) = InvalidNewtypeInstance cl <$> traverse f ts
gSimple (ExpectedType ty k) = ExpectedType <$> f ty <*> pure k
gSimple (OrphanInstance nm cl ts) = OrphanInstance nm cl <$> traverse f ts
gSimple (WildcardInferredType ty ctx) = WildcardInferredType <$> f ty <*> traverse (sndM f) ctx
gSimple (HoleInferredType name ty ctx env) = HoleInferredType name <$> f ty <*> traverse (sndM f) ctx <*> gTypeSearch env
gSimple (MissingTypeDeclaration nm ty) = MissingTypeDeclaration nm <$> f ty
gSimple (CannotGeneralizeRecursiveFunction nm ty) = CannotGeneralizeRecursiveFunction nm <$> f ty
gSimple other = pure other
gHint (ErrorInSubsumption t1 t2) = ErrorInSubsumption <$> f t1 <*> f t2
gHint (ErrorUnifyingTypes t1 t2) = ErrorUnifyingTypes <$> f t1 <*> f t2
gHint (ErrorCheckingType e t) = ErrorCheckingType e <$> f t
gHint (ErrorCheckingKind t) = ErrorCheckingKind <$> f t
gHint (ErrorInApplication e1 t1 e2) = ErrorInApplication e1 <$> f t1 <*> pure e2
gHint (ErrorInInstance cl ts) = ErrorInInstance cl <$> traverse f ts
gHint (ErrorSolvingConstraint con) = ErrorSolvingConstraint <$> overConstraintArgs (traverse f) con
gHint other = pure other
gTypeSearch (TSBefore env) = pure (TSBefore env)
gTypeSearch (TSAfter result) = TSAfter <$> traverse (traverse f) result
errorDocUri :: ErrorMessage -> Text
errorDocUri e = "https://github.com/purescript/documentation/blob/master/errors/" <> errorCode e <> ".md"
-- TODO Other possible suggestions:
-- WildcardInferredType - source span not small enough
-- DuplicateSelectiveImport - would require 2 ranges to remove and 1 insert
errorSuggestion :: SimpleErrorMessage -> Maybe ErrorSuggestion
errorSuggestion err =
case err of
UnusedImport{} -> emptySuggestion
DuplicateImport{} -> emptySuggestion
UnusedExplicitImport mn _ qual refs -> suggest $ importSuggestion mn refs qual
UnusedDctorImport mn _ qual refs -> suggest $ importSuggestion mn refs qual
UnusedDctorExplicitImport mn _ _ qual refs -> suggest $ importSuggestion mn refs qual
ImplicitImport mn refs -> suggest $ importSuggestion mn refs Nothing
ImplicitQualifiedImport mn asModule refs -> suggest $ importSuggestion mn refs (Just asModule)
HidingImport mn refs -> suggest $ importSuggestion mn refs Nothing
MissingTypeDeclaration ident ty -> suggest $ showIdent ident <> " :: " <> T.pack (prettyPrintSuggestedType ty)
WildcardInferredType ty _ -> suggest $ T.pack (prettyPrintSuggestedType ty)
_ -> Nothing
where
emptySuggestion = Just $ ErrorSuggestion ""
suggest = Just . ErrorSuggestion
importSuggestion :: ModuleName -> [ DeclarationRef ] -> Maybe ModuleName -> Text
importSuggestion mn refs qual =
"import " <> runModuleName mn <> " (" <> T.intercalate ", " (mapMaybe prettyPrintRef refs) <> ")" <> qstr qual
qstr :: Maybe ModuleName -> Text
qstr (Just mn) = " as " <> runModuleName mn
qstr Nothing = ""
suggestionSpan :: ErrorMessage -> Maybe SourceSpan
suggestionSpan e =
getSpan (unwrapErrorMessage e) <$> errorSpan e
where
startOnly SourceSpan{spanName, spanStart} = SourceSpan {spanName, spanStart, spanEnd = spanStart}
getSpan simple ss =
case simple of
MissingTypeDeclaration{} -> startOnly ss
_ -> ss
showSuggestion :: SimpleErrorMessage -> Text
showSuggestion suggestion = case errorSuggestion suggestion of
Just (ErrorSuggestion x) -> x
_ -> ""
ansiColor :: (ANSI.ColorIntensity, ANSI.Color) -> String
ansiColor (intesity, color) =
ANSI.setSGRCode [ANSI.SetColor ANSI.Foreground intesity color]
ansiColorReset :: String
ansiColorReset =
ANSI.setSGRCode [ANSI.Reset]
colorCode :: Maybe (ANSI.ColorIntensity, ANSI.Color) -> Text -> Text
colorCode codeColor code = case codeColor of
Nothing -> code
Just cc -> T.pack (ansiColor cc) <> code <> T.pack ansiColorReset
colorCodeBox :: Maybe (ANSI.ColorIntensity, ANSI.Color) -> Box.Box -> Box.Box
colorCodeBox codeColor b = case codeColor of
Nothing -> b
Just cc
| Box.rows b == 1 ->
Box.text (ansiColor cc) Box.<> b `endWith` Box.text ansiColorReset
| otherwise -> Box.hcat Box.left -- making two boxes, one for each side of the box so that it will set each row it's own color and will reset it afterwards
[ Box.vcat Box.top $ replicate (Box.rows b) $ Box.text $ ansiColor cc
, b
, Box.vcat Box.top $ replicate (Box.rows b) $ Box.text ansiColorReset
]
-- | Default color intesity and color for code
defaultCodeColor :: (ANSI.ColorIntensity, ANSI.Color)
defaultCodeColor = (ANSI.Dull, ANSI.Yellow)
-- | `prettyPrintSingleError` Options
data PPEOptions = PPEOptions
{ ppeCodeColor :: Maybe (ANSI.ColorIntensity, ANSI.Color) -- ^ Color code with this color... or not
, ppeFull :: Bool -- ^ Should write a full error message?
, ppeLevel :: Level -- ^ Should this report an error or a warning?
, ppeShowDocs :: Bool -- ^ Should show a link to error message's doc page?
}
-- | Default options for PPEOptions
defaultPPEOptions :: PPEOptions
defaultPPEOptions = PPEOptions
{ ppeCodeColor = Just defaultCodeColor
, ppeFull = False
, ppeLevel = Error
, ppeShowDocs = True
}
-- | Pretty print a single error, simplifying if necessary
prettyPrintSingleError :: PPEOptions -> ErrorMessage -> Box.Box
prettyPrintSingleError (PPEOptions codeColor full level showDocs) e = flip evalState defaultUnknownMap $ do
em <- onTypesInErrorMessageM replaceUnknowns (if full then e else simplifyErrorMessage e)
um <- get
return (prettyPrintErrorMessage um em)
where
(markCode, markCodeBox) = (colorCode &&& colorCodeBox) codeColor
-- Pretty print an ErrorMessage
prettyPrintErrorMessage :: TypeMap -> ErrorMessage -> Box.Box
prettyPrintErrorMessage typeMap (ErrorMessage hints simple) =
paras $
[ foldr renderHint (indent (renderSimpleErrorMessage simple)) hints
] ++
maybe [] (return . Box.moveDown 1) typeInformation ++
[ Box.moveDown 1 $ paras
[ line $ "See " <> errorDocUri e <> " for more information, "
, line $ "or to contribute content related to this " <> levelText <> "."
]
| showDocs
]
where
typeInformation :: Maybe Box.Box
typeInformation | not (null types) = Just $ Box.hsep 1 Box.left [ line "where", paras types ]
| otherwise = Nothing
where
types :: [Box.Box]
types = map skolemInfo (M.elems (umSkolemMap typeMap)) ++
map unknownInfo (M.elems (umUnknownMap typeMap))
skolemInfo :: (String, Int, Maybe SourceSpan) -> Box.Box
skolemInfo (name, s, ss) =
paras $
line (markCode (T.pack (name <> show s)) <> " is a rigid type variable")
: foldMap (return . line . (" bound at " <>) . displayStartEndPos) ss
unknownInfo :: Int -> Box.Box
unknownInfo u = line $ markCode ("t" <> T.pack (show u)) <> " is an unknown type"
renderSimpleErrorMessage :: SimpleErrorMessage -> Box.Box
renderSimpleErrorMessage (ModuleNotFound mn) =
paras [ line $ "Module " <> markCode (runModuleName mn) <> " was not found."
, line "Make sure the source file exists, and that it has been provided as an input to psc."
]
renderSimpleErrorMessage (CannotGetFileInfo path) =
paras [ line "Unable to read file info: "
, indent . lineS $ path
]
renderSimpleErrorMessage (CannotReadFile path) =
paras [ line "Unable to read file: "
, indent . lineS $ path
]
renderSimpleErrorMessage (CannotWriteFile path) =
paras [ line "Unable to write file: "
, indent . lineS $ path
]
renderSimpleErrorMessage (ErrorParsingFFIModule path extra) =
paras $ [ line "Unable to parse foreign module:"
, indent . lineS $ path
] ++
map (indent . lineS) (concatMap Bundle.printErrorMessage (maybeToList extra))
renderSimpleErrorMessage (ErrorParsingModule err) =
paras [ line "Unable to parse module: "
, prettyPrintParseError err
]
renderSimpleErrorMessage (MissingFFIModule mn) =
line $ "The foreign module implementation for module " <> markCode (runModuleName mn) <> " is missing."
renderSimpleErrorMessage (UnnecessaryFFIModule mn path) =
paras [ line $ "An unnecessary foreign module implementation was provided for module " <> markCode (runModuleName mn) <> ": "
, indent . lineS $ path
, line $ "Module " <> markCode (runModuleName mn) <> " does not contain any foreign import declarations, so a foreign module is not necessary."
]
renderSimpleErrorMessage (MissingFFIImplementations mn idents) =
paras [ line $ "The following values are not defined in the foreign module for module " <> markCode (runModuleName mn) <> ": "
, indent . paras $ map (line . runIdent) idents
]
renderSimpleErrorMessage (UnusedFFIImplementations mn idents) =
paras [ line $ "The following definitions in the foreign module for module " <> markCode (runModuleName mn) <> " are unused: "
, indent . paras $ map (line . runIdent) idents
]
renderSimpleErrorMessage (InvalidFFIIdentifier mn ident) =
paras [ line $ "In the FFI module for " <> markCode (runModuleName mn) <> ":"
, indent . paras $
[ line $ "The identifier " <> markCode ident <> " is not valid in PureScript."
, line "Note that exported identifiers in FFI modules must be valid PureScript identifiers."
]
]
renderSimpleErrorMessage (MultipleFFIModules mn paths) =
paras [ line $ "Multiple foreign module implementations have been provided for module " <> markCode (runModuleName mn) <> ": "
, indent . paras $ map lineS paths
]
renderSimpleErrorMessage InvalidDoBind =
line "The last statement in a 'do' block must be an expression, but this block ends with a binder."
renderSimpleErrorMessage InvalidDoLet =
line "The last statement in a 'do' block must be an expression, but this block ends with a let binding."
renderSimpleErrorMessage OverlappingNamesInLet =
line "The same name was used more than once in a let binding."
renderSimpleErrorMessage (InfiniteType ty) =
paras [ line "An infinite type was inferred for an expression: "
, markCodeBox $ indent $ typeAsBox ty
]
renderSimpleErrorMessage (InfiniteKind ki) =
paras [ line "An infinite kind was inferred for a type: "
, indent $ line $ markCode $ prettyPrintKind ki
]
renderSimpleErrorMessage (MultipleValueOpFixities op) =
line $ "There are multiple fixity/precedence declarations for operator " <> markCode (showOp op)
renderSimpleErrorMessage (MultipleTypeOpFixities op) =
line $ "There are multiple fixity/precedence declarations for type operator " <> markCode (showOp op)
renderSimpleErrorMessage (OrphanTypeDeclaration nm) =
line $ "The type declaration for " <> markCode (showIdent nm) <> " should be followed by its definition."
renderSimpleErrorMessage (RedefinedIdent name) =
line $ "The value " <> markCode (showIdent name) <> " has been defined multiple times"
renderSimpleErrorMessage (UnknownName name@(Qualified Nothing (IdentName (Ident "bind")))) =
line $ "Unknown " <> printName name <> ". You're probably using do-notation, which the compiler replaces with calls to the " <> markCode "bind" <> " function. Please import " <> markCode "bind" <> " from module " <> markCode "Prelude"
renderSimpleErrorMessage (UnknownName name) =
line $ "Unknown " <> printName name
renderSimpleErrorMessage (UnknownImport mn name) =
paras [ line $ "Cannot import " <> printName (Qualified Nothing name) <> " from module " <> markCode (runModuleName mn)
, line "It either does not exist or the module does not export it."
]
renderSimpleErrorMessage (UnknownImportDataConstructor mn tcon dcon) =
line $ "Module " <> runModuleName mn <> " does not export data constructor " <> markCode (runProperName dcon) <> " for type " <> markCode (runProperName tcon)
renderSimpleErrorMessage (UnknownExport name) =
line $ "Cannot export unknown " <> printName (Qualified Nothing name)
renderSimpleErrorMessage (UnknownExportDataConstructor tcon dcon) =
line $ "Cannot export data constructor " <> markCode (runProperName dcon) <> " for type " <> markCode (runProperName tcon) <> ", as it has not been declared."
renderSimpleErrorMessage (ScopeConflict nm ms) =
paras [ line $ "Conflicting definitions are in scope for " <> printName (Qualified Nothing nm) <> " from the following modules:"
, indent $ paras $ map (line . markCode . runModuleName) ms
]
renderSimpleErrorMessage (ScopeShadowing nm exmn ms) =
paras [ line $ "Shadowed definitions are in scope for " <> printName (Qualified Nothing nm) <> " from the following open imports:"
, indent $ paras $ map (line . markCode . ("import " <>) . runModuleName) ms
, line $ "These will be ignored and the " <> case exmn of
Just exmn' -> "declaration from " <> markCode (runModuleName exmn') <> " will be used."
Nothing -> "local declaration will be used."
]
renderSimpleErrorMessage (DeclConflict new existing) =
line $ "Declaration for " <> printName (Qualified Nothing new) <> " conflicts with an existing " <> nameType existing <> " of the same name."
renderSimpleErrorMessage (ExportConflict new existing) =
line $ "Export for " <> printName new <> " conflicts with " <> runName existing
renderSimpleErrorMessage (DuplicateModule mn ss) =
paras [ line ("Module " <> markCode (runModuleName mn) <> " has been defined multiple times:")
, indent . paras $ map (line . displaySourceSpan) ss
]
renderSimpleErrorMessage (CycleInDeclaration nm) =
line $ "The value of " <> markCode (showIdent nm) <> " is undefined here, so this reference is not allowed."
renderSimpleErrorMessage (CycleInModules mns) =
paras [ line "There is a cycle in module dependencies in these modules: "
, indent $ paras (map (line . markCode . runModuleName) mns)
]
renderSimpleErrorMessage (CycleInTypeSynonym name) =
paras [ line $ case name of
Just pn -> "A cycle appears in the definition of type synonym " <> markCode (runProperName pn)
Nothing -> "A cycle appears in a set of type synonym definitions."
, line "Cycles are disallowed because they can lead to loops in the type checker."
, line "Consider using a 'newtype' instead."
]
renderSimpleErrorMessage (NameIsUndefined ident) =
line $ "Value " <> markCode (showIdent ident) <> " is undefined."
renderSimpleErrorMessage (UndefinedTypeVariable name) =
line $ "Type variable " <> markCode (runProperName name) <> " is undefined."
renderSimpleErrorMessage (PartiallyAppliedSynonym name) =
paras [ line $ "Type synonym " <> markCode (showQualified runProperName name) <> " is partially applied."
, line "Type synonyms must be applied to all of their type arguments."
]
renderSimpleErrorMessage (EscapedSkolem binding) =
paras $ [ line "A type variable has escaped its scope." ]
<> foldMap (\expr -> [ line "Relevant expression: "
, markCodeBox $ indent $ prettyPrintValue valueDepth expr
]) binding
renderSimpleErrorMessage (TypesDoNotUnify u1 u2)
= let (sorted1, sorted2) = sortRows u1 u2
sortRows :: Type -> Type -> (Type, Type)
sortRows r1@RCons{} r2@RCons{} = sortRows' (rowToList r1) (rowToList r2)
sortRows t1 t2 = (t1, t2)
-- Put the common labels last
sortRows' :: ([(Label, Type)], Type) -> ([(Label, Type)], Type) -> (Type, Type)
sortRows' (s1, r1) (s2, r2) =
let common :: [(Label, (Type, Type))]
common = sortBy (comparing fst) [ (name, (t1, t2)) | (name, t1) <- s1, (name', t2) <- s2, name == name' ]
sd1, sd2 :: [(Label, Type)]
sd1 = [ (name, t1) | (name, t1) <- s1, name `notElem` map fst s2 ]
sd2 = [ (name, t2) | (name, t2) <- s2, name `notElem` map fst s1 ]
in ( rowFromList (sortBy (comparing fst) sd1 ++ map (fst &&& fst . snd) common, r1)
, rowFromList (sortBy (comparing fst) sd2 ++ map (fst &&& snd . snd) common, r2)
)
in paras [ line "Could not match type"
, markCodeBox $ indent $ typeAsBox sorted1
, line "with type"
, markCodeBox $ indent $ typeAsBox sorted2
]
renderSimpleErrorMessage (KindsDoNotUnify k1 k2) =
paras [ line "Could not match kind"
, indent $ line $ markCode $ prettyPrintKind k1
, line "with kind"
, indent $ line $ markCode $ prettyPrintKind k2
]
renderSimpleErrorMessage (ConstrainedTypeUnified t1 t2) =
paras [ line "Could not match constrained type"
, markCodeBox $ indent $ typeAsBox t1
, line "with type"
, markCodeBox $ indent $ typeAsBox t2
]
renderSimpleErrorMessage (OverlappingInstances nm ts (d : ds)) =
paras [ line "Overlapping type class instances found for"
, markCodeBox $ indent $ Box.hsep 1 Box.left
[ line (showQualified runProperName nm)
, Box.vcat Box.left (map typeAtomAsBox ts)
]
, line "The following instances were found:"
, indent $ paras (line (showQualified showIdent d <> " (chosen)") : map (line . showQualified showIdent) ds)
, line "Overlapping type class instances can lead to different behavior based on the order of module imports, and for that reason are not recommended."
, line "They may be disallowed completely in a future version of the compiler."
]
renderSimpleErrorMessage OverlappingInstances{} = internalError "OverlappingInstances: empty instance list"
renderSimpleErrorMessage (UnknownClass nm) =
paras [ line "No type class instance was found for class"
, markCodeBox $ indent $ line (showQualified runProperName nm)
, line "because the class was not in scope. Perhaps it was not exported."
]
renderSimpleErrorMessage (NoInstanceFound (Constraint C.Fail [ ty ] _)) | Just box <- toTypelevelString ty =
paras [ line "A custom type error occurred while solving type class constraints:"
, indent box
]
renderSimpleErrorMessage (NoInstanceFound (Constraint C.Partial
_
(Just (PartialConstraintData bs b)))) =
paras [ line "A case expression could not be determined to cover all inputs."
, line "The following additional cases are required to cover all inputs:\n"
, indent $ paras $
Box.hsep 1 Box.left
(map (paras . map (line . markCode)) (transpose bs))
: [line "..." | not b]
, line "Alternatively, add a Partial constraint to the type of the enclosing value."
]
renderSimpleErrorMessage (NoInstanceFound (Constraint nm ts _)) =
paras [ line "No type class instance was found for"
, markCodeBox $ indent $ Box.hsep 1 Box.left
[ line (showQualified runProperName nm)
, Box.vcat Box.left (map typeAtomAsBox ts)
]
, paras [ line "The instance head contains unknown type variables. Consider adding a type annotation."
| any containsUnknowns ts
]
]
where
containsUnknowns :: Type -> Bool
containsUnknowns = everythingOnTypes (||) go
where
go TUnknown{} = True
go _ = False
renderSimpleErrorMessage (AmbiguousTypeVariables t _) =
paras [ line "The inferred type"
, markCodeBox $ indent $ typeAsBox t
, line "has type variables which are not mentioned in the body of the type. Consider adding a type annotation."
]
renderSimpleErrorMessage (PossiblyInfiniteInstance nm ts) =
paras [ line "Type class instance for"
, markCodeBox $ indent $ Box.hsep 1 Box.left
[ line (showQualified runProperName nm)
, Box.vcat Box.left (map typeAtomAsBox ts)
]
, line "is possibly infinite."
]
renderSimpleErrorMessage (CannotDerive nm ts) =
paras [ line "Cannot derive a type class instance for"
, markCodeBox $ indent $ Box.hsep 1 Box.left
[ line (showQualified runProperName nm)
, Box.vcat Box.left (map typeAtomAsBox ts)
]
]
renderSimpleErrorMessage (InvalidNewtypeInstance nm ts) =
paras [ line "Cannot derive newtype instance for"
, markCodeBox $ indent $ Box.hsep 1 Box.left
[ line (showQualified runProperName nm)
, Box.vcat Box.left (map typeAtomAsBox ts)
]
, line "Make sure this is a newtype."
]
renderSimpleErrorMessage (CannotFindDerivingType nm) =
line $ "Cannot derive a type class instance, because the type declaration for " <> markCode (runProperName nm) <> " could not be found."
renderSimpleErrorMessage (DuplicateLabel l expr) =
paras $ [ line $ "Label " <> markCode (prettyPrintLabel l) <> " appears more than once in a row type." ]
<> foldMap (\expr' -> [ line "Relevant expression: "
, markCodeBox $ indent $ prettyPrintValue valueDepth expr'
]) expr
renderSimpleErrorMessage (DuplicateTypeArgument name) =
line $ "Type argument " <> markCode name <> " appears more than once."
renderSimpleErrorMessage (DuplicateValueDeclaration nm) =
line $ "Multiple value declarations exist for " <> markCode (showIdent nm) <> "."
renderSimpleErrorMessage (ArgListLengthsDiffer ident) =
line $ "Argument list lengths differ in declaration " <> markCode (showIdent ident)
renderSimpleErrorMessage (OverlappingArgNames ident) =
line $ "Overlapping names in function/binder" <> foldMap ((" in declaration " <>) . showIdent) ident
renderSimpleErrorMessage (MissingClassMember ident) =
line $ "Type class member " <> markCode (showIdent ident) <> " has not been implemented."
renderSimpleErrorMessage (ExtraneousClassMember ident className) =
line $ "" <> markCode (showIdent ident) <> " is not a member of type class " <> markCode (showQualified runProperName className)
renderSimpleErrorMessage (ExpectedType ty kind) =
paras [ line $ "In a type-annotated expression " <> markCode "x :: t" <> ", the type " <> markCode "t" <> " must have kind " <> markCode (prettyPrintKind kindType) <> "."
, line "The error arises from the type"
, markCodeBox $ indent $ typeAsBox ty
, line "having the kind"
, indent $ line $ markCode $ prettyPrintKind kind
, line "instead."
]
renderSimpleErrorMessage (IncorrectConstructorArity nm) =
line $ "Data constructor " <> markCode (showQualified runProperName nm) <> " was given the wrong number of arguments in a case expression."
renderSimpleErrorMessage (ExprDoesNotHaveType expr ty) =
paras [ line "Expression"
, markCodeBox $ indent $ prettyPrintValue valueDepth expr
, line "does not have type"
, markCodeBox $ indent $ typeAsBox ty
]
renderSimpleErrorMessage (PropertyIsMissing prop) =
line $ "Type of expression lacks required label " <> markCode (prettyPrintLabel prop) <> "."
renderSimpleErrorMessage (AdditionalProperty prop) =
line $ "Type of expression contains additional label " <> markCode (prettyPrintLabel prop) <> "."
renderSimpleErrorMessage TypeSynonymInstance =
line "Type class instances for type synonyms are disallowed."
renderSimpleErrorMessage (OrphanInstance nm cnm ts) =
paras [ line $ "Type class instance " <> markCode (showIdent nm) <> " for "
, markCodeBox $ indent $ Box.hsep 1 Box.left
[ line (showQualified runProperName cnm)
, Box.vcat Box.left (map typeAtomAsBox ts)
]
, line "is an orphan instance."
, line "An orphan instance is one which is defined in a module that is unrelated to either the class or the collection of data types that the instance is defined for."
, line "Consider moving the instance, if possible, or using a newtype wrapper."
]
renderSimpleErrorMessage (InvalidNewtype name) =
paras [ line $ "Newtype " <> markCode (runProperName name) <> " is invalid."
, line "Newtypes must define a single constructor with a single argument."
]
renderSimpleErrorMessage (InvalidInstanceHead ty) =
paras [ line "Type class instance head is invalid due to use of type"
, markCodeBox $ indent $ typeAsBox ty
, line "All types appearing in instance declarations must be of the form T a_1 .. a_n, where each type a_i is of the same form, unless the type is fully determined by other type class arguments via functional dependencies."
]
renderSimpleErrorMessage (TransitiveExportError x ys) =
paras [ line $ "An export for " <> markCode (prettyPrintExport x) <> " requires the following to also be exported: "
, indent $ paras $ map (line . markCode . prettyPrintExport) ys
]
renderSimpleErrorMessage (TransitiveDctorExportError x ctor) =
paras [ line $ "An export for " <> markCode (prettyPrintExport x) <> " requires the following data constructor to also be exported: "
, indent $ line $ markCode $ runProperName ctor
]
renderSimpleErrorMessage (ShadowedName nm) =
line $ "Name " <> markCode (showIdent nm) <> " was shadowed."
renderSimpleErrorMessage (ShadowedTypeVar tv) =
line $ "Type variable " <> markCode tv <> " was shadowed."
renderSimpleErrorMessage (UnusedTypeVar tv) =
line $ "Type variable " <> markCode tv <> " was declared but not used."
renderSimpleErrorMessage (MisleadingEmptyTypeImport mn name) =
line $ "Importing type " <> markCode (runProperName name <> "(..)") <> " from " <> markCode (runModuleName mn) <> " is misleading as it has no exported data constructors."
renderSimpleErrorMessage (ImportHidingModule name) =
paras [ line "hiding imports cannot be used to hide modules."
, line $ "An attempt was made to hide the import of " <> markCode (runModuleName name)
]
renderSimpleErrorMessage (WildcardInferredType ty ctx) =
paras $ [ line "Wildcard type definition has the inferred type "
, markCodeBox $ indent $ typeAsBox ty
] <> renderContext ctx
renderSimpleErrorMessage (HoleInferredType name ty ctx ts) =
let
maxTSResults = 15
tsResult = case ts of
(TSAfter idents) | not (null idents) ->
let
formatTS (names, types) =
let
idBoxes = Box.text . T.unpack . showQualified runIdent <$> names
tyBoxes = (\t -> BoxHelpers.indented
(Box.text ":: " Box.<> typeAsBox t)) <$> types
longestId = maximum (map Box.cols idBoxes)
in
Box.vcat Box.top $
zipWith (Box.<>)
(Box.alignHoriz Box.left longestId <$> idBoxes)
tyBoxes
in [ line "You could substitute the hole with one of these values:"
, markCodeBox (indent (formatTS (unzip (take maxTSResults idents))))
]
_ -> []
in
paras $ [ line $ "Hole '" <> markCode name <> "' has the inferred type "
, markCodeBox (indent (typeAsBox ty))
] ++ tsResult ++ renderContext ctx
renderSimpleErrorMessage (MissingTypeDeclaration ident ty) =
paras [ line $ "No type declaration was provided for the top-level declaration of " <> markCode (showIdent ident) <> "."
, line "It is good practice to provide type declarations as a form of documentation."
, line $ "The inferred type of " <> markCode (showIdent ident) <> " was:"
, markCodeBox $ indent $ typeAsBox ty
]
renderSimpleErrorMessage (OverlappingPattern bs b) =
paras $ [ line "A case expression contains unreachable cases:\n"
, Box.hsep 1 Box.left (map (paras . map (line . prettyPrintBinderAtom)) (transpose bs))
] ++
[ line "..." | not b ]
renderSimpleErrorMessage IncompleteExhaustivityCheck =
paras [ line "An exhaustivity check was abandoned due to too many possible cases."
, line "You may want to decompose your data types into smaller types."
]
renderSimpleErrorMessage (UnusedImport name) =
line $ "The import of module " <> markCode (runModuleName name) <> " is redundant"
renderSimpleErrorMessage msg@(UnusedExplicitImport mn names _ _) =
paras [ line $ "The import of module " <> markCode (runModuleName mn) <> " contains the following unused references:"
, indent $ paras $ map (line . markCode . runName . Qualified Nothing) names
, line "It could be replaced with:"
, indent $ line $ markCode $ showSuggestion msg ]
renderSimpleErrorMessage msg@(UnusedDctorImport mn name _ _) =
paras [line $ "The import of type " <> markCode (runProperName name)
<> " from module " <> markCode (runModuleName mn) <> " includes data constructors but only the type is used"
, line "It could be replaced with:"
, indent $ line $ markCode $ showSuggestion msg ]
renderSimpleErrorMessage msg@(UnusedDctorExplicitImport mn name names _ _) =
paras [ line $ "The import of type " <> markCode (runProperName name)
<> " from module " <> markCode (runModuleName mn) <> " includes the following unused data constructors:"
, indent $ paras $ map (line . markCode . runProperName) names
, line "It could be replaced with:"
, indent $ line $ markCode $ showSuggestion msg ]
renderSimpleErrorMessage (DuplicateSelectiveImport name) =
line $ "There is an existing import of " <> markCode (runModuleName name) <> ", consider merging the import lists"
renderSimpleErrorMessage (DuplicateImport name imp qual) =
line $ "Duplicate import of " <> markCode (prettyPrintImport name imp qual)
renderSimpleErrorMessage (DuplicateImportRef name) =
line $ "Import list contains multiple references to " <> printName (Qualified Nothing name)
renderSimpleErrorMessage (DuplicateExportRef name) =
line $ "Export list contains multiple references to " <> printName (Qualified Nothing name)
renderSimpleErrorMessage (IntOutOfRange value backend lo hi) =
paras [ line $ "Integer value " <> markCode (T.pack (show value)) <> " is out of range for the " <> backend <> " backend."
, line $ "Acceptable values fall within the range " <> markCode (T.pack (show lo)) <> " to " <> markCode (T.pack (show hi)) <> " (inclusive)." ]
renderSimpleErrorMessage msg@(ImplicitQualifiedImport importedModule asModule _) =
paras [ line $ "Module " <> markCode (runModuleName importedModule) <> " was imported as " <> markCode (runModuleName asModule) <> " with unspecified imports."
, line $ "As there are multiple modules being imported as " <> markCode (runModuleName asModule) <> ", consider using the explicit form:"
, indent $ line $ markCode $ showSuggestion msg
]
renderSimpleErrorMessage msg@(ImplicitImport mn _) =
paras [ line $ "Module " <> markCode (runModuleName mn) <> " has unspecified imports, consider using the explicit form: "
, indent $ line $ markCode $ showSuggestion msg
]
renderSimpleErrorMessage msg@(HidingImport mn _) =
paras [ line $ "Module " <> markCode (runModuleName mn) <> " has unspecified imports, consider using the inclusive form: "
, indent $ line $ markCode $ showSuggestion msg
]
renderSimpleErrorMessage (CaseBinderLengthDiffers l bs) =
paras [ line "Binder list length differs in case alternative:"
, indent $ line $ T.intercalate ", " $ fmap prettyPrintBinderAtom bs
, line $ "Expecting " <> T.pack (show l) <> " binder" <> (if l == 1 then "" else "s") <> "."
]
renderSimpleErrorMessage IncorrectAnonymousArgument =
line "An anonymous function argument appears in an invalid context."
renderSimpleErrorMessage (InvalidOperatorInBinder op fn) =
paras [ line $ "Operator " <> markCode (showQualified showOp op) <> " cannot be used in a pattern as it is an alias for function " <> showQualified showIdent fn <> "."
, line "Only aliases for data constructors may be used in patterns."
]
renderSimpleErrorMessage (CannotGeneralizeRecursiveFunction ident ty) =
paras [ line $ "Unable to generalize the type of the recursive function " <> markCode (showIdent ident) <> "."
, line $ "The inferred type of " <> markCode (showIdent ident) <> " was:"
, markCodeBox $ indent $ typeAsBox ty
, line "Try adding a type signature."
]
renderSimpleErrorMessage (CannotDeriveNewtypeForData tyName) =
paras [ line $ "Cannot derive an instance of the " <> markCode "Newtype" <> " class for non-newtype " <> markCode (runProperName tyName) <> "."
]
renderSimpleErrorMessage (ExpectedWildcard tyName) =
paras [ line $ "Expected a type wildcard (_) when deriving an instance for " <> markCode (runProperName tyName) <> "."
]
renderSimpleErrorMessage CannotUseBindWithDo =
paras [ line $ "The name " <> markCode "bind" <> " cannot be brought into scope in a do notation block, since do notation uses the same name."
]
renderSimpleErrorMessage (ClassInstanceArityMismatch dictName className expected actual) =
paras [ line $ "The type class " <> markCode (showQualified runProperName className) <>
" expects " <> T.pack (show expected) <> " argument(s)."
, line $ "But the instance " <> markCode (showIdent dictName) <> " only provided " <>
T.pack (show actual) <> "."
]
renderSimpleErrorMessage (UserDefinedWarning msgTy) =
let msg = fromMaybe (typeAsBox msgTy) (toTypelevelString msgTy) in
paras [ line "A custom warning occurred while solving type class constraints:"
, indent msg
]
renderSimpleErrorMessage (UnusableDeclaration ident) =
paras [ line $ "The declaration " <> markCode (showIdent ident) <> " is unusable."
, line $ "This happens when a constraint couldn't possibly have enough information to work out which instance is required."
]
renderHint :: ErrorMessageHint -> Box.Box -> Box.Box
renderHint (ErrorUnifyingTypes t1 t2) detail =
paras [ detail
, Box.hsep 1 Box.top [ line "while trying to match type"
, markCodeBox $ typeAsBox t1
]
, Box.moveRight 2 $ Box.hsep 1 Box.top [ line "with type"
, markCodeBox $ typeAsBox t2
]
]
renderHint (ErrorInExpression expr) detail =
paras [ detail
, Box.hsep 1 Box.top [ Box.text "in the expression"
, markCodeBox $ markCodeBox $ prettyPrintValue valueDepth expr
]
]
renderHint (ErrorInModule mn) detail =
paras [ line $ "in module " <> markCode (runModuleName mn)
, detail
]
renderHint (ErrorInSubsumption t1 t2) detail =
paras [ detail
, Box.hsep 1 Box.top [ line "while checking that type"
, markCodeBox $ typeAsBox t1
]
, Box.moveRight 2 $ Box.hsep 1 Box.top [ line "is at least as general as type"
, markCodeBox $ typeAsBox t2
]
]
renderHint (ErrorInInstance nm ts) detail =
paras [ detail
, line "in type class instance"
, markCodeBox $ indent $ Box.hsep 1 Box.top
[ line $ showQualified runProperName nm
, Box.vcat Box.left (map typeAtomAsBox ts)
]
]
renderHint (ErrorCheckingKind ty) detail =
paras [ detail
, Box.hsep 1 Box.top [ line "while checking the kind of"
, markCodeBox $ typeAsBox ty
]
]
renderHint ErrorCheckingGuard detail =
paras [ detail
, line "while checking the type of a guard clause"
]
renderHint (ErrorInferringType expr) detail =
paras [ detail
, Box.hsep 1 Box.top [ line "while inferring the type of"
, markCodeBox $ prettyPrintValue valueDepth expr
]
]
renderHint (ErrorCheckingType expr ty) detail =
paras [ detail
, Box.hsep 1 Box.top [ line "while checking that expression"
, markCodeBox $ prettyPrintValue valueDepth expr
]
, Box.moveRight 2 $ Box.hsep 1 Box.top [ line "has type"
, markCodeBox $ typeAsBox ty
]
]
renderHint (ErrorCheckingAccessor expr prop) detail =
paras [ detail
, Box.hsep 1 Box.top [ line "while checking type of property accessor"
, markCodeBox $ prettyPrintValue valueDepth (Accessor prop expr)
]
]
renderHint (ErrorInApplication f t a) detail =
paras [ detail
, Box.hsep 1 Box.top [ line "while applying a function"
, markCodeBox $ prettyPrintValue valueDepth f
]
, Box.moveRight 2 $ Box.hsep 1 Box.top [ line "of type"
, markCodeBox $ typeAsBox t
]
, Box.moveRight 2 $ Box.hsep 1 Box.top [ line "to argument"
, markCodeBox $ prettyPrintValue valueDepth a
]
]
renderHint (ErrorInDataConstructor nm) detail =
paras [ detail
, line $ "in data constructor " <> markCode (runProperName nm)
]
renderHint (ErrorInTypeConstructor nm) detail =
paras [ detail
, line $ "in type constructor " <> markCode (runProperName nm)
]
renderHint (ErrorInBindingGroup nms) detail =
paras [ detail
, line $ "in binding group " <> T.intercalate ", " (map showIdent nms)
]
renderHint (ErrorInDataBindingGroup nms) detail =
paras [ detail
, line $ "in data binding group " <> T.intercalate ", " (map runProperName nms)
]
renderHint (ErrorInTypeSynonym name) detail =
paras [ detail
, line $ "in type synonym " <> markCode (runProperName name)
]
renderHint (ErrorInValueDeclaration n) detail =
paras [ detail
, line $ "in value declaration " <> markCode (showIdent n)
]
renderHint (ErrorInTypeDeclaration n) detail =
paras [ detail