nixpkgs/pkgs/development/compilers/flutter/wrapper.nix

{ lib
, stdenv
, darwin
, callPackage
, flutter
, supportsLinuxDesktop ? stdenv.hostPlatform.isLinux
, supportsAndroid ? (stdenv.hostPlatform.isx86_64 || stdenv.hostPlatform.isDarwin)
, supportsDarwin ? stdenv.hostPlatform.isDarwin
, supportsIOS ? stdenv.hostPlatform.isDarwin
, includedEngineArtifacts ? {
    common = [
      "flutter_patched_sdk"
      "flutter_patched_sdk_product"
    ];
    platform = {
      android = lib.optionalAttrs supportsAndroid
        ((lib.genAttrs [ "arm" "arm64" "x64" ] (architecture: [ "profile" "release" ])) // { x86 = [ "jit-release" ]; });
      darwin = lib.optionalAttrs supportsDarwin
        ((lib.genAttrs [ "arm64" "x64" ] (architecture: [ "profile" "release" ])));
      ios = lib.optionalAttrs supportsIOS
        ((lib.genAttrs [ "" ] (architecture: [ "profile" "release" ])));
      linux = lib.optionalAttrs supportsLinuxDesktop
        (lib.genAttrs ((lib.optional stdenv.hostPlatform.isx86_64 "x64") ++ (lib.optional stdenv.hostPlatform.isAarch64 "arm64"))
          (architecture: [ "debug" "profile" "release" ]));
    };
  }
, extraPkgConfigPackages ? [ ]
, extraLibraries ? [ ]
, extraIncludes ? [ ]
, extraCxxFlags ? [ ]
, extraCFlags ? [ ]
, extraLinkerFlags ? [ ]
, makeWrapper
, runCommandLocal
, writeShellScript
, wrapGAppsHook
, git
, which
, pkg-config
, atk
, cairo
, gdk-pixbuf
, glib
, gtk3
, harfbuzz
, libepoxy
, pango
, libX11
, xorgproto
, libdeflate
, zlib
, cmake
, ninja
, clang
, lndir
, symlinkJoin
}:

let
  engineArtifacts = callPackage ./engine-artifacts {
    inherit (flutter) engineVersion;
    flutterVersion = flutter.version;
  };
  mkCommonArtifactLinkCommand = { artifact }:
    ''
      mkdir -p $out/artifacts/engine/common
      lndir -silent ${artifact} $out/artifacts/engine/common
    '';
  mkPlatformArtifactLinkCommand = { artifact, os, architecture, variant ? null }:
    let
      artifactDirectory = "${os}-${architecture}${lib.optionalString (variant != null) "-${variant}"}";
    in
    ''
      mkdir -p $out/artifacts/engine/${artifactDirectory}
      lndir -silent ${artifact} $out/artifacts/engine/${artifactDirectory}
    '';
  engineArtifactDirectory =
    runCommandLocal "flutter-engine-artifacts-${flutter.version}" { nativeBuildInputs = [ lndir ]; }
      (
        builtins.concatStringsSep "\n"
          ((map
            (name: mkCommonArtifactLinkCommand {
              artifact = engineArtifacts.common.${name};
            })
            (includedEngineArtifacts.common or [ ])) ++
          (builtins.foldl'
            (commands: os: commands ++
              (builtins.foldl'
                (commands: architecture: commands ++
                  (builtins.foldl'
                    (commands: variant: commands ++
                      (map
                        (artifact: mkPlatformArtifactLinkCommand {
                          inherit artifact os architecture variant;
                        })
                        engineArtifacts.platform.${os}.${architecture}.variants.${variant}))
                    (map
                      (artifact: mkPlatformArtifactLinkCommand {
                        inherit artifact os architecture;
                      })
                      engineArtifacts.platform.${os}.${architecture}.base)
                    includedEngineArtifacts.platform.${os}.${architecture}))
                [ ]
                (builtins.attrNames includedEngineArtifacts.platform.${os})))
            [ ]
            (builtins.attrNames (includedEngineArtifacts.platform or { }))))
      );

  cacheDir = symlinkJoin {
    name = "flutter-cache-dir";
    paths = [
      engineArtifactDirectory
      "${flutter}/bin/cache"
    ];
  };

  # By default, Flutter stores downloaded files (such as the Pub cache) in the SDK directory.
  # Wrap it to ensure that it does not do that, preferring home directories instead.
  # The sh file `$out/bin/internal/shared.sh` runs when launching Flutter and calls `"$FLUTTER_ROOT/bin/cache/` instead of our environment variable `FLUTTER_CACHE_DIR`.
  # We do not patch it since the script doesn't require engine artifacts(which are the only thing not added by the unwrapped derivation), so it shouldn't fail, and patching it will just be harder to maintain.
  immutableFlutter = writeShellScript "flutter_immutable" ''
    export PUB_CACHE=''${PUB_CACHE:-"$HOME/.pub-cache"}
    export FLUTTER_CACHE_DIR=${cacheDir}
    ${flutter}/bin/flutter "$@"
  '';

  # Tools that the Flutter tool depends on.
  tools = [ git which ];

  # Libraries that Flutter apps depend on at runtime.
  appRuntimeDeps = lib.optionals supportsLinuxDesktop [
    atk
    cairo
    gdk-pixbuf
    glib
    gtk3
    harfbuzz
    libepoxy
    pango
    libX11
    libdeflate
  ];

  # Development packages required for compilation.
  appBuildDeps =
    let
      # https://discourse.nixos.org/t/handling-transitive-c-dependencies/5942/3
      deps = pkg: builtins.filter lib.isDerivation ((pkg.buildInputs or [ ]) ++ (pkg.propagatedBuildInputs or [ ]));
      collect = pkg: lib.unique ([ pkg ] ++ deps pkg ++ builtins.concatMap collect (deps pkg));
    in
    builtins.concatMap collect appRuntimeDeps;

  # Some header files and libraries are not properly located by the Flutter SDK.
  # They must be manually included.
  appStaticBuildDeps = (lib.optionals supportsLinuxDesktop [ libX11 xorgproto zlib ]) ++ extraLibraries;

  # Tools used by the Flutter SDK to compile applications.
  buildTools = lib.optionals supportsLinuxDesktop [
    pkg-config
    cmake
    ninja
    clang
  ];

  # Nix-specific compiler configuration.
  pkgConfigPackages = map (lib.getOutput "dev") (appBuildDeps ++ extraPkgConfigPackages);
  includeFlags = map (pkg: "-isystem ${lib.getOutput "dev" pkg}/include") (appStaticBuildDeps ++ extraIncludes);
  linkerFlags = (map (pkg: "-rpath,${lib.getOutput "lib" pkg}/lib") appRuntimeDeps) ++ extraLinkerFlags;
in
(callPackage ./sdk-symlink.nix { }) (stdenv.mkDerivation
{
  pname = "flutter-wrapped";
  inherit (flutter) version;

  nativeBuildInputs = [ makeWrapper ]
    ++ lib.optionals stdenv.hostPlatform.isDarwin [ darwin.DarwinTools ]
    ++ lib.optionals supportsLinuxDesktop [ glib wrapGAppsHook ];

  passthru = flutter.passthru // {
    unwrapped = flutter;
    inherit engineArtifacts;
  };

  dontUnpack = true;
  dontWrapGApps = true;

  installPhase = ''
    runHook preInstall

    for path in ${builtins.concatStringsSep " " (builtins.foldl' (paths: pkg: paths ++ (map (directory: "'${pkg}/${directory}/pkgconfig'") ["lib" "share"])) [ ] pkgConfigPackages)}; do
      addToSearchPath FLUTTER_PKG_CONFIG_PATH "$path"
    done

    mkdir -p $out/bin
    makeWrapper '${immutableFlutter}' $out/bin/flutter \
      --set-default ANDROID_EMULATOR_USE_SYSTEM_LIBS 1 \
      --suffix PATH : '${lib.makeBinPath (tools ++ buildTools)}' \
      --suffix PKG_CONFIG_PATH : "$FLUTTER_PKG_CONFIG_PATH" \
      --suffix LIBRARY_PATH : '${lib.makeLibraryPath appStaticBuildDeps}' \
      --prefix CXXFLAGS "''\t" '${builtins.concatStringsSep " " (includeFlags ++ extraCxxFlags)}' \
      --prefix CFLAGS "''\t" '${builtins.concatStringsSep " " (includeFlags ++ extraCFlags)}' \
      --prefix LDFLAGS "''\t" '${builtins.concatStringsSep " " (map (flag: "-Wl,${flag}") linkerFlags)}' \
      ''${gappsWrapperArgs[@]}

    runHook postInstall
  '';

  inherit (flutter) meta;
})