Merge pull request #6867 from phadej/cabal-install-zinza

Template cabal-install.cabal using zinza

Author: phadej

.github/workflows/quick-jobs.yml

@@ -44,6 +44,7 @@ jobs:
           make spdx
           make templates
           make github-actions
+          make cabal-install-cabal
       - name: Check that diff is clean
         run: |
           git status > /dev/null

.github/workflows/windows.yml

@@ -49,7 +49,7 @@ jobs:
         run: cabal v2-update
       - uses: actions/checkout@v2
       - name: make cabal-install-dev
-        run: runghc cabal-dev-scripts/src/Preprocessor.hs -o cabal-install/cabal-install.cabal -f CABAL_FLAG_LIB cabal-install/cabal-install.cabal.pp
+        run: cp cabal-install/cabal-install.cabal.dev cabal-install/cabal-install.cabal
       # We cannot ask for all dependencies, but we can for Cabal.
       - name: cabal v2-build Cabal --only-dependencies
         run: cabal v2-build Cabal --only-dependencies

Makefile

@@ -64,12 +64,19 @@ Cabal/doc/buildinfo-fields-reference.rst : phony
 
 # cabal-install.cabal file generation
 
-cabal-install-prod : cabal-install/cabal-install.cabal.pp
-	runghc -package-env=- cabal-dev-scripts/src/Preprocessor.hs -o cabal-install/cabal-install.cabal cabal-install/cabal-install.cabal.pp
-	git update-index --no-assume-unchanged cabal-install/cabal-install.cabal
+cabal-install-cabal : phony cabal-install/cabal-install.cabal.dev cabal-install/cabal-install.cabal.prod
 
-cabal-install-dev : cabal-install/cabal-install.cabal.pp
-	runghc -package-env=- cabal-dev-scripts/src/Preprocessor.hs -o cabal-install/cabal-install.cabal -f CABAL_FLAG_LIB cabal-install/cabal-install.cabal.pp
+cabal-install/cabal-install.cabal.dev : cabal-install/cabal-install.cabal.zinza
+	cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-cabal-install-cabal -- True cabal-install/cabal-install.cabal.zinza cabal-install/cabal-install.cabal.dev
+
+cabal-install/cabal-install.cabal.prod : cabal-install/cabal-install.cabal.zinza
+	cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-cabal-install-cabal -- False cabal-install/cabal-install.cabal.zinza cabal-install/cabal-install.cabal.prod
+
+cabal-install-prod : cabal-install/cabal-install.cabal.prod
+	cp cabal-install/cabal-install.cabal.prod cabal-install/cabal-install.cabal
+
+cabal-install-dev : cabal-install/cabal-install.cabal.dev
+	cp cabal-install/cabal-install.cabal.dev cabal-install/cabal-install.cabal
 	@echo "tell git to ignore changes to cabal-install.cabal:"
 	@echo "git update-index --assume-unchanged cabal-install/cabal-install.cabal"
 
@@ -98,7 +105,7 @@ github-actions : .github/workflows/windows.yml
 # We need to generate cabal-install-dev so the test modules are in .cabal file!
 gen-extra-source-files-cli :
 	$(MAKE) cabal-install-dev
-	cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-extra-source-files -- $$(pwd)/cabal-install/cabal-install.cabal.pp $$(pwd)/cabal-install/cabal-install.cabal
+	cabal v2-run --builddir=dist-newstyle-meta --project-file=cabal.project.meta gen-extra-source-files -- $$(pwd)/cabal-install/cabal-install.cabal.zinza $$(pwd)/cabal-install/cabal-install.cabal
 	$(MAKE) cabal-install-prod
 
 # ghcid

appveyor.yml

@@ -47,7 +47,7 @@ cache:
   - "C:\\sr"
 
 build_script:
-  - runghc cabal-dev-scripts/src/Preprocessor.hs -o cabal-install/cabal-install.cabal -f CABAL_FLAG_LIB cabal-install/cabal-install.cabal.pp
+  - cp cabal-install/cabal-install.cabal.dev cabal-install/cabal-install.cabal
   - cabal %CABOPTS% v2-configure --enable-tests
   - appveyor-retry cabal %CABOPTS% v2-build lib:Cabal --only-dependencies
   - cabal %CABOPTS% v2-build lib:Cabal

boot/ci-quick-jobs.template.yml

@@ -44,6 +44,7 @@ jobs:
           make spdx
           make templates
           make github-actions
+          make cabal-install-cabal
       - name: Check that diff is clean
         run: |
           git status > /dev/null

boot/ci-windows.template.yml

@@ -56,7 +56,7 @@ jobs:
         run: cabal v2-update
       - uses: actions/checkout@v2
       - name: make cabal-install-dev
-        run: runghc cabal-dev-scripts/src/Preprocessor.hs -o cabal-install/cabal-install.cabal -f CABAL_FLAG_LIB cabal-install/cabal-install.cabal.pp
+        run: cp cabal-install/cabal-install.cabal.dev cabal-install/cabal-install.cabal
       # We cannot ask for all dependencies, but we can for Cabal.
       - name: cabal v2-build Cabal --only-dependencies
         run: cabal v2-build Cabal --only-dependencies

cabal-dev-scripts/cabal-dev-scripts.cabal

@@ -81,6 +81,17 @@ executable gen-cabal-macros
     , template-haskell
     , zinza             ^>=0.2
 
+executable gen-cabal-install-cabal
+  default-language: Haskell2010
+  main-is:          GenCabalInstallCabal.hs
+  hs-source-dirs:   src
+  ghc-options:      -Wall
+  build-depends:
+    , base
+    , bytestring
+    , Cabal
+    , zinza             ^>=0.2
+
 executable analyse-imports
   default-language: Haskell2010
   main-is:          AnalyseImports.hs

cabal-dev-scripts/src/GenCabalInstallCabal.hs

@@ -0,0 +1,49 @@
+{-# LANGUAGE DeriveGeneric       #-}
+{-# LANGUAGE ScopedTypeVariables #-}
+module Main (main) where
+
+import Control.Exception  (SomeException (..), catch, displayException)
+import GHC.Generics       (Generic)
+import System.Environment (getArgs)
+import System.Exit        (exitFailure)
+
+import qualified Zinza as Z
+
+withIO :: (Bool -> FilePath -> FilePath -> IO a) -> IO a
+withIO k = do
+    args <- getArgs
+    case args of
+        [dev',src,tgt]
+            | Just dev <- parseBool dev'
+            -> k dev src tgt `catch` \(SomeException e) -> do
+                putStrLn $ "Exception: " ++ displayException e
+                exitFailure
+        _         -> do
+            putStrLn "Usage cabal v2-run ... source.temeplate.ext target.ext"
+            exitFailure
+  where
+    parseBool "True"  = Just True
+    parseBool "False" = Just False
+    parseBool _       = Nothing
+    
+
+main :: IO ()
+main = withIO $ \dev src tgt -> do
+    render <- Z.parseAndCompileTemplateIO src
+    contents <- render $ Z dev ()
+    writeFile tgt contents
+
+-------------------------------------------------------------------------------
+-- Data
+-------------------------------------------------------------------------------
+
+data Z = Z
+    { zDev    :: Bool
+    , zUnused :: ()
+    }
+  deriving (Generic)
+
+instance Z.Zinza Z where
+    toType    = Z.genericToTypeSFP
+    toValue   = Z.genericToValueSFP
+    fromValue = Z.genericFromValueSFP