kicad: python2 -> python3

pkgs/applications/science/electronics/kicad/default.nix

@@ -1,11 +1,15 @@
-{ wxGTK, lib, stdenv, fetchurl, fetchFromGitHub, cmake, libGLU, libGL, zlib
+{ lib, stdenv, fetchFromGitHub, cmake, libGLU, libGL, zlib, wxGTK
 , libX11, gettext, glew, glm, cairo, curl, openssl, boost, pkgconfig
-, doxygen, pcre, libpthreadstubs, libXdmcp
+, doxygen, pcre, libpthreadstubs, libXdmcp, makeWrapper, gnome3
-, wrapGAppsHook
+, gsettings-desktop-schemas, librsvg, hicolor-icon-theme, lndir, cups
+, fetchpatch
+
 , oceSupport ? true, opencascade
+, withOCCT ? false, opencascade-occt
 , ngspiceSupport ? true, libngspice
-, swig, python, pythonPackages
+, scriptingSupport ? true, swig, python, pythonPackages, wxPython
-, lndir
+, debug ? false, valgrind
+, with3d ? true
 }:
 
 assert ngspiceSupport -> libngspice != null;
@@ -20,81 +24,116 @@ let
       rev = version;
       inherit sha256 name;
     };
-    nativeBuildInputs = [
+    nativeBuildInputs = [ cmake ];
-      cmake
-    ];
   } // attrs);
 
