Implement page lifecycle API

[ChangeLog][QtWebEngine][WebEngineView] WebEngineView now supports lifecycle
states that can be used for reducing CPU and memory consumption of invisible
views.
[ChangeLog][QtWebEngineWidgets][QWebEnginePage] QWebEnginePage now supports
lifecycle states that can be used for reducing CPU and memory consumption of
invisible pages.

Fixes: QTBUG-74166
Fixes: QTBUG-55079
Change-Id: I7d70c85dc995bd17c9fe91385a8e2750dbc0a627
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Peter Varga <pvarga@inf.u-szeged.hu>
 
 
 

3 files changed, 63 insertions, 6 deletions

diff --git a/src/webengine/api/qquickwebengineview.cpp b/src/webengine/api/qquickwebengineview.cpp
index 02c9b4d00..c92e8caab 100644
--- a/src/webengine/api/qquickwebengineview.cpp
+++ b/src/webengine/api/qquickwebengineview.cpp
@@ -705,6 +705,25 @@ const QObject *QQuickWebEngineViewPrivate::holdingQObject() const
     return q;
 }
 
+void QQuickWebEngineViewPrivate::lifecycleStateChanged(LifecycleState state)
+{
+    Q_Q(QQuickWebEngineView);
+    Q_EMIT q->lifecycleStateChanged(static_cast<QQuickWebEngineView::LifecycleState>(state));
+}
+
+void QQuickWebEngineViewPrivate::recommendedStateChanged(LifecycleState state)
+{
+    Q_Q(QQuickWebEngineView);
+    QTimer::singleShot(0, q, [q, state]() {
+        Q_EMIT q->recommendedStateChanged(static_cast<QQuickWebEngineView::LifecycleState>(state));
+    });
+}
+
+void QQuickWebEngineViewPrivate::visibleChanged(bool visible)
+{
+    Q_UNUSED(visible);
+}
+
 #ifndef QT_NO_ACCESSIBILITY
 QQuickWebEngineViewAccessible::QQuickWebEngineViewAccessible(QQuickWebEngineView *o)
     : QAccessibleObject(o)
@@ -844,8 +863,8 @@ void QQuickWebEngineViewPrivate::initializationFinished()
     for (QQuickWebEngineScript *script : qAsConst(m_userScripts))
         script->d_func()->bind(profileAdapter()->userResourceController(), adapter.data());
 
-    if (q->window() && q->isVisible())
-        adapter->wasShown();
+    if (q->window())
+        adapter->setVisible(q->isVisible());
 
     if (!m_isBeingAdopted)
         return;
@@ -1617,10 +1636,8 @@ void QQuickWebEngineView::itemChange(ItemChange change, const ItemChangeData &va
     Q_D(QQuickWebEngineView);
     if (d && d->profileInitialized() && d->adapter->isInitialized()
             && (change == ItemSceneChange || change == ItemVisibleHasChanged)) {
-        if (window() && isVisible())
-            d->adapter->wasShown();
-        else
-            d->adapter->wasHidden();
+        if (window())
+            d->adapter->setVisible(isVisible());
     }
     QQuickItem::itemChange(change, value);
 }
@@ -2132,6 +2149,24 @@ void QQuickWebEngineView::lazyInitialize()
     d->ensureContentsAdapter();
 }
 
+QQuickWebEngineView::LifecycleState QQuickWebEngineView::lifecycleState() const
+{
+    Q_D(const QQuickWebEngineView);
+    return static_cast<LifecycleState>(d->adapter->lifecycleState());
+}
+
+void QQuickWebEngineView::setLifecycleState(LifecycleState state)
+{
+    Q_D(QQuickWebEngineView);
+    d->adapter->setLifecycleState(static_cast<WebContentsAdapterClient::LifecycleState>(state));
+}
+
+QQuickWebEngineView::LifecycleState QQuickWebEngineView::recommendedState() const
+{
+    Q_D(const QQuickWebEngineView);
+    return static_cast<LifecycleState>(d->adapter->recommendedState());
+}
+
 QQuickWebEngineFullScreenRequest::QQuickWebEngineFullScreenRequest()
     : m_viewPrivate(0)
     , m_toggleOn(false)
