Merge branch 'master' into jgrpp
# Conflicts: # src/animated_tile.cpp # src/cargopacket.h # src/cheat_gui.cpp # src/company_cmd.cpp # src/company_gui.cpp # src/date.cpp # src/disaster_vehicle.cpp # src/dock_gui.cpp # src/economy.cpp # src/engine.cpp # src/error_gui.cpp # src/fontcache/spritefontcache.cpp # src/game/game_gui.cpp # src/game/game_text.cpp # src/gfx.cpp # src/graph_gui.cpp # src/highscore_gui.cpp # src/industry_cmd.cpp # src/lang/dutch.txt # src/lang/english_AU.txt # src/lang/english_US.txt # src/lang/finnish.txt # src/lang/french.txt # src/lang/italian.txt # src/lang/portuguese.txt # src/lang/russian.txt # src/lang/turkish.txt # src/lang/vietnamese.txt # src/main_gui.cpp # src/misc_gui.cpp # src/network/network_gui.cpp # src/network/network_server.cpp # src/newgrf.cpp # src/newgrf.h # src/newgrf_generic.cpp # src/news_gui.cpp # src/openttd.cpp # src/os/unix/unix.cpp # src/os/windows/font_win32.cpp # src/os/windows/win32.cpp # src/rail_gui.cpp # src/road_gui.cpp # src/saveload/afterload.cpp # src/saveload/misc_sl.cpp # src/saveload/oldloader_sl.cpp # src/saveload/saveload.cpp # src/saveload/saveload.h # src/script/script_gui.cpp # src/settings_table.cpp # src/signs_gui.cpp # src/smallmap_gui.cpp # src/smallmap_gui.h # src/spritecache.cpp # src/spritecache.h # src/spriteloader/grf.cpp # src/station_cmd.cpp # src/statusbar_gui.cpp # src/stdafx.h # src/strgen/strgen_base.cpp # src/subsidy.cpp # src/table/settings/difficulty_settings.ini # src/texteff.cpp # src/timetable_cmd.cpp # src/timetable_gui.cpp # src/toolbar_gui.cpp # src/town_cmd.cpp # src/town_gui.cpp # src/townname.cpp # src/vehicle.cpp # src/waypoint_cmd.cpp # src/widgets/dropdown.cpp # src/window.cpp
This commit is contained in:
104
src/timer/timer_manager.h
Normal file
104
src/timer/timer_manager.h
Normal file
@@ -0,0 +1,104 @@
|
||||
/*
|
||||
* This file is part of OpenTTD.
|
||||
* OpenTTD 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, version 2.
|
||||
* OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
/** @file timer_manager.h Definition of the TimerManager */
|
||||
/** @note don't include this file; include "timer.h". */
|
||||
|
||||
#ifndef TIMER_MANAGER_H
|
||||
#define TIMER_MANAGER_H
|
||||
|
||||
#include "stdafx.h"
|
||||
#include <set>
|
||||
|
||||
template <typename TTimerType>
|
||||
class BaseTimer;
|
||||
|
||||
/**
|
||||
* The TimerManager manages a single Timer-type.
|
||||
*
|
||||
* It allows for automatic registration and unregistration of timers like Interval and OneShot.
|
||||
*
|
||||
* Each Timer-type needs to implement the Elapsed() method, and distribute that to the timers if needed.
|
||||
*/
|
||||
template <typename TTimerType>
|
||||
class TimerManager {
|
||||
public:
|
||||
using TPeriod = typename TTimerType::TPeriod;
|
||||
using TElapsed = typename TTimerType::TElapsed;
|
||||
|
||||
/* Avoid copying this object; it is a singleton object. */
|
||||
TimerManager(TimerManager const &) = delete;
|
||||
TimerManager &operator=(TimerManager const &) = delete;
|
||||
|
||||
/**
|
||||
* Register a timer.
|
||||
*
|
||||
* @param timer The timer to register.
|
||||
*/
|
||||
static void RegisterTimer(BaseTimer<TTimerType> &timer) {
|
||||
#ifdef WITH_ASSERT
|
||||
Validate(timer.period);
|
||||
#endif /* WITH_ASSERT */
|
||||
GetTimers().insert(&timer);
|
||||
}
|
||||
|
||||
/**
|
||||
* Unregister a timer.
|
||||
*
|
||||
* @param timer The timer to unregister.
|
||||
*/
|
||||
static void UnregisterTimer(BaseTimer<TTimerType> &timer) {
|
||||
GetTimers().erase(&timer);
|
||||
}
|
||||
|
||||
#ifdef WITH_ASSERT
|
||||
/**
|
||||
* Validate that a new period is actually valid.
|
||||
*
|
||||
* For most timers this is not an issue, but some want to make sure their
|
||||
* period is unique, to ensure deterministic game-play.
|
||||
*
|
||||
* This is meant purely to protect a developer from making a mistake.
|
||||
* As such, assert() when validation fails.
|
||||
*
|
||||
* @param period The period to validate.
|
||||
*/
|
||||
static void Validate(TPeriod period);
|
||||
#endif /* WITH_ASSERT */
|
||||
|
||||
/**
|
||||
* Called when time for this timer elapsed.
|
||||
*
|
||||
* The implementation per type is different, but they all share a similar goal:
|
||||
* Call the Elapsed() method of all active timers.
|
||||
*
|
||||
* @param value The amount of time that has elapsed.
|
||||
*/
|
||||
static void Elapsed(TElapsed value);
|
||||
|
||||
private:
|
||||
/**
|
||||
* Sorter for timers.
|
||||
*
|
||||
* It will sort based on the period, smaller first. If the period is the
|
||||
* same, it will sort based on the pointer value.
|
||||
*/
|
||||
struct base_timer_sorter {
|
||||
bool operator() (BaseTimer<TTimerType> *a, BaseTimer<TTimerType> *b) const {
|
||||
if (a->period == b->period) return a < b;
|
||||
return a->period < b->period;
|
||||
}
|
||||
};
|
||||
|
||||
/** Singleton list, to store all the active timers. */
|
||||
static std::set<BaseTimer<TTimerType> *, base_timer_sorter> &GetTimers() {
|
||||
static std::set<BaseTimer<TTimerType> *, base_timer_sorter> timers;
|
||||
return timers;
|
||||
}
|
||||
};
|
||||
|
||||
#endif /* TIMER_MANAGER_H */
|
Reference in New Issue
Block a user