Add -Wcpp-undef warning flag
authorErik de Castro Lopo <erikd@mega-nerd.com>
Sat, 22 Oct 2016 19:38:41 +0000 (15:38 -0400)
committerBen Gamari <ben@smart-cactus.org>
Sat, 22 Oct 2016 19:39:50 +0000 (15:39 -0400)
When enabled, this new warning flag passes `-Wundef` to the C
pre-processor which causes the pre-processor to warn on uses of
the `#if` directive on undefined identifiers.

It is not currently enabled in any of the standard warning groups.

Test Plan: Make sure the two tests pass on all major platforms.

Reviewers: hvr, carter, Phyx, bgamari, austin

Reviewed By: Phyx

Subscribers: thomie

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

GHC Trac Issues: #12752

compiler/main/DynFlags.hs
compiler/main/SysTools.hs
docs/users_guide/8.2.1-notes.rst
docs/users_guide/using-warnings.rst
testsuite/tests/driver/T12752pass.hs [new file with mode: 0644]
testsuite/tests/driver/all.T
testsuite/tests/driver/should_fail/T12752.hs [new file with mode: 0644]
testsuite/tests/driver/should_fail/all.T

index 7978c03..cd8dc41 100644 (file)
@@ -619,6 +619,7 @@ data WarningFlag =
    | Opt_WarnMissingPatternSynonymSignatures -- since 8.0
    | Opt_WarnUnrecognisedWarningFlags     -- since 8.0
    | Opt_WarnSimplifiableClassConstraints -- Since 8.2
+   | Opt_WarnCPPUndef                     -- Since 8.2
    deriving (Eq, Show, Enum)
 
 data Language = Haskell98 | Haskell2010
@@ -3287,6 +3288,7 @@ wWarningFlagsDeps = [
     "it has no effect",
   depFlagSpec "auto-orphans"             Opt_WarnAutoOrphans
     "it has no effect",
+  flagSpec "cpp-undef"                   Opt_WarnCPPUndef,
   flagSpec "deferred-type-errors"        Opt_WarnDeferredTypeErrors,
   flagSpec "deferred-out-of-scope-variables"
                                          Opt_WarnDeferredOutOfScopeVariables,
index dd98883..d5fd0c5 100644 (file)
@@ -403,9 +403,8 @@ runCpp :: DynFlags -> [Option] -> IO ()
 runCpp dflags args =   do
   let (p,args0) = pgm_P dflags
       args1 = map Option (getOpts dflags opt_P)
-      args2 = if gopt Opt_WarnIsError dflags
-                 then [Option "-Werror"]
-                 else []
+      args2 = [Option "-Werror" | gopt Opt_WarnIsError dflags]
+                ++ [Option "-Wundef" | wopt Opt_WarnCPPUndef dflags]
   mb_env <- getGccEnv args2
   runSomethingFiltered dflags id  "C pre-processor" p
                        (args0 ++ args1 ++ args2 ++ args) mb_env
index c176a08..8988630 100644 (file)
@@ -56,6 +56,10 @@ Compiler
   and the latter code has no restrictions about whether the data constructors
   of ``T`` are in scope.
 
+- Add warning flag :ghc-flag:`-Wcpp-undef` which passes ``-Wundef`` to the C
+  pre-processor causing the pre-processor to warn on uses of the ``#if``
+  directive on undefined identifiers.
+
 GHCi
 ~~~~
 
index c07058a..c9216b9 100644 (file)
@@ -1007,6 +1007,12 @@ of ``-W(no-)*``.
     be inlined before the rule has a chance to fire. See
     :ref:`rules-inline`.
 
+.. ghc-flag:: -Wcpp-undef
+
+    This flag passes ``-Wundef`` to the C pre-processor (if its being used)
+    which causes the pre-processor to warn on uses of the `#if` directive on
+    undefined identifiers.
+
 If you're feeling really paranoid, the :ghc-flag:`-dcore-lint` option is a good choice.
 It turns on heavyweight intra-pass sanity-checking within GHC. (It checks GHC's
 sanity, not yours.)
diff --git a/testsuite/tests/driver/T12752pass.hs b/testsuite/tests/driver/T12752pass.hs
new file mode 100644 (file)
index 0000000..5826d48
--- /dev/null
@@ -0,0 +1,9 @@
+{-# LANGUAGE CPP #-}
+
+#if SHOULD_PASS
+message :: String
+message = "Hello!"
+#endif
+
+main :: IO ()
+main = putStrLn message
index c6283df..8cd5c2f 100644 (file)
@@ -491,9 +491,11 @@ test('T12135',
      run_command,
      ['$MAKE -s --no-print-directory T12135'])
 
-test('T12192', normal, run_command, ['mkdir foo && (cd foo && {compiler} -v0 ../T12192)']) 
+test('T12192', normal, run_command, ['mkdir foo && (cd foo && {compiler} -v0 ../T12192)'])
 
 test('T10923',
      extra_clean(['T10923.o', 'T10923.hi']),
      run_command,
      ['$MAKE -s --no-print-directory T10923'])
+
+test('T12752pass', normal, compile, ['-DSHOULD_PASS=1 -Wcpp-undef'])
diff --git a/testsuite/tests/driver/should_fail/T12752.hs b/testsuite/tests/driver/should_fail/T12752.hs
new file mode 100644 (file)
index 0000000..3560d00
--- /dev/null
@@ -0,0 +1,10 @@
+{-# LANGUAGE CPP #-}
+
+-- This should fail to compile with "ghc -Wcpp-undef -Werror ...".
+#if this_cpp_identifier_does_not_exist
+message :: String
+message = "This is wrong!"
+#endif
+
+main :: IO ()
+main = putStrLn "Hello"
index f068d65..3d0708b 100644 (file)
@@ -1,2 +1,4 @@
 # --make -o without Main should be an error, not a warning.
 test('T10895', normal, multimod_compile_fail, ['T10895.hs', '-v0 -o dummy'])
+
+test('T12752', expect_fail, compile, ['-Wcpp-undef -Werror'])