Implement the VivyDocument specification

Load and write to VivyDocuments.

While at it, refactor of {Audio,Video}Context and their streams and fix all warnings in headers with clang. Only place external headers in the precompiled header, not Vivy's ones.

Includes a small API update for the VideoSubDocument (ass the VideoContext with some getters).

Depends on !19 (merged)

src/UI/MainWindow.cc

@@ -6,27 +6,6 @@
 #include "../Lib/Utils.hh"
 #include "../VivyApplication.hh"
 
-#include <mutex>
-#include <algorithm>
-#include <functional>
-#include <QWindow>
-#include <optional>
-#include <QTreeView>
-#include <QPushButton>
-#include <QDialogButtonBox>
-#include <QFileInfo>
-#include <QStandardPaths>
-#include <QPixmap>
-#include <QVBoxLayout>
-#include <QMessageBox>
-#include <QFileDialog>
-#include <QStatusBar>
-#include <QMenuBar>
-#include <QImage>
-#include <QToolBar>
-#include <QTabWidget>
-#include <QEventLoop>
-
 #define DCL_MENU(menu, name) [[maybe_unused]] QMenu *menu##Menu = menuBar()->addMenu(name);
 
 #define DCL_ACTION(method, name, tip, menu)                              \
@@ -62,6 +41,7 @@ MainWindow::MainWindow() noexcept
     DCL_ACTION(openDocument, "&Open document", "Open a document", file);
     DCL_ACTION(saveFile, "&Save file", "Save the current document", file);
     DCL_ACTION(saveFileAs, "&Save file as", "Save the current document as", file);
+    DCL_ACTION(renameFile, "&Rename the file", "Rename the current document", file);
     fileMenu->addSeparator();
     DCL_ACTION(loadSubDocumentAudio, "&Load audio", "Load an audio file as a sub-document", file);
     DCL_ACTION(loadSubDocumentVideo, "&Load video", "Load a vide file as a sub-document", file);
@@ -73,6 +53,7 @@ MainWindow::MainWindow() noexcept
     ACTION_ADD_ICON(openDocument, VIVY_ICON_OPEN);
     ACTION_ADD_ICON(saveFile, VIVY_ICON_SAVE);
     ACTION_ADD_ICON(saveFileAs, VIVY_ICON_SAVE_AS);
+    ACTION_ADD_ICON(renameFile, VIVY_ICON_RENAME);
     ACTION_ADD_ICON(openDialogHelp, VIVY_ICON_ABOUT);
 
     ACTION_ADD_SHORTCUT(newDocument, QKeySequence::New);
@@ -117,10 +98,11 @@ MainWindow::MainWindow() noexcept
     loadSubDocumentVideoAct->setEnabled(false);
     loadSubDocumentAudioAct->setEnabled(false);
 
