New package happy-lib; make previous happy-* packages sublibraries (

#288) This is one design design discussed in #288. Fixes #288.
haskell · Sep 14, 2024 · c5e3f6c · c5e3f6c
1 parent 48d3480
commit c5e3f6c
Show file tree

Hide file tree

Showing 50 changed files with 219 additions and 30 deletions.
diff --git a/src/Main.lhs → app/Main.lhs b/src/Main.lhs → app/Main.lhs
diff --git a/cabal.project b/cabal.project
@@ -1,3 +1,3 @@
 packages:
-  packages/*/happy-*.cabal
-  ./
+  happy.cabal
+  lib/happy-lib.cabal
diff --git a/happy.cabal b/happy.cabal
@@ -31,11 +31,6 @@ tested-with:
         GHC == 8.4.4
         GHC == 8.2.2
         GHC == 8.0.2
---        GHC == 7.10.3
---        GHC == 7.8.4
---        GHC == 7.6.3
---        GHC == 7.4.2
---        GHC == 7.0.4
 
 extra-source-files:
         ChangeLog.md
@@ -137,18 +132,14 @@ source-repository head
   location: https://github.com/haskell/happy.git
 
 executable happy
-  hs-source-dirs: src
+  hs-source-dirs: app
   main-is: Main.lhs
 
   build-depends: base >= 4.9 && < 5,
                  array,
                  containers >= 0.4.2,
                  mtl >= 2.2.1,
-                 happy-grammar == 2.0,
-                 happy-tabular == 2.0,
-                 happy-frontend == 2.0,
-                 happy-backend-lalr == 2.0,
-                 happy-backend-glr == 2.0
+                 happy-lib == 2.0
 
   default-language: Haskell98
   default-extensions: CPP, MagicHash, FlexibleContexts, NamedFieldPuns

diff --git a/lib/ChangeLog.md b/lib/ChangeLog.md
@@ -0,0 +1 @@
+../ChangeLog.md
diff --git a/lib/README.md b/lib/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/packages/backend-glr/LICENSE → lib/backend-glr/LICENSE b/packages/backend-glr/LICENSE → lib/backend-glr/LICENSE
diff --git a/packages/backend-glr/Setup.hs → lib/backend-glr/Setup.hs b/packages/backend-glr/Setup.hs → lib/backend-glr/Setup.hs
diff --git a/packages/backend-glr/happy-backend-glr.cabal → lib/backend-glr/happy-backend-glr.cabal b/packages/backend-glr/happy-backend-glr.cabal → lib/backend-glr/happy-backend-glr.cabal
@@ -15,9 +15,15 @@ synopsis:        A GLR backend for happy
 
 Description:
   Happy is a parser generator for Haskell.
-  Happy-Backend-GLR is a backend which creates
-  GLR-based Haskell code.
+  This library translates the LR action and goto tables computed from a grammar
+  description into table-driven GLR parsing code in Haskell.
+  Ambiguous parses produce multiple parse trees.
 
+  The library happy-grammar defines the 'Grammar' AST type for grammar files.
+  The library happy-frontend provides a parser for happy grammar files (.y) to
+  produce a 'Grammar'.
+  The library happy-tabular computes the LR action and goto tables for the
+  given 'Grammar' and defines the data types representing said tables.
 
 tested-with:
         GHC == 9.10.1
@@ -57,4 +63,4 @@ library
   default-language:    Haskell98
   default-extensions:  CPP, MagicHash, FlexibleContexts
   ghc-options:         -Wall -Wincomplete-uni-patterns
-  other-modules:       Paths_happy_backend_glr
+  other-modules:       Paths_happy_lib
diff --git a/...ages/backend-glr/src/Happy/Backend/GLR.hs → lib/backend-glr/src/Happy/Backend/GLR.hs b/...ages/backend-glr/src/Happy/Backend/GLR.hs → lib/backend-glr/src/Happy/Backend/GLR.hs
@@ -1,6 +1,6 @@
 module Happy.Backend.GLR where
 
-import Paths_happy_backend_glr
+import Paths_happy_lib
 
 glrBackendDataDir :: IO String
-glrBackendDataDir = getDataDir
+glrBackendDataDir = getDataDir
diff --git a/...glr/src/Happy/Backend/GLR/ProduceCode.lhs → ...glr/src/Happy/Backend/GLR/ProduceCode.lhs b/...glr/src/Happy/Backend/GLR/ProduceCode.lhs → ...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_backend_glr ( version )
+> import Paths_happy_lib ( version )
 > import Happy.Grammar
 > import Happy.Tabular.LALR
 > import Data.Array ( Array, (!), array, assocs )

diff --git a/packages/backend-lalr/LICENSE → lib/backend-lalr/LICENSE b/packages/backend-lalr/LICENSE → lib/backend-lalr/LICENSE
diff --git a/packages/backend-lalr/Setup.hs → lib/backend-lalr/Setup.hs b/packages/backend-lalr/Setup.hs → lib/backend-lalr/Setup.hs
diff --git a/...ges/backend-lalr/happy-backend-lalr.cabal → lib/backend-lalr/happy-backend-lalr.cabal b/...ges/backend-lalr/happy-backend-lalr.cabal → lib/backend-lalr/happy-backend-lalr.cabal
@@ -15,9 +15,17 @@ synopsis:        A table-based backend for happy
 
 Description:
   Happy is a parser generator for Haskell.
-  Happy-Backend-LALR is responsible for code-generation:
-  It converts action and goto tables into LALR Haskell code.
+  This library translates LR action and goto tables computed from a grammar
+  description into table-driven deterministic parsing code in Haskell.
+  (Any shift/reduce conflicts are resolved in favour of shifting,
+  while any reduce/reduce conflicts are resolved in favour of the rule with the
+  lower number.)
 
+  The library happy-grammar defines the 'Grammar' AST type for grammar files.
+  The library happy-frontend provides a parser for happy grammar files (.y) to
+  produce a 'Grammar'.
+  The library happy-tabular computes the LR action and goto tables for the
+  given 'Grammar' and defines the data types representing said tables.
 
 tested-with:
         GHC == 9.10.1
@@ -56,4 +64,4 @@ library
   default-language:    Haskell98
   default-extensions:  CPP, MagicHash, FlexibleContexts
   ghc-options:         -Wall -Wincomplete-uni-patterns
-  other-modules:       Paths_happy_backend_lalr
+  other-modules:       Paths_happy_lib
diff --git a/...es/backend-lalr/src/Happy/Backend/LALR.hs → lib/backend-lalr/src/Happy/Backend/LALR.hs b/...es/backend-lalr/src/Happy/Backend/LALR.hs → lib/backend-lalr/src/Happy/Backend/LALR.hs
@@ -1,6 +1,6 @@
 module Happy.Backend.LALR where
 
-import Paths_happy_backend_lalr
+import Paths_happy_lib
 import Data.Char
 
 lalrBackendDataDir :: IO String

diff --git a/...lr/src/Happy/Backend/LALR/ProduceCode.lhs → ...lr/src/Happy/Backend/LALR/ProduceCode.lhs b/...lr/src/Happy/Backend/LALR/ProduceCode.lhs → ...lr/src/Happy/Backend/LALR/ProduceCode.lhs
@@ -6,7 +6,7 @@ The code generator.
 
 > module Happy.Backend.LALR.ProduceCode (produceParser) where
 
-> import Paths_happy_backend_lalr  ( version )
+> import Paths_happy_lib  ( version )
 > import Data.Version              ( showVersion )
 > import Happy.Grammar
 > import Happy.Tabular.LALR

diff --git a/packages/backend-glr/data/GLR_Base.hs → lib/data/GLR_Base.hs b/packages/backend-glr/data/GLR_Base.hs → lib/data/GLR_Base.hs
diff --git a/packages/backend-glr/data/GLR_Lib.hs → lib/data/GLR_Lib.hs b/packages/backend-glr/data/GLR_Lib.hs → lib/data/GLR_Lib.hs
diff --git a/packages/backend-lalr/data/HappyTemplate.hs → lib/data/HappyTemplate.hs b/packages/backend-lalr/data/HappyTemplate.hs → lib/data/HappyTemplate.hs
diff --git a/packages/frontend/LICENSE → lib/frontend/LICENSE b/packages/frontend/LICENSE → lib/frontend/LICENSE
diff --git a/packages/frontend/Setup.hs → lib/frontend/Setup.hs b/packages/frontend/Setup.hs → lib/frontend/Setup.hs
diff --git a/...es/frontend/boot-src/AttrGrammarParser.ly → lib/frontend/boot-src/AttrGrammarParser.ly b/...es/frontend/boot-src/AttrGrammarParser.ly → lib/frontend/boot-src/AttrGrammarParser.ly
diff --git a/packages/frontend/boot-src/Parser.ly → lib/frontend/boot-src/Parser.ly b/packages/frontend/boot-src/Parser.ly → lib/frontend/boot-src/Parser.ly
diff --git a/packages/frontend/bootstrap.sh → lib/frontend/bootstrap.sh b/packages/frontend/bootstrap.sh → lib/frontend/bootstrap.sh
diff --git a/packages/frontend/happy-frontend.cabal → lib/frontend/happy-frontend.cabal b/packages/frontend/happy-frontend.cabal → lib/frontend/happy-frontend.cabal
@@ -15,11 +15,17 @@ synopsis:        A yacc-like frontend for happy
 
 Description:
   Happy is a parser generator for Haskell.
-  Happy-Frontend is responsible for parsing .y- and .ly-files
-  and mangling them into a Grammar datatype.
+  This library provides a parser for happy grammar files (.y/.ly) to produce a
+  'Grammar' AST type.
   These .y- and .ly-files work similar to yacc's .y-files, but
   have some Haskell-specific features.
 
+  The library happy-grammar defines the 'Grammar' AST type for grammar files.
+  The library happy-tabular computes the LR action and goto tables for the
+  given 'Grammar'.
+  The library happy-backend-lalr defines functions to produce Haskell code
+  for the LR action and goto tables.
+
 tested-with:
         GHC == 9.10.1
         GHC == 9.8.2

diff --git a/packages/frontend/src/Happy/Frontend.hs → lib/frontend/src/Happy/Frontend.hs b/packages/frontend/src/Happy/Frontend.hs → lib/frontend/src/Happy/Frontend.hs
diff --git a/...es/frontend/src/Happy/Frontend/AbsSyn.lhs → lib/frontend/src/Happy/Frontend/AbsSyn.lhs b/...es/frontend/src/Happy/Frontend/AbsSyn.lhs → lib/frontend/src/Happy/Frontend/AbsSyn.lhs
diff --git a/...ontend/src/Happy/Frontend/AttrGrammar.lhs → ...ontend/src/Happy/Frontend/AttrGrammar.lhs b/...ontend/src/Happy/Frontend/AttrGrammar.lhs → ...ontend/src/Happy/Frontend/AttrGrammar.lhs
diff --git a/...rc/Happy/Frontend/AttrGrammar/Mangler.lhs → ...rc/Happy/Frontend/AttrGrammar/Mangler.lhs b/...rc/Happy/Frontend/AttrGrammar/Mangler.lhs → ...rc/Happy/Frontend/AttrGrammar/Mangler.lhs
diff --git a/.../src/Happy/Frontend/AttrGrammar/Parser.hs → .../src/Happy/Frontend/AttrGrammar/Parser.hs b/.../src/Happy/Frontend/AttrGrammar/Parser.hs → .../src/Happy/Frontend/AttrGrammar/Parser.hs
diff --git a/...ges/frontend/src/Happy/Frontend/Lexer.lhs → lib/frontend/src/Happy/Frontend/Lexer.lhs b/...ges/frontend/src/Happy/Frontend/Lexer.lhs → lib/frontend/src/Happy/Frontend/Lexer.lhs
diff --git a/...s/frontend/src/Happy/Frontend/Mangler.lhs → lib/frontend/src/Happy/Frontend/Mangler.lhs b/...s/frontend/src/Happy/Frontend/Mangler.lhs → lib/frontend/src/Happy/Frontend/Mangler.lhs
diff --git a/...tend/src/Happy/Frontend/Mangler/Monad.lhs → ...tend/src/Happy/Frontend/Mangler/Monad.lhs b/...tend/src/Happy/Frontend/Mangler/Monad.lhs → ...tend/src/Happy/Frontend/Mangler/Monad.lhs
diff --git a/...frontend/src/Happy/Frontend/ParamRules.hs → ...frontend/src/Happy/Frontend/ParamRules.hs b/...frontend/src/Happy/Frontend/ParamRules.hs → ...frontend/src/Happy/Frontend/ParamRules.hs
diff --git a/...frontend/src/Happy/Frontend/ParseMonad.hs → ...frontend/src/Happy/Frontend/ParseMonad.hs b/...frontend/src/Happy/Frontend/ParseMonad.hs → ...frontend/src/Happy/Frontend/ParseMonad.hs
diff --git a/...nd/src/Happy/Frontend/ParseMonad/Class.hs → ...nd/src/Happy/Frontend/ParseMonad/Class.hs b/...nd/src/Happy/Frontend/ParseMonad/Class.hs → ...nd/src/Happy/Frontend/ParseMonad/Class.hs
diff --git a/...ges/frontend/src/Happy/Frontend/Parser.hs → lib/frontend/src/Happy/Frontend/Parser.hs b/...ges/frontend/src/Happy/Frontend/Parser.hs → lib/frontend/src/Happy/Frontend/Parser.hs
diff --git a/...ntend/src/Happy/Frontend/PrettyGrammar.hs → ...ntend/src/Happy/Frontend/PrettyGrammar.hs b/...ntend/src/Happy/Frontend/PrettyGrammar.hs → ...ntend/src/Happy/Frontend/PrettyGrammar.hs
diff --git a/packages/grammar/LICENSE → lib/grammar/LICENSE b/packages/grammar/LICENSE → lib/grammar/LICENSE
diff --git a/packages/grammar/Setup.hs → lib/grammar/Setup.hs b/packages/grammar/Setup.hs → lib/grammar/Setup.hs
diff --git a/packages/grammar/happy-grammar.cabal → lib/grammar/happy-grammar.cabal b/packages/grammar/happy-grammar.cabal → lib/grammar/happy-grammar.cabal
@@ -15,9 +15,12 @@ synopsis:        happy's Grammar datatype
 
 Description:
   Happy is a parser generator for Haskell.
-  Happy-Grammar exposes the cross-package Grammar datatype,
+  This library exposes the cross-package Grammar datatype,
   which represents a grammar as can be parsed and processed by happy.
 
+  The package happy-frontend provides a parser for happy grammar files (.y) to
+  produce a 'Grammar'.
+
 tested-with:
         GHC == 9.10.1
         GHC == 9.8.2

diff --git a/packages/grammar/src/Happy/Grammar.lhs → lib/grammar/src/Happy/Grammar.lhs b/packages/grammar/src/Happy/Grammar.lhs → lib/grammar/src/Happy/Grammar.lhs
diff --git a/lib/happy-lib.cabal b/lib/happy-lib.cabal
@@ -0,0 +1,166 @@
+cabal-version: 3.0
+name: happy-lib
+version: 2.0
+license: BSD-2-Clause
+copyright: (c) Andy Gill, Simon Marlow
+author: Andy Gill and Simon Marlow
+maintainer: https://github.com/haskell/happy
+bug-reports: https://github.com/haskell/happy/issues
+stability: stable
+homepage: https://www.haskell.org/happy/
+synopsis: Happy is a parser generator for Haskell implemented using this library
+category: Development
+build-type: Simple
+
+Description:
+  Happy is a parser generator for Haskell.  Given a grammar
+  specification in BNF, Happy generates Haskell code to parse the
+  grammar.  Happy works in a similar way to the @yacc@ tool for C.
+
+  This library provides the following functionality:
+
+    * Data type definitions for the Grammar AST type, capturing the information in .y-files (Happy.Grammar)
+
+    * A parser for happy grammar files (.y) to produce a Grammar (Happy.Frontend.*)
+
+    * Implementations of the text book algorithms that compute the LR action and
+      goto tables for the given 'Grammar' (Happy.Tabular.*)
+
+    * An LALR code generator to produce table-driven, deterministic parsing code
+      in Haskell (Happy.Backend.LALR.*)
+
+    * A (less maintained) GLR code generator to produce table-driven,
+      non-deterministic parsing code in Haskell, where ambiguous parses produce
+      multiple parse trees (Happy.Backend.GLR.*)
+
+tested-with:
+        GHC == 9.10.1
+        GHC == 9.8.2
+        GHC == 9.6.5
+        GHC == 9.4.8
+        GHC == 9.2.8
+        GHC == 9.0.2
+        GHC == 8.10.7
+        GHC == 8.8.4
+        GHC == 8.6.5
+        GHC == 8.4.4
+        GHC == 8.2.2
+        GHC == 8.0.2
+
+extra-source-files:
+        ChangeLog.md
+        README.md
+        frontend/bootstrap.sh
+        frontend/boot-src/Parser.ly
+        frontend/boot-src/AttrGrammarParser.ly
+
+data-dir: data
+
+data-files:
+        HappyTemplate.hs
+        GLR_Base.hs
+        GLR_Lib.hs
+
+source-repository head
+  type:     git
+  location: https://github.com/haskell/happy.git
+
+library grammar
+  hs-source-dirs:      grammar/src
+
+  exposed-modules:     Happy.Grammar
+  build-depends:       base, array
+
+  default-language:    Haskell98
+  default-extensions:  CPP, MagicHash, FlexibleContexts
+  ghc-options: -Wall
+  other-modules:
+
+library frontend
+  hs-source-dirs:      frontend/src
+  exposed-modules:     Happy.Frontend,
+                       Happy.Frontend.AbsSyn,
+                       Happy.Frontend.Mangler,
+                       Happy.Frontend.PrettyGrammar
+
+  build-depends:       base, array, transformers, containers, mtl, happy-lib:grammar
+
+  default-language:    Haskell98
+  default-extensions:  CPP, MagicHash, FlexibleContexts
+  ghc-options: -Wall -Wno-incomplete-uni-patterns
+  other-modules:
+        Happy.Frontend.ParseMonad
+        Happy.Frontend.ParseMonad.Class
+        Happy.Frontend.Mangler.Monad
+        Happy.Frontend.Parser
+        Happy.Frontend.Lexer
+        Happy.Frontend.ParamRules
+        Happy.Frontend.AttrGrammar
+        Happy.Frontend.AttrGrammar.Parser
+        Happy.Frontend.AttrGrammar.Mangler
+
+library tabular
+  hs-source-dirs:      tabular/src
+
+  exposed-modules:     Happy.Tabular,
+                       Happy.Tabular.First,
+                       Happy.Tabular.Info,
+                       Happy.Tabular.LALR,
+                       Happy.Tabular.NameSet
+  build-depends:       base, array, containers, happy-lib:grammar
+
+  default-language:    Haskell98
+  default-extensions:  CPP, MagicHash, FlexibleContexts, NamedFieldPuns
+  ghc-options: -Wall
+
+library backend-lalr
+  hs-source-dirs:      backend-lalr/src
+
+  exposed-modules:     Happy.Backend.LALR,
+                       Happy.Backend.LALR.ProduceCode
+  build-depends:       base, array, happy-lib:grammar, happy-lib:tabular
+
+  default-language:    Haskell98
+  default-extensions:  CPP, MagicHash, FlexibleContexts
+  ghc-options:         -Wall -Wno-incomplete-uni-patterns
+  other-modules:       Paths_happy_lib
+
+library backend-glr
+  hs-source-dirs:      backend-glr/src
+
+  exposed-modules:     Happy.Backend.GLR,
+                       Happy.Backend.GLR.ProduceCode
+  build-depends:       base, array, happy-lib:grammar, happy-lib:tabular
+
+  default-language:    Haskell98
+  default-extensions:  CPP, MagicHash, FlexibleContexts
+  ghc-options:         -Wall -Wno-incomplete-uni-patterns
+  other-modules:       Paths_happy_lib
+
+library
+  reexported-modules:  Happy.Grammar,
+                       Happy.Frontend,
+                       Happy.Frontend.AbsSyn,
+                       Happy.Frontend.Mangler,
+                       Happy.Frontend.PrettyGrammar,
+                       Happy.Tabular,
+                       Happy.Tabular.First,
+                       Happy.Tabular.Info,
+                       Happy.Tabular.LALR,
+                       Happy.Tabular.NameSet,
+                       Happy.Backend.LALR,
+                       Happy.Backend.LALR.ProduceCode,
+                       Happy.Backend.GLR,
+                       Happy.Backend.GLR.ProduceCode
+
+  build-depends: base >= 4.9 && < 5,
+                 array,
+                 containers >= 0.4.2,
+                 transformers >= 0.5.6.2,
+                 mtl >= 2.2.1,
+                 happy-lib:grammar,
+                 happy-lib:tabular,
+                 happy-lib:frontend,
+                 happy-lib:backend-lalr,
+                 happy-lib:backend-glr
+  default-language:    Haskell98
diff --git a/packages/tabular/LICENSE → lib/tabular/LICENSE b/packages/tabular/LICENSE → lib/tabular/LICENSE
diff --git a/packages/tabular/Setup.hs → lib/tabular/Setup.hs b/packages/tabular/Setup.hs → lib/tabular/Setup.hs
diff --git a/packages/tabular/happy-tabular.cabal → lib/tabular/happy-tabular.cabal b/packages/tabular/happy-tabular.cabal → lib/tabular/happy-tabular.cabal
@@ -15,9 +15,16 @@ synopsis:        Action and goto tables for happy
 
 Description:
   Happy is a parser generator for Haskell.
-  Happy-Tabular converts `Grammar`s, coming from
-  a frontend, into LALR action and goto tables,
-  which are further processed by a backend.
+  For a given description of a happy grammar file (.y),
+  this library implements the text book computation of the LALR automaton and
+  generates the final LR action and goto tables, which are further processed by
+  a backend.
+
+  The library happy-grammar defines the 'Grammar' AST type for grammar files.
+  The library happy-frontend provides a parser for happy grammar files (.y) to
+  produce a 'Grammar'.
+  The library happy-backend-lalr defines functions to produce Haskell code
+  for the LR action and goto tables.
 
 tested-with:
         GHC == 9.10.1

diff --git a/packages/tabular/src/Happy/Tabular.lhs → lib/tabular/src/Happy/Tabular.lhs b/packages/tabular/src/Happy/Tabular.lhs → lib/tabular/src/Happy/Tabular.lhs
diff --git a/packages/tabular/src/Happy/Tabular/First.lhs → lib/tabular/src/Happy/Tabular/First.lhs b/packages/tabular/src/Happy/Tabular/First.lhs → lib/tabular/src/Happy/Tabular/First.lhs
diff --git a/packages/tabular/src/Happy/Tabular/Info.lhs → lib/tabular/src/Happy/Tabular/Info.lhs b/packages/tabular/src/Happy/Tabular/Info.lhs → lib/tabular/src/Happy/Tabular/Info.lhs
diff --git a/packages/tabular/src/Happy/Tabular/LALR.lhs → lib/tabular/src/Happy/Tabular/LALR.lhs b/packages/tabular/src/Happy/Tabular/LALR.lhs → lib/tabular/src/Happy/Tabular/LALR.lhs
diff --git a/...ages/tabular/src/Happy/Tabular/NameSet.hs → lib/tabular/src/Happy/Tabular/NameSet.hs b/...ages/tabular/src/Happy/Tabular/NameSet.hs → lib/tabular/src/Happy/Tabular/NameSet.hs