MainWindow.h

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later

 
#pragma once
 
#include <functional>
#include <memory>
#include <optional>
 
#include <QDir>
#include <QMainWindow>
#include <QPointer>
 
#include "App/BeWavedDolphin/DolphinHost.h"
#include "App/UI/MainWindowHost.h"
#include "App/UI/MainWindowUI.h"
 
class ElementPalette;
class ExerciseEngine;
class ExerciseOverlay;
class ExportController;
class ICController;
class ICPreviewPopup;
class LanguageManager;
class BewavedDolphin;
class RecentFiles;
class SceneUiBinder;
class TourEngine;
class TourOverlay;
class WorkSpace;
class WorkspaceManager;

class MainWindow : public QMainWindow, public DolphinHost, public MainWindowHost
{
    Q_OBJECT
    friend class TestMainWindowGui;
 
public:
    // --- Lifecycle ---

    explicit MainWindow(const QString &fileName = {}, QWidget *parent = nullptr);
    ~MainWindow() override;

    void show();
 
    // --- Tab Management ---

    void createNewTab();

    WorkSpace *currentTab() const override;
 
    // --- File Operations ---

    void save(const QString &fileName = {}) override;

    void loadPandaFile(const QString &fileName);

    void openICInTab(const QString &blobName, int icElementId, const QByteArray &blob);

    QFileInfo currentFile() const override;

    bool hasModifiedFiles();

    QDir currentDir() const override;

    QWidget *widget() override;

    DolphinHost *dolphinHost() override;

    ElementPalette *palette() const override;

    void showStatusMessage(const QString &message, int timeout) override;

    void requestSave() override;

    void setICButtonsVisible(bool visible) override;

    void refreshICButtonsEnabled() override;
 
    // --- Help ---

    QString shortcutsHelpHtml() const;
 
    // --- Export ---

    void exportToArduino(QString fileName);

    void exportToSystemVerilog(QString fileName);

    void exportToWaveFormFile(const QString &fileName);

    void exportToWaveFormTerminal();
 
    // --- BeWavedDolphin Integration ---

    QString dolphinFileName() override;

    void setDolphinFileName(const QString &fileName) override;
 
    // --- Translation ---

    void loadTranslation(const QString &language);

    void populateLanguageMenu();
 
    // --- View / Rendering ---

    void retranslateUi();

    void setFastMode(const bool fastMode);
 
    // --- Qt Event Override ---

    bool event(QEvent *event) override;
 
protected:
    // --- Protected Interface ---

    void closeEvent(QCloseEvent *event) override;
 
private:
    Q_DISABLE_COPY(MainWindow)
 
    // --- Tab Lifecycle ---
 
    
    void onCurrentTabChanged(WorkSpace *newTab);

    void updateWindowTitle();

    QFileInfo icListFile() const override;

    void connectSceneAction(QAction *action, void (Scene::*method)());
 
    // --- File Helpers ---
 
    void createRecentFileActions();
    void updateRecentFileActions();
    void openRecentFile();
 
    // --- Settings & Theme ---
 
    void updateSettings();
    void updateTheme();
    void aboutThisVersion();
 
    // --- Action Handlers ---
 
    void startExercise(const QString &resourcePath);
    void startTour(const QString &resourcePath);
    QRect resolveTourTarget(const QString &id) const;
 
    void clickTarget(const QString &id);
 
    static void on_actionDarkTheme_triggered();
    static void on_actionLightTheme_triggered();
    static void on_actionSystemTheme_triggered();
    void on_actionAboutQt_triggered();
    void on_actionAbout_triggered();
    void on_actionExit_triggered();
    void on_actionFastMode_triggered(const bool checked);
    void on_actionFlipHorizontally_triggered();
    void on_actionFlipVertically_triggered();
    void on_actionAlignLeft_triggered();
    void on_actionAlignRight_triggered();
    void on_actionAlignTop_triggered();
    void on_actionAlignBottom_triggered();
    void on_actionAlignHorizontalCenter_triggered();
    void on_actionAlignVerticalCenter_triggered();
    void on_actionDistributeHorizontally_triggered();
    void on_actionDistributeVertically_triggered();
    void on_actionFullscreen_triggered();
    void on_actionGates_triggered(const bool checked);
    void on_actionLabelsUnderIcons_triggered(const bool checked);
    void on_actionICPreview_triggered(const bool checked);
    void on_actionCheckForUpdates_triggered(const bool checked);
    void on_actionMute_triggered(const bool checked);
    void on_actionPlay_toggled(const bool checked);
    void on_actionReportTranslationError_triggered();
    void on_actionResetZoom_triggered() const;
    void on_actionZoomToFit_triggered() const;
    void on_actionRestart_triggered();
    void on_actionRotateLeft_triggered();
    void on_actionRotateRight_triggered();
    void on_actionSelectAll_triggered();
    void on_actionShortcuts_and_Tips_triggered();
    void on_actionShowMinimap_triggered(const bool checked);
    void on_actionWaveform_triggered();
    void on_actionWires_triggered(const bool checked);
    void on_actionZoomIn_triggered() const;
    void on_actionZoomOut_triggered() const;
 
#ifdef Q_OS_WASM
    static const char *onBeforeUnload(int eventType, const void *reserved, void *userData);
#endif
 
    // --- Constructor Setup ---

    void setupLanguage();
    void setupGeometry();
    void setupTheme();
    void setupRecentFiles();
    void setupExamplesMenu();
    void setupExercisesMenu();
    void setupToursMenu();
    void populateContentMenu(QMenu *menu, const QString &categoryKey,
                              const QString &openFolderText, const QString &openFolderFailureText,
                              const QStringList &completed, const std::function<void(const QString &)> &onSelect);
    void setupShortcuts();
    void setupConnections();
 
    // --- Members ---
 
    std::unique_ptr<MainWindowUi> m_ui;

    static inline std::optional<QString> s_testSystemLocaleNameOverride;

    std::function<QString(const QString &)> m_preferredContentDirForTesting;
 
    ElementPalette   *m_palette          = nullptr;
    LanguageManager  *m_languageManager  = nullptr;
    RecentFiles      *m_recentFiles      = nullptr;
    ExportController *m_exportController  = nullptr;
    ICController     *m_icController      = nullptr;
    SceneUiBinder    *m_binder            = nullptr;
    WorkspaceManager *m_workspaceManager  = nullptr;
 
    ExerciseEngine  *m_exerciseEngine  = nullptr;
    ExerciseOverlay *m_exerciseOverlay = nullptr;
 
    TourEngine  *m_tourEngine  = nullptr;
    QPointer<TourOverlay> m_tourOverlay;
 
    QPointer<BewavedDolphin> m_bwd;
    QMetaObject::Connection m_bwdDestroyed;

    QPointer<WorkSpace> m_previousTab;

    QPointer<ICPreviewPopup> m_icPreviewPopup;
};