packages feed

cabal-helper 0.7.3.0 → 1.1.0.0

raw patch · 106 files changed

Files

− CabalHelper/Common.hs 
@@ -1,106 +0,0 @@--- cabal-helper: Simple interface to Cabal's configuration state--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>------ This program is free software: you can redistribute it and/or modify--- it under the terms of the GNU Affero General Public License as published by--- the Free Software Foundation, either version 3 of the License, or--- (at your option) any later version.------ This program is distributed in the hope that it will be useful,--- but WITHOUT ANY WARRANTY; without even the implied warranty of--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the--- GNU Affero General Public License for more details.------ You should have received a copy of the GNU Affero General Public License--- along with this program.  If not, see <http://www.gnu.org/licenses/>.--{-# LANGUAGE DeriveDataTypeable, OverloadedStrings #-}-module CabalHelper.Common where--import Control.Applicative-import Control.Exception as E-import Control.Monad-import Data.List-import Data.Maybe-import Data.Version-import Data.Typeable-import Data.ByteString (ByteString)-import qualified Data.ByteString as BS-import qualified Data.ByteString.Char8 as BS8-import System.Environment-import System.IO-import System.Exit-import System.Directory-import System.FilePath-import Text.ParserCombinators.ReadP-import Prelude--data Panic = Panic String deriving (Typeable, Show)-instance Exception Panic--panic :: String -> a-panic msg = throw $ Panic msg--handlePanic :: IO a -> IO a-handlePanic action =-    action `E.catch` \(Panic msg) -> errMsg msg >> exitFailure--errMsg :: String -> IO ()-errMsg str = do-  prog <- getProgName-  hPutStrLn stderr $ prog ++ ": " ++ str---- | @getCabalConfigHeader "dist/setup-config"@ returns the cabal version and--- compiler version-getCabalConfigHeader :: FilePath -> IO (Maybe (Version, (ByteString, Version)))-getCabalConfigHeader file = bracket (openFile file ReadMode) hClose $ \h -> do-  parseHeader <$> BS.hGetLine h--parseHeader :: ByteString -> Maybe (Version, (ByteString, Version))-parseHeader header = case BS8.words header of-  ["Saved", "package", "config", "for", _pkgId ,-   "written", "by", cabalId,-   "using", compId]-    -> liftM2 (,) (snd <$> parsePkgId cabalId) (parsePkgId compId)-  _ -> Nothing--parsePkgId :: ByteString -> Maybe (ByteString, Version)-parsePkgId bs =-    case BS8.split '-' bs of-      [pkg, vers] -> Just (pkg, parseVer $ BS8.unpack vers)-      _ -> Nothing--parseVer :: String -> Version-parseVer vers = runReadP parseVersion vers--majorVer :: Version -> Version-majorVer (Version b _) = Version (take 2 b) []--sameMajorVersionAs :: Version -> Version -> Bool-sameMajorVersionAs a b = majorVer a == majorVer b--runReadP :: ReadP t -> String -> t-runReadP p i = case filter ((=="") . snd) $ readP_to_S p i of-                 (a,""):[] -> a-                 _ -> error $ "Error parsing: " ++ show i--appDataDir :: IO FilePath-appDataDir = (</> "cabal-helper") <$> getAppUserDataDirectory "ghc-mod"--isCabalFile :: FilePath -> Bool-isCabalFile f = takeExtension' f == ".cabal"--takeExtension' :: FilePath -> String-takeExtension' p =-    if takeFileName p == takeExtension p-      then "" -- just ".cabal" is not a valid cabal file-      else takeExtension p--replace :: String -> String -> String -> String-replace n r hs' = go "" hs'- where-   go acc h-       | take (length n) h == n =-           reverse acc ++ r ++ drop (length n) h-   go acc (h:hs) = go (h:acc) hs-   go acc [] = reverse acc
− CabalHelper/Compile.hs 
@@ -1,479 +0,0 @@--- cabal-helper: Simple interface to Cabal's configuration state--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>------ This program is free software: you can redistribute it and/or modify--- it under the terms of the GNU Affero General Public License as published by--- the Free Software Foundation, either version 3 of the License, or--- (at your option) any later version.------ This program is distributed in the hope that it will be useful,--- but WITHOUT ANY WARRANTY; without even the implied warranty of--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the--- GNU Affero General Public License for more details.------ You should have received a copy of the GNU Affero General Public License--- along with this program.  If not, see <http://www.gnu.org/licenses/>.-{-# LANGUAGE RecordWildCards, FlexibleContexts #-}-module CabalHelper.Compile where--import Control.Applicative-import Control.Arrow-import Control.Exception as E-import Control.Monad-import Control.Monad.Trans.Maybe-import Control.Monad.IO.Class-import Data.Traversable-import Data.Char-import Data.List-import Data.Maybe-import Data.String-import Data.Version-import Text.Printf-import System.Directory-import System.FilePath-import System.Process-import System.Exit-import System.IO-import System.IO.Temp-import Prelude--import Distribution.System (buildPlatform)-import Distribution.Text (display)--import Paths_cabal_helper (version)-import CabalHelper.Data-import CabalHelper.Common-import CabalHelper.Sandbox (getSandboxPkgDb)-import CabalHelper.Types-import CabalHelper.Log--data Compile = Compile {-      compCabalHelperSourceDir :: FilePath,-      compCabalSourceDir :: Maybe FilePath,-      compPackageDb      :: Maybe FilePath,-      compCabalVersion   :: Either String Version,-      compPackageDeps    :: [String]-    }--compileHelper :: Options -> Version -> FilePath -> FilePath -> IO (Either ExitCode FilePath)-compileHelper opts cabalVer projdir distdir = withHelperSources $ \chdir -> do-  case cabalPkgDb opts of-    Nothing ->-      run [-            -- TODO: here ghc's caching fails and it always recompiles, probably-            -- because we write the sources to a tempdir and they always look-            -- newer than the Cabal sources, not sure if we can fix this-            compileCabalSource chdir-          , Right <$> MaybeT (cachedExe cabalVer)-          , compileSandbox chdir-          , compileGlobal chdir-          , cachedCabalPkg chdir-          , MaybeT (Just <$> compilePrivatePkgDb chdir)-          ]-    mdb ->-      run [ Right <$> MaybeT (cachedExe cabalVer)-          , liftIO $ compileWithPkg chdir mdb cabalVer-          ]-- where-   run actions = fromJust <$> runMaybeT (msum actions)--   logMsg = "compiling helper with Cabal from "----- for relaxed deps: find (sameMajorVersionAs cabalVer) . reverse . sort--   -- | Check if this version is globally available-   compileGlobal :: FilePath -> MaybeT IO (Either ExitCode FilePath)-   compileGlobal chdir = do-       ver <- MaybeT $ find (== cabalVer) <$> listCabalVersions opts-       vLog opts $ logMsg ++ "user/global package-db"-       liftIO $ compileWithPkg chdir Nothing ver--   -- | Check if this version is available in the project sandbox-   compileSandbox :: FilePath -> MaybeT IO (Either ExitCode FilePath)-   compileSandbox chdir = do-       sandbox <- MaybeT $ getSandboxPkgDb projdir (display buildPlatform) =<< ghcVersion opts-       ver <- MaybeT $ logSomeError opts "compileSandbox" $-         find (== cabalVer) <$> listCabalVersions' opts (Just sandbox)-       vLog opts $ logMsg ++ "sandbox package-db"-       liftIO $ compileWithPkg chdir (Just sandbox) ver---   -- | Check if we already compiled this version of cabal into a private-   -- package-db-   cachedCabalPkg :: FilePath -> MaybeT IO (Either ExitCode FilePath)-   cachedCabalPkg chdir = do-       db_exists <- liftIO $ cabalPkgDbExists opts cabalVer-       case db_exists of-         False -> mzero-         True -> do-             db <- liftIO $ getPrivateCabalPkgDb opts (showVersion cabalVer)-             vLog opts $ logMsg ++ "private package-db in " ++ db-             liftIO $ compileWithPkg chdir (Just db) cabalVer--   -- | See if we're in a cabal source tree-   compileCabalSource :: FilePath -> MaybeT IO (Either ExitCode FilePath)-   compileCabalSource chdir = do-       let cabalFile = projdir </> "Cabal.cabal"-           isCabalMagicVer = cabalVer == Version [1,9999] []-       cabalSrc <- liftIO $ doesFileExist cabalFile--       when isCabalMagicVer $-         vLog opts $ "cabal magic version (1.9999) found"--       when cabalSrc $-         vLog opts $ "directory above distdir looks like cabal source tree (Cabal.cabal exists)"--       case isCabalMagicVer || cabalSrc of-         False -> mzero-         True -> liftIO $ do-           ver <- cabalFileVersion <$> readFile cabalFile-           vLog opts $ "compiling helper with local Cabal source tree"-           compileWithCabalTree chdir ver projdir--   -- | Compile the requested cabal version into an isolated package-db-   compilePrivatePkgDb :: FilePath -> IO (Either ExitCode FilePath)-   compilePrivatePkgDb chdir = do-       db <- installCabal opts cabalVer `E.catch`-             \(SomeException _) -> errorInstallCabal cabalVer distdir-       compileWithPkg chdir (Just db) cabalVer--   compileWithCabalTree chdir ver srcDir =-       compile distdir opts $ Compile chdir (Just srcDir) Nothing (Right ver) []--   compileWithPkg chdir mdb ver =-       compile distdir opts $ Compile chdir Nothing mdb (Right ver) [cabalPkgId ver]--   cabalPkgId v = "Cabal-" ++ showVersion v--compile :: FilePath -> Options -> Compile -> IO (Either ExitCode FilePath)-compile distdir opts@Options {..} Compile {..} = do-    cCabalSourceDir <- canonicalizePath `traverse` compCabalSourceDir-    appdir <- appDataDir--    let outdir' = maybe appdir (const $ distdir </> "cabal-helper") cCabalSourceDir-    createDirectoryIfMissing True outdir'-    outdir <- canonicalizePath outdir'--    let exedir' = maybe outdir (const distdir) cCabalSourceDir-    createDirectoryIfMissing True exedir'-    exedir <- canonicalizePath exedir'-    exe <- exePath' compCabalVersion <$> canonicalizePath exedir--    vLog opts $ "outdir: " ++ outdir-    vLog opts $ "exedir: " ++ exedir--    let (mj:mi:_) = case compCabalVersion of-                     Left _commitid -> [1, 10000]-                     Right (Version vs _) -> vs-    let ghc_opts =-             concat [-          [ "-outputdir", outdir-          , "-o", exe-          , "-optP-DCABAL_HELPER=1"-          , "-optP-DCABAL_MAJOR=" ++ show mj-          , "-optP-DCABAL_MINOR=" ++ show mi-          ],-          maybeToList $ ("-package-conf="++) <$> compPackageDb,-          map ("-i"++) $ nub $ ".":maybeToList cCabalSourceDir,--          if isNothing cCabalSourceDir-             then [ "-hide-all-packages"-                  , "-package", "base"-                  , "-package", "containers"-                  , "-package", "directory"-                  , "-package", "filepath"-                  , "-package", "process"-                  , "-package", "bytestring"-                  , "-package", "ghc-prim"-                  ]-             else [],--          concatMap (\p -> ["-package", p]) compPackageDeps,-          [ "--make",  "CabalHelper/Main.hs" ]-         ]--    vLog opts $ intercalate " " $ map (("\""++) . (++"\"")) $ ghcProgram:ghc_opts--    -- TODO: touch exe after, ghc doesn't do that if the input files didn't-    -- actually change-    rv <- callProcessStderr' (Just compCabalHelperSourceDir) ghcProgram ghc_opts-    return $ case rv of-               ExitSuccess -> Right exe-               e@(ExitFailure _) -> Left e--exePath :: Either String Version -> IO FilePath-exePath compCabalVersion = do-    exePath' compCabalVersion <$> appDataDir--exePath' :: Either String Version -> FilePath -> FilePath-exePath' (Left commitid) outdir =-    outdir </> "cabal-helper-" ++ showVersion version -- our ver-            ++ "-Cabal-HEAD-" ++ commitid-exePath' (Right compCabalVersion) outdir =-    outdir </> "cabal-helper-" ++ showVersion version -- our ver-            ++ "-Cabal-" ++ showVersion compCabalVersion--callProcessStderr' :: Maybe FilePath -> FilePath -> [String] -> IO ExitCode-callProcessStderr' mwd exe args = do-  (_, _, _, h) <- createProcess (proc exe args) { std_out = UseHandle stderr-                                                , cwd = mwd }-  waitForProcess h--callProcessStderr :: Maybe FilePath -> FilePath -> [String] -> IO ()-callProcessStderr mwd exe args = do-  rv <- callProcessStderr' mwd exe args-  case rv of-    ExitSuccess -> return ()-    ExitFailure v -> processFailedException "callProcessStderr" exe args v--processFailedException :: String -> String -> [String] -> Int -> IO a-processFailedException fn exe args rv =-      panic $ concat [fn, ": ", exe, " "-                     , intercalate " " (map show args)-                     , " (exit " ++ show rv ++ ")"]--installCabal :: Options -> Version -> IO FilePath-installCabal opts ver = do-  appdir <- appDataDir-  let sver = showVersion ver-  hPutStr stderr $ printf "\-\cabal-helper-wrapper: Installing a private copy of Cabal because we couldn't\n\-\find the right version in your global/user package-db, this might take a\n\-\while but will only happen once per Cabal version you're using.\n\-\\n\-\If anything goes horribly wrong just delete this directory and try again:\n\-\    %s\n\-\\n\-\If you want to avoid this automatic installation altogether install\n\-\version %s of Cabal manually (into your user or global package-db):\n\-\    $ cabal install Cabal --constraint \"Cabal == %s\"\n\-\\n\-\Installing Cabal %s ...\n" appdir sver sver sver--  withSystemTempDirectory "cabal-helper" $ \tmpdir -> do-    let-        mpatch :: Maybe (FilePath -> IO ())-        mpatch = snd <$> find ((ver`elem`) . fst) patchyCabalVersions-    msrcdir <- sequenceA $ unpackPatchedCabal opts ver tmpdir <$> mpatch-    db <- createPkgDb opts (showVersion ver)-    cabalInstall opts db (maybe (Right ver) Left msrcdir)-    return db--installCabalHEAD :: Options -> IO (FilePath, String)-installCabalHEAD opts = do-  withSystemTempDirectory "cabal-helper" $ \tmpdir -> do-    (srcdir, commit) <- unpackCabalHEAD tmpdir-    db <- createPkgDb opts commit-    cabalInstall opts db (Left srcdir)-    return (db, commit)--cabalInstall :: Options -> FilePath -> Either FilePath Version -> IO ()-cabalInstall opts db e_ver_msrcdir = do-  cabalInstallVer <- cabalInstallVersion opts-  cabal_opts <- return $ concat-      [-        [ "--package-db=clear"-        , "--package-db=global"-        , "--package-db=" ++ db-        , "--prefix=" ++ db </> "prefix"-        , "--with-ghc=" ++ ghcProgram opts-        ]-        , if cabalInstallVer >= Version [1,20,0,0] []-             then ["--no-require-sandbox"]-             else []-        , if ghcPkgProgram opts /= ghcPkgProgram defaultOptions-            then [ "--with-ghc-pkg=" ++ ghcPkgProgram opts ]-            else []-        ,-          case e_ver_msrcdir of-            Right ver ->-                [ "install", "Cabal"-                , "--constraint", "Cabal == " ++ showVersion ver-                ]-            Left srcdir ->-                [ "install", srcdir ]-      ]--  vLog opts $ intercalate " "-            $ map (("\""++) . (++"\""))-            $ cabalProgram opts:cabal_opts--  callProcessStderr (Just "/") (cabalProgram opts) cabal_opts-  hPutStrLn stderr "done"--patchyCabalVersions :: [([Version], FilePath -> IO ())]-patchyCabalVersions = [-    ( [ Version [1,18,1] [] ]-    , fixArrayConstraint-    ),---    ( [ Version [1,18,0] [] ]-    , \dir -> do-        fixArrayConstraint dir-        fixOrphanInstance dir-    ),--    -- just want the pristine version-    ( [ Version [1,24,1,0] [] ]-    , \_ -> return ()-    )-  ]- where-   fixArrayConstraint dir = do-     let cabalFile    = dir </> "Cabal.cabal"-         cabalFileTmp = cabalFile ++ ".tmp"--     cf <- readFile cabalFile-     writeFile cabalFileTmp $ replace "&& < 0.5" "&& < 0.6" cf-     renameFile cabalFileTmp cabalFile--   fixOrphanInstance dir = do-     let versionFile    = dir </> "Distribution/Version.hs"-         versionFileTmp = versionFile ++ ".tmp"--     let languagePragma =-           "{-# LANGUAGE DeriveDataTypeable, StandaloneDeriving #-}"-         languagePragmaCPP =-           "{-# LANGUAGE CPP, DeriveDataTypeable, StandaloneDeriving #-}"--         derivingDataVersion =-           "deriving instance Data Version"-         derivingDataVersionCPP = unlines [-             "#if __GLASGOW_HASKELL__ < 707",-             derivingDataVersion,-             "#endif"-           ]--     vf <- readFile versionFile-     writeFile versionFileTmp-       $ replace derivingDataVersion derivingDataVersionCPP-       $ replace languagePragma languagePragmaCPP vf--     renameFile versionFileTmp versionFile--unpackPatchedCabal ::-    Options -> Version -> FilePath -> (FilePath -> IO ()) -> IO FilePath-unpackPatchedCabal opts cabalVer tmpdir patch = do-  dir <- unpackCabal opts cabalVer tmpdir-  patch dir-  return dir--unpackCabal ::-    Options -> Version -> FilePath -> IO FilePath-unpackCabal opts cabalVer tmpdir = do-  let cabal = "Cabal-" ++ showVersion cabalVer-      dir = tmpdir </> cabal-  callProcessStderr (Just tmpdir) (cabalProgram opts)-                    [ "get", "--pristine", cabal ]-  return dir--unpackCabalHEAD :: FilePath -> IO (FilePath, String)-unpackCabalHEAD tmpdir = do-  let dir = tmpdir </> "cabal-head.git"-      url = "https://github.com/haskell/cabal.git"-  ExitSuccess <- rawSystem "git" [ "clone", "--depth=1", url, dir]-  commit <- trim <$> readProcess "git" ["-C", dir, "rev-parse", "HEAD"] ""-  return (dir </> "Cabal", commit)--errorInstallCabal :: Version -> FilePath -> a-errorInstallCabal cabalVer _distdir = panic $ printf "\-\Installing Cabal version %s failed.\n\-\\n\-\You have the following choices to fix this:\n\-\\n\-\- The easiest way to try and fix this is just reconfigure the project and try\n\-\  again:\n\-\        $ cabal clean && cabal configure\n\-\\n\-\- If that fails you can try to install the version of Cabal mentioned above\n\-\  into your global/user package-db somehow, you'll probably have to fix\n\-\  something otherwise it wouldn't have failed above:\n\-\        $ cabal install Cabal --constraint 'Cabal == %s'\n\-\\n\-\- If you're using `Build-Type: Simple`:\n\-\  - You can see if you can reinstall your cabal-install executable while\n\-\    having it linked to a version of Cabal that's available in you\n\-\    package-dbs or can be built automatically:\n\-\        $ ghc-pkg list | grep Cabal  # find an available Cabal version\n\-\            Cabal-W.X.Y.Z\n\-\        $ cabal install cabal-install --constraint 'Cabal == W.X.*'\n\-\    Afterwards you'll have to reconfigure your project:\n\-\        $ cabal clean && cabal configure\n\-\\n\-\- If you're using `Build-Type: Custom`:\n\-\  - Have cabal-install rebuild your Setup.hs executable with a version of the\n\-\    Cabal library that you have available in your global/user package-db:\n\-\        $ cabal clean && cabal configure\n\-\    You might also have to install some version of the Cabal to do this:\n\-\        $ cabal install Cabal\n\-\\n" sver sver- where-   sver = showVersion cabalVer--cachedExe :: Version -> IO (Maybe FilePath)-cachedExe compCabalVersion = do-   exe <- exePath (Right compCabalVersion)-   exists <- doesFileExist exe-   return $ if exists then Just exe else Nothing--listCabalVersions :: Options -> IO [Version]-listCabalVersions opts = listCabalVersions' opts Nothing---- TODO: Include sandbox? Probably only relevant for build-type:custom projects.-listCabalVersions' :: Options -> Maybe FilePath -> IO [Version]-listCabalVersions' Options {..} mdb = do-  let mdbopt = ("--package-conf="++) <$> mdb-      opts = ["list", "--simple-output", "Cabal"] ++ maybeToList mdbopt--  catMaybes . map (fmap snd . parsePkgId . fromString) . words-          <$> readProcess ghcPkgProgram opts ""--cabalPkgDbExists :: Options -> Version -> IO Bool-cabalPkgDbExists opts ver = do-  db <- getPrivateCabalPkgDb opts (showVersion ver)-  dexists <- doesDirectoryExist db-  case dexists of-    False -> return False-    True -> do-      vers <- listCabalVersions' opts (Just db)-      return $ ver `elem` vers---ghcVersion :: Options -> IO Version-ghcVersion Options {..} = do-    parseVer . trim <$> readProcess ghcProgram ["--numeric-version"] ""--ghcPkgVersion :: Options -> IO Version-ghcPkgVersion Options {..} = do-    parseVer . trim . dropWhile (not . isDigit) <$> readProcess ghcPkgProgram ["--version"] ""--cabalInstallVersion :: Options -> IO Version-cabalInstallVersion Options {..} = do-    parseVer . trim <$> readProcess cabalProgram ["--numeric-version"] ""--trim :: String -> String-trim = dropWhileEnd isSpace--createPkgDb :: Options -> String -> IO FilePath-createPkgDb opts@Options {..} ver = do-  db <- getPrivateCabalPkgDb opts ver-  exists <- doesDirectoryExist db-  when (not exists) $ callProcessStderr Nothing ghcPkgProgram ["init", db]-  return db--getPrivateCabalPkgDb :: Options -> String -> IO FilePath-getPrivateCabalPkgDb opts ver = do-  appdir <- appDataDir-  ghcVer <- ghcVersion opts-  return $ appdir </> "Cabal-" ++ ver ++ "-db-" ++ showVersion ghcVer---- | Find @version: XXX@ delcaration in a cabal file-cabalFileVersion :: String -> Version-cabalFileVersion cabalFile =-  fromJust $ parseVer . extract <$> find ("version:" `isPrefixOf`) ls- where-  ls = map (map toLower) $ lines cabalFile-  extract = dropWhile (/=':') >>> drop 1 >>> dropWhile isSpace >>> takeWhile (not . isSpace)
− CabalHelper/Data.hs 
@@ -1,46 +0,0 @@--- cabal-helper: Simple interface to Cabal's configuration state--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>------ This program is free software: you can redistribute it and/or modify--- it under the terms of the GNU Affero General Public License as published by--- the Free Software Foundation, either version 3 of the License, or--- (at your option) any later version.------ This program is distributed in the hope that it will be useful,--- but WITHOUT ANY WARRANTY; without even the implied warranty of--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the--- GNU Affero General Public License for more details.------ You should have received a copy of the GNU Affero General Public License--- along with this program.  If not, see <http://www.gnu.org/licenses/>.--{-# LANGUAGE TemplateHaskell #-}-{-# OPTIONS_GHC -fforce-recomp #-}-module CabalHelper.Data where--import Control.Monad-import Data.Functor-import qualified Data.ByteString as BS-import qualified Data.ByteString.UTF8 as UTF8-import Language.Haskell.TH-import System.FilePath-import System.Directory-import System.IO.Temp-import Prelude--withHelperSources :: (FilePath -> IO a) -> IO a-withHelperSources action = withSystemTempDirectory "cabal-helper" $ \dir -> do-    let chdir = dir </> "CabalHelper"-    createDirectory chdir-    forM_ sourceFiles $ \(fn, src) ->-        BS.writeFile (chdir </> fn) $ UTF8.fromString src-    action dir--sourceFiles :: [(FilePath, String)]-sourceFiles =-  [ ("Main.hs",   $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "CabalHelper/Main.hs")))-  , ("Common.hs", $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "CabalHelper/Common.hs")))-  , ("Sandbox.hs",  $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "CabalHelper/Sandbox.hs")))-  , ("Licenses.hs",  $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "CabalHelper/Licenses.hs")))-  , ("Types.hs",  $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile "CabalHelper/Types.hs")))-  ]
− CabalHelper/GuessGhc.hs 
@@ -1,86 +0,0 @@-module CabalHelper.GuessGhc (guessToolFromGhcPath) where--import Data.Maybe-import Data.Char-import Distribution.Simple.BuildPaths-import System.Directory-import System.FilePath---- Copyright (c) 2003-2014, Isaac Jones, Simon Marlow, Martin Sjögren,---                          Bjorn Bringert, Krasimir Angelov,---                          Malcolm Wallace, Ross Patterson, Ian Lynagh,---                          Duncan Coutts, Thomas Schilling,---                          Johan Tibell, Mikhail Glushenkov--- All rights reserved.---- Redistribution and use in source and binary forms, with or without--- modification, are permitted provided that the following conditions are--- met:----     * Redistributions of source code must retain the above copyright---       notice, this list of conditions and the following disclaimer.----     * Redistributions in binary form must reproduce the above---       copyright notice, this list of conditions and the following---       disclaimer in the documentation and/or other materials provided---       with the distribution.----     * Neither the name of Isaac Jones nor the names of other---       contributors may be used to endorse or promote products derived---       from this software without specific prior written permission.---- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS--- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT--- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR--- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT--- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,--- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT--- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,--- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY--- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT--- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE--- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.--guessToolFromGhcPath :: FilePath -- ^ Tool name-                     -> FilePath -- ^ GHC exe path-                     -> IO (Maybe FilePath)-guessToolFromGhcPath toolname ghcPath-  = do let-           path              = ghcPath-           dir               = takeDirectory path-           versionSuffix     = takeVersionSuffix (dropExeExtension path)-           guessNormal       = dir </> toolname <.> exeExtension'-           guessGhcVersioned = dir </> (toolname ++ "-ghc" ++ versionSuffix)-                               <.> exeExtension'-           guessVersioned    = dir </> (toolname ++ versionSuffix)-                               <.> exeExtension'-           guesses | null versionSuffix = [guessNormal]-                   | otherwise          = [guessGhcVersioned,-                                           guessVersioned,-                                           guessNormal]-       exists <- mapM doesFileExist guesses-       return $ listToMaybe [ file | (file, True) <- zip guesses exists ]--  where takeVersionSuffix :: FilePath -> String-        takeVersionSuffix = takeWhileEndLE isSuffixChar--        isSuffixChar :: Char -> Bool-        isSuffixChar c = isDigit c || c == '.' || c == '-'--        dropExeExtension :: FilePath -> FilePath-        dropExeExtension filepath =-          case splitExtension filepath of-            (filepath', extension) | extension == exeExtension' -> filepath'-                                   | otherwise                 -> filepath---- | @takeWhileEndLE p@ is equivalent to @reverse . takeWhile p . reverse@, but--- is usually faster (as well as being easier to read).-takeWhileEndLE :: (a -> Bool) -> [a] -> [a]-takeWhileEndLE p = fst . foldr go ([], False)-  where-    go x (rest, done)-      | not done && p x = (x:rest, False)-      | otherwise = (rest, True)--exeExtension' :: FilePath-exeExtension' = Distribution.Simple.BuildPaths.exeExtension
− CabalHelper/Licenses.hs 
@@ -1,119 +0,0 @@-{-# LANGUAGE CPP #-}-module CabalHelper.Licenses (-    displayDependencyLicenseList-  , groupByLicense-  , getDependencyInstalledPackageInfos-  ) where---- Copyright (c) 2014, Jasper Van der Jeugt <m@jaspervdj.be>-----------------------------------------------------------------------------------import Control.Arrow ((***), (&&&))-import Control.Monad (forM_, unless)-import Data.List (foldl', sort)-import Data.Maybe (catMaybes)-import Data.Version (Version)-import Data.Set (Set)-import qualified Data.Set as Set-import System.Directory (getDirectoryContents)-import System.Exit (exitFailure)-import System.FilePath (takeExtension)-import System.IO (hPutStrLn, stderr)--import Distribution.InstalledPackageInfo-import Distribution.License-import Distribution.Package-import Distribution.Simple.Configure-import Distribution.Simple.LocalBuildInfo-import Distribution.Simple.PackageIndex-import Distribution.Text-import Distribution.ModuleName-------------------------------------------------------------------------------------#if CABAL_MAJOR == 1 && CABAL_MINOR > 22-type CPackageIndex a = PackageIndex (InstalledPackageInfo)-#elif CABAL_MAJOR == 1 && CABAL_MINOR >= 22-type CPackageIndex a = PackageIndex (InstalledPackageInfo_ a)-#else-type CPackageIndex a = PackageIndex-#endif--#if CABAL_MAJOR == 1 && CABAL_MINOR >= 23-type CInstalledPackageId = UnitId-lookupInstalledPackageId' :: PackageIndex a -> UnitId -> Maybe a-lookupInstalledPackageId' = lookupUnitId-#elif CABAL_MAJOR == 1 && CABAL_MINOR > 22-type CInstalledPackageId = ComponentId-lookupInstalledPackageId' = lookupComponentId-#else-type CInstalledPackageId = InstalledPackageId-lookupInstalledPackageId' = lookupInstalledPackageId-#endif--findTransitiveDependencies-    :: CPackageIndex Distribution.ModuleName.ModuleName-    -> Set CInstalledPackageId-    -> Set CInstalledPackageId-findTransitiveDependencies pkgIdx set0 = go Set.empty (Set.toList set0)-  where-    go set []  = set-    go set (q : queue)-        | q `Set.member` set = go set queue-        | otherwise          =-            case lookupInstalledPackageId' pkgIdx q of-                Nothing  ->-                    -- Not found can mean that the package still needs to be-                    -- installed (e.g. a component of the target cabal package).-                    -- We can ignore those.-                    go set queue-                Just ipi ->-                    go (Set.insert q set) (Distribution.InstalledPackageInfo.depends ipi ++ queue)------------------------------------------------------------------------------------getDependencyInstalledPackageIds-    :: LocalBuildInfo -> Set CInstalledPackageId-getDependencyInstalledPackageIds lbi =-    findTransitiveDependencies (installedPkgs lbi) $-      Set.fromList $ map fst $ externalPackageDeps lbi-----------------------------------------------------------------------------------getDependencyInstalledPackageInfos-    :: LocalBuildInfo -> [InstalledPackageInfo]-getDependencyInstalledPackageInfos lbi = catMaybes $-    map (lookupInstalledPackageId' pkgIdx) $-    Set.toList (getDependencyInstalledPackageIds lbi)-  where-    pkgIdx = installedPkgs lbi------------------------------------------------------------------------------------groupByLicense-    :: [InstalledPackageInfo]-    -> [(License, [InstalledPackageInfo])]-groupByLicense = foldl'-    (\assoc ipi -> insertAList (license ipi) ipi assoc) []-  where-    -- 'Cabal.License' doesn't have an 'Ord' instance so we need to use an-    -- association list instead of 'Map'. The number of licenses probably won't-    -- exceed 100 so I think we're alright.-    insertAList :: Eq k => k -> v -> [(k, [v])] -> [(k, [v])]-    insertAList k v []   = [(k, [v])]-    insertAList k v ((k', vs) : kvs)-        | k == k'   = (k, v : vs) : kvs-        | otherwise = (k', vs) : insertAList k v kvs------------------------------------------------------------------------------------displayDependencyLicenseList-    :: [(License, [InstalledPackageInfo])]-    -> [(String, [(String, Version)])]-displayDependencyLicenseList =-    map (display *** map (getName &&& getVersion))-  where-    getName =-        display . pkgName . sourcePackageId-    getVersion =-        pkgVersion . sourcePackageId
− CabalHelper/Log.hs 
@@ -1,21 +0,0 @@-module CabalHelper.Log where--import Control.Monad-import Control.Monad.IO.Class-import Control.Exception as E-import Data.String-import System.IO-import Prelude--import CabalHelper.Types--vLog :: MonadIO m => Options -> String -> m ()-vLog Options { verbose = True } msg =-    liftIO $ hPutStrLn stderr msg-vLog _ _ = return ()--logSomeError :: Options -> String -> IO (Maybe a) -> IO (Maybe a)-logSomeError opts label a = do-  a `E.catch` \se@(SomeException _) -> do-      vLog opts $ label ++ ": " ++ show se-      return Nothing
− CabalHelper/Main.hs 
@@ -1,483 +0,0 @@--- cabal-helper: Simple interface to Cabal's configuration state--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>------ This program is free software: you can redistribute it and/or modify--- it under the terms of the GNU Affero General Public License as published by--- the Free Software Foundation, either version 3 of the License, or--- (at your option) any later version.------ This program is distributed in the hope that it will be useful,--- but WITHOUT ANY WARRANTY; without even the implied warranty of--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the--- GNU Affero General Public License for more details.------ You should have received a copy of the GNU Affero General Public License--- along with this program.  If not, see <http://www.gnu.org/licenses/>.--{-# LANGUAGE CPP, BangPatterns, RecordWildCards, RankNTypes #-}-{-# OPTIONS_GHC -fno-warn-deprecations #-}-import Distribution.Simple.Utils (cabalVersion)-import Distribution.Simple.Configure--import Distribution.Package (PackageIdentifier, InstalledPackageId, PackageId,-                             packageName, packageVersion)-import Distribution.PackageDescription (PackageDescription,-                                        GenericPackageDescription(..),-                                        Flag(..),-                                        FlagName(..),-                                        FlagAssignment,-                                        Executable(..),-                                        Library(..),-                                        TestSuite(..),-                                        Benchmark(..),-                                        BuildInfo(..),-                                        TestSuiteInterface(..),-                                        BenchmarkInterface(..),-                                        withLib)-import Distribution.PackageDescription.Parse (readPackageDescription)-import Distribution.PackageDescription.Configuration (flattenPackageDescription)--import Distribution.Simple.Program (requireProgram, ghcProgram)-import Distribution.Simple.Program.Types (ConfiguredProgram(..))-import Distribution.Simple.Configure (getPersistBuildConfig)-import Distribution.Simple.LocalBuildInfo (LocalBuildInfo(..),-                                           Component(..),-                                           ComponentName(..),-                                           ComponentLocalBuildInfo(..),-                                           componentBuildInfo,-                                           externalPackageDeps,-                                           withComponentsLBI,-                                           withLibLBI)-#if CABAL_MAJOR == 1 && CABAL_MINOR >= 23-import Distribution.Simple.LocalBuildInfo (localUnitId)-#elif CABAL_MAJOR == 1 && CABAL_MINOR <= 22-import Distribution.Simple.LocalBuildInfo (inplacePackageId)-#endif--import Distribution.Simple.GHC (componentGhcOptions)-import Distribution.Simple.Program.GHC (GhcOptions(..), renderGhcOptions)--import Distribution.Simple.Setup (ConfigFlags(..),Flag(..))-import Distribution.Simple.Build (initialBuildSteps)-import Distribution.Simple.BuildPaths (autogenModuleName, cppHeaderName, exeExtension)-import Distribution.Simple.Compiler (PackageDB(..), compilerId)--import Distribution.Compiler (CompilerId(..))-import Distribution.ModuleName (components)-import qualified Distribution.ModuleName as C (ModuleName)-import Distribution.Text (display)-import Distribution.Verbosity (Verbosity, silent, deafening, normal)--#if CABAL_MAJOR == 1 && CABAL_MINOR >= 22-import Distribution.Utils.NubList-#endif--import Control.Applicative ((<$>))-import Control.Arrow (first, (&&&))-import Control.Monad-import Control.Exception (catch, PatternMatchFail(..))-import Data.List-import qualified Data.Map as Map-import Data.Maybe-import Data.Monoid-import Data.IORef-import System.Environment-import System.Directory-import System.FilePath-import System.Exit-import System.IO-import System.IO.Unsafe (unsafeInterleaveIO, unsafePerformIO)-import Text.Printf--import CabalHelper.Licenses-import CabalHelper.Sandbox-import CabalHelper.Common-import CabalHelper.Types hiding (Options(..))--usage = do-  prog <- getProgName-  hPutStr stderr $ "Usage: " ++ prog ++ " " ++ usageMsg- where-   usageMsg = ""-     ++"PROJ_DIR DIST_DIR [--with-* ...] (\n"-     ++"    version\n"-     ++"  | print-lbi [--human]\n"-     ++"  | package-id\n"-     ++"  | flags\n"-     ++"  | config-flags\n"-     ++"  | non-default-config-flags\n"-     ++"  | write-autogen-files\n"-     ++"  | compiler-version\n"-     ++"  | ghc-options     [--with-inplace]\n"-     ++"  | ghc-src-options [--with-inplace]\n"-     ++"  | ghc-pkg-options [--with-inplace]\n"-     ++"  | ghc-merged-pkg-options [--with-inplace]\n"-     ++"  | ghc-lang-options [--with-inplace]\n"-     ++"  | package-db-stack\n"-     ++"  | entrypoints\n"-     ++"  | source-dirs\n"-     ++"  | licenses\n"-     ++"  ) ...\n"--commands :: [String]-commands = [ "print-lbi"-           , "package-id"-           , "flags"-           , "config-flags"-           , "non-default-config-flags"-           , "write-autogen-files"-           , "compiler-version"-           , "ghc-options"-           , "ghc-src-options"-           , "ghc-pkg-options"-           , "ghc-lang-options"-           , "package-db-stack"-           , "entrypoints"-           , "source-dirs"-           , "licenses"]--main :: IO ()-main = do-  args <- getArgs--  projdir:distdir:args' <- case args of-                    [] -> usage >> exitFailure-                    _ -> return args--  ddexists <- doesDirectoryExist distdir-  when (not ddexists) $ do-         errMsg $ "distdir '"++distdir++"' does not exist"-         exitFailure--  [cfile] <- filter isCabalFile <$> getDirectoryContents projdir--  v <- maybe silent (const deafening) . lookup  "GHC_MOD_DEBUG" <$> getEnvironment-  lbi <- unsafeInterleaveIO $ getPersistBuildConfig distdir-  gpd <- unsafeInterleaveIO $ readPackageDescription v (projdir </> cfile)-  let pd = localPkgDescr lbi-  let lvd = (lbi, v, distdir)--  let-      -- a =<< b $$ c   ==  (a =<< b) $$ c-      infixr 2 $$-      ($$) = ($)--      collectCmdOptions :: [String] -> [[String]]-      collectCmdOptions =-          reverse . map reverse . foldl f [] . dropWhile isOpt-       where-         isOpt = ("--" `isPrefixOf`)-         f [] x = [[x]]-         f (a:as) x-             | isOpt x = (x:a):as-             | otherwise = [x]:(a:as)--  let cmds = collectCmdOptions args'--  if any (["version"] `isPrefixOf`) cmds-    then do-      putStrLn $-       printf "using version %s of the Cabal library" (display cabalVersion)-      exitSuccess-    else return ()--  print =<< flip mapM cmds $$ \cmd -> do-  case cmd of-    "flags":[] -> do-      return $ Just $ ChResponseFlags $ sort $-        map (flagName' &&& flagDefault) $ genPackageFlags gpd--    "config-flags":[] -> do-      return $ Just $ ChResponseFlags $ sort $-        map (first unFlagName') $ configConfigurationsFlags $ configFlags lbi--    "non-default-config-flags":[] -> do-      let flagDefinitons = genPackageFlags gpd-          flagAssgnments = configConfigurationsFlags $ configFlags lbi-          nonDefaultFlags =-              [ (fn, v)-              | MkFlag {flagName=FlagName fn, flagDefault=dv} <- flagDefinitons-              , (FlagName fn', v) <- flagAssgnments-              , fn == fn'-              , v /= dv-              ]-      return $ Just $ ChResponseFlags $ sort nonDefaultFlags--    "write-autogen-files":[] -> do-      initialBuildStepsForAllComponents distdir pd lbi v-      return Nothing--    "compiler-version":[] -> do-      let CompilerId comp ver = compilerId $ compiler lbi-      return $ Just $ ChResponseVersion (show comp) ver--    "ghc-options":flags -> do-      res <- componentOptions lvd True flags id-      return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])])--    "ghc-src-options":flags -> do-      res <- componentOptions lvd False flags $ \opts -> mempty {-               -- Not really needed but "unexpected package db stack: []"-               ghcOptPackageDBs      = [GlobalPackageDB, UserPackageDB],--               ghcOptCppOptions      = ghcOptCppOptions opts,-               ghcOptCppIncludePath  = ghcOptCppIncludePath opts,-               ghcOptCppIncludes     = ghcOptCppIncludes opts,-               ghcOptFfiIncludes     = ghcOptFfiIncludes opts,-               ghcOptSourcePathClear = ghcOptSourcePathClear opts,-               ghcOptSourcePath      = ghcOptSourcePath opts-              }-      return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])])--    "ghc-pkg-options":flags -> do-      res <- componentOptions lvd True flags $ \opts -> mempty {-                       ghcOptPackageDBs = ghcOptPackageDBs opts,-                       ghcOptPackages   = ghcOptPackages opts,-                       ghcOptHideAllPackages = ghcOptHideAllPackages opts-                   }-      return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])])--    "ghc-merged-pkg-options":flags -> do-      let pd = localPkgDescr lbi-      res <- mconcat . map snd <$> (componentOptions' lvd True flags (\_ _ o -> return o) $ \opts -> mempty {-                       ghcOptPackageDBs = [],-                       ghcOptHideAllPackages = NoFlag,-                       ghcOptPackages   = ghcOptPackages opts-                   })--      let res' = nubPackageFlags $ res { ghcOptPackageDBs = withPackageDB lbi-                                       , ghcOptHideAllPackages = Flag True-                                       }--      Just . ChResponseList <$> renderGhcOptions' lbi v res'--    "ghc-lang-options":flags -> do-      res <- componentOptions lvd False flags $ \opts -> mempty {-                       ghcOptPackageDBs      = [GlobalPackageDB, UserPackageDB],--                       ghcOptLanguage = ghcOptLanguage opts,-                       ghcOptExtensions = ghcOptExtensions opts,-                       ghcOptExtensionMap = ghcOptExtensionMap opts-                   }-      return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])])--    "package-db-stack":[] -> do-      let-          pkgDb GlobalPackageDB = ChPkgGlobal-          pkgDb UserPackageDB   = ChPkgUser-          pkgDb (SpecificPackageDB s) = ChPkgSpecific s--      -- TODO: Setup.hs has access to the sandbox as well: ghc-mod#478-      return $ Just $ ChResponsePkgDbs $ map pkgDb $ withPackageDB lbi--    "entrypoints":[] -> do-      eps <- componentsMap lbi v distdir $ \c clbi bi ->-               return $ componentEntrypoints c-      -- MUST append Setup component at the end otherwise CabalHelper gets-      -- confused-      let eps' = eps ++ [(ChSetupHsName, ChSetupEntrypoint)]-      return $ Just $ ChResponseEntrypoints eps'--    "source-dirs":[] -> do-      res <- componentsMap lbi v distdir $$ \_ _ bi -> return $ hsSourceDirs bi-      return $ Just $ ChResponseCompList (res ++ [(ChSetupHsName, [])])--    "licenses":[] -> do-      return $ Just $ ChResponseLicenses $-        displayDependencyLicenseList $ groupByLicense $ getDependencyInstalledPackageInfos lbi--    "print-lbi":flags ->-      case flags of-        ["--human"] -> print lbi >> return Nothing-        [] -> return $ Just $ ChResponseLbi $ show lbi--    cmd:_ | not (cmd `elem` commands) ->-            errMsg ("Unknown command: " ++ cmd) >> usage >> exitFailure-    _ ->-            errMsg "Invalid usage!" >> usage >> exitFailure--flagName' = unFlagName' . flagName-unFlagName' (FlagName n) = n--getLibrary :: PackageDescription -> Library-getLibrary pd = unsafePerformIO $ do-  lr <- newIORef (error "libraryMap: empty IORef")-  withLib pd (writeIORef lr)-  readIORef lr--getLibraryClbi pd lbi = unsafePerformIO $ do-  lr <- newIORef Nothing--  withLibLBI pd lbi $ \ lib clbi ->-      writeIORef lr $ Just (lib,clbi)--  readIORef lr---componentsMap :: LocalBuildInfo-              -> Verbosity-              -> FilePath-              -> (   Component-                  -> ComponentLocalBuildInfo-                  -> BuildInfo-                  -> IO a)-              -> IO [(ChComponentName, a)]-componentsMap lbi v distdir f = do-    let pd = localPkgDescr lbi--    lr <- newIORef []--    -- withComponentsLBI is deprecated but also exists in very old versions-    -- it's equivalent to withAllComponentsInBuildOrder in newer versions-    withComponentsLBI pd lbi $ \c clbi -> do-        let bi = componentBuildInfo c-            name = componentNameFromComponent c--        l' <- readIORef lr-        r <- f c clbi bi-        writeIORef lr $ (componentNameToCh name, r):l'--    reverse <$> readIORef lr--componentOptions' (lbi, v, distdir) inplaceFlag flags rf f = do-  let pd = localPkgDescr lbi-  componentsMap lbi v distdir $ \c clbi bi -> let-           outdir = componentOutDir lbi c-           (clbi', adopts) = case flags of-                               _ | not inplaceFlag -> (clbi, mempty)-                               ["--with-inplace"] -> (clbi, mempty)-                               [] -> removeInplaceDeps v lbi pd clbi-           opts = componentGhcOptions normal lbi bi clbi' outdir-           opts' = f opts--         in rf lbi v $ nubPackageFlags $ opts' `mappend` adopts--componentOptions (lbi, v, distdir) inplaceFlag flags f =-    componentOptions' (lbi, v, distdir) inplaceFlag flags renderGhcOptions' f--#if CABAL_MAJOR == 1 && CABAL_MINOR < 25-componentNameToCh CLibName = ChLibName ""-#elif CABAL_MAJOR == 1 && CABAL_MINOR >= 25-componentNameToCh (CLibName n) = ChLibName n-#endif-componentNameToCh (CExeName n) = ChExeName n-componentNameToCh (CTestName n) = ChTestName n-componentNameToCh (CBenchName n) = ChBenchName n--#if CABAL_MAJOR == 1 && CABAL_MINOR < 25-componentNameFromComponent (CLib Library {}) = CLibName-#elif CABAL_MAJOR == 1 && CABAL_MINOR >= 25-componentNameFromComponent (CLib Library {..}) = CLibName libName-#endif-componentNameFromComponent (CExe Executable {..}) = CExeName exeName-componentNameFromComponent (CTest TestSuite {..}) = CTestName testName-componentNameFromComponent (CBench Benchmark {..}) = CBenchName benchmarkName--componentOutDir lbi (CLib Library {..})= buildDir lbi-componentOutDir lbi (CExe Executable {..})= exeOutDir lbi exeName-componentOutDir lbi (CTest TestSuite { testInterface = TestSuiteExeV10 _ _, ..}) =-    exeOutDir lbi testName-componentOutDir lbi (CTest TestSuite { testInterface = TestSuiteLibV09 _ _, ..}) =-    exeOutDir lbi (testName ++ "Stub")-componentOutDir lbi (CBench Benchmark { benchmarkInterface = BenchmarkExeV10 _ _, ..})=-    exeOutDir lbi benchmarkName--gmModuleName :: C.ModuleName -> ChModuleName-gmModuleName = ChModuleName . intercalate "." . components--componentEntrypoints :: Component -> ChEntrypoint-componentEntrypoints (CLib Library {..})-    = ChLibEntrypoint-        (map gmModuleName exposedModules)-        (map gmModuleName $ otherModules libBuildInfo)-componentEntrypoints (CExe Executable {..})-    = ChExeEntrypoint modulePath (map gmModuleName $ otherModules buildInfo)-componentEntrypoints (CTest TestSuite { testInterface = TestSuiteExeV10 _ fp, ..})-    = ChExeEntrypoint fp (map gmModuleName $ otherModules testBuildInfo)-componentEntrypoints (CTest TestSuite { testInterface = TestSuiteLibV09 _ mn, ..})-    = ChLibEntrypoint [gmModuleName mn] (map gmModuleName $ otherModules testBuildInfo)-componentEntrypoints (CTest TestSuite {})-    = ChLibEntrypoint [] []-componentEntrypoints (CBench Benchmark { benchmarkInterface = BenchmarkExeV10 _  fp, ..})-    = ChExeEntrypoint fp (map gmModuleName $ otherModules benchmarkBuildInfo)-componentEntrypoints (CBench Benchmark {})-    = ChLibEntrypoint [] []--exeOutDir :: LocalBuildInfo -> String -> FilePath-exeOutDir lbi exeName' =-  ----- Copied from Distribution/Simple/GHC.hs:buildOrReplExe-  let targetDir = (buildDir lbi) </> exeName'-      exeDir    = targetDir </> (exeName' ++ "-tmp")-  in exeDir---removeInplaceDeps :: Verbosity-                  -> LocalBuildInfo-                  -> PackageDescription-                  -> ComponentLocalBuildInfo-                  -> (ComponentLocalBuildInfo, GhcOptions)-removeInplaceDeps v lbi pd clbi = let-    (ideps, deps) = partition isInplaceDep (componentPackageDeps clbi)-    hasIdeps = not $ null ideps-    libopts =-      case getLibraryClbi pd lbi of-        Just (lib, libclbi) | hasIdeps ->-          let-            libbi = libBuildInfo lib-            liboutdir = componentOutDir lbi (CLib lib)-          in-            (componentGhcOptions normal lbi libbi libclbi liboutdir) {-                ghcOptPackageDBs = []-#if CABAL_MAJOR == 1 && CABAL_MINOR > 22 && CABAL_MINOR < 23-              , ghcOptComponentId = NoFlag-#endif--            }-        _ -> mempty-    clbi' = clbi { componentPackageDeps = deps }--  in (clbi', libopts)-- where-   isInplaceDep :: (InstalledPackageId, PackageId) -> Bool-#if CABAL_MAJOR == 1 && CABAL_MINOR >= 23-   isInplaceDep (ipid, pid) = localUnitId lbi == ipid-#elif CABAL_MAJOR == 1 && CABAL_MINOR <= 22-   isInplaceDep (ipid, pid) = inplacePackageId pid == ipid--#endif---#if CABAL_MAJOR == 1 && CABAL_MINOR >= 22--- >= 1.22 uses NubListR-nubPackageFlags opts = opts-#else-nubPackageFlags opts = opts { ghcOptPackages = nub $ ghcOptPackages opts }-#endif--renderGhcOptions' :: LocalBuildInfo-                  -> Verbosity-                  -> GhcOptions-                  -> IO [String]-renderGhcOptions' lbi v opts = do-#if CABAL_MAJOR == 1 && CABAL_MINOR < 20-  (ghcProg, _) <- requireProgram v ghcProgram (withPrograms lbi)-  let Just ghcVer = programVersion ghcProg-  return $ renderGhcOptions ghcVer opts-#elif CABAL_MAJOR == 1 && CABAL_MINOR >= 20 && CABAL_MINOR < 24--- && CABAL_MINOR < 24-  return $ renderGhcOptions (compiler lbi) opts-#elif CABAL_MAJOR == 1 && CABAL_MINOR >= 24---  CABAL_MAJOR == 1 && CABAL_MINOR >= 24-  return $ renderGhcOptions (compiler lbi) (hostPlatform lbi) opts-#endif---#if CABAL_MAJOR == 1 && CABAL_MINOR < 25-initialBuildStepsForAllComponents distdir pd lbi v =-  initialBuildSteps distdir pd lbi v-#elif CABAL_MAJOR == 1 && CABAL_MINOR >= 25-initialBuildStepsForAllComponents distdir pd lbi v =-  withComponentsLBI pd lbi $ \_c clbi ->-    initialBuildSteps distdir pd lbi clbi v-#endif
− CabalHelper/Sandbox.hs 
@@ -1,56 +0,0 @@-module CabalHelper.Sandbox where--import Control.Applicative-import Data.Char-import Data.Maybe-import Data.List-import Data.Version-import System.FilePath-import System.Directory-import Prelude--import qualified Data.Traversable as T---- | Get the path to the sandbox package-db in a project-getSandboxPkgDb :: FilePath-             -- ^ Path to the cabal package root directory (containing the-             -- @cabal.sandbox.config@ file)-             -> String-             -- ^ Cabal build platform, i.e. @buildPlatform@-             -> Version-             -- ^ GHC version (@cProjectVersion@ is your friend)-             -> IO (Maybe FilePath)-getSandboxPkgDb d platform ghcVer = do-  mConf <- T.traverse readFile =<< mightExist (d </> "cabal.sandbox.config")-  return $ fixPkgDbVer <$> (extractSandboxDbDir =<< mConf)-- where-   fixPkgDbVer dir =-       case takeFileName dir == ghcSandboxPkgDbDir platform ghcVer of-         True -> dir-         False -> takeDirectory dir </> ghcSandboxPkgDbDir platform ghcVer--ghcSandboxPkgDbDir :: String -> Version -> String-ghcSandboxPkgDbDir platform ghcVer =-   platform ++ "-ghc-" ++ showVersion ghcVer ++ "-packages.conf.d"---- | Extract the sandbox package db directory from the cabal.sandbox.config--- file. Exception is thrown if the sandbox config file is broken.-extractSandboxDbDir :: String -> Maybe FilePath-extractSandboxDbDir conf = extractValue <$> parse conf-  where-    key = "package-db:"-    keyLen = length key--    parse = listToMaybe . filter (key `isPrefixOf`) . lines-    extractValue = CabalHelper.Sandbox.dropWhileEnd isSpace . dropWhile isSpace . drop keyLen---mightExist :: FilePath -> IO (Maybe FilePath)-mightExist f = do-  exists <- doesFileExist f-  return $ if exists then (Just f) else (Nothing)---- dropWhileEnd is not provided prior to base 4.5.0.0.-dropWhileEnd :: (a -> Bool) -> [a] -> [a]-dropWhileEnd p = foldr (\x xs -> if p x && null xs then [] else x : xs) []
− CabalHelper/Types.hs 
@@ -1,71 +0,0 @@--- cabal-helper: Simple interface to Cabal's configuration state--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>------ This program is free software: you can redistribute it and/or modify--- it under the terms of the GNU Affero General Public License as published by--- the Free Software Foundation, either version 3 of the License, or--- (at your option) any later version.------ This program is distributed in the hope that it will be useful,--- but WITHOUT ANY WARRANTY; without even the implied warranty of--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the--- GNU Affero General Public License for more details.------ You should have received a copy of the GNU Affero General Public License--- along with this program.  If not, see <http://www.gnu.org/licenses/>.--{-# LANGUAGE DeriveGeneric, DeriveDataTypeable, DefaultSignatures #-}-module CabalHelper.Types where--import GHC.Generics-import Data.Version--newtype ChModuleName = ChModuleName String-    deriving (Eq, Ord, Read, Show, Generic)--data ChComponentName = ChSetupHsName-                     | ChLibName String-                     | ChExeName String-                     | ChTestName String-                     | ChBenchName String-  deriving (Eq, Ord, Read, Show, Generic)--data ChResponse-    = ChResponseCompList    [(ChComponentName, [String])]-    | ChResponseEntrypoints [(ChComponentName, ChEntrypoint)]-    | ChResponseList        [String]-    | ChResponsePkgDbs      [ChPkgDb]-    | ChResponseLbi         String-    | ChResponseVersion     String Version-    | ChResponseLicenses    [(String, [(String, Version)])]-    | ChResponseFlags       [(String, Bool)]-  deriving (Eq, Ord, Read, Show, Generic)--data ChEntrypoint = ChSetupEntrypoint -- ^ Almost like 'ChExeEntrypoint' but-                                      -- @main-is@ could either be @"Setup.hs"@-                                      -- or @"Setup.lhs"@. Since we don't know-                                      -- where the source directory is you have-                                      -- to find these files.-                  | ChLibEntrypoint { chExposedModules :: [ChModuleName]-                                    , chOtherModules   :: [ChModuleName]-                                    }-                  | ChExeEntrypoint { chMainIs         :: FilePath-                                    , chOtherModules   :: [ChModuleName]-                                    } deriving (Eq, Ord, Read, Show, Generic)--data ChPkgDb = ChPkgGlobal-             | ChPkgUser-             | ChPkgSpecific FilePath-               deriving (Eq, Ord, Read, Show, Generic)--data Options = Options {-          verbose       :: Bool-        , ghcProgram    :: FilePath-        , ghcPkgProgram :: FilePath-        , cabalProgram  :: FilePath-        , cabalVersion  :: Maybe Version-        , cabalPkgDb    :: Maybe FilePath-}--defaultOptions :: Options-defaultOptions = Options False "ghc" "ghc-pkg" "cabal" Nothing Nothing
− CabalHelper/Wrapper.hs 
@@ -1,154 +0,0 @@--- cabal-helper: Simple interface to Cabal's configuration state--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>------ This program is free software: you can redistribute it and/or modify--- it under the terms of the GNU Affero General Public License as published by--- the Free Software Foundation, either version 3 of the License, or--- (at your option) any later version.------ This program is distributed in the hope that it will be useful,--- but WITHOUT ANY WARRANTY; without even the implied warranty of--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the--- GNU Affero General Public License for more details.------ You should have received a copy of the GNU Affero General Public License--- along with this program.  If not, see <http://www.gnu.org/licenses/>.-{-# LANGUAGE RecordWildCards, FlexibleContexts #-}-module Main where--import Control.Applicative-import Control.Monad-import Data.Char-import Data.List-import Data.Maybe-import Data.String-import Data.Version-import Text.Printf-import System.Console.GetOpt-import System.Environment-import System.Directory-import System.FilePath-import System.Process-import System.Exit-import System.IO-import Prelude--import Distribution.System (buildPlatform)-import Distribution.Text (display)-import Distribution.Verbosity (silent, deafening)-import Distribution.PackageDescription.Parse (readPackageDescription)-import Distribution.Package (packageName, packageVersion)--import Paths_cabal_helper (version)-import CabalHelper.Common-import CabalHelper.GuessGhc-import CabalHelper.Compile-import CabalHelper.Types--usage :: IO ()-usage = do-  prog <- getProgName-  hPutStr stderr $ "Usage: " ++ prog ++ " " ++ usageMsg- where-   usageMsg = "\-\( print-appdatadir\n\-\| print-build-platform\n\-\| [--verbose]\n\-\  [--with-ghc=GHC_PATH]\n\-\  [--with-ghc-pkg=GHC_PKG_PATH]\n\-\  [--with-cabal=CABAL_PATH]\n\-\  [--with-cabal-version=VERSION]\n\-\  [--with-cabal-pkg-db=PKG_DB]\n\-\  PROJ_DIR DIST_DIR ( print-exe | package-id | [CABAL_HELPER_ARGS...] ) )\n"--globalArgSpec :: [OptDescr (Options -> Options)]-globalArgSpec =-      [ option "" ["verbose"] "Be more verbose" $-              NoArg $ \o -> o { verbose = True }--      , option "" ["with-ghc"] "GHC executable to use" $-              reqArg "PROG" $ \p o -> o { ghcProgram = p }--      , option "" ["with-ghc-pkg"] "ghc-pkg executable to use (only needed when guessing from GHC path fails)" $-              reqArg "PROG" $ \p o -> o { ghcPkgProgram = p }--      , option "" ["with-cabal"] "cabal-install executable to use" $-               reqArg "PROG" $ \p o -> o { cabalProgram = p }--      , option "" ["with-cabal-version"] "Cabal library version to use" $-               reqArg "VERSION" $ \p o -> o { cabalVersion = Just $ parseVer p }--      , option "" ["with-cabal-pkg-db"] "package database to look for Cabal library in" $-               reqArg "PKG_DB" $ \p o -> o { cabalPkgDb = Just p }--      ]- where-   option :: [Char] -> [String] -> String -> ArgDescr a -> OptDescr a-   option s l udsc dsc = Option s l dsc udsc--   reqArg :: String -> (String -> a) -> ArgDescr a-   reqArg udsc dsc = ReqArg dsc udsc--parseCommandArgs :: Options -> [String] -> (Options, [String])-parseCommandArgs opts argv-    = case getOpt RequireOrder globalArgSpec argv of-        (o,r,[])   -> (foldr id opts o, r)-        (_,_,errs) ->-            panic $ "Parsing command options failed:\n" ++ concat errs--guessProgramPaths :: Options -> IO Options-guessProgramPaths opts = do-    if not (same ghcProgram opts dopts) && same ghcPkgProgram opts dopts-       then do-         mghcPkg <- guessToolFromGhcPath "ghc-pkg" (ghcProgram opts)-         return opts {-           ghcPkgProgram = fromMaybe (ghcPkgProgram opts) mghcPkg-         }-       else return opts- where-   same f o o'  = f o == f o'-   dopts = defaultOptions--main :: IO ()-main = handlePanic $ do-  (opts', args) <- parseCommandArgs defaultOptions <$> getArgs-  opts <- guessProgramPaths opts'-  case args of-    [] -> usage-    "help":[] -> usage-    "version":[] -> putStrLn $ showVersion version-    "print-appdatadir":[] -> putStrLn =<< appDataDir-    "print-build-platform":[] -> putStrLn $ display buildPlatform--    projdir:_distdir:"package-id":[] -> do-      v <- maybe silent (const deafening) . lookup  "GHC_MOD_DEBUG" <$> getEnvironment-      -- ghc-mod will catch multiple cabal files existing before we get here-      [cfile] <- filter isCabalFile <$> getDirectoryContents projdir-      gpd <- readPackageDescription v (projdir </> cfile)-      putStrLn $ show $-        [Just $ ChResponseVersion (display (packageName gpd)) (packageVersion gpd)]--    projdir:distdir:args' -> do-      cfgf <- canonicalizePath (distdir </> "setup-config")-      mhdr <- getCabalConfigHeader cfgf-      case mhdr of-        Nothing -> panic $ printf "\-\Could not read Cabal's persistent setup configuration header\n\-\- Check first line of: %s\n\-\- Maybe try: $ cabal configure" cfgf-        Just (hdrCabalVersion, _) -> do-          case cabalVersion opts of-            Just ver | hdrCabalVersion /= ver -> panic $ printf "\-\Cabal version %s was requested setup configuration was\n\-\written by version %s" (showVersion ver) (showVersion hdrCabalVersion)-            _ -> do-              eexe <- compileHelper opts hdrCabalVersion projdir distdir-              case eexe of-                  Left e -> exitWith e-                  Right exe ->-                    case args' of-                      "print-exe":_ -> putStrLn exe-                      _ -> do-                        (_,_,_,h) <- createProcess $ proc exe args-                        exitWith =<< waitForProcess h-    _ -> error "invalid command line"
− Distribution/Helper.hs 
@@ -1,480 +0,0 @@--- ghc-mod: Making Haskell development *more* fun--- Copyright (C) 2015  Daniel Gröber <dxld ÄT darkboxed DOT org>------ This program is free software: you can redistribute it and/or modify--- it under the terms of the GNU Affero General Public License as published by--- the Free Software Foundation, either version 3 of the License, or--- (at your option) any later version.------ This program is distributed in the hope that it will be useful,--- but WITHOUT ANY WARRANTY; without even the implied warranty of--- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the--- GNU Affero General Public License for more details.------ You should have received a copy of the GNU Affero General Public License--- along with this program.  If not, see <http://www.gnu.org/licenses/>.--{-# LANGUAGE CPP, RecordWildCards, FlexibleContexts, ConstraintKinds #-}-{-# LANGUAGE GeneralizedNewtypeDeriving, DeriveDataTypeable, DeriveGeneric #-}--module Distribution.Helper (-    Programs(..)-  , defaultPrograms-  , QueryEnv-  , qeReadProcess-  , qePrograms-  , qeProjectDir-  , qeDistDir-  , qeCabalPkgDb-  , qeCabalVer-  , defaultQueryEnv--  -- * Running Queries-  , Query-  , runQuery--  -- * Queries against Cabal\'s on disk state--  , packageDbStack-  , entrypoints-  , sourceDirs-  , ghcOptions-  , ghcSrcOptions-  , ghcPkgOptions-  , ghcMergedPkgOptions-  , ghcLangOptions-  , pkgLicenses-  , flags-  , configFlags-  , nonDefaultConfigFlags-  , packageId-  , compilerVersion--  -- * Result types-  , ChModuleName(..)-  , ChComponentName(..)-  , ChPkgDb(..)-  , ChEntrypoint(..)--  -- * General information-  , buildPlatform--  -- * Stuff that cabal-install really should export-  , Distribution.Helper.getSandboxPkgDb--  -- * Managing @dist/@-  , prepare-  , prepare'-  , reconfigure-  , writeAutogenFiles-  , writeAutogenFiles'--  -- * $libexec related error handling-  , LibexecNotFoundError(..)-  , libexecNotFoundError-  ) where--import Control.Applicative-import Control.Monad-import Control.Monad.IO.Class-import Control.Monad.State.Strict-import Control.Monad.Reader-import Control.Exception as E-import Data.Char-import Data.List-import Data.Maybe-import Data.Version-import Data.Typeable-import Distribution.Simple.BuildPaths (exeExtension)-import System.Environment-import System.FilePath-import System.Directory-import System.Process-import System.IO.Unsafe-import Text.Printf-import GHC.Generics-import Prelude--import Paths_cabal_helper (getLibexecDir, version)-import CabalHelper.Types hiding (Options(..))-import CabalHelper.Sandbox---- | Paths or names of various programs we need.-data Programs = Programs {-      cabalProgram  :: FilePath,-      ghcProgram    :: FilePath,-      ghcPkgProgram :: FilePath-    } deriving (Eq, Ord, Show, Read, Generic, Typeable)--defaultPrograms :: Programs-defaultPrograms = Programs "cabal" "ghc" "ghc-pkg"--data QueryEnv = QueryEnv {-      -- | How to start the cabal-helper process. Useful if you need to-      -- capture stderr output from the helper.-      qeReadProcess :: FilePath -> [String] -> String -> IO String,--      qePrograms    :: Programs,--      -- | Path to project directory, i.e. the one containing the-      -- @project.cabal@ file-      qeProjectDir  :: FilePath,--      -- | Path to the @dist/@ directory-      qeDistDir     :: FilePath,--      -- | Where to look for the Cabal library when linking the helper-      qeCabalPkgDb  :: Maybe FilePath,--      -- | If @dist/setup-config@ wasn\'t written by this version of Cabal throw-      -- an error-      qeCabalVer    :: Maybe Version-    }--defaultQueryEnv :: FilePath-                -- ^ Path to project directory, i.e. the one containing the-                -- @project.cabal@ file-                -> FilePath-                -- ^ Path to the @dist/@ directory-                -> QueryEnv-defaultQueryEnv projdir distdir = QueryEnv {-    qeReadProcess = readProcess-  , qePrograms    = defaultPrograms-  , qeProjectDir  = projdir-  , qeDistDir     = distdir-  , qeCabalPkgDb  = Nothing-  , qeCabalVer    = Nothing-  }--data SomeLocalBuildInfo = SomeLocalBuildInfo {-      slbiPackageDbStack      :: [ChPkgDb],-      slbiEntrypoints         :: [(ChComponentName, ChEntrypoint)],-      slbiSourceDirs          :: [(ChComponentName, [String])],-      slbiGhcOptions          :: [(ChComponentName, [String])],-      slbiGhcSrcOptions       :: [(ChComponentName, [String])],-      slbiGhcPkgOptions       :: [(ChComponentName, [String])],-      slbiGhcMergedPkgOptions :: [String],-      slbiGhcLangOptions      :: [(ChComponentName, [String])],-      slbiPkgLicenses         :: [(String, [(String, Version)])],-      slbiFlags               :: [(String, Bool)],-      slbiConfigFlags         :: [(String, Bool)],-      slbiNonDefaultConfigFlags :: [(String, Bool)],-      slbiCompilerVersion     :: (String, Version)-    } deriving (Eq, Ord, Read, Show)---- | Caches helper executable result so it doesn't have to be run more than once--- as reading in Cabal's @LocalBuildInfo@ datatype from disk is very slow but--- running all possible queries against it at once is cheap.-newtype Query m a = Query { unQuery :: StateT (Maybe SomeLocalBuildInfo)-                                         (ReaderT QueryEnv m) a }-    deriving (Functor, Applicative, Monad, MonadIO)--instance MonadTrans Query where-    lift = Query . lift . lift--type MonadQuery m = ( MonadIO m-                    , MonadState (Maybe SomeLocalBuildInfo) m-                    , MonadReader QueryEnv m)--run :: Monad m => QueryEnv -> Maybe SomeLocalBuildInfo -> Query m a -> m a-run e s action = flip runReaderT e (flip evalStateT s (unQuery action))---- | @runQuery query distdir@. Run a 'Query'. @distdir@ is where Cabal's--- @setup-config@ file is located.-runQuery :: Monad m-         => QueryEnv-         -> Query m a-         -> m a-runQuery qe action = run qe Nothing action--getSlbi :: MonadQuery m => m SomeLocalBuildInfo-getSlbi = do-  s <- get-  case s of-    Nothing -> do-            slbi <- getSomeConfigState-            put (Just slbi)-            return slbi-    Just slbi -> return slbi---- | List of package databases to use.-packageDbStack :: MonadIO m => Query m [ChPkgDb]---- | Modules or files Cabal would have the compiler build directly. Can be used--- to compute the home module closure for a component.-entrypoints   :: MonadIO m => Query m [(ChComponentName, ChEntrypoint)]---- | A component's @source-dirs@ field, beware as if this is empty implicit--- behaviour in GHC kicks in.-sourceDirs    :: MonadIO m => Query m [(ChComponentName, [FilePath])]---- | All options cabal would pass to GHC.-ghcOptions    :: MonadIO m => Query m [(ChComponentName, [String])]---- | Only search path related GHC options.-ghcSrcOptions :: MonadIO m => Query m [(ChComponentName, [String])]---- | Only package related GHC options, sufficient for things don't need to--- access any home modules.-ghcPkgOptions :: MonadIO m => Query m [(ChComponentName, [String])]---- | Like @ghcPkgOptions@ but for the whole package not just one component-ghcMergedPkgOptions :: MonadIO m => Query m [String]---- | Only language related options, i.e. @-XSomeExtension@-ghcLangOptions :: MonadIO m => Query m [(ChComponentName, [String])]---- | Get the licenses of the packages the current project is linking against.-pkgLicenses :: MonadIO m => Query m [(String, [(String, Version)])]---- | Flag definitions from cabal file-flags :: MonadIO m => Query m [(String, Bool)]---- | Flag assignments from setup-config-configFlags :: MonadIO m => Query m [(String, Bool)]---- | Flag assignments from setup-config which differ from the default--- setting. This can also include flags which cabal decided to modify,--- i.e. don't rely on these being the flags set by the user directly.-nonDefaultConfigFlags :: MonadIO m => Query m [(String, Bool)]---- | The version of GHC the project is configured to use-compilerVersion :: MonadIO m => Query m (String, Version)---- | Package identifier, i.e. package name and version-packageId :: MonadIO m => Query m (String, Version)---packageDbStack      = Query $ slbiPackageDbStack      `liftM` getSlbi-entrypoints         = Query $ slbiEntrypoints         `liftM` getSlbi-sourceDirs          = Query $ slbiSourceDirs          `liftM` getSlbi-ghcOptions          = Query $ slbiGhcOptions          `liftM` getSlbi-ghcSrcOptions       = Query $ slbiGhcSrcOptions       `liftM` getSlbi-ghcPkgOptions       = Query $ slbiGhcPkgOptions       `liftM` getSlbi-ghcMergedPkgOptions = Query $ slbiGhcMergedPkgOptions `liftM` getSlbi-ghcLangOptions      = Query $ slbiGhcLangOptions      `liftM` getSlbi-pkgLicenses         = Query $ slbiPkgLicenses         `liftM` getSlbi-flags               = Query $ slbiFlags               `liftM` getSlbi-configFlags         = Query $ slbiConfigFlags         `liftM` getSlbi-nonDefaultConfigFlags = Query $ slbiNonDefaultConfigFlags `liftM` getSlbi-compilerVersion     = Query $ slbiCompilerVersion     `liftM` getSlbi-packageId           = Query $ getPackageId---- | Run @cabal configure@-reconfigure :: MonadIO m-            => (FilePath -> [String] -> String -> IO String)-            -> Programs -- ^ Program paths-            -> [String] -- ^ Command line arguments to be passed to @cabal@-            -> m ()-reconfigure readProc progs cabalOpts = do-    let progOpts =-            [ "--with-ghc=" ++ ghcProgram progs ]-            -- Only pass ghc-pkg if it was actually set otherwise we-            -- might break cabal's guessing logic-            ++ if ghcPkgProgram progs /= "ghc-pkg"-                 then [ "--with-ghc-pkg=" ++ ghcPkgProgram progs ]-                 else []-            ++ cabalOpts-    _ <- liftIO $ readProc (cabalProgram progs) ("configure":progOpts) ""-    return ()--readHelper :: (MonadIO m, MonadQuery m) => [String] -> m [Maybe ChResponse]-readHelper args = ask >>= \qe -> liftIO $ do-  out <- either error id <$> invokeHelper qe args-  let res = read out-  liftIO $ evaluate res `E.catch` \se@(SomeException _) -> do-      md <- lookupEnv' "CABAL_HELPER_DEBUG"-      let msg = "readHelper: exception: '" ++ show se ++ "'"-      error $ msg ++ case md of-        Nothing -> ", for more information set the environment variable CABAL_HELPER_DEBUG"-        Just _ -> ", output: '"++ out ++"'"--invokeHelper :: QueryEnv -> [String] -> IO (Either String String)-invokeHelper QueryEnv {..} args = do-  let progArgs = [ "--with-ghc="     ++ ghcProgram qePrograms-                 , "--with-ghc-pkg=" ++ ghcPkgProgram qePrograms-                 , "--with-cabal="   ++ cabalProgram qePrograms-                 ]-  exe  <- findLibexecExe-  let args' = progArgs ++ qeProjectDir:qeDistDir:args-  out <- qeReadProcess exe args' ""-  (Right <$> evaluate out) `E.catch` \(SomeException _) ->-      return $ Left $ concat-                 ["invokeHelper", ": ", exe, " "-                 , intercalate " " (map show args')-                 , " failed"-                 ]---getPackageId :: MonadQuery m => m (String, Version)-getPackageId = ask >>= \QueryEnv {..} -> do-  [ Just (ChResponseVersion pkgName pkgVer) ] <- readHelper [ "package-id" ]-  return (pkgName, pkgVer)---getSomeConfigState :: MonadQuery m => m SomeLocalBuildInfo-getSomeConfigState = ask >>= \QueryEnv {..} -> do-  res <- readHelper-         [ "package-db-stack"-         , "entrypoints"-         , "source-dirs"-         , "ghc-options"-         , "ghc-src-options"-         , "ghc-pkg-options"-         , "ghc-merged-pkg-options"-         , "ghc-lang-options"-         , "licenses"-         , "flags"-         , "config-flags"-         , "non-default-config-flags"-         , "compiler-version"-         ]-  let [ Just (ChResponsePkgDbs pkgDbs),-        Just (ChResponseEntrypoints eps),-        Just (ChResponseCompList srcDirs),-        Just (ChResponseCompList ghcOpts),-        Just (ChResponseCompList ghcSrcOpts),-        Just (ChResponseCompList ghcPkgOpts),-        Just (ChResponseList     ghcMergedPkgOpts),-        Just (ChResponseCompList ghcLangOpts),-        Just (ChResponseLicenses pkgLics),-        Just (ChResponseFlags fls),-        Just (ChResponseFlags cfls),-        Just (ChResponseFlags ndcfls),-        Just (ChResponseVersion comp compVer)-        ] = res--  return $ SomeLocalBuildInfo-    pkgDbs eps srcDirs ghcOpts ghcSrcOpts ghcPkgOpts ghcMergedPkgOpts ghcLangOpts pkgLics fls cfls ndcfls (comp, compVer)--prepare :: MonadIO m-        => (FilePath -> [String] -> String -> IO String)-        -> FilePath-        -> FilePath-        -> m ()-prepare readProc projdir distdir = liftIO $ do-  exe  <- findLibexecExe-  void $ readProc exe [projdir, distdir] ""--{-# DEPRECATED prepare-  "Will be replaced by prepare' in the next major release" #-}---- | Make sure the appropriate helper executable for the given project is--- installed and ready to run queries.-prepare' :: MonadIO m => QueryEnv -> m ()-prepare' qe =-  liftIO $ void $ invokeHelper qe []--writeAutogenFiles :: MonadIO m-                  => (FilePath -> [String] -> String -> IO String)-                  -> FilePath-                  -- ^ Path to project directory, i.e. the one containing the-                  -- @project.cabal@ file-                  -> FilePath-                  -- ^ Path to the @dist/@ directory-                  -> m ()-writeAutogenFiles readProc projdir distdir = liftIO $ do-  exe  <- findLibexecExe-  void $ readProc exe [projdir, distdir, "write-autogen-files"] ""--{-# DEPRECATED writeAutogenFiles-  "Will be replaced by writeAutogenFiles' in the next major release" #-}---- | Create @cabal_macros.h@ and @Paths_\<pkg\>@ possibly other generated files--- in the usual place.-writeAutogenFiles' :: MonadIO m => QueryEnv -> m ()-writeAutogenFiles' qe  =-  liftIO $ void $ invokeHelper qe ["write-autogen-files"]---- | Get the path to the sandbox package-db in a project-getSandboxPkgDb :: (FilePath -> [String] -> String -> IO String)-             -> FilePath-             -- ^ Cabal build platform, i.e. @buildPlatform@-             -> Version-             -- ^ GHC version (@cProjectVersion@ is your friend)-             -> IO (Maybe FilePath)-getSandboxPkgDb readProc =-    CabalHelper.Sandbox.getSandboxPkgDb $ unsafePerformIO $ buildPlatform readProc--buildPlatform :: (FilePath -> [String] -> String -> IO String) -> IO String-buildPlatform readProc = do-  exe  <- findLibexecExe-  CabalHelper.Sandbox.dropWhileEnd isSpace <$> readProc exe ["print-build-platform"] ""---- | This exception is thrown by all 'runQuery' functions if the internal--- wrapper executable cannot be found. You may catch this and present the user--- an appropriate error message however the default is to print--- 'libexecNotFoundError'.-data LibexecNotFoundError = LibexecNotFoundError String FilePath-                          deriving (Typeable)-instance Exception LibexecNotFoundError-instance Show LibexecNotFoundError where-  show (LibexecNotFoundError exe dir) =-    libexecNotFoundError exe dir "https://github.com/DanielG/cabal-helper/issues"--findLibexecExe :: IO FilePath-findLibexecExe = do-    libexecdir <- getLibexecDir-    let exeName = "cabal-helper-wrapper"-        exe = libexecdir </> exeName <.> exeExtension'--    exists <- doesFileExist exe--    if exists-       then return exe-       else do-         mdir <- tryFindCabalHelperTreeLibexecDir-         case mdir of-           Nothing ->-               error $ throw $ LibexecNotFoundError exeName libexecdir-           Just dir ->-               return $ dir </> "dist" </> "build" </> exeName </> exeName--tryFindCabalHelperTreeLibexecDir :: IO (Maybe FilePath)-tryFindCabalHelperTreeLibexecDir = do-  exe <- getExecutablePath'-  dir <- case takeFileName exe of-    "ghc" -> do -- we're probably in ghci; try CWD-        getCurrentDirectory-    _ ->-        return $ (!!4) $ iterate takeDirectory exe-  exists <- doesFileExist $ dir </> "cabal-helper.cabal"-  return $ if exists-             then Just dir-             else Nothing--libexecNotFoundError :: String   -- ^ Name of the executable we were trying to-                                 -- find-                     -> FilePath -- ^ Path to @$libexecdir@-                     -> String   -- ^ URL the user will be directed towards to-                                 -- report a bug.-                     -> String-libexecNotFoundError exe dir reportBug = printf- ( "Could not find $libexecdir/%s\n"- ++"\n"- ++"If you are a developer set the environment variable\n"- ++"`cabal_helper_libexecdir' to override $libexecdir[1]. The following will\n"- ++"work in the cabal-helper source tree:\n"- ++"\n"- ++"    $ export cabal_helper_libexecdir=$PWD/dist/build/%s\n"- ++"\n"- ++"[1]: %s\n"- ++"\n"- ++"If you don't know what I'm talking about something went wrong with your\n"- ++"installation. Please report this problem here:\n"- ++"\n"- ++"    %s") exe exe dir reportBug--getExecutablePath' :: IO FilePath-getExecutablePath' =-#if MIN_VERSION_base(4,6,0)-    getExecutablePath-#else-    getProgName-#endif--lookupEnv' :: String -> IO (Maybe String)-lookupEnv' k = lookup k <$> getEnvironment--exeExtension' :: FilePath-exeExtension' = Distribution.Simple.BuildPaths.exeExtension
LICENSE view
@@ -1,661 +1,202 @@-                    GNU AFFERO GENERAL PUBLIC LICENSE-                       Version 3, 19 November 2007 - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>- Everyone is permitted to copy and distribute verbatim copies- of this license document, but changing it is not allowed.--                            Preamble--  The GNU Affero General Public License is a free, copyleft license for-software and other kinds of works, specifically designed to ensure-cooperation with the community in the case of network server software.--  The licenses for most software and other practical works are designed-to take away your freedom to share and change the works.  By contrast,-our General Public Licenses are intended to guarantee your freedom to-share and change all versions of a program--to make sure it remains free-software for all its users.--  When we speak of free software, we are referring to freedom, not-price.  Our General Public Licenses are designed to make sure that you-have the freedom to distribute copies of free software (and charge for-them if you wish), that you receive source code or can get it if you-want it, that you can change the software or use pieces of it in new-free programs, and that you know you can do these things.--  Developers that use our General Public Licenses protect your rights-with two steps: (1) assert copyright on the software, and (2) offer-you this License which gives you legal permission to copy, distribute-and/or modify the software.--  A secondary benefit of defending all users' freedom is that-improvements made in alternate versions of the program, if they-receive widespread use, become available for other developers to-incorporate.  Many developers of free software are heartened and-encouraged by the resulting cooperation.  However, in the case of-software used on network servers, this result may fail to come about.-The GNU General Public License permits making a modified version and-letting the public access it on a server without ever releasing its-source code to the public.--  The GNU Affero General Public License is designed specifically to-ensure that, in such cases, the modified source code becomes available-to the community.  It requires the operator of a network server to-provide the source code of the modified version running there to the-users of that server.  Therefore, public use of a modified version, on-a publicly accessible server, gives the public access to the source-code of the modified version.--  An older license, called the Affero General Public License and-published by Affero, was designed to accomplish similar goals.  This is-a different license, not a version of the Affero GPL, but Affero has-released a new version of the Affero GPL which permits relicensing under-this license.--  The precise terms and conditions for copying, distribution and-modification follow.--                       TERMS AND CONDITIONS--  0. Definitions.--  "This License" refers to version 3 of the GNU Affero General Public License.--  "Copyright" also means copyright-like laws that apply to other kinds of-works, such as semiconductor masks.--  "The Program" refers to any copyrightable work licensed under this-License.  Each licensee is addressed as "you".  "Licensees" and-"recipients" may be individuals or organizations.--  To "modify" a work means to copy from or adapt all or part of the work-in a fashion requiring copyright permission, other than the making of an-exact copy.  The resulting work is called a "modified version" of the-earlier work or a work "based on" the earlier work.--  A "covered work" means either the unmodified Program or a work based-on the Program.--  To "propagate" a work means to do anything with it that, without-permission, would make you directly or secondarily liable for-infringement under applicable copyright law, except executing it on a-computer or modifying a private copy.  Propagation includes copying,-distribution (with or without modification), making available to the-public, and in some countries other activities as well.--  To "convey" a work means any kind of propagation that enables other-parties to make or receive copies.  Mere interaction with a user through-a computer network, with no transfer of a copy, is not conveying.--  An interactive user interface displays "Appropriate Legal Notices"-to the extent that it includes a convenient and prominently visible-feature that (1) displays an appropriate copyright notice, and (2)-tells the user that there is no warranty for the work (except to the-extent that warranties are provided), that licensees may convey the-work under this License, and how to view a copy of this License.  If-the interface presents a list of user commands or options, such as a-menu, a prominent item in the list meets this criterion.--  1. Source Code.--  The "source code" for a work means the preferred form of the work-for making modifications to it.  "Object code" means any non-source-form of a work.--  A "Standard Interface" means an interface that either is an official-standard defined by a recognized standards body, or, in the case of-interfaces specified for a particular programming language, one that-is widely used among developers working in that language.--  The "System Libraries" of an executable work include anything, other-than the work as a whole, that (a) is included in the normal form of-packaging a Major Component, but which is not part of that Major-Component, and (b) serves only to enable use of the work with that-Major Component, or to implement a Standard Interface for which an-implementation is available to the public in source code form.  A-"Major Component", in this context, means a major essential component-(kernel, window system, and so on) of the specific operating system-(if any) on which the executable work runs, or a compiler used to-produce the work, or an object code interpreter used to run it.--  The "Corresponding Source" for a work in object code form means all-the source code needed to generate, install, and (for an executable-work) run the object code and to modify the work, including scripts to-control those activities.  However, it does not include the work's-System Libraries, or general-purpose tools or generally available free-programs which are used unmodified in performing those activities but-which are not part of the work.  For example, Corresponding Source-includes interface definition files associated with source files for-the work, and the source code for shared libraries and dynamically-linked subprograms that the work is specifically designed to require,-such as by intimate data communication or control flow between those-subprograms and other parts of the work.--  The Corresponding Source need not include anything that users-can regenerate automatically from other parts of the Corresponding-Source.--  The Corresponding Source for a work in source code form is that-same work.--  2. Basic Permissions.--  All rights granted under this License are granted for the term of-copyright on the Program, and are irrevocable provided the stated-conditions are met.  This License explicitly affirms your unlimited-permission to run the unmodified Program.  The output from running a-covered work is covered by this License only if the output, given its-content, constitutes a covered work.  This License acknowledges your-rights of fair use or other equivalent, as provided by copyright law.--  You may make, run and propagate covered works that you do not-convey, without conditions so long as your license otherwise remains-in force.  You may convey covered works to others for the sole purpose-of having them make modifications exclusively for you, or provide you-with facilities for running those works, provided that you comply with-the terms of this License in conveying all material for which you do-not control copyright.  Those thus making or running the covered works-for you must do so exclusively on your behalf, under your direction-and control, on terms that prohibit them from making any copies of-your copyrighted material outside their relationship with you.--  Conveying under any other circumstances is permitted solely under-the conditions stated below.  Sublicensing is not allowed; section 10-makes it unnecessary.--  3. Protecting Users' Legal Rights From Anti-Circumvention Law.--  No covered work shall be deemed part of an effective technological-measure under any applicable law fulfilling obligations under article-11 of the WIPO copyright treaty adopted on 20 December 1996, or-similar laws prohibiting or restricting circumvention of such-measures.--  When you convey a covered work, you waive any legal power to forbid-circumvention of technological measures to the extent such circumvention-is effected by exercising rights under this License with respect to-the covered work, and you disclaim any intention to limit operation or-modification of the work as a means of enforcing, against the work's-users, your or third parties' legal rights to forbid circumvention of-technological measures.--  4. Conveying Verbatim Copies.--  You may convey verbatim copies of the Program's source code as you-receive it, in any medium, provided that you conspicuously and-appropriately publish on each copy an appropriate copyright notice;-keep intact all notices stating that this License and any-non-permissive terms added in accord with section 7 apply to the code;-keep intact all notices of the absence of any warranty; and give all-recipients a copy of this License along with the Program.--  You may charge any price or no price for each copy that you convey,-and you may offer support or warranty protection for a fee.--  5. Conveying Modified Source Versions.--  You may convey a work based on the Program, or the modifications to-produce it from the Program, in the form of source code under the-terms of section 4, provided that you also meet all of these conditions:--    a) The work must carry prominent notices stating that you modified-    it, and giving a relevant date.--    b) The work must carry prominent notices stating that it is-    released under this License and any conditions added under section-    7.  This requirement modifies the requirement in section 4 to-    "keep intact all notices".--    c) You must license the entire work, as a whole, under this-    License to anyone who comes into possession of a copy.  This-    License will therefore apply, along with any applicable section 7-    additional terms, to the whole of the work, and all its parts,-    regardless of how they are packaged.  This License gives no-    permission to license the work in any other way, but it does not-    invalidate such permission if you have separately received it.--    d) If the work has interactive user interfaces, each must display-    Appropriate Legal Notices; however, if the Program has interactive-    interfaces that do not display Appropriate Legal Notices, your-    work need not make them do so.--  A compilation of a covered work with other separate and independent-works, which are not by their nature extensions of the covered work,-and which are not combined with it such as to form a larger program,-in or on a volume of a storage or distribution medium, is called an-"aggregate" if the compilation and its resulting copyright are not-used to limit the access or legal rights of the compilation's users-beyond what the individual works permit.  Inclusion of a covered work-in an aggregate does not cause this License to apply to the other-parts of the aggregate.--  6. Conveying Non-Source Forms.--  You may convey a covered work in object code form under the terms-of sections 4 and 5, provided that you also convey the-machine-readable Corresponding Source under the terms of this License,-in one of these ways:--    a) Convey the object code in, or embodied in, a physical product-    (including a physical distribution medium), accompanied by the-    Corresponding Source fixed on a durable physical medium-    customarily used for software interchange.--    b) Convey the object code in, or embodied in, a physical product-    (including a physical distribution medium), accompanied by a-    written offer, valid for at least three years and valid for as-    long as you offer spare parts or customer support for that product-    model, to give anyone who possesses the object code either (1) a-    copy of the Corresponding Source for all the software in the-    product that is covered by this License, on a durable physical-    medium customarily used for software interchange, for a price no-    more than your reasonable cost of physically performing this-    conveying of source, or (2) access to copy the-    Corresponding Source from a network server at no charge.--    c) Convey individual copies of the object code with a copy of the-    written offer to provide the Corresponding Source.  This-    alternative is allowed only occasionally and noncommercially, and-    only if you received the object code with such an offer, in accord-    with subsection 6b.--    d) Convey the object code by offering access from a designated-    place (gratis or for a charge), and offer equivalent access to the-    Corresponding Source in the same way through the same place at no-    further charge.  You need not require recipients to copy the-    Corresponding Source along with the object code.  If the place to-    copy the object code is a network server, the Corresponding Source-    may be on a different server (operated by you or a third party)-    that supports equivalent copying facilities, provided you maintain-    clear directions next to the object code saying where to find the-    Corresponding Source.  Regardless of what server hosts the-    Corresponding Source, you remain obligated to ensure that it is-    available for as long as needed to satisfy these requirements.--    e) Convey the object code using peer-to-peer transmission, provided-    you inform other peers where the object code and Corresponding-    Source of the work are being offered to the general public at no-    charge under subsection 6d.--  A separable portion of the object code, whose source code is excluded-from the Corresponding Source as a System Library, need not be-included in conveying the object code work.--  A "User Product" is either (1) a "consumer product", which means any-tangible personal property which is normally used for personal, family,-or household purposes, or (2) anything designed or sold for incorporation-into a dwelling.  In determining whether a product is a consumer product,-doubtful cases shall be resolved in favor of coverage.  For a particular-product received by a particular user, "normally used" refers to a-typical or common use of that class of product, regardless of the status-of the particular user or of the way in which the particular user-actually uses, or expects or is expected to use, the product.  A product-is a consumer product regardless of whether the product has substantial-commercial, industrial or non-consumer uses, unless such uses represent-the only significant mode of use of the product.--  "Installation Information" for a User Product means any methods,-procedures, authorization keys, or other information required to install-and execute modified versions of a covered work in that User Product from-a modified version of its Corresponding Source.  The information must-suffice to ensure that the continued functioning of the modified object-code is in no case prevented or interfered with solely because-modification has been made.--  If you convey an object code work under this section in, or with, or-specifically for use in, a User Product, and the conveying occurs as-part of a transaction in which the right of possession and use of the-User Product is transferred to the recipient in perpetuity or for a-fixed term (regardless of how the transaction is characterized), the-Corresponding Source conveyed under this section must be accompanied-by the Installation Information.  But this requirement does not apply-if neither you nor any third party retains the ability to install-modified object code on the User Product (for example, the work has-been installed in ROM).--  The requirement to provide Installation Information does not include a-requirement to continue to provide support service, warranty, or updates-for a work that has been modified or installed by the recipient, or for-the User Product in which it has been modified or installed.  Access to a-network may be denied when the modification itself materially and-adversely affects the operation of the network or violates the rules and-protocols for communication across the network.--  Corresponding Source conveyed, and Installation Information provided,-in accord with this section must be in a format that is publicly-documented (and with an implementation available to the public in-source code form), and must require no special password or key for-unpacking, reading or copying.--  7. Additional Terms.--  "Additional permissions" are terms that supplement the terms of this-License by making exceptions from one or more of its conditions.-Additional permissions that are applicable to the entire Program shall-be treated as though they were included in this License, to the extent-that they are valid under applicable law.  If additional permissions-apply only to part of the Program, that part may be used separately-under those permissions, but the entire Program remains governed by-this License without regard to the additional permissions.--  When you convey a copy of a covered work, you may at your option-remove any additional permissions from that copy, or from any part of-it.  (Additional permissions may be written to require their own-removal in certain cases when you modify the work.)  You may place-additional permissions on material, added by you to a covered work,-for which you have or can give appropriate copyright permission.--  Notwithstanding any other provision of this License, for material you-add to a covered work, you may (if authorized by the copyright holders of-that material) supplement the terms of this License with terms:--    a) Disclaiming warranty or limiting liability differently from the-    terms of sections 15 and 16 of this License; or--    b) Requiring preservation of specified reasonable legal notices or-    author attributions in that material or in the Appropriate Legal-    Notices displayed by works containing it; or--    c) Prohibiting misrepresentation of the origin of that material, or-    requiring that modified versions of such material be marked in-    reasonable ways as different from the original version; or--    d) Limiting the use for publicity purposes of names of licensors or-    authors of the material; or--    e) Declining to grant rights under trademark law for use of some-    trade names, trademarks, or service marks; or--    f) Requiring indemnification of licensors and authors of that-    material by anyone who conveys the material (or modified versions of-    it) with contractual assumptions of liability to the recipient, for-    any liability that these contractual assumptions directly impose on-    those licensors and authors.--  All other non-permissive additional terms are considered "further-restrictions" within the meaning of section 10.  If the Program as you-received it, or any part of it, contains a notice stating that it is-governed by this License along with a term that is a further-restriction, you may remove that term.  If a license document contains-a further restriction but permits relicensing or conveying under this-License, you may add to a covered work material governed by the terms-of that license document, provided that the further restriction does-not survive such relicensing or conveying.--  If you add terms to a covered work in accord with this section, you-must place, in the relevant source files, a statement of the-additional terms that apply to those files, or a notice indicating-where to find the applicable terms.--  Additional terms, permissive or non-permissive, may be stated in the-form of a separately written license, or stated as exceptions;-the above requirements apply either way.--  8. Termination.--  You may not propagate or modify a covered work except as expressly-provided under this License.  Any attempt otherwise to propagate or-modify it is void, and will automatically terminate your rights under-this License (including any patent licenses granted under the third-paragraph of section 11).--  However, if you cease all violation of this License, then your-license from a particular copyright holder is reinstated (a)-provisionally, unless and until the copyright holder explicitly and-finally terminates your license, and (b) permanently, if the copyright-holder fails to notify you of the violation by some reasonable means-prior to 60 days after the cessation.--  Moreover, your license from a particular copyright holder is-reinstated permanently if the copyright holder notifies you of the-violation by some reasonable means, this is the first time you have-received notice of violation of this License (for any work) from that-copyright holder, and you cure the violation prior to 30 days after-your receipt of the notice.--  Termination of your rights under this section does not terminate the-licenses of parties who have received copies or rights from you under-this License.  If your rights have been terminated and not permanently-reinstated, you do not qualify to receive new licenses for the same-material under section 10.--  9. Acceptance Not Required for Having Copies.--  You are not required to accept this License in order to receive or-run a copy of the Program.  Ancillary propagation of a covered work-occurring solely as a consequence of using peer-to-peer transmission-to receive a copy likewise does not require acceptance.  However,-nothing other than this License grants you permission to propagate or-modify any covered work.  These actions infringe copyright if you do-not accept this License.  Therefore, by modifying or propagating a-covered work, you indicate your acceptance of this License to do so.--  10. Automatic Licensing of Downstream Recipients.--  Each time you convey a covered work, the recipient automatically-receives a license from the original licensors, to run, modify and-propagate that work, subject to this License.  You are not responsible-for enforcing compliance by third parties with this License.--  An "entity transaction" is a transaction transferring control of an-organization, or substantially all assets of one, or subdividing an-organization, or merging organizations.  If propagation of a covered-work results from an entity transaction, each party to that-transaction who receives a copy of the work also receives whatever-licenses to the work the party's predecessor in interest had or could-give under the previous paragraph, plus a right to possession of the-Corresponding Source of the work from the predecessor in interest, if-the predecessor has it or can get it with reasonable efforts.--  You may not impose any further restrictions on the exercise of the-rights granted or affirmed under this License.  For example, you may-not impose a license fee, royalty, or other charge for exercise of-rights granted under this License, and you may not initiate litigation-(including a cross-claim or counterclaim in a lawsuit) alleging that-any patent claim is infringed by making, using, selling, offering for-sale, or importing the Program or any portion of it.--  11. Patents.--  A "contributor" is a copyright holder who authorizes use under this-License of the Program or a work on which the Program is based.  The-work thus licensed is called the contributor's "contributor version".--  A contributor's "essential patent claims" are all patent claims-owned or controlled by the contributor, whether already acquired or-hereafter acquired, that would be infringed by some manner, permitted-by this License, of making, using, or selling its contributor version,-but do not include claims that would be infringed only as a-consequence of further modification of the contributor version.  For-purposes of this definition, "control" includes the right to grant-patent sublicenses in a manner consistent with the requirements of-this License.--  Each contributor grants you a non-exclusive, worldwide, royalty-free-patent license under the contributor's essential patent claims, to-make, use, sell, offer for sale, import and otherwise run, modify and-propagate the contents of its contributor version.+                                 Apache License+                           Version 2.0, January 2004+                        http://www.apache.org/licenses/ -  In the following three paragraphs, a "patent license" is any express-agreement or commitment, however denominated, not to enforce a patent-(such as an express permission to practice a patent or covenant not to-sue for patent infringement).  To "grant" such a patent license to a-party means to make such an agreement or commitment not to enforce a-patent against the party.+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION -  If you convey a covered work, knowingly relying on a patent license,-and the Corresponding Source of the work is not available for anyone-to copy, free of charge and under the terms of this License, through a-publicly available network server or other readily accessible means,-then you must either (1) cause the Corresponding Source to be so-available, or (2) arrange to deprive yourself of the benefit of the-patent license for this particular work, or (3) arrange, in a manner-consistent with the requirements of this License, to extend the patent-license to downstream recipients.  "Knowingly relying" means you have-actual knowledge that, but for the patent license, your conveying the-covered work in a country, or your recipient's use of the covered work-in a country, would infringe one or more identifiable patents in that-country that you have reason to believe are valid.+   1. Definitions. -  If, pursuant to or in connection with a single transaction or-arrangement, you convey, or propagate by procuring conveyance of, a-covered work, and grant a patent license to some of the parties-receiving the covered work authorizing them to use, propagate, modify-or convey a specific copy of the covered work, then the patent license-you grant is automatically extended to all recipients of the covered-work and works based on it.+      "License" shall mean the terms and conditions for use, reproduction,+      and distribution as defined by Sections 1 through 9 of this document. -  A patent license is "discriminatory" if it does not include within-the scope of its coverage, prohibits the exercise of, or is-conditioned on the non-exercise of one or more of the rights that are-specifically granted under this License.  You may not convey a covered-work if you are a party to an arrangement with a third party that is-in the business of distributing software, under which you make payment-to the third party based on the extent of your activity of conveying-the work, and under which the third party grants, to any of the-parties who would receive the covered work from you, a discriminatory-patent license (a) in connection with copies of the covered work-conveyed by you (or copies made from those copies), or (b) primarily-for and in connection with specific products or compilations that-contain the covered work, unless you entered into that arrangement,-or that patent license was granted, prior to 28 March 2007.+      "Licensor" shall mean the copyright owner or entity authorized by+      the copyright owner that is granting the License. -  Nothing in this License shall be construed as excluding or limiting-any implied license or other defenses to infringement that may-otherwise be available to you under applicable patent law.+      "Legal Entity" shall mean the union of the acting entity and all+      other entities that control, are controlled by, or are under common+      control with that entity. For the purposes of this definition,+      "control" means (i) the power, direct or indirect, to cause the+      direction or management of such entity, whether by contract or+      otherwise, or (ii) ownership of fifty percent (50%) or more of the+      outstanding shares, or (iii) beneficial ownership of such entity. -  12. No Surrender of Others' Freedom.+      "You" (or "Your") shall mean an individual or Legal Entity+      exercising permissions granted by this License. -  If conditions are imposed on you (whether by court order, agreement or-otherwise) that contradict the conditions of this License, they do not-excuse you from the conditions of this License.  If you cannot convey a-covered work so as to satisfy simultaneously your obligations under this-License and any other pertinent obligations, then as a consequence you may-not convey it at all.  For example, if you agree to terms that obligate you-to collect a royalty for further conveying from those to whom you convey-the Program, the only way you could satisfy both those terms and this-License would be to refrain entirely from conveying the Program.+      "Source" form shall mean the preferred form for making modifications,+      including but not limited to software source code, documentation+      source, and configuration files. -  13. Remote Network Interaction; Use with the GNU General Public License.+      "Object" form shall mean any form resulting from mechanical+      transformation or translation of a Source form, including but+      not limited to compiled object code, generated documentation,+      and conversions to other media types. -  Notwithstanding any other provision of this License, if you modify the-Program, your modified version must prominently offer all users-interacting with it remotely through a computer network (if your version-supports such interaction) an opportunity to receive the Corresponding-Source of your version by providing access to the Corresponding Source-from a network server at no charge, through some standard or customary-means of facilitating copying of software.  This Corresponding Source-shall include the Corresponding Source for any work covered by version 3-of the GNU General Public License that is incorporated pursuant to the-following paragraph.+      "Work" shall mean the work of authorship, whether in Source or+      Object form, made available under the License, as indicated by a+      copyright notice that is included in or attached to the work+      (an example is provided in the Appendix below). -  Notwithstanding any other provision of this License, you have-permission to link or combine any covered work with a work licensed-under version 3 of the GNU General Public License into a single-combined work, and to convey the resulting work.  The terms of this-License will continue to apply to the part which is the covered work,-but the work with which it is combined will remain governed by version-3 of the GNU General Public License.+      "Derivative Works" shall mean any work, whether in Source or Object+      form, that is based on (or derived from) the Work and for which the+      editorial revisions, annotations, elaborations, or other modifications+      represent, as a whole, an original work of authorship. For the purposes+      of this License, Derivative Works shall not include works that remain+      separable from, or merely link (or bind by name) to the interfaces of,+      the Work and Derivative Works thereof. -  14. Revised Versions of this License.+      "Contribution" shall mean any work of authorship, including+      the original version of the Work and any modifications or additions+      to that Work or Derivative Works thereof, that is intentionally+      submitted to Licensor for inclusion in the Work by the copyright owner+      or by an individual or Legal Entity authorized to submit on behalf of+      the copyright owner. For the purposes of this definition, "submitted"+      means any form of electronic, verbal, or written communication sent+      to the Licensor or its representatives, including but not limited to+      communication on electronic mailing lists, source code control systems,+      and issue tracking systems that are managed by, or on behalf of, the+      Licensor for the purpose of discussing and improving the Work, but+      excluding communication that is conspicuously marked or otherwise+      designated in writing by the copyright owner as "Not a Contribution." -  The Free Software Foundation may publish revised and/or new versions of-the GNU Affero General Public License from time to time.  Such new versions-will be similar in spirit to the present version, but may differ in detail to-address new problems or concerns.+      "Contributor" shall mean Licensor and any individual or Legal Entity+      on behalf of whom a Contribution has been received by Licensor and+      subsequently incorporated within the Work. -  Each version is given a distinguishing version number.  If the-Program specifies that a certain numbered version of the GNU Affero General-Public License "or any later version" applies to it, you have the-option of following the terms and conditions either of that numbered-version or of any later version published by the Free Software-Foundation.  If the Program does not specify a version number of the-GNU Affero General Public License, you may choose any version ever published-by the Free Software Foundation.+   2. Grant of Copyright License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      copyright license to reproduce, prepare Derivative Works of,+      publicly display, publicly perform, sublicense, and distribute the+      Work and such Derivative Works in Source or Object form. -  If the Program specifies that a proxy can decide which future-versions of the GNU Affero General Public License can be used, that proxy's-public statement of acceptance of a version permanently authorizes you-to choose that version for the Program.+   3. Grant of Patent License. Subject to the terms and conditions of+      this License, each Contributor hereby grants to You a perpetual,+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable+      (except as stated in this section) patent license to make, have made,+      use, offer to sell, sell, import, and otherwise transfer the Work,+      where such license applies only to those patent claims licensable+      by such Contributor that are necessarily infringed by their+      Contribution(s) alone or by combination of their Contribution(s)+      with the Work to which such Contribution(s) was submitted. If You+      institute patent litigation against any entity (including a+      cross-claim or counterclaim in a lawsuit) alleging that the Work+      or a Contribution incorporated within the Work constitutes direct+      or contributory patent infringement, then any patent licenses+      granted to You under this License for that Work shall terminate+      as of the date such litigation is filed. -  Later license versions may give you additional or different-permissions.  However, no additional obligations are imposed on any-author or copyright holder as a result of your choosing to follow a-later version.+   4. Redistribution. You may reproduce and distribute copies of the+      Work or Derivative Works thereof in any medium, with or without+      modifications, and in Source or Object form, provided that You+      meet the following conditions: -  15. Disclaimer of Warranty.+      (a) You must give any other recipients of the Work or+          Derivative Works a copy of this License; and -  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.+      (b) You must cause any modified files to carry prominent notices+          stating that You changed the files; and -  16. Limitation of Liability.+      (c) You must retain, in the Source form of any Derivative Works+          that You distribute, all copyright, patent, trademark, and+          attribution notices from the Source form of the Work,+          excluding those notices that do not pertain to any part of+          the Derivative Works; and -  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF-SUCH DAMAGES.+      (d) If the Work includes a "NOTICE" text file as part of its+          distribution, then any Derivative Works that You distribute must+          include a readable copy of the attribution notices contained+          within such NOTICE file, excluding those notices that do not+          pertain to any part of the Derivative Works, in at least one+          of the following places: within a NOTICE text file distributed+          as part of the Derivative Works; within the Source form or+          documentation, if provided along with the Derivative Works; or,+          within a display generated by the Derivative Works, if and+          wherever such third-party notices normally appear. The contents+          of the NOTICE file are for informational purposes only and+          do not modify the License. You may add Your own attribution+          notices within Derivative Works that You distribute, alongside+          or as an addendum to the NOTICE text from the Work, provided+          that such additional attribution notices cannot be construed+          as modifying the License. -  17. Interpretation of Sections 15 and 16.+      You may add Your own copyright statement to Your modifications and+      may provide additional or different license terms and conditions+      for use, reproduction, or distribution of Your modifications, or+      for any such Derivative Works as a whole, provided Your use,+      reproduction, and distribution of the Work otherwise complies with+      the conditions stated in this License. -  If the disclaimer of warranty and limitation of liability provided-above cannot be given local legal effect according to their terms,-reviewing courts shall apply local law that most closely approximates-an absolute waiver of all civil liability in connection with the-Program, unless a warranty or assumption of liability accompanies a-copy of the Program in return for a fee.+   5. Submission of Contributions. Unless You explicitly state otherwise,+      any Contribution intentionally submitted for inclusion in the Work+      by You to the Licensor shall be under the terms and conditions of+      this License, without any additional terms or conditions.+      Notwithstanding the above, nothing herein shall supersede or modify+      the terms of any separate license agreement you may have executed+      with Licensor regarding such Contributions. -                     END OF TERMS AND CONDITIONS+   6. Trademarks. This License does not grant permission to use the trade+      names, trademarks, service marks, or product names of the Licensor,+      except as required for reasonable and customary use in describing the+      origin of the Work and reproducing the content of the NOTICE file. -            How to Apply These Terms to Your New Programs+   7. Disclaimer of Warranty. Unless required by applicable law or+      agreed to in writing, Licensor provides the Work (and each+      Contributor provides its Contributions) on an "AS IS" BASIS,+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+      implied, including, without limitation, any warranties or conditions+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+      PARTICULAR PURPOSE. You are solely responsible for determining the+      appropriateness of using or redistributing the Work and assume any+      risks associated with Your exercise of permissions under this License. -  If you develop a new program, and you want it to be of the greatest-possible use to the public, the best way to achieve this is to make it-free software which everyone can redistribute and change under these terms.+   8. Limitation of Liability. In no event and under no legal theory,+      whether in tort (including negligence), contract, or otherwise,+      unless required by applicable law (such as deliberate and grossly+      negligent acts) or agreed to in writing, shall any Contributor be+      liable to You for damages, including any direct, indirect, special,+      incidental, or consequential damages of any character arising as a+      result of this License or out of the use or inability to use the+      Work (including but not limited to damages for loss of goodwill,+      work stoppage, computer failure or malfunction, or any and all+      other commercial damages or losses), even if such Contributor+      has been advised of the possibility of such damages. -  To do so, attach the following notices to the program.  It is safest-to attach them to the start of each source file to most effectively-state the exclusion of warranty; and each file should have at least-the "copyright" line and a pointer to where the full notice is found.+   9. Accepting Warranty or Additional Liability. While redistributing+      the Work or Derivative Works thereof, You may choose to offer,+      and charge a fee for, acceptance of support, warranty, indemnity,+      or other liability obligations and/or rights consistent with this+      License. However, in accepting such obligations, You may act only+      on Your own behalf and on Your sole responsibility, not on behalf+      of any other Contributor, and only if You agree to indemnify,+      defend, and hold each Contributor harmless for any liability+      incurred by, or claims asserted against, such Contributor by reason+      of your accepting any such warranty or additional liability. -    <one line to give the program's name and a brief idea of what it does.>-    Copyright (C) <year>  <name of author>+   END OF TERMS AND CONDITIONS -    This program is free software: you can redistribute it and/or modify-    it under the terms of the GNU Affero General Public License as published by-    the Free Software Foundation, either version 3 of the License, or-    (at your option) any later version.+   APPENDIX: How to apply the Apache License to your work. -    This program is distributed in the hope that it will be useful,-    but WITHOUT ANY WARRANTY; without even the implied warranty of-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the-    GNU Affero General Public License for more details.+      To apply the Apache License to your work, attach the following+      boilerplate notice, with the fields enclosed by brackets "[]"+      replaced with your own identifying information. (Don't include+      the brackets!)  The text should be enclosed in the appropriate+      comment syntax for the file format. We also recommend that a+      file or class name and description of purpose be included on the+      same "printed page" as the copyright notice for easier+      identification within third-party archives. -    You should have received a copy of the GNU Affero General Public License-    along with this program.  If not, see <http://www.gnu.org/licenses/>.+   Copyright [yyyy] [name of copyright owner] -Also add information on how to contact you by electronic and paper mail.+   Licensed under the Apache License, Version 2.0 (the "License");+   you may not use this file except in compliance with the License.+   You may obtain a copy of the License at -  If your software can interact with users remotely through a computer-network, you should also make sure that it provides a way for users to-get its source.  For example, if your program is a web application, its-interface could display a "Source" link that leads users to an archive-of the code.  There are many ways you could offer source, and different-solutions will be better for different programs; see section 13 for the-specific requirements.+       http://www.apache.org/licenses/LICENSE-2.0 -  You should also get your employer (if you work as a programmer) or school,-if any, to sign a "copyright disclaimer" for the program, if necessary.-For more information on this, and how to apply and follow the GNU AGPL, see-<http://www.gnu.org/licenses/>.+   Unless required by applicable law or agreed to in writing, software+   distributed under the License is distributed on an "AS IS" BASIS,+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+   See the License for the specific language governing permissions and+   limitations under the License.
README.md view
@@ -1,29 +1,121 @@-# cabal-helper+# The `cabal-helper` library+[![build status](https://gitlab.com/dxld/cabal-helper/badges/master/pipeline.svg)](https://gitlab.com/dxld/cabal-helper/commits/master) -`cabal-helper` provides a library which wraps the internal use of-anexecutable to lift the restrictions imposed by linking against versions of-GHC before `7.10`. This has the pleasant side effect of isolating the user-from having to deal with Cabal version changes manually as `cabal-helper`-can simply recompile it's helper program automatically as needed.+The purpose of the `cabal-helper` library is to give Haskell development+tools access to the same environment which build tools such as+[cabal](https://www.haskell.org/cabal) and+[stack](https://www.haskellstack.org) normally provide to the compiler. -`cabal-helper` uses a wrapper executable to compile the actual cabal-helper-executable at runtime while linking against an arbitrary version of-Cabal. This runtime-compiled helper executable is then used to extract-various bits and peices from Cabal's on disk state (dist/setup-config)-written by it's configure command.+## Introduction -In addition to this the wrapper executable also supports installing any-version of Cabal from hackage in case it cannot be found in any available-package database. The wrapper installs these instances of the Cabal library-into a private package database so as to not interfere with the user's-packages.+In the Haskell ecosystem the most widely used [build system](#build-system) is+the [`Cabal` library](https://hackage.haskell.org/package/Cabal), not to be+confused with the `cabal` *build tool* which is usually refered to by it's+package-name: `cabal-install` to disambiguate. -Furthermore the wrapper supports one special case namely reading a state-file for Cabal itself. This is needed as Cabal compiles it's Setup.hs using-itself and not using any version of Cabal installed in any package database.+All contemporary meta *build tools* such as `cabal` and `stack` as well as some+custom Haskell [build systems](#build-system) use the `Cabal` library as their+foundation. For example the Glasgow Haskell Compiler's bespoke GNU Make based+build system also utilises the `Cabal` library at its core. -`cabal-helper` can compile with `Cabal >= 1.14` but requires `Cabal >= 1.16`-at runtime.+We capitalize on this fact by using build information `Cabal` writes to disk as+the common denominator between all Haskell *build tools*. This allows us to+easily support a variety of *build tools* without incuring significant+additional complexity.++## Technical Background++### Haskell Packages and `Setup.hs`++Essentially all Haskell packages implement+["The Haskell Cabal" (pdf)](https://www.haskell.org/cabal/proposal/pkg-spec.pdf)+packaging specification. The `Cabal` library and `cabal-install` *build tool*+are named after this specification. Yes we really love confusing naming in+Haskell land.++The specification revolves around this `Setup.hs` script file you might+have seen before. Basically the idea is a Haskell source package consists+of, at the very least, a `Setup.hs` file, which is a Haskell program that+provides a well defined command-line interface for configuring, building+and installing it. Haskell developers can use *build tools*, such as+`cabal`, which interface with `Setup.hs` and provide functionality on top+it.++Note that even though originally packages were meant to be free to+implement the `Setup.hs` interface however they like, this hasn't been+supported by build tools for a long time. In practice use of the `Cabal`+library in `Setup.hs` is mandatory.++Now, the first step of building a package in "The Haskell Cabal" is to call+`Setup.hs`'s `configure` command:++    $ runhaskell Setup.hs configure++When invoking `Setup.hs` the default behaviour of the `Cabal` library is to+first read the `<pkg-name>.cabal` configuration file to determine how the+project is structured and what dependencies it has. In the case of+`configure` it will then probe the system it's running on about:++ - the list of available Haskell packages,+ - system package dependencies (using pkg-config) and+ - Haskell compiler type, version and supported language extensions (among+   other things).++Finally Haskell package dependency resolution is also run.+ +`Cabal` then writes all the gathered information on the concrete+configuration of the package into a file called `setup-config`. Subsequent+steps, such as`runhaskell Setup.hs build`, will then read this state file+instead of `<package-name>.cabal` to avoid having to probe the system or+run dependency resolution again.++It is this file that `cabal-helper` is primarily concerned with reading and+presenting in a usable manner. Reading this file essentially means that all+the complicated work has already been done for us and we can get straight+to running the compiler.++### Multi-package projects++So far so good. That's pretty much the end of the story for the traditional+`cabal build` commands but what about `cabal new-build` and Stack I hear+you asking?++Well, essentially both new-build and Stack simply build on top of the+traditional `Setup.hs` interface. So the `setup-config` file is still there+in all it's glory, we just have to deal with more than one of it since both+build-tools support multiple packages and `Setup.hs` only knows how to deal+with a single package at a time.++To support this cabal-helper has grown a representation of what a project+is in it's API starting with the 1.0 series. We currently support both+new-build and Stack. The API is designed to allow extending support to+custom build systems such as GHC's but we have not done this yet.++### The "Helper" in cabal-helper++In the API docs you will find frequent mentions of "the helper executable"+so I'll explain what that is here because it is quite fundamental to how+things work in the codebase.++The fundamental problem cabal-helper solves is the fact that in order to+access the data Cabal stores in the `setup-config` file we have to link+against `lib:Cabal`. However the binary format of this file is unstable and+there is no backwards compatibility mechanism in the library. So to read a+`setup-config` file produced by a certain version of Cabal we have to link+against exactly that version.++Not only that but usally the `cabal` commandline tool controls which Cabal+library version is used, so we really just have to deal with whatever we+get.++To solve this problem the cabal-helper library builds a small executable at+runtime who's only purpose is to link against `lib:Cabal`, read the+contents of `setup-config` and present the data there in a Cabal version+independent format for consumption by the cabal-helper library.++Recently some work was merged into cabal to have `Setup.hs` to do this+natively (https://github.com/haskell/cabal/pull/5954), we're planning to+use this eventually to replace our "helper".  ## IRC
Setup.hs view
@@ -1,108 +1,2 @@-#!/usr/bin/env runhaskell-{-# LANGUAGE RecordWildCards, NamedFieldPuns #-} import Distribution.Simple-import Distribution.Simple.Utils-import Distribution.Simple.Setup-import Distribution.Simple.Install-import Distribution.Simple.Register-import Distribution.Simple.BuildPaths-import qualified Distribution.Simple.InstallDirs as ID-import Distribution.Simple.LocalBuildInfo-import Distribution.Simple.Program-import Distribution.PackageDescription--import qualified Data.Map as M-import Data.Map (Map)--import Control.Arrow-import Control.Applicative-import Control.Monad-import Data.List-import Data.Maybe-import Data.Version-import Data.Monoid-import System.Process-import System.Exit-import System.FilePath-import System.Directory (renameFile)--main :: IO ()-main = defaultMainWithHooks $ simpleUserHooks {-   instHook = inst,-   copyHook = copy,-   buildHook = \pd lbi hooks flags -> (buildHook simpleUserHooks) pd (patchLibexecdir lbi) hooks flags,-   hookedPrograms = [ simpleProgram "cabal" ]- }--patchLibexecdir :: LocalBuildInfo -> LocalBuildInfo-patchLibexecdir lbi = let-    idirtpl     = installDirTemplates lbi-    libexecdir' = toPathTemplate $ fromPathTemplate (libexecdir idirtpl) </> "$abi/$pkgid"-    lbi' = lbi { installDirTemplates = idirtpl { libexecdir = libexecdir' } }-  in-    lbi'---- mostly copypasta from 'defaultInstallHook'-inst ::-    PackageDescription -> LocalBuildInfo -> UserHooks -> InstallFlags -> IO ()-inst pd lbi _uf ifl = do-  let copyFlags = defaultCopyFlags {-                      copyDistPref   = installDistPref ifl,-                      copyDest       = toFlag NoCopyDest,-                      copyVerbosity  = installVerbosity ifl-                  }-  xInstallTarget pd lbi copyFlags (\pd' lbi' -> install pd' lbi' copyFlags)-  let registerFlags = defaultRegisterFlags {-                          regDistPref  = installDistPref ifl,-                          regInPlace   = installInPlace ifl,-                          regPackageDB = installPackageDB ifl,-                          regVerbosity = installVerbosity ifl-                      }-  when (hasLibs pd) $ register pd lbi registerFlags--copy :: PackageDescription -> LocalBuildInfo -> UserHooks -> CopyFlags -> IO ()-copy pd lbi _uh cf =-    xInstallTarget pd lbi cf (\pd' lbi' -> install pd' lbi' cf)--xInstallTarget :: PackageDescription-               -> LocalBuildInfo-               -> CopyFlags-               -> (PackageDescription -> LocalBuildInfo -> IO ())-               -> IO ()-xInstallTarget pd lbi cf fn = do-  let (extended, regular) = partition isInternal (executables pd)--  let pd_regular = pd { executables = regular }--  _ <- flip mapM extended $ \exe -> do--    let pd_extended = onlyExePackageDesc [exe] pd--    fn pd_extended lbi--    let lbi' = patchLibexecdir lbi-        copydest  = fromFlag (copyDest cf)-        verbosity = fromFlag (copyVerbosity cf)-        InstallDirs { bindir, libexecdir } = absoluteInstallDirs pd lbi' copydest-        progprefix = substPathTemplate (packageId pd) lbi (progPrefix lbi)-        progsuffix = substPathTemplate (packageId pd) lbi (progSuffix lbi)-        fixedExeBaseName = progprefix ++ exeName exe ++ progsuffix--        fixedExeFileName = bindir </> fixedExeBaseName <.> exeExtension-        newExeFileName   = libexecdir </> fixedExeBaseName <.> exeExtension--    createDirectoryIfMissingVerbose verbosity True libexecdir-    renameFile fixedExeFileName newExeFileName--  fn pd_regular lbi-- where-   isInternal :: Executable -> Bool-   isInternal exe =-    fromMaybe False $ (=="True") <$> lookup "x-internal" (customFieldsBI $ buildInfo exe)--onlyExePackageDesc :: [Executable] -> PackageDescription -> PackageDescription-onlyExePackageDesc exes pd = emptyPackageDescription {-                     package = package pd-                   , executables = exes-                   }+main = defaultMain
cabal-helper.cabal view
@@ -1,156 +1,243 @@+cabal-version:       2.2 name:                cabal-helper-version:             0.7.3.0-synopsis:            Simple interface to some of Cabal's configuration state used by ghc-mod+version:             1.1.0.0+synopsis:+ Give Haskell development tools access to Cabal project environment description:-    @cabal-helper@ provides a library which wraps the internal use of an-    executable to lift the restrictions imposed by linking against versions of-    GHC before @7.10@. This has the pleasant side effect of isolating the user-    from having to deal with Cabal version changes manually as @cabal-helper@-    can simply recompile it's helper program automatically as needed.-    .-    @cabal-helper@ uses a wrapper executable to compile the actual cabal-helper-    executable at runtime while linking against an arbitrary version of-    Cabal. This runtime-compiled helper executable is then used to extract-    various bits and peices from Cabal\'s on disk state (dist/setup-config)-    written by it's configure command.-    .-    In addition to this the wrapper executable also supports installing any-    version of Cabal from hackage in case it cannot be found in any available-    package database. The wrapper installs these instances of the Cabal library-    into a private package database so as to not interfere with the user's-    packages.-    .-    Furthermore the wrapper supports one special case namely reading a state-    file for Cabal itself. This is needed as Cabal compiles it's Setup.hs using-    itself and not using any version of Cabal installed in any package database.-    .-    @cabal-helper@ can compile with @Cabal >= 1.14@ but requires @Cabal >= 1.16@-    at runtime.--license:             AGPL-3+ The purpose of the @cabal-helper@ library is to give Haskell development+ tools access to the same environment which build tools such as @cabal@ and+ @stack@ normally provide to the compiler.+license:             Apache-2.0 license-file:        LICENSE-author:              Daniel Gröber <dxld@darkboxed.org>-maintainer:          dxld@darkboxed.org+author:              Daniel Gröber <cabal-helper@dxld.at>+maintainer:          cabal-helper@dxld.at category:            Distribution-build-type:          Custom-cabal-version:       >=1.10+build-type:          Simple extra-source-files:  README.md-                     CabalHelper/Main.hs-                     CabalHelper/Licenses.hs+                     src/CabalHelper/Runtime/*.hs +                     tests/*.hs+                     tests/stack-resolvers+                     tests/cabal-versions++                     tests/exelib/*.hs+                     tests/exelib/*.cabal+                     tests/exelib/packages.list+                     tests/exelib/stack.yaml+                     tests/exelib/lib/*.hs++                     tests/exeintlib/*.hs+                     tests/exeintlib/*.cabal+                     tests/exeintlib/packages.list+                     tests/exeintlib/stack.yaml+                     tests/exeintlib/lib/*.hs+                     tests/exeintlib/intlib/*.hs++                     tests/fliblib/*.hs+                     tests/fliblib/*.cabal+                     tests/fliblib/packages.list+                     tests/fliblib/stack.yaml+                     tests/fliblib/lib/*.hs++                     tests/custom-setup/*.hs+                     tests/custom-setup/*.cabal+                     tests/custom-setup/packages.list+                     tests/custom-setup/stack.yaml++                     tests/bkpregex/*.hs+                     tests/bkpregex/*.cabal+                     tests/bkpregex/packages.list+                     tests/bkpregex/stack.yaml+                     tests/bkpregex/regex-example/*.hs+                     tests/bkpregex/regex-indef/*.hs+                     tests/bkpregex/regex-indef/*.hsig+                     tests/bkpregex/regex-types/Regex/*.hs+                     tests/bkpregex/str-impls/Str/*.hs++                     tests/src-repo/*.hs+                     tests/src-repo/*.cabal+                     tests/src-repo/packages.list+                     tests/src-repo/cabal.project++                     tests/multipkg/packages.list+                     tests/multipkg/pkg-oot/*.cabal+                     tests/multipkg/pkg-oot/*.hs+                     tests/multipkg/proj/*.cabal+                     tests/multipkg/proj/*.hs+                     tests/multipkg/proj/cabal.project+                     tests/multipkg/proj/pkg-a/*.cabal+                     tests/multipkg/proj/pkg-a/*.hs+                     tests/multipkg/proj/pkg-b/*.cabal+                     tests/multipkg/proj/pkg-b/*.hs+                     tests/multipkg/proj/stack.yaml++ source-repository head   type:     git   location: https://github.com/DanielG/cabal-helper.git -Custom-Setup-  Setup-Depends:         base-                       , Cabal >= 1.14 && < 1.25-                       , containers-                       , filepath-                       , directory-                       , process-                       , template-haskell-                       , transformers+flag dev+  description: Build development components+  default:     False+  manual:      True -library-  exposed-modules:     Distribution.Helper-  other-modules:       Paths_cabal_helper-                     , CabalHelper.Types-                     , CabalHelper.Sandbox-  default-language:    Haskell2010-  ghc-options:         -Wall-  build-depends:       base          < 5    && >= 4.5-                     , Cabal         < 1.25 && >= 1.14-                     , directory     < 1.4  && >= 1.1.0.2-                     , filepath      < 1.5  && >= 1.3.0.0-                     , transformers  < 0.6  && >= 0.3.0.0-                     , mtl           < 2.3  && >= 2.0-                     , process       < 1.5  && >= 1.1.0.1-                     , ghc-prim -executable cabal-helper-wrapper+common extensions   default-language:    Haskell2010+  default-extensions:  NondecreasingIndentation+                       ImplicitParams+                       NamedFieldPuns RecordWildCards+                       FlexibleContexts+                       ConstraintKinds   other-extensions:    TemplateHaskell-  main-is:             CabalHelper/Wrapper.hs-  other-modules:       Paths_cabal_helper-                       CabalHelper.Types-                       CabalHelper.Common-                       CabalHelper.GuessGhc-                       CabalHelper.Data-                       CabalHelper.Compile-                       CabalHelper.Log-                       CabalHelper.Sandbox-  ghc-options:         -Wall-  x-internal:          True-  build-depends:       base             < 5    && >= 4.5-                     , Cabal            < 1.25 && >= 1.14-                     , bytestring       < 0.11 && >= 0.9.2.1-                     , directory        < 1.4  && >= 1.1.0.2-                     , filepath         < 1.5  && >= 1.3.0.0-                     , transformers     < 0.6  && >= 0.3.0.0++common build-deps+  build-depends:       base             < 5    && >= 4.9.1.0+                     , Cabal            < 3.4  && >= 3.0+                                     || < 2.5  && >= 2.0+                                     || < 1.26 && >= 1.24.2.0+                     , cabal-plan       < 0.7  && >= 0.5.0.0+                     , clock            < 0.8  && >= 0.7.2+                     , containers       < 1    && >= 0.5.7.1+                     , bytestring       < 0.11 && >= 0.10.8.1+                     , directory        < 1.4  && >= 1.3.0.0+                     , filepath         < 1.5  && >= 1.4.1.1                      , mtl              < 2.3  && >= 2.0-                     , process          < 1.5  && >= 1.1.0.1-                     , temporary        < 1.3  && >= 1.2.0.4+                     , process          < 1.7  && >= 1.4.3.0+                     , semigroups       < 0.19 && >= 0.18+                     , semigroupoids    < 5.4  && >= 5.2+                     , SHA              < 1.7  && >= 1.6.4.4+                     , text             < 1.3  && >= 1.0.0.0+                     , template-haskell < 2.17 && >= 2.11.1.0+                     , temporary        < 1.3  && >= 1.2.1+                     , time             < 1.10 && >= 1.6.0.1+                     , transformers     < 0.6  && >= 0.5.2.0                      , utf8-string      < 1.1  && >= 1.0.1.1+  if os(windows)+    build-depends:     Win32            < 2.9  && >= 2.5.4.1+                     , Cabal            >= 3.0.1+                       --^ Need fix for dropExeExtension (haskell/cabal#6287)+  else+    build-depends:     unix             < 2.8  && >= 2.7.2.1+  build-depends:       unix-compat      < 0.6  && >= 0.4.3.1 -                     , template-haskell-                     , ghc-prim+  if flag(dev)+    ghc-options:       -Wall -fwarn-incomplete-uni-patterns -test-suite spec-  default-language:    Haskell2010-  type:                exitcode-stdio-1.0-  main-is:             Spec.hs-  other-modules:       CabalHelper.Common-                       CabalHelper.Compile-                       CabalHelper.Data-                       CabalHelper.Log-                       CabalHelper.Sandbox-                       CabalHelper.Types++common c-h-internal+  import:             build-deps, extensions+  other-modules:+                       CabalHelper.Compiletime.Cabal+                       CabalHelper.Compiletime.CompPrograms+                       CabalHelper.Compiletime.Compat.Environment+                       CabalHelper.Compiletime.Compat.Version+                       CabalHelper.Compiletime.Compat.Parsec+                       CabalHelper.Compiletime.Compile+                       CabalHelper.Compiletime.Data+                       CabalHelper.Compiletime.Log+                       CabalHelper.Compiletime.Process+                       CabalHelper.Compiletime.Program.CabalInstall+                       CabalHelper.Compiletime.Program.Stack+                       CabalHelper.Compiletime.Program.GHC+                       CabalHelper.Compiletime.Sandbox+                       CabalHelper.Compiletime.Types+                       CabalHelper.Compiletime.Types.Cabal+                       CabalHelper.Compiletime.Types.RelativePath+                       CabalHelper.Runtime.Compat+                       CabalHelper.Runtime.HelperMain+                       CabalHelper.Shared.Common+                       CabalHelper.Shared.InterfaceTypes+  other-modules:+                       Paths_cabal_helper+  autogen-modules:+                       Paths_cabal_helper+  other-modules:+                       Symlink+  if os(windows)+    hs-source-dirs:    os/win+  else+    hs-source-dirs:    os/posix+  hs-source-dirs:      src++common c-h-lib+  import:             build-deps, extensions, c-h-internal+  other-modules:                        Distribution.Helper+                       Distribution.Helper.Discover+  other-modules:                        Paths_cabal_helper-  hs-source-dirs:      tests, .-  ghc-options:         -Wall-  build-tools:         cabal-  build-depends:       base             < 5    && >= 4.5-                     , Cabal            < 1.26 && >= 1.14-                     , bytestring       < 0.11 && >= 0.9.2.1-                     , directory        < 1.4  && >= 1.1.0.2-                     , filepath         < 1.5  && >= 1.3.0.0-                     , transformers     < 0.6  && >= 0.3.0.0-                     , mtl              < 2.3  && >= 2.0-                     , process          < 1.5  && >= 1.1.0.1-                     , temporary        < 1.3  && >= 1.2.0.4-                     , utf8-string      < 1.1  && >= 1.0.1.1+  autogen-modules:+                       Paths_cabal_helper+  hs-source-dirs:      lib -                     -- additional test deps-                     , extra            < 1.5  && >= 1.4.10-                     , unix             < 2.8  && >= 2.5.1.0+library+  import:              build-deps, extensions, c-h-internal+  exposed-modules:     Distribution.Helper+                       Distribution.Helper.Discover+  other-modules:+                       Paths_cabal_helper+  autogen-modules:+                       Paths_cabal_helper+  hs-source-dirs:      lib -                     , template-haskell-                     , ghc-prim-                     , cabal-helper+test-suite compile-test+  import:              build-deps, extensions, c-h-internal+  type:                exitcode-stdio-1.0+  main-is:             CompileTest.hs+  other-modules:       TestOptions+  hs-source-dirs:      tests+  ghc-options:         -Wall -fwarn-incomplete-uni-patterns --- TODO: Use cabal_macros.h to replace -D flags by including it in--- CabalHelper.Data------ executable cabal-helper-main---   if flag(dev)---     buildable:         True---   else---     buildable:         False---   default-language:    Haskell2010---   default-extensions:  NondecreasingIndentation---   main-is:             CabalHelper/Main.hs---   other-modules:---   ghc-options:         -Wall -fno-warn-unused-imports -optP-DCABAL_MAJOR=1 -optP-DCABAL_MINOR=25 -optP-DCABAL_HELPER=1 -optP-DCABAL_HELPER_DEV=1---   build-depends:       base---                      , Cabal---                      , containers---                      , bytestring---                      , filepath---                      , directory------ flag dev---   description: Build development components---   default:     False---   manual:      True+test-suite programs-test+  import:              build-deps, extensions, c-h-internal+  type:                exitcode-stdio-1.0+  main-is:             ProgramsTest.hs+  hs-source-dirs:      tests+  ghc-options:         -Wall -fwarn-incomplete-uni-patterns+  build-depends:       pretty-show++test-suite ghc-session+  import:              build-deps, extensions, c-h-lib+  type:                exitcode-stdio-1.0+  main-is:             GhcSession.hs+  other-modules:       TestOptions+  hs-source-dirs:      tests+  ghc-options:         -Wall -fwarn-incomplete-uni-patterns+  build-depends:       ghc              < 8.11  && >= 8.0.2+                     , pretty-show      < 1.9  && >= 1.8.1++test-suite examples+  import:              build-deps, extensions, c-h-lib+  type:                exitcode-stdio-1.0+  main-is:             Examples.hs+  hs-source-dirs:      tests+  ghc-options:         -Wall -fwarn-incomplete-uni-patterns++executable cabal-helper-main+  default-language:    Haskell2010+  default-extensions:  NondecreasingIndentation+  main-is:             CabalHelper/Runtime/Main.hs+  hs-source-dirs:      src+  other-modules:+                       CabalHelper.Runtime.HelperMain+                       CabalHelper.Runtime.Compat+                       CabalHelper.Shared.Common+                       CabalHelper.Shared.InterfaceTypes+                       CabalHelper.Shared.Common++  -- This component is usually built at runtime but during development it's+  -- convinient to build it via cabal+  if flag(dev)+    buildable:         True+  else+    buildable:         False++  ghc-options:         -Wall -fno-warn-unused-imports -fwarn-incomplete-uni-patterns+  build-depends:       base             < 5    && >= 4.9.1.0+                     , Cabal+                     , containers+                     , bytestring+                     , filepath+                     , directory+                     , ghc-prim
+ lib/Distribution/Helper.hs view
@@ -0,0 +1,878 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2019  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE RecordWildCards, FlexibleContexts, ConstraintKinds,+  GeneralizedNewtypeDeriving, DeriveDataTypeable, DeriveGeneric, DeriveFunctor,+  StandaloneDeriving, NamedFieldPuns, OverloadedStrings, ViewPatterns,+  TupleSections, TypeFamilies, DataKinds, GADTs, ScopedTypeVariables,+  ImplicitParams, RankNTypes, MultiWayIf #-}++{-# OPTIONS_GHC -fno-warn-name-shadowing #-}++{-|+Module      : Distribution.Helper+License     : Apache-2.0+Maintainer  : cabal-helper@dxld.at+Portability : POSIX+-}++module Distribution.Helper (+  -- * Type Variable Naming Conventions+  -- $type-conventions++  -- * Running Queries+    Query+  , runQuery++  -- * Queries against Cabal\'s on disk state++  -- ** Project queries+  , compilerVersion+  , projectPackages++  -- ** 'Package' queries+  , Package -- abstract+  , pPackageName+  , pSourceDir+  , pUnits++  -- ** 'Unit' queries+  , Unit -- abstract+  , uComponentName+  , UnitId -- abstract+  , UnitInfo(..)+  , unitInfo++  -- ** Convenience Queries+  , allUnits++  -- * Query environment+  , QueryEnv+  , QueryEnvI -- abstract+  , mkQueryEnv+  , qeReadProcess+  , qeCallProcess+  , qePrograms+  , qeProjLoc+  , qeDistDir++  -- * GADTs+  , ProjType(..)+  , CabalProjType(..)+  , ProjLoc(..)+  , DistDir(..)+  , SProjType(..)+  , demoteSProjType+  , projTypeOfDistDir+  , projTypeOfProjLoc+  , SCabalProjType(..)+  , Ex(..)++  -- * Programs+  , Programs(..)+  , defaultPrograms+  , EnvOverride(..)++  -- * Query result types+  , ChComponentInfo(..)+  , ChComponentName(..)+  , ChLibraryName(..)+  , ChModuleName(..)+  , ChPkgDb(..)+  , ChEntrypoint(..)++  -- * General information+  , Distribution.Helper.buildPlatform++  -- * Legacy v1-build helpers+  , Distribution.Helper.getSandboxPkgDb++  -- * Build actions+  , prepare+  , writeAutogenFiles+  , buildProject+  , buildUnits+  ) where++import Cabal.Plan hiding (Unit, UnitId, uDistDir)+import Control.Applicative+import Control.Monad+import Control.Monad.Trans.Maybe+import Control.Monad.IO.Class+import Control.Exception as E+import qualified Data.ByteString.Char8 as BS8+import qualified Data.ByteString.UTF8 as BSU+import Data.IORef+import Data.List hiding (filter)+import Data.String+import qualified Data.Text as Text+import Data.Maybe+import Data.Either+import Data.Map.Strict (Map)+import qualified Data.Map.Strict as Map+import Data.Set (Set)+import qualified Data.Set as Set+import qualified Data.Traversable as T+import Data.List.NonEmpty (NonEmpty(..))+import qualified Data.List.NonEmpty as NonEmpty+import Data.Version+import Data.Function+import System.Clock as Clock+import System.IO+import System.Environment+import System.FilePath+import System.Directory+import System.Process+import System.Posix.Types+import System.PosixCompat.Files+import Text.Printf+import Text.Read+import Prelude++import CabalHelper.Compiletime.Compile+import qualified CabalHelper.Compiletime.Program.Stack as Stack+import qualified CabalHelper.Compiletime.Program.GHC as GHC+import qualified CabalHelper.Compiletime.Program.CabalInstall as CabalInstall+import CabalHelper.Compiletime.Cabal+import CabalHelper.Compiletime.CompPrograms+import CabalHelper.Compiletime.Log+import CabalHelper.Compiletime.Process+import CabalHelper.Compiletime.Sandbox+import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Types.Cabal+import CabalHelper.Compiletime.Types.RelativePath+import CabalHelper.Shared.InterfaceTypes+import CabalHelper.Shared.Common+import CabalHelper.Runtime.HelperMain (helper_main)++import CabalHelper.Compiletime.Compat.Version++import Distribution.System (buildPlatform)+import Distribution.Text (display)++-- $type-conventions+-- Throughout the API we use the following conventions for type variables:+--+-- * @pt@ stands for "project type", when instantiated it is always of kind+--   'ProjType'.+--+-- * @c@ stands for "cache". It is used internally to make the cache+--   inaccessible for some parts of the implementation. Users of the API may+--   completely ignore this parameter. See the internal 'qeCacheRef' field+--   accessor of 'QueryEnv' for details.+++-- | A query against a package's Cabal configuration. Use 'runQuery' to+-- execute it.+newtype Query pt a = Query+    { unQuery :: QueryEnv pt -> IO a+    -- ^ @runQuery env query@. Run a 'Query' under a given 'QueryEnv.+    }++instance Functor (Query pt) where+    fmap = liftM++instance Applicative (Query pt) where+    (<*>) = ap+    pure = return++instance Monad (Query pt) where+    (Query ma) >>= amb = Query $ \qe -> ma qe >>= \a -> unQuery (amb a) qe+    return a = Query $ const $ return a++runQuery :: Query pt a -> QueryEnv pt -> IO a+runQuery (Query action) qe = do+  ckr <- newIORef $ CacheKeyCache Nothing+  let qe' = qe { qeCacheKeys = ckr }+  conf_progs <- getConfProgs qe'+  action qe' { qePrograms = conf_progs }++-- | @mkQueryEnv projdir distdir@. Smart constructor for 'QueryEnv'.+-- Sets fields 'qeProjLoc' and 'qeDistDir' to @projdir@ and @distdir@+-- respectively and provides sensible defaults for the other fields.+mkQueryEnv+    :: ProjLoc pt+    -- ^ Location of the project.+    -> DistDir pt+    -- ^ Path to the @dist/@ or @dist-newstyle/@ directory, called+    -- /builddir/ in Cabal terminology.+    -> IO (QueryEnv pt)+mkQueryEnv projloc distdir = do+  cr <- newIORef $ QueryCache Nothing Nothing Nothing Map.empty+  return $ QueryEnv+    { qeReadProcess = \stdin mcwd env exe args -> do+        withVerbosity $ readProcessStderr mcwd env exe args ""+    , qeCallProcess  = \mcwd env exe args ->+        withVerbosity $ callProcessStderr mcwd env exe args+    , qePrograms     = defaultPrograms+    , qeProjLoc      = projloc+    , qeDistDir      = distdir+    , qeCacheRef     = cr+    , qeCacheKeys    = error "mkQuery: qeCacheKeys is uninitialized!"+    }++-- | Construct paths to project configuration files given where the project is.+projConf :: ProjLoc pt -> IO (ProjConf pt)+projConf (ProjLocV1Dir pkgdir) =+  ProjConfV1 <$> (complainIfNoCabalFile pkgdir =<< findCabalFile pkgdir)+projConf (ProjLocV1CabalFile cabal_file _) = return $+  ProjConfV1 cabal_file+projConf (ProjLocV2Dir projdir_path) =+  projConf $ ProjLocV2File (projdir_path </> "cabal.project") projdir_path+projConf (ProjLocV2File proj_file _) = return $+  ProjConfV2+    { pcV2CabalProjFile       = proj_file+    , pcV2CabalProjLocalFile  = proj_file <.> "local"+    , pcV2CabalProjFreezeFile = proj_file <.> "freeze"+    }+projConf (ProjLocStackYaml stack_yaml) = return $+  ProjConfStack+    { pcStackYaml = stack_yaml }++-- | Get the current modification-time for each file involved in configuring a+-- project. Optional files in 'ProjConf' are handled by not including them in+-- the result list in 'ProjConfModTimes' if they don\'t exist. This causes the+-- lists to be different if the files end up existing later, which is all we+-- need for cache invalidation.+getProjConfModTime :: ProjConf pt -> IO ProjConfModTimes+getProjConfModTime ProjConfV1{pcV1CabalFile} =+  fmap ProjConfModTimes $ mapM getFileModTime+    [ pcV1CabalFile+    ]+getProjConfModTime ProjConfV2{..} = do+  fmap (ProjConfModTimes . catMaybes) $+    mapM (traverse getFileModTime <=< mightExist)+      [ pcV2CabalProjFile+      , pcV2CabalProjLocalFile+      , pcV2CabalProjFreezeFile+      ]+getProjConfModTime ProjConfStack{..} =+  fmap ProjConfModTimes $ mapM getFileModTime+    [ pcStackYaml+    ]++getUnitModTimes :: Unit pt -> IO UnitModTimes+getUnitModTimes+  Unit+    { uDistDir=DistDirLib distdirv1+    , uPackage=Package+      { pCabalFile=CabalFile cabal_file_path+      , pSourceDir+      }+    , uImpl+    }+  = do+    umtPkgYaml <-+        case uImpl of+          UnitImplStack{}+            -> traverse getFileModTime =<< mightExist package_yaml_path+          _ -> return Nothing+    umtCabalFile <- getFileModTime cabal_file_path+    umtSetupConfig <- (traverse getFileModTime <=< mightExist) setup_config_path+    return UnitModTimes {..}+  where+    package_yaml_path = pSourceDir  </> "package.yaml"+    setup_config_path = distdirv1 </> "setup-config"++-- | Get a random unit from the project. Sometimes we need to get info we+-- can only get after configuring _any_ unit but we do assume that this+-- info is uniform across units.+someUnit :: ProjInfo pt -> Unit pt+someUnit proj_info =+    NonEmpty.head $ pUnits $+    NonEmpty.head $ piPackages proj_info++-- | The version of GHC the project is configured to use for compilation.+compilerVersion :: Query pt (String, Version)+compilerVersion = Query $ \qe ->+  getProjInfo qe >>= \proj_info ->+    let unit = someUnit proj_info in+    --  ^ ASSUMPTION: Here we assume the compiler version is uniform across all+    --  units so we just pick any one.+    case piImpl proj_info of+      ProjInfoV1 {} -> uiCompilerId <$> getUnitInfo qe unit+      ProjInfoV2 { piV2CompilerId } -> return piV2CompilerId+      ProjInfoStack {} -> uiCompilerId <$> getUnitInfo qe unit++-- | All local packages currently active in a project\'s build plan.+projectPackages :: Query pt (NonEmpty (Package pt))+projectPackages = Query $ \qe -> piPackages <$> getProjInfo qe++-- | Get the 'UnitInfo' for a given 'Unit'. To get a 'Unit' see 'projectUnits'.+unitInfo :: Unit pt -> Query pt UnitInfo+unitInfo u = Query $ \qe -> getUnitInfo qe u++-- | Get information on all units in a project.+allUnits :: (UnitInfo -> a) -> Query pt (NonEmpty a)+allUnits f = do+  fmap f <$> (T.mapM unitInfo =<< join . fmap pUnits <$> projectPackages)+++data Cached c ckc k v = Cached+  { cGet      :: !(c -> Maybe (k, v))+  , cSet      :: !(c -> (k, v) -> c)++  , cGetKey   :: !(ckc -> Maybe k)+  , cSetKey   :: !(ckc -> k -> ckc)++  , cCheckKey :: !(IO k)+  , cKeyValid :: !(k -> k -> Bool)+  -- ^ @cKeyValid old new@ should return 'True' if 'old' is still valid+  -- relative to the value of 'new'.++  , cRegen    :: !(k -> IO v)+  }++-- | Simple caching scheme. Invalidation is based on equality of a "cache+-- key" the current value of which can be got with the IO action 'cGetKey'.+--+-- Note that we only check the actual value of the cache key once per+-- 'runQuery' call by saving the cache key in an ephemeral map.+cached :: QueryEnvI (QueryCacheI a b c d) pt+       -> Cached (QueryCacheI a b c d pt) (CacheKeyCache pt) k v+       -> IO v+cached qe Cached{..} = do+  c <- readIORef (qeCacheRef qe)+  (c', v) <- checkUpdate c (cGet c)+  writeIORef (qeCacheRef qe) c'+  return v+ where+  checkUpdate c m = do+    ckc <- readIORef (qeCacheKeys qe)+    let regen ck = (ck,) <$> cRegen ck+    n <- case m of+      Nothing -> do+        ck <- cCheckKey+        writeIORef (qeCacheKeys qe) (cSetKey ckc ck)+        regen ck+      Just old@(old_ck, old_v) -> do+        ck <- case cGetKey ckc of+          Just cck ->+            return cck -- TODO: skip valid check below in this case+          Nothing -> do+            ck <- cCheckKey+            writeIORef (qeCacheKeys qe) (cSetKey ckc ck)+            return ck+        if+          | cKeyValid old_ck ck -> return old+          | otherwise -> regen ck+    return (cSet c n, snd n)++getProjConfAndModTime :: QueryEnvI c pt -> IO (ProjConf pt, ProjConfModTimes)+getProjConfAndModTime qe = do+  proj_conf <- projConf (qeProjLoc qe)+  mtime <- getProjConfModTime proj_conf+  return (proj_conf, mtime)++getPreInfo :: QueryEnvI (QCPreInfo a b c) pt -> IO (PreInfo pt)+getPreInfo qe =+  cached qe $ Cached+    { cGet = qcPreInfo+    , cSet = \a b -> a { qcPreInfo = Just b }+    , cGetKey = ckcProjConf+    , cSetKey = \a b -> a { ckcProjConf = Just b }+    , cCheckKey = getProjConfAndModTime qe+    , cKeyValid = (==) `on` snd+    , cRegen = \_k -> readPreInfo qe+    }++readPreInfo :: QueryEnvI c pt -> IO (PreInfo pt)+readPreInfo qe = do+  case projTypeOfQueryEnv qe of+    SStack -> do+      piStackProjPaths <- Stack.projPaths qe+      return PreInfoStack+        { piStackProjPaths+        }+    (SCabal _) ->+      return PreInfoCabal++getProjInfo :: QueryEnv pt -> IO (ProjInfo pt)+getProjInfo qe = do+  pre_info <- getPreInfo qe+  cached qe $ Cached+    { cGet = qcProjInfo+    , cSet = \c n@(_, proj_info) ->+        let active_units = NonEmpty.toList $ join $+              fmap pUnits $ piPackages proj_info in+        c { qcProjInfo = Just n+          , qcUnitInfos =+               discardInactiveUnitInfos active_units (qcUnitInfos c)+          }+    , cGetKey = ckcProjConf+    , cSetKey = \a b -> a { ckcProjConf = Just b }+    , cCheckKey = getProjConfAndModTime qe+    , cKeyValid = (==) `on` snd+    , cRegen = \(proj_conf, mtime) -> do+        shallowReconfigureProject qe+        readProjInfo qe proj_conf mtime pre_info+    }+++-- | Get the cabal version we need to build for this project.+getCabalLibVersion :: QueryEnv pt -> Reconfigured pt -> ProjInfo pt -> IO CabalVersion+getCabalLibVersion _ _ ProjInfo{piImpl=ProjInfoV1 {piV1CabalVersion}} =+  return piV1CabalVersion+getCabalLibVersion qe reconf proj_info = do+  unit <- case reconf of+    AlreadyReconfigured unit ->+        return unit+    Haven'tReconfigured -> do+        let unit = someUnit proj_info+        reconfigureUnit qe unit+        return unit+  let DistDirLib distdir = uDistDir $ unit+  hdr <- readSetupConfigHeader $ distdir </> "setup-config"+  let ("Cabal", cabalVer) = uhSetupId hdr+  return $ CabalVersion cabalVer+++getUnitInfo :: QueryEnv pt -> Unit pt -> IO UnitInfo+getUnitInfo qe@QueryEnv{..} unit@Unit{uDistDir} = do+  pre_info <- getPreInfo qe+  proj_info <- getProjInfo qe+  cached qe $ Cached+    { cGet = \c -> do+        ui <- Map.lookup uDistDir (qcUnitInfos c)+        return (uiModTimes ui, ui)+    , cSet = \c (_mtimes, unit_info) -> c { qcUnitInfos =+        Map.insert uDistDir unit_info (qcUnitInfos c) }++    , cGetKey = const Nothing+    , cSetKey = const+    , cCheckKey = getUnitModTimes unit+    , cKeyValid = (==)++    , cRegen = \mtimes -> do+        reconf <- reconfigureUnit qe unit+        cabal_ver <- getCabalLibVersion qe reconf proj_info+        helper <- getHelper qe pre_info proj_info cabal_ver+        readUnitInfo helper unit mtimes+    }++-- | Restrict 'UnitInfo' cache to units that are still active+discardInactiveUnitInfos+    :: [Unit pt]+    -> Map DistDirLib UnitInfo+    -> Map DistDirLib UnitInfo+discardInactiveUnitInfos active_units uis0 =+    restrictKeysMap uis0 $ Set.fromList $ map uDistDir active_units+  where+    restrictKeysMap :: Ord k => Map k a -> Set k -> Map k a+    restrictKeysMap m s = Map.filterWithKey (\k _ -> Set.member k s) m+++-- | Regenerate project-level information by calling the appropriate build+-- system.+shallowReconfigureProject :: QueryEnvI (QCProgs a b) pt -> IO ()+shallowReconfigureProject QueryEnv+  { qeProjLoc = ProjLocStackYaml _stack_yaml, .. } = do+    -- Stack's dry-run only generates the cabal file from package.yaml (or+    -- well that's the only thing we would care about). reconfigureUnit+    -- will take care of this though and we don't need the cabal files+    -- before the Unit stage anyways.+    return ()+shallowReconfigureProject qe = do+  buildProjectTarget qe Nothing DryRun++data Reconfigured pt = AlreadyReconfigured (Unit pt) | Haven'tReconfigured+reconfigureUnit :: QueryEnvI c pt -> Unit pt -> IO (Reconfigured pt)+reconfigureUnit qe u = do+  buildProjectTarget qe (Just u) OnlyCfg+  return (AlreadyReconfigured u)++buildUnits :: [Unit pt] -> Query pt ()+buildUnits units = Query $ \qe -> do+  conf_progs <- getConfProgs qe+  forM_ units $ \u ->+    buildProjectTarget qe { qePrograms = conf_progs } (Just u) DoBuild++buildProject :: Query pt ()+buildProject = Query $ \qe -> do+  conf_progs <- getConfProgs qe+  buildProjectTarget qe { qePrograms = conf_progs } Nothing DoBuild++data BuildStage = DryRun | OnlyCfg | DoBuild++buildProjectTarget+    :: QueryEnvI c pt -> Maybe (Unit pt) -> BuildStage -> IO ()+buildProjectTarget qe mu stage = do+  -- Stack and cabal just happen to have the same stage options, totally by+  -- accident :)+  stage_opts :: [String] <- return $ case stage of+    DryRun  -> ["--dry-run"]+    OnlyCfg -> ["--only-configure"]+    DoBuild -> []+  -- TODO: version check for cabal's --only-configure+  case qe of+    QueryEnv { qeDistDir = DistDirCabal cpt distdir, qeProjLoc } -> do+      let projdir = plCabalProjectDir qeProjLoc+      cmd <- return $ case stage of+        DryRun | SCV1 <- cpt ->+          CabalInstall.CIConfigure+          -- TODO: in v1 we configure twice because we do configure for+          -- DryRun and OnlyCfg.+        OnlyCfg ->+          CabalInstall.CIConfigure+        _ ->+          CabalInstall.CIBuild+      CabalInstall.callCabalInstallCmd qe (Just projdir) cmd $+        case cpt of+          SCV1 ->+            [ "--builddir="++distdir ]+          SCV2 -> do+            targets <- return $ case mu of+              Nothing -> ["all"]+              Just Unit{uImpl} -> concat+                [ if uiV2OnlyDependencies uImpl+                    then ["--only-dependencies"] else []+                , map snd $ filter ((/= ChSetupHsName) . fst) $ uiV2Components uImpl+                ]+            case qeProjLoc of+              ProjLocV2File {plCabalProjectFile} ->+                [ "--project-file="++plCabalProjectFile+                , "--builddir="++distdir+                ] ++ stage_opts ++ targets+              ProjLocV2Dir {} ->+                [ "--builddir="++distdir+                ] ++ stage_opts ++ targets++    QueryEnv { qeDistDir = DistDirStack mworkdir+             , qeProjLoc = qeProjLoc@ProjLocStackYaml {plStackYaml}+             } -> do+      let projdir = plStackProjectDir qeProjLoc+      let workdir_opts = Stack.workdirArg qe+      case mu of+        Just Unit{uPackage=Package{pSourceDir}} ->+          Stack.callStackCmd qe (Just pSourceDir) $+            workdir_opts +++            [ "--stack-yaml="++plStackYaml, "build", "."+            ] ++ stage_opts+        Nothing ->+          Stack.callStackCmd qe (Just projdir) $+            workdir_opts +++            [ "--stack-yaml="++plStackYaml, "build"+            ] ++ stage_opts++getFileModTime :: FilePath -> IO (FilePath, EpochTime)+getFileModTime f = do+  t <- modificationTime <$> getFileStatus f+  return (f, t)++readProjInfo+    :: QueryEnvI c pt -> ProjConf pt -> ProjConfModTimes -> PreInfo pt -> IO (ProjInfo pt)+readProjInfo qe pc pcm _pi = withVerbosity $ do+  let projloc = qeProjLoc qe+  case (qeDistDir qe, pc) of+    (DistDirCabal SCV1 distdir, ProjConfV1{pcV1CabalFile}) -> do+      setup_config_path <- canonicalizePath (distdir </> "setup-config")+      hdr@(UnitHeader (pkg_name_bs, _pkg_ver) ("Cabal", hdrCabalVersion) _)+          <- readSetupConfigHeader setup_config_path+      let+        v3_0_0_0 = makeVersion [3,0,0,0]+        pkg_name+          | hdrCabalVersion >= v3_0_0_0 = BSU.toString pkg_name_bs+          | otherwise = BS8.unpack pkg_name_bs+        pkg = Package+          { pPackageName = pkg_name+          , pSourceDir = plCabalProjectDir projloc+          , pCabalFile = CabalFile pcV1CabalFile+          , pFlags = []+          , pUnits = (:|[]) Unit+            { uUnitId = UnitId pkg_name+            , uPackage = pkg { pUnits = () }+            , uDistDir = DistDirLib distdir+            , uImpl = UnitImplV1+            }+          }+        piImpl = ProjInfoV1+          { piV1SetupHeader = hdr+          , piV1CabalVersion = CabalVersion hdrCabalVersion+          }+      return ProjInfo+        { piProjConfModTimes = pcm+        , piPackages = pkg :| []+        , piImpl+        }++    (DistDirCabal SCV2 distdirv2, _) -> do+      let plan_path = distdirv2 </> "cache" </> "plan.json"+      plan_mtime <- modificationTime <$> getFileStatus plan_path+      plan@PlanJson { pjCabalLibVersion=Ver pjCabalLibVersion+                    , pjCabalVersion+                    , pjCompilerId=PkgId (PkgName compName) (Ver compVer)+                    }+          <- decodePlanJson plan_path+      when (pjCabalVersion < Ver [2,4,1,0]) $+        panicIO $ "plan.json was produced by too-old a version of\+                  \cabal-install. The 'dist-dir' keys will be missing. \+                  \Please upgrade to at least cabal-instal-2.4.1.0"++      Just pkgs <- NonEmpty.nonEmpty <$> CabalInstall.planPackages plan+      return ProjInfo+        { piProjConfModTimes = pcm+        , piPackages = NonEmpty.sortWith pPackageName pkgs+        , piImpl = ProjInfoV2+          { piV2Plan = plan+          , piV2PlanModTime = plan_mtime+          , piV2CompilerId = (Text.unpack compName, makeDataVersion compVer)+          }+        }+    (DistDirStack{}, _) -> do+      Just cabal_files <- NonEmpty.nonEmpty <$> Stack.listPackageCabalFiles qe+      pkgs <- mapM (Stack.getPackage qe) cabal_files+      return ProjInfo+        { piProjConfModTimes = pcm+        , piPackages = NonEmpty.sortWith pPackageName pkgs+        , piImpl = ProjInfoStack+        }++readUnitInfo :: Helper pt -> Unit pt -> UnitModTimes -> IO UnitInfo+readUnitInfo helper u@Unit{uImpl=ui@UnitImplV2{uiV2Components}} umt+    | ChSetupHsName `elem` map fst uiV2Components = do+        let unit' = u {+          uImpl = ui+            { uiV2Components = filter ((/= ChSetupHsName) . fst) uiV2Components+            }+          }+        -- TODO: Add a synthetic UnitInfo for the setup executable. Cabal+        -- doesn't allow building it via a target on the cmdline and it+        -- doesn't really exist as far as setup-config is concerned but+        -- plan.json has the dependency versions for custom-setup so we+        -- should be able to represet that as a UnitInfo.+        readUnitInfo helper unit' umt+readUnitInfo helper unit@Unit {uUnitId=uiUnitId} uiModTimes = do+    res <- runHelper helper unit+           [ "package-id"+           , "compiler-id"+           , "flags"+           , "config-flags"+           , "non-default-config-flags"+           , "component-info"+           ]+    let [ Just (ChResponseVersion        uiPackageId),+          Just (ChResponseVersion        uiCompilerId),+          Just (ChResponseFlags          uiPackageFlags),+          Just (ChResponseFlags          uiConfigFlags),+          Just (ChResponseFlags          uiNonDefaultConfigFlags),+          Just (ChResponseComponentsInfo uiComponents)+          ] = res+    return $ UnitInfo {..}++readHelper+    :: QueryEnvI c pt+    -> FilePath+    -> CabalFile+    -> DistDirLib+    -> [String]+    -> IO [Maybe ChResponse]+readHelper qe exe cabal_file distdir args = do+  out <- invokeHelper qe exe cabal_file distdir args+  let res :: [Maybe ChResponse]+      res = read out+  liftIO $ evaluate res `E.catch` \ex@ErrorCall{} -> do+      md <- lookupEnv' "CABAL_HELPER_DEBUG"+      let msg = "readHelper: exception: '" ++ show ex ++ "'"+      panicIO $ msg ++ case md of+        Nothing -> "\n  for more information set the environment variable CABAL_HELPER_DEBUG and try again"+        Just _ -> "\n  output:\n'"++ out ++"'"++invokeHelper+    :: QueryEnvI c pt+    -> FilePath+    -> CabalFile+    -> DistDirLib+    -> [String]+    -> IO String+invokeHelper+  QueryEnv {..}+  exe+  (CabalFile cabal_file_path)+  (DistDirLib distdir)+  args0+  = do+    let args1 = cabal_file_path : distdir : args0+    evaluate =<< qeReadProcess "" Nothing [] exe args1 `E.catch`+      \(_ :: E.IOException) ->+        panicIO $ concat+          ["invokeHelper", ": ", exe, " "+          , intercalate " " (map show args1)+          , " failed!"+          ]++-- | Make sure the appropriate helper executable for the given project is+-- installed and ready to run queries.+--+-- The idea is you can run this at a convinient time instead of having the+-- helper compilation happen during a time-sensitive user interaction. This+-- will however happen automatically as needed if you don't run it first.+prepare :: Query pt ()+prepare = Query $ \qe -> do+  pre_info <- getPreInfo qe+  proj_info <- getProjInfo qe+  cabal_ver <- getCabalLibVersion qe Haven'tReconfigured proj_info+  void $ getHelper qe pre_info proj_info cabal_ver++-- | Create @cabal_macros.h@, @Paths_\<pkg\>.hs@ and other generated files+-- in the usual place. See 'Distribution.Simple.Build.initialBuildSteps'.+--+-- This is usually only needed on the first load of a unit or after the+-- cabal file changes.+writeAutogenFiles :: Unit pt -> Query pt ()+writeAutogenFiles unit = Query $ \qe -> do+  pre_info <- getPreInfo qe+  proj_info <- getProjInfo qe+  cabal_ver <- getCabalLibVersion qe Haven'tReconfigured proj_info+  helper <- getHelper qe pre_info proj_info cabal_ver+  void $ runHelper helper unit ["write-autogen-files"]++-- | Get the path to the sandbox package-db in a project+getSandboxPkgDb+    :: String+    -- ^ Cabal build platform, i.e. @buildPlatform@+    -> GHC.GhcVersion+    -- ^ GHC version (@cProjectVersion@ is your friend)+    -> FilePath+    -- ^ Path to the project directory, i.e. a directory containing a+    -- @cabal.sandbox.config@ file+    -> IO (Maybe FilePath)+getSandboxPkgDb buildPlat ghcVer projdir =+  CabalHelper.Compiletime.Sandbox.getSandboxPkgDb buildPlat ghcVer projdir++buildPlatform :: String+buildPlatform = display Distribution.System.buildPlatform++lookupEnv' :: String -> IO (Maybe String)+lookupEnv' k = lookup k <$> getEnvironment++withVerbosity :: (Verbose => IO a) -> IO a+withVerbosity act = do+  x <- lookup  "CABAL_HELPER_DEBUG" <$> getEnvironment+  let ?verbose = \level ->+        case x >>= readMaybe of+          Just x | x >= level -> True+          _ -> False+  act++getConfProgs :: QueryEnvI (QCProgs a b) pt -> IO Programs+getConfProgs qe = do+  pre_info <- getPreInfo qe+  cached qe $ Cached+    { cGet = qcConfProgs+    , cSet = \a b -> a { qcConfProgs = Just b }+    , cGetKey = const Nothing+    , cSetKey = const+    , cCheckKey = return (qePrograms qe)+    , cKeyValid = (==)+    , cRegen = \_k -> configurePrograms qe pre_info+    }++-- | Fixup program paths as appropriate for current project-type and bring+-- 'Programs' into scope as an implicit parameter.+configurePrograms :: QueryEnvI c pt -> PreInfo pt -> IO Programs+configurePrograms qe@QueryEnv{..} pre_info = withVerbosity $ do+  patchBuildToolProgs (projTypeOfQueryEnv qe) <=< guessCompProgramPaths $+    case pre_info of+      PreInfoStack projPaths ->+        Stack.patchCompPrograms projPaths qePrograms+      _ -> qePrograms++newtype Helper pt+  = Helper { runHelper :: Unit pt -> [String] -> IO [Maybe ChResponse] }++getHelper :: QueryEnvI c pt -> PreInfo pt -> ProjInfo pt -> CabalVersion -> IO (Helper pt)+getHelper qe@QueryEnv{..} _pre_info _proj_info cabal_ver+  | cabal_ver == bultinCabalVersion = return $ Helper $+      \Unit{ uDistDir=DistDirLib distdir+           , uPackage=Package{pCabalFile=CabalFile cabal_file}+           } args ->+        let pt = dispHelperProjectType (projTypeOfQueryEnv qe) in+        helper_main $ cabal_file : distdir : pt : args+getHelper qe@QueryEnv{..} pre_info proj_info cabal_ver = do+  withVerbosity $ do+    let ?progs = qePrograms+    t0 <- Clock.getTime Monotonic+    eexe <- compileHelper $ mkCompHelperEnv qeProjLoc qeDistDir pre_info proj_info cabal_ver+    t1 <- Clock.getTime Monotonic+    let dt = (/10^9) $ fromInteger $ Clock.toNanoSecs $ Clock.diffTimeSpec t0 t1+        dt :: Float+    vLog $ printf "compileHelper took %.5fs" dt+    case eexe of+      Left rv ->+        panicIO $ "compileHelper': compiling helper failed! exit code "++ show rv+      Right exe ->+        let pt = dispHelperProjectType (projTypeOfQueryEnv qe) in+        return $ Helper $ \Unit{uDistDir, uPackage=Package{pCabalFile}} args ->+          readHelper qe exe pCabalFile uDistDir (pt : args)++dispHelperProjectType :: SProjType pt -> String+dispHelperProjectType (SCabal SCV1) = "v1"+--  ^ v1-build needs a last minute addition of the inplace package-db+-- beyond what lbi has+dispHelperProjectType (SCabal SCV2) = "v2"+dispHelperProjectType SStack        = "v2"+--  ^ stack also embeds all necessary options into lbi like v2++mkCompHelperEnv+    :: Verbose+    => ProjLoc pt+    -> DistDir pt+    -> PreInfo pt+    -> ProjInfo pt+    -> CabalVersion+    -> CompHelperEnv+mkCompHelperEnv+  projloc+  (DistDirCabal SCV1 distdir)+  PreInfoCabal+  ProjInfo {}+  cabal_ver+  = CompHelperEnv+    { cheCabalVer = cabal_ver+    , cheProjDir  = plCabalProjectDir projloc+    , cheProjLocalCacheDir = distdir+    , chePkgDb    = []+    , chePjUnits = Nothing+    , cheDistV2 = Nothing+    }+mkCompHelperEnv+  projloc+  (DistDirCabal SCV2 distdir)+  PreInfoCabal+  ProjInfo{piImpl=ProjInfoV2{piV2Plan=plan}}+  cabal_ver+  = CompHelperEnv {..}+  where+    cheProjDir  = plCabalProjectDir projloc+    cheCabalVer = cabal_ver+    cheProjLocalCacheDir = distdir </> "cache"+    chePkgDb    = []+    chePjUnits  = Just $ pjUnits plan+    cheDistV2   = Just distdir+mkCompHelperEnv+  (ProjLocStackYaml stack_yaml)+  (DistDirStack mworkdir)+  PreInfoStack+    { piStackProjPaths=StackProjPaths+      { sppGlobalPkgDb, sppSnapPkgDb, sppLocalPkgDb }+    }+  ProjInfo {}+  cabal_ver+  = let workdir = fromMaybe ".stack-work" $ unRelativePath <$> mworkdir in+    let projdir = takeDirectory stack_yaml in+    CompHelperEnv+    { cheCabalVer = cabal_ver+    , cheProjDir  = projdir+    , cheProjLocalCacheDir = projdir </> workdir+    , chePkgDb    = [sppGlobalPkgDb, sppSnapPkgDb, sppLocalPkgDb]+    , chePjUnits = Nothing+    , cheDistV2 = Nothing+    }
+ lib/Distribution/Helper/Discover.hs view
@@ -0,0 +1,96 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2019  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE GADTs, TypeFamilies, DataKinds #-}++{-|+Module      : Distribution.Helper.Discover+Description : Finding project contexts+License     : Apache-2.0+Maintainer  : cabal-helper@dxld.at+Portability : portable+-}++-- TODO: $ sed -e s/DistDir/BuildDir/++module Distribution.Helper.Discover+  ( findProjects+  , getDefaultDistDir+  , isValidDistDir+  ) where++import Control.Monad.Writer+import System.Directory+import System.FilePath++import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Cabal++-- | @findProjects dir@. Find available project instances in @dir@.+--+-- For example, if the given directory contains both a @cabal.project@ and+-- a @stack.yaml@ file:+--+-- >>> findProjects "."+-- [ Ex (ProjLocStackYaml "./stack.yaml"), Ex (ProjLocCabalV2File "./cabal.project") ]+--+-- Note that this function only looks for "default" project markers. If you+-- want to for example support the common pattern of having multiple+-- @stack-<GHC_VER>.yaml@ files simply fill out a 'ProjLoc' yourself. In+-- this case 'ProjLocStackYaml'.+findProjects :: FilePath -> IO [Ex ProjLoc]+findProjects dir = execWriterT $ do+  let cabalProject = dir </> "cabal.project"+  whenM (liftIO $ doesFileExist cabalProject) $+    tell [Ex $ ProjLocV2File cabalProject dir]+  let stackYaml = dir </> "stack.yaml"+  whenM (liftIO $ doesFileExist stackYaml) $+    tell [Ex $ ProjLocStackYaml stackYaml]+  maybeCabalDir <- liftIO (fmap takeDirectory <$> findCabalFile dir)+  forM_ [Ex . ProjLocV2Dir, Ex . ProjLocV1Dir] $ \proj -> traverse (tell . pure . proj) maybeCabalDir+++-- | @getDefaultDistDir pl@. Get the default dist-dir for the given project.+--+-- Note that the path in the returned dist-dir might not exist yet if the+-- build-tool has never been run for this project before. This is fine as+-- far as @cabal-helper@ is concerned. It will simply invoke the build-tool+-- as needed to answer the requested queries.+getDefaultDistDir :: ProjLoc pt -> DistDir pt+getDefaultDistDir (ProjLocV1CabalFile _cabal_file pkgdir) =+  DistDirCabal SCV1 $ pkgdir </> "dist"+getDefaultDistDir (ProjLocV1Dir pkgdir) =+  DistDirCabal SCV1 $ pkgdir </> "dist"+getDefaultDistDir (ProjLocV2File _cabal_project projdir) =+  DistDirCabal SCV2 $ projdir </> "dist-newstyle"+getDefaultDistDir (ProjLocV2Dir projdir) =+  DistDirCabal SCV2 $ projdir </> "dist-newstyle"+getDefaultDistDir (ProjLocStackYaml _) =+  DistDirStack Nothing++-- | @isValidDistDir distdir@. Check if @distdir@ looks like a valid+-- build-dir for it's project type. We just check if characteristic marker+-- files for the associated project type exist.+--+-- If the project type does not have a way to do this (for example+-- 'DistDirStack') check we return 'Nothing'.+isValidDistDir :: DistDir pt -> IO (Maybe Bool)+isValidDistDir (DistDirCabal cpt dir) = do+  fmap Just $ doesFileExist $ dir </> cabalProjTypeMarkerFile cpt+isValidDistDir DistDirStack{} =+  return Nothing++cabalProjTypeMarkerFile :: SCabalProjType pt -> FilePath+cabalProjTypeMarkerFile SCV1 = "setup-config"+cabalProjTypeMarkerFile SCV2 = "cache" </> "plan.json"++whenM :: Monad m => m Bool -> m () -> m ()+whenM p x = p >>= (`when` x)
+ os/posix/Symlink.hs view
@@ -0,0 +1,2 @@+module Symlink (createSymbolicLink) where+import System.Posix.Files (createSymbolicLink)
+ os/win/Symlink.hs view
@@ -0,0 +1,3 @@+module Symlink (createSymbolicLink) where+import System.Win32.SymbolicLink (createSymbolicLinkFile)+createSymbolicLink = createSymbolicLinkFile
+ src/CabalHelper/Compiletime/Cabal.hs view
@@ -0,0 +1,256 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Program.Cabal+Description : Cabal library source unpacking+License     : Apache-2.0+-}++{-# LANGUAGE DeriveFunctor, ViewPatterns, OverloadedStrings #-}+{-# LANGUAGE CPP #-} -- for VERSION_Cabal++module CabalHelper.Compiletime.Cabal where++import Data.Char+import Control.Exception+import Data.List+import Data.Maybe+import Data.Time.Calendar+import Data.Time.Clock+import Data.Time.Clock.POSIX+import Data.Version+import System.Directory+import System.FilePath+import System.IO+import Text.Printf++import Distribution.Verbosity (Verbosity, silent, normal, verbose, deafening)++import qualified Data.ByteString as BS+import qualified Data.ByteString.Char8 as BS8++import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Types.Cabal+import CabalHelper.Compiletime.Process+import CabalHelper.Shared.Common (replace, parseVer, parseVerMay, parsePkgIdBS, panicIO)++data CabalPatchDescription = CabalPatchDescription+  { cpdVersions      :: [Version]+  , cpdUnpackVariant :: UnpackCabalVariant+  , cpdPatchFn       :: FilePath -> IO ()+  }++nopCabalPatchDescription :: CabalPatchDescription+nopCabalPatchDescription =+  CabalPatchDescription [] LatestRevision (const (return ()))++patchyCabalVersions :: [CabalPatchDescription]+patchyCabalVersions = [+  let versions  = [ Version [1,18,1] [] ]+      variant   = Pristine+      patch     = fixArrayConstraint+  in CabalPatchDescription versions variant patch,++  let versions  = [ Version [1,18,0] [] ]+      variant   = Pristine+      patch dir = do+        fixArrayConstraint dir+        fixOrphanInstance dir+  in CabalPatchDescription versions variant patch,++  let versions  = [ Version [1,24,1,0] [] ]+      variant   = Pristine+      patch _   = return ()+  in CabalPatchDescription versions variant patch+  ]+ where+   fixArrayConstraint dir = do+     let cabalFile    = dir </> "Cabal.cabal"+         cabalFileTmp = cabalFile ++ ".tmp"++     cf <- readFile cabalFile+     writeFile cabalFileTmp $ replace "&& < 0.5" "&& < 0.6" cf+     renameFile cabalFileTmp cabalFile++   fixOrphanInstance dir = do+     let versionFile    = dir </> "Distribution/Version.hs"+         versionFileTmp = versionFile ++ ".tmp"++     let languagePragma =+           "{-# LANGUAGE DeriveDataTypeable, StandaloneDeriving #-}"+         languagePragmaCPP =+           "{-# LANGUAGE CPP, DeriveDataTypeable, StandaloneDeriving #-}"++         derivingDataVersion =+           "deriving instance Data Version"+         derivingDataVersionCPP = unlines [+             "#if __GLASGOW_HASKELL__ < 707",+             derivingDataVersion,+             "#endif"+           ]++     vf <- readFile versionFile+     writeFile versionFileTmp+       $ replace derivingDataVersion derivingDataVersionCPP+       $ replace languagePragma languagePragmaCPP vf++     renameFile versionFileTmp versionFile++unpackPatchedCabal :: Env => Version -> FilePath -> IO CabalSourceDir+unpackPatchedCabal cabalVer tmpdir = do+    res@(CabalSourceDir dir) <- unpackCabalHackage cabalVer tmpdir variant+    patch dir+    return res+  where+    CabalPatchDescription _ variant patch = fromMaybe nopCabalPatchDescription $+      find ((cabalVer `elem`) . cpdVersions) patchyCabalVersions++-- legacy, for `installCabalLib` v1+unpackCabalV1+  :: Env+  => UnpackedCabalVersion+  -> FilePath+  -> IO CabalSourceDir+unpackCabalV1 (CabalVersion ver) tmpdir = do+  csdir <- unpackPatchedCabal ver tmpdir+  return csdir+unpackCabalV1 (CabalHEAD (_commit, csdir)) _tmpdir =+  return csdir++unpackCabal :: Env => CabalVersion -> FilePath -> IO UnpackedCabalVersion+unpackCabal (CabalVersion ver) _tmpdir = do+  return $ CabalVersion ver+unpackCabal (CabalHEAD ()) tmpdir = do+  (commit, csdir) <- unpackCabalHEAD tmpdir+  return $ CabalHEAD (commit, csdir)++unpackCabalHackage+    :: (Verbose, Progs)+    => Version+    -> FilePath+    -> UnpackCabalVariant+    -> IO CabalSourceDir+unpackCabalHackage cabalVer tmpdir variant = do+  let cabal = "Cabal-" ++ showVersion cabalVer+      dir = tmpdir </> cabal+      variant_opts = case variant of Pristine -> [ "--pristine" ]; _ -> []+      args = [ "get", cabal ] ++ variant_opts+  callProcessStderr (Just tmpdir) [] (cabalProgram ?progs) args+  return $ CabalSourceDir dir++unpackCabalHEAD :: Env => FilePath -> IO (CommitId, CabalSourceDir)+unpackCabalHEAD tmpdir = do+  let dir = tmpdir </> "cabal-head.git"+      url = "https://github.com/haskell/cabal.git"+  callProcessStderr (Just "/") [] "git" [ "clone", "--depth=1", url, dir]+  callProcessStderr (Just (dir </> "Cabal")) [] "cabal"+    [ "act-as-setup", "--", "sdist"+    , "--output-directory=" ++ tmpdir </> "Cabal" ]+  commit <- takeWhile isHexDigit <$>+    readCreateProcess (proc "git" ["rev-parse", "HEAD"]){ cwd = Just dir } ""+  ts <-+    readCreateProcess (proc "git" [ "show", "-s", "--format=%ct", "HEAD" ])+      { cwd = Just dir } ""+  let ut = posixSecondsToUTCTime $ fromInteger (read ts)+      (y,m,d) = toGregorian $ utctDay ut+      sec = round $ utctDayTime ut; sec :: Int+      datecode = makeVersion [1000, fromInteger y, m, d, sec]+  let cabal_file = tmpdir </> "Cabal/Cabal.cabal"+  cf0 <- readFile cabal_file+  let Just cf1 = replaceVersionDecl (const (Just datecode)) cf0+  writeFile (cabal_file<.>"tmp") cf1+  renameFile (cabal_file<.>"tmp") cabal_file+  return (CommitId commit, CabalSourceDir $ tmpdir </> "Cabal")++-- | Replace the version declaration in a cabal file+replaceVersionDecl :: (Version -> Maybe Version) -> String -> Maybe String+replaceVersionDecl ver_fn cf = let+  isVersionDecl ([],t) = "version:" `isPrefixOf` t+  isVersionDecl (i,t) = "\n" `isSuffixOf` i && "version:" `isPrefixOf` t+  Just (before_ver,m) = find isVersionDecl $ splits cf+  Just (ver_decl,after_ver)+    = find (\s -> case s of (_i,'\n':x:_) -> not $ isSpace x; _ -> False)+    $ filter (\(_i,t) -> "\n" `isPrefixOf` t)+    $ splits m+  Just vers0 = dropWhile isSpace <$> stripPrefix "version:" ver_decl+  (vers1,rest) = span (\c -> isDigit c || c == '.') vers0+  Just verp | all isSpace rest = parseVerMay $ vers1 in do+  new_ver <- ver_fn verp+  return $ concat+    [ before_ver, "version: ", showVersion new_ver, after_ver ]+  where+    splits xs = inits xs `zip` tails xs++resolveCabalVersion :: Verbose => CabalVersion -> IO ResolvedCabalVersion+resolveCabalVersion (CabalVersion ver) = return $ CabalVersion ver+resolveCabalVersion (CabalHEAD ()) = do+  out <- readProcess' "git"+    [ "ls-remote", "https://github.com/haskell/cabal.git", "-h", "master" ] ""+  let commit = takeWhile isHexDigit out+  return $ CabalHEAD $ CommitId commit++findCabalFile :: FilePath -> IO (Maybe FilePath)+findCabalFile pkgdir = do+    cfiles <- filter isCabalFile <$> getDirectoryContents pkgdir+    case cfiles of+      [] -> return Nothing+      [cfile] -> return $ Just $ pkgdir </> cfile+      _ -> panicIO $ "Multiple cabal-files found in directory '"+             ++pkgdir++"': " ++ show cfiles+  where+    isCabalFile :: FilePath -> Bool+    isCabalFile f = takeExtension' f == ".cabal"++    takeExtension' :: FilePath -> String+    takeExtension' p =+        if takeFileName p == takeExtension p+          then "" -- just ".cabal" is not a valid cabal file+          else takeExtension p++complainIfNoCabalFile :: FilePath -> Maybe FilePath -> IO FilePath+complainIfNoCabalFile _ (Just cabal_file) = return cabal_file+complainIfNoCabalFile pkgdir Nothing =+  panicIO $ "No cabal file found in package-dir: '"++pkgdir++"'"++bultinCabalVersion :: CabalVersion+bultinCabalVersion = CabalVersion $ parseVer VERSION_Cabal++readSetupConfigHeader :: FilePath -> IO UnitHeader+readSetupConfigHeader file = bracket (openFile file ReadMode) hClose $ \h -> do+  mhdr <- parseSetupHeader <$> BS.hGetLine h+  case mhdr of+    Just hdr@(UnitHeader _PkgId ("Cabal", _hdrCabalVersion) _compId) -> do+      return hdr+    Just UnitHeader {uhSetupId=(setup_name, _)} -> panicIO $+      printf "Unknown Setup package-id in setup-config header '%s': '%s'"+        (BS8.unpack setup_name) file+    Nothing -> panicIO $+      printf "Could not read '%s' header" file+++parseSetupHeader :: BS.ByteString -> Maybe UnitHeader+parseSetupHeader header = case BS8.words header of+  ["Saved", "package", "config", "for", pkgId ,+   "written", "by", setupId,+   "using", compId]+    -> UnitHeader+       <$> parsePkgIdBS pkgId+       <*> parsePkgIdBS setupId+       <*> parsePkgIdBS compId+  _ -> Nothing++getCabalVerbosity :: Verbose => Verbosity+getCabalVerbosity+  | ?verbose 2 = normal+  | ?verbose 3 = verbose+  | ?verbose 4 = deafening+  | otherwise = silent
+ src/CabalHelper/Compiletime/CompPrograms.hs view
@@ -0,0 +1,104 @@+{-# LANGUAGE GADTs #-}++module CabalHelper.Compiletime.CompPrograms where++import Control.Monad (when)+import Data.List+import Data.Maybe+import System.Directory+import System.FilePath+import System.IO.Temp++import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Cabal (getCabalVerbosity)+import CabalHelper.Shared.Common (panicIO)+import Symlink (createSymbolicLink)++import Distribution.Simple.GHC as GHC (configure)++import qualified Distribution.Simple.Program as ProgDb+  ( lookupProgram, lookupKnownProgram, programPath+  , configureProgram, userMaybeSpecifyPath+  , ghcProgram, ghcPkgProgram, haddockProgram )+import qualified Distribution.Simple.Program.Db as ProgDb++-- | Determine ghc-pkg/haddock path from ghc path+guessCompProgramPaths :: Verbose => Programs -> IO Programs+guessCompProgramPaths progs = do+  let v = getCabalVerbosity+      getMaybeProg' = getMaybeProg progs+      progdb =+        ProgDb.userMaybeSpecifyPath "ghc" (getMaybeProg' ghcProgram) $+        ProgDb.userMaybeSpecifyPath "ghc-pkg" (getMaybeProg' ghcPkgProgram) $+        ProgDb.userMaybeSpecifyPath "haddock" (getMaybeProg' haddockProgram) $+        ProgDb.defaultProgramDb+  (_compiler, _mplatform, progdb1) <- GHC.configure v Nothing Nothing progdb+  let Just haddockKnownProgram = ProgDb.lookupKnownProgram "haddock" progdb1+  progdb2 <- ProgDb.configureProgram v haddockKnownProgram progdb1+  let getProg p = ProgDb.programPath <$> ProgDb.lookupProgram p progdb2+  return progs+    { ghcProgram =+        fromMaybe (ghcProgram progs) $ getProg ProgDb.ghcProgram+    , ghcPkgProgram =+        fromMaybe (ghcPkgProgram progs) $ getProg ProgDb.ghcPkgProgram+    , haddockProgram =+        fromMaybe (haddockProgram progs) $ getProg ProgDb.haddockProgram+    }++getMaybeProg :: Programs -> (Programs -> FilePath) -> Maybe FilePath+getMaybeProg progs fn+    | fn progs == fn defaultPrograms = Nothing+    | otherwise = Just (fn progs)++patchBuildToolProgs :: SProjType pt -> Programs -> IO Programs+patchBuildToolProgs (SCabal _) progs = return progs+  { cabalUnitArgs = concat+    [ maybeToList (("--with-ghc="++) <$> getMaybeProg progs ghcProgram)+    , maybeToList (("--with-ghc-pkg="++) <$> getMaybeProg progs ghcPkgProgram)+    , maybeToList (("--with-haddock="++) <$> getMaybeProg progs haddockProgram)+    ] ++ cabalUnitArgs progs+  }+patchBuildToolProgs SStack progs+  -- optimization; if none of the program paths are non-default we don't+  -- even have to add anything to PATH.+  | ghcProgram progs == "ghc"+  , ghcPkgProgram progs == "ghc-pkg"+  , haddockProgram progs == "haddock"+  = return progs++  -- optimization; if all paths are unqualified and have the same version+  -- postfix Stack's default behaviour works for us.+  | [ghc] <- splitPath (ghcProgram progs)+  , [ghcPkg] <- splitPath (ghcPkgProgram progs)+  , [haddock] <- splitPath (haddockProgram progs)+  , Just ver <- stripPrefix "ghc-" ghc+  , Just ver == stripPrefix "ghc-pkg-" ghcPkg+  , Just ver == stripPrefix "haddock-" haddock+  = return progs+patchBuildToolProgs SStack progs = do+  -- otherwise fall back to creating a symlink farm+  --+  -- This is of course all quite horrible and we would much prefer just+  -- being able to pass executable paths straight through to stack but+  -- currently there is no option to let us do that.+  withSystemTempDirectory "cabal-helper-symlinks" $ \bindir -> do+  createProgSymlink True bindir $ ghcProgram progs+  createProgSymlink True bindir $ ghcPkgProgram progs+  createProgSymlink False bindir $ haddockProgram progs+  return $ progs+    { stackEnv =+        [("PATH", EnvPrepend $ bindir ++ [searchPathSeparator])] +++        stackEnv progs+    }++createProgSymlink :: Bool -> FilePath -> FilePath -> IO ()+createProgSymlink required bindir target+  | [exe] <- splitPath target = do+    mb_exe_path <- findExecutable exe+    case mb_exe_path of+      Just exe_path -> createSymbolicLink exe_path (bindir </> takeFileName target)+      Nothing -> when required $ panicIO $ "Error trying to create symlink to '" ++ target ++ "': "+                                        ++ "'" ++ exe ++ "'" ++ " executable not found."+  | otherwise = do+    cwd <- getCurrentDirectory+    createSymbolicLink (cwd </> target) (bindir </> takeFileName target)
+ src/CabalHelper/Compiletime/Compat/Environment.hs view
@@ -0,0 +1,30 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2017  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE CPP #-}+module CabalHelper.Compiletime.Compat.Environment where++import qualified System.Environment+#ifndef mingw32_HOST_OS+import qualified System.Posix.Env (setEnv)+#endif++lookupEnv :: String -> IO (Maybe String)+lookupEnv var =+  do env <- System.Environment.getEnvironment+     return (lookup var env)++setEnv :: String -> String -> IO ()+#ifdef mingw32_HOST_OS+setEnv = System.Environment.setEnv+#else+setEnv k v = System.Posix.Env.setEnv k v True+#endif
+ src/CabalHelper/Compiletime/Compat/Parsec.hs view
@@ -0,0 +1,36 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE CPP #-}+module CabalHelper.Compiletime.Compat.Parsec+    ( absorbParsecFailure+    , eitherParsec+    ) where++#if MIN_VERSION_Cabal(2,5,0)+import Distribution.Parsec+#else+import qualified Distribution.Compat.ReadP as Dist+import Distribution.Text+#endif++absorbParsecFailure :: String -> Either String a -> a+absorbParsecFailure _ (Right x) = x+absorbParsecFailure ctx (Left err) =+    error $ "Error parsing in '"++ctx++"': " ++ err++#if !MIN_VERSION_Cabal(2,5,0)+eitherParsec :: Text t => String -> Either String t+eitherParsec i =+  case filter ((=="") . snd) $ Dist.readP_to_S parse i of+    (a,""):[] -> Right a+    _ -> Left $ show i+#endif
+ src/CabalHelper/Compiletime/Compat/Version.hs view
@@ -0,0 +1,44 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2017-2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE CPP #-}+module CabalHelper.Compiletime.Compat.Version+    ( DataVersion+    , toDataVersion+    , fromDataVersion+    , Data.Version.showVersion+    , makeDataVersion+    ) where++import qualified Data.Version+import qualified Distribution.Version (Version)+#if MIN_VERSION_Cabal(2,0,0)+import qualified Distribution.Version  (versionNumbers, mkVersion)+#endif++type DataVersion = Data.Version.Version++toDataVersion :: Distribution.Version.Version -> Data.Version.Version+fromDataVersion :: Data.Version.Version -> Distribution.Version.Version+#if MIN_VERSION_Cabal(2,0,0)+toDataVersion v = Data.Version.Version (Distribution.Version.versionNumbers v) []+fromDataVersion (Data.Version.Version vs _) = Distribution.Version.mkVersion vs+#else+toDataVersion = id+fromDataVersion = id+#endif++makeDataVersion :: [Int] -> Data.Version.Version+#if MIN_VERSION_base(4,8,0)+makeDataVersion = Data.Version.makeVersion+#else+makeDataVersion xs = Data.Version.Version xs []+#endif
+ src/CabalHelper/Compiletime/Compile.hs view
@@ -0,0 +1,477 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE DeriveFunctor, GADTs, ScopedTypeVariables #-}++{-|+Module      : CabalHelper.Compiletime.Compile+Description : Runtime compilation machinery+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Compile where++import qualified Cabal.Plan as CP+import Cabal.Plan+  ( PkgId(..), PkgName(..), Ver(..), uPId)+import Control.Applicative+import Control.Arrow+import Control.Exception as E+import Control.Monad+import Control.Monad.Trans.Maybe+import Control.Monad.IO.Class+import Data.Char+import Data.List+import Data.Map.Strict (Map)+import Data.Maybe+import Data.String+import Data.Version+import Text.Printf+import qualified System.Clock as Clock+import System.Directory+import System.FilePath+import System.Exit+import System.IO+import System.IO.Temp+import Prelude++import qualified Data.Text as Text+import qualified Data.Map.Strict as Map++import Distribution.System+  ( buildPlatform )+import Distribution.Text+  ( display )++import CabalHelper.Compiletime.Cabal+import CabalHelper.Compiletime.Data+import CabalHelper.Compiletime.Log+import CabalHelper.Compiletime.Program.GHC+import CabalHelper.Compiletime.Program.CabalInstall+import CabalHelper.Compiletime.Sandbox+    ( getSandboxPkgDb )+import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Types.Cabal++import CabalHelper.Shared.Common++import Paths_cabal_helper (version)+++data Compile+    = CompileWithCabalSource+      { compCabalSourceDir     :: !CabalSourceDir+      , compCabalSourceVersion :: !Version+      }+    | CompileWithCabalPackage+      { compPackageSource  :: !GhcPackageSource+      , compCabalVersion   :: !ResolvedCabalVersion+      , compProductTarget  :: !CompilationProductScope+      }++data CompPaths = CompPaths+    { compBuildDir:: !FilePath+    , compOutDir  :: !FilePath+    , compExePath :: !FilePath+    }++-- | The Helper executable we produce as a compilation product can either be+-- placed in a per-project location, or a per-user/global location in the user's+-- home directory. This type controls where the compilation process places the+-- executable.+data CompilationProductScope = CPSGlobal | CPSProject++type CompHelperEnv = CompHelperEnv' CabalVersion+data CompHelperEnv' cv = CompHelperEnv+  { cheCabalVer :: !cv+  , chePkgDb    :: ![PackageDbDir]+  -- ^ A package-db where we are guaranteed to find Cabal-`cheCabalVer`.+  , cheProjDir  :: !FilePath+  , chePjUnits  :: !(Maybe (Map CP.UnitId CP.Unit))+  , cheDistV2   :: !(Maybe FilePath)+  , cheProjLocalCacheDir :: FilePath+  }++compileHelper+    :: Env => CompHelperEnv -> IO (Either ExitCode FilePath)+compileHelper che@CompHelperEnv {cheCabalVer} = do+  withSystemTempDirectory "cabal-helper.compile-tmp" $ \tmpdir -> do+    ucv <- unpackCabal cheCabalVer tmpdir+    compileHelper' che { cheCabalVer = ucv }++compileHelper'+    :: Env+    => CompHelperEnv' UnpackedCabalVersion+    -> IO (Either ExitCode FilePath)+compileHelper' CompHelperEnv {..} = do+  ghcVer <- ghcVersion+  Just (prepare, comp) <- case cheCabalVer of+    cabalVer@CabalHEAD {} -> runMaybeT $ msum  $ map (\f -> f ghcVer cabalVer)+      [ compileWithCabalV2GhcEnv'+      , compileWithCabalInPrivatePkgDb'+      ]+    CabalVersion cabalVerPlain -> do+      runMaybeT $ msum $ map (\f -> f ghcVer cabalVerPlain) $+        case chePkgDb of+          [] ->+            [ compileWithCabalV2Inplace+            , compileWithCabalV2GhcEnv+            , compileCabalSource+            , compileSandbox+            , compileGlobal+            , compileWithCabalInPrivatePkgDb+            ]+          dbs ->+            [ ((.).(.)) liftIO (compilePkgDbs dbs)+            ]+  appdir <- appCacheDir+  let cp@CompPaths {compExePath} = compPaths appdir cheProjLocalCacheDir comp+  helper_exists <- doesFileExist compExePath+  rv <- if helper_exists+    then do+      vLog $ "helper already compiled, using exe: "++compExePath+      return (Right compExePath)+    else do+      vLog $ "helper exe does not exist, compiling "++compExePath+      prepare >> compile cp comp+  return rv+++  where+   logMsg = "using helper compiled with Cabal from "++-- for relaxed deps: find (sameMajorVersionAs cheCabalVer) . reverse . sort++   compilePkgDbs dbs _ghcVer cabalVer = return $+       (,)+         (pure ())+         CompileWithCabalPackage+           { compPackageSource = GPSPackageDBs dbs+           , compCabalVersion  = CabalVersion cabalVer+           , compProductTarget = CPSProject+           }++   -- | Check if this version is globally available+   compileGlobal :: Env => gv -> Version -> MaybeT IO (IO (), Compile)+   compileGlobal _ghcVer cabalVer = do+       cabal_versions <- listCabalVersions Nothing+       _ <- MaybeT $ return $ find (== cabalVer) cabal_versions+       vLog $ logMsg ++ "user/global package-db"+       return $ (return (), compileWithPkg GPSAmbient cabalVer CPSGlobal)++   -- | Check if this version is available in the project sandbox+   compileSandbox :: Env => GhcVersion -> Version -> MaybeT IO (IO (), Compile)+   compileSandbox  ghcVer cabalVer = do+       let mdb_path = getSandboxPkgDb (display buildPlatform) ghcVer cheProjDir+       sandbox <- PackageDbDir <$> MaybeT mdb_path+       cabal_versions <- listCabalVersions (Just sandbox)+       _ <- MaybeT $ return $ find (== cabalVer) cabal_versions+       vLog $ logMsg ++ "sandbox package-db"+       return $ (return (), compileWithPkg (GPSPackageDBs [sandbox]) cabalVer CPSProject)++   -- | Check if the requested Cabal version is available in a v2-build+   -- project's inplace package-db.+   --+   -- This is likely only the case if Cabal was vendored by this project or if+   -- we're operating on Cabal itself!+   compileWithCabalV2Inplace :: Env => GhcVersion -> Version -> MaybeT IO (IO (), Compile)+   compileWithCabalV2Inplace ghcVer cabalVer = do+       -- TODO: Test coverage! Neither compile-test nor ghc-session test out+       -- this code path+       pjUnits <- maybe mzero pure chePjUnits+       distdir_newstyle <- maybe mzero pure cheDistV2+       let cabal_pkgid =+             PkgId (PkgName (Text.pack "Cabal")) (Ver $ versionBranch cabalVer)+           mcabal_unit = listToMaybe $+             Map.elems $ Map.filter (\CP.Unit{..} -> uPId == cabal_pkgid) pjUnits+       CP.Unit {} <- maybe mzero pure mcabal_unit+       let inplace_db_path = distdir_newstyle+             </> "packagedb" </> ("ghc-" ++ showGhcVersion ghcVer)+           inplace_db = PackageDbDir inplace_db_path+       cabal_versions <- listCabalVersions (Just inplace_db)+       _ <- MaybeT $ return $ find (== cabalVer) cabal_versions+       vLog $ logMsg ++ "v2-build package-db " ++ inplace_db_path+       return $ (return (), compileWithPkg (GPSPackageDBs [inplace_db]) cabalVer CPSProject)++   compileWithCabalV2GhcEnv :: Env => GhcVersion -> Version -> MaybeT IO (IO (), Compile)+   compileWithCabalV2GhcEnv ghcVer cabalVer =+     compileWithCabalV2GhcEnv' ghcVer (CabalVersion cabalVer)++   -- TODO: Support using existing ghc-environments too! That's mostly+   -- relevant for when you want to use a development version of+   -- cabal-install since that will depend on an unreleased version of+   -- Cabal we cannot new-install just like that.++   -- | If this is a v2-build project it makes sense to use @v2-install@ for+   -- installing Cabal as this will use the @~/.cabal/store@. We use+   -- @--package-env@ to instruct cabal to not meddle with the user's package+   -- environment.+   compileWithCabalV2GhcEnv' :: Env => GhcVersion -> UnpackedCabalVersion -> MaybeT IO (IO (), Compile)+   compileWithCabalV2GhcEnv' ghcVer cabalVer = do+       _ <- maybe mzero pure cheDistV2 -- bail if this isn't a v2-build project+       CabalInstallVersion instVer <- liftIO cabalInstallVersion+       guard $ instVer >= (Version [2,4,1,0] [])+       --  ^ didn't test with older versions+       guard $ ghcVer  >= (GhcVersion (Version [8,0] []))+       env@(PackageEnvFile env_file) <- liftIO $+         getPrivateCabalPkgEnv ghcVer $ unpackedToResolvedCabalVersion cabalVer+       vLog $ logMsg ++ "v2-build package-env " ++ env_file+       return $ (,)+         (prepare env)+         CompileWithCabalPackage+           { compPackageSource = GPSPackageEnv env+           , compCabalVersion  = unpackedToResolvedCabalVersion cabalVer+           , compProductTarget = CPSGlobal+           }+     where+       prepare env = do+         -- exists_in_env <- liftIO $ cabalVersionExistsInPkgDb cheCabalVer db+         void $ installCabalLibV2 ghcVer cheCabalVer env `E.catch`+           \(ex :: IOError) -> print ex >>+               case cheCabalVer of+                 CabalHEAD _ -> panicIO "Installing Cabal HEAD failed."+                 CabalVersion ver -> errorInstallCabal (CabalVersion ver)++++   compileWithCabalInPrivatePkgDb+       :: (Env, MonadIO m) => GhcVersion -> Version -> m (IO (), Compile)+   compileWithCabalInPrivatePkgDb ghcVer cabalVer =+       compileWithCabalInPrivatePkgDb' ghcVer (CabalVersion cabalVer)++   -- | Compile the requested Cabal version into an isolated package-db if it's+   -- not there already+   compileWithCabalInPrivatePkgDb'+       :: (Env, MonadIO m) => GhcVersion -> UnpackedCabalVersion -> m (IO (), Compile)+   compileWithCabalInPrivatePkgDb' ghcVer cabalVer = do+       db@(PackageDbDir db_path) <- liftIO $+         getPrivateCabalPkgDb $ unpackedToResolvedCabalVersion cabalVer+       vLog $ logMsg ++ "private package-db in " ++ db_path+       return $ (,)+         (prepare db)+         CompileWithCabalPackage+           { compPackageSource = GPSPackageDBs [db]+           , compCabalVersion  = unpackedToResolvedCabalVersion cabalVer+           , compProductTarget = CPSGlobal+           }+     where+       prepare db = do+         db_exists <- liftIO $ cabalVersionExistsInPkgDb cabalVer db+         when (not db_exists) $+           void (installCabalLibV1 ghcVer cabalVer) `E.catch`+             \(SomeException _) -> errorInstallCabal cabalVer++   -- | See if we're in a cabal source tree+   --   compileCabalSource :: Env => MaybeT IO (IO (), Compile)+   compileCabalSource _ghcVer _cabalVer = do+       let cabalFile = cheProjDir </> "Cabal.cabal"+       cabalSrc <- liftIO $ doesFileExist cabalFile+       let projdir = CabalSourceDir cheProjDir+       case cabalSrc of+         False -> mzero+         True -> do+           vLog $ "projdir looks like Cabal source tree (Cabal.cabal exists)"+           cf <- liftIO $ readFile cabalFile+           let buildType = cabalFileBuildType cf+               ver       = cabalFileVersion cf++           case buildType of+             "simple" -> do+                 vLog $ "Cabal source tree is build-type:simple, moving on"+                 mzero+             "custom" -> do+                 vLog $ "compiling helper with local Cabal source tree"+                 return $ (return (), compileWithCabalSource projdir ver)+             _ -> error $ "compileCabalSource: unknown build-type: '"++buildType++"'"++   compileWithCabalSource srcDir ver =+       CompileWithCabalSource+          { compCabalSourceDir       = srcDir+          , compCabalSourceVersion   = ver+          }++   compileWithPkg pkg_src ver target =+       CompileWithCabalPackage+          { compPackageSource        = pkg_src+          , compCabalVersion         = CabalVersion ver+          , compProductTarget        = target+          }++compile :: Env => CompPaths -> Compile -> IO (Either ExitCode FilePath)+compile paths@CompPaths {..} comp = do+    createDirectoryIfMissing True compOutDir+    createHelperSources compBuildDir++    vLog $ "compBuildDir: " ++ compBuildDir+    vLog $ "compOutDir: " ++ compOutDir+    vLog $ "compExePath: " ++ compExePath++    invokeGhc $ compGhcInvocation comp paths++compPaths :: FilePath -> FilePath -> Compile -> CompPaths+compPaths appdir proj_local_cachedir c =+  case c of+    CompileWithCabalPackage+      { compProductTarget=CPSGlobal+      , compCabalVersion+      } -> CompPaths {..}+        where+          compBuildDir =+            appdir </> exeName compCabalVersion ++ "--" ++ sourceHash <.> "build"+          compOutDir  = compBuildDir+          compExePath = compBuildDir </> "cabal-helper"+    CompileWithCabalPackage {compProductTarget=CPSProject} ->+        projLocalCachedirPaths+    CompileWithCabalSource {} ->+        projLocalCachedirPaths+  where+    projLocalCachedirPaths = CompPaths {..}+        where+          compBuildDir = proj_local_cachedir </> "cabal-helper"+          compOutDir  = compBuildDir+          compExePath = compOutDir </> "cabal-helper"++exeName :: ResolvedCabalVersion -> String+exeName (CabalHEAD commitid) = intercalate "--"+  [ "cabal-helper-" ++ showVersion version+  , "Cabal-HEAD" ++ unCommitId commitid+  ]+exeName CabalVersion {cvVersion} = intercalate "--"+  [ "cabal-helper-" ++ showVersion version+  , "Cabal-" ++ showVersion cvVersion+  ]++compGhcInvocation :: Compile -> CompPaths -> GhcInvocation+compGhcInvocation comp CompPaths {..} =+    case comp of+      CompileWithCabalSource {..} ->+        GhcInvocation+          { giIncludeDirs = [compBuildDir, unCabalSourceDir compCabalSourceDir]+          , giPackageSource = GPSAmbient+          , giHideAllPackages = False+          , giPackages    = []+          , giCPPOptions = cppOptions compCabalSourceVersion+                           ++ [cabalVersionMacro compCabalSourceVersion]+          , ..+          }+      CompileWithCabalPackage {..} ->+        GhcInvocation+          { giIncludeDirs = [compBuildDir]+          , giPackageSource = compPackageSource+          , giHideAllPackages = True+          , giPackages =+              [ "base"+              , "containers"+              , "directory"+              , "filepath"+              , "process"+              , "bytestring"+              , "ghc-prim"+              , case compCabalVersion of+                  CabalHEAD {} -> "Cabal"+                  CabalVersion ver -> "Cabal-" ++ showVersion ver+              ]+          , giCPPOptions = cppOptions (unCabalVersion compCabalVersion)+          , ..+          }+  where++    unCabalVersion (CabalVersion ver) = ver+    unCabalVersion (CabalHEAD _)      = Version [10000000, 0, 0] []++    cppOptions cabalVer =+        [ "-DCABAL_HELPER=1"+        , cabalMinVersionMacro cabalVer+        ]++    giOutDir = compOutDir+    giOutput = compExePath+    giWarningFlags = [ "-w" ] -- no point in bothering end users with warnings+    giInputs = [compBuildDir</>"CabalHelper"</>"Runtime"</>"Main.hs"]++cabalVersionMacro :: Version -> String+cabalVersionMacro (Version vs _) =+  "-DCABAL_VERSION="++intercalate "," (map show vs)++cabalMinVersionMacro :: Version -> String+cabalMinVersionMacro (Version (mj1:mj2:mi:_) _) =+  "-DCH_MIN_VERSION_Cabal(major1,major2,minor)=\+  \(  (major1)  < "++show mj1++" \+  \|| (major1) == "++show mj1++" && (major2)  < "++show mj2++" \+  \|| (major1) == "++show mj1++" && (major2) == "++show mj2++" && (minor) <= "++show mi+++  ")"+cabalMinVersionMacro _ =+    error "cabalMinVersionMacro: Version must have at least 3 components"++{-+TODO: If the Cabal version we want to install is less than or equal to one we+have available, either through act-as-setup or in a package-db we should be able+to use act-as-setup or build a default Setup.hs exe and patch the Cabal source+to say build-type:simple. This will sidestep bugs in c-i>=1.24++See conversation in+https://github.com/haskell/cabal/commit/e2bf243300957321497353a2f85517e464f764ab++Otherwise we might be able to use the shipped Setup.hs++-}++errorInstallCabal :: CabalVersion' a -> IO b+errorInstallCabal (CabalHEAD _) =+  error "cabal-helper: Installing Cabal HEAD failed."+errorInstallCabal (CabalVersion cabalVer) = panicIO $ printf "\+\cabal-helper: Installing Cabal version %s failed.\n\+\\n\+\You have the following choices to fix this:\n\+\\n\+\- The easiest way to try and fix this is just reconfigure the project and try\n\+\  again:\n\+\        $ cabal clean && cabal configure\n\+\\n\+\- If that fails you can try to install the version of Cabal mentioned above\n\+\  into your global/user package-db somehow, though you'll probably have to\n\+\  fix something otherwise it wouldn't have failed above:\n\+\        $ cabal install Cabal --constraint 'Cabal == %s'\n\+\\n\+\- If you're using `Build-Type: Simple`:\n\+\  - You can see if you can reinstall your cabal-install executable while\n\+\    having it linked to a version of Cabal that's available in you\n\+\    package-dbs or can be built automatically:\n\+\        $ ghc-pkg list | grep Cabal  # find an available Cabal version\n\+\            Cabal-W.X.Y.Z\n\+\        $ cabal install cabal-install --constraint 'Cabal == W.X.*'\n\+\    Afterwards you'll have to reconfigure your project:\n\+\        $ cabal clean && cabal configure\n\+\\n\+\- If you're using `Build-Type: Custom`:\n\+\  - Have cabal-install rebuild your Setup.hs executable with a version of the\n\+\    Cabal library that you have available in your global/user package-db:\n\+\        $ cabal clean && cabal configure\n\+\    You might also have to install some version of the Cabal to do this:\n\+\        $ cabal install Cabal\n\+\\n" sver sver+ where+   sver = showVersion cabalVer++-- | Find @version: XXX@ delcaration in a cabal file+cabalFileVersion :: String -> Version+cabalFileVersion = parseVer . cabalFileTopField "version"++-- | Find @build-type: XXX@ delcaration in a cabal file+cabalFileBuildType :: String -> String+cabalFileBuildType = cabalFileTopField "build-type"++cabalFileTopField :: String -> String -> String+cabalFileTopField field cabalFile = value+ where+  Just value = extract <$> find ((field++":") `isPrefixOf`) ls+  ls = map (map toLower) $ lines cabalFile+  extract = dropWhile (/=':') >>> drop 1 >>> dropWhile isSpace >>> takeWhile (not . isSpace)
+ src/CabalHelper/Compiletime/Data.hs view
@@ -0,0 +1,111 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2017  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE TemplateHaskell, ScopedTypeVariables, CPP #-}++{-|+Module      : CabalHelper.Compiletime.Data+Description : Embeds source code for runtime component using TH+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Data where++import Control.Monad+import Control.Monad.IO.Class+import Data.Digest.Pure.SHA+import Data.Functor+import Data.List+import qualified Data.ByteString as BS+import qualified Data.ByteString.UTF8 as UTF8+import qualified Data.ByteString.Lazy as LBS+import qualified Data.ByteString.Lazy.UTF8 as LUTF8+import Language.Haskell.TH+import Language.Haskell.TH.Syntax (addDependentFile)+import System.Directory+import System.FilePath+import System.IO.Temp+import System.PosixCompat.Files+import System.PosixCompat.Time+import System.PosixCompat.Types+import Prelude++import CabalHelper.Compiletime.Compat.Environment++withSystemTempDirectoryEnv :: String -> (FilePath -> IO b) -> IO b+withSystemTempDirectoryEnv tpl f = do+  m <- liftIO $ lookupEnv "CABAL_HELPER_KEEP_SOURCEDIR"+  case m of+    Nothing -> withSystemTempDirectory tpl f+    Just _  -> do+           tmpdir <- getCanonicalTemporaryDirectory+           f =<< createTempDirectory tmpdir tpl++createHelperSources :: FilePath -> IO ()+createHelperSources dir = do+    let chdir = dir </> "CabalHelper"+    liftIO $ do+      createDirectoryIfMissing True $ chdir </> "Runtime"+      createDirectoryIfMissing True $ chdir </> "Shared"++    let modtime :: EpochTime+        modtime = fromIntegral $ (read :: String -> Integer)+          -- See https://reproducible-builds.org/specs/source-date-epoch/+          $(runIO $ do+             msde :: Maybe Integer+                  <- fmap read <$> lookupEnv "SOURCE_DATE_EPOCH"+             (current_time :: Integer) <- round . toRational <$> epochTime+             return $ LitE . StringL $ show $ maybe current_time id msde)++    liftIO $ forM_ sourceFiles $ \(fn, src) -> do+        let path = chdir </> fn+        BS.writeFile path $ UTF8.fromString src+        setFileTimes path modtime modtime++sourceHash :: String+sourceHash  = fst runtimeSources++sourceFiles :: [(FilePath, String)]+sourceFiles = snd runtimeSources++runtimeSources :: (String, [(FilePath, FilePath)])+runtimeSources = $(+  let files = map (\f -> (f, ("src/CabalHelper" </> f))) $ sort $+        [ ("Runtime/Main.hs")+        , ("Runtime/HelperMain.hs")+        , ("Runtime/Compat.hs")+        , ("Shared/Common.hs")+        , ("Shared/InterfaceTypes.hs")+        ]+  in do+    contents <- forM (map snd files) $ \lf -> do+      addDependentFile lf+      runIO (LBS.readFile lf)+    let hashes = map (bytestringDigest . sha256) contents+    let top_hash = showDigest $ sha256 $ LBS.concat hashes++    let exprWrapper =+#if MIN_VERSION_template_haskell(2,16,0)+          Just+#else+          id+#endif+++    thfiles <- forM (map fst files `zip` contents) $ \(f, xs) -> do+      return $ TupE [exprWrapper (LitE (StringL f)), exprWrapper (LitE (StringL (LUTF8.toString xs)))]+++    return $ TupE [exprWrapper (LitE (StringL top_hash)), exprWrapper (ListE thfiles)]++  )++-- - $(LitE . StringL <$> runIO (UTF8.toString <$> BS.readFile
+ src/CabalHelper/Compiletime/Log.hs view
@@ -0,0 +1,35 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Log+Description : Logging utilities+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Log where++import Control.Monad.IO.Class+import System.IO+import System.IO.Error++import CabalHelper.Compiletime.Types++logIOError :: Verbose => String -> IO (Maybe a) -> IO (Maybe a)+logIOError label a = do+  a `catchIOError` \ex -> do+      vLog $ label ++ ": " ++ show ex+      return Nothing++vLog :: (MonadIO m, Verbose) => String -> m ()+vLog msg+    | ?verbose 0 = liftIO $ hPutStrLn stderr msg+    | otherwise = return ()
+ src/CabalHelper/Compiletime/Process.hs view
@@ -0,0 +1,112 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Process+Description : System process utilities+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Process+    ( module CabalHelper.Compiletime.Process+    , module System.Process+    ) where++import Data.Char+import Data.List+import Data.Maybe+import qualified Data.Map.Strict as Map+import GHC.IO.Exception (IOErrorType(OtherError))+import System.IO+import System.IO.Error+import System.Environment+import System.Exit+import System.Process++import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Log++readProcess' :: Verbose => FilePath -> [String] -> String -> IO String+readProcess' exe args inp =+  readProcessStderr Nothing [] exe args inp++readProcessStderr :: Verbose => Maybe FilePath -> [(String, EnvOverride)]+                  -> FilePath -> [String] -> String -> IO String+readProcessStderr mcwd env exe args inp = do+  logProcessCall mcwd env exe args+  env' <- execEnvOverrides env <$> getEnvironment+  outp <- readCreateProcess (proc exe args)+    { cwd = mcwd+    , env = if env == [] then Nothing else Just env'+    } inp+  vLog $ unlines $ map ("=> "++) $ lines outp+  return outp++-- | Essentially 'System.Process.callProcess' but returns exit code, has+-- additional options and logging to stderr when verbosity is enabled.+callProcessStderr'+    :: Verbose => Maybe FilePath -> [(String, EnvOverride)]+    -> FilePath -> [String] -> IO ExitCode+callProcessStderr' mcwd env exe args = do+  logProcessCall mcwd env exe args+  env' <- execEnvOverrides env <$> getEnvironment+  (_, _, _, h) <- createProcess (proc exe args)+    { std_out = UseHandle stderr+    , env = if env == [] then Nothing else Just env'+    , cwd = mcwd+    }+  waitForProcess h++logProcessCall :: Verbose => Maybe FilePath -> [(String, EnvOverride)]+               -> FilePath -> [String] -> IO ()+logProcessCall mcwd env exe args = do+  vLog $ intercalate " " $ cd ++ env_args ++ map formatProcessArg (exe:args)+  where+    env_args = map (\(k,v) -> k ++ "=" ++ show v) env+    cd = case mcwd of+      Nothing -> []; Just cwd -> [ "cd", formatProcessArg cwd++";" ]++execEnvOverride :: EnvOverride -> String -> Maybe String+execEnvOverride (EnvPrepend x) y = Just (x ++ y)+execEnvOverride (EnvAppend  y) x = Just (x ++ y)+execEnvOverride (EnvSet x)     _ = Just x+execEnvOverride  EnvUnset      _ = Nothing++execEnvOverrides+    :: [(String, EnvOverride)] -> [(String, String)] -> [(String, String)]+execEnvOverrides overrides env =+    Map.toList $ foldl f (Map.fromList env) overrides+  where+    f em (k, o) = Map.alter (execEnvOverride o . fromMaybe "") k em++-- | Essentially 'System.Process.callProcess' but with additional options+-- and logging to stderr when verbosity is enabled.+callProcessStderr :: Verbose => Maybe FilePath -> [(String, EnvOverride)]+                  -> FilePath -> [String] -> IO ()+callProcessStderr mwd env exe args = do+  rv <- callProcessStderr' mwd env exe args+  case rv of+    ExitSuccess -> return ()+    ExitFailure v -> processFailedException "callProcessStderr" exe args v++processFailedException :: String -> String -> [String] -> Int -> IO a+processFailedException fn exe args rv =+    ioError $ mkIOError OtherError msg Nothing Nothing+  where+    msg = concat [ fn, ": ", exe, " "+                 , intercalate " " (map formatProcessArg args)+                 , " (exit " ++ show rv ++ ")"+                 ]++formatProcessArg :: String -> String+formatProcessArg xs+    | any isSpace xs = "'"++ xs ++"'"+    | otherwise      = xs
+ src/CabalHelper/Compiletime/Program/CabalInstall.hs view
@@ -0,0 +1,372 @@+{-# LANGUAGE DataKinds, MultiWayIf, TupleSections, GADTs, OverloadedStrings #-}++-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Program.Cabal+Description : cabal-install program interface+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Program.CabalInstall where++import Control.Arrow ((&&&))+import qualified Cabal.Plan as CP+import Control.Monad+import Data.Coerce+import Data.List.NonEmpty (NonEmpty((:|)))+import Data.Semigroup ((<>))+import Data.Maybe+import Data.Version+import System.IO+import System.IO.Temp+import System.Directory+import System.Environment+import System.FilePath+import Text.Printf+import Text.Read++import qualified Data.Map.Strict as Map+import qualified Data.Set as Set+import qualified Data.Text as Text++import qualified CabalHelper.Compiletime.Cabal as Cabal+import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Program.GHC+  ( GhcVersion(..), createPkgDb )+import CabalHelper.Compiletime.Types.Cabal+  ( CabalSourceDir(..), UnpackedCabalVersion, CabalVersion'(..) )+import CabalHelper.Compiletime.Cabal+  ( unpackCabalV1 )+import CabalHelper.Compiletime.Process+import CabalHelper.Shared.InterfaceTypes+  ( ChComponentName(..), ChLibraryName(..) )+import CabalHelper.Shared.Common+  ( parseVer, trim, appCacheDir )++newtype CabalInstallVersion = CabalInstallVersion { cabalInstallVer :: Version }++data HEAD = HEAD deriving (Eq, Show)++cabalInstallVersion :: (Verbose, Progs) => IO CabalInstallVersion+cabalInstallVersion = do+  CabalInstallVersion . parseVer . trim+    <$> readProcess' (cabalProgram ?progs) ["--numeric-version"] ""++installCabalLibV1 :: Env => GhcVersion -> UnpackedCabalVersion -> IO PackageDbDir+installCabalLibV1 ghcVer cabalVer = do+  withSystemTempDirectory "cabal-helper.install-cabal-tmp" $ \tmpdir -> do+    installingMessage cabalVer+    srcdir <- unpackCabalV1 cabalVer tmpdir++    db <- createPkgDb cabalVer++    callCabalInstall db srcdir ghcVer cabalVer++    return db++installingMessage :: CabalVersion' a -> IO ()+installingMessage = message+  where+    message (CabalHEAD {}) = return () -- only used for tests+    message (CabalVersion ver) = do+      appdir <- appCacheDir+      let sver = showVersion ver+      -- TODO: dumping this to stderr is not really acceptable, we need to have+      -- a way to let API clients override this!+      hPutStr stderr $ printf "\+\cabal-helper: Installing a private copy of Cabal because we couldn't\n\+\find the right version anywhere on your system. You can set the environment\n\+\variable CABAL_HELPER_DEBUG=1 to see where we searched.\n\+\\n\+\Note that this installation might take a little while but it will only\n\+\happen once per Cabal library version used in your build-plans.\n\+\\n\+\If you want to avoid this automatic installation altogether install\n\+\version %s of the Cabal library manually, either using cabal or your\n\+\system package manager. With cabal you can use the following command:\n\+\    $ cabal install Cabal --constraint \"Cabal == %s\"\n\+\\n\+\FYI the build products and cabal-helper executable cache are all in the\n\+\following directory, you can simply delete it if you think something\n\+\is broken :\n\+\    %s\n\+\Please do report any problems you encounter.\n\+\\n\+\Installing Cabal %s ...\n" sver sver appdir sver++callCabalInstall+    :: Env+    => PackageDbDir+    -> CabalSourceDir+    -> GhcVersion+    -> UnpackedCabalVersion+    -> IO ()+callCabalInstall+  (PackageDbDir db)+  (CabalSourceDir srcdir)+  ghcVer+  unpackedCabalVer+  = do+  civ@CabalInstallVersion {..} <- cabalInstallVersion+  cabal_opts <- return $ concat+      [+        [ "--package-db=clear"+        , "--package-db=global"+        , "--package-db=" ++ db+        , "--prefix=" ++ db </> "prefix"+        ]+        , cabalWithGHCProgOpts+        , if cabalInstallVer >= Version [1,20,0,0] []+             then ["--no-require-sandbox"]+             else []+        , [ "install", srcdir ]+        , if | ?verbose 3 -> ["-v2"]+             | ?verbose 4 -> ["-v3"]+             | otherwise -> []+        , [ "--only-dependencies" ]+      ]++  callProcessStderr (Just "/") [] (cabalProgram ?progs) cabal_opts++  runSetupHs ghcVer db srcdir unpackedCabalVer civ++  hPutStrLn stderr "done"++runSetupHs+    :: Env+    => GhcVersion+    -> FilePath+    -> FilePath+    -> UnpackedCabalVersion+    -> CabalInstallVersion+    -> IO ()+runSetupHs ghcVer db srcdir cabalVer CabalInstallVersion {..}+    | cabalInstallVer >= parseVer "1.24" = do+      go $ \args -> callProcessStderr (Just srcdir) [] (cabalProgram ?progs) $+        [ "act-as-setup", "--" ] ++ args+    | otherwise = do+      SetupProgram {..} <- compileSetupHs ghcVer db srcdir+      go $ callProcessStderr (Just srcdir) [] setupProgram+  where+    parmake_opt :: Maybe Int -> [String]+    parmake_opt nproc'+        | CabalHEAD _ <- cabalVer =+            ["-j"++nproc]+        | CabalVersion ver <- cabalVer, ver >= Version [1,20] [] =+            ["-j"++nproc]+        | otherwise =+            []+      where+        nproc = fromMaybe "" $ show <$> nproc'+    go :: ([String] -> IO ()) -> IO ()+    go run = do+      run $ [ "configure", "--package-db", db, "--prefix", db </> "prefix" ]+              ++ cabalWithGHCProgOpts+      mnproc <- join . fmap readMaybe <$> lookupEnv "NPROC"+      run $ [ "build" ] ++ parmake_opt mnproc+      run [ "copy" ]+      run [ "register" ]++newtype SetupProgram = SetupProgram { setupProgram :: FilePath }+compileSetupHs :: Env => GhcVersion -> FilePath -> FilePath -> IO SetupProgram+compileSetupHs (GhcVersion ghcVer) db srcdir = do+  let no_version_macros+        | ghcVer >= Version [8] [] = [ "-fno-version-macros" ]+        | otherwise                = []++      file = srcdir </> "Setup"++  callProcessStderr (Just srcdir) [] (ghcProgram ?progs) $ concat+    [ [ "--make"+      , "-package-conf", db+      ]+    , no_version_macros+    , [ file <.> "hs"+      , "-o", file+      ]+    ]+  return $ SetupProgram file++cabalWithGHCProgOpts :: Progs => [String]+cabalWithGHCProgOpts = concat+  [ [ "--with-ghc=" ++ ghcProgram ?progs ]+  -- Only pass ghc-pkg if it was actually set otherwise we+  -- might break cabal's guessing logic+  , if ghcPkgProgram ?progs /= ghcPkgProgram defaultPrograms+      then [ "--with-ghc-pkg=" ++ ghcPkgProgram ?progs ]+      else []+  ]++installCabalLibV2 :: Env => GhcVersion -> UnpackedCabalVersion -> PackageEnvFile -> IO ()+installCabalLibV2 _ghcVer cv (PackageEnvFile env_file) = do+  exists <- doesFileExist env_file+  if exists+    then return ()+    else do+    installingMessage cv+    (target, cwd) <- case cv of+      CabalVersion cabalVer -> do+        return $ ("Cabal-"++showVersion cabalVer, "/")+      CabalHEAD (_commitid, CabalSourceDir srcdir) -> do+        return (".", srcdir)+    CabalInstallVersion {..} <- cabalInstallVersion+    cabal_opts <- return $ concat+        [ if cabalInstallVer >= Version [1,20] []+             then ["--no-require-sandbox"]+             else []+        , [ if cabalInstallVer >= Version [2,4] []+              then "v2-install"+              else "new-install"+          ]+        , cabalV2WithGHCProgOpts+        , [ "--package-env=" ++ env_file+          , "--lib"+          , target+          ]+        , if | ?verbose 3 -> ["-v2"]+             | ?verbose 4 -> ["-v3"]+             | otherwise -> []+        ]+    callProcessStderr (Just cwd) [] (cabalProgram ?progs) cabal_opts+    hPutStrLn stderr "done"+++cabalV2WithGHCProgOpts :: Progs => [String]+cabalV2WithGHCProgOpts = concat+  [ [ "--with-compiler=" ++ ghcProgram ?progs ]+  , if ghcPkgProgram ?progs /= ghcPkgProgram defaultPrograms+      then [ "--with-hc-pkg=" ++ ghcPkgProgram ?progs ]+      else []+  ]++planPackages :: CP.PlanJson -> IO [Package ('Cabal 'CV2)]+planPackages plan = do+    sequence $+      Map.elems $+      Map.mapWithKey mkPackage $+      Map.mapMaybe packagesWithSourceDir $+      groupByMap $+      Map.elems $+      CP.pjUnits plan+  where+    groupByMap = Map.fromListWith (<>) . map (CP.uPId &&& (:|[]))++    packagesWithSourceDir units@(unit :| _) =+      case unit of+        CP.Unit { uPkgSrc=Just (CP.LocalUnpackedPackage pkgdir) }+          -> Just (pkgdir, units)+        _ -> Nothing++    mkPackage :: CP.PkgId -> (FilePath, NonEmpty CP.Unit) -> IO (Package ('Cabal 'CV2))+    mkPackage (CP.PkgId (CP.PkgName pkg_name) _) (pkgdir, units) = do+      cabal_file <- Cabal.complainIfNoCabalFile pkgdir =<< Cabal.findCabalFile pkgdir+      let pkg = Package+            { pPackageName = Text.unpack pkg_name+            , pSourceDir = pkgdir+            , pCabalFile = CabalFile cabal_file+            , pFlags = []+            , pUnits = fmap (\u -> fixBackpackUnit u $ mkUnit pkg { pUnits = () } u) units+            }+      return pkg++    takeBackpackIndefUnitId :: CP.Unit -> Maybe CP.UnitId+    takeBackpackIndefUnitId CP.Unit {uId=CP.UnitId uid}+      | Text.any (=='+') uid = Just $ CP.UnitId $ Text.takeWhile (/='+') uid+      | otherwise = Nothing++    findUnitsDependingOn :: CP.UnitId -> [CP.Unit]+    findUnitsDependingOn uid = Map.elems $+      Map.filter (any (Set.member uid . CP.ciLibDeps) . Map.elems . CP.uComps) $+      CP.pjUnits plan++    -- Horrible workaround for https://github.com/haskell/cabal/issues/6201+    fixBackpackUnit plan_unit ch_unit+      | Just indef_uid <- takeBackpackIndefUnitId plan_unit = do+        let deps = findUnitsDependingOn indef_uid+        ch_unit { uImpl = (uImpl ch_unit)+          { uiV2Components = concatMap unitTargets deps+          , uiV2OnlyDependencies = True+          } }+      | otherwise =+        ch_unit++    unitTargets :: CP.Unit -> [(ChComponentName, String)]+    unitTargets CP.Unit {uComps, uPId=CP.PkgId pkg_name _} =+      [ (cpCompNameToChComponentName comp, Text.unpack target)+      | comp <- Map.keys uComps+      , let comp_str = CP.dispCompNameTarget pkg_name comp+      , let target = ((coerce pkg_name) <> ":") <> comp_str+      ]++    mkUnit :: Package' () -> CP.Unit -> Unit ('Cabal 'CV2)+    mkUnit pkg u@CP.Unit+      { uDistDir=Just distdirv1+      , uComps=comps+      , uId+      } =+        Unit+          { uUnitId     = UnitId $ Text.unpack (coerce uId)+          , uPackage    = pkg+          , uDistDir    = DistDirLib distdirv1+          , uImpl       =+            let+              comp_names = Map.keys comps+              uiV2ComponentNames = map cpCompNameToChComponentName comp_names+              uiV2Components = unitTargets u+              uiV2OnlyDependencies = False+            in UnitImplV2 {..}+          }+    mkUnit _ _ =+      error "planPackages.mkUnit: Got package without distdir!"++cpCompNameToChComponentName :: CP.CompName -> ChComponentName+cpCompNameToChComponentName cn =+    case cn of+      CP.CompNameSetup         -> ChSetupHsName+      CP.CompNameLib           -> ChLibName     ChMainLibName+      (CP.CompNameSubLib name) -> ChLibName   $ ChSubLibName $ Text.unpack name+      (CP.CompNameFLib name)   -> ChFLibName  $ Text.unpack name+      (CP.CompNameExe name)    -> ChExeName   $ Text.unpack name+      (CP.CompNameTest name)   -> ChTestName  $ Text.unpack name+      (CP.CompNameBench name)  -> ChBenchName $ Text.unpack name++data CabalInstallCommand+    = CIConfigure+    | CIBuild++doCabalInstallCmd+    :: (QueryEnvI c ('Cabal cpt) -> CallProcessWithCwdAndEnv a)+    -> QueryEnvI c ('Cabal cpt)+    -> Maybe FilePath -> CabalInstallCommand -> [String] -> IO a+doCabalInstallCmd procfn qe mcwd cmd args = do+  case (cmd, projTypeOfQueryEnv qe) of+    (CIConfigure, SCabal SCV1) ->+      run "v1-configure" cabalProjArgs cabalUnitArgs []+    (CIBuild, SCabal SCV1) ->+      run "v1-build" cabalProjArgs [] []+    (_, SCabal SCV2) ->+      run "v2-build" cabalProjArgs cabalUnitArgs []+  where+    Programs{..} = qePrograms qe+    run cmdarg before aftercmd after  = procfn qe mcwd [] cabalProgram $+      before ++ [cmdarg] ++ aftercmd ++ args ++ after++readCabalInstallCmd+    :: QueryEnvI c ('Cabal cpt)+    -> Maybe FilePath -> CabalInstallCommand -> [String] -> IO String+callCabalInstallCmd+    :: QueryEnvI c ('Cabal cpt)+    -> Maybe FilePath -> CabalInstallCommand -> [String] -> IO ()++readCabalInstallCmd = doCabalInstallCmd (\qe -> qeReadProcess qe "")+callCabalInstallCmd = doCabalInstallCmd qeCallProcess
+ src/CabalHelper/Compiletime/Program/GHC.hs view
@@ -0,0 +1,166 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Program.GHC+Description : GHC program interface+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Program.GHC where++import Control.Monad+import Control.Monad.Trans.Maybe+import Control.Monad.IO.Class+import Data.Char+import Data.List+import Data.Maybe+import Data.Version+import System.Exit+import System.FilePath+import System.Directory++import CabalHelper.Shared.Common+  (parseVer, trim, appCacheDir, parsePkgId)+import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Types.Cabal+  ( ResolvedCabalVersion, showResolvedCabalVersion, UnpackedCabalVersion+  , unpackedToResolvedCabalVersion, CabalVersion'(..) )+import CabalHelper.Compiletime.Process+import CabalHelper.Compiletime.Log++data GhcPackageSource+    = GPSAmbient+    | GPSPackageDBs ![PackageDbDir]+    | GPSPackageEnv !PackageEnvFile++data GhcInvocation = GhcInvocation+    { giOutDir          :: !FilePath+    , giOutput          :: !FilePath+    , giCPPOptions      :: ![String]+    , giPackageSource   :: !GhcPackageSource+    , giIncludeDirs     :: ![FilePath]+    , giHideAllPackages :: !Bool+    , giPackages        :: ![String]+    , giWarningFlags    :: ![String]+    , giInputs          :: ![String]+    }++newtype GhcVersion = GhcVersion { unGhcVersion :: Version }+    deriving (Eq, Ord, Read, Show)++showGhcVersion :: GhcVersion -> String+showGhcVersion (GhcVersion v) = showVersion v++ghcVersion :: (Verbose, Progs) => IO GhcVersion+ghcVersion = GhcVersion .+  parseVer . trim <$> readProcess' (ghcProgram ?progs) ["--numeric-version"] ""++ghcLibdir :: (Verbose, Progs) => IO FilePath+ghcLibdir = do+  trim <$> readProcess' (ghcProgram ?progs) ["--print-libdir"] ""++ghcPkgVersion :: (Verbose, Progs) => IO Version+ghcPkgVersion =+  parseVer . trim . dropWhile (not . isDigit)+    <$> readProcess' (ghcPkgProgram ?progs) ["--version"] ""++createPkgDb :: (Verbose, Progs) => UnpackedCabalVersion -> IO PackageDbDir+createPkgDb cabalVer = do+  db@(PackageDbDir db_path)+    <- getPrivateCabalPkgDb $ unpackedToResolvedCabalVersion cabalVer+  exists <- doesDirectoryExist db_path+  when (not exists) $+       callProcessStderr Nothing [] (ghcPkgProgram ?progs) ["init", db_path]+  return db++getPrivateCabalPkgDb :: (Verbose, Progs) => ResolvedCabalVersion -> IO PackageDbDir+getPrivateCabalPkgDb cabalVer = do+  appdir <- appCacheDir+  ghcVer <- ghcVersion+  let db_path =+        appdir </> "ghc-" ++ showGhcVersion ghcVer ++ ".package-dbs"+               </> "Cabal-" ++ showResolvedCabalVersion cabalVer+  return $ PackageDbDir db_path++getPrivateCabalPkgEnv+    :: Verbose => GhcVersion -> ResolvedCabalVersion -> IO PackageEnvFile+getPrivateCabalPkgEnv ghcVer cabalVer = do+  appdir <- appCacheDir+  let env_path =+        appdir </> "ghc-" ++ showGhcVersion ghcVer ++ ".package-envs"+               </> "Cabal-" ++ showResolvedCabalVersion cabalVer ++ ".package-env"+  return $ PackageEnvFile env_path++listCabalVersions+    :: (Verbose, Progs) => Maybe PackageDbDir -> MaybeT IO [Version]+listCabalVersions mdb = do+  let mdb_path = unPackageDbDir <$> mdb+  exists <- fromMaybe True <$>+    traverse (liftIO . doesDirectoryExist) mdb_path+  case exists of+    True -> MaybeT $ logIOError "listCabalVersions" $ Just <$> do+      let mdbopt = ("--package-conf="++) <$> mdb_path+          args = ["list", "--simple-output", "Cabal"] ++ maybeToList mdbopt+      catMaybes . map (fmap snd . parsePkgId) . words+               <$> readProcess' (ghcPkgProgram ?progs) args ""+    _ -> mzero++cabalVersionExistsInPkgDb+    :: (Verbose, Progs) => CabalVersion' a -> PackageDbDir -> IO Bool+cabalVersionExistsInPkgDb cabalVer db@(PackageDbDir db_path) = do+  fromMaybe False <$> runMaybeT (do+    vers <- listCabalVersions (Just db)+    return $+      case (cabalVer, vers) of+        (CabalVersion ver, _) -> ver `elem` vers+        (CabalHEAD _, []) -> False+        (CabalHEAD _, [_headver]) -> True+        (CabalHEAD _, _) ->+          error $ msg ++ db_path)+  where+    msg = "\+\Multiple Cabal versions in a HEAD package-db!\n\+\This shouldn't happen. However you can manually delete the following\n\+\directory to resolve this:\n    "++invokeGhc :: Env => GhcInvocation -> IO (Either ExitCode FilePath)+invokeGhc GhcInvocation {..} = do+    giOutDirAbs <- makeAbsolute giOutDir+    giOutputAbs <- makeAbsolute giOutput+    giIncludeDirsAbs <- mapM makeAbsolute giIncludeDirs+    giInputsAbs <- mapM makeAbsolute giInputs+    -- We unset some interferring envvars here for stack, see:+    -- https://github.com/DanielG/cabal-helper/issues/78#issuecomment-557860898+    let eos = [("GHC_ENVIRONMENT", EnvUnset), ("GHC_PACKAGE_PATH", EnvUnset)]+    rv <- callProcessStderr' (Just "/") eos (ghcProgram ?progs) $ concat+      [ [ "-outputdir", giOutDirAbs+        , "-o", giOutputAbs+        ]+      , map ("-optP"++) giCPPOptions+      , if giHideAllPackages then ["-hide-all-packages"] else []+      , let packageFlags = concatMap (\p -> ["-package", p]) giPackages in+        case giPackageSource of+          GPSAmbient -> packageFlags+          GPSPackageDBs dbs -> concat+            [ map ("-package-conf="++) $ unPackageDbDir <$> dbs+            , packageFlags+            ]+          GPSPackageEnv env -> [ "-package-env=" ++ unPackageEnvFile env ]+      , map ("-i"++) $ nub $ "" : giIncludeDirsAbs+      , giWarningFlags+      , ["--make"]+      , giInputsAbs+      ]+    return $+      case rv of+        ExitSuccess -> Right giOutput+        e@(ExitFailure _) -> Left e
+ src/CabalHelper/Compiletime/Program/Stack.hs view
@@ -0,0 +1,141 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Program.Stack+Description : Stack program interface+License     : Apache-2.0+-}++{-# LANGUAGE GADTs, DataKinds #-}++module CabalHelper.Compiletime.Program.Stack where++import Control.Exception (handle, throwIO)+import Control.Monad+import Control.Monad.Trans.Maybe+import Control.Monad.IO.Class+import Data.Char+import Data.List hiding (filter)+import Data.List.NonEmpty (NonEmpty(..))+import Data.String+import Data.Maybe+import Data.Function+import Data.Version+import System.Directory (findExecutable)+import System.FilePath hiding ((<.>))+import System.IO (hPutStrLn, stderr)+import Text.Printf (printf)+import Prelude++import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Types.RelativePath+import CabalHelper.Shared.Common++getPackage :: QueryEnvI c 'Stack -> CabalFile -> IO (Package 'Stack)+getPackage qe cabal_file@(CabalFile cabal_file_path) = do+  let pkgdir = takeDirectory cabal_file_path+  -- this is kind of a hack but works even for unicode package names and+  -- besides stack even enforces this naming convention unlike cabal. This+  -- is the error you get if the names don't match:+  --+  -- cabal file path foo-bla.cabal does not match the package name it defines.+  -- Please rename the file to: foo.cabal+  -- For more information, see:+  --  https://github.com/commercialhaskell/stack/issues/317+  let pkg_name = dropExtension $ takeFileName cabal_file_path+  look <- paths qe pkgdir+  let distdirv1_rel = look "dist-dir:"+  let pkg = Package+        { pPackageName = pkg_name+        , pSourceDir = pkgdir+        , pCabalFile = cabal_file+        , pFlags = []+        , pUnits = (:|[]) $ Unit+          { uUnitId     = UnitId pkg_name+          , uDistDir    = DistDirLib $ pkgdir </> distdirv1_rel+          , uPackage    = pkg { pUnits = () }+          , uImpl       = UnitImplStack+          }+        }+  return pkg++projPaths :: QueryEnvI c 'Stack -> IO StackProjPaths+projPaths qe@QueryEnv {qeProjLoc} = do+  look <- paths qe $ plStackProjectDir qeProjLoc+  return StackProjPaths+    { sppGlobalPkgDb = PackageDbDir $ look "global-pkg-db:"+    , sppSnapPkgDb   = PackageDbDir $ look "snapshot-pkg-db:"+    , sppLocalPkgDb  = PackageDbDir $ look "local-pkg-db:"+    , sppCompExe     = look "compiler-exe:"+    }++paths :: QueryEnvI c 'Stack -> FilePath -> IO (String -> FilePath)+paths qe@QueryEnv{qeProjLoc=ProjLocStackYaml stack_yaml} cwd+  = do+  out <- readStackCmd qe (Just cwd) $+    workdirArg qe ++ [ "path", "--stack-yaml="++stack_yaml ]+  return $ \k -> let Just x = lookup k $ map split $ lines out in x+  where+    split l = let (key, val) = break isSpace l in (key, dropWhile isSpace val)++listPackageCabalFiles :: QueryEnvI c 'Stack -> IO [CabalFile]+listPackageCabalFiles qe@QueryEnv{qeProjLoc}+  = handle ioerror $ do+  let projdir = plStackProjectDir qeProjLoc+  out <- readStackCmd qe (Just projdir)+    [ "ide", "packages", "--cabal-files", "--stdout" ]+  return $ map CabalFile $ lines out+  where+    ioerror :: IOError -> IO a+    ioerror ioe = (fromMaybe (throwIO ioe) =<<) $ runMaybeT $ do+      stack_exe <- MaybeT $ findExecutable $ stackProgram $ qePrograms qe+      stack_ver_str+        <- liftIO $ trim <$> readStackCmd qe Nothing ["--numeric-version"]+      stack_ver <- MaybeT $ return $ parseVerMay stack_ver_str+      guard $ stack_ver < makeVersion [1,9,4]++      let prog_cfg = show $ qePrograms qe++      liftIO $ hPutStrLn stderr $ printf+        "\nerror: stack version too old!\+        \\n\n\+        \You have '%s' installed but cabal-helper needs at least\n\+        \stack version 1.9.4+.\n\+        \\n\+        \FYI cabal-helper is using the following `stack` executable:\n\+        \  %s\n\+        \\n\+        \Additional debugging info: QueryEnv qePrograms =\n\+        \  %s\n" stack_ver_str stack_exe prog_cfg+      mzero++workdirArg :: QueryEnvI c 'Stack -> [String]+workdirArg QueryEnv{qeDistDir=DistDirStack mworkdir} =+  maybeToList $ ("--work-dir="++) . unRelativePath <$> mworkdir++doStackCmd :: (QueryEnvI c 'Stack -> CallProcessWithCwdAndEnv a)+           -> QueryEnvI c 'Stack+           -> Maybe FilePath -> [String] -> IO a+doStackCmd procfn qe mcwd args =+  let Programs{..} = qePrograms qe in+  procfn qe mcwd stackEnv stackProgram $+    stackProjArgs ++ args ++ stackUnitArgs++readStackCmd :: QueryEnvI c 'Stack -> Maybe FilePath -> [String] -> IO String+callStackCmd :: QueryEnvI c 'Stack -> Maybe FilePath -> [String] -> IO ()++readStackCmd = doStackCmd (\qe -> qeReadProcess qe "")+callStackCmd = doStackCmd qeCallProcess++patchCompPrograms :: StackProjPaths -> Programs -> Programs+patchCompPrograms StackProjPaths{sppCompExe} progs =+  progs { ghcProgram = sppCompExe }
+ src/CabalHelper/Compiletime/Sandbox.hs view
@@ -0,0 +1,70 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2017  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Shared.Sandbox+Description : Extracting information from @cabal.sandbox.config@ files+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Sandbox where++import Control.Applicative+import Data.Char+import Data.Maybe+import Data.List+import System.FilePath+import Prelude++import qualified Data.Traversable as T++import CabalHelper.Shared.Common+import CabalHelper.Compiletime.Program.GHC+    ( GhcVersion (..), showGhcVersion )++-- | Get the path to the sandbox package-db in a project+getSandboxPkgDb :: String+             -- ^ Cabal build platform, i.e. @buildPlatform@+             -> GhcVersion+             -- ^ GHC version (@cProjectVersion@ is your friend)+             -> FilePath+             -- ^ Path to the cabal package root directory (containing the+             -- @cabal.sandbox.config@ file)+             -> IO (Maybe FilePath)+getSandboxPkgDb platform ghcVer projdir = do+  mConf <-+      T.traverse readFile =<< mightExist (projdir </> "cabal.sandbox.config")+  return $ fixPkgDbVer <$> (extractSandboxDbDir =<< mConf)++ where+   fixPkgDbVer dir =+       case takeFileName dir == ghcSandboxPkgDbDir platform ghcVer of+         True -> dir+         False -> takeDirectory dir </> ghcSandboxPkgDbDir platform ghcVer++ghcSandboxPkgDbDir :: String -> GhcVersion -> String+ghcSandboxPkgDbDir platform ghcVer =+   platform ++ "-ghc-" ++ showGhcVersion ghcVer ++ "-packages.conf.d"++-- | Extract the sandbox package db directory from the cabal.sandbox.config+-- file. Exception is thrown if the sandbox config file is broken.+extractSandboxDbDir :: String -> Maybe FilePath+extractSandboxDbDir conf = extractValue <$> parse conf+  where+    key = "package-db:"+    keyLen = length key++    parse = listToMaybe . filter (key `isPrefixOf`) . lines+    extractValue = CabalHelper.Compiletime.Sandbox.dropWhileEnd isSpace . dropWhile isSpace . drop keyLen++-- dropWhileEnd is not provided prior to base 4.5.0.0.+dropWhileEnd :: (a -> Bool) -> [a] -> [a]+dropWhileEnd p = foldr (\x xs -> if p x && null xs then [] else x : xs) []
+ src/CabalHelper/Compiletime/Types.hs view
@@ -0,0 +1,596 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE DeriveGeneric, DeriveDataTypeable, DefaultSignatures,+  StandaloneDeriving, GADTs, DataKinds, KindSignatures, RankNTypes, PolyKinds #-}++{-|+Module      : CabalHelper.Compiletime.Types+Description : Types used throughout+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Types where++import Cabal.Plan+  ( PlanJson )+import Data.ByteString (ByteString)+import Data.IORef+import Data.Version+import Data.Typeable+import GHC.Generics+import System.FilePath (takeDirectory)+import System.Posix.Types+import CabalHelper.Compiletime.Types.RelativePath+import CabalHelper.Compiletime.Types.Cabal+import CabalHelper.Shared.InterfaceTypes++import Data.List.NonEmpty (NonEmpty)+--import qualified Data.List.NonEmpty as NonEmpty+import Data.Map.Strict (Map)+--import qualified Data.Map.Strict as Strict++-- | The kind of project being managed by a 'QueryEnv' (pun intended). Used+-- as a phantom-type variable throughout to make the project type being+-- passed into various functions correspond to the correct implementation.+data ProjType+    = Cabal CabalProjType -- ^ @cabal@ project.+    | Stack -- ^ @stack@ project.+      deriving (Eq, Ord, Show, Read)++-- | The kind of a @cabal@ project.+data CabalProjType+    = CV1 -- ^ @cabal v1-build@ project.+    | CV2 -- ^ @cabal v2-build@ project.+      deriving (Eq, Ord, Show, Read)++-- | A "singleton" datatype for 'ProjType' which allows us to establish a+-- correspondence between a runtime representation of 'ProjType' to the+-- compile-time value at the type level.+--+-- If you just want to know the runtime 'ProjType' use 'demoteSProjType' to+-- convert to that.+data SProjType pt where+    SCabal :: !(SCabalProjType pt) -> SProjType ('Cabal pt)+    SStack :: SProjType 'Stack++deriving instance Show (SProjType pt)++-- | This is a singleton, like 'SProjType', but restricted to just the+-- Cabal project types. We use this to restrict some functions which don't+-- make sense for Stack to just the Cabal project types.+data SCabalProjType pt where+    SCV1 :: SCabalProjType 'CV1+    SCV2 :: SCabalProjType 'CV2++deriving instance Show (SCabalProjType pt)++demoteSProjType :: SProjType pt -> ProjType+demoteSProjType (SCabal SCV1) = Cabal CV1+demoteSProjType (SCabal SCV2) = Cabal CV2+demoteSProjType SStack = Stack++-- | Location of a project context. This is usually just the path project's+-- top-level source code directory together with an optional project-type+-- specific config file path.+--+-- To find any recognized default project contexts in a given directory+-- use 'Distribution.Helper.Discover.findProjects'.+--+-- Build tools usually allow the user to specify the location of their+-- project config files manually, so we also support passing this path here+-- with the @*File@ constructors.+--+-- === Correspondence between Project and Package Source Directories+--+-- Note that the project's source directory does not necessarily correspond+-- to the directory containing the project config file, though in some+-- cases it does.+--+-- For example @cabal v2-build@ allows the @cabal.project@ file to be+-- positively anywhere in the filesystem when specified via the+-- @--cabal-project@ command-line flag, corresponding to the+-- 'ProjLocV2File' constructor here. This config file can then refer to+-- package directories with absolute paths in the @packages:@ declaration.+--+-- Hence it isn't actually possible to find /one/ directory which contains+-- the whole project's source code but rather we have to consider each+-- package's source directory individually, see 'Package.pSourceDir'+data ProjLoc (pt :: ProjType) where+    -- | A fully specified @cabal v1-build@ project context. Here you can+    -- specify both the path to the @.cabal@ file and the source directory+    -- of the package. The cabal file path corresponds to the+    -- @--cabal-file=PATH@ flag on the @cabal@ command line.+    --+    -- Note that more than one such files existing in a package directory+    -- is a user error and while cabal will still complain about that we+    -- won't.+    --+    -- Also note that for this project type the concepts of project and+    -- package coincide.+    ProjLocV1CabalFile :: { plCabalFile :: !FilePath, plProjectDirV1 :: !FilePath } -> ProjLoc ('Cabal 'CV1)++    -- | A @cabal v1-build@ project context. Essentially the same as+    -- 'ProjLocV1CabalFile' but this will dynamically search for the cabal+    -- file for you as cabal-install does by default.+    --+    -- If more than one @.cabal@ file is found in the given directory we+    -- will shamelessly throw a obscure exception so prefer+    -- 'ProjLocV1CabalFile' if you don't want that to happen. This mainly+    -- exists for easy upgrading from the @cabal-helper-0.8@ series.+    ProjLocV1Dir :: { plProjectDirV1 :: !FilePath } -> ProjLoc ('Cabal 'CV1)++    -- | A @cabal v2-build@ project context. The path to the+    -- @cabal.project@ file, though you can call it whatever you like. This+    -- configuration file then points to the packages that make up this+    -- project. This corresponds to the @--cabal-project=PATH@ flag on the+    -- @cabal@ command line.+    ProjLocV2File    :: { plCabalProjectFile :: !FilePath, plProjectDirV2 :: !FilePath } -> ProjLoc ('Cabal 'CV2)++    -- | This is equivalent to 'ProjLocV2File' but using the default+    -- @cabal.project@ file name in the given directory.+    ProjLocV2Dir     :: { plProjectDirV2 :: !FilePath } -> ProjLoc ('Cabal 'CV2)++    -- | A @stack@ project context. Specify the path to the @stack.yaml@+    -- file here. This configuration file then points to the packages that+    -- make up this project. Corresponds to @stack@'s @--stack-yaml=PATH@+    -- command line flag if different from the default name, @stack.yaml@.+    --+    -- Note: with Stack the invariant @takeDirectory plStackYaml == projdir@ holds.+    ProjLocStackYaml :: { plStackYaml :: !FilePath } -> ProjLoc 'Stack++deriving instance Show (ProjLoc pt)++plV1Dir :: ProjLoc ('Cabal 'CV1) -> FilePath+plV1Dir ProjLocV1CabalFile {plProjectDirV1} = plProjectDirV1+plV1Dir ProjLocV1Dir {plProjectDirV1} = plProjectDirV1++plCabalProjectDir :: ProjLoc ('Cabal cpt) -> FilePath+plCabalProjectDir ProjLocV1CabalFile {plProjectDirV1} = plProjectDirV1+plCabalProjectDir ProjLocV1Dir  {plProjectDirV1} = plProjectDirV1+plCabalProjectDir ProjLocV2File {plProjectDirV2} = plProjectDirV2+plCabalProjectDir ProjLocV2Dir  {plProjectDirV2} = plProjectDirV2++plStackProjectDir :: ProjLoc 'Stack -> FilePath+plStackProjectDir ProjLocStackYaml {plStackYaml} = takeDirectory plStackYaml++projTypeOfProjLoc :: ProjLoc pt -> SProjType pt+projTypeOfProjLoc ProjLocV1CabalFile{} = SCabal SCV1+projTypeOfProjLoc ProjLocV1Dir{}       = SCabal SCV1+projTypeOfProjLoc ProjLocV2File{}      = SCabal SCV2+projTypeOfProjLoc ProjLocV2Dir{}       = SCabal SCV2+projTypeOfProjLoc ProjLocStackYaml{}   = SStack++-- | A build directory for a certain project type. The @pt@ type variable+-- must be compatible with the 'ProjLoc' used. This is enforced by the type+-- system so you can't get this wrong.+data DistDir (pt :: ProjType) where+    -- | A build-directory for cabal, aka. dist-dir in Cabal+    -- terminology. 'SCabalProjType' specifies whether we should use+    -- /v2-build/ or /v1-build/. This choice must correspond to+    -- 'ProjLoc' \'s project type.+    DistDirCabal :: !(SCabalProjType pt) -> !FilePath -> DistDir ('Cabal pt)++    -- | A build-directory for stack, aka. /work-dir/. Optionally override+    -- Stack's /work-dir/. If you just want to use Stack's default set to+    -- @Nothing@+    DistDirStack :: !(Maybe RelativePath) -> DistDir 'Stack++deriving instance Show (DistDir pt)++projTypeOfDistDir :: DistDir pt -> SProjType pt+projTypeOfDistDir (DistDirCabal pt _) = SCabal pt+projTypeOfDistDir DistDirStack{} = SStack++-- | General purpose existential wrapper. Useful for hiding a phantom type+-- argument.+--+-- Say you have:+--+-- @+-- {-\# LANGUAGE DataKinds, GADTS \#-}+-- data K = A | B | ...+-- data Q k where+--   QA :: ... -> Q 'A+--   QB :: ... -> Q 'B+-- @+--+-- and you want a list of @Q@. You can use @Ex@ to hide the phantom type+-- argument and recover it later by matching on the GADT constructors:+--+-- @+-- qa :: Q A+-- qa = QA+--+-- qb :: Q B+-- qb = QB+--+-- mylist :: [Ex Q]+-- mylist = [Ex qa, Ex qb]+-- @+data Ex a = forall x. Ex (a x)++-- | Environment for running a 'Query'. The constructor is not exposed in the+-- API to allow extending it with more fields without breaking user code.+--+-- To create a 'QueryEnv' use the 'mkQueryEnv' smart constructor instead. Some+-- field accessors are exported and may be used to override the defaults filled+-- in by 'mkQueryEnv'. See below.+--+-- Note that this environment contains an 'IORef' used as a cache. If you want+-- to take advantage of this you should not simply discard the value returned by+-- the smart constructor after one use.+type QueryEnv pt = QueryEnvI QueryCache pt++data QueryEnvI c (pt :: ProjType) = QueryEnv+    { qeReadProcess :: !ReadProcessWithCwdAndEnv+    -- ^ Field accessor for 'QueryEnv'. Function used to to start processes+    -- and capture output. Useful if you need to, for example, redirect+    -- standard error output of programs started by cabal-helper.++    , qeCallProcess :: !(CallProcessWithCwdAndEnv ())+    -- ^ Field accessor for 'QueryEnv'. Function used to to start processes+    -- without capturing output. See also 'qeReadProcess'.++    , qePrograms     :: !Programs+    -- ^ Field accessor for 'QueryEnv'. Paths to various programs we use.++    , qeProjLoc      :: !(ProjLoc pt)+    -- ^ Field accessor for 'QueryEnv'. Defines path to the project directory,+    -- i.e. a directory containing a @cabal.project@ file++    , qeDistDir      :: !(DistDir pt)+    -- ^ Field accessor for 'QueryEnv'. Defines path to the @dist/@ or+    -- @dist-newstyle/@ directory, aka. /builddir/ in Cabal terminology.++    , qeCacheRef     :: !(IORef (c pt))+    -- ^ Cache for query results, only accessible when type parameter @c@ is+    -- instantiated with 'QueryCache'. This is the case wherever the type alias+    -- 'QueryEnv' is used.++    , qeCacheKeys    :: IORef (CacheKeyCache pt)+    }++projTypeOfQueryEnv :: QueryEnvI c pt -> SProjType pt+projTypeOfQueryEnv = projTypeOfProjLoc . qeProjLoc++type ReadProcessWithCwdAndEnv   =+  String -> CallProcessWithCwdAndEnv String++type CallProcessWithCwdAndEnv a =+  Maybe FilePath -> [(String, EnvOverride)] -> FilePath -> [String] -> IO a++-- | Full instansiation of 'QueryCacheI', with all cache fields visible+type QueryCache+  = QueryCacheI+      PreInfo+      Programs+      ProjInfo+      UnitInfo++-- | 'QueryCacheI', only instantiated with 'PreInfo' cache.+type QCPreInfo progs proj_info unit_info+  = QueryCacheI+      PreInfo+      progs+      proj_info+      unit_info++-- | 'QueryCacheI', only instantiated with 'PreInfo' and configured+-- 'Programs' cache.+type QCProgs proj_info unit_info+  = QueryCacheI+      PreInfo+      Programs+      proj_info+      unit_info++data QueryCacheI pre_info progs proj_info unit_info pt = QueryCache+    { qcPreInfo+        :: !(Maybe ((ProjConf pt, ProjConfModTimes), pre_info pt))+    , qcConfProgs :: !(Maybe (Programs, progs))+    , qcProjInfo+        :: !(Maybe ((ProjConf pt, ProjConfModTimes), proj_info pt))+    , qcUnitInfos :: !(Map DistDirLib unit_info)+    }++data CacheKeyCache pt = CacheKeyCache+    { ckcProjConf :: !(Maybe (ProjConf pt, ProjConfModTimes))+    }++newtype DistDirLib = DistDirLib FilePath+    deriving (Eq, Ord, Read, Show)++type Package pt = Package' (NonEmpty (Unit pt))++-- | A 'Package' is a named collection of many 'Unit's.+data Package' units = Package+    { pPackageName :: !String+    , pSourceDir   :: !FilePath+    , pCabalFile   :: !CabalFile+    , pFlags       :: ![(String, Bool)]+    -- | Cabal flags to set when configuring and building this package.+    , pUnits       :: !units+    } deriving (Show)++-- | A 'Unit' is essentially a "build target". It is used to refer to a set+-- of components (exes, libs, tests etc.) which are managed by a certain+-- instance of the Cabal build-system[1]. We may get information on the+-- components in a unit by retriving the corresponding 'UnitInfo'.+--+-- \[1]: No I'm not talking about the cabal-install /build-tool/, I'm+-- talking about the Cabal /build-system/. Note the distinction. Both+-- cabal-install and Stack use the Cabal build-system (aka @lib:Cabal@)+-- underneath.+--+-- Note that a 'Unit' value is only valid within the 'QueryEnv' context it+-- was created in, this is however this is not enforced by the+-- API. Furthermore if the user changes the underlying project+-- configuration while your application is running even a properly scoped+-- 'Unit' could become invalid because the component it belongs to was+-- removed from the cabal file.+data Unit pt = Unit+    { uUnitId      :: !UnitId+    , uPackage     :: !(Package' ())+    , uDistDir     :: !DistDirLib+    , uImpl        :: !(UnitImpl pt)+    } deriving (Show)++data UnitImpl pt where+  UnitImplV1 :: UnitImpl ('Cabal 'CV1)++  UnitImplV2 ::+    { uiV2Components       :: ![(ChComponentName, String)]+    , uiV2OnlyDependencies :: !Bool+    } -> UnitImpl ('Cabal 'CV2)++  UnitImplStack :: UnitImpl 'Stack++deriving instance Show (UnitImpl pt)++-- | This returns the component a 'Unit' corresponds to. This information is+-- only available if the correspondence happens to be unique and known before+-- querying setup-config for the respective project type. Currently this only+-- applies to @pt=@'V2'.+--+-- This is intended to be used as an optimization, to allow reducing the number+-- of helper invocations for clients that don't need to know the entire project+-- structure.+uComponentName :: Unit pt -> Maybe ChComponentName+uComponentName Unit { uImpl=UnitImplV2 { uiV2Components=[(comp, _)] } } =+    Just comp+uComponentName _ =+    Nothing++-- | The @setup-config@ header. Note that Cabal writes all the package names in+-- the header using 'Data.ByteString.Char8' and hence all characters are+-- truncated from Unicode codepoints to 8-bit Latin-1.+--+-- We can be fairly confident that 'uhSetupId' and 'uhCompilerId' won\'t have+-- names that cause trouble here so it's ok to look at them but user packages+-- are free to have any unicode name.+data UnitHeader = UnitHeader+    { uhPackageId  :: !(ByteString, Version)+      -- ^ Name and version of the source package. This is only going to be+      -- usable for unicode package names starting with @Cabal-3.0.0.0@. See+      -- 'uiPackageId' for an alternative that always works.+    , uhSetupId    :: !(ByteString, Version)+      -- ^ Name and version of the @Setup.hs@ implementation. We expect+      -- @"Cabal"@ here, naturally.+    , uhCompilerId :: !(ByteString, Version)+      -- ^ Name and version of the compiler that was used to build+      -- Setup.hs. WARNING: This does not identify the GHC version the project+      -- is configured to use!+    } deriving (Eq, Ord, Read, Show)++newtype UnitId = UnitId String+    deriving (Eq, Ord, Read, Show)++-- | The information extracted from a 'Unit'\'s on-disk configuration cache.+data UnitInfo = UnitInfo+    { uiUnitId                :: !UnitId+    -- ^ A unique identifier of this unit within the originating project.++    , uiPackageId             :: !(String, Version)+    -- ^ The package-name and version this unit belongs to.++    , uiComponents            :: !(Map ChComponentName ChComponentInfo)+    -- ^ The components of the unit: libraries, executables, test-suites,+    -- benchmarks and so on.++    , uiCompilerId            :: !(String, Version)+    -- ^ The version of GHC the unit is configured to use++    , uiPackageFlags          :: !([(String, Bool)])+    -- ^ Flag definitions from cabal file++    , uiConfigFlags           :: ![(String, Bool)]+    -- ^ Flag assignments from active configuration++    , uiNonDefaultConfigFlags :: ![(String, Bool)]+    -- ^ Flag assignments from setup-config which differ from the default+    -- setting. This can also include flags which cabal decided to modify,+    -- i.e. don't rely on these being the flags set by the user directly.++    , uiModTimes              :: !UnitModTimes+    -- ^ Key for cache invalidation. When this is not equal to the value+    -- returned by 'getUnitModTimes' this 'UnitInfo' is considered invalid.+    } deriving (Eq, Ord, Read, Show)++-- | Files relevant to the project-scope configuration. We gather them here so+-- we can refer to their paths conveniently throughout the code. These files are+-- not necessarily guaranteed to even exist.+data ProjConf pt where+  ProjConfV1 ::+    { pcV1CabalFile :: !FilePath+    } -> ProjConf ('Cabal 'CV1)++  ProjConfV2 ::+    { pcV2CabalProjFile       :: !FilePath+    , pcV2CabalProjLocalFile  :: !FilePath+    , pcV2CabalProjFreezeFile :: !FilePath+    } -> ProjConf ('Cabal 'CV2)++  ProjConfStack ::+    { pcStackYaml :: !FilePath+    } -> ProjConf 'Stack++projTypeOfProjConf :: ProjConf pt -> SProjType pt+projTypeOfProjConf ProjConfV1{}    = SCabal SCV1+projTypeOfProjConf ProjConfV2{}    = SCabal SCV2+projTypeOfProjConf ProjConfStack{} = SStack+++-- This is supposed to be opaque, as it's only meant to be used only for cache+-- invalidation.+newtype ProjConfModTimes = ProjConfModTimes [(FilePath, EpochTime)]+    deriving (Eq, Show)++-- | Project-scope information cache.+data ProjInfo pt = ProjInfo+  { piPackages         :: !(NonEmpty (Package pt))+  , piImpl             :: !(ProjInfoImpl pt)+  , piProjConfModTimes :: !ProjConfModTimes+  -- ^ Key for cache invalidation. When this is not equal to the return+  -- value of 'getProjConfModTime' this 'ProjInfo' is considered invalid.+  } deriving (Show)++data ProjInfoImpl pt where+  ProjInfoV1 ::+    { piV1SetupHeader  :: !UnitHeader+    , piV1CabalVersion :: !CabalVersion+    } -> ProjInfoImpl ('Cabal 'CV1)++  ProjInfoV2 ::+    { piV2Plan         :: !PlanJson+    , piV2PlanModTime  :: !EpochTime+    , piV2CompilerId   :: !(String, Version)+    } -> ProjInfoImpl ('Cabal 'CV2)++  ProjInfoStack :: ProjInfoImpl 'Stack++instance Show (ProjInfoImpl pt) where+    show ProjInfoV1 {..} = concat+      [ "ProjInfoV1 {"+      , "piV1SetupHeader = ", show piV1SetupHeader, ", "+      , "}"+      ]+    show ProjInfoV2 {..} = concat+      [ "ProjInfoV2 {"+      , "piV2Plan = ", show piV2Plan, ", "+      , "piV2PlanModTime = ", show piV2PlanModTime, ", "+      , "piV2CompilerId = ", show piV2CompilerId+      , "}"+      ]+    show ProjInfoStack{} = concat+      [ "ProjInfoStack {"+      , "}"+      ]++data UnitModTimes = UnitModTimes+    { umtPkgYaml     :: !(Maybe (FilePath, EpochTime))+    , umtCabalFile   :: !(FilePath, EpochTime)+    , umtSetupConfig :: !(Maybe (FilePath, EpochTime))+    } deriving (Eq, Ord, Read, Show)+data PreInfo pt where+  PreInfoCabal :: PreInfo ('Cabal cpt)+  PreInfoStack ::+    { piStackProjPaths :: !StackProjPaths+    } -> PreInfo 'Stack++instance Show (PreInfo pt) where+    show PreInfoCabal{} = concat+      [ "PreInfoCabal {"+      , "}"+      ]+    show PreInfoStack {..} = concat+      [ "PreInfoStack {"+      , "piStackProjPaths = ", show piStackProjPaths+      , "}"+      ]++newtype CabalFile = CabalFile FilePath+    deriving (Show)++data StackProjPaths = StackProjPaths+    { sppGlobalPkgDb :: !PackageDbDir+    , sppSnapPkgDb   :: !PackageDbDir+    , sppLocalPkgDb  :: !PackageDbDir+    , sppCompExe     :: !FilePath+    } deriving (Show)+++-- Beware: GHC 8.0.2 doesn't like these being recursively defined for some+-- reason so just keep them unrolled.+type Verbose = (?verbose :: Word -> Bool)+type Env     = ( ?progs :: Programs+               , ?verbose :: Word -> Bool)+type Progs   = (?progs :: Programs)++-- | Configurable paths to various programs we use.+data Programs = Programs+    { cabalProgram    :: !FilePath+      -- ^ The path to the @cabal@ program.+    , cabalProjArgs   :: ![String]+    , cabalUnitArgs   :: ![String]++    , stackProgram    :: !FilePath+      -- ^ The path to the @stack@ program.+    , stackProjArgs   :: ![String]+    , stackUnitArgs   :: ![String]+    , stackEnv        :: ![(String, EnvOverride)]+      --  ^ TODO: Stack doesn't support passing the compiler as a+      --  commandline option so we meddle with PATH instead. We should+      --  patch that upstream.++    , ghcProgram    :: !FilePath+    -- ^ The path to the @ghc@ program.++    , ghcPkgProgram :: !FilePath+    -- ^ The path to the @ghc-pkg@ program. If not changed it will be derived+    -- from the path to 'ghcProgram'.++    , haddockProgram :: !FilePath+    -- ^ The path to the @haddock@ program. If not changed it will be+    -- derived from the path to 'ghcProgram'.+    } deriving (Eq, Ord, Show, Read, Generic, Typeable)++-- | By default all programs use their unqualified names, i.e. they will be+-- searched for on @PATH@.+defaultPrograms :: Programs+defaultPrograms =+  Programs "cabal" [] []  "stack" [] [] [] "ghc" "ghc-pkg" "haddock"++data EnvOverride+    = EnvUnset+    | EnvSet String+    | EnvAppend String+    | EnvPrepend String+      deriving (Eq, Ord, Show, Read, Generic, Typeable)++data CompileOptions = CompileOptions+    { oVerbose       :: Bool+    , oCabalPkgDb    :: Maybe PackageDbDir+    , oCabalVersion  :: Maybe Version+    , oPrograms      :: Programs+    }++oCabalProgram :: Env => FilePath+oCabalProgram = cabalProgram ?progs++defaultCompileOptions :: CompileOptions+defaultCompileOptions =+    CompileOptions False Nothing Nothing defaultPrograms++newtype PackageDbDir = PackageDbDir { unPackageDbDir :: FilePath }+    deriving (Show)+newtype PackageEnvFile = PackageEnvFile { unPackageEnvFile :: FilePath }+    deriving (Show)
+ src/CabalHelper/Compiletime/Types/Cabal.hs view
@@ -0,0 +1,59 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2020  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Types.Cabal+License     : Apache-2.0+-}++{-# LANGUAGE DeriveFunctor #-}++module CabalHelper.Compiletime.Types.Cabal where++import Data.Version++-- | Cabal library version we're compiling the helper exe against.+data CabalVersion' a+    = CabalHEAD a+    | CabalVersion { cvVersion :: Version }+      deriving (Eq, Ord, Functor)++newtype CommitId = CommitId { unCommitId :: String }++type UnpackedCabalVersion = CabalVersion' (CommitId, CabalSourceDir)+type ResolvedCabalVersion = CabalVersion' CommitId+type CabalVersion = CabalVersion' ()++data UnpackCabalVariant = Pristine | LatestRevision+newtype CabalSourceDir = CabalSourceDir { unCabalSourceDir :: FilePath }+++unpackedToResolvedCabalVersion :: UnpackedCabalVersion -> ResolvedCabalVersion+unpackedToResolvedCabalVersion (CabalHEAD (commit, _)) = CabalHEAD commit+unpackedToResolvedCabalVersion (CabalVersion ver) = CabalVersion ver++showUnpackedCabalVersion :: UnpackedCabalVersion -> String+showUnpackedCabalVersion (CabalHEAD (commitid, _)) =+  "HEAD-" ++ unCommitId commitid+showUnpackedCabalVersion CabalVersion {cvVersion} =+  showVersion cvVersion++showResolvedCabalVersion :: ResolvedCabalVersion -> String+showResolvedCabalVersion (CabalHEAD commitid) =+  "HEAD-" ++ unCommitId commitid+showResolvedCabalVersion CabalVersion {cvVersion} =+  showVersion cvVersion++showCabalVersion :: CabalVersion -> String+showCabalVersion (CabalHEAD ()) =+  "HEAD"+showCabalVersion CabalVersion {cvVersion} =+  showVersion cvVersion
+ src/CabalHelper/Compiletime/Types/RelativePath.hs view
@@ -0,0 +1,51 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Compiletime.Types.RelativePath+License     : Apache-2.0+-}++module CabalHelper.Compiletime.Types.RelativePath+    ( RelativePath+    , mkRelativePath+    , unRelativePath+    ) where++import System.FilePath++-- | A path guaranteed to be relative and not escape the base path. The+-- constructor is not exposed, use the 'mkRelativePath' smart constructor.+newtype RelativePath = RelativePath { unRelativePath :: FilePath }+    deriving (Show)++-- | Smart constructor for 'RelativePath'. Checks if the given path+-- satisfies the constraints and throws 'UserError' if not.+mkRelativePath :: FilePath -> RelativePath+mkRelativePath dir+  | isAbsolute dir =+    error $ "mkRelativePath: the path given was absolute! got: " ++ dir+  | doesRelativePathEscapeCWD dir =+    error $ "mkRelativePath: the path given escapes the base dir! got: " ++ dir+  | otherwise =+    RelativePath dir++doesRelativePathEscapeCWD :: FilePath -> Bool+doesRelativePathEscapeCWD path =+    go [] $ splitDirectories $ normalise path+       -- normalise collapses '.' in path, this is very important or this+       -- check would be traivial to defeat. For example './../' would be+       -- able to escape.+  where+    go (_:xs) ("..":ys) = go xs ys+    go    []  ("..":__) = True+    go    xs  (y   :ys) = go (y:xs) ys+    go    _         []  = False
+ src/CabalHelper/Runtime/Compat.hs view
@@ -0,0 +1,239 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE CPP, BangPatterns, RecordWildCards, RankNTypes, ViewPatterns,+  TupleSections #-}+{-# OPTIONS_GHC -fno-warn-unused-imports #-}++#ifdef MIN_VERSION_Cabal+#undef CH_MIN_VERSION_Cabal+#define CH_MIN_VERSION_Cabal MIN_VERSION_Cabal+#endif++module CabalHelper.Runtime.Compat+    ( UnitId+    , componentNameToCh+    , unUnqualComponentName'+    , componentNameFromComponent+    , componentOutDir+    , internalPackageDBPath+    , unFlagAssignment+    ) where++import System.FilePath++import Distribution.PackageDescription+  ( PackageDescription+  , GenericPackageDescription(..)+  , Flag(..)+  , FlagName+  , FlagAssignment+  , Executable(..)+  , Library(..)+  , TestSuite(..)+  , Benchmark(..)+  , BuildInfo(..)+  , TestSuiteInterface(..)+  , BenchmarkInterface(..)+  , withLib+  )+import Distribution.Simple.LocalBuildInfo+  ( ComponentName(..)+  , Component(..)+  , LocalBuildInfo(..)+  )+++#if CH_MIN_VERSION_Cabal(1,24,0)+import Distribution.Package (UnitId)+#else+import Distribution.Package (InstalledPackageId)+#endif++#if CH_MIN_VERSION_Cabal(1,25,0)+-- >=1.25+import Distribution.PackageDescription+  ( unFlagName+  -- , mkFlagName+  )+import Distribution.Types.ForeignLib+  ( ForeignLib(..)+  )+import Distribution.Types.UnqualComponentName+  ( UnqualComponentName+  , unUnqualComponentName+  )+#else+-- <1.25+import Distribution.PackageDescription+  ( FlagName(FlagName)+  )+#endif++#if CH_MIN_VERSION_Cabal(2,0,0)+-- CPP >= 2.0+import Distribution.Simple.LocalBuildInfo+  ( allLibModules+  , componentBuildDir+  )+import Distribution.Simple.Register+  ( internalPackageDBPath+  )+import Distribution.Backpack+  ( OpenUnitId(..),+    OpenModule(..)+  )+import Distribution.ModuleName+  ( ModuleName+  )+import Distribution.Types.ComponentId+  ( unComponentId+  )+import Distribution.Types.ComponentLocalBuildInfo+  ( maybeComponentInstantiatedWith+  )+import Distribution.Types.ModuleRenaming+  ( ModuleRenaming(..),+    isDefaultRenaming+  )+import Distribution.Types.MungedPackageId+  ( MungedPackageId+  )+import Distribution.Types.UnitId+  ( UnitId+  , unDefUnitId+  , unUnitId+  )+import Distribution.Types.UnitId+  ( DefUnitId+  )+import Distribution.Utils.NubList+  ( toNubListR+  )+import Distribution.Version+  ( versionNumbers+  , mkVersion+  )+import qualified Distribution.InstalledPackageInfo as Installed+#endif++#if CH_MIN_VERSION_Cabal(3,2,0)+import Distribution.Types.Flag+  ( unFlagAssignment+  )+#elif CH_MIN_VERSION_Cabal(2,2,0)+import Distribution.Types.GenericPackageDescription+  ( unFlagAssignment+  )+#else+#define NOP_UN_FLAG_ASSIGNMENT 1+#endif++#if CH_MIN_VERSION_Cabal(2,5,0)+import Distribution.Types.LibraryName+  ( LibraryName (..)+  )+#endif+++import CabalHelper.Shared.Common+import CabalHelper.Shared.InterfaceTypes++++++++#if !CH_MIN_VERSION_Cabal(1,24,0)+type UnitId = InstalledPackageId+#endif++++componentNameToCh :: ComponentName -> ChComponentName+#if CH_MIN_VERSION_Cabal(2,5,0)+componentNameToCh (CLibName LMainLibName) = ChLibName ChMainLibName+componentNameToCh (CLibName (LSubLibName n)) = ChLibName $ ChSubLibName (unUnqualComponentName' n)+#elif CH_MIN_VERSION_Cabal(2,0,0)+componentNameToCh CLibName = ChLibName ChMainLibName+componentNameToCh (CSubLibName n) = ChLibName $ ChSubLibName (unUnqualComponentName' n)+#else+componentNameToCh CLibName = ChLibName ChMainLibName+#endif+#if CH_MIN_VERSION_Cabal(2,0,0)+componentNameToCh (CFLibName n) = ChFLibName (unUnqualComponentName' n)+#endif+componentNameToCh (CExeName n) = ChExeName (unUnqualComponentName' n)+componentNameToCh (CTestName n) = ChTestName (unUnqualComponentName' n)+componentNameToCh (CBenchName n) = ChBenchName (unUnqualComponentName' n)+++#if CH_MIN_VERSION_Cabal(1,25,0)+-- CPP >= 1.25+unUnqualComponentName' :: UnqualComponentName -> String+unUnqualComponentName' = unUnqualComponentName+#else+unUnqualComponentName' :: a -> a+unUnqualComponentName' = id+#endif+++componentNameFromComponent :: Component -> ComponentName+#if CH_MIN_VERSION_Cabal(2,5,0)+componentNameFromComponent (CLib Library { libName = n }) = CLibName n+componentNameFromComponent (CFLib ForeignLib {..}) = CFLibName foreignLibName+#elif CH_MIN_VERSION_Cabal(1,25,0)+-- CPP >= 1.25 (redundant)+componentNameFromComponent (CLib Library { libName = Nothing }) = CLibName+componentNameFromComponent (CLib Library { libName = Just n })  = CSubLibName n+componentNameFromComponent (CFLib ForeignLib {..}) = CFLibName foreignLibName+#else+-- CPP < 1.25+componentNameFromComponent (CLib Library {}) = CLibName+#endif+componentNameFromComponent (CExe Executable {..}) = CExeName exeName+componentNameFromComponent (CTest TestSuite {..}) = CTestName testName+componentNameFromComponent (CBench Benchmark {..}) = CBenchName benchmarkName+++componentOutDir :: LocalBuildInfo -> Component -> FilePath+componentOutDir lbi (CLib Library {..})=+    buildDir lbi+#if CH_MIN_VERSION_Cabal(2,0,0)+componentOutDir lbi (CFLib ForeignLib {..}) =+    componentOutDir' lbi (unUnqualComponentName foreignLibName)+#endif+componentOutDir lbi (CExe Executable {..}) =+    componentOutDir' lbi (unUnqualComponentName' exeName)+componentOutDir lbi (CTest TestSuite { testInterface = TestSuiteLibV09 _ _, ..}) =+    componentOutDir' lbi (unUnqualComponentName' testName ++ "Stub")+componentOutDir lbi (CTest TestSuite { testInterface = _, ..}) =+    componentOutDir' lbi (unUnqualComponentName' testName)+componentOutDir lbi (CBench Benchmark { benchmarkInterface = _, ..})=+    componentOutDir' lbi (unUnqualComponentName' benchmarkName)++componentOutDir' :: LocalBuildInfo -> String -> FilePath+componentOutDir' lbi compName' =+  ----- Copied from Distribution/Simple/GHC.hs:buildOrReplExe+  let targetDir = (buildDir lbi) </> compName'+      compDir    = targetDir </> (compName' ++ "-tmp")+  in compDir++#if !CH_MIN_VERSION_Cabal(2,0,0)+internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath+internalPackageDBPath lbi distPref =+  distPref </> "package.conf.inplace"+#endif++#ifdef NOP_UN_FLAG_ASSIGNMENT+unFlagAssignment = id+#endif
+ src/CabalHelper/Runtime/HelperMain.hs view
@@ -0,0 +1,510 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE CPP, BangPatterns, RecordWildCards, RankNTypes, ViewPatterns,+  TupleSections #-}+{-# OPTIONS_GHC -fno-warn-unused-imports #-}+{-  # OPTIONS_GHC -Wno-missing-signatures #-}+{-  # OPTIONS_GHC -fno-warn-incomplete-patterns #-}++#ifdef MIN_VERSION_Cabal+#undef CH_MIN_VERSION_Cabal+#define CH_MIN_VERSION_Cabal MIN_VERSION_Cabal+#endif++module CabalHelper.Runtime.HelperMain (helper_main) where++import Distribution.Simple.Utils (cabalVersion)+import Distribution.Simple.Configure+import Distribution.Package+  ( PackageIdentifier+  , PackageId+  , packageName+  , packageVersion+  )+import Distribution.PackageDescription+  ( PackageDescription+  , GenericPackageDescription(..)+  , Flag(..)+  , FlagName+  , FlagAssignment+  , Executable(..)+  , Library(..)+  , TestSuite(..)+  , Benchmark(..)+  , BuildInfo(..)+  , TestSuiteInterface(..)+  , BenchmarkInterface(..)+  , withLib+  )+import Distribution.PackageDescription.Configuration+  ( flattenPackageDescription+  )+import Distribution.Simple.Program+  ( requireProgram+  , ghcProgram+  )+import Distribution.Simple.Program.Types+  ( ConfiguredProgram(..)+  )+import Distribution.Simple.Configure+  ( getPersistBuildConfig+  )+import Distribution.Simple.LocalBuildInfo+  ( LocalBuildInfo(..)+  , Component(..)+  , ComponentName(..)+  , ComponentLocalBuildInfo(..)+  , componentBuildInfo+  , withAllComponentsInBuildOrder+  , withLibLBI+  , withExeLBI+  )+import Distribution.Simple.GHC+  ( componentGhcOptions+  )+import Distribution.Simple.Program.GHC+  ( GhcOptions(..)+  , renderGhcOptions+  )+import Distribution.Simple.Setup+  ( ConfigFlags(..)+  , Flag(..)+  , fromFlagOrDefault+  )+import Distribution.Simple.Build+  ( initialBuildSteps+  )+import Distribution.Simple.BuildPaths+  ( cppHeaderName+  )+import Distribution.Simple.Compiler+  ( PackageDB(..)+  , compilerId+  )+import Distribution.Compiler+  ( CompilerId(..)+  )+import Distribution.ModuleName+  ( components+  )+import qualified Distribution.ModuleName as C+  ( ModuleName+  )+import Distribution.Text+  ( display+  )+import Distribution.Verbosity+  ( Verbosity+  , silent+  , deafening+  , normal+  )+import Distribution.Version+  ( Version+  )++#if CH_MIN_VERSION_Cabal(1,22,0)+-- CPP >= 1.22+import Distribution.Utils.NubList+#endif++#if CH_MIN_VERSION_Cabal(1,23,0)+-- >= 1.23+import Distribution.Simple.LocalBuildInfo+  ( localUnitId+  )+#else+-- <= 1.22+import Distribution.Simple.LocalBuildInfo+  ( inplacePackageId+  )+#endif++#if CH_MIN_VERSION_Cabal(1,25,0)+-- >=1.25+import Distribution.PackageDescription+  ( unFlagName+  -- , mkFlagName+  )+import Distribution.Types.ForeignLib+  ( ForeignLib(..)+  )+import Distribution.Types.UnqualComponentName+  ( UnqualComponentName+  , unUnqualComponentName+  )+#else+-- <1.25+import Distribution.PackageDescription+  ( FlagName(FlagName)+  )+#endif++#if CH_MIN_VERSION_Cabal(2,0,0)+-- CPP >= 2.0+import Distribution.Simple.LocalBuildInfo+  ( allLibModules+  , componentBuildDir+  )+import Distribution.Backpack+  ( OpenUnitId(..),+    OpenModule(..)+  )+import Distribution.ModuleName+  ( ModuleName+  )+import Distribution.Types.ComponentId+  ( unComponentId+  )+import Distribution.Types.ComponentLocalBuildInfo+  ( maybeComponentInstantiatedWith+  )+import Distribution.Types.ModuleRenaming+  ( ModuleRenaming(..),+    isDefaultRenaming+  )+import Distribution.Types.MungedPackageId+  ( MungedPackageId+  )+import Distribution.Types.UnitId+  ( UnitId+  , unDefUnitId+  , unUnitId+  )+import Distribution.Types.UnitId+  ( DefUnitId+  )+import Distribution.Utils.NubList+  ( toNubListR+  )+import Distribution.Version+  ( versionNumbers+  , mkVersion+  )+import qualified Distribution.InstalledPackageInfo as Installed+#endif++import Control.Applicative ((<$>), (<*>), ZipList(..))+import Control.Arrow (first, second, (&&&))+import Control.Monad+import Control.Exception (catch, PatternMatchFail(..))+import Data.List+import qualified Data.Map.Strict as Map+import Data.Maybe+import Data.Monoid+import Data.IORef+import qualified Data.Version as DataVersion+import System.Environment+import System.Directory+import System.FilePath+import System.Exit+import System.IO+import System.IO.Unsafe (unsafeInterleaveIO, unsafePerformIO)+import Text.Printf++import CabalHelper.Shared.Common+import CabalHelper.Shared.InterfaceTypes+import CabalHelper.Runtime.Compat++usage :: IO ()+usage = do+  prog <- getProgName+  hPutStr stderr $ "Usage: " ++ prog ++ " " ++ usageMsg+ where+   usageMsg = ""+     ++"CABAL_FILE DIST_DIR (v1|v2)\n"+     ++"  ( version\n"+     ++"  | flags\n"+     ++"  | config-flags\n"+     ++"  | non-default-config-flags\n"+     ++"  | write-autogen-files\n"+     ++"  | compiler-id\n"+     ++"  | component-info\n"+     ++"  | print-lbi [--human]\n"+     ++"  ) ...\n"++commands :: [String]+commands = [ "flags"+           , "config-flags"+           , "non-default-config-flags"+           , "write-autogen-files"+           , "compiler-id"+           , "package-db-stack"+           , "component-info"+           , "print-lbi"+           ]++helper_main :: [String] -> IO [Maybe ChResponse]+helper_main args = do+  cfile : distdir : pt : args'+    <- case args of+         [] -> usage >> exitFailure+         _ -> return args++  ddexists <- doesDirectoryExist distdir+  when (not ddexists) $ do+         errMsg $ "distdir '"++distdir++"' does not exist"+         exitFailure++  v <- maybe silent (const deafening) . lookup  "CABAL_HELPER_DEBUG" <$> getEnvironment+  lbi <- unsafeInterleaveIO $ getPersistBuildConfig distdir+  gpd <- unsafeInterleaveIO $ readPackageDescription v cfile+  let pd = localPkgDescr lbi+  let lvd = (lbi, v, distdir)++  let+      -- a =<< b $$ c   ==  (a =<< b) $$ c+      infixr 2 $$+      ($$) = ($)++      collectCmdOptions :: [String] -> [[String]]+      collectCmdOptions =+          reverse . map reverse . foldl f [] . dropWhile isOpt+       where+         isOpt = ("--" `isPrefixOf`)+         f [] x = [[x]]+         f (a:as) x+             | isOpt x = (x:a):as+             | otherwise = [x]:(a:as)++  let cmds = collectCmdOptions args'++  flip mapM cmds $$ \x -> do+  case x of+    "version":[] ->+      return $ Just $ ChResponseVersion ("Cabal", toDataVersion cabalVersion)++    "package-id":[] ->+      return $ Just $ ChResponseVersion $ (,)+        (display (packageName gpd))+        (toDataVersion (packageVersion gpd))++    "flags":[] -> do+      return $ Just $ ChResponseFlags $ sort $+        map (flagName' &&& flagDefault) $ genPackageFlags gpd++    "config-flags":[] -> do+      return $ Just $ ChResponseFlags $ sort $+        map (first unFlagName)+          $ unFlagAssignment+          $ configConfigurationsFlags+          $ configFlags lbi++    "non-default-config-flags":[] -> do+      let flagDefinitons = genPackageFlags gpd+          flagAssgnments =+#if CH_MIN_VERSION_Cabal(2,2,0)+            unFlagAssignment $ configConfigurationsFlags+#else+            configConfigurationsFlags+#endif+              $ configFlags lbi+          nonDefaultFlags =+              [ (flag_name, val)+              | MkFlag {flagName=(unFlagName -> flag_name'), flagDefault=def_val} <- flagDefinitons+              , (unFlagName -> flag_name, val) <- flagAssgnments+              , flag_name == flag_name'+              , val /= def_val+              ]+      return $ Just $ ChResponseFlags $ sort nonDefaultFlags++    "write-autogen-files":[] -> do+      initialBuildStepsForAllComponents distdir pd lbi v+      return Nothing++    "compiler-id":[] -> do+      let CompilerId comp ver = compilerId $ compiler lbi+      return $ Just $ ChResponseVersion $ (,) (show comp) (toDataVersion ver)++    "component-info":[] -> do+      res <- componentsInfo lvd pt+      return $ Just $ ChResponseComponentsInfo res++    "print-lbi":flags ->+      case flags of+        ["--human"] -> print lbi >> return Nothing+        _           -> return $ Just $ ChResponseLbi $ show lbi++    cmd:_ | not (cmd `elem` commands) ->+            errMsg ("Unknown command: " ++ cmd) >> usage >> exitFailure+    _ ->+            errMsg "Invalid usage!" >> usage >> exitFailure++type ProjectType = String -- either "v1" or "v2"++componentsInfo+    :: (LocalBuildInfo, Verbosity, FilePath)+    -> ProjectType+    -> IO (Map.Map ChComponentName ChComponentInfo)+componentsInfo lvd@(lbi, v, distdir) pt = do+      let mod_ghc_opts opts+            | pt == "v1" = opts {+                ghcOptPackageDBs =+                  -- c.f. Simple/Build.hs createInternalPackageDB call+                  ghcOptPackageDBs opts +++                  [SpecificPackageDB $ internalPackageDBPath lbi distdir]+                }+            | pt == "v2" = opts+            | otherwise = error $ "Unknown project-type '"++pt++"'!"++      ciGhcOptions <- componentOptions lvd mod_ghc_opts++      ciSourceDirs <- componentsMap lbi v distdir $ \_ _ bi -> return $ hsSourceDirs bi++      ciEntrypoints <- componentsMap lbi v distdir $ \c _clbi _bi ->+               return $ componentEntrypoints c++      let comp_name = map fst ciGhcOptions+          uiComponents = Map.fromList+                      $ map (ciComponentName &&& id)+                      $ getZipList+                      $ ChComponentInfo+                     <$> ZipList comp_name+                     <*> ZipList (map snd ciGhcOptions)+                     <*> ZipList (map snd ciSourceDirs)+                     <*> ZipList (map snd ciEntrypoints)++      return uiComponents+++flagName' :: Distribution.PackageDescription.Flag -> String+flagName' = unFlagName . flagName++componentsMap :: LocalBuildInfo+              -> Verbosity+              -> FilePath+              -> (   Component+                  -> ComponentLocalBuildInfo+                  -> BuildInfo+                  -> IO a)+              -> IO [(ChComponentName, a)]+componentsMap lbi _v _distdir f = do+    let pd = localPkgDescr lbi++    lr <- newIORef []++    -- withComponentsLBI is deprecated but also exists in very old versions+    -- it's equivalent to withAllComponentsInBuildOrder in newer versions+    withAllComponentsInBuildOrder pd lbi $ \c clbi -> do+        let bi = componentBuildInfo c+            name = componentNameToCh $ componentNameFromComponent c++        l' <- readIORef lr+        r <- f c clbi bi+        writeIORef lr $ (name, r) : l'++    reverse <$> readIORef lr++componentOptions'+    :: (LocalBuildInfo, Verbosity, FilePath)+    -> (LocalBuildInfo -> Verbosity -> GhcOptions -> IO a)+    -> (GhcOptions -> GhcOptions)+    -> IO [(ChComponentName, a)]+componentOptions' (lbi, v, distdir) rf f = do+  componentsMap lbi v distdir $ \c clbi bi ->+         let+           outdir = componentOutDir lbi c+           opts = componentGhcOptions normal lbi bi clbi outdir++         in rf lbi v $ f opts++componentOptions :: (LocalBuildInfo, Verbosity, FilePath)+                 -> (GhcOptions -> GhcOptions)+                 -> IO [(ChComponentName, [String])]+componentOptions (lbi, v, distdir) f =+    componentOptions' (lbi, v, distdir) renderGhcOptions' f++gmModuleName :: C.ModuleName -> ChModuleName+gmModuleName = ChModuleName . intercalate "." . components+++initialBuildStepsForAllComponents+    :: FilePath+    -> PackageDescription+    -> LocalBuildInfo+    -> Verbosity+    -> IO ()+initialBuildStepsForAllComponents distdir pd lbi v =+  initialBuildSteps distdir pd lbi v++++#if !CH_MIN_VERSION_Cabal(1,25,0)+-- CPP < 1.25+unFlagName :: FlagName -> String+unFlagName (FlagName n) = n+-- mkFlagName n = FlagName n+#endif++toDataVersion :: Version -> DataVersion.Version+--fromDataVersion :: DataVersion.Version -> Version+#if CH_MIN_VERSION_Cabal(2,0,0)+toDataVersion v = DataVersion.Version (versionNumbers v) []+--fromDataVersion (DataVersion.Version vs _) = mkVersion vs+#else+toDataVersion = id+--fromDataVersion = id+#endif++++componentEntrypoints :: Component -> ChEntrypoint+componentEntrypoints (CLib Library {..})+    = ChLibEntrypoint+        (map gmModuleName exposedModules)+        (map gmModuleName $ otherModules libBuildInfo)+#if CH_MIN_VERSION_Cabal(2,0,0)+        (map gmModuleName signatures)+#else+        [] -- no signatures prior to Cabal 2.0+#endif+#if CH_MIN_VERSION_Cabal(2,0,0)+componentEntrypoints (CFLib (ForeignLib{..}))+    = ChLibEntrypoint+        []+        (map gmModuleName $ otherModules foreignLibBuildInfo)+        []+#endif+componentEntrypoints (CExe Executable {..})+    = ChExeEntrypoint+        modulePath+        (map gmModuleName $ otherModules buildInfo)+componentEntrypoints (CTest TestSuite { testInterface = TestSuiteExeV10 _ fp, ..})+    = ChExeEntrypoint fp (map gmModuleName $ otherModules testBuildInfo)+componentEntrypoints (CTest TestSuite { testInterface = TestSuiteLibV09 _ mn, ..})+    = ChLibEntrypoint [gmModuleName mn] (map gmModuleName $ otherModules testBuildInfo) []+componentEntrypoints (CTest TestSuite {})+    = ChLibEntrypoint [] [] []+componentEntrypoints (CBench Benchmark { benchmarkInterface = BenchmarkExeV10 _  fp, ..})+    = ChExeEntrypoint fp (map gmModuleName $ otherModules benchmarkBuildInfo)+componentEntrypoints (CBench Benchmark {})+    = ChLibEntrypoint [] [] []++renderGhcOptions' :: LocalBuildInfo+                  -> Verbosity+                  -> GhcOptions+                  -> IO [String]+#if !CH_MIN_VERSION_Cabal(1,20,0)+renderGhcOptions' lbi v opts = do+-- CPP < 1.20+  (ghcProg, _) <- requireProgram v ghcProgram (withPrograms lbi)+  let Just ghcVer = programVersion ghcProg+  return $ renderGhcOptions ghcVer opts+#elif CH_MIN_VERSION_Cabal(1,20,0) && !CH_MIN_VERSION_Cabal(1,24,0)+renderGhcOptions' lbi _v opts = do+-- CPP >= 1.20 && < 1.24+  return $ renderGhcOptions (compiler lbi) opts+#else+renderGhcOptions' lbi _v opts = do+-- CPP >= 1.24+  return $ renderGhcOptions (compiler lbi) (hostPlatform lbi) opts+#endif
+ src/CabalHelper/Runtime/Main.hs view
@@ -0,0 +1,16 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++import CabalHelper.Runtime.HelperMain (helper_main)+import System.Environment++main :: IO ()+main = getArgs >>= helper_main >>= print
+ src/CabalHelper/Shared/Common.hs view
@@ -0,0 +1,158 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-|+Module      : CabalHelper.Shared.Common+Description : Shared utility functions+License     : Apache-2.0+-}++{-# LANGUAGE CPP, DeriveDataTypeable, OverloadedStrings #-}+module CabalHelper.Shared.Common where++#ifdef MIN_VERSION_Cabal+#undef CH_MIN_VERSION_Cabal+#define CH_MIN_VERSION_Cabal MIN_VERSION_Cabal+#endif++import Distribution.PackageDescription+    ( GenericPackageDescription+    )+import Distribution.Verbosity+    ( Verbosity+    )++#if CH_MIN_VERSION_Cabal(2,2,0)+import qualified Distribution.PackageDescription.Parsec as P+#else+import qualified Distribution.PackageDescription.Parse as P+#endif++import Control.Applicative+import Control.Exception as E+import Control.Monad+import Data.Char+import Data.List+import Data.Maybe+import Data.Version+import Data.Typeable+import Data.ByteString (ByteString)+import qualified Data.ByteString as BS+import qualified Data.ByteString.Char8 as BS8+import System.Environment+import System.IO+import qualified System.Info+import System.Exit+import System.Directory+import System.FilePath+import Text.ParserCombinators.ReadP+import Prelude++data Panic = Panic String deriving (Typeable)+instance Exception Panic+instance Show Panic where+    show (Panic msg) = "panic! " ++ msg++panic :: String -> a+panic msg = throw $ Panic msg++panicIO :: String -> IO a+panicIO msg = throwIO $ Panic msg++handlePanic :: IO a -> IO a+handlePanic action =+    action `E.catch` \(Panic msg) -> errMsg msg >> exitFailure++errMsg :: String -> IO ()+errMsg str = do+  prog <- getProgName+  hPutStrLn stderr $ prog ++ ": " ++ str++parsePkgId :: String -> Maybe (String, Version)+parsePkgId s =+    case span (/='-') (reverse s) of+      (vers, '-':pkg) -> Just (reverse pkg, parseVer (reverse vers))+      _ -> Nothing++parsePkgIdBS :: ByteString -> Maybe (ByteString, Version)+parsePkgIdBS bs =+    case BS8.span (/='-') (BS.reverse bs) of+      (vers, pkg') ->+          Just ( BS.reverse $ BS.tail pkg'+               , parseVer (BS8.unpack (BS.reverse vers)))++parseVer :: String -> Version+parseVer vers = runReadP parseVersion vers++parseVerMay :: String -> Maybe Version+parseVerMay vers = runReadPMay parseVersion vers++trim :: String -> String+trim = dropWhileEnd isSpace++majorVer :: Version -> Version+majorVer (Version b _) = Version (take 2 b) []++sameMajorVersionAs :: Version -> Version -> Bool+sameMajorVersionAs a b = majorVer a == majorVer b++runReadP :: ReadP t -> String -> t+runReadP p i =+  case runReadPMay p i of+    Just x -> x+    Nothing -> error $ "Error parsing version: " ++ show i++runReadPMay :: ReadP t -> String -> Maybe t+runReadPMay p i = case filter ((=="") . snd) $ readP_to_S p i of+                 (a,""):[] -> Just a+                 _ -> Nothing+++appCacheDir :: IO FilePath+appCacheDir =+    (</> "cabal-helper") <$> getEnvDefault "XDG_CACHE_HOME" (homeRel cache)+ where+    -- for GHC 7.4+    lookupEnv' var = do env <- getEnvironment; return (lookup var env)+    getEnvDefault var def = lookupEnv' var >>= \m -> case m of Nothing -> def; Just x -> return x+    homeRel path = (</> path) <$> getHomeDirectory+    cache =+        case System.Info.os of+          "mingw32" -> windowsCache+          _         -> unixCache++    windowsCache = "Local Settings" </> "Cache"+    unixCache = ".cache"++replace :: String -> String -> String -> String+replace n r hs' = go "" hs'+ where+   go acc h+       | take (length n) h == n =+           reverse acc ++ r ++ drop (length n) h+   go acc (h:hs) = go (h:acc) hs+   go acc [] = reverse acc+++readPackageDescription+    :: Verbosity+    -> FilePath+    -> IO GenericPackageDescription+#if CH_MIN_VERSION_Cabal(2,0,0)+readPackageDescription = P.readGenericPackageDescription+#else+readPackageDescription = P.readPackageDescription+#endif++mightExist :: FilePath -> IO (Maybe FilePath)+mightExist f = do+  exists <- doesFileExist f+  return $ if exists then (Just f) else (Nothing)
+ src/CabalHelper/Shared/InterfaceTypes.hs view
@@ -0,0 +1,92 @@+-- cabal-helper: Simple interface to Cabal's configuration state+-- Copyright (C) 2015-2018  Daniel Gröber <cabal-helper@dxld.at>+--+-- SPDX-License-Identifier: Apache-2.0+--+-- Licensed under the Apache License, Version 2.0 (the "License");+-- you may not use this file except in compliance with the License.+-- You may obtain a copy of the License at+--+--     http://www.apache.org/licenses/LICENSE-2.0++{-# LANGUAGE DeriveGeneric, DeriveDataTypeable, DefaultSignatures #-}++{-|+Module      : CabalHelper.Shared.InterfaceTypes+Description : Types which are used by c-h library and executable to communicate+License     : Apache-2.0++These types are used to communicate between the cabal-helper library and helper+executable, using Show/Read. If any types in this module change the major+version must be bumped since this will be exposed in the @Distribution.Helper@+module.++The cached executables in @$XDG_CACHE_HOME/cabal-helper@ use the cabal-helper+version (among other things) as a cache key so we don't need to worry about+talking to an old executable.+-}+module CabalHelper.Shared.InterfaceTypes where++import GHC.Generics+import Data.Version+import Data.Map.Strict (Map)++data ChResponse+    = ChResponseComponentsInfo (Map ChComponentName ChComponentInfo)+    | ChResponseList           [String]+    | ChResponseLbi            String+    | ChResponseVersion        (String, Version)+    | ChResponseFlags          [(String, Bool)]+  deriving (Eq, Ord, Read, Show, Generic)++data ChComponentName = ChSetupHsName+                     | ChLibName ChLibraryName+                     | ChFLibName String+                     | ChExeName String+                     | ChTestName String+                     | ChBenchName String+  deriving (Eq, Ord, Read, Show, Generic)++data ChLibraryName = ChMainLibName+                   | ChSubLibName String+  deriving (Eq, Ord, Read, Show, Generic)++newtype ChModuleName = ChModuleName { unChModuleName :: String }+    deriving (Eq, Ord, Read, Show, Generic)++data ChComponentInfo = ChComponentInfo+    { ciComponentName         :: ChComponentName+    -- ^ The component\'s type and name++    , ciGhcOptions            :: [String]+    -- ^ Full set of GHC options, ready for loading this component into GHCi.++    , ciSourceDirs            :: [String]+    -- ^ A component's @hs-source-dirs@ field, note that this only contains the+    -- directories specified by the cabal file, however cabal also adds the+    -- output directory of preprocessors to GHC's search path when+    -- building. TODO: make this easier to use.++    , ciEntrypoints           :: ChEntrypoint+    -- ^ Modules or files Cabal would have the compiler build directly. Can be+    -- used to compute the home module closure for a component.+    } deriving (Eq, Ord, Read, Show)++data ChEntrypoint+    = ChSetupEntrypoint+      { chMainIs :: FilePath+      }+    | ChLibEntrypoint+      { chExposedModules :: [ChModuleName]+      , chOtherModules   :: [ChModuleName]+      , chSignatures     :: [ChModuleName] -- backpack only+      }+    | ChExeEntrypoint+      { chMainIs         :: FilePath+      , chOtherModules   :: [ChModuleName]+      } deriving (Eq, Ord, Read, Show, Generic)++data ChPkgDb = ChPkgGlobal+             | ChPkgUser+             | ChPkgSpecific FilePath+               deriving (Eq, Ord, Read, Show, Generic)
+ tests/CacheTest.hs view
@@ -0,0 +1,243 @@+-- | This test ensures caches are updated when on-disk project state changes.+--+-- For example when a cabal file changes we have to call the project's build+-- tool to regenerate @setup-config@s. When a @setup-config@ file changes we+-- have to re-run the helper to get the 'UnitInfo'.++module Main where++import GHC+import GHC.Paths (libdir)+import DynFlags++import qualified Control.Exception as E+import Control.Monad+import Control.Monad.IO.Class+import Data.List+import Data.Version+import qualified Data.Map as Map+import System.Environment (getArgs)+import System.Exit+import System.FilePath ((</>), takeFileName, takeDirectory)+import System.Directory+import System.IO+import System.IO.Temp+import System.Process (readProcess)++import Distribution.Helper++import CabalHelper.Shared.Common+import CabalHelper.Compiletime.Process+++main :: IO ()+main = do+  args <- getArgs+  topdir <- getCurrentDirectory+  res <- mapM (setup topdir test) $ case args of+    [] -> [ ("tests/exelib/exelib.cabal",       parseVer "1.10", parseVer "0")+          , ("tests/exeintlib/exeintlib.cabal", parseVer "2.0",  parseVer "0")+          , ("tests/fliblib/fliblib.cabal",     parseVer "2.0",  parseVer "0")+          , ("tests/bkpregex/bkpregex.cabal",   parseVer "2.0",  parseVer "8.1")+          --                           min Cabal lib ver -^   min GHC ver -^+          ]+    xs -> map (, parseVer "0", parseVer "0") xs++  if any (==False) $ concat res+    then exitFailure+    else exitSuccess++cabalInstallVersion :: IO Version+cabalInstallVersion =+    parseVer . trim <$> readProcess "cabal" ["--numeric-version"] ""++ghcVersion :: IO Version+ghcVersion =+    parseVer . trim <$> readProcess "ghc" ["--numeric-version"] ""++cabalInstallBuiltinCabalVersion :: IO Version+cabalInstallBuiltinCabalVersion =+    parseVer . trim <$> readProcess "cabal"+        ["act-as-setup", "--", "--numeric-version"] ""++data ProjSetup pt =+  ProjSetup+    { psDistDir   :: FilePath -> DistDir pt+    , psProjDir   :: FilePath -> ProjLoc pt+    , psConfigure :: FilePath -> IO ()+    , psBuild     :: FilePath -> IO ()+    , psSdist     :: FilePath -> FilePath -> IO ()+    }++oldBuild :: ProjSetup 'V1+oldBuild = ProjSetup+    { psDistDir   = \dir -> DistDirV1 (dir </> "dist")+    , psProjDir   = \cabal_file -> ProjLocCabalFile cabal_file+    , psConfigure = \dir ->+        runWithCwd dir "cabal" [ "configure" ]+    , psBuild     = \dir ->+        runWithCwd dir "cabal" [ "build" ]+    , psSdist     = \srcdir destdir ->+        runWithCwd srcdir "cabal" [ "sdist", "-v0", "--output-dir", destdir ]+    }++newBuild :: ProjSetup 'V2+newBuild = ProjSetup+    { psDistDir   = \dir  -> DistDirV2 (dir </> "dist-newstyle")+    , psProjDir   = \cabal_file -> ProjLocV2Dir (takeDirectory cabal_file)+    , psConfigure = \dir ->+        runWithCwd dir "cabal" [ "new-configure" ]+    , psBuild     = \dir ->+        runWithCwd dir "cabal" [ "new-build" ]+    , psSdist     = \srcdir destdir ->+        runWithCwd srcdir "cabal" [ "sdist", "-v0", "--output-dir", destdir ]+    }++setup :: FilePath -> (forall pt . ProjSetup pt -> FilePath -> IO [Bool]) -> (FilePath, Version, Version) -> IO [Bool]+setup topdir act (cabal_file, min_cabal_ver, min_ghc_ver) = do+    let projdir = takeDirectory cabal_file+    ci_ver <- cabalInstallVersion+    c_ver <- cabalInstallBuiltinCabalVersion+    g_ver <- ghcVersion+    let mreason+          | (ci_ver < parseVer "1.24") =+            Just $ "cabal-install-" ++ showVersion ci_ver ++ " is too old"+          | c_ver < min_cabal_ver =+            Just $ "Cabal-" ++ showVersion c_ver+                   ++ " < " ++ showVersion min_cabal_ver+          | g_ver < min_ghc_ver =+            Just $ "ghc-" ++ showVersion g_ver+                   ++ " < " ++ showVersion min_ghc_ver+          | otherwise =+            Nothing++    case mreason of+      Just reason -> do+        putStrLn $ "Skipping test '" ++ projdir ++ "' because " ++ reason ++ "."+        return []+      Nothing -> do+        putStrLn $ "Running test '" ++ projdir ++ "' with " ++ showVersion ci_ver ++ "."+        putStrLn "Old build -------------------------------------"+        rold <- runTest oldBuild topdir projdir cabal_file act+        putStrLn "New build -------------------------------------"+        rnew <- runTest newBuild topdir projdir cabal_file act+        return (rold ++ rnew)++runTest :: ProjSetup pt -> FilePath -> String -> FilePath+        -> (ProjSetup pt -> FilePath -> IO [Bool]) -> IO [Bool]+runTest ps@ProjSetup{..} topdir projdir cabal_file act = do+  putStrLn $ "Running test '" ++ projdir ++ "'-------------------------"+  withSystemTempDirectory' "cabal-helper.ghc-session.test" $ \tmpdir -> do++    psSdist (topdir </> projdir) tmpdir+    psConfigure tmpdir++    act ps $ tmpdir </> takeFileName cabal_file++runWithCwd :: FilePath -> String -> [String] -> IO ()+runWithCwd cwd x xs = do+  let ?verbose = True+  callProcessStderr (Just cwd) x xs++run :: String -> [String] -> IO ()+run x xs = do+  let ?verbose = True+  callProcessStderr Nothing x xs++test :: ProjSetup pt -> FilePath -> IO [Bool]+test ProjSetup{..} cabal_file = do+    let projdir = takeDirectory cabal_file+    qe <- mkQueryEnv+            (psProjDir cabal_file)+            (psDistDir projdir)+    cs <- concat <$> runQuery (allUnits (Map.elems . uiComponents)) qe+    forM cs $ \ChComponentInfo{..} -> do+        putStrLn $ "\n" ++ show ciComponentName ++ ":::: " ++ show ciNeedsBuildOutput++        when (ciNeedsBuildOutput == ProduceBuildOutput) $ do+          psBuild projdir++        let opts' = "-Werror" : ciGhcOptions++        let sopts = intercalate " " $ map formatArg $ "\nghc" : opts'+        putStrLn $ "\n" ++ show ciComponentName ++ ": " ++ sopts+        hFlush stdout+        compileModule projdir ciNeedsBuildOutput ciEntrypoints opts'+  where+    formatArg x+        | "-" `isPrefixOf` x = "\n  "++x+        | otherwise          = x++addCabalProject :: FilePath -> IO ()+addCabalProject dir = do+  writeFile (dir </> "cabal.project") "packages: .\n"++compileModule+    :: FilePath -> NeedsBuildOutput -> ChEntrypoint -> [String] -> IO Bool+compileModule projdir nb ep opts = do+    setCurrentDirectory projdir++    putStrLn $ "compiling:" ++ show ep ++ " (" ++ show nb ++ ")"++    E.handle (\(ec :: ExitCode) -> print ec >> return False) $ do++    defaultErrorHandler defaultFatalMessager defaultFlushOut $ do++    runGhc (Just libdir) $ do++    handleSourceError (\e -> GHC.printException e >> return False) $ do++    let target = case nb of+          ProduceBuildOutput -> HscNothing -- AZ: what should this be?+          NoBuildOutput      -> HscInterpreted++    dflags0 <- getSessionDynFlags+    let dflags1 = dflags0 {+        ghcMode   = CompManager+      , ghcLink   = LinkInMemory+      , hscTarget = target+      , optLevel  = 0+      }++    (dflags2, _, _) <- parseDynamicFlags dflags1 (map noLoc opts)+    _ <- setSessionDynFlags dflags2++    ts <- mapM (\t -> guessTarget t Nothing) $+         case ep of+           ChLibEntrypoint ms ms' ss -> map unChModuleName $ ms ++ ms' ++ ss+           ChExeEntrypoint m'  ms    ->+             let++               -- The options first clear out includes, then put in the build+               -- dir. We want the first one after that, so "regex-example" in+               -- the following case+               --+               -- ,"-i"+               -- ,"-idist/build/regex-example"+               -- ,"-iregex-example"+               firstInclude = drop 2 $ head $ drop 2 $ filter (isPrefixOf "-i") opts+               m = firstInclude </> m'+             in [m] ++ map unChModuleName ms+           ChSetupEntrypoint         -> ["Setup.hs"]++    let ts' = case nb of+                NoBuildOutput -> map (\t -> t { targetAllowObjCode = False }) ts+                ProduceBuildOutput -> ts++    setTargets ts'+    _ <- load LoadAllTargets++    when (nb == NoBuildOutput) $ do+      setContext $ case ep of+        ChLibEntrypoint ms ms' ss ->+            map (IIModule . mkModuleName . unChModuleName) $ ms ++ ms' ++ ss+        ChExeEntrypoint _  ms  ->+            map (IIModule . mkModuleName . unChModuleName) $ ChModuleName "Main" : ms+        ChSetupEntrypoint      ->+            map (IIModule . mkModuleName) ["Main"]++    liftIO $ print ExitSuccess+    return True++unChModuleName :: ChModuleName -> String+unChModuleName (ChModuleName  mn) = mn
+ tests/CompileTest.hs view
@@ -0,0 +1,183 @@+{-# LANGUAGE ScopedTypeVariables, GADTs, ImplicitParams, OverloadedStrings #-}++{-| This test tries to compile the Helper against every supported version of the+  Cabal library. Since we compile the Helper at runtime, on the user's machine,+  it is very important to make sure this will not fail to compile.++  This test only covers using v2-build to install the requested Cabal library+  version because it has the best build product caching (keeps CI times+  down). We could also use stack since it has a global package cache but we+  don't support that because stack always comes with the right Cabal library+  version available for a given resolver anyways.+-}++import System.Environment (getArgs)+import System.Directory+import System.FilePath+import System.Process+import System.Exit+import System.IO+import System.IO.Temp+import Data.List+import Data.Maybe+import Data.Version+import Data.Functor+import Data.Function+import Distribution.Version (VersionRange, withinRange)+import Control.Arrow+import Control.Monad+import Control.Monad.Trans.Maybe+import Prelude++import CabalHelper.Compiletime.Compat.Environment+import CabalHelper.Compiletime.Compat.Version+import CabalHelper.Compiletime.Compat.Parsec+import CabalHelper.Compiletime.Cabal+import CabalHelper.Compiletime.Compile+import CabalHelper.Compiletime.Program.GHC+import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.Types.Cabal+import CabalHelper.Shared.Common++import TestOptions++withinRange'CH :: Version -> VersionRange -> Bool+withinRange'CH v r =+    withinRange (fromDataVersion v) r++setupHOME :: IO ()+setupHOME = do+  mhome <- lookupEnv "HOME"+  case mhome of+    Just home -> do+      exists <- doesDirectoryExist home+      when (not exists) createHOME+    Nothing -> createHOME++createHOME :: IO ()+createHOME = do+  tmp <- fromMaybe "/tmp" <$> lookupEnv "TMPDIR"+  let home = tmp </> "compile-test-home"+  _ <- rawSystem "rm" ["-r", home]+  createDirectory home+  setEnv "HOME" home++main :: IO ()+main = do+  (modProgs, args) <- testOpts =<< getArgs++  let ?progs = modProgs defaultPrograms+  let ?opts = defaultCompileOptions { oVerbose = True }+  let ?verbose = \level -> case level of 1 -> True; _ -> False++  case args of+    "list-versions":[] -> do+        mapM_ print =<< relevantCabalVersions =<< ghcVersion+    "list-versions":ghc_ver_str:[] ->+        mapM_ print =<< relevantCabalVersions (GhcVersion (parseVer ghc_ver_str))+    _ ->+        test args++test :: Env => [String] -> IO ()+test args = do+  let action+       | null args = testRelevantCabalVersions+       | otherwise = testCabalVersions $ map parseVer' args++  setupHOME++  action++parseVer' :: String -> CabalVersion+parseVer' "HEAD" = CabalHEAD ()+parseVer' v      = CabalVersion $ parseVer v++relevantCabalVersions :: GhcVersion -> IO [Version]+relevantCabalVersions g = map snd . filter fst <$> allCabalVersions g++allCabalVersions :: GhcVersion -> IO [(Bool,Version)]+allCabalVersions (GhcVersion ghc_ver) = do+  cabal_versions+      <- map parseVer . lines <$> readFile "tests/cabal-versions"+  let+    constraint :: VersionRange+    constraint =+        fromMaybe (error $ "No cabal version constraint found for " ++ show ghc_ver) $+        fmap snd $+        find (and . (zipWith (==) `on` versionBranch) ghc_ver . fst) $+        constraint_table++    constraint_table :: [(Version, VersionRange)]+    constraint_table =+        map (parseVer *** (absorbParsecFailure "constraint_table" . eitherParsec)) $+            -- , ("7.8"  , ">= 1.18    && < 2")+            [ ("7.10" , ">= 1.22.2  && < 2")+            , ("8.0.1", ">= 1.24          ")+            , ("8.0.2", ">= 1.24.2        ")+            , ("8.2",   ">= 1.24.2.0      ")+            , ("8.4",   ">= 2.0.0.2       ")+            , ("8.6",   ">= 2.0.0.2       ")+            , ("8.8",   ">= 3.0.0.0       ")+            , ("8.10",  ">= 3.2.0.0       ")+            ]+  return $ reverse $ map (flip withinRange'CH constraint &&& id) cabal_versions+++testRelevantCabalVersions :: Env => IO ()+testRelevantCabalVersions = do+  ghc_ver <- ghcVersion+  relevant_cabal_versions <- relevantCabalVersions ghc_ver+  testCabalVersions $ map CabalVersion relevant_cabal_versions ++ [CabalHEAD ()]++testCabalVersions :: Env => [CabalVersion] -> IO ()+testCabalVersions versions = do+--  ghcVer <- ghcVersion+  rvs <- forM versions $ \cv -> do+    withSystemTempDirectory "cabal-helper.proj-local-tmp" $ \tmpdir -> do++    let sver = showCabalVersion cv+    hPutStrLn stderr $ "\n\n\n\n\n\n====== Compiling with Cabal-" ++ sver++    let che0 = \icv db -> CompHelperEnv+          { cheCabalVer = icv+          , chePkgDb = db+          , cheProjDir = tmpdir+          , chePjUnits = Nothing+          , cheDistV2 = Just $ tmpdir </> "dist-newstyle"+          , cheProjLocalCacheDir =+              tmpdir </> "dist-newstyle" </> "cache"+          }++    che <- case cv of+      CabalHEAD () -> do+        rcv <- resolveCabalVersion cv+        db <- getPrivateCabalPkgDb rcv+        mcabalVersions <- runMaybeT $ listCabalVersions (Just db)+        case mcabalVersions of+          Just [hdver] ->+            return $ che0 (CabalVersion hdver) [db]+          _ ->+            return $ che0 (CabalHEAD ()) []+      (CabalVersion ver) ->+        return $ che0 (CabalVersion ver) []++    compileHelper che++  let printStatus (cv, rv) = putStrLn $ "- Cabal "++ver++" "++status+        where  ver = showCabalVersion cv+               status = case rv of+                         Right _ ->+                             "succeeded"+                         Left rvc ->+                             "failed (exit code "++show rvc++")"++  let drvs = versions `zip` rvs++  mapM_ printStatus drvs+  if any isLeft' $ map snd $ filter ((/=(CabalHEAD ())) . fst) drvs+     then exitFailure+     else exitSuccess++ where+   isLeft' (Left _) = True+   isLeft' (Right _) = False
+ tests/Examples.hs view
@@ -0,0 +1,65 @@+{-# LANGUAGE ScopedTypeVariables #-}++module Main where++import Distribution.Helper+import Data.Foldable+    ( toList )+import System.Process+    ( system )+import System.Environment+    ( getArgs )+import System.Exit+    ( ExitCode(ExitSuccess) )+import System.IO+    ( hPutStrLn, stderr )+import System.Console.GetOpt+    ( OptDescr(Option), ArgDescr(NoArg), ArgOrder(RequireOrder), getOpt+    , usageInfo )++main :: IO ()+main = do+  args <- getArgs+  actions <- parseOpts args+  sequence_ actions++-- | Run shell command and+systemV :: String -> IO ()+systemV shell_cmd = do+  hPutStrLn stderr $ "$ " ++ shell_cmd+  ExitSuccess <- system shell_cmd+  return ()++options :: [OptDescr (IO ())]+options =+ [ Option [] ["cabal"]          (NoArg doCabalV2)     ""+ , Option [] ["cabal-old-v1"]   (NoArg doCabalV1)     ""+ , Option [] ["stack"]          (NoArg doCabalV2)     ""+ ]++parseOpts :: [String] -> IO [IO ()]+parseOpts argv =+   case getOpt RequireOrder options argv of+      (o, [], []  ) ->+          return o+      (_, _, errs) ->+          ioError (userError (concat errs ++ usageInfo header options))+  where header = "Usage: examples (--cabal|--cabal-old-v1|--stack)..."++doCabalV2 :: IO ()+doCabalV2 = do+  _ <- systemV "cabal new-build --builddir=dist-newstyle"+  qe <- mkQueryEnv (ProjLocV2Dir ".") (DistDirCabal SCV2 "dist-newstyle/")+  printUnitInfos qe++doCabalV1 :: IO ()+doCabalV1 = return ()++doStack :: IO ()+doStack = return ()++printUnitInfos :: QueryEnv pt -> IO ()+printUnitInfos qe = do+  components :: [ChComponentInfo]+      <- concat <$> runQuery (allUnits (toList . uiComponents)) qe+  print components
+ tests/GhcSession.hs view
@@ -0,0 +1,581 @@+{-# LANGUAGE TupleSections, ScopedTypeVariables, RecordWildCards, RankNTypes,+  DataKinds, ExistentialQuantification, PolyKinds, ViewPatterns,+  DeriveFunctor, MonoLocalBinds, GADTs, MultiWayIf #-}++{-| This test ensures we can get a GHC API session up and running in a+  variety of project environments.+-}++module Main where++import GHC+import Config+import Outputable+import DynFlags++import qualified Control.Exception as E+import Control.Monad+import Control.Monad.IO.Class+import Data.List+import Data.Maybe+import Data.Version+import Data.Bifunctor+import qualified Data.Map as Map+import System.Environment (getArgs)+import System.Exit+import System.FilePath ((</>), (<.>), makeRelative, takeDirectory)+import System.Directory+import System.IO+import System.IO.Unsafe (unsafePerformIO)+import System.IO.Temp+import Text.Printf (printf)+import Text.Show.Pretty (pPrint)++import Distribution.Helper++import CabalHelper.Shared.Common+import CabalHelper.Compiletime.Types (Env)+import CabalHelper.Compiletime.Process (readProcess, callProcessStderr)+import CabalHelper.Compiletime.Program.GHC+  (GhcVersion(..), ghcVersion, ghcLibdir)+import CabalHelper.Compiletime.Program.CabalInstall+  (CabalInstallVersion(..), cabalInstallVersion)++import TestOptions++data TestConfig = TC+  { location        :: TestLocation+  , cabalLowerBound :: Version+  , ghcLowerBound   :: Version+  , projTypes       :: [ProjType]+  } deriving (Show)++data TestLocation+  = TN String+  | TF FilePath FilePath FilePath+    deriving (Show)++testConfigToTestSpec :: TestConfig -> ProjType -> String+testConfigToTestSpec (TC loc _ _ _) pt =+  let (topdir, projdir, cabal_file) = testLocPath loc in+  "- " ++ intercalate ":" [topdir, projdir, cabal_file, show pt]++main :: IO ()+main = do+  (modProgs, args) <- testOpts =<< getArgs+  topdir <- getCurrentDirectory++  let withEnv :: (Env => a) -> a+      withEnv action =+        let ?verbose = const False+            ?progs = modProgs defaultPrograms+        in action++  GhcVersion g_ver <- withEnv ghcVersion+  CabalInstallVersion ci_ver <- withEnv cabalInstallVersion+  s_ver <- withEnv stackVersion+    `E.catch` \(_ :: IOError) -> return (makeVersion [0])++  -- Cabal lib version+  f_c_ver :: ProjType -> Either SkipReason Version <- do+    ci_c_ver <- Right <$> withEnv cabalInstallBuiltinCabalVersion+    s_c_ver :: Either SkipReason Version+      <- sequence $ withEnv stackBuiltinCabalVersion s_ver g_ver+    return $ \pt -> case pt of+      Cabal CV1 -> ci_c_ver+      Cabal CV2 -> ci_c_ver+      Stack -> s_c_ver++  let showEsrVer = either (\(SkipReason msg) -> "dunno, "++msg) showVersion++  putStrLn "Environment Info"+  putStrLn "================"+  putStrLn ""+  putStrLn $ "cabal-install version: " ++ showVersion ci_ver+  putStrLn $ "cabal-install builtin Cabal version: "+             ++ showEsrVer (f_c_ver (Cabal CV1))+  putStrLn $ "GHC executable version: " ++ showVersion g_ver+  putStrLn $ "GHC library version: " ++ cProjectVersion+  putStrLn $ "Stack version: " ++ showVersion s_ver+  putStrLn $ "Stack Cabal version: " ++ showEsrVer (f_c_ver Stack)+  putStrLn ""++  when (cProjectVersion /= showVersion g_ver) $+    error "GHC version mismatch! See above."++  let proj_impls :: [(ProjType, ProjSetup0)]+      proj_impls =+        -- V2 is sorted before the others here so helper compilation always+        -- uses v2-build caching!+        [ (Cabal CV2, newBuildProjSetup topdir)+        , (Cabal CV1, oldBuildProjSetup)+        , (Stack, stackProjSetup g_ver)+        ]+      all_proj_types = map fst proj_impls++  tests <- return $ case args of+    xs@(_:_) -> flip map xs $ \loc ->+      let (topdir, ':':x0) = span (/=':') loc+          (projdir0, ':':x1) = span (/=':') x0+          (cabal_file0, ':':pt) = span (/=':') x1+          projdir = makeRelative topdir projdir0+          cabal_file = makeRelative topdir cabal_file0 in+      TC (TF topdir projdir cabal_file) (parseVer "0") (parseVer "0") [read pt]+    [] ->+      -- below V2 is sorted before Stack and V1 since we rely on v2-build's+      -- fucking awesome store cache to keep CI times down.+      --+      -- TODO: Better test coverage for helper compilation with the other two!+      [ TC (TN "exelib")       (parseVer "1.10") (parseVer "0")   []+      , TC (TN "exeintlib")    (parseVer "2.0")  (parseVer "0")   []+      , TC (TN "fliblib")      (parseVer "2.0")  (parseVer "0")   []+      , TC (TN "custom-setup") (parseVer "1.24") (parseVer "0")   [Cabal CV2, Stack]+      --  ^ Custom setup has issues in v1. Specifically we can get into the+      --  situation where v1-configure --with-ghc=... will pick one Cabal+      --  lib version but then v1-build (without --with-ghc) will pick+      --  another because the system ghc has different packages available+      --  than the --with-ghc one.+      --+      -- At this point a setup recompile happens and hell breaks loose+      -- because setup-config is mismatched. The reason we can't just pass+      -- --with-ghc to v1-build to fix this is that it will actually ignore+      -- it as far as setup compilation is concerned while v1-configure+      -- will pick it up.+      --+      -- We could fuck around with $PATH in the v1-build case too but I+      -- really don't think that many people use v1 still and with+      -- built-type:custom no less.+      --+      -- See haskell/cabal#6749+      , TC (TN "bkpregex")     (parseVer "2.0")  (parseVer "8.1") [Cabal CV2, Cabal CV1]+      , TC (TN "src-repo")     (parseVer "2.4")  (parseVer "0")   [Cabal CV2]+      , let multipkg_loc = TF "tests/multipkg/" "proj/" "proj/proj.cabal" in+        TC  multipkg_loc       (parseVer "1.10") (parseVer "0")   [Cabal CV2, Stack]+      --            min Cabal lib ver -^    min GHC ver -^+      ]++  putStrLn "Going to Run These Tests"+  putStrLn "========================"+  forM_ tests $ \tc@(TC _ _ _ pts) -> do+    forM_ (if pts == [] then all_proj_types else pts)  $ \pt ->+      putStrLn $ testConfigToTestSpec tc pt++  pPrint tests+  putStrLn ""++  res :: [[TestResult]] <- sequence $ do+    tc@TC {..} <- tests+    (pt, ps0 :: ProjSetup0) <- proj_impls+    guard (null projTypes || pt `elem` projTypes)++    let skip (SkipReason reason) = do+          putStrLn $ intercalate " "+            [ "\n\n\nSkipping test"+            , psdHeading ps0+            , "'" ++ topdir </> projdir_rel ++ "'"+            , "because"+            , reason+            ]+          where+            (topdir, projdir_rel, _) = testLocPath location++    case psdImpl ps0 of+      Left reason -> return $ skip reason >> return []+      Right eximpl -> do+        let ps1 = ps0 { psdImpl = eximpl }+        case checkAndRunTestConfig modProgs VerEnv{..} ps1 tc of+          Left reason -> return $ skip reason >> return []+          Right (Message msg, act) -> return $ putStrLn msg >> act++  putStr "\n\n\n\n"+  putStrLn "Test Results"+  putStrLn "============"+  pPrint res++  if any (==False) $ map trSuccess $ concat res+    then exitFailure+    else exitSuccess++data VerEnv = VerEnv+  { ci_ver :: !Version+  -- ^ cabal-install exe version+  , f_c_ver :: !(ProjType -> Either SkipReason Version)+  -- ^ cabal-install/Stack builtin Cabal library version+  , g_ver  :: !Version+  -- ^ GHC exe version+  , s_ver  :: !Version+  -- ^ Stack exe version+  }++data Message = Message String+data SkipReason = SkipReason String+data TestResult+    = TestResult+      { trSuccess :: Bool+      , trComp    :: ChComponentName+      , trHeading :: String -- ^ project type+      , trDir     :: FilePath+      , trSpec    :: String+      }+ deriving (Show)++testLocPath :: TestLocation -> (FilePath, FilePath, FilePath)+testLocPath (TN test_name) = (projdir, ".", cabal_file)+  where+    projdir :: FilePath+    projdir = "tests" </> test_name+    cabal_file :: FilePath+    cabal_file = test_name <.> "cabal"+testLocPath (TF topdir projdir cabal_file) =+    (topdir, projdir, cabal_file)++-- | Check version bounds of tests against available versions, if successful run+-- the test.+checkAndRunTestConfig+    :: ModProgs+    -> VerEnv+    -> ProjSetup1+    -> TestConfig+    -> Either SkipReason (Message, IO [TestResult])+checkAndRunTestConfig+  modProgs+  VerEnv { ci_ver, f_c_ver, g_ver, s_ver }+  ps1@(psdImpl -> Ex psdImpl2)+  tc@(TC test_loc min_cabal_ver min_ghc_ver _proj_types)+  = let+  pt = demoteSProjType $ psiProjType psdImpl2+  (topdir, projdir_rel, cabal_file) = testLocPath test_loc in do+  c_ver <- f_c_ver pt+  first SkipReason $ do+  if| Stack <- pt, Left (SkipReason msg) <- stackCheckCompat s_ver ->+      Left $ msg+    | ci_ver < parseVer "1.24" ->+      Left $ "cabal-install-" ++ showVersion ci_ver ++ " is too old"+    | c_ver < min_cabal_ver ->+      Left $ pt_disp pt ++ "'s builtin Cabal version is too old:\n"+             ++ "Cabal-" ++ showVersion c_ver+             ++ " < " ++ showVersion min_cabal_ver+    | g_ver < min_ghc_ver ->+      Left $ "ghc-" ++ showVersion g_ver+             ++ " < " ++ showVersion min_ghc_ver+    | otherwise ->+      Right ()+  return $ (,)+    (Message $ intercalate " "+      [ "\n\n\nRunning test"+      , psdHeading ps1+      , "'" ++ topdir ++ "'"+      ])+    $ do+      trs <- runTest+        modProgs ps1{ psdImpl = psdImpl2 } topdir projdir_rel cabal_file+      return $ map ($ testConfigToTestSpec tc pt) trs++  where+    pt_disp (Cabal CV1) = "cabal-install"+    pt_disp (Cabal CV2) = "cabal-install"+    pt_disp Stack = "Stack"+++runTest+    :: ModProgs -> ProjSetup2 pt+    -> FilePath -> FilePath -> FilePath+    -> IO [String -> TestResult]+runTest modProgs ps2@(psdImpl -> ProjSetupImpl{..}) topdir projdir cabal_file+  = do+  withSystemTempDirectory' "cabal-helper.ghc-session.test" $ \tmpdir -> do+    trs <- test modProgs ps2 topdir tmpdir (tmpdir </> projdir) (tmpdir </> cabal_file)+    return $+      map ($ (topdir </> projdir)) $+      map ($ (psdHeading ps2)) $+      trs++runWithCwd :: FilePath -> String -> [String] -> IO ()+runWithCwd cwd x xs = do+  let ?verbose = (<=1)+  callProcessStderr (Just cwd) [] x xs++run :: String -> [String] -> IO ()+run x xs = do+  let ?verbose = (<=1)+  callProcessStderr Nothing [] x xs++test+    :: ModProgs -> ProjSetup2 pt+    -> FilePath -> FilePath -> FilePath -> FilePath+    -> IO [(String -> String -> FilePath -> TestResult)]+test modProgs (psdImpl -> ProjSetupImpl{..}) topdir tmpdir projdir cabal_file+  = do+    qe' <- psiQEmod <$> mkQueryEnv+            (psiProjLoc (CabalFile cabal_file) projdir)+            (psiDistDir projdir)++    let progs = modProgs (qePrograms qe')+        qe = qe' { qePrograms = progs }++    ghc_libdir <- let ?progs = progs; ?verbose = const False in ghcLibdir++    psiSdist progs topdir tmpdir++    cs <- concat <$> runQuery (allUnits (Map.elems . uiComponents)) qe++    -- TODO: Cludge until we can just build the unit dependencies+    runQuery buildProject qe++    let pkgdir = takeDirectory cabal_file+    homedir <- getHomeDirectory+    let var_table =+          [ (pkgdir,  "${pkgdir}")+          , (homedir, "${HOME}")+          ]++    forM cs $ \ChComponentInfo{..} -> do+        let opts' = "-Werror" : ciGhcOptions+        let sopts = intercalate " " $ map formatArg $ "ghc" : map (normalizeOutputWithVars var_table) opts'++        putStrLn $ "\n" ++ show ciComponentName ++ ":\n"+        hPutStrLn stderr $ "cd " ++ pkgdir -- messes up normalized output+        putStrLn sopts++        hFlush stdout+        tr <- compileModule ghc_libdir pkgdir ciEntrypoints ciSourceDirs opts'+        return $ tr ciComponentName+  where+    formatArg x+        | "-" `isPrefixOf` x = "\\\n  "++x+        | otherwise          = x++addCabalProject :: FilePath -> IO ()+addCabalProject dir = do+  writeFile (dir </> "cabal.project") "packages: .\n"++compileModule+    :: FilePath -> FilePath -> ChEntrypoint -> [FilePath] -> [String]+    -> IO (ChComponentName -> FilePath -> String -> String -> TestResult)+compileModule ghc_libdir pkgdir ep srcdirs opts = do+    cwd_before <- getCurrentDirectory+    setCurrentDirectory pkgdir+    flip E.finally (setCurrentDirectory cwd_before) $ do++    putStrLn $ "compiling: " ++ show ep++    E.handle (\(ec :: ExitCode) -> print ec >> return (TestResult False)) $ do++    defaultErrorHandler defaultFatalMessager defaultFlushOut $ do+    runGhc (Just ghc_libdir) $ do+    let printGhcEx e = GHC.printException e >> return (TestResult False)+    handleSourceError printGhcEx $ do++    let target = HscInterpreted -- TODO++    dflags0 <- getSessionDynFlags+    let dflags1 = dflags0 {+        ghcMode   = CompManager+      , ghcLink   = LinkInMemory+      , hscTarget = target+      , optLevel  = 0+      }++    (dflags2, _, _) <- parseDynamicFlags dflags1 (map noLoc opts)+    _ <- setSessionDynFlags dflags2++    ts <- mapM (\t -> guessTarget t Nothing) =<<+         case ep of+           ChLibEntrypoint ms ms' ss -> return $+             map unChModuleName $ ms ++ ms' ++ ss+           ChExeEntrypoint m  ms -> do+             -- TODO: this doesn't take preprocessor outputs in+             -- dist/build/$pkg/$pkg-tmp/ into account.+             m1 <- liftIO $ findFile srcdirs m+             case m1 of+               Just m2 -> return $ [m2] ++ map unChModuleName ms+               Nothing -> error $ printf+                 "Couldn't find source file for Main module (%s), search path:\n\+                 \%s\n" m (show srcdirs)+           ChSetupEntrypoint m -> return [m]++    -- Always compile targets as GHCi bytecode so the setContext call below+    -- can always succeed+    let ts' = map (\t -> t { targetAllowObjCode = False }) ts++    liftIO $ putStrLn $ "targets: " ++ showPpr dflags2 ts'++    setTargets ts'+    _ <- load LoadAllTargets++--    when (nb == NoBuildOutput) $ do+    do+      setContext $ case ep of+        ChLibEntrypoint ms ms' ss ->+            map (IIModule . mkModuleName . unChModuleName) $ ms ++ ms' ++ ss+        ChExeEntrypoint _  ms  ->+            map (IIModule . mkModuleName . unChModuleName) $ ChModuleName "Main" : ms+        ChSetupEntrypoint _    ->+            map (IIModule . mkModuleName) ["Main"]++    return $ TestResult True+++data CabalFile = CabalFile FilePath++type ProjSetup0 = ProjSetupDescr (Either SkipReason (Ex ProjSetupImpl))+type ProjSetup1 = ProjSetupDescr (Ex ProjSetupImpl)+type ProjSetup2 pt = ProjSetupDescr (ProjSetupImpl pt)++data ProjSetupDescr a =+  ProjSetupDescr+    { psdHeading :: !String+    , psdImpl    :: !a+    } deriving (Functor)++data ProjSetupImpl pt =+  ProjSetupImpl+    { psiProjType  :: !(SProjType pt)+    , psiDistDir   :: !(FilePath -> DistDir pt)+    , psiProjLoc   :: !(CabalFile -> FilePath -> ProjLoc pt)+    , psiSdist     :: !(Programs -> FilePath -> FilePath -> IO ())+    , psiQEmod     :: !(QueryEnv pt -> QueryEnv pt)+    }++oldBuildProjSetup :: ProjSetup0+oldBuildProjSetup = ProjSetupDescr "cabal-v1" $ Right $ Ex $ ProjSetupImpl+    { psiProjType  = SCabal SCV1+    , psiDistDir   = \dir -> DistDirCabal SCV1 (dir </> "dist")+    , psiProjLoc   = \(CabalFile cf) projdir -> ProjLocV1CabalFile cf projdir+    , psiSdist     = \progs srcdir destdir ->+        copyMuliPackageProject progs srcdir destdir (\_ _ -> return ())+    , psiQEmod     = id+    }++newBuildProjSetup :: FilePath -> ProjSetup0+newBuildProjSetup topdir+  = ProjSetupDescr "cabal-v2" $ Right $ Ex $ ProjSetupImpl+    { psiProjType  = SCabal SCV2+    , psiDistDir   = \dir  -> DistDirCabal SCV2 (dir </> "dist-newstyle")+    , psiProjLoc   = \_cabal_file projdir -> ProjLocV2File (projdir </> "cabal.project") projdir+                     -- TODO: check if cabal.project is there and only use+                     -- V2File then, also remove addCabalProject below so we+                     -- cover both cases.+    , psiSdist     = \progs srcdir destdir -> do+        copyMuliPackageProject progs srcdir destdir $ \pkgsrc pkgdest -> do+          exists <- doesFileExist (pkgsrc </> "cabal.project")+          if exists then+            writeFile (pkgdest </> "cabal.project") =<< replaceStrings [("${topdir}", topdir)] <$> readFile (pkgsrc </> "cabal.project")+          else+            addCabalProject pkgdest+    , psiQEmod     = id+    }++stackProjSetup :: Version -> ProjSetup0+stackProjSetup ghcVer =+    ProjSetupDescr "stack" $ do+    res <- lookupStackResolver ghcVer+    let argsBefore = [ "--resolver="++res, "--system-ghc" ]+    return $ Ex $ ProjSetupImpl+      { psiProjType  = SStack+      , psiDistDir   = \_dir  -> DistDirStack Nothing+      , psiProjLoc   = \_cabal_file projdir ->+          ProjLocStackYaml $ projdir </> "stack.yaml"+      , psiSdist     = \progs srcdir destdir -> do+          copyMuliPackageProject progs srcdir destdir copyStackYamls+      , psiQEmod     = \qe ->+          qe { qePrograms = (qePrograms qe)+               { stackProjArgs = argsBefore+               }+             }+      }++lookupStackResolver :: Version -> Either SkipReason String+lookupStackResolver ghcVer = maybe (Left msg) Right $+    lookup ghcVer stack_resolver_table+  where+    msg = SkipReason $ "missing stack_resolver_table entry for "+++                       showVersion ghcVer++stack_resolver_table :: [(Version, String)] -- ^ (ghc version, stack resolver)+stack_resolver_table = unsafePerformIO $+  map (\(words -> [g, l]) -> (parseVer g, l)) . lines+  <$> readFile "tests/stack-resolvers"++copyStackYamls :: FilePath -> FilePath -> IO ()+copyStackYamls srcdir destdir = do+  files <- (\\ [".", ".."]) <$> getDirectoryContents srcdir+  let ymls = filter (".yaml" `isSuffixOf`) $+             filter ("stack-" `isPrefixOf`) $ files+  forM_ ymls $ \filename -> copyFile (srcdir </> filename) (destdir </> filename)++-- | For each Cabal package listed in a @packages.list@ file, copy the package+-- to another directory while only including source files referenced in the+-- cabal file.+copyMuliPackageProject+    :: Programs -> FilePath -> FilePath -> (FilePath -> FilePath -> IO ()) -> IO ()+copyMuliPackageProject progs srcdir destdir copyPkgExtra = do+  let packages_file = srcdir </> "packages.list"+  pkgdirs <- lines <$> readFile packages_file+  forM_ pkgdirs $ \pkgdir -> do+    runWithCwd (srcdir </> pkgdir) (cabalProgram progs)+      [ "act-as-setup", "--", "sdist"+      , "--output-directory="++destdir </> pkgdir ]+    copyPkgExtra (srcdir </> pkgdir) (destdir </> pkgdir)++stackVersion :: (?progs :: Programs) => IO Version+stackVersion =+  parseVer . trim <$> readProcess (stackProgram ?progs) [ "--numeric-version" ] ""++stackBuiltinCabalVersion+    :: (?progs :: Programs)+    => Version -> Version -> Either SkipReason (IO Version)+stackBuiltinCabalVersion s_ver g_ver = do+    _ <- stackCheckCompat s_ver+    res <- lookupStackResolver g_ver+    return $ parseVer . trim <$> readProcess (stackProgram ?progs)+        [ "--resolver="++res, "--system-ghc", "exec", "--"+        , "ghc-pkg", "--simple-output", "--global", "field", "Cabal", "version"+        ] ""++stackCheckCompat :: Version -> Either SkipReason ()+stackCheckCompat s_ver =+  if| s_ver < parseVer "1.9.4" ->+        Left $ SkipReason $ "stack-" ++ showVersion s_ver ++ " is too old"+    | otherwise ->+        Right ()++cabalInstallBuiltinCabalVersion :: (?progs :: Programs) => IO Version+cabalInstallBuiltinCabalVersion =+    parseVer . trim <$> readProcess (cabalProgram ?progs)+        ["act-as-setup", "--", "--numeric-version"] ""++normalizeOutputWithVars = replaceStrings+replaceStrings :: [(String, String)] -> String -> String+replaceStrings ts str =+  case filter (isJust . fst) $ map (first (flip stripPrefix str)) ts of+    (Just rest, replacement) : _ ->+        replacement ++ replaceStrings ts rest+    _ -> cont+  where+    cont =+      case str of+        s:ss -> s : replaceStrings ts ss+        [] -> []+-- ---------------------------------------------------------------------+-- | Create and use a temporary directory in the system standard temporary directory.+--+-- Behaves exactly the same as 'withTempDirectory', except that the parent temporary directory+-- will be that returned by 'getCanonicalTemporaryDirectory'.+withSystemTempDirectory' :: String   -- ^ Directory name template+                        -> (FilePath -> IO a) -- ^ Callback that can use the directory+                        -> IO a+withSystemTempDirectory' template action+  = liftIO getCanonicalTemporaryDirectory >>= \tmpDir' -> withTempDirectory' tmpDir' template action++-- | Create and use a temporary directory inside the given directory.+--+-- The directory is deleted after use.+withTempDirectory' :: FilePath -- ^ Parent directory to create the directory in+                  -> String   -- ^ Directory name template+                  -> (FilePath -> IO a) -- ^ Callback that can use the directory+                  -> IO a+withTempDirectory' targetDir template =+  gbracket+    (liftIO (createTempDirectory targetDir template))+    (\x -> return x) -- Leave the dir for inspection later
+ tests/MultiGhcSession.hs view
@@ -0,0 +1,105 @@+{-# LANGUAGE ScopedTypeVariables #-}++module Main where++import Distribution.Helper+import Data.Foldable+    ( toList )+import System.Process+    ( system )+import System.Environment+    ( getArgs )+import System.Exit+    ( ExitCode(ExitSuccess) )+import System.IO+    ( hPutStrLn, stderr )+import System.Console.GetOpt+    ( OptDescr(Option), ArgDescr(NoArg), ArgOrder(RequireOrder), getOpt+    , usageInfo )++import System.Directory+import Text.Printf++import Control.Concurrent+import Control.Concurrent.QSemN+import Control.Monad+import Control.Monad.IO.Class++import GHC+import GHC.Paths (libdir)+import Outputable+import DynFlags+++main :: IO ()+main = do+  [dir] <- getArgs+  setCurrentDirectory dir+  _ <- systemV "sh -c pwd"+  _ <- systemV "cabal new-build --builddir=dist-newstyle"+  qe <- mkQueryEnv (ProjLocV2Dir ".") (DistDirV2 "dist-newstyle/")++  components :: [ChComponentInfo]+      <- concat <$> runQuery (allUnits (toList . uiComponents)) qe++  sem <- newQSemN 0++  _threads <- forM components $ \comp -> forkIO $ compile sem comp++  waitQSemN sem $ length components++  return ()++compile sem ci@ChComponentInfo{..} =+  defaultErrorHandler defaultFatalMessager defaultFlushOut $ do+  runGhc (Just libdir) $ do+  handleSourceError (\e -> GHC.printException e) $ do++  dflags0 <- getSessionDynFlags+  let dflags1 = dflags0 {+      ghcMode   = CompManager+    , ghcLink   = LinkInMemory+    , hscTarget = HscNothing+    , optLevel  = 0+    }++  (dflags2, _, _) <- parseDynamicFlags dflags1 (map noLoc ciGhcOptions)+  _ <- setSessionDynFlags dflags2++  ts <- mapM (\t -> guessTarget t Nothing) =<<+       case ciEntrypoints of+         ChLibEntrypoint ms ms' ss -> return $+           map unChModuleName $ ms ++ ms' ++ ss+         ChExeEntrypoint m  ms -> do+           m1 <- liftIO $ findFile ciSourceDirs m+           case m1 of+             Just m2 -> return $ [m2] ++ map unChModuleName ms+             Nothing -> error $ printf+               "Couldn't find source file for Main module (%s), search path:\n\+               \%s\n" m (show ciSourceDirs)+         ChSetupEntrypoint         -> return $+           ["Setup.hs"]++  setTargets $ map (\t -> t { targetAllowObjCode = False }) ts+  _ <- load LoadAllTargets++  setContext $ case ciEntrypoints of+    ChLibEntrypoint ms ms' ss ->+        map (IIModule . mkModuleName . unChModuleName) $ ms ++ ms' ++ ss+    ChExeEntrypoint _  ms  ->+        map (IIModule . mkModuleName . unChModuleName) $ ChModuleName "Main" : ms+    ChSetupEntrypoint      ->+        map (IIModule . mkModuleName) ["Main"]++  _ <- execStmt "print foo" execOptions++  liftIO $ print ci+  liftIO $ signalQSemN sem 1+  liftIO $ forever $ threadDelay 100000++-- | Run shell command and+systemV :: String -> IO ()+systemV shell_cmd = do+  hPutStrLn stderr $ "$ " ++ shell_cmd+  ExitSuccess <- system shell_cmd+  return ()
+ tests/ProgramsTest.hs view
@@ -0,0 +1,76 @@+{-| This test checks if 'guessCompProgramPaths'\'s behaviour makes sense+-}++{-# OPTIONS_GHC -fno-warn-incomplete-patterns #-}++import Control.Monad+import Data.List+import System.Directory+import System.Environment+import System.Exit+import System.FilePath+import System.IO.Temp+import Text.Show.Pretty++import CabalHelper.Compiletime.Types+import CabalHelper.Compiletime.CompPrograms+import Symlink (createSymbolicLink)++main :: IO ()+main = do+  prog_name <- getProgName+  args <- getArgs+  case prog_name of+    "programs-test"+      | "ghc":ver:rest     <- args  -> ghc ver rest+      | "ghc-pkg":ver:rest <- args  -> ghc_pkg ver rest+      | "haddock":ver:rest <- args  -> haddock ver rest+      | otherwise -> do_test+    _+      | Just ver <- stripPrefix "ghc-pkg-" prog_name  -> ghc_pkg ver args+      | Just ver <- stripPrefix "ghc-" prog_name      -> ghc ver args+      | Just ver <- stripPrefix "haddock-" prog_name  -> haddock ver args+  where+    ghc _ver ["--info"] = putStrLn "[]" -- seems we can get away with that :)+    ghc  ver ["--numeric-version"] = putStrLn ver+    ghc _ver ["--supported-languages"] = return ()++    ghc_pkg ver ["--version"] =+      putStrLn $ "GHC package manager version " ++ ver++    haddock _ver ["--version"] =+      putStrLn $ -- cabal isn't very picky about haddock versions so we just+                 -- hardocde it here+        "Haddock version 2.20.0, (c) Simon Marlow 2006" +++        "Ported to use the GHC API by David Waern 2006-2008"++do_test :: IO ()+do_test = do+  prog <- canonicalizePath =<< getExecutablePath++  withSystemTempDirectory "c-h-programs-test" $ \tmpdir -> do++  forM_ ["8.6.5", "8.4.4"] $ \ver -> do++  let ghc = tmpdir </> "ghc-" ++ ver+  let ghc_pkg = tmpdir </> "ghc-pkg-" ++ ver+  let haddock = tmpdir </> "haddock-" ++ ver+  let progs = defaultPrograms { ghcProgram = ghc }++  createSymbolicLink prog ghc+  createSymbolicLink prog ghc_pkg+  createSymbolicLink prog haddock++  let ?verbose = (==4)++  progs' <- guessCompProgramPaths progs++  pPrint (ghc, ghc_pkg, haddock) -- expected+  pPrint progs' -- actual++  when (not $ and [ ghcPkgProgram progs'  == ghc_pkg+                  , haddockProgram progs' == haddock+                  ])+    exitFailure++  putStr "\n\n"
+ tests/ProjectTest.hs view
@@ -0,0 +1,7 @@+{-| This test codifies the assumptions we make about build tool behaviour.+-}++import System.Process++main = do+  withSystemTempDirectory "c-h-project-test" $ \tmpdir -> do
− tests/Spec.hs 
@@ -1,127 +0,0 @@-import Distribution.Helper-import System.Environment.Extra (lookupEnv)-import System.Posix.Env (setEnv)-import System.Process-import System.Exit-import Data.Maybe-import Data.Version-import Data.Functor-import Control.Exception as E-import Control.Arrow-import Prelude--import CabalHelper.Common-import CabalHelper.Compile-import CabalHelper.Types---main :: IO ()-main = do-  flip (setEnv "HOME") True =<< fromMaybe "/tmp" <$> lookupEnv "TMPDIR"-  _ <- rawSystem "cabal" ["update"]--  writeAutogenFiles' $ defaultQueryEnv "." "./dist"--  let parseVer' "HEAD" = Left HEAD-      parseVer' v = Right $ parseVer v--  let vers :: [(Version, [Either HEAD Version])]-      vers = map (parseVer *** map parseVer') [-               ("7.4", [ -- "1.14.0" -- not supported at runtime-                       ]),--               ("7.6", [ "1.16.0"-                       , "1.16.0.1"-                       , "1.16.0.2"-                       , "1.16.0.3"-                       ]),--               ("7.8", [-                         "1.18.0"-                       , "1.18.1"-                       , "1.18.1.1"-                       , "1.18.1.2"-                       , "1.18.1.3"-                       , "1.18.1.4"-                       , "1.18.1.5"-                       , "1.18.1.6"-                       , "1.18.1.7"--                       , "1.20.0.0"-                       , "1.20.0.1"-                       , "1.20.0.2"-                       , "1.20.0.3"-                       , "1.20.0.4"-                       , "1.22.0.0"-                       , "1.22.1.0"-                       , "1.22.1.1"-                       ]),--               ("7.10", [-                         "1.22.2.0"-                       , "1.22.3.0"-                       , "1.22.4.0"-                       , "1.22.5.0"-                       , "1.22.6.0"-                       , "1.22.7.0"-                       , "1.22.8.0"-                       ]),-               ("8.0", [-                         "1.24.0.0"-                       , "1.24.1.0"-                       , "1.24.2.0"---                       , "HEAD"-                       ])-             ]--  ghcVer <- majorVer <$> ghcVersion defaultOptions--  let cabalVers = reverse $ concat $ map snd $ dropWhile ((<ghcVer) . fst) vers--  rvs <- mapM compilePrivatePkgDb cabalVers--  let printStatus (cv, rv) = putStrLn $ "- Cabal "++show cv++" "++status-        where status = case rv of-                         Right _ ->-                             "suceeded"-                         Left rvc ->-                             "failed (exit code "++show rvc++")"--  let drvs = cabalVers `zip` rvs--  mapM_ printStatus (cabalVers `zip` rvs)-  if any isLeft' $ map snd $ filter ((/=Left HEAD) . fst) drvs-     then exitFailure-     else exitSuccess-- where-   isLeft' (Left _) = True-   isLeft' (Right _) = False--data HEAD = HEAD deriving (Eq, Show)--compilePrivatePkgDb :: Either HEAD Version -> IO (Either ExitCode FilePath)-compilePrivatePkgDb (Left HEAD) = do-    _ <- rawSystem "rm" [ "-r", "/tmp/.ghc-mod" ]-    (db, commit) <- installCabalHEAD defaultOptions { verbose = True } `E.catch`-        \(SomeException ex) ->-            error $ "Installing cabal HEAD failed: " ++ show ex-    compileWithPkg "." (Just db) (Left commit)-compilePrivatePkgDb (Right cabalVer) = do-    _ <- rawSystem "rm" [ "-r", "/tmp/.ghc-mod" ]-    db <- installCabal defaultOptions { verbose = True } cabalVer `E.catch`-        \(SomeException _) ->-            errorInstallCabal cabalVer "dist"-    compileWithPkg "." (Just db) (Right cabalVer)--compileWithPkg :: FilePath-               -> Maybe FilePath-               -> Either String Version-               -> IO (Either ExitCode FilePath)-compileWithPkg chdir mdb ver =-    compile "dist" defaultOptions { verbose = True } $-      Compile chdir Nothing mdb ver [cabalPkgId ver]--cabalPkgId :: Either String Version -> String-cabalPkgId (Left _commitid) = "Cabal"-cabalPkgId (Right v) = "Cabal-" ++ showVersion v
+ tests/TestOptions.hs view
@@ -0,0 +1,33 @@+module TestOptions+    ( ModProgs+    , testOpts+    ) where++import System.Console.GetOpt as GetOpt++import CabalHelper.Compiletime.Types++type ModProgs = (Programs -> Programs)++options :: [OptDescr ModProgs]+options =+    [ GetOpt.Option [] ["with-cabal"]+        (ReqArg (\arg -> \p -> p { cabalProgram = arg }) "PROG")+        "name or path of 'cabal' executable"+    , GetOpt.Option [] ["with-stack"]+        (ReqArg (\arg -> \p -> p { stackProgram = arg }) "PROG")+        "name or path of 'stack' executable"+    , GetOpt.Option [] ["with-ghc"]+        (ReqArg (\arg -> \cp -> cp { ghcProgram = arg }) "PROG")+        "name or path of 'ghc' executable"+    , GetOpt.Option [] ["with-ghc-pkg"]+        (ReqArg (\arg -> \cp -> cp { ghcPkgProgram = arg }) "PROG")+        "name or path of 'ghc-pkg' executable"+    ]++testOpts :: [String] -> IO (ModProgs, [String])+testOpts args =+   case getOpt Permute options args of+      (o,n,[]  ) -> return (foldl (flip (.)) id o, n)+      (_,_,errs) -> ioError (userError (concat errs ++ usageInfo header options))+  where header = "Usage: ghc-session [OPTION..] [TEST_SPEC..]"
+ tests/UnitTests.hs view
@@ -0,0 +1,26 @@+import Test.Tasty+import Test.Tasty.HUnit+import Test.Tasty.SmallCheck++import Data.List++main :: IO ()+main = defaultMain $+  testGroup "Tests"+    [ testGroup "(checked by SmallCheck)"+        [ testProperty "sort == sort . reverse" $+            \list -> sort (list :: [Int]) == sort (reverse list)++        , testProperty "Fermat's last theorem" $+            \x y z n -> (n :: Integer) >= 3 ==>+              x^n + y^n /= (z^n :: Integer)+        ]++    , testGroup "Unit tests"+        [ testCase "List comparison (different length)" $+            [1, 2, 3] `compare` [1,2] @?= GT++        , testCase "List comparison (same length)" $+            [1, 2, 3] `compare` [1,2,2] @?= LT+        ]+    ]
+ tests/bkpregex/Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ tests/bkpregex/bkpregex.cabal view
@@ -0,0 +1,29 @@+name:                bkpregex+version:             0.1.0.0+build-type:          Simple+cabal-version:       2.0++library str-impls+  build-depends:       base, bytestring+  exposed-modules:     Str.String, Str.ByteString+  hs-source-dirs:      str-impls++library regex-types+  build-depends:       base+  exposed-modules:     Regex.Types+  hs-source-dirs:      regex-types++library regex-indef+  build-depends:       base, regex-types+  signatures:          Str+  exposed-modules:     Regex+  hs-source-dirs:      regex-indef++executable regex-example+  main-is:             Main.hs+  build-depends:       base, regex-indef, regex-types, str-impls+  mixins:              regex-indef (Regex as Regex.String)+                          requires (Str as Str.String),+                       regex-indef (Regex as Regex.ByteString)+                          requires (Str as Str.ByteString)+  hs-source-dirs:      regex-example
+ tests/bkpregex/packages.list view
@@ -0,0 +1,1 @@+./
+ tests/bkpregex/regex-example/Main.hs view
@@ -0,0 +1,12 @@+{-# LANGUAGE OverloadedStrings #-}+module Main where++import Regex.Types+import qualified Regex.String+import qualified Regex.ByteString++nocs = Rep (Alt (Sym 'a') (Sym 'b'))+onec = Seq nocs (Sym 'c')+evencs = Seq (Rep (Seq onec onec)) nocs+main = print (Regex.String.accept evencs "acc") >>+       print (Regex.ByteString.accept evencs "acc")
+ tests/bkpregex/regex-indef/Regex.hs view
@@ -0,0 +1,14 @@+module Regex where++import Prelude hiding (null)+import Str+import Regex.Types++accept :: Reg -> Str -> Bool+accept Eps       u = null u+accept (Sym c)   u = u == singleton c+accept (Alt p q) u = accept p u || accept q u+accept (Seq p q) u =+    or [accept p u1 && accept q u2 | (u1, u2) <- splits u]+accept (Rep r) u =+    or [and [accept r ui | ui <- ps] | ps <- parts u]
+ tests/bkpregex/regex-indef/Str.hsig view
@@ -0,0 +1,9 @@+signature Str where++data Str+instance Eq Str++null :: Str -> Bool+singleton :: Char -> Str+splits :: Str -> [(Str, Str)]+parts :: Str -> [[Str]]
+ tests/bkpregex/regex-types/Regex/Types.hs view
@@ -0,0 +1,7 @@+module Regex.Types where++data Reg = Eps+         | Sym Char+         | Alt Reg Reg+         | Seq Reg Reg+         | Rep Reg
+ tests/bkpregex/stack.yaml view
@@ -0,0 +1,3 @@+resolver: lts-0.0 # will be overridden on the commandline+packages:+- ./
+ tests/bkpregex/str-impls/Str/ByteString.hs view
@@ -0,0 +1,17 @@+module Str.ByteString(module Data.ByteString.Char8, module Str.ByteString) where++import Prelude hiding (length, null, splitAt)+import Data.ByteString.Char8+import Data.ByteString++type Str = ByteString++splits :: Str -> [(Str, Str)]+splits s = fmap (\n -> splitAt n s) [0..length s]++parts :: Str -> [[Str]]+parts s | null s    = [[]]+        | otherwise = do+            n <- [1..length s]+            let (l, r) = splitAt n s+            fmap (l:) (parts r)
+ tests/bkpregex/str-impls/Str/String.hs view
@@ -0,0 +1,21 @@+module Str.String where++import Prelude hiding (null)+import qualified Prelude as P++type Str = String++null :: Str -> Bool+null = P.null++singleton :: Char -> Str+singleton c = [c]++splits :: Str -> [(Str, Str)]+splits [] = [([], [])]+splits (c:cs) = ([], c:cs):[(c:s1,s2) | (s1,s2) <- splits cs]++parts :: Str -> [[Str]]+parts [] = [[]]+parts [c] = [[[c]]]+parts (c:cs) = concat [[(c:p):ps, [c]:p:ps] | p:ps <- parts cs]
+ tests/cabal-versions view
@@ -0,0 +1,61 @@+1.1.6+1.2.1+1.2.2.0+1.2.3.0+1.2.4.0+1.4.0.0+1.4.0.1+1.4.0.2+1.6.0.1+1.6.0.2+1.6.0.3+1.8.0.2+1.8.0.4+1.8.0.6+1.10.0.0+1.10.1.0+1.10.2.0+1.12.0+1.14.0+1.16.0+1.16.0.1+1.16.0.2+1.16.0.3+1.18.0+1.18.1+1.18.1.1+1.18.1.2+1.18.1.3+1.18.1.4+1.18.1.5+1.18.1.6+1.18.1.7+1.20.0.0+1.20.0.1+1.20.0.2+1.20.0.3+1.20.0.4+1.22.0.0+1.22.1.0+1.22.1.1+1.22.2.0+1.22.3.0+1.22.4.0+1.22.5.0+1.22.6.0+1.22.7.0+1.22.8.0+1.24.0.0+1.24.2.0+2.0.0.2+2.0.1.0+2.0.1.1+2.2.0.0+2.2.0.1+2.4.0.0+2.4.0.1+2.4.1.0+3.0.0.0+3.0.1.0+3.0.2.0+3.2.0.0
+ tests/custom-setup/Lib.hs view
@@ -0,0 +1,8 @@+module Lib where++import System.Directory+import System.FilePath++filepath  = "a" </> "b"+directory = doesFileExist "Exe.hs"+foo = 1
+ tests/custom-setup/Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ tests/custom-setup/custom-setup.cabal view
@@ -0,0 +1,13 @@+name:                custom-setup+version:             0+build-type:          Custom+cabal-version:       >=1.10+extra-source-files:  stack.yaml++custom-setup+  setup-depends: base, Cabal++library+  exposed-modules:     Lib+  build-depends:       base, filepath, directory+  default-language:    Haskell2010
+ tests/custom-setup/packages.list view
@@ -0,0 +1,1 @@+./
+ tests/custom-setup/stack.yaml view
@@ -0,0 +1,3 @@+resolver: lts-0.0 # will be overridden on the commandline+packages:+- ./
+ tests/exeintlib/Exe.hs view
@@ -0,0 +1,5 @@+module Main where++import Lib++main = print lib
+ tests/exeintlib/Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ tests/exeintlib/exeintlib.cabal view
@@ -0,0 +1,32 @@+name:                exeintlib+version:             0+build-type:          Simple+cabal-version:       >=2.0+extra-source-files:  stack.yaml++library+  exposed-modules:     Lib+  hs-source-dirs:      lib+  build-depends:       base, filepath, intlib+  default-language:    Haskell2010++library intlib+  exposed-modules:     IntLib+  hs-source-dirs:      intlib+  build-depends:       base, directory+  default-language:    Haskell2010++executable exe+  main-is:             Exe.hs+  build-depends:       base, exeintlib+  default-language:    Haskell2010++test-suite exe-test+    type:              exitcode-stdio-1.0+    main-is:           Exe.hs+    build-depends:     base, exeintlib++benchmark exe-bench+    type:              exitcode-stdio-1.0+    main-is:           Exe.hs+    build-depends:     base, exeintlib
+ tests/exeintlib/intlib/IntLib.hs view
@@ -0,0 +1,7 @@+module IntLib where++import System.Directory++directory = doesFileExist "Exe.hs"++intlib = 1
+ tests/exeintlib/lib/Lib.hs view
@@ -0,0 +1,8 @@+module Lib where++import System.FilePath+import IntLib++filepath  = "a" </> "b"++lib = 1 + intlib
+ tests/exeintlib/packages.list view
@@ -0,0 +1,1 @@+./
+ tests/exeintlib/stack.yaml view
@@ -0,0 +1,3 @@+resolver: lts-0.0 # will be overridden on the commandline+packages:+- ./
+ tests/exelib/Exe.hs view
@@ -0,0 +1,5 @@+module Main where++import Lib++main = print foo
+ tests/exelib/Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ tests/exelib/exelib.cabal view
@@ -0,0 +1,26 @@+name:                exelib+version:             0+build-type:          Simple+cabal-version:       >=1.10+extra-source-files:  stack.yaml++library+  exposed-modules:     Lib+  hs-source-dirs:      lib+  build-depends:       base, filepath, directory+  default-language:    Haskell2010++executable exelib+  main-is:             Exe.hs+  build-depends:       base, exelib+  default-language:    Haskell2010++test-suite exe-test+    type:              exitcode-stdio-1.0+    main-is:           Exe.hs+    build-depends:     base, exelib++benchmark exe-bench+    type:              exitcode-stdio-1.0+    main-is:           Exe.hs+    build-depends:     base, exelib
+ tests/exelib/lib/Lib.hs view
@@ -0,0 +1,8 @@+module Lib where++import System.Directory+import System.FilePath++filepath  = "a" </> "b"+directory = doesFileExist "Exe.hs"+foo = 1
+ tests/exelib/packages.list view
@@ -0,0 +1,1 @@+./
+ tests/exelib/stack.yaml view
@@ -0,0 +1,3 @@+resolver: lts-0.0 # will be overridden on the commandline+packages:+- ./
+ tests/fliblib/FLib.hs view
@@ -0,0 +1,5 @@+module FLib where++import Lib++flib = print foo
+ tests/fliblib/Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ tests/fliblib/fliblib.cabal view
@@ -0,0 +1,20 @@+name:                fliblib+version:             0+build-type:          Simple+cabal-version:       >=1.10+extra-source-files:  stack.yaml++library+  exposed-modules:     Lib+  hs-source-dirs:      lib+  build-depends:       base, filepath, directory+  default-language:    Haskell2010++foreign-library flib+  other-modules:       FLib+  build-depends:       base, fliblib+  hs-source-dirs:      .+  type:                native-shared+  if os(Windows)+    options:           standalone+  default-language:    Haskell2010
+ tests/fliblib/lib/Lib.hs view
@@ -0,0 +1,8 @@+module Lib where++import System.Directory+import System.FilePath++filepath  = "a" </> "b"+directory = doesFileExist "Exe.hs"+foo = 1
+ tests/fliblib/packages.list view
@@ -0,0 +1,1 @@+./
+ tests/fliblib/stack.yaml view
@@ -0,0 +1,3 @@+resolver: lts-0.0 # will be overridden on the commandline+packages:+- ./
+ tests/multipkg/packages.list view
@@ -0,0 +1,4 @@+proj/+proj/pkg-a+proj/pkg-b+pkg-oot/
+ tests/multipkg/pkg-oot/Exe.hs view
@@ -0,0 +1,1 @@+main = putStrLn "Hello World!"
+ tests/multipkg/pkg-oot/Lib.hs view
@@ -0,0 +1,2 @@+module Lib where+lib = ()
+ tests/multipkg/pkg-oot/pkg-oot.cabal view
@@ -0,0 +1,24 @@+name:                pkg-oot+version:             0+build-type:          Simple+cabal-version:       >=1.10++library+  exposed-modules:   Lib+  build-depends:     base, filepath, directory +  default-language:  Haskell2010++executable pkg-oot-exe+  main-is:           Exe.hs+  build-depends:     base, pkg-oot +  default-language:  Haskell2010++test-suite pkg-oot-test+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, pkg-oot ++benchmark pkg-oot-bench+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, pkg-oot
+ tests/multipkg/proj/Exe.hs view
@@ -0,0 +1,1 @@+main = putStrLn "Hello World!"
+ tests/multipkg/proj/Lib.hs view
@@ -0,0 +1,2 @@+module Lib where+lib = ()
+ tests/multipkg/proj/cabal.project view
@@ -0,0 +1,1 @@+packages: ./ ./pkg-a ./pkg-b ../pkg-oot
+ tests/multipkg/proj/pkg-a/Exe.hs view
@@ -0,0 +1,1 @@+main = putStrLn "Hello World!"
+ tests/multipkg/proj/pkg-a/Lib.hs view
@@ -0,0 +1,2 @@+module Lib where+lib = ()
+ tests/multipkg/proj/pkg-a/pkg-a.cabal view
@@ -0,0 +1,24 @@+name:                pkg-a+version:             0+build-type:          Simple+cabal-version:       >=1.10++library+  exposed-modules:   Lib+  build-depends:     base, filepath, directory +  default-language:  Haskell2010++executable pkg-a-exe+  main-is:           Exe.hs+  build-depends:     base, pkg-a +  default-language:  Haskell2010++test-suite pkg-a-test+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, pkg-a ++benchmark pkg-a-bench+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, pkg-a
+ tests/multipkg/proj/pkg-b/Exe.hs view
@@ -0,0 +1,1 @@+main = putStrLn "Hello World!"
+ tests/multipkg/proj/pkg-b/Lib.hs view
@@ -0,0 +1,2 @@+module Lib where+lib = ()
+ tests/multipkg/proj/pkg-b/pkg-b.cabal view
@@ -0,0 +1,24 @@+name:                pkg-b+version:             0+build-type:          Simple+cabal-version:       >=1.10++library+  exposed-modules:   Lib+  build-depends:     base, filepath, directory +  default-language:  Haskell2010++executable pkg-b-exe+  main-is:           Exe.hs+  build-depends:     base, pkg-b +  default-language:  Haskell2010++test-suite pkg-b-test+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, pkg-b ++benchmark pkg-b-bench+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, pkg-b
+ tests/multipkg/proj/proj.cabal view
@@ -0,0 +1,25 @@+name:                proj+version:             0+build-type:          Simple+cabal-version:       >=1.10+extra-source-files:  stack.yaml++library+  exposed-modules:   Lib+  build-depends:     base, filepath, directory ,pkg-a,pkg-b,pkg-oot+  default-language:  Haskell2010++executable proj-exe+  main-is:           Exe.hs+  build-depends:     base, proj ,pkg-a,pkg-b,pkg-oot+  default-language:  Haskell2010++test-suite proj-test+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, proj ,pkg-a,pkg-b,pkg-oot++benchmark proj-bench+  type:              exitcode-stdio-1.0+  main-is:           Exe.hs+  build-depends:     base, proj ,pkg-a,pkg-b,pkg-oot
+ tests/multipkg/proj/stack.yaml view
@@ -0,0 +1,6 @@+resolver: lts-0.0 # will be overridden on the commandline+packages:+- ./+- ./pkg-a+- ./pkg-b+- ../pkg-oot
+ tests/src-repo/Exe.hs view
@@ -0,0 +1,5 @@+module Main where++import Lib++main = print foo
+ tests/src-repo/Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ tests/src-repo/cabal.project view
@@ -0,0 +1,7 @@+packages: .++source-repository-package+    type: git+    location: ${topdir}+    tag: HEAD+    subdir: tests/exelib
+ tests/src-repo/packages.list view
@@ -0,0 +1,1 @@+./
+ tests/src-repo/src-repo.cabal view
@@ -0,0 +1,19 @@+name:                src-repo+version:             0+build-type:          Simple+cabal-version:       >=1.10++executable src-repo+  main-is:             Exe.hs+  build-depends:       base, exelib+  default-language:    Haskell2010++test-suite exe-test+    type:              exitcode-stdio-1.0+    main-is:           Exe.hs+    build-depends:     base, exelib++benchmark exe-bench+    type:              exitcode-stdio-1.0+    main-is:           Exe.hs+    build-depends:     base, exelib
+ tests/stack-resolvers view
@@ -0,0 +1,15 @@+8.6.5      lts-14.27+8.6.5      lts-13.30+8.4.4      lts-12.26+8.2.2      lts-11.22+8.2.2      lts-10.10+8.0.2      lts-9.21+8.0.2      lts-8.24+8.0.1      lts-7.24+7.10.3     lts-6.35+7.10.3     lts-5.18+7.10.3     lts-4.2+7.10.2     lts-3.22+7.8.4      lts-2.22+7.8.4      lts-1.15+7.8.3      lts-0.7