Setting the GTK app id
Nobody has claimed this yet.
- Dominant language
- Racket
- Stars
- 68
- Forks
- 82
- PR merge metrics
- No merged PRs in 30d
Description
I've started looking at the guide to porting from GTK 3 to GTK 4. A lot of it seems fairly straightforward, but I see some challenges around this point:
Set a proper application ID
In GTK 4 we want the application’s
GApplication‘application-id’ (and therefore the D-Bus name), the desktop file basename and Wayland’s xdg-shellapp_idto match. In order to achieve this with GTK 3.x callg_set_prgname()with the same application ID you passed toGtkApplication. Rename your desktop files to match the application ID if needed.The call to
g_set_prgname()can be removed once you fully migrated to GTK 4.
Currently, this is what racket/gui passes to gtk_application_new:
There are several problems:
-
It certainly doesn't match the base name of anyone's
.desktopfile, particularly given the use ofgethostname. -
There is no guarantee that it will satisfy
g_application_id_is_valid, particularly the limit of 255 characters and the restriction to[A-Z][a-z][0-9]_-in labels. -
It will never be valid for D-Bus due to the hyphen in
org.racket-lang. From theg_application_id_is_validdocs:Note that the hyphen (
-) character is allowed in application identifiers, but is problematic or not allowed in various specifications and APIs that refer to D-Bus, such as Flatpak application IDs, theDBusActivatableinterface in the Desktop Entry Specification, and the convention that an application’s “main” interface and object path resemble its application identifier and bus name. To avoid situations that require special-case handling, it is recommended that new application identifiers consistently replace hyphens with underscores.Like D-Bus interface names, application identifiers should start with the reversed DNS domain name of the author of the interface (in lower-case), and it is conventional for the rest of the application identifier to consist of words run together, with initial capital letters.
As with D-Bus interface names, if the author’s DNS domain name contains hyphen/minus characters they should be replaced by underscores, and if it contains leading digits they should be escaped by prepending an underscore. For example, if the owner of 7-zip.org used an application identifier for an archiving application, it might be named
org._7_zip.Archiver.These rules would suggest something like
org.racket_lang.DrRacket.
More broadly, it seems like the application ID should be under the control of the programmer.
I'm not sure how best to communicate the application ID to the point where it's needed. Maybe it could us one of the special command-line options to gracket that translate to unsafe-register-process-global? (Or maybe some existing one should be used?)
Then there's the aspect of getting the .desktop file installed under the corresponding name, particularly for something like DrRacket where we have, and presumably want to keep:
which implies that we continue to use the name drracket.desktop to work with get-aux-from-path. Maybe we should add another kind of aux entry to specify the application ID, and use that when installing the file? Maybe there's something analogous to the rewriting make-gracket-launcher already does to the Exec entry in the .desktop file.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with gui-lib/mred/private/wx/gtk/unique.rkt at the gtk_application_new call, then inspect drracket/info.rkt and the get-aux-from-path and make-gracket-launcher paths. The work is complete when the application ID can be controlled, remains valid for GTK and D-Bus, and the installed desktop-file name stays coordinated with it.
Written by the indexing model from the issue text.
Assessment
- Domain
- desktop
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100