------------------------------------------------------------------------------- |-- Module : Distribution.Simple.Build-- Copyright : Isaac Jones 2003-2005,-- Ross Paterson 2006,-- Duncan Coutts 2007-2008---- Maintainer : cabal-devel@haskell.org-- Portability : portable---- This is the entry point to actually building the modules in a package. It-- doesn't actually do much itself, most of the work is delegated to-- compiler-specific actions. It does do some non-compiler specific bits like-- running pre-processors.--{- Copyright (c) 2003-2005, Isaac Jones
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. -}moduleDistribution.Simple.Build(build,initialBuildSteps,writeAutogenFiles,)whereimportqualifiedDistribution.Simple.GHCasGHCimportqualifiedDistribution.Simple.JHCasJHCimportqualifiedDistribution.Simple.LHCasLHCimportqualifiedDistribution.Simple.NHCasNHCimportqualifiedDistribution.Simple.HugsasHugsimportqualifiedDistribution.Simple.UHCasUHCimportqualifiedDistribution.Simple.Build.MacrosasBuild.MacrosimportqualifiedDistribution.Simple.Build.PathsModuleasBuild.PathsModuleimportDistribution.Package(Package(..),PackageName(..),PackageIdentifier(..),Dependency(..),thisPackageVersion)importDistribution.Simple.Compiler(CompilerFlavor(..),compilerFlavor,PackageDB(..))importDistribution.PackageDescription(PackageDescription(..),BuildInfo(..),Library(..),Executable(..),TestSuite(..),TestSuiteInterface(..),Benchmark(..),BenchmarkInterface(..))importqualifiedDistribution.InstalledPackageInfoasIPIimportqualifiedDistribution.ModuleNameasModuleNameimportDistribution.Simple.Setup(BuildFlags(..),fromFlag)importDistribution.Simple.PreProcess(preprocessComponent,PPSuffixHandler)importDistribution.Simple.LocalBuildInfo(LocalBuildInfo(compiler,buildDir,withPackageDB,withPrograms),Component(..),ComponentLocalBuildInfo(..),withComponentsLBI,componentBuildInfo,inplacePackageId)importDistribution.Simple.Program.TypesimportDistribution.Simple.Program.DbimportDistribution.Simple.BuildPaths(autogenModulesDir,autogenModuleName,cppHeaderName,exeExtension)importDistribution.Simple.Register(registerPackage,inplaceInstalledPackageInfo)importDistribution.Simple.Test(stubFilePath,stubName)importDistribution.Simple.Utils(createDirectoryIfMissingVerbose,rewriteFile,die,info,setupMessage)importDistribution.Verbosity(Verbosity)importDistribution.Text(display)importData.Maybe(maybeToList)importData.List(intersect)importControl.Monad(unless)importSystem.FilePath((</>),(<.>))importSystem.Directory(getCurrentDirectory)-- ------------------------------------------------------------------------------- |Build the libraries and executables in this package.build::PackageDescription-- ^ Mostly information from the .cabal file->LocalBuildInfo-- ^ Configuration information->BuildFlags-- ^ Flags that the user passed to build->[PPSuffixHandler]-- ^ preprocessors to run before compiling->IO()buildpkg_descrlbiflagssuffixes=doletdistPref=fromFlag(buildDistPrefflags)verbosity=fromFlag(buildVerbosityflags)initialBuildStepsdistPrefpkg_descrlbiverbositysetupMessageverbosity"Building"(packageIdpkg_descr)internalPackageDB<-createInternalPackageDBdistPrefwithComponentsLBIpkg_descrlbi$\compclbi->letbi=componentBuildInfocompprogs'=addInternalBuildToolspkg_descrlbibi(withProgramslbi)lbi'=lbi{withPrograms=progs',withPackageDB=withPackageDBlbi++[internalPackageDB]}inbuildComponentverbositypkg_descrlbi'suffixescompclbidistPrefbuildComponent::Verbosity->PackageDescription->LocalBuildInfo->[PPSuffixHandler]->Component->ComponentLocalBuildInfo->FilePath->IO()buildComponentverbositypkg_descrlbisuffixescomp@(CLiblib)clbidistPref=dopreprocessComponentpkg_descrcomplbiFalseverbositysuffixesinfoverbosity"Building library..."buildLibverbositypkg_descrlbilibclbi-- Register the library in-place, so exes can depend-- on internally defined libraries.pwd<-getCurrentDirectoryletinstalledPkgInfo=(inplaceInstalledPackageInfopwddistPrefpkg_descrliblbiclbi){-- The inplace registration uses the "-inplace" suffix,-- not an ABI hash.IPI.installedPackageId=inplacePackageId(packageIdinstalledPkgInfo)}registerPackageverbosityinstalledPkgInfopkg_descrlbiTrue-- True meaning inplace(withPackageDBlbi)buildComponentverbositypkg_descrlbisuffixescomp@(CExeexe)clbi_=dopreprocessComponentpkg_descrcomplbiFalseverbositysuffixesinfoverbosity$"Building executable "++exeNameexe++"..."buildExeverbositypkg_descrlbiexeclbibuildComponentverbositypkg_descrlbisuffixescomp@(CTesttest@TestSuite{testInterface=TestSuiteExeV10_f})clbi_distPref=doletbi=testBuildInfotestexe=Executable{exeName=testNametest,modulePath=f,buildInfo=bi}preprocessComponentpkg_descrcomplbiFalseverbositysuffixesinfoverbosity$"Building test suite "++testNametest++"..."buildExeverbositypkg_descrlbiexeclbibuildComponentverbositypkg_descrlbisuffixescomp@(CTesttest@TestSuite{testInterface=TestSuiteLibV09_m})clbidistPref=dopwd<-getCurrentDirectoryletbi=testBuildInfotestlib=Library{exposedModules=[m],libExposed=True,libBuildInfo=bi}pkg=pkg_descr{package=(packagepkg_descr){pkgName=PackageName(testNametest)},buildDepends=targetBuildDepends$testBuildInfotest,executables=[],testSuites=[],library=Justlib}ipi=(inplaceInstalledPackageInfopwddistPrefpkgliblbiclbi){IPI.installedPackageId=inplacePackageId$packageIdipi}testDir=buildDirlbi</>stubNametest</>stubNametest++"-tmp"testLibDep=thisPackageVersion$packagepkgexe=Executable{exeName=stubNametest,modulePath=stubFilePathtest,buildInfo=(testBuildInfotest){hsSourceDirs=[testDir],targetBuildDepends=testLibDep:(targetBuildDepends$testBuildInfotest)}}-- | The stub executable needs a new 'ComponentLocalBuildInfo'-- that exposes the relevant test suite library.exeClbi=clbi{componentPackageDeps=(IPI.installedPackageIdipi,packageIdipi):(filter(\(_,x)->letPackageNamename=pkgNamexinname=="Cabal"||name=="base")(componentPackageDepsclbi))}preprocessComponentpkg_descrcomplbiFalseverbositysuffixesinfoverbosity$"Building test suite "++testNametest++"..."buildLibverbositypkglbilibclbiregisterPackageverbosityipipkglbiTrue$withPackageDBlbibuildExeverbositypkg_descrlbiexeexeClbibuildComponent____(CTestTestSuite{testInterface=TestSuiteUnsupportedtt})__=die$"No support for building test suite type "++displayttbuildComponentverbositypkg_descrlbisuffixescomp@(CBenchbm@Benchmark{benchmarkInterface=BenchmarkExeV10_f})clbi_=doletbi=benchmarkBuildInfobmexe=Executable{exeName=benchmarkNamebm,modulePath=f,buildInfo=bi}preprocessComponentpkg_descrcomplbiFalseverbositysuffixesinfoverbosity$"Building benchmark "++benchmarkNamebm++"..."buildExeverbositypkg_descrlbiexeclbibuildComponent____(CBenchBenchmark{benchmarkInterface=BenchmarkUnsupportedtt})__=die$"No support for building benchmark type "++displaytt-- | Initialize a new package db file for libraries defined-- internally to the package.createInternalPackageDB::FilePath->IOPackageDBcreateInternalPackageDBdistPref=doletdbFile=distPref</>"package.conf.inplace"packageDB=SpecificPackageDBdbFilewriteFiledbFile"[]"returnpackageDBaddInternalBuildTools::PackageDescription->LocalBuildInfo->BuildInfo->ProgramDb->ProgramDbaddInternalBuildToolspkglbibiprogs=foldrupdateProgramprogsinternalBuildToolswhereinternalBuildTools=[simpleConfiguredProgramtoolName(FoundOnSystemtoolLocation)|toolName<-toolNames,lettoolLocation=buildDirlbi</>toolName</>toolName<.>exeExtension]toolNames=intersectbuildToolNamesinternalExeNamesinternalExeNames=mapexeName(executablespkg)buildToolNames=mapbuildToolName(buildToolsbi)wherebuildToolName(Dependency(PackageNamename)_)=name-- TODO: build separate libs in separate dirs so that we can build-- multiple libs, e.g. for 'LibTest' library-style testsuitesbuildLib::Verbosity->PackageDescription->LocalBuildInfo->Library->ComponentLocalBuildInfo->IO()buildLibverbositypkg_descrlbilibclbi=casecompilerFlavor(compilerlbi)ofGHC->GHC.buildLibverbositypkg_descrlbilibclbiJHC->JHC.buildLibverbositypkg_descrlbilibclbiLHC->LHC.buildLibverbositypkg_descrlbilibclbiHugs->Hugs.buildLibverbositypkg_descrlbilibclbiNHC->NHC.buildLibverbositypkg_descrlbilibclbiUHC->UHC.buildLibverbositypkg_descrlbilibclbi_->die"Building is not supported with this compiler."buildExe::Verbosity->PackageDescription->LocalBuildInfo->Executable->ComponentLocalBuildInfo->IO()buildExeverbositypkg_descrlbiexeclbi=casecompilerFlavor(compilerlbi)ofGHC->GHC.buildExeverbositypkg_descrlbiexeclbiJHC->JHC.buildExeverbositypkg_descrlbiexeclbiLHC->LHC.buildExeverbositypkg_descrlbiexeclbiHugs->Hugs.buildExeverbositypkg_descrlbiexeclbiNHC->NHC.buildExeverbositypkg_descrlbiexeclbiUHC->UHC.buildExeverbositypkg_descrlbiexeclbi_->die"Building is not supported with this compiler."initialBuildSteps::FilePath-- ^"dist" prefix->PackageDescription-- ^mostly information from the .cabal file->LocalBuildInfo-- ^Configuration information->Verbosity-- ^The verbosity to use->IO()initialBuildSteps_distPrefpkg_descrlbiverbosity=do-- check that there's something to buildletbuildInfos=maplibBuildInfo(maybeToList(librarypkg_descr))++mapbuildInfo(executablespkg_descr)unless(anybuildablebuildInfos)$doletname=display(packageIdpkg_descr)die("Package "++name++" can't be built on this system.")createDirectoryIfMissingVerboseverbosityTrue(buildDirlbi)writeAutogenFilesverbositypkg_descrlbi-- | Generate and write out the Paths_<pkg>.hs and cabal_macros.h files--writeAutogenFiles::Verbosity->PackageDescription->LocalBuildInfo->IO()writeAutogenFilesverbositypkglbi=docreateDirectoryIfMissingVerboseverbosityTrue(autogenModulesDirlbi)letpathsModulePath=autogenModulesDirlbi</>ModuleName.toFilePath(autogenModuleNamepkg)<.>"hs"rewriteFilepathsModulePath(Build.PathsModule.generatepkglbi)letcppHeaderPath=autogenModulesDirlbi</>cppHeaderNamerewriteFilecppHeaderPath(Build.Macros.generatepkglbi)