diff --git a/Cabal.cabal b/Cabal.cabal --- a/Cabal.cabal +++ b/Cabal.cabal @@ -1,5 +1,5 @@ name: Cabal -version: 1.18.1.3 +version: 1.18.1.4 copyright: 2003-2006, Isaac Jones 2005-2011, Duncan Coutts license: BSD3 @@ -83,6 +83,11 @@ tests/PackageTests/CMain/foo.c tests/PackageTests/CMain/my.cabal tests/PackageTests/EmptyLib/empty/empty.cabal + tests/PackageTests/Haddock/CPP.hs + tests/PackageTests/Haddock/Literate.lhs + tests/PackageTests/Haddock/my.cabal + tests/PackageTests/Haddock/NoCPP.hs + tests/PackageTests/Haddock/Simple.hs tests/PackageTests/OrderFlags/Foo.hs tests/PackageTests/OrderFlags/my.cabal tests/PackageTests/PathsModule/Executable/Main.hs @@ -258,6 +263,7 @@ PackageTests.BuildTestSuiteDetailedV09.Check PackageTests.CMain.Check PackageTests.EmptyLib.Check + PackageTests.Haddock.Check PackageTests.OrderFlags.Check PackageTests.PackageTester PackageTests.PathsModule.Executable.Check diff --git a/Distribution/Simple/Haddock.hs b/Distribution/Simple/Haddock.hs --- a/Distribution/Simple/Haddock.hs +++ b/Distribution/Simple/Haddock.hs @@ -6,11 +6,8 @@ -- Maintainer : cabal-devel@haskell.org -- Portability : portable -- --- This module deals with the @haddock@ and @hscolour@ commands. Sadly this is --- a rather complicated module. It deals with two versions of haddock (0.x and --- 2.x). It has to do pre-processing for haddock 0.x which involves --- \'unlit\'ing and using @-DHADDOCK@ for any source code that uses @cpp@. It --- uses information about installed packages (from @ghc-pkg@) to find the +-- This module deals with the @haddock@ and @hscolour@ commands. +-- It uses information about installed packages (from @ghc-pkg@) to find the -- locations of documentation for dependent packages, so it can create links. -- -- The @hscolour@ support allows generating html versions of the original @@ -57,7 +54,7 @@ , PackageName(..), packageName ) import qualified Distribution.ModuleName as ModuleName import Distribution.PackageDescription as PD - ( PackageDescription(..), BuildInfo(..), allExtensions + ( PackageDescription(..), BuildInfo(..), usedExtensions , Library(..), hasLibs, Executable(..) , TestSuite(..), TestSuiteInterface(..) , Benchmark(..), BenchmarkInterface(..) ) @@ -70,8 +67,7 @@ ( ConfiguredProgram(..), requireProgramVersion , rawSystemProgram, rawSystemProgramStdout , hscolourProgram, haddockProgram ) -import Distribution.Simple.PreProcess (ppCpp', ppUnlit - , PPSuffixHandler, runSimplePreProcessor +import Distribution.Simple.PreProcess (PPSuffixHandler , preprocessComponent) import Distribution.Simple.Setup ( defaultHscolourFlags, Flag(..), toFlag, flagToMaybe, flagToList, fromFlag @@ -106,14 +102,13 @@ import Distribution.Verbosity import Language.Haskell.Extension -- Base -import System.Directory(removeFile, doesFileExist, createDirectoryIfMissing) +import System.Directory(doesFileExist) -import Control.Monad ( when, guard, forM_ ) -import Control.Exception (assert) +import Control.Monad ( when, forM_ ) import Data.Monoid import Data.Maybe ( fromMaybe, listToMaybe ) -import System.FilePath((), (<.>), splitFileName, splitExtension, +import System.FilePath((), (<.>), normalise, splitPath, joinPath, isAbsolute ) import System.IO (hClose, hPutStrLn) import Distribution.Version @@ -135,8 +130,8 @@ argOutputDir :: Directory, -- ^ where to generate the documentation. argTitle :: Flag String, -- ^ page's title, required. argPrologue :: Flag String, -- ^ prologue text, required. - argGhcOptions :: Flag (GhcOptions, Version), -- ^ additional flags to pass to ghc for haddock-2 - argGhcLibDir :: Flag FilePath, -- ^ to find the correct ghc, required by haddock-2. + argGhcOptions :: Flag (GhcOptions, Version), -- ^ additional flags to pass to ghc + argGhcLibDir :: Flag FilePath, -- ^ to find the correct ghc, required. argTargets :: [FilePath] -- ^ modules to process. } @@ -169,32 +164,25 @@ setupMessage verbosity "Running Haddock for" (packageId pkg_descr) (confHaddock, version, _) <- requireProgramVersion verbosity haddockProgram - (orLaterVersion (Version [0,6] [])) (withPrograms lbi) + (orLaterVersion (Version [2,0] [])) (withPrograms lbi) -- various sanity checks - let isVersion2 = version >= Version [2,0] [] - when ( flag haddockHoogle - && version > Version [2] [] && version < Version [2,2] []) $ die "haddock 2.0 and 2.1 do not support the --hoogle flag." - when (flag haddockHscolour && version < Version [0,8] []) $ - die "haddock --hyperlink-source requires Haddock version 0.8 or later" - - when isVersion2 $ do - haddockGhcVersionStr <- rawSystemProgramStdout verbosity confHaddock - ["--ghc-version"] - case simpleParse haddockGhcVersionStr of - Nothing -> die "Could not get GHC version from Haddock" - Just haddockGhcVersion - | haddockGhcVersion == ghcVersion -> return () - | otherwise -> die $ - "Haddock's internal GHC version must match the configured " - ++ "GHC version.\n" - ++ "The GHC version is " ++ display ghcVersion ++ " but " - ++ "haddock is using GHC version " ++ display haddockGhcVersion - where ghcVersion = compilerVersion (compiler lbi) + haddockGhcVersionStr <- rawSystemProgramStdout verbosity confHaddock + ["--ghc-version"] + case simpleParse haddockGhcVersionStr of + Nothing -> die "Could not get GHC version from Haddock" + Just haddockGhcVersion + | haddockGhcVersion == ghcVersion -> return () + | otherwise -> die $ + "Haddock's internal GHC version must match the configured " + ++ "GHC version.\n" + ++ "The GHC version is " ++ display ghcVersion ++ " but " + ++ "haddock is using GHC version " ++ display haddockGhcVersion + where ghcVersion = compilerVersion (compiler lbi) -- the tools match the requests, we can proceed @@ -203,7 +191,7 @@ when (flag haddockHscolour) $ hscolour' pkg_descr lbi suffixes $ defaultHscolourFlags `mappend` haddockToHscolour flags - libdirArgs <- getGhcLibDir verbosity lbi isVersion2 + libdirArgs <- getGhcLibDir verbosity lbi let commonArgs = mconcat [ libdirArgs , fromFlags (haddockTemplateEnv lbi (packageId pkg_descr)) flags @@ -216,10 +204,9 @@ doExe com = case (compToExe com) of Just exe -> do withTempDirectoryEx verbosity tmpFileOpts (buildDir lbi) "tmp" $ \tmp -> do - let bi = buildInfo exe - exeArgs <- fromExecutable verbosity tmp lbi exe clbi htmlTemplate - exeArgs' <- prepareSources verbosity tmp - lbi isVersion2 bi (commonArgs `mappend` exeArgs) + exeArgs <- fromExecutable verbosity tmp lbi exe clbi htmlTemplate + version + let exeArgs' = commonArgs `mappend` exeArgs runHaddock verbosity tmpFileOpts confHaddock exeArgs' Nothing -> do warn (fromFlag $ haddockVerbosity flags) @@ -228,10 +215,9 @@ case comp of CLib lib -> do withTempDirectoryEx verbosity tmpFileOpts (buildDir lbi) "tmp" $ \tmp -> do - let bi = libBuildInfo lib - libArgs <- fromLibrary verbosity tmp lbi lib clbi htmlTemplate - libArgs' <- prepareSources verbosity tmp - lbi isVersion2 bi (commonArgs `mappend` libArgs) + libArgs <- fromLibrary verbosity tmp lbi lib clbi htmlTemplate + version + let libArgs' = commonArgs `mappend` libArgs runHaddock verbosity tmpFileOpts confHaddock libArgs' CExe _ -> when (flag haddockExecutables) $ doExe comp CTest _ -> when (flag haddockTestSuites) $ doExe comp @@ -247,47 +233,8 @@ flag f = fromFlag $ f flags htmlTemplate = fmap toPathTemplate . flagToMaybe . haddockHtmlLocation $ flags --- | performs cpp and unlit preprocessing where needed on the files in --- | argTargets, which must have an .hs or .lhs extension. -prepareSources :: Verbosity - -> FilePath - -> LocalBuildInfo - -> Bool -- haddock >= 2.0 - -> BuildInfo - -> HaddockArgs - -> IO HaddockArgs -prepareSources verbosity tmp lbi isVersion2 bi args@HaddockArgs{argTargets=files} = - mapM (mockPP tmp) files >>= \targets -> return args {argTargets=targets} - where - mockPP pref file = do - let (filePref, fileName) = splitFileName file - targetDir = pref filePref - targetFile = targetDir fileName - (targetFileNoext, targetFileExt) = splitExtension $ targetFile - hsFile = targetFileNoext <.> "hs" - - assert (targetFileExt `elem` [".lhs",".hs"]) $ return () - - createDirectoryIfMissing True targetDir - - if needsCpp - then do - runSimplePreProcessor (ppCpp' defines bi lbi) - file targetFile verbosity - else - copyFileVerbose verbosity file targetFile - - when (targetFileExt == ".lhs") $ do - runSimplePreProcessor ppUnlit targetFile hsFile verbosity - removeFile targetFile - - return hsFile - needsCpp = EnableExtension CPP `elem` allExtensions bi - defines | isVersion2 = [] - | otherwise = ["-D__HADDOCK__"] - --------------------------------------------------------------------------------------------------- --- constributions to HaddockArgs +-- ------------------------------------------------------------------------------ +-- Contributions to HaddockArgs. fromFlags :: PathTemplateEnv -> HaddockFlags -> HaddockArgs fromFlags env flags = @@ -327,8 +274,9 @@ -> FilePath -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> Maybe PathTemplate -- ^ template for html location + -> Version -> IO HaddockArgs -fromLibrary verbosity tmp lbi lib clbi htmlTemplate = do +fromLibrary verbosity tmp lbi lib clbi htmlTemplate haddockVersion = do inFiles <- map snd `fmap` getLibSourceFiles lbi lib ifaceArgs <- getInterfaces verbosity lbi clbi htmlTemplate let vanillaOpts = (componentGhcOptions normal lbi bi clbi (buildDir lbi)) { @@ -339,7 +287,7 @@ ghcOptObjDir = toFlag tmp, ghcOptHiDir = toFlag tmp, ghcOptStubDir = toFlag tmp - } + } `mappend` getGhcCppOpts haddockVersion bi sharedOpts = vanillaOpts { ghcOptDynLinkMode = toFlag GhcDynamicOnly, ghcOptFPic = toFlag True, @@ -365,8 +313,9 @@ -> FilePath -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> Maybe PathTemplate -- ^ template for html location + -> Version -> IO HaddockArgs -fromExecutable verbosity tmp lbi exe clbi htmlTemplate = do +fromExecutable verbosity tmp lbi exe clbi htmlTemplate haddockVersion = do inFiles <- map snd `fmap` getExeSourceFiles lbi exe ifaceArgs <- getInterfaces verbosity lbi clbi htmlTemplate let vanillaOpts = (componentGhcOptions normal lbi bi clbi (buildDir lbi)) { @@ -377,7 +326,7 @@ ghcOptObjDir = toFlag tmp, ghcOptHiDir = toFlag tmp, ghcOptStubDir = toFlag tmp - } + } `mappend` getGhcCppOpts haddockVersion bi sharedOpts = vanillaOpts { ghcOptDynLinkMode = toFlag GhcDynamicOnly, ghcOptFPic = toFlag True, @@ -430,15 +379,27 @@ argInterfaces = packageFlags } +getGhcCppOpts :: Version + -> BuildInfo + -> GhcOptions +getGhcCppOpts haddockVersion bi = + mempty { + ghcOptExtensions = [EnableExtension CPP | needsCpp], + ghcOptCppOptions = defines + } + where + needsCpp = EnableExtension CPP `elem` usedExtensions bi + defines = [haddockVersionMacro] + haddockVersionMacro = "-D__HADDOCK_VERSION__=" + ++ show (v1 * 1000 + v2 * 10 + v3) + where + [v1, v2, v3] = take 3 $ versionBranch haddockVersion ++ [0,0] + getGhcLibDir :: Verbosity -> LocalBuildInfo - -> Bool -- ^ are we using haddock-2.x ? -> IO HaddockArgs -getGhcLibDir verbosity lbi isVersion2 - | isVersion2 = - do l <- ghcLibDir verbosity lbi - return $ mempty { argGhcLibDir = Flag l } - | otherwise = - return mempty +getGhcLibDir verbosity lbi = do + l <- ghcLibDir verbosity lbi + return $ mempty { argGhcLibDir = Flag l } ---------------------------------------------------------------------------------------------- @@ -473,7 +434,6 @@ let pflag = "--prologue=" ++ prologFileName k (pflag : renderPureArgs version args, result) where - isVersion2 = version >= Version [2,0] [] outputDir = (unDir $ argOutputDir args) result = intercalate ", " . map (\o -> outputDir @@ -482,8 +442,7 @@ Hoogle -> pkgstr <.> "txt") $ arg argOutput where - pkgstr | isVersion2 = display $ packageName pkgid - | otherwise = display pkgid + pkgstr = display $ packageName pkgid pkgid = arg argPackageName arg f = fromFlag $ f args @@ -492,9 +451,8 @@ [ (:[]) . (\f -> "--dump-interface="++ unDir (argOutputDir args) f) . fromFlag . argInterfaceFile $ args, - (\pname -> if isVersion2 - then ["--optghc=-package-name", "--optghc=" ++ pname] - else ["--package=" ++ pname]) . display . fromFlag . argPackageName $ args, + (\pname -> ["--optghc=-package-name", "--optghc=" ++ pname] + ) . display . fromFlag . argPackageName $ args, (\(All b,xs) -> bool (map (("--hide=" ++). display) xs) [] b) . argHideModules $ args, bool ["--ignore-all-exports"] [] . getAny . argIgnoreExports $ args, maybe [] (\(m,e) -> ["--source-module=" ++ m @@ -507,10 +465,9 @@ (:[]).("--odir="++) . unDir . argOutputDir $ args, (:[]).("--title="++) . (bool (++" (internal documentation)") id (getAny $ argIgnoreExports args)) . fromFlag . argTitle $ args, - [ "--optghc=" ++ opt | isVersion2 - , (opts, ghcVersion) <- flagToList (argGhcOptions args) + [ "--optghc=" ++ opt | (opts, ghcVersion) <- flagToList (argGhcOptions args) , opt <- renderGhcOptions ghcVersion opts ], - maybe [] (\l -> ["-B"++l]) $ guard isVersion2 >> flagToMaybe (argGhcLibDir args), -- error if isVersion2 and Nothing? + maybe [] (\l -> ["-B"++l]) $ flagToMaybe (argGhcLibDir args), -- error if Nothing? argTargets $ args ] where @@ -518,7 +475,6 @@ map (\(i,mh) -> "--read-interface=" ++ maybe "" (++",") mh ++ i) bool a b c = if c then a else b - isVersion2 = version >= Version [2,0] [] isVersion2_5 = version >= Version [2,5] [] verbosityFlag | isVersion2_5 = "--verbosity=1" diff --git a/Distribution/Simple/PreProcess.hs b/Distribution/Simple/PreProcess.hs --- a/Distribution/Simple/PreProcess.hs +++ b/Distribution/Simple/PreProcess.hs @@ -84,10 +84,10 @@ , findFileWithExtension, findFileWithExtension' ) import Distribution.Simple.Program ( Program(..), ConfiguredProgram(..), programPath - , lookupProgram, requireProgram, requireProgramVersion + , requireProgram, requireProgramVersion , rawSystemProgramConf, rawSystemProgram , greencardProgram, cpphsProgram, hsc2hsProgram, c2hsProgram - , happyProgram, alexProgram, haddockProgram, ghcProgram, gccProgram ) + , happyProgram, alexProgram, ghcProgram, gccProgram ) import Distribution.Simple.Test ( writeSimpleTestStub, stubFilePath, stubName ) import Distribution.System ( OS(..), buildOS, Arch(..), Platform(..) ) @@ -384,7 +384,6 @@ -- double-unlitted. In the future we might switch to -- using cpphs --unlit instead. ++ (if ghcVersion >= Version [6,6] [] then ["-x", "hs"] else []) - ++ (if use_optP_P lbi then ["-optP-P"] else []) ++ [ "-optP-include", "-optP"++ (autogenModulesDir lbi cppHeaderName) ] ++ ["-o", outFile, inFile] ++ extraArgs @@ -405,16 +404,6 @@ else []) ++ extraArgs } - --- Haddock versions before 0.8 choke on #line and #file pragmas. Those --- pragmas are necessary for correct links when we preprocess. So use --- -optP-P only if the Haddock version is prior to 0.8. -use_optP_P :: LocalBuildInfo -> Bool -use_optP_P lbi - = case lookupProgram haddockProgram (withPrograms lbi) of - Just (ConfiguredProgram { programVersion = Just version }) - | version >= Version [0,8] [] -> False - _ -> True ppHsc2hs :: BuildInfo -> LocalBuildInfo -> PreProcessor ppHsc2hs bi lbi = diff --git a/Distribution/Simple/Setup.hs b/Distribution/Simple/Setup.hs --- a/Distribution/Simple/Setup.hs +++ b/Distribution/Simple/Setup.hs @@ -1143,7 +1143,7 @@ where name = "haddock" shortDesc = "Generate Haddock HTML documentation." - longDesc = Just $ \_ -> "Requires the program haddock, either version 0.x or 2.x.\n" + longDesc = Just $ \_ -> "Requires the program haddock, version 2.x.\n" options showOrParseArgs = [optionVerbosity haddockVerbosity (\v flags -> flags { haddockVerbosity = v }) diff --git a/doc/API/Cabal/Cabal.haddock b/doc/API/Cabal/Cabal.haddock Binary files a/doc/API/Cabal/Cabal.haddock and b/doc/API/Cabal/Cabal.haddock differ diff --git a/doc/API/Cabal/Distribution-Compat-CreatePipe.html b/doc/API/Cabal/Distribution-Compat-CreatePipe.html new file mode 100644 --- /dev/null +++ b/doc/API/Cabal/Distribution-Compat-CreatePipe.html @@ -0,0 +1,4 @@ +Distribution.Compat.CreatePipe

