LaunchContext Class Reference

#include <launch_manager.hpp>

Inheritance diagram for LaunchContext:

Collaboration diagram for LaunchContext:

Classes
struct	ExtraData

Public Types
enum class	Type { None = 0 , Preview , Run , Query }

Signals
void	processOutputLine (std::string_view sv)
void	processOutputRead (QString str)
void	processTerminated (int code, QProcess::ExitStatus es, bool wasRequested)

Public Member Functions
	LaunchContext ()
void	terminate ()

Public Attributes
QStringList	args
QString	executablePath
std::unique_ptr< ExtraData >	extraData
LineBuffer	lineBuf
QProcess	process
Type	type = Type::None

Private Slots
void	processOutput ()
void	processTerminationHandler (int code, QProcess::ExitStatus es)

Private Attributes
QTimer	killTimer
bool	terminationRequested = false

Static Private Attributes
static constexpr int	terminateTimeoutMs = 1000

Detailed Description

Definition at line 11 of file launch_manager.hpp.

Member Enumeration Documentation

Type

enum class LaunchContext::Type

strong

Enumerator
None
Preview
Run
Query

Definition at line 14 of file launch_manager.hpp.

                        {
                None = 0,
                Preview,
                Run,
                Query
        };

Constructor & Destructor Documentation

LaunchContext()

LaunchContext::LaunchContext

(

)

Definition at line 76 of file launch_manager.cpp.

                            {
        connect(&killTimer, &QTimer::timeout, [=](){ process.kill(); });
        killTimer.setSingleShot(true);
        connect(&process, QOverload<int, QProcess::ExitStatus>::of(&QProcess::finished),
                        this, &LaunchContext::processTerminationHandler);
 
        process.setProcessChannelMode(QProcess::MergedChannels);
        connect(&process, &QProcess::readyReadStandardOutput, this, &LaunchContext::processOutput);
        connect(&process, &QProcess::readyReadStandardError, this, &LaunchContext::processOutput);
}

References killTimer, process, processOutput(), and processTerminationHandler().

Here is the call graph for this function:

Member Function Documentation

processOutput

void LaunchContext::processOutput ( )

privateslot

Definition at line 91 of file launch_manager.cpp.

                                 {
        QString str = process.isReadable() ? process.readAll() : QByteArray();
 
        emit processOutputRead(str);
 
        lineBuf.write(str.toStdString());
 
        while(lineBuf.hasLine()){
                emit processOutputLine(lineBuf.peek());
                lineBuf.pop();
        }
}

References LineBuffer::hasLine(), lineBuf, LineBuffer::peek(), LineBuffer::pop(), process, processOutputLine(), processOutputRead(), and LineBuffer::write().

Referenced by LaunchContext().

Here is the call graph for this function:

processOutputLine

void LaunchContext::processOutputLine ( std::string_view sv )

signal

Referenced by processOutput().

processOutputRead

void LaunchContext::processOutputRead ( QString str )

signal

Referenced by processOutput().

processTerminated

void LaunchContext::processTerminated ( int code, QProcess::ExitStatus es, bool wasRequested )

signal

Referenced by UltragridWindow::launchPreview(), UltragridWindow::launchQuery(), processTerminationHandler(), and UltragridWindow::start().

processTerminationHandler

void LaunchContext::processTerminationHandler ( int code, QProcess::ExitStatus es )

privateslot

Definition at line 87 of file launch_manager.cpp.

                                                                            {
        emit processTerminated(code, es, terminationRequested);
}

References processTerminated(), and terminationRequested.

Referenced by LaunchContext().

Here is the call graph for this function:

terminate()

void LaunchContext::terminate

(

)

Definition at line 104 of file launch_manager.cpp.

                             {
        terminationRequested = true;
        process.terminate();
        killTimer.start(terminateTimeoutMs);
}

References killTimer, process, terminateTimeoutMs, and terminationRequested.

Member Data Documentation

args

QStringList LaunchContext::args

Definition at line 29 of file launch_manager.hpp.

executablePath

QString LaunchContext::executablePath

Definition at line 28 of file launch_manager.hpp.

extraData

std::unique_ptr<ExtraData> LaunchContext::extraData

Definition at line 32 of file launch_manager.hpp.

killTimer

QTimer LaunchContext::killTimer

private

Definition at line 43 of file launch_manager.hpp.

Referenced by LaunchContext(), and terminate().

lineBuf

LineBuffer LaunchContext::lineBuf

Definition at line 31 of file launch_manager.hpp.

Referenced by processOutput().

process

QProcess LaunchContext::process

Definition at line 30 of file launch_manager.hpp.

Referenced by LaunchContext(), processOutput(), and terminate().

terminateTimeoutMs

int LaunchContext::terminateTimeoutMs = 1000

staticconstexprprivate

Definition at line 42 of file launch_manager.hpp.

Referenced by terminate().

terminationRequested

bool LaunchContext::terminationRequested = false

private

Definition at line 44 of file launch_manager.hpp.

Referenced by processTerminationHandler(), and terminate().

type

Type LaunchContext::type = Type::None

Definition at line 27 of file launch_manager.hpp.

---

The documentation for this class was generated from the following files:

• gui/QT/util/launch_manager.hpp
• gui/QT/util/launch_manager.cpp