summaryrefslogtreecommitdiff
path: root/archived/projt-launcher/launcher/tasks/ConcurrentTask.h
blob: 804ae7b01678382531b92473c7f87f137d72ff56 (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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
// SPDX-License-Identifier: GPL-3.0-only
// SPDX-FileCopyrightText: 2026 Project Tick
// SPDX-FileContributor: Project Tick Team
/*
 *  ProjT Launcher - Minecraft Launcher
 *  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, 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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, write to the Free Software Foundation,
 *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * === Upstream License Block (Do Not Modify) ==============================
 *
 *
 *
 *  Prism Launcher - Minecraft Launcher
 *  Copyright (c) 2022 flowln <flowlnlnln@gmail.com>
 *  Copyright (c) 2023 Rachel Powers <508861+Ryex@users.noreply.github.com>
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, write to the Free Software Foundation,
 *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * 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 <QHash>
#include <QQueue>
#include <QSet>
#include <QUuid>
#include <memory>

#include "tasks/Task.h"

/*!
 * Runs a list of tasks concurrently (according to `max_concurrent` parameter).
 * Behaviour is the same as regular Task (e.g. starts using start())
 */
class ConcurrentTask : public Task
{
	Q_OBJECT
  public:
	using Ptr = shared_qobject_ptr<ConcurrentTask>;

	explicit ConcurrentTask(QString task_name = "", int max_concurrent = 6);
	~ConcurrentTask() override;

	// safe to call before starting the task
	void setMaxConcurrent(int max_concurrent)
	{
		m_total_max_size = max_concurrent;
	}

	bool canAbort() const override
	{
		return true;
	}

	inline auto isMultiStep() const -> bool override
	{
		return totalSize() > 1;
	}
	auto getStepProgress() const -> TaskStepProgressList override;

	//! Adds a task to execute in this ConcurrentTask
	void addTask(Task::Ptr task);

  public slots:
	bool abort() override;

	/** Resets the internal state of the task.
	 *  This allows the same task to be re-used.
	 */
	void clear();

  protected slots:
	void executeTask() override;

	virtual void executeNextSubTask();

	void subTaskSucceeded(Task::Ptr);
	virtual void subTaskFailed(Task::Ptr, const QString& msg);
	void subTaskFinished(Task::Ptr, TaskStepState);
	void subTaskStatus(Task::Ptr task, const QString& msg);
	void subTaskDetails(Task::Ptr task, const QString& msg);
	void subTaskProgress(Task::Ptr task, qint64 current, qint64 total);

  protected:
	// NOTE: This is not thread-safe.
	unsigned int totalSize() const
	{
		return static_cast<unsigned int>(m_queue.size() + m_doing.size() + m_done.size());
	}

	virtual void updateState();

	void startSubTask(Task::Ptr task);

  protected:
	QQueue<Task::Ptr> m_queue;

	QHash<Task*, Task::Ptr> m_doing;
	QHash<Task*, Task::Ptr> m_done;
	QHash<Task*, Task::Ptr> m_failed;
	QHash<Task*, Task::Ptr> m_succeeded;

	QHash<QUuid, std::shared_ptr<TaskStepProgress>> m_task_progress;

	int m_total_max_size;
};