Add FileDialog class

Author: adazem009

src/uicomponents/CMakeLists.txt

@@ -16,6 +16,8 @@ set(MODULE_SRC
     menumodel.h
     menuitemmodel.cpp
     menuitemmodel.h
+    filedialog.cpp
+    filedialog.h
 )
 
 include(${PROJECT_SOURCE_DIR}/build/module.cmake)

src/uicomponents/filedialog.cpp

@@ -0,0 +1,121 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#include <QFileInfo>
+#include <QFileDialog>
+
+#include "filedialog.h"
+
+using namespace scratchcpp::uicomponents;
+
+FileDialog::FileDialog(QObject *parent) :
+    QObject(parent)
+{
+}
+
+const QStringList &FileDialog::nameFilters(void) const
+{
+    return m_nameFilters;
+}
+
+void FileDialog::setNameFilters(const QStringList &filters)
+{
+    m_nameFilters = filters;
+    emit nameFiltersChanged();
+}
+
+bool FileDialog::showAllFiles(void) const
+{
+    return m_showAllFiles;
+}
+
+void FileDialog::setShowAllFiles(bool value)
+{
+    m_showAllFiles = value;
+    emit showAllFilesChanged();
+}
+
+const QString &FileDialog::fileName(void) const
+{
+    return m_fileName;
+}
+
+QString FileDialog::shortFileName(void) const
+{
+    QFileInfo fileInfo(m_fileName);
+    return fileInfo.fileName();
+}
+
+const QString &FileDialog::defaultSuffix() const
+{
+    return m_defaultSuffix;
+}
+
+void FileDialog::setDefaultSuffix(const QString &newDefaultSuffix)
+{
+    if (m_defaultSuffix == newDefaultSuffix)
+        return;
+
+    m_defaultSuffix = newDefaultSuffix;
+    emit defaultSuffixChanged();
+}
+
+void FileDialog::getOpenFileContent(void)
+{
+    auto fileContentReadyLambda = [this](const QString &fileName, const QByteArray &fileContent) {
+        if (!fileName.isEmpty()) {
+            m_fileName = fileName;
+            emit fileNameChanged();
+            emit shortFileNameChanged();
+            emit fileContentReady(fileContent);
+        }
+    };
+
+#ifdef Q_OS_WASM
+    QFileDialog::getOpenFileContent(QString(), fileContentReadyLambda);
+#else
+    QString fileName = QFileDialog::getOpenFileName(nullptr, QString(), QString(), getFilters());
+
+    if (fileName != "") {
+        QFile file(fileName);
+
+        if (file.open(QIODevice::ReadOnly))
+            fileContentReadyLambda(fileName, file.readAll());
+    }
+#endif
+}
+
+QString FileDialog::getOpenFileName() const
+{
+    QFileDialog dialog(nullptr, QString(), QString(), getFilters());
+    dialog.setFileMode(QFileDialog::AnyFile);
+    dialog.setAcceptMode(QFileDialog::AcceptOpen);
+    dialog.setDefaultSuffix(m_defaultSuffix);
+
+    if (dialog.exec() == QDialog::Accepted)
+        return dialog.selectedFiles().at(0);
+    else
+        return "";
+}
+
+QString FileDialog::getSaveFileName() const
+{
+    QFileDialog dialog(nullptr, QString(), QString(), getFilters());
+    dialog.setFileMode(QFileDialog::AnyFile);
+    dialog.setAcceptMode(QFileDialog::AcceptSave);
+    dialog.setDefaultSuffix(m_defaultSuffix);
+
+    if (dialog.exec() == QDialog::Accepted)
+        return dialog.selectedFiles().at(0);
+    else
+        return "";
+}
+
+QString FileDialog::getFilters() const
+{
+    QString filtersStr = m_nameFilters.join(";;");
+
+    if (m_showAllFiles)
+        filtersStr += ";;" + tr("All files") + " (*)";
+
+    return filtersStr;
+}

src/uicomponents/filedialog.h

