summaryrefslogtreecommitdiffstats
path: root/api/logic/tasks
diff options
context:
space:
mode:
authorThomas Groman <tgroman@nuegia.net>2019-09-19 00:41:48 -0700
committerThomas Groman <tgroman@nuegia.net>2019-09-19 00:41:48 -0700
commit32b3ed0a1362a4b0798ad71fac3450fb77cb7e41 (patch)
tree7be7a2f602e6a5af7bc2db86bef9cf2a659c3d3d /api/logic/tasks
parent5fb2c6334e7d5237db11695b4c0ec0f2d1e47c88 (diff)
downloadMultiMC-32b3ed0a1362a4b0798ad71fac3450fb77cb7e41.tar
MultiMC-32b3ed0a1362a4b0798ad71fac3450fb77cb7e41.tar.gz
MultiMC-32b3ed0a1362a4b0798ad71fac3450fb77cb7e41.tar.lz
MultiMC-32b3ed0a1362a4b0798ad71fac3450fb77cb7e41.tar.xz
MultiMC-32b3ed0a1362a4b0798ad71fac3450fb77cb7e41.zip
merged from 0.6.7 codebase
Diffstat (limited to 'api/logic/tasks')
-rw-r--r--api/logic/tasks/SequentialTask.cpp56
-rw-r--r--api/logic/tasks/SequentialTask.h21
-rw-r--r--api/logic/tasks/Task.cpp168
-rw-r--r--api/logic/tasks/Task.h108
4 files changed, 192 insertions, 161 deletions
diff --git a/api/logic/tasks/SequentialTask.cpp b/api/logic/tasks/SequentialTask.cpp
index ac0e7820..d0777132 100644
--- a/api/logic/tasks/SequentialTask.cpp
+++ b/api/logic/tasks/SequentialTask.cpp
@@ -6,50 +6,50 @@ SequentialTask::SequentialTask(QObject *parent) : Task(parent), m_currentIndex(-
void SequentialTask::addTask(std::shared_ptr<Task> task)
{
- m_queue.append(task);
+ m_queue.append(task);
}
void SequentialTask::executeTask()
{
- m_currentIndex = -1;
- startNext();
+ m_currentIndex = -1;
+ startNext();
}
void SequentialTask::startNext()
{
- if (m_currentIndex != -1)
- {
- std::shared_ptr<Task> previous = m_queue[m_currentIndex];
- disconnect(previous.get(), 0, this, 0);
- }
- m_currentIndex++;
- if (m_queue.isEmpty() || m_currentIndex >= m_queue.size())
- {
- emitSucceeded();
- return;
- }
- std::shared_ptr<Task> next = m_queue[m_currentIndex];
- connect(next.get(), SIGNAL(failed(QString)), this, SLOT(subTaskFailed(QString)));
- connect(next.get(), SIGNAL(status(QString)), this, SLOT(subTaskStatus(QString)));
- connect(next.get(), SIGNAL(progress(qint64, qint64)), this, SLOT(subTaskProgress(qint64, qint64)));
- connect(next.get(), SIGNAL(succeeded()), this, SLOT(startNext()));
- next->start();
+ if (m_currentIndex != -1)
+ {
+ std::shared_ptr<Task> previous = m_queue[m_currentIndex];
+ disconnect(previous.get(), 0, this, 0);
+ }
+ m_currentIndex++;
+ if (m_queue.isEmpty() || m_currentIndex >= m_queue.size())
+ {
+ emitSucceeded();
+ return;
+ }
+ std::shared_ptr<Task> next = m_queue[m_currentIndex];
+ connect(next.get(), SIGNAL(failed(QString)), this, SLOT(subTaskFailed(QString)));
+ connect(next.get(), SIGNAL(status(QString)), this, SLOT(subTaskStatus(QString)));
+ connect(next.get(), SIGNAL(progress(qint64, qint64)), this, SLOT(subTaskProgress(qint64, qint64)));
+ connect(next.get(), SIGNAL(succeeded()), this, SLOT(startNext()));
+ next->start();
}
void SequentialTask::subTaskFailed(const QString &msg)
{
- emitFailed(msg);
+ emitFailed(msg);
}
void SequentialTask::subTaskStatus(const QString &msg)
{
- setStatus(msg);
+ setStatus(msg);
}
void SequentialTask::subTaskProgress(qint64 current, qint64 total)
{
- if(total == 0)
- {
- setProgress(0, 100);
- return;
- }
- setProgress(current, total);
+ if(total == 0)
+ {
+ setProgress(0, 100);
+ return;
+ }
+ setProgress(current, total);
}
diff --git a/api/logic/tasks/SequentialTask.h b/api/logic/tasks/SequentialTask.h
index 69031095..2ca77c00 100644
--- a/api/logic/tasks/SequentialTask.h
+++ b/api/logic/tasks/SequentialTask.h
@@ -9,23 +9,24 @@
class MULTIMC_LOGIC_EXPORT SequentialTask : public Task
{
- Q_OBJECT
+ Q_OBJECT
public:
- explicit SequentialTask(QObject *parent = 0);
+ explicit SequentialTask(QObject *parent = 0);
+ virtual ~SequentialTask() {};
- void addTask(std::shared_ptr<Task> task);
+ void addTask(std::shared_ptr<Task> task);
protected:
- void executeTask();
+ void executeTask();
private
slots:
- void startNext();
- void subTaskFailed(const QString &msg);
- void subTaskStatus(const QString &msg);
- void subTaskProgress(qint64 current, qint64 total);
+ void startNext();
+ void subTaskFailed(const QString &msg);
+ void subTaskStatus(const QString &msg);
+ void subTaskProgress(qint64 current, qint64 total);
private:
- QQueue<std::shared_ptr<Task> > m_queue;
- int m_currentIndex;
+ QQueue<std::shared_ptr<Task> > m_queue;
+ int m_currentIndex;
};
diff --git a/api/logic/tasks/Task.cpp b/api/logic/tasks/Task.cpp
index 2523aeb2..accb39b6 100644
--- a/api/logic/tasks/Task.cpp
+++ b/api/logic/tasks/Task.cpp
@@ -1,4 +1,4 @@
-/* Copyright 2013-2018 MultiMC Contributors
+/* Copyright 2013-2019 MultiMC Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,124 +23,146 @@ Task::Task(QObject *parent) : QObject(parent)
void Task::setStatus(const QString &new_status)
{
- if(m_status != new_status)
- {
- m_status = new_status;
- emit status(m_status);
- }
+ if(m_status != new_status)
+ {
+ m_status = new_status;
+ emit status(m_status);
+ }
}
void Task::setProgress(qint64 current, qint64 total)
{
- m_progress = current;
- m_progressTotal = total;
- emit progress(m_progress, m_progressTotal);
+ m_progress = current;
+ m_progressTotal = total;
+ emit progress(m_progress, m_progressTotal);
}
void Task::start()
{
- m_running = true;
- emit started();
- qDebug() << "Task" << describe() << "started";
- executeTask();
+ switch(m_state)
+ {
+ case State::Inactive:
+ {
+ qDebug() << "Task" << describe() << "starting for the first time";
+ break;
+ }
+ case State::AbortedByUser:
+ {
+ qDebug() << "Task" << describe() << "restarting for after being aborted by user";
+ break;
+ }
+ case State::Failed:
+ {
+ qDebug() << "Task" << describe() << "restarting for after failing at first";
+ break;
+ }
+ case State::Succeeded:
+ {
+ qDebug() << "Task" << describe() << "restarting for after succeeding at first";
+ break;
+ }
+ case State::Running:
+ {
+ qWarning() << "MultiMC tried to start task" << describe() << "while it was already running!";
+ return;
+ }
+ }
+ // NOTE: only fall thorugh to here in end states
+ m_state = State::Running;
+ emit started();
+ executeTask();
}
void Task::emitFailed(QString reason)
{
- // Don't fail twice.
- if (!m_running)
- {
- qCritical() << "Task" << describe() << "failed while not running!!!!: " << reason;
- return;
- }
- m_running = false;
- m_finished = true;
- m_succeeded = false;
- m_failReason = reason;
- qCritical() << "Task" << describe() << "failed: " << reason;
- emit failed(reason);
- emit finished();
+ // Don't fail twice.
+ if (!isRunning())
+ {
+ qCritical() << "Task" << describe() << "failed while not running!!!!: " << reason;
+ return;
+ }
+ m_state = State::Failed;
+ m_failReason = reason;
+ qCritical() << "Task" << describe() << "failed: " << reason;
+ emit failed(reason);
+ emit finished();
}
void Task::emitAborted()
{
- // Don't abort twice.
- if (!m_running)
- {
- qCritical() << "Task" << describe() << "aborted while not running!!!!";
- return;
- }
- m_running = false;
- m_finished = true;
- m_succeeded = false;
- m_failReason = "Aborted.";
- qDebug() << "Task" << describe() << "aborted.";
- emit failed(m_failReason);
- emit finished();
+ // Don't abort twice.
+ if (!isRunning())
+ {
+ qCritical() << "Task" << describe() << "aborted while not running!!!!";
+ return;
+ }
+ m_state = State::AbortedByUser;
+ m_failReason = "Aborted.";
+ qDebug() << "Task" << describe() << "aborted.";
+ emit failed(m_failReason);
+ emit finished();
}
void Task::emitSucceeded()
{
- // Don't succeed twice.
- if (!m_running)
- {
- qCritical() << "Task" << describe() << "succeeded while not running!!!!";
- return;
- }
- m_running = false;
- m_finished = true;
- m_succeeded = true;
- qDebug() << "Task" << describe() << "succeeded";
- emit succeeded();
- emit finished();
+ // Don't succeed twice.
+ if (!isRunning())
+ {
+ qCritical() << "Task" << describe() << "succeeded while not running!!!!";
+ return;
+ }
+ m_state = State::Succeeded;
+ qDebug() << "Task" << describe() << "succeeded";
+ emit succeeded();
+ emit finished();
}
QString Task::describe()
{
- QString outStr;
- QTextStream out(&outStr);
- out << metaObject()->className() << QChar('(');
- auto name = objectName();
- if(name.isEmpty())
- {
- out << QString("0x%1").arg((quintptr)this, 0, 16);
- }
- else
- {
- out << name;
- }
- out << QChar(')');
- out.flush();
- return outStr;
+ QString outStr;
+ QTextStream out(&outStr);
+ out << metaObject()->className() << QChar('(');
+ auto name = objectName();
+ if(name.isEmpty())
+ {
+ out << QString("0x%1").arg((quintptr)this, 0, 16);
+ }
+ else
+ {
+ out << name;
+ }
+ out << QChar(')');
+ out.flush();
+ return outStr;
}
bool Task::isRunning() const
{
- return m_running;
+ return m_state == State::Running;
}
bool Task::isFinished() const
{
- return m_finished;
+ return m_state != State::Running && m_state != State::Inactive;
}
bool Task::wasSuccessful() const
{
- return m_succeeded;
+ return m_state == State::Succeeded;
}
QString Task::failReason() const
{
- return m_failReason;
+ return m_failReason;
}
void Task::logWarning(const QString& line)
{
- qWarning() << line;
- m_Warnings.append(line);
+ qWarning() << line;
+ m_Warnings.append(line);
}
QStringList Task::warnings() const
{
- return m_Warnings;
+ return m_Warnings;
}
diff --git a/api/logic/tasks/Task.h b/api/logic/tasks/Task.h
index 643f8510..72bfeca8 100644
--- a/api/logic/tasks/Task.h
+++ b/api/logic/tasks/Task.h
@@ -1,4 +1,4 @@
-/* Copyright 2013-2018 MultiMC Contributors
+/* Copyright 2013-2019 MultiMC Contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,78 +23,86 @@
class MULTIMC_LOGIC_EXPORT Task : public QObject
{
- Q_OBJECT
+ Q_OBJECT
public:
- explicit Task(QObject *parent = 0);
- virtual ~Task() {};
+ enum class State
+ {
+ Inactive,
+ Running,
+ Succeeded,
+ Failed,
+ AbortedByUser
+ };
- bool isRunning() const;
- bool isFinished() const;
- bool wasSuccessful() const;
+public:
+ explicit Task(QObject *parent = 0);
+ virtual ~Task() {};
+
+ bool isRunning() const;
+ bool isFinished() const;
+ bool wasSuccessful() const;
- /*!
- * Returns the string that was passed to emitFailed as the error message when the task failed.
- * If the task hasn't failed, returns an empty string.
- */
- QString failReason() const;
+ /*!
+ * Returns the string that was passed to emitFailed as the error message when the task failed.
+ * If the task hasn't failed, returns an empty string.
+ */
+ QString failReason() const;
- virtual QStringList warnings() const;
+ virtual QStringList warnings() const;
- virtual bool canAbort() const { return false; }
+ virtual bool canAbort() const { return false; }
- QString getStatus()
- {
- return m_status;
- }
+ QString getStatus()
+ {
+ return m_status;
+ }
- qint64 getProgress()
- {
- return m_progress;
- }
+ qint64 getProgress()
+ {
+ return m_progress;
+ }
- qint64 getTotalProgress()
- {
- return m_progressTotal;
- }
+ qint64 getTotalProgress()
+ {
+ return m_progressTotal;
+ }
protected:
- void logWarning(const QString & line);
+ void logWarning(const QString & line);
private:
- QString describe();
+ QString describe();
signals:
- void started();
- void progress(qint64 current, qint64 total);
- void finished();
- void succeeded();
- void failed(QString reason);
- void status(QString status);
+ void started();
+ void progress(qint64 current, qint64 total);
+ void finished();
+ void succeeded();
+ void failed(QString reason);
+ void status(QString status);
public slots:
- virtual void start();
- virtual bool abort() { return false; };
+ virtual void start();
+ virtual bool abort() { return false; };
protected:
- virtual void executeTask() = 0;
+ virtual void executeTask() = 0;
protected slots:
- virtual void emitSucceeded();
- virtual void emitAborted();
- virtual void emitFailed(QString reason);
+ virtual void emitSucceeded();
+ virtual void emitAborted();
+ virtual void emitFailed(QString reason);
public slots:
- void setStatus(const QString &status);
- void setProgress(qint64 current, qint64 total);
+ void setStatus(const QString &status);
+ void setProgress(qint64 current, qint64 total);
private:
- bool m_running = false;
- bool m_finished = false;
- bool m_succeeded = false;
- QStringList m_Warnings;
- QString m_failReason = "";
- QString m_status;
- int m_progress = 0;
- int m_progressTotal = 100;
+ State m_state = State::Inactive;
+ QStringList m_Warnings;
+ QString m_failReason = "";
+ QString m_status;
+ int m_progress = 0;
+ int m_progressTotal = 100;
};