{-# OPTIONS -cpp -fffi #-}
-----------------------------------------------------------------------------
-- |
-- Module : Distribution.Simple.LocalBuildInfo
-- Copyright : Isaac Jones 2003-2004
--
-- Maintainer : Isaac Jones <ijones@syntaxpolice.org>
-- Stability : alpha
-- Portability : portable
--
-- Definition of the 'LocalBuildInfo' data type. This is basically
-- the information that is gathered by the end of the configuration
-- step which could include package information from ghc-pkg, flags
-- the user passed to configure, and the location of tools in the
-- PATH.
{- 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. -}
module Distribution.Simple.LocalBuildInfo (
LocalBuildInfo(..),
default_prefix,
default_bindir,
default_libdir,
default_libsubdir,
default_libexecdir,
default_datadir,
default_datasubdir,
mkLibDir, mkLibDirRel, mkBinDir, mkBinDirRel, mkLibexecDir, mkLibexecDirRel, mkDataDir, mkDataDirRel, mkHaddockDir, mkProgDirRel, mkProgDir,
absolutePath, prefixRelPath,
substDir,
distPref, srcPref, hscolourPref, haddockPref, autogenModulesDir, mkIncludeDir
) where
import Distribution.Program (ProgramConfiguration)
import Distribution.PackageDescription (PackageDescription(..))
import Distribution.Package (PackageIdentifier(..), showPackageId)
import Distribution.Compiler (Compiler(..), CompilerFlavor(..), showCompilerId)
import Distribution.Setup (CopyDest(..))
import Distribution.Version (showVersion)
import System.FilePath
#if mingw32_HOST_OS || mingw32_TARGET_OS
import Data.Maybe (fromMaybe)
import Distribution.PackageDescription (hasLibs)
import Foreign
import Foreign.C
#endif
-- |Data cached after configuration step. See also
-- 'Distribution.Setup.ConfigFlags'.
data LocalBuildInfo = LocalBuildInfo {
prefix :: FilePath,
-- ^ The installation directory (eg. @\/usr\/local@, or
-- @C:\/Program Files\/foo-1.2@ on Windows.
bindir :: FilePath,
-- ^ The bin directory
libdir :: FilePath,
-- ^ The lib directory
libsubdir :: FilePath,
-- ^ Subdirectory of libdir into which libraries are installed
libexecdir :: FilePath,
-- ^ The lib directory
datadir :: FilePath,
-- ^ The data directory
datasubdir :: FilePath,
-- ^ Subdirectory of datadir into which data files are installed
compiler :: Compiler,
-- ^ The compiler we're building with
buildDir :: FilePath,
-- ^ Where to build the package.
scratchDir :: FilePath,
-- ^ Where to put the result of the Hugs build.
packageDeps :: [PackageIdentifier],
-- ^ Which packages we depend on, /exactly/.
-- The 'Distribution.PackageDescription.PackageDescription'
-- specifies a set of build dependencies
-- that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions
-- available on this machine for this compiler.
withPrograms :: ProgramConfiguration, -- location and args for all programs
userConf :: Bool, -- ^Was this package configured with --user?
withHappy :: Maybe FilePath, -- ^Might be the location of the Happy executable.
withAlex :: Maybe FilePath, -- ^Might be the location of the Alex executable.
withHsc2hs :: Maybe FilePath, -- ^Might be the location of the Hsc2hs executable.
withC2hs :: Maybe FilePath, -- ^Might be the location of the C2hs executable.
withCpphs :: Maybe FilePath, -- ^Might be the location of the Cpphs executable.
withGreencard :: Maybe FilePath, -- ^Might be the location of the GreenCard executable.
withVanillaLib:: Bool, -- ^Whether to build normal libs.
withProfLib :: Bool, -- ^Whether to build profiling versions of libs.
withProfExe :: Bool, -- ^Whether to build executables for profiling.
withOptimization :: Bool, -- ^Whether to build with optimization (if available).
withGHCiLib :: Bool, -- ^Whether to build libs suitable for use with GHCi.
splitObjs :: Bool -- ^Use -split-objs with GHC, if available
} deriving (Read, Show)
-- ------------------------------------------------------------
-- * Some Paths
-- ------------------------------------------------------------
distPref :: FilePath
distPref = "dist"
srcPref :: FilePath
srcPref = distPref </> "src"
hscolourPref :: PackageDescription -> FilePath
hscolourPref = haddockPref
haddockPref :: PackageDescription -> FilePath
haddockPref pkg_descr
= foldl1 (</>) [distPref, "doc", "html", pkgName (package pkg_descr)]
-- |The directory in which we put auto-generated modules
autogenModulesDir :: LocalBuildInfo -> String
autogenModulesDir lbi = buildDir lbi </> "autogen"
-- |The place where install-includes are installed, relative to libdir
mkIncludeDir :: FilePath -> FilePath
mkIncludeDir = (</> "include")
-- -----------------------------------------------------------------------------
-- Default directories
{-
The defaults are as follows:
Windows:
prefix = C:\Program Files
bindir = $prefix\$pkgid
libdir = $prefix\Haskell
libsubdir = $pkgid\$compiler
datadir = $prefix (for an executable)
= $prefix\Common Files (for a library)
datasubdir = $pkgid
libexecdir = $prefix\$pkgid
Unix:
prefix = /usr/local
bindir = $prefix/bin
libdir = $prefix/lib/$pkgid/$compiler
libsubdir = $pkgid/$compiler
datadir = $prefix/share/$pkgid
datasubdir = $pkgid
libexecdir = $prefix/libexec
-}
default_prefix :: IO String
#if mingw32_HOST_OS || mingw32_TARGET_OS
# if __HUGS__
default_prefix = return "C:\\Program Files"
# else
default_prefix = getProgramFilesDir
# endif
#else
default_prefix = return "/usr/local"
#endif
#if mingw32_HOST_OS || mingw32_TARGET_OS
getProgramFilesDir = do
m <- shGetFolderPath csidl_PROGRAM_FILES
return (fromMaybe "C:\\Program Files" m)
getCommonFilesDir = do
m <- shGetFolderPath csidl_PROGRAM_FILES_COMMON
case m of
Nothing -> getProgramFilesDir
Just s -> return s
shGetFolderPath id =
allocaBytes long_path_size $ \pPath -> do
r <- c_SHGetFolderPath nullPtr id nullPtr 0 pPath
if (r /= 0)
then return Nothing
else do s <- peekCString pPath; return (Just s)
where
long_path_size = 1024
csidl_PROGRAM_FILES = 0x0026 :: CInt
csidl_PROGRAM_FILES_COMMON = 0x002b :: CInt
foreign import stdcall unsafe "shlobj.h SHGetFolderPathA"
c_SHGetFolderPath :: Ptr ()
-> CInt
-> Ptr ()
-> CInt
-> CString
-> IO CInt
#endif
default_bindir :: FilePath
default_bindir = "$prefix" </>
#if mingw32_HOST_OS || mingw32_TARGET_OS
"Haskell" </> "bin"
#else
"bin"
#endif
default_libdir :: Compiler -> FilePath
default_libdir _ = "$prefix" </>
#if mingw32_HOST_OS || mingw32_TARGET_OS
"Haskell"
#else
"lib"
#endif
default_libsubdir :: Compiler -> FilePath
default_libsubdir hc =
case compilerFlavor hc of
Hugs -> "hugs" </> "packages" </> "$pkg"
JHC -> "$compiler"
_ -> "$pkgid" </> "$compiler"
default_libexecdir :: FilePath
default_libexecdir = "$prefix" </>
#if mingw32_HOST_OS || mingw32_TARGET_OS
"$pkgid"
#else
"libexec"
#endif
default_datadir :: PackageDescription -> IO FilePath
#if mingw32_HOST_OS || mingw32_TARGET_OS
default_datadir pkg_descr
| hasLibs pkg_descr = getCommonFilesDir
| otherwise = return ("$prefix" </> "Haskell")
#else
default_datadir _
= return ("$prefix" </> "share")
#endif
default_datasubdir :: FilePath
default_datasubdir = "$pkgid"
mkBinDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
mkBinDir pkg_descr lbi copydest =
absolutePath pkg_descr lbi copydest (bindir lbi)
mkBinDirRel :: PackageDescription -> LocalBuildInfo -> CopyDest -> Maybe FilePath
mkBinDirRel pkg_descr lbi copydest =
prefixRelPath pkg_descr lbi copydest (bindir lbi)
mkLibDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
mkLibDir pkg_descr lbi copydest =
absolutePath pkg_descr lbi copydest (libdir lbi </> libsubdir lbi)
mkLibDirRel :: PackageDescription -> LocalBuildInfo -> CopyDest -> Maybe FilePath
mkLibDirRel pkg_descr lbi copydest =
prefixRelPath pkg_descr lbi copydest (libdir lbi </> libsubdir lbi)
mkLibexecDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
mkLibexecDir pkg_descr lbi copydest =
absolutePath pkg_descr lbi copydest (libexecdir lbi)
mkLibexecDirRel :: PackageDescription -> LocalBuildInfo -> CopyDest -> Maybe FilePath
mkLibexecDirRel pkg_descr lbi copydest =
prefixRelPath pkg_descr lbi copydest (libexecdir lbi)
mkDataDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
mkDataDir pkg_descr lbi copydest =
absolutePath pkg_descr lbi copydest (datadir lbi </> datasubdir lbi)
mkDataDirRel :: PackageDescription -> LocalBuildInfo -> CopyDest -> Maybe FilePath
mkDataDirRel pkg_descr lbi copydest =
prefixRelPath pkg_descr lbi copydest (datadir lbi </> datasubdir lbi)
mkHaddockDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
mkHaddockDir pkg_descr lbi copydest =
foldl1 (</>) [mkDataDir pkg_descr lbi copydest,
"doc", "html", pkgName (package pkg_descr)]
-- | Directory for program modules (Hugs only).
mkProgDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
mkProgDir pkg_descr lbi copydest =
absolutePath pkg_descr lbi copydest
(libdir lbi </> "hugs" </> "programs")
mkProgDirRel :: PackageDescription -> LocalBuildInfo -> CopyDest -> Maybe FilePath
mkProgDirRel pkg_descr lbi copydest =
prefixRelPath pkg_descr lbi copydest
(libdir lbi </> "hugs" </> "programs")
prefixRelPath :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
-> Maybe FilePath
prefixRelPath pkg_descr lbi0 copydest ('$':'p':'r':'e':'f':'i':'x':s) = Just $
case s of
(c:s') | isPathSeparator c -> substDir (package pkg_descr) lbi s'
_ -> substDir (package pkg_descr) lbi s
where
lbi = case copydest of
CopyPrefix d -> lbi0{prefix=d}
_otherwise -> lbi0
prefixRelPath _ _ _ _ = Nothing
absolutePath :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath
-> FilePath
absolutePath pkg_descr lbi copydest s =
case copydest of
NoCopyDest -> substDir (package pkg_descr) lbi s
CopyPrefix d -> substDir (package pkg_descr) lbi{prefix=d} s
CopyTo p -> p </> (dropAbsolutePrefix (substDir (package pkg_descr) lbi s))
where
-- | If the function is applied to an absolute path then it returns a local path droping
-- the absolute prefix in the path. Under Windows the prefix is \"\\\", \"c:\" or \"c:\\\". Under
-- Unix the prefix is always \"\/\".
dropAbsolutePrefix :: FilePath -> FilePath
dropAbsolutePrefix (c:cs) | isPathSeparator c = cs
#if mingw32_HOST_OS || mingw32_TARGET_OS
dropAbsolutePrefix (_:':':c:cs) | isPathSeparator c = cs -- path with drive letter
dropAbsolutePrefix (_:':':cs) = cs
#endif
dropAbsolutePrefix cs = cs
substDir :: PackageIdentifier -> LocalBuildInfo -> String -> String
substDir pkgId lbi xs = loop xs
where
loop "" = ""
loop ('$':'p':'r':'e':'f':'i':'x':s)
= prefix lbi ++ loop s
loop ('$':'c':'o':'m':'p':'i':'l':'e':'r':s)
= showCompilerId (compiler lbi) ++ loop s
loop ('$':'p':'k':'g':'i':'d':s)
= showPackageId pkgId ++ loop s
loop ('$':'p':'k':'g':s)
= pkgName pkgId ++ loop s
loop ('$':'v':'e':'r':'s':'i':'o':'n':s)
= showVersion (pkgVersion pkgId) ++ loop s
loop ('$':'$':s) = '$' : loop s
loop (c:s) = c : loop s
|
