sneedmc/logic/BaseProcess.h

143 lines
3.5 KiB
C
Raw Normal View History

2015-02-02 22:25:30 +00:00
/* Copyright 2013-2015 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 "BaseInstance.h"
/**
* @brief the MessageLevel Enum
* defines what level a message is
*/
namespace MessageLevel
{
enum Enum
{
MultiMC, /**< MultiMC Messages */
Debug, /**< Debug Messages */
Info, /**< Info Messages */
Message, /**< Standard Messages */
Warning, /**< Warnings */
Error, /**< Errors */
Fatal, /**< Fatal Errors */
PrePost, /**< Pre/Post Launch command output */
};
2015-01-27 21:31:07 +00:00
MessageLevel::Enum getLevel(const QString &levelName);
}
2015-01-27 21:31:07 +00:00
class BaseProcess: public QProcess
{
Q_OBJECT
2015-01-27 21:31:07 +00:00
protected:
explicit BaseProcess(InstancePtr instance);
void init();
2015-01-27 21:31:07 +00:00
public: /* methods */
virtual ~BaseProcess() {};
InstancePtr instance()
{
return m_instance;
}
/// Set the text printed on top of the log
void setHeader(QString header)
{
m_header = header;
}
void setWorkdir(QString path);
2015-01-27 21:31:07 +00:00
void killProcess();
2015-01-27 21:31:07 +00:00
/**
* @brief prepare the process for launch (for multi-stage launch)
*/
virtual void arm() = 0;
2015-01-27 21:31:07 +00:00
/**
* @brief launch the armed instance
*/
virtual void launch() = 0;
2015-01-27 21:31:07 +00:00
/**
* @brief abort launch
*/
virtual void abort() = 0;
protected: /* methods */
bool preLaunch();
bool postLaunch();
bool waitForPrePost();
QString substituteVariables(const QString &cmd) const;
void printHeader();
2015-01-27 21:31:07 +00:00
virtual QMap<QString, QString> getVariables() const = 0;
virtual QString censorPrivateInfo(QString in) = 0;
virtual MessageLevel::Enum guessLevel(const QString &message, MessageLevel::Enum defaultLevel) = 0;
signals:
/**
2015-01-27 21:31:07 +00:00
* @brief emitted when the Process immediately fails to run
*/
void launch_failed(InstancePtr);
/**
* @brief emitted when the PreLaunchCommand fails
*/
void prelaunch_failed(InstancePtr, int code, QProcess::ExitStatus status);
/**
* @brief emitted when the PostLaunchCommand fails
*/
void postlaunch_failed(InstancePtr, int code, QProcess::ExitStatus status);
/**
2015-01-27 21:31:07 +00:00
* @brief emitted when the process has finished and the PostLaunchCommand was run
*/
void ended(InstancePtr, int code, QProcess::ExitStatus status);
/**
* @brief emitted when we want to log something
* @param text the text to log
* @param level the level to log at
*/
void log(QString text, MessageLevel::Enum level = MessageLevel::MultiMC);
2015-01-27 21:31:07 +00:00
protected slots:
void finish(int, QProcess::ExitStatus status);
void on_stdErr();
void on_stdOut();
void on_prepost_stdOut();
void on_prepost_stdErr();
void logOutput(const QStringList &lines,
MessageLevel::Enum defaultLevel = MessageLevel::Message,
bool guessLevel = true, bool censor = true);
void logOutput(QString line,
MessageLevel::Enum defaultLevel = MessageLevel::Message,
bool guessLevel = true, bool censor = true);
2015-01-27 21:31:07 +00:00
protected:
InstancePtr m_instance;
QString m_err_leftover;
QString m_out_leftover;
QProcess m_prepostlaunchprocess;
bool killed = false;
QString m_header;
};