about summary refs log tree commit diff
path: root/pkgs/development/tools/analysis/include-what-you-use/default.nix
blob: 6e7f6d5eea1af69a3a9156c087831e8f021a0c25 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
{ lib, stdenv, fetchurl, cmake, llvmPackages, python3 }:

stdenv.mkDerivation rec {
  pname = "include-what-you-use";
  # Also bump llvmPackages in all-packages.nix to the supported version!
  version = "0.22";

  src = fetchurl {
    url = "${meta.homepage}/downloads/${pname}-${version}.src.tar.gz";
    hash = "sha256-hZB0tGHqS4MlpzQYwgfKM7XmVmsI5rWH65FkQWVppt0=";
  };

  postPatch = ''
    patchShebangs .
  '';

  nativeBuildInputs = with llvmPackages; [ cmake llvm.dev llvm python3 ];
  buildInputs = with llvmPackages; [ libclang clang-unwrapped python3 ];

  clang = llvmPackages.clang;

  cmakeFlags = [ "-DCMAKE_PREFIX_PATH=${llvmPackages.llvm.dev}" ];

  postInstall = ''
    substituteInPlace $out/bin/iwyu_tool.py \
      --replace-fail "'include-what-you-use'" "'$out/bin/include-what-you-use'"


    mv $out/bin/include-what-you-use $out/bin/.include-what-you-use-unwrapped
    mv $out/bin/iwyu_tool.py $out/bin/.iwyu_tool.py-unwrapped
    substituteAll ${./wrapper} $out/bin/include-what-you-use
    ln -s $out/bin/include-what-you-use $out/bin/iwyu_tool.py
    chmod +x $out/bin/include-what-you-use
    patchShebangs $out/bin/include-what-you-use
  '';

  meta = with lib; {
    description = "Analyze #includes in C/C++ source files with clang";
    longDescription = ''
      For every symbol (type, function variable, or macro) that you use in
      foo.cc, either foo.cc or foo.h should #include a .h file that exports the
      declaration of that symbol.  The main goal of include-what-you-use is to
      remove superfluous #includes, both by figuring out what #includes are not
      actually needed for this file (for both .cc and .h files), and by
      replacing #includes with forward-declares when possible.
    '';
    homepage = "https://include-what-you-use.org";
    license = licenses.bsd3;
    platforms = platforms.unix;
  };
}