feat: support generated cmm-sources

Author: andreabedini

Cabal-syntax/src/Distribution/PackageDescription/FieldGrammar.hs

@@ -174,7 +174,8 @@ libraryFieldGrammar
      , c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency)
      , c (List CommaVCat (Identity Dependency) Dependency)
      , c (List CommaVCat (Identity Mixin) Mixin)
-     , c (List VCat (Identity ExtraSource) ExtraSource)
+     , c (List VCat (Identity (ExtraSource Pkg)) (ExtraSource Pkg))
+     , c (List VCat (Identity (ExtraSource Build)) (ExtraSource Build))
      , c (List CommaVCat (Identity ModuleReexport) ModuleReexport)
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
@@ -225,7 +226,8 @@ foreignLibFieldGrammar
      , c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency)
      , c (List CommaVCat (Identity Dependency) Dependency)
      , c (List CommaVCat (Identity Mixin) Mixin)
-     , c (List VCat (Identity ExtraSource) ExtraSource)
+     , c (List VCat (Identity (ExtraSource Pkg)) (ExtraSource Pkg))
+     , c (List VCat (Identity (ExtraSource Build)) (ExtraSource Build))
      , c (List FSep (Identity ForeignLibOption) ForeignLibOption)
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
@@ -265,7 +267,8 @@ executableFieldGrammar
      , c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency)
      , c (List CommaVCat (Identity Dependency) Dependency)
      , c (List CommaVCat (Identity Mixin) Mixin)
-     , c (List VCat (Identity ExtraSource) ExtraSource)
+     , c (List VCat (Identity (ExtraSource Pkg)) (ExtraSource Pkg))
+     , c (List VCat (Identity (ExtraSource Build)) (ExtraSource Build))
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -342,7 +345,8 @@ testSuiteFieldGrammar
      , c (List CommaFSep Token String)
      , c (List CommaVCat (Identity Dependency) Dependency)
      , c (List CommaVCat (Identity Mixin) Mixin)
-     , c (List VCat (Identity ExtraSource) ExtraSource)
+     , c (List VCat (Identity (ExtraSource Pkg)) (ExtraSource Pkg))
+     , c (List VCat (Identity (ExtraSource Build)) (ExtraSource Build))
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -487,7 +491,8 @@ benchmarkFieldGrammar
      , c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency)
      , c (List CommaVCat (Identity Dependency) Dependency)
      , c (List CommaVCat (Identity Mixin) Mixin)
-     , c (List VCat (Identity ExtraSource) ExtraSource)
+     , c (List VCat (Identity (ExtraSource Pkg)) (ExtraSource Pkg))
+     , c (List VCat (Identity (ExtraSource Build)) (ExtraSource Build))
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -590,7 +595,8 @@ buildInfoFieldGrammar
      , c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency)
      , c (List CommaVCat (Identity Dependency) Dependency)
      , c (List CommaVCat (Identity Mixin) Mixin)
-     , c (List VCat (Identity ExtraSource) ExtraSource)
+     , c (List VCat (Identity (ExtraSource Pkg)) (ExtraSource Pkg))
+     , c (List VCat (Identity (ExtraSource Build)) (ExtraSource Build))
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -637,6 +643,8 @@ buildInfoFieldGrammar =
       ^^^ availableSince CabalSpecV3_0 []
     <*> monoidalFieldAla "cmm-sources" formatExtraSources L.cmmSources
       ^^^ availableSince CabalSpecV3_0 []
+    <*> monoidalFieldAla "autogen-cmm-sources" formatExtraSources L.autogenCmmSources
+    -- FIXME ^^^ availableSince CabalSpecV3_0 []
     <*> monoidalFieldAla "c-sources" formatExtraSources L.cSources
     <*> monoidalFieldAla "cxx-sources" formatExtraSources L.cxxSources
       ^^^ availableSince CabalSpecV2_2 []
@@ -840,7 +848,7 @@ formatOtherExtensions = alaList' FSep MQuoted
 formatOtherModules :: [ModuleName] -> List VCat (MQuoted ModuleName) ModuleName
 formatOtherModules = alaList' VCat MQuoted
 
