Move Paths_happy_lib into tabular to prevent a Cabal bug concerning…

… --libsubdir (#328) Not only do we need to move the module, we also need to reexport it under a different name lest we get an unhelpful error suggesting to add `Paths_happy_lib` to the other-modules section of `backend-{lalr,glr}`. Fixes #328.
haskell · Jan 17, 2025 · 1f11e09 · 1f11e09
1 parent 27fb1cc
commit 1f11e09
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 9 deletions.
diff --git a/lib/backend-glr/src/Happy/Backend/GLR.hs b/lib/backend-glr/src/Happy/Backend/GLR.hs
@@ -1,6 +1,6 @@
 module Happy.Backend.GLR where
 
-import Paths_happy_lib
+import Happy.Paths
 
 glrBackendDataDir :: IO String
 glrBackendDataDir = getDataDir
diff --git a/lib/backend-glr/src/Happy/Backend/GLR/ProduceCode.lhs b/lib/backend-glr/src/Happy/Backend/GLR/ProduceCode.lhs
@@ -17,7 +17,7 @@ This module is designed as an extension to the Haskell parser generator Happy.
 >                       , Options
 >                       ) where
 
-> import Paths_happy_lib ( version )
+> import Happy.Paths ( version )
 > import Happy.Grammar
 > import Happy.Grammar.ExpressionWithHole ( substExpressionWithHole )
 > import Happy.Tabular.LALR

diff --git a/lib/backend-lalr/src/Happy/Backend/LALR.hs b/lib/backend-lalr/src/Happy/Backend/LALR.hs
@@ -1,6 +1,6 @@
 module Happy.Backend.LALR where
 
-import Paths_happy_lib
+import Happy.Paths
 import Data.Char
 
 lalrBackendDataDir :: IO String

diff --git a/lib/backend-lalr/src/Happy/Backend/LALR/ProduceCode.lhs b/lib/backend-lalr/src/Happy/Backend/LALR/ProduceCode.lhs
@@ -6,7 +6,7 @@ The code generator.
 
 > module Happy.Backend.LALR.ProduceCode (produceParser) where
 
-> import Paths_happy_lib  ( version )
+> import Happy.Paths  ( version )
 > import Data.Version              ( showVersion )
 > import Happy.Grammar
 > import Happy.Grammar.ExpressionWithHole ( substExpressionWithHole )

diff --git a/lib/happy-lib.cabal b/lib/happy-lib.cabal
@@ -106,7 +106,23 @@ library tabular
                        Happy.Tabular.First,
                        Happy.Tabular.Info,
                        Happy.Tabular.LALR,
-                       Happy.Tabular.NameSet
+                       Happy.Tabular.NameSet,
+  -- The following 3 lines constitute a workaround for cabal#10687, triggered by #328.
+  -- The setup in #328 triggers a clashing use of Paths_happy_lib between
+  -- `backend-lalr` and `backend-glr` in the presence of --libsubdir.
+  -- The workaround moves Paths_happy_lib into `tabular` where it can be shared.
+  -- However, in order to really refer to the Paths_happy_lib from `tabular`,
+  -- we have to reexport it under a different name, because otherwise we get
+  --
+  --    These modules are needed for compilation but not listed in your .cabal file's other-modules for ‘happy-lib-2.1.3-inplace-backend-lalr’ :
+  --        Paths_happy_libsuppress
+  --
+                       Paths_happy_lib
+  reexported-modules:  Paths_happy_lib as Happy.Paths
+  autogen-modules:     Paths_happy_lib
+  -- end of workaround. Delete the workaround and use the bash script posted at
+  -- https://github.com/haskell/happy/issues/328#issuecomment-2597598320
+  -- to test whether the workaround is still needed.
   build-depends:       base < 5, array, containers, grammar
 
 
@@ -116,17 +132,13 @@ library backend-lalr
   exposed-modules:     Happy.Backend.LALR,
                        Happy.Backend.LALR.ProduceCode
   build-depends:       base < 5, array, grammar, tabular
-  other-modules:       Paths_happy_lib
-  autogen-modules:     Paths_happy_lib
 
 library backend-glr
   import: common-stanza
   hs-source-dirs:      backend-glr/src
   exposed-modules:     Happy.Backend.GLR,
                        Happy.Backend.GLR.ProduceCode
   build-depends:       base < 5, array, grammar, tabular
-  other-modules:       Paths_happy_lib
-  autogen-modules:     Paths_happy_lib
 
 library
   import: common-stanza