ScriptedAlgorithmHelpers.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphortiles_export.h>
#include <PhosphorLayoutApi/AlgorithmMetadata.h>
 
#include <QJSValue>
#include <QRect>
#include <QString>
#include <QStringList>
#include <QVariant>
#include <QVariantMap>
#include <QVector>
 
namespace PhosphorTiles {
namespace ScriptedHelpers {
 
struct CustomParamDef
{
    QString name; 
    QString type; 
    QVariant defaultValue; 
    QString description; 
    qreal minValue = 0.0; 
    qreal maxValue = 1.0; 
    QStringList enumOptions; 
 
    QVariantMap toVariantMap() const
    {
        QVariantMap m;
        m[QLatin1String("name")] = name;
        m[QLatin1String("type")] = type;
        m[QLatin1String("defaultValue")] = defaultValue;
        m[QLatin1String("description")] = description;
        if (type == QLatin1String("number")) {
            m[QLatin1String("minValue")] = minValue;
            m[QLatin1String("maxValue")] = maxValue;
        } else if (type == QLatin1String("enum")) {
            m[QLatin1String("enumOptions")] = QVariant(enumOptions);
        }
        return m;
    }
};
 
struct ScriptMetadata
{
    QString name;
    QString description;
    PhosphorLayout::ZoneNumberDisplay zoneNumberDisplay = PhosphorLayout::ZoneNumberDisplay::RendererDecides;
    qreal defaultSplitRatio = 0.0; 
    int defaultMaxWindows = 0; 
    int minimumWindows = 0; 
    int masterZoneIndex = -1;
    bool supportsMasterCount = false;
    bool supportsSplitRatio = false;
    bool supportsMemory = false;
    bool producesOverlappingZones = false;
    bool centerLayout = false;
    bool supportsMinSizes = true; 
    QString id; 
    QVector<CustomParamDef> customParams; 
};
 
PHOSPHORTILES_EXPORT QVector<CustomParamDef> parseCustomParamsFromJs(const QJSValue& jsCustomParams,
                                                                     const QString& filePath);
 
PHOSPHORTILES_EXPORT ScriptMetadata parseMetadataFromJs(const QJSValue& jsMetadata, const QString& filePath);
 
QVector<QRect> jsArrayToRects(const QJSValue& result, const QString& scriptId, int maxZones);
 
QVector<QRect> clampZonesToArea(const QVector<QRect>& zones, const QRect& area, const QString& scriptId);
 
} // namespace ScriptedHelpers
} // namespace PhosphorTiles