[TagDisplayWidget] Refactor to just store tags and use signals (#6395)

* Make fields private

* Move method to static

* clean up code

* move code

cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.cpp

@@ -154,8 +154,10 @@ void DeckEditorDeckDockWidget::createDeckDock()
             &DeckEditorDeckDockWidget::setBannerCard);
     bannerCardComboBox->setHidden(!SettingsCache::instance().getDeckEditorBannerCardComboBoxVisible());
 
-    deckTagsDisplayWidget = new DeckPreviewDeckTagsDisplayWidget(this, deckModel->getDeckList());
+    deckTagsDisplayWidget = new DeckPreviewDeckTagsDisplayWidget(this, deckModel->getDeckList()->getTags());
     deckTagsDisplayWidget->setHidden(!SettingsCache::instance().getDeckEditorTagsWidgetVisible());
+    connect(deckTagsDisplayWidget, &DeckPreviewDeckTagsDisplayWidget::tagsChanged, this,
+            &DeckEditorDeckDockWidget::setTags);
 
     activeGroupCriteriaLabel = new QLabel(this);
 
@@ -383,6 +385,13 @@ void DeckEditorDeckDockWidget::setBannerCard(int /* changedIndex */)
     emit deckModified();
 }
 
+void DeckEditorDeckDockWidget::setTags(const QStringList &tags)
+{
+    deckModel->getDeckList()->setTags(tags);
+    deckEditor->setModified(true);
+    emit deckModified();
+}
+
 void DeckEditorDeckDockWidget::syncDeckListBannerCardWithComboBox()
 {
     auto [name, id] = bannerCardComboBox->currentData().value<QPair<QString, QString>>();
@@ -451,7 +460,7 @@ void DeckEditorDeckDockWidget::syncDisplayWidgetsToModel()
     sortDeckModelToDeckView();
     expandAll();
 
-    deckTagsDisplayWidget->setDeckList(deckModel->getDeckList());
+    deckTagsDisplayWidget->setTags(deckModel->getDeckList()->getTags());
 }
 
 void DeckEditorDeckDockWidget::sortDeckModelToDeckView()
@@ -484,7 +493,7 @@ void DeckEditorDeckDockWidget::cleanDeck()
     emit deckModified();
     emit deckChanged();
     updateBannerCardComboBox();
-    deckTagsDisplayWidget->setDeckList(deckModel->getDeckList());
+    deckTagsDisplayWidget->setTags(deckModel->getDeckList()->getTags());
 }
 
 void DeckEditorDeckDockWidget::recursiveExpand(const QModelIndex &index)

cockatrice/src/interface/widgets/deck_editor/deck_editor_deck_dock_widget.h

@@ -112,6 +112,7 @@ private slots:
     void updateName(const QString &name);
     void updateComments();
     void setBannerCard(int);
+    void setTags(const QStringList &tags);
     void syncDeckListBannerCardWithComboBox();
     void updateHash();
     void refreshShortcuts();

cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.cpp

@@ -13,8 +13,8 @@
 #include <QHBoxLayout>
 #include <QMessageBox>
 
-DeckPreviewDeckTagsDisplayWidget::DeckPreviewDeckTagsDisplayWidget(QWidget *_parent, DeckList *_deckList)
+DeckPreviewDeckTagsDisplayWidget::DeckPreviewDeckTagsDisplayWidget(QWidget *_parent, const QStringList &_tags)
-    : QWidget(_parent), deckList(nullptr)
+    : QWidget(_parent), currentTags(_tags)
 {
 
     setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Minimum);
@@ -27,16 +27,14 @@ DeckPreviewDeckTagsDisplayWidget::DeckPreviewDeckTagsDisplayWidget(QWidget *_par
 
     flowWidget = new FlowWidget(this, Qt::Horizontal, Qt::ScrollBarAlwaysOff, Qt::ScrollBarAsNeeded);
 
-    if (_deckList) {
-        setDeckList(_deckList);
-    }
-
     layout->addWidget(flowWidget);
+
+    refreshTags();
 }
 
-void DeckPreviewDeckTagsDisplayWidget::setDeckList(DeckList *_deckList)
+void DeckPreviewDeckTagsDisplayWidget::setTags(const QStringList &_tags)
 {
-    deckList = _deckList;
+    currentTags = _tags;
     refreshTags();
 }
 
