PrismLauncher/launcher/tasks/Task.h

139 lines
4.2 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (c) 2022 flowln <flowlnlnln@gmail.com>
2013-02-05 19:40:43 +00:00
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
2013-02-05 19:40:43 +00:00
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2013-2021 MultiMC Contributors
*
* 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
*
* 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.
2013-02-05 19:40:43 +00:00
*/
#pragma once
2013-02-05 19:40:43 +00:00
#include <QRunnable>
#include "QObjectPtr.h"
class Task : public QObject, public QRunnable {
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, bool show_debug_log = true);
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;
virtual bool canAbort() const { return m_can_abort; }
auto getState() const -> State { return m_state; }
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();
2022-05-17 10:47:00 +01:00
void progress(qint64 current, qint64 total);
2018-07-15 13:51:05 +01:00
void finished();
void succeeded();
void aborted();
2018-07-15 13:51:05 +01:00
void failed(QString reason);
void status(QString status);
void stepStatus(QString status);
2015-04-26 22:04:50 +01:00
/** Emitted when the canAbort() status has changed.
*/
void abortStatusChanged(bool can_abort);
public slots:
// QRunnable's interface
void run() override { start(); }
2018-07-15 13:51:05 +01:00
virtual void start();
virtual bool abort() { if(canAbort()) emitAborted(); return canAbort(); };
void setAbortable(bool can_abort) { m_can_abort = can_abort; emit abortStatusChanged(can_abort); }
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);
protected:
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;
// TODO: Nuke in favor of QLoggingCategory
bool m_show_debug = true;
private:
// Change using setAbortStatus
bool m_can_abort = false;
2013-02-05 19:40:43 +00:00
};