nixpkgs/pkgs/development/haskell-modules/hoogle.nix

132 lines
3.8 KiB
Nix
Raw Normal View History

2015-01-22 23:10:08 +00:00
# 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.
#
# It is intended to be used in config.nix similarly to:
#
# { packageOverrides = pkgs: rec {
#
# haskellPackages =
# let callPackage = pkgs.lib.callPackageWith haskellPackages;
# in pkgs.recurseIntoAttrs (pkgs.haskellPackages.override {
# extension = self: super: {
# hoogleLocal = pkgs.haskellPackages.hoogleLocal.override {
# packages = with pkgs.haskellPackages; [
# mmorph
# monadControl
# ];
# };
# };
# });
# }}
#
# This will build mmorph and monadControl, and have the hoogle installation
# refer to their documentation via symlink so they are not garbage collected.
{ lib, stdenv, hoogle, writeText, ghc
, packages
2015-01-22 23:10:08 +00:00
}:
let
inherit (stdenv.lib) optional;
wrapper = ./hoogle-local-wrapper.sh;
2016-02-01 04:00:43 +00:00
isGhcjs = ghc.isGhcjs or false;
opts = lib.optionalString;
2016-02-01 04:00:43 +00:00
haddockExe =
if !isGhcjs
then "haddock"
else "haddock-ghcjs";
ghcName =
if !isGhcjs
then "ghc"
else "ghcjs";
ghcDocLibDir =
2016-02-01 04:00:43 +00:00
if !isGhcjs
then ghc.doc + ''/share/doc/ghc*/html/libraries''
else ghc + ''/doc/lib'';
2016-02-01 04:00:43 +00:00
# On GHCJS, use a stripped down version of GHC's prologue.txt
prologue =
if !isGhcjs
then "${ghcDocLibDir}/prologue.txt"
2016-02-01 04:00:43 +00:00
else writeText "ghcjs-prologue.txt" ''
This index includes documentation for many Haskell modules.
'';
# TODO: closePropagation is deprecated; replace
docPackages = lib.closePropagation
# we grab the doc outputs
(map (lib.getOutput "doc") packages);
2015-01-22 23:10:08 +00:00
in
stdenv.mkDerivation {
name = "hoogle-local-0.1";
buildInputs = [ghc hoogle];
2015-01-22 23:10:08 +00:00
phases = [ "buildPhase" ];
2015-01-22 23:10:08 +00:00
inherit docPackages;
buildPhase = ''
${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
2015-01-22 23:10:08 +00:00
echo importing builtin packages
for docdir in ${ghcDocLibDir}/*; do
name="$(basename $docdir)"
${opts isGhcjs ''docdir="$docdir/html"''}
if [[ -d $docdir ]]; then
ln -sfn $docdir $out/share/doc/hoogle/$name
fi
2015-01-22 23:10:08 +00:00
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)
(builtins.map (p: { haddockDir = p.haddockDir p;
name = p.pname; })
docPackages))}
2015-01-22 23:10:08 +00:00
echo building hoogle database
hoogle generate --database $out/share/doc/hoogle/default.hoo --local=$out/share/doc/hoogle
2015-01-22 23:10:08 +00:00
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
2016-02-01 04:00:43 +00:00
${ghc}/bin/${haddockExe} --gen-index --gen-contents -o . \
-t "Haskell Hierarchical Libraries" \
2016-02-01 04:00:43 +00:00
-p ${prologue} \
$args
2015-01-22 23:10:08 +00:00
echo finishing up
2015-01-22 23:10:08 +00:00
mkdir -p $out/bin
substitute ${wrapper} $out/bin/hoogle \
--subst-var out --subst-var-by shell ${stdenv.shell} \
--subst-var-by hoogle ${hoogle}
chmod +x $out/bin/hoogle
'';
passthru = {
isHaskellLibrary = false; # for the filter in ./with-packages-wrapper.nix
};
2015-01-22 23:10:08 +00:00
meta = {
description = "A local Hoogle database";
platforms = ghc.meta.platforms;
hydraPlatforms = with stdenv.lib.platforms; none;
maintainers = with stdenv.lib.maintainers; [ ttuegel ];
};
}