default-timer.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef BACKENDS_TIMER_DEFAULT_H
#define BACKENDS_TIMER_DEFAULT_H

#include "common/str.h"
#include "common/hash-str.h"
#include "common/timer.h"
#include "common/mutex.h"


struct TimerSlot {
    Common::TimerManager::TimerProc callback;
    void *refCon;
    Common::String id;
    uint32 interval;    // in microseconds

    uint32 nextFireTime;    // in milliseconds
    uint32 nextFireTimeMicro;   // microseconds part of nextFire

    TimerSlot *next;

    TimerSlot() : callback(nullptr), refCon(nullptr), interval(0), nextFireTime(0), nextFireTimeMicro(0), next(nullptr) {}
};

void insertPrioQueue(TimerSlot *head, TimerSlot *newSlot);

class DefaultTimerManager : public Common::TimerManager {
private:
    typedef Common::HashMap<Common::String, TimerProc, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo> TimerSlotMap;

    TimerSlotMap _callbacks;

    uint32 _timerCallbackNext;

protected:
    Common::Mutex _mutex;
    TimerSlot *_head;

public:
    DefaultTimerManager();
    virtual ~DefaultTimerManager();
    bool installTimerProc(TimerProc proc, int32 interval, void *refCon, const Common::String &id) override;
    void removeTimerProc(TimerProc proc) override;

    virtual void handler();

    /*
     * Ensure that the callback is called at regular time intervals.
     * Should be called from pollEvents() on backends without threads.
     */
    void checkTimers(uint32 interval = 10);
};

#endif