feat: add per-file options to extra source files

Author: andreabedini

Cabal-syntax/Cabal-syntax.cabal

@@ -140,6 +140,7 @@ library
     Distribution.Types.Executable
     Distribution.Types.Executable.Lens
     Distribution.Types.ExecutableScope
+    Distribution.Types.ExtraSource
     Distribution.Types.ExposedModule
     Distribution.Types.Flag
     Distribution.Types.ForeignLib

Cabal-syntax/src/Distribution/PackageDescription.hs

@@ -48,6 +48,9 @@ module Distribution.PackageDescription
   , module Distribution.Types.HookedBuildInfo
   , module Distribution.Types.SetupBuildInfo
 
+   -- * Extra sources
+  , module Distribution.Types.ExtraSource
+
     -- * Flags
   , module Distribution.Types.Flag
 
@@ -95,6 +98,7 @@ import Distribution.Types.ComponentName
 import Distribution.Types.CondTree
 import Distribution.Types.Condition
 import Distribution.Types.ConfVar
+import Distribution.Types.ExtraSource
 import Distribution.Types.Dependency
 import Distribution.Types.ExeDependency
 import Distribution.Types.Executable

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

@@ -174,6 +174,7 @@ 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 CommaVCat (Identity ModuleReexport) ModuleReexport)
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
@@ -224,6 +225,7 @@ 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 FSep (Identity ForeignLibOption) ForeignLibOption)
      , c (List FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
@@ -263,6 +265,7 @@ 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 FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -339,6 +342,7 @@ 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 FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -483,6 +487,7 @@ 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 FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -585,6 +590,7 @@ 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 FSep (MQuoted Extension) Extension)
      , c (List FSep (MQuoted Language) Language)
      , c (List FSep Token String)
