QtQuickClockManager.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <QtCore/QMetaObject>
#include <QtCore/QObject>
#include <QtCore/QPointer>
 
#include <atomic>
#include <memory>
#include <mutex>
#include <unordered_map>
 
QT_BEGIN_NAMESPACE
class QQuickWindow;
QT_END_NAMESPACE
 
namespace PhosphorAnimation {
 
class IMotionClock;
class QtQuickClock;
 
class PHOSPHORANIMATION_EXPORT QtQuickClockManager
{
public:
    QtQuickClockManager();
    ~QtQuickClockManager();
 
    static void setDefaultManager(QtQuickClockManager* manager);
 
    static QtQuickClockManager* defaultManager();
 
    IMotionClock* clockFor(QQuickWindow* window);
 
    void releaseClockFor(QQuickWindow* window);
 
    // ─── Test helpers ───
 
    int entryCount() const;
 
    void clearForTest();
 
    // Non-copyable — owns a registry of unique window->clock entries.
    QtQuickClockManager(const QtQuickClockManager&) = delete;
    QtQuickClockManager& operator=(const QtQuickClockManager&) = delete;
 
private:
    static std::atomic<QtQuickClockManager*> s_defaultManager;
 
    struct Entry
    {
        QPointer<QQuickWindow> window;
        std::unique_ptr<QtQuickClock> clock;
        QMetaObject::Connection destroyedConnection;
    };
 
    mutable std::mutex m_mutex;
    // std::unordered_map (not QHash) because `Entry` contains a
    // move-only `unique_ptr<QtQuickClock>` — Qt6's QHash still requires
    // copy-constructible values for its internal Node type. Same
    // rationale as `AnimationController::m_animations` in Phase 3.
    // Keyed on raw pointer so hash / equality are cheap. `QPointer`
    // inside `Entry` is consulted on lookup to detect stale windows;
    // keying on `QPointer` directly would be possible but hash /
    // comparison against raw `QQuickWindow*` keys in callers would
    // demand conversions on every lookup.
    std::unordered_map<QQuickWindow*, Entry> m_entries;
};
 
} // namespace PhosphorAnimation