nightcolormanager.h

Go to the documentation of this file.

/*
    KWin - the KDE window manager
    This file is part of the KDE project.
 
    SPDX-FileCopyrightText: 2017 Roman Gilg <subdiff@gmail.com>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include "constants.h"
#include "plugin.h"
 
#include <QDateTime>
#include <QObject>
#include <QPair>
 
#include <KConfigWatcher>
 
class QTimer;
 
namespace KWin
{
 
class ClockSkewNotifier;
class NightColorDBusInterface;
 
typedef QPair<QDateTime, QDateTime> DateTimes;
typedef QPair<QTime, QTime> Times;
 
enum NightColorMode {
    Automatic,
    Location,
    Timings,
    Constant,
};
 
class KWIN_EXPORT NightColorManager : public Plugin
{
    Q_OBJECT
 
public:
    explicit NightColorManager();
    ~NightColorManager() override;
 
    void autoLocationUpdate(double latitude, double longitude);
 
    void toggle();
 
    bool isInhibited() const;
 
    void inhibit();
 
    void uninhibit();
 
    bool isEnabled() const;
 
    bool isRunning() const;
 
    int currentTemperature() const;
 
    int targetTemperature() const;
 
    NightColorMode mode() const;
 
    bool daylight() const;
 
    QDateTime previousTransitionDateTime() const;
 
    qint64 previousTransitionDuration() const;
 
    QDateTime scheduledTransitionDateTime() const;
 
    qint64 scheduledTransitionDuration() const;
 
    // for auto tests
    void reconfigure();
    static NightColorManager *self();
 
    void preview(uint previewTemp);
 
    void stopPreview();
 
public Q_SLOTS:
    void resetSlowUpdateStartTimer();
    void quickAdjust(int targetTemp);
 
Q_SIGNALS:
    void inhibitedChanged();
 
    void enabledChanged();
 
    void runningChanged();
 
    void currentTemperatureChanged();
 
    void targetTemperatureChanged();
 
    void modeChanged();
 
    void daylightChanged();
 
    void previousTransitionTimingsChanged();
 
    void scheduledTransitionTimingsChanged();
 
private:
    void readConfig();
    void hardReset();
    void slowUpdate(int targetTemp);
    void resetAllTimers();
    int currentTargetTemp() const;
    void cancelAllTimers();
    void resetQuickAdjustTimer(int targetTemp);
    void resetSlowUpdateTimer();
 
    void updateTargetTemperature();
    void updateTransitionTimings(bool force);
    DateTimes getSunTimings(const QDateTime &dateTime, double latitude, double longitude, bool morning) const;
    bool checkAutomaticSunTimings() const;
 
    void commitGammaRamps(int temperature);
 
    void setEnabled(bool enabled);
    void setRunning(bool running);
    void setCurrentTemperature(int temperature);
    void setMode(NightColorMode mode);
    void setDaylight(bool daylight);
 
    NightColorDBusInterface *m_iface;
    ClockSkewNotifier *m_skewNotifier;
 
    // Specifies whether Night Color is enabled.
    bool m_active = false;
 
    // Specifies whether Night Color is currently running.
    bool m_running = false;
 
    // Specifies whether Night Color is inhibited globally.
    bool m_isGloballyInhibited = false;
 
    NightColorMode m_mode = NightColorMode::Automatic;
 
    // the previous and next sunrise/sunset intervals - in UTC time
    DateTimes m_prev = DateTimes();
    DateTimes m_next = DateTimes();
 
    // whether it is currently day or night
    bool m_daylight = true;
 
    // manual times from config
    QTime m_morning = QTime(6, 0);
    QTime m_evening = QTime(18, 0);
    int m_trTime = 30; // saved in minutes > 1
 
    // auto location provided by work space
    double m_latAuto;
    double m_lngAuto;
    // manual location from config
    double m_latFixed;
    double m_lngFixed;
 
    std::unique_ptr<QTimer> m_slowUpdateStartTimer;
    std::unique_ptr<QTimer> m_slowUpdateTimer;
    std::unique_ptr<QTimer> m_quickAdjustTimer;
    std::unique_ptr<QTimer> m_previewTimer;
 
    int m_currentTemp = DEFAULT_DAY_TEMPERATURE;
    int m_targetTemperature = DEFAULT_DAY_TEMPERATURE;
    int m_dayTargetTemp = DEFAULT_DAY_TEMPERATURE;
    int m_nightTargetTemp = DEFAULT_NIGHT_TEMPERATURE;
 
    int m_inhibitReferenceCount = 0;
    KConfigWatcher::Ptr m_configWatcher;
};
 
} // namespace KWin