Cabal-1.20.0.1: A framework for packaging Haskell software

Safe HaskellSafe-Inferred

Distribution.Compat.CreatePipe

Documentation

createPipe :: IO (Handle, Handle)

diff --git a/doc/API/Cabal/Distribution-Compat-Exception.html b/doc/API/Cabal/Distribution-Compat-Exception.html --- a/doc/API/Cabal/Distribution-Compat-Exception.html +++ b/doc/API/Cabal/Distribution-Compat-Exception.html @@ -1,4 +1,4 @@ Distribution.Compat.Exception

Cabal-1.18.1.3: A framework for packaging Haskell software

Safe HaskellSafe-Inferred

Distribution.Compat.Exception

Documentation

catchIO :: IO a -> (IOException -> IO a) -> IO a

catchExit :: IO a -> (ExitCode -> IO a) -> IO a

tryIO :: IO a -> IO (Either IOException a)

+

Cabal-1.18.1.4: A framework for packaging Haskell software

Safe HaskellSafe-Inferred

Distribution.Compat.Exception

Documentation

catchIO :: IO a -> (IOException -> IO a) -> IO a

catchExit :: IO a -> (ExitCode -> IO a) -> IO a

tryIO :: IO a -> IO (Either IOException a)

diff --git a/doc/API/Cabal/Distribution-Compat-ReadP.html b/doc/API/Cabal/Distribution-Compat-ReadP.html --- a/doc/API/Cabal/Distribution-Compat-ReadP.html +++ b/doc/API/Cabal/Distribution-Compat-ReadP.html @@ -1,7 +1,7 @@ Distribution.Compat.ReadP

Cabal-1.18.1.3: A framework for packaging Haskell software

Portabilityportable
Maintainerlibraries@haskell.org
Safe HaskellSafe-Inferred

Distribution.Compat.ReadP

Contents