Drop the dead build-tool greencard (#10908)

* Drop the dead build-tool greencard

This tool does not build with GHC 7.10 and up, so can be considered
dead by now.

Cabal will now pretend it never knew about `greencard`.
I am not sure of the repercussions of this, e.g. when we want to
revise a package on hackage that uses `build-tools: greencard`, will
the parser or checker blow up on us?

* Changelog entry for PR #10908 (remove greencard)

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

Author: andreasabel

Cabal/src/Distribution/Simple/BuildToolDepends.hs

@@ -34,7 +34,6 @@ desugarBuildToolSimple pname exeNames (LegacyExeDependency name reqVer)
       , "hsc2hs"
       , "c2hs"
       , "cpphs"
-      , "greencard"
       , "hspec-discover"
       ]
     allowMap = Map.fromList $ flip map allowlist $ \n ->

Cabal/src/Distribution/Simple/PreProcess.hs

@@ -35,7 +35,6 @@ module Distribution.Simple.PreProcess
   , runSimplePreProcessor
   , ppCpp
   , ppCpp'
-  , ppGreenCard
   , ppC2hs
   , ppHsc2hs
   , ppHappy
@@ -383,20 +382,6 @@ preprocessFile mbWorkDir searchLoc buildLoc forSDist baseFile verbosity builtinS
 
 -- ------------------------------------------------------------
 
-ppGreenCard :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
-ppGreenCard _ lbi _ =
-  PreProcessor
-    { platformIndependent = False
-    , ppOrdering = unsorted
-    , runPreProcessor = mkSimplePreProcessor $ \inFile outFile verbosity ->
-        runDbProgramCwd
-          verbosity
-          (mbWorkDirLBI lbi)
-          greencardProgram
-          (withPrograms lbi)
-          (["-tffi", "-o" ++ outFile, inFile])
-    }
-
 -- This one is useful for preprocessors that can't handle literate source.
 -- We also need a way to chain preprocessors.
 ppUnlit :: PreProcessor
@@ -873,11 +858,10 @@ standardPP lbi prog args =
 ppSuffixes :: [PPSuffixHandler] -> [Suffix]
 ppSuffixes = map fst
 
--- | Standard preprocessors: GreenCard, c2hs, hsc2hs, happy, alex and cpphs.
+-- | Standard preprocessors: c2hs, hsc2hs, happy, alex and cpphs.
 knownSuffixHandlers :: [PPSuffixHandler]
 knownSuffixHandlers =
