ScreenIdentity.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include "phosphorscreenscore_export.h"
 
// EDID parsing primitives + the wire-format helpers (`buildBaseId`,
// `buildScreenBaseId`, `normalizeHexSerial`, `readEdidHeaderSerial`,
// `invalidateEdidCache`) live in PhosphorIdentity::ScreenId — they're
// cross-process and the KWin effect needs them without pulling in
// Qt6::Gui. Re-include here so callers of this header don't have to
// chase the indirection.
#include <PhosphorIdentity/ScreenId.h>
 
#include <QString>
#include <QStringList>
 
class QScreen;
 
namespace Phosphor::Screens {
 
namespace ScreenIdentity {
 
// ─── QScreen-aware helpers ───────────────────────────────────────────────
//
// The EDID parsing + base-ID assembly primitives live in
// PhosphorIdentity::ScreenId (re-included via the header above so callers
// can just write `using namespace PhosphorIdentity::ScreenId;` if they
// want both surfaces).
 
PHOSPHORSCREENSCORE_EXPORT void reset();
 
PHOSPHORSCREENSCORE_EXPORT void invalidateEdidCache(const QString& connectorName = QString());
 
PHOSPHORSCREENSCORE_EXPORT void invalidateComputedIdentifiers();
 
PHOSPHORSCREENSCORE_EXPORT QString baseIdentifierFor(const QScreen* screen);
 
PHOSPHORSCREENSCORE_EXPORT QString identifierFor(const QScreen* screen);
 
PHOSPHORSCREENSCORE_EXPORT QScreen* findByIdOrName(const QString& identifier);
 
inline bool isConnectorName(const QString& identifier)
{
    return !identifier.isEmpty() && !identifier.contains(QLatin1Char(':'));
}
 
PHOSPHORSCREENSCORE_EXPORT QString idForName(const QString& connectorName);
 
PHOSPHORSCREENSCORE_EXPORT QString nameForId(const QString& screenId);
 
inline QStringList variantsFor(const QString& screenIdOrName)
{
    QStringList variants;
    if (screenIdOrName.isEmpty()) {
        return variants;
    }
    variants.append(screenIdOrName);
    if (isConnectorName(screenIdOrName)) {
        const QString resolved = idForName(screenIdOrName);
        if (!resolved.isEmpty() && resolved != screenIdOrName) {
            variants.append(resolved);
        }
    } else {
        const QString connector = nameForId(screenIdOrName);
        if (!connector.isEmpty() && connector != screenIdOrName) {
            variants.append(connector);
        }
    }
    return variants;
}
 
PHOSPHORSCREENSCORE_EXPORT bool screensMatch(const QString& a, const QString& b);
 
PHOSPHORSCREENSCORE_EXPORT bool belongsToPhysicalScreen(const QString& storedScreenId, const QString& physicalScreenId);
 
} // namespace ScreenIdentity
 
} // namespace Phosphor::Screens