Add Utils

QtQuick.Studio.Utils does contain FileReader, JSONBackend
and JSONListModel.

Change-Id: I77794a3759d86d70316aaf2e128624835aa1a0cc
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>

6 files changed, 379 insertions, 0 deletions

diff --git a/src/imports/CMakeLists.txt b/src/imports/CMakeLists.txt
index e621226..eab1684 100644
--- a/src/imports/CMakeLists.txt
+++ b/src/imports/CMakeLists.txt
@@ -6,4 +6,5 @@ add_subdirectory(logichelper)
 add_subdirectory(multitext)
 add_subdirectory(tools)
 add_subdirectory(application)
+add_subdirectory(utils)
 
diff --git a/src/imports/utils/CMakeLists.txt b/src/imports/utils/CMakeLists.txt
new file mode 100644
index 0000000..adcffa5
--- /dev/null
+++ b/src/imports/utils/CMakeLists.txt
@@ -0,0 +1,19 @@
+#####################################################################
+## QuickStudioApplicationModule:
+#####################################################################
+
+qt_internal_add_qml_module(QuickStudioUtils
+    URI "QtQuick.Studio.Utils"
+    VERSION "${PROJECT_VERSION}"
+    DESIGNER_SUPPORTED
+    PAST_MAJOR_VERSIONS 1 2
+ INCLUDE_DIRECTORIES
+    ${CMAKE_CURRENT_SOURCE_DIR}
+    SOURCES
+        quickstudiofilereader.cpp quickstudiofilereader_p.h
+    QML_FILES
+        JSONListModel.qml JSONBackend.qml
+    PUBLIC_LIBRARIES
+        Qt::Qml
+        Qt::Quick
+)
diff --git a/src/imports/utils/JSONBackend.qml b/src/imports/utils/JSONBackend.qml
new file mode 100644
index 0000000..1dac1d4
--- /dev/null
+++ b/src/imports/utils/JSONBackend.qml
@@ -0,0 +1,79 @@
+/****************************************************************************
+**
+** Copyright (C) 2023 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt Quick Dialogs module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick
+import QtQuick.Studio.Utils
+
+QtObject {
+    id: server
+    property url source: Qt.resolvedUrl("server.json")
+    property string __json: fileReader.content
+
+    property FileReader fileReader: FileReader {
+        id: fileReader
+        filePath: listModel.source
+    }
+
+    on__JsonChanged: server.updateJSON()
+
+    function updateJSON() {
+
+        if (server.__json === "" )
+            return;
+
+        var objectArray = parseJSONString(server.__json, server.__query);
+        for ( var key in objectArray ) {
+            var jo = objectArray[key];
+            if (server[key] !== undefined) {
+                server[key] = jo
+            } else {
+                console.warn(key, "undefined")
+            }
+        }
+    }
+
+    function parseJSONString(jsonString, jsonPathQuery) {
+        var objectArray = JSON.parse(jsonString);
+        if ( jsonPathQuery !== "" )
+            objectArray = JSONPath.jsonPath(objectArray, jsonPathQuery);
+        else {
+            console.error("JSON parsing failed")
+        }
+
+        return objectArray;
+    }
+
+}
diff --git a/src/imports/utils/JSONListModel.qml b/src/imports/utils/JSONListModel.qml
new file mode 100644
index 0000000..edba312
--- /dev/null
+++ b/src/imports/utils/JSONListModel.qml
@@ -0,0 +1,79 @@
+/****************************************************************************
+**
+** Copyright (C) 2023 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt Quick Dialogs module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+import QtQuick
+import QtQuick.Studio.Utils
+
+ListModel {
+    id: listModel
+    property url source: Qt.resolvedUrl("listmodel.json")
+    property string __json: fileReader.content
+    property string __query
+
+
+    property FileReader fileReader: FileReader {
+        id: fileReader
+        filePath: listModel.source
+    }
+
+    on__JsonChanged: listModel.updateJSON()
+    on__QueryChanged: listModel.updateJSON()
+
+    function updateJSON() {
+        if (listModel.__json === "" )
+            return;
+
+        listModel.clear()
+
+        var objectArray = parseJSONString(listModel.__json, listModel.__query);
+        for ( var key in objectArray ) {
+            var jo = objectArray[key];
+             listModel.append( jo );
+        }
+    }
+
+    function parseJSONString(jsonString, jsonPathQuery) {
+        var objectArray = JSON.parse(jsonString);
+        if ( jsonPathQuery !== "" )
+            objectArray = JSONPath.jsonPath(objectArray, jsonPathQuery);
+        else {
+            console.error("JSON parsing failed")
+        }
+
+        return objectArray;
+    }
+
+}
diff --git a/src/imports/utils/quickstudiofilereader.cpp b/src/imports/utils/quickstudiofilereader.cpp
new file mode 100644
index 0000000..9c177bc
--- /dev/null
+++ b/src/imports/utils/quickstudiofilereader.cpp
@@ -0,0 +1,108 @@
+/****************************************************************************
+**
+** Copyright (C) 2023 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt Quick Dialogs module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "quickstudiofilereader_p.h"
+
+#include <QDir>
+#include <QDirIterator>
+#include <QFileSystemWatcher>
+#include <QLoggingCategory>
+
+QT_BEGIN_NAMESPACE
+
+static Q_LOGGING_CATEGORY(texttomodelMergerDebug, "qt.Studiofilereader.debug", QtDebugMsg)
+
+    QuickStudioFileReader::QuickStudioFileReader(QObject *parent)
+    : QObject(parent)
+{}
+
+QString QuickStudioFileReader::loadFile(const QString &path)
+{
+    qCDebug(texttomodelMergerDebug) << Q_FUNC_INFO << "Load file: " << path;
+
+    QFile file(path);
+    bool ok = file.open(QIODevice::ReadOnly);
+
+    if (!ok) {
+        qWarning() << "File cannot be opened:" << file.errorString();
+        return {};
+    }
+
+    if (m_watcher)
+        m_watcher->deleteLater();
+
+    m_watcher = new QFileSystemWatcher({path}, this);
+
+    connect(m_watcher, &QFileSystemWatcher::fileChanged, this, &QuickStudioFileReader::reload);
+
+    return file.readAll();
+}
+
+void QuickStudioFileReader::reload()
+{
+    qCDebug(texttomodelMergerDebug) << Q_FUNC_INFO << "Load file: " << m_filePath;
+
+    QString localPath;
+
+    if (m_filePath.isLocalFile())
+        localPath = m_filePath.toLocalFile();
+
+    if (m_filePath.scheme() == QStringLiteral("qrc")) {
+        const QString &path = m_filePath.path();
+        localPath = QStringLiteral(":") + path;
+    }
+
+    QString newContent = loadFile(localPath);
+
+    if (newContent != m_content) {
+        m_content = newContent;
+        emit contentChanged();
+    }
+}
+
+void QuickStudioFileReader::setFilePath(const QUrl &url)
+{
+    if (url == filePath())
+        return;
+
+    m_filePath = url;
+
+    reload();
+
+    emit filePathChanged();
+}
+
+QT_END_NAMESPACE
diff --git a/src/imports/utils/quickstudiofilereader_p.h b/src/imports/utils/quickstudiofilereader_p.h
new file mode 100644
index 0000000..0c197b2
--- /dev/null
+++ b/src/imports/utils/quickstudiofilereader_p.h
@@ -0,0 +1,93 @@
+/****************************************************************************
+**
+** Copyright (C) 2023 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the Qt Quick Dialogs module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL3$
+** Commercial License Usage
+** Licensees holding valid commercial Qt 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 http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPLv3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or later as published by the Free
+** Software Foundation and appearing in the file LICENSE.GPL included in
+** the packaging of this file. Please review the following information to
+** ensure the GNU General Public License version 2.0 requirements will be
+** met: http://www.gnu.org/licenses/gpl-2.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QUICKSTUDIOUTILS_P_H
+#define QUICKSTUDIOUTILS_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+
+#include <QtCore/qurl.h>
+#include <QtQml/qqml.h>
+
+QT_BEGIN_NAMESPACE
+
+class QFileSystemWatcher;
+
+class QuickStudioFileReader : public QObject
+{
+    Q_OBJECT
+
+    QML_NAMED_ELEMENT(FileReader)
+    QML_ADDED_IN_VERSION(6, 2)
+
+    Q_PROPERTY(QUrl filePath READ filePath WRITE setFilePath NOTIFY filePathChanged)
+    Q_PROPERTY(QString content READ content NOTIFY contentChanged)
+
+public:
+    explicit QuickStudioFileReader(QObject *parent = nullptr);
+
+    const QUrl filePath() { return m_filePath; }
+    void setFilePath(const QUrl &file);
+
+    const QString content() { return m_content; }
+
+signals:
+    void filePathChanged();
+    void contentChanged();
+
+private:
+    QString loadFile(const QString &path);
+    void reload();
+
+    QUrl m_filePath;
+    QString m_content;
+    QFileSystemWatcher *m_watcher = nullptr;
+};
+
+QT_END_NAMESPACE
+
+QML_DECLARE_TYPE(QuickStudioFileReader)
+
+#endif // QUICKSTUDIOUTILS_P_H