{-# OPTIONS_GHC -cpp -fffi #-} ----------------------------------------------------------------------------- -- | -- Module : Distribution.Simple.LocalBuildInfo -- Copyright : Isaac Jones 2003-2004 -- -- Maintainer : Isaac Jones -- Stability : alpha -- Portability : portable -- -- Definition of the LocalBuildInfo data type. {- 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, mkProgDir, absolutePath, prefixRelPath, substDir, distPref, srcPref, 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.Compat.FilePath -- |Data cached after configuration step. 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 put the result of building. 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. 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 `joinFileName` "src" -- |The directory in which we put auto-generated modules autogenModulesDir :: LocalBuildInfo -> String autogenModulesDir lbi = buildDir lbi `joinFileName` "autogen" -- |The place where install-includes are installed, relative to libdir mkIncludeDir :: FilePath -> FilePath mkIncludeDir = (`joinFileName` "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 default_prefix = return "/usr/local" default_bindir :: FilePath default_bindir = "$prefix" `joinFileName` "bin" default_libdir :: Compiler -> FilePath default_libdir hc = "$prefix" `joinFileName` "lib" default_libsubdir :: Compiler -> FilePath default_libsubdir hc = case compilerFlavor hc of Hugs -> "hugs" `joinFileName` "packages" `joinFileName` "$pkg" JHC -> "$compiler" _ -> "$pkgid" `joinFileName` "$compiler" default_libexecdir :: FilePath default_libexecdir = "$prefix" `joinFileName` "libexec" default_datadir :: PackageDescription -> IO FilePath default_datadir pkg_descr = return ("$prefix" `joinFileName` "share") 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 `joinFileName` libsubdir lbi) mkLibDirRel :: PackageDescription -> LocalBuildInfo -> CopyDest -> Maybe FilePath mkLibDirRel pkg_descr lbi copydest = prefixRelPath pkg_descr lbi copydest (libdir lbi `joinFileName` 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 `joinFileName` datasubdir lbi) mkDataDirRel :: PackageDescription -> LocalBuildInfo -> CopyDest -> Maybe FilePath mkDataDirRel pkg_descr lbi copydest = prefixRelPath pkg_descr lbi copydest (datadir lbi `joinFileName` datasubdir lbi) mkHaddockDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath mkHaddockDir pkg_descr lbi copydest = foldl1 joinPaths [mkDataDir pkg_descr lbi copydest, "doc", "html"] -- | Directory for program modules (Hugs only). mkProgDir :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath mkProgDir pkg_descr lbi copydest = absolutePath pkg_descr lbi copydest (libdir lbi) `joinFileName` "hugs" `joinFileName` "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 pkg_descr lbi s s -> substDir pkg_descr lbi s where lbi = case copydest of CopyPrefix d -> lbi0{prefix=d} _otherwise -> lbi0 prefixRelPath pkg_descr lbi copydest s = Nothing absolutePath :: PackageDescription -> LocalBuildInfo -> CopyDest -> FilePath -> FilePath absolutePath pkg_descr lbi copydest s = case copydest of NoCopyDest -> substDir pkg_descr lbi s CopyPrefix d -> substDir pkg_descr lbi{prefix=d} s CopyTo p -> p `joinFileName` (dropAbsolutePrefix (substDir pkg_descr lbi s)) substDir :: PackageDescription -> LocalBuildInfo -> String -> String substDir pkg_descr lbi s = loop s 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 (package pkg_descr) ++ loop s loop ('$':'p':'k':'g':s) = pkgName (package pkg_descr) ++ loop s loop ('$':'v':'e':'r':'s':'i':'o':'n':s) = show (pkgVersion (package pkg_descr)) ++ loop s loop ('$':'$':s) = '$' : loop s loop (c:s) = c : loop s