feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Utils: Use callbacks when iterating remote file systems

Browse Source 
This will make recursion easier and has the potential to avoid creating
big intermediate lists.

Change-Id: I44d42925dae9c0048338c7d0a6aa26606f314c28
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
This commit is contained in:
hjk
2021-12-14 12:15:40 +01:00
parent 9a28edfd87
commit 7677dc4ba0
11 changed files with 94 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/libs/utils/filepath.cpp
View File

@@ -721,8 +721,11 @@ FilePaths FilePath::dirEntries(const QStringList &nameFilters,
QDir::SortFlags sort) const QDir::SortFlags sort) const
{ {
if (needsDevice()) { if (needsDevice()) {
QTC_ASSERT(s_deviceHooks.dirEntries, return {}); QTC_ASSERT(s_deviceHooks.iterateDirectory, return {});
return s_deviceHooks.dirEntries(*this, nameFilters, filters, sort); FilePaths result;
const auto callBack = [&result](const FilePath &path) { result.append(path); return true; };
s_deviceHooks.iterateDirectory(*this, callBack, nameFilters, filters);
return result;
} }
const QFileInfoList entryInfoList = QDir(m_data).entryInfoList(nameFilters, filters, sort); const QFileInfoList entryInfoList = QDir(m_data).entryInfoList(nameFilters, filters, sort);
@@ -741,10 +744,9 @@ void FilePath::iterateDirectory(const std::function<bool(const FilePath &item)>
QDirIterator::IteratorFlags flags) const QDirIterator::IteratorFlags flags) const
{ {
if (needsDevice()) { if (needsDevice()) {
for (const FilePath &filePath : QTC_ASSERT(s_deviceHooks.iterateDirectory, return);
s_deviceHooks.dirEntries(*this, nameFilters, filters, QDir::NoSort)) s_deviceHooks.iterateDirectory(*this, callBack, nameFilters, filters);
if (!callBack(filePath)) return;
return;
} }
QDirIterator it(m_data, nameFilters, filters, flags); QDirIterator it(m_data, nameFilters, filters, flags);

6
src/libs/utils/fileutils.h
View File

@@ -80,8 +80,10 @@ public:
std::function<FilePath(const FilePath &)> symLinkTarget; std::function<FilePath(const FilePath &)> symLinkTarget;
std::function<FilePath(const FilePath &)> mapToGlobalPath; std::function<FilePath(const FilePath &)> mapToGlobalPath;
std::function<QString(const FilePath &)> mapToDevicePath; std::function<QString(const FilePath &)> mapToDevicePath;
std::function<QList<FilePath>(const FilePath &, const QStringList &, std::function<void(const FilePath &,
QDir::Filters, QDir::SortFlags)> dirEntries; const std::function<bool(const FilePath &)> &, // Abort on 'false' return.
const QStringList &,
QDir::Filters)> iterateDirectory;
std::function<QByteArray(const FilePath &, qint64, qint64)> fileContents; std::function<QByteArray(const FilePath &, qint64, qint64)> fileContents;
std::function<bool(const FilePath &, const QByteArray &)> writeFileContents; std::function<bool(const FilePath &, const QByteArray &)> writeFileContents;
std::function<QDateTime(const FilePath &)> lastModified; std::function<QDateTime(const FilePath &)> lastModified;

12
src/plugins/debugger/debuggeritemmanager.cpp
View File

@@ -32,7 +32,6 @@
#include <extensionsystem/pluginmanager.h> #include <extensionsystem/pluginmanager.h>
#include <projectexplorer/devicesupport/devicemanager.h>
#include <projectexplorer/projectexplorerconstants.h> #include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/projectexplorericons.h> #include <projectexplorer/projectexplorericons.h>
@@ -755,12 +754,9 @@ void DebuggerItemManagerPrivate::autoDetectGdbOrLldbDebuggers(const FilePaths &s
if (searchPaths.isEmpty()) if (searchPaths.isEmpty())
return; return;
IDevice::ConstPtr device = DeviceManager::deviceForPath(searchPaths.front());
QTC_ASSERT(device, return);
FilePaths suspects; FilePaths suspects;
if (device->osType() == OsTypeMac) { if (searchPaths.front().osType() == OsTypeMac) {
QtcProcess proc; QtcProcess proc;
proc.setTimeoutS(2); proc.setTimeoutS(2);
proc.setCommand({"xcrun", {"--find", "lldb"}}); proc.setCommand({"xcrun", {"--find", "lldb"}});
@@ -782,9 +778,9 @@ void DebuggerItemManagerPrivate::autoDetectGdbOrLldbDebuggers(const FilePaths &s
paths = Utils::filteredUnique(paths); paths = Utils::filteredUnique(paths);
for (const FilePath &path : paths) { const auto addSuspect = [&suspects](const FilePath &entry) { suspects.append(entry); return true; };
suspects.append(device->directoryEntries(path, filters, QDir::Files | QDir::Executable)); for (const FilePath &path : paths)
} path.iterateDirectory(addSuspect, filters, QDir::Files | QDir::Executable);
QStringList logMessages{tr("Searching debuggers...")}; QStringList logMessages{tr("Searching debuggers...")};
for (const FilePath &command : qAsConst(suspects)) { for (const FilePath &command : qAsConst(suspects)) {

77
src/plugins/docker/dockerdevice.cpp
View File

@@ -1429,11 +1429,12 @@ bool DockerDevice::setPermissions(const FilePath &filePath, QFileDevice::Permiss
return false; return false;
} }
FilePaths DockerDevice::findFilesWithFind(const FilePath &filePath, void DockerDevice::iterateWithFind(const FilePath &filePath,
const QStringList &nameFilters, const std::function<bool(const Utils::FilePath &)> &callBack,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort) const QDir::Filters filters) const
{ {
QTC_ASSERT(callBack, return);
QTC_CHECK(filePath.isAbsolutePath()); QTC_CHECK(filePath.isAbsolutePath());
QStringList arguments{filePath.path(), "-maxdepth", "1"}; QStringList arguments{filePath.path(), "-maxdepth", "1"};
if (filters & QDir::NoSymLinks) if (filters & QDir::NoSymLinks)
@@ -1481,28 +1482,23 @@ FilePaths DockerDevice::findFilesWithFind(const FilePath &filePath,
if (!output.isEmpty() && !output.startsWith(filePath.path())) { // missing find, unknown option if (!output.isEmpty() && !output.startsWith(filePath.path())) { // missing find, unknown option
LOG("Setting 'do not use find'" << output.left(output.indexOf('\n'))); LOG("Setting 'do not use find'" << output.left(output.indexOf('\n')));
d->m_useFind = false; d->m_useFind = false;
return {}; return;
} }
QStringList entries = output.split("\n", Qt::SkipEmptyParts); const QStringList entries = output.split("\n", Qt::SkipEmptyParts);
if (sort & QDir::Name) for (const QString &entry : entries) {
entries.sort(filters & QDir::CaseSensitive ? Qt::CaseSensitive : Qt::CaseInsensitive); if (entry.startsWith("find: "))
QTC_CHECK(sort == QDir::Name || sort == QDir::NoSort || sort == QDir::Unsorted); continue;
if (!callBack(FilePath::fromString(entry).onDevice(filePath)))
// strip out find messages break;
entries = Utils::filtered(entries, }
[](const QString &entry) { return !entry.startsWith("find: "); });
FilePaths result;
for (const QString &entry : qAsConst(entries))
result.append(FilePath::fromString(entry).onDevice(filePath));
return result;
} }
static FilePaths filterEntriesHelper(const FilePath &base, static void filterEntriesHelper(const FilePath &base,
const QStringList &entries, const std::function<bool(const FilePath &)> &callBack,
const QStringList &nameFilters, const QStringList &entries,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort) QDir::Filters filters)
{ {
const QList<QRegularExpression> nameRegexps = transform(nameFilters, [](const QString &filter) { const QList<QRegularExpression> nameRegexps = transform(nameFilters, [](const QString &filter) {
QRegularExpression re; QRegularExpression re;
@@ -1520,43 +1516,46 @@ static FilePaths filterEntriesHelper(const FilePath &base,
return nameRegexps.isEmpty(); return nameRegexps.isEmpty();
}; };
// FIXME: Handle sort and filters. For now bark on unsupported options. // FIXME: Handle filters. For now bark on unsupported options.
QTC_CHECK(filters == QDir::NoFilter); QTC_CHECK(filters == QDir::NoFilter);
QTC_CHECK(sort == QDir::NoSort);
FilePaths result; FilePaths result;
for (const QString &entry : entries) { for (const QString &entry : entries) {
if (!nameMatches(entry)) if (!nameMatches(entry))
continue; continue;
result.append(base.pathAppended(entry)); if (!callBack(base.pathAppended(entry)))
break;
} }
return result;
} }
FilePaths DockerDevice::directoryEntries(const FilePath &filePath, void DockerDevice::iterateDirectory(const FilePath &filePath,
const QStringList &nameFilters, const std::function<bool(const FilePath &)> &callBack,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort) const QDir::Filters filters) const
{ {
QTC_ASSERT(handlesFile(filePath), return {}); QTC_ASSERT(handlesFile(filePath), return);
tryCreateLocalFileAccess(); tryCreateLocalFileAccess();
if (hasLocalFileAccess()) { if (hasLocalFileAccess()) {
const FilePaths entries = mapToLocalAccess(filePath).dirEntries(nameFilters, filters, sort); const FilePath local = mapToLocalAccess(filePath);
return Utils::transform(entries, [this](const FilePath &entry) { local.iterateDirectory([&callBack, this](const FilePath &entry) {
return mapFromLocalAccess(entry); return callBack(mapFromLocalAccess(entry));
}); },
nameFilters, filters);
return;
} }
if (d->m_useFind) { if (d->m_useFind) {
const FilePaths result = findFilesWithFind(filePath, nameFilters, filters, sort); iterateWithFind(filePath, callBack, nameFilters, filters);
// d->m_useFind will be set to false if 'find' is not found. In this
// case fall back to 'ls' below.
if (d->m_useFind) if (d->m_useFind)
return result; return;
} }
// if we do not have find - use ls as fallback // if we do not have find - use ls as fallback
const QString output = d->outputForRunInShell({"ls", {"-1", "-b", "--", filePath.path()}}); const QString output = d->outputForRunInShell({"ls", {"-1", "-b", "--", filePath.path()}});
QStringList entries = output.split('\n', Qt::SkipEmptyParts); const QStringList entries = output.split('\n', Qt::SkipEmptyParts);
return filterEntriesHelper(filePath, entries, nameFilters, filters, sort); filterEntriesHelper(filePath, callBack, entries, nameFilters, filters);
} }
QByteArray DockerDevice::fileContents(const FilePath &filePath, qint64 limit, qint64 offset) const QByteArray DockerDevice::fileContents(const FilePath &filePath, qint64 limit, qint64 offset) const

16
src/plugins/docker/dockerdevice.h
View File

@@ -94,10 +94,10 @@ public:
bool copyFile(const Utils::FilePath &filePath, const Utils::FilePath &target) const override; bool copyFile(const Utils::FilePath &filePath, const Utils::FilePath &target) const override;
bool renameFile(const Utils::FilePath &filePath, const Utils::FilePath &target) const override; bool renameFile(const Utils::FilePath &filePath, const Utils::FilePath &target) const override;
Utils::FilePath symLinkTarget(const Utils::FilePath &filePath) const override; Utils::FilePath symLinkTarget(const Utils::FilePath &filePath) const override;
QList<Utils::FilePath> directoryEntries(const Utils::FilePath &filePath, void iterateDirectory(const Utils::FilePath &filePath,
const QStringList &nameFilters, const std::function<bool(const Utils::FilePath &)> &callBack,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort) const override; QDir::Filters filters) const override;
QByteArray fileContents(const Utils::FilePath &filePath, qint64 limit, qint64 offset) const override; QByteArray fileContents(const Utils::FilePath &filePath, qint64 limit, qint64 offset) const override;
bool writeFileContents(const Utils::FilePath &filePath, const QByteArray &data) const override; bool writeFileContents(const Utils::FilePath &filePath, const QByteArray &data) const override;
QDateTime lastModified(const Utils::FilePath &filePath) const override; QDateTime lastModified(const Utils::FilePath &filePath) const override;
@@ -124,10 +124,10 @@ protected:
QVariantMap toMap() const final; QVariantMap toMap() const final;
private: private:
Utils::FilePaths findFilesWithFind(const Utils::FilePath &filePath, void iterateWithFind(const Utils::FilePath &filePath,
const QStringList &nameFilters, const std::function<bool(const Utils::FilePath &)> &callBack,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort) const; QDir::Filters filters) const;
void aboutToBeRemoved() const final; void aboutToBeRemoved() const final;

12
src/plugins/projectexplorer/devicesupport/desktopdevice.cpp
View File

@@ -176,15 +176,13 @@ bool DesktopDevice::handlesFile(const FilePath &filePath) const
return !filePath.needsDevice(); return !filePath.needsDevice();
} }
QList<FilePath> DesktopDevice::directoryEntries(const FilePath &filePath, void DesktopDevice::iterateDirectory(const FilePath &filePath,
const QStringList &nameFilters, const std::function<bool(const Utils::FilePath &)> &callBack,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort) const QDir::Filters filters) const
{ {
QTC_CHECK(!filePath.needsDevice()); QTC_CHECK(!filePath.needsDevice());
const QDir dir(filePath.path()); filePath.iterateDirectory(callBack, nameFilters, filters);
const QFileInfoList entryInfoList = dir.entryInfoList(nameFilters, filters, sort);
return Utils::transform(entryInfoList, &FilePath::fromFileInfo);
} }
qint64 DesktopDevice::fileSize(const FilePath &filePath) const qint64 DesktopDevice::fileSize(const FilePath &filePath) const

8
src/plugins/projectexplorer/devicesupport/desktopdevice.h
View File

@@ -56,10 +56,6 @@ public:
QUrl toolControlChannel(const ControlChannelHint &) const override; QUrl toolControlChannel(const ControlChannelHint &) const override;
bool handlesFile(const Utils::FilePath &filePath) const override; bool handlesFile(const Utils::FilePath &filePath) const override;
QList<Utils::FilePath> directoryEntries(const Utils::FilePath &filePath,
const QStringList &nameFilters,
QDir::Filters filters,
QDir::SortFlags sort) const override;
Utils::Environment systemEnvironment() const override; Utils::Environment systemEnvironment() const override;
bool isExecutableFile(const Utils::FilePath &filePath) const override; bool isExecutableFile(const Utils::FilePath &filePath) const override;
bool isReadableFile(const Utils::FilePath &filePath) const override; bool isReadableFile(const Utils::FilePath &filePath) const override;
@@ -77,6 +73,10 @@ public:
bool renameFile(const Utils::FilePath &filePath, const Utils::FilePath &target) const override; bool renameFile(const Utils::FilePath &filePath, const Utils::FilePath &target) const override;
QDateTime lastModified(const Utils::FilePath &filePath) const override; QDateTime lastModified(const Utils::FilePath &filePath) const override;
Utils::FilePath symLinkTarget(const Utils::FilePath &filePath) const override; Utils::FilePath symLinkTarget(const Utils::FilePath &filePath) const override;
void iterateDirectory(const Utils::FilePath &filePath,
const std::function<bool(const Utils::FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const override;
QByteArray fileContents(const Utils::FilePath &filePath, qint64 limit, qint64 offset) const override; QByteArray fileContents(const Utils::FilePath &filePath, qint64 limit, qint64 offset) const override;
bool writeFileContents(const Utils::FilePath &filePath, const QByteArray &data) const override; bool writeFileContents(const Utils::FilePath &filePath, const QByteArray &data) const override;
qint64 fileSize(const Utils::FilePath &filePath) const override; qint64 fileSize(const Utils::FilePath &filePath) const override;

10
src/plugins/projectexplorer/devicesupport/devicemanager.cpp
View File

@@ -496,11 +496,13 @@ DeviceManager::DeviceManager(bool isInstance) : d(std::make_unique<DeviceManager
return device->mapToDevicePath(filePath); return device->mapToDevicePath(filePath);
}; };
deviceHooks.dirEntries = [](const FilePath &filePath, const QStringList &nameFilters, deviceHooks.iterateDirectory = [](const FilePath &filePath,
QDir::Filters filters, QDir::SortFlags sort) { const std::function<bool(const FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) {
auto device = DeviceManager::deviceForPath(filePath); auto device = DeviceManager::deviceForPath(filePath);
QTC_ASSERT(device, return FilePaths()); QTC_ASSERT(device, return);
return device->directoryEntries(filePath, nameFilters, filters, sort); device->iterateDirectory(filePath, callBack, nameFilters, filters);
}; };
deviceHooks.fileContents = [](const FilePath &filePath, qint64 maxSize, qint64 offset) { deviceHooks.fileContents = [](const FilePath &filePath, qint64 maxSize, qint64 offset) {

11
src/plugins/projectexplorer/devicesupport/idevice.cpp
View File

@@ -361,17 +361,16 @@ FilePath IDevice::symLinkTarget(const FilePath &filePath) const
return {}; return {};
} }
QList<FilePath> IDevice::directoryEntries(const FilePath &filePath, void IDevice::iterateDirectory(const FilePath &filePath,
const QStringList &nameFilters, const std::function<bool(const FilePath &)> &callBack,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort) const QDir::Filters filters) const
{ {
Q_UNUSED(filePath); Q_UNUSED(filePath);
Q_UNUSED(callBack);
Q_UNUSED(nameFilters); Q_UNUSED(nameFilters);
Q_UNUSED(filters); Q_UNUSED(filters);
Q_UNUSED(sort);
QTC_CHECK(false); QTC_CHECK(false);
return {};
} }
QByteArray IDevice::fileContents(const FilePath &filePath, qint64 limit, qint64 offset) const QByteArray IDevice::fileContents(const FilePath &filePath, qint64 limit, qint64 offset) const

8
src/plugins/projectexplorer/devicesupport/idevice.h
View File

@@ -259,10 +259,10 @@ public:
virtual Utils::FilePath searchExecutable(const QString &fileName, virtual Utils::FilePath searchExecutable(const QString &fileName,
const QList<Utils::FilePath> &dirs) const; const QList<Utils::FilePath> &dirs) const;
virtual Utils::FilePath symLinkTarget(const Utils::FilePath &filePath) const; virtual Utils::FilePath symLinkTarget(const Utils::FilePath &filePath) const;
virtual QList<Utils::FilePath> directoryEntries(const Utils::FilePath &filePath, virtual void iterateDirectory(const Utils::FilePath &filePath,
const QStringList &nameFilters, const std::function<bool(const Utils::FilePath &)> &callBack,
QDir::Filters filters, const QStringList &nameFilters,
QDir::SortFlags sort = QDir::NoSort) const; QDir::Filters filters) const;
virtual QByteArray fileContents(const Utils::FilePath &filePath, virtual QByteArray fileContents(const Utils::FilePath &filePath,
qint64 limit, qint64 limit,
qint64 offset) const; qint64 offset) const;

16
src/plugins/projectexplorer/gcctoolchain.cpp
View File

@@ -1062,15 +1062,15 @@ static FilePaths findCompilerCandidates(const IDevice::Ptr &device,
FilePaths searchPaths = device->systemEnvironment().path(); FilePaths searchPaths = device->systemEnvironment().path();
for (const FilePath &deviceDir : qAsConst(searchPaths)) { for (const FilePath &deviceDir : qAsConst(searchPaths)) {
static const QRegularExpression regexp(binaryRegexp); static const QRegularExpression regexp(binaryRegexp);
const auto callBack = [&compilerPaths, compilerName](const FilePath &candidate) {
if (candidate.fileName() == compilerName)
compilerPaths << candidate;
else if (regexp.match(candidate.path()).hasMatch())
compilerPaths << candidate;
return true;
};
const FilePath globalDir = device->mapToGlobalPath(deviceDir); const FilePath globalDir = device->mapToGlobalPath(deviceDir);
const FilePaths fileNames = device->directoryEntries(globalDir, nameFilters, device->iterateDirectory(globalDir, callBack, nameFilters, QDir::Files | QDir::Executable);
QDir::Files | QDir::Executable);
for (const FilePath &fileName : fileNames) {
if (fileName.fileName() == compilerName)
compilerPaths << fileName;
else if (regexp.match(fileName.path()).hasMatch())
compilerPaths << fileName;
}
} }
} else { } else {
// The normal, local host case. // The normal, local host case.