Workspace.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 <QFileInfo>
#include <QPointer>
#include <QTimer>
#include <QUndoStack>
 
#include "App/Core/Settings.h"
#include "App/Scene/GraphicsView.h"
#include "App/Scene/Scene.h"
 
class ExerciseOverlay;
class GraphicsView;
class Simulation;

class WorkSpace : public QWidget
{
    Q_OBJECT
 
    friend class TestWorkspaceUnit;
 
public:
    enum class SaveOutcome {
        Saved,
        ReadOnlyTarget,
    };
 
    // --- Lifecycle ---

    explicit WorkSpace(QWidget *parent = nullptr);

    ~WorkSpace() override;
 
    // --- Component Access ---

    GraphicsView *view();
    Scene *scene();
    const Scene *scene() const;

    Simulation *simulation();
 
    // --- File Operations ---

    QFileInfo fileInfo() const;
    void load(const QString &fileName);
    void load(QDataStream &stream, const QVersionNumber &version, const QString &contextDir);

    SaveOutcome save(const QString &fileName);
    void save(QDataStream &stream);
    void setAutosaveFile();

    void flushPendingAutosave();
 
    // --- Inline IC Tab ---

    void loadFromBlob(const QByteArray &blob, WorkSpace *parent, int icElementId, const QString &parentContextDir);

    bool isInlineIC() const { return m_isInlineIC; }

    WorkSpace *parentWorkspace() const { return m_parentWorkspace; }

    int parentICElementId() const { return m_parentICElementId; }

    const QString &inlineBlobName() const { return m_inlineBlobName; }

    void setInlineBlobName(const QString &blobName) { m_inlineBlobName = blobName; }

    const QString &untitledTitle() const { return m_untitledTitle; }
    void setUntitledTitle(const QString &title) { m_untitledTitle = title; }

    bool isRecovered() const { return m_isRecovered; }
    void setRecovered(bool recovered) { m_isRecovered = recovered; }

    void removeEmbeddedIC(const QString &blobName);
 
    // Minimap control
    void setMinimapVisible(bool visible);
 
    // --- Waveform Integration ---

    QString dolphinFileName() const;
    void setDolphinFileName(const QString &fileName);
 
    // --- ID Management ---

    bool isFromNewerVersion() const;

    int lastId() const;

    void setLastId(int newLastId);

    void setExerciseOverlay(ExerciseOverlay *overlay);
 
protected:
    void resizeEvent(QResizeEvent *event) override;
    void showEvent(QShowEvent *event) override;
 
signals:
    void fileChanged(const QFileInfo &fileInfo);

    void icBlobSaved(int icElementId, const QByteArray &blob);
 
public slots:
    void onChildICBlobSaved(int icElementId, const QByteArray &blob);
 
private:
    // --- Internal methods ---
 
    void autosave();
    void createVersionedBackup(const QString &fileName, const QVersionNumber &version);
    void setAutosaveFileName();

    void setCurrentFile(const QString &filePath);

    void applyMinimapGeometry();

    void onMinimapGeometryChangeFinished(const QRect &geometry);
 
    // --- Members ---
 
    GraphicsView m_view;
    Scene m_scene;
    QFileInfo m_fileInfo;
    QString m_dolphinFileName;
    QString m_autosaveFileName;
    QTimer m_autosaveDebounceTimer;
    QVersionNumber m_loadedVersion;
    int m_lastId = 0;
 
    // Minimap overview widget (small, shows full scene and viewport)
    class MinimapWidget *m_minimap = nullptr;
    bool m_minimapPositioned = false;
 
    // Inline IC tab state
    bool m_isInlineIC = false;
    QPointer<WorkSpace> m_parentWorkspace;
    int m_parentICElementId = -1;
    QString m_inlineBlobName;
    QString m_untitledTitle;
    bool m_isRecovered = false;
 
    // Exercise overlay — non-owning pointer
    ExerciseOverlay *m_exerciseOverlay = nullptr;
};