-formatExtraSources :: [ExtraSource] -> List VCat (Identity ExtraSource) ExtraSource
+formatExtraSources :: [ExtraSource pkg] -> List VCat (Identity (ExtraSource pkg)) (ExtraSource pkg)
 formatExtraSources = alaList' VCat Identity
 
 -------------------------------------------------------------------------------

Cabal-syntax/src/Distribution/Types/BuildInfo.hs

@@ -72,15 +72,17 @@ data BuildInfo = BuildInfo
   -- ^ support frameworks for Mac OS X
   , extraFrameworkDirs :: [SymbolicPath Pkg (Dir Framework)]
   -- ^ extra locations to find frameworks
-  , asmSources :: [ExtraSource]
+  , asmSources :: [ExtraSource Pkg]
   -- ^ Assembly source files
-  , cmmSources :: [ExtraSource]
+  , cmmSources :: [ExtraSource Pkg]
   -- ^ C-- source files
-  , cSources :: [ExtraSource]
+  , autogenCmmSources :: [ExtraSource Build]
+  -- ^ C-- generated source files
+  , cSources :: [ExtraSource Pkg]
   -- ^ C source files
-  , cxxSources :: [ExtraSource]
+  , cxxSources :: [ExtraSource Pkg]
   -- ^ C++ source files
-  , jsSources :: [ExtraSource]
+  , jsSources :: [ExtraSource Pkg]
   -- ^ JavaScript source file
   , hsSourceDirs :: [SymbolicPath Pkg (Dir Source)]
   -- ^ where to look for the Haskell module hierarchy
@@ -172,6 +174,7 @@ instance Monoid BuildInfo where
       , extraFrameworkDirs = []
       , asmSources = []
       , cmmSources = []
+      , autogenCmmSources = []
       , cSources = []
       , cxxSources = []
       , jsSources = []
@@ -225,6 +228,7 @@ instance Semigroup BuildInfo where
       , extraFrameworkDirs = combineNub extraFrameworkDirs
       , asmSources = combineNub asmSources
       , cmmSources = combineNub cmmSources
+      , autogenCmmSources = combineNub autogenCmmSources
       , cSources = combineNub cSources
       , cxxSources = combineNub cxxSources
       , jsSources = combineNub jsSources

Cabal-syntax/src/Distribution/Types/BuildInfo/Lens.hs

