timed_event_mgr.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 ULTIMA4_EVENTS_TIMED_EVENT_MGR_H
#define ULTIMA4_EVENTS_TIMED_EVENT_MGR_H

#include "common/list.h"

namespace Ultima {
namespace Ultima4 {

class TimedEvent {
public:
    /* Typedefs */
    typedef Common::List<TimedEvent *> List;
    typedef void (*Callback)(void *);

    /* Constructors */
    TimedEvent(Callback callback, int interval, void *data = nullptr);

    /* Member functions */
    Callback getCallback() const;
    void *getData();

    void tick();

    /* Properties */
protected:
    Callback _callback;
    void *_data;
    int _interval;
    int _current;
};

class TimedEventMgr {
public:
    /* Typedefs */
    typedef TimedEvent::List List;

    /* Constructors */
    TimedEventMgr(int baseInterval);

    ~TimedEventMgr() {}

    void poll();

    bool isLocked() const;

    void add(TimedEvent::Callback theCallback, int interval, void *data = nullptr);

    List::iterator remove(List::iterator i);
    void remove(TimedEvent *event);
    void remove(TimedEvent::Callback theCallback, void *data = nullptr);

    void tick();

    void reset(uint interval);     
#if defined(IOS_ULTIMA4)
    bool hasActiveTimer() const;
#endif

private:
    void lock();                
    void unlock();              
    /* Properties */
protected:
    uint32 _lastTickTime;
    uint32 _baseInterval;
    bool _locked;
    List _events;
    List _deferredRemovals;
#if defined(IOS_ULTIMA4)
    TimedManagerHelper *m_helper;
#endif
};

} // End of namespace Ultima4
} // End of namespace Ultima

#endif