-    // Enable actions if the document is save-able
-    auto enableSaveOnDocument = [this](auto *widget, int index) noexcept -> void {
+    // Enable "Save As" action
+    auto enableSaveAsOnDocument = [this](auto *widget, int index) noexcept -> void {
         if (index >= 0) {
-            auto type = static_cast<AbstractDocumentView *>(documents->widget(index))->getType();
+            const auto doc  = static_cast<AbstractDocumentView *>(documents->widget(index));
+            const auto type = doc->getType();
             widget->setEnabled(type == AbstractDocumentView::Type::Vivy ||
                                type == AbstractDocumentView::Type::Script);
         } else {
@@ -128,6 +110,22 @@ MainWindow::MainWindow() noexcept
         }
     };
 
+    // Enable actions if the document is save-able
+    auto enableSaveOnDocument = [this](auto *widget, int index) noexcept -> void {
+        if (index >= 0) {
+            const auto doc  = static_cast<AbstractDocumentView *>(documents->widget(index));
+            const auto type = doc->getType();
+            const bool isVivyMemoryDoc =
+                (type == AbstractDocumentView::Type::Vivy) &&
+                dynamic_cast<VivyDocument *>(doc->getDocument())
+                    ->checkDocumentOption(VivyDocument::MemoryDocumentCreation);
+            widget->setEnabled((!isVivyMemoryDoc) && (type == AbstractDocumentView::Type::Vivy ||
+                                                      type == AbstractDocumentView::Type::Script));
+        } else {
+            widget->setEnabled(false);
+        }
+    };
+
     // Enable load sub-document on sub-document able objects
     auto enableLoadSubOnDocument = [this](auto *widget, int index) noexcept -> void {
         if (index >= 0) {
@@ -138,22 +136,18 @@ MainWindow::MainWindow() noexcept
         }
     };
 
-    {
-#define CONNECT_ENABLE(act, func) \
+    auto enableConnection = [this](QAction *const act, auto func) noexcept -> void {
         connect(documents, &QTabWidget::currentChanged, act, std::bind_front(func, act));
+    };
 
     connect(documents, &QTabWidget::currentChanged, this,
             [this](int) noexcept -> void { documentViewActionsChanged(); });
 
-        CONNECT_ENABLE(saveFileAct, enableSaveOnDocument);
-        CONNECT_ENABLE(saveFileAsAct, enableSaveOnDocument);
-
-        CONNECT_ENABLE(loadSubDocumentAssAct, enableLoadSubOnDocument);
-        CONNECT_ENABLE(loadSubDocumentVideoAct, enableLoadSubOnDocument);
-        CONNECT_ENABLE(loadSubDocumentAudioAct, enableLoadSubOnDocument);
-
-#undef CONNECT_ENABLE
-    }
+    enableConnection(saveFileAct, enableSaveOnDocument);
+    enableConnection(saveFileAsAct, enableSaveAsOnDocument);
+    enableConnection(loadSubDocumentAssAct, enableLoadSubOnDocument);
+    enableConnection(loadSubDocumentVideoAct, enableLoadSubOnDocument);
+    enableConnection(loadSubDocumentAudioAct, enableLoadSubOnDocument);
 
     // Main window has finished its construction
     statusBar()->showMessage("QSimulate has started");
@@ -166,19 +160,25 @@ MainWindow::MainWindow() noexcept
     newDocument();
 }
 
+void
+MainWindow::closeEvent(QCloseEvent *event) noexcept
+{
+    qDebug() << "Closing the main window!";
+    forEachViews<VivyDocumentView>([](VivyDocumentView *view, int) { view->closeDocument(); });
+    QMainWindow::closeEvent(event);
+}
+
 void
 MainWindow::updateFakeVimUsage(bool yes) noexcept
 {
-    const int count = documents->count();
-    for (int index = 0; index < count; ++index) {
-        AbstractDocumentView *docView = getTab(index);
+    forEachViews<AbstractDocumentView>([yes](AbstractDocumentView *docView, int) noexcept -> void {
         const bool documentExists = docView && docView->getDocument();
         const bool isScriptEditor =
             documentExists && (docView->getDocument()->getType() == AbstractDocument::Type::Script);
 
         if (isScriptEditor)
-            static_cast<ScriptDocumentView *const>(docView)->setUseFakeVimEditor(yes);
-    }
+            static_cast<ScriptDocumentView *>(docView)->setUseFakeVimEditor(yes);
+    });
 }
 
 void
@@ -211,24 +211,42 @@ MainWindow::openDialogHelp() noexcept
 }
 
 AbstractDocument *
