Modularize happy

.appveyor.yml

@@ -27,12 +27,9 @@ install:
  - "cabal --version"
  - "ghc --version"
  - "cabal %CABOPTS% v2-update -vverbose+nowrap"
- - "cabal %CABOPTS% v2-install alex --bindir=/hsbin"
- - "alex --version"
 
 build: off
 
 test_script:
  - "cd %APPVEYOR_BUILD_FOLDER%"
- - "make sdist"
- - "make sdist-test-only"
+ - "cabal %CABOPTS% v2-test happy -f -bootstrap"

.github/haskell-ci.patch

@@ -1,6 +1,14 @@
---- workflows/haskell-ci.yml	2021-07-14 19:49:44.000000000 +0200
-+++ workflows/haskell-ci.yml-patched	2021-07-14 19:49:28.000000000 +0200
-@@ -196,7 +196,7 @@
+--- workflows/haskell-ci.yml
++++ workflows/haskell-ci.yml
+@@ -107,6 +107,7 @@ jobs:
+           echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV"
+           HCDIR=/opt/$HCKIND/$HCVER
+           HC=$HCDIR/bin/$HCKIND
++          echo "$HCDIR/bin" >> "$GITHUB_PATH"
+           echo "HC=$HC" >> "$GITHUB_ENV"
+           echo "HCPKG=$HCDIR/bin/$HCKIND-pkg" >> "$GITHUB_ENV"
+           echo "HADDOCK=$HCDIR/bin/haddock" >> "$GITHUB_ENV"
+@@ -226,7 +227,7 @@ jobs:
            cat cabal.project.local
        - name: dump install plan
          run: |
@@ -9,19 +17,19 @@
            cabal-plan
        - name: cache
          uses: actions/cache@v2
-@@ -206,17 +206,19 @@
+@@ -236,17 +237,25 @@ jobs:
            restore-keys: ${{ runner.os }}-${{ matrix.compiler }}-
        - name: install dependencies
          run: |
 -          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all
 -          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all
 -      - name: build w/o tests
-+          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all
++          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests --dependencies-only -j2 all
 +          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all
 +      - name: build w/o tests and install
          run: |
 -          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
-+          $CABAL v2-install --reinstall --overwrite-policy=always --flags=-bootstrap $ARG_COMPILER --disable-tests --disable-benchmarks all
++          $CABAL v2-install --reinstall --overwrite-policy=always --flags=-bootstrap $ARG_COMPILER --disable-tests happy
        - name: build
          run: |
 -          $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always
@@ -30,14 +38,20 @@
          run: |
 -          $CABAL v2-test $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
 +          export HAPPY=$HOME/.cabal/bin/happy
-+          export HC=$HC
-+          $CABAL v2-test --flags=-bootstrap $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
++          export HC
++          export CABAL
++          if [[ $(ghc --numeric-version) == "8.10.1" ]]
++          then
++            make sdist-test
++          else
++            $CABAL v2-test --flags=-bootstrap $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
++          fi
        - name: cabal check
          run: |
-           cd ${PKGDIR_happy} || false
-@@ -224,4 +226,4 @@
+           cd ${PKGDIR_happy_frontend} || false
+@@ -267,4 +276,4 @@ jobs:
        - name: unconstrained build
          run: |
            rm -f cabal.project.local
 -          $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
-+          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests --disable-benchmarks all
++          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests all

.github/workflows/haskell-ci.yml

@@ -1,16 +1,16 @@
 # This GitHub workflow config has been generated by a script via
 #
-#   haskell-ci 'github' 'happy.cabal'
+#   haskell-ci 'github' 'cabal.project'
 #
 # To regenerate the script (for example after adjusting tested-with) run
 #
 #   haskell-ci regenerate
 #
 # For more information, see https://github.com/haskell-CI/haskell-ci
 #
-# version: 0.13.20210606
+# version: 0.13.20210621
 #
-# REGENDATA ("0.13.20210606",["github","happy.cabal"])
+# REGENDATA ("0.13.20210621",["github","cabal.project"])
 #
 name: Haskell-CI
 on:
