SurfaceFactory.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorLayer/Surface.h>
#include <PhosphorLayer/SurfaceConfig.h>
#include <PhosphorLayer/phosphorlayer_export.h>
 
#include <QObject>
#include <QString>
 
#include <optional>
#include <type_traits>
 
namespace PhosphorLayer {
 
class ILayerShellTransport;
class IQmlEngineProvider;
class IScreenProvider;
class ISurfaceAnimator;
 
class PHOSPHORLAYER_EXPORT SurfaceFactory : public QObject
{
    Q_OBJECT
public:
    struct Deps
    {
        ILayerShellTransport* transport = nullptr;
 
        IScreenProvider* screens = nullptr;
 
        IQmlEngineProvider* engineProvider = nullptr;
 
        ISurfaceAnimator* animator = nullptr;
 
        QString loggingCategory;
    };
 
    explicit SurfaceFactory(Deps deps, QObject* parent = nullptr);
    ~SurfaceFactory() override;
 
    [[nodiscard]] Surface* create(SurfaceConfig cfg, QObject* parent = nullptr);
 
    template<typename T>
    [[nodiscard]] T* createAs(SurfaceConfig cfg, QObject* parent = nullptr)
    {
        static_assert(std::is_base_of_v<Surface, T>, "T must derive from PhosphorLayer::Surface");
        auto sdeps = validateAndPrepareDeps(cfg);
        if (!sdeps) {
            return nullptr;
        }
        return new T(Surface::CtorToken{}, std::move(cfg), std::move(*sdeps), parent ? parent : this);
    }
 
    const Deps& deps() const noexcept;
 
    [[nodiscard]] std::optional<SurfaceDeps> validateAndPrepareDeps(SurfaceConfig& cfg);
 
private:
    class Impl;
    std::unique_ptr<Impl> m_impl;
};
 
} // namespace PhosphorLayer