FileBrowser: "Open containing folder" automatically selects file in the OS's file manager (LMMS#7700)

Introduces a new class FileRevealer to manage file selection across different platforms (Windows, macOS, Linux, and other *nix operating systems with xdg). Includes methods to open and select files or directories using the default file manager on the respective platform.

---------

Co-authored-by: Tres Finocchiaro <tres.finocchiaro@gmail.com>
Co-authored-by: Hyunjin Song <tteu.ingog@gmail.com>
Co-authored-by: Sotonye Atemie <sakertooth@gmail.com>
Co-authored-by: Dalton Messmer <messmer.dalton@gmail.com>

Author: 5 people

include/FileBrowser.h

@@ -195,8 +195,6 @@ private slots:
 	bool openInNewSampleTrack( lmms::gui::FileItem* item );
 	void sendToActiveInstrumentTrack( lmms::gui::FileItem* item );
 	void updateDirectory( QTreeWidgetItem * item );
-	void openContainingFolder( lmms::gui::FileItem* item );
-
 } ;
 
 

include/FileRevealer.h

@@ -0,0 +1,77 @@
+/*
+ * FileRevealer.h - include file for FileRevealer
+ *
+ * Copyright (c) 2025 Andrew Wiltshire <aw1lt / at/ proton/ dot/me >
+ *
+ * This file is part of LMMS - https://lmms.io
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public
+ * License along with this program (see COPYING); if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA.
+ *
+ */
+
+#ifndef LMMS_FILE_REVEALER_H
+#define LMMS_FILE_REVEALER_H
+
+#include <QFileInfo>
+
+namespace lmms {
+
+/**
+ * @class FileRevealer
+ * @brief A utility class for revealing files and directories in the system's file manager.
+ */
+class FileRevealer
+{
+public:
+	/**
+	 * @brief Retrieves the default file manager for the current platform.
+	 * @return The name or command of the default file manager.
+	 */
+	static const QString& getDefaultFileManager();
+
+	/**
+	 * @brief Opens the directory containing the specified file or folder in the file manager.
+	 * @param item The QFileInfo object representing the file or folder.
+	 */
+	static void openDir(const QFileInfo item);
+
+	/**
+	 * @brief Checks whether the file manager supports selecting a specific file.
+	 * @return True if selection is supported, otherwise false.
+	 */
+	static const QStringList& getSelectCommand();
+
+	/**
+	 * @brief Opens the file manager and selects the specified file if supported.
+	 * @param item The QFileInfo object representing the file to reveal.
+	 */
+	static void reveal(const QFileInfo item);
+
+private:
+	static bool s_canSelect;
+
+protected:
+	/**
+	 * @brief Determines if the given command supports the argument
+	 * @param command The name of the file manager to check.
+	 * @param arg The command line argument to parse for
+	 * @return True if the file command the argument, otherwise false.
+	 */
+	static bool supportsArg(const QString& command, const QString& arg);
+};
+
+} // namespace lmms
+#endif // LMMS_FILE_REVEALER_H

src/gui/CMakeLists.txt

@@ -14,6 +14,7 @@ SET(LMMS_SRCS
 	gui/EffectView.cpp
 	gui/embed.cpp
 	gui/FileBrowser.cpp
+	gui/FileRevealer.cpp
 	gui/GuiApplication.cpp
 	gui/LadspaControlView.cpp
 	gui/LfoControllerDialog.cpp

src/gui/FileBrowser.cpp

@@ -26,15 +26,14 @@
 #include "FileBrowser.h"
 
 #include <QApplication>
-#include <QDesktopServices>
 #include <QDirIterator>
 #include <QHBoxLayout>
-#include <QKeyEvent>
 #include <QLineEdit>
 #include <QMdiArea>
 #include <QMdiSubWindow>
 #include <QMenu>
 #include <QMessageBox>
+#include <QProcess>
 #include <QPushButton>
 #include <QShortcut>
 #include <QStringList>
@@ -45,7 +44,7 @@
 #include "ConfigManager.h"
 #include "DataFile.h"
 #include "Engine.h"
-#include "FileBrowser.h"
+#include "FileRevealer.h"
 #include "FileSearch.h"
 #include "GuiApplication.h"
 #include "ImportFilter.h"
@@ -624,28 +623,35 @@ void FileBrowserTreeWidget::focusOutEvent(QFocusEvent* fe)
 	QTreeWidget::focusOutEvent(fe);
 }
 