@@ -107,6 +107,7 @@ jobs:
           echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV"
           HCDIR=/opt/$HCKIND/$HCVER
           HC=$HCDIR/bin/$HCKIND
+          echo "$HCDIR/bin" >> "$GITHUB_PATH"
           echo "HC=$HC" >> "$GITHUB_ENV"
           echo "HCPKG=$HCDIR/bin/$HCKIND-pkg" >> "$GITHUB_ENV"
           echo "HADDOCK=$HCDIR/bin/haddock" >> "$GITHUB_ENV"
@@ -169,7 +170,14 @@ jobs:
       - name: initial cabal.project for sdist
         run: |
           touch cabal.project
-          echo "packages: $GITHUB_WORKSPACE/source/." >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/frontend" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/tabular" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/backend" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/backend-glr" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/grammar" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/cli" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/test" >> cabal.project
+          echo "packages: $GITHUB_WORKSPACE/source/packages/happy" >> cabal.project
           cat cabal.project
       - name: sdist
         run: |
@@ -181,17 +189,52 @@ jobs:
           find sdist -maxdepth 1 -type f -name '*.tar.gz' -exec tar -C $GITHUB_WORKSPACE/unpacked -xzvf {} \;
       - name: generate cabal.project
         run: |
+          PKGDIR_happy_frontend="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-frontend-[0-9.]*')"
+          echo "PKGDIR_happy_frontend=${PKGDIR_happy_frontend}" >> "$GITHUB_ENV"
+          PKGDIR_happy_tabular="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-tabular-[0-9.]*')"
+          echo "PKGDIR_happy_tabular=${PKGDIR_happy_tabular}" >> "$GITHUB_ENV"
+          PKGDIR_happy_backend="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-backend-[0-9.]*')"
+          echo "PKGDIR_happy_backend=${PKGDIR_happy_backend}" >> "$GITHUB_ENV"
+          PKGDIR_happy_backend_glr="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-backend-glr-[0-9.]*')"
+          echo "PKGDIR_happy_backend_glr=${PKGDIR_happy_backend_glr}" >> "$GITHUB_ENV"
+          PKGDIR_happy_cli="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-cli-[0-9.]*')"
+          echo "PKGDIR_happy_cli=${PKGDIR_happy_cli}" >> "$GITHUB_ENV"
+          PKGDIR_happy_grammar="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-grammar-[0-9.]*')"
+          echo "PKGDIR_happy_grammar=${PKGDIR_happy_grammar}" >> "$GITHUB_ENV"
+          PKGDIR_happy_test="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-test-[0-9.]*')"
+          echo "PKGDIR_happy_test=${PKGDIR_happy_test}" >> "$GITHUB_ENV"
           PKGDIR_happy="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/happy-[0-9.]*')"
           echo "PKGDIR_happy=${PKGDIR_happy}" >> "$GITHUB_ENV"
           rm -f cabal.project cabal.project.local
           touch cabal.project
           touch cabal.project.local
+          echo "packages: ${PKGDIR_happy_frontend}" >> cabal.project
+          echo "packages: ${PKGDIR_happy_tabular}" >> cabal.project
+          echo "packages: ${PKGDIR_happy_backend}" >> cabal.project
+          echo "packages: ${PKGDIR_happy_backend_glr}" >> cabal.project
+          echo "packages: ${PKGDIR_happy_grammar}" >> cabal.project
+          echo "packages: ${PKGDIR_happy_cli}" >> cabal.project
+          echo "packages: ${PKGDIR_happy_test}" >> cabal.project
           echo "packages: ${PKGDIR_happy}" >> cabal.project
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy-frontend" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy-tabular" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy-backend" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy-backend-glr" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy-grammar" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy-cli" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy-test" >> cabal.project ; fi
+          if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
           if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "package happy" >> cabal.project ; fi
           if [ $((HCNUMVER >= 80200)) -ne 0 ] ; then echo "    ghc-options: -Werror=missing-methods" >> cabal.project ; fi
           cat >> cabal.project <<EOF
           EOF
