summaryrefslogtreecommitdiff
path: root/src/manager-lib/application.h
blob: aba684e2b673416a24f3162d03a3b993f448d1d3 (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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
// 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

#pragma once

#include <QObject>
#include <QScopedPointer>
#include <QVariantMap>
#include <QUrl>
#include <QtAppManApplication/applicationinfo.h>
#include <QtAppManApplication/packageinfo.h>
#include <QtAppManManager/amnamespace.h>
#include <QtAppManCommon/global.h>

QT_BEGIN_NAMESPACE_AM

class AbstractRuntime;

// A place to collect functions used internally by appman without polluting
// Application's public QML API.
class ApplicationRequests
{
public:
    std::function<bool(const QString &documentUrl)> startRequested;
    std::function<bool(const QString &debugWrapper, const QString &documentUrl)> debugRequested;
    std::function<void(bool forceKill)> stopRequested;
};

class Package;

class Application : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("AM-QmlType", "QtApplicationManager.SystemUI/ApplicationObject 2.0 UNCREATABLE")

    Q_PROPERTY(QString id READ id CONSTANT)
    Q_PROPERTY(QString name READ name NOTIFY bulkChange)
    Q_PROPERTY(QVariantMap names READ names NOTIFY bulkChange)
    Q_PROPERTY(QString description READ description NOTIFY bulkChange)
    Q_PROPERTY(QVariantMap descriptions READ descriptions NOTIFY bulkChange)
    Q_PROPERTY(QStringList categories READ categories NOTIFY bulkChange)
    Q_PROPERTY(QUrl icon READ icon NOTIFY bulkChange)
    Q_PROPERTY(QString runtimeName READ runtimeName CONSTANT)
    Q_PROPERTY(QVariantMap runtimeParameters READ runtimeParameters CONSTANT)
    Q_PROPERTY(QStringList capabilities READ capabilities CONSTANT)
    Q_PROPERTY(QString documentUrl READ documentUrl CONSTANT)
    Q_PROPERTY(QStringList supportedMimeTypes READ supportedMimeTypes CONSTANT)
    Q_PROPERTY(QVariantMap applicationProperties READ applicationProperties CONSTANT)
    Q_PROPERTY(AbstractRuntime *runtime READ currentRuntime NOTIFY runtimeChanged)
    Q_PROPERTY(int lastExitCode READ lastExitCode NOTIFY lastExitCodeChanged)
    Q_PROPERTY(QT_PREPEND_NAMESPACE_AM(Am::ExitStatus) lastExitStatus READ lastExitStatus NOTIFY lastExitStatusChanged)
    Q_PROPERTY(QString codeDir READ codeDir NOTIFY bulkChange)
    Q_PROPERTY(QT_PREPEND_NAMESPACE_AM(Am::RunState) runState READ runState NOTIFY runStateChanged)
    Q_PROPERTY(Package *package READ package CONSTANT)

    // legacy, forwarded to Package
    Q_PROPERTY(bool builtIn READ isBuiltIn CONSTANT)
    Q_PROPERTY(bool alias READ isAlias CONSTANT)
    Q_PROPERTY(Application *nonAliased READ nonAliased CONSTANT)
    Q_PROPERTY(QString version READ version CONSTANT)
    Q_PROPERTY(State state READ state NOTIFY stateChanged)
    Q_PROPERTY(bool blocked READ isBlocked NOTIFY blockedChanged)

    // internal
    Q_PROPERTY(bool supportsApplicationInterface READ supportsApplicationInterface CONSTANT)

public:
    enum State { // kept for compatibility ... in reality moved to class Package
        Installed,
        BeingInstalled,
        BeingUpdated,
        BeingDowngraded,
        BeingRemoved
    };
    Q_ENUM(State)

    Application(ApplicationInfo *info, Package *package);

    Q_INVOKABLE bool start(const QString &documentUrl = QString());
    Q_INVOKABLE bool debug(const QString &debugWrapper, const QString &documentUrl = QString());
    Q_INVOKABLE void stop(bool forceKill = false);

    ApplicationInfo *info() const;
    PackageInfo *packageInfo() const;
    Package *package() const;

    // legacy compatibility
    bool isAlias() const { return false; }
    Application *nonAliased() { return this; }
    QString documentUrl() const;
    QStringList supportedMimeTypes() const;
    bool isBlocked() const;

    // Properties that mainly forward content from ApplicationInfo
    QString id() const;
    QUrl icon() const;
    QStringList categories() const;
    QString name() const;
    QVariantMap names() const;
    QString description() const;
    QVariantMap descriptions() const;
    bool isBuiltIn() const;
    QString runtimeName() const;
    QVariantMap runtimeParameters() const;
    QStringList capabilities() const;
    QVariantMap applicationProperties() const;
    bool supportsApplicationInterface() const;
    QString codeDir() const;
    QString version() const;

    // Properties present only in Application (not coming from ApplicationInfo)

    AbstractRuntime *currentRuntime() const { return m_runtime; }
    State state() const;
    qreal progress() const;
    Am::RunState runState() const { return m_runState; }
    int lastExitCode() const { return m_lastExitCode; }
    Am::ExitStatus lastExitStatus() const { return m_lastExitStatus; }

    ApplicationRequests requests;

    void setRunState(Am::RunState runState);
    void setCurrentRuntime(AbstractRuntime *runtime);

signals:
    void bulkChange();
    void runtimeChanged();
    void lastExitCodeChanged();
    void lastExitStatusChanged();
    void activated();
    void stateChanged(QT_PREPEND_NAMESPACE_AM(Application::State) state);
    void runStateChanged(QT_PREPEND_NAMESPACE_AM(Am::RunState) state);
    void blockedChanged(bool blocked);

private:
    void setLastExitCodeAndStatus(int exitCode, Am::ExitStatus exitStatus);

    ApplicationInfo *m_info = nullptr;
    Package *m_package = nullptr;
    AbstractRuntime *m_runtime = nullptr;

    Am::RunState m_runState = Am::NotRunning;

    int m_lastExitCode = 0;
    Am::ExitStatus m_lastExitStatus = Am::NormalExit;

};

QDebug operator<<(QDebug debug, const Application *app);

QT_END_NAMESPACE_AM

Q_DECLARE_METATYPE(const QT_PREPEND_NAMESPACE_AM(Application *))