@@ -1,14 +1,19 @@
11{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
23
34module Distribution.Nixpkgs.Haskell.FromCabal.PostProcess ( postProcess, pkg ) where
45
56import Control.Lens
7+import Control.Monad.Trans.State
68import Data.List.Split
9+import Data.Map ( Map )
10+import qualified Data.Map as Map
11+import Data.Map.Lens
712import Data.Set ( Set )
813import qualified Data.Set as Set
9−import Data.Set.Lens
1014import Distribution.Nixpkgs.Haskell
1115import Distribution.Nixpkgs.Meta
16+import Distribution.Nixpkgs.License
1217import Distribution.Package
1318import Distribution.System
1419import Distribution.Text
@@ -16,7 +21,11 @@ import Distribution.Version
1621import Language.Nix
1722
1823postProcess :: Derivation -> Derivation
19−postProcess deriv = foldr ($) (fixGtkBuilds deriv) [ f | (Dependency n vr, f) <- hooks, packageName deriv == n, packageVersion deriv `withinRange` vr ]
24+postProcess deriv =
25+ foldr (.) id [ f | (Dependency n vr _, f) <- hooks, packageName deriv == n, packageVersion deriv `withinRange` vr ]
26+ . fixGtkBuilds
27+ . fixBuildDependsForTools
28+ $ deriv
2029
2130fixGtkBuilds :: Derivation -> Derivation
2231fixGtkBuilds drv = drv & dependencies . pkgconfig %~ Set.filter (not . collidesWithHaskellName)
@@ -24,42 +33,79 @@ fixGtkBuilds drv = drv & dependencies . pkgconfig %~ Set.filter (not . collidesW
2433 & dependencies . tool %~ Set.filter (not . collidesWithHaskellName)
2534 where
2635 collidesWithHaskellName :: Binding -> Bool
27− collidesWithHaskellName b = view localName b `Set.member` buildDeps
36+ collidesWithHaskellName b = case buildDeps Map.!? view localName b of
37+ Nothing -> False -- totally uncollided
38+ Just p -> p /= view reference b -- identical is not collision, and important to preserve for cross
2839
2940 myName :: Identifier
3041 myName = ident # unPackageName (packageName drv)
3142
32− buildDeps :: Set Identifier
33− buildDeps = Set.delete myName (setOf (dependencies . haskell . folded . localName) drv)
43+ buildDeps :: Map Identifier Path
44+ buildDeps = Map.delete myName (toMapOf (dependencies . haskell . to Set.toList . traverse . binding . ifolded) drv)
45+
46+-- Per https://github.com/haskell/cabal/issues/5412 hvr considers
47+-- `build-depends` providing executables an accident, and fragile one at that,
48+-- unworthy of any compatibility hacks. But while he and the other Hackage
49+-- maintainers is dedicated to fixing executables and libraries on Hackage, test
50+-- suites and benchmarks are not a priority, as it is trivial to skip building
51+-- test-suites with cabal-install. Nix however wishes to build test suites much
52+-- more widely, so skipping those components is not an option.
53+--
54+-- Between that, and Stack not changing behavior as of
55+-- https://github.com/commercialhaskell/stack/pull/4132, it seems likely that
56+-- for a while packages scraped from Hackage will continue to improperly use
57+-- `build-depends: package-for-tool` instead of `build-tool-depends` (which does
58+-- also work for Stack). Until that changes, we provide do this to work around
59+-- those package's brokenness.
60+fixBuildDependsForTools :: Derivation -> Derivation
61+fixBuildDependsForTools = foldr (.) id
62+ [ fmap snd $ runState $ do
63+ needs <- use $ cloneLens c . haskell . contains p
64+ cloneLens c . tool . contains p ||= needs
65+ | (c :: ALens' Derivation BuildInfo) <- [ testDepends, benchmarkDepends ]
66+ , p <- self <$> [ "hspec-discover"
67+ , "tasty-discover"
68+ , "hsx2hs"
69+ , "markdown-unlit"
70+ ]
71+ ]
3472
3573hooks :: [(Dependency, Derivation -> Derivation)]
3674hooks =
3775 [ ("Agda < 2.5", set (executableDepends . tool . contains (pkg "emacs")) True . set phaseOverrides agdaPostInstall)
3876 , ("Agda >= 2.5", set (executableDepends . tool . contains (pkg "emacs")) True . set phaseOverrides agda25PostInstall)
3977 , ("alex < 3.1.5", set (testDepends . tool . contains (pkg "perl")) True)
40− , ("alex", set (executableDepends . tool . contains (bind "self.happy")) True)
41− , ("alsa-core", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Linux))) , ("bustle", set (libraryDepends . pkgconfig . contains "system-glib = pkgs.glib") True)
78+ , ("alex", set (executableDepends . tool . contains (self "happy")) True)
79+ , ("alsa-core", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Linux)))
4280 , ("bindings-GLFW", over (libraryDepends . system) (Set.union (Set.fromList [bind "pkgs.xorg.libXext", bind "pkgs.xorg.libXfixes"])))
43− , ("bindings-lxc", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Linux))) , ("bustle", set (libraryDepends . pkgconfig . contains "system-glib = pkgs.glib") True)
44− , ("bustle", set (libraryDepends . pkgconfig . contains "system-glib = pkgs.glib") True)
81+ , ("bindings-lxc", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Linux)))
82+ , ("bustle", bustleOverrides)
4583 , ("Cabal", set doCheck False) -- test suite doesn't work in Nix
46− , ("Cabal >2.2", over (setupDepends . haskell) (Set.union (Set.fromList [bind "self.mtl", bind "self.parsec"]))) -- https://github.com/haskell/cabal/issues/5391
84+ , ("Cabal >2.2", over (setupDepends . haskell) (Set.union (Set.fromList [self "mtl", self "parsec"]))) -- https://github.com/haskell/cabal/issues/5391
4785 , ("cabal-helper", set doCheck False) -- https://github.com/DanielG/cabal-helper/issues/17
4886 , ("cabal-install", set doCheck False . set phaseOverrides cabalInstallPostInstall)
87+ , ("cabal2nix > 2", cabal2nixOverrides)
4988 , ("darcs", set phaseOverrides darcsInstallPostInstall . set doCheck False)
5089 , ("dbus", set doCheck False) -- don't execute tests that try to access the network
5190 , ("dns", set testTarget "spec") -- don't execute tests that try to access the network
5291 , ("eventstore", over (metaSection . platforms) (Set.filter (\(Platform arch _) -> arch == X86_64)))
5392 , ("freenect < 1.2.1", over configureFlags (Set.union (Set.fromList ["--extra-include-dirs=${pkgs.freenect}/include/libfreenect", "--extra-lib-dirs=${pkgs.freenect}/lib"])))
93+ , ("fltkhs", set (libraryDepends . system . contains (pkg "fltk14")) True . over (libraryDepends . pkgconfig) (Set.union (pkgs ["libGLU", "libGL"]))) -- TODO: fltk14 belongs into the *setup* dependencies.
5494 , ("gf", set phaseOverrides gfPhaseOverrides . set doCheck False)
5595 , ("gi-cairo", giCairoPhaseOverrides) -- https://github.com/haskell-gi/haskell-gi/issues/36
96+ , ("gi-gdk", set runHaddock True )
97+ , ("gi-gio", set runHaddock True )
98+ , ("gi-glib", set runHaddock True )
5699 , ("gi-gst", giGstLibOverrides "gstreamer") -- https://github.com/haskell-gi/haskell-gi/issues/36
57100 , ("gi-gstaudio", giGstLibOverrides "gst-plugins-base") -- https://github.com/haskell-gi/haskell-gi/issues/36
58101 , ("gi-gstbase", giGstLibOverrides "gst-plugins-base") -- https://github.com/haskell-gi/haskell-gi/issues/36
59102 , ("gi-gstvideo", giGstLibOverrides "gst-plugins-base") -- https://github.com/haskell-gi/haskell-gi/issues/36
103+ , ("gi-gtk", set runHaddock True )
60104 , ("gi-javascriptcore < 4.0.0.0", webkitgtk24xHook) -- https://github.com/haskell-gi/haskell-gi/issues/36
61105 , ("gi-pango", giCairoPhaseOverrides) -- https://github.com/haskell-gi/haskell-gi/issues/36
106+ , ("gi-pango", set runHaddock True )
62107 , ("gi-pangocairo", giCairoPhaseOverrides) -- https://github.com/haskell-gi/haskell-gi/issues/36
108+ , ("gi-vte", set runHaddock True )
63109 , ("gi-webkit", webkitgtk24xHook) -- https://github.com/haskell-gi/haskell-gi/issues/36
64110 , ("gio", set (libraryDepends . pkgconfig . contains "system-glib = pkgs.glib") True)
65111 , ("git", set doCheck False) -- https://github.com/vincenthz/hit/issues/33
@@ -70,6 +116,7 @@ hooks =
70116 , ("GlomeVec", set (libraryDepends . pkgconfig . contains (bind "self.llvmPackages.llvm")) True)
71117 , ("graphviz", set (testDepends . system . contains (pkg "graphviz")) True)
72118 , ("gtk3", gtk3Hook)
119+ , ("gtkglext", gtkglextHook)
73120 , ("haddock", haddockHook) -- https://github.com/haskell/haddock/issues/511
74121 , ("hakyll", set (testDepends . tool . contains (pkg "utillinux")) True) -- test suite depends on "rev"
75122 , ("haskell-src-exts", set doCheck False)
@@ -80,31 +127,34 @@ hooks =
80127 , ("holy-project", set doCheck False) -- attempts to access the network
81128 , ("hoogle", set testTarget "--test-option=--no-net")
82129 , ("hsignal < 0.2.7.4", set phaseOverrides "prePatch = \"rm -v Setup.lhs\";") -- https://github.com/amcphail/hsignal/issues/1
83− , ("hslua < 0.9.3", over (libraryDepends . each) (replace (pkg "lua") (pkg "lua5_1")))
84− , ("hslua >= 0.9.3", over (libraryDepends . each) (replace (pkg "lua") (pkg "lua5_3")))
130+ , ("hslua < 0.9.3", over (libraryDepends . system) (replace (pkg "lua") (pkg "lua5_1")))
131+ , ("hslua >= 0.9.3", over (libraryDepends . system) (replace (pkg "lua") (pkg "lua5_3")))
85132 , ("hspec-core >= 2.4.4", hspecCoreOverrides)
86133 , ("http-client", set doCheck False) -- attempts to access the network
87134 , ("http-client-openssl >= 0.2.0.1", set doCheck False) -- attempts to access the network
88135 , ("http-client-tls >= 0.2.2", set doCheck False) -- attempts to access the network
89136 , ("http-conduit", set doCheck False) -- attempts to access the network
90137 , ("imagemagick", set (libraryDepends . pkgconfig . contains (pkg "imagemagick")) True) -- https://github.com/NixOS/cabal2nix/issues/136
91− , ("include-file <= 0.1.0.2", set (libraryDepends . haskell . contains (bind "self.random")) True) -- https://github.com/Daniel-Diaz/include-file/issues/1
138+ , ("include-file <= 0.1.0.2", set (libraryDepends . haskell . contains (self "random")) True) -- https://github.com/Daniel-Diaz/include-file/issues/1
92139 , ("js-jquery", set doCheck False) -- attempts to access the network
93140 , ("libconfig", over (libraryDepends . system) (replace "config = null" (pkg "libconfig")))
94141 , ("libxml", set (configureFlags . contains "--extra-include-dir=${libxml2.dev}/include/libxml2") True)
95142 , ("liquid-fixpoint", set (executableDepends . system . contains (pkg "ocaml")) True . set (testDepends . system . contains (pkg "z3")) True . set (testDepends . system . contains (pkg "nettools")) True . set (testDepends . system . contains (pkg "git")) True . set doCheck False)
96143 , ("liquidhaskell", set (testDepends . system . contains (pkg "z3")) True)
97− , ("lzma-clib", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Windows)) . set (libraryDepends . haskell . contains (bind "self.only-buildable-on-windows")) False)
98− , ("MFlow < 4.6", set (libraryDepends . tool . contains (bind "self.cpphs")) True)
144+ , ("lzma-clib", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Windows)) . set (libraryDepends . haskell . contains (self "only-buildable-on-windows")) False)
145+ , ("MFlow < 4.6", set (libraryDepends . tool . contains (self "cpphs")) True)
99146 , ("mwc-random", set doCheck False)
100147 , ("mysql", set (libraryDepends . system . contains (pkg "mysql")) True)
101148 , ("network-attoparsec", set doCheck False) -- test suite requires network access
102149 , ("numeric-qq", set doCheck False) -- test suite doesn't finish even after 1+ days
103150 , ("opencv", opencvOverrides)
104− , ("pandoc >= 1.16.0.2", set doCheck False) -- https://github.com/jgm/pandoc/issues/2709 and https://github.com/fpco/stackage/issues/1332
105− , ("pandoc", set jailbreak False) -- jailbreak-cabal break the build
106− , ("pandoc-citeproc", set doCheck False) -- https://github.com/jgm/pandoc-citeproc/issues/172
151+ , ("pandoc >= 1.16.0.2 && < 2.5", set doCheck False) -- https://github.com/jgm/pandoc/issues/2709 and https://github.com/fpco/stackage/issues/1332
152+ , ("pandoc < 2.6", pandocPre26Overrides)
153+ , ("pandoc >= 2.6", pandocOverrides)
154+ , ("pandoc-citeproc", set doCheck False) -- https://github.com/jgm/pandoc-citeproc/issues/369
107155 , ("purescript", set doCheck False) -- test suite doesn't cope with Nix build env
156+ , ("proto-lens-protobuf-types", set (libraryDepends . tool . contains (pkg "protobuf")) True)
157+ , ("proto-lens-protoc", set (libraryDepends . tool . contains (pkg "protobuf")) True)
108158 , ("qtah-cpp-qt5", set (libraryDepends . system . contains (bind "pkgs.qt5.qtbase")) True)
109159 , ("qtah-qt5", set (libraryDepends . tool . contains (bind "pkgs.qt5.qtbase")) True)
110160 , ("readline", over (libraryDepends . system) (Set.union (pkgs ["readline", "ncurses"])))
@@ -118,10 +168,11 @@ hooks =
118168 , ("target", set (testDepends . system . contains (pkg "z3")) True)
119169 , ("terminfo", set (libraryDepends . system . contains (pkg "ncurses")) True)
120170 , ("text", set doCheck False) -- break infinite recursion
121− , ("thyme", set (libraryDepends . tool . contains (bind "self.cpphs")) True) -- required on Darwin
171+ , ("tensorflow-proto", set (libraryDepends . tool . contains (pkg "protobuf")) True)
172+ , ("thyme", set (libraryDepends . tool . contains (self "cpphs")) True) -- required on Darwin
122173 , ("twilio", set doCheck False) -- attempts to access the network
123174 , ("tz", set phaseOverrides "preConfigure = \"export TZDIR=${pkgs.tzdata}/share/zoneinfo\";")
124− , ("udev", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Linux))) , ("bustle", set (libraryDepends . pkgconfig . contains "system-glib = pkgs.glib") True)
175+ , ("udev", over (metaSection . platforms) (Set.filter (\(Platform _ os) -> os == Linux)))
125176 , ("webkitgtk3", webkitgtk24xHook) -- https://github.com/haskell-gi/haskell-gi/issues/36
126177 , ("webkitgtk3-javascriptcore", webkitgtk24xHook) -- https://github.com/haskell-gi/haskell-gi/issues/36
127178 , ("websockets", set doCheck False) -- https://github.com/jaspervdj/websockets/issues/104
@@ -130,14 +181,18 @@ hooks =
130181 , ("wxc", wxcHook)
131182 , ("wxcore", set (libraryDepends . pkgconfig . contains (pkg "wxGTK")) True)
132183 , ("X11", over (libraryDepends . system) (Set.union (Set.fromList $ map bind ["pkgs.xorg.libXinerama","pkgs.xorg.libXext","pkgs.xorg.libXrender","pkgs.xorg.libXScrnSaver"])))
133− , ("xmonad", set phaseOverrides xmonadPostInstall)
134− , ("zip-archive < 0.3.1", over (testDepends . tool) (replace (bind "self.zip") (pkg "zip")))
184+ , ("xmonad >= 0.14.2", set phaseOverrides xmonadPostInstall)
185+ , ("zip-archive < 0.3.1", over (testDepends . tool) (replace (self "zip") (pkg "zip")))
135186 , ("zip-archive >= 0.3.1 && < 0.3.2.3", over (testDepends . tool) (Set.union (Set.fromList [pkg "zip", pkg "unzip"]))) -- https://github.com/jgm/zip-archive/issues/35
187+ , ("zip-archive >= 0.4", set (testDepends . tool . contains (pkg "which")) True)
136188 ]
137189
138190pkg :: Identifier -> Binding
139191pkg i = binding # (i, path # ["pkgs",i])
140192
193+self :: Identifier -> Binding
194+self i = binding # (i, path # ["self",i])
195+
141196pkgs :: [Identifier] -> Set Binding
142197pkgs = Set.fromList . map pkg
143198
@@ -147,10 +202,18 @@ bind s = binding # (i, path # is)
147202 is = map (review ident) (splitOn "." s)
148203 i = last is
149204
205+-- | @replace old new bset@ replaces the Nix binding @old@ with @new@ in the
206+-- set of bindings @bset@. If @old@ is not found in @bset@, then the function
207+-- fails with an 'error'.
150208replace :: Binding -> Binding -> Set Binding -> Set Binding
151−replace old new bs = if old `Set.member` bs then Set.insert new (Set.delete old bs) else bs
209+replace old new bs
210+ | old `Set.member` bs = Set.insert new (Set.delete old bs)
211+ | otherwise = error (unwords [ "post-process: cannot replace name binding"
212+ , show old, "by", show new
213+ , "because it's not found in set"
214+ , show bs
215+ ])
152216
153−-- TODO: I need to figure out how to conveniently replace a binding in a set.
154217gtk3Hook :: Derivation -> Derivation -- https://github.com/NixOS/cabal2nix/issues/145
155218gtk3Hook = set (libraryDepends . pkgconfig . contains (pkg "gtk3")) True
156219 . over (libraryDepends . pkgconfig) (Set.filter (\b -> view localName b /= "gtk3"))
@@ -167,13 +230,12 @@ gitAnnexHook = set phaseOverrides gitAnnexOverrides
167230 where
168231 gitAnnexOverrides = unlines
169232 [ "preConfigure = \"export HOME=$TEMPDIR; patchShebangs .\";"
170− , "installPhase = \"make PREFIX=$out BUILDER=: install\";"
171− , "checkPhase = ''"
233+ , "postBuild = ''"
172234 , " ln -sf dist/build/git-annex/git-annex git-annex"
173235 , " ln -sf git-annex git-annex-shell"
174− , " export PATH+=\":$PWD\""
175− , " git-annex test"
176236 , "'';"
237+ , "installPhase = \"make PREFIX=$out BUILDER=: install install-completions\";"
238+ , "checkPhase = ''PATH+=\":$PWD\" git-annex test'';"
177239 , "enableSharedExecutables = false;"
178240 ]
179241 buildInputs = pkgs ["git","rsync","gnupg","curl","wget","lsof","openssh","which","bup","perl"]
@@ -194,7 +256,7 @@ gfPhaseOverrides = unlines
194256 , " sed -i \"s|numJobs (bf bi)++||\" ./Setup.hs"
195257 -- Parallel compilation fails. Disable it.
196258 , "'';"
197− , "preBuild = ''export LD_LIBRARY_PATH=`pwd`/dist/build:$LD_LIBRARY_PATH'';"
259+ , "preBuild = ''export LD_LIBRARY_PATH=`pwd`/dist/build''${LD_LIBRARY_PATH:+:}$LD_LIBRARY_PATH'';"
198260 -- The build step itself, after having built the library, needs to be able
199261 -- to find the library it just built in order to compile grammar files.
200262 ]
@@ -230,10 +292,8 @@ darcsInstallPostInstall = unlines
230292xmonadPostInstall :: String
231293xmonadPostInstall = unlines
232294 [ "postInstall = ''"
233− , " shopt -s globstar"
234− , " mkdir -p $doc/share/man/man1"
235− , " mv \"$data/\"**\"/man/\"*[0-9] $doc/share/man/man1/"
236− , " rm \"$data/\"**\"/man/\"*"
295+ , " install -D man/xmonad.1 ''${!outputDoc}/share/man/man1/xmonad.1"
296+ , " install -D man/xmonad.hs ''${!outputDoc}/share/doc/$name/sample-xmonad.hs"
237297 , "'';"
238298 ]
239299
@@ -300,8 +360,50 @@ webkitgtk24xHook = set (libraryDepends . pkgconfig . contains (pkg "webkitgtk24x
300360opencvOverrides :: Derivation -> Derivation
301361opencvOverrides = set phaseOverrides "hardeningDisable = [ \"bindnow\" ];"
302362 . over (libraryDepends . pkgconfig) (replace (pkg "opencv") (pkg "opencv3"))
303− . set (configureFlags . contains "--with-gcc=${stdenv.cc}/bin/c++") True
304− . set (configureFlags . contains "--with-ld=${stdenv.cc}/bin/c++") True
305363
306364hspecCoreOverrides :: Derivation -> Derivation -- https://github.com/hspec/hspec/issues/330
307365hspecCoreOverrides = set phaseOverrides "testTarget = \"--test-option=--skip --test-option='Test.Hspec.Core.Runner.hspecResult runs specs in parallel'\";"
366+
367+cabal2nixOverrides :: Derivation -> Derivation
368+cabal2nixOverrides = set phaseOverrides $ unlines
369+ [ "preCheck = ''"
370+ , " export PATH=\"$PWD/dist/build/cabal2nix:$PATH\""
371+ , " export HOME=\"$TMPDIR/home\""
372+ , "'';"
373+ ]
374+
375+gtkglextHook :: Derivation -> Derivation
376+gtkglextHook = over (libraryDepends . system) (Set.union (Set.fromList deps))
377+ where
378+ deps :: [Binding]
379+ deps = bind <$> [ "pkgs.gtk2"
380+ , "pkgs.libGLU"
381+ , "pkgs.xorg.libSM"
382+ , "pkgs.xorg.libICE"
383+ , "pkgs.xorg.libXt"
384+ , "pkgs.xorg.libXmu"
385+ ]
386+
387+pandocPre26Overrides :: Derivation -> Derivation
388+pandocPre26Overrides = set phaseOverrides postInstall
389+ where
390+ postInstall = unlines [ "postInstall = ''"
391+ , " mkdir -p $out/share"
392+ , " mv $data/*/*/man $out/share/"
393+ , "'';"
394+ ]
395+
396+pandocOverrides :: Derivation -> Derivation
397+pandocOverrides = set phaseOverrides postInstall
398+ where
399+ postInstall = unlines [ "postInstall = ''"
400+ , " mkdir -p $out/share/man/man1"
401+ , " mv \"man/\"*.1 $out/share/man/man1/"
402+ , "'';"
403+ ]
404+
405+bustleOverrides :: Derivation -> Derivation
406+bustleOverrides = set (libraryDepends . pkgconfig . contains "system-glib = pkgs.glib") True
407+ . set (executableDepends . pkgconfig . contains "gio-unix = null") False
408+ . set (metaSection . license) (Known "stdenv.lib.licenses.lgpl21Plus")
409+ . set (metaSection . hydraPlatforms) allKnownPlatforms