@@ -627,14 +633,14 @@ buildInfoFieldGrammar =
     <*> monoidalFieldAla "pkgconfig-depends" (alaList CommaFSep) L.pkgconfigDepends
     <*> monoidalFieldAla "frameworks" (alaList' FSep RelativePathNT) L.frameworks
     <*> monoidalFieldAla "extra-framework-dirs" (alaList' FSep SymbolicPathNT) L.extraFrameworkDirs
-    <*> monoidalFieldAla "asm-sources" (alaList' VCat SymbolicPathNT) L.asmSources
+    <*> monoidalFieldAla "asm-sources" formatExtraSources L.asmSources
       ^^^ availableSince CabalSpecV3_0 []
-    <*> monoidalFieldAla "cmm-sources" (alaList' VCat SymbolicPathNT) L.cmmSources
+    <*> monoidalFieldAla "cmm-sources" formatExtraSources L.cmmSources
       ^^^ availableSince CabalSpecV3_0 []
-    <*> monoidalFieldAla "c-sources" (alaList' VCat SymbolicPathNT) L.cSources
-    <*> monoidalFieldAla "cxx-sources" (alaList' VCat SymbolicPathNT) L.cxxSources
+    <*> monoidalFieldAla "c-sources" formatExtraSources L.cSources
+    <*> monoidalFieldAla "cxx-sources" formatExtraSources L.cxxSources
       ^^^ availableSince CabalSpecV2_2 []
-    <*> monoidalFieldAla "js-sources" (alaList' VCat SymbolicPathNT) L.jsSources
+    <*> monoidalFieldAla "js-sources" formatExtraSources L.jsSources
     <*> hsSourceDirsGrammar
     <*> monoidalFieldAla "other-modules" formatOtherModules L.otherModules
     <*> monoidalFieldAla "virtual-modules" (alaList' VCat MQuoted) L.virtualModules
@@ -834,6 +840,9 @@ formatOtherExtensions = alaList' FSep MQuoted
 formatOtherModules :: [ModuleName] -> List VCat (MQuoted ModuleName) ModuleName
 formatOtherModules = alaList' VCat MQuoted
 
+formatExtraSources :: [ExtraSource] -> List VCat (Identity ExtraSource) ExtraSource
+formatExtraSources = alaList' VCat Identity
+
 -------------------------------------------------------------------------------
 -- newtypes
 -------------------------------------------------------------------------------

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

@@ -21,6 +21,7 @@ import Prelude ()
 
 import Distribution.Types.Dependency
 import Distribution.Types.ExeDependency
+import Distribution.Types.ExtraSource
 import Distribution.Types.LegacyExeDependency
 import Distribution.Types.Mixin
 import Distribution.Types.PkgconfigDependency
@@ -70,14 +71,17 @@ data BuildInfo = BuildInfo
   , frameworks :: [RelativePath Framework File]
   -- ^ support frameworks for Mac OS X
   , extraFrameworkDirs :: [SymbolicPath Pkg (Dir Framework)]
-  -- ^ extra locations to find frameworks.
-  , asmSources :: [SymbolicPath Pkg File]
-  -- ^ Assembly files.
-  , cmmSources :: [SymbolicPath Pkg File]
-  -- ^ C-- files.
-  , cSources :: [SymbolicPath Pkg File]
-  , cxxSources :: [SymbolicPath Pkg File]
-  , jsSources :: [SymbolicPath Pkg File]
+  -- ^ extra locations to find frameworks
+  , asmSources :: [ExtraSource]
+  -- ^ Assembly source files
+  , cmmSources :: [ExtraSource]
+  -- ^ C-- source files
+  , cSources :: [ExtraSource]
+  -- ^ C source files
+  , cxxSources :: [ExtraSource]
+  -- ^ C++ source files
+  , jsSources :: [ExtraSource]
+  -- ^ JavaScript source file
   , hsSourceDirs :: [SymbolicPath Pkg (Dir Source)]
   -- ^ where to look for the Haskell module hierarchy
   , -- NB: these are symbolic paths are not relative paths,

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

@@ -13,6 +13,7 @@ import Prelude ()
 import Distribution.Compiler (PerCompilerFlavor)
 import Distribution.ModuleName (ModuleName)
 import Distribution.Types.BuildInfo (BuildInfo)
+import Distribution.Types.ExtraSource (ExtraSource)
 import Distribution.Types.Dependency (Dependency)
 import Distribution.Types.ExeDependency (ExeDependency)
 import Distribution.Types.LegacyExeDependency (LegacyExeDependency)
@@ -79,23 +80,23 @@ class HasBuildInfo a where
   extraFrameworkDirs = buildInfo . extraFrameworkDirs
   {-# INLINE extraFrameworkDirs #-}
 
-  asmSources :: Lens' a [SymbolicPath Pkg File]
+  asmSources :: Lens' a [ExtraSource]
   asmSources = buildInfo . asmSources
   {-# INLINE asmSources #-}
 
-  cmmSources :: Lens' a [SymbolicPath Pkg File]
+  cmmSources :: Lens' a [ExtraSource]
   cmmSources = buildInfo . cmmSources
   {-# INLINE cmmSources #-}
 
-  cSources :: Lens' a [SymbolicPath Pkg File]
+  cSources :: Lens' a [ExtraSource]
   cSources = buildInfo . cSources
   {-# INLINE cSources #-}
 
-  cxxSources :: Lens' a [SymbolicPath Pkg File]
+  cxxSources :: Lens' a [ExtraSource]
   cxxSources = buildInfo . cxxSources
   {-# INLINE cxxSources #-}
 
-  jsSources :: Lens' a [SymbolicPath Pkg File]
+  jsSources :: Lens' a [ExtraSource]
   jsSources = buildInfo . jsSources
   {-# INLINE jsSources #-}
 
@@ -267,7 +268,7 @@ instance HasBuildInfo BuildInfo where
   cSources f s = fmap (\x -> s{T.cSources = x}) (f (T.cSources s))
   {-# INLINE cSources #-}
 
-  cxxSources f s = fmap (\x -> s{T.cSources = x}) (f (T.cxxSources s))
+  cxxSources f s = fmap (\x -> s{T.cxxSources = x}) (f (T.cxxSources s))
   {-# INLINE cxxSources #-}
 
   jsSources f s = fmap (\x -> s{T.jsSources = x}) (f (T.jsSources s))

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

@@ -0,0 +1,48 @@
+{-# LANGUAGE DeriveDataTypeable #-}
+{-# LANGUAGE DeriveGeneric #-}
+{-# LANGUAGE DataKinds #-}
+
+module Distribution.Types.ExtraSource
+  ( ExtraSource (..)
+  , extraSourceFromPath
+  ) where
+
+import Distribution.Compat.Prelude
+import Prelude ()
+
+import Distribution.Parsec
+import Distribution.Pretty
+import Distribution.Utils.Path (SymbolicPath, FileOrDir(..), Pkg)
+
+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]
+  }
+  deriving (Generic, Show, Read, Eq, Ord, Typeable, Data)
+
+instance Binary ExtraSource
+instance Structured ExtraSource
+instance NFData ExtraSource where rnf = genericRnf
+
+instance Parsec ExtraSource where
+  parsec = do
+    SymbolicPathNT path <- parsec <* P.spaces
+    opts <- P.optional (parensLax (P.sepBy p  P.spaces))
+    return (ExtraSource path (fromMaybe mempty opts))
+    where
+      p :: P.CharParsing p => p String
+      p = some $ P.satisfy (\c -> not (isSpace c) && not (c == ')'))
+
+parensLax :: (P.CharParsing m) => m a -> m a
+parensLax p = P.between (P.char '(' *> P.spaces) (P.char ')' *> P.spaces) p
+
+instance Pretty ExtraSource where
+  pretty (ExtraSource path opts) =
+    pretty (SymbolicPathNT path) <<>> PP.parens (PP.hsep (map PP.text opts))
+
+extraSourceFromPath :: SymbolicPath Pkg File -> ExtraSource
+extraSourceFromPath fp = ExtraSource fp mempty

Cabal-tests/tests/NoThunks.hs

@@ -1,4 +1,5 @@
 {-# LANGUAGE CPP                 #-}
+{-# LANGUAGE FlexibleInstances #-}
 #if !(__GLASGOW_HASKELL__ >= 806 && defined(MIN_VERSION_nothunks))
 module Main (main) where
 main :: IO ()
@@ -24,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)
@@ -72,6 +73,8 @@ instance NoThunks ConfVar
 instance NoThunks Dependency
 instance NoThunks Executable
 instance NoThunks ExecutableScope
+instance NoThunks (ExtraSource Pkg)
+instance NoThunks (ExtraSource Build)
 instance NoThunks FlagName
 instance NoThunks ForeignLib
 instance NoThunks ForeignLibOption

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

@@ -1,5 +1,6 @@
 {-# OPTIONS_GHC -freduction-depth=0 #-}
 {-# OPTIONS_GHC -Wno-orphans #-}
+{-# LANGUAGE FlexibleInstances #-}
 module Data.TreeDiff.Instances.Cabal () where
 
 import Data.TreeDiff
@@ -28,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, Pkg, Build)
 import Distribution.Utils.ShortText                (ShortText, fromShortText)
 import Distribution.Verbosity
 import Distribution.Verbosity.Internal
@@ -77,6 +78,8 @@ instance ToExpr ExeDependency
 instance ToExpr Executable
 instance ToExpr ExecutableScope
 instance ToExpr ExposedModule
+instance ToExpr (ExtraSource Pkg)
+instance ToExpr (ExtraSource Build)
 instance ToExpr FlagAssignment
 instance ToExpr FlagName
 instance ToExpr ForeignLib

Cabal/src/Distribution/PackageDescription/Check/Target.hs

@@ -445,11 +445,11 @@ checkBuildInfoPathsContent bi = do
 -- Paths well-formedness check for BuildInfo.
 checkBuildInfoPathsWellFormedness :: Monad m => BuildInfo -> CheckM m ()
 checkBuildInfoPathsWellFormedness bi = do
-  mapM_ (checkPath False "asm-sources" PathKindFile . getSymbolicPath) (asmSources bi)
-  mapM_ (checkPath False "cmm-sources" PathKindFile . getSymbolicPath) (cmmSources bi)
-  mapM_ (checkPath False "c-sources" PathKindFile . getSymbolicPath) (cSources bi)
-  mapM_ (checkPath False "cxx-sources" PathKindFile . getSymbolicPath) (cxxSources bi)
-  mapM_ (checkPath False "js-sources" PathKindFile . getSymbolicPath) (jsSources bi)
+  mapM_ (checkPath False "asm-sources" PathKindFile . getSymbolicPath . extraSourceFile) (asmSources bi)
+  mapM_ (checkPath False "cmm-sources" PathKindFile . getSymbolicPath . extraSourceFile) (cmmSources bi)
+  mapM_ (checkPath False "c-sources" PathKindFile . getSymbolicPath . extraSourceFile) (cSources bi)
+  mapM_ (checkPath False "cxx-sources" PathKindFile . getSymbolicPath . extraSourceFile) (cxxSources bi)
+  mapM_ (checkPath False "js-sources" PathKindFile . getSymbolicPath . extraSourceFile) (jsSources bi)
   mapM_
     (checkPath False "install-includes" PathKindFile . getSymbolicPath)
     (installIncludes bi)
@@ -515,8 +515,8 @@ checkBuildInfoFeatures bi sv = do
     (PackageBuildWarning CVExtensionsDeprecated)
 
   -- asm-sources, cmm-sources and friends only w/ spec ≥ 1.10
-  checkCVSources (map getSymbolicPath $ asmSources bi)
-  checkCVSources (map getSymbolicPath $ cmmSources bi)
+  checkCVSources (map (getSymbolicPath . extraSourceFile) $ asmSources bi)
+  checkCVSources (map (getSymbolicPath . extraSourceFile) $ cmmSources bi)
   checkCVSources (extraBundledLibs bi)
   checkCVSources (extraLibFlavours bi)
 

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 (extras ++ cSources bi)
+    new = ordNub (map extraSourceFromPath 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 (extras ++ cxxSources bi)
+    new = ordNub (map extraSourceFromPath 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 (extras ++ cmmSources bi)
+    new = ordNub (map extraSourceFromPath 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 (extras ++ asmSources bi)
+    new = ordNub (map extraSourceFromPath 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 (extras ++ jsSources bi)
+    new = ordNub (map extraSourceFromPath 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 ++ extras}}
+        lib' = lib{libBuildInfo = libbi{cSources = cSources libbi ++ map extraSourceFromPath 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 ++ extras}}
+              lib' = lib{libBuildInfo = libbi{cSources = cSources libbi ++ map extraSourceFromPath 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 ++ extras}}
+              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map extraSourceFromPath 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 ++ extras}}
+              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map extraSourceFromPath 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 ++ extras}}
+              exe' = exe{buildInfo = ebi{cSources = cSources ebi ++ map extraSourceFromPath extras}}
           replExe replFlags pkg_descr lbi exe' clbi
 #if __GLASGOW_HASKELL__ < 811
 -- silence pattern-match warnings prior to GHC 9.0