Port.h

Go to the documentation of this file.

// Copyright (c) 2012, STANISLAW ADASZEWSKI
// SPDX-License-Identifier: BSD-3-Clause
//
// Portions Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later
//
// Originally derived from Stanislaw Adaszewski's Qt Node Editor (qneblock); since
// re-authored for wiRedPanda. The BSD attribution above is retained as a license
// obligation for the derived design.

 
#pragma once
 
#include <QBrush>
#include <QGraphicsPathItem>
#include <QPen>
 
#include "App/Core/Enums.h"
 
class GraphicElement;
class Connection;
class Port;

class Port : public QGraphicsPathItem
{
public:
    // --- Type ---
 
    enum { Type = QGraphicsItem::UserType + 1 };
    int type() const override { return Type; }

    QPainterPath shape() const override;

    QRectF boundingRect() const override;

    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget) override;
 
    // --- Lifecycle ---

    explicit Port(QGraphicsItem *parent = nullptr);
    // Port is abstract (isInput()/isOutput()/isValid()/setStatus() are pure virtual), so it can
    // never be the most-derived type of a real object -- its own vtable "deleting destructor"
    // (D0) slot is dead by construction, unlike a concrete class's (pattern 34/pattern 35's
    // MainWindowHost precedent). Every real deletion, even through a base Port* pointer, resolves
    // to InputPort's/OutputPort's own D0, which then invokes this D2 (base-object destructor).
    virtual ~Port() = default; // LCOV_EXCL_LINE
 
    // --- Element Access ---

    GraphicElement *graphicElement() { return m_graphicElement; }
    const GraphicElement *graphicElement() const { return m_graphicElement; }
 
    // --- Identity & Status ---

    QString name() const;

    Status defaultValue() const { return m_defaultStatus; }

    Status status() const { return m_status; }

    bool isConnected(Port *otherPort);

    bool isRequired() const;

    const QList<Connection *> &connections() const;

    int index() const;

    int globalIndex() const;

    static quint64 makeSerialId(quint64 elementBase, int globalIndex);

    virtual bool isInput() const = 0;

    virtual bool isOutput() const = 0;

    virtual bool isValid() const = 0;
 
    // --- Status Management ---
 
    virtual void setStatus(Status status) = 0;
 
    // --- Connection Management ---

    void attachConnection(Connection *conn);

    void detachConnection(Connection *conn);

    void hoverEnter();

    void hoverLeave();

    void updateTheme();

    void setCurrentBrush(const QBrush &currentBrush);

    QPen currentPen() const { return m_currentPen; }

    void setDefaultStatus(const Status defaultStatus);

    void setGraphicElement(GraphicElement *graphicElement);

    void setIndex(const int index);

    void setName(const QString &name);

    void setRequired(const bool required);

    void updateConnections();
 
protected:
    // --- Qt Event Handling ---

    QVariant itemChange(GraphicsItemChange change, const QVariant &value) override;

    void drainConnections(bool isInput);

    static constexpr int kRadius = 5;
 
    // --- Members ---
 
    GraphicElement *m_graphicElement = nullptr;
    QBrush m_currentBrush;
    QPen m_currentPen;
    QList<Connection *> m_connections;
    QString m_name;
    Status m_defaultStatus = Status::Unknown;
    Status m_status = Status::Unknown;
    bool m_required = true;
    int m_index = 0;
 
private:
    QBrush currentBrush() const;
};

class InputPort : public Port
{
public:
    explicit InputPort(QGraphicsItem *parent = nullptr);
    ~InputPort() override;
 
    // --- Type Queries ---

    bool isInput() const override;
    bool isOutput() const override;
    bool isValid() const override;
 
    // --- Status Management ---

    void setStatus(const Status status) override;
 
private:
    Q_DISABLE_COPY_MOVE(InputPort)
};

class OutputPort : public Port
{
public:
    explicit OutputPort(QGraphicsItem *parent = nullptr);
    ~OutputPort() override;
 
    // --- Type Queries ---

    bool isInput() const override;
    bool isOutput() const override;
    bool isValid() const override;
 
    // --- Status Management ---

    void setStatus(const Status status) override;
 
private:
    Q_DISABLE_COPY_MOVE(OutputPort)
};