-  [ (Suffix "gc", ppGreenCard)
-  , (Suffix "chs", ppC2hs)
+  [ (Suffix "chs", ppC2hs)
   , (Suffix "hsc", ppHsc2hs)
   , (Suffix "x", ppAlex)
   , (Suffix "y", ppHappy)

Cabal/src/Distribution/Simple/Program.hs

@@ -125,7 +125,6 @@ module Distribution.Simple.Program
   , hscolourProgram
   , doctestProgram
   , haddockProgram
-  , greencardProgram
   , ldProgram
   , tarProgram
   , cppProgram

Cabal/src/Distribution/Simple/Program/Builtin.hs

@@ -36,7 +36,6 @@ module Distribution.Simple.Program.Builtin
   , hscolourProgram
   , doctestProgram
   , haddockProgram
-  , greencardProgram
   , ldProgram
   , tarProgram
   , cppProgram
@@ -89,7 +88,6 @@ builtinPrograms =
   , hsc2hsProgram
   , c2hsProgram
   , cpphsProgram
-  , greencardProgram
   , -- platform toolchain
     gccProgram
   , arProgram
@@ -347,9 +345,6 @@ haddockProgram =
     , programNormaliseArgs = \_ _ args -> args
     }
 
-greencardProgram :: Program
-greencardProgram = simpleProgram "greencard"
-
 ldProgram :: Program
 ldProgram =
   (simpleProgram "ld")

cabal-install/src/Distribution/Client/Init/Utils.hs

@@ -64,7 +64,6 @@ data SourceFileEntry = SourceFileEntry
 knownSuffixHandlers :: CabalSpecVersion -> String -> String
 knownSuffixHandlers v s
   | v < CabalSpecV3_0 = case s of
-      ".gc" -> "greencard"
       ".chs" -> "chs"
       ".hsc" -> "hsc2hs"
       ".x" -> "alex"
@@ -73,7 +72,6 @@ knownSuffixHandlers v s
       ".cpphs" -> "cpp"
       _ -> ""
   | otherwise = case s of
-      ".gc" -> "greencard:greencard"
       ".chs" -> "chs:chs"
       ".hsc" -> "hsc2hs:hsc2hs"
       ".x" -> "alex:alex"

cabal-install/tests/IntegrationTests2.hs

@@ -2705,7 +2705,6 @@ testConfigOptionComments = do
   "  -- ghc-pkg-location" `assertHasCommentLine` "ghc-pkg-location"
   "  -- ghcjs-location" `assertHasCommentLine` "ghcjs-location"
   "  -- ghcjs-pkg-location" `assertHasCommentLine` "ghcjs-pkg-location"
-  "  -- greencard-location" `assertHasCommentLine` "greencard-location"
   "  -- haddock-location" `assertHasCommentLine` "haddock-location"
   "  -- happy-location" `assertHasCommentLine` "happy-location"
   "  -- haskell-suite-location" `assertHasCommentLine` "haskell-suite-location"
@@ -2731,7 +2730,6 @@ testConfigOptionComments = do
   "  -- ghc-pkg-options" `assertHasCommentLine` "ghc-pkg-options"
   "  -- ghcjs-options" `assertHasCommentLine` "ghcjs-options"
   "  -- ghcjs-pkg-options" `assertHasCommentLine` "ghcjs-pkg-options"
-  "  -- greencard-options" `assertHasCommentLine` "greencard-options"
   "  -- haddock-options" `assertHasCommentLine` "haddock-options"
   "  -- happy-options" `assertHasCommentLine` "happy-options"
   "  -- haskell-suite-options" `assertHasCommentLine` "haskell-suite-options"

cabal-testsuite/PackageTests/AutogenModules/Package/setup.cabal.out

@@ -20,5 +20,5 @@ Distribution quality errors:
 Note: the public hackage server would reject this package.
 Building source dist for AutogenModules-0.1...
 Error: [Cabal-6421]
-Could not find module: MyLibHelperModule with any suffix: ["gc","chs","hsc","x","y","ly","cpphs","hs","lhs","hsig","lhsig"].
+Could not find module: MyLibHelperModule with any suffix: ["chs","hsc","x","y","ly","cpphs","hs","lhs","hsig","lhsig"].
 If the module is autogenerated it should be added to 'autogen-modules'.

cabal-testsuite/PackageTests/AutogenModules/Package/setup.out

@@ -20,5 +20,5 @@ Distribution quality errors:
 Note: the public hackage server would reject this package.
 Building source dist for AutogenModules-0.1...
 Error: [Cabal-6421]
-Could not find module: MyLibHelperModule with any suffix: ["gc","chs","hsc","x","y","ly","cpphs","hs","lhs","hsig","lhsig"].
+Could not find module: MyLibHelperModule with any suffix: ["chs","hsc","x","y","ly","cpphs","hs","lhs","hsig","lhsig"].
 If the module is autogenerated it should be added to 'autogen-modules'.

changelog.d/pr-10908.md

@@ -0,0 +1,8 @@
+---
+synopsis: Remove dead build-tool greencard
+packages: [Cabal,cabal-install]
+prs: 10908
+---
+
+Remove knowledge of the build-tool `greencard` (non-existing since GHC 7.10)
+and the connect of the `.gc` extension to this build-tool.

doc/cabal-package-description-file.rst

@@ -277,7 +277,6 @@ files, i.e. with names ending in "``.hs``" or "``.lhs``", or to inputs for
 various Haskell preprocessors. The simple build infrastructure understands the
 extensions:
 
--  ``.gc`` (:hackage-pkg:`greencard`)
 -  ``.chs`` (:hackage-pkg:`c2hs`)
 -  ``.hsc`` (:hackage-pkg:`hsc2hs`)
 -  ``.y`` and ``.ly`` (happy_)
@@ -1749,8 +1748,6 @@ system-dependent values for these fields.
     +--------------------------+-----------------------------------+-----------------+
     | ``cpphs``                | ``cpphs:cpphs``                   |                 |
     +--------------------------+-----------------------------------+-----------------+
-    | ``greencard``            | ``greencard:greencard``           |                 |
-    +--------------------------+-----------------------------------+-----------------+
     | ``haddock``              | ``haddock:haddock``               |                 |
     +--------------------------+-----------------------------------+-----------------+
     | ``happy``                | ``happy:happy``                   |                 |

doc/config.rst

@@ -341,8 +341,6 @@ The list of known programs is:
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
 | ``ghcjs-pkg``         |                                                                                                                                    |
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
-| ``greencard``         | Greencard hasn't been updated since 2014, it doesn't build with newer GHCs `<https://hackage.haskell.org/package/greencard>`_      |
-+-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
 | ``haddock``           | `<https://haskell-haddock.readthedocs.io/latest/>`_                                                                                |
 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------+
 | ``happy``             | `<https://haskell-happy.readthedocs.io/en/latest/>`_                                                                               |

test/IntegrationTests2/config/default-config

@@ -201,7 +201,6 @@ program-locations
   -- ghc-pkg-location:
   -- ghcjs-location:
   -- ghcjs-pkg-location:
-  -- greencard-location:
   -- haddock-location:
   -- happy-location:
   -- haskell-suite-location:
@@ -229,7 +228,6 @@ program-default-options
   -- ghc-pkg-options:
   -- ghcjs-options:
   -- ghcjs-pkg-options:
-  -- greencard-options:
   -- haddock-options:
   -- happy-options:
   -- haskell-suite-options:

test/IntegrationTests2/nix-config/default-config

@@ -201,7 +201,6 @@ program-locations
   -- ghc-pkg-location:
   -- ghcjs-location:
   -- ghcjs-pkg-location:
-  -- greencard-location:
   -- haddock-location:
   -- happy-location:
   -- haskell-suite-location:
@@ -229,7 +228,6 @@ program-default-options
   -- ghc-pkg-options:
   -- ghcjs-options:
   -- ghcjs-pkg-options:
-  -- greencard-options:
   -- haddock-options:
   -- happy-options:
   -- haskell-suite-options:

tests/IntegrationTests2/config/default-config

@@ -203,7 +203,6 @@ program-locations
   -- ghc-pkg-location:
   -- ghcjs-location:
   -- ghcjs-pkg-location:
-  -- greencard-location:
   -- haddock-location:
   -- happy-location:
   -- haskell-suite-location:
@@ -231,7 +230,6 @@ program-default-options
   -- ghc-pkg-options:
   -- ghcjs-options:
   -- ghcjs-pkg-options:
-  -- greencard-options:
   -- haddock-options:
   -- happy-options:
   -- haskell-suite-options:

tests/IntegrationTests2/nix-config/default-config

@@ -201,7 +201,6 @@ program-locations
   -- ghc-pkg-location:
   -- ghcjs-location:
   -- ghcjs-pkg-location:
-  -- greencard-location:
   -- haddock-location:
   -- happy-location:
   -- haskell-suite-location:
@@ -229,7 +228,6 @@ program-default-options
   -- ghc-pkg-options:
   -- ghcjs-options:
   -- ghcjs-pkg-options:
-  -- greencard-options:
   -- haddock-options:
   -- happy-options:
   -- haskell-suite-options: