GraphicElementSerializer.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 <QCoreApplication>
#include <QHash>
#include <QList>
#include <QMap>
#include <QString>
#include <QtGlobal>
#include <QVariant>
 
class GraphicElement;
class Port;
class QDataStream;
class QPointF;
class QVersionNumber;
struct SerializationContext;
struct SerializationOptions;

class GraphicElementSerializer
{
    // tr context for the load-error PANDACEPTION throws. lupdate extracts the plain
    // PANDACEPTION(...) calls below under the "GraphicElementSerializer" context (the
    // tr+=PANDACEPTION alias resolves via this class scope); PANDACEPTION_WITH_CONTEXT is NOT
    // extracted.
    Q_DECLARE_TR_FUNCTIONS(GraphicElementSerializer)
 
    // Test-only seam: several load-error throws (truncated-stream / implausible-count guards)
    // are private helpers one level below the public load() entry point. Precisely truncating a
    // full element stream at the exact byte offset each one needs is far more fragile than
    // calling the helper directly with a minimal hand-built stream.
    friend class TestGraphicElementSerializer;
 
public:
    static void save(const GraphicElement &element, QDataStream &stream, SerializationOptions options);

    static void load(GraphicElement &element, QDataStream &stream, SerializationContext &context);
 
private:
    static void loadOldFormat(GraphicElement &element, QDataStream &stream, SerializationContext &context);
    static void loadNewFormat(GraphicElement &element, QDataStream &stream, SerializationContext &context);

    static void validateFinitePos(const QPointF &pos);

    static void validateFiniteAngle(qreal angle);
 
    static void loadPos(GraphicElement &element, QDataStream &stream);
    static void loadRotation(GraphicElement &element, QDataStream &stream, const QVersionNumber &version);
    static void loadLabel(GraphicElement &element, QDataStream &stream, const QVersionNumber &version);
    static void loadPortsSize(QDataStream &stream, const QVersionNumber &version);
    static void loadTrigger(GraphicElement &element, QDataStream &stream, const QVersionNumber &version);
 
    static void loadInputPorts(GraphicElement &element, QDataStream &stream, SerializationContext &context);
    static void loadInputPort(GraphicElement &element, QDataStream &stream, SerializationContext &context, int port);
    static void loadOutputPorts(GraphicElement &element, QDataStream &stream, SerializationContext &context);
    static void loadOutputPort(GraphicElement &element, QDataStream &stream, SerializationContext &context, int port);
 
    static void removeSurplusInputs(GraphicElement &element, quint64 inputSize_, SerializationContext &context);
    static void removeSurplusOutputs(GraphicElement &element, quint64 outputSize_, SerializationContext &context);
 
    static void loadPixmapAppearanceNames(GraphicElement &element, QDataStream &stream, SerializationContext &context);
    static void loadPixmapAppearanceName(GraphicElement &element, QDataStream &stream, int index, const SerializationContext &context);

    static QList<QMap<QString, QVariant>> readPortList(QDataStream &stream, const char *label);

    static void removePortFromMap(Port *deletedPort, QHash<quint64, Port *> &portMap);
};