WindowTypeEnum.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <QLatin1StringView>
#include <QString>
#include <QStringView>
 
#include <optional>
#include <utility> // std::pair (kTable)
 
namespace PhosphorProtocol {
 
enum class WindowType : int {
    Unknown = 0, 
    Normal = 1, 
    Dialog = 2,
    Utility = 3,
    Toolbar = 4,
    Splash = 5,
    Menu = 6, 
    Tooltip = 7,
    Notification = 8,
    Dock = 9, 
    Desktop = 10,
    OnScreenDisplay = 11,
    Popup = 12, 
    AppletPopup = 13,
};
 
inline constexpr int windowTypeMinValue = static_cast<int>(WindowType::Unknown);
inline constexpr int windowTypeMaxValue = static_cast<int>(WindowType::AppletPopup);
 
inline constexpr bool isValidWindowType(int value)
{
    return value >= windowTypeMinValue && value <= windowTypeMaxValue;
}
 
inline constexpr WindowType windowTypeFromInt(int value)
{
    return isValidWindowType(value) ? static_cast<WindowType>(value) : WindowType::Unknown;
}
 
// Pin the bounds invariants beside the enum they describe: constexpr lets the
// compiler enforce what the runtime test also checks.
static_assert(windowTypeMinValue == 0);
static_assert(!isValidWindowType(windowTypeMinValue - 1) && !isValidWindowType(windowTypeMaxValue + 1));
static_assert(windowTypeFromInt(windowTypeMaxValue + 1) == WindowType::Unknown);
 
inline QString windowTypeToString(WindowType type)
{
    switch (type) {
    case WindowType::Unknown:
        return QStringLiteral("unknown");
    case WindowType::Normal:
        return QStringLiteral("normal");
    case WindowType::Dialog:
        return QStringLiteral("dialog");
    case WindowType::Utility:
        return QStringLiteral("utility");
    case WindowType::Toolbar:
        return QStringLiteral("toolbar");
    case WindowType::Splash:
        return QStringLiteral("splash");
    case WindowType::Menu:
        return QStringLiteral("menu");
    case WindowType::Tooltip:
        return QStringLiteral("tooltip");
    case WindowType::Notification:
        return QStringLiteral("notification");
    case WindowType::Dock:
        return QStringLiteral("dock");
    case WindowType::Desktop:
        return QStringLiteral("desktop");
    case WindowType::OnScreenDisplay:
        return QStringLiteral("onscreendisplay");
    case WindowType::Popup:
        return QStringLiteral("popup");
    case WindowType::AppletPopup:
        return QStringLiteral("appletpopup");
    }
    return QStringLiteral("unknown");
}
 
inline std::optional<WindowType> windowTypeFromString(QStringView s)
{
    static constexpr std::pair<QLatin1StringView, WindowType> kTable[] = {
        {QLatin1StringView("unknown"), WindowType::Unknown},
        {QLatin1StringView("normal"), WindowType::Normal},
        {QLatin1StringView("dialog"), WindowType::Dialog},
        {QLatin1StringView("utility"), WindowType::Utility},
        {QLatin1StringView("toolbar"), WindowType::Toolbar},
        {QLatin1StringView("splash"), WindowType::Splash},
        {QLatin1StringView("menu"), WindowType::Menu},
        {QLatin1StringView("tooltip"), WindowType::Tooltip},
        {QLatin1StringView("notification"), WindowType::Notification},
        {QLatin1StringView("dock"), WindowType::Dock},
        {QLatin1StringView("desktop"), WindowType::Desktop},
        {QLatin1StringView("onscreendisplay"), WindowType::OnScreenDisplay},
        {QLatin1StringView("popup"), WindowType::Popup},
        {QLatin1StringView("appletpopup"), WindowType::AppletPopup},
    };
    for (const auto& [token, type] : kTable) {
        if (s.compare(token, Qt::CaseInsensitive) == 0) {
            return type;
        }
    }
    return std::nullopt;
}
 
} // namespace PhosphorProtocol