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

Utils: Make validation async

Browse Source 
Changes FancyLineEdit to accept two types of validation functions:

AsyncValidationFunction, which returns a QFuture and takes the new text,
or SynchronousValidationFunction.

Especially PathChooser is changed to use async validation function to
improve snappyness of settings pages that do heavy validation,
for instance the Debugger page.

Change-Id: I1677e7d8acc29e36c69a867850304b7913e6ae7e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Marcus Tillmanns
2023-06-29 08:23:45 +02:00
parent 569e73c5ed
commit 83111bb3f6
15 changed files with 350 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
src/libs/utils/pathchooser.cpp
View File

@@ -3,6 +3,7 @@
#include "pathchooser.h"
#include "async.h"
#include "commandline.h"
#include "environment.h"
#include "fileutils.h"
@@ -15,6 +16,7 @@
#include "utilstr.h"
#include <QFileDialog>
#include <QFuture>
#include <QGuiApplication>
#include <QHBoxLayout>
#include <QMenu>
@@ -531,100 +533,73 @@ void PathChooser::setToolTip(const QString &toolTip)
d->m_lineEdit->setToolTip(toolTip);
}
FancyLineEdit::ValidationFunction PathChooser::defaultValidationFunction() const
static FancyLineEdit::AsyncValidationResult validatePath(FilePath filePath,
const QString &defaultValue,
PathChooser::Kind kind)
{
return std::bind(&PathChooser::validatePath, this, std::placeholders::_1, std::placeholders::_2);
}
bool PathChooser::validatePath(FancyLineEdit *edit, QString *errorMessage) const
{
QString input = edit->text();
if (input.isEmpty()) {
if (!d->m_defaultValue.isEmpty()) {
input = d->m_defaultValue;
} else {
if (errorMessage)
*errorMessage = Tr::tr("The path must not be empty.");
return false;
}
}
const FilePath filePath = d->expandedPath(FilePath::fromUserInput(input));
if (filePath.isEmpty()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" expanded to an empty string.").arg(input);
return false;
if (!defaultValue.isEmpty()) {
filePath = FilePath::fromUserInput(defaultValue);
} else {
return make_unexpected(Tr::tr("The path must not be empty."));
}
}
// Check if existing
switch (d->m_acceptingKind) {
switch (kind) {
case PathChooser::ExistingDirectory:
if (!filePath.exists()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" does not exist.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" does not exist.").arg(filePath.toUserOutput()));
}
if (!filePath.isDir()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" is not a directory.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" is not a directory.").arg(filePath.toUserOutput()));
}
break;
case PathChooser::File:
if (!filePath.exists()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" does not exist.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" does not exist.").arg(filePath.toUserOutput()));
}
if (!filePath.isFile()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" is not a file.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" is not a file.").arg(filePath.toUserOutput()));
}
break;
case PathChooser::SaveFile:
if (!filePath.parentDir().exists()) {
if (errorMessage)
*errorMessage = Tr::tr("The directory \"%1\" does not exist.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The directory \"%1\" does not exist.").arg(filePath.toUserOutput()));
}
if (filePath.exists() && filePath.isDir()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" is not a file.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" is not a file.").arg(filePath.toUserOutput()));
}
break;
case PathChooser::ExistingCommand:
if (!filePath.exists()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" does not exist.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" does not exist.").arg(filePath.toUserOutput()));
}
if (!filePath.isExecutableFile()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" is not an executable file.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" is not an executable file.").arg(filePath.toUserOutput()));
}
break;
case PathChooser::Directory:
if (filePath.exists() && !filePath.isDir()) {
if (errorMessage)
*errorMessage = Tr::tr("The path \"%1\" is not a directory.").arg(filePath.toUserOutput());
return false;
return make_unexpected(
Tr::tr("The path \"%1\" is not a directory.").arg(filePath.toUserOutput()));
}
if (filePath.osType() == OsTypeWindows && !filePath.startsWithDriveLetter()
&& !filePath.startsWith("\\\\") && !filePath.startsWith("//")) {
if (errorMessage)
*errorMessage = Tr::tr("Invalid path \"%1\".").arg(filePath.toUserOutput());
return false;
return make_unexpected(Tr::tr("Invalid path \"%1\".").arg(filePath.toUserOutput()));
}
break;
case PathChooser::Command:
if (filePath.exists() && !filePath.isExecutableFile()) {
if (errorMessage)
*errorMessage = Tr::tr("Cannot execute \"%1\".").arg(filePath.toUserOutput());
return false;
return make_unexpected(Tr::tr("Cannot execute \"%1\".").arg(filePath.toUserOutput()));
}
break;
@@ -632,9 +607,34 @@ bool PathChooser::validatePath(FancyLineEdit *edit, QString *errorMessage) const
;
}
if (errorMessage)
*errorMessage = Tr::tr("Full path: \"%1\"").arg(filePath.toUserOutput());
return true;
return filePath.toUserOutput();
}
FancyLineEdit::AsyncValidationFunction PathChooser::defaultValidationFunction() const
{
return [this](const QString &text) -> FancyLineEdit::AsyncValidationFuture {
if (text.isEmpty()) {
return QtFuture::makeReadyFuture((Utils::expected_str<QString>(
make_unexpected(Tr::tr("The path must not be empty.")))));
}
const FilePath expanded = d->expandedPath(FilePath::fromUserInput(text));
if (expanded.isEmpty()) {
return QtFuture::makeReadyFuture((Utils::expected_str<QString>(
make_unexpected(Tr::tr("The path \"%1\" expanded to an empty string.")
.arg(expanded.toUserOutput())))));
}
return Utils::asyncRun(
[expanded,
defVal = d->m_defaultValue,
kind = d->m_acceptingKind,
env = d->m_environment,
baseDirectory = d->m_baseDirectory]() -> FancyLineEdit::AsyncValidationResult {
return validatePath(expanded, defVal, kind);
});
};
}
void PathChooser::setValidationFunction(const FancyLineEdit::ValidationFunction &fn)