Add jsp-options (#10721)

Co-authored-by: Mateusz Goslinowski <[email protected]>

Author: zlonast

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

@@ -621,6 +621,8 @@ buildInfoFieldGrammar =
     <*> monoidalFieldAla "cc-options" (alaList' NoCommaFSep Token') L.ccOptions
     <*> monoidalFieldAla "cxx-options" (alaList' NoCommaFSep Token') L.cxxOptions
       ^^^ availableSince CabalSpecV2_2 []
+    <*> monoidalFieldAla "jsp-options" (alaList' NoCommaFSep Token') L.jspOptions
+      ^^^ availableSince CabalSpecV3_14 []
     <*> monoidalFieldAla "ld-options" (alaList' NoCommaFSep Token') L.ldOptions
     <*> monoidalFieldAla "hsc2hs-options" (alaList' NoCommaFSep Token') L.hsc2hsOptions
       ^^^ availableSince CabalSpecV3_6 []

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

@@ -61,6 +61,8 @@ data BuildInfo = BuildInfo
   -- ^ options for C compiler
   , cxxOptions :: [String]
   -- ^ options for C++ compiler
+  , jspOptions :: [String]
+  -- ^ options for pre-processing JavaScript code
   , ldOptions :: [String]
   -- ^ options for linker
   , hsc2hsOptions :: [String]
@@ -161,6 +163,7 @@ instance Monoid BuildInfo where
       , cmmOptions = []
       , ccOptions = []
       , cxxOptions = []
+      , jspOptions = []
       , ldOptions = []
       , hsc2hsOptions = []
       , pkgconfigDepends = []
@@ -214,6 +217,7 @@ instance Semigroup BuildInfo where
       , cmmOptions = combine cmmOptions
       , ccOptions = combine ccOptions
       , cxxOptions = combine cxxOptions
+      , jspOptions = combine jspOptions
       , ldOptions = combine ldOptions
       , hsc2hsOptions = combine hsc2hsOptions
       , pkgconfigDepends = combine pkgconfigDepends

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

@@ -59,6 +59,10 @@ class HasBuildInfo a where
   cxxOptions = buildInfo . cxxOptions
   {-# INLINE cxxOptions #-}
 
+  jspOptions :: Lens' a [String]
+  jspOptions = buildInfo . jspOptions
+  {-# INLINE jspOptions #-}
+
   ldOptions :: Lens' a [String]
   ldOptions = buildInfo . ldOptions
   {-# INLINE ldOptions #-}

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

@@ -814,6 +814,7 @@ checkBuildInfoOptions t bi = do
   checkCLikeOptions LangC "cc-options" (ccOptions bi) ldOpts
   checkCLikeOptions LangCPlusPlus "cxx-options" (cxxOptions bi) ldOpts
   checkCPPOptions (cppOptions bi)
+  checkJSPOptions (jspOptions bi)
 
 -- | Checks GHC options for commonly misused or non-portable flags.
 checkGHCOptions
@@ -904,6 +905,12 @@ checkGHCOptions title t opts = do
         ( [(flag, flag) | flag@('-' : 'D' : _) <- ghcNoRts]
             ++ [(flag, flag) | flag@('-' : 'U' : _) <- ghcNoRts]
         )
+      checkAlternatives
+        title
+        "jsp-options"
+        ( [(flag, flag) | flag@('-' : 'D' : _) <- ghcNoRts]
+            ++ [(flag, flag) | flag@('-' : 'U' : _) <- ghcNoRts]
+        )
       checkAlternatives
         title
         "include-dirs"
@@ -1093,3 +1100,21 @@ checkCPPOptions opts = do
           (PackageBuildWarning (COptCPP opt))
     )
     opts
+
+checkJSPOptions
+  :: Monad m
+  => [String] -- Options in String form.
+  -> CheckM m ()
+checkJSPOptions opts = do
+  checkAlternatives
+    "jsp-options"
+    "include-dirs"
+    [(flag, dir) | flag@('-' : 'I' : dir) <- opts]
+  mapM_
+    ( \opt ->
+        checkP
+          (not $ any (`isPrefixOf` opt) ["-D", "-U", "-I"])
+          (PackageBuildWarning (OptJSP opt))
+    )
+    opts
+

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

@@ -214,6 +214,7 @@ data CheckExplanation
   | OptWithRts String
   | COptONumber String WarnLang
   | COptCPP String
+  | OptJSP String
   | OptAlternatives String String [(String, String)]
   | RelativeOutside String FilePath
   | AbsolutePath String FilePath
@@ -380,6 +381,7 @@ data CheckExplanationID
   | CIOptWithRts
   | CICOptONumber
   | CICOptCPP
+  | CIOptJSP
   | CIOptAlternatives
   | CIRelativeOutside
   | CIAbsolutePath
@@ -525,6 +527,7 @@ checkExplanationId (OptRts{}) = CIOptRts
 checkExplanationId (OptWithRts{}) = CIOptWithRts
 checkExplanationId (COptONumber{}) = CICOptONumber
 checkExplanationId (COptCPP{}) = CICOptCPP
+checkExplanationId (OptJSP{}) = CIOptJSP
 checkExplanationId (OptAlternatives{}) = CIOptAlternatives
 checkExplanationId (RelativeOutside{}) = CIRelativeOutside
 checkExplanationId (AbsolutePath{}) = CIAbsolutePath
@@ -677,6 +680,7 @@ ppCheckExplanationId CIOptRts = "option-rtsopts"
 ppCheckExplanationId CIOptWithRts = "option-with-rtsopts"
 ppCheckExplanationId CICOptONumber = "option-opt-c"
 ppCheckExplanationId CICOptCPP = "cpp-options"
+ppCheckExplanationId CIOptJSP = "jsp-options"
 ppCheckExplanationId CIOptAlternatives = "misplaced-c-opt"
 ppCheckExplanationId CIRelativeOutside = "relative-path-outside"
 ppCheckExplanationId CIAbsolutePath = "absolute-path"
@@ -1086,6 +1090,8 @@ ppExplanation (COptONumber prefix label) =
     ++ " --disable-optimization flag."
 ppExplanation (COptCPP opt) =
   "'cpp-options: " ++ opt ++ "' is not a portable C-preprocessor flag."
+ppExplanation (OptJSP opt) =
+  "'jsp-options: " ++ opt ++ "' is not a portable C-preprocessor flag."
 ppExplanation (OptAlternatives badField goodField flags) =
   "Instead of "
     ++ quote (badField ++ ": " ++ unwords badFlags)

Cabal/src/Distribution/Simple/GHC/Internal.hs

@@ -510,7 +510,7 @@ componentJsGhcOptions verbosity lbi bi clbi odir filename =
     , ghcOptPackageDBs = withPackageDB lbi
     , ghcOptPackages = toNubListR $ mkGhcOptPackages (promisedPkgs lbi) clbi
     , ghcOptObjDir = toFlag odir
-    , ghcOptExtra = hcOptions GHC bi
+    , ghcOptExtra = jspOptions bi <> hcOptions GHC bi
     }
 
 componentGhcOptions

doc/buildinfo-fields-reference.rst

@@ -256,6 +256,13 @@ cmm-sources
     .. math::
         \mathrm{commalist}\left\{ \mathop{\mathit{hs\text{-}string}}\mid{{[\mathop{\mathord{``}\mathtt{\ }\mathord{"}}\mathop{\mathord{``}\mathtt{\text{,}}\mathord{"}}]^c}}^+_{} \right\}
 
+jsp-options
+    * Monoidal field
+    * Documentation of :pkg-field:`library:jsp-options`
+
+    .. math::
+        {\left\{ \mathop{\mathit{hs\text{-}string}}\mid{{[\mathop{\mathord{``}\mathtt{\ }\mathord{"}}]^c}}^+_{} \right\}}^\ast_{\bullet}
+
 cpp-options
     * Monoidal field
     * Documentation of :pkg-field:`library:cpp-options`

doc/cabal-commands.rst

@@ -1405,6 +1405,7 @@ A list of all warnings with their constructor:
 - ``option-with-rtsopts``: unnecessary ``-with-rtsopts``.
 - ``option-opt-c``: unnecessary ``-O[n]`` in C code.
 - ``cpp-options``: unportable ``-cpp-options`` flag.
+- ``jsp-options``: unportable ``-jsp-options`` flag.
 - ``misplaced-c-opt``: C-like options in wrong cabal field.
 - ``relative-path-outside``: relative path outside of source tree.
 - ``absolute-path``: absolute path where not allowed.

doc/cabal-package-description-file.rst

@@ -1992,6 +1992,13 @@ system-dependent values for these fields.
     arguments are compiler-dependent, this field is more useful with the
     setup described in the section on `system-dependent parameters`_.
 
+.. pkg-field:: jsp-options: token list
+
+    Command-line arguments for pre-processing Haskell code. Applies to
+    Haskell source and other pre-processed Haskell source like .js.
+    Does not apply to C code, that's what cc-options is for.
+    Flags here will be passed as ``-optJSP`` flags to GHC.
+
 .. pkg-field:: cpp-options: token list
 
     Command-line arguments for pre-processing Haskell code. Applies to

editors/vim/syntax/cabal.vim

@@ -65,6 +65,7 @@ syn keyword cabalFieldName contained
   \ cmm-options
   \ cmm-sources
   \ copyright
+  \ jsp-options
   \ cpp-options
   \ cxx-options
   \ cxx-sources