summaryrefslogtreecommitdiff
path: root/archived/projt-launcher/launcher/tasks/Task.h
diff options
context:
space:
mode:
authorMehmet Samet Duman <yongdohyun@projecttick.org>2026-04-02 18:51:45 +0300
committerMehmet Samet Duman <yongdohyun@projecttick.org>2026-04-02 18:51:45 +0300
commitd3261e64152397db2dca4d691a990c6bc2a6f4dd (patch)
treefac2f7be638651181a72453d714f0f96675c2b8b /archived/projt-launcher/launcher/tasks/Task.h
parent31b9a8949ed0a288143e23bf739f2eb64fdc63be (diff)
downloadProject-Tick-d3261e64152397db2dca4d691a990c6bc2a6f4dd.tar.gz
Project-Tick-d3261e64152397db2dca4d691a990c6bc2a6f4dd.zip
NOISSUE add archived projects
Signed-off-by: Mehmet Samet Duman <yongdohyun@projecttick.org>
Diffstat (limited to 'archived/projt-launcher/launcher/tasks/Task.h')
-rw-r--r--archived/projt-launcher/launcher/tasks/Task.h288
1 files changed, 288 insertions, 0 deletions
diff --git a/archived/projt-launcher/launcher/tasks/Task.h b/archived/projt-launcher/launcher/tasks/Task.h
new file mode 100644
index 0000000000..130290bd83
--- /dev/null
+++ b/archived/projt-launcher/launcher/tasks/Task.h
@@ -0,0 +1,288 @@
+// 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 <QLoggingCategory>
+#include <QRunnable>
+#include <QUuid>
+
+#include "QObjectPtr.h"
+
+Q_DECLARE_LOGGING_CATEGORY(taskLogC)
+
+enum class TaskStepState
+{
+ Waiting,
+ Running,
+ Failed,
+ Succeeded
+};
+
+Q_DECLARE_METATYPE(TaskStepState)
+
+struct TaskStepProgress
+{
+ QUuid uid;
+ qint64 current = 0;
+ qint64 total = -1;
+
+ qint64 old_current = 0;
+ qint64 old_total = -1;
+
+ QString status = "";
+ QString details = "";
+ TaskStepState state = TaskStepState::Waiting;
+
+ TaskStepProgress()
+ {
+ this->uid = QUuid::createUuid();
+ }
+ TaskStepProgress(QUuid uid_) : uid(uid_)
+ {}
+
+ bool isDone() const
+ {
+ return (state == TaskStepState::Failed) || (state == TaskStepState::Succeeded);
+ }
+ void update(qint64 new_current, qint64 new_total)
+ {
+ this->old_current = this->current;
+ this->old_total = this->total;
+
+ this->current = new_current;
+ this->total = new_total;
+ this->state = TaskStepState::Running;
+ }
+};
+
+Q_DECLARE_METATYPE(TaskStepProgress)
+
+using TaskStepProgressList = QList<std::shared_ptr<TaskStepProgress>>;
+
+/*!
+ * Represents a task that has to be done.
+ * To create a task, you need to subclass this class, implement the executeTask() method and call
+ * emitSucceeded() or emitFailed() when the task is done.
+ * the caller needs to call start() to start the task.
+ */
+class Task : public QObject, public QRunnable
+{
+ Q_OBJECT
+ public:
+ using Ptr = shared_qobject_ptr<Task>;
+
+ enum class State
+ {
+ Inactive,
+ Running,
+ Succeeded,
+ Failed,
+ AbortedByUser
+ };
+
+ public:
+ explicit Task(bool show_debug_log = true);
+ virtual ~Task() = default;
+
+ 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;
+ }
+
+ /*!
+ * 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 m_can_abort;
+ }
+
+ auto getState() const -> State
+ {
+ return m_state;
+ }
+
+ QString getStatus()
+ {
+ return m_status;
+ }
+ QString getDetails()
+ {
+ return m_details;
+ }
+
+ qint64 getProgress()
+ {
+ return m_progress;
+ }
+ qint64 getTotalProgress()
+ {
+ return m_progressTotal;
+ }
+ virtual auto getStepProgress() const -> TaskStepProgressList
+ {
+ return {};
+ }
+
+ QUuid getUid()
+ {
+ return m_uid;
+ }
+
+ protected:
+ void logWarning(const QString& line);
+
+ private:
+ QString describe();
+
+ signals:
+ void started();
+ void progress(qint64 current, qint64 total);
+ //! called when a task has either succeeded, aborted or failed.
+ void finished();
+ //! called when a task has succeeded
+ void succeeded();
+ //! called when a task has been aborted by calling abort()
+ void aborted();
+ void failed(QString reason);
+ void status(QString status);
+ void details(QString details);
+ void warningLogged(const QString& warning);
+ void stepProgress(TaskStepProgress const& task_progress);
+
+ //! Emitted when the canAbort() status has changed. */
+ void abortStatusChanged(bool can_abort);
+ void abortButtonTextChanged(QString text);
+
+ public slots:
+ // QRunnable's interface
+ void run() override
+ {
+ start();
+ }
+
+ //! used by the task caller to start the task
+ virtual void start();
+ //! used by external code to ask the task to abort
+ virtual bool abort()
+ {
+ if (canAbort())
+ emitAborted();
+ return canAbort();
+ }
+
+ void setAbortable(bool can_abort)
+ {
+ m_can_abort = can_abort;
+ emit abortStatusChanged(can_abort);
+ }
+
+ void setAbortButtonText(QString text)
+ {
+ emit abortButtonTextChanged(std::move(text));
+ }
+
+ protected:
+ //! The task subclass must implement this method. This method is called to start to run the task.
+ //! The task is not finished when this method returns. the subclass must manually call emitSucceeded() or emitFailed() instead.
+ virtual void executeTask() = 0;
+
+ protected slots:
+ //! The Task subclass must call this method when the task has succeeded
+ virtual void emitSucceeded();
+ //! **The Task subclass** must call this method when the task has aborted. External code should call abort() instead.
+ virtual void emitAborted();
+ //! The Task subclass must call this method when the task has failed
+ virtual void emitFailed(QString reason = "");
+
+ virtual void propagateStepProgress(TaskStepProgress const& task_progress);
+
+ public slots:
+ void setStatus(const QString& status);
+ void setDetails(const QString& details);
+ void setProgress(qint64 current, qint64 total);
+
+ protected:
+ State m_state = State::Inactive;
+ QStringList m_Warnings;
+ QString m_failReason = "";
+ QString m_status;
+ QString m_details;
+ int m_progress = 0;
+ int m_progressTotal = 100;
+
+ private:
+ // Change using setAbortStatus
+ bool m_can_abort = false;
+ QUuid m_uid;
+};