@@ -44,7 +42,7 @@ void DeckPreviewDeckTagsDisplayWidget::refreshTags()
 {
     flowWidget->clearLayout();
 
-    for (const QString &tag : deckList->getTags()) {
+    for (const QString &tag : currentTags) {
         flowWidget->addWidget(new DeckPreviewTagDisplayWidget(this, tag));
     }
 
@@ -71,7 +69,45 @@ static QStringList getAllFiles(const QString &filePath)
     return allFiles;
 }
 
-bool confirmOverwriteIfExists(QWidget *parent, const QString &filePath)
+/**
+ * Gets all tags that appear in the deck folder
+ */
+static QStringList findAllKnownTags()
+{
+    QStringList allFiles = getAllFiles(SettingsCache::instance().getDeckPath());
+
+    QStringList knownTags;
+    auto loader = DeckLoader(nullptr);
+    for (const QString &file : allFiles) {
+        loader.loadFromFile(file, DeckLoader::getFormatFromName(file), false);
+        QStringList tags = loader.getDeckList()->getTags();
+        knownTags.append(tags);
+        knownTags.removeDuplicates();
+    }
+
+    return knownTags;
+}
+
+void DeckPreviewDeckTagsDisplayWidget::openTagEditDlg()
+{
+    if (qobject_cast<DeckPreviewWidget *>(parentWidget())) {
+        // If we're the child of a DeckPreviewWidget, then we need to handle conversion
+        auto *deckPreviewWidget = qobject_cast<DeckPreviewWidget *>(parentWidget());
+
+        bool canAddTags = promptFileConversionIfRequired(deckPreviewWidget);
+
+        if (canAddTags) {
+            QStringList knownTags = deckPreviewWidget->visualDeckStorageWidget->tagFilterWidget->getAllKnownTags();
+            execTagDialog(knownTags);
+        }
+    } else {
+        // If we're the child of an AbstractTabDeckEditor, then we don't bother with conversion
+        QStringList knownTags = findAllKnownTags();
+        execTagDialog(knownTags);
+    }
+}
+
+static bool confirmOverwriteIfExists(QWidget *parent, const QString &filePath)
 {
     QFileInfo fileInfo(filePath);
     QString newFileName = QDir::toNativeSeparators(fileInfo.path() + "/" + fileInfo.completeBaseName() + ".cod");
@@ -86,98 +122,70 @@ bool confirmOverwriteIfExists(QWidget *parent, const QString &filePath)
     return true; // Safe to proceed
 }
 
-void DeckPreviewDeckTagsDisplayWidget::openTagEditDlg()
+static void convertFileToCockatriceFormat(DeckPreviewWidget *deckPreviewWidget)
 {
-    if (qobject_cast<DeckPreviewWidget *>(parentWidget())) {
+    deckPreviewWidget->deckLoader->convertToCockatriceFormat(deckPreviewWidget->filePath);
-        auto *deckPreviewWidget = qobject_cast<DeckPreviewWidget *>(parentWidget());
+    deckPreviewWidget->filePath = deckPreviewWidget->deckLoader->getLastLoadInfo().fileName;
-        QStringList knownTags = deckPreviewWidget->visualDeckStorageWidget->tagFilterWidget->getAllKnownTags();
+    deckPreviewWidget->refreshBannerCardText();
-        QStringList activeTags = deckList->getTags();
+}
 
-        bool canAddTags = true;
+/**
+ * Checks if the deck's file format supports tags.
+ * If not, then prompt the user for file conversion.
+ * @return whether the resulting file can support adding tags
+ */
+bool DeckPreviewDeckTagsDisplayWidget::promptFileConversionIfRequired(DeckPreviewWidget *deckPreviewWidget)
+{
+    if (DeckLoader::getFormatFromName(deckPreviewWidget->filePath) == DeckLoader::CockatriceFormat) {
+        return true;
+    }
 
-        if (DeckLoader::getFormatFromName(deckPreviewWidget->filePath) != DeckLoader::CockatriceFormat) {
+    // Retrieve saved preference if the prompt is disabled
-            canAddTags = false;
+    if (!SettingsCache::instance().getVisualDeckStoragePromptForConversion()) {
-            // Retrieve saved preference if the prompt is disabled
+        if (!SettingsCache::instance().getVisualDeckStorageAlwaysConvert()) {
-            if (!SettingsCache::instance().getVisualDeckStoragePromptForConversion()) {
+            return false;
-                if (SettingsCache::instance().getVisualDeckStorageAlwaysConvert()) {
-
-                    if (!confirmOverwriteIfExists(this, deckPreviewWidget->filePath))
-                        return;
-
-                    deckPreviewWidget->deckLoader->convertToCockatriceFormat(deckPreviewWidget->filePath);
-                    deckPreviewWidget->filePath = deckPreviewWidget->deckLoader->getLastLoadInfo().fileName;
-                    deckPreviewWidget->refreshBannerCardText();
-                    canAddTags = true;
-                }
-            } else {
-                // Show the dialog to the user
-                DialogConvertDeckToCodFormat conversionDialog(parentWidget());
-                if (conversionDialog.exec() == QDialog::Accepted) {
-
-                    if (!confirmOverwriteIfExists(this, deckPreviewWidget->filePath))
-                        return;
-
-                    deckPreviewWidget->deckLoader->convertToCockatriceFormat(deckPreviewWidget->filePath);
-                    deckPreviewWidget->filePath = deckPreviewWidget->deckLoader->getLastLoadInfo().fileName;
-                    deckPreviewWidget->refreshBannerCardText();
-                    canAddTags = true;
-
-                    if (conversionDialog.dontAskAgain()) {
-                        SettingsCache::instance().setVisualDeckStoragePromptForConversion(false);
-                        SettingsCache::instance().setVisualDeckStorageAlwaysConvert(true);
-                    }
-                } else {
-                    SettingsCache::instance().setVisualDeckStorageAlwaysConvert(false);
-
-                    if (conversionDialog.dontAskAgain()) {
-                        SettingsCache::instance().setVisualDeckStoragePromptForConversion(false);
-                    } else {
-                        SettingsCache::instance().setVisualDeckStoragePromptForConversion(true);
-                    }
-                }
-            }
         }
 
-        if (canAddTags) {
+        if (!confirmOverwriteIfExists(this, deckPreviewWidget->filePath)) {
-            DeckPreviewTagDialog dialog(knownTags, activeTags);
+            return false;
-            if (dialog.exec() == QDialog::Accepted) {
-                QStringList updatedTags = dialog.getActiveTags();
-                deckList->setTags(updatedTags);
-                deckPreviewWidget->deckLoader->saveToFile(deckPreviewWidget->filePath, DeckLoader::CockatriceFormat);
-                refreshTags();
-            }
         }
-    } else if (parentWidget()) {
-        // If we're the child of an AbstractTabDeckEditor, we are buried under a ton of childWidgets in the
-        // DeckInfoDock.
-        QWidget *currentParent = parentWidget();
-        while (currentParent) {
-            if (qobject_cast<AbstractTabDeckEditor *>(currentParent)) {
-                break;
-            }
-            currentParent = currentParent->parentWidget();
-        }
-        if (qobject_cast<AbstractTabDeckEditor *>(currentParent)) {
-            auto *deckEditor = qobject_cast<AbstractTabDeckEditor *>(currentParent);
-            QStringList knownTags;
-            QStringList allFiles = getAllFiles(SettingsCache::instance().getDeckPath());
-            DeckLoader loader(this);
-            for (const QString &file : allFiles) {
-                loader.loadFromFile(file, DeckLoader::getFormatFromName(file), false);
-                QStringList tags = loader.getDeckList()->getTags();
-                knownTags.append(tags);
-                knownTags.removeDuplicates();
-            }
 
-            QStringList activeTags = deckList->getTags();
+        convertFileToCockatriceFormat(deckPreviewWidget);
+        return true;
+    }
 
-            DeckPreviewTagDialog dialog(knownTags, activeTags);
+    // Show the dialog to the user
-            if (dialog.exec() == QDialog::Accepted) {
+    DialogConvertDeckToCodFormat conversionDialog(parentWidget());
-                QStringList updatedTags = dialog.getActiveTags();
+    if (conversionDialog.exec() != QDialog::Accepted) {
-                deckList->setTags(updatedTags);
+        SettingsCache::instance().setVisualDeckStoragePromptForConversion(!conversionDialog.dontAskAgain());
-                deckEditor->setModified(true);
+        SettingsCache::instance().setVisualDeckStorageAlwaysConvert(false);
-                refreshTags();
+
-            }
+        return false;
+    }
+
+    // Try to convert file
+    if (!confirmOverwriteIfExists(this, deckPreviewWidget->filePath)) {
+        return false;
+    }
+
+    convertFileToCockatriceFormat(deckPreviewWidget);
+
+    if (conversionDialog.dontAskAgain()) {
+        SettingsCache::instance().setVisualDeckStoragePromptForConversion(false);
+        SettingsCache::instance().setVisualDeckStorageAlwaysConvert(true);
+    }
+
+    return true;
+}
+
+void DeckPreviewDeckTagsDisplayWidget::execTagDialog(const QStringList &knownTags)
+{
+    DeckPreviewTagDialog dialog(knownTags, currentTags);
+    if (dialog.exec() == QDialog::Accepted) {
+        QStringList updatedTags = dialog.getActiveTags();
+        if (updatedTags != currentTags) {
+            setTags(updatedTags);
+            emit tagsChanged(updatedTags);
         }
     }
-}
+}

cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_deck_tags_display_widget.h

@@ -12,21 +12,31 @@
 
 #include <QWidget>
 
-inline bool confirmOverwriteIfExists(QWidget *parent, const QString &filePath);
-
 class DeckPreviewWidget;
 class DeckPreviewDeckTagsDisplayWidget : public QWidget
 {
     Q_OBJECT
 
-public:
+    QStringList currentTags;
-    explicit DeckPreviewDeckTagsDisplayWidget(QWidget *_parent, DeckList *_deckList);
-    void setDeckList(DeckList *_deckList);
-    void refreshTags();
-    DeckList *deckList;
     FlowWidget *flowWidget;
 
+public:
+    explicit DeckPreviewDeckTagsDisplayWidget(QWidget *_parent, const QStringList &_tags);
+    void setTags(const QStringList &_tags);
+    void refreshTags();
+
 public slots:
     void openTagEditDlg();
+
+private:
+    bool promptFileConversionIfRequired(DeckPreviewWidget *deckPreviewWidget);
+    void execTagDialog(const QStringList &knownTags);
+
+signals:
+    /**
+     * Emitted when the tags have changed due to user interaction.
+     * @param tags The new list of tags.
+     */
+    void tagsChanged(const QStringList &tags);
 };
 #endif // DECK_PREVIEW_DECK_TAGS_DISPLAY_WIDGET_H

cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.cpp

@@ -83,7 +83,8 @@ void DeckPreviewWidget::initializeUi(const bool deckLoadSuccess)
     setFilePath(deckLoader->getLastLoadInfo().fileName);
 
     colorIdentityWidget = new ColorIdentityWidget(this, getColorIdentity());
-    deckTagsDisplayWidget = new DeckPreviewDeckTagsDisplayWidget(this, deckLoader->getDeckList());
+    deckTagsDisplayWidget = new DeckPreviewDeckTagsDisplayWidget(this, deckLoader->getDeckList()->getTags());
+    connect(deckTagsDisplayWidget, &DeckPreviewDeckTagsDisplayWidget::tagsChanged, this, &DeckPreviewWidget::setTags);
 
     bannerCardLabel = new QLabel(this);
     bannerCardLabel->setObjectName("bannerCardLabel");
@@ -307,6 +308,12 @@ void DeckPreviewWidget::imageDoubleClickedEvent(QMouseEvent *event, DeckPreviewC
     emit deckLoadRequested(filePath);
 }
 
+void DeckPreviewWidget::setTags(const QStringList &tags)
+{
+    deckLoader->getDeckList()->setTags(tags);
+    deckLoader->saveToFile(filePath, DeckLoader::CockatriceFormat);
+}
+
 QMenu *DeckPreviewWidget::createRightClickMenu()
 {
     auto *menu = new QMenu(this);

cockatrice/src/interface/widgets/visual_deck_storage/deck_preview/deck_preview_widget.h

@@ -72,6 +72,8 @@ private:
     void addSetBannerCardMenu(QMenu *menu);
 
 private slots:
+    void setTags(const QStringList &tags);
+
     void actRenameDeck();
     void actRenameFile();
     void actDeleteFile();