Better warning message for orphan instances (Ticket #9178)
authorDr. Heinrich Hördegen <hoerdegen@energiefluss.info>
Fri, 6 Jun 2014 17:11:27 +0000 (19:11 +0200)
committerJoachim Breitner <mail@joachim-breitner.de>
Mon, 9 Jun 2014 13:14:50 +0000 (15:14 +0200)
Including a test case.

compiler/iface/MkIface.lhs
testsuite/tests/warnings/should_compile/Makefile [new file with mode: 0644]
testsuite/tests/warnings/should_compile/T9178.hs [new file with mode: 0644]
testsuite/tests/warnings/should_compile/T9178.stderr [new file with mode: 0644]
testsuite/tests/warnings/should_compile/T9178DataType.hs [new file with mode: 0644]
testsuite/tests/warnings/should_compile/all.T [new file with mode: 0644]

index f2d2058..760f349 100644 (file)
@@ -879,6 +879,13 @@ instOrphWarn :: DynFlags -> PrintUnqualified -> ClsInst -> WarnMsg
 instOrphWarn dflags unqual inst
   = mkWarnMsg dflags (getSrcSpan inst) unqual $
     hang (ptext (sLit "Orphan instance:")) 2 (pprInstanceHdr inst)
+    $$ text "To avoid this"
+    $$ nest 4 (vcat posibilities)
+  where
+    posibilities =
+      text "move the instance declaration to the module of the class or of the type, or" :
+      text "wrap the type with a newtype and declare the instance on the new type." :
+      []
 
 ruleOrphWarn :: DynFlags -> PrintUnqualified -> Module -> IfaceRule -> WarnMsg
 ruleOrphWarn dflags unqual mod rule
diff --git a/testsuite/tests/warnings/should_compile/Makefile b/testsuite/tests/warnings/should_compile/Makefile
new file mode 100644 (file)
index 0000000..9101fbd
--- /dev/null
@@ -0,0 +1,3 @@
+TOP=../../..
+include $(TOP)/mk/boilerplate.mk
+include $(TOP)/mk/test.mk
diff --git a/testsuite/tests/warnings/should_compile/T9178.hs b/testsuite/tests/warnings/should_compile/T9178.hs
new file mode 100644 (file)
index 0000000..9171381
--- /dev/null
@@ -0,0 +1,9 @@
+
+
+module T9178 where
+
+import T9178DataType
+
+
+instance Show T9178_Type where
+         show _ = undefined
\ No newline at end of file
diff --git a/testsuite/tests/warnings/should_compile/T9178.stderr b/testsuite/tests/warnings/should_compile/T9178.stderr
new file mode 100644 (file)
index 0000000..6f4b6c0
--- /dev/null
@@ -0,0 +1,8 @@
+[1 of 2] Compiling T9178DataType    ( T9178DataType.hs, T9178DataType.o )
+[2 of 2] Compiling T9178            ( T9178.hs, T9178.o )
+
+T9178.hs:8:10: Warning:
+    Orphan instance: instance Show T9178_Type
+    To avoid this
+        move the instance declaration to the module of the class or of the type, or
+        wrap the type with a newtype and declare the instance on the new type.
diff --git a/testsuite/tests/warnings/should_compile/T9178DataType.hs b/testsuite/tests/warnings/should_compile/T9178DataType.hs
new file mode 100644 (file)
index 0000000..e274117
--- /dev/null
@@ -0,0 +1,5 @@
+
+
+module T9178DataType where
+
+data T9178_Type
diff --git a/testsuite/tests/warnings/should_compile/all.T b/testsuite/tests/warnings/should_compile/all.T
new file mode 100644 (file)
index 0000000..f6747bf
--- /dev/null
@@ -0,0 +1,3 @@
+test('T9178', extra_clean(['T9178.o', 'T9178DataType.o',
+                          'T9178.hi', 'T9178DataType.hi']),
+             multimod_compile, ['T9178', '-Wall'])
\ No newline at end of file