BeWavedDolphin.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 <QFileInfo>
#include <QMainWindow>
#include <QStandardItemModel>
#include <QTableView>
#include <QUndoStack>
 
#include "App/BeWavedDolphin/BeWavedDolphinUI.h"
#include "App/BeWavedDolphin/SignalDelegate.h"
#include "App/BeWavedDolphin/SignalModel.h"
#include "App/Scene/Scene.h"
 
class DolphinHost;
class DolphinZoom;
class ExerciseOverlay;
class WaveformSimulator;
 
namespace DolphinSerializer { struct WaveformData; }

class BewavedDolphin : public QMainWindow
{
    Q_OBJECT
    friend class TestBewavedDolphinGui;
 
public:
    explicit BewavedDolphin(Scene *scene, const bool askConnection = true, DolphinHost *host = nullptr,
                            QWidget *parent = nullptr);
    ~BewavedDolphin() override;

    void createWaveform();

    void createWaveform(const QString &fileName);

    void print();

    void saveToTxt(QTextStream &stream);

    void show();
 
    // --- MCP Interface ---

    bool exportToPng(const QString &filename);

    void setCellValue(const int row, const int col, const int value);

    void prepare(const QString &fileName = {});

    void run();

    void setLength(const int simLength, const bool runSimulation = false);

    struct Signal {
        QString label;        
        QVector<int> values;  
    };

    struct WaveformSnapshot {
        QList<Signal> inputs;   
        QList<Signal> outputs;  
    };

    WaveformSnapshot snapshot(int duration) const;

    int inputRow(const QString &label) const;
 
    // --- Tour / Exercise overlay support ---

    void setExerciseOverlay(ExerciseOverlay *overlay);

    QTableView *signalTableView() const { return m_signalTableView; }
    QToolBar   *mainToolBar()        const;
    QAction    *actionCombinational() const;
    void triggerCombinational();
 
protected:
    // --- Qt event overrides ---

    void closeEvent(QCloseEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
    bool eventFilter(QObject *watched, QEvent *event) override;
 
private:
    Q_DISABLE_COPY(BewavedDolphin)
 
    // --- Internal accessors (test-only; TestBewavedDolphinGui is a friend) ---
 
    
    const SignalModel* model() const { return m_model; }
    const QVector<GraphicElement *>& outputElements() const { return m_outputs; }
    const QVector<GraphicElementInput *>& inputElements() const { return m_inputs; }
    int length() const { return m_length; }
 
    // --- File I/O ---

    bool checkSave();
    void associateToWiRedPanda(const QString &fileName);
    void load(const QString &fileName);
    void applyWaveformData(const DolphinSerializer::WaveformData &fileData);

    bool elementsStillLive() const;
 
    // --- Signal Table Management ---

    void loadFromTerminal();
    void loadNewTable(const QStringList &inputLabels, const QStringList &outputLabels);
    void applyToSelectedCells(const std::function<int(int)> &valueFn);

    std::pair<QList<QPair<int, int>>, QList<int>> snapshotCells(const QModelIndexList &indexes) const;

    QModelIndexList allCellIndexes(int rows, int cols) const;
    void applyZoom();
    void zoomChanged();
 
    // --- Action Handlers (menu / toolbar callbacks) ---
 
    void on_actionAboutQt_triggered();           
    void on_actionAbout_triggered();             
    void on_actionAutoCrop_triggered();          
    void on_actionClear_triggered();             
    void on_actionCombinational_triggered();     
    void on_actionCopy_triggered();              
    void on_actionCut_triggered();               
    void on_actionExit_triggered();              
    void on_actionExportToPdf_triggered();       
    void on_actionExportToPng_triggered();       
    void on_actionFitScreen_triggered();         
    void on_actionInvert_triggered();            
    void on_actionLoad_triggered();              
    void on_actionPaste_triggered();             
    void on_actionResetZoom_triggered();         
    void on_actionSaveAs_triggered();            
    void on_actionSave_triggered();              
    void on_actionSetClockWave_triggered();      
    void on_actionSetLength_triggered();         
    void on_actionSetTo0_triggered();            
    void on_actionSetTo1_triggered();            
    void on_actionShowNumbers_triggered();       
    void on_actionShowWaveforms_triggered();     
    void on_actionZoomIn_triggered();            
    void on_actionZoomOut_triggered();           
    void on_tableView_cellDoubleClicked();       
    void on_tableView_selectionChanged();        
 
    // --- Members ---
 
    std::unique_ptr<BewavedDolphinUi> m_ui;          
    QUndoStack m_undoStack;                           
    DolphinHost *m_host            = nullptr;         
    QFileInfo m_currentFile;                          
    SignalModel *m_model           = nullptr;         
    QTableView *m_signalTableView  = new QTableView(); 
    SignalDelegate *m_delegate     = nullptr;         
    QVector<GraphicElement *> m_outputs;              
    QVector<GraphicElementInput *> m_inputs;          
    QVector<Status> m_oldInputValues;                 
    Scene *m_externalScene         = nullptr;         
    Simulation *m_simulation       = nullptr;         
    std::unique_ptr<WaveformSimulator> m_simDriver;   
    std::unique_ptr<DolphinZoom> m_zoom;              
    bool m_edited                  = false;           
    const bool m_askConnection;                       
    int m_clockPeriod              = 0;               
    int m_inputPorts               = 0;               
    int m_length                   = 32;              
    ExerciseOverlay *m_exerciseOverlay = nullptr;     
};