-          $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(containers|happy|mtl|transformers)$/; }' >> cabal.project.local
+          $HCPKG list --simple-output --names-only | perl -ne 'for (split /\s+/) { print "constraints: $_ installed\n" unless /^(containers|happy|happy-backend|happy-backend-glr|happy-grammar|happy-cli|happy-frontend|happy-tabular|happy-test|mtl|transformers)$/; }' >> cabal.project.local
           cat cabal.project
           cat cabal.project.local
       - name: dump install plan
@@ -206,24 +249,47 @@ jobs:
           restore-keys: ${{ runner.os }}-${{ matrix.compiler }}-
       - name: install dependencies
         run: |
-          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all
+          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests --dependencies-only -j2 all
           $CABAL v2-build --flags=-bootstrap $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all
       - name: build w/o tests and install
         run: |
-          $CABAL v2-install --reinstall --overwrite-policy=always --flags=-bootstrap $ARG_COMPILER --disable-tests --disable-benchmarks all
+          $CABAL v2-install --reinstall --overwrite-policy=always --flags=-bootstrap $ARG_COMPILER --disable-tests happy
       - name: build
         run: |
           $CABAL v2-build --flags=-bootstrap $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always
       - name: tests
         run: |
           export HAPPY=$HOME/.cabal/bin/happy
-          export HC=$HC
-          $CABAL v2-test --flags=-bootstrap $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
+          export HC
+          export CABAL
+          if [[ $(ghc --numeric-version) == "8.10.1" ]]
+          then
+            make sdist-test
+          else
+            $CABAL v2-test --flags=-bootstrap $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --test-show-details=direct
+          fi
       - name: cabal check
         run: |
+          cd ${PKGDIR_happy_frontend} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_happy_tabular} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_happy_backend} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_happy_backend_glr} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_happy_grammar} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_happy_cli} || false
+          ${CABAL} -vnormal check
+          cd ${PKGDIR_happy_test} || false
+          ${CABAL} -vnormal check
           cd ${PKGDIR_happy} || false
           ${CABAL} -vnormal check
+      - name: haddock
+        run: |
+          $CABAL v2-haddock $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
       - name: unconstrained build
         run: |
           rm -f cabal.project.local
-          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests --disable-benchmarks all
+          $CABAL v2-build --flags=-bootstrap $ARG_COMPILER --disable-tests all

ChangeLog.md

@@ -1,3 +1,7 @@
+## Unreleased - 1.21.0
+
+- Split `happy` into multiple packages
+
 ## 1.20.0
 
 * Fix #121: the -i flag produces an .info file even if the `%expect`

DEVELOPER.md

@@ -7,7 +7,7 @@ CI on GitHub Actions
 
 The GHC workflow file `.github/workflows/haskell-ci.yml` is generated by:
 
-    haskell-ci github happy.cabal
+    haskell-ci github packages/happy/happy.cabal
     patch --input=.github/haskell-ci.patch .github/workflows/haskell-ci.yml
 
 The patch introduces happy specifics to the build and test process that

Makefile

