Fix: "cabal haddock" uses CPP overzealously

Until recently we supported ancient versions of Haddock, pre v2.0.  To
support the CPP extension with such versions, cabal had to invoke the
CPP before invoking Haddock on the output.  For simplicity cabal would
invoke the CPP on all Haskell files, if any Haskell file required CPP.
However, invoking CPP on a file which does not require it can cause
build failures.

Haddock v2.0+ supports the CPP via GHC, and even automatically
preprocesses any file with the {-# LANGUAGE CPP #-} pragma. Hence we
simply need only tell Haddock to enable the CPP when the CPP is a
package level default extension.

Fixes issue #1808.

Cabal/Cabal.cabal

@@ -86,6 +86,7 @@ extra-source-files:
  tests/PackageTests/Haddock/CPP.hs
  tests/PackageTests/Haddock/Literate.lhs
  tests/PackageTests/Haddock/my.cabal
+ tests/PackageTests/Haddock/NoCPP.hs
  tests/PackageTests/Haddock/Simple.hs
  tests/PackageTests/OrderFlags/Foo.hs
  tests/PackageTests/OrderFlags/my.cabal

Cabal/Distribution/Simple/Haddock.hs

@@ -54,7 +54,7 @@ import Distribution.Package
  , PackageName(..), packageName )
 import qualified Distribution.ModuleName as ModuleName
 import Distribution.PackageDescription as PD
- ( PackageDescription(..), BuildInfo(..), allExtensions
+ ( PackageDescription(..), BuildInfo(..), usedExtensions
  , Library(..), hasLibs, Executable(..)
  , TestSuite(..), TestSuiteInterface(..)
  , Benchmark(..), BenchmarkInterface(..) )
@@ -388,7 +388,7 @@ getGhcCppOpts haddockVersion bi =
  ghcOptCppOptions = defines
  }
  where
- needsCpp = EnableExtension CPP `elem` allExtensions bi
+ needsCpp = EnableExtension CPP `elem` usedExtensions bi
  defines = [haddockVersionMacro]
  haddockVersionMacro = "-D__HADDOCK_VERSION__="
  ++ show (v1 * 1000 + v2 * 10 + v3)

Cabal/tests/PackageTests/Haddock/Check.hs

@@ -26,7 +26,7 @@ suite ghcPath = TestCase $ do
  assertHaddockSucceeded hResult
 
  let docFiles = map (haddocksDir </>)
- ["CPP.html", "Literate.html", "Simple.html"]
+ ["CPP.html", "Literate.html", "NoCPP.html", "Simple.html"]
  mapM_ (assertFindInFile "For hiding needles.") docFiles
 
 assertFindInFile :: String -> FilePath -> Assertion

Cabal/tests/PackageTests/Haddock/NoCPP.hs

@@ -0,0 +1,8 @@
+module NoCPP (Haystack) where
+
+-- | For hiding needles.
+data Haystack = Haystack
+
+-- | Causes a build failure if the CPP language extension is enabled.
+stringGap = "Foo\
+\Bar"

Cabal/tests/PackageTests/Haddock/my.cabal

@@ -11,6 +11,6 @@ description:
  Check that Cabal successfully invokes Haddock.
 
 Library
- exposed-modules: CPP, Literate, Simple
+ exposed-modules: CPP, Literate, NoCPP, Simple
  other-extensions: CPP
  build-depends: base