+void FileBrowserTreeWidget::contextMenuEvent(QContextMenuEvent* e)
+{
+#ifdef LMMS_BUILD_APPLE
+	QString fileManager = tr("Finder");
+#elif defined(LMMS_BUILD_WIN32)
+	QString fileManager = tr("Explorer");
+#else
+	QString fileManager = tr("file manager");
+#endif
 
+	QTreeWidgetItem* item = itemAt(e->pos());
+	if (item == nullptr) { return; } // program hangs when right-clicking on empty space otherwise
 
+	QMenu contextMenu(this);
 
-void FileBrowserTreeWidget::contextMenuEvent(QContextMenuEvent * e )
-{
-	auto file = dynamic_cast<FileItem*>(itemAt(e->pos()));
-	if( file != nullptr && file->isTrack() )
+	switch (item->type())
 	{
-		QMenu contextMenu( this );
-
-		contextMenu.addAction(
-			tr( "Send to active instrument-track" ),
-			[=, this]{ sendToActiveInstrumentTrack(file); }
-		);
+	case TypeFileItem: {
+		auto file = dynamic_cast<FileItem*>(item);
 
-		contextMenu.addSeparator();
+		if (file->isTrack())
+		{
+			contextMenu.addAction(
+				tr("Send to active instrument-track"), [=, this] { sendToActiveInstrumentTrack(file); });
+			contextMenu.addSeparator();
+		}
 
-		contextMenu.addAction(
-			QIcon(embed::getIconPixmap("folder")),
-			tr("Open containing folder"),
-			[=, this]{ openContainingFolder(file); }
-		);
+		contextMenu.addAction(QIcon(embed::getIconPixmap("folder")), tr("Show in %1").arg(fileManager),
+			[=] { FileRevealer::reveal(file->fullName()); });
 
 		auto songEditorHeader = new QAction(tr("Song Editor"), nullptr);
 		songEditorHeader->setDisabled(true);
@@ -656,14 +662,20 @@ void FileBrowserTreeWidget::contextMenuEvent(QContextMenuEvent * e )
 		patternEditorHeader->setDisabled(true);
 		contextMenu.addAction(patternEditorHeader);
 		contextMenu.addActions( getContextActions(file, false) );
-
-		// We should only show the menu if it contains items
-		if (!contextMenu.isEmpty()) { contextMenu.exec( e->globalPos() ); }
+		break;
+	}
+	case TypeDirectoryItem: {
+		auto dir = dynamic_cast<Directory*>(item);
+		contextMenu.addAction(QIcon(embed::getIconPixmap("folder")), tr("Open in %1").arg(fileManager), [=] {
+			FileRevealer::openDir(dir->fullName());
+		});
+		break;
+	}
 	}
-}
-
-
 
+	// Only show the menu if it contains items
+	if (!contextMenu.isEmpty()) { contextMenu.exec(e->globalPos()); }
+}
 
 QList<QAction*> FileBrowserTreeWidget::getContextActions(FileItem* file, bool songEditor)
 {
@@ -991,22 +1003,6 @@ bool FileBrowserTreeWidget::openInNewSampleTrack(FileItem* item)
 
 
 
-
-void FileBrowserTreeWidget::openContainingFolder(FileItem* item)
-{
-	// Delegate to QDesktopServices::openUrl with the directory of the selected file. Please note that
-	// this will only open the directory but not select the file as this is much more complicated due
-	// to different implementations that are needed for different platforms (Linux/Windows/MacOS).
-
-	// Using QDesktopServices::openUrl seems to be the most simple cross platform way which uses
-	// functionality that's already available in Qt.
-	QFileInfo fileInfo(item->fullName());
-	QDesktopServices::openUrl(QUrl::fromLocalFile(fileInfo.dir().path()));
-}
-
-
-
-
 void FileBrowserTreeWidget::sendToActiveInstrumentTrack( FileItem* item )
 {
 	// get all windows opened in the workspace