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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
# Install not only the Hoogle library and executable, but also a local Hoogle
# database which provides "Source" links to all specified 'packages' -- or the
# current Haskell Platform if no custom package set is provided.
{
lib,
stdenv,
buildPackages,
haskellPackages,
writeText,
runCommand,
nixosTests,
}:
# This argument is a function which selects a list of Haskell packages from any
# passed Haskell package set.
#
# Example:
# (hpkgs: [ hpkgs.mtl hpkgs.lens ])
selectPackages:
let
inherit (haskellPackages) ghc hoogle;
packages = selectPackages haskellPackages;
wrapper = ./hoogle-local-wrapper.sh;
haddockExe = "haddock";
ghcDocLibDir = ghc.doc + "/share/doc/ghc*/html/libraries";
prologue = "${ghcDocLibDir}/prologue.txt";
docPackages =
lib.closePropagation
# we grab the doc outputs
(map (lib.getOutput "doc") packages);
# Hoogle database path, relative to `$out`.
databasePath = "share/doc/hoogle/default.hoo";
in
buildPackages.stdenv.mkDerivation (finalAttrs: {
name = "hoogle-with-packages";
buildInputs = [
ghc
hoogle
];
# compiling databases takes less time than copying the results
# between machines.
preferLocalBuild = true;
# we still allow substitutes because a database is relatively small and if it
# is already built downloading is probably faster. The substitution will only
# trigger for users who have already cached the database on a substituter and
# thus probably intend to substitute it.
allowSubstitutes = true;
buildCommand = ''
${
let
# Filter out nulls here to work around https://github.com/NixOS/nixpkgs/issues/82245
# If we don't then grabbing `p.name` here will fail.
packages' = lib.filter (p: p != null) packages;
in
lib.optionalString (packages' != [ ] -> docPackages == [ ]) (
"echo WARNING: localHoogle package list empty, even though"
+ " the following were specified: "
+ lib.concatMapStringsSep ", " (p: p.name) packages'
)
}
mkdir -p $out/share/doc/hoogle
echo importing builtin packages
for docdir in ${ghcDocLibDir}"/"*; do
name="$(basename $docdir)"
if [[ -d $docdir ]]; then
ln -sfn $docdir $out/share/doc/hoogle/$name
fi
done
echo importing other packages
${lib.concatMapStringsSep "\n"
(el: ''
ln -sfn ${el.haddockDir} "$out/share/doc/hoogle/${el.name}"
'')
(
lib.filter (el: el.haddockDir != null) (
map (p: {
haddockDir = if p ? haddockDir then p.haddockDir p else null;
name = p.pname;
}) docPackages
)
)
}
databasePath="$out/"${lib.escapeShellArg databasePath}
echo building hoogle database
hoogle generate --database "$databasePath" --local=$out/share/doc/hoogle
echo building haddock index
# adapted from GHC's gen_contents_index
cd $out/share/doc/hoogle
args=
for hdfile in $(ls -1 *"/"*.haddock | grep -v '/ghc\.haddock' | sort); do
name_version=`echo "$hdfile" | sed 's#/.*##'`
args="$args --read-interface=$name_version,$hdfile"
done
${ghc}/bin/${haddockExe} --gen-index --gen-contents -o . \
-t "Haskell Hierarchical Libraries" \
-p ${prologue} \
$args
echo finishing up
mkdir -p $out/bin
substitute ${wrapper} $out/bin/hoogle \
--subst-var-by shell ${stdenv.shell} \
--subst-var-by database "$databasePath" \
--subst-var-by hoogle ${hoogle}
chmod +x $out/bin/hoogle
'';
__structuredAttrs = true;
passthru = {
isHaskellLibrary = false; # for the filter in ./with-packages-wrapper.nix
inherit docPackages;
# The path to the Hoogle database.
database = "${finalAttrs.finalPackage}/${databasePath}";
tests.can-search-database = runCommand "can-search-database" { } ''
# This succeeds even if no results are found, but `Prelude.map` should
# always be available.
${finalAttrs.finalPackage}/bin/hoogle search Prelude.map > $out
'';
};
passthru.tests.nixos = nixosTests.hoogle;
meta = {
description = "Local Hoogle database";
platforms = ghc.meta.platforms;
hydraPlatforms = with lib.platforms; none;
maintainers = [ ];
};
})
|
