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

{
  lib,
  stdenv,
  replaceVars,
  fetchurl,
  pkg-config,
  gettext,
  docbook-xsl-nons,
  docbook_xml_dtd_43,
  gtk-doc,
  meson,
  mesonEmulatorHook,
  ninja,
  python3,
  makeWrapper,
  shared-mime-info,
  isocodes,
  expat,
  glib,
  cairo,
  pango,
  gdk-pixbuf,
  atk,
  at-spi2-atk,
  gobject-introspection,
  buildPackages,
  withIntrospection ?
    lib.meta.availableOn stdenv.hostPlatform gobject-introspection
    && stdenv.hostPlatform.emulatorAvailable buildPackages,
  compileSchemas ? stdenv.hostPlatform.emulatorAvailable buildPackages,
  fribidi,
  xorg,
  libepoxy,
  libxkbcommon,
  libxml2,
  gnome,
  gsettings-desktop-schemas,
  sassc,
  trackerSupport ? stdenv.hostPlatform.isLinux && (stdenv.buildPlatform == stdenv.hostPlatform),
  tinysparql,
  x11Support ? stdenv.hostPlatform.isLinux,
  waylandSupport ? stdenv.hostPlatform.isLinux,
  libGL,
  wayland,
  wayland-protocols,
  xineramaSupport ? stdenv.hostPlatform.isLinux,
  cupsSupport ? stdenv.hostPlatform.isLinux,
  cups,
  broadwaySupport ? true,
  wayland-scanner,
  testers,
}:

let

  gtkCleanImmodulesCache = replaceVars ./hooks/clean-immodules-cache.sh {
    gtk_module_path = "gtk-3.0";
    gtk_binary_version = "3.0.0";
  };

in

