Utils: Copy QFileSystemModel from Qt 6.2

... and fit it into Creator's namespace scheme.

The idea is to make it operate on (possibly remote) FilePaths.

Change-Id: I469b1fa201e747d326de82f73ae5ac33e9335c10
Reviewed-by: Christian Stenger <christian.stenger@qt.io>

src/libs/utils/CMakeLists.txt

@@ -52,6 +52,7 @@ add_qtc_library(Utils
     filenamevalidatinglineedit.cpp filenamevalidatinglineedit.h
     filepath.cpp filepath.h
     filesearch.cpp filesearch.h
+    filesystemmodel.cpp filesystemmodel.h
     filesystemwatcher.cpp filesystemwatcher.h
     fileutils.cpp fileutils.h
     filewizardpage.cpp filewizardpage.h
@@ -192,7 +193,7 @@ extend_qtc_library(Utils CONDITION WIN32
   SOURCES
     touchbar/touchbar.cpp
   DEPENDS
-    user32 iphlpapi ws2_32 shell32
+    user32 iphlpapi ws2_32 shell32 ole32
   DEFINES
     _UNICODE UNICODE
   PUBLIC_DEFINES

src/libs/utils/filesystemmodel.h

@@ -0,0 +1,172 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWidgets module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** 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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://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.LGPL3 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-3.0.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 (at your option) the GNU General
+** Public license version 3 or 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.GPL2 and 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-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#pragma once
+
+#include "utils_global.h"
+
+#include <QAbstractItemModel>
+#include <QPair>
+#include <QDir>
+
+QT_BEGIN_NAMESPACE
+class QFileIconProvider;
+QT_END_NAMESPACE
+
+namespace Utils {
+
+class ExtendedInformation;
+class FileSystemModelPrivate;
+
+class QTCREATOR_UTILS_EXPORT FileSystemModel : public QAbstractItemModel
+{
+    Q_OBJECT
+
+public:
+    enum Roles {
+        FileIconRole = Qt::DecorationRole,
+        FilePathRole = Qt::UserRole + 1,
+        FileNameRole = Qt::UserRole + 2,
+        FilePermissions = Qt::UserRole + 3
+    };
+
+    enum Option
+    {
+        DontWatchForChanges         = 0x00000001,
+        DontResolveSymlinks         = 0x00000002,
+        DontUseCustomDirectoryIcons = 0x00000004
+    };
+    Q_ENUM(Option)
+    Q_DECLARE_FLAGS(Options, Option)
+
+    explicit FileSystemModel(QObject *parent = nullptr);
+    ~FileSystemModel();
+
+    QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
+    QModelIndex index(const QString &path, int column = 0) const;
+    QModelIndex parent(const QModelIndex &child) const override;
+    using QObject::parent;
+    QModelIndex sibling(int row, int column, const QModelIndex &idx) const override;
+    bool hasChildren(const QModelIndex &parent = QModelIndex()) const override;
+    bool canFetchMore(const QModelIndex &parent) const override;
+    void fetchMore(const QModelIndex &parent) override;
+
+    int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+    int columnCount(const QModelIndex &parent = QModelIndex()) const override;
+
+    QVariant myComputer(int role = Qt::DisplayRole) const;
+    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
+    bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
+
+    QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
+
+    Qt::ItemFlags flags(const QModelIndex &index) const override;
+
+    void sort(int column, Qt::SortOrder order = Qt::AscendingOrder) override;
+
+    QStringList mimeTypes() const override;
+    QMimeData *mimeData(const QModelIndexList &indexes) const override;
+    bool dropMimeData(const QMimeData *data, Qt::DropAction action,
+                      int row, int column, const QModelIndex &parent) override;
+    Qt::DropActions supportedDropActions() const override;
+    QHash<int, QByteArray> roleNames() const override;
+
+    // FileSystemModel specific API
+    QModelIndex setRootPath(const QString &path);
+    QString rootPath() const;
+    QDir rootDirectory() const;
+
+    void setIconProvider(QFileIconProvider *provider);
+    QFileIconProvider *iconProvider() const;
+
+    void setFilter(QDir::Filters filters);
+    QDir::Filters filter() const;
+
+    void setResolveSymlinks(bool enable);
+    bool resolveSymlinks() const;
+
+    void setReadOnly(bool enable);
+    bool isReadOnly() const;
+
+    void setNameFilterDisables(bool enable);
+    bool nameFilterDisables() const;
+
+    void setNameFilters(const QStringList &filters);
+    QStringList nameFilters() const;
+
+    void setOption(Option option, bool on = true);
+    bool testOption(Option option) const;
+    void setOptions(Options options);
+    Options options() const;
+
+    QString filePath(const QModelIndex &index) const;
+    bool isDir(const QModelIndex &index) const;
+    qint64 size(const QModelIndex &index) const;
+    QString type(const QModelIndex &index) const;
+    QDateTime lastModified(const QModelIndex &index) const;
+
+    QModelIndex mkdir(const QModelIndex &parent, const QString &name);
+    bool rmdir(const QModelIndex &index);
+    QString fileName(const QModelIndex &aindex) const;
+    QIcon fileIcon(const QModelIndex &aindex) const;
+    QFile::Permissions permissions(const QModelIndex &index) const;
+    QFileInfo fileInfo(const QModelIndex &index) const;
+    bool remove(const QModelIndex &index);
+
+signals:
+    void rootPathChanged(const QString &newPath);
+    void fileRenamed(const QString &path, const QString &oldName, const QString &newName);
+    void directoryLoaded(const QString &path);
+
+protected:
+    void timerEvent(QTimerEvent *event) override;
+    bool event(QEvent *event) override;
+
+private:
+    FileSystemModelPrivate *d = nullptr;
+
+    friend class FileSystemModelPrivate;
+    friend class QFileDialogPrivate;
+};
+
+} // Utils
+
+QT_BEGIN_NAMESPACE
+Q_DECLARE_OPERATORS_FOR_FLAGS(Utils::FileSystemModel::Options)
+QT_END_NAMESPACE

src/libs/utils/utils-lib.pri

@@ -13,6 +13,8 @@ CONFIG += exceptions # used by portlist.cpp, textfileformat.cpp, and ssh/*
 win32: LIBS += -luser32 -lshell32
 # PortsGatherer
 win32: LIBS += -liphlpapi -lws2_32
+# FileSystemModel
+win32: LIBS *= -lole32
 
 SOURCES += \
     $$PWD/globalfilechangeblocker.cpp \
@@ -45,6 +47,7 @@ SOURCES += \
     $$PWD/wizard.cpp \
     $$PWD/wizardpage.cpp \
     $$PWD/filewizardpage.cpp \
+    $$PWD/filesystemmodel.cpp \
     $$PWD/filesystemwatcher.cpp \
     $$PWD/projectintropage.cpp \
     $$PWD/filenamevalidatinglineedit.cpp \
@@ -184,6 +187,7 @@ HEADERS += \
     $$PWD/wizard.h \
     $$PWD/wizardpage.h \
     $$PWD/filewizardpage.h \
+    $$PWD/filesystemmodel.h \
     $$PWD/filesystemwatcher.h \
     $$PWD/projectintropage.h \
     $$PWD/filenamevalidatinglineedit.h \

src/libs/utils/utils.qbs

@@ -12,7 +12,7 @@ Project {
         cpp.dynamicLibraries: {
             var libs = [];
             if (qbs.targetOS.contains("windows")) {
-                libs.push("user32", "iphlpapi", "ws2_32", "shell32");
+                libs.push("user32", "iphlpapi", "ws2_32", "shell32", "ole32");
             } else if (qbs.targetOS.contains("unix")) {
                 if (!qbs.targetOS.contains("macos"))
                     libs.push("X11");
@@ -117,6 +117,8 @@ Project {
             "filepath.h",
             "filesearch.cpp",
             "filesearch.h",
+            "filesystemmodel.cpp",
+            "filesystemmodel.h",
             "filesystemwatcher.cpp",
             "filesystemwatcher.h",
             "fileutils.cpp",