Rearrange error msgs and add section markers (Trac #11014).

This puts the "Relevant bindings" section at the end.

It uses a TcErrors.Report Monoid to divide messages by importance and
then mappends them together.  This is not the most efficient way since
there are various intermediate Reports and list appends, but it probably
doesn't matter since error messages shouldn't get that large, and are
usually prepended.  In practice, everything is `important` except
`relevantBindings`, which is `supplementary`.

ErrMsg's errMsgShortDoc and errMsgExtraInfo were extracted into ErrDoc,
which has important, context, and suppelementary fields.  Each of those
three sections is marked with a bullet character, '•' on unicode
terminals and '*' on ascii terminals.  Since this breaks tons of tests,
I also modified testlib.normalise_errmsg to strip out '•'s.

--- Additional notes:

To avoid prepending * to an empty doc, I needed to filter empty docs.
This seemed less error-prone than trying to modify everyone who produces
SDoc to instead produce Maybe SDoc.  So I added `Outputable.isEmpty`.
Unfortunately it needs a DynFlags, which is kind of bogus, but otherwise
I think I'd need another Empty case for SDoc, and then it couldn't be a
newtype any more.

ErrMsg's errMsgShortString is only used by the Show instance, which is
in turn only used by Show HscTypes.SourceError, which is in turn only
needed for the Exception instance.  So it's probably possible to get rid
of errMsgShortString, but that would a be an unrelated cleanup.

Fixes #11014.

Test Plan: see above

Reviewers: austin, simonpj, thomie, bgamari

Reviewed By: thomie, bgamari

Subscribers: simonpj, nomeata, thomie

Differential Revision: https://phabricator.haskell.org/D1427

GHC Trac Issues: #11014

1 files changed, 5 insertions, 5 deletions

diff --git a/testsuite/tests/gadt/rw.stderr b/testsuite/tests/gadt/rw.stderr
index 8b02f5c4d7..dcd3e10397 100644
--- a/testsuite/tests/gadt/rw.stderr
+++ b/testsuite/tests/gadt/rw.stderr
@@ -4,13 +4,13 @@ rw.hs:14:47:
       ‘a’ is a rigid type variable bound by
           the type signature for: writeInt :: T a -> IORef a -> IO ()
           at rw.hs:12:12
+    In the second argument of ‘writeIORef’, namely ‘(1 :: Int)’
+    In the expression: writeIORef ref (1 :: Int)
+    In a case alternative: ~(Li x) -> writeIORef ref (1 :: Int)
     Relevant bindings include
       ref :: IORef a (bound at rw.hs:13:12)
       v :: T a (bound at rw.hs:13:10)
       writeInt :: T a -> IORef a -> IO () (bound at rw.hs:13:1)
-    In the second argument of ‘writeIORef’, namely ‘(1 :: Int)’
-    In the expression: writeIORef ref (1 :: Int)
-    In a case alternative: ~(Li x) -> writeIORef ref (1 :: Int)
 
 rw.hs:19:51:
     Couldn't match type ‘a’ with ‘Bool’
@@ -19,9 +19,9 @@ rw.hs:19:51:
           at rw.hs:16:12
     Expected type: a -> Bool
       Actual type: Bool -> Bool
+    In the second argument of ‘(.)’, namely ‘not’
+    In the second argument of ‘(>>=)’, namely ‘(print . not)’
     Relevant bindings include
       ref :: IORef a (bound at rw.hs:17:12)
       v :: T a (bound at rw.hs:17:10)
       readBool :: T a -> IORef a -> IO () (bound at rw.hs:17:1)
-    In the second argument of ‘(.)’, namely ‘not’
-    In the second argument of ‘(>>=)’, namely ‘(print . not)’