-MainWindow::getCurrentDocument() const noexcept
+MainWindow::getCurrentDocument() const
 {
-    try {
     return getCurrentDocumentView()->getDocument();
-    } catch (const std::runtime_error &e) {
-        qCritical() << "No current view in the main window:" << e.what();
-        return nullptr;
-    }
 }
 
 void
 MainWindow::saveFile() noexcept
 {
     try {
-        if (auto document = getCurrentDocument()) {
-            qDebug() << "Request to save the document" << document->getName();
+        const auto document = getCurrentDocument();
+        document->save();
     }
-    } catch (const std::runtime_error &e) {
+
+    catch (const std::runtime_error &e) {
+        qCritical() << "Failed to save current document:" << e.what();
+    }
+}
+
+void
+MainWindow::renameFile() noexcept
+{
+    try {
+        const auto docView = getCurrentDocumentView();
+        auto document      = docView->getDocument();
+        const QString filename =
+            dialogSaveFileName("Select the target file to rename the current file to",
+                               QDir::homePath(), Utils::getVivyDocumentFileSuffixFilter());
+
+        if (filename.isEmpty())
+            throw std::runtime_error("No filename passed");
+
+        else
+            document->rename(filename); // Kubat: Save is called by rename!
+    }
+
+    catch (const std::runtime_error &e) {
         qCritical() << "Failed to save current document:" << e.what();
     }
 }
@@ -237,10 +255,20 @@ void
 MainWindow::saveFileAs() noexcept
 {
     try {
-        if (auto document = getCurrentDocument()) {
-            qDebug() << "Request to save the document" << document->getName();
+        const auto docView = getCurrentDocumentView();
+        auto document      = docView->getDocument();
+        const QString filename =
+            dialogSaveFileName("Select the target file to save into", QDir::homePath(),
+                               Utils::getVivyDocumentFileSuffixFilter());
+
+        if (filename.isEmpty())
+            throw std::runtime_error("No filename passed");
+
+        else
+            document->copy(filename); // Kubat: Save is called by copy!
     }
-    } catch (const std::runtime_error &e) {
+
+    catch (const std::runtime_error &e) {
         qCritical() << "Failed to save current document:" << e.what();
     }
 }
@@ -251,13 +279,12 @@ MainWindow::closeDocument(AbstractDocumentView *const view) noexcept
     if (view == nullptr || !view->getDocument())
         return;
 
-    const int count = documents->count();
-    for (int index = 0; index < count; ++index) {
-        const AbstractDocumentView *const documentView = getTab(index);
+    forEachViews<AbstractDocumentView>(
+        [this, view](AbstractDocumentView *documentView, int index) noexcept -> void {
             const bool documentExists = documentView && documentView->getDocument();
             if (documentExists && (*documentView->getDocument()) == (*view->getDocument()))
                 closeDocument(index);
-    }
+        });
 }
 
 void
@@ -293,7 +320,7 @@ void
 MainWindow::openDocument() noexcept
 {
     const QString filename = dialogOpenFileName("Select a document to open", QDir::homePath(),
-                                                Utils::getAnyDocumentFileSuffixFilter());
+                                                Utils::getAnyTopLevelDocumentFileSuffixFilter());
     if (filename.isEmpty()) {
         qWarning() << "Found an empty filename, don't open a file";
         return;
@@ -309,21 +336,17 @@ MainWindow::openDocument() noexcept
 
     // Handle the different types here
     try {
-        if ((fileType == Utils::DocumentType::Video) || (fileType == Utils::DocumentType::Vivy) ||
-            (fileType == Utils::DocumentType::Audio) || (fileType == Utils::DocumentType::ASS))
+        if (fileType == Utils::DocumentType::Vivy)
             addTab(new VivyDocumentView(vivyApp->documentStore.loadDocument(filename), documents));
 
         else if (fileType == Utils::DocumentType::VivyScript) {
-            // FIXME: First interpretation of the file to get the error, can do better.
-            std::shared_ptr<ScriptDocument> scriptDocument =
-                vivyApp->scriptStore.loadDocument(filename);
-            std::optional<std::tuple<int, std::string>> errorTuple =
-                vivyApp->scriptStore.executeScript(scriptDocument->getUuid());
+            auto scriptDocument = vivyApp->scriptStore.loadDocument(filename);
+            auto errorTuple     = vivyApp->scriptStore.executeScript(scriptDocument->getUuid());
             ScriptDocumentView *newView = new ScriptDocumentView(scriptDocument, documents);
 
             if (errorTuple.has_value()) {
                 const auto &[line, desc] = errorTuple.value();
-                emit newView->luaErrorFound(line, QString{ desc.c_str() });
+                emit newView->luaErrorFound(line, QString::fromUtf8(desc.c_str()));
             }
 
             addTab(newView);
@@ -369,7 +392,7 @@ MainWindow::loadSubDocumentAudio() noexcept
 }
 
 void
-MainWindow::addTab(AbstractDocumentView *tab)
+MainWindow::addTab(AbstractDocumentView *const tab)
 {
     int index = -1;
     if (const int untouched_index = findFirstUntouchedDocument(); untouched_index >= 0) {
@@ -384,10 +407,48 @@ MainWindow::addTab(AbstractDocumentView *tab)
     documents->setCurrentIndex(index);
     connect(tab, &AbstractDocumentView::viewActionsChanged, this,
             &MainWindow::documentViewActionsChanged);
+    connect(tab, &AbstractDocumentView::documentPropertyChanged, this,
+            [this, tab]() noexcept -> void {
+                int tabIndex = getIndexOfTab(tab);
+                if (tabIndex < 0) {
+                    qDebug() << "Tab was not found!";
+                } else {
+                    qDebug() << "Tab was found at index" << tabIndex;
+                    documents->setTabToolTip(tabIndex, tab->getDocumentTabToolTip());
+                    documents->setTabText(tabIndex, tab->getDocumentTabName());
+                }
+            });
     documentViewActionsChanged();
     qDebug() << "View constructed successfully";
 }
 
+int
+MainWindow::getIndexOfTab(const AbstractDocumentView *const viewA) const noexcept
+{
+    if (viewA == nullptr)
+        return -1;
+
+    const AbstractDocument *const docA = viewA->getDocument();
+    if (docA == nullptr)
+        return -1;
+
+    int returnIndex = -1;
+    forEachViews<AbstractDocumentView>(
+        [docA, &returnIndex](AbstractDocumentView *viewB, int index) noexcept -> void {
+            if (viewB == nullptr)
+                return;
+
+            const AbstractDocument *const docB = viewB->getDocument();
+            if (docB == nullptr)
+                return;
+
+            if (*docB == *docA)
+                returnIndex = index;
+        });
+
+    return returnIndex;
+}
+
 AbstractDocumentView *
 MainWindow::getCurrentDocumentView() const
 {
@@ -412,17 +473,14 @@ MainWindow::getTab(const int index) const noexcept
 int
 MainWindow::findFirstUntouchedDocument() const noexcept
 {
-    const int count = documents->count();
-    for (int index = 0; index < count; ++index) {
-        AbstractDocumentView *documentView = getTab(index);
-        if (documentView && (documentView->getType() == AbstractDocumentView::Type::Vivy) &&
-            static_cast<VivyDocumentView *>(documentView)
-                ->getDocument()
-                ->checkDocumentOption(VivyDocument::UntouchedByDefault))
-            return index;
-    }
+    int returnIndex = -1;
+    forEachViews<VivyDocumentView>(
+        [&returnIndex](VivyDocumentView *view, int index) noexcept -> void {
+            if (view->getDocument()->checkDocumentOption(VivyDocument::UntouchedByDefault))
+                returnIndex = index;
+        });
 
-    return -1;
+    return returnIndex;
 }
 
 void
@@ -438,27 +496,23 @@ MainWindow::documentViewActionsChanged() noexcept
         qInfo() << "No view to display:" << e.what();
     }
 }
-QString
-MainWindow::dialogOpenFileName(const QString &title, const QString &folder,
-                               const QString &filter) noexcept
+
+static inline QString
+executeDialog(MainWindow *const self, QFileDialog *const dialog) noexcept
 {
-    QFileDialog dialog(this, title, folder, filter);
     bool dialogAccepted = false;
     std::unique_ptr<VivyFileIconProvider> iconProvider(new VivyFileIconProvider());
 
-    dialog.setOption(QFileDialog::ReadOnly);
-    dialog.setIconProvider(iconProvider.get());
-    dialog.setFileMode(QFileDialog::ExistingFile);
-    connect(&dialog, &QFileDialog::accepted, this,
+    dialog->setIconProvider(iconProvider.get());
+    QFileDialog::connect(dialog, &QFileDialog::accepted, self,
                          [&dialogAccepted]() noexcept -> void { dialogAccepted = true; });
 
-    dialog.exec();
+    dialog->exec();
 
-    if (!dialogAccepted) {
+    if (!dialogAccepted)
         return QStringLiteral("");
-    }
 
-    const QStringList resList = dialog.selectedFiles();
+    const QStringList resList = dialog->selectedFiles();
     if (resList.size() != 1) {
         qCritical() << "You must select only one file";
         return QStringLiteral("");
@@ -466,3 +520,24 @@ MainWindow::dialogOpenFileName(const QString &title, const QString &folder,
 
     return resList.at(0);
 }
+
+QString
+MainWindow::dialogOpenFileName(const QString &title, const QString &folder,
+                               const QString &filter) noexcept
+{
+    QFileDialog dialog(this, title, folder, filter);
+    dialog.setOption(QFileDialog::ReadOnly);
+    dialog.setAcceptMode(QFileDialog::AcceptOpen);
+    dialog.setFileMode(QFileDialog::ExistingFile);
+    return executeDialog(this, &dialog);
+}
+
+QString
+MainWindow::dialogSaveFileName(const QString &title, const QString &folder,
+                               const QString &filter) noexcept
+{
+    QFileDialog dialog(this, title, folder, filter);
+    dialog.setOption(QFileDialog::ReadOnly, false);
+    dialog.setAcceptMode(QFileDialog::AcceptSave);
+    return executeDialog(this, &dialog);
+}