@@ -0,0 +1,56 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+#pragma once
+
+#include <QQmlEngine>
+
+namespace scratchcpp::uicomponents
+{
+
+class FileDialog : public QObject
+{
+        Q_OBJECT
+        QML_ELEMENT
+        Q_PROPERTY(QStringList nameFilters READ nameFilters WRITE setNameFilters NOTIFY nameFiltersChanged)
+        Q_PROPERTY(bool showAllFiles READ showAllFiles WRITE setShowAllFiles NOTIFY showAllFilesChanged)
+        Q_PROPERTY(QString fileName READ fileName NOTIFY fileNameChanged)
+        Q_PROPERTY(QString shortFileName READ shortFileName NOTIFY shortFileNameChanged)
+        Q_PROPERTY(QString defaultSuffix READ defaultSuffix WRITE setDefaultSuffix NOTIFY defaultSuffixChanged)
+
+    public:
+        explicit FileDialog(QObject *parent = nullptr);
+
+        const QStringList &nameFilters(void) const;
+        void setNameFilters(const QStringList &filters);
+
+        bool showAllFiles(void) const;
+        void setShowAllFiles(bool value);
+
+        const QString &fileName(void) const;
+        QString shortFileName(void) const;
+
+        const QString &defaultSuffix() const;
+        void setDefaultSuffix(const QString &newDefaultSuffix);
+
+        Q_INVOKABLE void getOpenFileContent(void);
+        Q_INVOKABLE QString getOpenFileName(void) const;
+        Q_INVOKABLE QString getSaveFileName() const;
+
+    private:
+        QString getFilters() const;
+
+        QStringList m_nameFilters;
+        bool m_showAllFiles = true;
+        QString m_fileName;
+        QString m_defaultSuffix;
+
+    signals:
+        void nameFiltersChanged();
+        void showAllFilesChanged();
+        void fileNameChanged();
+        void shortFileNameChanged();
+        void defaultSuffixChanged();
+        void fileContentReady(const QByteArray &content);
+};
+
+} // namespace scratchcpp::uicomponents

src/uicomponents/test/CMakeLists.txt

@@ -2,6 +2,7 @@ set(MODULE_TEST_SRC
     menuitemmodel.cpp
     menumodel.cpp
     menubarmodel.cpp
+    filedialog.cpp
 )
 
 include(${PROJECT_SOURCE_DIR}/build/module_test.cmake)

src/uicomponents/test/filedialog.cpp

@@ -0,0 +1,47 @@
+#include <gtest/gtest.h>
+
+#include "filedialog.h"
+
+using namespace scratchcpp::uicomponents;
+
+TEST(FileDialogTest, Constructor)
+{
+    FileDialog dialog1;
+    FileDialog dialog2(&dialog1);
+    ASSERT_EQ(dialog1.parent(), nullptr);
+    ASSERT_EQ(dialog2.parent(), &dialog1);
+}
+
+TEST(FileDialogTest, NameFilters)
+{
+    FileDialog dialog;
+    ASSERT_TRUE(dialog.nameFilters().isEmpty());
+
+    QStringList filters({ "a", "b", "c" });
+    dialog.setNameFilters(filters);
+    ASSERT_EQ(dialog.nameFilters(), filters);
+}
+
+TEST(FileDialogTest, ShowAllFiles)
+{
+    FileDialog dialog;
+    ASSERT_TRUE(dialog.showAllFiles());
+
+    dialog.setShowAllFiles(false);
+    ASSERT_FALSE(dialog.showAllFiles());
+
+    dialog.setShowAllFiles(false);
+    ASSERT_FALSE(dialog.showAllFiles());
+
+    dialog.setShowAllFiles(true);
+    ASSERT_TRUE(dialog.showAllFiles());
+}
+
+TEST(FileDialogTest, DefaultSuffix)
+{
+    FileDialog dialog;
+    ASSERT_TRUE(dialog.defaultSuffix().isEmpty());
+
+    dialog.setDefaultSuffix(".txt");
+    ASSERT_EQ(dialog.defaultSuffix(), ".txt");
+}