feat: Simplify QT-based tray implementaion by Kishi85 · Pull Request #121 · LizardByte/tray

Kishi85 · 2026-05-08T19:20:54Z

Description

This reworks the Qt-based tray with an adapted version of QtTrayMenu.h/cpp from upstream as suggested in LizardByte/Sunshine#4907.

This currently a very early work-in-progress version of the code with all of Lizardbyte's forks additional functionality (e.g. notifications) implemented but tested only very limited.

There is also still an issue with left clicking the tray icon that is also present in the current AI based implementation which caused by https://qt-project.atlassian.net/browse/QTBUG-139921.

This version is platform-neutral for QtTrayMenu.h/cpp code with Linux platform-specifics restricted to tray_linux.cpp. Special features like XDG desktop notifications (which wouldn't have worked with Sunshine anyway due to elevated privileges) have been replaced with Qt-native equivalents. Positioning is currently also fully reliant on Qt-provided features to maintain platform independence.

Screenshot

Issues Fixed or Closed

Closes Pr 121 test #123

Roadmap Issues

Type of Change

Checklist

Code follows the style guidelines of this project
Code has been self-reviewed
Code has been commented, particularly in hard-to-understand areas
Code docstring/documentation-blocks for new or existing methods/components have been added or updated
Unit tests have been added or updated for any new or modified functionality

AI Usage

None: No AI tools were used in creating this PR
Light: AI provided minor assistance (formatting, simple suggestions)
Moderate: AI helped with code generation or debugging specific parts
Heavy: AI generated most or all of the code changes

codecov · 2026-05-09T01:50:32Z

Codecov Report

❌ Patch coverage is 0% with 196 lines in your changes missing coverage. Please review.
✅ Project coverage is 41.00%. Comparing base (9189980) to head (c552bda).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
src/QtTrayMenu.cpp	0.00%	161 Missing and 1 partial ⚠️
src/tray_linux.cpp	0.00%	34 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (9189980) and HEAD (c552bda). Click for more details.

HEAD has 2 uploads less than BASE

Flag BASE (9189980) HEAD (c552bda)

Linux-qt5 1 0

Linux-qt6 1 0

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #121       +/-   ##
===========================================
- Coverage   63.75%   41.00%   -22.75%     
===========================================
  Files           4        5        +1     
  Lines         858      517      -341     
  Branches      313      148      -165     
===========================================
- Hits          547      212      -335     
- Misses        205      281       +76     
+ Partials      106       24       -82

Flag	Coverage Δ
Linux-qt5	`?`
Linux-qt6	`?`
Windows	`70.67% <ø> (ø)`
macOS	`57.52% <ø> (-1.77%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/tray_linux.cpp	`0.00% <0.00%> (-59.47%)`	⬇️
src/QtTrayMenu.cpp	`0.00% <0.00%> (ø)`

... and 1 file with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9189980...c552bda. Read the comment docs.

Kishi85 · 2026-05-11T11:43:23Z

I've fixed most of the issues I've found so far (added all the necessary pointer valid checks/etc. and moved the exit() order around so everything gets cleaned up in reverse order (clearing references as necessary on the go). But no matter what I do the CI pipeline segfaults at this one specific test:

[ RUN      ] TrayTest.TestCheckboxStates
/home/runner/work/_temp/d5b937f4-9556-4df2-8f27-571e2cb10ca8.sh: line 1:  8581 Segmentation fault      (core dumped) ./test_tray --gtest_color=yes --gtest_output=xml:test_results.xml
Error: Process completed with exit code 139.

I can run all the tests fine locally after I've added support for spectacle screenshots due to using KDE, tests running both with clang and gcc compiled project. It just wont complete when run on the CI-container with ubuntu-latest. I'm a bit out of ideas here and it looks like I have to test this on a native Ubuntu-latest install at some point to continue this further.

ReenigneArcher · 2026-05-12T02:04:56Z

@Kishi85 have a look at #123

ReenigneArcher · 2026-05-12T02:05:57Z

+    // We might not have access to the real argc/argv here due to being called/pulled as a dependency.
+    if (argc < 0 && argv == nullptr) {
+      argc = 1;
+      char *argvArray[] = {(char *) "TrayMenuApp", nullptr};


This was one of the things I didn't like about the upstream version. We need to be able to set the metadata ourselves, like

tray/src/tray_linux.cpp

Lines 544 to 573 in 2a638a8

void configure_app_metadata(const struct tray *tray) {

const QString effective_name = !g_app_name.isEmpty() ? g_app_name : QStringLiteral("tray");

if (QCoreApplication::applicationName().isEmpty()) {

QCoreApplication::setApplicationName(effective_name);

}

if (QGuiApplication::applicationDisplayName().isEmpty()) {

if (!g_app_display_name.isEmpty()) {

QGuiApplication::setApplicationDisplayName(g_app_display_name);

} else {

const QString display_name =

(tray != nullptr && tray->tooltip != nullptr) ? QString::fromUtf8(tray->tooltip) : effective_name;

QGuiApplication::setApplicationDisplayName(display_name);

}

}

if (!QGuiApplication::desktopFileName().isEmpty()) {

return;

}

if (!g_desktop_name.isEmpty()) {

QGuiApplication::setDesktopFileName(g_desktop_name);

return;

}

QString desktop_name = QCoreApplication::applicationName();

if (!desktop_name.endsWith(QStringLiteral(".desktop"))) {

desktop_name += QStringLiteral(".desktop");

}

QGuiApplication::setDesktopFileName(desktop_name);

That is one of the things I've taken over from your version. The constructor is just there to have it initialize without throwing an empty key error.

ReenigneArcher · 2026-05-12T02:09:56Z

-    }
-  }
-
-  void destroy_app() {


I believe this was needed for tests. You can look at the screenshots in the PR I mentioned and see that there is no longer proper cleanup between tests.

That part I've also taken over and put in QtTrayMenu::exit()

Kishi85 · 2026-05-12T06:02:29Z

@Kishi85 have a look at #123

I'll pick that test change if you dont mind as it IMHO makes more sense logically

Add a persistent default argv (anonymous namespace) and include QCursor, then construct QApplication with the default argv when original argc/argv are missing to avoid using a short-lived stack array. Hide trayTopMenu before clearing tray references to prevent lingering UI. Replace menu->show() with menu->popup(QCursor::pos()) to work around QTBUG-139921 on Linux/Wayland. NOSONAR comments for QApplication allocation are preserved.

Kishi85 · 2026-05-12T06:16:24Z

Also the change you did for showing the menu on wayland in #123 does not work. Same issue as with show() due to that bug in Qt:
qt.qpa.wayland: Failed to create grabbing popup. Ensure popup QWidgetWindow(0x55c3cc28b8c0, name="QMenuClassWindow") has a transientParent set and that parent window has received input.

Looks like the only way to get left-click to work on Linux/Wayland is for Qt to fix the bug, every other workaround either fails silently or yields above message unfortunately.

sonarqubecloud · 2026-05-12T06:27:09Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

Kishi85 changed the title ~~Simplify QT-based tray implementaion~~ fix: Simplify QT-based tray implementaion May 8, 2026

Kishi85 changed the title ~~fix: Simplify QT-based tray implementaion~~ feat: Simplify QT-based tray implementaion May 8, 2026

Kishi85 force-pushed the simplify-qt-tray branch 11 times, most recently from 275be0f to c552bda Compare May 11, 2026 11:31

ReenigneArcher reviewed May 12, 2026

View reviewed changes

Kishi85 and others added 10 commits May 12, 2026 08:04

Import adapted QtTrayMenu class from upstream

d176fe3

Integrate upstream QtTrayMenu.h/cpp into tray_linux.cpp

e8a82bb

doc: Add doxygen comments for public functions of QtTrayMenu

c83e123

fix: Add default initialized values and change running state tracking

7d4a6a9

Add support for spectacle screenshots on KDE

79126bb

Revert example to non-notification variant

1b10b38

fix: Segfaults from unit tests

04599b8

WIP - process events during exit

498fba8

Update test_tray.cpp

36ede20

menu->popup does not work for Linux/Wayland either, stick to show()

329b911

Kishi85 force-pushed the simplify-qt-tray branch from c552bda to 329b911 Compare May 12, 2026 06:18

Kishi85 added 2 commits May 12, 2026 08:21

QApplication::quit() only for apps that we created.

14f0861

Cleanup QtTrayMenu constructor

9f22593

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Simplify QT-based tray implementaion#121

feat: Simplify QT-based tray implementaion#121
Kishi85 wants to merge 13 commits into
LizardByte:masterfrom
Kishi85:simplify-qt-tray

Kishi85 commented May 8, 2026 •

edited

Loading

Uh oh!

codecov Bot commented May 9, 2026 •

edited

Loading

Uh oh!

Kishi85 commented May 11, 2026

Uh oh!

ReenigneArcher commented May 12, 2026

Uh oh!

ReenigneArcher May 12, 2026

Uh oh!

Kishi85 May 12, 2026

Uh oh!

ReenigneArcher May 12, 2026

Uh oh!

Kishi85 May 12, 2026

Uh oh!

Kishi85 commented May 12, 2026

Uh oh!

Kishi85 commented May 12, 2026 •

edited

Loading

Uh oh!

sonarqubecloud Bot commented May 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	void configure_app_metadata(const struct tray *tray) {
	const QString effective_name = !g_app_name.isEmpty() ? g_app_name : QStringLiteral("tray");
	if (QCoreApplication::applicationName().isEmpty()) {
	QCoreApplication::setApplicationName(effective_name);
	}

	if (QGuiApplication::applicationDisplayName().isEmpty()) {
	if (!g_app_display_name.isEmpty()) {
	QGuiApplication::setApplicationDisplayName(g_app_display_name);
	} else {
	const QString display_name =
	(tray != nullptr && tray->tooltip != nullptr) ? QString::fromUtf8(tray->tooltip) : effective_name;
	QGuiApplication::setApplicationDisplayName(display_name);
	}
	}

	if (!QGuiApplication::desktopFileName().isEmpty()) {
	return;
	}

	if (!g_desktop_name.isEmpty()) {
	QGuiApplication::setDesktopFileName(g_desktop_name);
	return;
	}

	QString desktop_name = QCoreApplication::applicationName();
	if (!desktop_name.endsWith(QStringLiteral(".desktop"))) {
	desktop_name += QStringLiteral(".desktop");
	}
	QGuiApplication::setDesktopFileName(desktop_name);

Uh oh!

Conversation

Kishi85 commented May 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Screenshot

Issues Fixed or Closed

Roadmap Issues

Type of Change

Checklist

AI Usage

Uh oh!

codecov Bot commented May 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Kishi85 commented May 11, 2026

Uh oh!

ReenigneArcher commented May 12, 2026

Uh oh!

ReenigneArcher May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Kishi85 May 12, 2026

Choose a reason for hiding this comment

Uh oh!

ReenigneArcher May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Kishi85 May 12, 2026

Choose a reason for hiding this comment

Uh oh!

Kishi85 commented May 12, 2026

Uh oh!

Kishi85 commented May 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 12, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Kishi85 commented May 8, 2026 •

edited

Loading

codecov Bot commented May 9, 2026 •

edited

Loading

Kishi85 commented May 12, 2026 •

edited

Loading