AlgorithmMetadata.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <QLatin1String>
#include <QString>
#include <QStringView>
 
namespace PhosphorLayout {
 
enum class ZoneNumberDisplay {
    RendererDecides, 
    All, 
    Last, 
    FirstAndLast, 
    None, 
};
 
inline QString zoneNumberDisplayToString(ZoneNumberDisplay value)
{
    switch (value) {
    case ZoneNumberDisplay::All:
        return QStringLiteral("all");
    case ZoneNumberDisplay::Last:
        return QStringLiteral("last");
    case ZoneNumberDisplay::FirstAndLast:
        return QStringLiteral("firstAndLast");
    case ZoneNumberDisplay::None:
        return QStringLiteral("none");
    case ZoneNumberDisplay::RendererDecides:
        break;
    }
    return QString();
}
 
inline ZoneNumberDisplay zoneNumberDisplayFromString(QStringView text)
{
    if (text == QLatin1String("all")) {
        return ZoneNumberDisplay::All;
    }
    if (text == QLatin1String("last")) {
        return ZoneNumberDisplay::Last;
    }
    if (text == QLatin1String("firstAndLast")) {
        return ZoneNumberDisplay::FirstAndLast;
    }
    if (text == QLatin1String("none")) {
        return ZoneNumberDisplay::None;
    }
    return ZoneNumberDisplay::RendererDecides;
}
 
struct AlgorithmMetadata
{
    bool supportsMasterCount = false;
 
    bool supportsSplitRatio = false;
 
    bool producesOverlappingZones = false;
 
    bool supportsCustomParams = false;
 
    bool supportsMemory = false;
 
    bool isScripted = false;
 
    bool isUserScript = false;
 
    ZoneNumberDisplay zoneNumberDisplay = ZoneNumberDisplay::RendererDecides;
};
 
} // namespace PhosphorLayout