clean up, update changelog

Author: raehik

CHANGELOG.md

@@ -1,3 +1,12 @@
+### Unreleased
+  * Restructure parsing-related modules for code deduplication and better user
+    experience.
+    * Now all user-facing parsers and the combinators to create them are in a
+      single module at `Language.Fortran.Parser`.
+    * The Happy parsers have fewer dependencies, so should no longer require a
+      recompile due to apparently unrelated changes.
+  * Remove some deprecated shims (from the restructured modules).
+
 ### 0.8.0 (Jan 04, 2022)
   * Merge declarator constructors. Now you differentiate between array and
     scalar declarators by looking at the relevant field. See

fortran-src.cabal

@@ -136,7 +136,7 @@ library
     , containers >=0.5 && <0.7
     , deepseq ==1.4.*
     , directory >=1.2 && <2
-    , either
+    , either >=5.0.1.1 && <5.1
     , fgl ==5.*
     , filepath ==1.4.*
     , mtl >=2.2 && <3
@@ -181,7 +181,7 @@ executable fortran-src
     , containers >=0.5 && <0.7
     , deepseq ==1.4.*
     , directory >=1.2 && <2
-    , either
+    , either >=5.0.1.1 && <5.1
     , fgl ==5.*
     , filepath ==1.4.*
     , fortran-src
@@ -258,7 +258,7 @@ test-suite spec
     , containers >=0.5 && <0.7
     , deepseq ==1.4.*
     , directory >=1.2 && <2
-    , either
+    , either >=5.0.1.1 && <5.1
     , fgl ==5.*
     , filepath ==1.4.*
     , fortran-src

package.yaml

@@ -63,7 +63,7 @@ dependencies:
 - deepseq >=1.4 && <1.5
 - filepath >=1.4 && <1.5
 - temporary >=1.2 && <1.4
-- either # TODO
+- either ^>=5.0.1.1
 
 # --pedantic for building (not used for stack ghci)
 ghc-options:

src/Language/Fortran/AST/Boz.hs

@@ -88,11 +88,10 @@ bozAsNatural :: (Num a, Eq a) => Boz -> a
 bozAsNatural (Boz pfx str) = runReadS $ parser str
   where
     runReadS = fst . head
-    parser = case pfx of
-               BozPrefixB -> -- TODO on GHC 9.2, 'Num.readBin'
-                 Num.readInt 2 (const True) binDigitVal
-               BozPrefixO -> Num.readOct
-               BozPrefixZ -> Num.readHex
+    parser = case pfx of BozPrefixB -> Num.readInt 2 (const True) binDigitVal
+                         -- (on GHC >=9.2, 'Num.readBin')
+                         BozPrefixO -> Num.readOct
+                         BozPrefixZ -> Num.readHex
     binDigitVal = \case '0' -> 0
                         '1' -> 1
                         _   -> error "Language.Fortran.AST.BOZ.bozAsNatural: invalid BOZ string"

src/Language/Fortran/Version.hs

@@ -5,7 +5,6 @@ module Language.Fortran.Version
   , fortranVersionAliases
   , selectFortranVersion
   , deduceFortranVersion
-  , deduceVersion -- deprecated
   ) where
 
 import           Data.Char (toLower)
@@ -74,7 +73,3 @@ deduceFortranVersion path
   | otherwise               = Fortran90         -- unrecognized, default to F90
   where
     isExtensionOf = flip isSuffixOf $ map toLower path
-
--- | Alias for previous function name. TODO: deprecate eventually.
-deduceVersion :: FilePath -> FortranVersion
-deduceVersion = deduceFortranVersion

upgrade-guide.md

@@ -1,4 +1,18 @@
 # fortran-src upgrade guide
+## Unreleased
+### Parser restructure
+***Necessitates changes.***
+
+Instead of grabbing parsers directly from `Language.Fortran.Parser.FortranXYZ`,
+import `Language.Fortran.Parser` qualified and use one of the many provided
+functions. If you need to do more complex parser incantations, we recommend
+using the combinators in `Parser`.
+
+In general, `parserVersions` and the parsers exported from respective parser
+modules can be replaced by `Parser.byVer`, `Parser.f77e` etc. The filepath
+argument now comes before the contents bytestring, so you may have to swap
+argument order (done to match other parsing libraries and most common usage).
+
 ## Release 0.8.0
 ### Declarator constructor refactor
 ***Necessitates changes.***