module Distribution.Simple.Haddock (
haddock, hscolour
) where
import Distribution.Compat.ReadP(readP_to_S)
import Distribution.Package (showPackageId)
import Distribution.PackageDescription
import Distribution.ParseUtils(Field(..), readFields, parseCommaList, parseFilePathQ)
import Distribution.Simple.Program(ConfiguredProgram(..), requireProgram,
lookupProgram, programPath, ghcPkgProgram,
hscolourProgram, haddockProgram, rawSystemProgram, rawSystemProgramStdoutConf,
ghcProgram)
import Distribution.Simple.PreProcess (ppCpp', ppUnlit, preprocessSources,
PPSuffixHandler, runSimplePreProcessor)
import Distribution.Simple.Setup
import Distribution.Simple.Build (initialBuildSteps)
import Distribution.Simple.InstallDirs (InstallDirTemplates(..),
PathTemplateVariable(..),
toPathTemplate, fromPathTemplate,
substPathTemplate,
initialPathTemplateEnv)
import Distribution.Simple.LocalBuildInfo ( LocalBuildInfo(..), hscolourPref,
haddockPref, distPref, autogenModulesDir )
import Distribution.Simple.Utils (die, warn, notice, createDirectoryIfMissingVerbose,
moduleToFilePath, findFile)
import Distribution.Simple.Utils (rawSystemStdout)
import Distribution.Verbosity
import Language.Haskell.Extension
import System.Directory(removeFile, doesFileExist)
import Control.Monad (liftM, when, unless, join)
import Data.Maybe ( isJust, catMaybes, fromJust )
import Data.Char (isSpace)
import Data.List (nub)
import Distribution.Compat.Directory(removeDirectoryRecursive, copyFile)
import System.FilePath((</>), (<.>), splitFileName, splitExtension,
replaceExtension)
import Distribution.Version
import Distribution.Simple.Compiler (compilerVersion, extensionsToFlags)
haddock :: PackageDescription -> LocalBuildInfo -> [PPSuffixHandler] -> HaddockFlags -> IO ()
haddock pkg_descr _ _ haddockFlags
| not (hasLibs pkg_descr) && not (haddockExecutables haddockFlags) =
warn (haddockVerbose haddockFlags) $
"No documentation was generated as this package does not contain "
++ "a\nlibrary. Perhaps you want to use the haddock command with the "
++ "--executables flag."
haddock pkg_descr lbi suffixes haddockFlags@HaddockFlags {
haddockExecutables = doExes,
haddockHscolour = hsColour,
haddockHscolourCss = hsColourCss,
haddockVerbose = verbosity
} = do
when hsColour $ hscolour pkg_descr lbi suffixes $
HscolourFlags hsColourCss doExes verbosity
(confHaddock, _) <- requireProgram verbosity haddockProgram
(orLaterVersion (Version [0,6] [])) (withPrograms lbi)
let tmpDir = buildDir lbi </> "tmp"
createDirectoryIfMissingVerbose verbosity True tmpDir
createDirectoryIfMissingVerbose verbosity True $ haddockPref pkg_descr
preprocessSources pkg_descr lbi False verbosity suffixes
setupMessage verbosity "Running Haddock for" pkg_descr
let replaceLitExts = map ( (tmpDir </>) . (`replaceExtension` "hs") )
let showPkg = showPackageId (package pkg_descr)
let outputFlag = if haddockHoogle haddockFlags
then "--hoogle"
else "--html"
let Just version = programVersion confHaddock
let have_src_hyperlink_flags = version >= Version [0,8] [] && version < Version [2,0] []
isVersion2 = version >= Version [2,0] []
let mockFlags
| isVersion2 = []
| otherwise = ["-D__HADDOCK__"]
let mockAll bi = mapM_ (mockPP mockFlags bi tmpDir)
let comp = compiler lbi
Just pkgTool = lookupProgram ghcPkgProgram (withPrograms lbi)
let cssFileFlag = case haddockCss haddockFlags of
Nothing -> []
Just cssFile -> ["--css=" ++ cssFile]
let verboseFlags = if verbosity > deafening then ["--verbose"] else []
when (hsColour && not have_src_hyperlink_flags) $
die "haddock --hyperlink-source requires Haddock version 0.8 or later"
let linkToHscolour = if hsColour
then ["--source-module=src/%{MODULE/./-}.html"
,"--source-entity=src/%{MODULE/./-}.html#%{NAME}"]
else []
let getField pkgId f = do
let name = showPackageId pkgId
s <- rawSystemStdout verbosity (programPath pkgTool) ["field", name, f]
case readFields s of
(ParseOk _ ((F _ _ fieldVal):_)) ->
return . join . join . take 1 . map fst . filter (null . snd)
. readP_to_S (parseCommaList parseFilePathQ) $ fieldVal
_ -> do
warn verbosity $ "Unrecognised output from ghc-pkg field "
++ name ++ " " ++ f ++ ": " ++ s
return []
let makeReadInterface pkgId = do
interface <- getField pkgId "haddock-interfaces"
html <- case haddockHtmlLocation haddockFlags of
Nothing -> getField pkgId "haddock-html"
Just htmlStrTemplate ->
let env0 = initialPathTemplateEnv pkgId (compilerId comp)
prefixSubst = prefixDirTemplate (installDirTemplates lbi)
env = (PrefixVar, prefixSubst) : env0
expandTemplateVars = fromPathTemplate
. substPathTemplate env
. toPathTemplate
in return (expandTemplateVars htmlStrTemplate)
interfaceExists <- doesFileExist interface
if interfaceExists
then return $ Just $ "--read-interface="
++ (if null html then "" else html ++ ",")
++ interface
else do warn verbosity $ "The documentation for package "
++ showPackageId pkgId ++ " is not installed. "
++ "No links to it will be generated."
return Nothing
packageFlags <- liftM catMaybes $ mapM makeReadInterface (packageDeps lbi)
when isVersion2 $ do
strHadGhcVers <- rawSystemProgramStdoutConf verbosity haddockProgram (withPrograms lbi) ["--ghc-version"]
let mHadGhcVers = readVersion strHadGhcVers
when (mHadGhcVers == Nothing) $ die "Could not get GHC version from Haddock"
when (fromJust mHadGhcVers /= compilerVersion comp) $
die "Haddock's internal GHC version must match the configured GHC version"
ghcLibDir0 <- rawSystemProgramStdoutConf verbosity ghcProgram (withPrograms lbi) ["--print-libdir"]
let ghcLibDir = reverse $ dropWhile isSpace $ reverse ghcLibDir0
let packageName = if isVersion2
then ["--optghc=-package-name", "--optghc=" ++ showPkg]
else ["--package=" ++ showPkg]
let haddock2options bi preprocessDir = if isVersion2
then ("-B" ++ ghcLibDir) : map ("--optghc=" ++) (ghcSimpleOptions lbi bi preprocessDir)
else []
when isVersion2 $ initialBuildSteps pkg_descr lbi verbosity suffixes
withLib pkg_descr () $ \lib -> do
let bi = libBuildInfo lib
modules = exposedModules lib ++ otherModules bi
inFiles <- getModulePaths lbi bi modules
unless isVersion2 $ mockAll bi inFiles
let prologName = distPref </> showPkg ++ "-haddock-prolog.txt"
prolog | null (description pkg_descr) = synopsis pkg_descr
| otherwise = description pkg_descr
subtitle | null (synopsis pkg_descr) = ""
| otherwise = ": " ++ synopsis pkg_descr
writeFile prologName (prolog ++ "\n")
let targets
| isVersion2 = modules
| otherwise = replaceLitExts inFiles
let haddockFile = haddockPref pkg_descr </> haddockName pkg_descr
rawSystemProgram verbosity confHaddock
([outputFlag,
"--odir=" ++ haddockPref pkg_descr,
"--title=" ++ showPkg ++ subtitle,
"--dump-interface=" ++ haddockFile,
"--prologue=" ++ prologName]
++ packageName
++ cssFileFlag
++ linkToHscolour
++ packageFlags
++ programArgs confHaddock
++ verboseFlags
++ map ("--hide=" ++) (otherModules bi)
++ haddock2options bi (buildDir lbi)
++ targets
)
removeFile prologName
notice verbosity $ "Documentation created: "
++ (haddockPref pkg_descr </> "index.html")
withExe pkg_descr $ \exe -> when doExes $ do
let bi = buildInfo exe
exeTargetDir = haddockPref pkg_descr </> exeName exe
createDirectoryIfMissingVerbose verbosity True exeTargetDir
inFiles' <- getModulePaths lbi bi (otherModules bi)
srcMainPath <- findFile (hsSourceDirs bi) (modulePath exe)
let inFiles = srcMainPath : inFiles'
mockAll bi inFiles
let prologName = distPref </> showPkg ++ "-haddock-prolog.txt"
prolog | null (description pkg_descr) = synopsis pkg_descr
| otherwise = description pkg_descr
writeFile prologName (prolog ++ "\n")
let targets
| isVersion2 = srcMainPath : otherModules bi
| otherwise = replaceLitExts inFiles
let preprocessDir = buildDir lbi </> exeName exe </> exeName exe ++ "-tmp"
rawSystemProgram verbosity confHaddock
([outputFlag,
"--odir=" ++ exeTargetDir,
"--title=" ++ exeName exe,
"--prologue=" ++ prologName]
++ linkToHscolour
++ packageFlags
++ programArgs confHaddock
++ verboseFlags
++ haddock2options bi preprocessDir
++ targets
)
removeFile prologName
notice verbosity $ "Documentation created: "
++ (exeTargetDir </> "index.html")
removeDirectoryRecursive tmpDir
where
mockPP inputArgs bi pref file
= do let (filePref, fileName) = splitFileName file
let targetDir = pref </> filePref
let targetFile = targetDir </> fileName
let (targetFileNoext, targetFileExt) = splitExtension targetFile
createDirectoryIfMissingVerbose verbosity True targetDir
if needsCpp bi
then runSimplePreProcessor (ppCpp' inputArgs bi lbi)
file targetFile verbosity
else copyFile file targetFile
when (targetFileExt == ".lhs") $ do
runSimplePreProcessor ppUnlit
targetFile (targetFileNoext <.> "hs") verbosity
return ()
needsCpp :: BuildInfo -> Bool
needsCpp bi = CPP `elem` extensions bi
ghcSimpleOptions :: LocalBuildInfo -> BuildInfo -> FilePath -> [String]
ghcSimpleOptions lbi bi mockDir
= ["-hide-all-packages"]
++ (concat [ ["-package", showPackageId pkg] | pkg <- packageDeps lbi ])
++ ["-i"]
++ hcOptions GHC (options bi)
++ ["-i" ++ autogenModulesDir lbi]
++ ["-i" ++ l | l <- nub (hsSourceDirs bi)]
++ ["-i" ++ mockDir]
++ ["-I" ++ dir | dir <- includeDirs bi]
++ ["-odir", mockDir]
++ ["-hidir", mockDir]
++ extensionsToFlags c (extensions bi)
where c = compiler lbi
hscolour :: PackageDescription -> LocalBuildInfo -> [PPSuffixHandler] -> HscolourFlags -> IO ()
hscolour pkg_descr lbi suffixes (HscolourFlags stylesheet doExes verbosity) = do
(confHscolour, _) <- requireProgram verbosity hscolourProgram
(orLaterVersion (Version [1,8] [])) (withPrograms lbi)
createDirectoryIfMissingVerbose verbosity True $ hscolourPref pkg_descr
preprocessSources pkg_descr lbi False verbosity suffixes
setupMessage verbosity "Running hscolour for" pkg_descr
let replaceDot = map (\c -> if c == '.' then '-' else c)
withLib pkg_descr () $ \lib -> when (isJust $ library pkg_descr) $ do
let bi = libBuildInfo lib
let modules = exposedModules lib ++ otherModules bi
inFiles <- getModulePaths lbi bi modules
flip mapM_ (zip modules inFiles) $ \(mo, inFile) -> do
let outputDir = hscolourPref pkg_descr </> "src"
let outFile = outputDir </> replaceDot mo <.> "html"
createDirectoryIfMissingVerbose verbosity True outputDir
copyCSS outputDir
rawSystemProgram verbosity confHscolour
["-css", "-anchor", "-o" ++ outFile, inFile]
withExe pkg_descr $ \exe -> when doExes $ do
let bi = buildInfo exe
let modules = "Main" : otherModules bi
let outputDir = hscolourPref pkg_descr </> exeName exe </> "src"
createDirectoryIfMissingVerbose verbosity True outputDir
copyCSS outputDir
srcMainPath <- findFile (hsSourceDirs bi) (modulePath exe)
inFiles <- liftM (srcMainPath :) $ getModulePaths lbi bi (otherModules bi)
flip mapM_ (zip modules inFiles) $ \(mo, inFile) -> do
let outFile = outputDir </> replaceDot mo <.> "html"
rawSystemProgram verbosity confHscolour
["-css", "-anchor", "-o" ++ outFile, inFile]
where copyCSS dir = case stylesheet of
Nothing -> return ()
Just s -> copyFile s (dir </> "hscolour.css")
getModulePaths :: LocalBuildInfo -> BuildInfo -> [String] -> IO [FilePath]
getModulePaths lbi bi =
fmap concat .
mapM (flip (moduleToFilePath (buildDir lbi : hsSourceDirs bi)) ["hs", "lhs"])