1{-# OPTIONS_GHC -Wall #-}
2{-# LANGUAGE OverloadedStrings #-}
3module Reporting.Error.Syntax
6 , Problem(..), Theory(..)
7 , ContextStack, Context(..)
13import qualified Data.Set as Set
14import qualified Data.Text as Text
15import Data.Text (Text)
17import qualified Reporting.Render.Type as RenderType
18import qualified Reporting.Region as R
19import qualified Reporting.Report as Report
20import qualified Reporting.Helpers as Help
21import Reporting.Helpers ((<>), dullyellow, hsep, i2t, reflowParagraph, text)
29 = Parse (Maybe R.Region) Problem
35 | SettingsOnNormalModule
36 | SettingsOnPortModule
37 | DuplicateSettingOnEffectModule Text
38 | BadSettingOnEffectModule Text
39 | NoSettingsOnEffectModule
40 | MissingManagerOnEffectModule Text
43 | TypeWithoutDefinition Text
45 | DuplicateArgument Text Text
46 | DuplicateFieldName R.Region Text
47 | DuplicateValueDeclaration Text
48 | DuplicateTypeDeclaration Text
49 | DuplicateDefinition Text
50 | UnboundTypeVarsInUnion Text [Text] [Text]
51 | UnboundTypeVarsInAlias Text [Text] [Text]
52 | UnusedTypeVarsInAlias Text [Text] [Text]
53 | MessyTypeVarsInAlias Text [Text] [Text] [Text]
60data ParseError = ParseError !Int !Int !Problem
68 | EndOfFile_MultiString
78 | BadOp BadOp ContextStack
79 | Theories ContextStack [Theory]
82data BadOp = HasType | Equals | Arrow | Pipe | Dot
110type ContextStack = [(Context, R.Position)]
138 deriving (Eq, Ord, Show)
145toReport :: RenderType.Localizer -> Error -> Report.Report
146toReport _localizer err =
148 Parse subRegion problem ->
149 problemToReport subRegion problem
151 BadFunctionName arity ->
153 "BAD FUNCTION DEFINITION"
155 "Complex patterns cannot be used as function names."
157 "This function definition has " <> i2t arity <> " arguments, but instead\
158 \ of a normal name like `add` or `reverse` it has a pattern. There is no\
159 \ way to \"deconstruct\" a function with pattern matching, so this needs to\
160 \ be changed to a normal name."
167 ("The free variable `" <> name <> "` appears more than once in this pattern.")
169 [ text "Rename the variables so there are no duplicates."
171 "In Elm, pattern matching works by binding these free variables to subsections\
172 \ of the matching value. It does not make sense to have the same name for two\
173 \ different subsections though! When you say `" <> name <> "` in some code, there\
174 \ is no way for me to know which subsection you mean!"
182 ("This documentation comment is not followed by anything.")
184 "All documentation comments need to be right above the declaration they\
185 \ describe. Maybe some code got deleted or commented out by accident? Or\
186 \ maybe this comment is here by accident?"
189 SettingsOnNormalModule ->
191 "BAD MODULE DECLARATION"
193 "A normal module can expose values, but not settings like this."
195 "If you want a normal module, just remove this stuff. If you want to create\
196 \ an `effect module` you forgot to use the `effect` keyword. In that\
197 \ case, change `module` to `effect module` and you should be headed in\
198 \ the right direction!"
201 SettingsOnPortModule ->
203 "BAD MODULE DECLARATION"
205 "A port module can expose values, but not have settings like this."
207 "If you want a port module, just remove this stuff. If you want to create\
208 \ a custom effect module instead (which is rare) change `port module`\
209 \ to `effect module` and you should be headed in the right direction!"
212 DuplicateSettingOnEffectModule name ->
214 "EFFECT MODULE PROBLEM"
216 ("You have defined " <> Help.functionName name <> " multiple times.")
218 "There can only be one " <> Help.functionName name
219 <> " though! Remove until there is one left."
222 BadSettingOnEffectModule name ->
224 "EFFECT MODULE PROBLEM"
226 ("Setting " <> Help.functionName name <> " is not recognized.")
228 "Remove this entry and you should be all set!"
231 NoSettingsOnEffectModule ->
233 "EFFECT MODULE PROBLEM"
235 ("You are defining an effect module, but it has no settings.")
237 "If you just wanted a normal module, change the keywords `effect module`\
238 \ to `module` and you should be all set. If you want a proper effect module,\
239 \ you need to specify your commands and/or subscriptions. Read more about this\
240 \ here: <http://guide.elm-lang.org/effect_managers/>"
243 MissingManagerOnEffectModule name ->
245 "EFFECT MODULE PROBLEM"
247 ("You are defining an effect module, but there is no " <> Help.functionName name <> " defined.")
249 "There is a small set of top-level functions and values that must be defined\
250 \ in any complete effect module. The best thing is probably to just read more\
251 \ about effect modules here:\
252 \ <http://guide.elm-lang.org/effect_managers/>"
255 UnexpectedPort name ->
259 ("You are declaring port " <> Help.functionName name <> " in a normal module.")
261 "All ports must be defined in a `port module`. You should probably have only\
262 \ one of these for your project. This way all of your foreign interactions\
263 \ stay relatively organized."
266 TypeWithoutDefinition valueName ->
270 ("There is a type annotation for `" <> valueName <> "` but there"
271 <> " is no corresponding definition!"
274 "Directly below the type annotation, put a definition like:\n\n"
275 <> " " <> valueName <> " = 42"
278 DuplicateArgument funcName argName ->
282 ( "The name `" <> argName
283 <> "` is used more than once in the arguments of "
284 <> Help.functionName funcName <> "."
287 "Rename things until `" <> argName <> "` is used only once.\
288 \ Otherwise how can we tell which one you want when you\
289 \ say `" <> argName <> "` it in the body of your function?"
292 DuplicateFieldName region name ->
296 ("This record has more than one field named `" <> name <> "`.")
297 (text "There can only be one. Do some renaming to make sure the names are distinct!")
299 DuplicateValueDeclaration name ->
301 "DUPLICATE DEFINITION"
303 ( "Naming multiple top-level values " <> Help.functionName name <> " makes things\n"
304 <> "ambiguous. When you say " <> Help.functionName name <> " which one do you want?"
307 "Find all the top-level values named " <> Help.functionName name
308 <> " and do some renaming. Make sure the names are distinct!"
311 DuplicateTypeDeclaration name ->
313 "DUPLICATE DEFINITION"
315 ( "There are multiple types named `" <> name <> "` in this module."
318 "Search through this module, find all the types named `"
319 <> name <> "`, and give each of them a unique name."
322 DuplicateDefinition name ->
324 "DUPLICATE DEFINITION"
326 ("There are multiple values named `" <> name <> "` in this let-expression."
329 "Search through this let-expression, find all the values named `"
330 <> name <> "`, and give each of them a unique name."
333 UnboundTypeVarsInUnion typeName givenVars unbound ->
334 unboundTypeVars "type" typeName givenVars unbound
336 UnboundTypeVarsInAlias typeName givenVars unbound ->
337 unboundTypeVars "type alias" typeName givenVars unbound
339 UnusedTypeVarsInAlias typeName givenVars unused ->
341 "UNUSED TYPE VARIABLES"
343 ( "Type alias `" <> typeName <> "` cannot have unused type variables: "
344 <> Help.commaSep unused
347 [ text "You probably need to change the declaration like this:"
348 , dullyellow $ hsep $
349 map text ("type" : "alias" : typeName : filter (`notElem` unused) givenVars ++ ["=", "..."])
353 MessyTypeVarsInAlias typeName givenVars unused unbound ->
355 "TYPE VARIABLE PROBLEMS"
357 ( "Type alias `" <> typeName <> "` has some problems with type variables."
361 "The declaration says it uses certain type variables ("
362 <> Help.commaSep unused <> ") but they do not appear in the aliased type. "
363 <> "Furthermore, the aliased type says it uses type variables ("
364 <> Help.commaSep unbound
365 <> ") that do not appear in the declaration."
366 , text "You probably need to change the declaration like this:"
367 , dullyellow $ hsep $
368 map text ("type" : "alias" : typeName : filter (`notElem` unused) givenVars ++ unbound ++ ["=", "..."])
373unboundTypeVars :: Text -> Text -> [Text] -> [Text] -> Report.Report
374unboundTypeVars declKind typeName givenVars unboundVars =
376 "UNBOUND TYPE VARIABLES"
378 ( Help.capitalize declKind <> " `" <> typeName <> "` must declare its use of type variable"
379 <> Help.commaSep unboundVars
382 [ text "You probably need to change the declaration like this:"
384 map text (declKind : typeName : givenVars)
385 ++ map (dullyellow . text) unboundVars
386 ++ map text ["=", "..."]
388 "Here's why. Imagine one `" <> typeName <> "` where `" <> head unboundVars <>
389 "` is an Int and another where it is a Bool. When we explicitly list the type\
390 \ variables, the type checker can see that they are actually different types."
396-- PARSE ERROR TO REPORT
399makeParseReport :: Maybe R.Region -> Text -> Help.Doc -> Report.Report
400makeParseReport subRegion pre post =
401 Report.report "PARSE ERROR" subRegion pre post
404problemToReport :: Maybe R.Region -> Problem -> Report.Report
405problemToReport subRegion problem =
406 let parseReport = makeParseReport subRegion in
410 "I ran into a tab, but tabs are not allowed in Elm files."
411 (reflowParagraph "Replace the tab with spages.")
415 "I got to the end of the file while parsing a multi-line comment."
418 "Multi-line comments look like {- comment -}, and it looks like\
419 \ you are missing the closing marker."
421 "Nested multi-line comments like {- this {- and this -} -} are allowed.\
422 \ That means the opening and closing markers must be balanced, just\
423 \ like parentheses in normal code. Maybe that is the problem?"
429 "I got to the end of the file while parsing a GLSL block."
431 "A shader should be defined in a block like this: [glsl| ... |]"
436 "I got to the end of the file while parsing a string."
438 "Strings look like \"this\" with double quotes on each end.\
439 \ So the closing double quote seems to be missing."
442 EndOfFile_MultiString ->
444 "I got to the end of the file while parsing a multi-line string."
446 "Multi-line strings begin and end with three double quotes in a\
447 \ row, like \"\"\"this\"\"\". So the closing marker seems\
453 "This string is missing the closing quote."
456 "Elm strings must start and end with a double quote, like \"this\"."
458 "If you want a string that can contain newlines, use three double quotes in a\
459 \ row, like \"\"\"this\"\"\"."
465 "Ran into a bad escape code."
467 "Elm allows typical escape characters like \\n and \\t, but you can\
468 \ also use \\x0040 to refer to unicode characters by their hex code.\
469 \ It seems like something has gone wrong with one of these codes."
474 "Ran into a bad use of single quotes."
477 "If you want to create a string, switch to double quotes:"
479 dullyellow (text "'this'")
481 <> dullyellow (text "\"this\"")
483 "Unlike JavaScript, Elm distinguishes between strings like \"hello\"\
484 \ and individual characters like 'A' and '3'. If you really do want\
485 \ a character though, something went wrong and I did not find the\
486 \ closing single quote."
492 "Numbers cannot end with a decimal points."
494 "Leave it off or add some digits after it, like or 3 or 3.0"
499 "Numbers cannot have letters or underscores in them."
501 "Maybe a space is missing between a number and a variable?"
506 "If you put the letter E in a number, it should followed by more digits."
508 "If you want to say 1000, you can also say 1e3.\
509 \ You cannot just end it with an E though!"
514 "I see the start of a hex number, but not the end."
516 "A hex number looks like 0x123ABC, where the 0x is followed by hexidecimal digits (i.e. 0123456789abcdefABCDEF)"
521 "Normal numbers cannot start with a zero. Take the zeros off the front."
523 "Only numbers like 0x0040 or 0.25 can start with a zero."
528 "I ran into a problem while parsing this GLSL block."
529 (reflowParagraph msg)
534 badOp subRegion stack "A" "\"has type\" operator"
535 "type annotations and record types"
536 "Maybe you want :: instead? Or maybe something is indented too much?"
539 badEquals subRegion stack
542 if isCaseRelated stack then
544 "I ran into a stray arrow while parsing this `case` expression."
546 "All branches in a `case` must be indented the exact\
547 \ same amount, so the patterns are vertically\
548 \ aligned. Maybe this branch is indented too much?"
552 badOp subRegion stack "An" "arrow"
553 "cases expressions and anonymous functions"
554 "Maybe you want > or >= instead?"
557 badOp subRegion stack "A" "vertical bar"
559 "Maybe you want || instead?"
563 "I was not expecting this dot."
565 "Dots are for record access and decimal points, so\
566 \ they cannot float around on their own. Maybe\
567 \ there is some extra whitespace?"
570 Theories stack allTheories ->
573 "Something went wrong while parsing "
574 <> contextToText "your code" "" stack
577 parseReport starter $
578 case Set.toList (Set.fromList allTheories) of
582 "I do not have any suggestions though!"
584 "Can you get it down to a <http://sscce.org> and share it at\
585 \ <https://github.com/elm-lang/error-message-catalog/issues>?\
586 \ That way we can figure out how to give better advice!"
591 "I was expecting to see "
592 <> addPeriod (theoryToText stack theory)
596 [ text "I was expecting:"
599 ++ map (bullet . theoryToText stack) theories
602bullet :: Text -> Help.Doc
604 Help.hang 4 (" - " <> reflowParagraph point)
607addPeriod :: Text -> Text
609 if Text.last msg `elem` ['`', ')', '.', '!', '?'] then
615badOp :: Maybe R.Region -> ContextStack -> Text -> Text -> Text -> Text -> Report.Report
616badOp subRegion stack article opName setting hint =
619 "I was not expecting this " <> opName
620 <> contextToText "" " while parsing " stack <> "."
622 makeParseReport subRegion pre $
624 article <> " " <> opName <> " should only appear in "
625 <> setting <> ". " <> hint
628badEquals :: Maybe R.Region -> ContextStack -> Report.Report
629badEquals subRegion stack =
632 "I was not expecting this equals sign"
633 <> contextToText "" " while parsing " stack <> "."
635 makeParseReport subRegion pre (badEqualsHelp stack)
638badEqualsHelp :: ContextStack -> Help.Doc
643 "Maybe you want == instead? Or maybe something is indented too much?"
645 (ExprRecord, _) : _ ->
647 "Records look like { x = 3, y = 4 } with the equals sign right\
648 \ after the field name. Maybe you forgot a comma?"
650 (Definition _, _) : rest ->
652 "Maybe this is supposed to be a separate definition? If so, it\
653 \ is indented too far. "
655 if any ((==) ExprLet . fst) rest then
656 "All definitions in a `let` expression must be vertically aligned."
658 "Spaces are not allowed before top-level definitions."
664contextToText :: Text -> Text -> ContextStack -> Text
665contextToText defaultText prefixText stack =
670 (context, _) : rest ->
671 let anchor = getAnchor rest in
674 ExprIf -> "an `if`" <> anchor
675 ExprLet -> "a `let`" <> anchor
676 ExprFunc -> "an anonymous function" <> anchor
677 ExprCase -> "a `case`" <> anchor
678 ExprList -> "a list" <> anchor
679 ExprTuple -> "an expression (in parentheses)" <> anchor
680 ExprRecord -> "a record" <> anchor
681 Definition name -> name <> "'s definition"
682 Annotation name -> name <> "'s type annotation"
683 TypeTuple -> "a type (in parentheses)" <> anchor
684 TypeRecord -> "a record type" <> anchor
685 PatternList -> "a list pattern" <> anchor
686 PatternTuple -> "a pattern (in parentheses)" <> anchor
687 PatternRecord -> "a record pattern" <> anchor
688 Module -> "a module declaration"
689 Import -> "an import"
690 TypeUnion -> "a union type"
691 TypeAlias -> "a type alias"
692 Infix -> "an infix declaration"
693 Port -> "a port declaration"
696getAnchor :: ContextStack -> Text
702 (context, _) : rest ->
705 " in " <> name <> "'s definition"
708 " in " <> name <> "'s type annotation"
714isCaseRelated :: ContextStack -> Bool
720 (context, _) : rest ->
721 context == ExprCase || isCaseRelated rest
724theoryToText :: ContextStack -> Theory -> Text
725theoryToText context theory =
728 "the `" <> keyword <> "` keyword"
732 "=" -> equalsTheory context
733 "->" -> "an arrow (->) followed by an expression"
734 ":" -> "the \"has type\" symbol (:) followed by a type"
736 "|" -> barTheory context
737 "::" -> "the cons operator (::) followed by more list elements"
739 "-" -> "a minus sign (-)"
740 "_" -> "an underscore"
741 "(" -> "a left paren, for grouping or starting tuples"
742 ")" -> "a closing paren"
743 "[" -> "a left square bracket, for starting lists"
744 "]" -> "a right square bracket, to end a list"
745 "{" -> "a left curly brace, for starting records"
746 "}" -> "a right curly brace, to end a record"
747 "{-|" -> "a doc comment, like {-| example -}"
748 _ -> "the (" <> symbol <> ") symbol"
751 "a lower-case variable, like `x` or `user`"
754 "an upper-case variable, like `Maybe` or `Just`"
757 "an infix operator, like (+) or (==)"
760 "a digit from 0 to 9"
767 Decl -> "a declaration, like `x = 5` or `type alias Model = { ... }`"
768 Expr -> "an expression, like x or 42"
769 AfterOpExpr op -> "an expression after that (" <> op <> ") operator, like x or 42"
770 ElseBranch -> "an `else` branch. An `if` must handle both possibilities."
771 Arg -> "an argument, like `name` or `total`"
772 Pattern -> "a pattern, like `name` or (Just x)"
773 Type -> "a type, like Int or (List String)"
774 Listing -> "a list of exposed values and types, like (..) or (x,y,z)"
775 Exposing -> "something like `exposing (..)`"
778equalsTheory :: ContextStack -> Text
784 (context, _) : rest ->
786 ExprRecord -> "an equals sign (=) followed by an expression"
787 Definition name -> "an equals sign (=) followed by " <> name <> "'s definition"
788 TypeUnion -> "an equals sign (=) followed by the first union type constructor"
789 TypeAlias -> "an equals sign (=) followed by the aliased type"
790 _ -> equalsTheory rest
793barTheory :: ContextStack -> Text
799 (context, _) : rest ->
801 ExprRecord -> "a vertical bar (|) followed by the record fields you want to update"
802 TypeRecord -> "a vertical bar (|) followed by some record field types"
803 TypeUnion -> "a vertical bar (|) followed by more union type constructors"
807badSpace :: ContextStack -> Text
811 "more indentation? I was not done with that last thing yet."
813 (context, _) : rest ->
815 ExprIf -> "the end of that `if`" <> badSpaceExprEnd rest
816 ExprLet -> "the end of that `let`" <> badSpaceExprEnd rest
817 ExprFunc -> badSpace rest
818 ExprCase -> "more of that `case`" <> badSpaceExprEnd rest
819 ExprList -> "the end of that list" <> badSpaceExprEnd rest
820 ExprTuple -> "a closing paren" <> badSpaceExprEnd rest
821 ExprRecord -> "the end of that record" <> badSpaceExprEnd rest
822 Definition name -> "the rest of " <> name <> "'s definition" <> badSpaceExprEnd stack
823 Annotation name -> "the rest of " <> name <> "'s type annotation" <> badSpaceEnd
824 TypeTuple -> "a closing paren" <> badSpaceEnd
825 TypeRecord -> "the end of that record" <> badSpaceEnd
826 PatternList -> "the end of that list" <> badSpaceEnd
827 PatternTuple -> "a closing paren" <> badSpaceEnd
828 PatternRecord -> "the end of that record" <> badSpaceEnd
829 Module -> "something like `module Main exposing (..)`"
830 Import -> "something like `import Html exposing (..)`"
831 TypeUnion -> "more of that union type" <> badSpaceEnd
832 TypeAlias -> "more of that type alias" <> badSpaceEnd
833 Infix -> "more of that infix declaration" <> badSpaceEnd
834 Port -> "more of that port declaration" <> badSpaceEnd
839 ". Maybe you forgot some code? Or you need more indentation?"
842badSpaceExprEnd :: ContextStack -> Text
843badSpaceExprEnd stack =
848 (Definition name, R.Position _ column) : _ ->
854 "more indentation? (Try " <> i2t (column + 1) <> "+ spaces.)"
856 ". Maybe you forgot some code? Or maybe the body of `" <> name
857 <> "` needs " <> ending
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list