Utils: Add optional recursion for file system iteration

Change-Id: Icded897b129aebd7132376cff55717e16dffc040
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
hjk
2021-12-14 18:04:41 +01:00
parent 5cfe69b049
commit f9c97d23c7
17 changed files with 70 additions and 30 deletions

View File

@@ -90,6 +90,7 @@ static FilePath findQmakeInDir(const FilePath &dir)
const FilePaths candidates = dir.dirEntries(
BuildableHelperLibrary::possibleQMakeCommands(),
QDir::Files,
QDirIterator::NoIteratorFlags,
QDir::Name | QDir::Reversed);
for (const FilePath &candidate : candidates) {
if (candidate == qmakePath)

View File

@@ -37,6 +37,7 @@
#include <QDataStream>
#include <QDateTime>
#include <QDebug>
#include <QDirIterator>
#include <QFileInfo>
#include <QOperatingSystemVersion>
#include <QRegularExpression>
@@ -719,26 +720,41 @@ bool FilePath::createDir() const
FilePaths FilePath::dirEntries(const QStringList &nameFilters,
QDir::Filters filters,
QDirIterator::IteratorFlags flags,
QDir::SortFlags sort) const
{
FilePaths result;
if (needsDevice()) {
QTC_ASSERT(s_deviceHooks.iterateDirectory, return {});
FilePaths result;
const auto callBack = [&result](const FilePath &path) { result.append(path); return true; };
s_deviceHooks.iterateDirectory(*this, callBack, nameFilters, filters);
return result;
s_deviceHooks.iterateDirectory(*this, callBack, nameFilters, filters, flags);
} else {
QDirIterator dit(m_data, nameFilters, filters, flags);
while (dit.hasNext())
result.append(FilePath::fromString(dit.next()));
}
const QFileInfoList entryInfoList = QDir(m_data).entryInfoList(nameFilters, filters, sort);
return Utils::transform(entryInfoList, &FilePath::fromFileInfo);
// FIXME: Not all flags supported here.
if ((sort & QDir::SortByMask) == QDir::Name)
Utils::sort(result);
if (sort & QDir::Reversed)
std::reverse(result.begin(), result.end());
return result;
}
QList<FilePath> FilePath::dirEntries(QDir::Filters filters) const
FilePaths FilePath::dirEntries(QDir::Filters filters) const
{
return dirEntries({}, filters);
}
// This runs \a callBack on each directory entry matching all \a filters and
// either of the specified \a nameFilters.
// An empty \nameFilters list matches every name.
void FilePath::iterateDirectory(const std::function<bool(const FilePath &item)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters,
@@ -746,14 +762,15 @@ void FilePath::iterateDirectory(const std::function<bool(const FilePath &item)>
{
if (needsDevice()) {
QTC_ASSERT(s_deviceHooks.iterateDirectory, return);
s_deviceHooks.iterateDirectory(*this, callBack, nameFilters, filters);
s_deviceHooks.iterateDirectory(*this, callBack, nameFilters, filters, flags);
return;
}
QDirIterator it(m_data, nameFilters, filters, flags);
while (it.hasNext())
while (it.hasNext()) {
if (!callBack(FilePath::fromString(it.next())))
return;
}
}
QByteArray FilePath::fileContents(qint64 maxSize, qint64 offset) const

View File

@@ -123,6 +123,7 @@ public:
bool createDir() const;
QList<FilePath> dirEntries(const QStringList &nameFilters,
QDir::Filters filters = QDir::NoFilter,
QDirIterator::IteratorFlags flags = QDirIterator::NoIteratorFlags,
QDir::SortFlags sort = QDir::NoSort) const;
QList<FilePath> dirEntries(QDir::Filters filters) const;
QByteArray fileContents(qint64 maxSize = -1, qint64 offset = 0) const;

View File

@@ -83,7 +83,8 @@ public:
std::function<void(const FilePath &,
const std::function<bool(const FilePath &)> &, // Abort on 'false' return.
const QStringList &,
QDir::Filters)> iterateDirectory;
QDir::Filters,
QDirIterator::IteratorFlags)> iterateDirectory;
std::function<QByteArray(const FilePath &, qint64, qint64)> fileContents;
std::function<bool(const FilePath &, const QByteArray &)> writeFileContents;
std::function<QDateTime(const FilePath &)> lastModified;

View File

@@ -948,7 +948,10 @@ FilePath FileApiParser::scanForCMakeReplyFile(const FilePath &buildDirectory)
if (!replyDir.exists())
return {};
const FilePaths entries = replyDir.dirEntries({"index-*.json"}, QDir::Files, QDir::Name);
const FilePaths entries = replyDir.dirEntries({"index-*.json"},
QDir::Files,
QDirIterator::NoIteratorFlags,
QDir::Name);
return entries.isEmpty() ? FilePath() : entries.first();
}

View File

@@ -1547,8 +1547,11 @@ static void filterEntriesHelper(const FilePath &base,
void DockerDevice::iterateDirectory(const FilePath &filePath,
const std::function<bool(const FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const
QDir::Filters filters,
QDirIterator::IteratorFlags flags) const
{
Q_UNUSED(flags) // FIXME: Use it.
QTC_ASSERT(handlesFile(filePath), return);
updateContainerAccess();
if (hasLocalFileAccess()) {

View File

@@ -97,7 +97,8 @@ public:
void iterateDirectory(const Utils::FilePath &filePath,
const std::function<bool(const Utils::FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const override;
QDir::Filters filters,
QDirIterator::IteratorFlags flags = QDirIterator::NoIteratorFlags) 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;
QDateTime lastModified(const Utils::FilePath &filePath) const override;

View File

@@ -304,7 +304,8 @@ static McuPackage *createCypressProgrammerPackage()
const FilePath candidate = findInProgramFiles("Cypress");
if (candidate.exists()) {
// "Cypress Auto Flash Utility 1.0"
const auto subDirs = candidate.dirEntries({"Cypress Auto Flash Utility*"}, QDir::Dirs, QDir::Unsorted);
const auto subDirs = candidate.dirEntries({"Cypress Auto Flash Utility*"},
QDir::Dirs, QDirIterator::NoIteratorFlags, QDir::Unsorted);
if (!subDirs.empty())
defaultPath = subDirs.first();
}
@@ -330,7 +331,8 @@ static McuPackage *createRenesasProgrammerPackage()
const FilePath candidate = findInProgramFiles("Renesas Electronics/Programming Tools");
if (candidate.exists()) {
// "Renesas Flash Programmer V3.09"
const auto subDirs = candidate.dirEntries({"Renesas Flash Programmer*"}, QDir::Dirs, QDir::Unsorted);
const auto subDirs = candidate.dirEntries({"Renesas Flash Programmer*"},
QDir::Dirs, QDirIterator::NoIteratorFlags, QDir::Unsorted);
if (!subDirs.empty())
defaultPath = subDirs.first();
}

View File

@@ -179,10 +179,11 @@ bool DesktopDevice::handlesFile(const FilePath &filePath) const
void DesktopDevice::iterateDirectory(const FilePath &filePath,
const std::function<bool(const Utils::FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const
QDir::Filters filters,
QDirIterator::IteratorFlags flags) const
{
QTC_CHECK(!filePath.needsDevice());
filePath.iterateDirectory(callBack, nameFilters, filters);
filePath.iterateDirectory(callBack, nameFilters, filters, flags);
}
qint64 DesktopDevice::fileSize(const FilePath &filePath) const

View File

@@ -76,7 +76,8 @@ public:
void iterateDirectory(const Utils::FilePath &filePath,
const std::function<bool(const Utils::FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const override;
QDir::Filters filters,
QDirIterator::IteratorFlags flags) 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;
qint64 fileSize(const Utils::FilePath &filePath) const override;

View File

@@ -525,10 +525,11 @@ DeviceManager::DeviceManager(bool isInstance) : d(std::make_unique<DeviceManager
deviceHooks.iterateDirectory = [](const FilePath &filePath,
const std::function<bool(const FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) {
QDir::Filters filters,
QDirIterator::IteratorFlags flags) {
auto device = DeviceManager::deviceForPath(filePath);
QTC_ASSERT(device, return);
device->iterateDirectory(filePath, callBack, nameFilters, filters);
device->iterateDirectory(filePath, callBack, nameFilters, filters, flags);
};
deviceHooks.fileContents = [](const FilePath &filePath, qint64 maxSize, qint64 offset) {

View File

@@ -364,12 +364,14 @@ FilePath IDevice::symLinkTarget(const FilePath &filePath) const
void IDevice::iterateDirectory(const FilePath &filePath,
const std::function<bool(const FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const
QDir::Filters filters,
QDirIterator::IteratorFlags flags) const
{
Q_UNUSED(filePath);
Q_UNUSED(callBack);
Q_UNUSED(nameFilters);
Q_UNUSED(filters);
Q_UNUSED(flags);
QTC_CHECK(false);
}

View File

@@ -262,7 +262,8 @@ public:
virtual void iterateDirectory(const Utils::FilePath &filePath,
const std::function<bool(const Utils::FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const;
QDir::Filters filters,
QDirIterator::IteratorFlags flags = QDirIterator::NoIteratorFlags) const;
virtual QByteArray fileContents(const Utils::FilePath &filePath,
qint64 limit,
qint64 offset) const;

View File

@@ -425,7 +425,8 @@ QList<Core::IWizardFactory *> JsonWizardFactory::createWizardFactories()
const QDir::Filters filters = QDir::Dirs|QDir::Readable|QDir::NoDotAndDotDot;
const QDir::SortFlags sortflags = QDir::Name|QDir::IgnoreCase;
FilePaths dirs = path.dirEntries({}, filters, sortflags);
const QDirIterator::IteratorFlag iteratorFlags = QDirIterator::NoIteratorFlags;
FilePaths dirs = path.dirEntries({}, filters, iteratorFlags, sortflags);
while (!dirs.isEmpty()) {
const FilePath currentDir = dirs.takeFirst();
@@ -482,7 +483,7 @@ QList<Core::IWizardFactory *> JsonWizardFactory::createWizardFactories()
result << factory;
} else {
FilePaths subDirs = currentDir.dirEntries({}, filters, sortflags);
FilePaths subDirs = currentDir.dirEntries({}, filters, iteratorFlags, sortflags);
if (!subDirs.isEmpty()) {
// There is no QList::prepend(QList)...
dirs.swap(subDirs);

View File

@@ -791,8 +791,8 @@ QStringList SessionManager::sessions()
{
if (d->m_sessions.isEmpty()) {
// We are not initialized yet, so do that now
const FilePaths sessionFiles =
ICore::userResourcePath().dirEntries({"*.qws"}, QDir::NoFilter, QDir::Time);
const FilePaths sessionFiles = ICore::userResourcePath().dirEntries({"*.qws"},
QDir::NoFilter, QDirIterator::NoIteratorFlags, QDir::Time);
for (const FilePath &file : sessionFiles) {
const QString &name = file.completeBaseName();
d->m_sessionDateTimes.insert(name, file.lastModified());

View File

@@ -677,7 +677,8 @@ static void filterEntriesHelper(const FilePath &base,
const std::function<bool(const FilePath &)> &callBack,
const QStringList &entries,
const QStringList &nameFilters,
QDir::Filters filters)
QDir::Filters filters,
QDirIterator::IteratorFlags flags)
{
const QList<QRegularExpression> nameRegexps = transform(nameFilters, [](const QString &filter) {
QRegularExpression re;
@@ -697,6 +698,7 @@ static void filterEntriesHelper(const FilePath &base,
// FIXME: Handle filters. For now bark on unsupported options.
QTC_CHECK(filters == QDir::NoFilter);
QTC_CHECK(flags == QDirIterator::NoIteratorFlags);
for (const QString &entry : entries) {
if (!nameMatches(entry))
@@ -709,13 +711,14 @@ static void filterEntriesHelper(const FilePath &base,
void LinuxDevice::iterateDirectory(const FilePath &filePath,
const std::function<bool(const FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const
QDir::Filters filters,
QDirIterator::IteratorFlags flags) const
{
QTC_ASSERT(handlesFile(filePath), return);
// if we do not have find - use ls as fallback
const QString output = d->outputForRunInShell({"ls", {"-1", "-b", "--", filePath.path()}});
const QStringList entries = output.split('\n', Qt::SkipEmptyParts);
filterEntriesHelper(filePath, callBack, entries, nameFilters, filters);
filterEntriesHelper(filePath, callBack, entries, nameFilters, filters, flags);
}
QByteArray LinuxDevice::fileContents(const FilePath &filePath, qint64 limit, qint64 offset) const

View File

@@ -79,7 +79,8 @@ public:
void iterateDirectory(const Utils::FilePath &filePath,
const std::function<bool(const Utils::FilePath &)> &callBack,
const QStringList &nameFilters,
QDir::Filters filters) const override;
QDir::Filters filters,
QDirIterator::IteratorFlags flags) 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;
QDateTime lastModified(const Utils::FilePath &filePath) const override;