IC.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 <QByteArray>
#include <QPixmap>
#include <QPoint>
#include <QSet>
 
#include "App/Element/GraphicElement.h"
#include "App/IO/SerializationContext.h"
 
class QGraphicsSceneHoverEvent;
class Connection;

class IC : public GraphicElement
{
    Q_OBJECT
 
    friend class TestArduino;
    friend class TestIC;
    friend class TestDanglingPointer;
    friend class TestICController;

    friend class ICLoader;
    friend class ICRenderer;
    friend class ICSimulation;
 
public:
    explicit IC(QGraphicsItem *parent = nullptr);
 
    ~IC() override;
 
signals:
    void requestOpenSubCircuit(int elementId, const QString &blobName, const QString &filePath);

    void previewRequested(IC *ic, const QPoint &screenPos);
    void previewMoved(IC *ic, const QPoint &screenPos);
    void previewHideRequested();
    void previewCancelRequested(IC *ic);
 
public:

    void loadFile(const QString &fileName, const QString &contextDir = {});

    void loadFromBlob(const QByteArray &blob, const QString &contextDir);
 
    void loadFromDrop(const QString &fileName, const QString &contextDir) override;
 
    const QString &file() const { return m_file; }

    QString displayName() const;

    const QString &blobName() const override { return m_blobName; }
    void setBlobName(const QString &name) { m_blobName = name; }
    bool isEmbedded() const override { return !m_blobName.isEmpty(); }
 
    const QVector<GraphicElement *> &internalElements() const { return m_internalElements; }
    const QVector<Port *> &internalInputs() const { return m_internalInputs; }
    const QVector<Port *> &internalOutputs() const { return m_internalOutputs; }

    const QPixmap &previewPixmap() const { return m_previewPixmap; }
 
    // --- Port metadata ---

    struct PortMetadata {
        int inputCount = 0;
        int outputCount = 0;
        QStringList inputLabels;
        QStringList outputLabels;
    };

    static PortMetadata buildPortMetadata(const QVector<GraphicElement *> &elements);
 
    // --- Visual ---

    void updateLogic() override;

    void resettleCombinational() override;

    void initializeSimulation();

    void saveSimState(QVector<Status> &out) const override;
    void restoreSimState(const QVector<Status> &in, int &cursor) override;

    QRectF boundingRect() const override;
    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget) override;
    void refresh() override;
 
    // --- External file dependencies ---

    QStringList externalFiles() const override;
 
    // --- Serialization ---

    void load(QDataStream &stream, SerializationContext &context) override;
    void save(QDataStream &stream, SerializationOptions options) const override;
 
protected:
    // --- Event handlers ---

    void mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event) override;

    void hoverEnterEvent(QGraphicsSceneHoverEvent *event) override;

    void hoverMoveEvent(QGraphicsSceneHoverEvent *event) override;

    void hoverLeaveEvent(QGraphicsSceneHoverEvent *event) override;
 
private:
    Q_DISABLE_COPY_MOVE(IC)
 
    // --- Utility methods ---
 
    
    bool isCursorOverPort(const QPointF &localPos) const;

    void resetInternalState();
 
    // --- Members ---
 
    QString m_file;
    QString m_blobName;
    QByteArray m_loadedBlobSnapshot;
    QVector<GraphicElement *> m_internalElements;
    QVector<Connection *> m_internalConnections;
    QVector<Port *> m_internalInputs;
    QVector<Port *> m_internalOutputs;
 
    // --- Members: Direct simulation ---
 
    QVector<GraphicElement *> m_sortedInternalElements;
    QSet<GraphicElement *> m_boundaryInputElements;
    bool m_internalHasFeedback = false;
 
    // --- Members: Hover preview ---
 
    QPixmap m_previewPixmap;           
};