From cfda1a04cb7a0b389fc067fe2cccdbde93ebde27 Mon Sep 17 00:00:00 2001
From: Michal Klocek <michal.klocek@qt.io>
Date: Thu, 20 Aug 2020 07:17:23 +0200
Subject: Introduce qml script collection and make webscript as basic type

In widget apis webenginescripts are value types and are managed
by webenginescriptcollection. Introduce same concept in qml and
make qquickwebenginescript a value type and reuse core userscript
as private implementation. Rewrite webenginscript list handling.

This patch is half baked since it does not include docs and tests
for new api, however aim is to move script classes to core and reuse
those in qml land. Therefore, new class introduced here is going to
be removed in follow up patches, so all the missing parts will be added
later. A new way of managing scripts in qml is as follows:

  * using collection with javascript dictionaries

    var script = { name: "FOO"
                   sourceUrl: Qt.resolvedUrl("foo.js"),
                   injectionPoint: WebEngineScript.DocumentReady }

    webEngineView.userScripts.collection = [ script1, script2 ];

  * using collection with webscript basic type

    var script = WebEngine.script()
    script.name = "FOO"
    webEngineView.userScripts.collection = [ script ];

  * using fine grain user script collection api with basic type

    var script = WebEngine.script()
    script.name = "FOO"
    webEngineView.userScripts.insert(script)

Of course new api can be extended and we can provide more convince
overloads.

Note the main motivation here is to enable reuse webenginescript object
created in c++ land, which is now passed as value in follow up
patches.

This changes reuses private apis of qml and will most likely require
further changes when QTBUG-82443 is completed.

[ChangeLog] WebEngineScript is a basic value type in qml, it is no
longer declarative way of creating it, instead use WebEngine.script()

Change-Id: I6a0ac3607e4522ccaefcec0a7d2986577d7e7024
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
---
 src/core/user_script.cpp | 16 +++++++++++++++-
 src/core/user_script.h   |  5 +++++
 2 files changed, 20 insertions(+), 1 deletion(-)

(limited to 'src/core')

diff --git a/src/core/user_script.cpp b/src/core/user_script.cpp
index 912b204b7..6f5828cbf 100644
--- a/src/core/user_script.cpp
+++ b/src/core/user_script.cpp
@@ -81,6 +81,7 @@ UserScript::UserScript(const UserScript &other)
         return;
     scriptData.reset(new UserScriptData(*other.scriptData));
     m_name = other.m_name;
+    m_url = other.m_url;
 }
 
 UserScript::~UserScript()
@@ -96,6 +97,7 @@ UserScript &UserScript::operator=(const UserScript &other)
     }
     scriptData.reset(new UserScriptData(*other.scriptData));
     m_name = other.m_name;
+    m_url = other.m_url;
     return *this;
 }
 
@@ -125,6 +127,16 @@ void UserScript::setSourceCode(const QString &source)
     parseMetadataHeader();
 }
 
+QUrl UserScript::sourceUrl() const
+{
+    return m_url;
+}
+
+void UserScript::setSourceUrl(const QUrl &url)
+{
+    m_url = url;
+}
+
 UserScript::InjectionPoint UserScript::injectionPoint() const
 {
     if (isNull())
@@ -173,7 +185,9 @@ bool UserScript::operator==(const UserScript &other) const
     return worldId() == other.worldId()
             && runsOnSubFrames() == other.runsOnSubFrames()
             && injectionPoint() == other.injectionPoint()
-            && name() == other.name() && sourceCode() == other.sourceCode();
+            && name() == other.name()
+            && sourceCode() == other.sourceCode()
+            && sourceUrl() == other.sourceUrl();
 }
 
 void UserScript::initData()
diff --git a/src/core/user_script.h b/src/core/user_script.h
index 8f65f4b74..07fba90f4 100644
--- a/src/core/user_script.h
+++ b/src/core/user_script.h
@@ -56,6 +56,7 @@
 #include <QtCore/QScopedPointer>
 #include <QtCore/QSharedData>
 #include <QtCore/QString>
+#include <QtCore/QUrl>
 
 struct UserScriptData;
 
@@ -84,6 +85,9 @@ public:
     QString sourceCode() const;
     void setSourceCode(const QString &);
 
+    QUrl sourceUrl() const;
+    void setSourceUrl(const QUrl &);
+
     InjectionPoint injectionPoint() const;
     void setInjectionPoint(InjectionPoint);
 
@@ -103,6 +107,7 @@ private:
 
     QScopedPointer<UserScriptData> scriptData;
     QString m_name;
+    QUrl m_url;
 };
 
 } // namespace QtWebEngineCore
-- 
cgit v1.2.3