summaryrefslogtreecommitdiffstats
path: root/src/manager-lib/abstractcontainer.h
blob: 0b35fba7cbf356a040fc9942f51cb9fbe2f63b5f (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
// Copyright (C) 2021 The Qt Company Ltd.
// Copyright (C) 2019 Luxoft Sweden AB
// Copyright (C) 2018 Pelagicore AG
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only

#ifndef ABSTRACTCONTAINER_H
#define ABSTRACTCONTAINER_H

#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QVariantMap>
#include <QtCore/QVector>

#include <QtAppManCommon/global.h>
#include <QtAppManManager/amnamespace.h>

QT_BEGIN_NAMESPACE_AM

class Application;
class AbstractContainer;

class AbstractContainerManager : public QObject
{
    Q_OBJECT
public:
    AbstractContainerManager(const QString &id, QObject *parent = nullptr);

    static QString defaultIdentifier();

    QString identifier() const;
    virtual bool supportsQuickLaunch() const;

    virtual AbstractContainer *create(Application *app, QVector<int> &&stdioRedirections,
                                      const QMap<QString, QString> &debugWrapperEnvironment,
                                      const QStringList &debugWrapperCommand) = 0;

    QVariantMap configuration() const;
    virtual void setConfiguration(const QVariantMap &configuration);

private:
    QString m_id;
    QVariantMap m_configuration;
};

class AbstractContainerProcess : public QObject
{
    Q_OBJECT

public:
    virtual qint64 processId() const = 0;
    virtual Am::RunState state() const = 0;

public Q_SLOTS:
    virtual void stop(QtAM::Am::ExitStatus exitStatus) = 0;

Q_SIGNALS:
    void started();
    void errorOccured(QtAM::Am::ProcessError error);
    void finished(int exitCode, QtAM::Am::ExitStatus status);
    void stateChanged(QtAM::Am::RunState newState);
};

class AbstractContainer : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString controlGroup READ controlGroup WRITE setControlGroup NOTIFY controlGroupChanged FINAL)
    Q_PROPERTY(bool hasDebugWrapper READ hasDebugWrapper CONSTANT FINAL)

public:
    ~AbstractContainer() override;

    virtual QString controlGroup() const;
    virtual bool setControlGroup(const QString &groupName);

    virtual bool setProgram(const QString &program);
    virtual void setBaseDirectory(const QString &baseDirectory);

    virtual bool isReady() = 0;
    virtual bool hasDebugWrapper() const = 0;

    virtual QString mapContainerPathToHost(const QString &containerPath) const;
    virtual QString mapHostPathToContainer(const QString &hostPath) const;

    virtual AbstractContainerProcess *start(const QStringList &arguments,
                                            const QMap<QString, QString> &runtimeEnvironment,
                                            const QVariantMap &amConfig) = 0;

    AbstractContainerProcess *process() const;

    void setApplication(Application *app);
    Application *application() const;

Q_SIGNALS:
    void ready();
    void memoryLowWarning();
    void memoryCriticalWarning();
    void applicationChanged(QtAM::Application *newApplication);
    void controlGroupChanged(const QString &controlGroup);

protected:
    explicit AbstractContainer(AbstractContainerManager *manager, Application *app);

    QVariantMap configuration() const;

    QString m_program;
    QString m_baseDirectory;
    AbstractContainerManager *m_manager;
    AbstractContainerProcess *m_process = nullptr;
    Application *m_app;
};

QT_END_NAMESPACE_AM

Q_DECLARE_METATYPE(QtAM::AbstractContainer *)

#endif // ABSTRACTCONTAINER_H