[RFC] Declarative wrappers

pkgs/applications/audio/picard/default.nix

@@ -21,7 +21,15 @@ in pythonPackages.buildPythonApplication rec {
     sha256 = "0xalg4dvaqb396h4s6gzxnplgv1lcvsczmmrlhyrj0kfj10amhsj";
   };
 
-  nativeBuildInputs = [ gettext qt5.wrapQtAppsHook qt5.qtbase ]
+  nativeBuildInputs = [ gettext qt5.wrapQtAppsHook ];
+
+  propagatedBuildInputs = with pythonPackages; [
+    qt5.qtbase
+    pyqt5
+    mutagen
+    chromaprint
+    discid
+  ]
     ++ stdenv.lib.optionals (pyqt5.multimediaEnabled) [
       qt5.qtmultimedia.bin
       gst_all_1.gstreamer
@@ -32,13 +40,6 @@ in pythonPackages.buildPythonApplication rec {
     ]
   ;
 
-  propagatedBuildInputs = with pythonPackages; [
-    pyqt5
-    mutagen
-    chromaprint
-    discid
-  ];
-
   prePatch = ''
     # Pesky unicode punctuation.
     substituteInPlace setup.cfg --replace "‘" "'"

pkgs/build-support/neowrap.nix

@@ -0,0 +1,129 @@
+{ lib
+, symlinkJoin
+, makeWrapper
+, extraPkgsByOverride ? []
+}:
+
+pkgList:
+
+let
+  wrapper = {
+    extraPkgs ? [],
+    extraMakeWrapperArgs ? ""
+  }:
+  let
+    # Where we keep general knowledge about known to be used environmental variables
+    encyclopedia = {
+      # Here we write the separator string between values of every env var, the
+      # default is ":"
+      separators = {
+        # XDG_DATA_DIRS = ":";
+      };
+      # If we want the wrapping to also include an environmental variable in
+      # out, we list here for every env var what path to add to the wrapper's
+      # args.  You can put a list as a value as well.
+      wrapOut = {
+        XDG_DATA_DIRS = "$out/share";
+      };
+    };
+    # recursive function that goes deep through the dependency graph of a given
+    # list of packages and creates a list of all buildInputs they all depend
+    # on. The 2nd argument pkgsFound is used internally and it's expected to be
+    # [] at the first call.
+    getAllInputs = 
+      pkgs:
+      pkgsFound:
+      map (
+        pkg:
+        if (builtins.typeOf pkg) == "set" then
+          if builtins.hasAttr "buildInputs" pkg || builtins.hasAttr "propagatedBuildInputs" pkg then
+            # builtins.trace "pkg is of type ${builtins.typeOf pkg} and it's ${builtins.toJSON pkg}, with inputs: ${builtins.toJSON (pkg.buildInputs ++ pkg.propagatedBuildInputs)}" (getAllInputs (pkg.buildInputs ++ pkg.propagatedBuildInputs) (pkgsFound ++ [ pkg ]))
+            (getAllInputs (pkg.buildInputs ++ pkg.propagatedBuildInputs) (pkgsFound ++ [ pkg ]))
+          else
+            pkgsFound ++ [ pkg ]
+        else
+          # builtins.trace "pkg is not a set but a ${builtins.typeOf pkg} at ${builtins.toJSON pkg}, current pkgsFound is ${builtins.toJSON pkgsFound}" pkgsFound
+          pkgsFound
+      ) pkgs;
+    allPkgs = (lib.lists.flatten pkgList) ++ extraPkgsByOverride ++ extraPkgs;
+    allInputs = lib.lists.unique (lib.lists.flatten (getAllInputs allPkgs []));
+    allInputs_ = builtins.trace "${builtins.toJSON allInputs}" allInputs;
+    # filter out of all the inputs the packages with the propagateEnv attribute
+    envPkgs = builtins.filter (
+      pkg:
+      (builtins.hasAttr "propagateEnv" pkg)
+    ) allInputs;
+    # Given a package, it's outputs and an envStr such as found in the values
+    # of passthru's `propagateEnv`, it replaces all occurences of %<outname>%
+    # from envStr according to the pkg.outputs
+    replaceAllOutputs = {
+      pkg,
+      envStr,
+      outputs,
+      outname ? "out",
+    }:
+      let
+        outname = builtins.elemAt outputs 0;
+      in
+      if (builtins.length outputs) == 0 then
+        envStr
+      else
+        replaceAllOutputs {
+          inherit pkg;
+          outputs = lib.lists.subtractLists [outname] outputs;
+          envStr = builtins.replaceStrings
+            [ "%${outname}%" ]
+            [ "${pkg.${outname}}" ]
+          envStr;
+        }
+    ;
+    envInfo = map (
+      pkg:
+      (lib.attrsets.mapAttrs (
+        name:
+        value:
+        replaceAllOutputs {
+          inherit pkg;
+          outputs = pkg.outputs;
+          envStr = value;
+        }
+      ) pkg.propagateEnv)
+    ) envPkgs;
+    envInfo_ = builtins.trace "envInfo is ${(builtins.toJSON envInfo)}" envInfo;
+    envInfoFolded = lib.attrsets.foldAttrs (n: a: [n] ++ a) [] envInfo;
+    envInfoFolded_ = builtins.trace "envInfoFolded is ${(builtins.toJSON envInfoFolded)}" envInfoFolded;
+    # Where we add stuff according to encyclopedia.wrapOut
+    envInfoWithLocal = lib.attrsets.mapAttrs (
+      name:
+      values:
+      if builtins.hasAttr name encyclopedia.wrapOut then
+        values ++ (lib.lists.flatten encyclopedia.wrapOut.${name})
+      else
+        values
+    ) envInfoFolded;
+    envInfoWithLocal_ = builtins.trace "envInfoWithLocal is ${(builtins.toJSON envInfoWithLocal)}" envInfoWithLocal;
+    makeWrapperArgs = lib.attrsets.mapAttrsToList (
+      key:
+      value:
+      (let
+        # TODO: make sure this works with any separator according to encyclopedia.separators
+        sep = encyclopedia.separators.${key} or ":"; # default separator used for most wrappings
+      in
+        "--prefix ${key} ${sep} ${builtins.concatStringsSep sep value}"
+      )
+    ) envInfoWithLocal;
+    makeWrapperArgs_ = builtins.trace "makeWrapperArgs is ${(builtins.toJSON makeWrapperArgs)}" makeWrapperArgs;
+  in
+  symlinkJoin {
+    name = "runtime-env";
+    paths = pkgList;
+
+    buildInputs = [ makeWrapper ];
+    postBuild = ''
+      for i in $out/bin/*; do
+        wrapProgram "$i" ${(builtins.concatStringsSep " " makeWrapperArgs_)}
+      done
+    '';
+  };
+in
+  lib.makeOverridable wrapper

pkgs/development/libraries/atk/default.nix

@@ -38,6 +38,9 @@ stdenv.mkDerivation rec {
     updateScript = gnome3.updateScript {
       packageName = pname;
     };
+    propagateEnv = {
+      GI_TYPELIB_PATH = "%out%/lib/girepository-1.0";
+    };
   };
 
   meta = {

pkgs/development/libraries/dconf/default.nix

@@ -35,6 +35,9 @@ stdenv.mkDerivation rec {
     updateScript = gnome3.updateScript {
       packageName = pname;
     };
+    propagateEnv = {
+      GIO_EXTRA_MODULES = "%lib%/lib/gio/modules";
+    };
   };
 
   meta = with stdenv.lib; {

pkgs/development/libraries/gdk-pixbuf/default.nix

@@ -98,6 +98,10 @@ in stdenv.mkDerivation rec {
 
     # gdk_pixbuf_moduledir variable from gdk-pixbuf-2.0.pc
     moduleDir = "lib/gdk-pixbuf-2.0/2.10.0/loaders";
+    cacheFile = "lib/gdk-pixbuf-2.0/2.10.0/loaders.cache";
+    propagateEnv = {
+      GI_TYPELIB_PATH = "%out%/lib/girepository-1.0";
+    };
   };
 
   meta = with stdenv.lib; {

pkgs/development/libraries/gobject-introspection/default.nix

@@ -72,6 +72,9 @@ stdenv.mkDerivation rec {
     updateScript = gnome3.updateScript {
       packageName = pname;
     };
+    propagateEnv = {
+      GI_TYPELIB_PATH = "%out%/lib/girepository-1.0";
+    };
   };
 
   meta = with stdenv.lib; {

pkgs/development/libraries/gsettings-desktop-schemas/default.nix

@@ -16,6 +16,10 @@ stdenv.mkDerivation rec {
 
   passthru = {
     updateScript = gnome3.updateScript { packageName = "gsettings-desktop-schemas"; };
+    propagateEnv = {
+      XDG_DATA_DIRS = "%out%/share/gsettings-schemas/${pname}-${version}";
+      GI_TYPELIB_PATH = "%out%/lib/girepository-1.0";
+    };
   };
 
   # meson installs the schemas to share/glib-2.0/schemas

pkgs/development/libraries/gstreamer/bad/default.nix

@@ -278,6 +278,12 @@ in stdenv.mkDerivation rec {
   # that trip up clang with format security enabled.
   hardeningDisable = [ "format" ];
 
+  passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
+  };
+
   doCheck = false; # fails 20 out of 58 tests, expensive
 
   meta = with stdenv.lib; {

pkgs/development/libraries/gstreamer/base/default.nix

@@ -135,6 +135,9 @@ stdenv.mkDerivation rec {
   doCheck = false; # fails, wants DRI access for OpenGL
 
   passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
     # Downstream `gst-*` packages depending on `gst-plugins-base`
     # have meson build options like 'gl' etc. that depend
     # on these features being built in `-base`.

pkgs/development/libraries/gstreamer/core/default.nix

@@ -100,6 +100,12 @@ stdenv.mkDerivation rec {
     moveToOutput "share/bash-completion" "$dev"
   '';
 
+  passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
+  };
+
   setupHook = ./setup-hook.sh;
 
   meta = with lib ;{

pkgs/development/libraries/gstreamer/ges/default.nix

@@ -55,6 +55,12 @@ stdenv.mkDerivation rec {
     sed -i -r -e 's/p(bad|good) = .*/p\1 = pbase/' tests/check/meson.build
   '';
 
+  passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
+  };
+
   meta = with stdenv.lib; {
     description = "Library for creation of audio/video non-linear editors";
     homepage = "https://gstreamer.freedesktop.org";

pkgs/development/libraries/gstreamer/good/default.nix

@@ -136,6 +136,12 @@ stdenv.mkDerivation rec {
   # fails 1 tests with "Unexpected critical/warning: g_object_set_is_valid_property: object class 'GstRtpStorage' has no property named ''"
   doCheck = false;
 
+  passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
+  };
+
   meta = with stdenv.lib; {
     description = "GStreamer Good Plugins";
     homepage = "https://gstreamer.freedesktop.org";

pkgs/development/libraries/gstreamer/libav/default.nix

@@ -37,6 +37,12 @@ stdenv.mkDerivation rec {
     libav
   ];
 
+  passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
+  };
+
   meta = with lib; {
     description = "FFmpeg/libav plugin for GStreamer";
     homepage = "https://gstreamer.freedesktop.org";

pkgs/development/libraries/gstreamer/ugly/default.nix

@@ -55,6 +55,12 @@ stdenv.mkDerivation rec {
     DiskArbitration
   ]);
 
+  passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
+  };
+
   mesonFlags = [
     "-Dexamples=disabled" # requires many dependencies and probably not useful for our users
     "-Dsidplay=disabled" # sidplay / sidplay/player.h isn't packaged in nixpkgs as of writing

pkgs/development/libraries/gstreamer/vaapi/default.nix

@@ -62,6 +62,12 @@ stdenv.mkDerivation rec {
     "-Dexamples=disabled" # requires many dependencies and probably not useful for our users
   ];
 
+  passthru = {
+    propagateEnv = {
+      GST_PLUGIN_SYSTEM_PATH_1_0 = "%out%/lib/gstreamer-1.0";
+    };
+  };
+
   meta = with stdenv.lib; {
     description = "Set of VAAPI GStreamer Plug-ins";
     homepage = "https://gstreamer.freedesktop.org";

pkgs/development/libraries/gtk/3.x.nix

@@ -189,6 +189,10 @@ stdenv.mkDerivation rec {
       packageName = "gtk+";
       attrPath = "gtk3";
     };
+    propagateEnv = {
+      XDG_DATA_DIRS = "%out%/share/gsettings-schemas/${pname}-${version}";
+      GI_TYPELIB_PATH = "%out%/lib/girepository-1.0";
+    };
   };
 
   meta = {

pkgs/development/libraries/gvfs/default.nix

@@ -120,6 +120,9 @@ stdenv.mkDerivation rec {
     updateScript = gnome3.updateScript {
       packageName = pname;
     };
+    propagateEnv = {
+      GIO_EXTRA_MODULES = "%out%/lib/gio/modules"
+    };
   };
 
   meta = with stdenv.lib; {

pkgs/development/libraries/librsvg/default.nix

@@ -76,6 +76,10 @@ stdenv.mkDerivation rec {
     updateScript = gnome3.updateScript {
       packageName = pname;
     };
+    propagateEnv = {
+      GDK_PIXBUF_MODULE_FILE = "%out%/${gdk-pixbuf.cacheFile}";
+      GI_TYPELIB_PATH = "%out%/lib/girepository-1.0";
+    };
   };
 
   meta = with stdenv.lib; {

pkgs/development/libraries/pango/default.nix

@@ -54,6 +54,9 @@ in stdenv.mkDerivation rec {
     updateScript = gnome3.updateScript {
       packageName = pname;
     };
+    propagateEnv = {
+      GI_TYPELIB_PATH = "%out%/lib/girepository-1.0";
+    };
   };
 
   meta = with stdenv.lib; {

pkgs/development/libraries/qt-5/modules/qtbase.nix

@@ -35,7 +35,7 @@ let
     if compareVersion "5.12.4" < 0 then ".qmake.cache" else ".qmake.stash";
 in
 
-stdenv.mkDerivation {
+stdenv.mkDerivation rec {
 
   name = "qtbase-${version}";
   inherit qtCompatVersion src version;
@@ -161,6 +161,12 @@ stdenv.mkDerivation {
   qtPluginPrefix = "lib/qt-${qtCompatVersion}/plugins";
   qtQmlPrefix = "lib/qt-${qtCompatVersion}/qml";
   qtDocPrefix = "share/doc/qt-${qtCompatVersion}";
+  passthru = {
+    propagateEnv = {
+      QT_PLUGIN_PATH = "%bin%/${qtPluginPrefix}";
+      # QML2_IMPORT_PATH = "%bin%/${qtQmlPrefix}";
+    };
+  };
 
   setOutputFlags = false;
   preConfigure = ''

pkgs/development/libraries/qt-5/modules/qtcharts.nix

@@ -4,4 +4,10 @@ qtModule {
   name = "qtcharts";
   qtInputs = [ qtbase qtdeclarative ];
   outputs = [ "out" "dev" "bin" ];
+  passthru = {
+    propagateEnv = {
+      QT_PLUGIN_PATH = "%bin%/${qtbase.qtPluginPrefix}";
+      QML2_IMPORT_PATH = "%bin%/${qtbase.qtQmlPrefix}";
+    };
+  };
 }

pkgs/development/libraries/qt-5/modules/qtdeclarative.nix

@@ -23,4 +23,10 @@ qtModule {
     "bin/qmlscene"
     "bin/qmltestrunner"
   ];
+  passthru = {
+    propagateEnv = {
+      QT_PLUGIN_PATH = "%bin%/${qtbase.qtPluginPrefix}";
+      QML2_IMPORT_PATH = "%bin%/${qtbase.qtQmlPrefix}";
+    };
+  };
 }