46492a19b0
This commit implement scaning a package db directory to collect package id If you installed a package both in a sandbox and globally, global package may be selected even if there's a package in a sandbox, which is different behavior from cabal sandbox. e.g. when you have fast-logger-2.0 globally and fast-logger-0.3.3 in a sandbox: (Without patch) $ ghc-mod check Foundation.hs Foundation.hs:12:31:Module `System.Log.FastLogger' does not export `Logger' (With patch) $ ghc-mod check Foundation.hs
149 lines
5.0 KiB
Haskell
149 lines
5.0 KiB
Haskell
{-# LANGUAGE BangPatterns #-}
|
|
|
|
module Language.Haskell.GhcMod.Cradle (
|
|
findCradle
|
|
, findCradleWithoutSandbox
|
|
, getPackageDbDir
|
|
, getPackageDbPackages
|
|
) where
|
|
|
|
import Data.Char (isSpace)
|
|
import Control.Applicative ((<$>))
|
|
import Control.Exception as E (catch, throwIO, SomeException)
|
|
import Control.Monad (filterM)
|
|
import Data.List (isPrefixOf, isSuffixOf, tails)
|
|
import Language.Haskell.GhcMod.Types
|
|
import System.Directory (getCurrentDirectory, getDirectoryContents, doesFileExist)
|
|
import System.FilePath ((</>), takeDirectory, takeFileName)
|
|
|
|
----------------------------------------------------------------
|
|
|
|
-- | Finding 'Cradle'.
|
|
-- Find a cabal file by tracing ancestor directories.
|
|
-- Find a sandbox according to a cabal sandbox config
|
|
-- in a cabal directory.
|
|
findCradle :: IO Cradle
|
|
findCradle = do
|
|
wdir <- getCurrentDirectory
|
|
findCradle' wdir `E.catch` handler wdir
|
|
where
|
|
handler :: FilePath -> SomeException -> IO Cradle
|
|
handler wdir _ = return Cradle {
|
|
cradleCurrentDir = wdir
|
|
, cradleCabalDir = Nothing
|
|
, cradleCabalFile = Nothing
|
|
, cradlePackageDbOpts = []
|
|
, cradlePackages = []
|
|
}
|
|
|
|
findCradle' :: FilePath -> IO Cradle
|
|
findCradle' wdir = do
|
|
(cdir,cfile) <- cabalDir wdir
|
|
pkgDbOpts <- getPackageDbOpts cdir
|
|
return Cradle {
|
|
cradleCurrentDir = wdir
|
|
, cradleCabalDir = Just cdir
|
|
, cradleCabalFile = Just cfile
|
|
, cradlePackageDbOpts = pkgDbOpts
|
|
, cradlePackages = []
|
|
}
|
|
|
|
-- Just for testing
|
|
findCradleWithoutSandbox :: IO Cradle
|
|
findCradleWithoutSandbox = do
|
|
cradle <- findCradle
|
|
return cradle { cradlePackageDbOpts = [], cradlePackages = [] }
|
|
|
|
----------------------------------------------------------------
|
|
|
|
cabalSuffix :: String
|
|
cabalSuffix = ".cabal"
|
|
|
|
cabalSuffixLength :: Int
|
|
cabalSuffixLength = length cabalSuffix
|
|
|
|
-- Finding a Cabal file up to the root directory
|
|
-- Input: a directly to investigate
|
|
-- Output: (the path to the directory containing a Cabal file
|
|
-- ,the path to the Cabal file)
|
|
cabalDir :: FilePath -> IO (FilePath,FilePath)
|
|
cabalDir dir = do
|
|
cnts <- getCabalFiles dir
|
|
case cnts of
|
|
[] | dir' == dir -> throwIO $ userError "cabal files not found"
|
|
| otherwise -> cabalDir dir'
|
|
cfile:_ -> return (dir,dir </> cfile)
|
|
where
|
|
dir' = takeDirectory dir
|
|
|
|
getCabalFiles :: FilePath -> IO [FilePath]
|
|
getCabalFiles dir = getFiles >>= filterM doesCabalFileExist
|
|
where
|
|
isCabal name = cabalSuffix `isSuffixOf` name
|
|
&& length name > cabalSuffixLength
|
|
getFiles = filter isCabal <$> getDirectoryContents dir
|
|
doesCabalFileExist file = doesFileExist $ dir </> file
|
|
|
|
----------------------------------------------------------------
|
|
|
|
configFile :: String
|
|
configFile = "cabal.sandbox.config"
|
|
|
|
pkgDbKey :: String
|
|
pkgDbKey = "package-db:"
|
|
|
|
pkgDbKeyLen :: Int
|
|
pkgDbKeyLen = length pkgDbKey
|
|
|
|
-- | Obtaining GHC options relating to a package db directory
|
|
getPackageDbOpts :: FilePath -> IO [GHCOption]
|
|
getPackageDbOpts cdir = (sandboxArguments <$> getPkgDb) `E.catch` handler
|
|
where
|
|
getPkgDb = getPackageDbDir (cdir </> configFile)
|
|
handler :: SomeException -> IO [GHCOption]
|
|
handler _ = return []
|
|
|
|
-- | Extract a package db directory from the sandbox config file.
|
|
-- Exception is thrown if the sandbox config file is broken.
|
|
getPackageDbDir :: FilePath -> IO FilePath
|
|
getPackageDbDir sconf = do
|
|
-- Be strict to ensure that an error can be caught.
|
|
!path <- extractValue . parse <$> readFile sconf
|
|
return path
|
|
where
|
|
parse = head . filter ("package-db:" `isPrefixOf`) . lines
|
|
extractValue = fst . break isSpace . dropWhile isSpace . drop pkgDbKeyLen
|
|
|
|
-- | Adding necessary GHC options to the package db.
|
|
-- Exception is thrown if the string argument is incorrect.
|
|
--
|
|
-- >>> sandboxArguments "/foo/bar/i386-osx-ghc-7.6.3-packages.conf.d"
|
|
-- ["-no-user-package-db","-package-db","/foo/bar/i386-osx-ghc-7.6.3-packages.conf.d"]
|
|
-- >>> sandboxArguments "/foo/bar/i386-osx-ghc-7.4.1-packages.conf.d"
|
|
-- ["-no-user-package-conf","-package-conf","/foo/bar/i386-osx-ghc-7.4.1-packages.conf.d"]
|
|
sandboxArguments :: FilePath -> [String]
|
|
sandboxArguments pkgDb = [noUserPkgDbOpt, pkgDbOpt, pkgDb]
|
|
where
|
|
ver = extractGhcVer pkgDb
|
|
(pkgDbOpt,noUserPkgDbOpt)
|
|
| ver < 706 = ("-package-conf","-no-user-package-conf")
|
|
| otherwise = ("-package-db", "-no-user-package-db")
|
|
|
|
-- | Extracting GHC version from the path of package db.
|
|
-- Exception is thrown if the string argument is incorrect.
|
|
--
|
|
-- >>> extractGhcVer "/foo/bar/i386-osx-ghc-7.6.3-packages.conf.d"
|
|
-- 706
|
|
extractGhcVer :: String -> Int
|
|
extractGhcVer dir = ver
|
|
where
|
|
file = takeFileName dir
|
|
findVer = drop 4 . head . filter ("ghc-" `isPrefixOf`) . tails
|
|
(verStr1,_:left) = break (== '.') $ findVer file
|
|
(verStr2,_) = break (== '.') left
|
|
ver = read verStr1 * 100 + read verStr2
|
|
|
|
-- | Obtaining packages installed in a package db directory.
|
|
getPackageDbPackages :: FilePath -> IO [Package]
|
|
getPackageDbPackages _ = return []
|