projectserializer.h

Go to the documentation of this file.

 
#ifndef PROJECTSERIALIZER_H
#define PROJECTSERIALIZER_H
 
#include <QDir>
#include <QFileInfo>
#include <QJsonObject>
#include <QString>
#include <QVector>
 
class SWMMVisProjectWindow;
class SWMMVisProject;
class OpenSWMMVisLayer;
class MapCanvas;
 
class ProjectSerializer
{
public:
    static constexpr int kCurrentSchemaVersion = 5;
 
    static bool saveToFile(const QString &oswpPath,
                           SWMMVisProjectWindow *pw,
                           QString *errorOut = nullptr);
 
    static bool saveToFile(const QString &oswpPath,
                           SWMMVisProject *proj,
                           QString *errorOut = nullptr);
 
    static bool applyFromFile(const QString &oswpPath,
                              SWMMVisProjectWindow *pw,
                              QString *errorOut = nullptr,
                              QStringList *warningsOut = nullptr);
 
    [[nodiscard]] static inline QString sidecarPathFor(const QString &inpPath);
 
    // ------------------------------------------------------------
    // Path helpers (Slice AA-3.2) — used by every file-reference
    // field written to / read from `.oswp`.  Two callers today
    // (inpPath and basemap urls don't apply); future slices reuse.
    // ------------------------------------------------------------
 
    [[nodiscard]] static inline QString toRelativePath(const QString &path,
                                                        const QString &oswpFile);
 
    [[nodiscard]] static inline QString resolveStoredPath(const QString &stored,
                                                            const QString &oswpFile);
 
private:
    static QJsonObject serializeSession(SWMMVisProjectWindow *pw,
                                        const QString &oswpFile);
    static bool        applySession(const QJsonObject &sessionObj,
                                    SWMMVisProjectWindow *pw,
                                    const QString &oswpFile,
                                    QStringList *warningsOut = nullptr);
 
    static bool        writeRootJson(const QString &oswpPath,
                                     const QVector<SWMMVisProjectWindow *> &windows,
                                     QString *errorOut);
 
    static QJsonObject serializeBasemapLayer(OpenSWMMVisLayer *layer,
                                             const QString &oswpPath);
    static OpenSWMMVisLayer *deserializeBasemapLayer(const QJsonObject &obj,
                                                     QObject *parent,
                                                     const QString &oswpPath,
                                                     QStringList *warningsOut = nullptr);
 
    // GIS data layers (schema v4+) — loaded rasters (GDAL) and vector
    // datasets (OGR shapefiles, GeoPackage, …). Persisted by source path so
    // they reopen on project load. deserializeGisLayer opens asynchronously
    // and adds the layer to \p canvas on completion.
    static QJsonObject serializeGisLayer(OpenSWMMVisLayer *layer,
                                         const QString &oswpPath);
    static void        deserializeGisLayer(const QJsonObject &obj,
                                           MapCanvas *canvas,
                                           const QString &oswpPath,
                                           QStringList *warningsOut = nullptr);
};
 
// ---------------------------------------------------------------------------
// Inline path helpers (Slice AA-3.2)
// ---------------------------------------------------------------------------
 
inline QString ProjectSerializer::toRelativePath(const QString &path,
                                                  const QString &oswpFile)
{
    if (path.isEmpty()) return {};
    const QFileInfo oswpFi(oswpFile);
    const QDir oswpDir = oswpFi.absoluteDir();
    const QString cleanedAbs = QDir::cleanPath(QFileInfo(path).absoluteFilePath());
    // QDir::relativeFilePath returns the absolute path unchanged when the
    // two are on different volumes (cross-drive on Windows) or can't be
    // made relative — exactly the fallback we want.
    return oswpDir.relativeFilePath(cleanedAbs);
}
 
inline QString ProjectSerializer::resolveStoredPath(const QString &stored,
                                                     const QString &oswpFile)
{
    if (stored.isEmpty()) return {};
    if (QDir::isAbsolutePath(stored))
        return QDir::cleanPath(stored);
    const QFileInfo oswpFi(oswpFile);
    const QDir oswpDir = oswpFi.absoluteDir();
    return QDir::cleanPath(oswpDir.absoluteFilePath(stored));
}
 
inline QString ProjectSerializer::sidecarPathFor(const QString &inpPath)
{
    if (inpPath.isEmpty()) return {};
    const QFileInfo fi(inpPath);
    return fi.absoluteDir().filePath(fi.completeBaseName() +
                                     QStringLiteral(".oswp"));
}
 
#endif // PROJECTSERIALIZER_H