-in stdenv.mkDerivation rec {
+  # oce on aarch64 fails a test
-  pname = "kicad";
+  withOCC = (stdenv.isAarch64 && (withOCCT || oceSupport)) || (!stdenv.isAarch64 && withOCCT);
-  series = "5.0";
+  withOCE = oceSupport && !stdenv.isAarch64 && !withOCC;
-  version = "5.1.4";
 
-  src = fetchurl {
+in
-    url = "https://launchpad.net/kicad/${series}/${version}/+download/kicad-${version}.tar.xz";
+stdenv.mkDerivation rec {
-    sha256 = "1r60dgh6aalbpq1wsmpyxkz0nn4ck8ydfdjcrblpl69k5rks5k2j";
+  pname = "kicad";
+  version = "5.1.5";
+
+  src = fetchFromGitHub {
+    owner = "KiCad";
+    repo = "kicad-source-mirror";
+    rev = version;
+    sha256 = "15h3rwisjss3fdc9bam9n2wq94slhacc3fbg14bnzf4n5agsnv5b";
   };
 
+  # quick fix for #72248
+  # should be removed if a better fix is merged
+  patches = [
+    (fetchpatch {
+      url = "https://github.com/johnbeard/kicad/commit/dfb1318a3989e3d6f9f2ac33c924ca5030ea273b.patch";
+      sha256 = "00ifd3fas8lid8svzh1w67xc8kyx89qidp7gm633r014j3kjkgcd";
+    })
+  ];
+
   postPatch = ''
     substituteInPlace CMakeModules/KiCadVersion.cmake \
-      --replace no-vcs-found ${version}
+      --replace "unknown" ${version}
   '';
 
-  cmakeFlags = [
+  makeFlags = optional (debug) [ "CFLAGS+=-Og" "CFLAGS+=-ggdb" ];
-    "-DKICAD_SCRIPTING=ON"
-    "-DKICAD_SCRIPTING_MODULES=ON"
-    "-DKICAD_SCRIPTING_WXPYTHON=ON"
-    # nix installs wxPython headers in wxPython package, not in wxwidget
-    # as assumed. We explicitely set the header location.
-    "-DCMAKE_CXX_FLAGS=-I${pythonPackages.wxPython}/include/wx-3.0"
-    "-DwxPYTHON_INCLUDE_DIRS=${pythonPackages.wxPython}/include/wx-3.0"
-  ] ++ optionals (oceSupport) [ "-DKICAD_USE_OCE=ON" "-DOCE_DIR=${opencascade}" ]
-    ++ optional (ngspiceSupport) "-DKICAD_SPICE=ON";
 
-  nativeBuildInputs = [
+  cmakeFlags =
-    cmake
+    optionals (scriptingSupport) [
-    doxygen
+      "-DKICAD_SCRIPTING=ON"
-    pkgconfig
+      "-DKICAD_SCRIPTING_MODULES=ON"
-    wrapGAppsHook
+      "-DKICAD_SCRIPTING_PYTHON3=ON"
-    pythonPackages.wrapPython
+      "-DKICAD_SCRIPTING_WXPYTHON_PHOENIX=ON"
-    lndir
+    ]
-  ];
+    ++ optional (!scriptingSupport)
-  pythonPath = [ pythonPackages.wxPython ];
+      "-DKICAD_SCRIPTING=OFF"
-  propagatedBuildInputs = [ pythonPackages.wxPython ];
+    ++ optional (ngspiceSupport) "-DKICAD_SPICE=ON"
+    ++ optionals (withOCE)
+      [ "-DKICAD_USE_OCE=ON" "-DOCE_DIR=${opencascade}" ]
+    ++ optionals (withOCC) [
+      "-DKICAD_USE_OCC=ON"
+      # this line is unneeded on unstable...
+      "-DKICAD_USE_OCE=OFF"
+      "-DOCC_INCLUDE_DIR=${opencascade-occt}/include/opencascade"
+    ]
+    ++ optionals (debug) [
+      "-DCMAKE_BUILD_TYPE=Debug"
+      "-DKICAD_STDLIB_DEBUG=ON"
+      "-DKICAD_USE_VALGRIND=ON"
+    ]
+    ;
+
+  pythonPath =
+    optionals (scriptingSupport)
+    [ wxPython pythonPackages.six ];
+
+  nativeBuildInputs =
+    [ cmake doxygen pkgconfig lndir ]
+    ++ optionals (scriptingSupport)
+      [ pythonPackages.wrapPython makeWrapper ]
+  ;
 
   buildInputs = [
-    libGLU libGL zlib libX11 wxGTK pcre libXdmcp glew glm libpthreadstubs
+    libGLU libGL zlib libX11 wxGTK pcre libXdmcp gettext
-    cairo curl openssl boost
+    glew glm libpthreadstubs cairo curl openssl boost
-    swig (python.withPackages (ps: with ps; [ wxPython ]))
+  ]
-  ] ++ optional (oceSupport) opencascade
+  ++ optionals (scriptingSupport) [ swig python wxPython ]
-    ++ optional (ngspiceSupport) libngspice;
+  ++ optional (ngspiceSupport) libngspice
+  ++ optional (withOCE) opencascade
+  ++ optional (withOCC) opencascade-occt
+  ++ optional (debug) valgrind
+  ;
 
-  # this breaks other applications in kicad
+  # 5.1.x fails the eeschema test
-  dontWrapGApps = true;
+  # doInstallCheck = (!debug);
+  # installCheckTarget = "test";
+
+  dontStrip = debug;
 
   passthru = {
-    i18n = mkLib version "i18n" "1dk7wis4cncmihl8fnic3jyhqcdzpifchzsp7hmf214h0vp199zr" {
+    symbols = mkLib "${version}" "symbols" "048b07ffsaav1ssrchw2p870lvb4rsyb5vnniy670k7q9p16qq6h" {
-      buildInputs = [
+      meta.license = licenses.cc-by-sa-40;
-        gettext
+    };
-      ];
+    templates = mkLib "${version}" "templates" "0cs3bm3zb5ngw5ldn0lzw5bvqm4kvcidyrn76438alffwiz2b15g" {
+      meta.license = licenses.cc-by-sa-40;
+    };
+    footprints = mkLib "${version}" "footprints" "1c4whgn14qhz4yqkl46w13p6rpv1k0hsc9s9h9368fxfcz9knb2j" {
+      meta.license = licenses.cc-by-sa-40;
+    };
+    i18n = mkLib "${version}" "i18n" "1rfpifl8vky1gba2angizlb2n7mwmsiai3r6ip6qma60wdj8sbd3" {
+      buildInputs = [ gettext ];
       meta.license = licenses.gpl2; # https://github.com/KiCad/kicad-i18n/issues/3
     };
-    symbols = mkLib version "symbols" "1lna4xlvzrxif3569pkp6mrg7fj62z3a3ri5j97lnmnnzhiddnh3" {
+    packages3d = mkLib "${version}" "packages3d" "0cff2ms1bsw530kqb1fr1m2pjixyxzwa81mxgac3qpbcf8fnpvaz" {
-      meta.license = licenses.cc-by-sa-40;
-    };
-    footprints = mkLib version "footprints" "0c0kcywxlaihzzwp9bi0dsr2v9j46zcdr85xmfpivmrk19apss6a" {
-      meta.license = licenses.cc-by-sa-40;
-    };
-    templates = mkLib version "templates" "1bagb0b94cjh7zp9z0h23b60j45kwxbsbb7b2bdk98dmph8lmzbb" {
-      meta.license = licenses.cc-by-sa-40;
-    };
-    packages3d = mkLib version "packages3d" "0h2qjj8vf33jz6jhqdz90c80h5i1ydgfqnns7rn0fqphlnscb45g" {
       hydraPlatforms = []; # this is a ~1 GiB download, occupies ~5 GiB in store
       meta.license = licenses.cc-by-sa-40;
     };
   };
 
-  modules = with passthru; [ i18n symbols footprints templates ];
+  # TODO, figure out how to skip this step? (since we're not making the 3D models optional)
+  modules = with passthru; [ i18n symbols footprints templates ]
+  ++ optionals (with3d) [ packages3d ];
 
   postInstall = ''
     mkdir -p $out/share
@@ -103,19 +142,53 @@ in stdenv.mkDerivation rec {
     done
   '';
 
-  preFixup = ''
+  makeWrapperArgs = [
-    buildPythonPath "$out $pythonPath"
+    "--prefix XDG_DATA_DIRS : ${hicolor-icon-theme}/share"
-    gappsWrapperArgs+=(--set PYTHONPATH "$program_PYTHONPATH")
+    "--prefix XDG_DATA_DIRS : ${gnome3.defaultIconTheme}/share"
+    "--prefix XDG_DATA_DIRS : ${wxGTK.gtk}/share/gsettings-schemas/${wxGTK.gtk.name}"
+    "--prefix XDG_DATA_DIRS : ${gsettings-desktop-schemas}/share/gsettings-schemas/${gsettings-desktop-schemas.name}"
+    # wrapGAppsHook did these, as well, no idea if it matters...
+    "--prefix XDG_DATA_DIRS : ${cups}/share"
+    "--prefix GIO_EXTRA_MODULES : ${gnome3.dconf}/lib/gio/modules"
+  ]
+  ++ optionals (ngspiceSupport) [ "--prefix LD_LIBRARY_PATH : ${libngspice}/lib" ]
+  # infinisil's workaround for #39493
+  ++ [ "--set GDK_PIXBUF_MODULE_FILE ${librsvg}/lib/gdk-pixbuf-2.0/2.10.0/loaders.cache" ]
+  ;
 
-    wrapGApp "$out/bin/kicad" --prefix LD_LIBRARY_PATH : "${libngspice}/lib"
+  # can't add $out stuff to makeWrapperArgs...
-  '';
+  # wrapGAppsHook added the $out/share, though i noticed no difference without it
+  preFixup =
+    optionalString (scriptingSupport) '' buildPythonPath "$out $pythonPath"
+    '' +
+    '' wrapProgram $out/bin/kicad $makeWrapperArgs --prefix XDG_DATA_DIRS : $out/share --set KICAD_SYMBOL_DIR $out/share/kicad/library --set KICAD_TEMPLATE_DIR $out/share/kicad/template --set KISYS3DMOD $out/share/kicad/modules/packages3d --set KISYSMOD $out/share/kicad/modules ''
+    + optionalString (scriptingSupport) '' --set PYTHONPATH "$program_PYTHONPATH"
+    '' +
+    '' wrapProgram $out/bin/pcbnew $makeWrapperArgs --prefix XDG_DATA_DIRS : $out/share --set KISYS3DMOD $out/share/kicad/modules/packages3d ''
+    + optionalString (scriptingSupport) '' --set PYTHONPATH "$program_PYTHONPATH"
+    '' +
+    '' wrapProgram $out/bin/eeschema $makeWrapperArgs --prefix XDG_DATA_DIRS : $out/share --set KICAD_SYMBOL_DIR $out/share/kicad/library ''
+    + optionalString (scriptingSupport) '' --set PYTHONPATH "$program_PYTHONPATH"
+    '' +
+    '' wrapProgram $out/bin/gerbview $makeWrapperArgs --prefix XDG_DATA_DIRS : $out/share ''
+    + optionalString (scriptingSupport) '' --set PYTHONPATH "$program_PYTHONPATH"
+    '' +
+    '' wrapProgram $out/bin/pcb_calculator $makeWrapperArgs --prefix XDG_DATA_DIRS : $out/share ''
+    + optionalString (scriptingSupport) '' --set PYTHONPATH "$program_PYTHONPATH"
+    '' +
+    '' wrapProgram $out/bin/pl_editor $makeWrapperArgs --prefix XDG_DATA_DIRS : $out/share ''
+    + optionalString (scriptingSupport) '' --set PYTHONPATH "$program_PYTHONPATH"
+    '' +
+    '' wrapProgram $out/bin/bitmap2component $makeWrapperArgs ''
+    + optionalString (scriptingSupport) '' --set PYTHONPATH "$program_PYTHONPATH"
+    ''
+  ;
 
   meta = {
     description = "Free Software EDA Suite";
-    homepage = http://www.kicad-pcb.org/;
+    homepage = "http://www.kicad-pcb.org/";
-    license = licenses.gpl2;
+    license = with licenses; [ gpl2 cc-by-sa-40 ];
-    maintainers = with maintainers; [ berce ];
+    maintainers = with maintainers; [ evils kiwi berce ];
     platforms = with platforms; linux;
-    broken = stdenv.isAarch64;
   };
 }