diff --git a/src/webengine/api/qquickwebengineview_p.h b/src/webengine/api/qquickwebengineview_p.h
index efbd0e3d0..3c8e1d9ec 100644
--- a/src/webengine/api/qquickwebengineview_p.h
+++ b/src/webengine/api/qquickwebengineview_p.h
@@ -109,6 +109,7 @@ private:
 
 class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineView : public QQuickItem {
     Q_OBJECT
+    Q_CLASSINFO("RegisterEnumClassesUnscoped", "false")
     Q_PROPERTY(QUrl url READ url WRITE setUrl NOTIFY urlChanged FINAL)
     Q_PROPERTY(QUrl icon READ icon NOTIFY iconChanged FINAL)
     Q_PROPERTY(bool loading READ isLoading NOTIFY loadingChanged FINAL)
@@ -137,6 +138,9 @@ class Q_WEBENGINE_PRIVATE_EXPORT QQuickWebEngineView : public QQuickItem {
     Q_PROPERTY(QQuickWebEngineTestSupport *testSupport READ testSupport WRITE setTestSupport NOTIFY testSupportChanged FINAL)
 #endif
 
+    Q_PROPERTY(LifecycleState lifecycleState READ lifecycleState WRITE setLifecycleState NOTIFY lifecycleStateChanged REVISION 11 FINAL)
+    Q_PROPERTY(LifecycleState recommendedState READ recommendedState NOTIFY recommendedStateChanged REVISION 11 FINAL)
+
 public:
     QQuickWebEngineView(QQuickItem *parent = 0);
     ~QQuickWebEngineView();
@@ -461,6 +465,14 @@ public:
     };
     Q_ENUM(PrintedPageOrientation)
 
+    // must match WebContentsAdapterClient::LifecycleState
+    enum class LifecycleState {
+        Active,
+        Frozen,
+        Discarded,
+    };
+    Q_ENUM(LifecycleState)
+
     // QmlParserStatus
     void componentComplete() override;
 
@@ -492,6 +504,11 @@ public:
     void setDevToolsView(QQuickWebEngineView *);
     QQuickWebEngineView *devToolsView() const;
 
+    LifecycleState lifecycleState() const;
+    void setLifecycleState(LifecycleState state);
+
+    LifecycleState recommendedState() const;
+
 public Q_SLOTS:
     void runJavaScript(const QString&, const QJSValue & = QJSValue());
     Q_REVISION(3) void runJavaScript(const QString&, quint32 worldId, const QJSValue & = QJSValue());
@@ -555,6 +572,8 @@ Q_SIGNALS:
     Q_REVISION(8) void printRequested();
     Q_REVISION(9) void selectClientCertificate(QQuickWebEngineClientCertificateSelection *clientCertSelection);
     Q_REVISION(10) void tooltipRequested(QQuickWebEngineTooltipRequest *request);
+    Q_REVISION(11) void lifecycleStateChanged(LifecycleState state);
+    Q_REVISION(11) void recommendedStateChanged(LifecycleState state);
 
 #if QT_CONFIG(webengine_testsupport)
     void testSupportChanged();
diff --git a/src/webengine/api/qquickwebengineview_p_p.h b/src/webengine/api/qquickwebengineview_p_p.h
index aa0a765f8..134d8237b 100644
--- a/src/webengine/api/qquickwebengineview_p_p.h
+++ b/src/webengine/api/qquickwebengineview_p_p.h
@@ -101,6 +101,9 @@ public:
     QtWebEngineCore::RenderWidgetHostViewQtDelegate* CreateRenderWidgetHostViewQtDelegate(QtWebEngineCore::RenderWidgetHostViewQtDelegateClient *client) override;
     QtWebEngineCore::RenderWidgetHostViewQtDelegate* CreateRenderWidgetHostViewQtDelegateForPopup(QtWebEngineCore::RenderWidgetHostViewQtDelegateClient *client) override;
     void initializationFinished() override;
+    void lifecycleStateChanged(LifecycleState state) override;
+    void recommendedStateChanged(LifecycleState state) override;
+    void visibleChanged(bool visible) override;
     void titleChanged(const QString&) override;
     void urlChanged(const QUrl&) override;
     void iconChanged(const QUrl&) override;