stdenv.mkDerivation (finalAttrs: {
  pname = "gtk+3";
  version = "3.24.49";

  outputs = [
    "out"
    "dev"
  ]
  ++ lib.optional withIntrospection "devdoc";
  outputBin = "dev";

  setupHooks = [
    ./hooks/drop-icon-theme-cache.sh
    gtkCleanImmodulesCache
  ];

  src =
    let
      inherit (finalAttrs) version;
    in
    fetchurl {
      url = "mirror://gnome/sources/gtk/${lib.versions.majorMinor version}/gtk-${version}.tar.xz";
      hash = "sha256-XqUsaijw5ezy6aPC+suzDQQLc4cfzV8zzRMX6QGKFG4=";
    };

  patches = [
    ./patches/3.0-immodules.cache.patch
    ./patches/3.0-Xft-setting-fallback-compute-DPI-properly.patch
  ]
  ++ lib.optionals stdenv.hostPlatform.isDarwin [
    # X11 module requires <gio/gdesktopappinfo.h> which is not installed on Darwin
    # let’s drop that dependency in similar way to how other parts of the library do it
    # e.g. https://gitlab.gnome.org/GNOME/gtk/blob/3.24.4/gtk/gtk-launch.c#L31-33
    # https://gitlab.gnome.org/GNOME/gtk/merge_requests/536
    ./patches/3.0-darwin-x11.patch
  ];

  depsBuildBuild = [
    pkg-config
  ];
  nativeBuildInputs = [
    gettext
    makeWrapper
    meson
    ninja
    pkg-config
    python3
    sassc
    gdk-pixbuf
  ]
  ++ finalAttrs.setupHooks
  ++ lib.optionals withIntrospection [
    gobject-introspection
    docbook_xml_dtd_43
    docbook-xsl-nons
    gtk-doc
    # For xmllint
    libxml2
  ]
  ++
    lib.optionals
      ((withIntrospection || compileSchemas) && !stdenv.buildPlatform.canExecute stdenv.hostPlatform)
      [
        mesonEmulatorHook
      ]
  ++ lib.optionals waylandSupport [
    wayland-scanner
  ];

  buildInputs =
    lib.optionals (x11Support || waylandSupport) [
      # TODO: Reorder me on `staging`.
      libxkbcommon
    ]
    ++ [
      (libepoxy.override { inherit x11Support; })
    ]
    ++ lib.optionals (x11Support || waylandSupport) [
      isocodes
    ]
    ++ lib.optionals trackerSupport [
      tinysparql
    ];
  #TODO: colord?

  propagatedBuildInputs = [
    at-spi2-atk
    atk
    cairo
    expat
    fribidi
    gdk-pixbuf
    glib
    gsettings-desktop-schemas
  ]
  ++ lib.optionals x11Support (
    with xorg;
    [
      libICE
      libSM
      libXcomposite
      libXcursor
      libXdamage
      libXfixes
      libXi
      libXrandr
      libXrender
    ]
  )
  ++ [
    # TODO: Reorder me on `staging`.
    pango
  ]
  ++ lib.optionals waylandSupport [
    libGL
    wayland
    wayland-protocols
  ]
  ++ lib.optionals xineramaSupport [
    xorg.libXinerama
  ]
  ++ lib.optionals cupsSupport [
    cups
  ];

  mesonFlags = [
    "-Dgtk_doc=${lib.boolToString withIntrospection}"
    "-Dtests=false"
    "-Dtracker3=${lib.boolToString trackerSupport}"
    "-Dbroadway_backend=${lib.boolToString broadwaySupport}"
    "-Dx11_backend=${lib.boolToString x11Support}"
    "-Dquartz_backend=${lib.boolToString (stdenv.hostPlatform.isDarwin && !x11Support)}"
    "-Dintrospection=${lib.boolToString withIntrospection}"
  ];

  doCheck = false; # needs X11

  separateDebugInfo = stdenv.hostPlatform.isLinux;

  # These are the defines that'd you'd get with --enable-debug=minimum (default).
  # See: https://developer.gnome.org/gtk3/stable/gtk-building.html#extra-configuration-options
  env.NIX_CFLAGS_COMPILE = "-DG_ENABLE_DEBUG -DG_DISABLE_CAST_CHECKS";

  postPatch = ''
    # See https://github.com/NixOS/nixpkgs/issues/132259
    substituteInPlace meson.build \
      --replace "x11_enabled = false" ""

    # this conditional gates the installation of share/gsettings-schemas/.../glib-2.0/schemas/gschemas.compiled.
    substituteInPlace meson.build \
      --replace 'if not meson.is_cross_build()' 'if ${lib.boolToString compileSchemas}'

    files=(
      build-aux/meson/post-install.py
      demos/gtk-demo/geninclude.py
      gdk/broadway/gen-c-array.py
      gdk/gen-gdk-gresources-xml.py
      gtk/cursor/dnd-copy.png
      gtk/gen-gtk-gresources-xml.py
      gtk/gen-rc.py
      gtk/gentypefuncs.py
    )

    chmod +x ''${files[@]}
    patchShebangs ''${files[@]}
  '';

  postInstall =
    lib.optionalString (!stdenv.hostPlatform.isDarwin) ''
      # The updater is needed for nixos env and it's tiny.
      moveToOutput bin/gtk-update-icon-cache "$out"
      # Launcher
      moveToOutput bin/gtk-launch "$out"
      # Broadway daemon
      moveToOutput bin/broadwayd "$out"

      # TODO: patch glib directly
      for f in $dev/bin/gtk-encode-symbolic-svg; do
        wrapProgram $f --prefix XDG_DATA_DIRS : "${shared-mime-info}/share"
      done
    ''
    + lib.optionalString (stdenv.buildPlatform == stdenv.hostPlatform) ''
      GTK_PATH="''${out:?}/lib/gtk-3.0/3.0.0/immodules/" ''${dev:?}/bin/gtk-query-immodules-3.0 > "''${out:?}/lib/gtk-3.0/3.0.0/immodules.cache"
    '';

  # Wrap demos
  postFixup =
    lib.optionalString (!stdenv.hostPlatform.isDarwin) ''
      demos=(gtk3-demo gtk3-demo-application gtk3-icon-browser gtk3-widget-factory)

      for program in ''${demos[@]}; do
        wrapProgram $dev/bin/$program \
          --prefix XDG_DATA_DIRS : "$GSETTINGS_SCHEMAS_PATH:$out/share/gsettings-schemas/${finalAttrs.pname}-${finalAttrs.version}"
      done
    ''
    + lib.optionalString stdenv.hostPlatform.isDarwin ''
      # a comment created a cycle between outputs
      sed '/^# ModulesPath =/d' -i "$out"/lib/gtk-*/*/immodules.cache
    '';

  passthru = {
    updateScript = gnome.updateScript {
      packageName = "gtk";
      attrPath = "gtk3";
      freeze = true;
    };
    tests.pkg-config = testers.testMetaPkgConfig finalAttrs.finalPackage;
  };

  meta = with lib; {
    description = "Multi-platform toolkit for creating graphical user interfaces";
    longDescription = ''
      GTK is a highly usable, feature rich toolkit for creating
      graphical user interfaces which boasts cross platform
      compatibility and an easy to use API.  GTK it is written in C,
      but has bindings to many other popular programming languages
      such as C++, Python and C# among others.  GTK is licensed
      under the GNU LGPL 2.1 allowing development of both free and
      proprietary software with GTK without any license fees or
      royalties.
    '';
    homepage = "https://www.gtk.org/";
    license = licenses.lgpl2Plus;
    maintainers = with maintainers; [ raskin ];
    teams = [ teams.gnome ];
    pkgConfigModules = [
      "gdk-3.0"
      "gtk+-3.0"
    ]
    ++ lib.optionals x11Support [
      "gdk-x11-3.0"
      "gtk+-x11-3.0"
    ];
    platforms = platforms.all;
    changelog = "https://gitlab.gnome.org/GNOME/gtk/-/raw/${finalAttrs.version}/NEWS";
  };
})