Analyze and improve search in File Browser (again)

include/FileBrowser.h

@@ -29,24 +29,16 @@
 #include <QDir>
 #include <QMutex>
 
-#ifdef __MINGW32__
-#include <mingw.condition_variable.h>
-#include <mingw.mutex.h>
-#include <mingw.thread.h>
-#else
-#include <condition_variable>
-#include <mutex>
-#include <thread>
-#endif
+#include "FileBrowserSearcher.h"
+#include <QProgressBar>
 
 #if (QT_VERSION >= QT_VERSION_CHECK(5,14,0))
 	#include <QRecursiveMutex>
 #endif
 #include <QTreeWidget>
 
-
 #include "SideBarWidget.h"
-
+#include "lmmsconfig.h"
 
 class QLineEdit;
 
@@ -83,12 +75,25 @@ class FileBrowser : public SideBarWidget
 
 	~FileBrowser() override = default;
 
-	static QDir::Filters dirFilters();
+	static QStringList directoryBlacklist()
+	{
+		static auto s_blacklist = QStringList{
+#ifdef LMMS_BUILD_LINUX
+			"/bin", "/boot", "/dev", "/etc", "/proc", "/run", "/sbin",
+			"/sys"
+#endif
+#ifdef LMMS_BUILD_WIN32
+			"C:\\Windows"
+#endif
+		};
+		return s_blacklist;
+	}
+	static QDir::Filters dirFilters() { return QDir::AllDirs | QDir::Files | QDir::NoDotAndDotDot; }
+	static QDir::SortFlags sortFlags() { return QDir::LocaleAware | QDir::DirsFirst | QDir::Name | QDir::IgnoreCase; }
 
 private slots:
 	void reloadTree();
 	void expandItems( QTreeWidgetItem * item=nullptr, QList<QString> expandedDirs = QList<QString>() );
-	bool filterAndExpandItems(const QString & filter, QTreeWidgetItem * item = nullptr);
 	void giveFocusToFilter();
 
 private:
@@ -99,7 +104,7 @@ private slots:
 	void saveDirectoriesStates();
 	void restoreDirectoriesStates();
 
-	void buildSearchTree(QStringList matches, QString id);
+	void buildSearchTree();
 	void onSearch(const QString& filter);
 	void toggleSearch(bool on);
 
@@ -108,6 +113,9 @@ private slots:
 
 	QLineEdit * m_filterEdit;
 
+	std::shared_ptr<FileBrowserSearcher::SearchFuture> m_currentSearch;
+	QProgressBar* m_searchIndicator = nullptr;
+
 	QString m_directories; //!< Directories to search, split with '*'
 	QString m_filter; //!< Filter as used in QDir::match()
 
@@ -183,54 +191,12 @@ private slots:
 
 } ;
 
-class FileBrowserSearcher : public QObject
-{
-	Q_OBJECT
-public:
-	struct SearchTask
-	{
-		QString directories;
-		QString userFilter;
-		QDir::Filters dirFilters;
-		QStringList nameFilters;
-		QString id;
-	};
-
-	FileBrowserSearcher();
-	~FileBrowserSearcher() noexcept override;
-
-	void search(SearchTask task);
-	void cancel();
-
-	bool inHiddenDirectory(const QString& path);
-
-	static FileBrowserSearcher* instance();
-
-signals:
-	void searchComplete(QStringList matches, QString id);
-
-private:
-	void run();
-	void filter();
-	SearchTask m_currentTask;
-	std::thread m_worker;
-	std::mutex m_runMutex;
-	std::mutex m_cancelMutex;
-	std::condition_variable m_runCond;
-	std::atomic<bool> m_cancel = false;
-	bool m_stopped = false;
-	bool m_run = false;
-	inline static std::unique_ptr<FileBrowserSearcher> s_instance = nullptr;
-};
-
-
 
 
 class Directory : public QTreeWidgetItem
 {
 public:
-	Directory( const QString & filename, const QString & path,
-						const QString & filter );
+	Directory(const QString& filename, const QString& path, const QString& filter, bool disableEntryPopulation = false);
 
 	void update();
 
@@ -275,7 +241,7 @@ class Directory : public QTreeWidgetItem
 	QString m_filter;
 
 	int m_dirCount;
-
+	bool m_disableEntryPopulation = false;
 } ;
 
 