@@ -80,23 +80,27 @@ class HasBuildInfo a where
   extraFrameworkDirs = buildInfo . extraFrameworkDirs
   {-# INLINE extraFrameworkDirs #-}
 
-  asmSources :: Lens' a [ExtraSource]
+  asmSources :: Lens' a [ExtraSource Pkg]
   asmSources = buildInfo . asmSources
   {-# INLINE asmSources #-}
 
-  cmmSources :: Lens' a [ExtraSource]
+  autogenCmmSources :: Lens' a [ExtraSource Build]
+  autogenCmmSources = buildInfo . autogenCmmSources
+  {-# INLINE autogenCmmSources #-}
+
+  cmmSources :: Lens' a [ExtraSource Pkg]
   cmmSources = buildInfo . cmmSources
   {-# INLINE cmmSources #-}
 
-  cSources :: Lens' a [ExtraSource]
+  cSources :: Lens' a [ExtraSource Pkg]
   cSources = buildInfo . cSources
   {-# INLINE cSources #-}
 
-  cxxSources :: Lens' a [ExtraSource]
+  cxxSources :: Lens' a [ExtraSource Pkg]
   cxxSources = buildInfo . cxxSources
   {-# INLINE cxxSources #-}
 
-  jsSources :: Lens' a [ExtraSource]
+  jsSources :: Lens' a [ExtraSource Pkg]
   jsSources = buildInfo . jsSources
   {-# INLINE jsSources #-}
 

Cabal-syntax/src/Distribution/Types/ExtraSource.hs

@@ -1,48 +1,79 @@
+{-# LANGUAGE DataKinds #-}
 {-# LANGUAGE DeriveDataTypeable #-}
 {-# LANGUAGE DeriveGeneric #-}
-{-# LANGUAGE DataKinds #-}
+{-# LANGUAGE FlexibleInstances #-}
+{-# LANGUAGE TypeFamilies #-}
 
 module Distribution.Types.ExtraSource
   ( ExtraSource (..)
-  , extraSourceFromPath
+  , ExtraSourceClass (..)
   ) where
 
 import Distribution.Compat.Prelude
 import Prelude ()
 
 import Distribution.Parsec
 import Distribution.Pretty
-import Distribution.Utils.Path (SymbolicPath, FileOrDir(..), Pkg)
+import Distribution.Utils.Path (Build, FileOrDir (..), Pkg, RelativePath, SymbolicPath, relativeSymbolicPath, unsafeCoerceSymbolicPath)
 
 import qualified Distribution.Compat.CharParsing as P
 import qualified Text.PrettyPrint as PP
-import Distribution.FieldGrammar.Newtypes (SymbolicPathNT(..))
 
-data ExtraSource = ExtraSource
-  { extraSourceFile :: SymbolicPath Pkg File
-  , extraSourceOpts :: [String]
-  }
+data family ExtraSource pkg
+
+data instance ExtraSource Pkg = ExtraSourcePkg (SymbolicPath Pkg File) [String]
+  deriving (Generic, Show, Read, Eq, Ord, Typeable, Data)
+
+data instance ExtraSource Build = ExtraSourceBuild (RelativePath Build File) [String]
   deriving (Generic, Show, Read, Eq, Ord, Typeable, Data)
 
-instance Binary ExtraSource
-instance Structured ExtraSource
-instance NFData ExtraSource where rnf = genericRnf
+class ExtraSourceClass e where
+  extraSourceOpts :: e -> [String]
+  extraSourceFile :: e -> SymbolicPath Pkg 'File
+
+instance ExtraSourceClass (ExtraSource Pkg) where
+  extraSourceOpts (ExtraSourcePkg _ opts) = opts
+  extraSourceFile (ExtraSourcePkg f _) = f
+
+instance ExtraSourceClass (ExtraSource Build) where
+  extraSourceOpts (ExtraSourceBuild _ opts) = opts
+
+  -- FIXME
+  extraSourceFile (ExtraSourceBuild f _) = unsafeCoerceSymbolicPath (relativeSymbolicPath f)
 
-instance Parsec ExtraSource where
+instance Binary (ExtraSource Pkg)
+instance Structured (ExtraSource Pkg)
+instance NFData (ExtraSource Pkg) where rnf = genericRnf
+
+instance Binary (ExtraSource Build)
+instance Structured (ExtraSource Build)
+instance NFData (ExtraSource Build) where rnf = genericRnf
+
+instance Parsec (ExtraSource Pkg) where
   parsec = do
-    SymbolicPathNT path <- parsec <* P.spaces
-    opts <- P.optional (parensLax (P.sepBy p  P.spaces))
-    return (ExtraSource path (fromMaybe mempty opts))
+    path <- parsec <* P.spaces
+    opts <- P.optional (parensLax (P.sepBy p P.spaces))
+    return (ExtraSourcePkg path (fromMaybe mempty opts))
     where
       p :: P.CharParsing p => p String
-      p = some $ P.satisfy (\c -> not (isSpace c) && not (c == ')'))
+      p = some $ P.satisfy (\c -> not (isSpace c) && (c /= ')'))
 
-parensLax :: (P.CharParsing m) => m a -> m a
-parensLax p = P.between (P.char '(' *> P.spaces) (P.char ')' *> P.spaces) p
+instance Parsec (ExtraSource Build) where
+  parsec = do
+    path <- parsec <* P.spaces
+    opts <- P.optional (parensLax (P.sepBy p P.spaces))
+    return (ExtraSourceBuild path (fromMaybe mempty opts))
+    where
+      p :: P.CharParsing p => p String
+      p = some $ P.satisfy (\c -> not (isSpace c) && (c /= ')'))
 
-instance Pretty ExtraSource where
-  pretty (ExtraSource path opts) =
-    pretty (SymbolicPathNT path) <<>> PP.parens (PP.hsep (map PP.text opts))
+instance Pretty (ExtraSource Pkg) where
+  pretty (ExtraSourcePkg path opts) =
+    pretty path <<>> PP.parens (PP.hsep (map PP.text opts))
 
-extraSourceFromPath :: SymbolicPath Pkg File -> ExtraSource
-extraSourceFromPath fp = ExtraSource fp mempty
+instance Pretty (ExtraSource Build) where
+  pretty (ExtraSourceBuild path opts) =
+    pretty path <<>> PP.parens (PP.hsep (map PP.text opts))
+
+parensLax :: P.CharParsing m => m a -> m a
+parensLax p = P.between (P.char '(' *> P.spaces) (P.char ')' *> P.spaces) p

Cabal-syntax/src/Distribution/Utils/Path.hs

@@ -460,7 +460,7 @@ data CWD
 -- | Abstract directory: package directory (e.g. a directory containing the @.cabal@ file).
 --
 -- See Note [Symbolic paths] in Distribution.Utils.Path.
-data Pkg
+data Pkg deriving (Data)
 
 -- | Abstract directory: dist directory (e.g. @dist-newstyle@).
 --
@@ -490,7 +490,7 @@ data Framework
 -- | Abstract directory: build directory.
 --
 -- See Note [Symbolic paths] in Distribution.Utils.Path.
-data Build
+data Build deriving (Data)
 
 -- | Abstract directory: directory for build artifacts, such as documentation or @.hie@ files.
 --

Cabal-tests/tests/NoThunks.hs

@@ -25,7 +25,7 @@ import Distribution.ModuleName                (ModuleName)
 import Distribution.PackageDescription.Parsec (parseGenericPackageDescription)
 import Distribution.SPDX                      (License, LicenseExceptionId, LicenseExpression, LicenseId, LicenseRef, SimpleLicenseExpression)
 import Distribution.System                    (Arch, OS)
-import Distribution.Utils.Path                (SymbolicPathX)
+import Distribution.Utils.Path                (SymbolicPathX, Pkg, Build)
 import Distribution.Utils.ShortText           (ShortText)
 import Distribution.Version                   (Version, VersionRange)
 import Language.Haskell.Extension             (Extension, KnownExtension, Language)
@@ -73,7 +73,8 @@ instance NoThunks ConfVar
 instance NoThunks Dependency
 instance NoThunks Executable
 instance NoThunks ExecutableScope
-instance NoThunks ExtraSource
+instance NoThunks (ExtraSource Build)
+instance NoThunks (ExtraSource Pkg)
 instance NoThunks FlagName
 instance NoThunks ForeignLib
 instance NoThunks ForeignLibOption

Cabal-tree-diff/src/Data/TreeDiff/Instances/Cabal.hs

@@ -29,7 +29,7 @@ import Distribution.Types.DumpBuildInfo            (DumpBuildInfo)
 import Distribution.Types.PackageVersionConstraint
 import Distribution.Types.UnitId                   (DefUnitId, UnitId)
 import Distribution.Utils.NubList                  (NubList)
-import Distribution.Utils.Path                     (SymbolicPathX)
+import Distribution.Utils.Path                     (SymbolicPathX, Build, Pkg)
 import Distribution.Utils.ShortText                (ShortText, fromShortText)
 import Distribution.Verbosity
 import Distribution.Verbosity.Internal
@@ -78,7 +78,8 @@ instance ToExpr ExeDependency
 instance ToExpr Executable
 instance ToExpr ExecutableScope
 instance ToExpr ExposedModule
-instance ToExpr ExtraSource
+instance ToExpr (ExtraSource Build)
+instance ToExpr (ExtraSource Pkg)
 instance ToExpr FlagAssignment
 instance ToExpr FlagName
 instance ToExpr ForeignLib

Cabal/src/Distribution/Simple/Build.hs

@@ -642,35 +642,35 @@ generateCode codeGens nm pdesc bi lbi clbi verbosity = do
 addExtraCSources :: BuildInfo -> [SymbolicPath Pkg File] -> BuildInfo
 addExtraCSources bi extras = bi{cSources = new}
   where
-    new = ordNub (map extraSourceFromPath extras ++ cSources bi)
+    new = ordNub (map (flip ExtraSourcePkg []) extras ++ cSources bi)
 
 -- | Add extra C++ sources generated by preprocessing to build
 -- information.
 addExtraCxxSources :: BuildInfo -> [SymbolicPath Pkg File] -> BuildInfo
 addExtraCxxSources bi extras = bi{cxxSources = new}
   where
-    new = ordNub (map extraSourceFromPath extras ++ cxxSources bi)
+    new = ordNub (map (flip ExtraSourcePkg []) extras ++ cxxSources bi)
 
 -- | Add extra C-- sources generated by preprocessing to build
 -- information.
 addExtraCmmSources :: BuildInfo -> [SymbolicPath Pkg File] -> BuildInfo
 addExtraCmmSources bi extras = bi{cmmSources = new}
   where
-    new = ordNub (map extraSourceFromPath extras ++ cmmSources bi)
+    new = ordNub (map (flip ExtraSourcePkg []) extras ++ cmmSources bi)
 
 -- | Add extra ASM sources generated by preprocessing to build
 -- information.
 addExtraAsmSources :: BuildInfo -> [SymbolicPath Pkg File] -> BuildInfo
 addExtraAsmSources bi extras = bi{asmSources = new}
   where
-    new = ordNub (map extraSourceFromPath extras ++ asmSources bi)
+    new = ordNub (map (flip ExtraSourcePkg []) extras ++ asmSources bi)
 
 -- | Add extra JS sources generated by preprocessing to build
 -- information.
 addExtraJsSources :: BuildInfo -> [SymbolicPath Pkg File] -> BuildInfo
 addExtraJsSources bi extras = bi{jsSources = new}
   where
-    new = ordNub (map extraSourceFromPath extras ++ jsSources bi)
+    new = ordNub (map (flip ExtraSourcePkg []) extras ++ jsSources bi)
 
 -- | Add extra HS modules generated by preprocessing to build
 -- information.
@@ -716,7 +716,7 @@ replComponent
     preprocessComponent pkg_descr comp lbi clbi False verbosity suffixHandlers
     extras <- preprocessExtras verbosity comp lbi
     let libbi = libBuildInfo lib
-        lib' = lib{libBuildInfo = libbi{cSources = cSources libbi ++ map extraSourceFromPath extras}}
+        lib' = lib{libBuildInfo = libbi{cSources = cSources libbi ++ map (flip ExtraSourcePkg []) extras}}
     replLib replFlags pkg lbi lib' libClbi
 replComponent
   replFlags
@@ -733,23 +733,23 @@ replComponent
       case comp of
         CLib lib -> do
           let libbi = libBuildInfo lib
-              lib' = lib{libBuildInfo = libbi{cSources = cSources libbi ++ map extraSourceFromPath extras}}
+              lib' = lib{libBuildInfo = libbi{cSources = cSources libbi ++ map (flip ExtraSourcePkg []) extras}}
           replLib replFlags pkg_descr lbi lib' clbi
         CFLib flib ->
           replFLib replFlags pkg_descr lbi flib clbi
         CExe exe -> do
           let ebi = buildInfo exe
-              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map extraSourceFromPath extras}}
+              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map (flip ExtraSourcePkg []) extras}}
           replExe replFlags pkg_descr lbi exe' clbi
         CTest test@TestSuite{testInterface = TestSuiteExeV10{}} -> do
           let exe = testSuiteExeV10AsExe test
           let ebi = buildInfo exe
-              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map extraSourceFromPath extras}}
+              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map (flip ExtraSourcePkg []) extras}}
           replExe replFlags pkg_descr lbi exe' clbi
         CBench bm@Benchmark{benchmarkInterface = BenchmarkExeV10{}} -> do
           let exe = benchmarkExeV10asExe bm
           let ebi = buildInfo exe
-              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map extraSourceFromPath extras}}
+              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map (flip ExtraSourcePkg []) extras}}
           replExe replFlags pkg_descr lbi exe' clbi
 #if __GLASGOW_HASKELL__ < 811
 -- silence pattern-match warnings prior to GHC 9.0