feat: support generated cmm-sources

Author: andreabedini

Cabal-syntax/src/Distribution/PackageDescription/FieldGrammar.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.hs

@@ -16,6 +16,7 @@ import Distribution.Types.BuildInfo (BuildInfo)
 import Distribution.Types.ExtraSource (ExtraSource)
 import Distribution.Types.Dependency (Dependency)
 import Distribution.Types.ExeDependency (ExeDependency)
+import Distribution.Types.ExtraSource (ExtraSource)
 import Distribution.Types.LegacyExeDependency (LegacyExeDependency)
 import Distribution.Types.Mixin (Mixin)
 import Distribution.Types.PkgconfigDependency (PkgconfigDependency)
@@ -80,23 +81,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/BuildInfo/Lens.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/Types/ExtraSource.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.
 --