2026-02-17 21:32:10 +01:00
|
|
|
# Generate a Haddock index page for all packages visible to the current GHC
|
|
|
|
|
{
|
2026-02-17 21:35:28 +01:00
|
|
|
lib,
|
2026-02-17 21:32:10 +01:00
|
|
|
writers,
|
|
|
|
|
coreutils,
|
|
|
|
|
gnugrep,
|
|
|
|
|
gnused,
|
|
|
|
|
graphviz,
|
|
|
|
|
}:
|
|
|
|
|
writers.writeBashBin "nix-haddock-index" ''
|
|
|
|
|
set -efux
|
|
|
|
|
|
|
|
|
|
if test -z "''${NIX_GHC-}"; then
|
2026-02-17 21:35:28 +01:00
|
|
|
NIX_GHC=$(${lib.getExe' coreutils "readlink"} -f "$(type -P ghc)")
|
2026-02-17 21:32:10 +01:00
|
|
|
fi
|
|
|
|
|
|
2026-02-17 21:35:28 +01:00
|
|
|
if ! echo $NIX_GHC | ${lib.getExe gnugrep} -q '^/nix/store/'; then
|
2026-02-17 21:32:10 +01:00
|
|
|
printf '%s: error: unsupported GHC executable path (not in Nix store): %q\n' \
|
|
|
|
|
"$0" \
|
|
|
|
|
"$NIX_GHC" \
|
|
|
|
|
>&2
|
|
|
|
|
exit 1
|
|
|
|
|
fi
|
|
|
|
|
|
2026-02-17 21:35:28 +01:00
|
|
|
NIX_GHC_PREFIX=$(${lib.getExe' coreutils "dirname"} "$(${lib.getExe' coreutils "dirname"} "$NIX_GHC")")
|
2026-02-17 21:32:10 +01:00
|
|
|
NIX_GHC_DOCDIR=$NIX_GHC_PREFIX/share/doc/ghc/html
|
|
|
|
|
|
|
|
|
|
main() {
|
2026-02-17 21:35:28 +01:00
|
|
|
hash=$(echo $NIX_GHC_PREFIX | ${lib.getExe gnused} -n 's|^/nix/store/\([a-z0-9]\+\).*|\1|p')
|
2026-02-17 21:32:10 +01:00
|
|
|
title="Haddock index for $NIX_GHC_PREFIX"
|
|
|
|
|
|
|
|
|
|
header=$(
|
|
|
|
|
printf 'Haddock index for <a href="%s">%s</a>\n' \
|
|
|
|
|
$NIX_GHC_PREFIX \
|
|
|
|
|
$NIX_GHC_PREFIX \
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
suffix=''${hash:+-$hash}
|
|
|
|
|
index_file=/tmp/haddock$suffix-index.html
|
|
|
|
|
svg_file=/tmp/haddock$suffix.svg
|
|
|
|
|
|
|
|
|
|
eval "$(
|
|
|
|
|
echo 'gen_index() {'
|
|
|
|
|
echo ' html_head'
|
2026-02-17 21:35:28 +01:00
|
|
|
"$NIX_GHC_PREFIX"/bin/ghc-pkg dump | ${lib.getExe gnused} -n '
|
2026-02-17 21:32:10 +01:00
|
|
|
s/^---$/ reset/p
|
|
|
|
|
s/^\(name\|version\):\s*\([-A-Za-z0-9_.]\+\)$/ \1=\2/p
|
|
|
|
|
s/^haddock-html:\s*\([-A-Za-z0-9_./]\+\)$/ haddock_html \1/p
|
|
|
|
|
'
|
|
|
|
|
echo ' html_foot'
|
|
|
|
|
echo '}'
|
|
|
|
|
)"
|
|
|
|
|
|
|
|
|
|
gen_index > $index_file
|
|
|
|
|
|
2026-02-17 21:35:28 +01:00
|
|
|
"$NIX_GHC_PREFIX"/bin/ghc-pkg dot | ${lib.getExe' graphviz "tred"} | ${lib.getExe' graphviz "dot"} -Tsvg | ${lib.getExe gnused} '
|
2026-02-17 21:32:10 +01:00
|
|
|
s/<svg width="[0-9]\+pt" height="[0-9]\+pt"/<svg width="3600px" height="100%"/
|
|
|
|
|
' > $svg_file
|
|
|
|
|
|
|
|
|
|
echo $index_file
|
|
|
|
|
}
|
|
|
|
|
reset() {
|
|
|
|
|
unset name version
|
|
|
|
|
}
|
|
|
|
|
haddock_html() {
|
|
|
|
|
printf '<li>'
|
|
|
|
|
printf '<a href="%s/index.html">%s</a>' "$1" "$name-$version"
|
|
|
|
|
printf '</li>\n'
|
|
|
|
|
}
|
|
|
|
|
html_head() {
|
|
|
|
|
printf '<!doctype html>\n'
|
|
|
|
|
printf '<title>%s</title>\n' "$title"
|
|
|
|
|
printf '<link href="%s" rel="stylesheet" type="text/css">\n' \
|
|
|
|
|
"$NIX_GHC_DOCDIR/libraries/ocean.css"
|
|
|
|
|
printf '<h1>%s</h1>\n' "$header"
|
|
|
|
|
printf '<ul>\n'
|
|
|
|
|
}
|
|
|
|
|
html_foot() {
|
|
|
|
|
printf '</ul>\n'
|
|
|
|
|
printf '<a href="%s">graph</a>\n' "$svg_file"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
main "$@"
|
|
|
|
|
''
|