@@ -1,48 +1,13 @@
-CABAL = cabal
-
-HAPPY_VER = `awk '/^version:/ { print $$2 }' happy.cabal`
-
-ALEX = alex
-ALEX_OPTS = -g
-
-SDIST_DIR=dist-newstyle/sdist
-
-sdist ::
-	@case "`$(CABAL) --numeric-version`" in \
-		2.[2-9].* | [3-9].* ) ;; \
-		* ) echo "Error: needs cabal 2.2.0.0 or later (but got : `$(CABAL) --numeric-version`)" ; exit 1 ;; \
-	esac
-	@if [ "`git status -s`" != '' ]; then \
-		echo "Error: Tree is not clean"; \
-		exit 1; \
-	fi
-	$(CABAL) v2-sdist
-	@if [ ! -f "${SDIST_DIR}/happy-$(HAPPY_VER).tar.gz" ]; then \
-		echo "Error: source tarball not found: dist/happy-$(HAPPY_VER).tar.gz"; \
-		exit 1; \
-	fi
-	git checkout .
-	git clean -f
-
-sdist-test :: sdist sdist-test-only
-	@rm -rf "${SDIST_DIR}/happy-${HAPPY_VER}/"
-
-sdist-test-only ::
-	@if [ ! -f "${SDIST_DIR}/happy-$(HAPPY_VER).tar.gz" ]; then \
-		echo "Error: source tarball not found: ${SDIST_DIR}/happy-$(HAPPY_VER).tar.gz"; \
-		exit 1; \
-	fi
-	rm -rf "${SDIST_DIR}/happy-$(HAPPY_VER)/"
-	tar -xf "${SDIST_DIR}/happy-$(HAPPY_VER).tar.gz" -C ${SDIST_DIR}/
-	echo "packages: ." > "${SDIST_DIR}/happy-$(HAPPY_VER)/cabal.project"
-	echo "tests: True" >> "${SDIST_DIR}/happy-$(HAPPY_VER)/cabal.project"
-	cd "${SDIST_DIR}/happy-$(HAPPY_VER)/" \
-		&& cabal v2-build all --flag -bootstrap \
-		&& cabal v2-install --flag -bootstrap --installdir="./bootstrap-root" \
-		&& cabal v2-test all -j --flag -bootstrap \
-		&& export PATH=./bootstrap-root:$$PATH \
-		&& cabal v2-build all --flag +bootstrap \
-		&& cabal v2-test all -j --flag +bootstrap
-	@echo ""
-	@echo "Success! ${SDIST_DIR}/happy-$(HAPPY_VER).tar.gz is ready for distribution!"
-	@echo ""
+ENV = .local.env
+HC ?= ghc
+CABAL ?= cabal
+
+EXECUTABLE = "happy"
+PACKAGES = ["happy", "happy-cli", "happy-grammar", "happy-frontend", "happy-tabular", "happy-backend", "happy-test"]
+BOOTSTRAPPING = True
+
+sdist-test ::
+	rm -f ${ENV}
+	$(CABAL) v2-install --lib happy-test --package-env ${ENV}
+	$(HC) -package-env ${ENV} -e 'Happy.Test.SDist.sdist_test "${CABAL}" "$(shell pwd)" ${EXECUTABLE} ${PACKAGES} ${BOOTSTRAPPING}'
+	rm -f ${ENV}

README.md

@@ -11,12 +11,11 @@ Happy is a parser generator for Haskell 98 (and later).
 
 Happy is built using Cabal.  First install GHC, then:
 ```
-  $ cabal install
+  $ cabal install happy
 ```
-If you obtained the development version from https://github.com/simonmar/happy/,
-install via:
+If you don't have a local version of `happy` (yet), you can also install a non-bootstrapped version via:
 ```
-  $ make sdist && cabal install
+  $ cabal install happy -f -bootstrap
 ```
 
 Complete documentation can be found in the directory 'doc', in

cabal.project

@@ -1,2 +1,9 @@
 packages:
-  ./
+ packages/backend,
+ packages/backend-glr,
+ packages/cli,
+ packages/frontend,
+ packages/grammar,
+ packages/happy,
+ packages/tabular,
+ packages/test

examples/Calc.ly

@@ -1,6 +1,6 @@
 > {
 > module Calc where
-> import Char
+> import Data.Char
 > }
 
 First thing to declare is the name of your parser,

examples/ErrorTest.ly

@@ -2,7 +2,7 @@
 Test for monadic Happy Parsers, Simon Marlow 1996.
 
 > {
-> import Char
+> import Data.Char
 > }
 
 > %name calc

examples/LexerTest.ly

@@ -2,7 +2,7 @@
 Test for monadic Happy Parsers, Simon Marlow 1996.
 
 > {
-> import Char
+> import Data.Char
 > }
 
 > %name calc

examples/MonadTest.ly

@@ -2,7 +2,7 @@
 Tests %monad without %lexer.
 
 > {
-> import Char
+> import Data.Char
 > }
 
 > %name calc

packages/backend-glr/LICENSE

@@ -0,0 +1 @@
+../../LICENSE