PrismLauncher/api/logic/tasks/Task.h

109 lines
2.4 KiB
C
Raw Normal View History

2018-02-10 23:40:01 +00:00
/* Copyright 2013-2018 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 "multimc_logic_export.h"
class MULTIMC_LOGIC_EXPORT Task : public QObject
2013-02-05 19:40:43 +00:00
{
2018-07-15 13:51:05 +01:00
Q_OBJECT
public:
enum class State
{
Inactive,
Running,
Succeeded,
Failed,
AbortedByUser
};
2013-02-05 19:40:43 +00:00
public:
2018-07-15 13:51:05 +01:00
explicit Task(QObject *parent = 0);
virtual ~Task() {};
2018-07-15 13:51:05 +01:00
bool isRunning() const;
bool isFinished() const;
bool wasSuccessful() const;
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; }
2018-07-15 13:51:05 +01:00
QString getStatus()
{
return m_status;
}
2018-07-15 13:51:05 +01:00
qint64 getProgress()
{
return m_progress;
}
2018-07-15 13:51:05 +01:00
qint64 getTotalProgress()
{
return m_progressTotal;
}
protected:
2018-07-15 13:51:05 +01:00
void logWarning(const QString & line);
private:
2018-07-15 13:51:05 +01:00
QString describe();
2015-04-26 22:04:50 +01:00
signals:
2018-07-15 13:51:05 +01:00
void started();
void progress(qint64 current, qint64 total);
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; };
2013-02-05 19:40:43 +00:00
protected:
2018-07-15 13:51:05 +01:00
virtual void executeTask() = 0;
2014-09-06 17:16:56 +01:00
protected slots:
2018-07-15 13:51:05 +01:00
virtual void emitSucceeded();
virtual void emitAborted();
virtual void emitFailed(QString reason);
public slots:
2018-07-15 13:51:05 +01:00
void setStatus(const QString &status);
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
};
2014-09-06 17:16:56 +01:00