1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
module Settings.Builders.Haddock (haddockBuilderArgs) where
import Hadrian.Utilities
import Hadrian.Haskell.Cabal
import Rules.Documentation
import Settings.Builders.Common
import Settings.Builders.Ghc
-- | Given a version string such as "2.16.2" produce an integer equivalent.
versionToInt :: String -> Int
versionToInt s = case map read . words $ replaceEq '.' ' ' s of
[major, minor, patch] -> major * 1000 + minor * 10 + patch
_ -> error "versionToInt: cannot parse version."
haddockBuilderArgs :: Args
haddockBuilderArgs = withHsPackage $ \cabalFile -> mconcat
[ builder (Haddock BuildIndex) ? do
output <- getOutput
inputs <- getInputs
mconcat
[ arg "--gen-index"
, arg "--gen-contents"
, arg "-o", arg $ takeDirectory output
, arg "-t", arg "Haskell Hierarchical Libraries"
, arg "-p", arg "libraries/prologue.txt"
, pure [ "--read-interface="
++ (takeFileName . takeDirectory) haddock
++ "," ++ haddock | haddock <- inputs ] ]
, builder (Haddock BuildPackage) ? do
output <- getOutput
pkg <- getPackage
path <- getBuildPath
version <- expr $ pkgVersion cabalFile
synopsis <- expr $ pkgSynopsis cabalFile
deps <- getPkgDataList DepNames
haddocks <- expr . haddockDependencies =<< getContext
hVersion <- expr $ pkgVersion (unsafePkgCabalFile haddock) -- TODO: improve
ghcOpts <- haddockGhcArgs
mconcat
[ arg $ "--odir=" ++ takeDirectory output
, arg "--verbosity=0"
, arg "--no-tmp-comp-dir"
, arg $ "--dump-interface=" ++ output
, arg "--html"
, arg "--hyperlinked-source"
, arg "--hoogle"
, arg $ "--title=" ++ pkgName pkg ++ "-" ++ version
++ ": " ++ synopsis
, arg $ "--prologue=" ++ path -/- "haddock-prologue.txt"
, arg $ "--optghc=-D__HADDOCK_VERSION__="
++ show (versionToInt hVersion)
, map ("--hide=" ++) <$> getPkgDataList HiddenModules
, pure [ "--read-interface=../" ++ dep
++ ",../" ++ dep ++ "/src/%{MODULE}.html#%{NAME},"
++ haddock | (dep, haddock) <- zip deps haddocks ]
, pure [ "--optghc=" ++ opt | opt <- ghcOpts ]
, getInputs
, arg "+RTS"
, arg $ "-t" ++ path -/- "haddock.t"
, arg "--machine-readable"
, arg "-RTS" ] ]
|
