pkgs/gecko/default.nix

{ geckoSrc ? null, lib
, stdenv, fetchFromGitHub, pythonFull, which, autoconf213, m4
, perl, unzip, zip, gnumake, yasm, pkgconfig, xlibs, gnome2, pango, freetype, fontconfig, cairo
, dbus, dbus_glib, alsaLib, libpulseaudio
, gtk3, glib, gobjectIntrospection, gdk_pixbuf, atk, gtk2
, git, mercurial, openssl, cmake, procps
, libnotify
, valgrind, gdb, rr
, inotify-tools
, setuptools
, rust # rust & cargo bundled. (otheriwse use pkgs.rust.{rustc,cargo})
, buildFHSUserEnv # Build a FHS environment with all Gecko dependencies.
, llvm, llvmPackages, nasm
, ccache

, zlib, xorg
, rust-cbindgen
, nodejs
, jsdoc
, fzf # needed by "mack try fuzzy"
}:

let

  inherit (lib) updateFromGitHub importJSON optionals inNixShell;

  gcc = if stdenv.cc.isGNU then stdenv.cc.cc else stdenv.cc.cc.stdenv.cc.cc;

  # Gecko sources are huge, we do not want to import them in the nix-store when
  # we use this expression for making a build environment.
  src =
    if inNixShell then
      null
    else if geckoSrc == null then
      fetchFromGitHub (importJSON ./source.json)
    else
      geckoSrc;

  version = "HEAD"; # XXX: builtins.readFile "${src}/browser/config/version.txt";

  buildInputs = [

    # Expected by "mach"
    pythonFull setuptools which autoconf213 m4

    # Expected by the configure script
    perl unzip zip gnumake yasm pkgconfig

    xlibs.libICE xlibs.libSM xlibs.libX11 xlibs.libXau xlibs.libxcb
    xlibs.libXdmcp xlibs.libXext xlibs.libXt xlibs.libXtst
    xlibs.libXcomposite
    xlibs.libXfixes
    xlibs.libXdamage xlibs.libXrender
    ] ++ (if xlibs ? xproto then [
    xlibs.damageproto xlibs.printproto xlibs.kbproto
    xlibs.renderproto xlibs.xextproto xlibs.xproto
    xlibs.compositeproto xlibs.fixesproto
    ] else [
    xorg.xorgproto
    ]) ++ [
    gnome2.libart_lgpl gnome2.libbonobo gnome2.libbonoboui
    gnome2.libgnome gnome2.libgnomecanvas gnome2.libgnomeui
    gnome2.libIDL

    pango freetype fontconfig cairo

    dbus dbus_glib

    alsaLib libpulseaudio

    gtk3 glib gobjectIntrospection gdk_pixbuf atk
    gtk2 gnome2.GConf

    rust

    # For building bindgen
    # Building bindgen is now done with the extra options added by genMozConfig
    # shellHook, do not include clang directly in order to avoid messing up with
    # the choices of the compilers.

    # clang
    llvm

    # mach mochitest
    procps

    # "mach vendor rust" wants to list modified files by using the vcs.
    git mercurial

    # needed for compiling cargo-vendor and its dependencies
    openssl cmake

    # Useful for getting notification at the end of the build.
    libnotify

    # cbindgen is used to generate C bindings for WebRender.
    rust-cbindgen

    # nasm is used to build libdav1d.
    nasm

    # NodeJS is used for tooling around JS development.
    nodejs

    # Used for building documentation.
    # jsdoc

  ] ++ optionals inNixShell [
    valgrind gdb ccache
    (if stdenv.isAarch64 then null else rr)
    fzf # needed by "mach try fuzzy"
    inotify-tools # Workaround download of prebuilt binaries.
  ];

  # bindgen.configure now has a rule to check that with-libclang-path matches CC
  # or CXX. Default to the stdenv compiler if we are compiling with clang.
  clang_path =
    if stdenv.cc.isGNU then "${llvmPackages.clang}/bin/clang"
    else "${stdenv.cc}/bin/cc";
  libclang_path =
    if stdenv.cc.isGNU then "${llvmPackages.clang.cc.lib}/lib"
    else "${stdenv.cc.cc.lib}/lib";

  genMozConfig = ''
    cxxLib=$( echo -n ${gcc}/include/c++/* )
    archLib=$cxxLib/$( ${gcc}/bin/gcc -dumpmachine )

    cat - > $MOZCONFIG <<EOF
    ac_add_options --disable-bootstrap
    #ac_add_options --without-wasm-sandboxed-libraries # this may be needed
    mk_add_options AUTOCONF=${autoconf213}/bin/autoconf
    ac_add_options --with-libclang-path=${libclang_path}
    ac_add_options --with-clang-path=${clang_path}
    export BINDGEN_CFLAGS="-cxx-isystem $cxxLib -isystem $archLib"
    export CC="${stdenv.cc}/bin/cc"
    export CXX="${stdenv.cc}/bin/c++"
    EOF
  '';

  shellHook = ''
    export MOZCONFIG=$PWD/.mozconfig.nix-shell
    export MOZBUILD_STATE_PATH=$PWD/.mozbuild
    export CC="${stdenv.cc}/bin/cc";
    export CXX="${stdenv.cc}/bin/c++";
    # To be used when building the JS Shell.
    export NIX_EXTRA_CONFIGURE_ARGS="--with-libclang-path=${libclang_path} --with-clang-path=${clang_path}"
    cxxLib=$( echo -n ${gcc}/include/c++/* )
    archLib=$cxxLib/$( ${gcc}/bin/gcc -dumpmachine )
    export BINDGEN_CFLAGS="-cxx-isystem $cxxLib -isystem $archLib"
    ${genMozConfig}
    ${builtins.getEnv "NIX_SHELL_HOOK"}
    unset AS
  '';

  # propagatedBuildInput should already have applied the "lib.chooseDevOutputs"
  # on the propagated build inputs.
  pullAllInputs = inputs:
    inputs ++ lib.concatMap (i: pullAllInputs (i.propagatedNativeBuildInputs or [])) inputs;

  fhs = buildFHSUserEnv rec {
    name = "gecko-deps-fhs";
    targetPkgs = _: pullAllInputs (lib.chooseDevOutputs (buildInputs ++ [ stdenv.cc zlib xorg.libXinerama xorg.libXxf86vm ]));
    multiPkgs = null; #targetPkgs;
    extraOutputsToInstall = [ "share" ];
    profile = ''
      # build-fhs-userenv/env.nix adds it, but causes 'ls' to SEGV.
      unset LD_LIBRARY_PATH;
      export LD_LIBRARY_PATH=/lib/;
      export IN_NIX_SHELL=1
      export PKG_CONFIG_PATH=/usr/lib/pkgconfig:/usr/share/pkgconfig
      ${shellHook}
    '';
  };
in

stdenv.mkDerivation {
  name = "gecko-dev-${version}";
  inherit src buildInputs shellHook;

  # Useful for debugging this Nix expression.
  tracePhases = true;

  configurePhase = ''
    unset AS; # Set to CC when configured.
    export MOZBUILD_STATE_PATH=$(pwd)/.mozbuild
    export MOZCONFIG=$(pwd)/.mozconfig
    export builddir=$(pwd)/builddir
    ${genMozConfig}

    mkdir -p $MOZBUILD_STATE_PATH $builddir

    echo >> $MOZCONFIG "
    # . $src/build/mozconfig.common

    ac_add_options --enable-application=browser
    mk_add_options MOZ_OBJDIR=$builddir
    ac_add_options --prefix=$out
    ac_add_options --enable-official-branding
    "
  '';

  AUTOCONF = "${autoconf213}/bin/autoconf";

  buildPhase = ''
    cd $builddir
    $src/mach build
  '';

  installPhase = ''
    cd $builddir
    $src/mach install
  '';

  # TODO: are there tests we would like to run? or should we package them separately?
  doCheck = false;
  doInstallCheck = false;

  # This is for debugging purposes, go to hell damn wrapper which are removing
  # all I need for debugging.
  hardeningDisable = [ "all" ];

  passthru.updateScript = updateFromGitHub {
    owner = "mozilla";
    repo = "gecko-dev";
    branch = "master";
    path = "pkgs/gecko/source.json";
  };
  passthru.fhs = fhs; # gecko.x86_64-linux.gcc.fhs.env
}