Cockatrice/cockatrice/src/interface/widgets/tabs/tab_deck_editor.cpp

#include "tab_deck_editor.h"

#include "../../../client/settings/cache_settings.h"
#include "../../../client/settings/shortcuts_settings.h"
#include "../deck_editor/deck_editor_card_database_dock_widget.h"
#include "../deck_editor/deck_editor_card_info_dock_widget.h"
#include "../deck_editor/deck_editor_deck_dock_widget.h"
#include "../deck_editor/deck_editor_printing_selector_dock_widget.h"
#include "../deck_editor/deck_state_manager.h"
#include "../interface/widgets/deck_editor/deck_editor_filter_dock_widget.h"
#include "../interface/widgets/menus/deck_editor_menu.h"

#include <QAction>
#include <QByteArray>
#include <QDockWidget>
#include <QEvent>
#include <QList>
#include <QMap>
#include <QMenu>
#include <QSize>
#include <QString>
#include <libcockatrice/settings/cards_display_settings.h>
#include <libcockatrice/settings/layouts_settings.h>
#include <qnamespace.h>

class TabSupervisor;

/**
 * @brief Constructs a new TabDeckEditor object.
 * Sets up menus, translations, shortcuts, and loads the layout.
 * @param _tabSupervisor Pointer to parent TabSupervisor.
 */
TabDeckEditor::TabDeckEditor(TabSupervisor *_tabSupervisor) : AbstractTabDeckEditor(_tabSupervisor)
{
    setObjectName("TabDeckEditor");

    TabDeckEditor::createMenus();

    installEventFilter(this);

    TabDeckEditor::retranslateUi();
    TabDeckEditor::refreshShortcuts();

    TabDeckEditor::loadLayout();
}

/**
 * @brief Creates menus for deck editing and view customization.
 *
 * Adds DeckEditorMenu, view menus, and actions for dock visibility and floating.
 */
void TabDeckEditor::createMenus()
{
    deckMenu = new DeckEditorMenu(this);
    addTabMenu(deckMenu);

    viewMenu = new QMenu(this);

    registerDockWidget(viewMenu, cardDatabaseDockWidget, {500, 500});
    registerDockWidget(viewMenu, cardInfoDockWidget, {250, 500});
    registerDockWidget(viewMenu, deckDockWidget, {250, 360});
    registerDockWidget(viewMenu, filterDockWidget, {250, 250});
    registerDockWidget(viewMenu, printingSelectorDockWidget, {525, 250});

    connect(&SettingsCache::instance().cardsDisplay(),
            &CardsDisplaySettings::overrideAllCardArtWithPersonalPreferenceChanged, this,
            [this](bool enabled) { dockToActions[printingSelectorDockWidget].menu->setEnabled(!enabled); });

    viewMenu->addSeparator();

    aResetLayout = viewMenu->addAction(QString());
    connect(aResetLayout, &QAction::triggered, this, &TabDeckEditor::restartLayout);
    viewMenu->addAction(aResetLayout);

    deckMenu->setSaveStatus(false);
    addTabMenu(viewMenu);
}

/**
 * @brief Returns the text to display in the tab.
 * Prepends "*" if the deck is modified.
 * @return Tab text including modified mark.
 */
QString TabDeckEditor::getTabText() const
{
    QString result = tr("Deck: %1").arg(deckStateManager->getSimpleDeckName());
    if (deckStateManager->isModified()) {
        result.prepend("* ");
    }
    return result;
}

/** @brief Updates text of menus and actions for localization. */
void TabDeckEditor::retranslateUi()
{
    deckMenu->retranslateUi();
    cardDatabaseDockWidget->retranslateUi();
    cardInfoDockWidget->retranslateUi();
    deckDockWidget->retranslateUi();
    filterDockWidget->retranslateUi();
    printingSelectorDockWidget->retranslateUi();

    viewMenu->setTitle(tr("&View"));

    dockToActions[cardDatabaseDockWidget].menu->setTitle(tr("Card Database"));
    dockToActions[cardInfoDockWidget].menu->setTitle(tr("Card Info"));
    dockToActions[deckDockWidget].menu->setTitle(tr("Deck"));
    dockToActions[filterDockWidget].menu->setTitle(tr("Filters"));
    dockToActions[printingSelectorDockWidget].menu->setTitle(tr("Printing"));

    for (auto &actions : dockToActions.values()) {
        actions.aVisible->setText(tr("Visible"));
        actions.aFloating->setText(tr("Floating"));
    }

    aResetLayout->setText(tr("Reset layout"));
}

/** @brief Refreshes shortcuts for deck editor menu actions. */
void TabDeckEditor::refreshShortcuts()
{
    ShortcutsSettings &shortcuts = SettingsCache::instance().shortcuts();
    aResetLayout->setShortcuts(shortcuts.getShortcut("TabDeckEditor/aResetLayout"));
}

/**
 * @brief Loads deck editor layout from settings or resets to default.
 */
void TabDeckEditor::loadLayout()
{
    LayoutsSettings &layouts = SettingsCache::instance().layouts();

    auto layoutState = layouts.getDeckEditorLayoutState();
    // Start with every current dock placed. Saved layouts from older versions
    // cannot describe docks introduced later; restoreState leaves those docks
    // in their existing positions while restoring the saved docks, including
    // their visibility and floating state.
    restartLayout();
    if (!layoutState.isEmpty()) {
        if (!restoreState(layoutState)) {
            // A corrupt or incompatible state must not leave a partial layout.
            restartLayout();
        }
        restoreGeometry(layouts.getDeckEditorGeometry());
    }
}

/**
 * @brief Resets all dock widgets to default layout.
 */
void TabDeckEditor::restartLayout()
{
    // Show/hide and reset floating
    for (auto dockWidget : dockToActions.keys()) {
        dockWidget->setVisible(true);
        dockWidget->setFloating(false);
    }

    addDockWidget(Qt::LeftDockWidgetArea, cardDatabaseDockWidget);
    addDockWidget(Qt::RightDockWidgetArea, deckDockWidget);
    addDockWidget(Qt::RightDockWidgetArea, cardInfoDockWidget);
    addDockWidget(Qt::RightDockWidgetArea, filterDockWidget);
    addDockWidget(Qt::RightDockWidgetArea, printingSelectorDockWidget);

    splitDockWidget(cardInfoDockWidget, printingSelectorDockWidget, Qt::Horizontal);
    splitDockWidget(printingSelectorDockWidget, deckDockWidget, Qt::Horizontal);
    splitDockWidget(cardInfoDockWidget, printingSelectorDockWidget, Qt::Horizontal);
    splitDockWidget(cardInfoDockWidget, filterDockWidget, Qt::Vertical);
}

/**
 * @brief Handles close/hide events to update menu state and save layout.
 * @param o Object sending the event.
 * @param e Event.
 * @return Always returns false.
 */
bool TabDeckEditor::eventFilter(QObject *o, QEvent *e)
{
    if (o == this && e->type() == QEvent::Hide) {
        LayoutsSettings &layouts = SettingsCache::instance().layouts();
        layouts.setDeckEditorLayoutState(saveState());
        layouts.setDeckEditorGeometry(saveGeometry());
    }
    return false;
}