# 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 }: let inherit (stdenv.lib) optional; wrapper = ./hoogle-local-wrapper.sh; isGhcjs = ghc.isGhcjs or false; opts = lib.optionalString; haddockExe = if !isGhcjs then "haddock" else "haddock-ghcjs"; ghcName = if !isGhcjs then "ghc" else "ghcjs"; ghcDocLibDir = if !isGhcjs then ghc.doc + ''/share/doc/ghc*/html/libraries'' else ghc + ''/doc/lib''; # On GHCJS, use a stripped down version of GHC's prologue.txt prologue = if !isGhcjs then "${ghcDocLibDir}/prologue.txt" else writeText "ghcjs-prologue.txt" '' This index includes documentation for many Haskell modules. ''; # Packages like base and bytestring are null. These must be removed # to prevent eval errors. nonNullPackages = builtins.filter (p: p != null) packages; # TODO: closePropagation is deprecated; replace docPackages = lib.closePropagation # we grab the doc outputs (map (lib.getOutput "doc") nonNullPackages); in stdenv.mkDerivation { name = "hoogle-local-0.1"; buildInputs = [ghc hoogle]; phases = [ "buildPhase" ]; inherit docPackages; buildPhase = '' ${lib.optionalString (nonNullPackages != [] -> docPackages == []) ("echo WARNING: localHoogle package list empty, even though" + " the following were specified: " + lib.concatMapStringsSep ", " (p: p.name) nonNullPackages)} mkdir -p $out/share/doc/hoogle 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 done echo importing other packages ${lib.concatMapStringsSep "\n" (el: '' ln -sfn ${el.haddockDir} "$out/share/doc/hoogle/${el.name}" '') (builtins.map (p: { haddockDir = if p ? haddockDir then p.haddockDir p else null; name = p.pname; }) docPackages)} echo building hoogle database hoogle generate --database $out/share/doc/hoogle/default.hoo --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 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 }; meta = { description = "A local Hoogle database"; platforms = ghc.meta.platforms; hydraPlatforms = with stdenv.lib.platforms; none; maintainers = with stdenv.lib.maintainers; [ ttuegel ]; }; }