sneedmc/launcher/launch/LaunchTask.h

145 lines
3.9 KiB
C
Raw Normal View History

// SPDX-License-Identifier: GPL-3.0-only
/*
* PolyMC - Minecraft Launcher
* Copyright (C) 2022 Sefa Eyeoglu <contact@scrumplex.net>
*
* 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, see <https://www.gnu.org/licenses/>.
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Copyright 2013-2021 MultiMC Contributors
*
* Authors: Orochimarufan <orochimarufan.x3@gmail.com>
*
* 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 <QProcess>
#include <QObjectPtr.h>
#include "LogModel.h"
#include "BaseInstance.h"
#include "MessageLevel.h"
#include "LoggedProcess.h"
#include "LaunchStep.h"
class LaunchTask: public Task
{
2018-07-15 12:51:05 +00:00
Q_OBJECT
2015-01-27 21:31:07 +00:00
protected:
2018-07-15 12:51:05 +00:00
explicit LaunchTask(InstancePtr instance);
void init();
public:
2018-07-15 12:51:05 +00:00
enum State
{
NotStarted,
Running,
Waiting,
Failed,
Aborted,
Finished
};
2015-01-27 21:31:07 +00:00
public: /* methods */
static shared_qobject_ptr<LaunchTask> create(InstancePtr inst);
2018-07-15 12:51:05 +00:00
virtual ~LaunchTask() {};
void appendStep(shared_qobject_ptr<LaunchStep> step);
void prependStep(shared_qobject_ptr<LaunchStep> step);
2018-07-15 12:51:05 +00:00
void setCensorFilter(QMap<QString, QString> filter);
2018-07-15 12:51:05 +00:00
InstancePtr instance()
{
return m_instance;
}
2018-07-15 12:51:05 +00:00
void setPid(qint64 pid)
{
m_pid = pid;
}
2018-07-15 12:51:05 +00:00
qint64 pid()
{
return m_pid;
}
2018-07-15 12:51:05 +00:00
/**
* @brief prepare the process for launch (for multi-stage launch)
*/
virtual void executeTask() override;
2018-07-15 12:51:05 +00:00
/**
* @brief launch the armed instance
*/
void proceed();
2018-07-15 12:51:05 +00:00
/**
* @brief abort launch
*/
bool abort() override;
2018-07-15 12:51:05 +00:00
bool canAbort() const override;
2018-07-15 12:51:05 +00:00
shared_qobject_ptr<LogModel> getLogModel();
2015-07-22 07:01:04 +00:00
public:
void substituteVariables(const QStringList &args) const;
2018-07-15 12:51:05 +00:00
QString substituteVariables(const QString &cmd) const;
QString censorPrivateInfo(QString in);
2015-01-27 21:31:07 +00:00
protected: /* methods */
2018-07-15 12:51:05 +00:00
virtual void emitFailed(QString reason) override;
virtual void emitSucceeded() override;
signals:
2018-07-15 12:51:05 +00:00
/**
* @brief emitted when the launch preparations are done
*/
void readyForLaunch();
2018-07-15 12:51:05 +00:00
void requestProgress(Task *task);
2018-07-15 12:51:05 +00:00
void requestLogging();
public slots:
2021-10-17 22:47:02 +00:00
void onLogLines(const QStringList& lines, MessageLevel::Enum defaultLevel = MessageLevel::Launcher);
void onLogLine(QString line, MessageLevel::Enum defaultLevel = MessageLevel::Launcher);
2018-07-15 12:51:05 +00:00
void onReadyForLaunch();
void onStepFinished();
void onProgressReportingRequested();
private: /*methods */
2018-07-15 12:51:05 +00:00
void finalizeSteps(bool successful, const QString & error);
protected: /* data */
2018-07-15 12:51:05 +00:00
InstancePtr m_instance;
shared_qobject_ptr<LogModel> m_logModel;
QList <shared_qobject_ptr<LaunchStep>> m_steps;
2018-07-15 12:51:05 +00:00
QMap<QString, QString> m_censorFilter;
int currentStep = -1;
State state = NotStarted;
qint64 m_pid = -1;
};