summaryrefslogtreecommitdiff
path: root/meshmc/launcher/tasks/Task.h
blob: 8019c9bd9c91c7cf9a1661edcf804f3c60c8576b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/* SPDX-FileCopyrightText: 2026 Project Tick
 * SPDX-FileContributor: Project Tick
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 *   MeshMC - A Custom Launcher for Minecraft
 *   Copyright (C) 2026 Project Tick
 *
 *   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, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   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.
 *
 *   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.
 */

#pragma once

#include <QObject>
#include <QString>
#include <QStringList>

#include "QObjectPtr.h"

class Task : public QObject
{
	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() {};

	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;

	virtual QStringList warnings() const;

	virtual bool canAbort() const
	{
		return false;
	}

	QString getStatus()
	{
		return m_status;
	}

	qint64 getProgress()
	{
		return m_progress;
	}

	qint64 getTotalProgress()
	{
		return m_progressTotal;
	}

  protected:
	void logWarning(const QString& line);

  private:
	QString describe();

  signals:
	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;
	};

  protected:
	virtual void executeTask() = 0;

  protected slots:
	virtual void emitSucceeded();
	virtual void emitAborted();
	virtual void emitFailed(QString reason);

  public slots:
	void setStatus(const QString& status);
	void setProgress(qint64 current, qint64 total);

  private:
	State m_state = State::Inactive;
	QStringList m_Warnings;
	QString m_failReason = "";
	QString m_status;
	int m_progress = 0;
	int m_progressTotal = 100;
};