Timer.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_TIMER_HPP
#define TGUI_TIMER_HPP
 
#include <TGUI/Config.hpp>
 
#include <TGUI/Duration.hpp>
#include <TGUI/Optional.hpp>
 
#include <functional>
#include <memory>
#include <vector>

 
namespace tgui
{
    class TGUI_API Timer : public std::enable_shared_from_this<Timer>
    {
    public:
        using Ptr = std::shared_ptr<Timer>; // Only provided for potential consistence in user code
 
        Timer(const Timer&) = delete;
        Timer& operator=(const Timer&) = delete;

        [[nodiscard]] static std::shared_ptr<Timer> create(const std::function<void()>& callback, Duration interval, bool enable = true);

        [[nodiscard]] static std::shared_ptr<Timer> create(const std::function<void(std::shared_ptr<Timer>)>& callback,
                                                           Duration interval,
                                                           bool enable = true);

        static void scheduleCallback(const std::function<void()>& callback, Duration interval = Duration());

        void setInterval(Duration interval);

        [[nodiscard]] Duration getInterval() const;

        void setEnabled(bool enabled);

        [[nodiscard]] bool isEnabled() const;

        void setCallback(const std::function<void()>& callback);

        void setCallback(const std::function<void(std::shared_ptr<Timer>)>& callback);

        void restart();

        static bool updateTime(Duration elapsedTime);

        [[nodiscard]] static Optional<Duration> getNextScheduledTime();

        static void clearTimers();

 
    protected:
        // Default constructor, used by static create and scheduleCallback functions
        Timer() = default;

 
    private:
        static std::vector<std::shared_ptr<Timer>> m_activeTimers;
 
        bool m_repeats = false;
        bool m_enabled = false;
        Duration m_interval;
        std::function<void()> m_callback;
 
        Duration m_remainingDuration;
    };
} // namespace tgui
 
#endif // TGUI_TIMER_HPP