aboutsummaryrefslogtreecommitdiff
path: root/launcher/tasks
diff options
context:
space:
mode:
Diffstat (limited to 'launcher/tasks')
-rw-r--r--launcher/tasks/ConcurrentTask.cpp39
-rw-r--r--launcher/tasks/ConcurrentTask.h4
-rw-r--r--launcher/tasks/MultipleOptionsTask.cpp41
-rw-r--r--launcher/tasks/MultipleOptionsTask.h14
-rw-r--r--launcher/tasks/SequentialTask.cpp102
-rw-r--r--launcher/tasks/SequentialTask.h60
-rw-r--r--launcher/tasks/Task.cpp24
-rw-r--r--launcher/tasks/Task.h12
-rw-r--r--launcher/tasks/Task_test.cpp67
9 files changed, 92 insertions, 271 deletions
diff --git a/launcher/tasks/ConcurrentTask.cpp b/launcher/tasks/ConcurrentTask.cpp
index b88cfb13..ce08a6a2 100644
--- a/launcher/tasks/ConcurrentTask.cpp
+++ b/launcher/tasks/ConcurrentTask.cpp
@@ -1,10 +1,11 @@
#include "ConcurrentTask.h"
#include <QDebug>
+#include <QCoreApplication>
ConcurrentTask::ConcurrentTask(QObject* parent, QString task_name, int max_concurrent)
: Task(parent), m_name(task_name), m_total_max_size(max_concurrent)
-{}
+{ setObjectName(task_name); }
ConcurrentTask::~ConcurrentTask()
{
@@ -36,31 +37,40 @@ void ConcurrentTask::executeTask()
{
m_total_size = m_queue.size();
- for (int i = 0; i < m_total_max_size; i++)
- startNext();
+ // Start the least amount of tasks needed, but at least one
+ int num_starts = std::max(1, std::min(m_total_max_size, m_total_size));
+ for (int i = 0; i < num_starts; i++) {
+ QMetaObject::invokeMethod(this, &ConcurrentTask::startNext, Qt::QueuedConnection);
+ }
}
bool ConcurrentTask::abort()
{
+ m_queue.clear();
+ m_aborted = true;
+
if (m_doing.isEmpty()) {
// Don't call emitAborted() here, we want to bypass the 'is the task running' check
emit aborted();
emit finished();
- m_aborted = true;
return true;
}
- m_queue.clear();
+ bool suceedeed = true;
- m_aborted = true;
- for (auto task : m_doing)
- m_aborted &= task->abort();
+ QMutableHashIterator<Task*, Task::Ptr> doing_iter(m_doing);
+ while (doing_iter.hasNext()) {
+ auto task = doing_iter.next();
+ suceedeed &= (task.value())->abort();
+ }
- if (m_aborted)
+ if (suceedeed)
emitAborted();
+ else
+ emitFailed(tr("Failed to abort all running tasks."));
- return m_aborted;
+ return suceedeed;
}
void ConcurrentTask::startNext()
@@ -68,7 +78,7 @@ void ConcurrentTask::startNext()
if (m_aborted || m_doing.count() > m_total_max_size)
return;
- if (m_queue.isEmpty() && m_doing.isEmpty()) {
+ if (m_queue.isEmpty() && m_doing.isEmpty() && !wasSuccessful()) {
emitSucceeded();
return;
}
@@ -91,6 +101,8 @@ void ConcurrentTask::startNext()
setStepStatus(next->isMultiStep() ? next->getStepStatus() : next->getStatus());
updateState();
+ QCoreApplication::processEvents();
+
next->start();
}
@@ -127,11 +139,6 @@ void ConcurrentTask::subTaskStatus(const QString& msg)
void ConcurrentTask::subTaskProgress(qint64 current, qint64 total)
{
- if (total == 0) {
- setProgress(0, 100);
- return;
- }
-
m_stepProgress = current;
m_stepTotalProgress = total;
}
diff --git a/launcher/tasks/ConcurrentTask.h b/launcher/tasks/ConcurrentTask.h
index 5898899d..f1279d32 100644
--- a/launcher/tasks/ConcurrentTask.h
+++ b/launcher/tasks/ConcurrentTask.h
@@ -9,7 +9,9 @@ class ConcurrentTask : public Task {
Q_OBJECT
public:
explicit ConcurrentTask(QObject* parent = nullptr, QString task_name = "", int max_concurrent = 6);
- virtual ~ConcurrentTask();
+ ~ConcurrentTask() override;
+
+ bool canAbort() const override { return true; }
inline auto isMultiStep() const -> bool override { return m_queue.size() > 1; };
auto getStepProgress() const -> qint64 override;
diff --git a/launcher/tasks/MultipleOptionsTask.cpp b/launcher/tasks/MultipleOptionsTask.cpp
index 6e853568..5ad6181f 100644
--- a/launcher/tasks/MultipleOptionsTask.cpp
+++ b/launcher/tasks/MultipleOptionsTask.cpp
@@ -6,43 +6,22 @@ MultipleOptionsTask::MultipleOptionsTask(QObject* parent, const QString& task_na
void MultipleOptionsTask::startNext()
{
- Task* previous = nullptr;
- if (m_currentIndex != -1) {
- previous = m_queue[m_currentIndex].get();
- disconnect(previous, 0, this, 0);
- }
-
- m_currentIndex++;
- if ((previous && previous->wasSuccessful())) {
+ if (m_done.size() != m_failed.size()) {
emitSucceeded();
return;
}
- Task::Ptr next = m_queue[m_currentIndex];
-
- connect(next.get(), &Task::failed, this, &MultipleOptionsTask::subTaskFailed);
- connect(next.get(), &Task::succeeded, this, &MultipleOptionsTask::startNext);
-
- connect(next.get(), &Task::status, this, &MultipleOptionsTask::subTaskStatus);
- connect(next.get(), &Task::stepStatus, this, &MultipleOptionsTask::subTaskStatus);
-
- connect(next.get(), &Task::progress, this, &MultipleOptionsTask::subTaskProgress);
-
- qDebug() << QString("Making attemp %1 out of %2").arg(m_currentIndex + 1).arg(m_queue.size());
- setStatus(tr("Making attempt #%1 out of %2").arg(m_currentIndex + 1).arg(m_queue.size()));
- setStepStatus(next->isMultiStep() ? next->getStepStatus() : next->getStatus());
+ if (m_queue.isEmpty()) {
+ emitFailed(tr("All attempts have failed!"));
+ qWarning() << "All attempts have failed!";
+ return;
+ }
- next->start();
+ ConcurrentTask::startNext();
}
-void MultipleOptionsTask::subTaskFailed(QString const& reason)
+void MultipleOptionsTask::updateState()
{
- qDebug() << QString("Failed attempt #%1 of %2. Reason: %3").arg(m_currentIndex + 1).arg(m_queue.size()).arg(reason);
- if(m_currentIndex < m_queue.size() - 1) {
- startNext();
- return;
- }
-
- qWarning() << QString("All attempts have failed!");
- emitFailed();
+ setProgress(m_done.count(), m_total_size);
+ setStatus(tr("Attempting task %1 out of %2").arg(QString::number(m_doing.count() + m_done.count()), QString::number(m_total_size)));
}
diff --git a/launcher/tasks/MultipleOptionsTask.h b/launcher/tasks/MultipleOptionsTask.h
index 7c508b00..db7d4d9a 100644
--- a/launcher/tasks/MultipleOptionsTask.h
+++ b/launcher/tasks/MultipleOptionsTask.h
@@ -5,15 +5,13 @@
/* This task type will attempt to do run each of it's subtasks in sequence,
* until one of them succeeds. When that happens, the remaining tasks will not run.
* */
-class MultipleOptionsTask : public SequentialTask
-{
+class MultipleOptionsTask : public SequentialTask {
Q_OBJECT
-public:
- explicit MultipleOptionsTask(QObject *parent = nullptr, const QString& task_name = "");
- virtual ~MultipleOptionsTask() = default;
+ public:
+ explicit MultipleOptionsTask(QObject* parent = nullptr, const QString& task_name = "");
+ ~MultipleOptionsTask() override = default;
-private
-slots:
+ private slots:
void startNext() override;
- void subTaskFailed(const QString &msg) override;
+ void updateState() override;
};
diff --git a/launcher/tasks/SequentialTask.cpp b/launcher/tasks/SequentialTask.cpp
index f1e1a889..a34137cb 100644
--- a/launcher/tasks/SequentialTask.cpp
+++ b/launcher/tasks/SequentialTask.cpp
@@ -2,107 +2,21 @@
#include <QDebug>
-SequentialTask::SequentialTask(QObject* parent, const QString& task_name) : Task(parent), m_name(task_name), m_currentIndex(-1) {}
-
-SequentialTask::~SequentialTask()
-{
- for(auto task : m_queue){
- if(task)
- task->deleteLater();
- }
-}
-
-auto SequentialTask::getStepProgress() const -> qint64
-{
- return m_stepProgress;
-}
-
-auto SequentialTask::getStepTotalProgress() const -> qint64
-{
- return m_stepTotalProgress;
-}
-
-void SequentialTask::addTask(Task::Ptr task)
-{
- m_queue.append(task);
-}
-
-void SequentialTask::executeTask()
-{
- m_currentIndex = -1;
- startNext();
-}
-
-bool SequentialTask::abort()
-{
- if(m_currentIndex == -1 || m_currentIndex >= m_queue.size()) {
- if(m_currentIndex == -1) {
- // Don't call emitAborted() here, we want to bypass the 'is the task running' check
- emit aborted();
- emit finished();
- }
-
- m_aborted = true;
- return true;
- }
-
- bool succeeded = m_queue[m_currentIndex]->abort();
- m_aborted = succeeded;
-
- if (succeeded)
- emitAborted();
-
- return succeeded;
-}
+SequentialTask::SequentialTask(QObject* parent, QString task_name) : ConcurrentTask(parent, task_name, 1) {}
void SequentialTask::startNext()
{
- if (m_aborted)
- return;
-
- if (m_currentIndex != -1 && m_currentIndex < m_queue.size()) {
- Task::Ptr previous = m_queue.at(m_currentIndex);
- disconnect(previous.get(), 0, this, 0);
- }
-
- m_currentIndex++;
- if (m_queue.isEmpty() || m_currentIndex >= m_queue.size()) {
- emitSucceeded();
+ if (m_failed.size() > 0) {
+ emitFailed(tr("One of the tasks failed!"));
+ qWarning() << m_failed.constBegin()->get()->failReason();
return;
}
- Task::Ptr next = m_queue[m_currentIndex];
-
- connect(next.get(), SIGNAL(failed(QString)), this, SLOT(subTaskFailed(QString)));
- connect(next.get(), SIGNAL(succeeded()), this, SLOT(startNext()));
-
- connect(next.get(), SIGNAL(status(QString)), this, SLOT(subTaskStatus(QString)));
- connect(next.get(), SIGNAL(stepStatus(QString)), this, SLOT(subTaskStatus(QString)));
-
- connect(next.get(), SIGNAL(progress(qint64, qint64)), this, SLOT(subTaskProgress(qint64, qint64)));
- setStatus(tr("Executing task %1 out of %2").arg(m_currentIndex + 1).arg(m_queue.size()));
- setStepStatus(next->isMultiStep() ? next->getStepStatus() : next->getStatus());
-
- setProgress(m_currentIndex + 1, m_queue.count());
-
- next->start();
+ ConcurrentTask::startNext();
}
-void SequentialTask::subTaskFailed(const QString& msg)
+void SequentialTask::updateState()
{
- emitFailed(msg);
-}
-void SequentialTask::subTaskStatus(const QString& msg)
-{
- setStepStatus(msg);
-}
-void SequentialTask::subTaskProgress(qint64 current, qint64 total)
-{
- if (total == 0) {
- setProgress(0, 100);
- return;
- }
-
- m_stepProgress = current;
- m_stepTotalProgress = total;
+ setProgress(m_done.count(), m_total_size);
+ setStatus(tr("Executing task %1 out of %2").arg(QString::number(m_doing.count() + m_done.count()), QString::number(m_total_size)));
}
diff --git a/launcher/tasks/SequentialTask.h b/launcher/tasks/SequentialTask.h
index f5a58b1b..5eace96e 100644
--- a/launcher/tasks/SequentialTask.h
+++ b/launcher/tasks/SequentialTask.h
@@ -1,49 +1,21 @@
#pragma once
-#include "Task.h"
-#include "QObjectPtr.h"
-
-#include <QQueue>
-
-class SequentialTask : public Task
-{
+#include "ConcurrentTask.h"
+
+/** A concurrent task that only allows one concurrent task :)
+ *
+ * This should be used when there's a need to maintain a strict ordering of task executions, and
+ * the starting of a task is contingent on the success of the previous one.
+ *
+ * See MultipleOptionsTask if that's not the case.
+ */
+class SequentialTask : public ConcurrentTask {
Q_OBJECT
-public:
- explicit SequentialTask(QObject *parent = nullptr, const QString& task_name = "");
- virtual ~SequentialTask();
-
- inline auto isMultiStep() const -> bool override { return m_queue.size() > 1; };
- auto getStepProgress() const -> qint64 override;
- auto getStepTotalProgress() const -> qint64 override;
-
- inline auto getStepStatus() const -> QString override { return m_step_status; }
-
- void addTask(Task::Ptr task);
-
-public slots:
- bool abort() override;
-
-protected
-slots:
- void executeTask() override;
-
- virtual void startNext();
- virtual void subTaskFailed(const QString &msg);
- virtual void subTaskStatus(const QString &msg);
- virtual void subTaskProgress(qint64 current, qint64 total);
-
-protected:
- void setStepStatus(QString status) { m_step_status = status; emit stepStatus(status); };
-
-protected:
- QString m_name;
- QString m_step_status;
-
- QQueue<Task::Ptr > m_queue;
- int m_currentIndex;
-
- qint64 m_stepProgress = 0;
- qint64 m_stepTotalProgress = 100;
+ public:
+ explicit SequentialTask(QObject* parent = nullptr, QString task_name = "");
+ ~SequentialTask() override = default;
- bool m_aborted = false;
+ protected:
+ void startNext() override;
+ void updateState() override;
};
diff --git a/launcher/tasks/Task.cpp b/launcher/tasks/Task.cpp
index bb71b98c..b4babdd4 100644
--- a/launcher/tasks/Task.cpp
+++ b/launcher/tasks/Task.cpp
@@ -37,8 +37,9 @@
#include <QDebug>
-Task::Task(QObject *parent) : QObject(parent)
+Task::Task(QObject *parent, bool show_debug) : QObject(parent), m_show_debug(show_debug)
{
+ setAutoDelete(false);
}
void Task::setStatus(const QString &new_status)
@@ -63,27 +64,32 @@ void Task::start()
{
case State::Inactive:
{
- qDebug() << "Task" << describe() << "starting for the first time";
+ if (m_show_debug)
+ qDebug() << "Task" << describe() << "starting for the first time";
break;
}
case State::AbortedByUser:
{
- qDebug() << "Task" << describe() << "restarting for after being aborted by user";
+ if (m_show_debug)
+ qDebug() << "Task" << describe() << "restarting for after being aborted by user";
break;
}
case State::Failed:
{
- qDebug() << "Task" << describe() << "restarting for after failing at first";
+ if (m_show_debug)
+ qDebug() << "Task" << describe() << "restarting for after failing at first";
break;
}
case State::Succeeded:
{
- qDebug() << "Task" << describe() << "restarting for after succeeding at first";
+ if (m_show_debug)
+ qDebug() << "Task" << describe() << "restarting for after succeeding at first";
break;
}
case State::Running:
{
- qWarning() << "The launcher tried to start task" << describe() << "while it was already running!";
+ if (m_show_debug)
+ qWarning() << "The launcher tried to start task" << describe() << "while it was already running!";
return;
}
}
@@ -118,7 +124,8 @@ void Task::emitAborted()
}
m_state = State::AbortedByUser;
m_failReason = "Aborted.";
- qDebug() << "Task" << describe() << "aborted.";
+ if (m_show_debug)
+ qDebug() << "Task" << describe() << "aborted.";
emit aborted();
emit finished();
}
@@ -132,7 +139,8 @@ void Task::emitSucceeded()
return;
}
m_state = State::Succeeded;
- qDebug() << "Task" << describe() << "succeeded";
+ if (m_show_debug)
+ qDebug() << "Task" << describe() << "succeeded";
emit succeeded();
emit finished();
}
diff --git a/launcher/tasks/Task.h b/launcher/tasks/Task.h
index aafaf68c..2baf0188 100644
--- a/launcher/tasks/Task.h
+++ b/launcher/tasks/Task.h
@@ -35,9 +35,11 @@
#pragma once
+#include <QRunnable>
+
#include "QObjectPtr.h"
-class Task : public QObject {
+class Task : public QObject, public QRunnable {
Q_OBJECT
public:
using Ptr = shared_qobject_ptr<Task>;
@@ -45,7 +47,7 @@ class Task : public QObject {
enum class State { Inactive, Running, Succeeded, Failed, AbortedByUser };
public:
- explicit Task(QObject* parent = 0);
+ explicit Task(QObject* parent = 0, bool show_debug_log = true);
virtual ~Task() = default;
bool isRunning() const;
@@ -95,6 +97,9 @@ class Task : public QObject {
void stepStatus(QString status);
public slots:
+ // QRunnable's interface
+ void run() override { start(); }
+
virtual void start();
virtual bool abort() { if(canAbort()) emitAborted(); return canAbort(); };
@@ -117,4 +122,7 @@ class Task : public QObject {
QString m_status;
int m_progress = 0;
int m_progressTotal = 100;
+
+ // TODO: Nuke in favor of QLoggingCategory
+ bool m_show_debug = true;
};
diff --git a/launcher/tasks/Task_test.cpp b/launcher/tasks/Task_test.cpp
deleted file mode 100644
index ef153a6a..00000000
--- a/launcher/tasks/Task_test.cpp
+++ /dev/null
@@ -1,67 +0,0 @@
-#include <QTest>
-
-#include "Task.h"
-
-/* Does nothing. Only used for testing. */
-class BasicTask : public Task {
- Q_OBJECT
-
- friend class TaskTest;
-
- private:
- void executeTask() override {};
-};
-
-/* Does nothing. Only used for testing. */
-class BasicTask_MultiStep : public Task {
- Q_OBJECT
-
- friend class TaskTest;
-
- private:
- auto isMultiStep() const -> bool override { return true; }
-
- void executeTask() override {};
-};
-
-class TaskTest : public QObject {
- Q_OBJECT
-
- private slots:
- void test_SetStatus_NoMultiStep(){
- BasicTask t;
- QString status {"test status"};
-
- t.setStatus(status);
-
- QCOMPARE(t.getStatus(), status);
- QCOMPARE(t.getStepStatus(), status);
- }
-
- void test_SetStatus_MultiStep(){
- BasicTask_MultiStep t;
- QString status {"test status"};
-
- t.setStatus(status);
-
- QCOMPARE(t.getStatus(), status);
- // Even though it is multi step, it does not override the getStepStatus method,
- // so it should remain the same.
- QCOMPARE(t.getStepStatus(), status);
- }
-
- void test_SetProgress(){
- BasicTask t;
- int current = 42;
- int total = 207;
-
- t.setProgress(current, total);
-
- QCOMPARE(t.getProgress(), current);
- QCOMPARE(t.getTotalProgress(), total);
- }
-};
-
-QTEST_GUILESS_MAIN(TaskTest)
-
-#include "Task_test.moc"
generated by cgit (git 2.46.0) at 2025-06-13 04:25:31 +0000