cambalache: init at 0.8.0

[jtojnar]

Motivation for this change

UI designer for GTK 3 & 4 (sort of like Glade):

https://gitlab.gnome.org/jpu/cambalache

• GTK 3 works but GTK 4 currently does not and no errors are logged, needs debugging. https://gitlab.gnome.org/jpu/cambalache/-/issues/28
• MIME declarations ($out/share/mime/) are required for filters in „Open project“ dialogue, can we add them to XDG_DATA_DIRS or something – turns out it is a bug https://gitlab.gnome.org/jpu/cambalache/-/merge_requests/7
• Opening projects is broken on main branch https://gitlab.gnome.org/jpu/cambalache/-/issues/29
• GTK 4’s Broadway daemon should be moved out of dev output to reduce runtime closure.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
• Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
• Tested execution of all binary files (usually in ./result/bin/)
• 21.11 Release Notes (or backporting 21.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

[r-rmcgibbo]

Result of nixpkgs-review pr 138940 at a9001915 run on x86_64-linux 1

1 package built successfully:

• cambalache

1 suggestion:

• warning: unused-argument

  Unused argument: stdenv.
  Near pkgs/development/tools/cambalache/default.nix:1:3:

    |
  1 | { stdenv
    |   ^
  

---

Result of nixpkgs-review pr 138940 at a9001915 run on aarch64-linux 1

1 package built successfully:

• cambalache

1 suggestion:

• warning: unused-argument

  Unused argument: stdenv.
  Near pkgs/development/tools/cambalache/default.nix:1:3:

    |
  1 | { stdenv
    |   ^
  

[psydvl]

Newbie questions:

1. Why python3.pkgs instead of python3Packages?
2. Why unstableGitUpdater, nor stable?
3. And why is it still draft? I successfully built v0.8.0 (latest) with similar build file...

[jtojnar]

• Why python3.pkgs instead of python3Packages?

It is shorter. And these days, the latter is alias of the former.

• Why unstableGitUpdater, nor stable?

I had to switch to git revision because 0.7.4 was broken. Now that 0.8.0 has been released, that probably will no longer be necessary.

• And why is it still draft? I successfully built v0.8.0 (latest) with similar build file...

See the checkboxes in the OP.

[psydvl]

Idea:
Since gtk4-broadwayd not necessary dependency and for now not separable from gtk4.dev, it can be brought out as option like useGTK4Broadwayd

-{ stdenv
+{ stdenv, lib
---
---
+, useGTK3Broadwayd ? false
+, useGTK4Broadwayd ? false
}:

  preFixup = ''
    # Let python wrapper use GNOME flags.
    makeWrapperArgs+=(
+      # For gtk3 broadwayd
+      ${ lib.optionalString useGTK3Broadwayd ''--prefix PATH : "${gtk3.dev}/bin"''}
      # For gtk4-broadwayd
-      --prefix PATH : "${gtk4.dev}/bin"
+      ${ lib.optionalString useGTK3Broadwayd ''--prefix PATH : "${gtk4.dev}/bin"''}
      "''${gappsWrapperArgs[@]}"
    )
  '';

Then app can be used as pkgs.cambalache or

pkgs.cambalache.override {
  # useGTK3Broadwayd = true;
  useGTK4Broadwayd = true;
}

Also, there are can be cambalache-dev added to all-packages.nix or dev (cambalache.dev) output created

[jtojnar]

Broadway is necessary dependency – it is used for rendering the designed interface. And I think it should not be that hard – just move broadwayd (only on GTK 4 by the way, GTK3 does not have a separate binary) to a new output in postInstall. I just have not gotten to doing it yet.

The path to the gtk4.dev is baked into the program using a wrapper so adding cambalache.dev output would do nothing.

[psydvl]

GTK3 has separate binary
It's lay on ${gtk3}/bin/broadwayd
And it required since we have next warning on launch without any

WARNING:cambalache.cmb_view broadwayd not found, Gtk 3 workspace wont work.
WARNING:cambalache.cmb_view gtk4-broadwayd not found, Gtk 4 workspace wont work.

So next code works for me, and since I launch using nix-shell with --pure option, I think all essential included?

$ nix-shell -I nixpkgs=$NIXPKGS_GIT -p cambalache --pure --run cambalache

Same as

$ nix-shell -I nixpkgs=$NIXPKGS_GIT -p "cambalache.override{ useGTK4Broadwayd=true; }" --pure --run cambalache

My default.nix

{ lib, stdenv, fetchFromGitLab
, meson, pkg-config, ninja
, python3
, appstream-glib , desktop-file-utils, shared-mime-info
, gobject-introspection, gtk3, gtk4
, wrapGAppsHook
, webkitgtk
, gnome, dconf
, useGTK3Broadwayd ? false
, useGTK4Broadwayd ? false
}:

python3.pkgs.buildPythonApplication rec {
  pname = "cambalache";
  version = "0.8.0";
  format = "other";
  strictDeps = false; # https://github.com/NixOS/nixpkgs/issues/56943

  src = fetchFromGitLab {
    domain = "gitlab.gnome.org";
    owner = "jpu";
    repo = pname;
    rev = version;
    sha256 = "05hf45v24l73fwv36bf90h6ksf6axvi8f4mddyq24x63w1yndhg9";
  };

  nativeBuildInputs = [
    meson
    ninja
    pkg-config
    appstream-glib
    desktop-file-utils
    gobject-introspection
    wrapGAppsHook
    shared-mime-info
  ];

  buildInputs = [
    gtk3
    gtk4
    webkitgtk
    gnome.adwaita-icon-theme
  ];

  propagatedBuildInputs = with python3.pkgs; [
    pygobject3
    lxml
  ];
  
  # Prevent double wrapping.
  dontWrapGApps = true;
  
  preFixup = ''
    # Let python wrapper use GNOME flags.
    makeWrapperArgs+=(
      # For gtk3 broadwayd
      ${ lib.optionalString useGTK3Broadwayd ''--prefix PATH : "${gtk3}/bin"''}
      # For gtk4-broadwayd
      ${ lib.optionalString useGTK4Broadwayd ''--prefix PATH : "${gtk4.dev}/bin"''}
      "''${gappsWrapperArgs[@]}"
    )
  '';

  postPatch = ''
    patchShebangs postinstall.py
    mkdir -p $out/bin
    ${ lib.optionalString (!useGTK3Broadwayd) "install ${gtk3}/bin/broadwayd $out/bin/"}
    ${ lib.optionalString (!useGTK4Broadwayd) "install ${gtk4.dev}/bin/gtk4-broadwayd $out/bin/"}
  '';

  meta = with lib; {
    description = "Cambalache is a new RAD tool for Gtk 4 and 3 with a clear MVC design and data model first philosophy.";
    homepage = "https://gitlab.gnome.org/jpu/cambalache";
    license = with licenses; [
      lgpl21Only # Cambalache
      gpl2Only # tools
    ];
    #platforms = stdenv.lib.platforms.linux;
    #maintainers = with maintainers; [ psydvl ];
  };
}

[jtojnar]

Thanks, I did not realize we did #116053 so I thought GTK 3 did not use the daemon. I decided to do the same in GTK 4 since it is quite small.

[jtojnar]

Not sure if it is makes sense to merge this since it is still not very usable at the moment.

[psydvl]

Since pythonPath is deprecated

nixpkgs/pkgs/development/interpreters/python/mk-python-derivation.nix

Lines 46 to 47 in e0f466e

	# DEPRECATED: use propagatedBuildInputs
	, pythonPath ? []

Shouldn't it be replaced with propagatedBuildInputs?

[jtojnar]

Hopefully it will not be deprecated for much longer, albeit under a different name: #102613

[psydvl]

There are 0.8.2 already published
https://gitlab.gnome.org/jpu/cambalache/-/tags
And it's so usable, so glade is
Why not to merge?

version = "0.8.2";
sha256 = "1+IoBoaNHwvN8W+KRyV5cTFkFG+pTHJBehQ2VosCEfs=";

[noonien]

Any update on this?