PrismLauncher/launcher/tasks/Task.h

101 lines
2.7 KiB
C
Raw Normal View History

2021-01-18 07:28:54 +00:00
/* Copyright 2013-2021 MultiMC Contributors
2013-02-05 19:40:43 +00:00
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
2013-02-05 19:40:43 +00:00
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
2013-02-05 19:40:43 +00:00
#include <QObject>
#include <QString>
#include <QStringList>
2013-02-05 19:40:43 +00:00
#include "QObjectPtr.h"
class Task : public QObject {
2018-07-15 13:51:05 +01:00
Q_OBJECT
public:
using Ptr = shared_qobject_ptr<Task>;
enum class State { Inactive, Running, Succeeded, Failed, AbortedByUser };
public:
explicit Task(QObject* parent = 0);
virtual ~Task() = default;
2018-07-15 13:51:05 +01:00
bool isRunning() const;
bool isFinished() const;
bool wasSuccessful() const;
/*!
* MultiStep tasks are combinations of multiple tasks into a single logical task.
* The main usage of this is in SequencialTask.
*/
virtual auto isMultiStep() const -> bool { return false; }
2018-07-15 13:51:05 +01:00
/*!
* 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;
2018-07-15 13:51:05 +01:00
virtual QStringList warnings() const;
2018-07-15 13:51:05 +01:00
virtual bool canAbort() const { return false; }
QString getStatus() { return m_status; }
virtual auto getStepStatus() const -> QString { return m_status; }
qint64 getProgress() { return m_progress; }
qint64 getTotalProgress() { return m_progressTotal; }
virtual auto getStepProgress() const -> qint64 { return 0; }
virtual auto getStepTotalProgress() const -> qint64 { return 100; }
protected:
void logWarning(const QString& line);
private:
2018-07-15 13:51:05 +01:00
QString describe();
signals:
2018-07-15 13:51:05 +01:00
void started();
virtual void progress(qint64 current, qint64 total);
2018-07-15 13:51:05 +01:00
void finished();
void succeeded();
void failed(QString reason);
void status(QString status);
2015-04-26 22:04:50 +01:00
public slots:
2018-07-15 13:51:05 +01:00
virtual void start();
virtual bool abort() { return false; };
protected:
2018-07-15 13:51:05 +01:00
virtual void executeTask() = 0;
protected slots:
2018-07-15 13:51:05 +01:00
virtual void emitSucceeded();
virtual void emitAborted();
virtual void emitFailed(QString reason);
public slots:
void setStatus(const QString& status);
2018-07-15 13:51:05 +01:00
void setProgress(qint64 current, qint64 total);
private:
State m_state = State::Inactive;
2018-07-15 13:51:05 +01:00
QStringList m_Warnings;
QString m_failReason = "";
QString m_status;
int m_progress = 0;
int m_progressTotal = 100;
2013-02-05 19:40:43 +00:00
};