aboutsummaryrefslogtreecommitdiffstats
path: root/src/livenodeengine.h
blob: ce8a56f9c8b71400dae7d2deef26c6d871fa3681 (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
/****************************************************************************
**
** Copyright (C) 2016 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QmlLive tool.
**
** $QT_BEGIN_LICENSE:GPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company.  For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: GPL-3.0
**
****************************************************************************/

#pragma once

#include <QtCore>
#include <QtQuick>

#include "contentadapterinterface.h"

class LiveRuntime;
class ContentPluginFactory;
class OverlayUrlInterceptor;

class LiveNodeEngine : public QObject
{
    Q_OBJECT

public:
    enum WorkspaceOption {
        NoWorkspaceOption = 0x0,
        LoadDummyData = 0x1,
        AllowUpdates = 0x2,
        UpdatesAsOverlay = 0x4
    };
    Q_DECLARE_FLAGS(WorkspaceOptions, WorkspaceOption)
#if QT_VERSION >= QT_VERSION_CHECK(5, 5, 0)
    Q_FLAG(WorkspaceOptions)
#else
    Q_FLAGS(WorkspaceOptions)
#endif

public:
    explicit LiveNodeEngine(QObject *parent = 0);
    ~LiveNodeEngine();

    QQmlEngine *qmlEngine() const;
    void setQmlEngine(QQmlEngine *qmlEngine);

    QQuickView *fallbackView() const;
    void setFallbackView(QQuickView *fallbackView);

    int xOffset() const;
    int yOffset() const;
    int rotation() const;

    QString workspace() const;
    void setWorkspace(const QString &path, WorkspaceOptions options = NoWorkspaceOption);

    void setPluginPath(const QString& path);
    QString pluginPath() const;

    QUrl activeDocument() const;
    ContentAdapterInterface *activePlugin() const;
    QQuickWindow *activeWindow() const;

public Q_SLOTS:
    void setXOffset(int offset);
    void setYOffset(int offset);
    void setRotation(int rotation);
    void setActiveDocument(const QString& document);
    void loadDocument(const QUrl& url);
    void delayReload();
    virtual void reloadDocument();
    void updateDocument(const QString &document, const QByteArray &content);

Q_SIGNALS:
    void activateDocument(const QString& document);
    void clearLog();
    void logIgnoreMessages(bool on);
    void documentLoaded();
    void activeWindowChanged(QQuickWindow *window);
    void logErrors(const QList<QQmlError> &errors);
    void workspaceChanged(const QString &workspace);

protected:
    virtual void initPlugins();
    QList<ContentAdapterInterface*> m_plugins;
    QUrl m_activeFile;
    LiveRuntime *m_runtime;

private Q_SLOTS:
    void onSizeChanged();

private:
    void checkQmlFeatures();
    QUrl errorScreenUrl() const;
    QUrl queryDocumentViewer(const QUrl& url);
    void initOverlay();
    void destroyOverlay();

private:
    int m_xOffset;
    int m_yOffset;
    int m_rotation;

    QPointer<QQmlEngine> m_qmlEngine;
    QPointer<QQuickView> m_fallbackView;
    QPointer<QObject> m_object;
    QPointer<QQuickWindow> m_activeWindow;
    QList<QMetaObject::Connection> m_activeWindowConnections;
    QDir m_workspace;
    WorkspaceOptions m_workspaceOptions;
    QPointer<OverlayUrlInterceptor> m_overlayUrlInterceptor;
    QTimer *m_delayReload;

    ContentPluginFactory* m_pluginFactory;
    ContentAdapterInterface* m_activePlugin;

    ContentAdapterInterface::Features m_quickFeatures;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(LiveNodeEngine::WorkspaceOptions)