Serialization.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 <QFileInfo>
#include <QKeySequence>
#include <QMap>
#include <QSet>
#include <QString>
#include <QVersionNumber>
 
#include "App/IO/SerializationContext.h"
 
class QGraphicsItem;
class Port;

class Serialization
{
    Q_DECLARE_TR_FUNCTIONS(Serialization)
 
public:
    static void serialize(const QList<QGraphicsItem *> &items, QDataStream &stream, SerializationOptions options);

    static QList<QGraphicsItem *> deserialize(QDataStream &stream, SerializationContext &context);
 
    // --- View Serialization ---

    static QRectF loadRect(QDataStream &stream, const QVersionNumber &version);
 
    // --- Waveform Serialization ---

    static QString loadDolphinFileName(QDataStream &stream, const QVersionNumber &version);
 
    // --- Utility ---

    static QString typeName(const int type);
 
    // --- File Headers ---

    static QVersionNumber readPandaHeader(QDataStream &stream);

    static QMap<QString, QVariant> readBoundedMetadata(QDataStream &stream);

    static QString readBoundedString(QDataStream &stream);

    static QKeySequence readBoundedKeySequence(QDataStream &stream);

    static QMap<QString, QByteArray> readBoundedBlobMap(QDataStream &stream);

    static void readDolphinHeader(QDataStream &stream);

    static void writeDolphinHeader(QDataStream &stream);

    static void writePandaHeader(QDataStream &stream);

    static void writePayload(QDataStream &stream, const QByteArray &payload);

    static QByteArray readPayload(QDataStream &stream, const QVersionNumber &version);

    static void createVersionedBackup(const QString &fileName, const QVersionNumber &version);
 
    // --- Panda Preamble ---

    struct Preamble {
        QVersionNumber version;
        QMap<QString, QVariant> metadata;
        QByteArray remainingPayload;
    };

    static Preamble readPreamble(QDataStream &stream);
 
    // --- Embedded ICs ---

    static QMap<QString, QByteArray> deserializeBlobRegistry(const QMap<QString, QVariant> &metadata,
                                                              const QVersionNumber &fileVersion);

    static void serializeBlobRegistry(const QMap<QString, QByteArray> &blobs, QMap<QString, QVariant> &metadata);
 
    // --- File Utilities ---

    static void copyPandaFile(const QFileInfo &srcPath, const QFileInfo &destPath,
                              QSet<QString> *visited = nullptr, int depth = 0);
 
    // --- Magic Headers ---
 
    constexpr static quint32 MAGIC_HEADER_CIRCUIT = 0x57504346; // "WPCF" (wiRedPanda Circuit File)
    constexpr static quint32 MAGIC_HEADER_WAVEFORM = 0x57505746; // "WPWF" (wiRedPanda Waveform File)
};