Merge pull request #304749 from hatch01/clang-uml

clang-uml: init at 0.5.1
NixOS · Jun 5, 2024 · 999b26a · 999b26a
2 parents dba23c2 + 69deec4
commit 999b26a
Show file tree

Hide file tree

Showing 2 changed files with 110 additions and 0 deletions.
diff --git a/pkgs/by-name/cl/clang-uml/package.nix b/pkgs/by-name/cl/clang-uml/package.nix
@@ -0,0 +1,79 @@
+{ lib
+, fetchFromGitHub
+, stdenv
+, cmake
+, pkg-config
+, installShellFiles
+, libclang
+, clang
+, llvmPackages
+, libllvm
+, yaml-cpp
+, elfutils
+, libunwind
+, enableLibcxx ? false
+, debug ? false
+,
+}:
+stdenv.mkDerivation (finalAttrs: {
+  pname = "clang-uml";
+  version = "0.5.2";
+
+  src = fetchFromGitHub {
+    owner = "bkryza";
+    repo = "clang-uml";
+    rev = finalAttrs.version;
+    hash = "sha256-ZVaMLsI1FK05xFfMmlLBPop7DR3fDstnfgjdBmsjNBA=";
+  };
+
+  nativeBuildInputs = [
+    cmake
+    pkg-config
+    installShellFiles
+  ] ++ (if debug then [
+    elfutils
+    libunwind
+  ] else [ ]);
+
+  buildInputs = [
+    clang
+    libclang
+    libllvm
+    yaml-cpp
+  ];
+
+  cmakeFlags = if debug then [ "-DCMAKE_BUILD_TYPE=Debug" ] else [ ];
+
+  clang = if enableLibcxx then llvmPackages.libcxxClang else llvmPackages.clang;
+
+  postInstall = ''
+    cp $out/bin/clang-uml $out/bin/clang-uml-unwrapped
+    rm $out/bin/clang-uml
+    export unwrapped_clang_uml="$out/bin/clang-uml-unwrapped"
+
+    # inject clang and unwrapp_clang_uml variables into wrapper
+    substituteAll ${./wrapper} $out/bin/clang-uml
+    chmod +x $out/bin/clang-uml
+
+    installShellCompletion --cmd clang-uml \
+      --bash $src/packaging/autocomplete/clang-uml \
+      --zsh $src/packaging/autocomplete/_clang-uml
+  '';
+
+  dontFixup = debug;
+  dontStrip = debug;
+
+  meta = with lib; {
+    description = "Customizable automatic UML diagram generator for C++ based on Clang.";
+    longDescription = ''
+      clang-uml is an automatic C++ to UML class, sequence, package and include diagram generator, driven by YAML configuration files.
+      The main idea behind the project is to easily maintain up-to-date diagrams within a code-base or document legacy code.
+      The configuration file or files for clang-uml define the types and contents of each generated diagram.
+      The diagrams can be generated in PlantUML, MermaidJS and JSON formats.
+    '';
+    maintainers = with maintainers; [ eymeric ];
+    homepage = "https://clang-uml.github.io/";
+    license = licenses.asl20;
+    platforms = platforms.all;
+  };
+})
diff --git a/pkgs/by-name/cl/clang-uml/wrapper b/pkgs/by-name/cl/clang-uml/wrapper
@@ -0,0 +1,31 @@
+#!/bin/sh
+# This file is copied from https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/clang-tools/wrapper
+# The clang-tools wrapper is commonly used together with the clang package on
+# nix, because without the wrapper, clang tools fail to find stdlib includes on
+# nix.
+
+buildcpath() {
+  local path after
+  while (( $# )); do
+    case $1 in
+        -isystem)
+            shift
+            path=$path${path:+':'}$1
+            ;;
+        -idirafter)
+            shift
+            after=$after${after:+':'}$1
+            ;;
+    esac
+    shift
+  done
+  echo $path${after:+':'}$after
+}
+
+export CPATH=${CPATH}${CPATH:+':'}$(buildcpath ${NIX_CFLAGS_COMPILE} \
+                                               $(<@clang@/nix-support/libc-cflags)):@clang@/resource-root/include
+export CPLUS_INCLUDE_PATH=${CPLUS_INCLUDE_PATH}${CPLUS_INCLUDE_PATH:+':'}$(buildcpath ${NIX_CFLAGS_COMPILE} \
+                                                                                      $(<@clang@/nix-support/libcxx-cxxflags) \
+                                                                                      $(<@clang@/nix-support/libc-cflags)):@clang@/resource-root/include
+
+exec @unwrapped_clang_uml@ "$@"