include/FileBrowserSearcher.h

@@ -0,0 +1,148 @@
+/*
+ * FileBrowserSearcher.h - Batch processor for searching the filesystem
+ *
+ * Copyright (c) 2023 saker <[email protected]>
+ *
+ * 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_BROWSER_SEARCHER_H
+#define LMMS_FILE_BROWSER_SEARCHER_H
+
+#include <QHash>
+#include <QString>
+#include <QStringList>
+#include <optional>
+#include <queue>
+
+#ifdef __MINGW32__
+#include <mingw.condition_variable.h>
+#include <mingw.mutex.h>
+#include <mingw.thread.h>
+#else
+#include <condition_variable>
+#include <mutex>
+#include <thread>
+#endif
+
+namespace lmms::gui {
+
+//! An active object that handles searching for files that match a certain filter across the file system.
+class FileBrowserSearcher
+{
+public:
+	//! Number of milliseconds to wait for before a match should be processed by the user.
+	static constexpr int MillisecondsPerMatch = 1;
+
+	//! The future object for FileBrowserSearcher. It is used to track the current state of search operations, as
+	// well as retrieve matches.
+	class SearchFuture
+	{
+	public:
+		//! Possible state values of the future object.
+		enum class State
+		{
+			Idle,
+			Running,
+			Cancelled,
+			Completed
+		};
+
+		//! Constructs a future object using the specified filter, paths, and valid file extensions in the Idle state.
+		SearchFuture(const QString& filter, const QStringList& paths, const QStringList& extensions)
+			: m_filter(filter)
+			, m_paths(paths)
+			, m_extensions(extensions)
+		{
+		}
+
+		//! Retrieves a match from the match list.
+		auto match() -> QString
+		{
+			const auto lock = std::lock_guard{m_matchesMutex};
+			return m_matches.empty() ? QString{} : m_matches.takeFirst();
+		}
+
+		//! Returns the current state of this future object.
+		auto state() -> State { return m_state; }
+
+		//! Returns the filter used.
+		auto filter() -> const QString& { return m_filter; }
+
+		//! Returns the paths to filter.
+		auto paths() -> const QStringList& { return m_paths; }
+
+		//! Returns the valid file extensions.
+		auto extensions() -> const QStringList& { return m_extensions; }
+
+	private:
+		//! Adds a match to the match list.
+		auto addMatch(const QString& match) -> void
+		{
+			const auto lock = std::lock_guard{m_matchesMutex};
+			m_matches.append(match);
+		}
+
+		QString m_filter;
+		QStringList m_paths;
+		QStringList m_extensions;
+
+		QStringList m_matches;
+		std::mutex m_matchesMutex;
+
+		std::atomic<State> m_state = State::Idle;
+
+		friend FileBrowserSearcher;
+	};
+
+	~FileBrowserSearcher();
+
+	//! Enqueues a search to be ran by the worker thread.
+	//! Returns a future that the caller can use to track state and results of the operation.
+	auto search(const QString& filter, const QStringList& paths, const QStringList& extensions)
+		-> std::shared_ptr<SearchFuture>;
+
+	//! Sends a signal to cancel a running search.
+	auto cancel() -> void { m_cancelRunningSearch = true; }
+
+	//! Returns the global instance of the searcher object.
+	static auto instance() -> FileBrowserSearcher*
+	{
+		static auto s_instance = FileBrowserSearcher{};
+		return &s_instance;
+	}
+
+private:
+	//! Event loop for the worker thread.
+	auto run() -> void;
+
+	//! Using Depth-first search (DFS), filters the specified path and adds any matches to the future list.
+	auto process(SearchFuture* searchFuture, const QString& path) -> bool;
+
+	std::queue<std::shared_ptr<SearchFuture>> m_searchQueue;
+	std::atomic<bool> m_cancelRunningSearch = false;
+
+	bool m_workerStopped = false;
+	std::mutex m_workerMutex;
+	std::condition_variable m_workerCond;
+	std::thread m_worker{[this] { run(); }};
+};
+} // namespace lmms::gui
+
+#endif // LMMS_FILE_BROWSER_SEARCHER_H

src/gui/CMakeLists.txt

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